Skip to end of metadata
Go to start of metadata

Article only applies for the Classic JOC interface

Icon

The information provided on this page only applies to the Classic JOC user interface, which is entering retirement:

FEATURE AVAILABILITY ENDING WITH RELEASE 1.11

The JOC Cockpit user interface replaces JOC:

FEATURE AVAILABILITY STARTING FROM RELEASE 1.11

See the JOC Cockpit - Features Article for general information about the features of the JOC Cockpit.

A detailed list of the functions available with JobScheduler's operating interface, JOC. 

WORK IN PROGRESS

Scheduler Menu

This means the menu button in the top of JOC.

...WORK IN PROGRESS

Job Menu

For each job in the Jobs tab you can call a menu of some functions

  • via right click in the left tree view of the jobs.
  • via the Job menu button in the left list view of the jobs.
  • via the Job menu button in the right detail view of a job which you get when you have click on a job.

 

These functions are:

show log

It shows the job log in a new window via:

http://<JobScheduler host>:<JobScheduler port>/show_log?job=jobname

show configuration

It shows the job configuration in a new window.

This function is only active for jobs which has its configuration in the ./config/live/ folder.

If the job is configured directly in the ./config/scheduler.xml then this function is inactive.

Underlying command: <show_job job="jobname" what="source"/>

show description

If the job has a description in its configuration then this function is active and shows it in a new window.

show dependencies

...WORK IN PROGRESS

show start times

...WORK IN PROGRESS

start task immediately

Hereby you start a task of a (standalone) job immediately independent if the job is stopped or not.

This function is inactive for order jobs. Order jobs can only be started by an order.

Underlying command: <start_job job="jobname"/>

start task after

Here you get a dialog for a later job start. You can enter a start time in ISO format "yyyy-mm-dd HH:MM[:SS]" or "now".

The run time of the job is deactivated.

Relative times - "now + HH:MM[:SS]" and "now + SECONDS" - are allowed.

Underlying command: <start_job job="jobname" at="..."/>

start task parametrized

Here you get a dialog for a later job start and for parameter settings. See start task after.

Underlying command: <start_job job="jobname" at="..."><params><param name="..." value="..."/>...</params></start_job>

set run time

...WORK IN PROGRESS

stop

You can configure a job to stop automatically after an error occurs.

Here you can stop a job manually.

If you stop a job while a task is running then this task continues to run normally.

Stopped jobs cannot start a new task due to its run time or an order until you unstop it.

But you can start a stopped job manually via the start task immediately function.

Underlying command: <modify_job job="jobname" cmd="stop"/>

unstop

This function is only active for a stopped job to unstop it.

Underlying command: <modify_job job="jobname" cmd="unstop"/>

reread

This function is obsolete and removed in the next release.

end tasks

The end tasks, suspend tasks and continue tasks has only an effect on API jobs.

They have no effect on shell jobs.

Because of this special effect, end tasks, suspend tasks and continue tasks are hidden per default since JobScheduler Release 1.8.

You can configure the custom.js to show them.

The end tasks function close all running tasks of the API job after the current process step.

It isn't a kill. The job is not stopped after the end tasks.

Underlying command: <modify_job job="jobname" cmd="end"/>

suspend tasks

This function suspends all running tasks of the API job after the current process step.

The tasks are still alive.

Underlying command: <modify_job job="jobname" cmd="suspend"/>

continue tasks

This function continues all suspended tasks and the next process step is called.

Underlying command: <modify_job job="jobname" cmd="continue"/>

Task Menu

If a task of a job is running and you have clicked on the job then you see in the right detail view of the job the running tasks with a task menu button which contains the following functions

show log

It shows the task log in a new window via

http://<JobScheduler host>:<JobScheduler port>/show_log?task=task-id

end

This function has only an effect on API jobs.

They have no effect on shell jobs.

It close the task of the API job after the current process step.

Underlying command: <kill_task job="jobname" id="task-id"/>

kill immediately

This function kills the task immediately from the process list.

The job stops when it is configured to stop on error.

Underlying command: <kill_task job="jobname" id="task-id" immediately="yes"/>

Job Chain Menu

...WORK IN PROGRESS

Job Node Menu

...WORK IN PROGRESS

Order Menu

show log

It shows the order log in a new window via

http://<JobScheduler host>:<JobScheduler port>/show_log?job_chain=jobchain_name&order=order_id

show configuration

It shows the order configuration in a new window.

This function is only active for orders which has its configuration in the ./config/live/ folder.

If the order is temporary or is configured directly in the ./config/scheduler.xml then this function is inactive.

Underlying command: <show_order job_chain="jobchainname" order="order-id" what="source"/>

show start times

...WORK IN PROGRESS

start order now

Hereby you start the order immediately.

Underlying command: <modify_order job_chain="jobchainname" order="order-id" at="now"/>

start order at

Here you get a dialog for a later order start. You can enter a start time in ISO format "yyyy-mm-dd HH:MM[:SS]" or "now".

The run time of the order is deactivated.

Relative times - "now + HH:MM[:SS]" and "now + SECONDS" - are allowed.

Underlying command: <modify_order job_chain="jobchainname" order="order-id" at="..."/>

start order parametrized

Here you get a dialog for a later order start and for parameter settings. See start order at.

Underlying command: <modify_order job_chain="jobchainname" order="order-id" at="..."><params><param name="..." value="..."/>...</params></modify_order>

add order

The current order is used as a template for a new order expect its run time.

The new order is a temporary order. It doesn't get a configuration file in ./config/live/.

You get a dialog to modify some order settings like id, status and parameters before the new order will be started.

Underlying command: <add_order job_chain="jobchainname" order="order-id" at="..."><params><param name="..." value="..."/>...</params></add_order>

set order state

...WORK IN PROGRESS

set run time

...WORK IN PROGRESS

suspend order

You can configure a job chain node so that an order will be suspended if the job in this node throws an error.

Here you can suspend an order manually.

It is not possible to suspend the order while it has started a job.

A suspended order remains at the job chain node where it was suspended.

A suspended order cannot start the job task of its current job chain node due to its run time until you resume it.

Underlying command: <modify_order job_chain="jobchainname" order="order-id" suspended="yes"/>

resume order

This function is only active for a suspended order to resume it.

Underlying command: <modify_order job_chain="jobchainname" order="order-id" suspended="no"/>

reset order

Hereby you move the order to its initial job chain node (normally the first node).

It is not possible to reset the order while it has started a job.

The order log will not be closed. If a a reset order starts then its log appends.

Underlying command: <modify_order job_chain="jobchainname" order="order-id" action="reset"/>

remove setback

You can configure a job chain node that an order will be automatically repeated if the job in this node throws an error.

This function stops the automatically repeat.

Underlying command: <modify_order job_chain="jobchainname" order="order-id" setback="no"/>