The Formatter is a way to filter and format your variables that produce strings, numbers, arrays, and dates.
This is a great feature to use when you want to simplify complex data like dates produced in ISO 8601 date and time formatting (2008-01-10T11:00:00) and have the values converted to a more readable format like MM/DD/YY (10/01/08).
Accessing the Formatter
To access the Formatter, click the vertical 3-dot icon at the right of any variable to open the Step Options, then click Format.
You will then be able to format your variable's output using the formatting options that populate within the sidebar menu.
Formatting Options
Within the Formatter sidebar menu, you'll be able to adjust the value your variable produces based on its type.
Date
Add time: Adds a specified amount of time to a date.
Format: Converts a date into a different format.
Start of day: Converts a date to the start of the day (00:00:00).
End of day: Converts a date to the end of the day (23:59:59).
Subtract time: Subtracts a specified amount of time from a date.
Time between: Calculates the time difference between two dates.
Time since: Calculates the time difference from a date to now.
String
Append: Adds text to the end of a string.
Capitalize: Capitalizes the first word in a string and downcases the remaining characters.
Downcase: Converts all letters to lowercase.
Prepend: Adds text to the beginning of a string.
Remove last: Removes the last instance of a substring inside a string.
Replace: Replaces all occurrences of specific text within a string.
Replace last: Replaces only the last occurrence of specific text within a string.
Split: Breaks a string into an array based on a separator.
Strip: Removes spaces from the beginning and end of a string.
Strip HTML: Removes all HTML tags from a string.
Upcase: Converts all letters to uppercase.
Math
At least: Ensures a number is no smaller than a set minimum.
At most: Ensures a number is no larger than a set maximum.
Divided by: Divides a number and keeps the same type (integer or decimal).
Minus: Subtracts one number from another.
Plus: Adds two numbers.
Round: Rounds a number to the nearest whole number.
Times: Multiplies a number by another number.
Array
Compact: Removes empty values from an array.
Concat: Combines two arrays into one.
First: Retrieves the first item in an array.
Join: Combines all of the items in an array into a single string, separated by a space.
Last: Retrieves the last item in an array.
Map: Extracts values from a specific property in an array of objects.
Size: Returns the length of a string or the number of items in an array.
Sort by an array item property: Sorts the items in an array in case-insensitive alphabetical order.
Sum: Adds up all numbers in an array.
To apply your formatting, fill out one of the options based on the type you're working with and click apply.
You can add multiple combinations of formatted options to create the precise variable value that you need. They will be listed in the order that you apply them within the top of the Formatter sidebar.
