The following table describes the mandatory rule attributes that must be specified for each advice item rule class:
Rule Attribute Name |
Attribute Type |
Purpose |
---|---|---|
adviceText | String | The purpose of this attribute is to allow the rule set developer to link to the text that will appear if this advice item is triggered. Note that the value that this attribute contains is not the actual advice text. The value of this attribute is the name of the property entry that contains the advice text. For more information, see Specifying the Advice Text . |
showAdvice | Boolean | The purpose of this attribute is to allow the rule set developer to specify the conditions under which this advice item will be displayed. If the value is calculated as TRUE, the advice will be displayed, if it is calculated as FALSE, the advice will not be displayed. These rules are the main rules for the advice item, and can examine any data related to the context in order to decide whether to display the advice. |
category | CodeTableItem | The purpose of this rule attribute is to allow the rule set developer to specify the category of advice that this advice belongs to. Two available categories are provided OOTB: issue and reminder. |
priority | CodeTableItem | The purpose of this rule attribute is to allow the rule set developer to specify the priority of this advice item. The priority determines the order in which the advice item will appear on the list of advice displayed for the page. |
status | CodeTableItem | The purpose of this rule attribute is to allow the rule set developer to indicate whether the advice has had action taken on it or not. The status of the advice can be pending or complete. |