Processing results schema

The FTP send and Mail send tools produce a log file with processing results. This log file is carried along the outgoing log connections.

This log file can be associated with the job as a metadata dataset by using a "data with log" connection (see the "Carry this type of files" property of traffic-light connections).

Data model and schema

The processing results log file uses the XML data model with a simple schema without namespaces.

The XML document element name is "ProcessingResults". It contains a sequence of elements with a name and contents as described in the following table. If a data item is not applicable, the corresponding element may be missing.

Element name

Data type

Description

Destination

Text

For FTP, the complete target URL for the job

For Mail, the list of destination email addresses

FlowElementName

Text

The name of the flow element that produced this log file (as displayed in the canvas)

FlowElementType

Text

The type of the flow element that produced this log file (e.g. "FTP send" or "Mail send")

FlowName

Text

The name of the flow (as displayed in the flows pane) containing the flow element that produced this log file

JobArrivalStamp

Integer

The arrival stamp for the processed job as a signed integer number; a lower arrival stamp indicates a job that arrived in the flow earlier (and vice versa)

Several jobs may have the same arrival stamp, for example when multiple jobs are generated from the same original job

JobByteCount

Integer

The size in bytes of the processed job; if it is a job folder, all files in subfolders are included in the count, recursively

JobExtension

Text

The processed job's filename extension, or the empty string if there is none

JobFileCount

Integer

The number of files in the processed job, including all files in subfolders, recursively (folders and subfolders themselves do not contribute to the count)

JobFiles

Sequence of "File" elements

A sequence of one or more "File" elements representing the files in the processed job in arbitrary order; each File element has the Text data type and contains the relative path of a file within the job (using a forward slash as path separator)

Folders are NOT represented in this list

JobIsFile

Boolean

True if the processed job is a single file, false otherwise

JobIsFolder

Boolean

True if the processed job is a folder, false otherwise

JobName

Text

The file or folder name for the processed job, including filename extension if present, but excluding the unique filename prefix

JobNameProper

Text

The file or folder name for the processed job excluding filename extension and excluding the unique filename prefix

JobOrigin

Text

An indication of the origin of the processed job before it was injected in the flow; for example, a Submit point writes the absolute path of the original job (on the client machine) in this field

JobPath

Text

The absolute file or folder path for the processed job as it resided in the input folder before being processed, including unique filename prefix

JobPriority

Integer

The job priority assigned to the processed job as a signed integer number

JobUniqueNamePrefix

Text

The unique filename prefix used for the processed job, without the underscores; for a job called "_0G63D_myjob.txt" this would be "0G63D"

JobUserName

Text

The user name associated with the processed job, if any

ProcessingEnded

Date

The date-time when the operation was completed (in the ISO 8601 format also used for Switch date variables)

ProcessingStarted

Date

The date-time when the operation started (in the ISO 8601 format also used for Switch date variables)

ServerAddress

Text

The name or IP address of the destination server

ServerLoginName

Text

The user name used to login at the destination server

ServerPort

Integer

The port of the destination server