Page tree
Skip to end of metadata
Go to start of metadata

The Auto-Context page, within the 'Custom Fields' tab allows you to use the powerful features included in the Cleaner for Jira App to:

  • Scan you system for Custom Fields which don't have the best Context/s configured
  • Select Custom Fields which you would like to automatically set the Context

Cleaner for Jira makes optimising your usage of Custom Fields an easy operation.

Features:

  • Drill Down into Suggested Context/s
  • See Issue Usage
  • Automatically Context Fields

How do Custom Field Context/s affect Performance?

The correct scoping of Custom Fields will:

  • Decrease the size of your Index.
    • Index is directly linked to the amount of dimensions there are.
  • Decrease the amount of data sent/received (and response times) for REST requests relating to Issues (create/edit/view).
    • Prevents numerous "customfield_10001":null values from being sent with every request (and associated SQL queries).
    • To test this assumption on your own system, please make a request to a JIRA Issue using the following endpoint:
      • /jira/rest/api/2/issue/ABC-123
      • Search for 'null' to see how many Custom Fields with no values are being returned for a single issue.
  • Make creating, editing and viewing issues quicker.
    • Reduces the amount of processing required when performing these actions.
  • Make management easier.
    • Lower applicable issues makes administration easier in the long term, as field usage is carefully controlled.


Custom Fields are widely accepted to be the single performance-affecting object that affect's the system. Bad configuration of Custom Fields can affect even Data Center instances, as it has a multiplier effect on the performance of the system, due to the data being accessed when most actions are performed in the system.


Steps

To get started with the Auto-Context feature, follow the instrucxtions below:

  1. Navigate to the Auto-Context page in the interface by clicking on the Custom Fields tab
  2. Read the information shown on the front page of the Auto Context page carefully and when you understand the functionality provided by the Auto Context feature, click on the 'Scan' button in the top-right to start the scan.
  3. The App will perform the following tasks to determine what Custom Fields can be processed by the Auto-Context feature included in the Cleaner for Jira App.
    1. Determine how many Custom Fields (number) have a single, global Context and return this to the client. This stage excludes Custom Fields that are on our blacklist.
    2. In sets of 10, the App will determine the usage of each Custom Field and determine if it is a good candidate for having it's context set correctly.
    3. A good candidate Custom Field will be used in:
      1. Less than 10 Projects
      2. Less than 10 Issue Types
    4. This will continue until all the Custom Fields determined to be in scope for the scan has completed.
  4. When complete, you will be allowed to select Custom Fields that you want to automatically set up correctly.]

After you have performed an Auto-Context, in order to reduce the size of the index and reduce load on the system, please perform a full re-index.

Screenshots

Introduction Page

Execution Page

  • No labels