Configure Schedules

You can configure schedules by enabling the schedule in the IDOL Speech Server configuration file and adding a schedule file that defines the task schedule.

Create a Schedule File

The schedule file is a text file that contains the details of the schedules. Each line of the schedule file contains the details of a particular task schedule.

TIP:

You can add comment lines by starting the line with a pound sign (#).

Specify the task details in the following format:

Name;Days;Dates;Hours;Minutes;Task_Type;Task_Parameters

where

Name is the name of the schedule.
Days are the days of the week that you want to run the schedule. You can specify days with full names (Monday, Tuesday, and so on), or the first three letters (Mon, Tue, and so on). The day names are not case sensitive. Separate multiple days with commas. If you want to run the task on every day (subject to any Dates restrictions), set this value to an asterisk (*).
Dates are the dates of the month that you want to run the schedule. Separate multiple days with commas. If you want to run the task on every day (subject to any Days restrictions), set this value to an asterisk (*).
Hours are the hours (0-23) that you want to run the schedule. Separate multiple hours with commas. If you want to run the task every hour, set this value to an asterisk (*).
Minutes are the minutes (0-59) in the specified hour that you want to run the schedule. Separate multiple minutes with commas.
Task_Type is the type of task that you want to run. This value is the same as the Type parameter for the AddTask action.
Task_Parameters are the parameters for the task that you want to run. Specify parameters in the same way that you use in the AddTask action string. For details of the available task parameters, see the IDOL Speech Server Reference.

For scheduled tasks, you can use the following special placeholder tags in the task parameters to add an appropriate value for each schedule run, rather than a fixed value for all runs:

{NAME} The schedule label.
{ITERATION} The iteration of this scheduled task being run.
{ITERATION_N} The iteration of this scheduled task, up to a maximum of N. After N iterations, the iteration resets to zero and cycles back through the first N values.
{YEAR} The year that the task runs (YYYY).
{MONTH} The month that the task run runs (1-12).
{DAY} The day that the task runs (1-31).
{HOUR} The hour that the task runs (0-23).
{MINUTE} The minute that the task runs (0-59).

For example:

BreakingNewsENUK;*;*;*;0,30;Type=LanguageModelBuild&Lang=ENUK&ContentServer=content1.example.com&ContentDatabase=news&NewLanguageModel={NAME}-{HOUR}{MINUTE}.tlm

This example schedule runs a LanguageModelBuild task at 0 and 30 minutes past each hour, every day. Each time the schedule runs, it creates a new language model with a name that follows the template {NAME}-{HOUR}{MINUTE}.tlm (for example BreakingNewsENUK-1230.tlm).

BreakingNewsENUK;MON,FRI;*;12;30;Type=LanguageModelBuild&Lang=ENUK&ContentServer=content1.example.com&ContentDatabase=news&NewLanguageModel={NAME}-{ITERATION_5}.tlm

This example schedule runs a LanguageModelBuild task at 12:30 every Monday and Friday. For the first five times the schedule runs, it creates a new language model with a name that follows the template {NAME}-{ITERATION}.tlm (for example BreakingNewsENUK-0.tlm through to BreakingNewsENUK-4.tlm). After the first five iterations, the iteration number in the name loops back to 0 and cycles through the existing files.

Enable the Schedule in the Configuration File

After you create the schedule file, you must enable the schedule in the IDOL Speech Server configuration file.

To enable a schedule

  1. Open your configuration file in a text editor.

  2. Find the [Schedule] section, or create one if it does not exist.

  3. Set EnableSchedule to True.

  4. Set ScheduleFile to the path and file name of the file that contains your schedule details. You can specify an absolute or relative file path. If you specify a relative path, it is considered as being relative to the IDOL Speech Server installation directory.

  5. Save and close the configuration file.

  6. Restart IDOL Speech Server to implement your changes. IDOL Speech Server starts to run the schedule at the next scheduled time.

For example: 

[Schedule]
EnableSchedule=True
ScheduleFile=C:\SpeechServerFiles\Schedule\speechserver-schedule.txt
TIP:

When you want to modify the schedule you can update the schedule file on disk, and then use the LoadSchedules action to reload the schedule configuration file without having to restart IDOL Speech Server.


_FT_HTML5_bannerTitle.htm