Install Payroll Extract integrations

How to configure parameters and install this integration to make it 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. Click Tap Create .
  3. Enter an appropriate, unique, and descriptive Integration Name.
  4. (Optional) Enter a Description.
  5. Do not select API Integration.
  6. (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.
  7. (Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.
  8. (Optional) Email Notifications
    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.

  9. Complete the SFTP settings:
    • In File Access, select one of the following:

      None: Do not select a Connection.

      File Upload

      Source/Output Download

    • In Connection, click tap Internal SFTP.
  10. (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.
  11. Scheduling Configuration

    (Optional)

    (Only for file-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.
  12. Integration template and parameters
    1. In Integration Template, select PayrollExtractE2E.
    2. Click Tap Assign .
    3. (Optional) In Integration Parameters, you can override default settings: Configure the following parameters as needed to include in the payroll extract:
      Note: Alternatively, you can configure integration list parameters and select that source; see Configure Integration List Parameters.

      (Optional) Specify the hyperfind query of employees:

      Click Tap Create .

      Enter the following values:

      HyperfindAndLocations

      Parameter Name: (Required) Enter Hyperfind.

      Description: (Optional)

      Template Parameter: (Required) Select HyperfindAndLocations.

      Parameter Type: (Required) Select Hyperfind.

      Default Value: (Optional)

      User Prompted: If the value does not need to be changed when the integration runs, select No.

      Click Tap Save.

      (Optional) Specify the parameter to process data for only a limited number of employees:

      Click Tap Create .

      Enter the following values:

      IncludeEmployees

      Parameter Name: (Required) Enter Include Employees.

      Description: (Optional)

      Template Parameter: (Required) Select IncludeEmployees.

      Parameter Type: (Required) Select Text.

      Default Value: (Optional) Can be a single or multiple values separated by commas (,) and no spaces. Leave blank to process data for all employees.

      User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.

      Click Tap Save.

  13. Click Tap Save.
  14. Make sure that the generic data access profiles (GDAP) allow access by the people who need to run the installed integrations. Select Administration > Application Setup > Integrations Setup > Access Profiles; see Configure Access to Integrations.