Product Knowledge Base

Space shortcuts

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 23 Next »

Introduction & Requirements

This tutorial follows on directly from JobScheduler - Tutorial 2 - Editing a Simple Job with JOE and will show how a Run Time parameter can be configured to start the Order. This is also a first step towards learning to using the JobScheduler's Schedule function.

It is assumed that before you start to work through this tutorial you have already configured the 'Hello World' job chain with its two jobs as described in the previous tutorials.

Note that the other tutorials in this series are:

Setting the Days When the Order is to Run

  1.  Start by selecting the hello_world_order in JOE as shown here:


  2. Now click on the triangle to the left of the order in the Scheduler Elements pane to show the Parameter and Run Time elements.


  3. Still in the Scheduler Elements pane, open the Run Time element and click on the Any Weekday element.
    This will open a Weekday form as shown in the diagram below:


  4. Now click on the Every Day button as shown in the screen shot above, which will specify that the JobScheduler is to start the order every day of the week.
    It does this by creating a new Group with all seven days of the week and showing this Group in the central field of the form as shown below:


  5. This seven-day Group can be edited - for example, to reduce the number of days to the normal five working days - by selecting the group as shown in the next screenshot and then marking the days to be removed.


  6. The Apply Group button is then used to overwrite the original seven day group shown in the central field with the new one.

Setting the Time of Day at which the Order is to run

For the purpose of this tutorial, it would be useful to let the order run at intervals of an hour, starting at 12:00 and ending at 24:00.

  1. In the Scheduler Elements pane, click on the 1 2 3 4 5 element, representing the Monday to Friday group just configured. This will open the Periods form, which is used to set the times of the day when the Order is to run.


  2. Click on the New Period button as shown in the screenshot above, to activate the Time Slot and Start Time fields (the field background color changes from gray to white) in the upper part of the form:


  3. To restrict the time during which our Order will run set the Begin Time in the Time Slot area of the form to 12:00 and the End Time to 24:00.
    Next, set the type of start time in the Start Time part of the form to Interval start/start, which will be more regular than Interval end/start as shown in the next screenshot:


  4. Now set the interval in the Start Time part of the form to 01:00:00 and then click on the Apply Period button to note the Period, which will now be entered in the Periods list in the lower part of the form as shown below:


  5. As a final step in JOE, save the run time information using the Save Configuration button at the top of JOE.

Using the JOC Cockpit to Start An Order On-The-Fly and Observe Order Processing

Opening the Job Chain Flow Diagram

This presentation of the Job Chain is intended to provide more detailed information and offer additional options than the Card and List presentations shown in Tutorial 1. 

  1. Call up the JOC Cockpit Login page and log in with your user account as described at the start of Tutorial 1.
     
  2. Select the Job Chains view in the main menu and then open the tutorials folder in the tree menu at the left.
    This will open the card view of the hello_world_job_chain.
     
  3. Now open the Additional Options menu (the ellipsis symbol) and select the Show Flow Diagram option as shown below:


  4. The Job Chain Flow Diagram is shown in the next screenshot. It is dynamic and can be used to monitor the progress of the Order along the Job Chain in near real-time. 
    The Order is represented in the Diagram by the line of text alongside the yellow circle above the first Node in the chain and has an Additional Options menu, which is opened using the ellipsis symbol as shown in the screenshot.
     

Starting the Order Now and Following the Order Progress

Persistent and On-The-Fly Settings 

The Run Time configuration set for the hello_world_order in the first part of this tutorial will start the Order once every hour between 12:00 and 24:00 Mondays to Fridays. As with all configurations made using the JobScheduler Object Editor, JOE, this configuration is saved in the JobScheduler's file system and is therefore persistent. However, these settings may not be very convenient if you want to observe the Job Chain being processed and, for example, are following this tutorial at a time when the Order is not scheduled to run. The JOC Cockpit can be used to configure on-the-fly settings for Run Times that are available in addition to the Run Times set using JOE. There are a number of ways that this can be done:

  • In Tutorial 1 the Order was started using the Add New Order function. This was accessed from the Order's Card view Additional Options menu and allows a start time to be configured as well as the immediate start that was used in the tutorial. In addition the form can be used to configure parameters for the order. 
     
  • The Flow Diagram presentation provides a Start Order Now option. In contrast with the Add New Order option described in Tutorial 1, this option does not allow a start time to be configured nor does it allow on-the-fly configuration of the order such as setting parameters.

The Flow Diagram presentation also allows the Order processing to be followed in near real-time. (The ping commands in the Job scripts help here as they increase the processing times of the Jobs.)

Note that Run Time settings and Parameters configured in the JOC Cockpit are not stored persistently but Schedules (which may also include Run Times) are.

Starting the Order Now

  1. Open the Order's Additional Options menu by clicking in the ellipsis symbol above the first job in the job chain in the Flow Diagram Presentation and start the hello_world_order by selecting the Start Order Now option. You will now be able to follow the progress of the Order along the Job Chain almost in real-time
    The screenshot below shows the order being processed at the second job.
    In addition, the Order History table at the foot of the screenshot will show the current Order Status of processing, the Start Time, the processing Duration and the Node currently being processed - also in near real-time.


    Note that the Add an Order button at the top right of the View can be used to access the Add New Order form with the possibility of setting Parameters and a Run Time.

 

  • No labels