Develop > Wizards Guide > Using the Wizard Tool > Usage tab field definitions

Usage tab field definitions

Use this tab to set wizard usage options, such as whether and which subformat will be displayed to the user and which buttons will be available on the panel displayed.

Field Description
Wizard Usage
section		 Determines the action that HPE Service Manager should take when the wizard is run. You must select one of the five main options presented on the screen.

Select one record from list

wizard.type

Choose from the Selection Criteria listed below.
Selection Criteria When you choose to Select one record from list, selecting one of the following options allows you to select a record from a list. The list is formed based on the options selected.

Use $L.file as $L.selection

use.file.as.selection

This option uses the $L.file variable to form the list of records where the selection is to be performed.

Query for records

query.for.records

This option allows you to specify a query to form the list of records. The fields that are needed for the query are noted below.

of type

query.for.records.filename

Enter the name of the table (dbdict name) that the query should run against. Check that the dbdict for field names is valid for the query.

using query

query.for.records.query

This option is used in conjunction with the options "Query for Records" and "of type." Enter the query using Service Manager system language syntax.

sort by

query.for.records.sort

This option allows you to present the list, sorted in order, based on the fields specified in this option. Enter field names that are valid for the selected dbdict and sorted in ascending order.

If no records

query.select.no.records

This option allows you to specify an action if there are no records on the list. The actions are as follows:

return: Returns to the previous wizard panel if there is one, or to the place from which the wizard was called (if this is the first panel).

continue: Shows the empty list and allows you to continue.

skip display: Skips the wizard panel and goes to the following panel, if applicable.

No records message

query.no.records.msg

This option allows you to display a message to present if there are no records in the list. An scmessage record can be used to construct the message.

If one record

query.select.one.record

This option allows you to specify an action if there is just one record in the list. The one record can be displayed in a list, or it can be used as the current file variable without being presented to the user for selection.

Allow "Skip" option?

allow.skip

If selected (set to true), enables users to skip the panel.

Request user input

wizard.type

This field indicates that the user will be prompted for information. When this option is selected, the Sub Format to display entry becomes required and a prompt with instructions needs to be entered in the Wizard Info tab.

Skip Display

wizard.type

Skip Display should be used when the current wizard manipulates the current record without the need for user input. Typically, a wizard that is not displayed to the user is part of a complex wizard workflow.

Cancel Immediately

wizard.type

This option is used to cancel a process immediately if a wizard is started by a user type who is not intended to use the wizard.

For example: A company creates a wizard to gather information from top-level management customers. Let us say that a user who does not fit the criteria chooses to start the wizard and make his way through the wizard panels. The Cancel Immediately option causes the process to immediately end when it becomes clear that the information does not need to be gathered from that user.

Select multiple records from list

wizard.type

Selecting this option displays a list and allows the user to select multiple records from the list. The list is formed based on the options selected in the "Selection Criteria" section.

Multiple Selection field

mult.field.name

This option determines which field in the list becomes available for the user to select multiple records from.

Sub Format to Display

sub.format

Enter the name of the format for user input to display within the wizard format.

Main Format

(Defaults to Medium)

form.Name

The wizard creation tool offers several format choices that effect the size of the wizard and the placement of buttons. HPE Service Manager offers the following wizard format options. If no format is selected, the default is "Medium."

Small (wizard.small) - This wizard offers the least amount of space for text and options, but also requires the least amount of screen space. This wizard is ideal for clients running in low resolution environments. It allows only a small space for the subformat, so the subformats need to be kept small. Buttons available are Previous, Next, Finish, and Cancel, and placement is horizontally-aligned along the bottom.

Medium (wizard) - This wizard offers sufficient space for most wizard tasks. Buttons available are Previous, Next, Finish, and Cancel, and placement is horizontally-aligned along the bottom.

Large (wizard.large) - This wizard offers the most amount of space for text and options, but also requires the most amount of screen space. This wizard is ideal for clients running with high screen resoltuions. It offers the most amount of space for the subformat to display, allowing for more complex subforms. Buttons available are Previous, Next, Finish, and Cancel, and placement is horizontally-aligned along the bottom.

OK Only - Small (wizard.okonly.small) - Uses the small wizard size and limits the buttons available to navigate through the task. Buttons available are OK and Cancel, and placement is horizontally-aligned along the bottom.

OK Only - Medium (wizard.okonly) - Uses the medium wizard size and limits the buttons available to navigate through the task. Buttons available are OK and Cancel, and placement is horizontally-aligned along the bottom.

Buttons on Top (wizard.buttonsOnTop) - Uses the medium wizard size and places the buttons along the top of the wizard. Buttons available are Previous, Next, Finish, and Cancel, and placement is horizontally-aligned along the top.

Buttons on Side (wizard.buttonsOnSide) - Uses the medium wizard size and places the buttons along the right edge of the wizard. Buttons available are Previous, Next, and Finish, and placement is vertically-aligned along the right side.

Display Screen (Defaults to wizard.display)

display.screen

Enter a display screen, if you want to customize the button and menu options available within the wizard. The default display screen is wizard.display.

Activate "Finish" option?

allow.finish

Use this option for the final wizard in the series. Selecting this check box makes a Finish button appear on the wizard panel.

Note It is possible to have the Finish button available prior to the last wizard in the workflow, if the wizard panels displayed after this wizard only provide optional information. The Finish button cannot be activated before all required information can be collected from the user.

Turn off Next and Previous buttons?

disable.next.previous

Selecting this check box makes the Next and Previous buttons unavailable in the wizard, so the user cannot click "Next" or "Previous" to move forward or backward in the wizard.

Note This selection should only be made on the very last wizard panel in the workflow. Also, the Finsih button needs to be activated if the Next and Previous buttons are disabled.

Turn off Next button only?

disable.next

Selecting this check box makes the Next button unavailable in the wizard, so the user cannot click "Next" to move forward in the wizard.

Turn off Previous button only?

disable.previous

Selecting this check box makes the Previous button unavailable in the wizard, so the user cannot click "Previous" to move backward in the wizard.

Note This option should be used if the first displayed panel of the wizard is not the Start Node. Selecting Previous in such a case would exit the wizard without going through proper cancel processing.

Use Conditional Previous Exits?

previous.cond

When you select this option, the Previous Wizard tab appears on the form. In the Previous Wizard tab, you define the different possible exits when the Previous button is clicked.

Never prompt on cancel? Determines whether the user is prompted when canceling out of the wizard. The Return prompt can send the user back to the panel.

Send Help Center feedback