XML rules handling
All rules and accelerators of a cube are represented in one XML structure. This structure is used by the following XML functions:
- Cube GetRules
- Cube PutRules
- Cube VerifyRule
Alea:Rules is the topmost element in this structure and can contain these elements and attributes:
| Element | Description |
|---|---|
Alea:RuleGroup |
Described in the "RuleGroup" section. |
Alea:Rule |
Described in the "Rule" section. |
Alea:Accelerator |
Described in the "Accelerator" section. |
Accelerated |
This attribute specifies if accelerators are used. We recommend to set this attribute to false. Therefore you are using the pre-fetching Rules Engine. |
User |
This attribute indicates the user who changed the rules. It is read-only. |
Time |
This attribute indicates the creation date and time of the rules. It is read-only. |
RuleGroup
The
Alea:RuleGroup element can include these elements and attributes:
| Object | Description |
|---|---|
Alea:RuleGroup |
RuleGroups can be nested. |
Alea:Rule |
Described in the "Rule" section. |
Alea:Accelerator |
Described in the "Accelerator" section. |
Alea:Name |
The name of the RuleGroup. |
Alea:Description |
This element specifies the text string to use as the description. |
Enabled |
This attribute specifies if the RuleGroup element is enabled, either true or false. |
Type |
This attribute indicates if the rule group contains the dimensional rules. It is read-only. |
Rule
The Alea:Rule element can be included in the Alea:Rules and Alea:RuleGroup elements.
These elements and attributes can be contained in the Alea:Rule element:
| Object | Description |
|---|---|
Alea:Target |
This element specifies the target data area. In a response it can contain the ErrorID and ErrorPosition attributes. |
Alea:Formula |
This element specifies the formula. In a response it can contain the ErrorID and ErrorPosition attributes. |
Alea:ShortDescription |
This element specifies the text string to use as the name of the rule in the user interface. |
Alea:Description |
This element specifies the text string to use as the description. |
Enabled |
This attribute specifies if the rule is enabled. The possible values are true or false. |
Cells |
This attribute specifies the affected cells. The possible values are All, Consolidated, or Basic. |
Type |
This attribute indicates the rule type. It is read-only. The possible values are Cube or Dimensional. |
RuleID |
This attribute specifies the rule ID. It is read-only. |
ErrorID |
In case of certain errors, this optional attribute returns the corresponding error number. It is read-only. |
Accelerator
The Alea:Accelerator element can be included in the Alea:Rules and Alea:RuleGroup elements.
The Alea:Accelerator element is provided for backward compatibility. We recommend you use the pre-fetching rules engine.
These elements and attributes can be used in the Alea:Accelerator element:
| Object | Description |
|---|---|
Alea:Source |
This element specifies the source data area. |
Alea:Destination |
This element specifies the destination data area. |
Alea:Description |
This element specifies the text string to use as the description. |
AcceleratorID |
This attribute specifies the accelerator ID. |
Enabled |
This attribute specifies if the Accelerator element is enabled, either true or false. |