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 )
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.