Create Paylocity-Connected Nintex Workflows

Nintex Workflow Cloud is a cloud-based platform where you can design workflows to automate simple or complex processes using drag-and-drop interactions — without writing any code. When paired with CData Connect Cloud, you get instant, cloud-to-cloud access to Paylocity data for business applications. This article shows how to create a virtual database for Paylocity in Connect Cloud and build a simple workflow from Paylocity data in Nintex.

CData Connect Cloud provides a pure, cloud-to-cloud interface for Paylocity, allowing you to build workflows from live Paylocity data in Nintex Workflow Cloud — without replicating the data to a natively supported database. Nintex allows you to access data directly using SQL queries. Using optimized data processing out of the box, CData Connect Cloud pushes all supported SQL operations (filters, JOINs, etc.) directly to Paylocity, leveraging server-side processing to quickly return the requested Paylocity data.

Configure Paylocity Connectivity for Nintex

Connectivity to Paylocity from Nintex is made possible through CData Connect Cloud. To work with Paylocity data from Nintex, we start by creating and configuring a Paylocity connection.

1. Log into Connect Cloud, click Connections and click Add Connection
2. Select "Paylocity" from the Add Connection panel
3. Enter the necessary authentication properties to connect to Paylocity.

   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.

4. Click Create & Test
5. Navigate to the Permissions tab in the Add Paylocity Connection page and update the User-based permissions.

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

1. Click on your username at the top right of the Connect Cloud app and click User Profile.
2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
3. Give your PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured, you are ready to connect to Paylocity data from Nintex Workflow Cloud.

Connect to Paylocity from Nintex

The steps below outline creating a new connection to Paylocity data from Nintex (via Connect Cloud).

1. Log into Nintex Workflow Cloud
2. In the Connections tab, click "Add new"
3. Select "Microsoft SQL Server" as the connector and click "Connect"
4. In the SQL Server connection wizard, set the following properties:
   • Connection Name: a Connect Cloud
   • Username: a Connect Cloud username (e.g. user@mydomain.com)
   • Password: the Connect Cloud user's PAT
   • Database Host: tds.cdata.com
   • Database Name: the Paylocity connection (a.g., Paylocity1)
5. Click "Connect"
6. Configure the connection permissions and click "Save permissions"

Create a Simple Paylocity Workflow

With the connection to CData Connect Cloud configured, we are ready to build a simple workflow to access Paylocity data. Start by clicking the "Create workflow" button.

Configure the Start Event Action

1. Click the start event task and select the "Form" event
2. Click "Design form"
3. Drag a "Text - Long" element onto the Form and click the element to configure it
   • Set "Title" to "Enter SQL query"
   • Set "Required" to true
4. Drag a "Text - Short" element onto the Form and click the element to configure it
   • Set "Title" to "Enter desired result column"
   • Set "Required" to true

Configure an "Execute a Query" Action

1. Add an "Execute a query" action after the "Start event: Form" action and click to configure the action
2. Set "SQL Script" to the "Enter SQL Query" variable from the "Start event" action
3. Set "Column to retrieve" to the "Enter desired result column" variable from the "Start event" action
4. Set "Retrieved column" to a new variable (a.g., "values")

Configure a "Send an Email" Action

1. Add a "Send an email" action after the "Execute a query" action and click to configure the action
2. Set the "Recipient email address"
3. Set the "Subject"
4. Set the "Message body" to the variable created for the retrieved column

Once you configure the actions, click "Save," name the Workflow, and click "Save" again. You now have a simple workflow that will query Paylocity using SQL and sand an email with the results.

To learn more about live data access to 100+ SaaS, Big Data, and NoSQL sources directly from your cloud applications, check out the CData Connect Cloud page. Sign up for a free trial and reach out to our Support Team if you have any questions.