Metis Smart Modeling - Masks

Description of the different functionalities and their impact on the other windows/menus of Metis.

| Throughout this section, an example will be used as a base for presenting all the function linked to the creation of a mask. Though it will be quite simple, it will cover all different type of objects and functionalities which can be used in this part of Metis Smart Modeling. As masks are used only in conjunction with models, the example will also make links to the creation of the underlying model.

Link to Metis Smart Quote

When planning the design of a mask, or simply creating one, it is very important to consider the equipment used in throughout the organization. The most relevant aspect is the screen size of the machine used. Each screen has its own maximum resolution. For example, the sizes most commonly found nowadays are either 1280 x 800 or 1378 x 768. This means that the average width of the screens is around 1300. This should be taken into account when defining the width of the mask. It doesn't means that the designer building the masks will have to make calculation to check whether the mask will fit on the most common screens but that he should pay attention its own screen size, so that if his is above average, he keeps in mind that his users will have smaller screens.

In the “Modeling” menu, make sure to select the “Masks” sub-menu.

Click on “Add" [[File:MetisSmartModelingAddButton.PNG|link=]].

This opens a window asking which type of mask to create, a selection can done between a "simple" mask and a Group of masks. Select “Mask,” and confirm.

A mask designer window opens and the first settings can be provided.

A pop-up window also opens in which the name of the mask must be defined.

Enter in a name for the new mask; for example, name it “S-Basic Properties.”  

Confirm to save the new mask.

The new mask is shown in the list.

| <mediaplayer width='400' height='300'>File:Creating_a_mask_OK.mp4‎</mediaplayer>

The selection of an object from the list is done by enabling the check-box on the left hand side of the line describing the object. This will also highlight he object on the design board. This ensure the user that the proper object is selected in order to apply modifications or to delete it.

For mask with many input fields, it is possible to define the order in which the users will go through them using the order shown in the list of objects. This will not only set the navigation order when using the keyboard TAB key, but also the display order of for overlaying the object. If not set, the object reversed insertion order will be applied (last one first). In order to move an object in the list, select it and use the up and down pointing arrows on the right of the object list.

* '''Properties''' :  

Common TAB to all objects which can be used in masks created in Metis Smart Modeling. Please refer to the various object type sections for detailed information on the properties which can be configured.

* '''Activation''' :  

For all objects an activation rule can be defined in order for the object to enabled or disabled based on the setting of another object. This functionality is simply used by selecting "Like object" and selecting the correct object from the drop-down list. For example if an input field is disabled based on a specific setting, the accompanying title field should also be disabled. Thus the latest can inherit the disabled setting from the first one.

* '''Caption''' :

For objects like 'titles' and 'check-boxes', this TAB allows to set the caption (text) to be displayed in the object. In order to set this text, click on the text button next to the field and a new windows will open. It allows to provide a text in all available languages and will display it in the mask in Metis Smart Quotes.

The following table describes the buttons are to be used in order to work with a mask, manage events and format, add new objects and align them:

|style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | To save the edits that may have been made and exit

|style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | To cancel the edits that may have been made and exit

|style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | To insert a [[#Rectangles|Rectangle]] object

|style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | To insert a [[#Circles|Circle]] object

|style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | To insert a [[#Lines|Line]] object

|style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | To set an identical width to the selected objects as the first one.

|style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | To set an identical height to the selected objects as the first one.

|style="border-style: solid; border-color: grey; border-width: 0 0 0 0" | To define "display" rule between objects.

| <mediaplayer width='400' height='300'>File:Inserting_a_picture_in_a_mask_OK.mp4‎</mediaplayer>

|style="border-style: solid; border-color: grey; border-width: 0 0 0 0" | This property allows to set the image to be inserted in the field. The list of available images in definable through the functionality available in the "Data Management" section of QSM. Refer to this section in order to import new images in QSM.

| Use pictures in masks in order to better illustrate the data requested in order to configure a specific system or model.

The graphic can be resized by clicking and holding on the sides or corners.

| <mediaplayer width='400' height='300'>File:Inserting_a_rectangle_OK.mp4</mediaplayer>

The graphic can be resized by clicking and holding on the sides or corners.

The graphic is resized as specified.

 

| <mediaplayer width='400' height='300'>File:OLE_Tag_Suppport_Video.mp4</mediaplayer>

| Inserting a line in a mask and working with its properties.

| From the properties table, when selecting a background or a border color, a pop window is displayed which shows a set of basic colors which can be applied. In the lower part of this window to buttons allow to browse through additional colors. The first ones shows the full color spectrum and allows to pinpoint the one required. The second one lists colors which are commonly used with their name.

This graphic can be resized by clicking and holding on the sides or corners.

To resize the width and the height, use the width and height fields. For example, set the width to 120 and the height to 50.

| <mediaplayer width='400' height='300'>File:OLE_Tag_Suppport_Video.mp4</mediaplayer>

Now click on the “Link” tab.  A link is made to an entry in order for Metis to use the inputted field value in a model.

For example, select “variables.” Search for a position, for example, "$Memory" is selected from the list. Click on confirm to continue.

| <mediaplayer width='400' height='300'>File:OLE_Tag_Suppport_Video.mp4</mediaplayer>

| Input fields can only be used to display enter input numerical values, as text cannot be used as input or output for rules.

Now click on the “Link” tab.  A link is made to an entry in order for Metis to use the inputted field value in a model.

| <mediaplayer width='400' height='300'>File:Inserting_a_dropdown_list_OK.mp4‎</mediaplayer>

The object can be resized by clicking and holding on the sides or corners.

Now click on the “Link” tab.  A link is made to an entry in order for Metis to use the inputted field value in a model.

For example, select “variables.” Search for a position, for example, “$SelectChoice.”

| <mediaplayer width='400' height='300'>File:Inserting_a_checkbox_in_a_mask_OK.mp4</mediaplayer>

| Values returned by a checkbox field can only be "0" and "1", as the checkbox is a boolean field.

This object can be resized by clicking and holding on the sides or corners.

Now click on the “Link” tab.  A link is made to an entry in order for Metis to use the inputted field value in a model.

| <mediaplayer width='400' height='300'>File:Inserting_a_radio_button_OK.mp4</mediaplayer>

| Limits and default configurations of all the systems included in the group will be used when executing the group in Metis Smart Quote.

* '''Comment''' (mandatory)

A description for the display rule, usually a name to identify the rule within the list.

* '''ID''' (automatic)

Internal identification number for the current rule.

* '''State'''  

State to be set for the selected fields if the condition defined within the rule is valid.

To create a display proceed as follows:

 

First make sure to be in the “Modeling” menu, then in the “Masks” sub-menu.

Click on the conditional display button.

A window opens with a list of rules which apply to current fields in the mask.

To create a new rule, click on the “Add” button.

The rule window opens.

In the comment field, name the rule. For example: “Router List.”

It is possible to select positions, variables and attributes.

Choose variables. Select a variable from the list and confirm to continue.

Now open Smart Quotes.  

 

| <mediaplayer width='400' height='300'>File:Activation Rule OK.mp4</mediaplayer>

| All display rules defined within a mask should be taken into account when defining the calculation rules to be executed within the model link to the mask. For example, if a check-box hides a list of options, the rules which will use the value selected in the list should first test if the check-box has been validated.

In the “Modeling” menu, make sure to select the “Masks” sub-menu. Select the Mask. Click on the "Delete" button [[File:MetisSmartModelingDeleteButton.PNG|link=]]. This opens a small window requesting to confirm the deletion of the selected mask. Once confirmed it will be definitively deleted and a model might not have any mask anymore. If this is the case, the model may not work anymore.  

| Extra care should be taken when deleting masks from Metis Smart Modeling, as entire models may be depending on it. Please verify the use of a mask before deleting it.  

In the “Modeling” menu, make sure to select the “Mask” sub-menu. Select the mask to be modified from the list. Click on the "Edit" button [[File:MetisSmartModelingEditButton.PNG|link=]]. The mask editor window opens up with the selected mask displayed in the design board. Please refer to the section above for information about editing a mask and using the available opbjects. Changes will be stored only when the window is validated. To do this, click on the confirmation button [[File:MetisSmartModelingOKButton.PNG|link=]].

A group of masks is a set of masks which could be related to the same subject, but which are presented in Metis Smart Quote under tabs which can be defined in Metis Smart Quote. The whole principle of group of masks is to setup this layout. Metis Smart Modelling allows to define the name and the content of the group, basically a group is an entity which then links to different masks, which will then make up the group. Each masks linked to the group is then named in order to setup the tabs. And define the definitive layout in Metis Smart Quote.

* '''Name''' (mandatory)

A name for the group of masks must be given.

* '''Comment'''

Remarks are intended for internal use only and will not be accessible in Metis Smart Quotes.

* '''Description'''

A description for the group of masks, usually a name, can be added in all of the active languages.

* '''Help file'''

A file with information about the masks contained in the group and the model can be linked to the group of masks. An icon will be displayed in Metis Smart Quotes in order for the user to view the file within the application.

A mask cannot live without being part of a model, refer to the [[Description_of_the_Sub-Menu_Models#Creating_a_new_model|section about creating and defining models]].