Metis Smart Modeling - Debug
From Metis Documentation
| Line 10: | Line 10: | ||
Example of errors or problems which can be detected using the debugger : | Example of errors or problems which can be detected using the debugger : | ||
* Incorrect results : | * Incorrect results : | ||
| - | Use the "Output Values & Watchdogs" list in order to determine at the end of the execution process the values which should be "calculated" through the used [[Metis_Smart_Modeling_-_Models|models]]. To solve this type of issues, validate all rules which will generate output and add-ons. | + | Use the "Output Values & Watchdogs" list in order to determine at the end of the execution process the values which should be "calculated" through the used [[Metis_Smart_Modeling_-_Models|models]]. To solve this type of issues, validate all [[Metis_Smart_Modeling_-_Rules|rules]] which will generate output and add-ons. |
* Incorrect intermediate values : | * Incorrect intermediate values : | ||
| - | During the execution of a [[Metis_Smart_Modeling_-_Models|model]], the values for [[Metis_Smart_Modeling_-_Variables|variables]] and positions may change based on the rules. This could mean that throughout the execution, such object may receive a value that is not planned or wished. Verify thoroughly all rules which use identical object that see if incoherence may appears during the execution. For example, create temporary [[Metis_Smart_Modeling_-_Variables|variable]] which will only be used during an execution. | + | During the execution of a [[Metis_Smart_Modeling_-_Models|model]], the values for [[Metis_Smart_Modeling_-_Variables|variables]] and positions may change based on the [[Metis_Smart_Modeling_-_Rules|rules]]. This could mean that throughout the execution, such object may receive a value that is not planned or wished. Verify thoroughly all [[Metis_Smart_Modeling_-_Rules|rules]] which use identical object that see if incoherence may appears during the execution. For example, create temporary [[Metis_Smart_Modeling_-_Variables|variable]] which will only be used during an execution. |
* Execution order issues : | * Execution order issues : | ||
| - | Within a [[Metis_Smart_Modeling_-_Models|model]] the order of the various groups of rules which are executed is key. Errors may occur if groups are executed in the wrong order. Verify all the processes to be executed within a [[Metis_Smart_Modeling_-_Models|model]] to ensure that the order is relevant. | + | Within a [[Metis_Smart_Modeling_-_Models|model]] the order of the various groups of [[Metis_Smart_Modeling_-_Rules|rules]] which are executed is key. Errors may occur if groups are executed in the wrong order. Verify all the processes to be executed within a [[Metis_Smart_Modeling_-_Models|model]] to ensure that the order is relevant. |
* Rights on defined objects : | * Rights on defined objects : | ||
The results of the debugger is dependent on the rights and profiles applicable to the user logged in Metis Smart Quotes. This means that the availability of certain [[Metis_Smart_Modeling_-_Attributes|attributes]], price categories, variants or hierarchies will have a great influence of the calculated results. The cause of such issue may just be that the end-user doesn't have access to part of the objects used in the [[Metis_Smart_Modeling_-_Models|model]]. | The results of the debugger is dependent on the rights and profiles applicable to the user logged in Metis Smart Quotes. This means that the availability of certain [[Metis_Smart_Modeling_-_Attributes|attributes]], price categories, variants or hierarchies will have a great influence of the calculated results. The cause of such issue may just be that the end-user doesn't have access to part of the objects used in the [[Metis_Smart_Modeling_-_Models|model]]. | ||
| Line 50: | Line 50: | ||
|style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | |style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
[[File:MetisSmartModelingDebugPrRuleButton.PNG|link=]] | [[File:MetisSmartModelingDebugPrRuleButton.PNG|link=]] | ||
| - | |style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | To preview the selected rule. | + | |style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | To preview the selected [[Metis_Smart_Modeling_-_Rules|rule]]. |
|- | |- | ||
|style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" | | |style="border-style: solid; border-color: grey; border-width: 0 1px 0 0" | | ||
| Line 119: | Line 119: | ||
An explorer window opens where the debug file can be selected and then opened. | An explorer window opens where the debug file can be selected and then opened. | ||
Once opened, the debug sub-menu appears. Under the top table, click on “expand all.” | Once opened, the debug sub-menu appears. Under the top table, click on “expand all.” | ||
| - | Information about the price category, the [[Metis_Smart_Modeling_-_Models|models]] or the rules is displayed. It is possible to see the details about a rule. For example, select the rule “Configure basic hardware based on CPU choice (low).” | + | Information about the price category, the [[Metis_Smart_Modeling_-_Models|models]] or the [[Metis_Smart_Modeling_-_Rules|rules]] is displayed. It is possible to see the details about a [[Metis_Smart_Modeling_-_Rules|rule]]. For example, select the [[Metis_Smart_Modeling_-_Rules|rule]] “Configure basic hardware based on CPU choice (low).” |
| - | Preview the rule by either clicking on the “Rule Preview” button or by double clicking on the selected rule. | + | Preview the [[Metis_Smart_Modeling_-_Rules|rule]] by either clicking on the “Rule Preview” button or by double clicking on the selected [[Metis_Smart_Modeling_-_Rules|rule]]. |
| - | The rule window opens showing details about the rule. Close this window. | + | The [[Metis_Smart_Modeling_-_Rules|rule]] window opens showing details about the [[Metis_Smart_Modeling_-_Rules|rule]]. Close this window. |
In the second table below, the first tab “Output Values and Watchdogs,” lists all output [[Metis_Smart_Modeling_-_Variables|variables]] and positions used by the [[Metis_Smart_Modeling_-_Models|models]]. | In the second table below, the first tab “Output Values and Watchdogs,” lists all output [[Metis_Smart_Modeling_-_Variables|variables]] and positions used by the [[Metis_Smart_Modeling_-_Models|models]]. | ||
The user can also set a “watchdog” to a position or a [[Metis_Smart_Modeling_-_Variables|variable]]. A “watchdog” can be considered as a breakpoint. When executing the [[Metis_Smart_Modeling_-_Models|model]] using the “Start” and “Next Break point” buttons, the process continues until the “watchdog” position or [[Metis_Smart_Modeling_-_Variables|variable]] is encountered. | The user can also set a “watchdog” to a position or a [[Metis_Smart_Modeling_-_Variables|variable]]. A “watchdog” can be considered as a breakpoint. When executing the [[Metis_Smart_Modeling_-_Models|model]] using the “Start” and “Next Break point” buttons, the process continues until the “watchdog” position or [[Metis_Smart_Modeling_-_Variables|variable]] is encountered. | ||
The second tab lists the input values which were defined in the [[Metis_Smart_Modeling_-_Masks|mask]] in Smart Quotes. | The second tab lists the input values which were defined in the [[Metis_Smart_Modeling_-_Masks|mask]] in Smart Quotes. | ||
| - | Click on the “Start” button to execute the [[Metis_Smart_Modeling_-_Models|model]]. Click on the next button to execute the rules of the [[Metis_Smart_Modeling_-_Models|model]], step by step. | + | Click on the “Start” button to execute the [[Metis_Smart_Modeling_-_Models|model]]. Click on the next button to execute the [[Metis_Smart_Modeling_-_Rules|rules]] of the [[Metis_Smart_Modeling_-_Models|model]], step by step. |
| - | The result values associated with the execution of the rules are displayed in the table “output values and watchdogs” below. | + | The result values associated with the execution of the [[Metis_Smart_Modeling_-_Rules|rules]] are displayed in the table “output values and watchdogs” below. |
Clicking on the “Stop” button stops the [[Metis_Smart_Modeling_-_Models|model]] execution and the values disappear. | Clicking on the “Stop” button stops the [[Metis_Smart_Modeling_-_Models|model]] execution and the values disappear. | ||
| Line 156: | Line 156: | ||
1. '''In the execution steps''' | 1. '''In the execution steps''' | ||
| - | In the Metis Smart Modeling debugger window, the top table shows the complete content of the imported environment (Offer, [[Metis_Smart_Modeling_-_Systems|system]] and applications, [[Metis_Smart_Modeling_-_Models|models]] used, [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] and rules which are executed). Each line listed in the table represents one of the steps of the execution process. Break-point can be set of any of those lines simply by clicking once the leftmost "grayed" column of the table. this add a small red dot to the line showing the user that the step-by-step will stop before executing this line in the process. | + | In the Metis Smart Modeling debugger window, the top table shows the complete content of the imported environment (Offer, [[Metis_Smart_Modeling_-_Systems|system]] and applications, [[Metis_Smart_Modeling_-_Models|models]] used, [[Metis_Smart_Modeling_-_Group_of_Rules|group of rules]] and [[Metis_Smart_Modeling_-_Rules|rules]] which are executed). Each line listed in the table represents one of the steps of the execution process. Break-point can be set of any of those lines simply by clicking once the leftmost "grayed" column of the table. this add a small red dot to the line showing the user that the step-by-step will stop before executing this line in the process. |
In order to jump from one break-point the other, use the "Next Break-point" button. | In order to jump from one break-point the other, use the "Next Break-point" button. | ||
| Line 164: | Line 164: | ||
2. '''On a or position''' | 2. '''On a or position''' | ||
| - | Additionally to stopping the execution of the imported environment at a specific place or moment of the execution, Metis Smart Modeling also allows to set break-point on [[Metis_Smart_Modeling_-_Variables|variable]], positions and [[Metis_Smart_Modeling_-_Variables#What_is_a_group_of_items.3F|group of items]]. This can be done by using the "output Values & Watchdogs" table. Simply click in the leftmost column of the item which should stop the execution. Metis Smart modeling will then pause the execution process when the value stored with the item changes due to a rule. By looking at the execution list, the specific operation which applied this change can be viewed. | + | Additionally to stopping the execution of the imported environment at a specific place or moment of the execution, Metis Smart Modeling also allows to set break-point on [[Metis_Smart_Modeling_-_Variables|variable]], positions and [[Metis_Smart_Modeling_-_Variables#What_is_a_group_of_items.3F|group of items]]. This can be done by using the "output Values & Watchdogs" table. Simply click in the leftmost column of the item which should stop the execution. Metis Smart modeling will then pause the execution process when the value stored with the item changes due to a [[Metis_Smart_Modeling_-_Rules|rule]]. By looking at the execution list, the specific operation which applied this change can be viewed. |
| Line 172: | Line 172: | ||
=== Using watchdogs === | === Using watchdogs === | ||
| - | Within the list of of "Output Values & Watchdogs" are only shown the [[Metis_Smart_Modeling_-_Variables|variables]], positions and groups of items which are either used as an output or an add-on to any rule included in the environment. In order to work on [[Metis_Smart_Modeling_-_Variables|variables]] or positions which could be used as inputs or filters, Metis Smart Modeling allows the user define so called watchdogs. They are [[Metis_Smart_Modeling_-_Variables|variables]], positions or [[Metis_Smart_Modeling_-_Attributes|attributes]] which are not listed in the previously named table but which could be used in rules as either input values or filters. | + | Within the list of of "Output Values & Watchdogs" are only shown the [[Metis_Smart_Modeling_-_Variables|variables]], positions and groups of items which are either used as an output or an add-on to any [[Metis_Smart_Modeling_-_Rules|rule]] included in the environment. In order to work on [[Metis_Smart_Modeling_-_Variables|variables]] or positions which could be used as inputs or filters, Metis Smart Modeling allows the user define so called watchdogs. They are [[Metis_Smart_Modeling_-_Variables|variables]], positions or [[Metis_Smart_Modeling_-_Attributes|attributes]] which are not listed in the previously named table but which could be used in [[Metis_Smart_Modeling_-_Rules|rules]] as either input values or filters. |
| Line 182: | Line 182: | ||
{{Note | {{Note | ||
| - | | Watchdogs on [[Metis_Smart_Modeling_-_Variables|variable]] or positions are very helpful to test and verify that a given [[Metis_Smart_Modeling_-_Variables|variable]] or position is not modified prior to being used as an input to another rule. | + | | Watchdogs on [[Metis_Smart_Modeling_-_Variables|variable]] or positions are very helpful to test and verify that a given [[Metis_Smart_Modeling_-_Variables|variable]] or position is not modified prior to being used as an input to another [[Metis_Smart_Modeling_-_Rules|rule]]. |
}} | }} | ||