R9 - Using the Scheduler Utility

Owned by p_demou (Deactivated)
Last updated: Apr 07, 2016 by Persia Xenopoulou (Deactivated)
7 min read

What does this section cover?

Navigating to Scheduler Utility

FOUNDATION > UTILITIES > MANAGE SCHEDULED PROCESSES

Explaining Scheduler Utility Fields

Scheduler Utility Fields are all read only and display the information of the scheduled task: 

NameDescription
Task NumberThe number of the scheduled task
OrganisationThe organisation that scheduled the task
DescriptionA description of the scheduled task
Class

The name of the Class that is being executed

MethodThe specific method of the class that is being executed
Parameters

The parameters that will be processed by the scheduler. Multiple parameters can be specified by using the character | as separator. Default parameter type is String. Parameter types can be defined using the notation type@value, example of Integer plus Double parameters: java.lang.Integer@1|java.lang.Double@10.2

Application Server

AVAILABLE FROM CRM.COM R9.0.0

The server that the process is or will be executed from

CRON ExpressionThe CRON expression that defines when the task should be performed
State

The state of the task which can be one of the following:

  • Draft
  • Effective

 

Managing Scheduler Utility

  1. Navigate to the Scheduler Utility
    Managing Scheduler Utility

  2. The scheduler can be in one of 2 states

    • Running
       All Jobs that are effective and have a Cron Expression equals to the current time of the scheduler will be executed. 
    • Stand By Mode
      If on  Stand By Mode then no Job will be executed even if it is due to be executed
  3. The following ACTIONS are available through the Scheduler Utility:
    AVAILABLE SCHEDULER ACTIONS

 

    1. VIEW EFFECTIVE TASKS: retrieves the effective tasks only
    2. VIEW ALL TASK: retrieves all tasks
    3. AVAILABLE FROM CRM.COM R9.0.0VIEW SCHEDULED TASKS: If selected then only the tasks which are scheduled for the specific organisation are displayed. View more information in Setting up the Scheduler 
    4. AVAILABLE FROM CRM.COM R9.0.0VIEW RUNNING TASKS: If selected then only the tasks which are already running for the specific organisation are displayed. View more information in Setting up the Scheduler  
    5. AVAILABLE FROM CRM.COM R9.0.0VIEW COMPLETED TASKS: retrieves all completed scheduled tasks. If selected then a log of all the tasks which were applied for the specific organisation are displayed. View more information in Setting up the Scheduler 
    6. VIEW LOG: allows you to look at the scheduler log
      The Log is available for all the days of the current month. Clicking on the respective Day the jobs and results of the jobs that have been executed are available
    7. START SCHEDULER: starts the scheduler.
      AVAILABLE FROM CRM.COM R9.0.0 This action can be applied only if the current application server is enabled to run schedule processes for the specific organisation. View more information in Setting up the Scheduler 
    8. STOP SCHEDULER: stops the scheduler. 

Modifying Scheduled Task 

DELETING A SCHEDULED TASK

  1. Navigate to the Scheduler Utility
  2. Click on the scheduled task to navigate to the task's detail page
  3. Click on DELETE
  4. The scheduled task is deleted permanently and not listed in the scheduler screen any more

STOPPING A RUNNING SCHEDULED TASK - AVAILABLE FROM CRM.COM R9.0.0

This action can be applied only if the application server is already running the scheduler task.

  1. Navigate to the Scheduler Utility
  2. Find the running task to be stopped 
  3. Click on STOP
    1. Provide the reason that the running task was stopped
  4. The scheduled task is stopped
  5. The following information is kept on the log entry related with the scheduler task that was stopped:
    1. The user that stopped the running task 
    2. The date and time that the running task stopped
    3. The reason that the running task was stopped

The log will be available on the server. (Will need to be required from your System Administrator)

Scheduling and Running a Task

CRM.COM allows you to schedule a task. This functionality is called by specific business processes of the software which are requesting a task to be scheduled, for example scheduling the execution of a billing run. 

AVAILABLE FROM CRM.COM R9.0.0 - Processes can be scheduled through any application server which is registered for that organisation, even if that application server is not enabled to run a scheduled process. Scheduled processes are picked up and applied only by the application servers which are registered for that specific organisation, and are allowed to perform that specific process. If there is no application server defined for a specific scheduled process, then the default application server register for that organisation is used. 

View Setting up the Scheduler for more information on how you can configure scheduling settings.


Understanding the CRON expression

A "Cron-Expression" is a string comprised of 6 or 7 fields separated by white space. The legal characters and the names of months and days of the week are not case sensitive. The 6 mandatory and 1 optional fields are as follows:

Field NameAllowed ValuesAllowed Special Characters
Seconds0-59, - * /
Minutes0-59, - * /
Hours0-23, - * /
Day-of-month1-31, - * ? / L W C
Month1-12 or JAN-DEC, - * /
Day-of-Week1-7 or SUN-SAT, - * ? / L C #
Year (Optional)empty, 1970-2099, - * /
Special CharactersMeaningAdditional Information
*The '*' character is used to specify all values. For example, "*" in the minute field means "every minute". Not Applicable
?The '?' character is allowed for the day-of-month and day-of-week fields. It is used to specify 'no specific value'. This is useful when you need to specify something in one of the two fields, but not the other. See the examples below for clarification. Not Applicable
-The '-' character is used to specify ranges For example "10-12" in the hour field means "the hours 10, 11 and 12". Not Applicable
,The ',' character is used to specify additional values. For example "MON,WED,FRI" in the day-of-week field means "the days Monday, Wednesday, and Friday". Not Applicable
/The '/' character is 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 '/'. Not Applicable
LThe 'L' character is allowed for the day-of-month and day-of-week fields. This character is short-hand for "last", but it has different meaning in each of the two fields. 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". When using the 'L' option, it is important not to specify lists, or ranges of values, as you'll get confusing results. The 'L' and 'W' characters can also be combined for the day-of-month expression to yield 'LW', which translates to "last weekday of the month". 
WThe 'W' character is allowed for the day-of-month field. This character is 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 for the day-of-month expression to yield 'LW', which translates to "last weekday of the month". 
#The '#' character is allowed for the day-of-week field. This character is 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. Not Applicable
CThe 'C' character is allowed for the day-of-month and day-of-week fields. This character is short-hand for "calendar". This means values are calculated against the associated calendar, if any. If no calendar is associated, then it is equivalent to having an all-inclusive calendar. A value of "5C" in the day-of-month field means "the first day included by the calendar on or after the 5th". A value of "1C" in the day-of-week field means "the first day included by the calendar on or after Sunday". Not Applicable

 

Here are some full examples, paying attention to the effects of '?' and '*' in the day-of-week and day-of-month fields:

ExpressionMeaning
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 * * ? 2005Fire 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 5 minutes 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 WEDFire at 2:10pm and at 2:44pm every Wednesday in the month of March.
0 15 10 ? * MON-FRIFire 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 ? * 6LFire at 10:15am on the last Friday of every month
0 15 10 ? * 6L 2002-2005Fire at 10:15am on every last friday of every month during the years 2002, 2003, 2004 and 2005
0 15 10 ? * 6#3Fire at 10:15am on the third Friday of every month


Related Areas

Filter by label

There are no items with the selected labels at this time.

Popular Labels