Available variables are common configuration items for component configuration. Common variables are created in the Available Variables section by default for calling during process orchestration. This topic describes default available variables and how to add, insert, and delete available variables.
Before you begin
Before you can use available variables, you need to go to the process that you want to edit and find the target component that you want to use available variables for.
YesChat App Message Service Console > Process Editor > Process Management. Click the name of the flow that you want to edit. The orchestration page of the flow appears.
On the canvas, click the icon of the widget whose variables you want to use. In the widget configuration section on the right, you can view the Available Variables section.
NoteThe trigger type is a preset system variable in processes such as WhatsApp, Instagram, Viber, and Messenger. If you want to manually trigger a flow, click Start and add variables to the Basic Configurations section to receive the parameters that you pass after the flow is triggered.
Default Variables
Parameter | Description | Sample value |
incomingMessage | The first upstream message of the user. | Hello |
wabald | WhatsApp Business Account (WABA) ID. | 10***********23 |
wabaPhoneNumber | Phone numbers bound to WABAs. | 861301111**** |
customerPhoneNumber | The phone numbers of end users. | 861310000**** |
customerName | The names of end users. | John |
Create a variable
You can add available variables by referring to the following operations. You can add variables in three ways. Before you add variables, complete the preceding steps.
Add a variable to the Set Variable widget
Drag the Set Variable component from the Component Library on the left side of the canvas.
Click the Set Variable component on the canvas. In the right-side Variable Configuration pane, add a variable.
To add multiple variables, click Add Variable. After you add the variables, click Save.
In the dialog box that appears, click Save.
Add a variable to insert a variable
On the canvas of the flow, add a variable in the Message Settings section on the right of the Send Viber Message or Send Instagram Message component, and click Insert Variable.
In the dialog box that appears, enter a variable name and click Create Variable to add a variable. After you exit the dialog box, click Save.
In the dialog box that appears, click Save.
Add variables to the canvas start bar (only for Trigger Type: Manual)
Click Start on the canvas. In the Basic Settings section on the right, turn off Do not accept variables. In the Variable Name field, enter the name of the variable that you want to add.
To add multiple variables, click Add Variable. Click Save.
In the dialog box that appears, click Save.
Insert a variable
You can perform the following steps to insert an available variable. Before you insert a variable, perform the steps described in the Before you begin section of this topic.
In the Component Configuration section, find the location where you want to insert a variable and click Insert Variable.
In the Select Variable dialog box, find the desired variable and click Insert in the Operation column to insert the variable.
View the inserted variable.
Delete a variable
You can perform the following operations to delete available variables. You can perform the following operations to delete available variables: Before you begin
If you delete a variable, you can only delete the corresponding variable from the source component. You cannot delete the default system variable. If you delete a variable, the variable cannot be referenced. Exercise caution when you perform this operation.
Delete a variable from the Set Variable widget
Click the Set Variable component on the canvas. In the right-side configuration pane, click Delete for the variable that you want to delete.
NoteIf a variable is added by inserting a variable in the Set Variable component, click Insert Variable on the right when deleting the variable. In the dialog box that appears, click Delete.
Click Save. In the dialog box that appears, click Save.
Other components delete variables
Click the target widget on the canvas. In the right-side configuration pane, click Insert Variable.
In the dialog box that appears, select the variables that you want to delete and click Delete.
Click Save. In the dialog box that appears, click Save.
Delete a variable from the canvas start (only when the trigger type is manual)
Click Start on the canvas. In the right-side configuration pane, click the Delete icon.
Click Save. In the dialog box that appears, click Save.