Smartstaff
1,385
edits
Changes
no edit summary
==Configuration - Essentials==
==Configuration - Advanced==
==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:Autoloader_DS1.png ]]
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===
[[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
* '''Append Datetime Stamp to File Name''' - will append date and time when the file picked up from the sftp do not have a datestamp
<!--see ticket 18426 - autoloader FTP settings-->
* '''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===
[[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-->
* '''URL''' - the URL where the file(s) can be retrieved from
* '''File Names''' - name of the files to be loaded via the Autoloader
===SOAP===
[[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
<!--see ticket 18426 - autoloader FTP settings-->
* '''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===
<!--Upgrade May 2018 - Ticket#62753-->
[[Image:External-OData1.PNG]]
* '''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
==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.
[[Image:AutoFilePreparation.png]]
==Settings Explained==
This section describes the detailed steps required to use the Autoloader. Carefully examine, using a file editor, the file that will be uploaded.
* '''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. [[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:Autoloader_DS1.png ]] 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===[[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* '''Append Datetime Stamp to File Name''' - will append date and time when the file picked up from the sftp do not have a datestamp<!--see ticket 18426 - autoloader FTP settings-->* '''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===[[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-->* '''URL''' - the URL where the file(s) can be retrieved from* '''File Names''' - name of the files to be loaded via the Autoloader ===SOAP===[[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 <!--see ticket 18426 - autoloader FTP settings-->* '''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===<!--Upgrade May 2018 - Ticket#62753-->[[Image:External-OData1.PNG]]* '''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:
