archiveTmTransactions

Archives matched transactions, including support and adjustment details, that are equal to or older than a specified age. The matched transactions are recorded in a ZIP file.

Use this command to keep the Account Reconciliation application size optimal by archiving and then purging old matched transactions based on the transaction retention policies of your organization.

Applies to

Account Reconciliation

Required Roles

Service Administrator, Power User, User, Viewer

Users with Power User, User, and Viewer predefined roles may require additional application roles.

Usage

epmautomate archiveTmTransactions matchType age [filterOperator=VALUE][filterValue=VALUE] [logFilename=FILE_NAME] [filename=FILE_NAME] where:
  • matchType is the identifier (TextID) of the match type from which matched transactions should be archived.
  • age identifies the number of days since the transaction was matched. Matched transaction older than or equal to this value will be archived.
  • filterOperator, optionally, is one of the following filter conditions to identify the accounts containing matched transactions for archival. This value is combined with the filterValue to identify the accounts from which matched transactions should be archived:
    • equals
    • not_equals
    • starts_with
    • ends_with
    • contains
    • not_contains
  • filterValue, optionally, is a filter value to identify the transactions to archive. If the filterOperator is equals or not_equals, you can use a space-separated list to specify multiple values; for example, filterValue=101-120 filterValue=102-202. If multiple values are specified, transactions from accounts matching any filter operator and filter value combination are selected for archival.

    Note:

    If filterOperator and filterValue are not specified, all matched transactions older than or equal to the age from all accounts for the specified matchType are archived.
  • logFilename, optionally, is the name of a log file to record information about the command activity. If a file name is not specified, a log file named Archive_Transactions_matchType_JOBID.log is automatically generated.
  • filename, optionally, is the name of a .ZIP file that should contain the archived transactions. If not specified, the command, by default, creates Archived_Transactions_matchType_JOBID.zip. Use the downloadFile command to download this file to a local computer.

Note:

This command runs the Archive TM Transaction job using the parameters you specify. The job ID is returned in the command output to facilitate its use with the purgeArchivedTmTransactions command. You can monitor the job from the Job Console.

Examples

  • Archive old matched transactions without using filters, but using custom log and .ZIP file name:

    epmautomate archiveTmTransactions cashrecon 180 logFile=tmlogs.log filename=trans.zip

  • Archive old matched transactions using filters:

    • epmautomate archiveTmTransactions cashrecon 180 filterOperator=equals filterValue=101-120 FilterValue=102-202

    • epmautomate archiveTmTransactions cashrecon 180 filterOperator=contains filterValue=11