DOC 2.4.3
Job

You can run MQL scripts automatically at specific times.

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

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

Synonymous

    job create|insert|add

Description

    To add a new job

Parameters

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

job show

Description

    To show all jobs

admin
job show;
mentdb
{<br> "server.reset_id": {<br> "pattern": "0 0 0 * * ?",<br> "activate": "1",<br> "scriptName": "server.reset_id.post",<br> "id": "server.reset_id"<br> },<br> "server.process_mail": {<br> "pattern": "0/1 * * * * ?",<br> "activate": "1",<br> "scriptName": "mail.process_mail.post",<br> "id": "server.process_mail"<br> },<br> "server.remove_logs": {<br> "pattern": "0 0 0 * * ?",<br> "activate": "1",<br> "scriptName": "log.remove_with_retention.post",<br> "id": "server.remove_logs"<br> },<br> "server.process_stack": {<br> "pattern": "0/1 * * * * ?",<br> "activate": "1",<br> "scriptName": "stack.process_stack.post",<br> "id": "server.process_stack"<br> }<br>}

job show activate

Description

    To show all activate jobs

admin
job show activate;
mentdb
[<br> [<br> "server.process_stack",<br> "stack.process_stack.post",<br> "0/1 * * * * ?",<br> "1"<br> ],<br> [<br> "server.reset_id",<br> "server.reset_id.post",<br> "0 0 0 * * ?",<br> "1"<br> ],<br> [<br> "server.process_mail",<br> "mail.process_mail.post",<br> "0/1 * * * * ?",<br> "1"<br> ],<br> [<br> "server.remove_logs",<br> "log.remove_with_retention.post",<br> "0 0 0 * * ?",<br> "1"<br> ]<br>]

job exist <jobId>

Description

    To check if a job already exist

Parameters

    jobId:   The job id - string - required
admin
job exist "myJobId"
mentdb
1

job pause <jobId>

Description

    To pause a job

Parameters

    jobId:   The job id - string - required
admin
job pause "myJobId";
mentdb
1

job resume <jobId>

Description

    To resume a job

Parameters

    jobId:   The job id - string - required
admin
job resume "myJobId";
mentdb
1

job generate update <jobId>

Description

    To generate an update job update request

Parameters

    jobId:   The job id - string - required
admin
job generate update "myJobId";
mentdb
job update "myJobId" "addition" "0 0 * * * ?";

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 activate ? (true | false) - string - required
admin
job update "myJobId" "addition" "0 1 * * * ?" true;
mentdb
Job updated with successful.
admin
job show
mentdb
{<br> "server.reset_id": {<br> "pattern": "0 0 0 * * ?",<br> "activate": "1",<br> "scriptName": "server.reset_id.post",<br> "id": "server.reset_id"<br> },<br> "server.process_mail": {<br> "pattern": "0/1 * * * * ?",<br> "activate": "1",<br> "scriptName": "mail.process_mail.post",<br> "id": "server.process_mail"<br> },<br> "server.remove_logs": {<br> "pattern": "0 0 0 * * ?",<br> "activate": "1",<br> "scriptName": "log.remove_with_retention.post",<br> "id": "server.remove_logs"<br> },<br> "server.process_stack": {<br> "pattern": "0/1 * * * * ?",<br> "activate": "1",<br> "scriptName": "stack.process_stack.post",<br> "id": "server.process_stack"<br> }<br>}

job remove <jobId>

Description

    To remove a job

Parameters

    jobId:   The job id - string - required
admin
job remove "myJobId";
mentdb
Job removed with successful.
admin
job show
mentdb
{<br> "server.reset_id": {<br> "pattern": "0 0 0 * * ?",<br> "activate": "1",<br> "scriptName": "server.reset_id.post",<br> "id": "server.reset_id"<br> },<br> "server.process_mail": {<br> "pattern": "0/1 * * * * ?",<br> "activate": "1",<br> "scriptName": "mail.process_mail.post",<br> "id": "server.process_mail"<br> },<br> "server.remove_logs": {<br> "pattern": "0 0 0 * * ?",<br> "activate": "1",<br> "scriptName": "log.remove_with_retention.post",<br> "id": "server.remove_logs"<br> },<br> "server.process_stack": {<br> "pattern": "0/1 * * * * ?",<br> "activate": "1",<br> "scriptName": "stack.process_stack.post",<br> "id": "server.process_stack"<br> }<br>}

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.

job scheduler status

Description

    To show the status of the job scheduler

admin
job scheduler status;
mentdb
Running...


MentDB © 2012 - 2021 - Legal Notice