Getting Familiar with the Configuration Page
You can manage all your pattern mappings in the config page
Access the configuration page of the FEJ plugin via the 'Configure Field Extractor' 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
Provide a Name for your rule.
Select the Project and Issue type combination to which you wish to apply the rule for.
You may chose 'All Projects' and/or 'All Issue types' as well to select them in bulk.
Now select the Jira events for which the Plugin should listen to. Currently FEJ supports 'Create Issue'/ 'Edit Issue'/ 'Add Comment' and 'Edit Comment' events.
Once you enable a particular event, you should select the source/input field which would be parsed during the Event.
Eg: You may choose to parse the 'Description' field during Issue Creation, and another text area field called 'User Inputs' during issue edit.
Please note for 'Create Comment' and 'Edit Comment' you can only choose 'Comment' as the input field for parsing.
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.
Not all the custom field types from your Jira instance might be listed here.
We are extending support for more and more field type in the new releases. In case you want us to extend support for a specific field type, please reach out to us.
Finally click 'Add Pattern Mapping'
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/ Event selections/ Source 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
Provide a new 'Rule Name'
Perform the modifications to the Project/Issue Type/ Custom Fields, Event selections/ Source 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: 'FEJ 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 FEJ plugin ?
Resetting the plugin configs would remove all the previous Mappings, Configurations and Logs of FEJ.
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 FEJ 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. Type 'reset' in the box and Submit to remove all the previous configurations of the App including Rules and Logs permanently.
