Working with Rulesets
A ruleset is a collection of one or more RA rules that you have configured, along with their execution order and scoring priority. Each ruleset can be different from the other in terms of:
cara
A ruleset is a collection of one or more RA rules that you have configured, along with their execution order and scoring priority. Each ruleset can be different from the other in terms of:
- Set of configured rules
- Score and priority for each rule in the set
- Enabling or disabling of rules in the set
- Configured parameters and data for each rule
As a GA, you can configure multiple global rulesets that are available to all the organizations. These rulesets can then be used by other GAs or OAs of these organizations to create new rulesets simply by "copying from" an existing ruleset. In addition, the "copied" rules within a ruleset can also be edited. This not only significantly saves the time and effort required for individually configuring each rule again for organizations, but also reduces the number of errors.
RA is shipped with an out-of-the-box global ruleset called
DEFAULTORG-DEFAULT
. When you create a new organization, a default ruleset called <ORGANIZATION_NAME>
-DEFAULT is automatically created.This article covers the following topics:
How Do Rulesets Work
A ruleset is just a container and does not work on its own. You need to create rules within its context. Also, just creating it is not sufficient. You must assign it to an organization. Here is how to make rulesets work:
- Step 1:Create a ruleset either at a global level or at the level of an organization. You can also clone an existing ruleset for the purpose.See How to Create a Ruleset and How to Clone a Ruleset.
- Step 2:Configure and enable rules (out-of-the-box or custom) with the ruleset.See Working with Out-of-the-Box Rules and Creating Custom Rules by Using Rule Builder.
How to Create a Ruleset
Important!
After you create a global ruleset as a GA, the OAs of the individual organizations must assign these rulesets to their respective organizations. See How to Assign a Ruleset to an Organization for more information about how to do this.When you create a new rule simply by specifying a name, you create a rule based on default ruleset. This implies, your new ruleset inherits the default configurations for all out-of-the-box rules that make up the out-of-the-box ruleset. Like other RA configurations, you can create a ruleset at two levels::
How to Create a Ruleset at the Global Level
After you create a global ruleset as a GA, the OAs of the individual organizations must assign these rulesets to their respective organizations. See How to Assign a Ruleset to an Organization for more information about how to do this.
To create a new ruleset with all default settings at a global level, so that it is available to all organizations in the scope of the administrator who creates it:
- Ensure that you are logged in as a GA.
- Activate theServices and Server Configurationstab.
- Activate theRisk Analyticstab.
- Under theRulesetManagementsection on the side-bar menu, click theCreate Rulesetlink.The Create Ruleset page is displayed.
- Specify the name of the ruleset in theNamefield.
- ClickCreateto create and save the new ruleset.The ruleset is not yet active, and not available to your end users.
- To make the changes active, you must migrate them to production.Refer to How to Migrate a Ruleset to Production for instructions to do so.
How to Create a Ruleset at the Organization Level
After you create a global ruleset as a GA, the OAs of the individual organizations must assign these rulesets to their respective organizations. See "How to Assign a Ruleset to an Organization" for more information about how to do this.
To create a new ruleset with all default settings at the level of an organization, so that it is only available to the current organization:
- Ensure that you are logged in as an OA.
- Activate theOrganizationstab.
- Under theManage Organizationssection, click theSearch Organizationlink to display the Search Organization page.
- Enter the complete or partial information of the organization you want to search and clickSearch.A list of organizations matching the search criteria appears.
- Under theOrganizationcolumn, click the <ORGANIZATION_NAME> link for the required organization.The Organization Information page appears.
- Activate theRisk Enginetab.
- Under theRulesetManagementsection on the side-bar menu, click theCreate Rulesetlink.The Create Ruleset page is displayed.
- Specify the name of the ruleset in theNamefield.
- ClickCreateto create and save the new ruleset.The ruleset is not yet active, and not available to your end users.
- To make the changes active, you must migrate them to production.Refer to How to Migrate a Ruleset to Production for instructions to do so.
How to Clone a Ruleset
Before you clone a ruleset, you must ensure that the source ruleset has been assigned to an organization. See How to Assign a Ruleset to an Organization for detailed instructions, if you have already not done so.
As a GA or an OA, you can configure multiple rulesets that are available to all the organizations in your scope. These rulesets can then be used by other GAs or OAs of these organizations to create new rulesets simply by "copying from" an existing ruleset. This not only significantly saves the time and effort required for individually configuring each rule again for every required organization, but also reduces the number of potential errors. You can either clone from a system ruleset or some ruleset you created earlier. This topic covers:
How to Clone from SYSTEM Ruleset
RA is shipped with an out-of-the-box ruleset called
DEFAULTORG-DEFAULT
. When you create a new organization, a default ruleset called <ORGANIZATION_NAME>-DEFAULT
is automatically created. This ruleset offers the default settings for all the out-of-the-box rules that constitute this ruleset.Initially, it is highly recommended that you create new rulesets by cloning this SYSTEM ruleset.
Cloning SYSTEM Ruleset at Global Level
To clone from the SYSTEM ruleset at a global level:
- Ensure that you are logged in as a GA.
- Activate theServices and Server Configurationstab.
- Activate theRisk Analyticstab.
- Under theRulesetManagementsection on the side-bar menu, click theCreate Rulesetlink.The Create Ruleset page is displayed.
- Specify the name of the ruleset in theNamefield.
- In theAdvanced Optionsection:
- Select theCopy from an Existing Rulesetoption to clone an existing ruleset.
- SelectSYSTEM - DEFAULTfrom the corresponding list.
- ClickCreateto create and save the new ruleset.The ruleset is not yet active, and not available to your end users.
- To make the changes active, you must migrate them to production.Refer to How to Migrate a Ruleset to Production for instructions to do so.
Cloning SYSTEM Ruleset at Organization Level
To clone from the SYSTEM ruleset at the level of an organization:
- Ensure that you are logged in as an OA.
- Activate theOrganizationstab.
- Under theManage Organizationssection, click theSearch Organizationlink to display the Search Organization page.
- Enter the complete or partial information of the organization you want to search and clickSearch.A list of organizations matching the search criteria appears.
- Under theOrganizationcolumn, click the <ORGANIZATION_NAME> link for the required organization.The Organization Information page appears.
- Activate theRisk Enginetab.
- Under theRulesetManagementsection on the side-bar menu, click theCreate Rulesetlink.The Create Ruleset page is displayed.
- Specify the name of the ruleset in theNamefield.
- In theAdvanced Optionsection:
- Select theCopy from an Existing Rulesetoption to clone an existing ruleset.
- SelectSYSTEM - DEFAULTfrom the corresponding list.
- ClickCreateto create and save the new ruleset.The ruleset is not yet active, and not available to your end users.
- To make the changes active, you must migrate them to production.Refer to How to Migrate a Ruleset to Production for instructions to do so.
How to Clone an Existing Ruleset
This section walks you through the steps for cloning an existing ruleset.
Cloning an Existing Ruleset at Global Level
To clone from an existing ruleset at a global level:
- Ensure that you are logged in as a GA.
- Activate theServices and Server Configurationstab.
- Activate theRisk Analyticstab.
- Under theRulesetManagementsection on the side-bar menu, click theCreate Rulesetlink.The Create Ruleset page is displayed.
- Specify the name of the ruleset in theNamefield.
- In theAdvanced Optionsection:
- Select theCopy from an Existing Rulesetoption to clone an existing ruleset.
- Select the name of the ruleset whose configuration you want to copy from the corresponding list.
- ClickCreateto create and save the new ruleset.The ruleset is not yet active, and not available to your end users.
- To make the changes active, you must migrate them to production.Refer to How to Migrate a Ruleset to Production for instructions to do so.
Cloning an Existing Ruleset at Organization Level
To clone from an existing ruleset at the level of an organization:
- Ensure that you are logged in as an OA.
- Activate theOrganizationstab.
- Under theManage Organizationssection, click theSearch Organizationlink to display the Search Organization page.
- Enter the complete or partial information of the organization you want to search and clickSearch.A list of organizations matching the search criteria appears.
- Under theOrganizationcolumn, click the <ORGANIZATION_NAME> link for the required organization.The Organization Information page appears.
- Activate theRisk Enginetab.
- Under theRulesetManagementsection on the side-bar menu, click theCreate Rulesetlink.The Create Ruleset page is displayed.
- Specify the name of the ruleset in theNamefield.
- In theAdvanced Optionsection:
- Select theCopy from an Existing Rulesetoption to clone an existing ruleset.
- Select the name of the ruleset whose configuration you want to copy from the corresponding list.
- ClickCreateto create and save the new ruleset.The ruleset is not yet active, and not available to your end users.
- To make the changes active, you must migrate them to production.Refer to How to Migrate a Ruleset to Production for instructions to do so.
How to Assign a Ruleset to an Organization
After a GA or an OA creates a ruleset for their organization and migrates it to production, you must activate this ruleset for an organization within your scope for it to take effect. This is achieved by assigning the ruleset to an organization.
To assign an existing ruleset to an organization:
- Ensure that you are logged in with the required privileges and scope to assign rulesets.
- Activate theOrganizationstab.
- Under theManage Organizationssection, click theSearch Organizationlink to display the Search Organization page.
- Enter the complete or partial information of the organization you want to search and clickSearch.A list of organizations matching the search criteria appears.
- Under theOrganizationcolumn, click the <ORGANIZATION_NAME> link for the required organization.The Organization Information page appears.
- Activate theRisk Enginetab.
- Under theRulesetsection, click theAssign Rulesetlink.The Assign Ruleset page appears.
- Select the ruleset that you want to activate from theSelect Ruleset to assignlist.
- ClickSaveto make the specified ruleset active for the current organization.
- To make the changes active, you must migrate them to production.Refer to How to Migrate a Ruleset to Production for instructions to do so.
How to Edit a Ruleset
Important!
Before you modify the definition of a ruleset, you must assign the ruleset. See How to Assign a Ruleset to an Organization for detailed instructions, if you have already not done so.To edit the definition of an existing ruleset:
- Ensure that you are logged in with the required privileges and scope to assign rulesets.
- Ensure that the rule has been assigned.
- Activate theOrganizationstab.
- Under theManage Organizationssection, click theSearch Organizationlink to display the Search Organization page.
- Enter the complete or partial information of the organization you want to search and clickSearch.A list of organizations matching the search criteria appears.
- Under theOrganizationcolumn, click the <ORGANIZATION_NAME> link for the required organization.The Organization Information page appears.
- Activate theRisk Enginetab.
- Under theRules Managementsection, click theRules and Scoring Managementlink.The Rules and Scoring Management page appears.
- Select the ruleset that you want to edit from theSelect Ruleset to assignlist.
- For each rule that you want to change in the ruleset, in thePROPOSEDcolumn of the displayed table:
- Select (to enable the rule) or clear (to disable the rule) theEnableoption.
- Specify the requiredRisk Score.
- Select a priority for the rule from thePrioritylist.
- In thePROPOSEDcolumn forDefault Score(the second table on the page), specify the required Risk Score.RA uses this value to generate the final Risk Score and Advice if none of the rules in the preceding table match.
- ClickSaveto save the changes you made on this screen.The changes are not yet active and are not available to your end users.
- To make the changes active, you must migrate them to production.Refer to How to Migrate a Ruleset to Production for instructions to do so.
How to Migrate a Ruleset to Production
When you configure an out-of-the-box rule, custom rule, or callout, the change is yet not permanent, and the changed configuration data is referred to as
Proposed data
. This data can be created over a period of time by using several administrative sessions. While you configure this data, it is stored in the Proposed Configuration
area and is reflected in the Proposed
column on respective configuration page. As a result, any changes that you make to the Proposed
column affect this data.When all data is configured according to your requirements, then the Proposed data can be converted to
Active data
(the Active
column on respective configuration page) by migrating it to production and refreshing the Transaction Server cache.At any point in time, RA Servers work with Active data configurations
only
. This means, RA only uses Active data for real-time risk evaluations and for generating Risk Score and the corresponding Risk Advice.After the Proposed data has been migrated to Active data, if you configure the data again, a copy of the Active data is created in the Proposed configuration area. Further additions or deletions can be done to the Proposed data until configurations are ready to be migrated to production. All modifications are reflected only in the Proposed data. However, Reports can be viewed as Active or Proposed configurations. Active data is versioned to keep track of the changes made to the RA configuration data. Every time the Proposed data is migrated to production, unique data versions are created for the new set of Active configuration data. Like other RA configurations, you can migrate a ruleset to production at two levels:
- Global level (How to Migrate a Ruleset to Production at the Global Level)
- Organization level (How to Migrate a Ruleset to Production at the Organization Level)
How to Migrate a Ruleset to Production at the Global Level
To migrate a ruleset at system (or global) level:
- Ensure that you are logged in as a GA or as an OA.
- Activate theServices and Server Configurationstab.
- Activate theRisk Analyticstab.
- Under theMigrate to Productionsection on the side-bar menu, click theMigrate to Productionlink.The Migrate to Production page appears.
- On the page, either:
- Select theSelect All Rulesetsoption, if you want to migrate all the changes that you made to all the configured rulesets.or
- Select a specific ruleset from theSelect Ruleset(s)list to migrate the changes that you made to this ruleset.
- ClickMigrate.The page to confirm the action is displayed.
- On the confirmation page, clickConfirmto start the migration process.Based on the volume of data that you are migrating to production, the migration process might take a few minutes.After the migration is completed, the "The proposed data has been successfully migrated to Production." message is displayed.
How to Migrate a Ruleset to Production at the Organization Level
To migrate a ruleset to production so that the changes are available:
- Ensure that you are logged in as an OA.
- Activate theOrganizationstab.
- Under theManage Organizationssection, click theSearch Organizationlink to display the Search Organization page.
- Enter the complete or partial information of the organization you want to search and clickSearch.A list of organizations matching the search criteria appears.
- Under theOrganizationcolumn, click the <ORGANIZATION_NAME> link for the required organization.The Organization Information page appears.
- Activate theRisk Analyticstab.
- Under theMigrate to Productionsection on the side-bar menu, click theMigrate to Productionlink.The Migrate to Production page appears.
- On the page, either:
- Select theSelect All Rulesetsoption, if you want to migrate all the changes that you made to all the configured rulesets.or
- Select a specific ruleset from theSelect Ruleset(s)list to migrate the changes that you made to this ruleset.
- ClickMigrate.The page to confirm the action is displayed.
- On the confirmation page, clickConfirmto start themigration process.Based on the volume of data that you are migrating to production, the migration process might take a few minutes.After the migration is completed, the "The proposed data has been successfully migrated to Production." message is displayed.