Skip to end of banner
Go to start of banner

Adding Pattern Mappings Guidelines

Skip to end of metadata
Go to start of metadata

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

Compare with Current View Page History

« Previous Version 9 Current »

Rule Name:

'Rule Name' is used to uniquely identify each rule. Rule Name can not be duplicated.

'Rule Name' is used to uniquely identify each rule. Rule Name can not be duplicated.

Example : *Rule name already taken. Try another one

Field Parsing Logic

Let's get familiar with the pattern syntax..

  • The pattern must always contain the string "{value}"

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

  • The plugin uses regex matching in the backend. Based on prefix and suffix tries to pick the relevant string from the Comment.

  • 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 comment.

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

Lets 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: 

username=Jira-ADMIN
Address:5th Floor, Tower ‘X’,
Silver Enclave,
Airport Road, Bengaluru;
Level::7
Instance=https://mgtechsoft.atlassian.net
Begin Time=25/Aug/22 10:55 AM

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 (wink) )

Please note, only if the comment contains Jira accepted field values it would be populated in the Custom Fields. 

Eg : Providing text field to a Numeric Custom Field, would fail to populate the Custom Field. Similarly for date field, URL fields etc..

Please visit "Supported Fields" section of the Documentation for more details.

Rule Priority

What if we have multiple rules defined which a which might be applicable for a particular Jira Event. 

This comes into picture when you have rules defined for 'All Projects' and or 'All Issue Types' which are called 'Global rules' depicted with 'G'

Consider the four rules above. Imagine we are Creating a 'Task' in 'Demo Monitoring Project'.

Here even though all the rules match this Create Issue Event, the rule which is defined at the most fine grained level would take priority over Global Rule and would execute

Here the priority would be in the order : Demo Rule > Sample Rule> key based rules> Global Rules

Please note: You won't be able to able to add multiple rules for the same 'Project' and 'Issue Type' combination.

In case you try to add the same, system would prompt you whether you wish to overwrite the existing Rule.

Clicking 'OK' would replace the previous rule with this new rule. Instead you may choose another Project/ Issue Type combination and proceed as well.

  • No labels