Environment Issue Custom Fields

Environment Manager is officially shipped with Environment Custom Field Type since Version 3 (experimental since release 2.5).

Using Environment Custom Fields is an alternative to the free text Environment field that is provided by default by JIRA. If you use Environment Manager you have already started to create structured and rich information about your environments. Why not re-use all this information directly in JIRA issues ?

Learn how to add Environment Custom Fields, how to manage environment information in your issues, how to search issues using environments data and how to build dashboards and get statistics :

Apwide TEM Custom Issue Page Environment CustomFields Example

Why create Environment Custom Fields ?

The default “Environment” free text field that is provided by default by JIRA can be very ambiguous. Does it represent the environment on which I have detected my bug ? Is it the environment used to test the bugfix we have just received ? How is it possible to get accurate statistics (ex : number of issues detected on a an environment) based on a free text field ?

If these questions sound familiar to your, it can really help you to start creating different Environment Custom Field. Like for version, creating different fields of type environment can really bring clarity for you and other JIRA users. We suggest you to start adding at least 2 environment custom field to all your issues :

  1. “Detected in” : environment on which a new issue has been detected
  2. “Tested in” : environment on which a fixed issue has been tested

You can imagine many more. For example : “Reproduced In”, “Demoed in”,…

N.B. The concept is similar to the version concept in JIRA : you have only one list of versions but you can have different fields of type version on the same issue (ex: Fix Version/s and Affects Version/s).

How to create Environment Custom Fields ?

You must have installed Environment Manager and to be a JIRA administrator in order to create a new Environment Custom Field.

N.B. If you have never created a custom field before, please read the documentation of Atlassian. It will help you to understand the concept: How to add a custom field

If you are allowed and ready to create *custom fields”, open the “Issues” administration panel, click then on the Custom Fields (left menu) and follow these instructions :

Apwide TEM Custom Setup Environment CustomFields

Associate Environments on Edit Issue Page

If no environment is already associated to the issue, open the Edit page :

Apwide TEM Custom Issue Page Edit Environment CustomFields Example 1

Associate Environments on View Issue Page

If some environments are already set, just click on the field to remove or add new environments :

Apwide TEM Custom Issue Page Edit Environment CustomFields Example 2

Apwide TEM Custom Issue Page Edit Environment CustomFields Example 3

Associate Environments using the Jira REST API

You can edit the value(s) of an environment custom field using the standard Jira REST API. The values of an environment custom field are set using an array of Strings representing the id’s of the associated environments. Please refer to the curl example below:

#update an environment custom field
#simply set an array with the id's of environments you want to set (ex: ["1","2","3"]) for your apwide environment customfield (ex: customfield_10200)

$ curl -D- -u admin:admin -X PUT --data '{"fields" : {"customfield_10200" : ["1","2","3"]} }' -H "Content-Type: application/json" http://localhost:2990/jira/rest/api/2/issue/NDT-1

Search issues by Environments, Categories or Applications

If you have associated issues to environments using one or many Environment Custom Fields, you can use Environment search criterion to filter your issues.

Simple Search

Apwide TEM Custom Issue Simple Search Environment CustomFields Example

Advanced JQL Search

Apwide TEM Custom Issue Advanced JQL Search Environment CustomFields Example

Use Advanced JQL functions

Read documentation of Environment JQL Functions.

Use Environments data for Dashboards and Statistics

Environment Custom Fields can be used by statistical gadgets to build dashboards. Interested to know how many bugs have been detected or tested on your various environments ?

Apwide TEM Custom Dashboard Environment CustomFields Example