Task data purge
Use the Task Data Purge task template to schedule regular purging of old task log information. The default is to purge every 90 days. When purging large amounts of data, you can run multiple Task Data Purge tasks in parallel. If you choose to do so, allow the first new instance of the task to run to completion before starting multiple tasks. For more information, see Maintaining the Database, in the IEE Configuration Guide.
Use the following procedure to configure a task template:
-
Go to System Operations > Task Management > Task Templates.
-
Use the dropdown menu to select the Task Type and Task Template. (Click Add to create a new task template. For more information, see Adding task templates.)
-
Configure the Task specific parameters. These parameters are defined after step 5 of this procedure.
-
Configure the Common task template parameters. For more information, see Task template parameters.
-
Click Save.
Task specific parameters:
Note: The Processing Chunk Size parameter is not applicable to the Task Data Purge task. Use the BATCHSIZE parameter entered in the Command Text field instead. If BATCHSIZE is not defined in the Command Text field, the BATCHSIZE default value of 1000 is used.
Processing Chunk Size
Defines the number of configuration entities processed by sub-tasks. IEE groups the data that was processed by the task into separate batches of the size you designate here. IEE considers the task completed when all child tasks are finished, and each has reported back to the parent tasks.
Chunk size is a parameter common to several task templates. The higher the chunk size value, the greater the portion of the total available work each IEE task runner performs. A smaller value means dividing the work between more concurrent task runners.
Chunk sizes that are too large overburden a few task runners, while other task runners sit idle. In extreme cases, overly large chunk sizes could result in system failure due to lack of available, allocated memory. Chunk sizes that are too small spawn many task runners that perform more initialization and shutdown than actual work. Both large and small extremes will cause delays in export processing.
When fine tuning chunk sizes, consider database resources, hardware requirements, daily processing levels, and processing windows. Adjust values over time, as hardware and networking conditions change.
File Type
Select the file type for the export file containing the data requested from IEE. Raw output provides data with no headers, footers, punctuation or other text describing the task.
Note: The External System parameter is not applicable to the Task Data Purge task.
External System
Defines any external system to which IEE configuration data can be associated. In many places this parameter provides you with the dropdown menu to select from the external systems configured in the External System table.
Export File Name
Defines the export file name. You can enter a unique file name or accept the default. This parameter supports the standard IEE macros.
Export Directory
Defines the directory where IEE places the file containing exported data. Accept the IEE default file path or click Search to browse to a directory. This parameter supports the standard IEE macros. Reference as ($ExportDirectory) when configuring a task. Exported data is generated by an export task template or an export API.
Command Text
In a custom export, the command text parameters can contain one or more database statements, or the name of a stored procedure. The output writes to the output file. The command text parameter has a different format for SQL Server and for Oracle. If the SQL Server command is used in an Oracle database environment, an Oracle error message is returned. Always use the correct syntax for your database.
In the task data purge template, the command text configures the frequency that IEE runs the data purge.
Examples of command text for Oracle and SQL follow. The examples contain the syntax for purge parameters.
-
Oracle. declare begin Task_purge (daystokeep=>90, batchsize=>5000, historic_only=>’TRUE’, timetorun=>180);
-
SQL Server. exec Task_purge @DaysToKeep=90, @BatchSize=5000, @historic_only=’TRUE’, @TimeToRun=180
The following examples contain the syntax for purge tasks without any parameters defined. When parameter values are not specified in the command text, code default values are used. For more information about task purge defaults, see the chapter "Maintaining the Database" in the IEE Configuration Guide.