Define Consistency Rules

To improve the usability, you can guide the user/calculator by defining consistency rules for relevant properties. Because the table surface is calculated, we would like to inform the user that the inputs for table length and table width are required to calculate the table surface according to the defined formula.

You can define consistency rule for the cost model header and resources (global and local). The localization of consistency rule violation message can be managed inside the FACTON CMD for English and German.

Define Consistency Rules

    Select »'TableModel' on Product« in »My Local Configuration«.

    The Properties view opens on the right side.

  1. In the Consistency Rules view, select the Errors folder.
  2. In the ribbon, click on Consistency Rule to insert a new consistency rule.

    Alternative: Right-click on the corresponding consistency rule folder in the Consistency Rules view ► Consistency Rule.

  3. Define the details of the consistency rule in the Details view:
    Internal nameTableLength required 
    RuleIsSignificant(TableLength)[...]
    Message (en)Length of table is required. 
    Message (de)Tischlänge ist erforderlich. 

    In the FACTON CMD Test Client, this consistency rule will be shown at the property »Table Length«.

  4. Repeat step 2 to step 4 for the following consistency rule:
  5. Define the details of the consistency rule in the Details view:
    Internal nameTableWidth required 
    RuleIsSignificant(TableWidth)[...]
    Message (en)Width of table is required. 
    Message (de)Tischbreite ist erforderlich. 

    In the FACTON CMD Test Client, this consistency rule will be shown at the property »Table Width«.

 

Hint

You can copy and paste existing consistency rules to other resources and cost model headers.

Note

You can test the consistency rules by running the cost model.

In order to use the latest developed configuration of the FACTON CMD, please consider that you have to update the configuration of an existing calculation (in the FACTON CMD Test Client).

Further Information ► Configuration Update

 

The Consistency Rules view

In the Consistency Rules view, you are able to create consistency rules. Consistency rules enable you to check the validity / accuracy of values in the calculation and show the severity of the rule violations. This allows you to monitor the quality of the data in the calculation.

Depending on the severity of the consistency rule, you can create consistency rules like error, warning and info.

 

The Details view of the Consistency Rules view

In the Details view of the Consistency Rules view, you are able to define the rule and messages in different languages - as defined in the base solution - for the priorly created consistency rule.

  • Internal name

    For reasons of clarity, the internal name of consistency rules should be unique. It is shown as text in the FACTON CMD Test Client later on, and thus can have spaces and special characters.

  • Rule

    The rule describes the consistent state. So, if this statement is 'FALSE', the rule message will appear. You can check the validity, availability and significance of a value.

    Further Information ► FACTON_12_1_Platform_FQLManual_EN.pdf

    By clicking [...], you can open the Formula Editor. The dialog provides more space to edit formulas and/ or FQL commands for a better overview. For further orientation, the path and the property you are currently editing a formula for are displayed in the dialog header.

    Syntax highlighting is available here.

    Input Assistant is available here.

  • Message (en / de)

    Consistency rule messages can be localized in English (en), German (de) as defined in the base solution. The message text will be displayed when the consistency rule applies. The message text will be displayed when the consistency rule applies.