Managing Rule Sets

A Rule Set is made up of one or more Packages containing Rules, Quick Rules, Actions and Quick Actions. Rule Sets are used to manage, publish, backup and restore these Packages.

All Rule Sets are created within the top level content folder.

Note: In order for rulesets to be available within application Add-ins or the web app widget, they must be published (see Publishing Rulesets) and associated with a data service (see Configuring a Data Service).

Note: In order to use particular feature classes within your Rules, you must select a schema for the Ruleset (see Managing Schemas).

Creating Rulesets

In order to create your own rules or packages, you must first create a ruleset in which to store them.

Create a New Ruleset

1. Log in to the Rule Author.

2. Right-click on the content folder and select New Ruleset.

3. Enter a name and click Create.

   The new Ruleset is created and added to the content folder.

Publishing Rulesets

Published rulesets can be accessed by datasets, and are visible within the application Add-ins or the web app widget.

Any unpublished rules within a ruleset will be marked with an icon.

Publish a ruleset

1. Right-click on the required ruleset.

2. Click Publish.

   A confirmation message is displayed once the ruleset has been successfully published.

   

   Confirmation that ruleset is published

   Note: If the Ruleset fails validation, an error will be displayed.

Downloading and Uploading Rulesets

Rulesets (and the Rules and Actions contained within them) can be downloaded or uploaded as a backup file (.rules).

A .rules file can be extracted from one Rule Author and then uploaded to another.

Note: The free ruleset is a .rules backup file, and is uploaded in the same way.

Note: It is also possible to upload XML data. Please contact us for further information.

Download a Ruleset

1. Right-click on the required ruleset.

2. Select Download.

   

   Downloading a ruleset

3. The backup file is downloaded to the default web downloads location on your computer.

Upload a Ruleset

1. Log in to the Rule Author.

2. Right-click on the contents folder in the sidebar and click Upload Ruleset.

   

   Uploading a ruleset

3. Enter a name for your ruleset.

   

   Select a ruleset to upload

4. Either drag and drop your .rules file onto the Upload Ruleset box, or click on the box and navigate to your file.

5. Click Upload.

   A confirmation message is displayed once the ruleset has been successfully uploaded.

   Note: An error message may display if the corresponding schema cannot be found. See Managing Schemas for information on how to upload a corresponding schema.

Moving, Copying and Deleting Rulesets

Rulesets can be moved to a new destination folder, copied, or deleted.

Move a Ruleset

1. Right-click on the Ruleset and select Cut.
2. Right-click on the destination folder and select Paste.
3. Enter a new name for the Ruleset and click OK.

Copy a Ruleset

1. Right-click on the Ruleset and select Copy.
2. Right-click on the destination folder and select Paste.
3. Enter a new name for the Ruleset and click OK.

Delete a Ruleset

1. Right-click on the Ruleset and select Delete.
2. Click Confirm Delete to permanently delete the Ruleset.