Migrating data from Paylocity to Snowflake using CData SSIS Components.

Snowflake is a leading cloud data warehouse and a popular backbone for enterprise BI, analytics, data management, and governance initiatives. Snowflake offers features such as data sharing, real-time data processing, and secure data storage which makes it a common choice for cloud data consolidation.

The CData SSIS Components enhance SQL Server Integration Services by enabling users to easily import and export data from various sources and destinations.

In this article, we explore the data type mapping considerations when exporting to Snowflake and walk through how to migrate Paylocity data to Snowflake using the CData SSIS Components for Paylocity and Snowflake.

Data Type Mapping

Special Considerations

• Casing: Snowflake enforces an exact case match by default for identifiers, so it is common to run into issues that can be attributed to mismatched casing. Set the IgnoreCase property to True in your CData SSIS Components for Snowflake connection to resolve these issues. This property directly maps to the QUOTED_IDENTIFIERS_IGNORE_CASE property in Snowflake and specifies whether Snowflake will treat identifiers as case-sensitive.

• Timestamps: Snowflake supports three timestamp types:

  • TIMESTAMP_NTZ: This timestamp stores UTC time with a specified precision. However, all operations are performed in the current session's time zone, controlled by the TIMEZONE session parameter.
  • TIMESTAMP_LTZ: This timestamp stores "wallclock" time with a specified precision. All operations are performed without taking any time zone into account.
  • TIMESTAMP_TZ: This timestamp stores UTC time together with an associated time zone offset. When a time zone isn't provided, the session time zone offset is used.

  By default the CData SSIS Components write timestamps to Snowflake as TIMESTAMP_NTZ unless manually configured.

Prerequisites

• Visual Studio 2022
• SQL Server Integration Services Projects extension for Visual Studio 2022
• CData SSIS Components for Snowflake
• CData SSIS Components for Paylocity

Create the project and add components

1. Open Visual Studio and create a new Integration Services Project. 👁 Create the SSIS project
   
2. Add a new Data Flow Task to the Control Flow screen and open the Data Flow Task.
3. Add a CData Paylocity Source control and a CData Snowflake Destination control to the data flow task. 👁 Add the source and destination controls (Salesforce is shown)
   

Configure the Paylocity source

Follow the steps below to specify properties required to connect to Paylocity.

1. Double-click the CData Paylocity Source to open the source component editor and add a new connection. 👁 Open the source component editor (Salesforce is shown)
   
2. In the CData Paylocity Connection Manager, configure the connection properties, then test and save the connection.

   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. 👁 Configure the source connection (Salesforce is shown)
   

3. After saving the connection, select "Table or view" and select the table or view to export into Snowflake, then close the CData Paylocity Source Editor. 👁 Select the table to export (Salesforce is shown)
   

Configure the Snowflake destination

With the Paylocity Source configured, we can configure the Snowflake connection and map the columns.

1. Double-click the CData Snowflake Destination to open the destination component editor and add a new connection. 👁 Open the destination component editor
   
2. In the CData Snowflake Connection Manager, configure the connection properties, then test and save the connection.
   • The component supports Snowflake user authentication, federated authentication, and SSL client authentication. To authenticate, set User and Password, and select the authentication method in the AuthScheme property. Starting with accounts created using Snowflake’s bundle 2024_08 (October 2024), password-based authentication is no longer supported due to security concerns. Instead, use alternative authentication methods such as OAuth or Private Key authentication.

   Other helpful connection properties

   • QueryPassthrough: When this is set to True, queries are passed through directly to Snowflake.
   • ConvertDateTimetoGMT: When this is set to True, the components will convert date-time values to GMT, instead of the local time of the machine.
   • IgnoreCase: A session parameter that specifies whether Snowflake will treat identifiers as case sensitive. Default: false(case is sensitive).
   • BindingType: There are two kinds of binding types: DEFAULT and TEXT. DEFAULT uses the binding type DATE for the Date type, TIME for the Time type, and TIMESTAMP_* for the Timestamp_* type. TEST uses the binding type TEXT for Date, Time, and Timestamp_* types.
   👁 Configure the destination connection
   
3. After saving the connection, select a table in the Use a Table menu and in the Action menu, select Insert. 👁 Choose the destination table
   
4. On the Column Mappings tab, configure the mappings from the input columns to the destination columns. 👁 Map the columns (Salesforce is shown)
   

Run the project

You can now run the project. After the SSIS Task has finished executing, data from your SQL table will be exported to the chosen table.