Guidelines for Adding Pattern Mappings

Field Parsing Logic

Let's get familiar with the Pattern syntax in Basic Mode.

• The pattern must always contain the string "{value}" in Basic Mode.

• Pattern may optionally contain a prefix and/or a suffix

• The plugin uses regex matching in the backend. Based on prefixes and suffixes tries to pick the relevant string from the Source Field.

• The "{value}" string part will be identified and populated to the corresponding custom field

• If a suffix is not provided, then only the current line would be matched. By providing a suffix you may match multi-lines.

• Casing and space chars in prefix/suffix need an exact match with the Source Field.

• It is okay to add multiple mappings for the same Custom Field. You may leverage this to handle Casing/Space chars.

Let's look at an example to see the plugin in Action

Imagine we have added a pattern mapping as shown below:

Now let's add the following Sample Comment to the Jira Issue: 

Based on the above mappings the following would happen:

• Custom field 'Employee Name' is populated with value 'Jira-ADMIN'

• 'Employee Address' field is populated with value '5th Floor, Tower ‘X’,Silver Enclave,Airport Road, Bengaluru'

• 'Total Score' field is populated with '7'

• 'Server URL' field gets updated as 'https://mgtechsoft.atlassian.net'

• The 'Actual Start Date' field gets updated as '25/Aug/22 10:55 AM'

• Lastly the 'Last Comment Field' is populated with the whole of the comment text. ( You may use this trick to maintain a custom field which stores the Last Comment added to issue  )

Use the check box highlighted below in the Create/ Edit or Clone dialogue to enable Regex mode for a particular rule item.

Next, provide a regex pattern in the ‘Pattern’ input. PFB is an example.

When in action, the input rich text field would be checked against the regex pattern for a match, if a match is found the same would be updated to the ‘Priority’ field in Jira.

Regex Helper

We recommend to Visit the 'Manage Apps’ → ‘Regex Helper' module in your Jira to test Regex patterns against input texts before using them in Rules.

The Regex Helper tool is designed to assist users in performing regular expression matches on input data. Users can input a valid regular expression and a set of data, and the tool will automatically perform the match.

Valid Regular Expression:

Crafting a valid regular expression requires precision in considering the pattern's structure and matching criteria. Successful matches, shown in blue, exemplify the data to be inserted into the custom field on the issue page, while red highlights indicate mismatches.

In this example, the given regex pattern is returning a value ‘High’ based on the input data. Once the same pattern is used in a Rule as shown below, the rule can set the field ‘Priority’ as ‘High’.

Invalid Regular Expression or Input Data:

When the regular expression is invalid or a regex match is NOT found in in the Input Data, a corresponding error message is shown in Red color. Tweak the regex/ input data to get a success output before using it in a actual rule.

Clearing Input Fields:

To clear the input fields, entered values in both the "REGULAR EXPRESSION" and "INPUT DATA" fields, and then click the "Cancel" link. This action will swiftly reset both fields, providing a convenient way to start fresh.

Sample regex patterns for reference:

Guide on regex patterns! Below, you'll find a collection of sample regular expressions (regex) to help you validate and extract phone numbers from text etc….

Priority Extraction:
Regex: priority\s*=\s*(\S+)

Extracted Value: High

Name Extraction:

Regex: name\s*=\s*([a-zA-Z]+)

Extracted Value: ABC

Profile Extraction (up to 3 lines):
Regex: profile=(.(?:\n(?![a-z]+=).)*)
Extracted Value: ABC,
more details here,
Thank you.

Email Address Extraction:
Regex: assign\s*=\s*([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,})

Extracted Value: admin@admin.com

Phone Number Extraction:
Regex: phone\s*=\s*(\+?[0-9\s-]+)

Extracted Value: +1234567890