Job
Schedule MQL scripts to run automatically at given times: add, update, pause, resume and remove jobs, and start, stop or restart the job scheduler. Typical uses: nightly imports, periodic reports, cleanup tasks. job generate update deploys a job on another server.
job helpjob add job create|insert|addjob showjob show activatejob existjob pausejob resumejob generate updatejob updatejob set cluster_scriptjob removejob scheduler stopjob scheduler startjob scheduler restartjob scheduler status

job help


Description

    To show the job help

admin
job help;
mentdb
Cron is a UNIX tool that has been around for a long time, so its scheduling capabilities are powerful and proven. The CronTrigger class is based on the scheduling capabilities of cron. CronTrigger uses "cron expressions", which are able to create firing schedules such as: "At 8:00am every Monday through Friday" or "At 1:30am every last Friday of the month". Cron expressions are powerful, but can be pretty confusing. This tutorial aims to take some of the mystery out of creating a cron expression, giving users a resource which they can visit before having to ask in a forum or mailing list. Format A cron expression is a string comprised of 6 or 7 fields separated by white space. Fields can contain any of the allowed values, along with various combinations of the allowed special characters for that field. The fields are as follows: Field Name Mandatory Allowed Values Allowed Special Characters Seconds YES 0-59 , - * / Minutes YES 0-59 , - * / Hours YES 0-23 , - * / Day of month YES 1-31 , - * ? / L W Month YES 1-12 or JAN-DEC , - * / Day of week YES 1-7 or SUN-SAT , - * ? / L # Year NO empty, 1970-2099 , - * / So cron expressions can be as simple as this: * * * * ? * or more complex, like this: 0/5 14,18,3-39,52 * ? JAN,MAR,SEP MON-FRI 2002-2010 Special characters * ("all values") - used to select all values within a field. For example, "" in the minute field means *"every minute". ? ("no specific value") - useful when you need to specify something in one of the two fields in which the character is allowed, but not the other. For example, if I want my trigger to fire on a particular day of the month (say, the 10th), but don't care what day of the week that happens to be, I would put "10" in the day-of-month field, and "?" in the day-of-week field. See the examples below for clarification. - - used to specify ranges. For example, "10-12" in the hour field means "the hours 10, 11 and 12". , - used to specify additional values. For example, "MON,WED,FRI" in the day-of-week field means "the days Monday, Wednesday, and Friday". / - used to specify increments. For example, "0/15" in the seconds field means "the seconds 0, 15, 30, and 45". And "5/15" in the seconds field means "the seconds 5, 20, 35, and 50". You can also specify '/' after the '' character - in this case '' is equivalent to having '0' before the '/'. '1/3' in the day-of-month field means "fire every 3 days starting on the first day of the month". L ("last") - has different meaning in each of the two fields in which it is allowed. For example, the value "L" in the day-of-month field means "the last day of the month" - day 31 for January, day 28 for February on non-leap years. If used in the day-of-week field by itself, it simply means "7" or "SAT". But if used in the day-of-week field after another value, it means "the last xxx day of the month" - for example "6L" means "the last friday of the month". You can also specify an offset from the last day of the month, such as "L-3" which would mean the third-to-last day of the calendar month. When using the 'L' option, it is important not to specify lists, or ranges of values, as you'll get confusing/unexpected results. W ("weekday") - used to specify the weekday (Monday-Friday) nearest the given day. As an example, if you were to specify "15W" as the value for the day-of-month field, the meaning is: "the nearest weekday to the 15th of the month". So if the 15th is a Saturday, the trigger will fire on Friday the 14th. If the 15th is a Sunday, the trigger will fire on Monday the 16th. If the 15th is a Tuesday, then it will fire on Tuesday the 15th. However if you specify "1W" as the value for day-of-month, and the 1st is a Saturday, the trigger will fire on Monday the 3rd, as it will not 'jump' over the boundary of a month's days. The 'W' character can only be specified when the day-of-month is a single day, not a range or list of days. The 'L' and 'W' characters can also be combined in the day-of-month field to yield 'LW', which translates to *"last weekday of the month"*. # - used to specify "the nth" XXX day of the month. For example, the value of "6#3" in the day-of-week field means "the third Friday of the month" (day 6 = Friday and "#3" = the 3rd one in the month). Other examples: "2#1" = the first Monday of the month and "4#5" = the fifth Wednesday of the month. Note that if you specify "#5" and there is not 5 of the given day-of-week in the month, then no firing will occur that month. The legal characters and the names of months and days of the week are not case sensitive. MON is the same as mon. Examples Here are some full examples: **Expression** **Meaning** 0 0 12 * * ? Fire at 12pm (noon) every day 0 15 10 ? * * Fire at 10:15am every day 0 15 10 * * ? Fire at 10:15am every day 0 15 10 * * ? * Fire at 10:15am every day 0 15 10 * * ? 2005 Fire at 10:15am every day during the year 2005 0 * 14 * * ? Fire every minute starting at 2pm and ending at 2:59pm, every day 0 0/5 14 * * ? Fire every 5 minutes starting at 2pm and ending at 2:55pm, every day 0 0/5 14,18 * * ? Fire every 5 minutes starting at 2pm and ending at 2:55pm, AND fire every 5minutes starting at 6pm and ending at 6:55pm, every day 0 0-5 14 * * ? Fire every minute starting at 2pm and ending at 2:05pm, every day 0 10,44 14 ? 3 WED Fire at 2:10pm and at 2:44pm every Wednesday in the month of March. 0 15 10 ? * MON-FRI Fire at 10:15am every Monday, Tuesday, Wednesday, Thursday and Friday 0 15 10 15 * ? Fire at 10:15am on the 15th day of every month 0 15 10 L * ? Fire at 10:15am on the last day of every month 0 15 10 L-2 * ? Fire at 10:15am on the 2nd-to-last last day of every month 0 15 10 ? * 6L Fire at 10:15am on the last Friday of every month 0 15 10 ? * 6L Fire at 10:15am on the last Friday of every month 0 15 10 ? * 6L 2002-2005 Fire at 10:15am on every last friday of every month during the years 2002,2003, 2004 and 2005 0 15 10 ? * 6#3 Fire at 10:15am on the third Friday of every month 0 0 12 1/5 * ? Fire at 12pm (noon) every 5 days every month, starting on the first day of themonth. 0 11 11 11 11 ? Fire every November 11th at 11:11am. Pay attention to the effects of '?' and '*' in the day-of-week and day-of-month fields!
Used in use cases (1 recipe)

    Scheduler developer › Check cron expressions before deploying jobs
Often used with

    atom get  ·  atom size  ·  job add  ·  job exist  ·  job remove  ·  script create  ·  script delete  ·  string regexp_extract

job add <jobId> <scriptName> <pattern> <activate>


Synonymous

    job create|insert|add

Description

    To add a new job (when activate is true, it is scheduled at once if the job scheduler is started)

Parameters

    jobId:   The job id - string - required
    scriptName:   The script name - string - required
    pattern:   The pattern - string - required
    activate:   Is it active? (true | false) - string - required
admin
job add "myJobId" "myScript.post" "0/5 * * * * ?" true;
mentdb
Job added with successful.
Used in use cases (11 recipes)

    Scheduler developer › A heartbeat job every 2 seconds: run, pause, resume, remove
    Automation architect › Nightly import with a cron, a file watcher and a flow
    Scheduler developer › Generate the update request and change the cron
    Scheduler developer › Prove a job ran with the log table
    Scheduler developer › Check cron expressions before deploying jobs
    Scheduler developer › Run a job on one node of a cluster
    and 5 more in the Use cases
Often used with

    script create  ·  job remove  ·  script delete  ·  job pause  ·  wait  ·  job exist  ·  sequence add  ·  sequence increment

job show


Description

    To show all jobs

admin
job show;
mentdb
{ "server.reset_id": { "pattern": "0 0 0 * * ?", "activate": "1", "scriptName": "server.reset_id.post", "id": "server.reset_id" }, "server.process_mail": { "pattern": "0/1 * * * * ?", "activate": "1", "scriptName": "mail.process_mail.post", "id": "server.process_mail" }, "server.remove_logs": { "pattern": "0 0 0 * * ?", "activate": "1", "scriptName": "log.remove_with_retention.post", "id": "server.remove_logs" }, "server.process_stack": { "pattern": "0/1 * * * * ?", "activate": "1", "scriptName": "stack.process_stack.post", "id": "server.process_stack" } }
Used in use cases (5 recipes)

    Scheduler developer › A heartbeat job every 2 seconds: run, pause, resume, remove
    Automation architect › Audit of the cron jobs
    Cluster & high-availability engineer › Is this server ready for a cluster?
    Scheduler developer › Run a job on one node of a cluster
    Scheduler developer › Audit your own jobs and generate their redeploy script
Often used with

    job exist  ·  job add  ·  job remove  ·  script create  ·  script delete  ·  concat_var  ·  job generate update  ·  job pause

job show activate


Description

    To show all active jobs

admin
job show activate;
mentdb
[ [ "server.process_stack", "stack.process_stack.post", "0/1 * * * * ?", "1" ], [ "server.reset_id", "server.reset_id.post", "0 0 0 * * ?", "1" ], [ "server.process_mail", "mail.process_mail.post", "0/1 * * * * ?", "1" ], [ "server.remove_logs", "log.remove_with_retention.post", "0 0 0 * * ?", "1" ] ]
Used in use cases (3 recipes)

    Scheduler developer › Generate the update request and change the cron
    Automation architect › Audit of the cron jobs
    Scheduler developer › Audit your own jobs and generate their redeploy script
Often used with

    job generate update  ·  job add  ·  job pause  ·  job remove  ·  job show  ·  json fields  ·  script create  ·  script delete

job exist <jobId>


Description

    To check if a job already exists

Parameters

    jobId:   The job id - string - required
admin
job exist "myJobId"
mentdb
1
Used in use cases (8 recipes)

    Scheduler developer › A heartbeat job every 2 seconds: run, pause, resume, remove
    Automation architect › Audit of the cron jobs
    Cluster & high-availability engineer › Is this server ready for a cluster?
    Scheduler developer › Check cron expressions before deploying jobs
    Scheduler developer › Run a job on one node of a cluster
    Scheduler developer › A sampling job and statistics on its rolling window
    and 2 more in the Use cases
Often used with

    job add  ·  script create  ·  job remove  ·  script delete  ·  job show  ·  job generate update  ·  job pause  ·  wait

job pause <jobId>


Description

    To pause a job

Parameters

    jobId:   The job id - string - required
admin
job pause "myJobId";
mentdb
1
Used in use cases (10 recipes)

    Scheduler developer › A heartbeat job every 2 seconds: run, pause, resume, remove
    Automation architect › Retry the failed runs of a worker
    Scheduler developer › Generate the update request and change the cron
    Scheduler developer › Prove a job ran with the log table
    Scheduler developer › Audit your own jobs and generate their redeploy script
    Scheduler developer › A job that only queues work in the stack
    and 4 more in the Use cases
Often used with

    job add  ·  job remove  ·  script create  ·  script delete  ·  wait  ·  sequence add  ·  sequence increment  ·  sequence remove

job resume <jobId>


Description

    To resume a job

Parameters

    jobId:   The job id - string - required
admin
job resume "myJobId";
mentdb
1
Used in use cases (3 recipes)

    Scheduler developer › A heartbeat job every 2 seconds: run, pause, resume, remove
    Automation architect › Retry the failed runs of a worker
    Automation architect › Heartbeat job: schedule, pause, resume, reschedule
Often used with

    job pause  ·  job add  ·  job exist  ·  job remove  ·  script create  ·  script delete  ·  sequence add  ·  sequence get current

job generate update <jobId>


Description

    To generate the job update request of a job (to deploy it on another server; job update applies at once)

Parameters

    jobId:   The job id - string - required
admin
job generate update "myJobId";
mentdb
job update "myJobId" "myScript.post" "0/5 * * * * ?" true;
Used in use cases (5 recipes)

    Scheduler developer › Generate the update request and change the cron
    Automation architect › Audit of the cron jobs
    Scheduler developer › Audit your own jobs and generate their redeploy script
    Automation architect › Nightly import with a cron, a file watcher and a flow
    Automation architect › Heartbeat job: schedule, pause, resume, reschedule
Often used with

    job add  ·  script create  ·  job exist  ·  job pause  ·  job remove  ·  job show activate  ·  script delete  ·  job show

job update <jobId> <scriptName> <pattern> <activate>


Description

    To update a job

Parameters

    jobId:   The job id - string - required
    scriptName:   The script name - string - required
    pattern:   The pattern - string - required
    activate:   Is it active? (true | false) - string - required
admin
job update "myJobId" "addition" "0 1 * * * ?" true;
mentdb
Job updated with successful.
admin
job show
mentdb
{ "server.reset_id": { "pattern": "0 0 0 * * ?", "activate": "1", "scriptName": "server.reset_id.post", "id": "server.reset_id" }, "server.process_mail": { "pattern": "0/1 * * * * ?", "activate": "1", "scriptName": "mail.process_mail.post", "id": "server.process_mail" }, "server.remove_logs": { "pattern": "0 0 0 * * ?", "activate": "1", "scriptName": "log.remove_with_retention.post", "id": "server.remove_logs" }, "server.process_stack": { "pattern": "0/1 * * * * ?", "activate": "1", "scriptName": "stack.process_stack.post", "id": "server.process_stack" } }
Used in use cases (2 recipes)

    Scheduler developer › Generate the update request and change the cron
    Automation architect › Heartbeat job: schedule, pause, resume, reschedule
Often used with

    job add  ·  job generate update  ·  job pause  ·  job remove  ·  script create  ·  script delete  ·  sequence add  ·  sequence get current

job set cluster_script <jobId> <cluster_script>


Description

    Set the cluster script execution

Parameters

    jobId:   The job id - string - required
    cluster_script:   The cluster script (can be null) - string - required
admin
job set cluster_script "myJobId" "cluster.1n.job_execution.exe";
mentdb
Job updated with successful.
Used in use cases (3 recipes)

    Scheduler developer › Run a job on one node of a cluster
    Automation architect › Nightly import with a cron, a file watcher and a flow
    Cluster & high-availability engineer › Failover of a node
Often used with

    job add  ·  job exist  ·  script create  ·  cluster node delete  ·  cluster node expels  ·  cluster node reinstate  ·  cluster nodes show_txt  ·  cluster signal delete

job remove <jobId>


Description

    To remove a job (it is also removed from the running scheduler)

Parameters

    jobId:   The job id - string - required
admin
job remove "myJobId";
mentdb
Job removed with successful.
admin
job show
mentdb
{ "server.reset_id": { "pattern": "0 0 0 * * ?", "activate": "1", "scriptName": "server.reset_id.post", "id": "server.reset_id" }, "server.process_mail": { "pattern": "0/1 * * * * ?", "activate": "1", "scriptName": "mail.process_mail.post", "id": "server.process_mail" }, "server.remove_logs": { "pattern": "0 0 0 * * ?", "activate": "1", "scriptName": "log.remove_with_retention.post", "id": "server.remove_logs" }, "server.process_stack": { "pattern": "0/1 * * * * ?", "activate": "1", "scriptName": "stack.process_stack.post", "id": "server.process_stack" } }
Used in use cases (10 recipes)

    Scheduler developer › A heartbeat job every 2 seconds: run, pause, resume, remove
    Automation architect › Heartbeat job: schedule, pause, resume, reschedule
    Scheduler developer › Generate the update request and change the cron
    Scheduler developer › Prove a job ran with the log table
    Scheduler developer › Check cron expressions before deploying jobs
    Scheduler developer › Run a job on one node of a cluster
    and 4 more in the Use cases
Often used with

    job add  ·  script create  ·  script delete  ·  job pause  ·  wait  ·  sequence add  ·  sequence increment  ·  sequence remove

job scheduler stop


Description

    To stop the job scheduler

admin
job scheduler stop;
mentdb
Job scheduler stoped with successful.

job scheduler start


Description

    To start the job scheduler

admin
job scheduler start;
mentdb
Job scheduler started with successful.

job scheduler restart


Description

    To restart the job scheduler

admin
job scheduler restart;
mentdb
Job scheduler restarted with successful.
Used in use cases (1 recipe)

    System administrator & DevOps › Maintenance window: lock, change the config, reopen
Often used with

    and  ·  config reload  ·  config set  ·  kill  ·  log remove  ·  log trace  ·  log write  ·  maintenance get

job scheduler status


Description

    To show the status of the job scheduler

admin
job scheduler status;
mentdb
Running...
Used in use cases (3 recipes)

    Backend & web service developer › Health check endpoint for the load balancer
    Scheduler developer › Audit your own jobs and generate their redeploy script
    Automation architect › Monitor the stack queue
Often used with

    maintenance get  ·  script create  ·  script delete  ·  stack count_error  ·  stack count_wait  ·  string regexp_extract  ·  atom get  ·  count sessions