Joblist Metadata

Joblist nodes contain a read-only XML metadata stream called info. It can be obtained using the getMetaData method on the WiretapNodeHandle object for the joblist node, or using the wiretap_get_metadata command-line tool.

The joblist node info stream contains the metadata for all jobs on the server. This approach is considerably more efficient than retrieving the job node IDs (using the listChildren or wiretap_get_children command-line tool) then querying each job node for its metadata individually.

The returned metadata contains the info element and attributes related to the current jobs. It is structured as follows (line-breaks have been inserted between attributes for clarity): 

<info>
  <job  id="jobid"
        name="jobname"
        user="userid"
        description="description"
        host="hostname"
        pluginName="renderername"
        state="jobstate"
        priority="jobpriority"
        submittedTime="YYYY-MM-DD HH:MM:SS"
        startTime="YYYY-MM-DD HH:MM:SS"
        endTime="YYYY-MM-DD HH:MM:SS"
        numTasks="totaltasks"
        numTasksCompleted="completedtasks">
  </job>
</info>

The following table explains the elements in the metadata stream.

Element/Attribute Type Comments
<info> complex Container for other elements
<job

</job>

start tag

end tag

Container for job attributes
id integer The job’s ID as assigned by the Backburner Manager.
name string The job display name. Unique within current set of Backburner jobs, and set when the job is first created.
user string The name of the user that submitted the job.

This element is set automatically by Backburner when the job is first created.

This value is also returned by WireTapOS::getUserId.
description string The description as provided by the processing client.
host string The name of the host from which the job was submittedThis value is also returned by WireTapOs::getHostName.
pluginName string The Backburner renderer adapter/plug-in needed for the job.

Backburner jobs are always assigned to a specific renderer type. This value is used by the Backburner Manager to determine which servers are eligible to handle a given job.

state string The current state of the job:
  • complete: Completed successfully.
  • active: Currently being serviced.
  • suspended: On hold.
  • idle: Not scheduled for service.
  • waiting: Ready, and waiting to be serviced.
priority integer The job priority, from 0 to 100. Zero is the highest priority. 100 means the job is suspended. Default is 0.
submittedTime string The time at which the job was originally submitted.
startTime string The time at which the job started in the following format: YYYY-MM-DD HH:MM:SS

If the job has not started, zeros appear for the values.

endTime string The time at which the job completed.

When not completed, the time appears as a series of zeros: 0000-00-00 00:00:00.

numTasks integer Backburner jobs are broken down into tasks or sub-jobs that define the granularity of the job.

Blocks of tasks are delegated to multiple servers by the Backburner Manager in any order.

This value is set by the Wiretap client when the job is created. Default is 1.
numTasksCompleted integer Set by the Backburner Manager as each task is completed.

Example

The following use of the wiretap_get_metadata command returns the metadata for a joblist node on a Backburner Wiretap server called camiri:Backburner. The colons (:) indicate material omitted from the example. 

wiretap_get_metadata -h camiri:Backburner  -n /jobs -s info
 
<info>
  <job   id="1318676208" 
         name="Burn_camiri_070620_12.41.07" 
         user="root" 
         description="Test"
         host="camiri" 
         pluginName="burn 2008.0" 
         state="suspended" 
         priority="50"
         submittedTime="2008-01-16 12:15:18"
         startTime="2008-01-16 12:22:23"
         endTime="0000-00-00 00:00:00"
         numTasks="3" 
         umTasksCompleted="0">
  </job>
  :
  :
</info>
Parent topic: Backburner Wiretap Server