1. Home
  2. OpenKM 6.3 - CE
  3. Administration guide
  4. Crontab
  1.  

Crontab

The application implements a time-based job scheduler named Crontab. In crontab view there are a set a jobs that are executed periodically at fixed times or intervals.

Typically automated application maintenance or administration are crontab jobs.

Crontab is shown in a table structure.

Name

Expression

Mime

File name

Mail

Last begin

Last end

Active

Crontab parameters

FieldDescriptionRequired

Name

Job name.

true

Expression

Sets when the job is executed.

Takes in consideration the status of the application when the task will be executed.

For example, if you stop the application at 00:00 to perform a backup, it delays the task until you consider the backup process will be completed.

true

Mime

Supported MIME types:

  • application/x-bsh ( BeanShell ).
  • application/x-java-archive ( JAR file ).

The application supports tasks written in beanshell or classes into JAR file.

We recommend using JAR files instead of beanshell.

More information at: Creating your own Crontab job.

true

Mail

When present, a mail is sent as part of the task once the execution has been completed. You can use several mail addresses using a comma "," as separator.

false

Last begin

Shows the last time a process started.

-

Last end

Shows the last time a process was completed.

-

Active

Enables or disables the process execution.

true

Understanading expresion syntax

The commands are executed by cron when the minute, hour, and month fields match the current time, and when at least one of the two day fields (day of month, or day of week) match the current time. The scheduler examines crontab entries once every minute. The time and date fields are:

 * * * * * command to execute
 ? ? ? ? ?
 ? ? ? ? ?
 ? ? ? ? ????? day of week (0 - 6) (0 to 6 are Sunday to Saturday, or use names; 7 is Sunday, the same as 0)
 ? ? ? ?????????? month (1 - 12)
 ? ? ??????????????? day of month (1 - 31)
 ? ???????????????????? hour (0 - 23)
 ????????????????????????? min (0 - 59)
FieldValues

minute

0-59

hour

0-23

day of month

1-31

month

1-12

Other expressions:

ExpressionEquivalentDescription
@yearly 0 0 1 1 *

Runs once a year at midnight of January 1.
@annually 0 0 1 1 *

Same as @yearly.
@monthly 0 0 1 * *

Runs once a month at midnight of the first day of the month.
@weekly 0 0 * * 0

Runs once a week at midnight on Sunday morning.
@daily 0 0 * * *

Runs once a day at midnight.
@midnight 0 0 * * *

Same as daily.
@hourly 0 * * * *

Runs once an hour at the beginning of the hour.

A field may be an asterisk (*), which always stands for first-last.

Ranges of numbers are allowed. Ranges are two numbers separated with a hyphen. The specified range is inclusive. For example, "8-11" for an hours entry specifies execution at hours 8, 9, 10 and 11.

Lists are allowed. A list is a set of numbers (or ranges) separated by commas. Examples: "1,2,5,9", "0-4,8-12".

Step values can be used in conjunction with ranges. Following a range with "/<number>" specifies skips of the number's value through the range. For example, "0-23/2" can be used in the hours field to specify command execution every other hour. Steps are also permitted after an asterisk, so if you want to say "every two hours", just use "*/2".

Names can also be used for the month and day of week fields. Use the first three letters of the particular day or month (case doesn't matter). Ranges or lists of names are not allowed.

Create a new crontab job

  • On top right click  New crontab job icon.
  • Fill the fields.
  • Click on Create button.

Edit a crontab job

  • Click on  Edit crontab job icon.
  • Modify the fields.
  • Click on Edit button.

Execute a crontab job

  • Click on  Execute crontab job icon.

Download a crontab job

  • Click on  Download crontab job icon.
  • After some second will be retrieved the file.

Delete a crontab job

  • Click on  Delete crontab job icon.
  • Click on Delete button.