| # Wizards (tgwzr1500m000) The Wizards (tgwzr1500m000) session is used to create new wizards or to modify existing wizards. A wizard is used to group a number of wizard steps. The wizard does not contain any questions, but only shows a dialog box with an introductory text and, when finished, a dialog box with an end text. Like most model items, wizards are version dependent. To create a wizard, complete the following steps: In the Wizard field, specify a name for the wizard. If it is compulsory that the wizard is carried out in the business function model, in the Mandatory field, select the value Yes. In the Owner field, select the LN user who created or who is responsible for the wizard. Click Save
Key fields for the Wizards (tgwzr1100s000) session |
Field | Description |
--- | --- | ---
Image | To illustrate the wizard, select a graphic representation shown in the Wizard dialog box. |
Start Text | Starts the text editor so you can define the wizard start text. This text explains the function of the wizard, but does not ask any questions, because that is done in the individual wizard steps. If no start text has been defined, the first wizard step is directly shown when the wizard is carried out.
End Text | Starts the text editor so you can define the wizard end text. This text explains the result of the wizard or indicates you have completed all wizard steps.
Help Text | Starts the text editor so you can define the wizard Help text. This text explains the objective of the wizard.
Execute Wizard | Carries out the wizard without actually setting the parameter values
Wizard Steps (tgwzr2500m000) The wizard steps are used to ask questions and to receive input. A wizard can have multiple wizard steps. Each step has one question and a range of possible answers that can only be limited by the domain of the parameter that must be set. To create new wizard steps or to modify existing steps, use the Wizard Steps (tgwzr2500m000) session. Furthermore, this session can be used to modify additional data related to the wizard steps. There are two ways to create wizard steps: You can import parameters from the Parameters (tgbrg9100m000) session. To select the parameters that must be set through one or more wizard steps, from the appropriate menu, select Import Parameters Next, a wizard step is created for each selected parameter. If you use this option, the value of the following fields is set automatically: Description Domain Default Answer Mandatory Question Text Apply Constraint Help text You can define answers manually if you leave the Domain field empty. In this case, you must define the possible answers to the wizard question manually in the Wizard Step Answers (tgwzr2120m000) session. Note It is recommended you use the first user-friendly option to create consistent and correct wizard steps. To manually create a wizard step: From the Sessions (ttadv2506s000) session in the Zoom/Browse Session field, select a session, to which you can zoom, and select a value from when you carry out the wizard. The values in the Return Field and the Show Field are defined automatically. The Return Field field is the value returned to the parameter; for example, the employee code 1234. The Show Field field is the field displayed in the dialog box to clarify the return field; for example, Mr. John Doe. In the Domain field, specify the domain of the data that must be returned to the parameter. A domain determines some characteristics of the Return Field field, such as data type such as string or integer, the length of the field, and allowed values. If answers are defined manually, this field cannot be modified.
Key fields for the Wizard Steps (tgwzr2100s000)
Field | description
--- | ---
Session to start | Select a LN session that can be started from the wizard step. This session must be a multi-occurrence session so an LN user can enter new records.
Business Process to start | Select a business process that can be started from the wizard step. This business process can be used to enter data by working through the activities included in the business process.
Question Text | Starts the text editor yo define the wizard step question text.
Wizard Constraint | Starts the text editor to define the wizard constraints.
Apply Constraint | Starts the text editor to define apply constraints.
Hint Text | Starts the text editor to define the wizard step hint text. Unlike the Help text, which gives a direct explanation, hint text directs users to the answer by referring to examples from obvious common practice.
Help Text | Starts the text editor so you can define the wizard step Help text. Help text is used to explain the question in more detail, or to place the question in perspective to parts of the reference or project model. It differs from hint text, which advises about possible answers.
Execute Wizard Step | Carries out the wizard step.
Wizard Step Answers (tgwzr2120m000) To manually define answers for the wizard step, use the Wizard Step Answers (tgwzr2120m000) session. Usually, the possible answers are set automatically based on the domain linked to the parameter. However, if an answer results in setting several parameters, it is impossible to define just one domain for this step. Therefore, to access this session, the Domain field in the Wizard Steps (tgwzr2100s000) session should be left empty. To make a wizard step that sets several parameters, use this session to define the answers. Click Apply Constraint to start the text editor and define what needs to be done for each possible answer. Because the Domain field in the Wizard Steps (tgwzr2100s000) session is empty, the domains for the parameters must be included in the apply constraint. Wizard Constraints To start the text editor and define a wizard constraint, in the Wizard Steps (tgwzr2100s000) session: Click Wizard Constraint; alternatively, on the appropriate menu of the Wizard Steps (tgwzr2500m000) session, click Edit Wizard Constraint. Wizard constraints define which nonstandard actions must be taken based on certain conditions. Therefore, a wizard constraint is only necessary when the actions involve more than setting a parameter. For example, If a certain question in a step is answered with Yes, another nested wizard is started. Functions that are needed in wizard constraints can be included using the Use menu option Options - Start Zoomsession to zoom in rule condition option in the text editor’s Options menu. Example `IF answer = 10` `THEN` `Start. wizard ("demowiz1")` `ELSE` `Start. wizard ("demowiz2")` `ENDIF` If the answer given to this wizard step is `10`, then demo wizard `1` is started. In case another answer is given, demo wizard `2` will be started. Apply Constraints To activate the text editor and define the apply constraints of the wizard step, in the Wizard Steps (tgwzr2100s000) session: Click Apply Constraint; alternatively, on the appropriate menu of the Wizard Steps (tgwzr2500m000) session, click Edit Apply Constraint. Apply constraints define what must be done when you have worked through the wizard steps and choose to apply the answers. Wizard step answers can be applied in the business function model of a project model. When you have answered all wizard steps, the question is asked if the answers you have given must be applied based on certain conditions. The apply constraints are created automatically when parameters are imported in the Wizards (tgwzr1100s000) session. If you have created the wizard step answers manually, the apply constraints must be created manually. Functions needed in the apply constraints can be included using the Use menu option Options - Start Zoomsession to zoom in rule condition option in the text editor’s Options menu. Example `IF answer = 10` `THEN fill. Parameter ("tdpur000.cspn.4", 950)` `| First position number for additional cost sets` `ENDIF` `IF answer = 20` `THEN fill. Parameter ("tdpur000.cspn.4", 900)` `ENDIF` `10` and `20` are the sequence numbers of the answers. The parameters get the value `950` if the answer is `10`, and `900` if the answer is `20`. |