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.
Note: Contributor - Manju Kumari
Understanding the Integration between EIC and Paychex Flex
Preface
This guide describes the integration between Saviynt Enterprise Identity Cloud (EIC) and Paychex Flex.
Audience
This guide is intended for administrators and target system integration teams responsible for integrating and importing users from Paychex Flex.
Introduction
Paychex Flex is a cloud-based human resource management and payroll software platform offered by Paychex, Inc., a company that specializes in providing payroll and human resource services to businesses. Paychex Flex is designed to help businesses manage their payroll, HR, benefits, and other related tasks more efficiently.
Some key features of Paychex Flex include:
Payroll Processing: It allows businesses to process payroll, calculate taxes, and handle direct deposits. It can also generate pay stubs and tax forms.
Time and Attendance: Paychex Flex offers time and attendance tracking to monitor employee work hours, paid time off, and scheduling.
HR Management: The platform helps with HR functions like employee onboarding, HR compliance, document storage, and reporting.
Benefits Administration: It assists in managing employee benefits, such as health insurance and retirement plans.
Employee Self-Service: Employees can access their pay stubs, tax forms, and other information through a self-service portal.
Reporting and Analytics: It provides various reporting and analytics tools to help businesses gain insights into their HR and payroll data.
Mobile Accessibility: Paychex Flex offers a mobile app, making it easy for employees and administrators to access the system on the go.
The specific features and capabilities of Paychex Flex may vary depending on the subscription plan and customization options chosen by the business. It's a popular choice among small and medium-sized businesses looking for an integrated solution to manage their payroll and HR needs.
Paychex Flex is known for its user-friendly interface and the ability to provide a holistic view of HR and employee management in one system. It's designed to help businesses of various sizes and industries streamline their HR and administrative processes.
The REST connector enables you to create an integration with Paychex Flex 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 Paychex Flex (REST-based) connector for performing operations listed in the Supported Features.
Supported Features
The Paychex Flex integration supports the following features:
Supported Software Versions
Software | Version |
EIC | Release v4.5 and later |
Understanding the Integration between EIC and Paychex Flex
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:
Paychex Flex 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 Paychex Flex integration.
Integration Architecture
EIC uses a REST connection for integrating with Paychex Flex for importing users. The REST connection uses the REST protocol to communicate with the REST interface of Paychex Flex.
The following diagram illustrates the connector architecture and communication with the target application.
Figure: Paychex Flex Integration Architecture
Configuring a Connection
Prerequisites
Your application will be given an API key and secret which are necessary for the making the authentication call. The authentication call with allow Paychex to authorize consumption of the Flex API. (for clients) the API key will be generated automatically when you create your application within Paychex Flex, Company Settings, Connected Applications.
Using your Key/Secret
Your application's key is the like a username and the secret as a password.
After making the Authorization call using the key/secret, a bearer token will be generated. This is like a session to verify who you are when making requests.
Your credentials MUST be provided in the 'request body'
If you have an application that is authorized to multiple client accounts, you can use the same key and secret between them.
Access tokens have a short life span. By default, access tokens expire in 60 minutes.
Response headers will let you know how much time you have left on the token. You will need to regenerate using the authentication endpoint to create a new bearer token (no refresh is available).
Treat your secret API keys as you would any other password. Grant access only to those who need it. Your client credentials carry many privileges, so be sure to keep them secure!
Using the generated bearer token
When you make a call to a Paychex API resource end point, you need to provide an active bearer token within the 'Body' of your request.
Creating a Connection
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.
Understanding the Configuration Parameters
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.
Configuration Parameters for User Import
The connector uses the following parameters for creating a connection and for importing users from the target application:
Connection Parameters
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.
| Use the following format to connect to the Paychex Flex application: | Yes |
Import Parameters
Parameter | Description
| Recommended Configuration | Mandatory? |
UserImport JSON | Specify this parameter to import the users. | Use the following format to import users using the Paychex Flex application: Refer to the Connection Package |
Yes |
Using the Paychex Flex Integration
You can use the Paychex Flex integration for performing user import after configuring it to meet your requirements.
Guidelines for Using the Integration
To configure import, map all Paychex Flex attributes to EIC user attributes using UserImport JSON.
Configuring Import Operations
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 full import, the invoke API gets 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 Paychex Flex 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.
Troubleshooting
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.
