Knowledge Base

Task scheduler

Last Modified:
06 Jun 2019
User Level:
Administrator

Description

TERMINALFOUR has a schedule functionality, which is used for managing a publish schedule as well as any other scheduled tasks, such as review and archiving of content.

Current scheduled tasks

To view the Task Scheduler go to System administration > Task scheduler.

All current scheduled tasks are listed showing their name, create date, the date it is next due to run, the maximum number of times it will run, how often it runs and how many times it has run to date. 

The list can be sorted, filtered and the number of records to display can be changed.

In addition to tasks that are created by a user, tasks for content review and content archive are also shown:

Review content: When content has a Review date set under the Options tab.
Archive content: When content has an Expiry date and Archive section set under the Options tab.

ItemDescription
Name (id) Name of the task and the ID
Create date Date/time the task was created
Next due Date/time the task is next due to run
Maximum executions The maximum number of times this task will run e.g. Infinite, 1
Execution interval The execution interval of the task e.g. 1 hour, 1 day, 10 minutes, Once
Execution count The number of times this task has run

Task Scheduler Listing

Create new task

Select type

Select type

Click the Create new task button to create a new schedule task and select the type of task that is required:

ItemDescription
Channel SEO report Schedule an SEO report for a channel
Channel accessibility report Schedule an accessibility report for a channel
Channel publish Schedule a publish of a channel
Content syncer Schedule a sync for a content syncer data store
External link checker report Schedule a check of all external links within the system
Formbuilder submissions Schedule a task to import submissions from the configured form bank server
Google sitemap Schedule a google site map to be generated for a given site
LDAP import Schedule an import of users from an LDAP server
Social poster Schedule the social poster to process pending posts
Temporary directory clearout Schedule a task to clean the temp directory
Transfer site Schedule a transfer for a transfer manager site
URLRedirect generator Schedule a task to generate the files for a URLRedirect site
xForms Schedule a task to download files for xForms and import any relevant content

 

Enter details

Details to enter depend on the task type selected:

TaskItemDescription
All Name Sets the name of the task
All Next due Sets the date/time for the next/first execution of the task
All Execution interval Sets the execution interval of the task.  Options are:  Once, 10 minutes, 15 minutes, 30 minutes, 1 hour, 2 hours, 3 hours, 4 hours, 5 hours, 6 hours, 12 hours, 1 day, 2 days, 3 days, 4 days, 5 days, 6 days, 1 week
Channel SEO report Channel Sets the channel for the SEO report
Channel accessibility report Channel Sets the channel for the accessibility report
Channel publish Channel Sets the channel to publish
Channel publish Publish complete channel   Publishes the complete channel
Channel publish Publish microsites Publishes the channel's microsites rather than a full publish
Channel publish Microsites Sets the microsites to publish
Channel publish Publish pending version Publishes the channels pending version
Channel publish Publish archive sections If Allow advanced options for scheduled publishes is enabled in the Preview & Publish Settings, this option is available. If checked, it forces a publish of archive sections (configured on the General tab when Creating or Edting a Section)
Channel publish Override publish period restriction If Allow advanced options for scheduled publishes is enabled in the Preview & Publish Settings, this option is available. If checked, it publishes all fulltext content, even if the fulltext publish period on the Channel is not complete.
Content syncer Data store Sets the data store to sync
Content syncer Sync type

Sets the type of sync to perform:

  • Initial sync: Used on the first import. It creates a new Content Item for each entry in the database
  • Data sync refresh: Refreshes content synced initially and updates with new content, if changed
  • Data sync new and refresh: Creates new content for each new entry and updates content which has already been synced
  • Clean & initial sync: Deletes all content and does Initial Sync
  • Data sync old status: Compares the status of content on the database and changes the status of content already synced and marks as inactive if missing.
Content syncer Email address The email address of the person(s) you want to be notified in case of a failure of the sync.
Google sitemap Google site Sets the id of the google site to use to generate the sitemap xml file
Google sitemap Sitemap URL Sets the URL for the sitemap xml file
Transfer site Transfer site Sets the site to transfer
URLRedirect generator URLRedirect site Sets the id of the URLRedirect site to use to generate the relevant files
xForms Configuration file Sets the path to the xForms configuration file

Select recipients

Select the users to receive notifications.

 

Generate task

Click Save changes to generate the task.

Edit a task

A task can be edited by clicking the name or by selecting Actions > Edit.

Delete a task

To delete a task, place a check in the box beside the task and click Actions > Delete. You can Select all items by checking the box located in the header row and bulk delete the items.

Alternatively, it is possible to temporarily suspend scheduled tasks, to prevent them from running.