Aliases

Owned by Ryan Clifton
Last updated: Jun 16, 2023
4 min read

Summary

Aliases are versatile mechanisms for providing short cuts to common directives, e.g. an Alias bug with value issueType=bug allows a Directive of @bug to be used. Additionally, Aliases can be used to provide a mapping from some other source that happens to match a supported JEMH Field Processor format, for example, if a remote system created a value:

Related Systems: this,that,the other

This value could be mapped to components by setting up an Alias components with a value of Related Systems.

No Directive Characters

When creating Aliases, they are not specific to a field processor, no @ prefixes should be used etc.

Creating an Alias

  1. Enter the Alias name that you would like and then enter the value you would it to be linked to. In this example the Alias is “bug” and the value is “issueType=bug”

  2. Press Submit to save the Alias. Once saved it will appear in the list at the bottom. Here you are able to edit or delete the Alias.

Testing Alias

  1. Create a Test Case that uses this Alias within a Directive. In this example we are using the At (@) Prefix Field Processor. (For info about Field Processors see: https://thepluginpeople.atlassian.net/wiki/spaces/JEMH/pages/3787227192) The email looks like the following:

    MIME-Version: 1.0 Received: by 10.223.112.12 with HTTP; Sat, 18 Jun 2011 22:42:26 -0700 (PDT) Date: Tue, 18 April 2023 15:42:26 +1200 Message-ID: <BANLkTinB1mfSh+GwOXGNWoL4SyDvOpdBoQ@mail.gmail.com> Subject: This is a starting email template, update as required From: admin@localhost To: mailbox@localhost Content-Type: text/plain; charset=UTF-8 @bug some text

  2. Now when we run this example we will see that a Directive was found and that JEMH will set the Issue Type to Bug:

     

  3. Issue view:

Examples

Here are some examples using the AtPrefix Field Processor Directive format, bold italic values are JIRA defined values

Type

Incoming Directive

Example related Alias applied

resulting key/value pair used

Summary

Type

Incoming Directive

Example related Alias applied

resulting key/value pair used

Summary

key aliasing with key-value replacement

@important

important == priority = highest

priority=highest

The supplied value important is found as an Alias, that has a value priority=highest that is then applied in place of the supplied value

key+value aliasing with different key-value replacement

@importance=high

importance=high == priority=highest

priority=highest

The supplied value importance=high is found as an Alias (matching on the entire key and value), the value of the Alias is priority=highest that is then used to replace of the entire key/value supplied

key replacement

@Thing=highest

Thing == priority

priority=highest

The supplied key Thing is found as an Alias for priority and is replaced to make a final supplied value priority=highest

value replacement

@priority=unknown

unknown == highest

priority=highest

(In standard field processors in 1.7.28+ - feature already exists in the Regexp Field Processor) The supplied key priority is retained, the value unknown is found to be an Alias match, and is replaced with the value highest resulting in a final supplied value of priority=highest

Inbound Key/Key+Value aliasing.

To shorten a more long winded Directive (@issueType=Improvement) into something easier to remember (@idea). The value may contain an equals sign which is used to break out a key and a value that will replace the 'idea' alias at processing time. An Alias can be created as follows:

Create an Alias

After saving

Configuration View

Create an Alias

After saving

Configuration View

 

 

 

Inbound Key aliasing

To convert a given key from an externally provided value to an alternate field, aliases can be used to perhaps to avoid collision with an existing field, e.g. a provided field 'components' is going to be interpreted as the JIRA field, perhaps it needs to be Aliased to 'Remote Components' that could be a custom field.

Add the Alias

Create a Test Case

See the Issue Created

Add the Alias

Create a Test Case

See the Issue Created

 

 

 

Inbound Value aliasing

currently this only implemented in the Regexp Field Processor, others will follow.

Recently, as part of features added to the Regexp Field Processor, JEMH now also supports discrete Value Aliasing (specifically used in the Regexp Field Processor, others to follow. This allows remote system values to be mapped into JIRA specific values, for example, if a remote system says priority: awfully important, the value awfully important could be aliased to major. etc.

Alias options

Edit

This will add the existing values for this Alias into the Alias and Value textboxes, allowing you to modify the Alias. Pressing Submit after altering will save the modified version of the Alias.

Delete

This will delete the Alias, meaning that it can no longer be used.

Related Pages