Web services for Orders in JOC Cockpit

DESCRIPTION IN PROGRESS
The orders should have more information for JOC Cockpit. In general two different web services are required, one for a list of orders and one for a summary.

Web service for order listing

• Orders can be filtered by
  • processingStates: Planned, NotPlanned, Suspended, Setback, Running, Blacklist, Waiting
    mutiple processingStates can be defined
  • sourceTypes AdHoc, Permanent, FIleOrder
    mutiple sourceTypes can be defined
  • folder with recursive or not
  • jobchain
  • orderId
• multiple filters are possible
• Orders are responsed in a compact or a detailed view depends on a parameter
  The detailed view contains the fields of the compact view

The fields of the compact view

• path: job chain path,orderId
• nodeId
• job
• sourceType: Permanent/AdHoc/FileOrder
• startedAt
• historyId
• processingState: see below
• obstacles: see below; array with reasons why an order is not processed
• fileBasedObstacles: see below; contains information about changed configuration

Additional fields of the detailed view

• title (if defined)
• priority (if defined)
• initialState
• endState (if defined)
• fileModifiedAt
• params

processingState

• NotPlanned:
  "Untouched" order without run time
• Planned:
  "Untouched" order with run time. Additional field is defined for
  • next start time
• InTaskProcess:
  Task is started and order is in processing. Additional fields are defined for
  • task id
  • timestamp since process began
  • used process class
  • agent uri if agent used
  • clusterMemberId if the job chain is distributed
• WaitingInTask:
  Task is started but order will not be processed because agent is not accessible. Additional fields are defined for
  • task id
  • used process class
  • agent uri
• Setback:
  Order has a setback. Additional fields are defined for
  • timestamp until setback will be started
• Suspended:
  Order is supended.
• Blacklisted:
  Order is in the blacklist
  • clusterMemberId if the job chain is distributed
• Pending:
  this is the same like WaitingForOther but the order was "untouched"
• WaitingForOther:
  Order waits for a resource such as job is not in period
  Reasons are defined in an obstacles array

obstacles

• job not in period
• job stopped
• job chain stopped
• node stopped
• node delay
• lock
• max processes
• max tasks

fileBasedObstacles

• changed file not loaded because it is invalid
  • TYPE: "Replaced"
  • error: ...
• removing delayed
  • TYPE: "Removed"
• replacement is standing by
  • TYPE: "Replaced"
• missing requisites
  • TYPE: "MissingRequisite"
  • objType: e.g. Job, Schedule, job chain, etc...
  • path: /path/of/missing/object

Web service for order summary

it counts the orders of each processingState Planned, NotPlanned, Suspended, Setback, Running, Blacklist, Waiting

{ "Planned":[number], "NotPlanned":[number], "Suspended":[number], "Setback":[number], "Running":[number], "Blacklist":[number], "Waiting":[number] }

• Orders can be filtered by
  • jobChain - only orders of the jobChain are counted
  • job - only orders of job's orderqueue are counted