RuleSets

This component runs the Rule Sets (RST) function.

Note: Before you set up a new Rule Set, you must first create at least one Event Profile.

Methods

CreateOrAmend
Driver Type: SASI
Use this method to create or amend one or more rulesets. A ruleset is created if it does not exist and amended if it does.
Delete
Driver Type: SASI
Use this method to delete a rule set.
Query
Driver Type: Export
Use this method to obtain rule set details or to extract rule set data from SunSystems.

Mandatory fields

  • When amending a rule set, the following must be supplied:

    • EventCode - payload element <EventCode>

    • Rule Code - payload element <RuleCode>

  • When creating a rule set, the following must be supplied:

    • EventCode - payload element <EventCode>

    • Rule Code - payload element <RuleCode>

    • Description - payload element <Description>

  • When creating or amending rule set details, the following must be supplied:

    • Rule Command - payload element <RuleCommand>

    • Literal 1 - payload element <Literal1>

    • Rule Action - payload element <RuleAction>

Note: At runtime the component validates the payload contents to ensure that the values supplied are correct. Various combinations of values may require other elements in the payload to be specified before the payload can be processed successfully.

Related data

Rule Set Details.