Creating and managing schedules

On the Schedules tab, you can configure tasks to run automatically at the specified date and time, perform clean-ups, collect database statistics, perform deployment activities, and get the channel configuration. You can create, modify, or delete a schedule.

To add a schedule

  1. Click the Schedules tab.
  2. On the bottom right, below the list of existing schedules, click Add Schedule.
    Perform the following steps to add a new schedule: 
    1. In the Label field, enter a name for the schedule.
    2. To enter time and dates for the schedule, in the Cron Spec field, click the (Use the Wizard) icon.
    3. From the Owner list, select the ID that should run the operation, which implicitly grants the user permissions to the operation.
    4. From the Module list, select the module to run at the scheduled times.
      The Module list shows a list of schedules available in RPD. For more information about each schedule, see Schedules in RPD
  3. Click Create.
  4. Confirm the schedule and complete any further configuration by clicking  Actions > Configure for the schedule.
  5. To start the scheduled task, in the corresponding  Actions menu for the schedule, click Run.
    In the Schedules list, the Next Run column shows the status of the schedule as Now.

Info

When you schedule a module that has references to a server added to the default "Undefined" zone, then only engines assigned to the "Undefined" zone perform the module tasks.

When you schedule a module that has references to a server added to some custom zone, then only engines assigned to that custom zone perform the module tasks. If those engines cannot perform a module task at a specific moment, that task waits in a queue until the engine can perform it. For more information about zones, see Zones and Managing zones.

To edit a schedule

  1. Click the Schedules tab.
  2. Make changes as necessary:
    • To change the schedule name, click the name, and then enter a new name in the opened edit window.
    • To configure the schedule, in the Actions menu associated with the schedule that you want to configure, click 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.

Schedules in RPD

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

Schedule

Description

Options

Archive Audit Log

Archives a portion of the audit log files on the file system and trims the database table where these audit logs are saved.

  • Archive Language: English only 
  • 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.
  • Events Older Than Days: Archives entries that are older than the specified number of days. It parses and stores the audit log file in the text file. The audit entries are stored in the tokenized format for translation into other languages. You can select a language for the export.

Deploy Package

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

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

Deploy Repository

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

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

Deploy Package Conditional

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

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

Expire Package

Purges old package or repository instances from the database.

Only those instances that are in an unlocked state are purged. You may first run the Unlock Old Instances schedule and then run the Expire Package schedule to delete them.

  • Keep At Least: Always leaves the specified number of package instances. This option prevents the module from deleting the last X package instances even if they are older than the specified date. 
  • Older Than Days: Deletes package instances that are older than the specified number of days.
  • Source Repository: Based on the selection, deletes instances from a specific repository, or a package.
    If specified as Not Defined, deletes all package and repository instances.

Garbage Collector (Perform Internal System Cleanup)

Performs internal system cleanup of the database. For example, when an instance is deleted, the reference counts on internal master records that are set to 0 but are not physically deleted from the database. This module looks for data with 0 reference counts and removes the data.

Run this module regularly during times of minimal deployment activity.

None

Prune Channel Rev

Cleans old configuration revisions for channels in the database. Every time a channel configuration is changed, a snapshot is created for this 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 amount of configuration data on the managed channels, and if the database size is an issue, you might need to run it more often.

  • Older Than Days: Selects channels that are older than the specified number of days.
  • Channel Name (Blank for all): Purges old channel revisions from a channel, or purges from all channels if you leave the field blank.
Prune Shared DriveDeletes files in the remote storage that are older than the specified number of days.
  • Older Than Days: Selects entries that are older than the specified number of days.
  • Remote Storage Server: Dispatcher to which the remote storage is connected.
  • Remote Storage (Location to act as repeater): Local path to the remote storage location directory.

Prune Instance Data

Selects instances in the database that are 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 the log information.

Content is deleted only for unlocked instances and instance creation date is considered. You may first run the Unlock Old Instances schedule and then run the Prune Instance Data schedule.

This enables you to delete the binary content in the instances, but retain the configuration and the log information for reporting.

  • Older Than Days: Selects entries that are older than the specified number of days.
  • Source Repository: Specify name of a repository, or select Not Defined to specify all repositories.

Prune Instance Feed

Selects instances in the database that are 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.

Content is deleted only for unlocked instances and instance creation date is considered. You may first run the Unlock Old Instances schedule and then run the Prune Instance Feed schedule.

This enables you to retain the binary content and the metadata, but discard the fetch logs if they are no longer needed.

  • Older Than Days: Selects entries that are older than the specified number of days.
  • Source Repository: Specify name of a repository, or leave it blank to specify all repositories.

Prune Task Feed

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

Note: To run prune task feed for instances involved in any delivery that may be in a locked state, you must ensure that you unlock the instances before running the Prune Task Feed schedule.

To unlock instances, run the Unlock Old Instances schedule.

Older Than Days: Selects entries that are older than the specified number of days.

Purge System Process

Purges the data for a 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.

Older Than Days: Selects entries that are older than the specified number of days.

Sync All Channel Templates

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

None

Sync Channel Template

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

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

System Stat (Statistics)

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 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.

Delete samples older than days: Selects entries for discard that are older than the specified number of days.

Unlock Old Instances

Unlocks the package or repository instances after a certain period of time, but leaves the specified number of instances and the instances that are deployed to protected environments (if Preserve Instances From Protected Environment is set to Yes).

This schedule only unlocks the instances that are delivered. Undelivered instances are not unlocked.

The schedule is inactive by default.

  • Keep At Least: Always leaves the specified number of instances. This option prevents the module from unlocking the last X instances, even if they are older than the specified date. The default number is 5.
  • Older Than Days: Unlocks instances that are older than the specified number of days. The default number of days is 90.
  • NEW IN 5.0.02Preserve Instances From Protected Environment: Valid values are:
    • Yes: Does not unlock the package or repository instances that are deployed to protected environments. Instances are not pruned irrespective of whether they are older than the limit specified in Older Than Days
    • No (Default): Unlocks the deployed package or repository instances after a certain period of time, but leaves the specified number of instances as specified in previous options.
Was this page helpful? Yes No Submitting... Thank you

Comments