Payroll Contribution Integrations

Payroll Contribution Integrations

You can run your Payroll Contribution integration files from within the Integrations Dashboard.

The Integrations Dashboard enables you to run and view the results of integrations between UKG Pro products and other business partners. The Integrations Dashboard is the first page that appears when you log in to the Integration Platform. There are two main components to the Integrations Dashboard, the Integrations and Events pages.

Displays Integrations Dashboard Example Text

Access the Integrations Dashboard

From within Role Administration, you must first assign web access rights to the appropriate user roles in UKG Pro (Menu > System Configuration > Security > Role Administration > Select a Role > Web Access Rights > Integration Platform). Check the View and Edit access boxes so that users assigned to the role can access the integration.

Displays Web Access Rights menu

To access the Integrations Dashboard:

https://integrations.ultipro.com/

  1. At the Sign In page, enter your Company Access Code or Customer API Key. You can locate this information in UKG Pro > System Configuration > Security > Service Account Administration.

  2. Check the I Agree to Terms and Conditions (Required) box.

  3. Select Continue.
    Note Multi-factor authentication (MFA) is required the first time you log in.
  4. Complete the multi-factor authentication steps, as applicable.

  5. Enter your UKG Pro credentials.

  6. Select Sign In. The Integrations Dashboard displays.

Run a Payroll Contribution Integration

The Integrations Dashboard allows you to run an integration manually, monitor the status of the integration, and view the integration status.

Integrations Dashboard Example 2
  1. From the Integrations page, locate your carrier's integration for Payroll Contribution.
  2. Hover your mouse over the integration to display additional action item icons.
  3. Select the Run icon. The Integration run page displays.
    Displays Run Principal Contribution example
  4. At the Date Range section, select the date that should be included in the output as the Start Date and End Date. For example, if the
    • Check date is 01/05/2021, enter 01/05/2021 as both the Start Date and the End Date.

    • Check dates are 01/05/2021 thru to 01/15/2021, enter 01/05/2021 as the Start Date and 01/15/2021 as the End Date.
  5. At the Notifications section, to receive a notification email, you can enter one or more email addresses and select from these notification options: Start, Success, or Failure. Multiple email addresses must be separated by a comma.
  6. From the Pay Group drop-down list, select one or more pay groups to include in this integration run.
  7. At the Options section, select either Test or Production based on the file type the carrier is expecting for this integration. This indicator may be used in the file name and/or in the file header.
  8. At the File Output section, check the Send to Carrier box to enable the Location selection options. These options vary by carrier. You may see either:
    • One server listed that receives both Test and Production files.

    • Two servers listed - a Test server and a separate Production server.
      Important Always confirm that the correct file type Option and Location are selected before moving on. Otherwise, if the Test file type is selected and a Production server is selected, then a Test file could be processed through a Production environment.
  9. From the Payroll Sequence drop-down list, the default selection is All. You can choose to either run an integration for only the regular payroll or you can choose to include supplemental payrolls, as applicable.
    • To run the integration for only the regular payroll, uncheck the All box. Then, check only the 1 box.

    • To include supplemental payrolls, uncheck the All box. Then check the boxes 2 thru 9, as applicable.

  10. Select Run. The Integrations page displays.
  11. Select the Events page to view the integration.
    • Select the link in the Event Date/Time column to view the event details.

    • Select the link in the Event Status column to view the file details.

      Integrations Dashboard Example 3

Re-Run an Integration

You may need to re-run an integration in the event that an integration failed or was not received by the vendor.

  1. From the Events tab, search for the integration that you need to re-run.
  2. Select the Event Date/Time link for that integration. The Event Details page displays.
  3. Select the Actions drop-down menu and then select the Re-Run Integration option. Re-Run an Integration
    Note We recommend that you enter a Support Case if you attempted to re-run the integration twice and it continues to fail.