Managing integrations

You can manage the existing configured integrations.

About this task

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

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 DevOps Velocity (Velocity) 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 the following steps:


  1. On the Velocity Home page, click Settings > Integrations.

    The Configured page lists all 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 overflow menu > Edit, and then modify the integration definition properties.
  3. Optional: To view the integration log file, click overflow menu > View logs.
    This action displays the integration's last execution log.
  4. Optional: To upgrade or downgrade the plugin used by the integration, click overflow menu > Upgrade/Downgrade.
  5. Optional: To sync with the external tool, click overflow menu > 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.

    Not all integration types support this action. All scheduled event plugins such as Jira, GitHub, GitLab, Azure DevOps, and HCL DevOps Deploy are supported with the resync functionality.

  6. Optional: To archive an integration, click overflow menu > Archive/Delete.
    Note: Select the Delete the integration data checkbox to delete the integration data.
  7. Optional: To disable or enable 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.
  8. Optional: To disable or enable multiple integrations, select the required integrations and then Select Actions appears. Click the drop-down list of Select Actions and select Disable or Enable.