Home > Help center > Management Panel Manual > Automation - Scheduler

Automation - Scheduler

The Scheduler is a software, which is a part of ApiHawk Gear. It is designed to schedule processes through cron schedule expressions. The software uses Crontab, which is a Unix-based command that creates a table/list of commands, that would be executed by the OS at a specifically set time.

preview of the scheduler section

Scheduler list sections

ColumnDefinition
ID- The unique ID of that scheduled process.
Name- The name of the process that is being scheduled.
Schedule- The cron schedule expression itself.
Status- The status of the scheduled process.
TTL- Time To Live - sets the maximum execution time for the scheduled process once it has been activated. If it exceeds the TTL the cron will cease the execution and mark it as unsuccessful. The TTL timeframe is in seconds.

Available Admin actions

Control buttonDefinitionDetail
Alternative textEdit- Modify the scheduled process.
Alternative textDelete- Delete the scheduled process.
Alternative textExecute- Manually execute the scheduled process.
Alternative textAdd new- Create a new scheduled process.

Scheduler Statuses

Scheduler StatusTitleDefinition
Alternative textActive- This schedule entry is active.
Alternative textInactive- This schedule entry is inactive.

Note: If a schedule entry exceeds its TTL it would end as unsuccessfully executed process. This would be visible in the system Logs here**.

Cron schedule expressions

A cron expression is a string of six or seven subexpressions (or fields) that describe individual details of the schedule. It uses certain symbols and numbers to describe a timeframe for a certain process or action to take place. To see more information on cron schedule expressions and crontab please see www.crontab.guru.

Add new scheduler

In order to create a scheduler, a process is needed to be specified. All processes are predefined and depend on the Billia engine configuration and what the system supports.

add a new scheduler task

Add Scheduler field definitions

FieldDefinition
Scheduler name- Set the process name for the scheduler here.
TTL- Set the TTL in seconds, e.g. 2 minutes are 120 (seconds). Type only the number.
JSON data- If necessary, a JSON script can be set here for additional criteria.
Schedule- This field will automatically populate itself after clicking to calculate the time intervals and the time frame set for the scheduler.
Type- Two types can be selected here: "Custom date" or "Day of the week". This sets the larger time frame criteria for the scheduler. If "Day of the week" is selected a new field appears below to select a specific day of the week.
Month- Set the cron scheduler to run at certain monthly intervals - "Every" month, "Every n-th" month (on every certain month), or "In n-th" (on a specific month). After setting this preference, there is a free row next to the setting to type in the numerical value of "n". This field is available only for "Custom date" time frame type.
Day- Set the cron scheduler to run at certain daily intervals - "Every" day, "Every n-th" day (on every certain day), or "In n-th" (on a specific day). After setting this preference, there is a free row next to the setting to type in the numerical value of "n". This field is available only for "Custom date" time frame type.
Hour- Set the cron scheduler to run at certain hourly intervals - "Every" hour, "Every n-th" hour (on every certain hour), or "At n-th" (at a specific hour). After setting this preference, there is a free row next to the setting to type in the numerical value of "n".
Minute- Set the cron scheduler to run at certain minutely intervals - "Every" minute, "Every n-th" minute (on every certain minute), or "At n-th" (at a specific minute). After setting this preference, there is a free row next to the setting to type in the numerical value of "n".

Available Admin actions

Control buttonDefinitionDetail
Alternative textMake active- If selected, it will make the Scheduler active. If not, it will remain in the list but will not operate.
Alternative textCalculate- Click to calculate the Scheduler cron expression. This will automatically calculate the values from the time frame fields.