Person info history purge

This purge deletes records from the YFS_PERSON_INFO_H table based on the purge criteria.

Attributes

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

Table 1. PersonInfo history purge attributes
Attribute	Value
Base Transaction ID	PERSONINFOHISTPRG
Base Document Type	General
Base Process Type	General
Abstract Transaction	No
APIs Called	None
User Exits Called	None

Criteria parameters

The following are the criteria parameters for this transaction:

Table 2. PersonInfo history 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 the number specified is less than 10000, it defaults to 10000. If the number specified is greater than 10000, then that value is used.
Live	Optional. Mode in which to run. Valid values are: Y - Default value. Moves qualifying records from the regular tables listed under Tables Purged to the corresponding history tables. N - Test mode. Determines the rows that are moved to history tables without actually moving them.
PurgeCode	Required. Cannot be modified. Used for internal calculations, such as determining retention days. Corresponds with the PurgeCode used in Business Rules Purge Criteria.
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.
EnterpriseCode	Optional. Enterprise for which the PersonInfo Purge needs to be run. If not passed, then all enterprises are monitored.
TableType	Required in a multi schema deployment when YFS_PERSON_INFO_H table may exist in multiple schemas. Valid Values: TRANSACTION, MASTER. If set to TRANSACTION, purge runs for the YFS_PERSON_INFO_H records associated with tables that have TableType as TRANSACTION; for example, YFS_ORDER_HEADER_H, YFS_SHIPMENT_H, and so forth. Note that purge would run for all TableTypes that exist in the same schema as the one passed. For example, if set to TRANSACTION, purge would also run for YFS_PERSON_INFO_H records associated with tables that have TableType as MASTER, since they reside in the same schema.
ColonyID	Required in a multi schema deployment where the YFS_PERSON_INFO_H table may exist in multiple schemas. Runs the agent for the colony.

Statistics tracked

The following statistics are tracked for this transaction:

Table 3. PersonInfo history purge statistics
Statistic Name	Description
NumPersonInfoHIstoryRecords Purged	Number of person info history records purged.

Pending job count

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

Events raised

None.

Tables purged

YFS_PERSON_INFO_H