Defines a single-valued variable for a step.

A Call single-valued variable is used to send a single-valued input variable to a transaction/sequence targeted by a Call Transaction/Call Sequence step.
It can define a default value, specified in the Default value property, that is used as parameter value if no value is found for this variable.
At runtime, the variable value is calculated by Convertigo through the following steps:

• if the Source property is set, the variable value is the source result (see Source property documentation),
• if no source is set, the JavaScript value of the variable is chosen, if a variable of the same name exists in the JavaScript scope of current context,
• if no JavaScript variable is defined, the context value of the variable is chosen, if a variable of the same name is stored in current context,
• if none of the previous methods gives a value, the default value set in the Default value property is used,
• if no default value is specified, the variable is not sent to the target transaction/sequence.

Note: In Convertigo Studio, when a Call single-valued variable is created in a Call Transaction/Call Sequence step, it can be easily replaced by a Call multi-valued variable, using the right-click menu on the variable and choosing the option Change to > MultiValued variable.

Property Type Category Description
Comment String standard Describes the object comment to include in the documentation report.
This property generally contains an explanation about the object.
Default value Object standard Defines the variable’s default value(s).
This property allows defining a default value or default list of values to use when no variable value is provided to the parent transaction (or sequence).
A variable is always created with a default value set to null, which means that the variable is only declared and has no default value.
At run time, Convertigo looks for the variable among the query parameters, the JavaScript scope or the objects in the context to retrieve its value. If the variable is found, its value is used, if not found, the default value specified by this property is used.
In this last case, and if the default value of the variable is not set (Default value property set to null), an exception can be thrown by any object or JavaScript code trying to use the undefined variable.
It is up to the Convertigo developer to unset the variable’s null value, i.e. to set a default value to the variable. He should prefer using a Test Case to test specific values for the variable or pass a variable value directly when invoking the transaction (or sequence).
Note: To unset the null value of the property, click on the cross-shaped button in the field. Then, the default value is an empty string. You can use it as is or add a value.
Description String standard Describes the variable.
This property is used to describe the variable in the widget generated from its parent transaction (or sequence) in Convertigo Mashup Composer.
Visibility int standard Defines the variable’s visibility.
This property allows defining whether the variable’s value is masked or not in:

• log files: selecting this option will mask the variable’s value that may be printed in all loggers,
• studio user interface: selecting this option will mask the variable’s value in the Properties view from the Studio, as well as in the tree of the Projects view,
• platform user interface: selecting this option will mask the variable’s value in the test platform of the project and when editing the project in Convertigo web administration,
• project's XML files: selecting this option will mask the variable’s value in the project’s XML files generated on the file system when saving the objects from the project.

Any combination of these options can be chosen, it allows to customize precisely the variable’s value display. A last option is available: Mask value in all. Selecting this option will mask the variable’s value in all previously described cases.
isRequired Boolean standard Defines whether the variable is required.
Source XMLVector expert Defines the source to use as variable value.
This property allows defining the variable value as a source from a previous step.
A source is defined as a reference on a step previously existing in the parent sequence, associated with an XPath applied on the step’s result DOM. At runtime, the XPath is applied on the step’s current execution result XML and the variable takes for value the XML node value resulting from this execution (the variable value will be its text content).
If the XPath doesn’t match or if the source is left blank, the variable value is calculated as explained in the main description of this object.