IBM Support

Managing the space consumed by historical output of data rule and rule set executions in InfoSphere Information Analyzer

Technote (FAQ)


Question

How do I manage the space that is consumed by historical output of data rule and rule set executions in InfoSphere Information Analyzer?

Cause

Each execution of a data rule or rule set creates output tables that contain the results of the run. The result data is associated with each run, and not per column or table. Depending on the output selections and data volumes, these output tables can be fairly large. Over time, the space that they consume within the IADB (InfoSphere Information Analyzer analysis database) can grow quite large. Currently, you can free up the space that is associated with rule executions by deleting such executions in the View Output screen of the data rule or rule set in the InfoSphere Information Server console. However, this can become cumbersome if you have a lot of rules and rule sets and many executions of them.

Answer

Available in Information Analyzer 8.5 Rollup Patch 8: Two new commands can help you clean up the output of data rules and rule sets in an easier and more efficient manner. You can retain the output data you need and get rid of the data that is no longer required. These commands allow you to control the space consumption in the analysis database.

Deleting execution history and output tables
The deleteExecutionHistory command deletes the data rule and rule set execution history information from the metadata repository (also known as the XMETA database). The command also deletes the data rule and rule set output tables from the analysis database.
To delete the execution history and output tables, use the CLI or the REST API call. projectName and ruleName are mandatory options. Also, it is mandatory to use one of the following options: executionID, keepLastRuns, olderThanNMonths, olderThanNWeeks, or olderThanDate.

    • CLI command
      -deleteExecutionHistory -host hostName -port portNumber -user userName -password password
        -projectName ProjectName
        -ruleName RuleName
        [-executionID executionID
        -keepLastRuns Number of runs to keep
        -olderThanNMonths Number of months to keep
        -olderThanNWeeks Number of weeks to keep
        -olderThanDate date in yyyy - mm - dd format]
    • REST API call
      This call uses the same options that are listed for the CLI command.
      http://host:port/InformationAnalyzer/executableRule/executionHistory

D elet ing only se lected output tables
The deleteOutputTable command deletes only the data rule/rule set output tables from analysis database.
To delete only selected output tables, use the CLI or the REST API call. projectName and ruleName are mandatory options. Also, it is mandatory to use one of the following options: executionID, keepLastRuns, olderThanNMonths, olderThanNWeeks, or olderThanDate.
    • CLI command
      -deleteOutputTable -host hostName -port portNumber -user userName -password password
        -projectName ProjectName
        -ruleName RuleName
        [-executionID executionID
        -keepLastRuns Number of runs to keep
        -olderThanNMonths Number of months to keep
        -olderThanNWeeks Number of weeks to keep
        -olderThanDate date in yyyy - mm - dd format ]
    • REST API call
      This call uses the same options that are listed for the CLI command.
      http://host:port/InformationAnalyzer/executableRule/executionHistory/outputTable?...




Examples
View the following example API calls and CLI commands to help understand how to use the new commands.
    Note:
    • projectName and ruleName are mandatory options. Also, it is mandatory to use one of the following options: executionID, keepLastRuns, olderThanNMonths, olderThanNWeeks, or olderThanDate.
    • When used in CLI the asterisk (*) always needs to be in double quotes(“*”).
    • For olderThanDate option, the date value entered should always be in yyyy-mm-dd format.

  • Delete all output tables of all rules and rulesets in all projects but keep the last 3 runs:
      IAAdmin -user <username> -password <password> -host <hostname> -port <portnumber> -deleteOutputTable -projectName “*” -ruleName “*” -keepLastRuns 3

      DELETE http://host:port/InformationAnalyzer/executableRule/executionHistory/outputTable?projectName=*&ruleName=*&keepLastRuns=3

  • Delete all output tables of all rules and rulesets in all projects which are older than 1 month
      IAAdmin -user <username> -password <password> -host <hostname> -port <portnumber> -deleteOutputTable -projectName “*” -ruleName “*” -olderThanNMonths 1

      DELETE http://host:port/InformationAnalyzer/executableRule/executionHistory/outputTable?projectName=*&ruleName=*&olderThanNMonths=1

  • Delete all output tables of all rules and rulesets in projects project1 and project 2 which are older than 2 weeks
      IAAdmin -user <username> -password <password> -host <hostname> -port <portnumber> -deleteOutputTable -projectName project1,project2  -ruleName “*” -olderThanNWeeks 2

      DELETE http://host:port/InformationAnalyzer/executableRule/executionHistory/outputTable?projectName=project1,project2&ruleName=*&olderThanNWeeks=2

  • Delete all output tables of rule1, and rule2 in project project1
      IAAdmin -user <username> -password <password> -host <hostname> -port <portnumber> -deleteOutputTable -projectName project1 -ruleName rule1,rule2 -executionID “*”

      DELETE http://host:port/InformationAnalyzer/executableRule/executionHistory/outputTable?projectName=project1&ruleName=rule1,rule2&executionID=*

  • Delete the execution history and output tables of the execution #3 of the rule rule1 in project project1
      IAAdmin -user <username> -password <password> -host <hostname> -port <portnumber> -deleteExecutionHistory -projectName project1 -ruleName rule1 -executionID 3

      DELETE http://host:port/InformationAnalyzer/executableRule/executionHistory?projectName=project1&ruleName=rule1&executionID=3


  • Delete all the execution histories and output tables of all the rules and rulesets in all the projects.
      IAAdmin -user <username> -password <password> -host <hostname> -port <portnumber> -deleteExecutionHistory -projectName “*” -ruleName “*” -executionID “*”

      DELETE http://host:port/InformationAnalyzer/executableRule/executionHistory?projectName=*&ruleName=*&executionID=*


  • Delete the execution histories and output tables of the ruleset ruleset1 in project project1 which are older than a certain date.
      IAAdmin -user <username> -password <password> -host <hostname> -port <portnumber> -deleteExecutionHistory -projectName project1 -ruleName ruleset1 -olderThanDate 2012-02-15

      DELETE http://host:port/InformationAnalyzer/executableRule/executionHistory?projectName=project1&ruleName=ruleset1&olderThanDate=2012-02-15


  • Delete the execution histories and output tables of the ruleset ruleset1 in project project1 which are older than a week.
      IAAdmin -user <username> -password <password> -host <hostname> -port <portnumber> -deleteExecutionHistory -projectName project1 -ruleName ruleset1 -olderThanNWeeks 1

      DELETE http://host:port/InformationAnalyzer/executableRule/executionHistory?projectName=project1&ruleName=ruleset1&olderThanNWeeks=1


Error scenarios
This section describes what you can expect when an invalid value is entered for various options.

execution ID

    • When an execution ID is entered and the execution with that ID does not exist, a warning message similar to the following is issued.
        <?xml version="1.0" encoding="UTF-8"?>
        <iaapi:Warnings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:iaapi=" http://www.ibm.com/investigate/api

                <Error xsi:type="iaapi:NoExecutionFound" executionID="*" resourceType="executionHistory" ruleName="*">
          <Message>No execution with ID &quot;*&quot; was found for rule &quot;*&quot; and has been ignored.</Message>
        </Error>
      </iaapi:Warnings>
    • When an invalid execution ID like a, xyz, -1 is entered, the command fails, and the subsequent command will not be executed. Failure throws an ExecutionNotFound exception or shows command help. In the case of negative numbers, the command considers them another option. The error flags negative numbers as "invalid" and shows the command help.

keepLastRuns
    • When you enter a number greater than the number of executions available, whatever executions are available are kept and no error or warning message is shown. No deletion takes place.
    • When a invalid number like x, abc, -1, 0 is entered, the command fails, and the subsequent command will not be executed. Failure throws an ExecutionNotFound exception or shows command help. In the case of negative numbers, the command considers them another option. The error flags negative numbers as "invalid" and shows the command help. (Note: In the case of keepLastRuns, 0 is also an invalid number)

olderThanNMonths
    When a invalid number like x, abc, -1, ½ is entered, the command fails, and the subsequent command will not be executed. Failure throws an InvalidNumber exception or shows command help. In the case of negative numbers, the command considers them another option. The error flags negative numbers as "invalid" and shows the command help.

olderThanNWeeks
    When a invalid number like x, abc, -1, ½ is entered, the command fails, and the subsequent command will not be executed. Failure throws and InvalidNumber exception or shows command help. In the case of negative numbers, the command considers them another option. The error flags negative numbers as "invalid" and shows the command help.

olderThanDate
    • When a invalid date like x, abc, -1, ½ is entered, , the command fails, and the subsequent command will not be executed. Failure throws an InvalidDate exception or shows command help. In the case of negative numbers, the command considers them another option. The error flags negative numbers as "invalid" and shows the command help.
    • When a future date is entered, a warning message similar to the following message is displayed.
      <?xml version="1.0" encoding="UTF-8"?>
      <iaapi:Warnings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:iaapi="http://www.ibm.com/investigate/api
          <Error xsi:type="iaapi:FutureDateUsed"
          date="Sat May 26 00:00:00 PDT 2012">
          <Message>The date used &quot;Sat May 26 00:00:00 PDT 2012&quot; is a future Date. Choose a valid date.</Message>
          </Error>
       </iaapi:Warnings>
    • When a date which is not in the yyyy-mm-dd format is entered, a warning message similar to the following message is issued.
      <?xml version="1.0" encoding="UTF-8"?>
      <iaapi:Warnings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:iaapi="http://www.ibm.com/investigate/api
        <Error xsi:type="iaapi:UnSupportedDateFormat">
          <Message>The format of the date entered is not supported. Please use a date in 'yyyy-mm-dd' format.</Message>
        </Error>
      </iaapi:Warnings>

Document information

More support for: InfoSphere Information Analyzer

Software version: 8.5.0.2

Operating system(s): AIX, HP-UX, Linux, Solaris, Windows

Software edition: All Editions

Reference #: 1593395

Modified date: 19 May 2014