Run and Test Integrations for Healthcare Productivity

How to run, schedule, set parameter values, check the status of, and troubleshoot integrations for Healthcare Productivity.

Run integrations to test that the configuration is set up correctly.

Requirements of the integrations

  • The source files must be in comma-separated values (CSV) format. Any other format fails the integrations.
  • When input parameters are incorrect, the integration fails.
  • When files are missing or fail, the integration fails.
  • Integrations cannot run simultaneously but only one at a time.

Test the integrations

How to run each integration to test that the Healthcare Productivity configuration is correct.

Run each integration to test that the configuration is correct.

Note: Only for integrations that have import and export versions, you can run the import integration, then run the corresponding export integration to check the output file and make sure that the import processed the records correctly. Example: Run Work Unit Import, then run Work Unit Export and check the output file.

Work Unit Import

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Work Unit Import integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.

    Example: For test runs, it can be helpful to change the filename.

  5. (Not recommended) You can select a different source file. Click Tap Browse and navigate to and select the file.
    Caution:
    • (Required)

      Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.

    • For scheduled runs of the integration, do not select a different source file. The default file was generated from the installation kit, and a scheduled integration cannot run without it.
    • For manual runs of the integration, you must enter the complete file name of the source file. Otherwise if the Inbound folder contains multiple files, the integration cannot distinguish which source file is the correct file to process, especially if you use wildcards (*) in the file name.
    • The maximum size of source file is 1 MB. However, you can compress a larger file and select the compressed *.zip file as the source file.
    • The format of the file must be .csv, .zip, .pgp, or .gpg.
  6. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

  7. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  8. If the integration run failed , check for errors in the following:
    • Each Work Unit Code and Work Unit Name is unique.
    • The Work Unit Code cannot be longer than 50 characters.
    • The Work Unit Name cannot be longer than 256 characters.
    • The organizational path in the work unit configuration must correspond to a path in the business structure.
    • The default Service Line is UNK_SVC_LN.
    • FTE Hours has 6 decimal places or less.
    • Each WFD Pay Rule is defined in the database.
    • Work Group Code is optional even if the Work Unit Type is a work group.
    • For errors that are common to all integrations; see Check the results > Troubleshooting.

Work Unit Export

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Work Unit Export integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

    See Check the results.

  6. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  7. Make sure that the exported data corresponds to the source data:
    1. Open the source (input) and exported (output) files.
    2. Compare the data for accuracy.

Work Unit Hyperfinds Import

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Work Unit Hyperfinds Import integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. (Not recommended) You can select a different source file. Click Tap Browse and navigate to and select the file.
    Caution:
    • (Required)

      Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.

    • For scheduled runs of the integration, do not select a different source file. The default file was generated from the installation kit, and a scheduled integration cannot run without it.
    • For manual runs of the integration, you must enter the complete file name of the source file. Otherwise if the Inbound folder contains multiple files, the integration cannot distinguish which source file is the correct file to process, especially if you use wildcards (*) in the file name.
    • The maximum size of source file is 1 MB. However, you can compress a larger file and select the compressed *.zip file as the source file.
    • The format of the file must be .csv, .zip, .pgp, or .gpg.
  6. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

  7. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  8. If the integration run failed , check for errors in the following:
    • For errors that are common to all integrations; see Check the results > Troubleshooting.

Work Unit Hyperfinds Export

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Work Unit Hyperfinds Export integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

    See Check the results.

  6. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  7. Make sure that the exported data corresponds to the source data:
    1. Open the source (input) and exported (output) files.
    2. Compare the data for accuracy.

Work Unit Hyperfind Profiles Import

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Work Unit Hyperfind Profiles Import integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. (Not recommended) You can select a different source file. Click Tap Browse and navigate to and select the file.
    Caution:
    • (Required)

      Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.

    • For scheduled runs of the integration, do not select a different source file. The default file was generated from the installation kit, and a scheduled integration cannot run without it.
    • For manual runs of the integration, you must enter the complete file name of the source file. Otherwise if the Inbound folder contains multiple files, the integration cannot distinguish which source file is the correct file to process, especially if you use wildcards (*) in the file name.
    • The maximum size of source file is 1 MB. However, you can compress a larger file and select the compressed *.zip file as the source file.
    • The format of the file must be .csv, .zip, .pgp, or .gpg.
  6. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

  7. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  8. If the integration run failed , check for errors in the following:
    • For errors that are common to all integrations; see Check the results > Troubleshooting.

Work Unit Hyperfind Profiles Export

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Work Unit Hyperfind Profiles Export integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

    See Check the results.

  6. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  7. Make sure that the exported data corresponds to the source data:
    1. Open the source (input) and exported (output) files.
    2. Compare the data for accuracy.

Work Group Import

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Work Group Import integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. (Not recommended) You can select a different source file. Click Tap Browse and navigate to and select the file.
    Caution:
    • (Required)

      Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.

    • For scheduled runs of the integration, do not select a different source file. The default file was generated from the installation kit, and a scheduled integration cannot run without it.
    • For manual runs of the integration, you must enter the complete file name of the source file. Otherwise if the Inbound folder contains multiple files, the integration cannot distinguish which source file is the correct file to process, especially if you use wildcards (*) in the file name.
    • The maximum size of source file is 1 MB. However, you can compress a larger file and select the compressed *.zip file as the source file.
    • The format of the file must be .csv, .zip, .pgp, or .gpg.
  6. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

  7. If the integration run failed , check for errors in the following:
    • Each Work Group Code is unique.
    • Each Work Group Code and Work Group Description is not blank.
    • The maximum length of Work Group Code is 50 characters, and Work Group Description is 256 characters.
    • No records are duplicated.
    • For errors that are common to all integrations; see Check the results > Troubleshooting.

Work Group Export

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Work Group Export integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

    See Check the results.

  6. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  7. Make sure that the exported data corresponds to the source data:
    1. Open the source (input) and exported (output) files.
    2. Compare the data for accuracy.

Job Code Work Group Import

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Job Code Work Group Import integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. (Not recommended) You can select a different source file. Click Tap Browse and navigate to and select the file.
    Caution:
    • (Required)

      Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.

    • For scheduled runs of the integration, do not select a different source file. The default file was generated from the installation kit, and a scheduled integration cannot run without it.
    • For manual runs of the integration, you must enter the complete file name of the source file. Otherwise if the Inbound folder contains multiple files, the integration cannot distinguish which source file is the correct file to process, especially if you use wildcards (*) in the file name.
    • The maximum size of source file is 1 MB. However, you can compress a larger file and select the compressed *.zip file as the source file.
    • The format of the file must be .csv, .zip, .pgp, or .gpg.
  6. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

  7. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  8. If the integration run failed , check for errors in the following:
    • Each combination of Job Name and Work Group Code is unique.
    • A job cannot be mapped to more than one work group.
    • Each Job Name and Work Group Code is not blank.
    • The generic jobs and work groups must be defined in the system.
    • For errors that are common to all integrations; see Check the results > Troubleshooting.

Job Code Work Group Export

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Job Code Work Group Export integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

    See Check the results.

  6. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  7. Make sure that the exported data corresponds to the source data:
    1. Open the source (input) and exported (output) files.
    2. Compare the data for accuracy.

Billing Department Mapping Import

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Billing Department Import integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. (Not recommended) You can select a different source file. Click Tap Browse and navigate to and select the file.
    Caution:
    • (Required)

      Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.

    • For scheduled runs of the integration, do not select a different source file. The default file was generated from the installation kit, and a scheduled integration cannot run without it.
    • For manual runs of the integration, you must enter the complete file name of the source file. Otherwise if the Inbound folder contains multiple files, the integration cannot distinguish which source file is the correct file to process, especially if you use wildcards (*) in the file name.
    • The maximum size of source file is 1 MB. However, you can compress a larger file and select the compressed *.zip file as the source file.
    • The format of the file must be .csv, .zip, .pgp, or .gpg.
  6. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

  7. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  8. If the integration run failed , check for errors in the following:
    • The work units must be defined in the system.
    • Work Unit Code, Billing Facility Code, and Billing Department Code must be unique, because the system cannot determine which duplicate record is correct.
    • Only Facility, Department, and Custom type work units are supported; Combination type work units are not supported.
    • For errors that are common to all integrations; see Check the results > Troubleshooting.

Billing Department Mapping Export

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Billing Department Export integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

    See Check the results.

  6. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  7. Make sure that the exported data corresponds to the source data:
    1. Open the source (input) and exported (output) files.
    2. Compare the data for accuracy.

Charge Master Import

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Charge Master Import integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. (Not recommended) You can select a different source file. Click Tap Browse and navigate to and select the file.
    Caution:
    • (Required)

      Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.

    • For scheduled runs of the integration, do not select a different source file. The default file was generated from the installation kit, and a scheduled integration cannot run without it.
    • For manual runs of the integration, you must enter the complete file name of the source file. Otherwise if the Inbound folder contains multiple files, the integration cannot distinguish which source file is the correct file to process, especially if you use wildcards (*) in the file name.
    • The maximum size of source file is 1 MB. However, you can compress a larger file and select the compressed *.zip file as the source file.
    • The format of the file must be .csv, .zip, .pgp, or .gpg.
  6. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.
      Caution: Rows are updated only when the Weight or Effective Date changes. To update the Billing Department Code or the Procedure Code, the Weight or Effective Date must be updated for the changed rows.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

  7. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  8. If the integration run failed , check for errors in the following:
    • Billing Facility Code, Billing Department Code, and Procedure Code must be unique, because the system cannot determine which duplicate record is correct.
    • For errors that are common to all integrations; see Check the results > Troubleshooting.

Charge Master Export

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Charge Master Export integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

    See Check the results.

  6. Make sure that the exported data corresponds to the source data:
    1. Open the source (input) and exported (output) files.
    2. Compare the data for accuracy.

    Example: If the Effective Date and Weight for the same Procedure Code change, the integration exports two records. Time periods cannot overlap, so a later Effective Date sets an end date for the previous record. Example: An Effective Date of 12/1/2021 on the second record ends the previous record on 11/30/2021.

    Example charge master export

    Example exported charge master data

    Billing Facility Code

    Billing Department Code

    Procedure Code

    Procedure Code Description

    Weight

    Effective Date

    1183140-MedSurg1

    1183140-MedSurg1

    0011072

    X-Ray MedSurge 1

    1.000000

    1/1/2021

    1183140-MedSurg1

    1183140-MedSurg1

    0011072

    X-Ray MedSurge 1

    1.500000

    12/1/2021

Volume Department Copy Import

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Volume Department Copy Import integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. (Not recommended) You can select a different source file. Click Tap Browse and navigate to and select the file.
    Caution:
    • (Required)

      Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.

    • For scheduled runs of the integration, do not select a different source file. The default file was generated from the installation kit, and a scheduled integration cannot run without it.
    • For manual runs of the integration, you must enter the complete file name of the source file. Otherwise if the Inbound folder contains multiple files, the integration cannot distinguish which source file is the correct file to process, especially if you use wildcards (*) in the file name.
    • The maximum size of source file is 1 MB. However, you can compress a larger file and select the compressed *.zip file as the source file.
    • The format of the file must be .csv, .zip, .pgp, or .gpg.
  6. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

  7. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  8. If the integration run failed , check for errors in the following:
    • Billing Facility Code, Billing Department Code, Destination Billing Facility Code, and Destination Billing Department Code must be unique, because the system cannot determine which duplicate record is correct.
    • For errors that are common to all integrations; see Check the results > Troubleshooting.

Volume Department Copy Export

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Volume Department Copy Export integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

    See Check the results.

  6. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  7. Make sure that the exported data corresponds to the source data:
    1. Open the source (input) and exported (output) files.
    2. Compare the data for accuracy.

Volume Department Copy Override Import

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Volume Department Copy Override Import integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. (Not recommended) You can select a different source file. Click Tap Browse and navigate to and select the file.
    Caution:
    • (Required)

      Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.

    • For scheduled runs of the integration, do not select a different source file. The default file was generated from the installation kit, and a scheduled integration cannot run without it.
    • For manual runs of the integration, you must enter the complete file name of the source file. Otherwise if the Inbound folder contains multiple files, the integration cannot distinguish which source file is the correct file to process, especially if you use wildcards (*) in the file name.
    • The maximum size of source file is 1 MB. However, you can compress a larger file and select the compressed *.zip file as the source file.
    • The format of the file must be .csv, .zip, .pgp, or .gpg.
  6. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

  7. If the integration run failed , check for errors in the following:
    • Billing Facility Code, Billing Department Code, Destination Billing Facility Code, Destination Billing Department Code, and Procedure Code must be unique, because the system cannot determine which duplicate record is correct.
    • Make sure that the combination of the Billing Facility Code and Billing Department Code in the source file and the destination file is configured in the billing department mapping.
    • Avoid looping logic between the Volume Department Copy and Volume Department Copy Override integrations. Example: Do not import volume departments, override those departments, then import again those same departments.
    • For errors that are common to all integrations; see Check the results > Troubleshooting.

Volume Department Copy Override Export

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Volume Department Copy Override Export integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

    See Check the results.

  6. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  7. Make sure that the exported data corresponds to the source data:
    1. Open the source (input) and exported (output) files.
    2. Compare the data for accuracy.

Payroll Department Mapping Import

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Payroll Department Mapping Import integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. (Not recommended) You can select a different source file. Click Tap Browse and navigate to and select the file.
    Caution:
    • (Required)

      Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.

    • For scheduled runs of the integration, do not select a different source file. The default file was generated from the installation kit, and a scheduled integration cannot run without it.
    • For manual runs of the integration, you must enter the complete file name of the source file. Otherwise if the Inbound folder contains multiple files, the integration cannot distinguish which source file is the correct file to process, especially if you use wildcards (*) in the file name.
    • The maximum size of source file is 1 MB. However, you can compress a larger file and select the compressed *.zip file as the source file.
    • The format of the file must be .csv, .zip, .pgp, or .gpg.
  6. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

  7. If the integration run failed , check for errors in the following:
    • Each paycode must be unique within the input file.
    • The same Payroll Facility Code, Payroll Department Code, or Payroll Source must not map to multiple work units, unless the Delete Switch for all but one of the work units is 1. The combined payroll facility, department, and source must be unique.
    • Each Delete Switch is 0 or 1.
    • For errors that are common to all integrations; see Check the results > Troubleshooting.

Payroll Department Mapping Export

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Payroll Department Mapping Export integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

    See Check the results.

  6. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  7. Make sure that the exported data corresponds to the source data:
    1. Open the source (input) and exported (output) files.
    2. Compare the data for accuracy.

Payroll Employment Status Mapping Import

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Payroll Employment Status Mapping Import integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. (Not recommended) You can select a different source file. Click Tap Browse and navigate to and select the file.
    Caution:
    • (Required)

      Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.

    • For scheduled runs of the integration, do not select a different source file. The default file was generated from the installation kit, and a scheduled integration cannot run without it.
    • For manual runs of the integration, you must enter the complete file name of the source file. Otherwise if the Inbound folder contains multiple files, the integration cannot distinguish which source file is the correct file to process, especially if you use wildcards (*) in the file name.
    • The maximum size of source file is 1 MB. However, you can compress a larger file and select the compressed *.zip file as the source file.
    • The format of the file must be .csv, .zip, .pgp, or .gpg.
  6. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

    See Check the results.

Payroll Employment Status Mapping Export

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Payroll Employment Status Mapping Export integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

    See Check the results.

  6. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  7. Make sure that the exported data corresponds to the source data:
    1. Open the source (input) and exported (output) files.
    2. Compare the data for accuracy.

Payroll Job Mapping Import

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Payroll Job Mapping Import integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. (Not recommended) You can select a different source file. Click Tap Browse and navigate to and select the file.
    Caution:
    • (Required)

      Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.

    • For scheduled runs of the integration, do not select a different source file. The default file was generated from the installation kit, and a scheduled integration cannot run without it.
    • For manual runs of the integration, you must enter the complete file name of the source file. Otherwise if the Inbound folder contains multiple files, the integration cannot distinguish which source file is the correct file to process, especially if you use wildcards (*) in the file name.
    • The maximum size of source file is 1 MB. However, you can compress a larger file and select the compressed *.zip file as the source file.
    • The format of the file must be .csv, .zip, .pgp, or .gpg.
  6. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

  7. If the integration run failed , check for errors in the following:
    • The same Labor Category Entry(payroll job) and Payroll Source must not map to multiple Job Name s (generic jobs), unless the Delete Switch for all but one of the jobs is 1.
    • For errors that are common to all integrations; see Check the results > Troubleshooting.

Payroll Job Mapping Export

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Payroll Job Mapping Export integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

    See Check the results.

  6. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  7. Make sure that the exported data corresponds to the source data:
    1. Open the source (input) and exported (output) files.
    2. Compare the data for accuracy.

Targets Import

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Targets Import integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. (Not recommended) You can select a different source file. Click Tap Browse and navigate to and select the file.
    Caution:
    • (Required)

      Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.

    • For scheduled runs of the integration, do not select a different source file. The default file was generated from the installation kit, and a scheduled integration cannot run without it.
    • For manual runs of the integration, you must enter the complete file name of the source file. Otherwise if the Inbound folder contains multiple files, the integration cannot distinguish which source file is the correct file to process, especially if you use wildcards (*) in the file name.
    • The maximum size of source file is 1 MB. However, you can compress a larger file and select the compressed *.zip file as the source file.
    • The format of the file must be .csv, .zip, .pgp, or .gpg.
  6. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

  7. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  8. If the integration run failed , check for errors in the following:
    • Fixed and Variable targets are validated.
      • If a validation fails, the target definition is rejected for that combined work unit and metric.
      • Fixed or Variable targets that are empty are excluded from the target definition for a combined work unit, metric, and effective date.
    • Fixed target validations:
      • Each fixed target must have a default value.
      • Targets must be numbers; alphabetic characters are not valid.
      • Maximum length of the target is 10 digits before and 6 digits after the decimal point.
      • The Adjustment Flag applies only to the Productive Hours (daily or pay period) metric.
    • Variable target validations:
      • Each pay-period and daily-ratio target must have a default value. Alternate pay-period values are optional.
      • Targets must be numbers; alphabetic characters are not valid.
      • Maximum length of the target is 10 digits before and 6 digits after the decimal point.
      • If any fixed or variable target has an error, you must submit all of the data again.
      • Group records by Work Unit Code and metric name so that multiple records for the same combined work unit and metric are together and validated for date overlaps.
      • Work units must have pay periods defined in the system before you can import the targets for the pay period end date. Otherwise, these records fail the integration run.
    • Date-overlap validations: The same pay period (same start and end dates) cannot have more than one target definition. Otherwise, the records for that work unit and metric are rejected.
    • The Start Date of a pay period is used as the effective date. The expiration date is forever or is calculated if the same work unit has multiple pay periods. For multiple pay periods, the most recent last date of a pay period has an expiration date of forever, and all other pay period end dates are the respective expiration dates.
    • The possible values for targetType are hca_fixed_target and hca_variable_target.
    • For targetFunctions, the values contain name= PRODUCTIVE_HRS and qualifier= METRIC_SET.
    • All of the required fields are not blank.
    • Each Work Unit Code and Pay Period End Date is unique.
    • The date format is MM/DD/YYYY.
    • For errors that are common to all integrations; see Check the results > Troubleshooting.

Targets Export

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Targets Export integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

    See Check the results.

  6. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  7. Make sure that the exported data corresponds to the source data:
    1. Open the source (input) and exported (output) files.
    2. Compare the data for accuracy.

Fiscal Calendar Import

Healthcare Productivity

Note: Multiple files are not supported for this integration, that is, it can run only one file at a time from the SFTP server.
  1. Make sure that Fiscal Calendar Import is Allowed in your FAP; see Configure Access to Healthcare Productivity.
  2. Select Main Menu Maintenance > Integrations.
  3. Click Tap Run an Integration .
  4. Select the Fiscal Calendar Import integration. Click Tap Select.
  5. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  6. (Not recommended) You can select a different source file. Click Tap Browse and navigate to and select the file.
    Caution:
    • (Required)

      Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.

    • For scheduled runs of the integration, do not select a different source file. The default file was generated from the installation kit, and a scheduled integration cannot run without it.
    • For manual runs of the integration, you must enter the complete file name of the source file. Otherwise if the Inbound folder contains multiple files, the integration cannot distinguish which source file is the correct file to process, especially if you use wildcards (*) in the file name.
    • The maximum size of source file is 1 MB. However, you can compress a larger file and select the compressed *.zip file as the source file.
    • The format of the file must be .csv, .zip, .pgp, or .gpg.
  7. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

  8. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  9. If the integration run failed , check for errors in the following:
    • All dates for this fiscal year are in sequence, and no date is skipped between any first and last entry.
    • FSCL_DAY_OF_YR_NBR starts at 1 and goes up in incremental order.
    • FSCL_WK_OF_YR_NBR starts at 1 and repeats in incremental order.
    • FSCL_MO_OF_YR_NBR starts at 1 and repeats in incremental order.
    • FSCL_QTR_OF_YR_NBR starts at 1 and repeats in incremental order.
    • For errors that are common to all integrations; see Check the results > Troubleshooting.

Volume Import

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Volume Import integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.

  5. Set parameters:

    Select or enter the following parameters or files:

    • Billing Filename
    • Patient Flag
    • Is Billing File Rolling?
    • Manual Filename
    • Is Manual File Rolling?
  6. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

  7. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  8. When the import process starts and finishes, notifications go the Control Center and by email.
  9. If the integration run failed , check for errors that are common to all integrations; see Check the results > Troubleshooting.
    • Rename the volume exception file and consolidate the exceptions in that file.
    • Move that file to the Inbound folder.
    • Re-run the Volume Import integration to import the rows from the volume exception file.

Volume import use case – new Charge Master

The Volume Import integration creates a new charge master if one is not defined in the database.

Scenario: This integration processes a CSV input file that contains new charge-master records with or without weights.

Example volume feed

Example volume feed data for a new charge master

Field

File 1

FCLTY_NBR

Fac1

DEPT_NBR

Dept

BILL_COD

Procedure code1

BILL_COD_DES

Procedure code1 description

VOL_QTY

10

POSTING_DAT

12/12/2021

SVC_DAT

12/12/2021

WEIGHT

(Optional)

PAT_TYPE

(Optional)

  • The volume feed has records with charges that are already in the charge master: the charges are aggregated and weight is allocated.
  • The volume feed has records with charges that are not in the charge master:
    • The integration does not check whether the charges exist for the service date, but it checks only the charges in the database.
    • The charges are added to the database with weight of null and an effective date set to the beginning of time.

      Example volume import for a new charge master

      Example volume import data for a new charge master when charges are added to the database with a weight of null and an effective date set to the beginning of time

      Field

      Charge master in database

      Billing Facility Code

      Fac1

      Billing Department Code

      Dept

      Procedure Code

      Procedure code1

      Procedure Code Description

      Procedure code1 description

      WEIGHT

      null

      Effective Date

      01/01/1753 (Beginning of Time)

      Note:
      • Records that have the unknown charge weight of null are written to an exception file and are not added to the database.
      • When you run the Charge Master Export integration, it exports the entire table and filters out the null weights.
      • Update the weights in the exported SCV file, and re-run the Charge Master Import integration with new weights to replace the charge master exceptions.

Volume import use case – Charge Master updates

If the charge master is in the system already, and you import a volume feed with a new weight for the charge master, the system expires the previous charge master with an effective end date of the day before the day you imported the volume feed (load date — 1). The system creates a new charge master with an effective date of the day you imported the volume feed (load date).

To see the records, run the Charge Master Export integration.

Volume import use case — Aggregation

Volume quantity is aggregated for records in the same file with facility number, department number, billing code, and service date.

Example volume import for aggregation

Example volume import for aggregated data

Fields

File 1

File 1

Aggregated result

FCLTY_NBR

Fac1

Fac1

Fac1

DEPT_NBR

Dept

Dept

Dept

BILL_COD

Procedure code1

Procedure code1

Procedure code1

BILL_COD_DES

Procedure code1 description

Procedure code1 description

Procedure code1 description

VOL_QTY

10

10

20

POSTING_DAT

12/12/2021

12/12/2021

12/12/2021

SVC_DAT

12/12/2021

12/12/2021

12/12/2021

WEIGHT (Optional)

—

—

—

PAT_TYPE (Optional)

—

—

—

Volume import use case — Correction or override

  • If the post date and service date are the same for earlier records, new records override VOL_QTY (volume quantity). Example: File2_Record1 replaces the volume quantity from File1_Record1.
  • If the post date is different, the volume quantity of the earlier records is aggregated, and the weighted volume for the service date accounts for the aggregated value for productivity metrics.
  • For corrections, a negative volume quantity is supported.

Example volume import for correction or override

Example volume import for corrected or overridden data

Fields

File 1

File 2

Override result

FCLTY_NBR

Fac1

Fac1

Fac1

DEPT_NBR

Dept

Dept

Dept

BILL_COD

Procedure code1

Procedure code1

Procedure code1

BILL_COD_DES

Procedure code1 description

Procedure code1 description

Procedure code1 description

VOL_QTY

10

15

15

POSTING_DAT

12/12/2021

12/12/2021

12/12/2021

SVC_DAT

12/12/2021

12/12/2021

12/12/2021

WEIGHT (Optional)

—

—

—

PAT_TYPE (Optional)

—

—

—

Payroll Import

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Payroll Import integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. (Not recommended) You can select a different source file. Click Tap Browse and navigate to and select the file.
    Caution:
    • (Required)

      Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.

    • For scheduled runs of the integration, do not select a different source file. The default file was generated from the installation kit, and a scheduled integration cannot run without it.
    • For manual runs of the integration, you must enter the complete file name of the source file. Otherwise if the Inbound folder contains multiple files, the integration cannot distinguish which source file is the correct file to process, especially if you use wildcards (*) in the file name.
    • The maximum size of source file is 1 MB. However, you can compress a larger file and select the compressed *.zip file as the source file.
    • The format of the file must be .csv, .zip, .pgp, or .gpg.
  6. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

  7. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  8. When the import process starts and finishes, notifications go the Control Center and by email.
  9. If the integration run failed , check for errors in the following:
    Note: The Payroll import integration processes employee data in batches for a pay period end date. If any records in the batch fail the validations, the integration fails all records for that employee for that pay period end date. This prevents the integration from importing invalid records. Check the error message for details.
    • The payroll data must be only for regular employees and not include data for agency employees.
    • Date formats are MM/DD/YYYY or MM-DD-YYYY.
    • The integration run fails if the following occur:

      Multiple primary job codes for an employee during one pay period

      Multiple employment status for an employee during one pay period

      Multiple standard hours values for an employee during one pay period

      Multiple home departments for an employee during one pay period

      Multiple payroll sources for the same employee during one pay period

    • Each EMP_NBR must be unique across all payroll source files.
    • The following are optional but cannot be blank:
      Caution: If these fields do not apply to a record, enter 0 for the value.

      STD_HRS

      PAY_RATE_AMT

      PAYROLL_PAYCD_HRS

      PAYROLL_PAYCD_AMT

    • The following must contain a distinct value for each combination of employee and pay period:

      HM_DEPT_COD

      STD_HRS

      PAYROLL_EMPLMT_STAT_COD

      PRI_JOB_COD

      SRC_COD: Must be a unique code that identifies the payroll source file and differentiates between payroll systems.

    • If the error indicates a Bad File, do the following:

      Open the source file and replace all values with zero ( 0).

      Run the integration again with this file that has the hours and amounts zeroed. This overrides the bad records that were imported.

      Find the correct file and run the integration again with that file.

    • Extra part time hours for an employee are calculated based on the paycode and the mapping category for the associated paycode.
    • For errors that are common to all integrations; see Check the results > Troubleshooting.

Payroll import use case — Aggregation

The hours and amounts are aggregated if there are multiple records for an employee for the same pay period that matches the following field values in the file:

  • Employee number
  • Payroll Home Facility
  • Payroll Home Department
  • Payroll Worked Facility
  • Payroll Worked Department
  • Payroll Pay Code
  • Job Code (Paid Job)
  • Payroll Employment Status Code
  • Pay Period End Date
  • Payroll Source

Example payroll import for aggregation

Example payroll import for aggregated data

Fields

Record 1

Record 2

Aggregated result

EMP_NBR

G7704

G7704

G7704

EMP_NAM

G7704FU

G7704FU

G7704FU

HM_FCLTY_COD

BMH

BMH

BMH

HM_DEPT_COD

50600

50600

50600

JOB_COD

C0848U

C0848U

C0848U

STD_HRS

40

40

80

PAYROLL_EMPLMT_STAT_COD

F

F

F

PAY_RATE_AMT

40.580000

40.580000

40.580000

FCLTY_COD

BMH

BMH

BMH

DEPT_COD

50600

50600

50600

PAYROLL_PAYCD

A01

A01

A01

PAYROLL_PAYCD_HRS

23.250000

23.250000

46.500000

PAYROLL_PAYCD_AMT

943.490000

943.490000

1186.980000

ASSGND_SHIFT_NAM

—

—

—

PRI_JOB_COD

C0848U

C0848U

C0848U

HIRE_DAT

09/30/1960

09/30/1960

09/30/1960

TERM_DAT

—

—

—

PPEND_DAT

11/29/2018

11/29/2018

11/29/2018

SRC_COD

PAYROLL

PAYROLL

PAYROLL

Payroll import use case — Correction or override

To correct already imported records, zeroed hours and amounts must be imported with the exact same set of values for the following fields:

  • Employee number
  • Payroll Home Facility
  • Payroll Home Department
  • Payroll Worked Facility
  • Payroll Worked Department
  • Payroll Pay Code
  • Job Code (Paid Job)
  • Payroll Employment Status Code
  • Pay Period End Date
  • Payroll Source

The record date of File 2 overrides the record date of File 1.

Example payroll import for correction or override

Example payroll import for corrected or overridden data

Fields

File 1

File 2

Override result

EMP_NBR

G7704

G7704

G7704

EMP_NAM

G7704FU

G7704FU

G7704FU

HM_FCLTY_COD

BMH

BMH

BMH

HM_DEPT_COD

50600

50600

50600

JOB_COD

C0848U

C0848U

C0848U

STD_HRS

40

30

30

PAYROLL_EMPLMT_STAT_COD

F

F

F

PAY_RATE_AMT

—

—

—

FCLTY_COD

BMH

BMH

BMH

DEPT_COD

50600

50600

50600

PAYROLL_PAYCOD

A01

A01

A01

PAYRwOLL_PAYCD_HRS

40

30

30

PAYROLL_PAYCD_AMT

943.490000

707.617500

707.617500

ASSGND_SHIFT_NAM

—

—

—

PRI_JOB_COD

C0848U

C0848U

C0848U

HIRE_DAT

09/30/1960

09/30/1967

09/30/1967

TERM_DAT

—

—

—

PPEND_DAT

11/29/2018

11/29/2018

11/29/2018

SRC_COD

PAYROLL

PAYROLL

PAYROLL

For an employee for a pay period, these fields cannot have more than one value. To correct the following values, the system must import a correction record that has zeroed hours and amounts:

  • Primary job code
  • Employment status
  • Standard hours
  • Home department
  • Payroll source

Payroll import use case — Generic job transfers

If employees transfer to departments that do not have an exactly matching job or a generic job in that location, the Payroll Import integration returns exceptions for those records. As a result, the payroll reports do not show the data for the respective work units.

To process these transfers as generic jobs without exceptions, do the following:

  • Set the site.healthcareanalytics.payroll.config.default.generic.job system setting to the name of a generic job that maps to unknown jobs. Example: Default Job. For instructions, see the Healthcare Analytics System Settings topic.
    Note: Before you use Setup Data Manager (SDM) to transfer this property, check the generic job on the target tenant. Also, if the payroll records fail even though the generic job system setting is configured correctly, check whether the job is still effective.
  • If the payroll job mapping is updated to another job, you can move the old records to the newly configured job. Recalculate payroll according to the Recalculate Healthcare Analytics topic.

Agency Export

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Agency Export integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. Set parameters:

    Select or enter the following parameters:

    • Reference Date from which to export the transactional punches of agency employees. If you do not select a date, the integration exports the past 90 days of punches.
    • Hyperfind: Leave the default Agency Employees or All People hyperfind query selected.
    Note:

    To troubleshoot exceptions in agency worker records, click tap Browse and select the Exception_Agency_Export file. This file shows detailed information about each exception in the following columns:

    • EMP_NBR
    • EMP_FULL_NAME
    • WORK_UNIT_ID
    • ORG_ID
    • PAYCODE_ID
    • HOURS
    • AMOUNT
    • PP_START_DATE
    • PP_END_DATE
    • HIRE_DATE
    • TERMINATE_DATE
    • WORK_UNIT_NAME
    • ORG_PATH
    • PAYCODE_NAME
    • EXCEPTION_DETAIL
  6. Select the following:
    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

    See Check the results.

    Caution: Do not modify the exported CSV file.

  7. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

Agency Import

Healthcare Productivity
  1. Select Main Menu Maintenance > Integrations.
  2. Click Tap Run an Integration .
  3. Select the Agency Import integration. Click Tap Select.
  4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  5. (Not recommended) You can select a different source file. Click Tap Browse and navigate to and select the file.
    Caution:
    • (Required)

      Make sure that only one file with this filename is on the SFTP server at a time. Otherwise, the data can become corrupted.

    • For scheduled runs of the integration, do not select a different source file. The default file was generated from the installation kit, and a scheduled integration cannot run without it.
    • For manual runs of the integration, you must enter the complete file name of the source file. Otherwise if the Inbound folder contains multiple files, the integration cannot distinguish which source file is the correct file to process, especially if you use wildcards (*) in the file name.
    • The maximum size of source file is 1 MB. However, you can compress a larger file and select the compressed *.zip file as the source file.
    • The format of the file must be .csv, .zip, .pgp, or .gpg.

    To troubleshoot exceptions in agency worker records, click tap Browse and select the Exception_Agency_Export file. This file shows detailed information about each exception.

  6. Select the following:

    • Run Integration : If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter settings again. Click Tap Yes to run the integration with the previous parameter settings, or No to edit the parameters for this run.

    Wait for the confirmation that the integration completed or failed . Close the panel.

    Click Tap Refresh .

    To see details, select the integration run. Select Run Summary.

    See Check the results.

  7. When the integration run starts and when it finishes, notifications go to the Control Center and by email.

  8. When the import process starts and finishes, notifications go the Control Center and by email.
  9. Make sure that the imported data corresponds to the exported (source) data:
    1. Open the source (input) and imported (output) files.
    2. Compare the data for accuracy.

Check the results

How to check the results of Healthcare Productivity integration runs.

Integration tiles

On the Integrations page, each tile indicates the current status of Healthcare Productivity integration runs as follows:

Status indicators

  • In-Progress: The run of this integration has not yet completed.
  • Completed: The integration ran successfully without errors.
  • Scheduled: This integration is scheduled to run later or repeatedly.
  • (Grayed out) Scheduled but Deleted: This integration is scheduled to run, but the integration template has been deleted. When it runs, it will generate an error. To prevent this error, delete the scheduled integration run.
  • Completed with Errors: 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.
  • Failed: The integration run has errors or could not run.
  • To troubleshoot and resolve errors, do the following:

    Check the Run Summary for details.

    • To troubleshoot all types of errors, or if the Run Summary shows a large number of errors, click tap Go to Additional Details (if available), or click tap the Source File to open and examine the input source file.
    • (Only for import integrations) To troubleshoot and resubmit integrations that have transactional or data errors, click tap Go to Transaction Assistant.
Note: Only import integrations can have a status of Partial Failed. Export integrations export all records for the run to complete or no records for the run to fail; export integrations cannot partially succeed.

Run Summary

The Run Summary shows an overview of the results of a Healthcare Productivity integration run.

  1. Click Tap the tile for a completed integration run.
  2. Click Tap Run Summary to see the results of the integration run.

  3. Run Summary details

    • Integration Type: Import or Export
    • Records Processed: Number of records that were processed
    • Records Created: Number of records that were created
    • Errors: Number of records that failed
    • Source Files: For file-based import integrations, click tap the flat file to see the input source for the integration.
    • Output File: For file-based export integrations, click tap the CSV file to see the exported data.
    • Error Files: If the run of a file-based integration has errors, click tap the CSV file. The filename starts with Exception_. This file lists the records that have errors, each record to a row, and is kept for 30 days. The Exception Details column in the file provides a detailed message for each error. If a record has multiple errors, each error message is separated by a semi-colon ( ;). You can edit this file and reload it.

Troubleshooting

To check the results of Healthcare Productivity integration runs in more detail and troubleshoot errors, do the following:

  1. In Error Files, open the exception file to find the erroneous records and see details.
    • The filename starts with Exception_. Example: Exception_work_units_*.csv
    • This file lists the records that have errors, each record to a row.
    • The Exception Details column in the file provides a detailed message for each error.
    • If a record has multiple errors, each error message is separated by a semi-colon ( ;).
    • You can edit this file and reload it.
  2. In Source Files, open the generated CSV file and check for the following errors that are common to all integrations in addition to any errors that are specific to an integration:
    • The first row of the file is a header.
    • The headers are correct.
    • All of the required fields are completed and are not blank (null). If these fields do not apply to a record, enter 0 for the value.
    • Formats are correct. Example: Dates are in MM/DD/YYYY or MM-DD-YYYY format.
    • Number fields are right-justified and have no leading zeros.
    • Negative numbers show the minus ( —) sign to the left of the number (floating).
    • Field values which must be unique are unique. Example: EMP_NBR must be unique across all payroll source files.
    • If the integration depends on data from previous integrations or external processes, make sure that those integrations or processes finish before this integration starts.

      Example: Payroll Facility and Department Facility Mappings must finish before you can import the payroll records.

      Note: Use integration sets to sequence integration runs; see Configure Integration Sets for Healthcare Productivity.
  3. If the source file does not open, navigate to the SFTP server and check the following:
    • The file type is .csv
    • There is only one version of the file. If an integration has multiple files, the system selects one file at random to prevent data corruption.
    • The filename is correct. Example: payroll_*.csv
  4. Log into the destination system and make sure that the data has been correctly updated.

    Examples:

    • Check the Work Unit Definitions to see if the integration imported the work units correctly; see Configure Work Units.
    • Check the Target Management to see if the integration imported the targets and thresholds correctly; see Configure Targets and Thresholds.

    • If changes are made to volume, payroll, or agency configurations, you can process the historical data again to fit the new configuration.

      See the Recalculate Healthcare Productivity topic.