Write a Simple Go Application to work with Paylocity Data on Linux

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Paylocity ODBC Driver

The Paylocity ODBC Driver is a powerful tool that allows you to connect with live data from Paylocity, directly from any applications that support ODBC connectivity.

Access Paylocity data like you would a database - read, write, and update Paylocity FALSE, etc. through a standard ODBC Driver interface.



Use the CData ODBC Driver for Paylocity and unixODBC to create a simple Go app with live connectivity to Paylocity data.

Go is an open source programming language that enables you to easily build software on Linux/UNIX machines. When Go is paired with the ODBC Driver for Paylocity and unixODBC you are able write applications with connectivity to live Paylocity data. This article will walk you through the process of installing the ODBC Driver for Paylocity, configuring a connection using the unixODBC Driver Manager, and creating a simple Go application to work with Paylocity data.

Using the CData ODBC Drivers on a Unix/Linux Machine

The CData ODBC Drivers are supported in various Red Hat-based and Debian-based systems, including Ubuntu, Debian, RHEL, CentOS, and Fedora. There are also several libraries and packages that are required, many of which may be installed by default, depending on your system. For more information on the supported versions of Linux operating systems and the required libraries, please refer to the "Getting Started" section in help documentation (installed and found online).

Installing the Driver Manager

Before installing the driver, you need to be sure that your system has a driver manager. For this article, you will use unixODBC, a free and open source ODBC driver manager that is widely supported.

For Debian-based systems like Ubuntu, you can install unixODBC with the APT package manager:

$ apt-get install unixODBC unixODBC-dev

For systems based on Red Hat Linux, you can install unixODBC with yum or dnf:

$ yum install unixODBC unixODBC-devel

The unixODBC driver manager reads information about drivers from an odbcinst.ini file and about data sources from an odbc.ini file. You can determine the location of the configuration files on your system by entering the following command into a terminal:

$ odbcinst -j

The output of the command will display the locations of the configuration files for ODBC data sources and registered ODBC drivers. User data sources can only be accessed by the user account whose home folder the odbc.ini is located in. System data sources can be accessed by all users. Below is an example of the output of this command:

DRIVERS............: /etc/odbcinst.ini SYSTEM DATA SOURCES: /etc/odbc.ini FILE DATA SOURCES..: /etc/ODBCDataSources USER DATA SOURCES..: /home/myuser/.odbc.ini SQLULEN Size.......: 8 SQLLEN Size........: 8 SQLSETPOSIROW Size.: 8

Installing the Driver

You can download the driver in standard package formats: the Debian .deb package format or the .rpm file format. Once you have downloaded the file, you can install the driver from the terminal.

The driver installer registers the driver with unixODBC and creates a system DSN, which can be used later in any tools or applications that support ODBC connectivity.

For Debian-based systems like Ubuntu, run the following command with sudo or as root: $ dpkg -i /path/to/package.deb

For systems that support .rpms, run the following command with sudo or as root: $ rpm -i /path/to/package.rpm

Once the driver is installed, you can list the registered drivers and defined data sources using the unixODBC driver manager:

List the Registered Driver(s)

$ odbcinst -q -d CData ODBC Driver for Paylocity ...

List the Defined Data Source(s)

$ odbcinst -q -s CData Paylocity Source ...

To use the CData ODBC Driver for Paylocity with unixODBC, you need to ensure that the driver is configured to use UTF-16. To do so, edit the INI file for the driver (cdata.odbc.paylocity.ini), which can be found in the lib folder in the installation location (typically /opt/cdata/cdata-odbc-driver-for-paylocity), as follows:

cdata.odbc.paylocity.ini

... [Driver] DriverManagerEncoding = UTF-16

Modifying the DSN

When the driver is installed, a system DSN should be predefined. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties. Additionally, you can create user-specific DSNs that will not require root access to modify in $HOME/.odbc.ini.

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.

/etc/odbc.ini or $HOME/.odbc.ini

[CData Paylocity Source] Driver = CData ODBC Driver for Paylocity Description = My Description OAuthClientID = YourClientId OAuthClientSecret = YourClientSecret RSAPublicKey = YourRSAPubKey Key = YourKey IV = YourIV

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Creating a Simple Go App for Paylocity Data

With the Driver Manager installed and the DSN configured, you are ready to create a simple Go application to work with your Paylocity data. To start, install a Go driver for ODBC databases. While there are several options available, this article will use the odbc driver found at https://github.com/alexbrainman/odbc.

Installing odbc on Linux

To install the odbc driver for Go, you will need to first ensure that you define the GOPATH environment variable:

export GOPATH=$HOME/golang/go

Once GOPATH is defined, you are ready to install the Go driver for ODBC databases:

$ go get github.com/alexbrainman/odbc

Now you are ready to create and execute a simple Go application.

Sample Go Application

The sample application issues a simple SQL SELECT query for Paylocity data and displays the results. Create the directory $GOPATH/src/cdata-odbc-paylocity and create a new Go source file, copying the source code from below.

cdata-odbc-paylocity.go

package main import ( _ "github.com/alexbrainman/odbc" "database/sql" "log" "fmt" ) func main() { db, err := sql.Open("odbc", "DSN=CData Paylocity Source") if err != nil { log.Fatal(err) } var ( firstname string lastname string ) rows, err := db.Query("SELECT FirstName, LastName FROM Employee WHERE EmployeeId = ?", "1234") if err != nil { log.Fatal(err) } defer rows.Close() for rows.Next() { err := rows.Scan(&firstname, &lastname) if err != nil { log.Fatal(err) } fmt.Println(firstname, lastname) } err = rows.Err() if err != nil { log.Fatal(err) } defer db.Close() }

In the terminal, navigate to the Go application directory and build the application:

$ go build

After the application builds, you will be able to execute the application, displaying your Paylocity data:

$ ./cdata-odbc-paylocity

At this point, you have a simple Go application for working with Paylocity data. From here, you can easily expand the application, adding deeper read/write functionality through familiar SQL queries.