Using the Alert Purge Utility>

7.3.1 Using the Alert Purge Utility>

The Alert Purge Utility is not part of an automated batch process. You run this manual process only when necessary.

The following sections describe configuring and executing the utility, as well as the utility’s process flow.

Configuring the Alert Purge Utility

To configure the Alert Purge Utility, follow these steps:

Navigate to the <OFSAAI Installed Directory>/database/db_tools/mantas_cfg.

Edit the parameters in the install.cfg file to the desired settings. This file contains common configuration information that the Alert Purge Utility and other utilities require for processing. The following is a sample section from the install.cfg file for configuration information specific to this utility:

################ ALERT PURGE CONFIGURATION ##########################
# Set the Alert Purge input variables here.
# (use the word "null" as the value of any parameters that are not
#  to be used)
#

# Specify whether or not to consider Matches
limit_matches=N

# Specify whether or not to purge the data 
purge=Y

# Specify batch size for which commit should perform
batch_size=5000

job=null
scenario=null
# enter dates, with quotes in the following format:
#   'DD-MON-YYYY HH24:MI:SS'
start_date=null
end_date=null
alert_status=NW

# Specify purge db user
purge.database.user=f802_fccm

# Specify purge db user password.
purge.database.password=

# Specify whether alerts has to be purged or not.
purge_alert_flag=Y

# Specify whether fatca cases/assessments has to be purged or not.
purge_fatca_flag=Y

# Specify whether case has to be purged or not.
purge_case_flag=Y

# Specify defualt rule set.
purge_default_rule_set=

# Specify total number of threads should be used for the process.
purge_threads_no=10

# Specify report directory for report on process performed.
purge_report_directory=

# Specify product version
purge_product_version=


#Base Working Directory required to put the temporary log from Database Server
ap.storedproc.logdir=/tmp

#The common Path required to put the SQL files to execute
commonSQLFilePath=/scratch/ofsaadb/BD804_Final/BD804FL/database/db_tools/data

Note:

Not specifying a value of null , such as leaving a value blank, in this section of the install.cfg file causes undesirable results.

The following table describes required and optional parameters for this utility.

Table 7-4 Alert Purge Utility Parameters

Parameter	Description
purge	Determines how the utility performs processing, depending on the specified value: N(default): Performs all processing up to the point of the purge. The utility identifies resulting matches, alerts, and actions, but performs no purging. Y: Performs the above in addition to purging matches, alerts, and actions.
limit_matches	Identifies restrictions on the matches to delete: Y (default): If a match that you want to delete is part of an alert that contains matches that you do not want to delete, do not delete this match either (applies to multi-match alerts). N: Deletes all selected matches for purging based on the input criteria. The utility deletes only alerts and associated actions that exclusively contain matches to be purged. Note: The system purges matches that do not relate to alerts, regardless of the value of limit_matches.
batch_size	Optional: Sets the batch size of purge actions to minimize log space use. Specifying a non- positive value or specifying no value uses the default of 5,000 rows.
purge_alert_flag	Determines whether or not the utility would purge alerts, depending on the specified value: N: Does not purge the alerts irrespective of whether or not they identified according to the purge rule being used. This may be used when purging only the cases. Y(default): Purges the alerts as identified by the purge rule used to perform the purge operation.
purge_case_flag	Determines whether or not the utility would purge cases, depending on the specified value: N: Does not purge the cases irrespective of whether or not they identified accordingto the purge rule being used. This may be used when purging only the cases. Y(default): Purges the cases as identified by the purge rule used to perform the purge operation.
purge_default_rule_set	(Optional) Indicates the default set of rules to be used for purging alerts. You may either specify the purge rules to be used against this parameter, or pass the name of the specific purge rules) as command line parameters. You may specify a single purge rule, or a comma separated list of purge rules to be used as default when no other purge rule is provided from the command line.
purge_threads_no	(Optional) Identifies the number of concurrent threads to create for purging the alerts to optimize the performance. Specifying a non-positive value or specifying no value uses the default of 10 threads.
purge_report_directory	Identifies the absolute path to the directory where the purge activity report should be generated. The report file name has a name similar to Purge_<YYYYMMDD.HH.MM.SS>.txt. Here <YYYYMMDD.HH.MM.SS>represents current timestamp when the utility was executed.
purge_product_version	Identifies the OFSBD Product Version installed by the client.

The<OFSAAI Installed Directory>/database/db_tools/mantas_cfg/etc/xml/PurgeRules.xml file contains purge rules configuration information that the Alert Purge Utility requires for processing. The following sample section from the PurgeRules.xml file provides configuration information for this utility.

<?xml version="1.0" encoding="utf-8"?>
<xs:RuleSet xmlns:xs="http://namespaces.mantas.com/RuleSet">
  <Alert>
    	<Rule id="1">
   	 	<IdentifierList>286,4565,4537</IdentifierList>
 	<ScenarioIdList>114697002</ScenarioIdList>
      		<ScenarioClassList>CR</ScenarioClassList>
      		<CreateDate>
        			<StartDate>2011-05-25</StartDate>
        			<EndDate>2011-05-25</EndDate>
      		</CreateDate>
      		<DomainCode>MTS</DomainCode>
      		<BatchId>2</BatchId>
      		<ThresholdSetIds>118745206,118710066</ThresholdSetIds>
      		<LastActionDate>
        			<StartDate>2016-05-25</StartDate>
        			<EndDate>2016-05-25</EndDate>
      		</LastActionDate> 
      		<Status>CL</Status>
      		<JobIds>102202</JobIds>
    	</Rule>
   </Alert>
  <Case>
    	<Rule id="2">
      		<IdentifierList>CA51300004,CA3773,CA3757,CA3766</IdentifierList>
      		<CaseTypeList>FR_EE,FR_ON</CaseTypeList>
      		<CreateDate>
        			<Age>1Y</Age>
      		</CreateDate>
      		<LastActionDate>
        			<StartDate>2016-06-22</StartDate>
        			<EndDate>2016-06-22</EndDate>
</LastActionDate>
    	</Rule>
    </Case>
</xs:RuleSet>

The following table describes the Purge Rules Configuration Parameters.

Table 7-5 Purge Rules Configuration Parameters

Parameter	Description
Alert/Case	Identifies and encapsulates the purge rules for Alerts. You may define any number of purge rules for alerts.
Rule	Identifies a set of rules to be used for purging Alert Information. All Alert Purge rules defined in this file must be provided a unique positive integer ID (as specified against the ID attribute). The value provided against the ID attribute is used by the utility to identify the rules to be used for carrying out the purge operations. Not specifying a unique value for the ID attribute may lead to undesirable results.
IdentifierList	Identifies a list of Alert IDs to be purged. You may specify more than one alert or case ID by separating them by comma.
ScenarioIdList	Identifies a list of Scenario IDs for which the alerts are to be purged. You may specify more than one Scenario ID by separating them by comma. This property is specific to alerts only. This should not be specified for cases
ScenarioClassList	Identifies a list of Scenario Class for which the alerts are to be purged. You may specify more than one Scenario Class by separating them by comma. This property is specific to alerts only. This should not be specified for cases
CreateDate	Identifies the dates to be considered for purging the alerts by their creation date. The date range may be provided in terms of Start Date or End Date, or the Age of the Alert or Case calculated from the current day/month/year. StartDate: Identifies the date from when the alerts are to be consideredfor purging. The date should be provided in the format YYYY-MM-DD. EndDate:Identifies the date up to which the alerts are to be purged. The date should be provided in the format YYYY-MM-DD Age: Identifies the age of the Alert/Case to be purged relative to the current date/month/year. Acceptable values for this parameter constitutes a non- negative number followed by D (Days), M (Months) or Y (Years). If we specify age of a record is 1 Day means it should complete 1 day in the database. That is from current day to yesterday. The example below gives more details: (Assume Current date: 21 NOV 2012) Case1: if age = 1Y: Date range would be considered: 21 NOV 2012 to 21 NOV 2011 (includes both days) if age = 5Y: Date range would be considered: 21 NOV 2012 to 21 NOV 2007 (includes both days) Case2: if age = 1M: Date range would be considered: 21 NOV 2012 to 21 OCT2012 (includes both days) if age = 5M: Date range would be considered: 21 NOV 2012 to 21 JUN2012 (includes both days) Case3: if age = 1D: Date range would be considered: 21 NOV 2012 to 20 NOV 2012 (includes both days) if age = 5D: Date range would be considered: 21 NOV 2012 to 16 NOV 2012 (includes both days) if age = 0D: Date range would be considered: 21 NOV 2012 to 21 NOV 2012 (that is, current date only) If only EndDate is specified, utility would consider it as on or before that date, in case of only StartDate being provided, utility would consider it as on or after that date. In-case both dates are specified utility would consider both the dates and the dates in between them.
BatchId	Identifies the list of Batch IDs for which the alerts should be purged. This property is specific to alerts only.
DomainCode	Identifies the list of domains for which the alerts should be purged. Acceptable values include: MTS TST PFM NVZ This property is specific to alerts only.
LastActionDate	Identifies the dates to be considered for purging the alerts by he date on which last action was taken on them. The date range may be provided in terms of Start Date or End Date, or the Age of the Alert or Case calculated from the current day/month/year. StartDate: Identifies the date from when the alerts/cases are to beconsidered for purging.The date should be provided in the format YYYY-MM-DD EndDate:Identifies the date up to which the alerts are to be purged. The date should be provided in the format YYYY-MM-DD Age: Identifies the age of the Alert or Case to be purged relative to the current date/month/year. Acceptable values for this parameter constitutes a non- negative number followed by D (Days), M (Months) or Y (Years). If we specify age of a record is 1 Day means it should complete 1 day in the database. That is from current day to yesterday. The example below gives more details: (Assume Current date: 21 NOV 2012) Case1: if age = 1Y: Date range would be considered: 21 NOV 2012 to 21 NOV 2011 (includes both days) if age = 5Y: Date range would be considered: 21 NOV 2012 to 21 NOV 2007 (includes both days) Case2: if age = 1M: Date range would be considered: 21 NOV 2012 to 21 OCT2012 (includes both days) if age = 5M: Date range would be considered: 21 NOV 2012 to 21 JUN2012 (includes both days) Case3 if age = 1D: Date range would be considered: 21 NOV 2012 to 20 NOV 2012 (includes both days) (ii)if age = 5D: Date range would be considered: 21 NOV 2012 to 16 NOV 2012 (includes both days) if age = 0D: Date range would be considered: 21 NOV 2012 to 21 NOV 2012 (that is, current date only) If only EndDate is specified, utility would consider it as on or before that date, in case of only StartDate being provided, utility would consider it as on or after that date. If both dates are specified utility would consider both the dates and the dates in between them.
Status	Identifies a list of Status Codes against which the Alert or Case should be purged. You may specify more than one Status Code by separating them by comma.
JobIds	Identifies the list of Job IDs for which the alerts should be purged. You may specify more than one Job ID by separating them by comma. This property is specific to alerts only.
ThresholdSetIds	Identifies the list of Threshold Set IDs for which the alerts should be purged. You may specify more than one Threshold Set ID by separating them by comma. This property is specific to alerts only.