Metis Smart Modeling - Models

A model is the building block of Metis. It allows the application to generate a list of material, service items and configure maintenance based on logic rules defined by the business.

Before explaining how to create and use models, it is necessary to explain how Metis Smart Quote works in order to provide the user with a fully featured offer. Establishing such an offer can be summarized through the following scheme.

When an offer is initiated in Metis Smart Quote, '''modeled positions''' are “calculated” based in the information provided in modeling [[Metis_Smart_Modeling_-_Masks|masks]]. These values represent the customer’s needs. Through the execution of the [[#Material|material]] model, the application creates a list of positions which basically represents the customer’s desired items and all of these products are listed in a structured way.

For example, in the case of a company selling computer [[Metis_Smart_Modeling_-_Systems|systems]], requirements will be provided in the modeling [[Metis_Smart_Modeling_-_Masks|masks]] and after calculation will result in a list of components like computers, servers and network appliances.

Based on the previous example, a secondary screen can be added for one or more calculated computers. Or, additional, none modeled network features can be added.

Once the customer required material and service positions defined through the models or manually, the '''global pricing''' of an offer can be calculated by Metis Smart Quote.

Now that the ground work of the model concept is laid down, it is necessary to understand a bit how such a model works in the Metis environment. As described in figure [[:File:Model_Exec_1.png|Model execution overview]], outside of the [[Metis_Smart_Modeling_-_Masks|masks]], a [[Metis_Smart_Modeling_-_Models|model]] is built on specific objects. Each model includes at least one “[[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]]”, which is a container for individual [[Metis_Smart_Modeling_-_Rules|rules]]. Those [[Metis_Smart_Modeling_-_Rules|rules]] are the logic part of the models. Each [[Metis_Smart_Modeling_-_Rules|rule]] uses input values ([[Metis_Smart_Modeling_-_Variables|variables]], [[Metis_Smart_Modeling_-_Attributes|attributes]], positions) coming from the [[Metis_Smart_Modeling_-_Masks|masks]], default or calculated information to process a logic “formula”. A [[Metis_Smart_Modeling_-_Group_of_Rules|Group of rules]] can include as many [[Metis_Smart_Modeling_-_Rules|rules]] as necessary, with the only constrain that the result of a given [[Metis_Smart_Modeling_-_Rules|rule]] will only be available in the next [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] in the process. As described in figure [[:File:Model_Exec_2.png|Group of rules execution overview]], a [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] feeds on input values which are instantiated before its execution. Once inside, all [[Metis_Smart_Modeling_-_Rules|rules]] will use those values to process the formulas. When all [[Metis_Smart_Modeling_-_Rules|rules]] are processed, the resulting [[Metis_Smart_Modeling_-_Variables|variables]] and/or material positions are prepared for the next [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]].Before starting the execution of the next [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]], the engine instantiates the new input values and lets the various [[Metis_Smart_Modeling_-_Rules|rules]] included in the group feed on them.  

The main concept behind this type of model is for the Metis Smart Quote user to be able to enter in a simple and graphic way his customer's requirements and then let the application generate the list of necessary positions. This type can be used in many different ways. For example, in the case of a business selling computer [[Metis_Smart_Modeling_-_Systems|systems]], a model can be created which will ask for basic configuration properties and then let the application calculate the various possibilities which may fulfill the customer’s need. The [[Metis_Smart_Modeling_-_Systems|system]] may then even pre-select the less expensive solution. The other possibility is to define a model which could basically be compared to a component catalog and let the user select the required items manually, but in a graphical environment.

* (Is Material Position)

Will return a Boolean value defining of the position being treated is a material position.

* (Is Service Position)

Will return a Boolean value defining of the position being treated is a service position.

* Cost Price

Will return the cost price of the position being treated.

* Gross Price

Will return the gross price (sales price before all discounts) of the position being treated.

* Net Sales Price

Will return the net sales price (sales price after all discounts) of the position being treated.

* Original Sales Price

Will return the original sales price (sales price as by default in the database) of the position being treated.

The main screen of the "Modeling" tab in Metis Smart Modeling displays the list of all the model available in the version. That list shows the name of the model, its version, type and creation date. On the left-hand side of the screen, it s possible to filter this list. It is possible to select what type of model to display, search by its name and select the models linked to a specific [[Metis_Smart_Modeling_-_Systems|system]].

== Creating a new model ==

To create a model, first make sure to be in the Modeling menu then in the Models sub-menu.

Click on the add button [[File:MetisSmartModelingAddButton.PNG|link=]]. The Model window opens.  

Select a model type, for example “MAT”. Provide a name for the model, for example “Entry-Level Desktop”, enter a version, for example “1.0”. Enter a description for each available language.

The tables below allow the user to define the two main parts of the model, those being the “[[Metis_Smart_Modeling_-_Masks|masks]]” and the “[[Metis_Smart_Modeling_-_Group_of_Rules|groups of rules]]”

For the [[Metis_Smart_Modeling_-_Masks|masks]] table, click on the add button.

A window opens where [[Metis_Smart_Modeling_-_Masks|masks]] and groups of [[Metis_Smart_Modeling_-_Masks|masks]] can be selected and linked to the model.

Select the desired [[Metis_Smart_Modeling_-_Masks|masks]], for example, “D-Basic Hardware” and “D-Peripherals” and then confirm to continue.

For the [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] table, click on the add button.

A window similar to the [[Metis_Smart_Modeling_-_Masks|masks]] window opens, but for [[Metis_Smart_Modeling_-_Group_of_Rules|groups of rules]].

Select the desired groups of [[Metis_Smart_Modeling_-_Rules|rules]] and confirm.

The green up and down arrows found above each table allow the user to modify the display order of the [[Metis_Smart_Modeling_-_Masks|masks]] as well as the execution order of the groups of [[Metis_Smart_Modeling_-_Rules|rules]].

* '''Description''' (mandatory) :

A description for the model, usually a name.

* '''Type''' ( mandatory) :

Each model requires to be typed. On this information will depend the moment the model is executed when used in Metis Smart Quotes.

* '''Versioning''' :

When updating a model based on an old one, this information is very useful to keep track of the different versions.

* '''[[Metis_Smart_Modeling_-_Masks|masks]]''' :

List of [[Metis_Smart_Modeling_-_Masks|masks]] used in this model. Once the model is linked to a [[Metis_Smart_Modeling_-_Systems|system]], the listed [[Metis_Smart_Modeling_-_Masks|mask]] will appear in Metis Smart Quotes when configuring the [[Metis_Smart_Modeling_-_Systems|system]] in the "Design" section.

* '''[[Metis_Smart_Modeling_-_Group_of_Rules|Group of rules]]''' :

List of [[Description_of_the_Sub-Menu_Group_of_Rules|groups of rules]] to be used when executing the model in Metis Smart Quotes. The order of the groups of [[Metis_Smart_Modeling_-_Rules|rules]] is very important for the model to generate concrete and valid results.

| A model service or material model doesn't have influence on a configuration without fully configured groups of [[Metis_Smart_Modeling_-_Rules|rules]] and in the case on material models [[Metis_Smart_Modeling_-_Masks|masks]].

== Deleting a model ==

A model can be deleted by using the "Delete" button on the main screen. When deleting a model from there, the [[Metis_Smart_Modeling_-_Masks|masks]] and [[Metis_Smart_Modeling_-_Group_of_Rules|groups of rules]] which were linked to it are not deleted. The reason for this is that those parts could be used in other models or re-used in a new one. This way only the binding object is removed from the application.

| Deleting a model only removes the "container" form the Metis Database, all [[Metis_Smart_Modeling_-_Masks|masks]] and groups of [[Metis_Smart_Modeling_-_Rules|rules]] which were linked to it will not be deleted!

To delete a model, first make sure to be in the Modeling menu then in the Models sub-menu.

Select the model to be deleted and click on the delete button[[File:MetisSmartModelingDeleteButton.PNG|link=]]. A confirmation window opens. Validated the question in order to remove the selected model from the Metis Database.

== Modifying a model ==

To edit an existing model, first make sure to be in the Modeling menu then in the Models sub-menu.

Select the model to be modified and click on the edit button [[File:MetisSmartModelingEditButton.PNG|link=]]. The Model window opens.  

Apply all necessary modifications based on the explanations available in the previous section about creating and defining a new model. Once done validate the windows to apply the changes.