Manage, Run, or Schedule Integrations

Integration Hub Integration Hub exchanges and maps data between applications in a cloud-computing environment. exchanges and maps data between applications in a cloud-computing environment. It supports multiple tenants and requires no customer installation of additional software, hardware, or network infrastructure. You can run integrations on-demand or scheduled.

  1. Select the integration. Do one of the following:
    • Run an integration when you are alerted to do so:
      1. Click Tap Notifications  . The number on the button indicates the number of active notifications. 
      2. In Categories, select Integrations.
      3. Select the integration.
    • Run an integration at any time:
      1. Click Tap Main Menu  > Maintenance > Integrations. 
      2. Click Tap Run an Integration  . 
      3. Select the integration from the list. Click Tap Select. 
      4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, you will use the default name, which ends with a date and time stamp. 
  2. Set parameters

    Select or enter any parameters or files that are required. Integrations have different required and optional parameters or links to external files.

  3. Run the integration
    1. Select Run Integration.
    2. Wait for the confirmation that the integration completed or failed. Close the panel.
    3. Click Tap Refresh  .

    4. Check the status indicators:

      •  In-progress: The run of this integration has not yet completed.
      •  Completed: The integration ran successfully without errors.
      •  Scheduled: This integration is scheduled to run later or repeatedly.
      • (Greyed out) Scheduled but Deleted: This integration is scheduled to run, but the integration template has been deleted. When it runs, it will trigger an error. To prevent this error, delete the scheduled integration run.
      •  Completed with Errors: The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set A sequence of integrations that can be run on-demand or be scheduled., the integration set stops.
      •  Failed: The integration run has errors or could not run.
      • To troubleshoot and resolve errors, do the following:

        Check the Run Summary for details.

    5. To see details, select the integration. Select Run Summary.
  1. Select the integration set. Do one of the following:
    • Run an integration set when you are alerted to do so:
      1. Click Tap Notifications  . The number on the button indicates the number of active notifications. 
      2. In Categories, select Integrations.
      3. Select the integration set.
    • Run an integration set at any time:
      1. Click Tap Main Menu  > Maintenance > Integrations. 
      2. Click Tap Run an Integration  . 
      3. In Select Integration, click tap Integration Sets. 
      4. Select an integration set from the list. Click Tap Select. 

      5. (Optional) Enter a unique Integration Run Name to identify the run of the integration set.

        Tip: Include "IntegrationSet" in the name to make it easier to distinguish integrations from integration sets on the Integrations page.

        Otherwise, you will use the default name, which ends with a date and time stamp.

  2. Set parameters for each integration in the set:

    Select or enter any parameters or files that are required. Integrations have different required and optional parameters or links to external files.

  3. Run the integration set:
    1. Select Run Integration.
    2. Wait for the confirmation that the integration has completed or failed. Close the panel.
    3. Click Tap Refresh . 
    4. To see details, select the integration. Select Run Summary.

You can schedule integrations to run once later or at a recurring frequency.

  1. Click Tap Main Menu  > Maintenance > Integrations.
  2. Click Tap Schedule Processes .

    Note: If you don't see this button, click tap Run Processes to toggle the labels.

  3. Click Tap Schedule an Integration .
  4. Select the integration or integration set from the list. Click Tap Select.
  5. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, you will use the default name, which ends with a date and time stamp.
  6. Select or enter any parameters or files that are required. Integrations have different required and optional parameters or links to external files.

  7. In Schedule, select one of the following:

    Caution: Although integrations run in parallel and independently, if you schedule the same integration or integration set to run repeatedly at short intervals, errors can result. Also frequent runs increase the traffic load on the network. A best practice is to space runs at least 15 minutes apart. For example: If two integrations access and update a file, the first integration must finish the update before the second integration starts to update the same file. If the first integration moves or erases that file before the second can access it, the second integration fails.

    • One-time Scheduled Run

      1. Select a date .
      2. Click Tap Apply.
      3. Enter the Start Time.
      4. Click Tap Schedule Integration.
      5. Close the panel.

    • Recurring Scheduled Run

      Repeat the run on a regular schedule.

      1. Click Tap Recurrence .
      2. From Repeats, select the frequency of runs:

        By Month

        • Select the months.
        • Select the day of the month.

        By Day – Select the number of days between runs.

        By Hour – Select the number of hours between runs.

        By Week

        • Select the number of weeks between runs.
        • Select the day of the week.

        By Minute – Select 5-minute intervals.

      3. Select the Start Date.
      4. Enter the Start Time.
      5. Select the End Date. If you select Forever or leave the End Date blank, the schedule recurs indefinitely.
      6. Click Tap Apply.
      7. Click Tap Schedule Integration Request.
      8. Close the panel.
  8. Repeat for other integrations.

Scheduled integration sets can run once later or at a recurring frequency.

  1. Click Tap Main Menu  > Maintenance > Integrations.
  2. Click Tap Schedule Processes  .

    Note: If you don't see this button, click tap Run Processes to toggle the labels.

  3. Click Tap Schedule an Integration  .
  4. Select an integration set from the list. Click Tap Select.
  5. (Optional) Enter a unique Integration Run Name to identify the run of the integration set. Otherwise, you will use the default name, which ends with a date and time stamp.

    Note: Include "IntegrationSet" in the name to make it easier to distinguish integrations from integration sets on the Integrations page.

  6. For each integration in the set:

    Select or enter any parameters or files that are required. Integrations have different required and optional parameters or links to external files.

  7. Caution: Although integrations run in parallel and independently, if you schedule the same integration set to run repeatedly at short intervals, errors can result. Also frequent runs increase the traffic load on the network. A best practice is to space runs at least 15 minutes apart. For example: If two integration sets access and update a file, the first integration set must finish the update before the second integration set starts to update the same file. If the first integration set moves or erases that file before the second can access it, the second integration set fails.

    In Schedule, select either:

    • One-time scheduled run

      1. Select a date  .
      2. Click Tap Apply.
      3. Select the Start Time.
      4. Click Tap Schedule Integration.
      5. Close the panel.

    • Recurring scheduled run

      Repeat the run of the integration set on a regular schedule.

      1. Click Tap Recurrence  .
      2. From Repeats, select the frequency of runs:

        By Month

        • Select the months.
        • Select the day of the month.

        By Day – Select the number of days between runs.

        By Hour – Select the number of hours between runs.

        By Week

        • Select the number of weeks between runs.
        • Select the day of the week.
      3. Select the Start Date.
      4. Select the Start Time.
        Caution:

        Daylight savings time

        For scheduled events, the scheduled time is now adjusted for daylight savings time. The clock time remains as scheduled.

        Example: An integration that is scheduled to run at 4 am standard time, runs at 4 am daylight time, which is 60 minutes earlier than before the spring time change. For the autumn time change, this integration again runs at 4 am standard time.

        • If the time change removes an hour, events that are scheduled to run during that hour or the hour before do not run. Example: If the spring time change skips the hour from 2:00-2:59 am, events that are scheduled to run from 1:00-2:59 am do not run.
        • If an event is scheduled to run for the first time during the hours after the hour that is skipped by the time change, that event does not run on that day, and runs one hour before the scheduled time on every other day that it is scheduled. Example: If the spring time change skips the hour from 2:00-2:59 am, the first run of an integration that is scheduled to run at 3:00 am does not run. However, the next runs occur at the scheduled 2:00 am.
      5. Select the End Date. If you select Forever or leave the End Date blank, the schedule recurs indefinitely.
      6. Click Tap Apply.
      7. Click Tap Schedule Integration.
      8. Close the panel.
  8. Repeat for other integrations or integration sets.
  1. Click Tap Main Menu  > Maintenance > Integrations.
  2. Select Timeframe  or the arrows or to change the time period.
  3. (Optional) Show only scheduled integration runs. Click Tap Integrations to Manage   > Scheduled Integration Requests.
  4. Select a scheduled  integration.

    Tip: Click Tap Grid view  . Double-click a scheduled integration run to edit the schedule.

  5. Do one of the following:

    • Edit the schedule or other parameters

      1. Click Tap More  > Edit  or Copy  .
      2. Select Edit Scheduled Integration Request to change the currently scheduled integration.
      3. Edit the dates, times, recurrence, any options to exclude groups of employees, or other parameters as needed.
      4. Select Apply.
      5. Select Schedule Integration Request.
      6. Close the confirmation.

    • Delete scheduled integrations from running in the future

      1. Click Tap More  > Delete .
      2. Click Tap Yes to confirm. The underlying integration template remains available and is not deleted.
  6. Close the panel.

Download a cross-reference table to change the parameter values in an integration.

Note:

The maximum size of a cross-reference table is 1 MB or 10,000 rows.

Examples: You cannot download a table that is larger than 1 MB and has fewer than 10,000 rows; or that is smaller than 1 MB but has more than 10,000 rows.

  1. Click Tap Main Menu  > Maintenance > Integrations.
  2. Select an integration.
  3. Select Reference Tables  > Download.
  4. Select the table and select Download.
  5. Navigate to and select the folder to store the file.
  6. Close the panel.

This topic describes how to:

  • List completed, in-progress, scheduled, and failed integrations.
  • Display the start and end times, any parameter settings, who ran integrations, and the status of integration runs.
  • Check that integrations ran correctly.
  1. Click Tap Main Menu  > Maintenance > Integrations.

  2. Check the status indicators:

    •  In-progress: The run of this integration has not yet completed.
    •  Completed: The integration ran successfully without errors.
    •  Scheduled: This integration is scheduled to run later or repeatedly.
    • (Greyed out) Scheduled but Deleted: This integration is scheduled to run, but the integration template has been deleted. When it runs, it will trigger an error. To prevent this error, delete the scheduled integration run.
    •  Completed with Errors: The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set, the integration set stops.
    •  Failed: The integration run has errors or could not run.
    • To troubleshoot and resolve errors, do the following:

      Check the Run Summary for details.

      • To troubleshoot and resubmit integrations that have transactional or data errors. click tap Go to Transaction Assistant.
      • To troubleshoot all types of errors, click tap Go to Additional Details if available, or click tap the Source File to open and examine the input source file.

  3. (Optional) You can do the following:
    • Update the monitor view. Click Tap Refresh . 
    • Respond to alerts. Click Tap Notifications . The number on the button indicates the number of active alerts. 
    • Change the time period. Click Tap Select Timeframe  or the arrows or . 
    • Change the monitor view. Do one of the following:
      • Click Tap Grid View  – Shows the integration runs and details in a table. To change the sort order, click tap a header. To edit a scheduled integration run, double-click the scheduled run.
      • Click Tap List View  – Shows the integration runs in a series of tiles A container that provides navigation or action from its summary view.. Each tile displays the Run name, the Type, the Date of the run, and the Details for one integration run.
    • Filter the integrations. Click Tap Integrations to Manage  and either:
      • Past Integration Runs (default) to show integration runs that are in progress, completed or failed.
      • Scheduled Integration Requests to show only scheduled integration runs.

    • Sort or filter the list of integrations. Click Tap Refine .

      In the Refine slider, you can Sort or Filter the integration runs. To retrieve integrations from the past four days, you can filter by the Integration Run Name alone. For older runs, you must filter with the Start Date and End Date. You can also sort or filter by Type, Process Name, Status and User, who is the person that ran the integration.

You can monitor the status of integration sets as follows:

  • As an integration sets runs.
  • As integrations within the set complete, the status indicates which ran and the relationship of the integrations that ran together.
  • When the integration set completes, you can see the run summary for each process in the set.
  • If an integration fails or has errors, and the following integrations are configured to run only if the previous integration completes successfully, you can see that these dependent integrations did not run.
  1. Click Tap Main Menu  > Maintenance > Integrations. This page shows single integrations and integration sets.
  2. Check the status indicators for the integration sets:
    •  In-Progress: The run of all of the integrations in the set has not yet completed.
    •  Completed: All of the integrations in the integration set ran successfully without errors.
    •  Scheduled: This integration set is scheduled to run later or repeatedly.
    •  Failed:If the integration set is configured to abort on failures, this status indicates that an integration in the integration set failed because of errors or was deleted.

      Check the Run Summary for details.

      To resubmit integrations that have minor errors, click tap Go to Transaction Assistant.

      To troubleshoot, click tap Go to Additional Details if available, or click tap the Source File to open and examine the input source file.

Integration Hub verifies the validity of data and indicates integration runs that contain errors.

  1. Do one of the following:

    • Select Main Menu  > Maintenance > Integrations.
    • Click Tap Notifications . The number on the button indicates the number of active notifications.  In Categories, select Integrations.
  2. Select an integration run.
  3. Check the Run Summary for details.
  4. Click Tap Go to Transaction Assistant.
  5. Check the details in the Transaction Assistant:

    Note: The initial page of the Transaction Assistant can show up to 200 records of errors; scroll to show more records. The Transaction Assistant can load a maximum of 50,000 records.

    Above the table are the following counts of records:

    • Total
    • Selected
    • Displayed: The number of records that have been loaded; scroll to show more.

    The table shows the following:

    • Error Number: The system number of the error
    • Description: A brief error message; hover the cursor over a description to display more information. Includes the name of the API tag that has the error. If the same ID has multiple errors, the pop-up shows all of the error messages.
    • Error Date/Time: Date and time of the first error; an error can trigger later errors. The date and time remain the same regardless of the number of times the integration is submitted.

      For example: If a process to import a new person ID fails, all other import processes for that person ID will also fail. This can include imports of punches The entries on a timecard that mark the beginning (in-punch) or end (out-punch) of a work interval, such as the beginning of a shift or transfer., pay code edits, or schedules.

    • ID: For a failed integration, the specific value varies according to the information that Integration Hub sends to the Transaction Assistant. Examples: person ID, labour category, shift code, or any value that is in the detailed error description. For example: If a failure occurs in a clocking import process, ID displays the Person ID for the clocking that failed.

      Note: ID does not show the property name, such as person ID, only the value of the property. Hover the cursor over the ID to see the property name.

      If you sort by ID, you sort first by the property that failed, then by the value of that property. Hover the cursor over the ID column to see the name of the property that failed. For example: For a person import process where the Transaction type is People, failures occurred for a number of employees and all failed integrations are sorted together. The integrations are sorted first according to the value of the failed item: Person ID. Then each failure for the employee is sorted.

      Scan the list for related errors. For example: Search all errors that occurred for employee 123456 in the people integration of the person import process.

    • Transaction Type: The import category of the integration. For example: Data Import, clockings, labour categories
    • Transaction Start Date/Time: Date and time when the integration started

      Transaction Start Date/Time is the same as Error Date/Time unless Integration Hub uses the transaction date and time. For example: Transaction Start Date/Time can be the time when the import process starts, and Error Date/Time can be the time of the error.

      The date and time in the Transaction Assistant can be different from the date and time in the import reports. The Transaction Assistant displays Error Date/Time and Transaction Start Date/Time according to the time the errors occurred or the time the integration started. The Import Statistics and Import Errors reports record the date and time when the error information is saved.

    • API Endpoint: The API endpoint that was called and which produced the transactional error.
  6. To see more information about an error, click tap the Description. The slider opens to show detailed information.
  7. (Optional) Change the time period. Click Tap Select Timeframe  or the arrows or .
  8. (Optional) Filter the list of records as follows:
    1. Click Tap Refine  to sort or filter the list of records.
    2. In Refine, select the drop-down for the corresponding column header.
    3. Select or enter the operator and value.

      For example:

      1. Select API Endpoint.
      2. Select Custom to match the text that you enter.
      3. Enter clocking.

        Note: This field is for searches for text strings, and regular expressions are not supported.

    4. Click Tap Apply.
    5. Repeat with more operators and values to filter the records further.

      Example:

      Filter for punch errors for an employee on a specific date as follows:

      1. Select API Endpoint. Select Custom. Enter punch to show only errors that are related to punch integrations.
      2. Select ID. Enter the person ID of an employee.
      3. Select Error Date/Time. Select the date.
  9. (Optional) To download all error records for an integration run to a comma-separated values (CSV) file for troubleshooting, see Transaction Assistant Downloads.
  10. (Optional) To copy the error records to another application, such as a text file or spreadsheet, do the following:
    1. Select an error record, or page down to load all records and click tap Select Max.
    2. Hold Shift while you click tap the last error record that you want to copy.
    3. Press Ctrl + C.
    4. Paste the records into the other application.
  11. Resubmit an integration as follows:
    • Correct parameters if you can.
      1. Select the Description of the error.
      2. Search for and correct parameters.
      3. Click Tap Resubmit. 
    • If the parameters of the integration are correct, but another condition caused it to fail, submit the integration process again without making any changes or edits.

      For example: A business structure import failed because the labour category had not been entered. Once you enter the labour categories, you can submit the business structure import again without making changes to the integration.

      1. Select any field of the error except Description.

        To select multiple errors, press and hold Ctrl while you select errors. You can select up to 200 errors at a time to resubmit or delete.

        To select up to 200 of the errors that are loaded, click tap Select Max . You cannot select more than 200 records, and Select Max selects only the first 200 records in the Transaction Assistant. To filter the error records, click tap Refine.

      2. Click Tap Resubmit. 
      3. To resubmit more errors, scroll to load more errors and repeat these steps.
  12. If you see a Warning, select Continue Processing All Selected Transactions in the Event of a Failed Record. Click Tap Yes to confirm.
  13. Click Tap OK to close the confirmation or error message.
  14. Close the panel.
  15. Click Tap Refresh  .
    • When you resubmit an integration run, it becomes a new integration and the previous integration run is deleted from the list. If the integration fails again, the Transaction Assistant lists the resubmitted integration run.
    • There is no limit to how often you can submit an integration.