Define a custom script action

To add a custom script action, follow these steps:

1. Click Actions on the tab bar. The Actions panel appears.

2. To add an action, click Add Action .

3. Type a name for the new action.

4. To add a parameter, click + Add parameter. Specify the name and the type of the parameter. The type can be string, number, or Boolean.
   You can use parameters avoid creating several, nearly identical custom actions where only a specific variable is different. For each occurrence of the same custom action in a script, you can define a different value for the same parameter.
   Note: You can define up to 25 parameters for each custom action.

5. Click + Add Step.

   Note: An action can execute one or more steps in sequence. Each step is a built-in action or a custom action. Actions can evaluate variables to determine whether steps run.

6. Perform one of these steps:

   Expand allCollapse all

   Select an action to execute as a stepClick to expand

   Select the action name. The selected action appears in the editor.

   Create an If/Else expression to execute different branches of steps, based on the value of a variable or dynamic expressionClick to expand

   An if/else construct allows an action to execute different steps based on the runtime value of a variable or dynamic expression. To execute different steps based on the runtime value of a variable:

   1. Click If/Else. An expression editor appears.

   2. Under Left Hand Side, select the variable whose runtime value compares with something else.

   3. Next, select the Operator to use for the comparison.

   4. Click the options menu for Right-Hand Side.

      To select what to compare the Left Hand side variable to, choose Interpolated Text, Text Expression, or Variable.

      • Interpolated Text: Evaluates a string that contains the runtime value of one or more placeholders.
      • Text Expression: Compares with the result of a logical expression. See Dynamic variables.
      • Variable: Compares with the runtime value of a variable.

   5. Based on your selection, type text in the input box or choose a variable.

   6. Click Add Step, and then choose a built-in or custom action to run when the expression evaluates True. Add any other steps to execute when the expression is True.

   7. To define steps to take when the expression is False, click Add Step under Else. This process defines an alternate series of steps that the action can take, based on the value of the Left Hand Side variable. 

      Note: The bottom-most Add Step button performs a special function. It defines additions steps for the action to take after actions in the conditional expression run. In programming terms, this behavior is equivalent to lines of code that follow an if…then…else expression. These steps always execute when the action runs, regardless of the variable’s value. 

   To execute different steps based on the runtime value of a dynamic expression:

   1. Click If/Else. An expression editor appears.
   2. Switch the Dynamic Expression toggle on.
   3. Under Left Hand Side, enter a dynamic expression in the Insert Variable box.
   4. Click Add Step, and then choose a built-in or custom action to run when the dynamic expression evaluates True. Add any other steps to execute when the expression is True.
   5. To define steps to take when the expression is False, click Add Step under Else. This process defines an alternate series of steps that the action can take, based on the value of the Left Hand Side variable. 

   Delay the progression of a custom actionClick to expand

   A delay allows you to suspend the execution of an action for a specified amount of time.

   1. Select Delay.

   2. Enter the amount of time to delay in milliseconds. From the options menu , choose whether that amount is as an integer, math expression, or variable.

   3. Click Add Step.

   Create a Try/On Error expressionClick to expand

   A Try/On Error expression allows you to determine what happens if an error occurs when you attempt to do something.

   1. Click Try/On Error. An expression editor appears.
   2. Under Try, click Add Step, and then choose a built-in or custom action to execute. Add any other steps to execute when the expression is True.
   3. Under On Error, click Add Step, and then choose a built-in or custom action to execute when the Try action results in an error.
   4. Click Add Step.

   Note: You cannot currently expose a variable that returns the actual error from the Try action.

   Add an Info BannerClick to expand

   An Add an Info Banner action allows you to display text to the agent for the amount of time the action takes to execute.

   1. Click Info Banner. A text editor appears.
   2. Type or paste the text that you want to appear in the banner.
   3. Click Add Step.
      
      Note: To display the banner for a specific amount of time, be sure to add a Delay step.

   Create a Wait Until action to monitor a variable or expression until it is TrueClick to expand

   A Wait Until action freezes execution of the data action until the runtime value of a variable or a dynamic expression is True.

   1. Select Wait Until.
   2. Switch the Dynamic Expression toggle on.
   3. Under Left Hand Side, enter a dynamic expression in the Insert Variable box.
   4. Click Add Step, and then choose a built-in or custom action to run when the dynamic expression evaluates True. Add any other steps to execute when the expression is True.

   Add a commentClick to expand

   You can add a comment to an action to help other administrators understand the purpose of that action.

   Create groupClick to expand

   You can group steps together to organize them and to help you and other administrators identify which parts of the custom action function as a logical unit.

6. Add other steps as needed.
7. If you create multiple steps, you can use the up and down arrows to reorder them. Steps execute in top-down order.

8. To finish, click Save.