| Both sides previous revision Previous revision Next revision | Previous revision |
| 2500_config_apps:0800_add_edit_rules:0400_rule_properties [2022/08/21 22:48] – ↷ Page moved from docs:2500_config_apps:0800_add_edit_rules:0400_rule_properties to 2500_config_apps:0800_add_edit_rules:0400_rule_properties administrator | 2500_config_apps:0800_add_edit_rules:0400_rule_properties [2026/08/13 00:55] (current) – ↷ Links adapted because of a move operation localdev |
|---|
| ===== Description ===== | ===== Description ===== |
| | |
| This is the description of the rule. Providing a description is highly recommended. Any description if defined is included into the generated documentation for the business space version – see [[docs:2500_config_apps:3100_gen_doc|Generating Documentation]]. To provide the description of the rule, click on the Description button next to the rule’s name. The Configuration Tool will display the Description dialog – enter the description and press OK. | This is the description of the rule. Providing a description is highly recommended. Any description if defined is included into the generated documentation for the business space version – see [[2500_config_apps:3100_gen_doc|Generating Documentation]]. To provide the description of the rule, click on the Description button next to the rule’s name. The Configuration Tool will display the Description dialog – enter the description and press OK. |
| |
| ===== Enabled ===== | ===== Enabled ===== |
| ===== Priority ===== | ===== Priority ===== |
| | |
| The rule priorities are described in details in the [[docs:2000_concepts:0800_data_processing:0100_rule_evaluation:0700_evaluation_unorder_rule_collections:0500_rule_priorities|Rule Priorities]] section. By default //**Aware IM**// will assign a priority to the rule based on the rule actions. Actions that modify attributes will have the highest priority whereas actions that call pre-defined operations (such as ''[[docs:3100_actions:0170_find|FIND]]'', ''[[docs:3100_actions:0130_send|SEND]]'' etc) will have lower priority while actions that initialise documents from templates will have the lowest priority. You can set rule priority explicitly and override automatic detection of priorities. | The rule priorities are described in details in the [[2000_concepts:0800_data_processing:0100_rule_evaluation:0700_evaluation_unorder_rule_collections:0500_rule_priorities|Rule Priorities]] section. By default //**AwareIM**// will assign a priority to the rule based on the rule actions. Actions that modify attributes will have the highest priority whereas actions that call pre-defined operations (such as ''[[ref:a_f:a:find|FIND]]'', ''[[ref:a_f:a:send|SEND]]'' etc) will have lower priority while actions that initialise documents from templates will have the lowest priority. You can set rule priority explicitly and override automatic detection of priorities. |
| |
| ===== While loop ===== | ===== While loop ===== |
| |
| The rules supporting the semantics of a “while” statement are explained in detail in the [[docs:2000_concepts:0800_data_processing:0100_rule_evaluation:0700_evaluation_unorder_rule_collections:0300_while_semantics|While Semantics]] section. If you tick the “while loop” checkbox, the conditions of the rule will be checked repeatedly – immediately after the execution of the rule’s actions. | The rules supporting the semantics of a “while” statement are explained in detail in the [[2000_concepts:0800_data_processing:0100_rule_evaluation:0700_evaluation_unorder_rule_collections:0300_while_semantics|While Semantics]] section. If you tick the “while loop” checkbox, the conditions of the rule will be checked repeatedly – immediately after the execution of the rule’s actions. |
| |
| ===== Form initialiazation ===== | ===== Form initialiazation ===== |
| |
| Initialization rules are explained in detail in the [[docs:2000_concepts:0800_data_processing:0100_rule_evaluation:0900_initialization_rules|Initialization Rules]] section. Basically when the user creates an instance of a business object the appropriate form of the business object is displayed. The form is initialized with values calculated after evaluation of certain rules attached to the business object. Only initialization rules are evaluated. You can get //**Aware IM**// to automatically determine which rules are considered to be initializtion rules by selecting the “Automatic” option (default) or you can explicitly indicate whether the rule should be evaluated during form initialization or not. | Initialization rules are explained in detail in the [[2000_concepts:0800_data_processing:0100_rule_evaluation:0900_initialization_rules|Initialization Rules]] section. Basically when the user creates an instance of a business object the appropriate form of the business object is displayed. The form is initialized with values calculated after evaluation of certain rules attached to the business object. Only initialization rules are evaluated. You can get //**AwareIM**// to automatically determine which rules are considered to be initializtion rules by selecting the “Automatic” option (default) or you can explicitly indicate whether the rule should be evaluated during form initialization or not. |
| |
| Note that these options are only available for rules attached to a business object. | Note that these options are only available for rules attached to a business object. |
| ===== Dynamic ===== | ===== Dynamic ===== |
| |
| Sometimes it may be necessary to dynamically re-calculate attribute values on forms while the user is making changes. For example, you may have a calculation rule that calculates value of an attribute based on values of other attributes and you want the user to see the results of re-calculation immediately after he makes a change that affects the calculation. In this case it is necessary to mark the rule that performs the calculation as “dynamic”, so that //**Aware IM**// executes this rule dynamically while the form is being changed. | Sometimes it may be necessary to dynamically re-calculate attribute values on forms while the user is making changes. For example, you may have a calculation rule that calculates value of an attribute based on values of other attributes and you want the user to see the results of re-calculation immediately after he makes a change that affects the calculation. In this case it is necessary to mark the rule that performs the calculation as “dynamic”, so that //**AwareIM**// executes this rule dynamically while the form is being changed. |
| |
| ===== Do not run on server ===== | ===== Do not run on server ===== |
| ===== Don’t check referred ===== | ===== Don’t check referred ===== |
| |
| This checkbox controls whether the rule will be recognized as a cross-reference rule. See [[docs:2000_concepts:0800_data_processing:0100_rule_evaluation:0400_cross_reference_rules|Cross-reference Rules]] for details and the example of a scenario when turning off cross-reference rules might be useful. | This checkbox controls whether the rule will be recognized as a cross-reference rule. See [[2000_concepts:0800_data_processing:0100_rule_evaluation:0400_cross_reference_rules|Cross-reference Rules]] for details and the example of a scenario when turning off cross-reference rules might be useful. |
| |
| **Rule Filter Dialog** | **Rule Filter Dialog** |
| |
| To invoke the Rule Filter dialog where you can specify which rules will be shown click on the {{:documentation:icons:icon_search.png?nolink&20}} icon in the toolbar at the top of the table.The following options can be specified: | To invoke the Rule Filter dialog where you can specify which rules will be shown click on the {{docs:icons:icon_search.png?nolink&20}} icon in the toolbar at the top of the table.The following options can be specified: |
| |
| ===== Rule name ===== | ===== Rule name ===== |
| ===== Show auto-generated rules ===== | ===== Show auto-generated rules ===== |
| | |
| Select this option if you want to view rules generated by the Configuration Tool automatically. When you define attributes of business objects and notifications (see [[docs:2500_config_apps:0700_add_edit_attributes|Adding/Editing Attributes]]) the Configuration Tool may generate certain rules behind the scenes. Rules are automatically generated when: | Select this option if you want to view rules generated by the Configuration Tool automatically. When you define attributes of business objects and notifications (see [[2500_config_apps:0700_add_edit_attributes|Adding/Editing Attributes]]) the Configuration Tool may generate certain rules behind the scenes. Rules are automatically generated when: |
| |
| * An attribute has an initial value. | * An attribute has an initial value. |