How To Guide

Purge Parameters

Table of Contents

Overview ...................................................................................................................................................... 1
Trace Logs Purge ........................................................................................................................................ 2
Batch Server Logs Purge ........................................................................................................................... 5

Overview
This document describes the process of configuring Purge Parameters for files and tables, and
scheduling recurring batch tasks to run the purges. The two most common purges for Trace Logs and
Batch Server Logs are illustrated.

Archiving and Purges of other groups and tables should be in compliance with your companys data
retention policy and discussed with a Sage ERP X3 functional consultant before proceeding.

2009 Sage Page 1 of 8

 Purge Parameters

Trace Logs Purge

Each Sage ERP X3 application folder tree includes a folder named TRA which contains all trace logs text
files generated from user activities or batch jobs specific to the folder. The trace logs continue to
accumulate which eventually can take a large amount of disk storage.

The trace logs can be manually deleted or moved to another folder via Windows Explorer. But that can
be cumbersome with the risk of deleting more recent logs that may be useful or required based on your
retention requirements.

Establish the Purge Parameters to specify how many days of Trace Logs are to be retained when the
Purge process is executed.

Admin menu path: Set-up (or Parameters) | Usage | Data | Purge Parameters

March 2009 Sage Page 2 of 8

 Purge Parameters

Code: ATRACE (Trace files)

Archive: set to No
Purge: set to Yes
Days: is the number of days of trace logs to retain (example shows 60 days)
Frequency: minimum number of days allowed between Purges (example shows 5 days). This is
useful so as not to purge logs inadvertently if the purge is run manually or executed too frequently.
Select <OK> to save the settings. This only specifies the Purge criteria, nothing is Purged until
the Purge function is executed (manually or via a batch job).
To schedule a Recurring Batch Task to execute the Purge, log into the child folder:
Admin menu path: Usage | Batch Server | Recurring Task Management

Select the New icon

Recurring Task: give the Task a name. As the tasks are specific to each child folders, and you may
want to establish purges in each folder, the example shows a name including the child folder name.
Description: description of the task
Folder: will default to the current folder.
User Code: will default to the current user.
Password: will be skipped if the User Code is the current user. If the User Code is changed so the
job is run under another user code, that user codes password must be specified.
Group: skip, leave blank
Task Code: specify AHISTO (this is the history/purge function)

March 2009 Sage Page 3 of 8

 Purge Parameters

Active: leave the box not checked for now.

Frequency: set the Frequency and when you which this job to run. Example shows running it each
Saturday at 04:00 (military time).
Select <Create> to save this initial setup.

Select <Parameter Definitions> to specify the purge code to execute.

Code: select/enter ATRACE (the Trace Logs Purge code parameter)

Check boxes: Purge, All Companies, and Detailed Log File.
Uncheck boxes: Archive, and Simulation.

March 2009 Sage Page 4 of 8

 Purge Parameters

Select <OK> to return to the main Recurring Task screen

Active: check the box, then select <Save>

The Recurring task will be scheduled in the Batch Server queue per the Frequency specified. The job will
not show up in the Batch Server Request Management queue until the date the job is to be run.

To manually execute a Trace Logs purge, log into the child folder.

Admin menu path: Usage | History/Purge

The same History/Purge selection screen as the Recurring Task Parameter Definitions.
Enter the same criteria and select <OK>

CAUTION: this is an interactive process which may take a very long time to complete and is not
recommended.

Batch Server Logs Purge

The Sage ERP X3 runtime folder tree includes a folder named TRA (..\runtime\SERVX3\TRA) which
contains all batch jobs logs text files generated for all application child folders.

The batch logs can be manually deleted or moved to another folder via Windows Explorer. But that can
be cumbersome with the risk of deleting more recent logs that may be useful or required based on your
retention requirements.

To manually purge the batch jobs logs, select the <Purge> button on the Request Management screen,
then specify the date logs are to be removed up to and including that date.

CAUTION: this is an interactive process which may take a very long time to complete depending on the
number of batch job logs to be purged based on the date specified.

March 2009 Sage Page 5 of 8

 Purge Parameters

This setup must be done logged in the X3 reference folder as Admin. The batch server
encompasses the entire Sage ERP X3 runtime.

Establish the Purge Parameters to specify how many days of Batch Jobs Logs are to be retained when
the Purge process is executed.

Admin menu path: Parameters | Usage | Purge Parameters

Code: ABATCH (Batch requests)

Archive: set to No
Purge: set to Yes
Days: is the number of days of trace logs to retain (example shows 20 days)
Frequency: minimum number of days allowed between Purges (example shows 5 days). This is
useful so as not to purge logs inadvertently if the purge job is run too frequently.
Select <OK> to save the settings. This only specifies the Purge criteria, nothing is Purged until
the Purge function is executed.

The number of Days to retain should be determined by how many batch jobs are run on a daily basis and
how long you wish to keep the batch logs available in the Request Management screen.

March 2009 Sage Page 6 of 8

 Purge Parameters

To schedule a Recurring Batch Task to execute the Purge, still logged into the X3 reference folder::
Admin menu path: Batch Server | Recurring Task Management
Select the New icon

Recurring Task: give the Task a name.

Description: description of the task
Folder: will default to the current folder.
User Code: will default to the current user (leave as ADMIN)
Password: will be skipped if the User Code is the current user. If the User Code is changed so the
job is run under another user code, that user codes password must be specified.
Group: skip, leave blank
Task Code: specify AHISTO (this is the history/purge function)
Active: leave the box not checked for now.
Frequency: set the Frequency and when you which this job to run. Example shows running it each
Sunday at 04:00 (military time).
Select <Create> to save this initial setup.
Select <Parameter Definitions> to specify the purge code to execute.

March 2009 Sage Page 7 of 8

 Purge Parameters

Code: select/enter ABATCH (the Batch requests Purge code parameter)

Check boxes: Purge, All Companies, and Detailed Log File.
Uncheck boxes: Archive, and Simulation.
Select <OK> to return to the main Recurring Task screen

Active: check the box, then select <Save>

The Recurring task will be scheduled in the Batch Server queue per the Frequency specified. The job will
not show up in the Batch Server Request Management queue until the date the job is to be run.

March 2009 Sage Page 8 of 8