Using variable requests

Variable requests test for the existence of data held by a variable, and if none, request the user to enter data required in a document. This is similar to the workflow Set Variables step with the conditional option, coded in documents as an '&SET'.

It is also possible in documents to request, then use, variables that are not held in the database, but merely exist for the duration of merging a specific document. This command is known as an '&ASK'.

Variable request syntax

Variable requests must appear in the following format:

[&name,dialog description,variable name]

The variable request syntax has these parts:

Part

Description

&name

Required. One of the following requests:

&ASK

Used to request an item (word, or phrase - text only) at the time of the document merge.

Example:

[&ASK,Type date of last letter,ask_date]

&SET

Workflow equivalent of Set Variables step, with the conditional option. Used to enter data at the time of the merge, when none was previously held by the database variable. The display will match the database variable appearance. Any data entered here, could be included in the document and will be added to the database. If data existed before the document is merged it will not be displayed.

Example:

[&SET,Buying with a mortgage?,p2con_mortgage]

&USET

Workflow equivalent of Set Variables step, with the unconditional option. Used to display the database variable and allow editing of the data prior to being included in the document. The display will match the database variable appearance. Any amendment will be used to update the data held in the database and could be used in the document.

Example:

[&USET,Is vehicle driveable?,pi_driveable]

Dialog Description

Required. The text to be used to label the dialog box (spaces are allowed).

Variable Name

Required. Variable name is prefixed by 'ask_' (temporary variable).

Notes