06/02/2023 12:55 AM - edited 06/02/2023 01:06 AM
Disclaimer
The integration was either created by Saviynt or by Saviynt community users. The integration is available “as is” and falls under standard connectors support for REST, SOAP, JDBC, LDAP, PowerShell, Jar and Saviynt Connector Framework.
This guide describes the integration between Saviynt Enterprise Identity Cloud (EIC) and Paylocity.
This guide is intended for administrators and target system integration teams responsible for integrating and importing users from Paylocity.
Paylocity provides cloud-based payroll and human capital management (HCM) software solutions for businesses of all sizes. Their software platform is designed to streamline and automate various aspects of HR and payroll processes, helping organizations manage their workforce more efficiently.
The REST connector enables you to create an integration with Paylocity for importing users to Saviynt EIC as an HR Identity source. For more information about different connectors in EIC, see Saviynt Enterprise Identity Cloud Connectors.
Note: This guide provides information about using the Paylocity (REST-based) connector for performing operations listed in the Supported Features.
The Paylocity integration supports the following features:
Software | Version |
EIC | Release v4.5 and later |
You must create an integration between EIC and the collaboration platform hosted by the target application to perform import tasks. The following components are involved in the integration:
Paylocity is the target application that is integrated with the EIC through the REST connector to import the users.
The REST connector enables communication between EIC and the target application. It provides a simplified integration mechanism where in some instances you only need to create a connection with minimal connectivity information for your target application. The REST connector is used for importing users through the REST APIs. For more information about creating a connection, see Creating a Connection.
Job Scheduler is a software component that executes a job based on the configured schedule to perform import operations from EIC. For more information about the jobs used by the connector in the Paylocity integration.
EIC uses a REST connection for integrating with Paylocity for importing users. The REST connection uses the REST protocol to communicate with the REST interface of Paylocity.
The following diagram illustrates the connector architecture and communication with the target application.
Figure: Paylocity Integration Architecture
Paylocity will provide the secure client credentials and set up the scope (type of requests and allowed company numbers). You will receive the unique client id, secret, and Paylocity public key for the data encryption. The secret will expire in 365 days.
Paylocity will send you an e-mail 10 days prior to the expiration date for the current secret. If not renewed, the second e-mail notification will be sent 5 days prior to the secret's expiration. Each email will contain the code necessary to renew the client secret.
You can obtain the new secret by calling the API endpoint using your current not yet expired credentials and the code that was sent with the notification email. For details on the API endpoint, please see the Client Credentials section.
Both the current secret value and the new secret value will be recognized during the transition period. After the current secret expires, you must use the new secret.
If you were unable to renew the secret via the API endpoint, you can still contact Service and they will email you a new secret via secure email.
For more information check this link.
Connection refers to the configuration setup for connecting EIC to target applications. For more information about the procedure to create a connection, see Creating a Connection.
While creating a connection, you must specify connection parameters that the connector uses to connect with the target application, define the type of operations to perform, the target application objects against which those operations are performed, and the frequency of performing them. In addition, you can view and edit attribute mappings between EIC and the target application.
The connector uses the following parameters for creating a connection and for importing users from the target application:
Parameter | Description | Example Configuration | Mandatory? |
Connection Name | Specify the name to identify the connection. | - | Yes |
Connection Description | Specify the description for the connection. | - | No |
Connection Type | Select the connection type as REST. | - | Yes |
Default SAV Role | Specify this parameter to assign the SAV role for the connection. The SAV role is a role in EIC that assigns specific access to users. This parameter is valid only for importing users. Sample value: User assigned with the ROLE_ADMIN role, has access to all the sections of EIC. | - | No |
Email Template | Specify this parameter to select an email template for sending notifications. Email templates provide immediate trigger of emails to a user based on actions performed. Email informs user about the action performed and if critical, needs immediate action from the user. | - | No |
ConnectionJSON | Specify this parameter to create a connection.
|
| Yes |
Parameter | Description | Recommended Configuration | Mandatory? |
UserImport JSON | Specify this parameter to import the users. |
|
Yes |
UpdateUserJSON | Specify this parameter to update the users. |
| Yes |
You can use the Paylocity integration for performing user import after configuring it to meet your requirements.
To configure import, map all Paylocity attributes to EIC user attributes using UserImport JSON.
Full User import: When configuring the connection for the first time, first perform the full import to import all existing Users from the target application to EIC. To perform the full import, the invoke API gets the response from the target application and maps the attributes in the target application with attributes in EIC.
The import jobs are automatically created in EIC after you create a connection for the Paylocity integration.
To import users:
Specify the connection and import parameters.
Note: Ensure that the connection type is selected as REST.
Configure the User Import via a Connection (UserImportJob) to import users. For more information about creating jobs, see Data Jobs.
To troubleshoot common problems with connectors, answer frequently asked questions, and provide solutions to a few common issues you might encounter while configuring or working with connectors, see Common Troubleshooting Guide for Connectors.
To troubleshoot common problems or obtain answers to frequently asked questions for REST connectors, see the REST Connector Guide.