Manage variables for business rules

The Variables tab of the Business Rules page displays all defined variablesClosed An identifier with a value that can be changed during normal execution of the software. (Contrast with "constant.") . From this tab, you can create, edit, and delete variables to use in business rules.

To open this tab, navigate to Administration > Program Management > Business Rules, and click the Variables tab.

The table in the Variables tab has the followings . All columns are read-only:
Column Name Description
Name Variable name.
Short Name Short name for a variable.
Type A variable type listed below, in Variable types.
Resource Type

A resource type. The following resource types are supported by default:

  • session: Variables that expire after a single browser session. They are cleared when a customer leaves the website, and they are stored within site cookies.

  • tmpVars: JavaScript variables whose values are reset on each page.

  • state: Variables that persist between sessions. They are not be cleared, and they are stored within site cookies.

Note: You can create a custom resource type in XML, in the Source tab of the Business Rules page. This is described in Manage business rules in XML.
GUI-editable

Indicates whether this variable is editable in the user interface.

  • If this variable is editable, you can double-click the corresponding row to edit it in the Edit Variable page.

  • If this variable is not editable, you can edit it only in the Source tab, as described in Manage business rules in XML.
Default Value Default value for the variable, if one is defined.

Add a variable

  1. Click New and then select the variable type, which are listed below, in Variable types.

  2. In the Create Variable page, complete the fields, which depend on the variable type you selected. These are listed below, in Variable types.

  3. Click Save.

Edit a variable

  1. Double-click a row in the table.

  2. In the Edit Variable page, update the fields, which depend on the variable type you selected. These are listed below, in Variable types.

  3. Click Save.

Delete a variable

  1. Click a row in the table to highlight a variable.

  2. Click Delete.
    A warning message confirms that you want to delete the variable.
  3. Click Confirm.

Variable types

Setting Description
Type Boolean. Read-only. Specified when creating the variable.
Resource Type

A resource type. The following resource types are supported by default:

  • session: Variables that expire after a single browser session. They are cleared when a customer leaves the website, and they are stored within site cookies.

  • tmpVars: JavaScript variables whose values are reset on each page.

  • state: Variables that persist between sessions. They are not be cleared, and they are stored within site cookies.

Note: You can create a custom resource type in XML, in the Source tab of the Business Rules page. This is described in Manage business rules in XML.
Name Variable name.
Short Name Short name for the variable.
Default Value

Default value for the variable. Select one of the following from the drop-down list:

  • None: no default value.

  • True

  • False
Setting Description
Type Date. Read-only. Specified when creating the variable.
Resource Type

A resource type. The following resource types are supported by default:

  • session: Variables that expire after a single browser session. They are cleared when a customer leaves the website, and they are stored within site cookies.

  • tmpVars: JavaScript variables whose values are reset on each page.

  • state: Variables that persist between sessions. They are not be cleared, and they are stored within site cookies.

Note: You can create a custom resource type in XML, in the Source tab of the Business Rules page. This is described in Manage business rules in XML.
Name Variable name.
Short Name Short name for the variable.
Default Value

Default value for the variable. Select one of the following radio buttons:

  • None: No default value.

  • Now: The variable is set to the date when it is first initialized.

  • Select Date: Select a date for the value of this variable .

Setting Description
Type Date List. Read-only. Specified when creating the variable.
Resource Type

A resource type. The following resource types are supported by default:

  • session: Variables that expire after a single browser session. They are cleared when a customer leaves the website, and they are stored within site cookies.

  • tmpVars: JavaScript variables whose values are reset on each page.

  • state: Variables that persist between sessions. They are not be cleared, and they are stored within site cookies.

Note: You can create a custom resource type in XML, in the Source tab of the Business Rules page. This is described in Manage business rules in XML.
Name Variable name.
Short Name Short name for the variable.
Default Value

Default values for the variable.

  1. Click Add Default Item.

    The Date setting is displayed.

  2. Select one of the following radio buttons:

  • Now: The variable is set to the date when it is first initialized.

  • Select Date: Select a date for the value of this variable .

  1. To create another default value, tepeat the previous steps.
Setting Description
Type Map. Read-only. Specified when creating the variable.
Resource Type

A resource type. The following resource types are supported by default:

  • session: Variables that expire after a single browser session. They are cleared when a customer leaves the website, and they are stored within site cookies.

  • tmpVars: JavaScript variables whose values are reset on each page.

  • state: Variables that persist between sessions. They are not be cleared, and they are stored within site cookies.

Note: You can create a custom resource type in XML, in the Source tab of the Business Rules page. This is described in Manage business rules in XML.
Name Variable name.
Short Name Short name for the variable.
Setting Description
Type Number. Read-only. Specified when creating the variable.
Resource Type

A resource type. The following resource types are supported by default:

  • session: Variables that expire after a single browser session. They are cleared when a customer leaves the website, and they are stored within site cookies.

  • tmpVars: JavaScript variables whose values are reset on each page.

  • state: Variables that persist between sessions. They are not be cleared, and they are stored within site cookies.

Note: You can create a custom resource type in XML, in the Source tab of the Business Rules page. This is described in Manage business rules in XML.
Name Variable name.
Short Name Short name for the variable.
Random Select this check box to set a random number as the value for this variable. You can set minimum and maximum values for this number in the following fields.
Min. Value Minimum value for a random number. Available only with the Random check box, describe above, is selected.
Random Maximum value for a random number. Available only with the Random check box, describe above, is selected.
Default Value Default value for the variable. Available only with the Random check box, describe above, is cleared.
Setting Description
Type Number List. Read-only. Specified when creating the variable.
Resource Type

A resource type. The following resource types are supported by default:

  • session: Variables that expire after a single browser session. They are cleared when a customer leaves the website, and they are stored within site cookies.

  • tmpVars: JavaScript variables whose values are reset on each page.

  • state: Variables that persist between sessions. They are not be cleared, and they are stored within site cookies.

Note: You can create a custom resource type in XML, in the Source tab of the Business Rules page. This is described in Manage business rules in XML.
Name Variable name.
Short Name Short name for the variable.
Max Size Maximum number of bytes. This cannot exceed 4096 bytes.
Default Value

Default values for the variable.

  1. Click Add Default Item.

    The Number field is displayed.

  2. Enter a number in the Number field.

  3. To create another default value, tepeat the previous steps.

This is a data structure containing at least one key-value pair.

Setting Description
Type Object. Read-only. Specified when creating the variable.
Resource Type

A resource type. The following resource types are supported by default:

  • session: Variables that expire after a single browser session. They are cleared when a customer leaves the website, and they are stored within site cookies.

  • tmpVars: JavaScript variables whose values are reset on each page.

  • state: Variables that persist between sessions. They are not be cleared, and they are stored within site cookies.

Note: You can create a custom resource type in XML, in the Source tab of the Business Rules page. This is described in Manage business rules in XML.
Name Variable name.
Short Name Short name for the variable.
Setting Description
Type String. Read-only. Specified when creating the variable.
Resource Type

A resource type. The following resource types are supported by default:

  • session: Variables that expire after a single browser session. They are cleared when a customer leaves the website, and they are stored within site cookies.

  • tmpVars: JavaScript variables whose values are reset on each page.

  • state: Variables that persist between sessions. They are not be cleared, and they are stored within site cookies.

Note: You can create a custom resource type in XML, in the Source tab of the Business Rules page. This is described in Manage business rules in XML.
Name Variable name.
Max Size Maximum number of bytes. This cannot exceed 4096 bytes.
Short Name Short name for the variable.
Default Value Default value for the variable.
Setting Description
Type String List. Read-only. Specified when creating the variable.
Resource Type

A resource type. The following resource types are supported by default:

  • session: Variables that expire after a single browser session. They are cleared when a customer leaves the website, and they are stored within site cookies.

  • tmpVars: JavaScript variables whose values are reset on each page.

  • state: Variables that persist between sessions. They are not be cleared, and they are stored within site cookies.

Note: You can create a custom resource type in XML, in the Source tab of the Business Rules page. This is described in Manage business rules in XML.
Name Variable name.
Short Name Short name for the variable.
Max Size Maximum number of bytes. This cannot exceed 4096 bytes.
Default Value

Default values for the variable.

  1. Click Add Default Item.

    The String field is displayed.

  2. Enter a number in the String field.

  3. To create another default value, tepeat the previous steps.