Configuring retention parameters to prevent loss of archive data

This procedure describes how to check and adjust retention parameters, to prevent loss of archive data during periods of time when the Workload Archiving Server is down and cannot collect job data. At such times, you must ensure that data is retained in Control-M components for a large enough number of days to cover the time that the Workload Archiving Server was down and the extra time that the Workload Archiving Server needs for retrieving job data after it is brought back up.

To configure retention parameters to prevent loss of archive data

1. Update retention parameters for Control-M/Server through the ctmsys utility:
   1. Run the ctmsys utility, as described in Running the ctmsys utility.
   2. From the Main Menu, choose Option 2, System Parameters.
   3. Specify n to display the second page of parameters.
   4. Update the following parameters with larger values:
      • Option 6, Maximum Days Retained by Control-M Log
      • Option 7, Maximum Days to Retain Output Files
   5. Save your changes and exit the utility.

   NOTE: Increasing Control-M Log retention requires additional database space on Control-M/Server. Increasing job output retention requires additional disk space on each Control-M/Agent.

2. If you require a retention period that is longer than the default of 30 days, update the retention period for all Control-M/Agents:
   Through the CCM, update the value defined in the GENERAL_CLEANUP_INTERVAL system parameter for each of your agents, as described in Defining Control-M/Agent system parameters.
3. Verify that Control-M/Server retention parameters take effect on all Control-M/Agents:
   • Ensure that the Control-M/Agents do not use the SYSKEEPDAYS parameter:
     • On UNIX, ensure that the CONFIG table in <Agent home>/data/CONFIG.dat does not contain the SYSKEEPDAYS parameter. If necessary, remove this parameter.
     • On Windows, ensure that the Agent Registry folder that contains the CONFIG table does not contain the SYSKEEPDAYS parameter. If necessary, remove this parameter.
     • In the CCM, right-click each Control-M/Agent and select Properties. On the Output tab, ensure that the Days to retain OUTPUT files is set to Default.
   • Verify that Control-M/Server sends the output retention value to all agents at NewDay time:
     1. In the Control-M/Server config.dat file, located in <Control-M/Server home directory>/ctm_server/data/, update or add the following line:
        AGENTS_CLEANUP_IN_NEWDAY Y
     2. Restart the Control-M/Server.
4. If you need a long retention period, update retention for Control-M/EM. Through the CCM, update the values of the following Control-M/EM system parameters, as described in Defining Control-M/EM system parameters:
   • ArchiveRetentionPeriod, one of the Control-M Workload Archiving parameters
   • RunTimeHistoryDays, a general system parameter. This is the number of days that Runinfo history information is retained before being cleaned from the Control-M/EM database. The default is 90 days.

   NOTE: Increasing the Archive retention through Control-M/EM system parameters will impact the Control-M/EM database size required to support the new value.

5. Update the following retention parameters in $EM_HOME/archive/config/SystemParameters.xml on the Workload Archiving Server with the same values that you used in Step 1:
   • override.num.days.log.keep.in.server
   • override.num.days.output.keep.in.server

   For your changes to take effect, recycle the Workload Archiving Server.