Run and Test Integrations

Run, set parameter values, and check the status of integrations; schedule integrations or integration sets.

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

Test the integrations

  1. Select the integration:
    1. Select Main Menu Maintenance > Integrations.
    2. Click Tap Run an Integration .
    3. Select the integration from the list. 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. (Optional) For import integrations, 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 server at a time. Otherwise, the data can become corrupted.
      • 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.
  2. Set parameters — Select or enter any parameters or files that are required. Required and optional parameters, and external files vary by integration.
  3. 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 values again. Click Tap Yes to continue, or No to not run the integration and to return to the parameter settings.
  4. Wait for the confirmation that the integration completed or failed. Close the panel.
  5. Click Tap Refresh .
  6. To see details, select the integration run. Select Run Summary.

Check the results

  1. Check the 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.

Run integrations during production

During day-to-day operations, run the integrations as needed.

  1. Select the integration:
    1. Select Main Menu Maintenance > Integrations.
    2. Click Tap Run an Integration .
    3. Select the integration from the list. 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. (Optional) For import integrations, 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 server at a time. Otherwise, the data can become corrupted.
      • 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.
  2. Set parameters — Select or enter any parameters or files that are required. Required and optional parameters, and external files vary by integration.
  3. 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 values again. Click Tap Yes to continue, or No to not run the integration and to return to the parameter settings.
  4. Wait for the confirmation that the integration completed or failed. Close the panel.
  5. Click Tap Refresh .
  6. To see details, select the integration run. Select Run Summary.

Note:

  • You can group and sequence integrations in integration sets. See the Configure Integration Sets topic.

  • You can schedule integrations and integration sets to run once later or at a recurring frequency. See the Schedule Integrations topic.