Supported fields for use with Directives

Values are considered as CSV where mulitple values are possible (eg selects, multi picker fields), in such cases, comma ' , ' cannot form part of values to be set.

Custom fields can be manipulated in two ways:

• The custom field name. If values for fields can be represented as a string. Tested with Labels, e.g. "Labels: sentByEmail". Note to be careful naming custom fields with default field names, for example assignee is a default field.

• Custom field ids can be used as per example:

  • customfields_<customfield id>

numeric (e.g. 10001), textual name (e.g. Support) or project key (e.g. SPP). Only required if email to: address is not a known project key

numeric (e.g. 4) or text name (e.g. critical)

numeric (e.g. 12) or text name (e.g. Feature Request)

numeric (e.g. 6) or text name (e.g. Closed)

It’s possible to migrate an existing Issue Type with a status when this directive is used in conjunction with the issueType directive.

For example (in the @ prefix field processor):
@issueType=Task
@issueType.status=Closed

A CSV capable field. Can be numeric (e.g. 100020) or textual name (e.g. My Magic Component)

String value matching a group or role name, used to restrict the visibility of comments

String

userid or email address of given user in JIRA

userid or email address of given user in JIRA, who is 'assignable'

String (single line)

String (multiple lines)

Comma Separated Variable list of userid's, in Jira

Users can override the default (ISO standard) SimpleDateFormat string yyyy-MM-ddTHH:mm:ssZ through the 'dueDateFormat' field (e.g. dd-MMM-yyyy enables dates like 12-May-2009.  If the user does not provide a dueDateFormat directive, the system default (in jira-application.properties) under the key jira.date.picker.java.format will be used as a fallback

of format 1w7d12h30m, or any derivative JIRA 6 requires spaces between values. When supplied in the subject it needs quoting like: #workEstimate="1w 2d 3h"

Issue Linking more information on Issue Links here: https://confluence.atlassian.com/adminjiraserver/configuring-issue-linking-938847862.html ,

Format

Legend

• direction type = to/from

• destinationIssue = issue you want the property to apply to

• sourceIssue = issue being processed

• linkTypeProperty = outward/inward/name value

directionType:destinationIssue/linkTypeProperty

Examples

to

to:ABC-101/duplicate

from

from:XYZ-123/relates

to+from

to:ABC-101/duplicate,from:XYZ-123/relates

multiple links

to:ABC-101/duplicate,from:XYZ-123/relates,from:XYZ-124/is blocked by,to:XYZ-125/blocks

1.3,2.1

1.0,1.1,2.0

true (only value to make sense/false)

Long value, e.g. 12345.

Required when creating an issue of type "Epic"

Required in order to link an issue to a parent Epic.  The value used is the name of the epic you are linking it to.

The colour pre-set used for the Epic.  The values are ghx-label-1 to ghx-label-9.

Sets the Organizations field on requests. The value can be either the ID or name of one or more Organizations. Multiple values should be comma separated.

Used to set whether a comment is internal (private, not seen by customers) or not.  Can only be used by Agent users. Value is boolean (true or false).

issueKey

this Directive can identify an issue directly, e.g. with a value of ABC-123. Alternatively, it is also possible for this to be a simple assertion for a custom field value, e.g.: with a value of Custom Field X=123456789 a JQL search will be triggered for issues containing that value. The first found will be commented upon.

parentIssueKey

value indicates issue to create new task under PROJ-123, currently only 'Sub-task' is supported

issueTemplate

uses fields from the given issue during issue creation, allowing defaulted custom field values and more

value indicates the workflow step, can be exact text match or first word match (see FAQ), e.g. start would match 'Start Progress'

keys with suffixes of workflow. are interpreted as parameters to the given workflow transition, otherwise defaults will be used (see FAQ). For example, workflow.resolution with a value of cancelled

wl.timeSpent

Sets logged work duration to be set in normal 3h 45m type format (It is important there is a space between each time unit)

wl.startDate

Set logged work start date in system default date format (TODO link to Jira property)

wl.newEstimate

Sets the new estimate of effort for the work, value format 1d3h25m

wl.keepEstimate

If set true will keep the existing estimate unmodified, when logging timeSpent

wl.viewable.role

Enables Project Role visibility restrictions for work logs to be set, Name or ID can be used

wl.viewable.group

Enables visibility restrictions for work logs to be set (NOTE: must be enabled through jira-application.properties), Name or ID can be used

values are toWatcher and toCustomField. toWatcher makes cc: resolvable users watchers, toCustomField routes resolvable users to a nominated Custom Field, set by ccHandlingTargetCustomFieldName

Defines the name or ID of a Custom Field that will have cc: resolvable users added to

This field can be used in addition to the standard email cc:, it is a CSV formatted value, identifying users by ID/email. The provided values are processed according to system configuration values ccHandling and ccHandlingTargetCustomFieldName