Scheduled maintenance tasks

Important

SIP Feature Server 8.1.203 requires external Python 3.x interpreter to execute scheduled maintenance tasks in environments where CQL connection mode is enabled for Cassandra connections. You can configure the python location using the process-launcher option in the python section of Feature Server configuration. After you start using the CQL connection and external python interpreter, you can remove the legacy jython interpreter module from Feature Server installation. For more details on removing unused modules, see the SIP Feature Server Deployment Guide.

Master Feature Server can schedule and run three maintenance tasks:

• update-mailbox-counters
• delete-expired-messages
• forget-me
• reimport

All the scheduled tasks must be configured in the configuration environment. All options intended for maintenance tasks are detailed in the [ScheduledTasks] section of the Configuration Options page.

Running maintenance tasks

The following are the two methods to run scheduled tasks:

Method 1

To run the schedule task manually by calling the Feature Server resource, complete the following steps:

1. Type the following address in your browser:

   http://<fs-server-host:port>/fs/api/admin/tasks/start/<task-name>

   where,

   <fs-server-host:port> is your Feature Server host.

   <task-name> is the name of your task.

2. When the site requests your credentials, log in by using administrator credentials to initiate this scheduled task.

Method 2

To enable Master Feature Server to automatically start scheduled tasks, set the [Scheduled-task] <task-name>.active option to true in the master Feature Server application, then scheduled task runs automatically at the time scheduled in the [Scheduled Tasks]<task-name>.schedule option in the master Feature Server application.
For example, to enable update-mailbox-counters tasks: [ScheduleTask] update-mailbox-counters.active = true

Cancelling maintenance tasks

You can cancel a scheduled task by calling HTTP resource on master Feature Server:

1. Type the following address in your browser:

   http://<fs-server-host>:port/fs/api/admin/tasks/cancel/<task-name>

   where,

   <fs-server-host:port> is your Feature Server host.

   <task-name> is the name of your task.

2. When the site requests your credentials, log in by using administrator credentials to cancel schedule tasks.

Warning

Genesys does not recommend cancelling tasks.

Monitoring maintenance tasks

You can monitor scheduled tasks using the Feature Server HTTP resource that displays the status of scheduled tasks:

1. Type the following address in your browser on the master Feature Server:

   http://<fs-server-host>:<port>/fs/api/admin/tasks/state

   where,

   <fs-server-host:port> is your Feature Server host.

   <task-name> is the name of your task.

2. When the site requests your credentials, log in by using administrator credentials to display the current state of scheduled tasks, which can be one of the following:

• In progress
• Ready to start