About value stream integrations#

Integrate external tools into your value streams.

Value stream integrations are defined by integration objects in the value_stream_name.json file. Each value stream has its own value_stream_name.json field. You can add any number of integration objects to the JSON file.

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. These properties identify the integration and determine if the integration is enabled or disabled.

The following table describes the properties that are common to all value stream integrations.

Property Description
_id Value stream identifier. The value is generated by UrbanCodeā„¢ Velocity.
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 UrbanCode Velocity.
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 about the parameters unique to a specific integration, see Managing integrations.

About integration types#

In addition to the integrations that you define in the value stream JSON file, you can define some integrations in external tools. UrbanCode Velocity provides REST API endpoints that can be used to communicate with external tools. In these cases, the external tool or service sends data in the expected format to the endpoint. Data received this way can be incorporated into value streams or reports.

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

"type": "ucv-ext-jira",     
"name": "my-jira",     
"properties": {       
"baseUrl": "https://jenkins-jira-test.net",       
"username": "jenkins.jenkins@mycompany.com",       
"password": "<password>",       
"jiraProjects": [         "JT"       ]     

The following table lists the supported value stream plug-ins.

Plug-in type property Description
ucv-ext-appscan AppScan
ucv-ext-bitbucket-server BitBucket
ucv-ext-github GitHub
ucv-ext-jira Jira
ucv-ext-sonarcube SonarCube

Parent topic: Integrating tools into value streams