FORMAT

This help page is for Studio. This information is also available for Desktop Studio.

A rectangle with a horizontal line in it with a pencil.

Applies special formatting logic to a string or number.

Supported Script Types


Generic	Email	Chat	Phone	Voicemail	Work Item	SMS

These properties define data that the action uses when executing.

Property	Details
Add Caption	Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon.
String	This property contains text or numbers to format. If Format is using the number formatting guidelines, this property may be numeric, otherwise, the use of variable substitution can be used.
Format	Enter the format you want the returned string to be. Use the formatting guidelines for the type of information being formatted: String Format Character Format Number Format
Variable	The name of the variable that you want to hold the newly-formatted string.

Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.

Condition	Description
Default	Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.

There are three distinct formatting methods that can be used depending on the data that needs to be formatted: