Paychex¶
Paychex is a provider of Human Resources (HR) software and services. This HR system is designed to streamline HR processes and provide a centralized platform for managing employee data and HR functions.
Getting Your HR Data¶
Hire2Retire utilizes OAuth 2.0 authentication method to connect with Paychex.
To set up Paychex as an HR system on Hire2Retire, follow these steps:
Set up a Paychex Integration Application¶
Note: These steps are common for both Paychex production and sandbox environment setup.
-
Log into your Paychex admin account.
-
Click the triple bar icon in the top left corner of the dashboard and Navigate to the
Company Settings
page.Figure 1. Paychex Company Settings -
Select
Integrated apps
.Figure 2. Integrated Apps -
Click on
Create app
button and fill in all required application information.Figure 3. Create an integration app -
In the Access settings, enable read-only access for
Company and worker APIs
.Figure 4. Data Access Settings -
Check the box next to
I have read and agree to the Third Party Terms of Use
, and then click Save. -
After saving, you will get your API key and Secret. Please keep these details safe, as they are necessary for establishing the connection on Hire2Retire.
Figure 5. Paychex Application
Create Paychex Connection on Hire2Retire¶
Hire2Retire requires the following details to create a connection to your Paychex Account:
-
Connection Name - A user defined nomenclature for your connection. By default, the connection name is "Connection-OAuth-1", you can change the name as per your preferences.
-
Environment - The specific type of Paychex account, such as Production, Sandbox, or Mock Server.
-
Client ID - This is the API key generated when you set up a Paychex integration app. You can also find your Client ID in the integrated apps section on Paychex.
-
Client Secret - This is the secret generated when you set up a Paychex integration app. You can also regenerate it in the integrated apps section on Paychex.
Once you have the necessary details, Go to the Connection Step on Hire2Retire and enter the connection details for Paychex. Then, click the Link Account
button.
Configuration¶
Once you have successfully configured the connections, you can continue with the Design section to configure the rest of the workflow following these steps in order.
- HR Data Definition (Paychex API Integration)
- Lifecycle Business Rules
- Employment Status
- HR to AD Profile Map
- Organizational Unit Assignment - Only defined in on-premise Active Directory
- Security Group Assignment
- Distribution List Assignment
Deployment¶
Once your workflow has been setup, you have two optional features you can setup before deploying it.
Otherwise, you can proceed to deploy and test it on the Hire2Retire platform, see Deploy and Test Flow