iConsole Review Queue Guide › Deploy the Review Queue › Configuration: Quick Setup › Custom Metric Definition

Custom Metric Definition

The most common method of customizing the RQ is by defining the review metrics. These metrics define how events are sampled in order to be placed onto review queues. Customizing the metric definition is described below.

Note: This customization is not needed if you want to use the default review metric. The default review review metric adds all events that triggered policy for all reviewers onto review queues.

Advisors and Managers

Example: An organization has two types of users and groups in the system, Advisors and Managers. In the user hierarchy, all Advisors are in the ADV group (or its subgroups) and all Managers are in the MGR group (or its subgroups).

Which Events Are Queued for the ADV Group?

• 5% sample of messages are selected from a pool of violations
• If the resulting number is between 10 and 50, only that number is applicable for review by Advisors
• If the resulting number is more than 50, only 50 messages are applicable for review by Advisors
• If the resulting number is less than 10, then we top it off for a total of 10 messages

Which Events Are Queued for the MGR Group?

• 2% sample of messages are selected from a pool of violations
• No minimum or maximum number is set for this group

Logically, we can define these metrics as follows:

To implement these metrics

Using an appropriate SQL interface such as SQL*Plus or TOAD:

1. Determine the internal GroupIDM and GroupID values for the group. This is done in SQL with the following:

   SELECT GROUPIDM,GROUPID FROM WGNGROUP WHERE GROUPNAME='ADV'
   

2. The stored procedure WGN_RQ_METRIC_INSERT_1 (SQL Server) or WGN_RQ.METRIC_INSERT_1 (Oracle) inserts the metric values into the table Wgn3ReviewMetrics (see step 4).

   Assuming that the ADV group has values 1 and 104 for GroupIDM and GroupID respectively, you must supply these necessary parameters to the procedure:

   1,104,0,5,0,'P','P' 
   1,104,1,10,1,null,'A'
   1,104,2,50,1,null,null
   

   Where the ordered parameters to the procedure are:

   GroupIDM,
   GroupID,
   Category (0,1,2,3),
   Value,
   ValueType (0=percentage, 1=absolute),
   MetricTarget ('A'=All,'P'=Prime,'X'=Excluded),
   DataTarget ('A'=All,'P'=Prime,'X'=Excluded),
   DataGrouping(0 or Null=no grouping, 1=grouping, defaults to NULL if not specified),
   Process (defaults to 1 if not specified)
   

   Although this customization can issue SQL Insert statements directly against this table, we strongly recommend that you use this stored procedure. Using this stored procedure prevents future schema changes causing customizations to fail.

3. Repeat steps 1 and 2 for MGR group.

   Assuming the MGR group has 1 and 105 for GroupIDM and GroupID respectively, supply these parameters to the procedure:

   1,105,0,2,0,'P','P'
   

4. Create a custom stored procedure. This stored procedure must implement these metrics and deploy them in the database.

   The simplest method to create a custom stored procedure is to edit the CA-supplied customizable package body WGN_RQ_CUST as shown below The physical source file is WGN_RQ_CUST_BODY.sql located in the Support\CustomSQLTemplates' directory on the installation image.

   Oracle

   PROCEDURE Set_Metrics
   IS
   BEGIN
   
     -- Default is to insert metric parameters for top-level group only.
     -- All other sub-groups inherit this.
   
     -- Wgn_RQ.Set_Metrics_Def_1;
   
     -- To use custom code the default call above must be commented out.
     -- Provide custom code as follows by always using the specific
     -- procedure/function calls where stated:
   
     -- purge existing metrics
     -- <<MANDATORY>>
     WGN_RQ_EXEC_DDL.Truncate_Table('Wgn3ReviewMetrics');
   
     -- insert new metrics
     -- <<OPTIONAL>>
     -- WGN_RQ.METRIC_INSERT_1(1,100,0,5,0,'P','P',
     -- <<p_DGrouping>>,<<p_Process>>);
     -- WGN_RQ.METRIC_INSERT_1(1,100,1,10,1,null,'A');
     -- WGN_RQ.METRIC_INSERT_1(1,100,2,50,1,null,null);
     -- WGN_RQ.METRIC_INSERT_1(1,101,0,2,0,'P','P');
     -- WGN_RQ.METRIC_INSERT_1(1,123,0,50,0,'P','P',1,1);
     -- WGN_RQ.METRIC_INSERT_1(1,103,0,75,0,'P','P',
     -- p_DGrouping=>1,p_Process=>1);
     -- WGN_RQ.METRIC_INSERT_1(1,118,3,75,0,'P','P');
     -- ...
     -- ... where <<p_DGrouping>> defaults to null
     -- ...   and <<p_Process>> defaults to 1 if omitted
   
     WGN_RQ.METRIC_INSERT_1(1,104,0,5,0,'P','P'); 
     WGN_RQ.METRIC_INSERT_1(1,104,1,10,1,null,'A');
     WGN_RQ.METRIC_INSERT_1(1,104,2,50,1,null,null);
     WGN_RQ.METRIC_INSERT_1(1,105,0,2,0,'P','P');
   
   END Set_Metrics;
   

   SQL Server

   CREATE PROC WGN_RQ_SET_METRICS_CUSTOM_1
   AS
   BEGIN
         truncate table wgn3reviewmetrics
   
         EXEC WGN_RQ_METRIC_INSERT_1 1,104,0,5,0,'P','P' 
         EXEC WGN_RQ_METRIC_INSERT_1 1,104,1,10,1,null,'A'
         EXEC WGN_RQ_METRIC_INSERT_1 1,104,2,50,1,null,null
         EXEC WGN_RQ_METRIC_INSERT_1 1,105,0,2,0,'P','P'
   END
   

More information:

Metric Definitions