Metis Smart Modeling - Variables

A variable is a symbolic name given to some quantity, for the purpose of allowing the name to be used independently of the information it represents. The scope of a variable is local to the model it is used in. On the other hand, its extend is limited to the Group of Rules its used as an input or output. The value linked to a variable may change during the execution of a model.

Limits : As object and filter for setting limits on systems.

Default Configuration : As object representing base configuration for systems.

'''Masks'''

Links : As target for values given to most field types which can be inserted in masks.

Dependencies : As conditions for field display in masks.

'''Rules'''

Filter : As conditions to execute a rule.

Rule : As input or output of the execution part of a rule.

Add-on : As additional output of a rule.

* '''Name''' (mandatory)

A description for the variable.

* '''Comment - Title'''

Title for the comment which can be given to a variable.

* '''Comment - Description'''

Description for the comment which can be given to a variable. This comment is very useful to better describe the variables.

| Variables can be defined within most part of the Metis Smart Modeling application where variable are used. This means that variables can be created as needed. Be careful not to generate redundancy or ignore the list when associating a variable with an object, a rule or a mask.

When used in a rule or model, it works the same way as a simple variable. The only difference is that the output of a rule (or add-on) cannot be applied on a group of items . The can only be used as input.

'''Masks'''

Dependencies : As conditions for field display in masks.

'''Rules'''

Filter : As conditions to execute a rule.

Rule : As input of the execution part of a rule.

The content of a group of items can be defined as a list of elements which will be added to determine the value stored in the group. Each element of the list can be either a position, a variable or a group of items. For each of those, a factor can be defined in order to multiply their value.

[[File:MetisSmartModelingSCVariables2.PNG|center|850x860px]]

* '''Name''' (mandatory)

A name for the group of items.

* '''Content''' (mandatory)

List which specifies the content of the group of items. It can contain either positions, variables or other group of items.

* '''Comment'''

A comment can be given to all group of items. Please refer to the description of variables for details.

Using the "test" [[File:MetisSmartModelingTestButton.PNG|link=]] button displayed on the main variable screen, it is possible to have an overview of the group of items. The functionality is intended to enable the user to analyze the content of on group. Fro example, if a group of items includes other groups, the test window will display dismantle the object down to individual variables and positions. This allows the user to validate the construction of any group of items created in Metis Smart Modeling. The list displayed in the window also show the factors defined on the elements included in the group.

[[File:MetisSmartModelingSCGroupOfRulesTest.PNG|center|850x860px]]

To create a variable in the “Modeling” menu, make sure that the “Variables” sub-menu has been selected.

Click on the “add” button [[File:MetisSmartModelingAddButton.PNG|link=]].

A small window opens with “variable” and “group of items” as the two create options.

Select “Variable” and confirm to continue.

This opens the “Variable” window.

In the “Name” field, enter a name for the variable. For example, “$SelectChoice.”

A title and description can also be entered to better describe the use of the variable.

Click on confirm. The new variable is now added to the list.

Now, to create a group of items, click once again on the “add” button.

This time, choose “Group of Items” and confirm.

In the “Name” field, enter for example, “$NB_Screens.”

Next, click on the “add” button. It is possible to add positions, variables or attributes.

Make sure that “positions” is selected at the top.

Tick the checkbox for the desired items and then click on confirm.

In the “modeling” menu, make sure to select the “variables” sub-menu. Select the variable or group of items to be edited. Modification of the object can be done through the use of the EDIT button [[File:MetisSmartModelingEditButton.PNG|link=]]. Please refer to the definition of variables and/or groups for further information on the various fields which can be setup.

{{Note| When a variable is renamed, it is still valid anywhere it is used (masks, systems and rules). Links are only broken when deleted!

== Deleting a variable and group of items” ==

In the “modeling” menu, make sure to select the “variables” sub-menu. Select the variable or group of items to be removed. Deletion of a variable can be done through the use of the DELETE button [[File:MetisSmartModelingDeleteButton.PNG|link=]]. When deleting a variable or a group of items, its reference in rules and/or mask will be lost. Thus it is very important to verify if the deleted object is used anywhere in a model.

| Deleted variables or groups will render the masks and rules to which they are linked unusable!

| In order to verify a rule or a group of rules for missing variables, use the "Validate" function available under to Group of rules" sub-menu. This functionality will display any errors appearing in the selected group of rules.