User Activity Purge

This transactions purges all activity records from the table older than the specified retention days.

This agent should be used whenever user activity records need to be removed, such as after a application server restart.

You can use the pseudo-logic of purge codes to benefit in analyzing purges. A user activity record is picked up for purge if it meets the following condition:

Attributes

The following are the attributes for this time-triggered transaction:

Table 1. User Activity Purge Attributes
Attribute Value
Base Transaction ID USERACTIVITYPRG
Base Document Type General
Base Process Type General
Abstract Transaction No
APIs Called None
User Exits Called YFSBeforePurgeUE

Criteria Parameters

The following are the criteria parameters for this transaction:

Table 2. User Activity Purge Criteria Parameters
Parameter Description
Action Required. Triggers the transaction. If left blank, it defaults to Get, the only valid value.
Number of Records To Buffer Optional. Number of records to retrieve and process at one time. If left blank or specified as 0 (zero), it defaults to 5000.
PurgeCode Required. Cannot be modified. Used for internal calculations, such as determining retention days. Corresponds with the PurgeCode used in Business Rules Purge Criteria.
BatchDelete Required. Mode in which the records get deleted from the user activity table. Default to "".
  • Y - Records are deleted in a batch.
  • N - Records are deleted one by one.
CollectPendingJobs If this parameter is set to "N", the agent does not collect information on the pending jobs for this monitor. This pending job information is used for monitoring the monitor in the System Management Console.
Live Optional. Mode in which to run. Defaults to "N".
  • Y - Production mode. Deletes records from regular tables.
  • N - Test mode.
ColonyID Required in a multischema deployment where the YFS_USER_ACTIVITY table may exist in multiple schemas. Runs the agent for the colony.

Statistics Tracked

The following statistics are tracked for this transaction:

Table 3. User Activity Purge Statistics
Parameter Description
NumActivitiesPurged Number of records purged from the User Activity table.

Pending Job Count

For this transaction the pending job count is the number of records that can be purged from the YFS_USER_ACTIVITY table.

Events Raised

None.

Tables Purged

YFS_USER_ACTIVITY