Jobarchive Metadata

Jobarchive nodes contain a read-only metadata stream called info. Like all metadata streams, 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 jobarchive node info stream contains the metadata for all archived jobs on the server. This approach is considerably more efficient than retrieving the archived job node IDs (using the listChildren or wiretap_get_children command-line tool) and then querying each job node for its metadata individually.

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

<info>
  <job id="jobid"
       name="jobname"
       user="userid"
       description="description"
       submittedTime="timesent"
       endTime="timecompleted"
       pluginName="renderername"
  </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 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, this is 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.
submittedTime string The time at which the job is submitted in the following format: YYYY-MM-DD HH:MM:SS.
endTime string The time at which the job is completed. When there is no end-time, or the job is archived before completion, the time appears as a series of zeros:

0000-00-00 00:00:00.

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.

Example

The following use of the wiretap_get_metadata command returns the info metadata for jobs archived on a Backburner Wiretap server called santos:Backburner. The colons (:) indicate material omitted from the example. 

wiretap_get_metadata -h santos:Backburner -n /archive -s info
 
<info>
  <job  id="1040720950" 			
        name="job4" 
        user="nelsonr" 
        description="/tmp/dst" 
        submittedTime="2008-01-08 15:31:13" 
        endTime="0000-00-00 00:00:00" 
        pluginName="Wire"
  </job>
:
:
</info>
Parent topic: Backburner Wiretap Server