CONFIG_ISSUE_TRACK_SYSTEM
CONFIG_ISSUE_TRACK_SYSTEM is a configuration package that is used to configure a link to an issue track system, such as Atlassian Jira.
See also:
Usage
Open the configuration package from Designer package list.
Click Export package in the Actions tab.
Click Download.
Edit JSON file.
Import edited JSON back to Designer with Import Package.
After a successful import, changes to the configuration package have been applied to Designer only. It is recommended to deploy the same changes to Runtime environments as well.
Contents
Issue track systems
Issue track system configurations are managed inside the JSON array block named issueTrackSystems.
Key | Value type | Example | Description |
|---|---|---|---|
issueTrackSystemName | String | Dev Jira | The name of the issue track system. |
baseUrl | String | https://devjira.companyxyz.com/browse | The base url of the issue track system. |
You can add a new issue track systems or update the contents of an existing issue track systems.
Example: Issue Track Systems Configuration
"issueTrackSystems": [
. . .
{
"issueTrackSystemName": "Dev Jira",
"baseUrl": "<https://devjira.companyxyz.com/browse/">
}
. . .
]If an existing issue track systems needs to be deleted, simply remove it from the set of values before importing the configuration package.
The following keywords are supported when defining the baseUrl:
<issueId>
<issueTrackProjectShortName>
<issueNumber>
For example, given an issue identifier: ISSUE-1234:
<issueId> is ISSUE-1234
<issueTrackProjectShortName> is ISSUE
<issueNumber> is 1234
The keywords can be combined in any order within the baseUrl. For example:
baseUrl | Resulting | Comment |
|---|---|---|
https://devjira.companyxyz.com/<issueTrackProjectShortName>/browse/<issueNumber> | https://devjira.companyxyz.com/JIRA/browse/1234 | |
https://devjira.companyxyz.com/browse/<issueId> | https://devjira.companyxyz.com/browse/JIRA-1234 | |
https://devjira.companyxyz.com/browse | https://devjira.companyxyz.com/browse/JIRA-1234 | When no keywords are provided, issueId will be programmatically concatenated into the end of baseUrl. |
Issue track projects
Issue track system configurations are managed inside the JSON array block named issueTrackProjects.
Key | Value type | Example | Description |
|---|---|---|---|
issueTrackProjectShortName | String | EDW | The short name of the issue track project. |
issueTrackSystemName | String | Dev Jira | The name of the issue track system. For more information, refer to the Issue Track Systems Configuration section above. |
You can add a new issue track projects or update the contents of an existing issue track projects.
Example: Issue Track Projects Configuration
"issueTrackProjects": [
. . .
{
"issueTrackProjectShortName": "EDW",
"issueTrackSystemName": "Dev Jira"
}
. . .
]If an existing issue track projects needs to be deleted, simply remove it from the set of values before importing the configuration package.