Install the PlanSource Integration

How to configure parameters and install PlanSource Demographics Export and Deductions Import integrations to make them 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.

Select Main Menu Administration > Application Setup > Integrations Setup > Install Integrations.

Install the PlanSource Demographic Export integration

HCM PlanSource Demographic Export integration

Click Tap Create .
Enter an appropriate, unique, and descriptive Integration Name.
(Optional) Enter a Description.
Do not select API Integration.
In File Access, leave at None; do not select an SFTP connection.
(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.
(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.
In Scheduling Configuration, configure the behavior if integrations overlap in time to allow frequent integration runs that avoid redundant processing of data and avoid multiple integrations processing the same data.
Do the following:

Note: If Installed Instance and Allow Minute Interval are selected, scheduled integrations automatically request changed records since the last successful run.
1. Select Installed Instance to not run a scheduled integration if another instance of the same installed integration is in-progress. Only once such integrations finish, can this integration run at the next scheduled time.
2. Click Tap 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 HCMDemographicExport-v1.
2. Click Tap Assign .
3. (Optional) In Integration Parameters, you can override default settings:
  1. Click Tap Create .
  2. (Required) Specify the type of import integration:
    Parameter Name: (Required) Enter Delta.
    Caution: Parameter Name must use the exact same spelling as the Template Parameter.
    Description: (Optional)
    Template Parameter: (Required) Select Delta.
    Parameter Type: (Required) Select Boolean.
    Default Value: (Recommended) Enter Yes or No.
    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 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 number of days to search from today and earlier to get change records:
    Click Tap Create .
    LookbackDays
    Parameter Name: (Required) Enter a descriptive name. Example: Lookback Days.
    Description: (Optional)
    Template Parameter: (Required) Select LookbackDays.
    Parameter Type: (Required) Select Text.
    Default Value: (Optional) Enter from 1—31 days.
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    Click Tap Save.
Click Tap Save.

Install the PlanSource Deductions Import integration

HCM PlanSource Deductions Import integration

Click Tap Create .
Enter an appropriate, unique, and descriptive Integration Name.
(Optional) Enter a Description.
Clear API 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.
(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.
In File Access, leave at None; do not select an SFTP connection.
(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.
(Optional) Scheduling Configuration

(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.
Note: If Installed Instance and Allow Minute Interval are selected, scheduled integrations automatically request changed records since the last successful run.
Integration template and parameters
1. In Integration Template, select HCMDemographicExport-v1.
2. Click Tap Assign .
3. (Optional) In Integration Parameters, you can override default settings:
  1. Click Tap Create .
  2. (Required) Specify the type of import integration:
    Parameter Name: (Required) Enter Delta.
    Caution: Parameter Name must use the exact same spelling as the Template Parameter.
    Description: (Optional)
    Template Parameter: (Required) Select Delta.
    Parameter Type: (Required) Select Boolean.
    Default Value: (Recommended) Enter Yes or No.
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    Click Tap Save.
    Click Tap Create .
    (Optional) Specify the following parameter:
    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.
    Click Tap Create .
    (Optional) Specify how far to look back for changes in PlanSource:
    DeductionStartDate
    Parameter Name: (Required) Enter a descriptive name. Example: Plan Year Start Date.
    Description: (Optional)
    Template Parameter: (Required) Select DeductionStartDate.
    Parameter Type: (Required) Select Date.
    Default Value: (Optional) Enter a default date that is the day before the start date of the plan year (Plan Year Start Date — 1 day). Use the format MM-DD-YYYY.
    User Prompted: 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 integrations

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.