Creating archive policies

When an archiving policy is run, the names of all the tables being archived are written into the WBATD_TABLE_NAMES column of the WB_ARCH_TRAN_DET table. In addition to the tables configured in the policy, dependent tables that require archiving are also included in the transaction log. The size limit for this column is 1000 characters, which is sufficient for all core policies.

Note: As a best practice, you should not configure more than 20 tables in a custom archiving policy. WFM tables have a maximum name length of 30 characters, so 20 tables and their dependent tables can be handled within the 1000 character limit.
  1. Select Maintenance > System Administration > Archiving > Archiving Policy Definitions.
    By default, the existing policies are alphabetically sorted by type. This sort displays all ARCHIVE entries before PURGE entries.
  2. Click Create New Entry.
  3. Specify this information:
    Name
    Specify the name of the archive policy. The name should indicate the area in which the policy is designed to address, such as PAYROLL DATA.
    Desc
    Optionally, specify a brief description of the archive policy.
    Type
    Select the transaction type from the drop-down list. These options are available:
    • ARCHIVE: Moves data from the core data source to the archive datasource. Data from the core datasource is deleted depending how the Commit Type and Commit Parameters are defined. This type also deletes and purges data from the archive datasource based on the Purge Aging Days value specified in the Archiving Policy Definition. See below for more information.
      Note: Archiving policy definition values can change between releases, particularly the Purge Aging Days value. You should closely examine the default values to determine if they meet your business requirements.
    • PURGE: Deletes and purges data from core data source based on how the Commit Type and Commit Parameters are defined.
    • PURGE_ARCHIVED: Purges the data in the archive datasource specified by the policy. This is similar to how the PURGE type works for core datasource.
    Purge Aging Days
    Specify the number of days the data is set to remain in the database. Data exceeding the specified number is purged from the database. All archive policies use this value when purging data from the database.
    Class Name
    Specify the Java class that implements the archiving policy. The default is wbArchiveDefault, which examines the archive policy details and archives or purges them according to their defined priority.
    Enabled
    Select this option to enable the policy.
    Commit Type
    Specify when the transaction for the policy is set to run from the drop-down list. These options are available: ALL_OR_NOTHING, EVERY_POLICY_DETAIL, EVERY_X_DAYS, EVERY_X_EMPLOYEE, and EVERY_X_RECORDS.
    Commit Parameters
    Specify the start date and the ‘X’ value, if applicable.
    Notification Enabled
    Specify the users to notify of the transaction. User names are separated by commas.
    Notification Status
    Specify when users are notified from the drop-down list. This time is based on the transaction status. These options are available: ALWAYS, NEVER, SUCCESS_ONLY, and FAILURE_ONLY.
  4. Click Save.
  5. In the Archiving Policy Definition Details section, configure the tables included in the policy. Specify this information for each table:
    Priority
    Specify the order to archive the corresponding table specified in the Table Name field.
    Table Name
    Specify the table to archive.
    Where Clause
    Specify the data to be archived using SQL statements.
  6. Click Save in the Archiving Policy Definition Details section.
  7. In the Archiving Policy Parameters section, configure the policy parameters, if applicable. Specify this information for each parameter:
    Parameter Name
    Specify the parameter name.
    Description
    Optionally, specify a brief description of the archive parameter.
    Data Type
    Select the data type of the parameter from the drop-down list: Date, STRING, or NUMBER.
    Value
    Specify the value associated to the parameter name, depending on the selected data type.
  8. Click Save in the Archiving Policy Parameters section.