Learn what Environment Custom Fields are and how to use them in Jira:
What are Environment Custom Fields?
Environment Custom Fields are used to link Jira Issues and Service Management Requests with Golive Environments.
Why Environment Custom Fields?
Linking your Jira issues to Golive Environments will enable your teams to build accurate statistics about the number of issues/tickets created, reproduced, tested,... in your various environments.
For example, you may add the following Environment Custom Fields to your "Bug" issues:
Detected in: Environment in which a new issue has been detected
Tested in: Environment in which a fixed issue has been tested
You can add up to 50 Custom Fields, so possibilities are just limited by your imagination!
Environments to book
Environment Custom Fields can then be used to setup custom workflows that we deal with your environments, for example:
The concept of Environment Custom Fields is similar to the Version concept in Jira: you have only one inventory of Versions but you can have different Version fields on the same issue (ex: Fix Version/s and Affects Version/s).
Create an Environment Custom Field
You must be an Apwide administrator in order to create a new Environment Custom Field. On the Golive Page, click on “Global Settings” from the Settings menu.
Then open the Custom Fields tab:
Jira Server users could be confused, but Jira Cloud has changed the way third party Custom Fields are managed. From the Jira Cloud Custom Field configuration screen, you can only manage the fields provided by Jira Cloud platform. Apps have to manage Custom Fields on their side.
From here, you can create and delete Environment Custom Fields:
Key, name, description and type mandatory and key only supports "A-Z", "a-z" and "-" characters.
You can choose between single/multi select depending on your needs.
By default, the Custom Field options are all Environments from Applications linked to the current Jira Project. It is possible to disable this behavior or additional restrictions can be applied.
You will then need to add the newly created Custom Field to your issue types' screens accessible from Configure screens link.
If you want to add custom fields in a company-managed project, refer to this page:
Add a custom field to a screen
If you want to add custom fields in a team-managed project, refer to this page:
Add a custom field to a team-managed project
You may have to authorize the Golive App in the “Previously-created fields” bottom-right section.
Apart Environment filter and Filter by applications checkbox, Jira Cloud Custom Fields are not editable, so, be aware that you can only create and delete fields. However, if you delete a custom field, at the time you create a new one using the same Key, all of your data (eg: Jira issue reference) will be kept.
Select Environments on the Issue screen
If you configured an Environment Custom Field and added it to a Screen, you should be able to add Environments from the Issue screen:
The list of Environments that can be selected depends of the Project/Applications Setup. Only the Environments of the Applications linked to the current Jira Project will be displayed in the list.
Force Synchronization of Environment Custom Field options
Environment custom field is a single/multi-option field. Each Environment is represented by a specific Option having different properties (eg: category name, application name, etc.). Environment is an asset part of your Golive Environment Inventory, and Options are their copy in your Jira instance. On your issues, when you select a value for an Environment Custom Field, you select an option which refers to an Environment in your inventory. This means options must be maintained, synchronized, to represent the status of your Environment inventory. For example, each time an environment is created/deleted, its corresponding option is created/deleted as well.
Usually, this synchronization happens automatically under the hood. But it happens that options and Environment inventory differs, due to an action in Jira that Golive was not aware of (eg: restoration of a Jira backup, creation of a new project, etc.). You can consult the status of the synchronization from the Custom Fields page:
If Options and Environments differ, the number of differences is displayed in a gray badge. If no badge, it means your Options are aligned with your Environments for this Custom Field.
By clicking on the Synchronize button, you have the detail of the differences and you can consult the list of issues referencing an option by clicking on option link:
One of the most common misalignment reason is an Environment that has been deleted but still referenced by issue:
If you want to solve this issue, you have 2 options:
automatically be forcing the deletion. Option will be unset for the issues referencing it and then deleted.
if you need more granularity in the way of updating issues, you can click the option link to open the list of issues referencing it, and fine tune the way to unset the option with bulk update Jira capability. Once the option is not anymore referenced, trigger a new synchronization and the option will be removed.