Metis Smart Modeling - Debug
From Metis Documentation
| Line 1: | Line 1: | ||
| - | A debugger or debugging tool is included in Metis Smart Modeling. It is used to test and debug Models. The debugger also offer more sophisticated functions such as running a model step by step (single-stepping or program animation), stopping (breaking) (pausing the program to examine the current state) at some event or specified instruction by means of a breakpoint, and tracking the values of some variables. | + | A debugger or debugging tool is included in Metis Smart Modeling. It is used to test and debug Models. The debugger also offer more sophisticated functions such as running a model step by step (single-stepping or program animation), stopping (breaking) (pausing the program to examine the current state) at some event or specified instruction by means of a breakpoint, and tracking the values of some [[Metis_Smart_Modeling_-_Variables|variables]]. |
The importance of a debugger in Metis Smart Modeling cannot be overstated. Indeed, the existence and quality of such a tool supports precise and technically valid models within the environment. The tool expands over the two main applications in the Metis Environment. This means that a model can be executed in Metis Smart Quotes and afterwards debugged in Metis Smart Modeling. | The importance of a debugger in Metis Smart Modeling cannot be overstated. Indeed, the existence and quality of such a tool supports precise and technically valid models within the environment. The tool expands over the two main applications in the Metis Environment. This means that a model can be executed in Metis Smart Quotes and afterwards debugged in Metis Smart Modeling. | ||
| Line 12: | Line 12: | ||
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 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 models. To solve this type of issues, validate all rules which will generate output and add-ons. | ||
* Incorrect intermediate values : | * Incorrect intermediate values : | ||
| - | During the execution of a model, the values for 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 variable which will only be used during an execution. | + | During the execution of a 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. |
* Execution order issues : | * Execution order issues : | ||
Within a 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 model to ensure that the order is relevant. | Within a 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 model to ensure that the order is relevant. | ||
| Line 75: | Line 75: | ||
[[File:MetisSmartModelingDebugBPButton.PNG|link=]] | [[File:MetisSmartModelingDebugBPButton.PNG|link=]] | ||
| width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | | width="80%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| - | Indicates that a break-point has be set on this execution line or output object (variable or position). | + | Indicates that a break-point has be set on this execution line or output object ([[Metis_Smart_Modeling_-_Variables|variable]] or position). |
|- | |- | ||
| width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | | width="15%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
| Line 122: | Line 122: | ||
Preview the rule by either clicking on the “Rule Preview” button or by double clicking on the selected rule. | Preview the rule by either clicking on the “Rule Preview” button or by double clicking on the selected rule. | ||
The rule window opens showing details about the rule. Close this window. | The rule window opens showing details about the rule. Close this window. | ||
| - | In the second table below, the first tab “Output Values and Watchdogs,” lists all output variables and positions used by the 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 models. |
| - | The user can also set a “watchdog” to a position or a variable. A “watchdog” can be considered as a breakpoint. When executing the model using the “Start” and “Next Break point” buttons, the process continues until the “watchdog” position or 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 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 mask in Smart Quotes. | The second tab lists the input values which were defined in the mask in Smart Quotes. | ||
Click on the “Start” button to execute the model. Click on the next button to execute the rules of the model, step by step. | Click on the “Start” button to execute the model. Click on the next button to execute the rules of the model, step by step. | ||
| Line 149: | Line 149: | ||
=== Using breakpoints === | === Using breakpoints === | ||
| - | The debugger tool included in Metis Smart Modeling allows to set breakpoints throughout the execution of an imported Metis Smart Quotes environment. Those breakpoints can be used to stop a step-by-step execution at a specific place or time of the offer. For example at the beginning of one of the systems included in the offer or when a specific variable changes value. This can be very useful to pinpoint a problem in a model based on certain values. | + | The debugger tool included in Metis Smart Modeling allows to set breakpoints throughout the execution of an imported Metis Smart Quotes environment. Those breakpoints can be used to stop a step-by-step execution at a specific place or time of the offer. For example at the beginning of one of the systems included in the offer or when a specific [[Metis_Smart_Modeling_-_Variables|variable]] changes value. This can be very useful to pinpoint a problem in a model based on certain values. |
| Line 162: | Line 162: | ||
To remove a break-point from the execution list, click of the small red dot in from of the line. The execution will then execute until the next one or the end of the list. | To remove a break-point from the execution list, click of the small red dot in from of the line. The execution will then execute until the next one or the end of the list. | ||
| - | 2. '''On a variable or position''' | + | 2. '''On a [[Metis_Smart_Modeling_-_Variables|variable]] 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 variable, positions and 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 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. |
{{Note | {{Note | ||
| - | | Breakpoints on variable or positions are very helpful to test and verify that it is not modified when not required. | + | | Breakpoints on [[Metis_Smart_Modeling_-_Variables|variable]] or positions are very helpful to test and verify that it is not modified when not required. |
}} | }} | ||
=== Using watchdogs === | === Using watchdogs === | ||
| - | Within the list of of "Output Values & Watchdogs" are only shown the 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 variables or positions which could be used as inputs or filters, Metis Smart Modeling allows the user define so called watchdogs. They are variables, positions or 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 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 attributes which are not listed in the previously named table but which could be used in rules as either input values or filters. |
| - | In order to define a new watchdog within the debugger, click on the ADD button [[File:MetisSmartModelingAddButton.PNG|link=]] located on the right of the "Output Values & Watchdogs" table. A window opens up which allows to select the position, the variable (or group of items) or attribute to be used as a watchdog. Select the appropriate one and validate in order for it to be listed in the table. Once done, move to the XX column of the inserted element and set the value for which it should be tested. When the execution process starts, and at each step, the watchdog will be tested against the value provided. If equal, then the execution pauses. | + | In order to define a new watchdog within the debugger, click on the ADD button [[File:MetisSmartModelingAddButton.PNG|link=]] located on the right of the "Output Values & Watchdogs" table. A window opens up which allows to select the position, the [[Metis_Smart_Modeling_-_Variables|variable]] (or [[Metis_Smart_Modeling_-_Variables|group of items]]) or attribute to be used as a watchdog. Select the appropriate one and validate in order for it to be listed in the table. Once done, move to the XX column of the inserted element and set the value for which it should be tested. When the execution process starts, and at each step, the watchdog will be tested against the value provided. If equal, then the execution pauses. |
| Line 182: | Line 182: | ||
{{Note | {{Note | ||
| - | | Watchdogs on variable or positions are very helpful to test and verify that a given 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 rule. |
}} | }} | ||