The Wizard 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.
- Click
to configure the wizard.
- 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.
- Run the wizard in the drop-down list found in the top banner.
Notes
- Wizards are created by EasyVista. You cannot add new ones.
- Only user profiles authorized to edit display presentations can configure a wizard.
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
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
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
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.
See User Profiles.
- Users can enter their comments on the wizard.
See the description.
Access
in a window displaying a wizard
- Select Administration > Parameters > Wizards in the menu
Editor description
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.
: Used to enter the title in different languages.
: 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.
See:
Object types in wizards
Object | Description | Notes | Configurable properties | ||
---|---|---|---|---|---|
Titles |
|
|
|
||
Messages | Different types of messages are displayed in each step of the wizard.
|
|
|
||
Action buttons | Action buttons are present in steps that display messages. They depend on the type of message. |
|
|
||
Fields | Different types of fields are displayed in each step of the wizard. Their display in the wizard depends on their type.
|
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.
|
|
||
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
|
|
|
||
Emails | Wizards can display a Send Email step that contains a number of fields.
example Install/Move wizard
|
|
|
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.
example
|
|
|||
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.
|
|
|||
Try to load Value from the Database | Available field | Used to indicate the value to be displayed in an available field.
example Available field is Serial number; type of field is Text
example Available field is Serial number; type of field is Query
|
||||
Number 0 is allowed | Available field - Integer | Used to indicate if users can enter 0.
|
||||
Read Only | All types of fields | Used to indicate if the field can be modified when running the wizard.
|
||||
Column Label | Grid | Names of the table columns. |
|
|||
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.
|
|
|||
Signed Number | Available field - Integer | Used to indicate whether users are allowed to enter a plus (+) or minus (-) operator before the numeric value.
|
||||
Is Required | All | Used to indicate if a value must be entered for the field.
|
|
|||
Alone on line | All | Used to indicate the display mode of a field in a row.
|
||||
Displayed Text | Blocking message | Text of the message that stops the running of the wizard. |
|
|||
Sort | Grid | Sort order of the table, i.e. ascending or descending. | ||||
Type | Available field | Used to indicate the type of data entry field.
|
||||
Display | All | Used to indicate whether the field is displayed or hidden when running the wizard.
|
|
Procedure and Wizards
How to configure a wizard
Step 1: Open the wizard studio.
1. Run the wizard you want to configure.
2. Click .
- The wizard studio will appear.
- The first step will appear.
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 Next to go to the step you want.
- Click the radio button next to the object.
- Specify its properties.
See Object types and List of properties.
- 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.
- 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
.
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.