Metis Smart Modeling - Rules
From Metis Documentation
(→Single Selection) |
(→Formulas) |
||
| Line 172: | Line 172: | ||
'''Q from''' | '''Q from''' | ||
| 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" | | ||
| - | The value set in this field will define the lower limit for which the rule is valid and should be executed. For example, if the | + | The value set in this field will define the lower limit for which the rule is valid and should be executed. For example, if the '''Q in''' value is 6 and that the "Q from" value is 5, then the rule will provide an output. The "Q from" value can also be considered as a base value for the [[Metis_Smart_Modeling_-_Systems|system]] in which the [[Metis_Smart_Modeling_-_Models|model]] is used. |
|- | |- | ||
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | | width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
'''Q to''' | '''Q to''' | ||
| 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" | | ||
| - | The value set in this field will define the upper limit for which the rule is valid and should be executed. For example, if the | + | The value set in this field will define the upper limit for which the rule is valid and should be executed. For example, if the '''Q in''' value is 6 and that the "Q to" value is 4, then the rule will not provide an output. |
|- | |- | ||
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | | width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
| Line 195: | Line 195: | ||
| [[Metis_Smart_Modeling_-_Attributes|Attributes]] do not hold any values in material [[Metis_Smart_Modeling_-_Models|models]], as in Rules their value is calculated based on a list of material and that this list is only available when the execution of the model is completed. | | [[Metis_Smart_Modeling_-_Attributes|Attributes]] do not hold any values in material [[Metis_Smart_Modeling_-_Models|models]], as in Rules their value is calculated based on a list of material and that this list is only available when the execution of the model is completed. | ||
}} | }} | ||
| - | |||
| - | |||
== Rule types == | == Rule types == | ||
| Line 268: | Line 266: | ||
=== Single Selection === | === Single Selection === | ||
| - | The single selection rule tests an input and calculates the defined output based on a simple logical relation. The Input "object" can be of any type available, but the output one can only be a position or a variable. If the input is set to be a variable, its value may come directly from a field placed in a [[Metis_Smart_Modeling_-_Masks|mask]] or a default value. The output quantity ( | + | The single selection rule tests an input and calculates the defined output based on a simple logical relation. The Input "object" can be of any type available, but the output one can only be a position or a variable. If the input is set to be a variable, its value may come directly from a field placed in a [[Metis_Smart_Modeling_-_Masks|mask]] or a default value. The output quantity ('''Q out''') is determined by the input quantity ('''Q in'''). If they are both set to "1", then for every number of input there will be an output. On the other hand, if the '''Q out''' fields is set to 2, it means that for every input there will be 2 output. |
| Line 275: | Line 273: | ||
{{Warning | {{Warning | ||
| - | | Beware that if the | + | | Beware that if the '''Q in''' field is left empty, the output will be equal to the input. The output value will always be equal to the input value, for any '''Q in''' value. |
}} | }} | ||
| - | In certain case their could be a 'start' value for the output provided by the rule. For example a motherboard is generally already equipped with multiple USB ports, in this case lets say 4. Based on the result of the execution, the required number of ports could be 6. s the base of the 'system' being modeled already '''includes''' 4, the result of the rule should be 1. This value could then be used in another Group of rules to define an expansion card for the system. The 'Q included' field allows to define the value that is already available in the model. | + | In certain case their could be a 'start' value for the output provided by the rule. For example a motherboard is generally already equipped with multiple USB ports, in this case lets say 4. Based on the result of the execution, the required number of ports could be 6. s the base of the 'system' being modeled already '''includes''' 4, the result of the rule should be 1. This value could then be used in another Group of rules to define an expansion card for the system. The '''Q included''' field allows to define the value that is already available in the model. |
{{Note | {{Note | ||
| - | | If the | + | | If the '''Q from''' field is left empty, this means ‘from 0'. If the '''Q to''' field is left empty, this means “up to ∞” (or > 999'999'999). |
}} | }} | ||
| Line 302: | Line 300: | ||
In the description field, enter “ddr” and click on filter. | In the description field, enter “ddr” and click on filter. | ||
Select “DDR2 1GB” from the list and confirm. | Select “DDR2 1GB” from the list and confirm. | ||
| - | In the field | + | In the field '''Q in''' enter the value “1.” |
To test this new rule, click on the “test” button. | To test this new rule, click on the “test” button. | ||
The test window opens. | The test window opens. | ||
In the “test value” field for “$Memory” enter “4.” | In the “test value” field for “$Memory” enter “4.” | ||
Click on the test button. The results appear below. | Click on the test button. The results appear below. | ||
| - | In this example the result value is also “4” because | + | In this example the result value is also “4” because '''Q in''' and '''Q out''' were both set to “1.” |
Close the test window. | Close the test window. | ||
Now click on confirm to save the rule. It now appears in the list of rules. | Now click on confirm to save the rule. It now appears in the list of rules. | ||
| Line 315: | Line 313: | ||
{| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" | {| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" | ||
|- | |- | ||
| - | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Q in | + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q in''' |
| - | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Q out | + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q out''' |
! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark | ||
|- | |- | ||
| Line 355: | Line 353: | ||
=== Table Selection=== | === Table Selection=== | ||
| - | The goal is to determine an output quantity within several ranges of input values. The rule allows to enter several 'Q from' and 'Q to' to determine those ranges. They each then induce a specific 'Q out' which will be used as a quantity for the output. | + | The goal is to determine an output quantity within several ranges of input values. The rule allows to enter several '''Q from''' and '''Q to''' to determine those ranges. They each then induce a specific '''Q out''' which will be used as a quantity for the output. |
| Line 383: | Line 381: | ||
The same window from before opens. Select “[[Metis_Smart_Modeling_-_Variables|variables]].” | The same window from before opens. Select “[[Metis_Smart_Modeling_-_Variables|variables]].” | ||
Select “$NB_HDD” from the list and confirm to continue. The variable is added to the output field. | Select “$NB_HDD” from the list and confirm to continue. The variable is added to the output field. | ||
| - | The requirement for this rule is that for a RAID configuration with a value of 0 or 1, the number of disks must be 2, hence why | + | The requirement for this rule is that for a RAID configuration with a value of 0 or 1, the number of disks must be 2, hence why '''Q out''' is set to 2. With a value anywhere from 2 to 10, the number of disks must be 3, hence '''Q out''' is set to "3". |
| - | Therefore, under the Q fields, in the first field, Set | + | Therefore, under the Q fields, in the first field, Set '''Q from''' to “0,” '''Q to''' to “1” and '''Q out''' to “2.” |
| - | In the second field, set | + | In the second field, set '''Q from''' to “2,” '''Q to''' to “10,” and '''Q out''' to “3.” |
| - | Please note, that although it is not displayed the value “0” for | + | Please note, that although it is not displayed the value “0” for '''Q from''' has indeed been saved. |
The rule can now be tested. | The rule can now be tested. | ||
Click on the “Test” button found at the top. A test window opens. | Click on the “Test” button found at the top. A test window opens. | ||
| Line 400: | Line 398: | ||
{| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" | {| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" | ||
|- | |- | ||
| - | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Q from | + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q from''' |
| - | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Q to | + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q to''' |
| - | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Q out | + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q out''' |
! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark | ||
|- | |- | ||
| Line 450: | Line 448: | ||
Click on the add button near the “input” field. A window opens where it is possible to select positions, [[Metis_Smart_Modeling_-_Variables|variables]], and [[Metis_Smart_Modeling_-_Attributes|attributes]]. Select “[[Metis_Smart_Modeling_-_Variables|variables]]”. | Click on the add button near the “input” field. A window opens where it is possible to select positions, [[Metis_Smart_Modeling_-_Variables|variables]], and [[Metis_Smart_Modeling_-_Attributes|attributes]]. Select “[[Metis_Smart_Modeling_-_Variables|variables]]”. | ||
In the list below, select “$NB_Licences.” Click on confirm. | In the list below, select “$NB_Licences.” Click on confirm. | ||
| - | Click on the add button near the | + | Click on the add button near the '''Q in''' field. The same window from before opens, but it is only possible to select positions or [[Metis_Smart_Modeling_-_Variables|variables]]. In this example a position is added. |
In the description field, enter “cal” and then click on filter. | In the description field, enter “cal” and then click on filter. | ||
From the results, select the position “Windows Server 2008 CAL 1x” and then click on confirm. | From the results, select the position “Windows Server 2008 CAL 1x” and then click on confirm. | ||
Repeat the previous steps, but this time select “Windows Server 2008 CAL 5x” and click on confirm. | Repeat the previous steps, but this time select “Windows Server 2008 CAL 5x” and click on confirm. | ||
| - | In | + | In '''Q in''' field for “Windows Server 2008 CAL 5x” set the value to “5.” |
| - | Click on the add button near | + | Click on the add button near '''Q in''' once again. |
Repeat the previous steps and select the “Windows Server 2008 CAL 25x” position and click on confirm. | Repeat the previous steps and select the “Windows Server 2008 CAL 25x” position and click on confirm. | ||
| - | Enter “25” in the | + | Enter “25” in the '''Q in''' field for “Windows Server 2008 CAL 25x” |
The rule now states that based on the number of licenses, various solutions are possible. When executed, the rule looks up the prices of the various outputs to determine the cheapest and most suitable option. | The rule now states that based on the number of licenses, various solutions are possible. When executed, the rule looks up the prices of the various outputs to determine the cheapest and most suitable option. | ||
To test this new rule, click on the “test” button. | To test this new rule, click on the “test” button. | ||
| Line 468: | Line 466: | ||
{| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" | {| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" | ||
|- | |- | ||
| - | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Q in | + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q in''' |
| - | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Q out | + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q out''' |
! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark | ||
|- | |- | ||
| Line 491: | Line 489: | ||
|- | |- | ||
|} | |} | ||
| + | |||
| + | |||
| + | {{Note | ||
| + | | As the optimal rule is a 'sequence' of single rules, the '''Q included''' field works as described above. | ||
| + | }} | ||
| Line 497: | Line 500: | ||
| Definition of an optimal rule within Metis Smart Modeling. | | Definition of an optimal rule within Metis Smart Modeling. | ||
}} | }} | ||
| - | |||
| - | |||
=== Maximal Selection === | === Maximal Selection === | ||
| - | This type of rule can be used when several input values influence a specific output. Each line will be used as a single criterion and Metis will return the highest result possible. It is particularly useful when the goal is to define a minimal number of one position in order to satisfy several criteria. When the input quantity is not within the indicated range (Q from – Q to), the line will not be valid, thus not considered by the rule. | + | This type of rule can be used when several input values influence a specific output. Each line will be used as a single criterion and Metis will return the highest result possible. It is particularly useful when the goal is to define a minimal number of one position in order to satisfy several criteria. When the input quantity is not within the indicated range ('''Q from''' – '''Q to'''), the line will not be valid, thus not considered by the rule. |
| Line 531: | Line 532: | ||
{{Note | {{Note | ||
| - | | If the | + | | If the '''Q from''' field is left empty, this means ‘from 0'. If the '''Q to''' field is left empty, this means “up to ∞” (or > 999'999'999). |
}} | }} | ||
| Line 537: | Line 538: | ||
{| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" | {| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" | ||
|- | |- | ||
| - | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Q in | + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q in''' |
| - | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Q out | + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q out''' |
! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark | ||
|- | |- | ||
| Line 563: | Line 564: | ||
{{Note | {{Note | ||
| - | | If the | + | | If the '''Q from''' field is left empty, this means ‘from 0'. If the '''Q to''' field is left empty, this means “up to ∞” (or > 999'999'999). |
}} | }} | ||
| Line 591: | Line 592: | ||
{| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" | {| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" | ||
|- | |- | ||
| - | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Q in | + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q in''' |
| - | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Q out | + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q out''' |
! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark | ||
|- | |- | ||
| Line 638: | Line 639: | ||
{| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" | {| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" | ||
|- | |- | ||
| - | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Q in | + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q in''' |
| - | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Q out | + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q out''' |
! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark | ||
|- | |- | ||
| Line 701: | Line 702: | ||
0.5 and 0.99: the number is rounded to 1. For example, 3.7 is rounded to 4 (no decimal). | 0.5 and 0.99: the number is rounded to 1. For example, 3.7 is rounded to 4 (no decimal). | ||
| + | |- | ||
| + | | width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
| + | '''RoundUp''' | ||
| + | | width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
| + | Calculates the upward rounded value of a numeric value according to the specified number of decimal. | ||
| + | | width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| + | <Result> = Roundup(<Numeric Value> [,<Number of Decimals>]) | ||
| + | |||
| + | '''Parameter Details''' | ||
| + | |||
| + | <Result>: Integer or real rounded value of the specified numeric value. | ||
| + | <Numeric Value>: Real or currency numeric value to round. We recommend that you use the currency type in order to get reliable results. | ||
| + | |||
| + | '''Numeric Value''' | ||
| + | If <Numeric Value> is included between: | ||
| + | |||
| + | 0 and 0.99: the number is rounded up to 1. For example, 3.7 is rounded to 4 (no decimal). | ||
| + | |- | ||
| + | | width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
| + | '''RoundDown''' | ||
| + | | width="30%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
| + | Calculates the downward rounded value of a numeric value according to the specified number of decimal. | ||
| + | | width="50%" style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | | ||
| + | <Result> = Rounddown(<Numeric Value> [,<Number of Decimals>]) | ||
| + | |||
| + | '''Parameter Details''' | ||
| + | |||
| + | <Result>: Integer or real rounded value of the specified numeric value. | ||
| + | <Numeric Value>: Real or currency numeric value to round. We recommend that you use the currency type in order to get reliable results. | ||
| + | |||
| + | '''Numeric Value''' | ||
| + | If <Numeric Value> is included between: | ||
| + | |||
| + | 0 et 0.49: the number is rounded to 0. For example, 3.2 is rounded to 3 (no decimal). | ||
|- | |- | ||
| width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | | width="20%" style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | | ||
| Line 948: | Line 983: | ||
|- | |- | ||
|} | |} | ||
| - | |||
| - | |||
=== External Selection=== | === External Selection=== | ||
| Line 979: | Line 1,012: | ||
{| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" | {| class="wikitable centre" width="90%" style="border-collapse: separate; border-spacing: 0; border-width: 1px; border-style: solid; border-color: grey;" | ||
|- | |- | ||
| - | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Q in | + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q in''' |
| - | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | Q out | + | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 1px 1px 0" | '''Q out''' |
! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark | ! scope=col style="border-style: solid; border-color: grey; border-width: 0 0 1px 0" | Remark | ||
|- | |- | ||
| Line 1,006: | Line 1,039: | ||
| The external application which is executed when running an external rule can be written in any programming language as long as it is configured to accept one or more input [[Metis_Smart_Modeling_-_Variables|variables]] and only one output. Common consideration for executing the application are not supported by Xpert Technologies SA. | | The external application which is executed when running an external rule can be written in any programming language as long as it is configured to accept one or more input [[Metis_Smart_Modeling_-_Variables|variables]] and only one output. Common consideration for executing the application are not supported by Xpert Technologies SA. | ||
}} | }} | ||
| - | |||
| - | |||
== Testing rules == | == Testing rules == | ||