Problem

How to configure the SecureClient log maintenance parameters from the command line?

Resolution

SecureClient's log maintenance has the following parameters:

* Number of log archives: How many times the log files will be archived before the sequence restarts. For example, if you select 3, the archive operation will rename the log file, adding a number to the beginning of the file name three times. For example, scheduler.txt is the file in current use, 0scheduler.txt is the oldest, 1scheduler.txt is newer than 0scheduler.txt, 2scheduler.txt is newer than 1scheduler.txt. Then the sequence restarts and the files are overwritten.

* Log archive frequency: How often log files will be archived. Choose from never, each day, each week, or each month.

* Purge schedule frequency: How often finished schedules should be purged. Choose from never, each day, each week, or each month.

* Purge schedule older than: How long old schedules are allowed to remain in the database before they are purged. This property depends on the purge schedule frequency. The maximum age is taken when a purge is executed (defined by the purge frequency). Purge is not triggered by a job that is older than the value in this field. This value can be one day, one week or one month. In addition, you can specify that all schedules be purged regardless of age.

* Max finished jobs to keep: The number of finished schedules to retain in the logs regardless of their age. Based on this value, schedules that would be purged due to their age are retained.

These configuration options are kept in the config.scheduler.properties file. On Unix/Linux, this is located in the <USERHOME>/.axway/SecureClient/properties directory; on Windows, in the %APPDATA%\axway\SecureClient\properties directory.

To change any of these values, add the appropriate "variable=value" pair (without the quotation marks) on a new line in the following manner:


Number of log archive
==========================================================================
LogArchiveNum=<value>

where <value> should be the number of log archives to be kept.



Log archive frequency
==========================================================================
LogArchiveFreq=<value>

where <value> could be the following:

- 0 - Never
- 1 - Each day
- 2 - Each week
- 3 - Each month


Purge schedule frequency
==========================================================================
JobPurgeFreq=<value>

where <value> could be the following:

- 0 - Never
- 1 - Each day
- 2 - Each week
- 3 - Each month


Purge schedule older than
==========================================================================
JobPurgeOlder=<value>

where <value> could be the following:

- 0 - All
- 1 - 1 day
- 2 - 1 week
- 3 - 1 month


Max finished jobs to keep
==========================================================================
JobsNumberToKeep=<value>

where <value> should be the number of jobs to be retain in the logs.

Here is an example of the content of a "config.scheduler.properties" file:

#Wed Apr 24 20:35:39 EEST 2013
JobPurgeFreq=3
JobsNumberToKeep=101
LogArchiveNum=4
LogArchiveFreq=3
JobPurgeOlder=0


NOTE: Performing the above change requires a restart of the scheduler service.