Maintenance

 

 

 

The Maintenance job step type is used to perform routine, configurable system maintenance to ensure that the system is running optimally. 

 

Each implementation of pasUnity should have one (and only one) job defined that contains a maintenance job step.  This job will perform maintenance for the entire system and as such does not need to be defined on multiple agents.  The job should be set to execute regularly (once per day is recommended) using a schedule impeller.

 


This job step type extends basic job step functionality.  For details common to all job step types click here.


 

In addition to the common attributes shared by all job steps this job step type has the following attributes:

 

Backup tab:

Enable system configuration backup: When this option is enabled a complete copy of the current system configuration is exported to an XML backup file.  All object definitions and their related permissions are included in the export file. 

Backup Folder: the name of the folder where the backup configuration file will be generated.  If a backup folder name is omitted, the installation folder will be used.  The file will be named pasUnity-yyyy-MM-dd.xml and will overwrite any existing file in the folder with the same name.

NOTE: absolutely NO data files, payload files, job history, work queue, email messages or other transient or user data is exported - only configuration settings and permissions.

NOTE: the export can take a significant time to compile, is processor intensive, and is only recommended for use only in specific scenarios as advised by technical support.

Credentials tab:

Enable credential maintenance: When this option is enabled the system performs credential-related maintenance.  This involves pruning history from the database that have not occurred frequently or recently.

Max Retention Days: The maximum number of days to retain history detail for.  A value of 0 (zero) will hold exception detail indefinitely.  The default is 180.

Max Retention Rows: The maximum number of instances of a specific history to retain.  A value of 0 (zero) will retain detail indefinitely.  The default is 5000.

Database tab:

Enable database maintenance: When this option is enabled the system performs database performance-related maintenance.  This involves the tuning and rebuilding of indexes and the generation of index statistics to ensure that the system is running at top speed.  In order to use this option, the owner of the pasUnity database must be a member of the SQL Server sysadmin role.  It is recommended that the database be owned by the sa logon in SQL Server.

Exceptions tab:

Enable exception maintenance: When this option is enabled the system performs exception-related maintenance.  This involves pruning exceptions from the database that have not occurred frequently or recently.

Max Retention Days: The maximum number of days to retain exception detail for.  A value of 0 (zero) will hold exception detail indefinitely.  The default is 180.

Max Retention Rows: The maximum number of instances of a specific exception to retain.  A value of 0 (zero) will retain detail indefinitely.  The default is 500.

History tab:

Enable history maintenance: When this option is enabled the system performs history-related maintenance.  This involves removing job history entries from the database that are either excessively old or sequentially old.

Max Retention Days: The maximum number of days to retain history for.  A value of 0 (zero) will hold history indefinitely.  The default is 180.

Max Retention Rows: The maximum number of rows to retain for individual jobs.  A value of 0 (zero) will retain history indefinitely.  The default is 500.

Matrices tab:

Enable matrix maintenance: When this option is enabled the system performs matrix-related maintenance.  Matrix related maintenance includes pruning data files from DropBoxes that have exceeded their retention period.  Data files that still have work queued against them will not be removed from the database.  The retention period for data files is defined on the parent matrix.

Messages tab:

Enable message maintenance: When this option is enabled the system performs message-related maintenance.  Message maintenance includes pruning stored email messages from the database that have exceeded their retention period.  Messages that still have work queued against them will not be removed from the database.  The retention period for email messages is defined on the parent account.

Payloads tab:

Enable payload maintenance: When this option is enabled the system performs payload-related maintenance.  Any payload that is older than one month will be removed.  Payloads that still have work queued against them will not be removed from the database.

After making changes be sure to press the Update button to save your changes.

 


Copyright © 2024 pasUNITY, Inc.

 

Send comments on this topic.