Wizards


Wizards are interfaces designed to perform previously defined tasks not included in standard data entry windows (forms). They are accessed using the Actions drop-down list available in forms and lists, e.g. employee departure, equipment delivery reception, hardware installation, contract termination.

Each wizard:

  • Is defined by Logo - EasyVista.png. Customers can adapt the appearance of wizards to their requirements, e.g. by renaming a field, hiding a table column, making a field mandatory or invisible, modifying the order in which fields are displayed in a step. However, customers cannot modify the way wizards are designed to work.
  • Is built around a parent query that accesses a set of standardized data from the database.
  • Can trigger processing to update the database. 
  • Can use objects (e.g. fields, messages, grids, images, dynamic text, buttons, etc.) whose proprieties can be modified to display a different aspect or behavior on screen (e.g. step displayed, field name, default value, infotip, etc.).
  • Can contain different types of steps, e.g. display of blocking messages, data entry in fields, summary, sending of an email, etc.

Example

The Install/Move Equipment wizard is available in the Equipment list and form. It is used to move and assign equipment to users via different configurable steps.

  • Step 1: Select the user who should be notified of the moving of the equipment by email.
       --> Configure a step for sending the email conditionally when a user is specified.
             Wizard - Example 1.png
  • Step 2: Select the new location and department for the moved equipment and the installation or move date.
       --> Configure a default value for the installation date (= current date) and modify the display order and position of the fields in the window.
  • Step 3: Display the list of equipment to be moved or installed.
       --> Configure the equipment grid, e.g. column names, alignment, etc.
  • Step 4: Display the confirmation email sent to the user.
       --> Configure the message, the recipient, etc.

Notes

  • Access rights to wizards are defined by profile.
  • Only profiles authorized to edit displays for the module associated with the menu option that opens the wizard can configure the wizard.
  • You cannot create new wizards. Wizards are created by Logo - EasyVista.png.
  • You cannot modify the way wizards are designed to work. You can only adapt their appearance to your requirements.
  • The configuration that you are authorized to modify depends on the wizard. For example, in certain wizards, you are allowed to add user-defined fields while in others, you are not.
  • You can modify a wizard:
    • By selecting Administration > Parameters > Wizards in the menu.
    • Directly in the wizard by clicking Edit icon.png in the title bar to switch to edit mode.
  • Modifications made to a wizard are completely integrated in the EasyVista Mobile version.
  • When users complete all of the steps in the wizard up to the last step, the values specified will automatically be saved in the database.

Caution

  • The modifications made to the properties of an object are not automatically saved. You must remember to click [ SAVE PROPERTIES ] before performing another operation.
  • The names of wizards may not be unique, e.g. there are two Assign to a Contract wizards used to perform different operations in two different windows, Licenses and Equipment.

Best Practice big icon.pngBest practice

  • To ensure that you are configuring the correct wizard if its name is not unique, you can open it in the required context using a form or list. Next, click Edit icon.png to switch to edit mode.
  • To modify only the title of the wizard appearing in the Actions drop-down list, switch to edit mode. Click [ NEXT ] and then click [ FINISH ]. You will be able to enter the wizard title in the field.
  • To configure a specific step in the wizard, display the wizard and switch to edit mode. Click [ EDIT THE CURRENT PAGE ]. The step will be displayed.
  • To access the wizard title quickly, run the wizard, click [ NEXT ] and then click [ FINISH ].

Screens description

         Wizard - Launch.png ==> Wizard.png

Access: Run the wizard and click Edit icon.png in the title bar.

Wizard - Edit help icon.png: Used to an authorized profile (Wizard option > Edit Help) to enter his own comments related to the wizard.

  • The comments must be entered in the Html format between the <BODY> </BODY> tags.
             Wizard - Edit comments.png
  • They are saved in a file specific to each user.
  • When the connected user has entered comments, a new ev itsm - Help icon.png icon will be displayed in the title bar of the wizard.
             Wizard with comments.png

ev itsm - Help icon.png: Used to display the wizard contextual help.

Types of configurable objects

Title of the wizard: Name displayed in the Actions drop-down list that can be configured in the last page of the wizard. 

Titles of steps: Name of each step displayed in the title bar of the Web browser that can be configured in each page of the wizard.

  • A default name is defined for all of the steps in the wizard. This can be configured in the first page of the wizard.
  • You can define a specific name that will replace the default name for each step.

Example documentation icon EN.png  The default name, Move Equipment is replaced only in step 2 by User Definition.

Names of action buttons: Name of each action button displayed in steps in the wizard.

  • A default name is defined for all of the buttons used in the wizard. This can be configured in the first page of the wizard.
  • You can define a specific name that will replace the default name for each step. Go to the step you want and click [ TITLES OF BUTTONS AND WARNING MESSAGES ].

Example documentation icon EN.png  The default name, [ FINISH ] is replaced only in step 3 by [ STOP ].

Messages: Type of message:

  • Information, Warning, Alert (e.g. mandatory field left unspecified): Users can use action buttons to correct the error or continue the wizard. Note: You cannot delete this type of message but you can modify its name. Go to the step you want and click [ TITLES OF BUTTONS AND WARNING MESSAGES ].
  • Stop: The message is the only object displayed on the page of the wizard which has stopped. Users can use the action button, [ FINISH ], to continue the wizard. Note: You cannot modify the name of the action button but you can modify its properties and message name. Go to the step you want and click the radio button next to the message. Modify the properties you want.
    Caution: If you hide a blocking message, the step will not be displayed. Users will not understand why the wizard has stopped.

Example documentation icon EN.png  In the Install/Move Equipment wizard:

  • No equipment is selected --> a blocking message, You must select at least one Equipment, and the [ FINISH ] button are displayed.
  • In the Location and Department step, no value is entered --> an alert is displayed, The status is required.

Fields: Type of field (Note: The way certain fields are displayed may depend on values entered in other fields):

  • Information: No action is authorized for the field which is defined as read-only.
  • Data entry (e.g. drop-down list, list of values, text field): The field must be specified before going on to the next step in the wizard. Note: You cannot modify the type of data entry field as this is defined by Logo - EasyVista.png.
  • Conditional: This displays the field only if a condition is satisfied. Note:
    • You cannot modify the display condition of the field as this is defined by Logo - EasyVista.png. The field is indicated by a message at the top of the Properties Window, A condition determines if the Field is visible or not.
    • A condition can be associated with information and data entry fields only.
  • Dynamic text: This displays standard text that can be replaced or completed.
  • Available: This displays a field with no processing, simply used to store a value in the database. Note: Click [ ADD FIELDS ] and select the field you want among those available. These are defined by Logo - EasyVista.png and as such, are non-modifiable.
  • List of values/drop-down list: This displays a field linked to an SQL query used to return values from the database. Note: You cannot create a new SQL query but you can modify the existing ones by clicking [  OVERLOAD THE QUERY OF... ].

Example documentation icon EN.png  In the Install/Move Equipment wizard:

  • Conditional field: The Keep current Users of equipment related to selected equipment checkbox is displayed only if the equipment selected has related equipment.
  • Drop-down list: The Status field is specified using a list that displays the statuses available for equipment.

Tables: Grid fields used to display summarized information in a table and enter information. Note

  • You cannot add or delete columns in the table but you can modify their properties.
  • To hide a column, change the value of the Visible property to No.
  • To authorize data entry in the table, change the value of the Read Only property to No.
  • Certain columns may be linked to a display condition that is defined by Logo - EasyVista.png and as such, non-modifiable.

Example documentation icon EN.png  In the Install/Move Equipment wizard: The Summary step displays a table summarizing all equipment to be moved or installed with the asset tag, category, model and serial number in columns.
          --> Users can enter the serial number of each item of equipment directly in the table.

Email: All fields displayed in the steps for sending an email: 

  • From, To, Cc: Email sender and recipients.
  • Subject: Subject of the message.
  • Text: Body of the message (Note: The default text is defined by Logo - EasyVista.png and can only be modified in execute mode by the user).
  • Image: This displays the Plus icon.png and Minus icon.png icons for adding and deleting file attachments.
  • Grid: This displays the list of files attached to the email.
  • Send Email: This displays the Send Email checkbox.

Notes

  • You cannot add or delete the fields proposed in steps for sending an email. These are defined by Logo - EasyVista.png.
  • To hide a field, change the value of the Visible property to No
  • The step for sending an email may be linked to a display condition that is defined by Logo - EasyVista.png and as such, non-modifiable.

Example documentation icon EN.png  In the Install/Move Equipment wizard: The step for sending an email is displayed only if a recipient was specified in the first step.

Object properties

         Wizard - Properties.png

Menu access: Go to the step you want and click the radio button next to the object.

Note: All of the object properties that can be used by a wizard are listed below. The properties to be specified will depend on the type of object selected.

Alignment (Note: Only for Grid objects): Used to define the horizontal alignment of table cells, e.g. left, center or right.

Change the Text (Note: Only for Dynamic Text objects): Used to indicate if standard text defined by Logo - EasyVista.png can be modified.

  • No: Non-modifiable standard text.
  • Replace the Default Value: Standard text will be replaced with the text entered.
  • Add Text before the default Value: The text entered will be added before standard text.
  • Add Text after the default Value: The text entered will be added after standard text.

The type of text entered can be as follows:

  • String without Translation: The text displayed is the one entered.
  • Translated String: The text is displayed in the user's language. (Note: Remember to click Multilingual labels icon.png to translate the text into different languages).

Example documentation icon EN.png  Standard text = The equipment will be moved.
                Add Text before the default Value = Caution!
       --> Text displayed in the wizard = Caution! The equipment will be moved.

Comment: Infotip displayed when users move the cursor over the field name.

WYSIWYG Component (Note: Only for Text fields in the step for sending an email): Used to indicate if users can access the text editor by clicking Switch wysiwyg icon.png (XML Value option or Yes) or if users can enter text only by entering HTML code (No).

Try to load value from the database (Note: Only for available fields): Used to indicate if the value to be displayed by default in execute mode is the one saved in the database (Yes) or if it is the one defined in the available field's properties (No). In the latter case, you should specify the Value field.

Example documentation icon EN.png  In the Install/Move Equipment wizard: The Serial Number available field is added. It is a Text field used to display the serial number of the equipment to be installed. 

     ==> The default value: 123456:

  • Yes: Displays the Serial Number field with the value stored in the database.
  • No: Displays the Serial Number field with the default value 123456.

Example documentation icon EN.png  In the Install/Move Equipment wizard: The Serial Number available field is added. It is a Query field used to display a drop-down list containing all asset tags whose serial number is specified. 

==> The default value:

SELECT am_asset.asset_tag
FROM   am_asset
WHERE  am_asset.serial_number IS NOT NULL  
  • Yes: Displays the Serial Number field with the drop-down list.
  • No: Displays the Serial Number field with an empty data entry field, without any drop-down list.

Number 0 is allowed (Note: Only for an Integer available field): Used to indicate if users can enter 0 (null value).

Read Only: Used to indicate whether the field can be modified in execute mode (No) or not (Yes).

Column Label (Note: Only for Grid objects): Names of the table columns.

  • Columns whose display is conditional are identified by star.
  • If you do not enter a name, the column will be displayed without a column header. If you do not want to display the column, change the value of the Visible property to No.

Maximum Length of String (Note: Only for a Memo available field): Maximum size of the Memo text field.

Enter a Default Value (Note: Only if the field is declared Visible): Used to indicate whether the default value is proposed to users (Yes) or not (No). In the first case, you should select it in the Value field. The authorized default values vary depending on the type of field. They are defined by Logo - EasyVista.png and as such, are non-modifiable.

  • Checkbox: False (box is not checked) or True (box is checked).
  • Date: Current date or a date entered using the calendar.
  • List of values (e.g. Department): Values in the list, e.g. Export/Direct Sales.
  • Drop-down list (e.g. Status): Values defined in the reference table, e.g. In Stock.
  • Email field (e.g. sender, recipient, etc.): A default value is defined by Logo - EasyVista.png but it can be modified:
    • Replace the Default Value: Standard text will be replaced with the text entered.
    • Add Text before the default Value: The text entered will be added before standard text.
    • Add Text after the default Value: The text entered will be added after standard text.

The type of text entered can be as follows:

  • String without Translation: The text displayed is the one entered.
  • Translated String: The text is displayed in the user's language. (Note: Remember to click Multilingual labels icon.png to translate the text into different languages).
  • Numeric: A numeric value is inserted instead of text.
  • Line: A line is inserted instead of text.
  • Space: A space is inserted instead of text.
  • Null: A null value is inserted instead of text.

Example documentation icon EN.png  Standard text = The equipment will be moved.
                Add Text before the default Value = Caution!
       --> Default value = Caution! The equipment will be moved.

Signed Number (Note: Only for an Integer available field): Used to indicate whether users are allowed to enter a plus add or minus delete operator before the numeric value (Yes) or not (No).

Required: Used to indicate, in execute mode, if the field is mandatory (Yes) or optional (No).

  • A message will appear if users do not enter data in the mandatory field. You can configure the message by clicking [ TITLES OF BUTTONS AND WARNING MESSAGES ].
  • You cannot change a default mandatory field defined by Logo - EasyVista.png to an optional field.

Alone on line: Used to indicate if a field is unique for the line (Yes) or if it can be placed next to another field on the same line (No).

Displayed Text (Note: Only for blocking messages): Message text that prevents a step from being run and stops the wizard. You can insert HTML tags to format the text.

Type (Note: Only for available fields): Type of available field that affects the appearance and size of the data entry field in execute mode as well as how data is entered, e.g. drop-down list, tree or free text field.

  • Text: Displays an alphanumeric field of limited size.
  • Memo: Displays an alphanumeric field of unlimited size that provides access to the text editor via Switch wysiwyg icon.png. HTML instructions can also be inserted.
  • Integer: Displays a numeric field without decimals.
  • Number: Displays a numeric field that can have decimals.
  • Checkbox: Displays a checkbox.
  • List of Values: Displays a drop-down list of different types of values (Note: If you select the Translated String option, remember to click Multilingual labels icon.png to translate the text into different languages):
    • [ ADD ROW]: Adds a value to the list. You should specify the type and enter the value.
    • [ ADD COLUMN]: Adds a second column to the list. The first indicates the value stored in the database and the second contains the value displayed by the wizard.
  • Query: Displays a drop-down list containing the results of an SQL query.
    • To display the results of the SQL query, select Yes in the Try to load Value from the Database field.
    • Enter the query in the Value field displayed below as follows:
SELECT key_name,value_name
FROM   table__name
WHERE  filter_condition

Visible: Used to define whether or not a field is displayed in execute mode:

  • Yes: The field is displayed.
  • No (Hidden Field Value): The field is hidden but you can automatically assign a value among those proposed in Hidden Field Value (defined by Logo - EasyVista.png and as such, non-modifiable).
    • If you do not select any value, the field will have a null value.
    • For Date fields, the value can be the current date or a date specified using the calendar.
  • No (Leave current Wizard behavior unchanged): The field is hidden and it keeps its current value.

Procedure: How to configure a wizard

1. In the Actions drop-down list of a form or list, open the wizard you want to configure and click Edit icon.png. The first step of the wizard will appear.

Note: To configure a specific step in the wizard:

  • Open the wizard and click [ NEXT ] to proceed until you reach the step you want to configure.
  • Click Edit icon.png and then click [ EDIT THE CURRENT PAGE ].

2. Modify the names of the action buttons used in the wizard.

  • In the first page of the wizard, define the default names for all of the buttons and the default titles for all of the steps.
  • To modify the name of a button for a specific step in the wizard:
    • Go to the step you want.
    • Click [ TITLES OF BUTTONS AND WARNING MESSAGES ].
    • Enter the name of the step and click [ SAVE PROPERTIES ].

3. Click [ NEXT ] to proceed through the wizard and make the required modifications.

  • You can modify the title of the step. Note: You enter the default title in the first page of the wizard.
  • To modify the properties of an object:
    • Click the radio button next to it.
    • Specify its properties and click [ SAVE PROPERTIES ].
      If the field is associated with a list of values or a drop-down list, you can modify the default SQL query used to build the list.
      • Click [ OVERLOAD THE QUERY OF THE LIST ] for a list of values or [ OVERLOAD THE QUERY OF THE COMBO ] for a drop-down list.
      • Make the required modifications in the data entry fields (Note: Instructions that appear in blue cannot be modified).
      • Click [ CONFIRM QUERY ] and then click [ SAVE PROPERTIES ].
      • If you want to modify the SQL query again, open the Properties Window for the field and click [  OVERLOAD THE QUERY OF... ].
      • To return to the default SQL query, open the Properties Window for the field and click [ RETURN TO THE INITIAL QUERY... ].
  • To modify a message:
    • Click [ TITLES OF BUTTONS AND WARNING MESSAGES ].
    • Modify the name and click [ SAVE PROPERTIES ].
  • To modify the order of the fields:
    • Select the box next to the field to be moved.
    • Click Insert Here next to the field above which you want to move the selected field.
  • To add an available field:
    • Click [ ADD FIELDS ] and then click Plus icon.png.
    • Select the field you want and specify its name.
    • Click the radio button in the Proprieties column.
    • Specify the properties for the new field and click [ SAVE PROPERTIES ].
    • Repeat the procedure for adding other available fields and click [ SAVE PROPERTIES ].
      Note: The Number of Fields added message will appear on the page when one or more fields have been added. Click [ ADD FIELDS ] to display the list.

4. In the last step, you can modify the name of the wizard that will appear in the Actions drop-down list.

5. Click [ FINISH ].

6. Check the workability of your modifications by running the wizard.

Tags:
Last modified by Unknown User on 2018/05/31 19:24
Created by Administrator XWiki on 2013/03/25 18:22

Shortcuts

Recent Updates

Haven't been here in a while? Here's what changed recently:

-   Product name - ev itsm.png
-   Product name - ev sas.png

Interesting Content

How to Automate Integration
Add a Shortcut to an App
History
Quick Dashboard
Full text search - Stop Words

Powered by XWiki ©, EasyVista 2018