JobScheduler - Tutorial 6 - Configuring and Running Standalone Jobs

1. Create a subdirectory named quickstart within the live folder (./config/live) directory for the JobScheduler objects described in this article.
2. Start JOE (JobScheduler Object Editor) using one of the following scripts:
   
   • %SCHEDULER_HOME%\bin\jobeditor.cmd ( Windows™ )
   • $SCHEDULER_HOME/bin/jobeditor.sh ( Unix™ )
3. Use the key combination ctrl+D to open the live folder in JOE .
   You can also open this dialog by selecting File -> Open Hot Folder from the menu or by clicking the red folder icon.
   The live folder should have been selected by default: if not, navigate to ./config/live. Select the quickstart sub-folder.
   If required you can also use this dialog to create the quickstart subdirectory.
   
4. Open JOC  - the JobScheduler Operations Center.
   You can use JOC to follow changes to Jobs and other objects as they happen.
   You open JOC in a browser by entering the address http://[scheduler_host]:[scheduler_port], where [scheduler_host] and [scheduler_port] are the host name and the TCP port number of the JobScheduler (e.g. http://localhost:4444). Note that the JobScheduler must be running before JOC is called.

Setting up a Standalone Job

Have you finished making the steps described in the Getting Started section above? Then we can continue.

The JobScheduler object tree is shown in the left hand pane of the screenshot below. Click on the Jobs element in this tree and then click on the New Standalone Job button in the right hand pane. A new Job will now be added. This will be shown in both the left hand element tree and the list of jobs in the main pane. Click on this new job.

This will open the Job configuration element as shown in the next screenshot. Give this job a name by entering, for example, firstJob in the Job Name field. Note that for standalone Jobs the Stop On Error checkbox to be activated (in the Options tab in JOE when Jobs->firstJob is selected; see also Error Handling below). Now enter a shell script such as the following in the Source Code text field:

@echo off
echo  %SCHEDULER_JOB_NAME% is  running echo  Current Timestamp:  %DATE% %TIME%
exit %ERRORLEVEL% 

#!/bin/sh
echo  "$SCHEDULER_JOB_NAME is running"
echo  "Current Timestamp:  `date`"
exit $?

Note that a Start Period or Parameters can also be allocated to a Job (see below).

Now save this configuration, either using the ctrl+S keys or File->Save, and JOE will create the ./config/live/quickstart/firstJob.job.xml file.

Now change to JOC and update the window using the Update button at the very top of the window. You will now see the quickstart/firstJob Job in the Jobs tab.

Click on the Job in the left hand part of the window to open a detailed view of the Job in the right hand part. Start a task for this Job by clicking on ->Start task immediately  in the Job menu, as shown in the screenshot below.

The task will now start to run and you can follow its progress in the Task history by clicking on the Show log button.

This will open a new browser window with the log output, where, amongst other things, you will be able to read the output from the shell script.

Congratulations!

You have successfully configured and run your first Standalone Job.

Scheduled Job Starts

In the following example a Standalone Job is configured to start daily at 12:00 o'clock and at 14:00.

You will find the Run Time->Everyday function in the element tree in the left hand pane of JOE: this is a sub-element available for both Jobs and Orders. Use the New Period button (positioned on the right hand side) to add a new start period. Use the Apply Period button to save your input after you have selected Single Start  12:00:00 in the Start Time field. Repeat this procedure for Single Start 14:00:00.

Note that in addition to the fixed start times (Single Start), it is also possible to set the following starting modes:

• repeat intervals (Interval end/start, Interval start/start).
• run-time period when a Job is to be started outside of the Job's time period, the Job will be queued and started once its run-time period has been reached.TO CHECK

Standalone Jobs can still be started manually, regardless of whether a start time or run period has been set. It is also possible to combine the scheduled starting of a Standalone Job with Directory Monitoring, which will be described below.

Schedules

Schedules are predefined Run Time configurations, which are saved as separate JobScheduler objects and then called up as required for any number of jobs.

Schedule elements are configured in JOE separately to jobs as can be seen in the screenshot below.

The configuration of the Schedule follows the same pattern as the configuration of Run Time parameters described above.

The Schedule is then specified for the firstJob job as shown in the screenshot below.

Configuration as XML

The code used to specify the firstJob job at the times specified in schedule1 and with the Directory Monitoring also described is shown in the code block below:

<spooler>
  <config>
    <schedules>
      <schedule name="schedule1">
        <weekdays>
          <day day="1">
            <period single_start="10:00" />
          </day>
          <day day="3">
            <period single_start="10:00" />
          </day>
          <day day="5">
            <period single_start="10:00" />
          </day>
        </weekdays>
      </schedule>
    </schedules>
    <jobs>
      <job name="firstJob">
        <script language="shell"><![CDATA[@echo off
echo  %SCHEDULER_JOB_NAME% is  running echo  Current Timestamp:  %DATE% %TIME%
exit %ERRORLEVEL%]]></script>
        <run_time schedule="schedule1" />
      </job>
    </jobs>
  </config>
</spooler>

Further Reading

A Overview of the JobScheduler Documentation