Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

Contents

The JIRA Suite Utilities plugin provides these additional workflow validators:

  • Date Compare
  • Date Expression Compare (since version 1.4.8)
  • Fields Required
  • Regular Expression Check (since version 1.4.9)
  • Window Dates

For information on workflow validators in JIRA, see the JIRA documentation.

On this page:

Date Compare Validator

Description

The 'Date Compare' validator compares the values of two date fields on the issue (for example, one field must be greater than the other). If the validation fails, the transition will not be completed.

Configuration

You must select the two date fields and the comparison function for the validator, when configuring the transition. For example:

For information on how to configure a validator in JIRA, see the JIRA documentation.

Example

A workflow is configured so that the 'Resolve' transition has the 'Date Compare' validator where 'Resolved Date' <= 'Due Date'. If a user attempts to resolve an issue on this workflow, where the 'Resolved Date' is after the 'Due Date', the validation will fail and the transition will not be completed.

Date Expression Compare Validator

Description

The 'Date Expression Compare' validator compares the value of a date field with a date expression (for example, date field must be more recent than actual date). If the validation fails, the transition will not be completed.

Configuration

You must select the date field, the comparison condition, the date expression itself, and optional whether to include the time part for comparison. For example:

For information on how to configure a validator in JIRA, see the JIRA documentation.

Example

A workflow is configured so that the 'Resolve' transition has the 'Date Expression Compare' validator where 'Due Date' > '5d'. If a user attempts to resolve an issue on this workflow, where the 'Due Date' is less than 5 days from now, the validation will fail and the transition will not be completed.

Fields Required Validator

Description

The 'Fields Required' validator checks whether values for specified fields are set for a given transition. If the validation fails, the transition will not be completed.

Since version 1.4.10, Σ Time Spent may be used to validate that work has already been logged once, before the current transition or within itself. And a new option has been added, to be able to ignore the context check on fields made by the plugin.

Configuration

You must select mandatory fields, when configuring the transition. For example:

For information on how to configure a validator in JIRA, see the JIRA documentation.

Example

A workflow is configured so that the 'Resolve' transition has the 'Fields Required' validator where 'Fix Version' is mandatory. If a user attempts to resolve an issue on this workflow, where the 'Fix Version' field its value not set, the validation will fail and the transition will not be completed.

Regular Expression Check Validator

Description

The 'Regular Expression Check' validator compares the value of a text, number or url's field against a regular expression. For example to verify that the content matches a given format.

Since version 1.4.10, selection fields, radio buttons and multi selection fields are also supported.

Configuration

You must select the field  to validate and enter the regular expression. For example:


For information on how to configure a validator in JIRA, see the JIRA documentation.

Example

A workflow is configured so that the 'Resolve' transition has the 'Regular Expression Check' validator where 'TextField' has to match '[a-z]*'. If a user attempts to resolve an issue on this workflow, where the 'TextField' is for example '7 pieces', the validation will fail, and the transition will not be completed. However 'pieces' as content would be allowed.

Window Dates Validator

Description

The 'Window Dates' validator checks whether the value of one date field falls within the range (window) of another date field. Note, the date checking is only one-way, i.e. it only looks forwards, not backwards. If the validation fails, the transition will not be completed.

Configuration

You must select the two date fields and the window period, when configuring the transition. For example:

For information on how to configure a validator in JIRA, see the JIRA documentation.

Example

A workflow is configured so that the 'Close' transition has the 'Window Dates' validator. The 'Resolved Date' is validated using a window of 5 days with respect to the 'Created Date'. If a user attempts to resolve an issue on this workflow, where the 'Resolved Date' is more than 5 days after the 'Created Date', the validation will fail and the transition will not be completed.

Supported Field Types

In its different modules (especially those for workflows), the JSU app supports many different field types. System fields, as well as custom fields.

However you should be aware, that not all field types are supported. Also not in all combinations. We think we cover the most important field types and still are continuously adding and improving which and how different field types are supported. But the one you need, might just not (yet) work. Some custom fields of other third party app might never get supported.

For that reason you should always test anything you do with the JSU app with fields. Before you buy a license for JSU, try it with a free evaluation license, if it works for you.