Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Quantum::Estimator plugin offers a set of JQL functions that allow to query estimations. All Quantum::Estimator JQL functions return a list of Jira issues that fulfill the search criteria.

...

Supported Functions

Table of Contents

Standard form

The standard form is

...

since the Quantum::Estimator functions will allways always return a list of issue filtered based on your query.

Provided functions

estimationCreator()

The estimationCreator() function will return all issues with a specific creator.

...

Code Block
issue in estimationCreator(admin, smith)

estimationDue()

The estimationDue() function will return issue matching specific criterias criteria regarding its due date. The estimaationDue() function expects, zero, one or two arguments.

Search for tickets due today:

`issue in estimationDue()` returns Searching all issues which are in estimation state `ESTIMATING`

Status
colourYellow
titleESTIMATING
and are due or overdue.

Code Block
issue in estimationDue()


The `estimationDue()` functions accepts a duration string, following the standard Jira duration format as as used in the time tracking field. Here are some examples:


Search for tickets due at a specific date:

...

Code Block
issue in estimationDue('2020-08-01')

...

Will return all issues which are in estimation state `ESTIMATING`

Status
colourYellow
titleESTIMATING
and will be due at `2020-08-01`.

Search for tickets due within a date range:

Code Block

...

issue in estimationDue('2020-08-01', '2020-08-07')

...

Will return all issues which are in estimation state `ESTIMATING`

Status
colourYellow
titleESTIMATING
and will be due in the date range between `2020-08-01`, `2020-08-07`.

Search for tickets with a relative duration:

Code Block

...

issue in estimationDue('1w')

...

Will return all issues which are in estimation state `ESTIMATING`

Status
colourYellow
titleESTIMATING
and will be due in one week from now.

Code Block

...

issue in estimationDue('1w', '1w')

...

Will return all issues which are in estimation state `ESTIMATING`

Status
colourYellow
titleESTIMATING
and are due in the range of the past seven and future seven days.

...

The function accepts dates in the format: `YYYYYYYY-MM-DD`DD.

Relative format pattern:

The function accepts relative times in the format: `1d``1d`, `2d`, `5w`, etc.

estimationState()

The estimationState() function returns all issues that are matching an estimation state.:

Code Block
issue in estimationState()

estimatedByUser()

The estimatedByUser() function will return all issues with estimation tasks that where estimated by a user.:

Code Block
issue in estimatedByUser()

estimatesMissing()

The estimatesMissing() function will return all issues which are in estimation state `ESTIMATING`

Status
colourYellow
titleESTIMATING
and that have missing estimates.:

Code Block
issue in estimatesMissing()

estimatesMissingForUser()

The estimatesMissingForUser() function will return all issues whith with estimation tasks that where the user is allowed to estimate and has not yet estimated.:

Code Block
issue in estimatesMissingForUser()