Defines a single-valued variable for a transaction/sequence.

A Request single-valued variable declares a variable which accepts a unique value to a transaction/sequence.
This variable is dedicated to the following transaction/sequence objects, except for HTTP-based transactions which use more specific variables:

• Generic Sequence,
• Javelin transaction,
• SQL transaction,
• Site Clipper transaction.

This variable object can define a default value, specified in the Default value property, that is used if no value is found for this variable.
At runtime, the variable value is calculated by Convertigo through the following steps:

• the value is received in the request to the transaction/sequence,
• if no value is received for this variable, 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 value 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 is used,
• if no default value is specified, the variable is not defined and an Exception can be thrown when trying to access its value in the core of the transaction/sequence.

Note: In Convertigo Studio, when a Request single-valued variable is created in a transaction/sequence, it can be easily replaced by a Request 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.
Cache key boolean expert Defines whether the variable should be part of the cache key.
If set to true, the variable and its value are added to the cache key which is used to determine whether the transaction’s response (or sequence’s response) should be pulled from the cache or not.
A transaction’s cached response (or sequence’s cached response) is pulled from the cache when all cache key values are corresponding to a stored cache entry (may contain other data that variables, for example the certificate group defined by some transactions).
Customizable boolean expert Defines whether the variable is customizable.
If set to true, the variable is used as a customizable preference field in the widget generated from the parent transaction (or sequence) in Convertigo Mashup Composer or any other portal.
Note: This property is used when applicable, i.e. when the widget is declared in a portal including customizable preference fields feature.
Is a file upload boolean expert Defines whether the variable is an uploaded file.
When set to true, this property indicates that the transaction/sequence should receive an uploaded file in this variable.
When received, the uploaded file is stored in a temporary folder and deleted at the end of the transaction/sequence. In the transaction/sequence execution context, the variable contains the path of the temporary file.
Note: This property value is used only by the Test Platform to allow the developer testing the transaction/sequence. When receiving a multi-part request, Convertigo can set any variable as an uploaded file.
Schema type QName XmlQName expert Assigned schema type qualified name
WSDL exposed boolean expert Defines whether the variable is exposed in web service.
If set to true, variable definition is inserted in the project’s WSDL as a method parameter.
Note: The Accessibility property of the parent transaction (or sequence) defines how the method itself is exposed in the web service.