Issue link field dimensions
eazyBI for Jira
Linked issue dimensions let you analyze issues using a field value inherited from a related issue at a different hierarchy level; for example, story points on stories by the fix version of their epic.
On this page:
Overview
Jira Software, Plans custom fields, and issue links let you build issue hierarchies in Jira and import them into eazyBI as new hierarchies. Different fields are often managed at different levels of such a hierarchy: the fix version might be set on the epic, while the story points and time tracking sit on the stories and sub-tasks below it.
Linked issue dimensions let you analyze data at lower levels using a field from a higher-level issue, for example, story points on stories by the fix version of their epic. The same approach works with a single linked issue.
eazyBI can build these dimensions from several Jira default fields: Fix Version, Affects Version, Label, Status, Resolution, Issue Type, Priority, and Security level, giving you dimensions such as Epic Fix version or Feature Label. Custom fields can also be inherited, including single select lists and calculated JavaScript custom fields, as long as they are imported as dimensions in the account and hold a single-choice value.
There are two ways to define a linked issue dimension, and the right one depends on how many accounts need it and what your role is in eazyBI.
- Account-specific linked issue dimension is defined and used in only one eazyBI account and is not available in other eazyBI accounts. eazyBI users with data admin or higher roles can define new linked issue dimensions in the account import options using the user interface with available options. Choose this for dimensions that matter to one team or project.
Account-specific linked issue dimensions are available on Jira Cloud. - Global linked issue dimension is defined once for the whole eazyBI instance in eazyBI advanced settings or site settings for Cloud and is available for all eazyBI accounts; defining it requires Jira administrator permissions. The data admin of each eazyBI account then decides whether to import it.
Account-specific linked issue dimensions in import options
Account-specific linked issue dimensions are available on Jira Cloud.
In Jira import options, tab Custom fields [1], section Linked issues dimensions [2], you can add a new, edit, and delete account-specific linked issue dimensions and view the global linked issue dimensions defined in eazyBI advanced settings.
Add new linked issue dimension
Choose the option to Add new linked issue dimension and fill in the required information describing which value to inherit and where from.
- Display Name [1] – give the dimension a name, for example, Epic Fix version. It will be visible in import options and in eazyBI reports. The name cannot duplicate a dimension name already in the account; if it does, a warning appears, and eazyBI will not let you create the dimension.
- Field to inherit value from [2] – choose the field whose values are copied, for example, Fix Version. eazyBI offers default fields that can be inherited and custom fields imported as dimensions in this account, including single-choice and calculated JavaScript custom fields. Fields with multiple values are not offered, as eazyBI has to copy a single value. This is what
source_dimensiondoes in advanced settings. Inherit from issue hierarchy level or linked issue [3] – choose the issue level from which the value comes, for example, Epic. eazyBI offers the options available in your account and groups them by source:
- Issue hierarchy levels, such as Parent or Epic.
- Plans hierarchy levels, such as Initiative, which you pick by name without counting levels
- Issue link custom fields imported with the issue link import.
A hierarchy level is offered only when that hierarchy is imported, an issue link custom field is only offered after it is selected for import, and multi-value link fields are not offered at all. This is what
issue_key_columndoes in advanced settings.
Select Create, then select Import linked issue dimension for the new dimension. Select Import to save the changes and start the import right now, or Save to change the options for the next regular import.
Edit an account-specific dimension
You can edit and delete account-specific linked issue dimensions. Global linked issue dimensions are read-only here: select Show to see how one is defined, and change it in advanced settings or site settings for Cloud if needed.
Global linked issue dimensions in advanced settings
If you would like to make a linked issue dimension available to all accounts, you need to define it in eazyBI advanced settings or site settings for Cloud, which are available to Jira system administrators, Jira site admins, and eazyBI admins.
Each linked issue dimension is a separate [[jira.issue_link_field_dimensions]] block. Fill in the parameters describing which value to inherit and where from.
name – give the dimension a name that will be visible in the import options and in eazyBI reports, for example, Epic Fix version. Use a name describing both the field and the linked issue. The name cannot repeat the name of a dimension that already exists in the account; such a dimension is skipped with an import warning.
[[jira.issue_link_field_dimensions]] name = "Epic Fix version"
source_dimension – specify which Jira field values should be copied from the linked issue. Use the dimension name for a default field (list of supported fields):
source_dimension = "Fix Version"
Or specify the custom field ID for a custom field, such as a single-choice or a calculated JavaScript custom field. The custom field should be imported as a dimension in the account and contain a single value:
source_dimension = "customfield_10001"
issue_key_column – set the reference to the issue the values come from. You can use KEY columns describing the hierarchy level or only one linked issue. For example, if
customfield_featureholds a single linked Feature issue, you can use a reference to it:issue_key_column = "customfield_feature"
Here are options for
issue_key_columnvalues using other default hierarchies:"subtask_parent_key"if you would like to get values from parent issues to sub-tasks."epic_key"if you would like to get values from a linked epic to its child issues and sub-tasks."epic_parent_key"if you would like to get values from the parent issue in the Epic hierarchy."jpoh_parent_X"if you are using Jira Plans and would like to get values in the Parent hierarchy. Use a parent level number 1, 2, 3, … instead of X, counting parent levels on top of sub-tasks: 1 for the story or standard issue level (jpoh_parent_1), 2 for the epic level (jpoh_parent_2), and so on.
group – set a group in dimension selection. Use "Linked issue dimensions" so that global and account-specific dimensions are grouped together; account-specific dimensions always use this group.
group = "Linked issue dimensions"
A complete definition looks like this:
[[jira.issue_link_field_dimensions]] name = "Epic Fix Version" source_dimension = "Fix Version" issue_key_column = "epic_key" group = "Linked issue dimensions"
After you have saved the advanced settings with the linked issue dimension definition, go to the Jira import options, tab Custom fields, and check whether you have this dimension in the Linked issue dimensions section. Global dimensions are available in all site accounts with the same configuration; select Show to see how one is defined, and Import linked issue dimension to import it. They cannot be changed or deleted from an account.
If you would like to test whether the dimension is defined correctly, import it into one account and build a small report that includes issue keys and the new dimension to see which issues have a value.
Linked issues dimensions import and usage
Both the account-specific and global linked issue dimensions appear in the Linked issues dimensions section of the Jira import options. Select the dimensions you need for data analysis for import into each account.
eazyBI builds linked issue dimensions with the same structure as default dimensions: they have the same hierarchies and member structure, and eazyBI supports access to the same set of properties as for default dimensions. For example, retrieve the release start date for the Epic Fix Version dimension member.
[Epic Fix Version].CurrentHierarchyMember.Get('Start date')
Examples
Here are several examples for both global and account-specific linked issue dimensions; the content is the same, differing only in how the name, source dimension, and issue level are specified.
Epic Fix Version
The Epic Fix Version dimension lets you group and filter stories and sub-tasks by the Fix Version of their epic.
Parameters for the account-specific linked issue dimension Epic Fix Version:
- Field to inherit value from: select Fix Version
- Inherit from issue hierarchy level or linked issue: select Epic
If you want to make a global linked issue dimension, add the following configuration in the advanced settings or site settings for Cloud.
[[jira.issue_link_field_dimensions]] name = "Epic Fix Version" source_dimension = "Fix Version" issue_key_column = "epic_key" group = "Linked issue dimensions"
Epic Team
The Epic Team dimension lets you group and filter stories and sub-tasks by the Team of their Epic, where Team is a single-choice custom field. The Team custom field should be imported as a dimension in the account too; otherwise, the Epic Team dimension is skipped with an import warning.
Parameters for the account-specific linked issue dimension Epic Team:
- Field to inherit value from: select Team
- Inherit from issue hierarchy level or linked issue: select Epic
If you want to make a global linked issue dimension, add the following configuration in the advanced settings or site settings for Cloud. Reference the Team by its custom field ID customfield_NNNNN instead of a dimension name.
[[jira.issue_link_field_dimensions]] name = "Epic Team" source_dimension = "customfield_NNNNN" issue_key_column = "epic_key" group = "Linked issue dimensions"
Initiative Status
The Initiative Status dimension lets you group and filter issues by the Status of their Initiative from the Plans hierarchy. Here, we assume that Initiative is one level above Epic in the hierarchy, and the Plans hierarchy is this: Initiative → Epic → Parent → Sub-task.
Parameters for the account-specific linked issue dimension Initiative Status:
- Field to inherit value from: select Status
- Inherit from issue hierarchy level or linked issue: select Initiative
If you want to make a global linked issue dimension, add the following configuration in the advanced settings or site settings for Cloud. The levels in the Plans hierarchy are numbered from the bottom, where the first level above the sub-task has the value 1 (jpoh_parent_1). For example, Initiative jpoh_parent_3 → Epic jpoh_parent_2 → Parent jpoh_parent_1 → Sub-task. Check which number matches the Initiative in your hierarchy.
[[jira.issue_link_field_dimensions]] name = "Initiative Status" source_dimension = "Status" issue_key_column = "jpoh_parent_3" group = "Linked issue dimensions"
Feature Label
The Feature Label dimension lets you group and filter Epics and their child issues by the label of the Feature linked to the Epic. First, import the issue link for Feature as a dimension so you can refer to it. Then add the linked issue dimension Feature Label.
Parameters for the account-specific linked issue dimension Feature Label:
- Field to inherit value from: select Label
- Inherit from issue hierarchy level or linked issues: select Feature.
If you want to make a global linked issue dimension, add the following configuration in the advanced settings or site settings for Cloud. The first definition describes the issue linked to the Feature. Then you can use the Feature by its internal name in the issue_key_column.
[jira.customfield_feature] name = "Feature" inward_link = "is child of" issue_type = "Feature" update_from_issue_key = "epic_key" [[jira.issue_link_field_dimensions]] name = "Feature Label" source_dimension = "Label" issue_key_column = "customfield_feature" group = "Linked issue dimensions"
Troubleshooting
There might be cases when a linked issue dimension does not work as expected. Here are hints to find out why.
- The dimension is missing after the import. Check that the Import linked issues dimension is selected for it, and that an import has run since you selected it. Save only stores the option for the next regular import; the dimension appears once that import finishes.
- "Dimension with this name already exists." Another dimension in the account already uses this name. Give a display name that indicates both the field and the issue it comes from, such as Epic Fix version.
- The field is missing from the list. The field is either not imported as a dimension or holds several values. Linked issue dimensions appear only after they are imported, and hierarchy levels only when that hierarchy is imported.
- The dimension is imported, but all values are empty. Check that the linked issues are imported into this account and that the link points in the direction you expect. A small report with issue keys and the new dimension shows which issues get a value.