String transform functions

Use string transform functions to reformat or perform calculations on String data pills.

String transform functions require a String input data pill. Make sure to use the correct input data pill type when applying string transform functions. If a string transform function is applied to an improper data type, the data is not transformed at runtime and the input value is returned instead. For more information on confirming your flow runtime values, see Test a flow.

Convert String to Number

Converts a string into a number.

Input data pill	Output data pill
String	Number - Number converted from a string.

Figure 1. Example

• Input: “500”
• Output: 500

Contains

Returns true when the input string contains a given sequence of characters.

Input data pill	Parameters	Output data pill
String	Characters to search for.	Boolean indicating whether a sequence of characters exists in the input string

Figure 2. Example

• Input: Cheese Pizza
• Parameter: Cheese
• Output: true

Does not Contain

Returns true when the input string does not contain a given sequence of characters.

Input data pill	Parameters	Output data pill
String	Characters to search for.	Boolean indicating whether a sequence of characters does not exist in the input string

Figure 3. Example

• Input: Cheese Pizza
• Parameter: Joey
• Output: true

Ends With

Returns true when the input string ends with a given sequence of characters.

Input data pill	Parameters	Output data pill
String	Characters to search for.	Boolean indicating whether the input string ends with the given sequence of characters

Figure 4. Example

• Input: Cheese Pizza
• Parameter: Pizza
• Output: true

First Character

Returns the first character of the input String.

Input data pill	Output data pill
String	String - Transformed String as the first character of the input String

Figure 5. Example

• Input: Madrid
• Output: M

In this example, the flow triggers when a User [sys_user] record is created. The flow then updates the City field for the User [sys_user] record with a code that is represented as the first character of the city's name.

Last Character

Returns the last character of the input String.

Input data pill	Output data pill
String	String - Transformed String as the last character of the input String

Figure 6. Example

• Input: Madrid
• Output: d

Replace String

Returns a replaced string from the input string based on the provided regular expression (regex) and replacement string. Use the JavaScript regular expression format.

Input data pill	Parameters	Output data pill
String	Regex - Regular expression to be matched for replacement Replace String - Replacement string	Resulting string after replacement with given parameters

Figure 7. Example

• Input: "Example input string."
• Parameters:
  • Regex: \"
  • Replacement string: \\\"
• Output: \"Example input string.\"

Size

Returns the total number of characters in the input String.

Input data pill	Output data pill
String	Integer

Figure 8. Example

• Input: Example input string.
• Output: 21

Split

Returns an Array.String based on a provided Separator that splits the input String. If the Separator field is left blank, the transformation is ignored and the system returns the input String. If entering any data type other than a String as the Separator, the system converts the provided value to a String.

Input data pill	Parameters	Output data pill
String	Separator - Enter a delimiter that specifies where the input String should be split. If left blank, the input String is not transformed at runtime.	Array.String - An array of substrings from the input String

Figure 9. Example

• Input: Example, input, string.
• Separator: ,
• Output: ["Example", "input", "string."]

Starts With

Returns true when the input string starts with a given sequence of characters.

Input data pill	Parameters	Output data pill
String	Characters to search for.	Boolean indicating whether the input string starts with the given sequence of characters

Figure 10. Example

• Input: Cheese Pizza
• Parameter: Chees
• Output: true

Substring

Returns a substring from the input String that is based on the provided Start Index and End Index. Input String index starts at 0.

Input data pill	Parameters	Output data pill
String	Start Index - Index of the first character to include in the returned substring End Index - Index of the last character to include in the returned substring	String - Transformed String as a substring of the input String

Note:

If the Start Index value is longer than the string's length, then the transform function returns the input string. This behavior is different from the JavaScript substring() method, which instead returns an empty string.

Figure 11. Example 1

• Input: Example input string
• Start Index: 3
• End Index: 6
• Output: mple

Figure 12. Example 2

• Input: Example input string
• Start Index: 30
• End Index: 40
• Output: Example input string

To Lower Case

Converts the input String to all lowercase characters.

Input data pill	Output data pill
String	String in all lowercase characters

Figure 13. Example

• Input: ExamPle inpuT stRing
• Output: example input string

To Proper Case

Changes the case of words in the input string. Capitalizes the first letter of each word and makes the remaining letters in the word lower case. A word is considered any string separated by a space, hyphen, backslash, or forward slash character. The transform function always evaluates words from left-to-right to determine the first letter.

Input data pill	Output data pill
String	String in proper case

Figure 14. Example

• Input: exAMPle-input string/TEXT
• Output: Example-Input String/Text

To Upper Case

Converts the input String to all uppercase characters.

Input data pill	Output data pill
String	String in all uppercase characters

Figure 15. Example

• Input: ExamPle inpuT stRing
• Output: EXAMPLE INPUT STRING

Trim

Removes white space from the beginning and end of the input String. Does not remove white space within the input String.

Input data pill	Output data pill
String	String - Transformed String with trimmed white space

Figure 16. Example

• Input: SQL Server APAC 1
• Output: SQL Server APAC 1

In this example, the action makes a REST call to a third-party system and GETs a response body containing data about a server. Then, the Trim transform function removes any unwanted white space before adding the server's name to a new record in the Server [cmdb_ci_server] table.