Reporting database purge task

The reporting database purge task purges records from the reporting and analytics database only. It attempts to purge records that reach their expired time from specific database tables that contain business day data.

The task deletes the data from the database tables that are shown in the following table. Data can also be deleted from tables that are not on this list, such as when data is deleted from any child tables.
ADJUSTMENT_ENTRY BUNDLE BUSINESS_DAY
CASH_LETTER ENTRY FILE_TRACKING
IMAGE_ADDENDUM IMAGE_DATA IMAGE_INFO
IPD_PROCESS_LOCK ISN_XREF ITEM
ITEM_ADDENDUM ITEM_RECORD ITEM_VAL
OUTBOUND_FILE OUTBOUND_PRES_GROUP OUTBOUND_PRESENTMENT
PAYMENT PAYMENT_USER PAYMENT_VALUE
PRESENTMENT PRESENTMENT_GROUP REMEDIATION_ITEM
REMEDIATION_UOW REPAIR_AUDIT REPAIR_UOW
RISK_ACT_MONITOR RISK_PAYMENT_MONITOR_REJECT RISK_PAYMENT_MONITOR_XREF
RISK_PAYMENT_REJECT RUNNABLE_TASK SEGMENT
SIDEPOINT SUSPECT_DATA TASK
TRACKABLE WIP_RECORD  
Consider the following information when you configure this task to purge records from these tables in the reporting and analytics database:
  • Configure the task to run automatically on a scheduled basis to ensure that the tables in the database are kept current. Scheduling a purge also minimizes the volume of data that is stored in the database.
  • This task cannot be run concurrently.

Implementing the task

To run this task, you need to add the FTM base purge utility to the Services Framework engine pod. The steps to implement the reporting database purge task in Services Framework are shown in the following list.
  1. Add the FTM base purge utility to the Services Framework engine pod. For more information, see Add the FTM base purge utility to the Services Framework engine pod
  2. Register the reporting database purge task.
  3. Configure the reporting database purge task.
    1. Set the appropriate configuration parameters for purge processing.
  4. Schedule the reporting database purge configuration to run on a recurring basis.

Add the FTM base purge utility to the Services Framework engine pod

The steps to add the FTM base purge utility to the Services Framework engine pod are shown in the following list.
  1. Download the FTM base purge utility from the artifacts pod and configure the properties. For more information about configuring the purge utility, see Configuring and running.
  2. Use SFTP to copy the purge utility files to the /opt/ibm/application/services-engine/lib directory. Copy the modified or encrypted properties and the purgeDB.jar.
  3. Add the data source. Modify the <ftm-instance>-services-engine-dropins configmap to add the data source to the YAML. For example, 
    <!-- Data Source for Services Framework engine Reporting DB -->
    <authData id="reportingDataSourceAuth" user="${DB_USER}"
    password="${DB_PASSWORD}"/>

    <dataSource id="ServicesEngineReportingDS"
    jndiName="jdbc/iyb/services/RepDB" queryTimeout="600s"
    validationTimeout="10s" containerAuthDataRef="reportingDataSourceAuth">
        <jdbcDriver javax.sql.ConnectionPoolDataSource="com.ibm.db2.jcc.DB2ConnectionPoolDataSource" libraryRef="DB2JCCLib"/>
        <connectionManager id="DSConMgr" connectionTimeout="360" maxPoolSize="100" minPoolSize="10" enableContainerAuthForDirectLookups="true"/>
        <properties.db2.jcc databaseName="${DB_NAME}"
                            currentSchema="${DB_SCHEMA}"
                            currentFunctionPath="${DB_SCHEMA}"
                            driverType="4"
                            portNumber="${DB_PORT}"
                            serverName="${DB_HOST}"
                            useJDBC4ColumnNameAndLabelSemantics="2"
                            sslConnection="${DB_ENABLE_SSL}"
                            sslTrustStoreType="JKS"
                            sslTrustStoreLocation="${TRUST_STORE_LOC}"
                            sslTrustStorePassword="${TSTORE_PASSWORD}"/>
    </dataSource>
  4. Restart the Services Framework engine pod.