Install Workforce Planner Integrations

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.

Install the integrations

Select Main Menu > Administration > Application Setup > Integrations Setup > Install Integrations.
You must repeat the remaining steps five times to install each of the integrations in the following order:
1. Workforce Planner Business Structure Represents the logical structure of an organization as it concerns staffing. It contains the locations and jobs to which an employee may be assigned. Export
2. Workforce Planner Skills and Certifications Export
3. Workforce Planner People Export
4. Workforce Planner Schedule Batch Import
5. Workforce Planner Schedule Import
Options and values for each integration are specified in the corresponding steps.
Click Tap Create .
Enter the corresponding Integration Name as follows:
- Business Structure Export
- Skills and Certs Export
- People Export
- Schedule Batch Import
- Schedule Import
(Optional) Enter a Description.
Integration type
For Business Structure Export, Skills and Certifications Export, and People Export:
1. Do not select API Integration.
2. In File Access, leave at None, do not select an SFTP connection.
3. (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.
4. (Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.
5. Email Notifications
  
  (Optional)
  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 A sequence of integrations that can be run on-demand or be scheduled., the integration set stops.
    Completed with Errors — The integration run has errors or could not run.
6. 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.
For Schedule Batch Import and Schedule Import: Select API Integration.
Integration template
1. In Integration Template, select the corresponding integration template from the table as follows:
  - Business Structure Export: Select WFPBusinessStructureExport-v1.
  - Skills and Certs Export: Select WFPSkillsAndCertsSetupExport-v1.
  - People Export: Select WFPPeopleExport-v1.
  - Schedule Batch Import: Select WFPScheduleImport-Batch-v1.
  - Schedule Import: Select WFPScheduleImport-v1.
2. Click Tap Assign .
Integration parameters
1. In Integration Parameters, click tap Create .
2. Configure the parameters for each integration.
  
  Enter the values for each parameter. Click Tap Save for each parameter.
  - Business Structure Export
    
    EndDate
    
    Parameter Name: (Required) Enter End Date.
    
    Description: (Optional)
    
    Template Parameter: (Required) Select EndDate.
    
    Parameter Type: (Required) Select Date.
    
    Default Value: (Optional) Enter a default date as the symbolic period (preferred), symbolic period span, or date in MM-DD-YYYY format.
    
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    
    LocationType
    
    Parameter Name: (Required) LocationType; must be exactly the same spelling as the Template Parameter.
    
    Description: (Optional)
    
    Template Parameter: (Required) Select LocationType.
    
    Parameter Type: (Required) Select Date.
    
    Default Value: (Not specified)
    
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    
    StartDate
    
    Parameter Name: (Required) Enter Start Date.
    
    Description: (Optional)
    
    Template Parameter: (Required) Select StartDate.
    
    Parameter Type: (Required) Select Date.
    
    Default Value: (Optional) Enter a default date as the symbolic period (preferred), symbolic period span, or date in MM-DD-YYYY format.
    
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
  - Skills & Certs Export: No integration parameters are defined.
  - People Export
    
    (Optional)
    
    InitialTimeToWait: If an API limit is exceeded, this property defines how long to wait before sending the API call again.
    
    Default = 60000 ms (1 minute)
    
    This property sets only the first retry. If the API call has to be sent again, each repetition adds 60,000 ms to the wait time.
    Example:
    - 1st TimetoWait = 60,000 ms (InitialTimeToWait)
    - 2nd TimetoWait = 60,000 ms + 60,000 ms = 120,000 ms
    - 3rd TimetoWait = 60,000 ms + (2 * 60,000 ms) = 180,000 ms
    To change the initial wait time:
    - Clear Use Default.
    - Enter the wait time in milliseconds (ms) up to a maximum of 180000 ms.
    (Optional) isMoreThan50K
    
    This integration exports records by employee ID based on each location. If a single location has more than 50,000 employees, the integration fails. To prevent this and export more than 50,000 employee records from a location, do the following when you install the integration:
    1. Select isMoreThan50K.
    2. Upload the BusinessStructureExport-v1_LocationTypes cross-reference table from the Workforce Planner Business Structure Export integration. Alternatively, you can use the WFPPeopleExport-v1_LocationTypes cross-reference table that is configured to map the WFP Type Institution to the WFD Type WFP_Institution.
    (Optional)
    
    EnableContactByInstitution
    
    Parameter Name: (Required) EnableContactByInstitution; must be exactly the same spelling as the Template Parameter.
    
    Description: (Optional)
    
    Template Parameter: (Required) Select EnableContactByInstitution.
    
    Parameter Type: (Required) Select Boolean.
    
    Default Value: To use institution-based contact mapping, enter True.
    
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    
    Caution: If you select Yes, the people who run the integrations can change this setting, and the results in the Run Summary become inconsistent between integration runs. To prevent changes, select No.
  - For bothSchedule Batch Import and Schedule Import:
    AdjustToCalendarDay
    Parameter Name: (Required) AdjustToCalendarDay; must be exactly the same spelling as the Template Parameter.
    Description: (Optional)
    Template Parameter: (Required) Select AdjustToCalendarDay.
    Parameter Type: (Required) Select Boolean.
    Default Value: (Required) Select False.
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    AtwFromDate
    Parameter Name: (Required) AtwFromDate; must be exactly the same spelling as the Template Parameter.
    Description: (Optional)
    Template Parameter: (Required) Select AtwFromDate.
    Parameter Type: (Required) Select Text or Date.
    Default Value: No default value is assigned to this property.
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    AtwThruDate
    Parameter Name: (Required) AtwThruDate; must be exactly the same spelling as the Template Parameter.
    Description: (Optional)
    Template Parameter: (Required) Select AtwThruDate.
    Parameter Type: (Required) Select Text or Date.
    Default Value: No default value is assigned to this property.
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    DayDivide
    Parameter Name: (Required) DayDivide; must be exactly the same spelling as the Template Parameter.
    Description: (Optional)
    Template Parameter: (Required) Select DayDivide.
    Parameter Type: (Required) Select Number.
    Default Value: (Not specified)
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    ExtraDaysBeyondPeriod
    Parameter Name: (Required) ExtraDaysBeyondPeriod; must be exactly the same spelling as the Template Parameter.
    Description: (Optional)
    Template Parameter: (Required) Select ExtraDaysBeyondPeriod.
    Parameter Type: (Required) Select Number.
    Default Value: (Not specified)
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    FromDate
    Parameter Name: (Required) FromDate; must be exactly the same spelling as the Template Parameter.
    Description: (Optional)
    Template Parameter: (Required) Select FromDate.
    Parameter Type: (Required) Select Text.
    Default Value: (Not specified)
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    MergeAdjacentShifts
    Parameter Name: (Required) MergeAdjacentShifts; must be exactly the same spelling as the Template Parameter.
    Description: (Optional)
    Template Parameter: (Required) Select MergeAdjacentShifts.
    Parameter Type: (Required) Select Boolean.
    Default Value: (Optional) Select False.
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    NoPaySegmentTag
    Parameter Name: (Required) NoPaySegmentTag; must be exactly the same spelling as the Template Parameter.
    Description: (Optional)
    Template Parameter: (Required) Select NoPaySegmentTag.
    Parameter Type: (Required) Select Text.
    Default Value: (Not specified)
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    PayCodeEditsOnly
    Parameter Name: (Required) PayCodeEditsOnly; must be exactly the same spelling as the Template Parameter.
    Description: (Optional)
    Template Parameter: (Required) Select PayCodeEditsOnly.
    Parameter Type: (Required) Select Boolean.
    Default Value: (Optional) Select False.
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    ThruDate
    Parameter Name: (Required) ThruDate; must be exactly the same spelling as the Template Parameter.
    Description: (Optional)
    Template Parameter: (Required) Select ThruDate.
    Parameter Type: (Required) Select Text.
    Default Value: (Not specified)
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
  - Only for Schedule Import integrations:
    SupportPartialSuccess
    Parameter Name: (Required) SupportPartialSuccess; must be exactly the same spelling as the Template Parameter.
    Description: (Optional)
    Template Parameter: (Required) Select SupportPartialSuccess.
    Parameter Type: (Required) Select Boolean.
    Default Value: (Optional) Enter one of the following:
    - True — Runs of this integration can have a status of Completed with Errors in the Run Summary.
    - False (default) — Runs of this integration cannot have a status of Completed with Errors.
    User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
    Caution:
    Also do the following in Workforce Planner > Import Manager > Integrations tab:
    - To allow partial success in batch Schedule Import integrations, select Enable Batch Partial Success. Previously, this setting was called Enable Partial Success.
    - To allow partial success in low-latency Schedule Import integrations, select Enable Low Latency Partial Success.
Click Tap Save.
Repeat to install the next integration.
Configure and assign the GDAP for the people who need to run the installed integrations.