Open topic with navigation

# ScheduleTask

Creates a schedule to run a task. You can use this option to run the same operation at regular intervals. For example, you can use this option to build new language models on a regular basis to keep up with a changing data set.

You can also enable schedules in the IDOL Speech Server configuration file. See Schedule Configuration Parameters.

NOTE:

If you use the `ScheduleTask` action to add a schedule, IDOL Speech Server does not update the configured schedule file. Schedules that you add in an action are available only until you stop the server.

## Example

    http://localhost:15000/a=ScheduleTask&ScheduleName=BreakingNewsENUS&ScheduleTime=*;*;*;0,20,40&Type=LanguageModelBuild&lang=ENUS&BuildLabel={NAME}&ContentServer=content1.example.com&ContentDatabase=news&NewLanguageModel={NAME}-{ITERATION}.tlm

This action instructs IDOL Speech Server to run the `LanguageModelBuild` task every 20 minutes using the `ENUS` language pack, and writing the new language model to a file that has a name of the form `{NAME}-{ITERATION}.tlm` (see Comments).

## Parameters

Parameter | Description | Required
--- | --- | ---
OutputEncoding | The encoding to use for the action output. |
ScheduleName | The name of the schedule. | Yes
ScheduleTime | The times that you want to run the schedule. | Yes
Type | The name of the configuration section that defines the task that you want to schedule. Different tasks also require additional parameters. See Comments. | Yes

This action accepts the following standard ACI action parameters.

Parameter | Description
--- | ---
ActionID | A string to use to identify an ACI action.
EncryptResponse | Encrypt the output.
FileName | The file to write output to.
ForceTemplateRefresh | Forces the server to load the template from disk.
Output | Writes output to a file.
ResponseFormat | The format of the action output.
Template | The template to use for the action output.
TemplateParamCSVs | A list of variables to use for the specified template.

## Comments

The other `ScheduleTask` action parameters depend on the task specified in the Type parameter. You can configure which action parameters are available for the task in the IDOL Speech Server configuration file. For more information, see Module Configuration Parameters.

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 number 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 more information, see ScheduleFile, and the IDOL Speech Server Administration Guide.

© 2015-2018 EntIT Software LLC, a Micro Focus company | Send documentation feedback to Micro Focus Close Send documentation feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to swpdl.idoldocsfeedback@microfocus.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_FT_HTML5_bannerTitle.htm