Install PBJ Export Integrations

How to configure parameters and install this integration to make it available for running and scheduling.

Note: Only for the Payroll Based Journal (PBJ) Export integration pack.

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.

Click Tap Main Menu > Administration > Application Setup > Integrations Setup > Install Integrations.
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.
(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.
(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.
For frequently run integrations:

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.
In Integration Template:
1. Select the PBJExport integration template from the table.
2. Click Tap Assign .
Create or edit the following Integration Parameters:
FacilityNames
- Click Tap Create .
- In Parameter Name, enter Facility Names.
- (Optional) Enter a Description.
- In Template Parameter, select the FacilityNames integration list to be source for the integration parameters.
- In Parameter Type, select List.
- In Parameter Value, select a facility to be the default value.
- Select User Prompted.
- Click Tap Save.
File Type
- Click Tap Create .
- In Parameter Name, enter File Type.
- (Optional) Enter a Description.
- In Template Parameter, select the FileType integration list to be source for the integration parameters.
- In Parameter Type, select Dropdown.
- In Parameter Value, select one of the following to be the default value:
  - Clean= Exclude negative values and jobs that are longer than 24 hours.
  - Full= Export all values.
- Select User Prompted.
- Click Tap Save.
Output Directory
- Click Tap Create .
- In Parameter Name, enter Output Directory.
- (Optional) Enter a Description.
- In Template Parameter, select OutputDirectory.
- In Parameter Type, select Text.
- In Parameter Value, select /Outbound/PBJ.
  Caution:
  Do not change the name of the folder from Outbound. Additional or differently named folders are not supported by .
- Do not select User Prompted.
- Click Tap Save.
Processing Type
- Click Tap Create .
- In Parameter Name, enter Processing Type.
- (Optional) Enter a Description.
- In Template Parameter, select the ProcessingType list to be source for the integration parameters.
- In Parameter Type, select Dropdown.
- In Parameter Value, select one of the following to be the default value:
  - Merge(most common)
    - If a lookup value has no previous data that is appropriate for a section, that data is added to the PBJ database.
    - If a specific lookup value does have previous data that is appropriate for a section, this data overwrites the corresponding data in the PBJ database.
      Example data and sections: Employee identifier and date for the Staffing Hours section, month end date for the Census section.
  - Replace(not recommended)
    The data in the PBJ submission file overwrites all previously submitted data for that section in the report quarter.
- Select User Prompted.
- Click Tap Save.
Reporting Quarter
- Click Tap Create .
- In Parameter Name, enter Reporting Quarter.
- (Optional) Enter a Description.
- In Template Parameter, select the ReportingQuarter integration list to be source for the integration parameters.
- In Parameter Type, select Dropdown.
- In Parameter Value, select 1, 2, 3, or 4 to be the default reporting quarter.
- Select User Prompted.
- Click Tap Save.
Reporting Year
- Click Tap Create .
- In Parameter Name, enter Reporting Year.
- (Optional) Enter a Description.
- In Template Parameter, select ReportingYear.
- In Parameter Type, select Text.
- Do not select a Parameter Value.
- Select User Prompted.
- Click Tap Save.
Time Frame
- Click Tap Create .
- In Parameter Name, enter Reporting Year.
- (Optional) Enter a Description.
- In Template Parameter, select PayPeriod.
- In Parameter Type, select Time Period.
- Do not select a Parameter Value.
- Select User Prompted.
- Click Tap Save.
Click Tap Save.
Configure the GDAP for the people who need to run the installed integrations; see Configure Access to Integrations.