2.3.1 Create a Schedule Definition

Define the frequency at which you want to execute a workflow, such as weekly, monthly, or daily.

Before you create a schedule definition, ensure that scheduler.enabled is set to true in the values.yaml file. See MicroTx Workflows Server Configuration in MicroTx Installation and Configuration Guide.

To create a schedule definition:

1. Open the navigation menu and click Definitions.
2. Click the Schedules tab.

   The Schedules list page opens. All the schedules that you have defined are displayed in a table.

3. Click (Add New Schedule).
   The New Schedule Definition dialog box is displayed.
4. Enter the following information to schedule a workflow execution.
   • Name: Mandatory. Enter a unique name to identify the schedule. The name can be up to 128-characters long. Use only letters, numbers, underscores (_), and hyphens (-). Spaces and other special characters are not supported. You cannot change this name later.
   • Workflow Name: Select a workflow.
   • Workflow Version: Select the version of the workflow.
   • Status: Enable a schedule to run workflows as per the defined schedule. By default, the schedule is disabled.
   • Timezone: Select the time zone that the server uses to schedule the workflow.
   • Repeats: Select one of the following to specify the frequency at which the workflow is executed.
     • Repeat by minute: Specify the number of minutes after which the workflow is executed in the Every _ minute(s) field.
     • Repeat by hour: Specify the number of hours after which the workflow is executed in the Every _ hour(s) field.
     • Repeat daily: Specify the number of days after which the workflow is executed in the Every _ day(s) field when you select the daily mode as Repeat every X days. If you select Only on weekdays (MON-FRI) as the daily mode, it runs the workflow daily on weekdays.
     • Repeat weekly: Select the days of the week when the workflow is executed in the Select day(s) of week field.
     • Repeat monthly: Specify additional details about the day of the month or a weekday when the workflow is executed.
   • Start Time: Select the time at which you want the workflow to be executed. The service stores time in UTC format.
   • Cron Expression: When you click Generate in the Schedule group, a CRON expression is automatically populated based on selected options in the Schedule group.
   • Input (JSON): Provide values for the input parameters of the workflow, if any, in JSON format.
5. Click Save.

Details of the schedule that you have created are displayed on the Schedules list page.