Versions Compared

Key

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

...

  • To start a job chain via SOAP web service the SOAP client should send a post request to the JobScheduler with the following SOAP format:

    Code Block
    languagexml
    titleSOAP request to start a job chain
    collapsetrue
    <?xml version="1.0" encoding="UTF-8"?>
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
       <soapenv:Body>
          <addOrder xmlns="http://www.sos-berlin.com/scheduler">
            <!-- Job Chain name with full qualified path after live folder-->
             <jobchain>examples<jobChain>examples/01_JobChainShellJobs/01_JobChainA</jobchain>jobChain>
             <title>soaptest</title>
             <!-- parameters passed to the job chain-->
             <param>
                <name>SOAP_PARAM1</name>
                <value>Value1</value>
             </param>
             <param>
                <name>SOAP_PARAM2</name>
                <value>Value2</value>
             </param>
          </addOrder>
       </soapenv:Body>
    </soapenv:Envelope>
  • Above given SOAP request will submit an order to the job chain example/01_JobChainShellJobs/01_JobChainA. The order will also have two parameters SOAP_PARAM1=Value1 and SOAP_PARAM2=Value2 that will be passed to the job chain.
  • With the SOAP request being received the JobScheduler will immediately add the order and send back the order id with the SOAP response. 

    Code Block
    languagexml
    titleSOAP response to start an order for a job chain
    collapsetrue
    <?xml version="1.0" encoding="ISO-8859-1"?>
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
      <soapenv:Body>
        <sos:orderId xmlns:sos="http://www.sos-berlin.com/scheduler">100635</sos:orderId>
      </soapenv:Body>
    </soapenv:Envelope>

...

  • To check the status of the order that has been sent to JobScheduler you can send the below SOAP request to the JobScheduler.
  • For possible errors with this operation see 

    Jira
    serverSOS JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId6dc67751-9d67-34cd-985b-194a8cdc9602
    keyJS-1183
     for more information. 

    Code Block
    languagexml
    titleSOAP request to check order status
    collapsetrue
    <?xml version="1.0" encoding="UTF-8"?>
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
       <soapenv:Body>
          <showOrder xmlns="http://www.sos-berlin.com/scheduler">
             <jobchain>examples<jobChain>examples/01_JobChainShellJobs/01_JobChainA</jobchain>jobChain>
             <order>100638</order>
          </showOrder>
       </soapenv:Body>
    </soapenv:Envelope>

...