Metis Smart Modeling - Models
From Metis Documentation
Line 7: | Line 7: | ||
This section explains all parameters and techniques to build and maintain models, giving a full understanding of the possibilities behind this functionality. The following sections of this manual will present all aspects related to this task. They are structured based on the different elements required to create full featured models. | This section explains all parameters and techniques to build and maintain models, giving a full understanding of the possibilities behind this functionality. The following sections of this manual will present all aspects related to this task. They are structured based on the different elements required to create full featured models. | ||
- | The current section describes how a model works and how one can create and maintain it. Based on that information, the following sections describe model building blocks like rules, groups of rules, variables and masks. For consistency purposes, all aspects of the creation of models are based on a full featured example. | + | The current section describes how a model works and how one can create and maintain it. Based on that information, the following sections describe model building blocks like rules, groups of rules, variables and [[Metis_Smart_Modeling_-_Masks|masks]]. For consistency purposes, all aspects of the creation of models are based on a full featured example. |
== How does a model work? == | == How does a model work? == | ||
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. | 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. | ||
[[Image:Model_Metis_SQ_Exec.png|thumb|upright=0.5|alt=Metis Smart Quote Execution Description|Metis Smart Quote Execution Description]] | [[Image:Model_Metis_SQ_Exec.png|thumb|upright=0.5|alt=Metis Smart Quote Execution Description|Metis Smart Quote Execution Description]] | ||
- | When an offer is initiated in Metis Smart Quote, '''modeled positions''' are “calculated” based in the information provided in modeling 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. | + | 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 masks and after calculation will result in a list of components like computers, servers and network appliances. | + | 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. |
All positions listed through the use of models will be in read only mode. Metis Smart Quote allows, however, editing the list by adding '''manual positions'''. All parameters related to them can be manually set, like quantity and [[Metis_Smart_Modeling_-_Attributes|attributes]]. | All positions listed through the use of models will be in read only mode. Metis Smart Quote allows, however, editing the list by adding '''manual positions'''. All parameters related to them can be manually set, like quantity and [[Metis_Smart_Modeling_-_Attributes|attributes]]. | ||
Line 30: | Line 30: | ||
On top of that, based on the overall offer, Metis allows to trigger so called Tax models which are executed at the very end of the process. These models can typically be used to '''add sales taxes to an offer''' (VAT or recycling). | On top of that, based on the overall offer, Metis allows to trigger so called Tax models which are executed at the very end of the process. These models can typically be used to '''add sales taxes to an offer''' (VAT or recycling). | ||
- | In Metis Smart Quote, models appear in different forms, based on their type. For [[#Material|material]] models, the linked masks will be displayed the application in the offer window when selecting the [[Metis_Smart_Modeling_-_Systems|system]]. | + | In Metis Smart Quote, models appear in different forms, based on their type. For [[#Material|material]] models, the linked [[Metis_Smart_Modeling_-_Masks|masks]] will be displayed the application in the offer window when selecting the [[Metis_Smart_Modeling_-_Systems|system]]. |
Line 38: | Line 38: | ||
- | 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 masks, a model is built on specific objects. Each model includes at least one “group of rules”, which is a container for individual rules. Those rules are the logic part of the models. Each rule uses input values ([[Metis_Smart_Modeling_-_Variables|variables]], [[Metis_Smart_Modeling_-_Attributes|attributes]], positions) coming from the masks, default or calculated information to process a logic “formula”. A Group of rule can include as many rules as necessary, with the only constrain that the result of a given rule will only be available in the next group of rules in the process. As described in figure [[:File:Model_Exec_2.png|Group of rules execution overview]], a Group of rules feeds on input values which are instantiated before its execution. Once inside, all rules will use those values to process the formulas. When all rules are processed, the resulting [[Metis_Smart_Modeling_-_Variables|variables]] and/or material positions are prepared for the next Group of rules.Before starting the execution of the next Group of rules, the engine instantiates the new input values and lets the various rules included in the group feed on them. | + | 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_-_Model|model]] is built on specific objects. Each model includes at least one “group of rules”, which is a container for individual rules. Those rules are the logic part of the models. Each 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 Group of rule can include as many rules as necessary, with the only constrain that the result of a given rule will only be available in the next group of rules in the process. As described in figure [[:File:Model_Exec_2.png|Group of rules execution overview]], a Group of rules feeds on input values which are instantiated before its execution. Once inside, all rules will use those values to process the formulas. When all rules are processed, the resulting [[Metis_Smart_Modeling_-_Variables|variables]] and/or material positions are prepared for the next Group of rules.Before starting the execution of the next Group of rules, the engine instantiates the new input values and lets the various rules included in the group feed on them. |
[[Image:IMG_BLANK.png|500x226px|link=]][[Image:Model_Exec_1.png|500x226px|link=]] [[Image:Model_Exec_2.png|500x226px|link=]] | [[Image:IMG_BLANK.png|500x226px|link=]][[Image:Model_Exec_1.png|500x226px|link=]] [[Image:Model_Exec_2.png|500x226px|link=]] | ||
Line 57: | Line 57: | ||
=== Material === | === Material === | ||
- | A model defined as being of type "material" is defined in Metis Smart Modeling to generate a list of material in Metis Smart Quote based on input masks, rules and logic. The result will be displayed in the latest. | + | A model defined as being of type "material" is defined in Metis Smart Modeling to generate a list of material in Metis Smart Quote based on input [[Metis_Smart_Modeling_-_Masks|masks]], rules and logic. The result will be displayed in the latest. |
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. | 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. | ||
Line 76: | Line 76: | ||
{{Warning | {{Warning | ||
- | | Masks cannot be used in conjunction with service models, as they are calculated based on a list of positions. | + | | [[Metis_Smart_Modeling_-_Masks|Masks]] cannot be used in conjunction with service models, as they are calculated based on a list of positions. |
}} | }} | ||
Line 134: | Line 134: | ||
Click on the add button [[File:MetisSmartModelingAddButton.PNG|link=]]. The Model window opens. | 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. | 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 | + | 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 “groups of rules” |
- | For the masks table, click on the add button. | + | For the [[Metis_Smart_Modeling_-_Masks|masks]] table, click on the add button. |
- | A window opens where masks and groups of masks can be selected and linked to the model. | + | 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 masks, for example, “D-Basic Hardware” and “D-Peripherals” and then confirm to continue. | + | Select the desired [[Metis_Smart_Modeling_-_Masks|masks]], for example, “D-Basic Hardware” and “D-Peripherals” and then confirm to continue. |
For the group of rules table, click on the add button. | For the group of rules table, click on the add button. | ||
- | A window similar to the masks window opens, but for groups of rules. | + | A window similar to the [[Metis_Smart_Modeling_-_Masks|masks]] window opens, but for groups of rules. |
Select the desired groups of rules and confirm. | Select the desired groups of rules and confirm. | ||
- | The green up and down arrows found above each table allow the user to modify the display order of the masks as well as the execution order of the groups of rules. | + | 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 rules. |
Line 151: | Line 151: | ||
[[File:MetisSmartModelingSCModelsDef.PNG|center|764x860px]] | [[File:MetisSmartModelingSCModelsDef.PNG|center|764x860px]] | ||
- | A model is basically constructed of 3 main information. Basic properties will define such information as description, type and versioning. The logical part is made of "Group of rules" which will be used to run the calculation and masks which will be displayed in Metis Smart Quotes to allow for input in the model. | + | A model is basically constructed of 3 main information. Basic properties will define such information as description, type and versioning. The logical part is made of "Group of rules" which will be used to run the calculation and [[Metis_Smart_Modeling_-_Masks|masks]] which will be displayed in Metis Smart Quotes to allow for input in the model. |
* '''Description''' (mandatory) : | * '''Description''' (mandatory) : | ||
Line 159: | Line 159: | ||
* '''Versioning''' : | * '''Versioning''' : | ||
When updating a model based on an old one, this information is very useful to keep track of the different versions. | 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 [[ | + | 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. |
* '''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 rules is very important for the model to generate concrete and valid results. | 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 rules is very important for the model to generate concrete and valid results. | ||
Line 166: | Line 166: | ||
{{Video | {{Video | ||
| <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/7/71/VID_CreatingAModel.PNG'>File:Creating a model OK.mp4</mediaplayer> | | <mediaplayer width='400' height='300' image='http://www.xpert-technologies.ch/mediawikidev/images/7/71/VID_CreatingAModel.PNG'>File:Creating a model OK.mp4</mediaplayer> | ||
- | | Creation of a new model, selection of linked groups of rules and masks. | + | | Creation of a new model, selection of linked groups of rules and [[Metis_Smart_Modeling_-_Masks|masks]]. |
}} | }} | ||
{{Note | {{Note | ||
- | | A model service or material model doesn't have influence on a configuration without fully configured groups of rules and in the case on material models masks. | + | | A model service or material model doesn't have influence on a configuration without fully configured groups of rules and in the case on material models [[Metis_Smart_Modeling_-_Masks|masks]]. |
}} | }} | ||
Line 191: | Line 191: | ||
== Deleting a model == | == Deleting a model == | ||
- | A model can be deleted by using the "Delete" button on the main screen. When deleting a model from there, the masks and group 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. | + | 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 group 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. |
{{Note | {{Note | ||
- | | Deleting a model only removes the "container" form the Metis Database, all masks and groups of rules which were linked to it will not be deleted! | + | | Deleting a model only removes the "container" form the Metis Database, all [[Metis_Smart_Modeling_-_Masks|masks]] and groups of rules which were linked to it will not be deleted! |
}} | }} | ||