This chapter provides an overview of the data types available for archiving and an overview of archive objects definitions, PSQuery objects, and template objects and discusses how to:
Archive data.
Restore archived data.
See Also
Enterprise PeopleTools PeopleBook: Data Management, “Using PeopleSoft Data Archive Manager”
This section discusses:
Archiving general overview.
Archiving business process.
Archiving business rules.
In Payables, you use the PeopleTools Data Archive Manager to archive payments, vouchers, and vendors. This process removes them from the production transaction tables, yet keeps them online in history tables where they are available for queries and reporting. Removing them from your production tables helps maintain speedy daily processing activities, while still retaining online access to information.
In addition, you can generate archived reports that provide the necessary tracking information for your regulatory agencies. Remember that the data stays available if you need to reload it for an audit.
To archive data in Payables, you’ll complete the same procedures for payments, vouchers, and vendors. Payments that are cleared or canceled must be archived to history tables and deleted from the transaction tables before you can begin to archive the related vouchers. Likewise, before you can archive vendors, completely processed vouchers or closed vouchers must be archived to history tables and deleted from the transaction tables.
When you archive, you first move transactions out of the main online tables into online history tables where you can still query them for information about the transactions. Later, when you no longer need to reference those transactions, you can use third-party database utilities to move them to flat files and delete them completely from the online system.
Note. We recommend that you use unique run control IDs for each archive process. That is, have separate run control IDs for payment archive, voucher archive, and vendor archive.
When you archive your transactions, you'll need to select a batch ID. Batch IDs provide a method of identifying a group of transactions during the archiving process, and are automatically assigned by the system. The combination of batch ID and archive date specified during archive selection is then used as the key when you run the selection report, rollback, and deletion processes, and when you perform audits.
The following procedures provide an overview of the archiving procedure in Payables.
Archive transactions as follows:
Run the payment, voucher, or vendor archive selection process.
Based on the template and query you select, this process flags selected transactions for archival.
Run the payment, voucher, or vendor archive selection report.
This report lists all the selected data, so you can verify that you’re archiving the correct transactions. You’ll probably want to run this report every time you run a payment, voucher, or vendor archive request.
Run the payment, voucher, or vendor archive rollback process.
If the report reveals that you have selected the wrong set of data, you can run a rollback process. This clears the records, enabling you to rerun the archive selection process with different parameters.
Run the payment, voucher, or vendor archive delete process.
This removes the records from the transaction tables.
This section discusses the following Payables archiving business rules:
Payment archival business rules.
Voucher archival business rules.
Vendor archival business rules.
Payment Archival Business Rules
To be archived, payment data must pass the following business rules:
The Payment Post status must be Posted and the Reconciliation Status must be Reconciled when any of these three scenarios are met:
The Reconciliation Method is set to none (N), the Cash Cleared Flag is active (Y), the Cash Cleared Date is not null, and the Cash Cleared Date value is less than Archive As of Date value.
The Cancel Action value is set to Close or Processed, the Cancel Date is not null, and the Cancel Date value is less than Archive As of Date value.
The Cash Cleared Flag is not active (N), the Bank Account does not use the Cash Clearing process, and the Payment Date value is less than the Archive As of date value.
Voucher Archival Business Rules
To be archived, voucher data must pass the following business rules:
Voucher Post Status is Posted and Invoice Date value is less than the Archive As Of Date value, or Voucher Entry Status is Deleted and Invoice Date value is less than the Archive As of Date value.
Associated payments no longer exist on the payment table. Payments must have been previously archived.
No related vouchers exist that are not currently archived.
Voucher does not have accounting lines which have not been distributed to the general ledger.
Voucher does not have accounting lines with a Journal Date value greater than an Archive As of Date value.
Voucher does not have scheduled payments with a status other than Closed, Paid, or Canceled.
Voucher does not have scheduled payments with unposted withholding transactions.
Voucher does not have accounting lines with unposted VAT information.
Voucher should be matched or overridden if matching is required.
Voucher does not have voucher lines referencing a purchase order that does not have a status of Complete, Canceled, or Pending Cancel.
Voucher does not have accounting lines which have asset information that has not been distributed to Asset Management.
Voucher does not have accounting lines which have Projects related information that has not been distributed to Projects.
Voucher has been budget checked if applicable.
Vendor Archival Business Rules
To be archived, vendor data must pass the following business rules:
Last Activity Date value is less than Archive As of Date value, or the Last Activity Date value is null and the Vendor Status value is equal to the To Be Archived value.
Vendor cannot have any payments on the Payment table. Payments must be archived prior to running the Vendor Archive process.
Vendor cannot have any voucher on the Voucher table. Vouchers must be archived prior to running the Vendor Archive process.
Vendor may not have existing purchase orders that do not have a status of Complete, Canceled, or Pending Cancel.
Vendor may not also be linked to an active Receivables customer.
Payables delivers archive object definitions, query definitions, and template definitions to archive:
Payment data
Voucher data
Vendor data
You can modify them if needed using the Data Archive Manager. You can also use the Data Archive Manager to create your own archive object definitions, query definitions, and template definitions to archive other types of data.
An archive object definition identifies the tables that contain the data to be archived and the history tables that will be updated for each table. Payables delivers these archive objects:
Data Type |
Archive Object |
Payment data |
PAYABLES_PAYMENTS |
Reconciled payment data |
PAYMENT_RECON_TBL |
Payment advice table |
PYMNT_ADVICE |
Voucher – vendor bank data |
VCHR_VNDR_BANK |
Voucher – vendor information data |
VCHR_VNDR_INFO |
Voucher data |
VOUCHER |
Voucher HIPAA data |
VOUCHER_HIPAA |
Vendor data |
VENDOR |
Vendor – reporting element data |
VENDOR_RPT_ELEMENTS |
Each archive query definition defines the selection criteria to archive data from transaction tables. Payables delivers these archive queries:
Data Type |
Archive Query |
Archive all payment data |
AP_ARCHIVE_PYMNT_ALL |
Archive bank account data |
AP_ARCHIVE_PYMNT_BANK_ACCT |
Archive voucher, all business units |
AP_ARCHIVE_VOUCHER_ALL |
Archive voucher, business unit |
AP_ARCHIVE_VOUCHER_BU |
Archive all vendors data |
AP_VENDOR_ARCH_ALL |
Archive vendors by class data |
AP_VENDOR_ARCH_CLASS |
Archive vendors by persistence data |
AP_VENDOR_ARCH_PERS |
Archive vendors by setID data |
AP_VENDOR_ARCH_SETID |
Archive vendors by status data |
AP_VENDOR_ARCH_STATUS |
Review these queries to determine whether you want to add additional selection criteria for the transactions to be archived. Refer to the PeopleTools Query PeopleBook documentation if you want to create your own archive queries.
See Enterprise PeopleTools PeopleBook: Data Management, “Using PeopleSoft Data Archive Manager,” Defining Archive Queries
See Enterprise PeopleTools PeopleBook: PeopleSoft Query
When you archive data, you select an archive template definition. Each archive template definition includes one or more archive object definitions and the archive query definitions used to select the data. Payables delivers these archive templates:
Data Type |
Archive Template |
Payment data |
Payables Payment Archive (AP_PYMNT) |
Voucher data |
Voucher Archive (AP_VCHR) |
Vendor data |
Vendor Archive (AP_VNDR) |
This section provides an overview of the archive process flow, an overview of history tables, and lists the pages used to archive data.
Archive transaction data as follows:
Archive transaction data to the history tables by selecting the archive template and query for the data type that you want to archive on the Archive Data to History page.
Also, enter the archive date used to select the transactions by clicking Reset Query Find Variables on the Define Query Bind Variables page.
This table shows what the system compares the archive date to for the different data types:
Data Type |
Archive Date |
Payment |
|
Voucher |
|
Vendor |
|
Note. You can run the process multiple times to create various “what-if” scenarios based on the archive date.
(Optional) Review the number of rows that were selected for archiving for each table on the Audit Archiving page.
This page lists the number of rows that were selected for archiving for each archive ID (template), archive batch number, and table combination.
Note. This page displays data only if you selected the Audit Row Count check box on the Archive Data to History page.
Delete the data from the transaction tables for a specific archive ID (template) and batch number on the Archive Data to History page.
(Optional) Rollback the transaction data from the history tables for a specific archive ID (template) and batch number on the Archive Data to History page if you deleted the transaction data in error.
Remove the transaction data from the history tables for a specific archive ID (template) and batch number on the Archive Data to History page.
Payables updates these history tables when you run the selection process:
Data to Archive |
FROM History Table |
TO History Table |
Payment data |
PAYMENT_TBL |
AP_ARC_PYM_TB_H |
PAYMENT_RCN_TBL |
AP_ARC_PYM_RC_H |
|
PYMNT_ADVICE |
AP_ARC_PYM_AD_H |
|
Voucher data |
BCH_XREF_EXT |
AP_ARC_BCH_XR_H |
DISTRIB_LINE |
AP_ARC_DIST_L_H |
|
DISTRIB_LINE_NP |
AP_ARC_DIST_N_H |
|
PYMNT_VCHR_MSG |
AP_ARC_PY_MSG_H |
|
PYMNT_VCHR_WTHD |
AP_ARC_PYM_WT_H |
|
PYMNT_VCHR_XREF |
AP_ARC_PYM_XR_H |
|
VCHR_ACCTG_LINE |
AP_ARC_VCH_AC_H |
|
VCHR_DOCSEQ_HDR |
AP_ARC_VCH_DO_H |
|
VCHR_FRGH_CHRG |
AP_ARC_VCH_FR_H |
|
VCHR_LINE_TXGEO |
AP_ARC_VCH_TG_H |
|
VCHR_LINE_WTHD |
AP_ARC_VCH_WT_H |
|
VCHR_LN_EXS_DTL |
AP_ARC_VCHL_E_H |
|
VCHR_LN_TX_DTL |
AP_ARC_VCH_TX_H |
|
VCHR_MISC_CHRG |
AP_ARC_VCH_MS_H |
|
VCHR_RECV_MTCH |
AP_ARC_VCH_RM_H |
|
VCHR_SALETX_CHG |
AP_ARC_VCH_ST_H |
|
VCHR_USETAX_CHG |
AP_ARC_VCH_UT_H |
|
VCHR_VNDR_IBANK |
AP_ARC_VCH_VI_H |
|
VCHRLN_MISC_CHG O |
AP_ARC_VCHL_M_H |
|
VOUCHER_LINE |
AP_ARC_VCH_LN_H |
|
VOUCHER |
AP_ARC_VOUCH_H |
|
VOUCHER_HIPAA |
AP_ARC_VCH_HP_H |
|
VCHR_VNDR_BANK |
AP_ARC_VCH_VB_H |
|
VCHR_VNDR_INF |
AP_ARC_VCH_VN_H |
|
Vendor data |
VENDOR |
AP_ARC_VENDOR_H |
VENDOR_ADDR |
AP_ARC_VND_AD_H |
|
VENDOR_ADDR_PHN |
AP_ARC_VND_PH_H |
|
VENDOR_CNTCT |
AP_ARC_VND_CN_H |
|
VENDOR_ID_NBRS |
AP_ARC_VND_ID_H |
|
VENDOR_INVOICE |
AP_ARC_VND_IN_H |
|
VENDOR_LOC |
AP_ARC_VND_LC_H |
|
VENDOR_PAY |
AP_ARC_VND_PY_H |
|
VENDOR_TYPE |
AP_ARC_VND_TP_H |
|
VENDOR_WTHD |
AP_ARC_VND_WT_H |
|
VENDOR_WTHD_JUR |
AP_ARC_VND_WJ_H |
|
VNDR_ADDR_SCROL |
AP_ARC_VND_AS_H |
|
VNDR_BANK_ACCT |
AP_ARC_VND_BK_H |
|
VNDR_CNTCT_PHN |
AP_ARC_VND_CP_H |
|
VNDR_CNTCT_SCR |
AP_ARC_VND_CS_H |
|
VNDR_GOV_CERT |
AP_ARC_VND_GC_H |
|
VNDR_GOV_SRC |
AP_ARC_VND_GS_H |
|
VNDR_HDR_IND_CL |
AP_ARC_VND_HN_H |
|
VNDR_IBANK_ACCT |
AP_ARC_VND_IB_H |
|
VNDR_IND_CLASS |
AP_ARC_VND_IC_H |
|
VNDR_LOC_NBR |
AP_ARC_VND_LI_H |
|
VNDR_LOC_SCROL |
AP_ARC_VND_LS_H |
|
VNDR_RTV_FEE |
AP_ARC_VND_RT_H |
|
VNDR_URL |
AP_ARC_VND_UR_H |
|
VNDR_VAT_RGSTRN |
AP_ARC_VND_VT_H |
|
VNDR_RPT_ELEM |
AP_ARC_VND_RP_H |
The data in these tables is keyed by the archive ID (template) and batch number for each archive run. If you want to see all transactions that are selected to archive you can run a query on the history tables or you can run one of the Payables archive reports.
You may not want to delete data from the history tables each time that you select and delete data from the transaction tables. This way the data will be available for a period of time to enable you to restore the data into the transaction tables. We recommend that create a schedule for deleting data from the history tables. Before you delete data from the history tables, you should use a third-party database utility to copy the contents to a flat file.
Important! If you decide to run the archive selection process again because you didn't select the correct data, you must first use the Data Archive Manager option to remove the data from the history tables.
Page Name |
Object Name |
Navigation |
Usage |
PSARCHRUNCNTL |
PeopleTools, Data Archive Manager, Archive Data to History |
Select an archive template and query and select the action you want to take in the archiving process. |
|
PSARCHRUNQRYBND |
Click Define Binds on the Archive Data to History page. |
Enter the date used to select the transactions to archive by clicking the Reset Query Bind Variables button. |
|
PSARCHIVEAUDIT |
PeopleTools, Data Archive Manager, Audit Archiving |
View the number of rows selected to be archived for each table for a specific archive run. |
This section provides an overview of data restoration and lists the page used to restore data.
The Selection option on the Archive Data to History page places a copy of the data in the transaction tables in the history tables and the Delete option removes the transaction data from the transaction tables. If you delete the data from transaction tables in error, you can restore the data from the history tables by using the Rollback option on the Archive Data to History page. The process restores all data for a specific archive ID (template) and process run. You cannot restore selected data. For example, you cannot specify that you want to restore data for a specific payment, voucher, or vendor.
Important! After you delete data from the history tables, you cannot restore it to the transaction tables unless you first manually restore it to the history tables from a flat file.
See Also
Enterprise PeopleTools PeopleBook: Using PeopleSoft Data Archive Manager, Archiving Data to History
Page Name |
Object Name |
Navigation |
Usage |
PSARCHRUNCNTL |
PeopleTools, Data Archive Manager, Archive Data to History |
Select an archive ID (template) and the batch number for the process run of the data that you want to restore. |