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.
- 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.
Summary of integration parameters
- SourceDirectory on server over SFTP connection for the source file
- OutputDirectory on server over SFTP connection for processed and exception files
- SourceFileName of data to import
- OutputDirectory on server over SFTP connection for the output file
- SourceDirectory on server over SFTP connection for the source file
- OutputDirectory on server over SFTP connection for processed and exception files
- SourceFileName of data to import
- OutputDirectory on server over SFTP connection for the output file
Work Unit Hyperfind Profiles Import
- SourceDirectory on server over SFTP connection for the source file
- OutputDirectory on server over SFTP connection for processed and exception files
- SourceFileName of data to import
Work Unit Hyperfind Profiles Export
- OutputDirectory on server over SFTP connection for the output file
- SourceDirectory on server over SFTP connection for the source file
- OutputDirectory on server over SFTP connection for processed and exception files
- SourceFileName of data to import
- OutputDirectory on server over SFTP connection for the output file
- SourceDirectory on server over SFTP connection for the source file
- OutputDirectory on server over SFTP connection for processed and exception files
- SourceFileName of data to import
- OutputDirectory on server over SFTP connection for the output file
Billing Department Mapping Import
- SourceDirectory on server over SFTP connection for the source file
- OutputDirectory on server over SFTP connection for processed and exception files
- SourceFileName of data to import
Billing Department Mapping Export
- OutputDirectory on server over SFTP connection for the output file
- SourceDirectory on server over SFTP connection for the source file
- OutputDirectory on server over SFTP connection for processed and exception files
- SourceFileName of data to import
- OutputDirectory on server over SFTP connection for the output file
- SourceDirectory on server over SFTP connection for the source file
- OutputDirectory on server over SFTP connection for processed and exception files
- SourceFileName of data to import
- OutputDirectory on server over SFTP connection for the output file
Volume Department Copy Override Import
- SourceDirectory on server over SFTP connection for the source file
- OutputDirectory on server over SFTP connection for processed and exception files
- SourceFileName of data to import
Volume Department Copy Override Export
- OutputDirectory on server over SFTP connection for the output file
Payroll Department Mapping Import
- SourceDirectory on server over SFTP connection for the source file
- OutputDirectory on server over SFTP connection for processed and exception files
- SourceFileName of data to import
Payroll Department Mapping Export
- OutputDirectory on server over SFTP connection for the output file
Payroll Employment Status Mapping Import
- SourceDirectory on server over SFTP connection for the source file
- OutputDirectory on server over SFTP connection for processed and exception files
- SourceFileName of data to import
Payroll Employment Status Mapping Export
- OutputDirectory on server over SFTP connection for the output file
- SourceDirectory on server over SFTP connection for the source file
- OutputDirectory on server over SFTP connection for processed and exception files
- SourceFileName of data to import
- OutputDirectory on server over SFTP connection for the output file
- SourceDirectory on server over SFTP connection for the source file
- OutputDirectory on server over SFTP connection for processed and exception files
- SourceFileName of data to import
- OutputDirectory on server over SFTP connection for the output file
- SourceDirectory on server over SFTP connection for the source file
- OutputDirectory on server over SFTP connection for processed and exception files
- SourceFileName of data to import
Volume Import Billing file and Manual file
- BillingFileName of the billing file to import
- PatientFlag for the billing file
- IsBillingFileRolling?: yes or no
- ManualFileName of the manual volume file to import
- IsManualFileRolling?: yes or no
- SourceDirectory on server over SFTP connection for the source file
- OutputDirectory on server over SFTP connection for processed and exception files
Payroll Import feed
- SourceDirectory on server over SFTP connection for the source file
- OutputDirectory on server over SFTP connection for processed and exception files
- SourceFileName of data to import
- processHistoricalErroneousRecords: Merge cumulative exception records with new records.
- OutputDirectory on server over SFTP connection for the inbound file for the Agency Import
- ReferenceDate
- AgencyEmployees: hyperfind query for agency employees
- SourceDirectory on server over SFTP connection for the source file
- SourceFileName of data to import
- OutputDirectory on server over SFTP connection for processed and exception files
Recalculate:
- Domain to recalculate Volume or Payroll.
- StartDate
- EndDate
Before you start
- Configure all of the worksheets in the installation kit; see Configure the Installation Kit for Healthcare Productivity.
- Configure the Fiscal Calendar Import for Healthcare Productivity.
- Configure the Volume Import for Healthcare Productivity.
- Configure the Payroll Import for Healthcare Productivity.
- Configure the Agency Export and Import for Healthcare Productivity.
- Configure the SFTP Connection.
Install the bulk import and export integrations
Select Main Menu
Install the Work Unit Import integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Work Unit Import
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select File Upload.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
-
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 Skip Configuration, select one of the following:
- Integration templates and parameters
- In the Integration Template table, select WorkUnitImport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
SourceDirectory
Parameter Name: (Required) Enter Source Directory.
Description: (Optional)
Template Parameter: (Required) Select SourceDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory for the source file. Example: /root/{projectName}/Inbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
SourceFileName
Parameter Name: (Required) Enter Source File Name.
Description: (Optional)
Template Parameter: (Required) Select SourceFileName.
Parameter Type: (Required) Select Text.
Default Value: (Recommended) Enter the filename of the CSV file exactly as it was generated from the Installation Kit: Work_Units*.csv
Caution: Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.
Caution: Import integrations accept only UTF-8 encoded input files.
User Prompted: If the value does not need to be changed when the integration runs, select No.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Work Unit Export integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Work Unit Export
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select Source/Output Download.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration template and parameters
- In the Integration Template table, select WorkUnitExport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Work Unit Hyperfinds Import integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Work Unit Hyperfinds Import
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select File Upload.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select WorkUnitHyperfindImport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
SourceDirectory
Parameter Name: (Required) Enter Source Directory.
Description: (Optional)
Template Parameter: (Required) Select SourceDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory for the source file. Example: /root/{projectName}/Inbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
SourceFileName
Parameter Name: (Required) Enter Source File Name.
Description: (Optional)
Template Parameter: (Required) Select SourceFileName.
Parameter Type: (Required) Select Text.
Default Value: (Recommended) Enter the filename of the CSV file exactly as it was generated from the Installation Kit: Work_Unit_Hyperfinds*.csv
Caution: Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.
Caution: Import integrations accept only UTF-8 encoded input files.
User Prompted: If the value does not need to be changed when the integration runs, select No.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Work Unit Hyperfinds Export integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Work Unit Hyperfinds Export
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select Source/Output Download.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select WorkUnitHyperfindExport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Work Unit Hyperfind Profiles Import integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Work Unit Hyperfind Profiles Import
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select File Upload.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select WorkUnitHyperfindprofileImport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
SourceDirectory
Parameter Name: (Required) Enter Source Directory.
Description: (Optional)
Template Parameter: (Required) Select SourceDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory for the source file. Example: /root/{projectName}/Inbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
SourceFileName
Parameter Name: (Required) Enter Source File Name.
Description: (Optional)
Template Parameter: (Required) Select SourceFileName.
Parameter Type: (Required) Select Text.
Default Value: (Recommended) Enter the filename of the CSV file exactly as it was generated from the Installation Kit: Work_Unit_Hyperfind_Profiles*.csv
Caution: Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.
Caution: Import integrations accept only UTF-8 encoded input files.
User Prompted: If the value does not need to be changed when the integration runs, select No.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Work Unit Hyperfind Profiles Export integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Work Unit Hyperfind Profiles Export
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select Source/Output Download.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select WorkUnitHyperfindprofileExport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Work Group Import integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Work Group Import
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select File Upload.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select WorkGroupImport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
SourceDirectory
Parameter Name: (Required) Enter Source Directory.
Description: (Optional)
Template Parameter: (Required) Select SourceDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory for the source file. Example: /root/{projectName}/Inbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
SourceFileName
Parameter Name: (Required) Enter Source File Name.
Description: (Optional)
Template Parameter: (Required) Select SourceFileName.
Parameter Type: (Required) Select Text.
Default Value: (Recommended) Enter the filename of the CSV file exactly as it was generated from the Installation Kit: Work_Group*.csv
Caution: Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.
Caution: Import integrations accept only UTF-8 encoded input files.
User Prompted: If the value does not need to be changed when the integration runs, select No.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Work Group Export integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Work Group Export
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select Source/Output Download.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select WorkGroupExport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Job Code Work Group Import integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Job Code Work Group Import
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select File Upload.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select JobCodeWorkGroupMappingImport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
SourceDirectory
Parameter Name: (Required) Enter Source Directory.
Description: (Optional)
Template Parameter: (Required) Select SourceDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory for the source file. Example: /root/{projectName}/Inbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
SourceFileName
Parameter Name: (Required) Enter Source File Name.
Description: (Optional)
Template Parameter: (Required) Select SourceFileName.
Parameter Type: (Required) Select Text.
Default Value: (Recommended) Enter the filename of the CSV file exactly as it was generated from the Installation Kit: Job_Code_Mappings*.csv
Caution: Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.
Caution: Import integrations accept only UTF-8 encoded input files.
User Prompted: If the value does not need to be changed when the integration runs, select No.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Job Code Work Group Export integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Job Code Work Group Export
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select Source/Output Download.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select JobCodeWorkGroupMappingExport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Billing Department Mapping Import integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Billing Department Import
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select File Upload.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select BillingDeptMappingImport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
SourceDirectory
Parameter Name: (Required) Enter Source Directory.
Description: (Optional)
Template Parameter: (Required) Select SourceDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory for the source file. Example: /root/{projectName}/Inbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
SourceFileName
Parameter Name: (Required) Enter Source File Name.
Description: (Optional)
Template Parameter: (Required) Select SourceFileName.
Parameter Type: (Required) Select Text.
Default Value: (Recommended) Enter the filename of the CSV file exactly as it was generated from the Installation Kit: Billing_Dept_Mapping_Consolid*.csv
Caution: Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.
Caution: Import integrations accept only UTF-8 encoded input files.
User Prompted: If the value does not need to be changed when the integration runs, select No.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Billing Department Mapping Export integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Billing Department Export
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select Source/Output Download.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select BillingDeptMappingExport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Charge Master Import integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Charge Master Import
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select File Upload.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select ChargeMasterImport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
SourceDirectory
Parameter Name: (Required) Enter Source Directory.
Description: (Optional)
Template Parameter: (Required) Select SourceDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory for the source file. Example: /root/{projectName}/Inbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
SourceFileName
Parameter Name: (Required) Enter Source File Name.
Description: (Optional)
Template Parameter: (Required) Select SourceFileName.
Parameter Type: (Required) Select Text.
Default Value: (Recommended) Enter the filename of the CSV file exactly as it was generated from the Installation Kit: Charge_Master*.csv
Caution: Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.
Caution: Import integrations accept only UTF-8 encoded input files.
User Prompted: If the value does not need to be changed when the integration runs, select No.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Charge Master Export integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Charge Master Export
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select Source/Output Download.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select ChargeMasterExport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Volume Department Copy Import integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Volume Department Copy Import
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select File Upload.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select VolumeDeptCopyImport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
SourceDirectory
Parameter Name: (Required) Enter Source Directory.
Description: (Optional)
Template Parameter: (Required) Select SourceDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory for the source file. Example: /root/{projectName}/Inbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
SourceFileName
Parameter Name: (Required) Enter Source File Name.
Description: (Optional)
Template Parameter: (Required) Select SourceFileName.
Parameter Type: (Required) Select Text.
Default Value: (Recommended) Enter the filename of the CSV file exactly as it was generated from the Installation Kit: Volume_Dept_Copy*.csv
Caution: Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.
Caution: Import integrations accept only UTF-8 encoded input files.
User Prompted: If the value does not need to be changed when the integration runs, select No.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Volume Department Copy Export integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Volume Department Copy Export
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select Source/Output Download.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select VolumeDeptCopyExport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Volume Department Copy Override Import integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Volume Department Copy Override Import
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select File Upload.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select VolumeDeptCopyOverrideImport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
SourceDirectory
Parameter Name: (Required) Enter Source Directory.
Description: (Optional)
Template Parameter: (Required) Select SourceDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory for the source file. Example: /root/{projectName}/Inbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
SourceFileName
Parameter Name: (Required) Enter Source File Name.
Description: (Optional)
Template Parameter: (Required) Select SourceFileName.
Parameter Type: (Required) Select Text.
Default Value: (Recommended) Enter the filename of the CSV file exactly as it was generated from the Installation Kit: Volume_Copy_Override*.csv
Caution: Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.
Caution: Import integrations accept only UTF-8 encoded input files.
User Prompted: If the value does not need to be changed when the integration runs, select No.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Volume Department Copy Override Export integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Volume Department Copy Override Export
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select Source/Output Download.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select VolumeDeptCopyOverrideExport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Payroll Department Mapping Import integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Payroll Department Mapping Import
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select File Upload.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select PayrollDeptMappingImport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
SourceDirectory
Parameter Name: (Required) Enter Source Directory.
Description: (Optional)
Template Parameter: (Required) Select SourceDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory for the source file. Example: /root/{projectName}/Inbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
SourceFileName
Parameter Name: (Required) Enter Source File Name.
Description: (Optional)
Template Parameter: (Required) Select SourceFileName.
Parameter Type: (Required) Select Text.
Default Value: (Recommended) Enter the filename of the CSV file exactly as it was generated from the Installation Kit: Payroll_Dept_Mapping*.csv
Caution: Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.
Caution: Import integrations accept only UTF-8 encoded input files.
User Prompted: If the value does not need to be changed when the integration runs, select No.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Payroll Department Mapping Export integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Payroll Department Mapping Export
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select Source/Output Download.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select PayrollDeptMappingExport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Payroll Employment Status Mapping Import integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Employment Status Mapping Import
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select File Upload.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select PayrollEmplmtStatusMappingImport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
SourceDirectory
Parameter Name: (Required) Enter Source Directory.
Description: (Optional)
Template Parameter: (Required) Select SourceDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory for the source file. Example: /root/{projectName}/Inbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
SourceFileName
Parameter Name: (Required) Enter Source File Name.
Description: (Optional)
Template Parameter: (Required) Select SourceFileName.
Parameter Type: (Required) Select Text.
Default Value: (Recommended) Enter the filename of the CSV file exactly as it was generated from the Installation Kit: Payroll_Emplmt_Status_Code_Cat*.csv
Caution: Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.
Caution: Import integrations accept only UTF-8 encoded input files.
User Prompted: If the value does not need to be changed when the integration runs, select No.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Payroll Employment Status Mapping Export integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Employment Status Mapping Export
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select Source/Output Download.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select PayrollEmplmtStatusMappingExport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Payroll Job Mapping Import integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Payroll Job Mapping Import
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select File Upload.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select PayrollJobMappingImport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
SourceDirectory
Parameter Name: (Required) Enter Source Directory.
Description: (Optional)
Template Parameter: (Required) Select SourceDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory for the source file. Example: /root/{projectName}/Inbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
SourceFileName
Parameter Name: (Required) Enter Source File Name.
Description: (Optional)
Template Parameter: (Required) Select SourceFileName.
Parameter Type: (Required) Select Text.
Default Value: (Recommended) Enter the filename of the CSV file exactly as it was generated from the Installation Kit: Payroll_Job_Mapping*.csv
Caution: Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.
Caution: Import integrations accept only UTF-8 encoded input files.
User Prompted: If the value does not need to be changed when the integration runs, select No.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Payroll Job Mapping Export integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Payroll Job Mapping Export
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select Source/Output Download.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select PayrollJobMappingExport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Targets Import integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Targets Import
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select File Upload.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select TargetsImport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
SourceDirectory
Parameter Name: (Required) Enter Source Directory.
Description: (Optional)
Template Parameter: (Required) Select SourceDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory for the source file. Example: /root/{projectName}/Inbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
SourceFileName
Parameter Name: (Required) Enter Source File Name.
Description: (Optional)
Template Parameter: (Required) Select SourceFileName.
Parameter Type: (Required) Select Text.
Default Value: (Recommended) Enter the filename of the CSV file exactly as it was generated from the Installation Kit: Targets*.csv
Caution: Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.
Caution: Import integrations accept only UTF-8 encoded input files.
User Prompted: If the value does not need to be changed when the integration runs, select No.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Targets Export integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Targets Export
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select Source/Output Download.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select TargetsExport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Fiscal Calendar Import integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Fiscal Calendar
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select File Upload.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select FiscalCalendar-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
SourceDirectory
Parameter Name: (Required) Enter Source Directory.
Description: (Optional)
Template Parameter: (Required) Select SourceDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory for the source file. Example: /root/{projectName}/Inbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
SourceFileName
Parameter Name: (Required) Enter Source File Name.
Description: (Optional)
Template Parameter: (Required) Select SourceFileName.
Parameter Type: (Required) Select Text.
Default Value: (Recommended) Enter the filename of the CSV file exactly as it was generated from the Installation Kit: Fiscal_Calendar*.csv
Caution: Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.
Caution: Import integrations accept only UTF-8 encoded input files.
User Prompted: If the value does not need to be changed when the integration runs, select No.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Volume Import integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Volume
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select File Upload.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select Volume-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the transaction file from the billing system. This file is also called the volume feed.
BillingFileName
Parameter Name: (Required) Enter Billing Filename.
Description: (Optional)
Template Parameter: (Required) Select BillingFileName.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the name of the CSV file exactly as it was generated by the billing system. Example: Volume*.csv
Caution: Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.
Caution: Import integrations accept only UTF-8 encoded input files.
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the patient flag if the volume feed contains 9 columns and it provides the patient type:
PatientFlag
Parameter Name: (Required) Enter Patient Flag.
Description: (Optional)
Template Parameter: (Required) Select PatientFlag.
Parameter Type: (Required) Select Boolean.
Default Value: (Recommended) Enter one of the following:
- True if the patient flag is defined in the volume feed.
- False if the patient flag is not defined in the volume feed.
User Prompted: If the value does not need to be changed when the integration runs, select No.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
IsBillingFileRolling?
Parameter Name: (Required) Enter Is Billing File Rolling?.
Description: (Optional)
Template Parameter: (Required) Select IsBillingFileRolling?.
Parameter Type: (Required) Select Boolean.
Default Value: (Recommended) Enter one of the following:
- True if the manual volume feed contains old and new records.
- False if the manual volume feed does not contain old records.
User Prompted: If the value does not need to be changed when the integration runs, select No.
Click Tap Save.
Click Tap Create
. Enter the values for the manually generated volume feed. If both billing and manual files are defined, the Integration can process both files in one installation.
ManualFileName
Parameter Name: (Required) Enter Manual Filename.
Description: (Optional)
Template Parameter: (Required) Select ManualFileName.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the name of the CSV file exactly as it was generated by the billing system. Example: Manual_Volume*.csv
Caution: Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.
Caution: Import integrations accept only UTF-8 encoded input files.
User Prompted: (Recommended) Select No if the volume feed does have not a manual file.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
IsManualFileRolling?
Parameter Name: (Required) Enter Is Manual File Rolling?.
Description: (Optional)
Template Parameter: (Required) Select IsManualFileRolling?.
Parameter Type: (Required) Select Boolean.
Default Value: (Recommended) Enter one of the following:
- True if the manual volume feed contains old and new records.
- False if the manual volume feed does not contain old records.
User Prompted: (Recommended) Select No if the volume feed does have not a manual file.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
SourceDirectory
Parameter Name: (Required) Enter Source Directory.
Description: (Optional)
Template Parameter: (Required) Select SourceDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory for the source file. Example: /root/{projectName}/Inbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Payroll Import integrations
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Payroll
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select File Upload.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select Payroll-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
SourceFileName
Parameter Name: (Required) Enter Source File Name.
Description: (Optional)
Template Parameter: (Required) Select SourceFileName.
Parameter Type: (Required) Select Text.
Default Value: (Recommended) Enter the filename of the CSV file exactly as it was generated from the Installation Kit: Payroll*.csv
Caution: Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.
Caution: Import integrations accept only UTF-8 encoded input files.
User Prompted: If the value does not need to be changed when the integration runs, select No.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
SourceDirectory
Parameter Name: (Required) Enter Source Directory.
Description: (Optional)
Template Parameter: (Required) Select SourceDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory for the source file. Example: /root/{projectName}/Inbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
- Click Tap Create
- True — Merge cumulative exception records with new records in the payroll import only when the pay period end date and employee number match the exception records. Otherwise, save the exception records without merging.
- False — Do not merge cumulative exception records with new records.
- Click Tap Save.
Enter the values for the following parameter:
processHistoricalErroneousRecords
Parameter Name: (Required) Enter Process Historical Erroneous Records.
Description: (Optional)
Template Parameter: (Required) Select processHistoricalErroneousRecords.
Parameter Type: (Required) Select Boolean.
Default Value: (Recommended) Enter one of the following:
Install the Agency Export integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Agency Export
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select Source/Output Download.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select AgencyExport-v1.
- Click Tap Assign
. - (Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: Enter the path to and the name of the same SFTP directory for the input file for the Agency Import integration. Default = Inbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
ReferenceDate
Parameter Name: (Required) Enter Reference Date.
Description: (Optional)
Template Parameter: (Required) Select ReferenceDate.
Parameter Type: (Required) Select Date.
Default Value: (Optional) Select a default date.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
AgencyEmployees
Parameter Name: (Required) Enter Agency Employees.
Description: (Optional)
Template Parameter: (Required) Select AgencyEmployees.
Parameter Type: (Required) Select Hyperfind.
Default Value: Select the Agency Employees hyperfind query that you configured in Configure the Agency Export and Import for Healthcare Productivity as the default hyperfind.
Caution: If this hyperfind is not configured, the integration uses the All People hyperfind.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Agency Import integration
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Agency Import
- (Optional) Enter a Description.
- Clear API Integration.
- In File Access, select File Upload.
- (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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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 Connection, click tap SFTP.
- (Optional) In Scheduling Configuration, you can configure the behavior for integrations that are scheduled to run frequently if the integrations overlap in time; for details, see Scheduling Configuration.
- Integration templates and parameters
- In the Integration Template table, select AgencyImport-v1.
- Click Tap Assign
. -
(Optional) In Integration Parameters, you can override default settings:
- Click Tap Create
. - Enter the values for the following parameter:
SourceDirectory
Parameter Name: (Required) Enter Source Directory.
Description: (Optional)
Template Parameter: (Required) Select SourceDirectory.
Parameter Type: (Required) Select Text.
Default Value: Enter the path to and the name of the same SFTP directory for the input file for the Agency Export integration. Default = Inbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
SourceFileName
Parameter Name: (Required) Enter Source File Name.
Description: (Optional)
Template Parameter: (Required) Select SourceFileName.
Parameter Type: (Required) Select Text.
Default Value: (Recommended) Enter the filename of the CSV file exactly as it was generated: Agency_Export*.csv
Caution: Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.
Caution: Import integrations accept only UTF-8 encoded input files.
User Prompted: If the value does not need to be changed when the integration runs, select No.
Click Tap Save.
Click Tap Create
. Enter the values for the following parameter:
OutputDirectory
Parameter Name: (Required) Enter Output Directory.
Description: (Optional)
Template Parameter: (Required) Select OutputDirectory.
Parameter Type: (Required) Select Text.
Default Value: (Required) Enter the path to and the name of a default directory to archive the output file. For import integrations, this directory also stores the generated exceptions file. Example: /root/{projectName}/Outbound
User Prompted: (Recommended) Select No to prevent accidental changes to the path to the directory.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Install the Recalculate integration
Before you start, create the Domain integration list parameters and DomainList parameter; see Configure Integration List Parameters for Healthcare Productivity.
- Click Tap Create
. - Enter an appropriate, unique, and descriptive Integration Name. Example: Recalculate
- (Optional) Enter a Description.
- Do not select API Integration.
- In File Access, select None.
- 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.
-
Email Notifications
(Optional)
- Select Yes to send email and control center notifications for integration runs.
- 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.
- Do not define Scheduling Configuration:
- In Skip Configuration, select None.
- You cannot select Allow Minute Interval.
- Integration templates and parameters
- In the Integration Template table, select Recalculate-v1.
- Click Tap Assign
. -
In Integration Parameters, you can override default settings:
- Click Tap Create
. - (Required) Enter the values for the following parameter:
Domain
Parameter Name: (Required) Enter Domain.
Description: (Optional)
Template Parameter: (Required) Select the Domain integration list parameters that you created.
Parameter Type: (Required) Select Dropdown.
Default Value: (Required) Select the Domain integration list parameters that you created.
User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
Click Tap Save.
Note: Define both Start Date and End Date, or define neither. If you do not define both date parameters, the integration uses the default date range of today and the 29 previous days.
Click Tap Create
. (Optional) Enter the values for the following parameter:
StartDate
Parameter Name: (Required) Enter Start Date.
Description: (Optional)
Template Parameter: (Required) Select StartDate.
Parameter Type: (Required) Select Date.
Default Value: (Required) Leave blank.
User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
Click Tap Save.
Click Tap Create
. (Optional) Enter the values for the following parameter:
EndDate
Parameter Name: (Required) Enter End Date.
Description: (Optional)
Template Parameter: (Required) Select EndDate.
Parameter Type: (Required) Select Date.
Default Value: (Required) Leave blank.
User Prompted: To prompt the person who manually runs the integration to set this parameter, select Yes.
Click Tap Save.
- Click Tap Create
- Click Tap Save.
Configure access to the integrations
Configure the GDAP for the people who need to run the installed integrations; see Configure Access to Integrations.