Versions Compared

Version Old Version 3 New Version 4
Changes made by

Jessie Ju

Farah S Noshirwani (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Menu Path: Control Panel > Developer > Plugins > Task Scheduler > Create Task

Now that the scheduler has been activated, the user will need to specify on which tasks to perform automatically. The two key crucial settings in configuring the tasks can be summarised as below:  

  • What task needs to be done automatically?
    • When should this be carried out? (Configurable by Cron Expression / Cron Scripts )
    Panel



    Expand
    title Example for Creating Tasks
    • Specify accordingly, with reference to the task, the "Group", "Name" and "Description" of the task.
      1. Group : Billing
      2. Name : Outstanding Invoice
      3. Description : Email notification when there is any outstanding invoice.
    • Select the required job to be executed from the drop-down list under "Job". **Note that only uploaded job / task will be shown.
      1. Example: Select : plugin-wavelet-tasksched-invOutstandingDue
    • Key in the path for the selected job / task in the "Main Job Class" To identify the path for the selected job / task, extract the initially saved file/s using programs such as winrar  . 2 files should be extracted out, namely "META-INF" and "Taskscheduler" 
    • Copy and paste the entire path from "Taskscheduler" into the "Main Job Class".
      1. For example, if the user have downloaded the job/ task of plugin-wavelet-tasksched-invOutstandingDue.jar,
      2. The user should be able to drill down from Taskscheduler > Notification > Invoice_due > src > InvOutstandingDueNotification.class
      3. The path should appear as taskscheduler\notification\invoice_due\src\InvOutstandingDueNotification.class
    • After performing the copy and paste, replace the "\" with "." and remove the ".class" 
      1. From the above example, the path that should appear in this job/ task under the "Main Job Class" should be as below:
      2. taskscheduler.notification.invoice_due.src.InvOutstandingDueNotification
      • - You may get this from our Support Team
    • Specify accordingly, with reference to the task, the "Group" and "Name" under "Trigger" 
      1. Trigger Group : Email notification
      2. Trigger Name : Invoice triggered

      3. Cron Script Trigger : Refer to the

        table below:
        Image Removed

        below

      4. Set Unscheduled Run as "NO" for it to run based on Trigger
    • Click "Create task" to confirm the settings and create the task
    • Set the Parameter with required information and then Click save
    • Lastly, load the created task into the scheduler by clicking '(Re)Load Task to scheduler now' for it to run based on Trigger Cron

    For Email notification to be sent out for Plugin : Please configure it under EMP Configuration - System


    the plugin module uses Cron Scripts to allow user to specify when the job / task needs to be executed. If the user didn't specify anything at all, the Cron script without values will be shown as '*******' (Seven asterisk). 

    The user must specify a value for each field. Except for the year field, these fields can contain the following:

    • A number in the specified range. To run a command in May, specify 5 in the month field.
    • Two numbers separated by a dash to indicate an inclusive range. To run a cron job on Tuesday through Friday, place 2-5 in the weekday field.
    • A list of numbers separated by commas. To run a command on the first and last day of January, you would specify 1,31 in the day_of_month field.
    • A combination of two numbers separated by a dash to indicate an inclusive range and a list of numbers separated by commas can be used in conjunction. To run a command on the first, tenth to sixteenth and last day of January, you would specify 1,10-16,31 in the day_of_month field. The above two points can also be used in combination.
    • An * (asterisk), meaning all allowed values. To run a job every hour, specify an asterisk in the hour field.

    Note: Any character preceded by a backslash (including the %) causes that character to be treated literally. The specification of days may be made by two fields (day of the month and day of the week). If you specify both as a list of elements, both are adhered to. For example, the following entry:

    • 0 0 1,15 * 1 ?

    Would run command on the first and fifteenth days of each month, as well as every Monday. To specify days by only one field, the other field should contain an * .
    Find more from: http://quartz-scheduler.org/documentation/quartz-1.x/tutorials/crontrigger

    Expand
    titleUnderstand the Cron Expression / Cron Scripts

    Cron Expression can be automatically configured if you select the option under Trigger Con field, if you wish to set complex contrab that is not found you can contact us or find more from: http://quartz-scheduler.org/documentation/quartz-1.x/tutorials/crontrigger

    Example for Cron Script Trigger:

    CronTrigger Example 1 - an expression to create a trigger that simply fires every 5 minutes

    "0 0/5 * * * ?"

    CronTrigger Example 2 - an expression to create a trigger that fires every 5 minutes, at 10 seconds after the minute (i.e. 10:00:10 am, 10:05:10 am, etc.).

    "10 0/5 * * * ?"

    CronTrigger Example 3 - an expression to create a trigger that fires at 10:30, 11:30, 12:30, and 13:30, on every Wednesday and Friday.

    "0 30 10-13 ? * WED,FRI"

    CronTrigger Example 4 - an expression to create a trigger that fires every half hour between the hours of 8 am and 10 am on the 5th and 20th of every month. Note that the trigger will NOT fire at 10:00 am, just at 8:00, 8:30, 9:00 and 9:30
    "0 0/30 8-9 5,20 * ?"

  • Click "Create task" to confirm the settings and create the task. 
  • Load the created task into the scheduler by clicking '(Re)Load Task to scheduler now'
    • Expand
    titleUnderstand the Cron Expression / Cron Scripts




    Certain tasks are already in the Job files, and Plugin Job File Cabinet for download. To upload the job files into your Wavelet EMP system, the user will need to perform the below procedures:

  • Download the job / task files Plugin Job File Cabinet
    • Expand
    title Available Tasks (by File Upload)
    Expand
    title Available Tasks (by File Upload)

    For plugins, you can contact our Support Team and we can assist you to provide the file necessary for set up (if already exist) or program a new plugin based on your requirement (charges may apply)

    Once received, you can upload the file to File Manager (Goto System Admin > File Cabinet (File Manager)

    Select the target folder as '/files' and add the downloaded file/s individually (if more than 1 job/ task

    )

    is required to be uploaded.Describe each job/ file accordingly under 'File Description' and select Document Type to be 'ask

    and set Document Type as task_scheduler_job

    ' for each job / task that needs to be uploaded.Click 'Upload File'

    and click Upload and create the task thereafter


    Panel

    Search Results
    spacekeyWMS
    maxLimit5
    querytask scheduler automate
    typepage

    ...