B2B Data Exchange Repository Cleaning

Challenge

Events that B2B Data Exchange generates can be archived to manage storage space in the runtime DX repository. The chosen archive tool is based upon requirements in each organization. The archive command line utility is a basic B2B Data Exchange utility that archives events to an XML file and deletes the events from B2B Data Exchange. Use the archive utility if your organization does not require access to archived events as archived events cannot be browsed or restored when archived with this utility.

Data Exchange also offers Data Archive which is an advanced archive tool that archives events and documents to a compressed file store. Refer to the B2B Data Exchange Administrator Guide for more information on Data Archive.

Description

This document focuses on the archive command line utility that should be used when the primary objective is to delete events from the DX runtime repository.

Archive Command Line Utility

Use the archive command line utility to archive events and documents from B2B Data Exchange to an external XML file and delete the events and the documents from B2B Data Exchange.

The following event types can be archived:

• Root events
• Parent and child events
• Events with a final status
• Legacy audit trail events from earlier B2B Data Exchange versions with a status of Completed or Rejected
• Reconciliation events with a Reconciled reconciliation status

The archive specification file contains the parameters according to which events are to be archived. Archive events for a specific partner or account can be selected in the specification file. Events can also be archived based on the event creation date and time. The archive specification file also contains pre-configured rules that can be used to limit the archive criteria. If any event to be archived contains reconciliation information, the associated reconciliation event must be set to a status of Reconciled.

After the archive process completes successfully, B2B Data Exchange generates an event for the archive process with a status of Complete. The event contains a log BLOB that describes the object hierarchies in the archive file, the data that the archive utility purged, and any error that the archive utility generated.     

Archive Specification File

The archive specification file contains rules that the archive utility uses to determine which events to archive. The following table describes the archive specification file elements:

Following are examples of archive specification files:

Requirement– Purge events for all partners or events with no partner that are older than 1 day.

                        <ArchiveTask>
                              <ArchiveRule>
                                    <Name>Archive events older than a day</Name>
                                    <PartnerName>(ALL)</PartnerName>
                                    <StorageLocation>c:\temp\archive </StorageLocation>
                                    <EventAge>1d 0h 0m</EventAge>
                                    <ArchiveEvents>false</ArchiveEvents>
                                    <PurgeEvents>true</PurgeEvents>
                                    <IncludeLogBlobs>false</IncludeLogBlobs>
                          </ArchiveRule>
                    </ArchiveTask> 

Requirement– Purge audit trail and system events older than 5 days

                    <ArchiveTask>
                          <ArchiveRule>
                                    <Name>System Events</Name>
                                    <PartnerName>(SYSTEM)</PartnerName>
                                    <StorageLocation>c:\temp\archive\system</StorageLocation>
                                    <EventAge>5d 00h 00m</EventAge>
                                    <ArchiveEvents>false</ArchiveEvents>
                                    <PurgeEvents>true</PurgeEvents>
                                    <IncludeLogBlobs>true</IncludeLogBlobs>
                          </ArchiveRule>
                    </ArchiveTask>

Archive Command Syntax

After the archive rules are defined in the specification file, run the archive utility with the command line. The archive utility creates the archive file and deletes the archived events from B2B Data Exchange.

The archive utility uses the following syntax:

archive
<-s|--specification> file
<-u|--user> userID
<-p|--password> user password
[--server "hostname:port"]

The following table describes options and arguments for the archive utility commands:

Examples by Operating System:

Windows:

<DXInstallationDir>\dx-tools\archive.bat -s c:\temp\archive\archive_spec_file.xml -u admin -p xxxx  --server “infa-server:18095”

Unix

<DXInstallationDir>\dx-tools\ archive.sh -s \infa\temp\archive\archive_spec_file.xml -u admin -p xxxx  --server “infa-server:18095”

Truncate all events in DX repository

Follow the steps below to delete all of the event history in the B2B DX repository at once:

1. Stop DX services.
2. From the command line, navigate to ..\DataExchange\dx_tools folder and execute:
   
   repoutil -c truncateEvents -l <repository JDBC URL> -u <repository JDBC user name> -p <repository JDBC password>
    
3. A confirmation message is displayed. Acknowledge the confirmation to proceed with removal of the events.

Note: The command executes the ‘truncate table …’ which means that there is no database transaction log of that operation.