Changes

Jump to: navigation, search

Auto Loader

2,300 bytes added, 14:55, 13 February 2020
FILE LAYOUT Tab
multiple line breaks"|777-8888
6th Record|Submitted|"Normal Content again"|111-2233
 
* If the file has special characters, convert encoding to UTF-8.
* If columns has a number sign after the comma, always add double quotes to avoid data problem when processing the file.
* The user uploading the file must have write permissions to the folder where the file is to be stored.
* You '''must''' not use the upload folder for any purpose other than uploading files, as the autoloader will attempt to process any file added to the folder.
 
 
==Instructions==
* Click the '''Autoloader''' link.
* Click the New Autoloader tab.
* Go thru each of the first three tabs.
==='''GENERAL''' tab===
: [[File:Auto6b.PNG]]
===='''Setting the Autoloader Name===='''  
As you can define any number of autoloaders each autoloader process must be uniquely named.
: [[File:Auto3.PNG|thumb|none|400px]]
===='''Setting the SmartFolder====Folder Type''' * Click the Select Folder Lookup button to display the Type: [[SmartFolders Overview|SmartFolder]], list  or [[SmartFolders_Overview#Configuration_Folders|Configuration Folder]]* Click the Folder Lookup button to display the list.
* Select the folder where you plan to add the file.
The folder name will be added to the Folder box.
===='''Setting the File Properties===='''  
The File Type can be a CSV,Text file, an XML file, Fixed Length, or JSON data.
: [[Image:AutoFile.png|thumb|none|400px]]
===='''Defining the Record Type===='''  
The Record type can be Company, Contact, Resource or a [[Universal Tracking Application]].
: [[Image:Auto5b.png|thumb|none|400px]]
===='''Activate Autoloader===='''  
Enable this check box for the Autoloader to execute.
 
'''External Data Source'''
====External Data Source====
Autoloader can be connected an external data source to pull the file and move the file to the SmartFolder.
Select a connection type and complete the ''Schedule'' section below to specify the launch times of the autoloader everyday.
===='''Schedule===='''  
Complete this section to specify when autoloader will ran.
* Process Last Completed - datestamp of the last time the autoloader was processed.
 
==='''FILE LAYOUT''' Tab===
* '''Record Node Filter''' - Only presented when the File Type is XML.
===='''Defining the Column Mapping===='''  
Once you have defined the number of fields, you define the field order to match the column order in the upload file.
: [[Image:Auto9.png|thumb|none|900px]]
* The '''number of columns''' you select determines the number of fields you can map.
* The '''field nameIdentifier''' . Enable the column that you have identified as the identifier.  This is selected from the Field combo boximportant when you are updating existing records.  Single/multiple field(see the Reference section below for information on standard field namess)* In order for the update to succeed, a single field is /are required to match an upload uploaded record to an existing database record this is indicated as within the Identifier field. Customer data will generally be an account number type fieldsystem. * The''' Table header''' field is only required if you are using the HTML Table feature or when loading an XML or JSON file. You can fill out this section with the column headers of the file you want to upload.* The '''Duplicate Match BeahviourField ''' drop-down allows user to specify is selected thru a dropdown box. (see the behaviour whenever multiple records are matched using the Identifier Reference section below for information on standard field(snames).** Update Unique Match Only - will only update when one matching record is found** Update All Matches - will update all matching records
<span style="font-size: medium;">'''IMPORTANT:''' </span><br />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)
* If used the fields should be marked as the Identifier.
* These fields would normally be used if you have extracted data from [[SmartSimple]] including those ID fields, updated the data outside of [[SmartSimple]] and wish to import the updated information.
 
'''NOTE:'''  
: [[Image:Auto7.png]]
* '''Create/Update Behavior''' - If you wish to create new record, then enable the '''Create new or update matching record''''' check box. If you enable the other check box '''''Update only, do not create new''', existing records will be updated but new records will be rejected.
* '''Duplicate Match Behavior''' - behavior when multiple records are matched by the same identifier key.Drop-down allows user to specify the behaviour whenever multiple records are matched using the Identifier field(s).** Update Unique Match Only - will only update when one matching record is found** Update All Matches - will update all matching records
* '''Account''' – determines where in the organisational hierarchy new records should be added.
* '''Is External''' – choose this option when creating external companies under the root company.
: [[Image:Auto7c.png]]
* '''Create/Update Behavior''' - If you wish to create new record, then enable the '''Create new or update Matching record''' check box. If you do not enable the other check box '''Update only, do not create new''' existing records will be updated but new records will be rejected.
* '''Duplicate Match Behavior'''  - behavior when multiple records are matched by the same identifier key.Drop-down allows user to specify the behaviour whenever multiple records are matched using the Identifier field(s).** Update Unique Match Only - will only update when one matching record is found** Update All Matches - will update all matching records
* '''Type''' – drop-down list of all Event or Transaction types, depending on the exact '''Item''' selected. It defaults to N/A
* '''Status''' – drop-down list of all Event or Transaction statuses, depending on the exact '''Item''' selected. It defaults to N/A
: [[Image:AutoloaderNewRecordUTA.png|link=]]
* '''Create/Update Behavior''' - If you wish to create new record, then enable the '''Create new or update Matching record''' check box. If you do not enable the other check box '''Update only, do not create new''' existing records will be updated but new records will be rejected.
* '''Duplicate Match Behavior'''  - behavior when multiple records are matched by the same identifier key.Drop-down allows user to specify the behaviour whenever multiple records are matched using the Identifier field(s).** Update Unique Match Only - will only update when one matching record is found** Update All Matches - will update all matching records
* '''Type''' – drop-down list of all Level 1, Level 2, Level 3 or Transaction types, depending on the exact '''Level''' selected. It defaults to N/A
* '''Status''' – drop-down list of all Level 1, Level 2, Level 3 or Transaction statuses, depending on the exact '''Item''' selected. It defaults to N/A
[[Image:AdhocAutoload.png|100.px|border]]
==='''HISTORY''' tab Tab===
<span style="color: #ff0000;">Available after February 2019 upgrade.</span> <br/>
A new Autoloader feature that shows a new History information tab. The list includes the file name, user who uploaded the file, start time, end time, records added/updated and status of last run.
[[Image:Autoloader-History.PNG]]
 
* '''#''' - item number
* '''File''' - filename that was processed. If the file is deleted from the SmartFolder, the filename will not be displayed on the list.
* '''Uploaded By''' - name of the user who uploaded the file
* '''Start Time''' - date and time the file was processed
* '''End Time''' - date and time the file was completed
* '''Added''' - number of records that were added
* '''Updated''' - number of records that were updated
* '''Failed''' - number of records that failed to update/add
* '''Status''' - status of the process.   
** '''''Processing''''' - the file is currently being processed and is not yet complete
** '''''Completed''''' - the file was successfully processed and was completed
** '''''Interrupted''''' - the process was terminated i.e. GORT was terminated abruptly (someone restarted the server)
** '''''Data Problem''''' - the file has data problem i.e. pound sign at the start of the column . data with # should be enclosed in double quotes e.g. ,"another column","#111 Peter Street","another column",
** '''''Connection Failed''''' - external data source connection failed
** '''''No file / download file failed''''' - connection was established but no file was existing in the external data source subfolder
** '''''File problem''''' 
** '''''File failed pre-processing''''' 
** '''''Error processing file''''' 
** '''''Wrong file type''''' 
* '''Process ID''' - unique identifier of the process
==File Preparation==
|}
==Example how to upload a file using use '''''ad hoc upload url'''''==
When you click on the Upload File button then you will be presented with page one of the Ad Hoc Autoloader screen. Use the 'Choose file' button to select the file to be loaded and then click the 'Upload' button.
[[Image:AdhocAutoload3.png|100.px|border]]
 
 
==See Also==
Smartstaff
1,385
edits

Navigation menu