This is the documentation of JSU for Jira Server/Data Center. If you are using JSU on Jira Cloud, you can find the documentation here.
Description
The 'Regular Expression Check' 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.
Configuration
You must select the field to be checked and enter the regular expression. For example:
- [0-9]{4}-[0-9]{4} would allow numbers such as: 1245-7783
- [0-9]+ EUR$ would allow price tags such as: 34 EUR
- [a-z]* would allow an empty string, or any lower case word such as: yellow
- Option [A,B] would allow a selection of options: Option A, Option B or both.
Detailed Documentation on Regex can be found here: https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html It is quite technical though. A good website that could help further is https://www.freeformatter.com/java-regex-tester.html where you can test them and also have a less technical documentation with examples. Hope this helps.
For information on how to configure a check in JIRA, see the JIRA documentation.
Be careful what kind of regular expressions you are using. Some might be exploited by a malicious person. See ReDoS . It is your responsibility as JIRA administrator to only use safe regular expressions.
You can define a custom error message for most JSU validators to provide a clear explanation of the situation to your users. If you leave this field empty, a default error message from Jira will be displayed on validation errors. This might be a bit too technical, and make it difficult for your users to understand and resolve the error.
Example
A workflow is configured so that the 'Resolve' transition has the 'Regular Expression Check' 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 check will fail, and no action will be performed. However 'pieces' as content would be allowed.
Supported Field Types
JSU supports many different field types such as system fields and custom fields. However you should be aware, that not all field types are supported, and not in all combinations. We aim to cover the most important field types and are continuously adding and improving how different field types are supported. Some custom fields of other third-party apps might never be supported. You should always test anything you do with issue fields with JSU. You can try it with a free 30-day evaluation license.