ADP Integration Settings

To be able to use integration of Lanteria HR with ADP Workforce Now, it must be configured first. This topic is aimed at Lanteria HR administrators who will be configuring integration with ADP Workforce Now on the Lanteria HR side.

To configure integration with ADP Workforce Now

1. In Lanteria HR, go to Settings > Settings and Configuration > Integrations > ADP Integration.
2. On the Basic tab, fill in the fields as described below.
   • Enabled – Select this check box to enable integration of Lanteria HR with ADP Workforce Now or clear this check box to temporarily disable the integration.
   • ADP Client ID – Specifies the unique client ID. This globally unique identifier (GUID) is automatically generated after the ADP customer acquires the Lanteria HR Data Connector. After the Data Connector has been purchased, the Lanteria HR administrator can view the client ID in the Lanteria HR database (client_id), and then specify it in this field.
   • ADP Client Secret – Specifies the unique client secret GUID. This GUID is automatically generated after the ADP customer acquires the Lanteria HR Data Connector. After the Data Connector has been purchased, the Lanteria HR administrator can view the client secret in the Lanteria HR database (client_secret), and then specify it in this field.
   • ADP Service Url – Specifies the URL of the service that will be used for integration with ADP Workforce Now. At present, the following ADP service URL should be specified: https://adpconnector.lanteriaonline.com
3. Select Edit next to Field Mapping to review and reconfigure, if necessary, field mapping between Lanteria HR and ADP Workforce Now. This field mapping defines which employee-related fields in Lanteria HR correspond to which worker (employee-related) fields in ADP Workforce Now so that the LHR - ADP Integration job in could retrieve workers (employees) data from ADP Workforce Now and create or update employees, or employee-related information, in Lanteria HR properly. By default, this mapping is pre-configured, but it can be changed if need be.

   

   If you need to change field mapping, you can use the following actions:

   • Add New Mapping Table - Adds a new mapping table with a new set of mapping records. This is useful when you want to update information with data from ADP workers in a Lanteria HR list other than the Employees list – you can create a mapping to another list and update it through lookup.
   • Save - Saves the changes.
   • Add New Mapping Record - Adds a new mapping records to an existing mapping table.
   • Delete Mapping Table - Deletes the mapping table.
   • Delete - Deletes the mapping record.
   You can configure the following settings for a mapping table:
   • ADP API Name - Specifies the name of the API on the ADP side that will be used to transfer data according to this mapping table.
   • Lanteria List Name - Specifies the name of a list in Lanteria HR the fields in which will be updated according to this mapping table.
   • Lanteria Key Field - Specifies the key field that will be used to identify which Lanteria list must be updated. Next to this setting, specify the field type:
     • String - The specified Lanteria key field will be used to directly update the list, specified in the Lanteria List Name setting.
     • Lookup - The specified Lanteria key field will be used to update the list, specified in the Lanteria List Namesetting, through a lookup. With this type, you must also configure the following two settings:
       • Lookup Table Name - Specifies the name of the lookup table that will be used to identify the Lanteria HR list that must be updated if the type of the Lanteria key field is set to Lookup.
       • Lookup Field Name - Specifies the name of the lookup field that will be used to identify the Lanteria HR list that must be updated if the type of the Lanteria key field is set to Lookup.
   • ADP Key Field - Specifies the key field on the ADP side that will be used to idenify the entity to take data from. At present, only the Workers entity can be used.
   • ADP API Endpoint - Specifies the API endpoint that will be used to transfer data according to this mapping table.
   If you need to add or change a mapping record, fill in the columns as described below:
   • Lanteria Field Name - Specifies the internal name of the field into which value will be retrieved during employee data synchronization from the corresponding field in ADP, specified in the ADP Response Json Path column.
   • ADP Response Json Path -Specifies the response JSON path to a field in ADP, the value from which will be retrieved during employee data synchronization into the employee field specified in the Lanteria Field Name column. The asterisk symbol * in a path indicates that there is an array (in this case, you may need an additional expression to retrieve a proper value, which you can specify in the Additional Expression column).
   • Field Type - Specifies the type of field on this map record. For example, String, Lookup, Date, or Choice.
   • Lookup Table Name - Specifies the name of the lookup table in Lanteria HR for the field, specified in the Lanteria Field Name column on this mapping record. This column must be filled in if the field type is Lookup.
   • Lookup Relation Field Name - Specifies the name of the field, which is used to establish a lookup relation. This column must be filled in if the field type is Lookup.
   • Add lookup Item if Does Not Exist - Select this check box if you want the lookup item to be added automatically in case it is not specified here, but present in the corresponding ADP field, from which value is retrieved. This check box can be selected for fields with type Lookup.
   • Error if Does Not Exist -  Specifies whether an error should occur in case the corresponding ADP field does not contain any value. It is recommended that this check box is selected for Lanteria HR fields that are vital for proper work of the system (for example, Job Role, Org Unit, etc.).
   • Additional Expression - Specifies an expression that will be used as an additional filter to retrieve a value. This additional expression may be useful if there is an array present in the ADP response JSON path (an array is marked by the asterisk symbol *). In an expression, you can specify that a certain field must be set to a specific value, and also specify the index of the array (the number after a semicolon) that must be used to retrieve a value. For example, the expression primaryIndicator=true;0 means that the primaryIndicator check box must be selected and the first element of the array (indicated by the zero number after the semicolon) should be used.
4. Select Test Connection to test connection with the ADP server. If the connection test fails, verify that you configured the settings properly.
5. Select Apply Changes save and apply the integration settings.