Versions Compared

Key

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

...

  1. Using count and interval attributes to run the task a  specified number of times at a given interval .
  2. Giving the scheduled time as a cron style entry.
  3. Making the task run only once after the ESB WSO2 EI starts by using the once attribute.

Having deployed a task implementation to the ESB runtime (see Writing Tasks), you can use the ESB Management Console to add a task to the "Tasks" list and schedule various instances of the task. You can use either UI configuration  or XML configuration to add and schedule tasks.

...

UI Configuration

Follow the instructions below to add and schedule a task in ESB Management Console.

1. Sign in. Enter your user name and password to log in to the ESB Management Console.

2. Click Main in the left menu to access the Manage menu.

Image Removed

3. In the Manage menu, click Scheduled Tasks under Service Bus.

Image Removed

4. The Scheduled Tasks page appears, where you can add, edit, and delete tasks.

Image Removed

5. Click Add Task.

Image Removed

6. The New Scheduled Task page appears. Enter the required details into the fields.

...

  • Simple Trigger - Defined by specifying a count and an interval, implying that the task will run a count number of times at specified intervals.
    • Count - The number of times the task will be executed.
    • Interval - The interval between consecutive executions of a task.
  • Cron Trigger - Defined using a cron expression.

...

Anchor
task_handling_cluster
task_handling_cluster

Info
titleTask handling in a clustered environment

In a clustered environment, tasks are distributed among server nodes according to the round-robin method, by default. If required, you can change this default task handling behavior so that tasks are distributed randomly, or according to a specific rule. This is a server-level setting that is configured in the tasks-config.xml file.

  • See Configuring the Task Scheduling Component for instructions on configuring the task handling behavior at server-level.
  • You can also configure the task handling behavior at task-level, by specifying the Pinned Servers for a task. Note that this setting overrides the server-level configuration.

Also, note that a scheduled task will only run on one of the nodes (at a given time) in a clustered environment. The task will failover to another node, only if the first node fails.

Having deployed a task implementation to WSO2 EI runtime (see Writing Tasks), you can use the WSO2 EI Management Console to add a task to the "Tasks" list and schedule various instances of the task. You can use either UI configuration or XML configuration to add and schedule tasks.

Anchor
UI configuration
UI configuration

UI Configuration

Follow the instructions below to add and schedule a task in WSO2 EI Management Console.

1. Sign in. Enter your user name and password to log in to WSO2 EI Management Console.

2. Click Main in the left menu to access the Manage menu.

Image Added

3. In the Manage menu, click Scheduled Tasks under Service Bus.

Image Added

4. The Scheduled Tasks page appears, where you can add, edit, and delete tasks.

Image Added

5. Click Add Task.

Image Added

6. The New Scheduled Task page appears. Enter the required details into the fields.

  • Task Name - Name of a scheduled task.
  • Task Group - The group name to grouping tasks. The group name synapse.simple.quartz belongs to WSO2 EI - Synapse. All available groups are displayed as a drop-down menu. If there are tasks belong to some other domains, for example WSO2 Mashups tasks, then those will be shown here as a separate group names.
  • Task Implementation - The implementation class of the task. To use the default task implementation that is available with the WSO2 EI (and therefore can be used without downloading any third-party libraries or custom JARs), specify  org.apache.synapse.startup.tasks.MessageInjector. This class simply injects a specified message into the Synapse environment at WSO2 EI startup. For more information on writing custom task implementations, see Writing Tasks.
  • Trigger Type- Trigger type for the task. This can be selected as either "Simple" or "Cron."
    • Simple Trigger - Defined by specifying a count and an interval, implying that the task will run a count number of times at specified intervals.
      • Count - The number of times the task will be executed.
      • Interval - The interval between consecutive executions of a task.
    • Cron Trigger - Defined using a cron expression.
  • Anchor
    pinned_servers
    pinned_servers
    Pinned Servers - The list of ESB server nodes that will run the task. You can specify the IP addresses of the required nodes. 

    Info

    This setting can be used if you want the task to run on a selected set of nodes in an ESB cluster. Note that the task will only run on one of the nodes at a time. It will failover to another node, only if the first node fails.

    As explained above, pinned servers will override the default task handling behavior defined at server-level (for this particular task). However, if rule-based task handling is specified at server-level, you need to ensure that the same server nodes you specify as pinned servers for the task are also specified for the task handling rule at server-level.

7. Click Load Task Properties to see the instance properties of the task implementation.

...

1. Sign in. Enter your user name and password to log on to the ESB WSO2 EI Management Console.

2. Click on "Main" in the left menu to access the "Manage" menu.

...

Anchor
once
once

To run only once after ESB WSO2 EI starts:

Code Block
<task name="CheckPrice" class="org.wso2.esb.tutorial.tasks.PlaceStockOrderTask">
<trigger once="true"/>
</task>

...