You create new System Variables using the New System Variable dialog. Any variables added here will be immediately available to all Interactions.

To create a new System Variable:

Note: System Variables cannot be added while working in locked TEST or PROD environments of a Multi Environment Account.

  1. At the upper right corner of the System Variables page, click Add. The New System Variable dialog opens.
  2. In the Variable Name textbox, enter a unique name for the variable. The name is a required field. The new name cannot be identical to that of any other existing System or User Variable.
  3. From the Variable Type dropdown list, select its type. The default variable type is Text. Along with primitive types, you can also select a Collection or (at the bottom of the dropdown list) choose a Custom Type that has been created.
  4. If desired, enter a Default Value for the new variable. The default input field contents will vary, depending on the variable type chosen:
    • Text, Number, Currency: A textbox is presented.
    • Boolean: A checkbox is presented.
    • Date: A textbox with a date picker is presented. Use the date picker to navigate to and select a date, or simply enter the date in the textbox.
  5. In the Description field, optionally enter notes or comments related to the variable.
  6. If it appears as an option, you can select the Do not audit the variable’s value checkbox to prevent this variable from being saved in the Interact database. This field helps to ensure the privacy of the variable's data.
  7. If it appears as an option, you can select the desired status of the new variable from the Read Only dropdown list:
    • Yes: The variable will be Read Only. (The user is not able to update the default value.)
    • No: The variable will not be Read Only. (The user is able to update the default value.) This is the default status.

  8. When adding a date variable, specify the required date format by selecting it from the Format dropdown menu that appears below.

    The Custom option allows you to define a customized date format:

  9. When the variable is Read Only, in the Client Header textbox, enter a name to be passed at the start of the Interaction to populate the variable.
  10. When using a Multi-Environment Accounts, an additional parameter called Environment Variable is displayed. For more information about this variable, refer to Using Environment Variables.
  11. Click Save. A confirmation message is displayed, and the new variable is displayed in the System Variables list.

Note: When you add or make changes to a System Variable, we recommend that you Refresh currently active Interactions to update them with the new information and redraw them in the Web Designer. Use the Refresh button in the main toolbar of the Web Designer. For more information, click here.

Adding a Custom Type as a System Variable

When choosing the Variable Type for a new System Variable, you can select a variable that has been defined on the Custom Types page of the Admin Console for use as a System Variable:


When adding this type, only the name of the selected Custom Type appears in the dropdown menu. For detailed information, refer to Working with Custom Types.

Adding a Collection as a System Variable

You can create a Collection of values that will be available as a set to all Interactions.

To create a global Collection:

  1. At the upper right corner of the System Variables page, click Add. The New System Variable dialog opens.
  2. In the Variable Name textbox, enter a unique name for the variable. The name is a required field. The new name cannot be identical to that of any other existing System or User Variable.
  3. From the Variable Type dropdown list, select Collection:

  4. From the Of dropdown list, select the variable type that will be used for the Collection:



    For more details on Collections, click here.
  5. Complete other System Variable fields as usual (described above).
  6. Click Save. A confirmation message is displayed, and the new Collection is displayed in the System Variables list.

Handling Conflicts Caused by Duplicate Variable Names

Duplicating the names of System and User variables is not allowed in the Interaction Designer.

Should a System Variable be created in the Admin Console that has the same name as an existing User Variable in an Interaction, the Conflicts Center panel will be displayed when an Interaction with the duplicate User Variable is opened in the Web Designer.

The Conflicts Center will assist you in locating the conflicting User Variable and prompt you to assign it a unique new name. Conflicting instances of the User Variable in the Interaction will then be renamed with the new name.

Revision:

Comments