Create an SAP BusinessObjects Universe on the CData ODBC Driver for Paylocity

This article shows how to create and publish an SAP BusinessObjects universe on the CData ODBC Driver for Paylocity. You will connect to Paylocity data from the Information Design Tool as well as the Web Intelligence tool.

Connect to Paylocity as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Create an ODBC Connection to Paylocity Data

This section shows how to create a connection to the Paylocity ODBC data source in the Information Design Tool. After you create a connection, you can analyze data or create a BusinessObjects universe.

1. Right-click your project and click New -> New Relational Connection.

2. In the wizard that is displayed, enter a name for the connection.

3. Select Generic -> Generic ODBC datasource -> ODBC Drivers and select the DSN.

4. Finish the wizard with the default values for connection pooling and custom parameters.

Analyze Paylocity Data in the Information Design Tool

In the Information Design Tool, you can use both published and local ODBC connections to browse and query data.

1. In the Local Projects view, double-click the connection (the .cnx file) to open the Paylocity data source.

2. On the Show Values tab, you can load table data and enter SQL queries. To view table data, expand the node for the table, right-click the table, and click Show Values. Values will be displayed in the Raw Data tab.

3. On the Analysis tab, you can drag and drop columns onto the axes of a chart.

👁 A chart in the Information Design Tool. (Salesforce is shown.)

Publish the Local Connection

To publish the universe to the CMS, you additionally need to publish the connection.

1. In the Local Projects view, right-click the connection and click Publish Connection to a Repository.

2. Enter the host and port of the repository and connection credentials.

3. Select the folder where the connection will be published.

4. In the success dialog that results, click Yes to create a connection shortcut.

Create a Universe on the ODBC Driver for Paylocity

You can follow the steps below to create a universe on the ODBC driver for Paylocity. The universe in this example will be published to a repository, so it uses the published connection created in the previous step.

1. In the Information Design Tool, click File->New Universe.

2. Select your project.

3. Select the option to create the universe on a relational data source.

4. Select the shortcut to the published connection.

5. Enter a name for the Data Foundation.

6. Import tables and columns that you want to access as objects.

7. Enter a name for the Business Layer.

👁 The BusinessObjects universe created on the ODBC data source. (Salesforce is shown.)

Publish the Universe

You can follow the steps below to publish the universe to the CMS.

1. In the Local Projects view, right-click the business layer and click Publish -> To a Repository.

2. In the Publish Universe dialog, enter any integrity checks before importing.

3. Select or create a folder on the repository where the universe will be published.

Query Paylocity Data in Web Intelligence

You can use the published universe to connect to Paylocity in Web Intelligence.

1. Open Web Intelligence from the BusinessObjects launchpad and create a new document.

2. Select the Universe option for the data source.

3. Select the Paylocity universe. This opens a Query Panel. Drag objects to the Result Objects pane to use them in the query.

👁 A query using Paylocity data objects in Web Intelligence. (Dynamics CRM is shown.)