Steps Used to Create and Use Wizards

Follow these high-level steps to create a wizard and use it to generate a draft-authored document:

Create or review wizard bind variables.

Wizard bind variables are used in a wizard to substitutes user-entered values into the text of clauses and documents. They also determine the result of a rule that can include content in the document. Selection wizards are not included in this process. For additional information about wizard bind variables, see Understanding Bind Variables
Create questions groups that are included in wizard definitions.

You define a sequence of questions within a question group. When you create a question group, you indicate whether it’s for document creation or a selection wizard. When defining document creation wizards, the question group definition can be a good starting point because it contains features that allow you to link to and define wizard bind variables and rules along with the question group and questions.

A wizard can consist of one or more groups of questions. Each question provides a value for the document or can determine the next question or question group. You can control question navigation using a list of values and navigation to incorporate some questions or to bypass them.

Question groups can apply to a specific source transaction or to multiple transactions. These question groups can be added to wizard definitions and are only executed when the document that is created matches the source transaction for that question group. For more information about question groups, see the Question Groups Page for selection wizards.

Note:

To create questions on a Question Group with valid responses in a drop down all valid answers must be from within the list of valid values. A Blank is not considered a valid value.
Create rules and add them to questions in a question group.

Rules use logic along with wizard and transactional bind variable values to determine the composition of a document. If the logic in a rule is true, then one or more clauses or sections can be added to the document. For example, if a wizard question asks, “Is freight insurance required?”, then the rule in a section or configurator can use the response to determine whether to add one or more clauses or sections to the document that specifies freight insurance requirements. As part of this step, you should create rules that reference wizard responses using bind variables, and include those rules on configurators or sections in document configurators. Rules are determined using a yes or no question on the Rules tab of the Valid Values and Navigation Page.

Note:

To use rules with a wizard, you must include them in the document configurator after you create them.

Note:

Blanks are always presented as values on account of PeopleTools restrictions. However a rule cannot be executed when a Blank is selected. Therefore questions with valid responses in a drop down cannot be accessed by rule if a Blank is selected.
Set up the wizard definition.

Wizard definitions allow you to define instructions, the status of the wizard, and add question groups in a preferred sequence. You can preview questions, navigate to question groups while defining the wizard, and copy wizard definitions and questions groups. When you initially create a wizard you indicate whether it is a document creation or configurator selection wizard. The wizard status is initially set by the system to Draft. You can change the status to Available after completing and testing the wizard.
Test the wizard.

A Test Mode button allows you to run the wizard without generating a document. You can review the questions within a single or multiple question group to ensure the flow. This provides a method to test the user paths and prompts within the wizard. When a wizard is linked to multiple configurators, you should always test it to evaluate each path. The system does not save the answers that you provide when using the test mode.
Create a document configurator and attach the wizard.

You can define or change a wizard for an existing configurator. Using a configurator, you determine whether you use a wizard with a specific source transaction document. You can also designate a configurator for multiple source transactions and define question groups for specific source transactions, and then combine them in one wizard. You should design clause, section, and rule content in the configurator to reference the appropriate wizard responses for the various paths in the wizard that you defined in step 2 of this list.
Create a document.

Create a document that initiates the configurator selection and the document creation wizard routing. To create a contract document, use the Document Management component from within Supplier Contract Management or access it from the respective source transaction. When creating a document, the configurator selection wizard is called based on how the Document Type Page is defined. If required, the system launches the selection wizard when you add a document definition that guides authors to the correct configurator for the type of document that they need to create. Then, if the selected configurator uses a document creation wizard, the system launches that wizard routing to create the document. For more information about how to setup this type of wizard, see the Define Wizard Page.
Respond to wizard questions.

The system prompts you with wizard question groups in the sequence in which they were defined in the wizard definition. You can bypass some questions or prompts, if they are not activated, based on bind settings in previous responses or if the question is not required. When creating a new document, if you have a long wizard with many question groups, the document creation wizard provides a Save for Later button that saves wizard values to which you have responded. In this case, the system has not created the document. When you return to the document the system inserts your saved responses, but you must review these from the beginning.
The system generates a draft, authored document.

The system creates a document using the clauses, sections and rules with the values of the wizard bind variables associated with questions substituted when wizard binds are referenced. For rules that render true, based on wizard bind responses, the system includes the content related to the rule, while clauses that contain wizard bind responses resolve the value.

When wizards are more complex and contain multiple paths to test them, you should test all possible paths in the test environment and generate multiple documents with detailed logging turned on. This ensures that the system populates the correct content and values into the document. You should do this before moving wizards or configurators into your production environment.

If you refresh or re-create a document, you may want to update some or all of the questions. The system prompts you with the existing populated wizard responses, which can be changed.

If you change a question, the system may present additional question, or change the sequence of the questions. This can occur when a changed value affects other questions. For example, if a question is only activated based on the response of a previous question, and the previous questions response is changed, then you need to set the next question to its default value. If the wizard requires a response to a question in a question group, then you cannot proceed to the next question group until you respond. The system displays a warning when required questions are not answered.

When a question which affects the display of previous responses is changed, such responses are blanked out. Responses hidden from view are always removed so as not to affect rules and bind values.

Note:

Blank responses are not considered as valid values and so do not trigger display of questions. You must therefore always select valid values before saving wizard responses. Additionally make such questions mandatory fields, so that an answer also becomes mandatory.