Integrating tools into value streams

Create value stream integrations by defining integration objects to the value-stream-name.json file.

Before you begin

Modify the value stream with the phases, stages, and queries required for your project.

About this task

To define an integration, complete the following steps:

Procedure

  1. On the Value Streams page, click value stream configure and select Download value stream map. The value_stream_name-vsm.json is downloaded to the specified location.
  2. Using a text editor, define an integration object in the value_stream_name-vsm.json file.
    The following code example illustrates a Bitbucket™ integration:
    
       {
        "type": "ucv-ext-bitbucket-server",
        "tenant_id": "[ID]",
        "name": "my-bitbucket",
        "disabled": false,
        "properties": {
          "baseApiUrl": "[Base URL ex: http://10.134.116.110:7990/rest/api/1.0]",
          "username": "admin",
          "password": "[Basic user password]",
          "projectName": "[Full project name ex: JKE Mortgage Application]",
          "projectKey": "[Project key ex: JMA]",
          "repositoryName": "[app repository name ex: web-application]",
          "repositorySlug": "[app repository name ex: web-application]"
       }
     }
  3. Optional: Define queries for the stages where data is required from the integrated tool.
    For example, the following query defined for the In Progress stage matches open pull requests from source control systems: 
    
     {
          "name": "Development",
          "description": null,
          "stages": [
            {
              "name": "In Progress",
              "query": "pr.status="open",
              "description": null,
              "wipLimit": null,
              "gates": null   
            },
  4. On the Value Streams page, click , select Edit value stream map > Import JSON, and then select the JSON file that you modified.
    For more information about creating value stream integrations, see About value stream integrations.

Results

Objects from the integrated tool appear in stages of the value stream, and the integration is listed on the Integrations page in the web UI.

What to do next

Increase usability by linking integrated tools. Linked value stream dots provide information for the linked tools.