You create process variables in the Variables view. When you create variables, consider the following practices:
Use a common naming style.
Use descriptive names, especially if the variables will be visible in the user interface. If you know that a variable will be displayed to a user, such as in Workspace ES, provide a Title string. This string ensures that the purpose of the variable will be clear to users even if the variable name itself is not.
You can create as many variables as a process requires. However, using a large number of variables, especially those of complex data types, could affect database performance. Keep the number of complex data types to the minimum required, and use simple data types where possible. Furthermore, reuse variables wherever possible.
To create a process variable:
In the Variables view, click Create New Variable
.
In the Name box, type a name for the variable, following these naming rules:
Must be a valid XML element name that contains only valid XML tagname characters.
Must not start with a digit.
Must be less than 100 characters long.
Must be unique and therefore cannot be id, create_time, update_time, creator_id, or status, which are reserved variables always in the process data model.
In the Title box, type a label for the variable to be displayed in user interface windows or dialog boxes. Otherwise, the variable name is used in these locations.
In the Description box, type a description of what the variable is used for so that future developers can readily understand the purpose and usage of the variable.
In the Type list, select the data type of the variable. The data type you choose depends on the values that the variable will hold and the requirements of the process. (See Variable types reference.)
If the data type is not in the Type list, select Find Type, type a search string in the Search box, click Search, select a data type from the displayed list, and then click OK.
The search string is a series of characters. Any data type that contains that series of characters is found. The search does not use wildcard characters, such as an asterisk (*).
If the Type is a map or a list, in the Sub-type list, select a data sub-type. For other data types, this list is not used.
If the variable will store input data that is mandatory to initiate the process, select Required.
If the variable will store input data that is provided when the process is initiated, select Input. For example, if the data originates from an event that starts a process, it must be defined as Input data.
If the variable will store data that is returned to the process initiator when the process is complete, select Output.
To display the variable in searches in Workspace ES, select Searchable.
To display the variable in the Workspace ES user interface, select Visible In UI.
If the variable requires specific settings, type the required information in the Datatype Specific Settings area. This step only applies to some kinds of variable types. (See Variable types reference.)
To create a process variable:
.