Use this 2.5 version of the Wizards tool Help file to make changes for 2.6. Confluence will track your changes for subsequent review.Wizards: Overview
Wizards are customized collections of informational screens and forms that provide structure and guidance for a wide variety of activities and processes using customized forms and items from the Resources tool.
If you are a system administrator or a CIG Coordinator (site organizer or other user with permission) in a portfolio site, you can use this tool to perform these activities.
...
In Sakai, you can create three types of wizards. The simplest type is a sequential wizard. This kind of wizard is well suited to activities in which a series of steps are performed in a linear fashion. For example, you might create a sequential wizard to guide students through the steps of creating a term paper or to guide students though assist students in performing and documenting work on an experiment that extends over a significant period of time. A wizard for an experiment might track the timing of each step, collect data and interpretations from students at critical points, and provide an opportunity for you or others an instructor or the student's peers to provide feedback along the way.
...
The third type of wizard is a matrix wizard (see [Link to Matrices Tool Help)]. Also called a matrix, this wizard presents forms and information in a set of rows and columns. You might create a matrix to track progress across different disciplines (using the rows of the matrix) that have similar milestones (using the columns )of the matrix). Each cell in the matrix is a point at which you can track achievements, encourage reflection on how the disciplines mesh, offer formative feedback, and provide feedbacksummative evaluation.
Who Uses Wizards
In the out-of-the-box version of Sakai, any site participant can build a matrix wizard in My Workspace by using the Worksite Setup tool to add the Matrices tool to My Workspace. Most often, however, instructors and site organizers create and share wizards with site participants in portfolio, course, and project sites. After a wizard has been published, users in many different roles may access it with different levels of permission.
Let's say you are an academic advisor and you have that has created a wizard in a portfolio site for use in tracking student progress in a specific program. Each student in the program accesses your wizard to complete forms, attach files as evidence of work completed, reflect on learning, etcand submit his or her work for evaluation. Reviewers and evaluators (who that you identify when you create the wizard) also access the wizard to review work and add comments at key points and/or after the entire wizard has been completed.
...
A wizard is made up of one or more units known as pages. Each page can contain many different components. These components can include instructions or general guidance to the user, an introduction to or rationale for the page, examples to help participants understand how to use the wizard, forms for people in various roles to complete (including, if desired, forms that solicit reflection, feedback, or other feedbackevaluation), and/or items from Resources.
To build an effective wizard, you use XSD (XML Schema) programming and the Forms tool to create forms. These forms are then attached to wizard pages which comprise the wizard. The forms you create allow you to structure and collect information, such as reflections on learning documentation of the evidence, reflection on what was learned, and feedback and evaluation of on the work shown displayed in the wizard. These forms may apply to the wizard as a whole and/or to each page of the wizard. You may also use a .css file to create a display style for the wizard.
...
To access the tool, click the Launch launch button for Wizards. Sakai displays the Wizards home page.
...
Avoid unnecessary complexity: You can add unlimited instructions, forms, feedback, evaluation, and other features to each page of a wizard. You can also create an unlimited number of pages, categories, and subcategories. As a result, it's possible to make a wizard overly complex and difficult or burdensome to use. Remember this: You that you do not have to use every element and feature at every opportunity. If something seems to have little or no value at any point, leave it out.
...
1. Analyze the activity or process that the wizard will support. Identify the type of wizard that will best support it (hierarchical or sequential).
2. Alternatively, use the Matrices tool for a matrix wizard.
2. If you plan to create a hierarchical wizard, identify the categories and subcategories you will need. You may want to consider creating a category for each distinct path or grouping of activities. You may find it helpful to draw a high-level diagram of the wizard's organization.
3. Identify the pages you will need. You may want to consider creating a page for each step that requires different guidance, produces a different work product, or takes place at a different time.
4. Identify the content needed (instructions, files, forms, etc.) for each page and -- if the wizard contains more than one page -- for the wizard as a whole. You may find it helpful to draw a diagram showing the organization of the wizard's components.
5. If you plan to attach files to provide information to users of the wizard, create those files and store them in Resources.
6. Identify the points at which formative and summative feedback are needed. You may allow for feedback on the wizard as a whole or on a page-by-page basis. Before making decisions in this regard, think carefully about the load placed on reviewers (those who provide formative feedback) and evaluators (those who provide summative feedback). Also, keep in mind that after a page or a wizard has been submitted for evaluation, participants can no longer change it.
7. Identify people to provide formative and summative feedback. Be sure they have appropriate permissions. For more information on setting permissions for reviewers, see "[link to Changing Permissions for the Wizards Tool"].
8. If you plan to use forms for users to use in responding to instructions on a wizard page and/or for collecting comments from reviewers and evaluators, create those forms and store the .xsd files for them in Resources. Forms for collecting reflections and feedback comments , offering formative feedback, and providing summative evaluation, may be added to the wizard as a whole or to individual pages. Forms for participants to use in following the instructions for completing providing content for inclusion in a wizard can be added only to individual pages, not to the wizard as a whole.
9. Choose the style(s) you want to use in the wizard. In most cases, it is good practice to use a single style throughout a wizard. If you plan to use a style other than the default, store the .css file for it in Resources and use the Styles tool to create the style.
...
To build a matrix wizard, use the Matrices tool. For more information on this step, see [link to 2.6 Matrices Tool Help Documentation].
To build a sequential or hierarchical wizard, access the Wizards tool and follow these steps:
Step 1: Creating the Wizard
1. If the Wizards menu bar is not displayed, click the Reset button.
2. Click the Add button on the menu bar. Sakai displays the Add screen.
3. Select the type of wizard you are creating by clicking the button for either sequential or hierarchical.
- A sequential wizard presents pages in a linear sequence, so that the user can complete pages in a sequential order.
- A hierarchical wizard organizes pages into categories and sub-categories, so that the user can complete pages in categorical order.
4. To proceed, click Continue. Or, to return to the Wizards home page without creating a wizard, click Cancel.
5. If you clicked Continue, Sakai displays the Add Wizard, Step 1, screen. Using the boxes shown, enter a name, a description of the wizard's purpose, and keywords. Only the Name entry is required.
6. Choose one of the following options:
- To apply Sakai's default style to this wizard, skip this step and proceed directly to step 7.
- To apply another style to this wizard, click Select Style. Sakai displays the Manage Styles screen. This screen lists the styles available for use in your wizards. Click the Select link for the style you want to apply to this wizard. Sakai redisplays the Add Wizard, Step 1, screen. The name of the style you chose is displayed in the Apply a Style box. Or, to return to that screen without selecting a style, click Go Back.
7. To proceed, click Continue. Or, to return to the Wizards home page without creating a wizard, click Cancel.
If you clicked Continue, Sakai displays the Add Wizard, Step 2, screen. This screen is shown in the next subsection.
...
1. To add instructions and other helpful information for users, click Add Instructions. Sakai displays the Guidance screen.
2. Choose one or both of these options:
- Enter text directly into the text box on the screen. Use the icons and pulldown pull-down lists to format the text as appropriate.
- Attach a file by clicking Select Items. To do so, follow the instructions given for selecting an item. After you click Finish, Sakai displays the Guidance screen again.
3. To save the information you have entered or attached, click Save. Sakai saves the information in the wizard and displays the Add Wizard, step 2, screen again. If you have entered text, that text is displayed in the appropriate part of the screen. If you have attached a file, its name is displayed.
4. To explain the purpose of the wizard to site participants, click Add Rationale. Sakai displays the Add Rationale screen. Except for its name, it is identical to the Guidance screen shown above. Proceed as instructed in steps 2 and 3.
5. To add examples to show users how to use the wizard, click Add Examples. Sakai displays the Add Example screen. Except for its name, it is identical to the Guidance screen shown above. Proceed as instructed in steps 2 and 3.
6. To add a form with which to collect participant reflections upon their work in the entire wizard, select the appropriate form from the Reflection pulldown pull-down list.
7. To add a form in which reviewers will provide formative feedback to participants, select the appropriate form from the Feedback pulldown list.The form you select must have already been created using the Forms tool and made available in this site. After you have selected the form, do not forget to click Add or the form you have selected will not be saved as a link to the page. You may add as many forms as you like to any page.
7. To add a form in which reviewers will provide formative feedback to participants on their work in the entire wizard, select the appropriate form from the Feedback pull-down list. The form you select must have already been created using the Forms tool and made available in this site.
8. To add a form in which reviewers will provide summative feedback to participants on their work in the entire wizard, select the appropriate form from the Evaluation pulldown list. pull-down list. The form you select must have already been created using the Forms tool and made available in this site. If you want participants to be able to modify their responses indefinitely, do not include an evaluation form and do not identify evaluators for the wizard. In the absence of evaluation form and an evaluator evaluators to provide summative feedback, the wizard has no end point, so participants can return to it and change it as desired.
9. To select people to provide summative feedback, click Select Evaluators. Sakai displays the Select Evaluators screen. The window on the left side of the screen lists all roles defined for this site. Below the line, it also lists all site participants.
10. To select evaluators, click the names of roles and/or individuals and then click the Add button. The roles you have selected for evaluators must have permission to evaluate wizards. Furthermore, the individuals selected for evaluation must be assigned a role selected for evaluation in the site. If these conditions are not met, the selected users will not be able to view and evaluate wizards. For more information on setting permissions, "see [link to Changing Permissions for the Wizards Tool"]. To select more than one role or person at a time, hold the CTRL key down as you click. Sakai displays the names of the roles and/or people in the box on the right.
11. To remove any of these roles or people from the list of selected evaluators, click their names and click the Remove button.
12. When you have identified all roles and/or individual participants who will act as evaluators, click Finish. Sakai displays the Add Wizard, step 2, screen again. The screen shows the names of the roles and/or individuals you have selected as evaluators.
13. Choose one of the following options:
- To create additional pages for this wizard, click Continue. Sakai displays the Add Wizard, step 3, screen. This screen varies, depending on whether you are creating a sequential or hierarchical wizard.
- To complete this wizard without adding additional pages to it, click Finish. Sakai displays the Wizards home page. Your new wizard is listed on this screen.. Your new wizard is listed on this screen. [Note: A sequential wizard must have at least one page in order to be able to preview it.]
- To return to the Add Wizard, step 1, screen, click Back.
- To exit without creating this wizard, click Cancel. Sakai displays the Wizards home page.
14. To add pages to this wizard, follow the instructions for either "consult [link to Step 3: Adding Pages to a Sequential Wizard" ] or "[link to Step 4: Adding Categories, Subcategories, and Pages to a Hierarchical Wizard"].
15. To publish this wizard, see "[link to Publishing a Wizard"].
Step 3: Adding Pages to a Sequential Wizard
If you are creating a sequential wizard and have completed " Step 2: Add Wizard Support " by clicking Finish, Sakai displays this screen " Step 3: Add Wizard Pages":.
1. Click the Add button on the menu bar. Sakai displays the Revise Wizard Page Settings screen. This screen looks like a combination of the Add Wizard, step 1, and the Add Wizard, step 2, screen. Just as those screens provided all the boxes, pulldown pull-down lists, and access to files and forms that you needed for the wizard as a whole, this screen provides the boxes you need to define a single page in the wizard. This screen contains one new box, which is a pulldown pull-down list for adding forms for site participants to use in completing this page of the wizard.
2. Referring Refer to the instructions given in "[link to Step 1: Creating the Wizard" ] and "[link to Step 2: Adding Wizard Support" , ] to provide the information and materials that participants, reviewers, and wizard evaluators need for this page.
3. To select forms for participants to completefor participants to add content to the page, go to the page to which you wish to add a form, select a form from the Forms pulldown pull-down list and click Add. Sakai displays the name of the form you have added. After you have selected the form, do not forget to click Add or the form you have selected will not be saved as a link to the page. You may add as many forms as you like to any page. Repeat this step to select the other forms you need for reflection, feedback, and/or evaluation.
4. After entering information, attaching forms and files, and identifying evaluators as needed, click Save Changes. Sakai displays the Add Wizard, step 3, screen. The page you have added is listed on this screen. Or, to return to this screen without adding the page to the wizard, click Cancel.
5. To add another page, repeat steps 1- 4.
6. After adding as the pages you need, click Finish. Sakai displays the Wizards home page. Or, to return to the Add Wizard, step 2, screen, click Back. To return to the Wizards home page without adding this wizard page, click Cancel.
Step 4: Adding Categories, Subcategories, and Pages to a Hierarchical Wizard
If you are creating a hierarchical wizard and have completed " Step 2: Adding Wizard Support " by clicking Finish, Sakai displays the Add Hierarchical Wizard, Step 3, screen. This screen provides the starting point from which you add categories, subcategories, and pages to your hierarchical wizard.
...
- To save your work and return to the Wizards home page, click Finish.
- To save your work and return to the Add Wizard, Step 2, screen, click Back.
- To return to the home page without saving any of the categories, subcategories, and pages you have created, click Cancel.pages you have created, click Cancel. [Note: A hierarchical wizard must have at least one page to be able to preview it.]
Adding Categories
To add one or more categories, access the Add Hierarchical Wizard, Step 3, screen and follow these steps:
1. Click the Add Category link for the wizard. Sakai displays the Add Wizard Category screen
2. Enter a title for the category in the Title box. This entry is required.
3. If desired, enter a description of the category in the Description box and enter keywords in the Keywords box.
4. To save this category, click Save. Or, to return to the Add Wizard, Step 3, screen without adding the category, click Cancel. If you clicked Save, Sakai saves the category and displays the Add Wizard, Step 3, screen again. The category you have added is now listed.
5. To add another category, repeat steps 1 - 4.
...
1. Find the category to which you want to add a subcategory and click the Add Category link for it. Sakai displays the Add Wizard Category screen
2. Enter a title for the subcategory in the Title box. This entry is required.
3. If desired, enter a description of the subcategory in the Description box and enter keywords in the Keywords box.
4. To save this subcategory, click Save. Or, to return to the Add Wizard, Step 3, screen without adding the subcategory, click Cancel. If you clicked Save, Sakai saves the subcategory and displays the Add Wizard, Step 3, screen again. The subcategory you have added is now listed.
5. To add another subcategory, repeat steps 1 - 4.
...
1. Depending on where you want to add a page, click the Add Page link for the wizard itself or any category or subcategory in the wizard. Sakai displays the Revise Wizard Page Settings.
2. Referring to the instructions given in "Step 1: Creating the Wizard" and "Step 2: Adding Wizard Support", provide the information and materials that participants, reviewers, and wizard evaluators need for this page.
3. To select forms for participants to completeadd content to the page, select a form from the Forms pulldown pull-down list and click Add. Sakai displays the name of the form you have added. After you have selected the form, do not forget to click Add or the form you have selected will not be saved as a link to the page. You may add as many forms as you like to any page. Repeat this step to select the other forms you need for reflection, feedback, and/or evaluation.
4. After entering information, attaching forms and files, and identifying evaluators as needed, click Save Changes. Sakai displays the Add Wizard, step 3, screen. The page you have added is listed on this screen. Or, to return to this screen without adding the page to the wizard, click Cancel.
5. After adding as the pages you need, click Finish. Sakai displays the Wizards home page. Or, to return to the Add Wizard, step 2, screen, click Back. To return to the Wizards home page without adding this wizard, click Cancel.
6. After entering information, attaching forms and files, and identifying evaluators as needed, click Save Changes. Sakai displays the Add Wizard, step 3, screen. The page you have added is listed on this screen. Or, to return to this screen without adding the page to the wizard, click Cancel.
7. To add another page to the wizard, repeat steps 1 - 6.
...
1. If the Wizards home page is not displayed, click the Reset button.
2. Find the wizard you want to change and click the Edit link beneath its name. Sakai displays the Edit Wizard, Step 1 screen. Except for its name, this screen looks like the Add Wizard, Step 1 screen.
3. Referring to the instructions given in " Step 1: Creating the Wizard, " steps 5 - 7, change entries as appropriate.
4. If you press click Continue, Sakai displays the Revise Wizard, Step 2, screen. Except for its name, this screen is identical to the Add Wizard, Step 2 screen.
5. Referring to the instructions in "[link to Step 2: Adding Wizard Support"], change entries, as appropriate. If you press click Continue, Sakai displays the Revise Wizard, Step 3, screen. This screen varies, depending on whether you are revising a sequential or hierarchical wizard. Note that categories and pages are identified by different icons:
- downDown-facing triangle denotes a category that contains pages.
- rightRight-facing triangle denotes a category that contains no pages.
- circle Circle denotes a page.
6. To make other types of changes, choose one or more of these options:
- To add pages to a sequential wizard, see "[link to Step 3: Adding Pages to a Sequential Wizard"].
- To add categories and/or pages to a hierarchical wizard, see "[link to Step 4: Adding Categories, Subcategories, and Pages to a Hierarchical Wizard"].
- To change, delete, or move a category or page, see the subsections that follow.
...
- To save your work and return to the Wizards home page, click Finish.
- To save your work and return to the Add Wizard, Step 2, screen, click Back.
- To return to the home page without saving any of the changes you have made, click Cancel.
Changing a Category
To change a category in a hierarchical wizard, follow these steps:
1. On the Add Wizard, Step 3, screen, find the category you want to change and click the Revise link below its name. Sakai displays the Revise Wizard Category screen. Except for its name, it is identical to the Add Wizard Category screen.
2. Referring to the instructions given in " [link to Adding Categories], " steps 2 - 5, make changes as needed.
...
1. On the Add Wizard, Step 3, screen, find the page you want to change and click the Revise link below its name. Sakai displays the Revise Wizard Page Settings screen (see page 1).
2. Referring to the instructions given in "[link to Step 1: Creating the Wizard" ] beginning with step 5, and "Step 2: Adding Wizard Support", make changes as needed.
3. To select forms for participants to complete, select a form from the Forms pulldown pull-down list and click Add. Sakai displays the name of the form you have added. Repeat this step to select the other forms you need.
4. After entering information, attaching forms and files, and identifying evaluators as needed, click Save Changes. Sakai displays the Add Wizard, step 3, screen. The page you have added is listed on this screen. Or, to return to this screen without adding the page to the wizard, click Cancel.
Deleting a Category or Page
...
1. On the Add Wizard, Step 3, screen, find the category or page you want to delete. Caution: Be sure you have chosen the correct category or page.
2. Click the Delete link below the name of this category or page. Sakai deletes your selection immediately, without asking you to confirm your selection.
...
1. On the Add Wizard, Step 3, screen, find the category or page you want to move and click the Move link for it. Sakai redisplays the screen, showing the possible destinations for the category or page.
2. Find the category you want to move the category or page into and click the Move Category Here link for it. Sakai moves the category or page to the new location.
...
You can delete a wizard only if it has not yet been published. To delete a wizard, access the Wizards home page and find the wizard you want to delete. Then follow these steps:
1. Click the Delete link below the name of the wizard. Sakai displays this screen:
2. To delete this wizard, click Delete. Sakai deletes the wizard and displays the Wizards home page. Or, to return to the home page without deleting this wizard, click Cancel.
Publishing a Wizard
Publishing a wizard makes it available to site participants. Caution: After a wizard has been published, you cannot add, move, reorder, or delete any of the categories or forms in it, nor can you delete the wizard itself. For this reason, we strongly recommend that you publish a wizard only when you are sure it contains the components you want in the order you want them.
...
1. If Sakai is not displaying the Wizards home page, click the Reset button.
2. Find the wizard you want to change, and click Publish. Sakai publishes the wizard and redisplays the home page.
...
If you own more than one site, you may want to use the same wizard in two or more of them. To do so, you first export the wizard to your desktop as a compressed file and then import it to the other site(s) where you plan to use it.
Exporting a Wizard
To export a wizard as a compressed file, access the Wizards tool and follow these steps:
1. If the Wizards home page is not displayed, click the Reset button.
2. Find the wizard you want to export.
3. Click the Export link below the name of the wizard. Sakai displays the Opening File window.
4. Follow the instructions.
5. Upload the compressed file to Resources.
...
1. Add the file to Resources.
2. Access the Wizards tool. If the Wizards menu bar is not displayed, click the Reset button.
3. Click the Import button on the menu bar. Sakai displays the Import Wizard screen.
4. Click Select files. Sakai displays the Select Item screen.
5. Select the compressed file for the wizard by following the instructions given for selecting an item. After you click Finish, Sakai displays the Import Wizard screen again.
6. The name of the file you chose is displayed in the Name box.
7. Click the Import button. Sakai imports the file from the Resources area and redisplays the Wizards home page. The imported wizard is listed there. It has the same name and instructions as it had on its original site. Or, to return to the home page without importing the file into the Forms tool, click Cancel.
Regardless of the state (published or unpublished) of the wizard on the original site, it is always imported in the unpublished state.
...
1. If the Wizards home page is not displayed, click the Reset button.
2. Use the dropdown drop-down list to select the name of the person whose wizard you want to review.
3. Click Go. Sakai displays a list of wizards for the user you specified.
4. Find the wizard you want to review and click its name. Sakai displays the introductory page of that wizard.
5. Review the introductory page and then click Continue. Sakai displays the first page of the wizard. If this is not the page you want to work with, click Continue until you reach the appropriate page.
6. To review an attached item on any page, click its name.
7. To enter feedback, click the Add Feedback link in the "Feedback" section at the bottom of the page. Sakai displays a screen containing a feedback form.
8. Enter information in the fields, as appropriate. Caution: The Access section of the screen allows you to make your feedback public to people other than the participant whose work you are reviewing. As a general rule, we advise against making feedback public in any way. To keep your feedback between you and the participant, do not click either radio button in this section.
9. To add your feedback, click Add. Sakai displays the wizard page again. The title of your feedback is shown in the Feedback section of the screen.
10. Choose from among these options:
- To review other pages in this participant's wizard, click Continue.
- To return to the Wizards home page, click Return to Wizards.
- If you have reached the last page of the wizard, click Finish to return to the Wizards home page.
...
1. If the Wizards menu bar is not displayed, click the Reset button.
2. Click the Permissions button on the menu bar. Sakai displays the Permissions screen.
3. Referring to the table below, check boxes to select the appropriate permissions for users in each role.
...
4. To save the permissions settings, click save Save. Sakai saves the settings and displays the Wizards home page. Or, to return to that screen without saving your changes, click cancel Cancel.
Completing a Wizard
A wizard is a customized collection of instructions, forms, files, and other materials that guide you through an activity. You complete the wizard as you perform the various tasks or steps that make up the activity.
...
1. If the Wizards home page is not displayed, click the Reset button.
2. Click the name of the wizard you want to work with. Sakai displays the introductory screen for the wizard you chose.
...
- To fill out the form and attach it, click the Add Form link below the name of the form. Sakai displays the form you have selected. Complete the form, including the Title field (required; your entry provides a display name for your work in this form), and click Add. Sakai saves the information and displays the wizard again. It also stores the completed form (by the title you gave it) in Resources the Portfolio Interactions folder in your My Workspace Resources.
- If you have already filled out this form and have stored it in Resources, click the "Select Existing Form " link. When Sakai displays the Resources home page. Open the Portfolio Interactions folder in your My Workspace Resources folder. Open the wizard, matrix, or portfolio for which you created the form, and select the form.
7. When you have completed a page that calls for submission or have completed the entire wizard, submit the page or wizard for evaluation. To do so, click the Submit for Evaluation confirmation button. Sakai a screen asking you to confirm that you want to submit the completed wizard for evaluation. Caution: After you submit the wizard for evaluation, you cannot access it again to make changes. Therefore, you should make sure that all of your entries are in their final form and are ready for review and comment before you submit the wizard.
8. To submit the wizard now, click Submit. Or, to cancel the submission process, click Cancel.
9. To return to the Wizards home page at any point, click the Return to Wizards button.