Field Processors

Owned by Mike Harrison
Last updated: Apr 06, 2023 by Ryan Clifton
3 min read

Summary

A common goal is to set the fields of an issue based on the contents of an email. Field processors enable this functionality by detecting relevant information in pre-defined patterns and extracting it. This data is then used to create an in-memory map of Directives - commands that drive JEMHC to create and update issues.

Several field processors are available - each catering to different data formats and locations. For example, the Subject Field Processor parses only the email subject header (as the name suggests). On the other hand, the Regexp Field Processor can be used on both the email subject and body.

 

Enabling a field processor for use

Ensure that you

  1. Navigate to your JEMH Cloud profile configuration via JEMH Cloud > Profiles

  2. Edit a project mapping of your choice, and select Field Processors from the left navigation panel

  3. Under General Configuration section of the page, you will see a setting named Apply field processors. Select an option for this setting other than ‘Off’.

  4. Under the Field Processors section of the page, select ‘Yes’ for a field processor that you want to process the email with

  5. Some field processors will then show further configuration options, which you can learn more about via their respective documentation pages below.

 

Directive Aliases

This allows the directives sent in emails or derived via field processors to be re-mapped to a different value. They are often used to shorten verbose directives sent via email. For example, 'bug' can be used as an alias for the directive 'issueType=bug'.

When creating the alias you have to specify:

Alias Type

This defines the type of alias that should be created. Current options are:

  • Key/Value - Converts one key into a key and value. For example Bug ➡ issueType=bug.

  • Key - Converts only the key part of a directive

  • Value - Converts only the value part of a directive

Alias

This is the directive that will be identified within the email body.

Value

This is the original value/directive that JEMHC can use to set the relevant values on the issue.

 

Security

This section allows you to specify who can use Field Processors and the directives that can be run.

Allowed email addresses

This is a CSV list of email addresses that are allowed to send directives.

Allowed Users

List of users that are allowed to send directives. Any non matching users will not be able to send directives.

Allowed Groups

Members of the selected groups are allowed to send directives. Any users that are not in the groups will not be able to send directives.

Allowed directives

List of directives that can be processed. Any non matching directives will not be run.

Blocked Directives

List of directives that will not be processed. All matching directives will not be run.

 

Field Processors Email Tester

This form allows you to test what directives are resolved when processing emails. You can base your email on a test case. This allows you to test the settings before saving! Make sure the test email matches the current project mapping's rules to test this configuration.