Difference between revisions of "Auto Loader"

Revision as of 15:13, 6 March 2023

A SmartSimple feature used to automatically upload files of data related to companies, contacts and Universal Tracking Applications.

Overview

The Autoloader feature provides you with the ability to automatically update SmartSimple information with data from external text files. This feature is vital if you need to keep SmartSimple customer or project data in sync with an existing legacy or enterprise resource planning (ERP) system.

An autoloader can be triggered whenever a file is added to a designated SmartFolder/Configuration Folder. These files can be added manually or uploaded automatically picking by up a file from an SFTP.

• Once a file is added to the SmartFolder/Configuration Folder, the autoloader process will recognize that a file has been added and start the upload process.
• Once the file has been processed, it will not be processed a second time unless a new file of the same name is added to the folder.
• Each record from the upload file will update the associated record in the database.
• A log file created indicates the success or failure of each record update and an email can be sent to a designated user indicating the success of the upload.
• If a new version of the file is added to the folder, then this flag is reset and the new file will be processed.
• You can create any number of autoloaders within the system to provide for different upload processes.
• An autoloader can upload companies, contacts and Universal Tracking Application Level 1 or Level 2 data.

Before you can deploy this feature it is necessary to:

• Define the SmartFolder/Configuration Folder where the upload file will be stored.
• Define the format and layout of the data file (the number of columns in the upload file, the delimiter between each field and the field order).
• Specify a field in the upload file that the system will use to match an upload record to an existing customer record.
• Determine if you wish to use an automated process for files by adding a schedule to pick up files from an external source (i.e. SFTP or manually add the files to the folder).

Each record in the uploaded file is used to update one set of fields in the entity to be updated.

The existing value in the SmartSimple field will be replaced by the value on the field in the upload file.

Creating a SmartFolder/Configuration Folder

• Any SmartFolder can be used as the source for an Autoloader.
• The folder must be used exclusively for the Autoloader, since every file uploaded will be processed.
• Incorrect files or incorrectly formatted files will be processed so could lead to data loss and/or creation of invalid data.

IMPORTANT:  Because any file uploaded to a SmartFolder/Configuration Folder that is associated to an autoloader will be processed, it is extremely important that the SmartFolder/Configuration Folder is permissioned and labelled appropriately.

• SmartFolders/Configuration Folder for autoloaders should be permissioned such that only contacts that need to be able to upload files for autoloading are permitted to do so.
• It is best practice to put all Autoloader enabled SmartFolders into a parent folder named Autoloader (with role-restricted access) to help ensure no inappropriate files are uploaded to the folder.

Preparing the Upload File

• You must be able to specify a unique field that will be used to link each record in the upload file to each record in the customer record. You cannot use a standard field such as customer name or phone number.
• This common field needs to be present in each record on the upload file and in each customer record. For instance, a unique account number field that you add to the customer table can be linked to the same account number field in the upload data.
• The file to be uploaded must be in ASCII format. There is no specific file naming convention.
• Each record in the file must be separated by a CR/LF (ASCII 13,10 /D,A) character combination.
• Each field must be delimited by one of the following characters:

Comma – “,” (ASCII 44/2C)
Tab – (ASCII 9/9)
Pipe – “|” (ASCII 179/B3)
Semi colon – “;” (ASCII 59/3B)
Colon – “:” (ASCII 58/3A)

This can be accomplished either using Notepad to create and edit the data for import which can be saved with txt as the file extension.

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:

Start -> Settings -> Control Panel -> Regional Settings -> Additional Settings Button.
Click the "Number" tab and in the "List Separator" field, 
Replace the current default separator with the one you want to use (such as the pipe symbol | ). 

• If you use Microsoft Excel to create a csv file it is recommended that you open the document with Notepad to review the contents prior to Autoloading. If any of the data within the Excel document had line breaks within cells it will create a line break in the csv document. Each new line in the csv document will start a new record, thus you must ensure all inner-cell line breaks are removed from either Excel or the txt document.
• Alternately when performing a CSV import, any columns that have line breaks or delimiters within the content can be contained within double quotes. NOTE: Any double quotes within that content MUST be escaped with a backslash \ in front of the double quote so they aren't treated as the closing quote of the column. Example of a 4-column CSV:

1st Record|Draft|"This content"|555-1212
2nd Record|Submitted|"That content"|123-4567
3rd Record|Draft|"Broken  
Content"|444-5555
4th Record|Draft|"Normal Content Test"|321-9876
5th Record|Submitted|"Backslash Escaped \" quote content
Also with 
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.

Autoloader Constraints

• You must be a Global User Administrator in your instance of SmartSimple to access the Autoloader feature and set up an upload process.
• 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.

Autoloader Configuration Page

This section describes the detailed steps required to use the Autoloader. Carefully examine, using a file editor, the file that will be uploaded.

Ensure that the file meets the file layout criteria outlined in the previous section:

• Choose the Configuration, Global Settings menu.
• Stay on the System tab and scroll down the page.
• Click the Autoloader link.
• Click the New Autoloader tab.
• Go thru each of the three tabs.

General tab

Setting the Autoloader Name

As you can define any number of autoloaders each autoloader process must be uniquely named.

• Set the name for this autoloader process.

Setting the Folder Type

• Select Folder Type: SmartFolder  or 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.

The File Encoding can be UTF-8, UTF-16 or ANSI. This option is hidden if the File Type is XML.

Defining the Record Type

The Record type can be Company, Contact, Resource or a Universal Tracking Application.

If the selected Record type is Company or Contact then the user is required to populate an additional Item field. The possible options here can include Company or Contact, Event,Transactions, Address and Associations (User or Company) .

If the selected Record type is a UTA then the user is required to populate an additional Level field. The possible options here can include Level 1, Level 2, Level 3, Transactions, L1 Company Association, L1 Contact Association, L2 Company Association and L2 Contact Association.

If the selected Record type is a UTA and the selected Level is Transaction then the user is required to populate an additional drop-down field reflecting all the levels that the transactions are enabled against.

Activate Autoloader

Enable this check box for the Autoloader to execute.

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

Here is a more detailed look at the automated Scheduler.

File Layout Tab

The File Layout section is used to determine the number of columns in the file and the Field Delimiter.

• Number of Columns - The number of columns you select is used to define the number of columns in the upload file, and the number of fields that can be updated in the database.
  • The maximum number of fields that can be updated is 100 fields in a single file.
  • If more than 100 fields are required, then you will need to create two upload files.
• Ignore Lines - You can specify the number of rows to ignore from the beginning of the file. This can be used to ignore column headers, if they exist as the first row in any file.
• Field Delimiter - drop-down list showing the delimiter options used to separate different values in the file into different columns. Will not be presented when the File Type is XML or JSON.
• Record Node Name - Only presented when the File Type is XML.
• 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.

• The number of columns you select determines the number of fields you can map.
• Identifier. Enable the column that you have identified as the identifier.  This is important when you are updating existing records. Single/multiple field(s) is/are required to match an uploaded record to an existing record within the system.  
• The Table header field is only required if you are using an XML or JSON file. You can fill out this section with the column headers of the file you want to upload.
• Field is selected thru a dropdown box. (see the Reference section below for information on standard field names)

IMPORTANT:
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)
• Resource ID (Resource Auto Loader)
• Tracking ID (Level 2 / Level 3 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.
• 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:  

1. If you wish to deactivate a user using the Autoloader then select the Disable User Login (use value of 1) Field option and ensure that the uploaded file has a value of 1 in the relevant cells.

2. If the Item or App Level option is set to one of the Association options then you can only have Associations ID as identifier. The system we will force the Identifier when Associations ID is selected in mapping, and will only alert them when they try to set any other columns as identifier.

Process 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.
• Run report after loader ends - drop-down list that contains a list of all reports in the system.  It will ran the configured Scheduled Export of the report. Frequency on the report should bet set to On Demand.
• Run sequencial Autoloader after loader ends – Linking Autoloaders
• Trigger Formulas – enables the triggering of any template formulas that may exist for the selected record type and item/level. If this check box is not enabled then these formulas will not execute.
• Send email with log when Autoloader is done – Sends email every time the Autoloader executes with a report of the upload process.(Note: The log file is also stored in the same folder as the uploaded file.)
• Send email notification when Autoloader failed to complete – Sends email when ftp/sftp connection failed, or when autoloader process was terminated unexpectedly.
• Send email with log when Autoloader has any failed records - Sends email when autoloader fails to complete.
• Email To – Sets the email address who will receive a message. Multiple email addresses can be included separated by commas.

Create Options

This section of the Autoloader is used to determine how new records in the upload file should be handled.

The exact fields that are displayed vary depending on the Record Type and Item or List values previously selected.

Company Record / Company Item

• 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.
• Category – determines the organisational category that you wish to be associated with the new records.
• Trigger Workflow – drop-down list of all workflows related to the Record Type. It defaults to N/A.
• Trigger On All Records - check-box that is populated is you wish to have a workflow execute against all records, whether new records or updated records. This can be used to create companies with multiple categories.

Contact Record / Contact Item

• 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.
• Account – determines where in the organisational hierarchy new records should be added.
• Role – determines a user role that you wish to be associated with the new records. If you wish to have multiple roles associated with a user then you will need to trigger a workflow against each record (see below for further details).
• Trigger Workflow – drop-down list that of all workflows related to the Record Type. It defaults to N/A.
• Trigger On All Records - check-box that is populated is users wants to have a workflow execute against all records, whether new records or updated records. This can be used to activate users with multiple roles and to e-mail a password to newly created contacts automatically.

Company or Contact Record / Event or Transaction Item

• 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
• Trigger Workflow – drop-down list that of all workflows related to the Record Type. It defaults to N/A.
• Trigger On All Records - check-box that is populated if users wants to have a workflow execute against all records, whether new records or updated records.

UTA Record / all Levels

• 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
• Trigger Workflow – drop-down list of all workflows related to the Record Type. It defaults to N/A.
• Trigger On All Records - check-box that is populated if you wish to have a workflow execute against all records, whether new records or updated records.

Updating Account Owners

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.

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.

Updating Account Parent

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.

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.
Example: Updating Account Parent AutoLoader Configuration:

The AutoLoader Parent ID field is an Account field that will get populated with the second value (Parent ID) from the CSV record below.
Example: AutoLoader Source File:

Action: A two column report with the Company ID and the Parent ID needs to be created, exported to a CSV file and uploaded to the associated AutoLoader SmartFolder.
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.

Updating Parent Company

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.

Updating Event / Transaction Parent User

When you are updating user type related to a Transaction information you can automatically associate a user field to a transaction field in order to establish a parent user for the transaction. 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.

Branch, Company and Owner Custom Field Matching

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.

Updating Tracking Parent

When you are updating UTA Level 2 or 3 information you can automatically associate a field on the level 2 with a field on the level 1, or associate a field on the level 3 with a field on the level 1, in order to establish a relationship between the entities.

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 entity 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 UTA and the Level to Level 2 or Level 3.

Parent record match field ids

This section allows for manipulation of the data prior to the Autoloader actually loading the data onto the system.

It is only available when the File Type is XML.

Ad hoc upload url

This is an Autoloader setting that provides a more friendly and accessible user interface for importing data into the system as well as allowing users to verify the file before uploading it to a SmartFolder for processing by the Autoloader. This feature is intended to be used when External Data Source is not configured.

History Tab

Available after February 2019 upgrade.
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.

• # - 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

This section allows for manipulation of the data prior to the Autoloader actually loading the data onto the system.

It is only available when the File Type is either CSV,Text or Fixed Length Text.

It is not available when File Type is XML.

See Autoloader File Preparation for configuration instructions.

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.

The External Data Source is a drop-down list with 5 options available:

Additional fields are exposed when one of these options is selected, with the exact number and type of fields dependent on the selected option.

FTP and SFTP

• 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
• Append Datetime Stamp to File Name - will append date and time when the file picked up from the sftp do not have a datestamp
• URL - the URL where the file(s) can be retrieved from. e.g. my.sftp.com or my.sftp.com:2222
• Login Name - username to allow access to the system
• Login Password - password to allow access to the system
• Use Private Key - enable this setting when using keys as credentials to authenticate
• Private Key File - upload the private key file
• Path - exact folder location on the system where the files can be found i.e. "/" for root directory or "/in" or "/out"
• File Names - name of the files to be loaded via the Autoloader. e.g. HRFeed.csv, Payment_*.csv (Use * for wildcards in filenames. < br/>

Note that when settings are saved, a Verify Connection button will appear next to the Login Name Textbox. This button can be used to verify that the url, username, password are correct.

HTTP

• 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

• URL - the URL where the file(s) can be retrieved from
• File Names - name of the files to be loaded via the Autoloader

SOAP

• 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

• URL - the URL where the file(s) can be retrieved from
• Login Name - username to allow access to the system
• Login Password - password to allow access to the system
• Function - The function called by the Web Service call.
• Request Body - The content of the Web Service message to be sent to the external service.
• Callback - Method to sends the response back to the client.

OData

• OData Version - Version of OData available from the endpoint
• URL - the endpoint of OData
• Login Name - username to allow access to the system
• Login Password - password to allow access to the system

Important note about XML Files

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:

• <![CDATA[ CONTENTS ]]>

For example, an address or company name could contain ampersands, so should be included as:

JaneSmith

• 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

{
"data":[{
"Name":"Acme Corporation",
"Phone":"416-123-4567",
"CompanyID":"496246"
},
{
"Name":"Super Banana Ltd.",
"Phone":"800-555-1234",
"CompanyID":"496244"
},
{
"Name":"Red Apple Supply",
"Phone":"917-123-0000",
"CompanyID":"496248"
},
{
"Name":"Orange you Glad",
"Phone":"410-222-2030",
"CompanyID":"496242"
}
]
}

Reference: Standard Field Names and Variables

The below table can be used to compare Level 1 Standard Field terminology found in the UTA, on the Autoloader, in the Database, and Variable syntax]]

Example how to 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.

You will be presented with page 2 of the Ad Hoc Autoloader screen, which provides users the option to review the file being uploaded, including what data us being mapped to what field.

If there is no issue with the data and the mappings then click on the 'Add to SmartFolder and Autolader queue' button. You should be presented with page 3 of the Ad Hoc Autoloader screen, which confirms that the file has been successfully added to the SmartFolder.

See Also

• • How to Add Users and Contacts
  • Autoloader File Preparation
  • Linking Autoloaders