Skip to main content
Skip table of contents

CONFIG_ISSUE_TRACK_SYSTEM

CONFIG_ISSUE_TRACK_SYSTEM is a configuration package used to integrate Agile Data Engine with external issue tracking systems, such as Atlassian Jira.

This integration allows you to reference issue tickets directly in commit messages and descriptions of packages, entities, attributes, and other metadata items.

Within this package, you can:

  • Configure supported issue tracking systems and their base URLs

  • Define projects within each system to form recognizable ticket references (e.g., ISSUE-123, where ISSUE is the project key and 123 is the issue number)

This setup enables easy navigation from Agile Data Engine to related tickets in your issue tracking platform.


See also:


Usage

  1. Open CONFIG_ISSUE_TRACK_SYSTEM package and click Issue Track System to access the configuration.

  2. Configure systems and their base URLs in the Issue Tracking Systems tab.

  3. Configure projects in the Issue Tracking Projects tab.

Note that after making changes, CONFIG_ENTITY_DEFAULTS will have uncommitted changes. To maintain a change history, it is recommended to commit the package.


Contents

Issue tracking system configuration

Issue tracking system configurations are managed within the JSON array block named issueTrackSystems.

Key

Value type

Example

Description

issueTrackSystemName

String

Dev Jira

Name of the issue track system.

baseUrl

String

https://devjira.companyxyz.com/browse

Base URL of the issue track system.

Example: Issue tracking system configuration

JSON
"issueTrackSystems": [
  ...
  {
    "issueTrackSystemName": "Dev Jira",
    "baseUrl": "https://devjira.companyxyz.com/browse/"
  }
  ...
]

When configuring the baseUrl for an issue tracking system, the following keywords are supported and can be used in any order:

  • <issueId> – The full issue identifier (e.g., ISSUE-1234)

  • <issueTrackProjectShortName> – The project key or short name (e.g., ISSUE)

  • <issueNumber> – The numeric part of the issue identifier (e.g., 1234)

For example, for issue ID ISSUE-1234:

  • <issueId>ISSUE-1234

  • <issueTrackProjectShortName>ISSUE

  • <issueNumber>1234

Example combinations:

baseUrl

Resulting URL

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

If no keywords are provided in the baseUrl, the <issueId> will be automatically appended to the end of the URL.


Issue tracking project configuration

Issue tracking project configurations are managed within the JSON array block named issueTrackProjects.

Key

Value type

Example

Description

issueTrackProjectShortName

String

ISSUE

Specifies the short name (project key) of the issue tracking project.
This is the prefix used in issue identifiers, such as JIRA in JIRA-1234.

issueTrackSystemName

String

Dev Jira

References the name of the issue tracking system configured in the issueTrackSystems array.

Example: Issue tracking project configuration

JSON
"issueTrackProjects": [
  ...
  {
    "issueTrackProjectShortName": "ISSUE",
    "issueTrackSystemName": "Dev Jira"
  }
  ...
]
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.