Skip to end of metadata
Go to start of metadata

The JobScheduler can be controlled by commands (e.g. starting a jobs) from external applications (or scripts).
More information of all available commands can be found here: Jetty/xml_commands.xml Command List].

The syntax of the command is similar to the xml syntax which is used to implement JobScheduler objects. The external API contains commands, like "start_job, add_order, show_state, ...". Everytime when a command is sent to the JobScheduler engine, the engine will reply an answer. This answer is pure XML as well. JOC, for Example, is using this external API very intensive.

An external application, which is able and has the authorisation to send such commands to the JSEngine can use http(s) or tcp/ip to establish the communication. That means, that even a script language like javascript can be used to communicate. For Java users we have a wrapper class paket which was created using JAXB and the xsd schema for the commands and answers.


The commands can be transferred to the JobScheduler via the following protocols:

  • HTTP
  • TCP
  • UDP

and telnet.

In addition a command line interface (CLI) is available via the "" script.

Example using JOC

You can use JOC to send a command using the URL:


or if you open JOC with  Jetty then type:


where <show_state/> is an example for a command of the JobScheduler external API.

Example using the JobScheduler script

You can use the startscript found in ./bin to send a command too.
An example for using the command line option command "<show_state/>"

The answer of command ... is without indent and newlines.
If you want a more readable answer then type command "<show_state/>" | sed -e 's;[^>]*$;;' | xmllint --format -

Object Model: start an order

package com.sos.scheduler.model.commands;
import java.util.List;

import org.apache.log4j.Logger;
import org.junit.BeforeClass;
import org.junit.Test;

import com.sos.JSHelper.Exceptions.JobSchedulerException;
import com.sos.scheduler.model.SchedulerObjectFactory;
import com.sos.scheduler.model.answers.Answer;
import com.sos.scheduler.model.answers.ERROR;
import com.sos.scheduler.model.objects.Params;
import com.sos.scheduler.model.objects.Spooler;

public class JSCmdAddOrderTest {
	private final static Logger				logger	= Logger.getLogger(JSCmdAddOrderTest.class);
	private static SchedulerObjectFactory	factory	= null;

	@BeforeClass public static void setUpBeforeClass() throws Exception {
		factory = new SchedulerObjectFactory("localhost", 4112);

	@Test public final void testSetValidXmlContent() {
		JSCmdAddOrder cmdOrder = factory.createAddOrder();
		cmdOrder.setTitle("JobNet: null");
		cmdOrder.setParams(new Params());
		List<Object> objL = cmdOrder.getParams().getParamOrCopyParamsOrInclude();
		objL.add(factory.createParam("successor", "B,C,D,"));
		objL.add(factory.createParam("predecessor", ""));
		objL.add(factory.createParam("script_to_execute", "echo Here is the bootstrap order"));
		objL.add(factory.createParam("uuid_jobnet_identifier", "989ac2ce-2538-4276-8003-3350a6224c97"));
		objL.add(factory.createParam("jobnet", "/job_chain_multiple_inheritance_sample/job_chain_multiple_inheritance_sample"));
		cmdOrder.setAt("2012-04-17 22:00");
		String xml = cmdOrder.toXMLString();;
		Answer answer = cmdOrder.getAnswer();
		ERROR jsError = answer.getERROR();
		if (jsError != null) {
			logger.debug(xml + "\n" + jsError.getText());
			throw new JobSchedulerException("Error in execution of order");


Examples in Detail

See also

Write a comment…