Wizards - The editor


Definition

Wizards enable you to perform business processes using predefined tasks. They are used to perform predefined actions that update the database.

Depending on the context, you can run wizards on selected records in List mode to update all of them, or on a single record in a form.

EndDefinition
  • Wizards are built around a parent query that accesses a set of standardized data from the database.
  • Their functioning is defined by EasyVista. It cannot be modified.
  • You can adapt them based on customer requirements.
    • Adapt the appearance: Rename a field, hide a column in the grid, modify the display order of fields in a step, etc.
    • Adapt the structure: Make an item of information mandatory, add an available field, etc.
  • When you switch to edit mode, you can access all of the steps in the wizard, including those that are not displayed in execute mode, e.g. error dialog box. You can also access fields that are conditionally displayed.
     

Wizard structure

  • Wizards can contain different types of steps, e.g. display of blocking messages, data entry in fields, summary, sending of an email, etc.
  • They can use different types of objects (fields, messages, grids, action buttons) whose properties can be modified to define their appearance and behavior on screen.

Examples

  • List of wizards: Employee Departure, Delivery Reception, Link to a Problem
  • Install/Move wizard available in the Equipment list and form:
    • Run the wizard in the drop-down list found in the top banner.
               Example - Wizards list.png
    • Click Circle Edit icon.png to configure the wizard.
               Example - Wizard.png
      • 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.
      • 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 on screen.
      • Step 3: Display the list of equipment to be moved or installed ==>  Configure the equipment grid, e.g. column labels, alignment, etc.
      • Step 4: Display the confirmation email sent to the user ==> Configure the message, the recipient, etc.

Notes

  • Wizards are created by EasyVista. You cannot add new ones. 
  • Only user profiles authorized to edit display presentations can configure a wizard. Open url.png See User Profiles > Edit rights and display rights.
  • The configuration that you are authorized to modify depends on the wizard.
  • You can add the AVAILABLE_FIELD fields and other E_ fields from the main table of the parent query in certain steps of the wizard.
    • Fields are displayed using their physical name.
    • If their alias (or logical name) is specified, then it will be displayed. Click Multilingual labels icon.png to enter the name in different languages.

      example  

      • Physical name: AVAILABLE_FIELD_1; Alias: Available Field 1
      • Physical name: E_LAST_DATE_UPDATE
  • The first step of a wizard in edit mode is always hidden in execute mode.
    • It is used to configure the default values of action buttons that will be propagated to all of the steps in the wizard.
    • You can overwrite the default value and define a specific one in each step if required.

Caution

  • Modifications made to the properties of an object will not be saved automatically. Remember to click Save Properties before you move on to another operation.
  • The titles of wizards are not unique.

    example  Two wizards have the same title, Link to a contract

    • Wizard in the Licenses window: ATTACH CONTRACT TO LICENSES
    • Wizard in the Equipment window: ATTACH CONTRACT TO EQUIPMENT

Best Practice

  • To ensure that you configure the correct wizard, you should run it in the relevant context of use and then click Circle Edit icon.png to switch to edit mode.
  • To modify only the title of the wizard, switch to edit mode. Click Next and then click Finish. The page where you can modify the wizard title will appear.
  • To configure a precise step in a wizard, display it before switching to edit mode. Click Edit the Current Page. The step will appear.
  • To display text in the user language, click Multilingual labels icon.png in each object to enter the text in different languages.
  • If you do not want to display a step when running the wizard, you should hide all of the objects it uses.

Characteristics specific to versions 2016 and earlier

The configuration of wizards in versions 2016 and earlier is different.

  • Edit rights are assigned to each user profile in the module associated with the menu item using the wizard. Open url.png See User Profiles.
  • Users can enter their comments on the wizard. Open url.png See the description.

Access

  • Circle Edit icon.png in a window displaying a wizard
  • Select Administration > Parameters > Wizards in the menu

Screen description

         Wizard studio.png

Title bar: In the first step, the bar contains the title of the wizard. In subsequent steps, the bar contains the title of the current step.

Multilingual labels icon.png: Used to enter the title in different languages.

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

Properties: Properties specific to the selected object, displayed when you click the radio button next to each object.

    Open url.png See:

Object types in wizards

Object Description Notes Configurable properties
Titles
  • Title of the wizard: Name displayed in the drop-down list of wizards found in the top banner of each screen.
  • Title of steps: Name displayed in the title bar of the wizard in each step.
  • The title of the wizard is configured in the last page of the wizard.
  • A default title for each step is defined in the first page of the wizard. It is applied to all of the steps in the wizard.
  • You can overwrite the default value and define a specific one in each step. Open url.png See the procedure.

    example

    • Default title for all steps: Move Equipment
    • In step 2, you replace the title with User Definition.
Messages Different types of messages are displayed in each step of the wizard.
  • Information or warning messages: The message is displayed with action buttons that users can click to correct the error or continue running the wizard.

    example Install/Move wizard

    • No value is specified in the Location and Department step ==> Warning message: The Field Status is required
  • Blocking messages: The message is displayed with an action button that users can click to stop running the wizard.

    example Install/Move wizard

    • No equipment is selected ==> Blocking message: You must select at least one Equipment displayed with a single action button Finish
  • Messages are defined by EasyVista. You cannot add new ones.
  • The action buttons displayed will depend on the type of message.
  • You can hide a message.
  • Caution: If you hide a blocking message, the step will not be displayed and users will not understand why the wizard was interrupted.
  • You can modify the names of messages and properties in each step. Open url.png See the procedure.
Action buttons Action buttons are present in steps that display messages. They depend on the type of message.
  • A default label is defined in the first page of the wizard for each action button in the wizard. It is applied to all of the steps in the wizard.
  • You can modify the labels of action buttons in each step. Open url.png See the procedure.

    example

    • Default label of the action button Finish: Applied to all steps
    • In step 3, you replace the label with Stop.
Fields Different types of fields are displayed in each step of the wizard. Their display in the wizard depends on their type.
  • Data entry fields: Data entry field, e.g. drop-down list, list of values, text field, that users must complete before going on to the next step in the wizard.
  • Information fields: Read-only information.
  • Available fields: Field displayed based on its type in the database, e.g. text, number, list of values, etc.
  • Lists of values/drop-down lists: List of values that can be extracted from the database using a predefined SQL query.
    example Install/Move wizard: The Status field proposes a drop-down list with all of the equipment statuses available in the database
  • Dynamic text: Default text that can be completed or replaced dynamically in execute mode in the wizard.
  • Information fields and data entry fields:
    • They may be linked to display conditions defined by EasyVista. You cannot add new ones.
    • Fields with display conditions are indicated by the following message, A condition determines if the Field is visible or not. This message will appear at the top of the properties window.
example Install/Move wizard: The Keep current Users of equipment related to selected equipment checkbox is displayed only if the selected equipment has related equipment.
  • Available fields:
    • You can add fields only in certain steps.
    • All AVAILABLE_FIELD fields and other E_ fields from the main table of the parent query can be added.
  • Dynamic text: Default text is defined by EasyVista.
  • The configurable properties depend on the type of field.
  • You can modify the labels of fields and properties in each step.
  • You can customize dynamic text using the Change the Text property.
Grids Grids or tables are used to display a summary of the operations performed by the wizard and offer the possibility of entering information.

example Install/Move wizard

  • The Summary step displays a table summarizing all equipment to be moved or installed.
  • Users can enter the serial number of equipment in the table.
  • Display conditions can apply to columns. These conditions are defined by EasyVista. You cannot modify them.
  • Columns in the table are defined by EasyVista. You cannot add new ones.
  • Modification of column properties, e.g. display, input authorized.
Emails Wizards can display a Send Email step that contains a number of fields.
  • From, To, Cc: Email sender and recipients.
  • Subject: Subject of the message.
  • Text: Body of the message.
  • Image: Click Plus icon.png or Minus icon.png to add or delete file attachments.
  • Grid: Used to display the list of files attached to the email.
  • Send Email: Used to display a checkbox that indicates, in execute mode, whether or not an email should be sent.

example Install/Move wizard

  • The Summary step displays a table summarizing all equipment to be moved or installed.
  • Users can enter the serial number of equipment in the table.
  • The text in the message body is defined by EasyVista. You can modify it only in execute mode in the wizard.
  • Display conditions may apply to a Send Email step. These conditions are defined by EasyVista. You cannot modify them.
  • The fields displayed in a Send Email step are defined by EasyVista. You cannot add new ones.
  • Fields displayed in the Send Email step

Object properties

Property Object Description Notes
Alignment Grid Type of alignment used for the contents of columns in a table, i.e. left, centered, right
Change the Text Dynamic Text Used to customize the default value of a dynamic field when running the wizard.
  • No: The default value is displayed.
  • Replace the Default Value: Enter the text that will replace the default value in the Displayed Text field.
  • Add Text before the default Value: Enter the text that must be inserted before the default value in the Displayed Text field.
  • Add Text after the default Value: Enter the text that must be inserted after the default value in the Displayed Text field.

example

  • Default value = The equipment will be moved.
  • Select the Add Text before the default Value option.
  • Enter the text in the Displayed Text field = Caution!

    ==> Text displayed in the wizard = Caution! The equipment will be moved.

  • The default value of a dynamic field is defined by EasyVista.
    Best Practice icon.png Switch to execute mode to display the default value.
  • If you complete or replace the dynamic text, it will be updated when the wizard is run.
  • You can choose whether to translate the additional text or replacement text into different languages (Translated String option) or not (String without Translation option). If it is translated, it will appear in the logged-in user's language.

    Caution: If you select the Translated String option, you must translate the text into different languages.

Sort Column Grid Number of the table column to be sorted.
Comment All types of fields Content of the infotip displayed when users move the cursor over the field name.
WYSIWYG Component Email - Text field Used to define the behavior of the text field.
  • XML Value: The text field displayed depends on the default configuration.
  • Yes: A toolbar is added to the text field to format the text in WYSIWYG mode.
  • No: The toolbar is not displayed. You can only format the text by inserting HTML tags.

    Property - Wysiwyg text.png

  • The default configuration is defined by EasyVista.
  • Text fields cannot be edited in the wizards below because their content is inherited from mail templates.
    • Send Email to Requestor (HD - Send Mail to Requestor from Action or Request)
    • Notify Support Person (WF - Recovery Support)
    • Transfer (HD - Transfer Incident)
Try to load Value from the Database Available field Used to indicate the value to be displayed in an available field.
  • Yes: The value displayed is the value of the available field saved in the database.
  • No: The contents of the available field are based on the properties of the available field. The Type field is used to indicate the type of field, e.g. number, text, query, and the Value field is used to specify the field contents.

example Available field is Serial number; type of field is Text

  • Value in the database = CVC- 1948CK
  • Value defined in the properties of the available field = 12089A
  • Option selected:
    • Yes: The Serial number field will display CVC- 1948CK.
    • No: The Serial number field will display 12089A.

example Available field is Serial number; type of field is Query

  • Define the SQL query: SELECT am_asset.asset_tag FROM am_asset WHERE am_asset.serial_number IS NOT NULL  
  • Option selected:
    • Yes: The Serial number field will display a drop-down list containing values extracted from the database using the SQL query.
    • No: The Serial number field will display an empty data entry field, without any drop-down list.
Number 0 is allowed Available field - Integer Used to indicate if users can enter 0.
  • Yes: The value entered can be equal to 0 if users want to enter a null value.
  • No: The value entered cannot be equal to 0.
Read Only All types of fields Used to indicate if the field can be modified when running the wizard.
  • Yes: The field is modifiable.
  • No: The field is read-only.
Column Label Grid Names of the table columns.
  • Columns whose display is conditional are identified by (*).
  • If there is no name, the column will be displayed without a column header.
Best Practice icon.png Change the value of the Display property to No to hide the column.
Maximum Length of String Available field - Memo Maximum size of the Memo text field.
Overwrite the Default Value Display field Used to indicate if a default value is proposed to users.
  • Yes: The default value is proposed.
    • Specify it in the Value field that appears.
    • The types of default values depend on the type of field.
  • No: No default value is proposed.
Types of default values
  • Checkbox: The default value is a checkbox. Indicate whether it should be checked (True) or not (False).
  • Date: The default value is a date. Indicate if this is the current date or a date entered using the calendar.
  • List of values: The default value is a list of values from a Tree field.

    example Department, Equipment type

  • Drop-down list: The default value is a list of values from a reference table.

    example List of values from the Status table

  • Text (body) of an email:
    • The default value proposed is standard text defined by EasyVista.
    • You can replace it using the Replace the Default Value option or complete it with the Add Text before the default Value option or the Add Text after the default Value option. Open url.png See the Change the Text property.
    • You can choose whether to translate the additional text or replacement text into different languages (Translated String option) or not (String without Translation option). If it is translated, it will appear in the logged-in user's language.

      Caution: If you select the Translated String option, you must translate the text into different languages.

  • The types of default values are defined by EasyVista. You cannot add new ones.
Best Practice icon.png Text (body) of an email
  • Switch to execute mode to display the default value.
  • To hide the text in the field when running the wizard, select the Replace the Default Value option and replace the default value with a line, space or null value.
Signed Number Available field - Integer Used to indicate whether users are allowed to enter a plus (+) or minus (-) operator before the numeric value.
  • Yes: Users can enter an operator before the numeric value.
  • No: No operator can be entered.
Is Required All Used to indicate if a value must be entered for the field.
  • Yes: A value is mandatory.
  • No: A value is optional.
  • You can configure the information message that will appear when a mandatory field is left empty.
  • You cannot change a field that is mandatory by default into an optional field.
Alone on line All Used to indicate the display mode of a field in a row.
  • Yes: The field must be displayed alone in the row.
  • No: The field can be adjacent to another field in the same row.
Displayed Text Blocking message Text of the message that stops the running of the wizard.
  • You can format it using HTML tags.
Sort Grid Sort order of the table, i.e. ascending or descending.
Type Available field Used to indicate the type of data entry field.
  • Text: Displays an alphanumeric field of limited size.
  • Memo: Displays an alphanumeric field of unlimited size, with access to an editor for formatting text.
  • Integer: Displays a numeric field without decimals.
  • Number: Displays a numeric field that can contain decimals.
  • Checkbox: Displays a checkbox.
  • List of values: Displays a drop-down list of values.
    • The list can be built using a default SQL query that is modifiable.
    • It can contain different types of values.
    • It can display the value stored in the database and the one displayed in the wizard.
  • Query: Displays a drop-down list containing the results of an SQL query.
Best Practice icon.png To display the list of values in a Query field:
  • Select Yes in the Try to load Value from the Database field.
  • Enter the query in the Value field displayed, as shown below.
    SELECT key_name,value_name
    FROM table__name
    WHERE filter_condition
Display All Used to indicate whether the field is displayed or hidden when running the wizard.
  • Yes: The field is displayed.
  • No: The field is hidden.
  • You can attribute a value to a hidden field.
    • No (value of the hidden field): The value selected in the Hidden Field Value field is attributed to the hidden field.

      Caution: If no value is selected, the hidden field will contain a null value.

    • No (Leave current Wizard behavior unchanged): The hidden field will keep its current value.
  • For hidden Date fields, the value can be the current date or a date specified using the calendar.

Procedure: How to configure a wizard

Step 1: Open the wizard studio.

1. Run the wizard you want to configure.

2. Click Circle Edit icon.png.

  • The wizard studio will appear.
  • The first step will appear.

Best Practice icon.png  To configure a specific step of the wizard:

  • Run the wizard.
  • Click Next to proceed until you reach the step you want to configure.
  • Click Circle Edit icon.png.
  • Click Edit the Current Page.

Step 2: Customize the wizard.

1. In the first page of the wizard, specify the default values of the step titles and action button labels that will be applied to all of the steps in the wizard.

2. If you want to enter a specific step title or specific action button label, this text must not be identical to the default value.

  • Click Next to go to the step you want.
  • Click Titles of Buttons and Warning Messages.
  • Enter the specific title for the step.
    Click Save Properties.

3. Specify the properties of objects.

  • Click Save Properties.
     

Build a list of values or a drop-down list using an SQL query

  • Click Override the List Query for a list of values or Override the Combo Query for a drop-down list.
    An input wizard that helps you define the SQL query will appear. Instructions that appear in blue cannot be modified.
  • Define the SQL query as shown below.
    • Caution: The WHERE and GROUP BY clauses are mandatory.
    • The list of fields will automatically appear. Add available fields and other E_ fields as required.
    • The name of the main table in the parent query will automatically appear. Add the required joins.
SELECT <Field1, Field2, ...>
FROM <TableName>
WHERE <Clause>
GROUP BY <Clause>
  • Click Confirm Query and then click Save Properties.
  • Note:
    • If you want to modify the query again, click Edit the overloaded Query of the List/Combo.
    • To reset the query to its default value, click Return to the Initial Query of the List/Combo.
       

Modify a message

  • Click Titles of Buttons and Warning Messages.
  • Modify the text of the message.
  • Click Save Properties.
     

Add an available field

  • Click Add Fields.
  • Click Plus icon.png.
    All AVAILABLE_FIELD fields and other E_ fields from the main table of the parent query will appear.  
  • Select the field.
  • Enter its name.
  • Click the radio button in the Proprieties column.
  • Specify the properties of the new field.
  • Click Save Properties.
    The Number of Fields added message will appear in the page.
     

Modify the display order of 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.
     

4. Modify the title of the wizard displayed in the drop-down list found in the top banner.

  • Go to the last step of the wizard.
  • Modify the title of the wizard.
     

Step 3: Save and check the workability of the wizard.

1. Click Finish.

2. Run the wizard.

3. Check that the configuration you defined is correctly propagated in the wizard.

Tags:
Last modified by Unknown User on 2021/03/25 14:34
Created by Administrator XWiki on 2013/03/25 18:22

Shortcuts

Powered by XWiki ©, EasyVista 2021