Integrate Paylocity Data in Your Informatica Cloud Instance

Informatica Cloud allows you to perform extract, transform, and load (ETL) tasks in the cloud. With the Cloud Secure Agent and the CData JDBC Driver for Paylocity, you get live access to Paylocity data, directly within Informatica Cloud. In this article, we will walk through downloading and registering the Cloud Secure Agent, connecting to Paylocity through the JDBC Driver and generating a mapping that can be used in any Informatica Cloud process.

Informatica Cloud Secure Agent

To work with the Paylocity data through the JDBC Driver, install the Cloud Secure Agent.

1. Navigate to the Administrator page in Informatica Cloud 👁 Image
   
2. Select the Runtime Environments tab
3. Click "Download Secure Agent" 👁 Image
   
4. Make note of the Install Token 👁 Image
   
5. Run the installer on the client machine and register the Cloud Secure Agent with your username and install token 👁 Image
   

NOTE: It may take some time for all of the Cloud Secure Agent services to get up and running.

Connecting to the Paylocity JDBC Driver

With the Cloud Secure Agent installed and running, you are ready to connect to Paylocity through the JDBC Driver.

Adding the JDBC Driver to the Secure Agent Machine

1. Navigate to the following directory on the Secure Agent machine:

   %Secure Agent installation directory%/ext/connectors/thirdparty/

2. Create a folder and add the driver JAR file (cdata.jdbc.paylocity.jar) based on the type of mapping that you want to configure.

   For mappings, create the following folder and add the driver JAR file:

   informatica.jdbc_v2/common

   For mappings in advanced mode, also create the following folder and add the driver JAR file:

   informatica.jdbc_v2/spark

3. Restart the Secure Agent.

Connecting to Paylocity in Informatica Cloud

After installing the driver JAR file, you are ready to configure your connection to Paylocity in Informatica Cloud. Start by clicking the Connections tab and clicking New Connection. Fill in the following properties for the connection:

• Connection Name: Name your connection (i.e.: CData Paylocity Connection)
• Type: Select "JDBC_V2"
• Runtime Environment: Select the runtime environment where you installed the Secure Agent
• JDBC Driver Class Name: The name of the JDBC driver class: cdata.jdbc.paylocity.PaylocityDriver
• JDBC Connection URL: Set this to the JDBC URL for Paylocity. Your URL will look similar to the following:
  
  

  jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH;

  Set the following to establish a connection to Paylocity:

  • RSAPublicKey: Set this to the RSA Key associated with your Paylocity, if the RSA Encryption is enabled in the Paylocity account.

    This property is required for executing Insert and Update statements, and it is not required if the feature is disabled.

  • UseSandbox: Set to true if you are using sandbox account.
  • CustomFieldsCategory: Set this to the Customfields category. This is required when IncludeCustomFields is set to true. The default value for this property is PayrollAndHR.
  • Key: The AES symmetric key(base 64 encoded) encrypted with the Paylocity Public Key. It is the key used to encrypt the content.

    Paylocity will decrypt the AES key using RSA decryption.
    It is an optional property if the IV value not provided, The driver will generate a key internally.

  • IV: The AES IV (base 64 encoded) used when encrypting the content. It is an optional property if the Key value not provided, The driver will generate an IV internally.

  Connect Using OAuth Authentication

  You must use OAuth to authenticate with Paylocity. OAuth requires the authenticating user to interact with Paylocity using the browser. For more information, refer to the OAuth section in the Help documentation.

  The Pay Entry API

  The Pay Entry API is completely separate from the rest of the Paylocity API. It uses a separate Client ID and Secret, and must be explicitly requested from Paylocity for access to be granted for an account. The Pay Entry API allows you to automatically submit payroll information for individual employees, and little else. Due to the extremely limited nature of what is offered by the Pay Entry API, we have elected not to give it a separate schema, but it may be enabled via the UsePayEntryAPI connection property.

  Please be aware that when setting UsePayEntryAPI to true, you may only use the CreatePayEntryImportBatch & MergePayEntryImportBatchgtable stored procedures, the InputTimeEntry table, and the OAuth stored procedures. Attempts to use other features of the product will result in an error. You must also store your OAuthAccessToken separately, which often means setting a different OAuthSettingsLocation when using this connection property.

  Built-In Connection String Designer

  For assistance in constructing the JDBC URL, use the connection string designer built into the Paylocity JDBC Driver. Either double-click the .jar file or execute the .jar file from the command-line.

   java -jar cdata.jdbc.paylocity.jar
   

  Fill in the connection properties and copy the connection string to the clipboard.

  👁 Using the built-in connection string designer to generate a JDBC URL (Google Sheets is shown.)
  
• Username: Set this to a placeholder value (since Paylocity does not require a username)
• Password: Set this to a placeholder value (since Paylocity does not require a password)

👁 Configuring the Connection (Google Sheets is shown.

Create a Mapping for Paylocity Data

With the connection to Paylocity configured, we can now access Paylocity data in any Informatica process. The steps below walk through creating a mapping for Paylocity to another data target.

1. Navigate to the Data Integration page 👁 Image
   
2. Click New.. and select Mapping from the Mappings tab 👁 Image
   
3. Click the Source Object and in the Source tab, select the Connection and set the Source Type 👁 Selecting the Source Connection and Source Type
   
4. Click "Select" to choose the table to map 👁 Selecting the Source Object
   
5. In the Fields tab, select the fields from the Paylocity table to map 👁 Selecting Source Fields to map
   
6. Click the Target object and configure the Target source, table and fields. In the Field Mapping tab, map the source fields to the target fields. 👁 Selecting the Target Field Mappings
   

With the mapping configured, you are ready to start integrating live Paylocity data with any of the supported connections in Informatica Cloud. Download a free, 30-day trial of the CData JDBC Driver for Paylocity and start working with your live Paylocity data in Informatica Cloud today.