Automation smart values - text fields

The following smart values are available to access and format text strings when setting up a rule. Check out how we use smart values in our Jira automation template library.

abbreviate(int maxLength)

Abbreviates the text string to the defined number of characters and adds "..." to the end. The maxLength parameter needs to be at least 4.

For more information, see: StringUtils.abbreviate(int).

asNumber

Takes a string, and converts it to a number if possible. Otherwise, returns null.

charAt(int index)

Identifies the character at the specified position in the text string.

For more information, see: String.charAt(int).

capitalize()

Capitalizes the first character.

For more information, see: StringUtils.capitalize(String).

concat(String str)

Adds a specified text string to the end of the returned value.

For more information, see: String.concat(String).

endsWith(String str)

Checks if the text string ends with the specified text, and returns true or false.

For more information, see: String.endsWith(String).

equals(string)

Takes a text field and checks if it is equal to the given string. Returns true if the strings are equal. Can be used in conditional logic.

equalsIgnoreCase(string)

Takes a text field and checks if it is equal to the given string, regardless of case. Returns true if the strings are equal. Can be used in conditional logic.

htmlEncode()

Encodes text to allow it to be included in HTML content.

html render

Takes a text field that contains wiki markup and converts it to HTML or plain text. Read more about converting wiki markup to HTML

indexOf(String str)

Returns the position of the first character in the specified text string.

For more information, see: String.indexOf(String).

isAlpha()

Checks if the text contains only letters, and returns true or false.

For more information, see: StringUtils.isAlpha().

isAlphanumeric()

Checks if the text contains only letters or numbers, and returns true or false.

For more information, see: StringUtils.isAlphanumeric().

isEmpty()

Checks to see if the text is empty, and returns true or false.

For more information, see: StringUtils.isEmpty().

isNotEmpty()

Checks to see if the text is not empty, and returns true or false.

For more information, see: StringUtils.isNotEmpty().

isNumeric()

Checks if the text contains only numbers, and returns true or false.

For more information, see: StringUtils.isNumeric().

jsonEncode()

Encodes text to allow it to be included in JSON calls, for example, the send outgoing web request action. 

View Json encoding below for details on encoding when sending outgoing webhooks as JSON.

jsonStringToObject()

Converts a JSON Formatted String into a JSON Object, who's keys can be accessed via Dot Notation.

Where the smart value for webResponse.body returned:

Arrays of Arrays do not work, such as:

But an Object of Arrays work:

lastIndexOf(String str)

Returns the position of the last character in the specified text string.

For more information, see: string.lastIndexOf(String).

left(int length)

Returns the characters, from the specified amount of characters, from the left of the text string.

For more information, see: StringUtils.left(int).

leftPad(int length, String pad)

Adds characters to the beginning of the text until the specified total number of characters is reached.

For more information, see: StringUtils.leftPad(int, String).

length()

Returns the number of characters in the text string.

For more information, see: String.length().

match()

Performs a regular expression search and returns the first (and only one) matching regular expression group.

The underlying implementation is based on Java's Pattern class and uses Matcher.find() to find matches. If multiple matches are found, they return as a collection that can be iterated. This can be used to find a single pattern match (e.g. extract a version number from the issue description) or to match multiple patterns (e.g. extract all e-mail addresses from an issue comment).

quote()

Escapes the smart value into a literal text expression that can be used in a regular expression match using Pattern.quote().

remove(String remove)

Removes characters from text.

For more information, see: StringUtils.remove(String).

replace(String target, String replacement)

Replaces all literal text matches with a specified replacement.

For more information, see: String.replace(String, String).

replaceAll(String regex, String replacement)

Performs a regular expression search and replaces any match with the replacement. $1 can be used to access a matching group in the replacement.

For more information, see: String.replaceAll(String, String).

reverse()

Reverses the characters in the text string.

For more information, see: StringUtils.reverse().

right(int length)

Returns the characters, from the specified amount of characters, from the right of the text string.

For more information, see: StringUtils.right(int).

rightPad(int length, String pad)

Adds characters to the end of the text string until the specified total number of characters is reached.

For more information, see: StringUtils.rightPad(int, String).

split(String separator)

Splits the text and returns the word specified by the word's position in the text string.

For more information, see: String.split(String).

startsWith(String str)

Checks if the text string starts with the specified text, and returns true or false.

For more information, see: String.startsWith(String).

substring(int start)

Returns the characters after the amount of characters specified.

For more information, see: StringUtils.substring(int).

substring(int start, int end)

Returns the characters at the positions specified.

For more information, see: StringUtils.substring(int, int).

substringAfter( String separator)

Returns the text after the first occurrence of the given separator.

For more information, see: StringUtils.substringAfter(String).

substringAfterLast(String separator)

Returns the text after the last occurrence of the given separator.

For more information, see: StringUtils. substringAfterLast(String).

substringBefore(String separator)

Returns the text before the first occurrence of the given separator.

For more information, see: StringUtils. substringBefore(String).

substringBeforeLast(String separator)

Returns the text before the last occurrence of the given separator.

For more information, see: StringUtils. substringBeforeLast(String).

substringBetween(String open, String close)

Returns the text between the given parameters.

For more information, see: StringUtils. substringBetween(String, String).

toLowerCase()

Converts the text string to lower case.

For more information, see: String.toLowerCase().

toUpperCase()

Converts the text string to upper case

For more information, see: String.toUpperCase().

trim()

Removes any whitespace at the beginning or end of the value.

For more information, see: String.trim().

urlEncode()

Encodes text to allow them to be included as a URL param, for example, a link in an email.

xmlEncode()

Encodes text to allow them to be included in XML data, for example, an outgoing webhook.

Encoding

When integrating with other systems or sending emails, you may need to encode the text to comply with standards or not break things. For example, if you are sending an HTML email, you may need to encode an issue's description as HTML. This escapes specific characters to comply with the HTML specifications.

Html encoding

HTML encoding is useful for emails and exporting HTML pages. For example, Waiting for R&D would be encoded as Waiting for R&D.

For security reasons, you should only use the function version, rather than the inline version. When sending a webhook response (that has a property called htmlEncode) in an email, encoding the response with {{webhookData.htmlEncode}} will return the value of the htmlEncode property instead of encoding the content of webhookData.

Json encoding

Useful when sending outgoing webhooks as JSON. For example, "Hello World" would be encoded as \"Hello World\".

URL encoding

Useful when sending creating links in emails. For example, Hello & World would be encoded as Hello+%26+World (the spaces become +, and the ampersand becomes %26).

Xml encoding

Useful when sending Outgoing webhooks as XML. For example, Hello & World would be encoded as Hello & World.