You can use the statement WIZARD to present the user with a Content Wizard, wherein Sections and Text Blocks can be selected.
Note
ITP Models using this feature can be created with ITP/Workstation, but to run a model containing this feature, you will need ITP/Server or ITP/OnLine Server.
Definition
WIZARD id
NAME path
FOLDER path
SELECTION_INPUT map
SELECTION_OUTPUT map
SUPPRESS_EDITABLE_TEXTBLOCKS
SUPPRESS_QFORMS
SHOW_ALL
NON_INTERACTIVE
DATA_DEFINITION NONE
The label id identifies the Content Wizard for later use with the statement FOREACH WIZARD. If multiple Content Wizards use the same label id, the statement FOREACH WIZARD will use the data from the last occurrence.
The keyword NAME specifies the Content Wizard path that is presented to the end user.
The keyword FOLDER specifies that the user can choose a Content Wizard from the Content Wizard path or its subfolders. If there is only a single choice possible, the selection screen is suppressed and the choice is made automatically. If a Title property is configured in the ITP/MDK Repository for the Content Wizard path it is shown as the title of the selection screen. For more information on configuring the title of the Content Wizard folder, refer to the topic Content Wizard folder General tab of the ITP/MDK Repository Configuration Help.
The keywords NAME and FOLDER are mutually exclusive. One of those keywords must be specified.
The path parameters are paths to the appropriate objects in the ITP/MDK Repository. This path must include all containing folders separated by backslashes.
The keyword SELECTION_INPUT specifies a map that contains a set of overrides, which are applied to the Content Wizard before it is presented to the (Content Wizard) user. This keyword is optional. If no map is specified the defaults as specified by the editor of the Content Wizard will be used.
The keyword SELECTION_OUTPUT specifies a map that will receive a list of the state of each item that was presented in the Content Wizard. This keyword is optional.
The keyword SUPPRESS_EDITABLE_TEXTBLOCKS will prevent the Content Wizard from showing any Editable Text Blocks, which are otherwise presented to the user based on the selected Text Blocks. This keyword is optional.
The keyword SUPPRESS_QFORMS will prevent the Content Wizard from showing any QForms, which are otherwise presented to the user based on the selected Text Blocks. This keyword is optional.
The keyword SHOW_ALL specifies that all mandatory items in the Content Wizard will be presented to the end user. This keyword is optional and can be ignored depending on the definition of the Content Wizard in the ITP/MDK Repository.
The keyword NON_INTERACTIVE specifies that the Content Wizard should be run in a non-interactive modus. This keyword allows Content Wizards to be used in batch environments. The Content Wizard will select all default values for the Content Wizard, suppress the editing of Editable Text Blocks, and select all default values in the associated QForm(s). If the defaults do not satisfy constraints on the QForm or on the Content Wizard, for example the number of selected Text Blocks, an error will be reported and the ITP Model will stop.
The keyword DATA_DEFINITION specifies a variable, which can be used as Data Definition when representing repeating structures in the Content Wizard. Currently only the value *NONE is allowed. See below for more details.
Mandatory items in the Content Wizard
By default all mandatory items in the Content Wizard are hidden from the end user. Content Wizards containing only mandatory items are completely suppressed. You can configure this behavior in the Content Wizard Editor in the ITP/MDK Repository. If the Content Wizard developer selects the option Model decides in the Content Wizard Editor, the keyword SHOW_ALL can be used in the model to change the behavior. If another option is selected in the Content Wizard Editor the keyword SHOW_ALL in the model has no effect.
QForms
The Content Wizard can define one or more QForms. Any Field Set used in these QForms must be declared before the statement WIZARD. The Sections and Text Blocks selected by the user can be accessed by using the statement FOREACH WIZARD.
If an ITP Model is compiled with a Data Definition the variable _data represents the Data Definition and its content will be used implicitly with all Content Wizards and Text Blocks in that ITP Model. The implicit use of the _data Data Definition can be disabled by specifying DATA_DEFINITION NONE on the statement WIZARD. ITP/Server will report a runtime error if the model does use a Content Wizard that requires a Data Definition.
It is not possible to use DATA_DEFINITION to specify an alternative Data Definition.
The map filled by the keyword SELECTION_OUTPUT can be used as input to the keyword SELECTION_INPUT in another WIZARD to reproduce a default state for the Content Wizard, which is identical to the previous selection. For more information on MAPs refer to MAP.
The map contains keys that consist of a sequence of Section titles that are separated by backslashes. The sequence of Section titles can optionally be followed by a Text Block title. For a Content Wizard containing Section "a" and Subsection "b" with Text Block "tb1", Subsection "b" would be presented by "a\b" and Text Block "tb1" would be presented by "a\b\tb1". Each key has a value indicating the selection state. These values are:
Input which would alter Mandatory Sections or Text Blocks as defined in the Content Wizard Editor will be ignored.
Input which sets Optional Sections or Text Blocks to MS (Mandatory Select) will be handled as if they are set to OS (Optional Selected).
If no input is provided for a Section or Text Block the definition as entered in the Content Wizard Editor will be maintained.
Incorrect input will be ignored, such as;
Note
The SELECTION_INPUT and SELECTION_OUTPUT maps cannot differentiate between multiple identical items in the same section because these all map to the same key in the MAP.
The Content Wizard will always write a value MS into the SELECTION_OUTPUT map if one of the objects was Mandatory Selected, otherwise it will write a value OS if at least one of the objects was selected. If none of the objects is selected the value OD is used.