Changes

Jump to: navigation, search

Auto Loader

51 bytes added, 18:35, 22 May 2018
no edit summary
: Alternately you can use the '''Save As''' feature within Microsoft Excel and save the document as a '''csv''' file.
'''Notes:'''
 
* If any of the data to be imported contains commas and you are creating a '''csv''' file from Excel you should export the data using pipes (|) as the separators rather than commas. To do this you need to change the settings on your PC prior to creating the '''csv''' file. The method of doing this depends on your PCs Operating System, but is roughly outlined below:
* Click the '''Autoloader''' link.
* Click the New Autoloader tab.
 
* '''Workflow before loader starts''' – drop-down list that contains a list of all workflows in the system. It defaults to No and if users wants to have a workflow execute before the autoloader adds the data to the system they should select the relevant workflow.
* '''Workflow after loader ends''' – drop-down list that contains a list of all workflows in the system. It defaults to No and if users wants to have a workflow execute after the autoloader adds the data to the system they should select the relevant workflow.
 
The following fields must only be included in the Autoloader field mappings if you are updating '''existing''' records. These fields '''must not''' be used when using the Auto Loader to create new records.
*
*::* '''Company ID''' (Company Auto Loader)
*::* '''User ID''' (Contact Auto Loader)
*::* '''Tracking ID''' ({{l2}} / {{l3}} Auto Loader)
*
** When using the fields above the IDs being Auto Loaded must match IDs of records present within the system.
** If used the fields should be marked as the Identifier.
When you are updating company type information you can automatically associate an account field to a user field in order to establish “account ownership”. This section is only displayed at the bottom of the Autoloader page if you have set the Record Type to Company and Item to company.
*
*: [[Image:Auto10a.png]]
*: ''For example, if the imported account file contains an employee ID field, then this can be matched to the user table – providing each user with an employee ID field.''
When you are updating company type information you can automatically associate an account field to a parent account field in order to establish “company hierarchy”. This section is only displayed at the bottom of the Autoloader page if you have set the Record Type to Company and Item to company.
*
*: [[Image:Auto10b.png]]
*: ''For example, if the imported account file contains a parent ID field, then this can be matched to the account table – providing each company with a parent company.''
*: Result: The Account records with a Company ID IN (278520,297733,316703) will have their Parent ID changed to 349238.
*
 
==Updating Event / Transaction Parent Company==
When you are updating company type information related to an Event or a Transaction you can automatically associate an account field to a transaction or event field in order to establish a parent for the transaction. This includes using Account standard fields.
If no matches exist then you can select the required action using the '''No parent matched action''' drop-down.
*
*:* Reject Record - record is not loaded into the system
*:* Add as orphan record - record is loaded into the system but without being attached to a parent company
*:* Attach to dummy account - record is loaded into the system and is attached to the parent company specified in the '''Default Parent ID''' field.
*
*
This section is only displayed at the bottom of the Autoloader page if you have set the '''Record Type''' to Company and the '''Item''' to either Event or Transaction.
*
*: [[Image:Auto10c.png]]
*
When you are updating people type information you can automatically associate an account field to a user field in order to attach the user to the correct account. This section is only displayed at the bottom of the Autoloader page if you have set the Type to People.
*
*: [[Image:Auto10f.png]]
*
If no matches exist then you can select the required action using the '''No parent matched action''' drop-down.
*
*:* Reject Record - record is not loaded into the system
*:* Add as orphan record - record is loaded into the system but without being attached to a parent company
*:* Attach to dummy account - record is loaded into the system and is attached to the parent company specified in the '''Default Parent ID''' field.
*
*
This section is only displayed at the bottom of the Autoloader page if you have set the '''Record Type''' to People and the '''Item''' to either Event or Transaction.
*
*: [[Image:Auto10d.png]]
*
When you are updating UTA information you can automatically associate a standard field on the UTA with user and company fields in order to establish individual or organizational ownership. This section is only displayed at the bottom of the Autoloader page if you have set the Record Type to [[UTA]] and the Level to Level 1.
*
*: [[Image:Auto10e.png]]
*
This section is only displayed at the bottom of the Autoloader page if you have set the Record Type to [[UTA]] and the Level to Level 2 or Level 3.
*
*: [[Image:Auto10g.png]]
*
It is only available when the '''File Type''' is '''XML'''.
*
*: [[Image:AutoXML.png]]
*
 
==File Preparation==
This section allows for manipulation of the data prior to the Autoloader actually loading the data onto the system.
See [[Autoloader File Preparation]] for configuration instructions.
*
*: [[Image:AutoFilePreparation.png]]
*
 
==External Data Source==
This section allows for the configuration of an external file source if the user does not want to manually upload the file.
*
*: [[Image:AutoFTP2.PNG]]
*
** Disable processing. Download file only - if checked then the system will only pull the file across into SmartSimple, but will not load the contents of the file
** Delete File from Data Source After Downloaded - file will be deleted from the sftp site
*
*: [[Image:AutoHTTP.png]]
*
** Disable processing. Download file only - if checked then the system will only pull the file across into SmartSimple, but will not load the contents of the file
<!--see ticket 18426 - autoloader FTP settings-->
*
*: [[Image:AutoSOAP.png]]
*
** Disable processing. Download file only - if checked then the system will only pull the file across into SmartSimple, but will not load the contents of the file
*
*: [[Image:External-OData1.PNG]]
*
** OData Version - Version of OData available from the endpoint
** URL - the endpoint of OData
** Login Password - password to allow access to the system
===Schedule===
*
*: [[Image:External-Schedule.PNG]]
* ** Frequency -  
'''On File Upload''' - will process autoloader upon file upload
'''Scheduled''' - will allow you to specify the launch times of the autoloader everyday.
** Launch Hour - a 24-hour format on desired hours to pull from external source for processing
 
e.g. 07,15,23
** Process Last Completed - datestamp of the last time the autoloader was processed.
If the contents of any the elements in an XML file being autoloaded contains certain special characters it will disrupt the XML structure, making the message unreadable by the receiving server. The '''less than''' symbol (<) and '''ampersand''' (&) are two primary special characters to be concerned about. When including fields that may contain those characters you should use a special wrapper so the receiving understands that they are data content and not part of the XML structure:
*
*: <span style="font-size: small;">&lt;![CDATA[ '''''CONTENTS''''' ]]></span>
*
 
For example, an '''address''' or '''company name''' could contain ampersands, so should be included as:
** It is advisable to use CDATA for any field containing text since the contents are often unpredictable.
 
==Note about JSON Files==
JSON format should start with a '''data''' node, as shown in the example below
Smartstaff
1,385
edits

Navigation menu