Creating and managing schedules


With the Schedules tab, you can configure tasks to run automatically at specified dates and times to perform clean-ups, collect DB statistics, perform deployment activities, get the Channel configuration, etc.. You can create, modify, or delete a schedule.

The following table describes the modules that you can use when creating schedules.

Schedule

Options

Description

Archive Audit Log

Archive Language: English only
Archive Directory: Directory to hold the audit log text file.
Events Older Than Days: Archive entries older than the specified number of days. Parses and stores the audit log in a text file. The audit entries are stored in tokenized format for translation into other languages. You select a language for the export.

Archives a portion of the audit logs on the file system and trims the database table where those audit logs are saved.
Archive Directory: Directory path for the audit log text file on the server where the system engine is running, which must be writable by the engine. If you are running multiple engine servers, each must use the same directory, and the directory must exist on each of the servers in the cluster.

Deploy Package

The Package To Deploy: Name of the package
The Route To Deploy To: Name of the route

Creates an instance of the specified package and deploys it to the first environment in the specified route

Deploy Repository

The Repository To Deploy: Name of the repository
The Route To Deploy To: Name of the route

Creates a snapshot of a repository and deploys it to the specified route

Deploy Package Conditional

The Package To Deploy: Name of the package
The Route To Deploy To: Name of the route
Deploy Only Changed References: yes/no

Works exactly like Deploy Repository except that you can deploy only content that has changed since the last successful deployment of that repository

Expire Package

Keep At Least: Always leave the specified number of packages. This option prevents the module from deleting the last X packages, even if they are older than the cutoff age.
Older Than Days: Delete packages older than the specified number of days
Source Repository: Delete packages from a specific repository, or leave blank to delete all.

Purges old packages from the database

Garbage Collector (Perform Internal System Cleanup)

None

Performs internal system cleanup of the database. For example, when an instance is deleted, the reference counts on internal master records are set to 0 but are not physically deleted from the database. This module looks for data with 0 reference counts and performs the deletion.
Run this module regularly during times of minimal deployment activity.

Prune Channel Rev

Older Than Days: Age in days of entries to select
Channel Name (Blank for all): Purge old channel revisions from a channel, or leave blank to purge from all channels

Cleans old configuration revisions for channels in the database. Every time a channel configuration is changed, a snapshot is created for that channel for historical purposes. This includes configuration data for managed channels and channel properties. This module purges old channel snapshots from the database.
Run this module, on average, once a month. If you collect significant amounts of configuration data on managed channels, you might need to run it more often if database size is an issue.

Prune Instance Data

Older Than Days: Age in days of entries to select
Source Repository: Name of repository, or leave blank to specify all repositories

Selects instances in the database older than the specified number of days and from a specific repository or any repository, and deletes the instance content while leaving the instance metadata and log information. This enables you to delete the binary content in instances but retain the configuration and log information for reporting.

Prune Instance Feed

Older Than Days: Age in days of entries to select
Source Repository (Blank for all): Name of repository, or leave blank to specify all repositories

Selects instances in the database older than the specified number of days and from a specific repository or any repository, and deletes the log data from the instance, while leaving the metadata and the binary content.
This enables you to retain the binary content and metadata but discard the fetch logs if they are no longer needed.

Prune Task Feed

Older Than Days: Age in days of entries to select

Prunes log data for deployment processes. The log information is removed, but the process run and status information is retained for reporting purposes.

Purge System Process

Older Than Days: Age in days of entries to select

Purges the data for system and automatic processes, such as channel configuration sync processes, and other system-initiated processes. The Purge System Process schedule always leaves two processes after the schedule run: one last stable configuration and one Drift configuration.

Sync All Channel Templates

None

Initiates a sync operation on all channels whose template is Managed.

Sync Channel Template

The Channel Template to Synchronize: Name of the channel template to sync.

Performs the same operation as Sync All Channel Templates but for a specific channel template.

System Stat (Statistics)

Delete samples older than days: Age in days of entries to select for discard

Takes a snapshot of internal system counters and sizes in the database. This information can be used to track and trend the load and database sizes in the database.
Run this module a few times a week until you have an idea of the amount of data being managed in the database and have tuned the system for that load.
Note: Data for reports is generated by this module, so it should be run regularly to ensure accurate report data and should not be disabled or deleted.

To create a schedule

  1. Click the Schedules tab.
  2. Click Add Schedule on the right, below the list of existing schedules.
  3. Enter a label (name) for the schedule.
  4. To enter time and dates for the schedule in the Cron Spec field, click the Use the Wizard icon to specify the cron format correctly.
  5. Select the user ID that should run the operation, which implicitly grants those user permissions to the operation.
  6. Select the module to run at the scheduled times.
     For descriptions of the modules, see the preceding table.
  7. Click Create.
  8. Confirm the schedule and complete any further configuration by clicking Configure in the associated Actions menu for that schedule.
  9. To start the scheduled task, click Run in the associated Actions menu for that schedule.
     The Schedules list shows the new schedule with "Now" under the Next Run column.

To modify a schedule

  1. Click the Schedules tab.
  2. Make changes as necessary:
    • To change the schedule name, click the name and enter a new name in the edit window that appears.
    • To configure the schedule, click Configure in the Actions menu associated with the schedule that you want to configure.
  3. Save your changes.

To delete a schedule

  1. Click the Schedules tab.
  2. in the Actions menu for the schedule that you want to delete, click Delete.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*