Getting Familiar with the Configuration Page
You can manage all your pattern mappings in the config page
Access the configuration page of the JECH plugin via the 'Configure Comment Handler' link in the Manage Addons Page.
You would be greeted with a UI as shown below.
How to Add a new Pattern Mapping ?
Click on 'Add new Rule' button in the Configuration Page to add mappings.
You should get a pop up window as shown below
Select the Project and Issue type combination to which you wish to apply the pattern for.
You may chose 'All Projects' and/or 'All Issue types' as well to select them in bulk.
Next select the custom field/entity from the 'Custom Field' dropdown.
This dropdown also supports Jira native features such as Summary, Description, Assignee, Status etc..
You may use the '+' and '-' icons respectively to add and remove mappings.
Please note that, NOT all the fields shown in the fields dropdown may be compatible with JECH.
Please cross check the 'supported fields' section of your plugin version to know the list of Custom Field Types supported.
We are extending support for more and more fields in the new releases. In case you want us to extend support for a specific field type, please reach out to us.
How to Edit an existing Pattern Mapping ?
Click on 'Edit' link for the Pattern you wish to modify.
You should get a pop up window as shown below
Perform the modifications to the Project/Issue Type/ Custom Fields and or Patterns.
You may use the '+' and '-' icons respectively to add and remove mappings.
Finally click 'Update Pattern Mapping' to Save the changes.
How to Clone an existing Pattern Mapping ?
You may clone existing patterns to create new ones in a faster way.
Click on 'Clone' link for the Pattern you wish to modify.
You should get a pop up window as shown below
Perform the modifications to the Project/Issue Type/ Custom Fields and or Patterns.
You may use the '+' and '-' icons respectively to add and remove mappings.
Finally click 'Clone Pattern Mapping' to create a new mapping.
How to Delete a Pattern Mapping ?
Click on 'Delete' link for the Pattern you wish to remove.
You would be prompted with a confirmation message. Click 'Ok' to remove the pattern permanently.
How to set the 'Run As User' ?
Once you finish setting up the plugin, up on end user comments, the Jira custom fields updates would be performed on behalf of the 'Run As User' you select.
By default this would be the 'Logged in User'.
Select the desired user from the dropdown and click 'Update user' button to Save the changes.
It is recommended to keep a default user with all the necessary permissions ( Eg: Edit Issue permission to perform field updates, Transition Issue permission to perform Status update etc.. ) as the 'Run As User'.
Eg username: 'JECH Default User'
Instead by selecting 'Logged in User' the field updates would be tried to be done as the user who is adding the Comment.
This can result in more failures while trying to update Custom Fields as it is hard to ensure all permissions of all users to the Projects.
How to Reset all the Configurations of the JECH plugin ?
Resetting the plugin configs would remove all the previous Mappings, Configurations and Logs of JECH.
This will not affect the Plugin License or any existing data in the JIRA Projects or Issues etc..
In case you wish to reset the JECH plugin configurations for a fresh start, you may do so by clicking on 'Reset' button from the top Menu Bar.
You would be prompted with a confirmation message. Click 'Ok' to remove the pattern permanently.
Let's get familiar with the pattern logic..
- The pattern must always contain a 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 can match multi lines.
- Casing and space chars in prefix/suffix need an exact match with comment.
- It is ok to add multiple mappings for the same Custom Field. You may leverage this to handle Casing/Space chars.
Examples :
Consider a user adding the Sample Comment below to :
| Random lines here; Emp Id=007 Role=Agent User Name=James Bond <age>32</age> More text here |
|---|
Based on the above mappings the following would happen:
- Custom field 'Full Name' is populated with value 'James Bond'
- Description 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
) - Number Field1 gets updated as '32'
- Text Field2 gets populated with 'Random lines here' as it comes before the suffix ';'
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.
You may cross check the Log messages from 'Comment Handler Logs' section to see the success / error logs
