********************************************************************** * Define Group "DIALOG" (Dialog/Dialog Alternate Element): * ********************************************************************** * The "DIALOG" group defines a convenient method to specify either * * a dialog element or a dialog alternate element. * ********************************************************************** ********************************************************************** * Define Element dialog (Dialog Element) containing:- * ********************************************************************** * The dialog element provides a method to display a question to the * * user for the purpose of updating variable values in the State * * Information. * ********************************************************************** * applic - Optional Single Applicability * *====================================================================* * Mandatory Repeatable Group * *====================================================================* * fillin \ Fill in the blank * * or >Mandatory Single * * menu / Menu of choices * *====================================================================* *@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@* * Attribute(s):- * * id - ID - IMPLIED - Node ID * * Attribute Definition List stored in attribute group "secur". * ********************************************************************** ********************************************************************** * Define Element dialog-alt (Dialog Alternatives) containing:- * ********************************************************************** * The dialog-alt element is a pointer to multiple Dialog Elements * * where only one is valid determined by required applicability on * * the contained Dialog Elements. * * This element employs the 'Node Alternate' class. * ********************************************************************** * dialog - mandatory repeatable Dialog Elements * *@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@* * Attribute(s):- * * id - ID - IMPLIED - Node ID * * name - CDATA - IMPLIED - Name of the node * * Attribute Definition List stored in attribute group "secur". * ********************************************************************** ********************************************************************** * Define Element fillin (Fill-In-The-Blank Dialog) containing:- * ********************************************************************** * The fillin element provides a fill-in-the-blank question to the * * user. It contains a prompt, the variable to store the user's * * answer in, and optional default and range constraints. * ********************************************************************** * prompt - Mandatory Single Question to the user * * variable-ref - Mandatory Single Variable to store answer in * * text - Optional Single Default answer - prefill * * num-range - Optional Single Acceptable number range * *@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@* * Attribute(s):- * * id - ID - IMPLIED - Element ID * ********************************************************************** ********************************************************************** * Define Element num-range (Fillin Dialog Number Range) * * containing:- * ********************************************************************** * The num-range element defines the acceptable input for fillin * * dialogs requiring an integer or real number input. The user's * * response is to be validated to fall within the num-range. * ********************************************************************** * low-bound \ Low number and up * * or \ * * double-bound >Mandatory Single Between two numbers * * or / * * high-bound / Up to high number * ********************************************************************** ********************************************************************** * Define Element low-bound (Low Number Range) containing:- * ********************************************************************** * The low-bound element provides either an integer or a real * * number used to validate the user's input to a fill-in-the-blank * * type of dialog. * ********************************************************************** * integer \ Integer number * * >Mandatory Single * * real / Real number * ********************************************************************** ********************************************************************** * Define Element high-bound (High Number Range) containing:- * ********************************************************************** * The high-bound element provides either an integer or a real * * number used to validate the user's input to a fill-in-the-blank * * type of dialog. * ********************************************************************** * integer \ Integer number * * >Mandatory Single * * real / Real number * ********************************************************************** ********************************************************************** * Define Element double-bound (Low and High Number Range) * * containing:- * ********************************************************************** * The double-bound element defines the acceptable input for fillin * * dialogs requiring an integer or real number input. The user's * * response is to be validated to fall within the low and high bounds.* ********************************************************************** * low-bound - Mandatory Single Low number * * high-bound - Mandatory Single High number * ********************************************************************** ********************************************************************** * Define Element menu (Menu Choice Dialog) containing:- * ********************************************************************** * The menu element provides a question to the user with a list of * * choices. It contains a prompt and choices. Each choice contains * * the action to perform if that choice is selected. * ********************************************************************** * prompt - Mandatory Single Question to the user * * menuchoice - Mandatory Repeatable Choices for the user to choose* *@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@* * Attribute(s):- * * id - ID - IMPLIED - Element ID * * select - Declared - "single" - Selection type: * * - "single" - only one choice may be selected. * * - "multiple" - multiple choices may be selected. * ********************************************************************** ********************************************************************** * Define Element prompt (Dialog Prompt) containing:- * ********************************************************************** * The prompt element provides the question presented to the user * * for both fillin and menu type of dialogs. * ********************************************************************** * text - Mandatory Single Text of question to the user * *@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@* * Attribute(s):- * * id - ID - IMPLIED - Element ID * ********************************************************************** ********************************************************************** * Define Element menuchoice (Menu Dialog Choice) containing:- * ********************************************************************** * The menuchoice element provides one choice in a menu dialog. Each * * choice contains a precondition to specify applicability, the text * * of the choice, and the action to perform if the choice is selected * * as either changes to the State Information (assertion) or no * * further action to perform (noassertions). * ********************************************************************** * applic - Optional Single Applicability * * text - Mandatory Single Text of the choice * *====================================================================* * Mandatory Single Group * *====================================================================* * assertion - Mandatory Repeatable Changes to the State Info * * or * * noassertions - Mandatory Single No action to perform. * *====================================================================* *@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@* * Attribute(s):- * * id - ID - IMPLIED - Element ID * * default - NUMBER - "0" - Whether the choice should be * * pre-selected as the default. * * - "1" - Yes * * - "0" - No * ********************************************************************** ********************************************************************** * Define Element noassertions (No Assertions) containing:- * ********************************************************************** * The noassertions element provides for a Dialog Menu Choice that * * performs no action when selected. * ********************************************************************** * No Other Tags. * ********************************************************************** ********************************************************************** * Define Element preset (Preset a Variable Value) containing:- * ********************************************************************** * The preset element provides a method to set a variable value * * in the State Information prior to executing the rest of the * * content in an element. * ********************************************************************** * assertion - Mandatory Single Assertion to execute * *@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@* * Attribute(s):- * * id - ID - IMPLIED - Element ID * ********************************************************************** ********************************************************************** * Define Element postset (Postset a Variable Value) containing:- * ********************************************************************** * The postset element provides a method to set a variable value * * in the State Information after executing the rest of the content * * in an element. * ********************************************************************** * assertion - Mandatory Single Assertion to execute * *@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@* * Attribute(s):- * * id - ID - IMPLIED - Element ID * ********************************************************************** ********************************************************************** * Define Element assertion (Set a Variable Value) containing:- * ********************************************************************** * The assertion element provides the method to set a variable value * * in the State Information. The expression is evaluated and the * * result is assigned to the variable referenced in the State Info. * ********************************************************************** * variable-ref - Mandatory Single Reference to the variable to set* * expression - Mandatory Single Results to be stored in variable* *@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@* * Attribute(s):- * * id - ID - IMPLIED - Element ID * ********************************************************************** ********************************************************************** * Define Element expression (Expression Definition) containing:- * ********************************************************************** * The expression element defines an expression to be evaluated when * * setting a variable value (assertion) or context filtering (applic) * * Four forms of expressions are supported: * * Binary Operations: expression binary-operator expression * * Unary Operations: unary-operator expression * * Variable Value: variable-ref * * Explicit Value: value * * Complicated expressions are built using multiple levels of binary * * and unary expressions. * ********************************************************************** *====================================================================* * Mandatory Single Group * *====================================================================* * Binary Form: * * expression - Mandatory Single First operand of expression * * Definition stored in group "BINOP" * * - Mandatory Single Operator to apply to operands * * expression - Mandatory Single Second operand of expression * *====================================================================* * or * *====================================================================* * Mandatory Single Group * *====================================================================* * Unary Form: * * Definition stored in group "UNOP" * * - Mandatory Single Operator to apply to operand * * expression - Mandatory Single Operand of expression * *====================================================================* * or * * Variable Form: * * variable-ref - Mandatory Single Variable value to use in the * * expression evaluation * * or * * Value Form: * * Definition stored in group "VALUE" * * - Mandatory Single Explicit value to use in the * * expression evaluation * *@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@* * Attribute(s):- * * id - ID - IMPLIED - Element ID * * print-form - CDATA - IMPLIED - Human readable form * * suitable for printing * ********************************************************************** ********************************************************************** * Define Element variable (Variable Declaration) containing:- * ********************************************************************** * The variable element declares a variable to be maintained in the * * state table. * ********************************************************************** * dialog - Optional Single - Dialog to present to the user to * * obtain a value for the variable * * initialize - Optional Single - Initial value for the variable * *@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@* * Attribute(s):- * * name - CDATA - REQUIRED - Name of the variable * * description - CDATA - IMPLIED - Human readable description * * config - NUMBER - "0" - Is this a config item? * * - "1" - Yes * * - "0" - No * * valuetype - Declared - "integer" - Data type the variable * * represents. * * - "boolean" - Boolean data type. * * - "string" - String data type. * * - "real" - Real data type. * * - "integer" - Integer data type. * * - "set-string" - String Set data type. * * - "set-real" - Real Set data type. * * - "set-integer" - Integer Set data type. * * precision - CDATA - IMPLIED - Precision of real type data.* * scope - Declared - "global" - Scope of the variable * * - "global" - This variable has global scope; * * local scope to be a future addition * ********************************************************************** ********************************************************************** * Define Element variable-declarations (Variable Declarations):- * ********************************************************************** * The variable-declarations element provides a grouping of * * variables that will be used in this Data Module * ********************************************************************** * variable - Mandatory Repeatable - Variables used in this DM * *@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@* * Attribute(s):- * * id - ID - IMPLIED - Element ID * ********************************************************************** ********************************************************************** * Define Element variable-ref (Variable Reference) containing:- * ********************************************************************** * The variable-ref element is used to reference the value of the * * variable with name from the State Information. * ********************************************************************** * No Other Tags. * *@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@* * Attribute(s):- * * name - CDATA - REQUIRED - Name of the variable to reference* ********************************************************************** ********************************************************************** * Define Element initialize (Initialize a Variable Value) * * containing:- * ********************************************************************** * The initialize element provides a method to set the initial * * variable value at the time of creation * ********************************************************************** * expression - Mandatory Single Value to assign to the variable * ********************************************************************** ********************************************************************** * Define Element extapp (External Application Interface) containing:-* ********************************************************************** * The extapp element defines an external application to interface * * with including parameters to send to the external application and * * expected return results. * ********************************************************************** * text - Mandatory Single - Description of the interface * * send - Optional Repeatable - Parameters to send * * receive - Optional Repeatable - Return results * * recbyname - Optional Repeatable - Return results by name * * recbypos - Optional Repeatable - Return results by position * *@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@* * Attribute(s):- * * application - ENTITY - REQUIRED - Name of the service being * * requested * * Attribute Definition List stored in attribute group "bodyatt". * ********************************************************************** ********************************************************************** * Define Element send (Send Parameter) containing:- * ********************************************************************** * The send element defines parameters to send to an external * * application. * ********************************************************************** * sendname - Optional Single - Name associated with the param * * variable-ref - Mandatory Single - Value of a Variable * * string - Mandatory Single - Static string value * *@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@* * Attribute(s):- * * Attribute Definition List stored in attribute group "bodyatt". * ********************************************************************** ********************************************************************** * Define Element sendname (Name associated with Send) containing:- * ********************************************************************** * The sendname element defines a name associated with a Send * * parameter in order to create a name / value pair. * ********************************************************************** ********************************************************************** * Define Element receive (Receive Parameter) containing:- * ********************************************************************** * The receive element defines the Variable in the state information * * to update with the return value received from an external * * application. * ********************************************************************** * variable-ref - Mandatory Single - Variable to update * *@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@* * Attribute(s):- * * Attribute Definition List stored in attribute group "bodyatt". * ********************************************************************** ********************************************************************** * Define Element recbyname (Receive Parameter by Name) containing:- * ********************************************************************** * The recbyname element defines what to do with return values from * * an external application when the return consists of a name / value * * pair. The element defines a name expected from the external * * application and a Variable to place the associated return value * * into. * ********************************************************************** * recname - Mandatory Single - Name associated with the return* * variable-ref - Mandatory Single - Variable to update * *@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@* * Attribute(s):- * * Attribute Definition List stored in attribute group "bodyatt". * ********************************************************************** ********************************************************************** * Define Element recname (Name of a returned value) containing:- * ********************************************************************** * The recname element defines a name associated with a returned value* * from an external application that returns name / value pairs. * ********************************************************************** ********************************************************************** * Define Element recbypos (Receive Parameter by Position) containing:* ********************************************************************** * The recbypos element defines what to do with return values from * * an external application. The element defines an integer position * * of the return parameter (starting with 1) from the external * * application and a Variable to place the associated return value * * into. * ********************************************************************** * recposition - Mandatory Single - Position with the return value * * variable-ref - Mandatory Single - Variable to update * *@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@* * Attribute(s):- * * Attribute Definition List stored in attribute group "bodyatt". * ********************************************************************** ********************************************************************** * Define Element recposition (Position of a returned value) * * containing:- * ********************************************************************** * The recposition element defines a position of a returned value * * from an external application (starting with 1). * **********************************************************************