Swipeclock Integration Setup
Swipeclock Integration — Database Setup
This article reviews the legacy Swipeclock integration and is here for reference purposes only. The newer Swipeclock TimeWorks Plus integration should be used for all live end clients.
ReadyPay Online (RPO) supports integration with Swipeclock that allows
for direct time importing and single sign-on (SSO) to their product.
Before these capabilities can be used, web services login information
needs to be entered into the dbo.SIntegrationProvider table. This
table contains external system settings that apply to all companies
that utilize integration/SSO capabilities from within RPO.
To enable the full Swipeclock integration with SSO, the following
records must be created/updated in the dbo.SIntegrationProvider
table.
| Field Name | Value | Description |
|---|---|---|
| Provider | Swipeclock | |
| IntegrationType | Timeclock | |
| Description | Integration with the Swipeclock web services | |
| MultipleConfigs | 1 | |
| ProviderSpec1 | <Vendor Username> | Vendor username provided by Swipeclock for connection through web services (sample value: "demopayrollsync") |
| ProviderSpec2 | <Vendor Password> | The password provided by Swipeclock for connection through web services (sample value: "g1n#L5xp") |
| ProviderSpec3 | This configuration option is not used | |
| ProviderSpec4 | This configuration option is not used |
| Field Name | Value | Description |
|---|---|---|
| Provider | Swipeclock | |
| IntegrationType | SSO | |
| Description | SSO integration with Swipeclock | |
| MultipleConfigs | 0 | |
| ProviderSpec1 | <Vendor Username> | Vendor username provided by Swipeclock for connection through web services (sample value: "demopayrollsync"). This is the same as the Timeclock integrationType entry above. |
| ProviderSpec2 | <Vendor Password> | The password provided by Swipeclock for connection through web services (sample value: "g1n#L5xp"). This is the same as the Timeclock integrationType entry above. |
| ProviderSpec3 | This configuration option is not used | |
| ProviderSpec4 | This configuration option is not used |
Single Sign On (SSO) — Company Setup
Adding SSO Service
In Company | Master Company Setup | Status & Services on RPO, add the SSO Service and set the Service Level to Swipeclock SSO.
Adding SSO Integration
In Company | Master Company Setup | Integrations on RPO, click ADD and select the SSO Integration Type and Swipeclock as the Provider from the pull-down menus on the right-hand side of the screen. The Configuration will remain Default. Click SAVE.
Once the Service and Integration are set up, users may click on the Time & Labor icon in the blue menu bar on RPO and will be taken to their Account Settings page. Users should add their Swipeclock login. Then click the SAVE SETTING button. A confirmation will be displayed at the top of the screen if successful.
Timeclock — Company Setup
Adding Timeclock Service
In Company | Master Company Setup | Status & Services on RPO, add the Timeclock Service and set the Service Level to Swipeclock integration.
Adding Timeclock Integration
In Company | Master Company Setup | Integrations on RPO, click ADD and enter the company ID in the Name field. Then select the Timeclock Integration Type and Swipeclock as the Provider from the pull-down menus on the right-hand side of the screen. Click SAVE.
In the Options sub-tab, review the following and pay close attention to required items marked with a red asterisk:
| Field Name | Value |
|---|---|
| IsClassic * | Mark if client is using the classic version of Swipeclock. |
| Site * | Enter the Swipeclock Site ID assigned to the client. |
| DefaultEmpFilter | Enter an Employee Filter to be used for filterable operations (i.e., employee updates for active employees only). |
| Department | Enter the applicable cost center level (CC1–CC5) that refers to the client's departments. |
| Location | Enter the applicable cost center level (CC1–CC5) that refers to the client's locations. |
| Send Clock Number | Mark to send clock numbers to Swipeclock in addition to the employee IDs. |
| TrimEmpID | Mark to remove extra spaces from the ReadyPay employee IDs (spaces due to justification during initial employee creation). |
| SendPayRate | Mark to send pay rates to Swipeclock. |
Adding Timeclock Integration Schedules
In Company | Master Company Setup | Integrations on RPO, find the Integration Schedules page. Click ADD and enter the following:
| Field Name | Description |
|---|---|
| Integration Type | Choose Timeclock. |
| Provider | Choose Swipeclock. |
| Config | Choose the entry set to the client's ID from the Timeclock Integration Setup that was created. |
| Action | Choose UpdateChangedEmployees to sync changes. |
| Run Every (secs) | Enter the number of seconds between syncing of employee changes. (It is recommended to perform this action every 60 minutes — 3,600 secs.) |
| Start Date | Choose a date and time in the future to begin the Integration action. |
Click SAVE when done. You may click the RUN ACTION NOW button to force the action to occur as a test. This will update the Last Run field and the Integration Schedule will be based off that time (and the Run Every (secs) field). The Last Action Date will populate when there are changes made due to the Integration Schedule (changes to EE data). The integration may be turned off at any time by unmarking the Active check box and clicking SAVE. Conversely, it can be turned back on by marking the same box.
Questions?
Contact your Payroll Service Provider.