About value stream integrations#

Integrate external tools into your value streams.

Value stream integrations are specified in the value_stream_name-vsm.json file. Each value stream has a unique value_stream_name-vsm.json file. You can add any number of integration objects to the JSON file.

You can add integrations to value streams by the following two methods:

  1. Create an integration on the Integrations page, and then insert a reference to it in the value_stream_name-vsm.json file. For example, the following JSON code adds an integration named "DevOps Team" into the value stream, "name": "DevOps team".
  2. Define all properties for the integration in the value_stream_name-vsm.json file. When you configure an integration with this method, the integration is displayed on the Integrations page.

Properties common to all value stream integrations#

While all plug-ins have unique properties, the plug-ins that you can integrate into a value stream share some common properties. The properties identify the integration and determine if the integration is enabled or disabled.

The properties common to all value stream integrations are detailed in the table below.

Property Description
image The plug-in version.
type The plug-in type identifier. See the list of supported plug-in types later in this topic.
tenant_id Tenant identifier. The value is generated by HCL™ Accelerate.
name Integration name. The name should be unique.
disabled A flag that is used to disable the integration. The default value is null, which means the integration is enabled. To disable the integration, change the value to true. You can also set this value with the Disable/Enable button on the Integrations page.
properties The properties object defines properties that are specific to the plug-in. See the documentation for the tool that you want to integrate.

For information regarding parameters unique to a specific integration, see Introducing plug-ins.

The following code block shows a typical Jira-type integration defined in the value_stream_name-vsm.json file:


"integrations": [
    {
      "type": "ucv-ext-jira",
      "tenant_id": "tenantid",
      "name": "Jira_Plugin ",
      "properties": {
        "baseUrl": "jira_server_url",
        "username": "jira_server_user_name",
        "password": "jira_server_password",
        "consumer_key": null,
        "consumer_secret": null,
        "access_token": null,
        "access_token_secret": null,
        "jiraProjects": [
          "jira_project_name"
        ],
        "proxyServer": "proxy_server_url",
        "proxyUsername": "proxy_server_user_name",
        "proxyPassword": "proxy_server_password"
      }
    }  ]

Parent topic: Integrating tools into value streams