Install the HCM Payroll Export integration

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.

Note:

Version 2 of the HCM Payroll Export integration improves performance because it only transfers data and does not modify or transform that data. It does not have cross-reference tables or data maps. The HCM Payroll Configuration and Payroll Code Mapping setup pages replace the PaycodeCRT cross-reference table.

To edit the payroll data, see:

Select Main Menu > Administration > Application Setup > Integrations Setup > Install Integrations.
Click Tap Create .
Enter an appropriate, unique, and descriptive Integration Name.
(Optional) Enter a Description.
Do not select API Integration.
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.
( Only for the HCM Payroll Export-v1 integration) (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.

Caution: For the HCM Payroll Export-v2 integration, do not select Execute Integration with System Account.
(Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.
(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.
(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.
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.
Integration template and parameters
1. In Integration Template, select HCMPayrollExport-v2(recommended) or HCMPayrollExport-v1.
2. Click Tap Assign .
3. (Optional) In Integration Parameters, you can override default settings:
  Note: Alternatively, you can configure integration list parameters and select that source; see Configure Integration List Parameters.
  1. Configure the following parameters as needed to include in the payroll export:
    (Required) Specify the company list to export payroll data including the base rate combinations for EINs, pay periods, and base rate.
    Click Tap Create .
    HCMPayrollCompanyList
    Parameter Name: (Required) Enter Company List.
    Description: (Optional)
    Template Parameter: (Required) Select HCMPayrollCompanyList.
    Parameter Type: (Required) Select List.
    Default Value: (Optional) Enter HCM Payroll Company List.
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    Click Tap Save.
    (Required) Specify the parameter to allow override of the Changes Only process property when you install and run the integration:
    Click Tap Create .
    ChangesOnly
    Parameter Name: (Required) Enter Changes Only.
    Description: (Optional)
    Template Parameter: (Required) Select ChangesOnly.
    Parameter Type: (Required) Select Boolean.
    Default Value: (Optional) Enter one of the following:
    - True— Export only the changes in the time card since the last integration run on the same day for a combined EIN, pay period profile. This setting saves time when you run multiple payroll exports on the same day.
    - False— Export all time-card data for all employees in the combined EIN, pay period profile to payroll.
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    Click Tap Save.
    (Optional) Specify paycodes to exclude from the payroll export:
    Click Tap Create .
    ExcludePaycodes
    Parameter Name: (Required) Enter Exclude Paycodes.
    Description: (Optional)
    Template Parameter: (Required) Select ExcludePaycodes.
    Parameter Type: (Required) Select Text.
    Default Value: (Not specified) Can be a single or up to 20multiple values separated by commas ( ,) and no spaces.
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    Click Tap Save.
    (Optional) Specify the hyperfind query of employees that includes all employees who worked during the time period:
    Click Tap Create .
    HyperfindAndLocations
    Parameter Name: (Required) Enter Hyperfind Query.
    Description: (Optional)
    Template Parameter: (Required) Select HyperfindAndLocations.
    Parameter Type: (Required) Select Hyperfind.
    Default Value: (Recommended) Enter All People.
    Caution: Do not change the default. Location based hyperfinds — including All Home— do not work with HCMPayrollExport-v2.
    User Prompted: If the value does not need to be changed when the integration runs, select No.
    Click Tap Save.
    (Optional) Specify whether to export only signed-off data, or signed-off and not signed-off data:
    Click Tap Create .
    IgnoreSignoff
    Parameter Name: (Required) Enter Ignore Signoff.
    Description: (Optional)
    Template Parameter: (Required) Select IgnoreSignoff.
    Parameter Type: (Required) Select Boolean.
    Default Value: (Optional) Enter one of the following:
    - True— Export onlysigned-off data.
    - False— Export signed-off andnot signed-off data.
    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 .
    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.
    (Optional) Specify the parameter to process data for only a limited number of paycodes:
    Click Tap Create .
    IncludePaycodes
    Parameter Name: (Required) Enter Include Paycodes.
    Description: (Optional)
    Template Parameter: (Required) Select IncludePaycodes.
    Parameter Type: (Required) Select Text.
    Default Value: (Not specified) Can be a single or up to 20multiple values separated by commas ( ,) and no spaces.
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    Click Tap Save.
    (Optional) Specify a pay period to process:
    Click Tap Create .
    PayPeriod
    Parameter Name: (Required) Enter Pay Period.
    Description: (Optional)
    Template Parameter: (Required) Select PayPeriod.
    Parameter Type: (Required) Select Time period.
    Default Value: (Optional) Enter one of the following pay periods:
    - 0 = Previous pay period
    - 1 = Current pay period
    - 2 = Next pay period
    - 3 = Previous schedule period
    - 4 = Current schedule period
    - 5 = Next schedule period
    - 6 = Week to date
    - 7 = Last week
    - 8 = Yesterday
    - 10 = Range of relative dates
    - 11 = Specific date
    - 12 = Relative specific date
    - 13 = Today
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    Click Tap Save.
    (Optional) Specify the type of pay statement to issue:
    Click Tap Create .
    PayStatementType
    Parameter Name: (Required) Enter Pay Statement Type.
    Description: (Optional)
    Template Parameter: (Required) Select PayStatementType.
    Parameter Type: (Required) Select Text.
    Default Value: (Recommended) Enter Regular.
    User Prompted:
    - If the value does not need to be changed when the integration runs, select No.
    - To prompt the person who manually runs the integration to set this parameter, select Yes.
    Click Tap Save.
Click Tap Save.

Configure access to the integration

How to configure access to this integration.

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.