Rules Targets

The Cúram Rules Codification Guide and the Cúram Rules Editor Guide provide an introduction to the support for rules in Cúram. A rule set is the fundamental structure which describes the rules within a Cúram application. It is the database that is the system of record for rule sets. This allows the rule sets to be changed at run-time via an administration client. However, support is also provided for representing rule sets as .xml files. These .xml files can be used for source control management. To allow for the synchronization between these .xml files and the database a number of extra targets have been introduced:

Representing Rulesets as XML Files: Support for ruleset import and export is only there to allow source control management and to exchange rulesets between machines. Direct editing of the ruleset XML files is not supported in any way.

listrulesets - Produce a listing of the names and identifiers of the rulesets that are present on the database.
exportruleset - This target exports a ruleset definition (.xml file) from database to the file system. This command takes two parameters - rulesetid and component. Exported ruleset will be saved as [specified rulesetid].xml in <SERVER_DIR>/components/[specified component]/rulesets folder.
rulesetid - Identifier of the ruleset that is to be exported from the database.

component - Name of the component to which the rule set has to be exported (copied).

For example:
```
build exportruleset
-Drulesetid=PRODUCT_1
-Dcomponent=custom
```
Where 'PRODUCT_1' denotes the identifier of the ruleset that is to be exported from the database and 'core' denotes the name of the component to which the rule set has to be exported (copied).
importruleset - This target imports a ruleset definition (.xml file) from a file system to the database. It validates the rule set ID for uniqueness before importing the rule set, it does this by searching for existing IDs in the SERVER_DIR/components/../rulesets directories. This command takes two parameters- ruleset.file and overwrite.
ruleset.file - This parameter denotes the path of the ruleset that is to be placed on the database.

overwrite (Optional) - This is an optional flag with the default value as false, indicating whether the database should be overwritten if the ruleset already exists.

For example:
```
build importruleset
-Druleset.file=
  <SERVER_DIR>/components/core/rulesets/PRODUCT_1.xml
-Doverwrite=true
```
Where <SERVER_DIR>/components/core/rulesets/PRODUCT_1.xml denotes the path of the ruleset definition file and true denotes the flag to overwrite the database, if ruleset already exists.
validateallrulesets - Validates all the rule sets in the Cúram application. This target has to be invoked from the SERVER_DIR directory, where it scans all the components for rule set files and validates them. For schema validation this target uses the rule set schema located in CURAMSDEJ/lib directory by default, unless another schema is specified by using an optional property 'schema.file'.
The validator ensures that the rule set ID is unique by searching for existing IDs in the SERVER_DIR/components/../rulesets directories.

schema.file (Optional) - This optional parameter specifies the rule set schema that has to be used for validating the rule sets.

For example:
```
ant validateallrulesets
ant validateallrulesets
            -Dschema.file=C:/Rules/ruleset.xsd
```
validaterulesets - Validates all the rule sets in the specified directory. The property 'rulesets.dir' has to be specified when invoking the target. For schema validation this target uses the rule set schema located in CURAMSDEJ/lib directory by default, unless another schema is specified by using an optional property 'schema.file'.
The validator ensures that the rule set ID is unique by searching for existing IDs in the SERVER_DIR/components/../rulesets directories.

schema.file (Optional) - This optional parameter specifies the rule set schema that has to be used for validating the rule sets.

rulesets.dir - This parameter specifies the directory within which rule sets are to be validated.

For example:
```
ant validaterulesets
            -Drulesets.dir=
              <SERVER_DIR>/components/core
ant validaterulesets
            -Drulesets.dir=
              <SERVER_DIR>/components/core
                -Dschema.file=C:/Rules/ruleset.xsd
```
validateruleset - Validates the specified rule set. The property 'ruleset.file' that denotes the rule set path and file name has to be specified when invoking the target. For schema validation this target uses the rule set schema located in CURAMSDEJ/lib directory by default, unless another schema is specified by using an optional property 'schema.file'.
The validator ensures that the rule set ID is unique by searching for existing IDs in the SERVER_DIR/components/../rulesets directories.

schema.file (Optional) - This optional parameter specifies the rule set schema that has to be used for validating the rule set.

ruleset.file - This parameter specifies the rule set path and file name.

For example:
```
ant validateruleset
            -Drulesets.file=
            <SERVER_DIR>/components/core/rulesets/PRODUCT_1.xml
ant validateruleset
            -Drulesets.file=
              <SERVER_DIR>/components/core/rulesets/PRODUCT_1.xml
              -Dschema.file=C:/Rules/ruleset.xsd
```
rulesfunctionsmerge - Merge rules custom function meta-data from.xml files.