Install Integrations

How to install integrations and configure parameters to make the integrations available for running and scheduling.

After the integrations are deployed and the connection settings and process properties are configured, install the integrations to make them available for running or scheduling.

Note:

  • An integration template is the configured integration that you deploy to an Atom and then install to make available for running or scheduling.

  • An installed integration is a single instance of an integration that is based on an integration template. When you install an integration, you can define parameters or set parameters to be defined when the integration is run.
  1. Select Main Menu > Administration > Application Setup > Integrations Setup > Install Integrations.
  2. Create, edit, or remove an installed integration as follows:
    • Click Tap Create . Enter a unique and descriptive Integration Name.
    • Select an installed integration. Click Tap Edit . In Save Changes to, select one of the following:
      • Save changes everywhere that the named entity is used— Save the changes to all installations of the current integration.
      • Save as a new named entity— Save the changes as a new, installed integration.
    • Select an installed integration. Click Tap Delete . Click Tap Yes to confirm.
      Caution: Scheduled integrations will continue to run; to delete these, see Delete Scheduled Integrations.
  3. (Optional) Enter a Description.
  4. Select one of the following types of integration:
    • Select API Integration to install an API-based integration.
    • Clear API Integration to install a file-based integration and select None and do not select a connection, or select File Upload for import integrations or Source/Output Download for export integrations, and in Connection, select Internal SFTP.
      Note: Import integrations accept only UTF-8 encoded input files.
  5. (Optional) To allow the integration access to all APIs in the FAP, and the relevant permissions and data even if the person who runs the integration doesn't have full access, select Execute Integration with System Account.
  6. (Optional and not available for API-based integrations) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.
  7. Email Notifications (Optional and not available for API-based integrations)
    1. Select Yes to send email and control center notifications for integration runs.
    2. Enter the email addresses of the recipients for the following types of run status. For multiple recipients, separate the addresses by a comma, but no spaces: In Progress — The integration run started and has not finished.

      Completed — The integration ran successfully without errors.

      Failed — 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.

      Completed with Errors — The integration run has errors or could not run.

  8. (Optional, not available for API-based integrations) Select Enhanced Payroll Monitoring to identify whether this integration is part of a payroll process. This setting allows to monitor the integration and sub-processes and help to troubleshoot payroll processes if the integration has errors or fails.
  9. Scheduling Configuration

    (Optional and not available for API-based integrations)

    For integrations that will be scheduled to run frequently, configure the behavior if integrations overlap in time. These settings allow frequent integration runs that avoid redundant processing of data and avoid multiple integrations processing the same data.

    • In Skip Configuration, select one of the following:

      None (default): Allow multiple integrations to run at the same time or with the same data without restrictions.

      Installed Instance (Recommended): Do not run a scheduled integration if another instance of the same installed integration is in-progress. Only once such integrations finish, this integration can run at the next scheduled time.

      Integration Template: Do not run a scheduled integration if any installed instance of the same integration template is in-progress. Only once such integrations finish, can this integration run at the next scheduled time.

    • Only if Installed Instance or Integration Template is selected, select Allow Minute Interval to allow the person who schedules the integration to select the By Minute recurrence to repeat the integration run every 5, 10, 15, 20, 25, or 30 minutes.
  10. Integration template In Integration Template, select an integration template from the table. Click Tap Assign .
  11. Integration parameters

    Parameters or external files are required or optional when you run or schedule an integration. Parameters vary by integration and can include settings for licenses, to disqualify active or inactive employees, for seniority date, pay period for a location, job status, or directory.

    1. In Integration Parameters, do one of the following:
      • Click Tap Create . Enter a Parameter Name.
        Note: Use camel case for parameter names. Example: DisqualifyTerminated.
      • Select a parameter. Click Tap Edit .
      • Select a parameter. Click Tap Delete . Click Tap Yes to confirm.
    2. (Optional) Enter a Description.
    3. Select a Template Parameter to be the source of the parameter. Example: HyperfindAndLocations

      If the integration requires integration list parameters, select that source. See Configure Integration List Parameters.

    4. Select the Parameter Type to define the data format of the parameter: Example: To allow the person who runs a payroll export integration to select a defined pay period or range of dates, select the PayPeriod parameter. Then in Parameter Type, select Time Period.
      • Boolean — Select True or False.
      • Text
      • List — If you selected integration list parameters in Template Parameter, select List.
      • Dropdown
      • Password
      • Time Period — Select a time range.
      • Number — Requires a numeric entry.
      • Date — Select a date.
      • Hyperfind query — Select a configured hyperfind of employees.
    5. Enter or select a Default Value.
    6. So that this parameter prompts when the user must enter or select a value, select User Prompted.
    7. Click Tap Save.
    8. Repeat for more parameters.
  12. Click Tap Save.
  13. Configure the GDAP for the people who need to run the installed integrations; see Configure Access to Integrations.