Installation

The installation is easy via the UPM in Jira. After the successful installation, the plugin can be used immediately upon entering a license key.
 
Since the calculation of issue statistics requires a large amount of computing power, especially when you're dealing with numerous fields and/or
issues, those statistics have to be configured seperately for each custom field. This way you ensure that only desired statistics are being produced.


Issue navigator

There are several things that can be configured in the issue navigator for the summation of issue fields.

In the Issue Navigator list view sidebar you will find a "Calculate" button.

Clicking the button results in the totals (average...) being shown at the end of the issue table.



Permanent calculation

Enable or disable permanent calculation for the issue navigator.

(warning) SumUp can be very performance intensive in large instances with a great number of issues ( more than 100.000 issues). In those instances it is not recommended to enable this feature.



Filter results

The Filter-Results-Gadget on the dashboard will also display the column totals of any given filter result,

Define those filters where the sum row will appear in the issue navigator or in the dashboard gadget "Filter results".


By clicking the "Save" button, the form is submitted and the entry should appear on the screen. Please be aware that non-indexed custom fields (see Jira custom field searcher), will be calculated using the database. This can raise performance issues depending on field settings and the number of issues being searched.


Save settings

If you, as the filter owner, click the button in a saved and currently not modified filter, the settings will be saved for your next visit.

If you have shared the filter with others they will also get the column totals (specified metric).



SumUp Calculation rules

SINCE VERSION 3.3.0 Changed naming and new features

Configuration is always necessary when custom fields are going to be evaluated according to your specific needs.

Configure sumUp fields in the Jira Add-On Administration → SumUp→ Calculation rules.



To calculate sums/averages for a field, you have to set up a configuration rule for that field. On the SumUp Configuration site click "Add new rule".

A field rule has a set of calculation and output options:



Calculated Method
  • Sum
  • Average
Output formatClick here to see how velocity templates work
Decimal PlacesNumber of decimal places
Prefix/ SuffixType in any pre- or suffix you want to add to your calculation (e.g. Suffix: "$" for 4.000 $)
Number format
  • Default
  • Regex Extractor
  • Locale Number Format

SINCE VERSION 3.3.0

Primary

If there is more than one rule for one custom field, the current rule will be selected as primary by ticking the checkbox


Regular Expression

If, for example, you have a field in which you collect numerical data and some other characters, you can add a regular expression for this field to extract the numerical part of the information and enable the possibility to compute sums and averages for these values as well.


Examples:

Data Type

Field Data

Regular Expression

Evaluated Data

Simple NumberWords: 79\d+79
Number with optional fractional part1000 $\d+(\.\d+)?1000
Floating point numberThe average speed was -1.79e5 m/h.[-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]+)?-179000


Evaluation of text fields containing special number formats

A special locale number input format can be defined from add-on version 2.2.2 and higher  to evaluate text fields containing numbers. 

InputFormat

Field Data

Local

Evaluated Data

NumberFormat1.000.000,5de1000000.5
NumberFormat1,000,000.5en1000000.5


User Permissions

Starting with version 2.3.0, you can choose whether users or groups are or are not allowed to have access to the app.



Administrator configuration

SINCE VERSION 3.2.2

Due to performance issues when using sumUp in large Jira instance with a lot of data to calculate, the maximum issue count and maximum calculation seconds can be specified in the administration.

By default they are set to 500.000 issues and 600 seconds.


sumUp post function

Updates an issue field to a computed summed value of another field. Select Issues via JQL or Filter.

Example: When creating a new issue, I want my custom field called "Total Story Points" to sum all the Story Points that I chose in my filter/JQL.

In order to configure this function, you need to edit a workflow, and add a new post function on a certain step. The images below shows the screen you should see when performing this action.

(info) For now, only fields of type "String" can be used as result fields for the Post-Function.




On this page