Specifications
Logging
Switch automatically issues the appropriate log messages when a script invokes the one of the
Job.sendTo() or Job.fail() functions. A script can call the function described below to log additional
job-related messages.
Logs a message of the specified type for this job,
automatically including the appropriate job information.
log( type : Number, message :
String, extra : String or Number )
See the description of the Environment.log() function for
more information on the arguments.
Getting job ticket info
See using hierarchy info, using email info, viewing job state statistics, and configuring users for
background information.
Returns an Array with the location path segments in the
hierarchy info associated with the job, or an empty array if
getHierarchyPath( ) : String[ ]
there is no hierarchy info. The topmost path segment is stored
at index 0.
Returns an Array with the email addresses in the email info
associated with the job, or an empty array if there are none.
getEmailAddresses( ) : String[ ]
Returns the email body text in the email info associated with
the job, or the empty string if there is none.
getEmailBody( ) : String
Returns the job state currently set for the job, or the empty
string if the job state was never set.
getJobState( ) : String
Returns the short user name for the job, or the empty string
if no user information has been associated with this job.
getUserName() : String
Returns the value of the private data with the specified tag,
or the empty string if no private data with that tag was set
for the job.
getPrivateData ( tag : String ) :
String
Returns a list of all tags for which non-empty private data
was set for the job.
getPrivateDataTags( ) : String[ ]
Returns the job priority for this job as a signed integer
number; see job priorities.
getPriority( ) : Number
Returns the arrival stamp for this job as a signed integer
number; see arrival stamps.
getArrivalStamp( ) : Number
Updating job ticket info
See using hierarchy info, using email info, viewing job state statistics, and configuring users for
background information.
469
Enfocus Switch 10