Managing integrations

Edit and update existing configurations.

About this task

After an integration is successfully configured, it periodically communicates with the external tool to synchronize the data flow.

An integration that is working properly has a status of Online. An integration that is not working has a status of Failed. Disrupted communications or inaccurate integration configurations can cause the integration to fail. The Last Sync field displays the time of the last successful communication. The default communication interval when scheduled event integrations run can be configured by the PLUGIN_INTEGRATION_RUN_INTERVAL environment variable on the reporting-consumer service to a valid integer for the minutes between each run.

Note: Starting in HCL Accelerate version 2.4.0, user access keys are auto-generated. To understand how user access keys are managed, you can find details here.

To manage an integration, perform one or more of the following steps:


  1. On the HCL Accelerate Home page, click Settings > Integrations.

    The Integrations page lists the configured integrations. All integrations are listed regardless of how they are created. You can use search functionality for searching the integration in the Integrations tab. The search query finds the matches in Name and Type fields. On the Integrations tab, you can sort the Name, Status, Type, and Last sync fields in ascending or descending order by clicking on the required table header field.

  2. Optional: To modify an integration definition, click Actions > Edit, and then modify the integration definition properties.
  3. Optional: To view the integration log file, click Actions > View Log.
    This action displays the integration's last execution log.
  4. Optional: To sync with the external tool, click Actions > Resync.
    This action attempts to communicate with the external tool immediately. You might do this when you want to run tests before the next communication interval. You can also select the time line from when you want to resync the data from the external tool.
    Note: Not all integration types support this action. All scheduled event plugins such as Jira, GitHub, GitLab, Azure DevOps, and HCL Launch are supported with the resync functionality.
  5. Optional: To upgrade the plugin used by the integration, click Actions > Upgrade.
  6. Optional: To disable an integration, click the Disable/Enable field of the integration.
    Communication with the external tool stops until re-enabled. You might do this if you want to stop data delivery during testing.
  7. Optional: To delete an integration, click Actions > Delete.