JobInfos

Prev Next

Applies to: Lasernet Core 10

Introduction

A JobInfo is a unique and variable information string, which is automatically generated in a module, or manually defined by a user. They are used as keywords and for setting up information in various modules. Generally, JobInfos are used for declaring an email address, an archive index or printer specific information. JobInfos can also be very useful for setting up conditions for validating the data stream. Lasernet Core will automatically build up a system list depending on the input module receiver, although user-defined JobInfos can be added as well.

JobInfos will be transferred between modules. This gives the ability to check, print, update and execute a current JobInfo at any statement, when processing a job through Lasernet Core. In turn, this ensures the seamless integration of Lasernet Core into a Windows environment.

To fully understand JobInfos, it is useful to first understand what constitutes a Job. Think of a Job as a package from the post office. It is a box with something in it – the raw data that you wish to process. In this analogy, JobInfos can be thought of as all the various labels that are attached to the package. One is the address where package is to be sent, another contains information about where the package originated and yet another shows the package has been processed by Customs en-route to its destination. Even the stamp is marked with a date that shows when the package was sent. All these extra pieces of key information attached to the package can be thought of as JobInfos. As well as containing metadata about the package, JobInfos also contain metadata about the Job. All JobInfos have a name which is used to access the data associated with it. In much the same way the Customs Label will be clearly marked ‘Customs’

The name of a JobInfo is not case-sensitive. The lines below are considered identical.

job.setJobInfo('a little jobinfo', 'With A Vengeance', true);

job.setJobInfo('A Little JobInfo', 'With A Vengeance', true);

Note

The value is case sensitive. This is important to remember when retrieving values and using them e.g. in comparisons.

JobInfo Types

Most JobInfos can be represented as text, but sometimes the data type is such that it cannot easily be represented in this way. Internally, Lasernet Core handles all JobInfos (regardless of type) as binary data. In technical terms this means that when assigning a text to a JobInfo, Lasernet Core converts it to UTF-8 (a Unicode representation that can be stored byte-wise). When using JobInfos as text (the most common usage), this does not pose any problems. However, a few situations require special attention. This includes the File Output module, which has the ability to embed JobInfos into the JobData. In this instance it is possible to choose which codepage the JobInfo should be converted to before embedding it.

JobInfo lists

In some situations, it is necessary or desirable to have more than one value in a JobInfo. For instance, the Source JobInfo is a list of modules that the Job has passed through; a new value being added to the Source JobInfo for every new process. The function “Replace existing JobInfo”, commonly found throughout Lasernet Core, can knock out these accumulated values and replace them with a single user defined value instead. If “Replace existing JobInfo” is not activated, any existing values will be preserved.

The individual items can then be accessed in different ways. If there is a JobInfo list called MyJobInfo, accessing the third element of the list can be done with a script function such as getJobInfo(“MyJobInfo”,2) or by creating a Fixed Text Rearrange of type JobInfo and writing MyJobInfo[2]. The indexing is zero-based, meaning that the first item of the list is MyJobInfo[0].

JobInfo Substitution

Since the JobInfos are an essential part of a Job it is possible to assign values to them in many different ways and at multiple locations. When assigning a value to a JobInfo you must specify the name of the JobInfo as well. The value does not have to be text. Special syntax exists which allows for greater functionality. This is generally known as substitution. For example, this allows you to write:

The job came from #InputPort#

as a value. This means that Lasernet Core will look up the value in the InputPort JobInfo and replace #InputPort# with that value. This can be done with more than one JobInfo:

The job came from #InputPort# and was created at #JobTime#

The #JobInfoName# syntax has a few more possibilities. Since a JobInfo can also be a list, you can choose to access a specific value in the list, by adding an index to the substitution:

The job came from #Source[0]#

You can also choose to expand the list with a custom delimiter:

The job has passed through these modules: #Source{,}#

To facilitate the use of # as a value, an escape character is used – The Generic Currency Symbol – ¤ – Ascii A4.

Putting a ¤ before the # allows you to use # as a value. To get a ¤ as value, simply use two: ¤¤

If you only need one # simply put that in. As long as there is no matching # Lasernet Core assumes you just want the one #

In the following examples, |name| means the contents of the JobInfo that has that name.

abc¤###def => abc##def

abc¤¤#def  => abc¤#def

abc¤¤#def# => abc¤|def|

JobInfo substitution is not recursive, so if a JobInfo name is put in a JobInfo value, only the outer JobInfo is substituted e.g., if there are two JobInfos: Inner=Value, Outer=#Inner#, typing “#Inner#” in a field with substitution will yield Value, while putting “#Outer#” will yield “#Inner”, which will not be substituted further.

Due to historical implementation issues, there may be some places in Lasernet Core where JobInfo substitution does not work.

JobData as JobInfo

As JobInfos are incredibly versatile the actual raw job data is also stored in a JobInfo. This JobInfo is called JobData (by default).

This means that you can change the value of the raw data by using normal substitution expressions as detailed above. Caution should be exercised when using this approach as the substitution is not foolproof, especially when working with a mixture of binary and text data. Whilst results are generally favorable, unexpected output may occur. As such, this function should only be used after careful consideration.

System-Generated JobInfos

These JobInfos are automatically generated by Lasernet Core. This information is generated by specific input modules that receive data.

Dynamic JobInfos give quick and easy access to key information:

JobInfo Name Description
JobSize The size of the Job (in bytes)
ConfigRevision To get the revision of the configuration on a form. In the Developer app returns 'Patched' unless an older revision is opened. Lasernet Core Service returns the deployed revision number.
CurrentTime Always returns the current time as hh:mm:ss.zzz (where zzz is milliseconds)
CurrentDate Always returns the current date as yyyy-MM-dd
LocalHost Returns the name of the current computer
CurrentSubmoduleID The name of the module currently processing the Job.
JobID A unique ID for the Job – this can change for each sub module that the Job passes through
JobData The standard JobInfo containing the raw data to process
PrimaryJobData The name of the JobInfo that contains the JobData – by default the value is JobData (NB: This JobInfo is deprecated and will be removed in future releases)
PublicID The JobID of the Job when it was first created.
CurrentModuleID The full target URL of the module that is currently handling the Job
OriginatingModule The module that created the Job – usually the same as Input module but could also be an instance of the Forms Engine that creates and manipulates copies of the Job
InputPort The Input module that created the first instance of the Job
JobTime The time the Job was started
JobDate The date the Job was started
Source A list of the modules that the Job has passed through

Manually Generated JobInfo in the ERP System

A JobInfo can be declared in any Windows application, such as an ERP system. Type the JobInfo string as pure text. The syntax for manually setting up a JobInfo in a Windows application is:

#JobInfo JobInfoType=JobInfoValue# like

#JobInfo MailTo=john.doe@hotmail.com# or

#JobInfo MailTo=john.doe@hotmail.com; jane.doe@hotmail.com#

Comma and semicolon are valid as separator characters for multiple addresses.

The JobInfo text can be defined with any font, size, or typeface and Lasernet Core will still scan the spool job and pick up the keywords.

JobInfo Defined via UI in Modules

A JobInfo can be defined in any module, at different event types that are called Pre JobInfos and Post JobInfos (depending on the module type). The green tabs at the bottom of the module dialogs illustrate the processing order of jobs.

To set up a JobInfo in a Lasernet Core module, fill out the JobInfo Name and JobInfo Value by clicking the Add button. In some cases, you will find a button named Add Copy JobInfos. This button is used to copy the contents of JobData in Binary mode to PreviewJobData. This used to preview the original contents of the input data in Lasernet Client.

Type: Select Assign to assign a value in text mode. Select Copy to copy a value in binary mode.

Name: Includes a list of the most commonly used, pre-defined Lasernet JobInfos, or a custom named JobInfo.

Value/Copy: This field is empty by default. However, several JobInfos include a list of typical values to choose from. These are only provided for guidance and do not have to be used.

In Assign mode the value can be set as a mix of a JobInfo and clear text, like

In Copy mode a binary value is copy from the name of JobInfo to the name of another JobInfo:

Log Level: Used to maintain the status of the server log message. Default value is JobInfo level that will show the name and value of the log message. Debug mode is only show the name and value in debug mode and log level NoLog will not create a log message.

Replace: By activating this checkbox is will replace any other JobInfo with the same name. Some JobInfos can contain a list of several values for example, an email distribution list.

The Move up and Move down buttons modify the order in which the JobInfos are defined.

JobInfo Reference

JobInfo Name Description
ActiveCodePage Lasernet Core attempts to keep this JobInfo up to date with the code page of any text currently residing in JobData. It is set by the Code Page Conversion Modifier, the Text Filter Modifier and the Filter Engine. The Code Page Conversion Modifier sets it to the name of the output codec. Since the Text Filter Modifier and the Filter Engine have options for disabling code page conversion, they both check on the value of the ActiveCodePage JobInfo. If it exists, they convert from the codec it suggests to UTF16, filter the data and then convert to the desired output format. If no output format is chosen it defaults to UTF8. The value of ActiveCodePage is then set to the name of the output codec (default UTF8).
ActualOutputFilename The ActualOutputFilename JobInfo is created by the File Output module. The value is set to the name of the output file actually written to disk. The filename includes the entire path. The value could be used in a Data Written Modifier.
ArchiveFileName Contains the name of the archive file. Created by the Compression module if decompress is enabled.
Autofill Created by Meta Input. Available when an Autofill request has been sent from Lasernet Meta. The value is equal 1.
AutoPaperSource

Set value to "1", "Yes" or "True" to automatically select the paper source in the printer, by detecting the PDF page size, for PDF documents stored in the JobInfo PrintAttachment.

Modules: Printer Output, Printer Service

CleanJobInfos Used by the Database Command. If set to 1, JobInfo Substitution will not occur on the JobInfos whose assigned values are returned from the database. If set to anything else they will be substituted.
ClientID ClientID is used together with PreviewExtension to give the client further information.
ClientUserName

Created by Meta Input. Username for the login client as defined in the Lasernet Meta > Tools > Client settings.

When running with default credentials the value will be left empty.

ColorMode Supported by EMF2RAW, Printer Output and Printer Service to set monochrome or color printing.
Copies Supported by Printer Output and Printer Service to control the number of printed copies.
CompressionLevel Contains the compression level of the zip archive. Created by the Compression module if decompress is enabled.
CurrentDate The CurrentDate JobInfo is always available. It contains the current date in the format yyyy-MM-dd. The date is fetched from the computer on which Lasernet Core is running.
CurrentModuleID The CurrentModuleID JobInfo contains the full path to the module in which the job currently resides.
CurrentPage The CurrentPage JobInfo is set in the Form Engine when the analysis has finished fitting text to the pages and has started running scripts on rearranges. It is set to the page number on which the script for rearranges is currently being run.
CurrentTime The CurrentTime JobInfo is always available. It contains the current time in the format hh:mm:ss.zzz where zzz represents milliseconds. The time is fetched from the computer on which Lasernet Core is running.
DataFormat

The DataFormat JobInfo is created by the Printer Input module. The value is the data format generated by the printer that the engine is using. If the DataFormat is empty, the Printer Input module sets it to the default value EMF. It is also created by the PDF Modifier where it is consistently set to the value RAW.

It is also created by the Form Engine where it can be set to TEXT or EMF.

DataFormat is used by EMF2RAW.

DataParameters Created by the Printer Input module. Contains parameters from the print processor which handled the job.
DataPrinterName Created by the Printer Input module. Contains the name of the printer that printed the job.
DataStartTime Created by the Printer Input module.
DataTotalPages Created by the Printer Input module. Contains the total number of pages in the print job. May be zero if the job does not contain any page delimiting information.
DataUntilTime Created by the Printer Input module.
Default, DefaultPrinter The Default or DefaultPrinter JobInfos are options that can be set by several input modules. This value can be used to store a destination that can be used later, for example, in the form engine. This is convenient for pairing input and output modules but letting the job pass through the same engines somewhere in the middle.
Destination Will be set each time a job is passed to another engine or an output module. It is set to the name of the receiver.
DetailInformation Created by various modules. It is primarily used by the Lasernet Monitor to show module specific information about the job. It is possible for the user to add information to this JobInfo but be aware that it may be overwritten at any time.
DocName

Created by the Printer Input module. It contains the name of the print job as set by the Windows Print Spooler. If it is empty the default value set by Printer Input module is Unnamed – Lasernet document.

DocName also is supported in the Printer Output, Printer Service modules to set name of print job for the Windows printer queue.

DocumentName Created by Meta Input. The name of the print job, as set by the Windows Print Spooler, when the document is printed to Lasernet Meta. Or the name of the file, as set by the Windows File System, when the document is retrieved via polling in Lasernet Meta.
DropboxURL URL to publicly shared file. The JobInfo is only set when Sharing publicly is enabled in the GUI.
DriverName The name of printer driver as set by the Windows Print Spooler, when the document is sent to Meta Input (via Lasernet Meta) or direct to the Printer Input module.
DuplexMode

Allows to print on both sides of a paper automatically. Examples of values are: Default, Simplex, Vertical and Horizontal.

Supported by EMF2RAW, Printer Output and Printer Service modules.

Extension Created by the Azure Storage Input, File, FTP, HTTP and Meta Input modules. The value is set to the extension of the file which is received by module e.g., ‘.txt’. The extension includes the dot (.) in front.
ExitCode Is generated by the Process Modifier. It contains the actual exit code of the external application.
FailingPort The FailingPort JobInfo is set when a job is failed.
FailingSubmodule The FailingSubmodule JobInfo is set when a job is failed. It is set to the name of the submodule in which the job fails.
FileCreated Set by File Input module to the time the file was created. The time is in the format yyyy-mm-dd hh:mm:ss.zzz.
FileComment Contains a comment embedded in the zip archive if available. Created by the Compression module if decompress is enabled.
FileID ID of uploaded file returned after upload to Google Drive or OneDrive via the output modules.
FileLastModified Set by File Input or Compression module to the last modified time of the incoming file (for Compression module file(s) inside the archive). The time is in the format yyyy-mm-dd hh:mm:ss.zzz.
FileLastRead Set by File Input module to the last read time of the file. The date is in the format yyyy-mm-dd hh:mm:ss.zzz.
Filename

The Filename JobInfo is created by the File Input module. The value is set to the filename (without the path – see Filepath) of the file which is picked up by File Input module.

Also set by the Azure Storage Input, FTP and HTTP modules to the name of the file (without URL) retrieved from the server.

Filename is used by the File Output module to specify where to save the job data.

Filename is also used by the Mail Output module to set the filename of optional attachments.

Filename is also used by the PDM Output module to specify the file to be archived.

FileNameWithoutExt The FilenameWithoutExt JobInfo is created by the File Input module. The value is set to the name of the file which is picked up by File Input module, excluding the path, extension and the dot (.). If the filename picked up is called myfile.txt then FilenameWithoutExt is set to myfile.
Also set by the Azure Storage Input, FTP and HTTP modules according to the same rules.
FilePath The FilePath JobInfo is created by the File Input module. The value is set to the path (excluding filename) where the file is picked up by the File Input module.
Also set by the Exchange, FTP and Mail Input modules. Here it is the URL of the file without filename.
FileRelativePath The relative path to the root of the file is created by the File Input module.
FileRootPath The path to the root of the file without filename is created by the File Input module.
FileSize

The FileSize JobInfo is created by the File Input module. The value is set to the size of the file which is picked up by the File Input module.

If using the JobInfo Scanner feature, the FileSize JobInfo is not set as the actual data processed may be in one or more files. Instead, use the JobSize JobInfo which is set to the size (in bytes) of the job actually being processed

Set by the Exchange, FTP, HTTP and Mail Input modules to the size of the file retrieved from the server. Also set by the Azure Storage Input module.

FileSizeCompressed Contains the file size of the compressed archive file. Created by the Compression module if decompress is enabled.
FirstPageInJob The value will be set to 1 (boolean) when the Form module processes the first page in forms running in page to job mode. Otherwise, it is set to 0 (zero).
FirstPageInSpoolJob The value will be set to 1 (boolean) when the Form module processes the first page in a spool job.
FJobDate The FJobDate JobInfo is always available. It contains the date on which the job was created. The time is in the format yyyy_MM_dd. The corresponding time is in the JobInfo JobTime. A more user-friendly version of this JobInfo is JobDate.
FJobTime The FJobTime JobInfo is always available. It contains the time at which the job was created. The time is in the format hh_mm_ss_zzz. The corresponding date is in the JobInfo FJobDate. A more user-friendly version of this JobInfo is JobTime.
FormName FormName is used by EMF2RAW and Printer Output module to set a paper format supported by the printer driver.
Formtype Set Formtype to define a custom queue name in Lasernet Client for paused, scheduled or failed jobs. Name of queue will figure as a child node to the module for where the job is being saved. If Formtype is not defined, for a job, an empty name is listed in Lasernet Client as the queue name.
FQDN Created by Meta Input. Fully qualified domain name for the user running Lasernet Meta.
FullFilename The FullFilename JobInfo is created by the File Input module and Azure Storage Input module. The value is set to the full filename – including path, filename and extension (see Filepath and Filename) of the file which is picked up by the File Input module.
GrabWidth The GrabWidth JobInfo is set by the Form Engine. The value is set to the maximum width of the grab being handled by the recognized form.
InputBody Set by the Exchange and Mail Input modules to the body of the mail, if any, of an incoming email.
HTTPStatusCode The HTTP status code received by the HTTP modifier or output module.
HTTPStatusText The HTTP status text received by the HTTP modifier or output module.

HTTPHeaderFieldName

HTTPHeaderFieldValue

A pair of JobInfo lists that contain the names and values of the HTTP headers received by the HTTP modifier or output module.

Each header’s name is an item in HTTPHeaderFieldName. That header’s value is the corresponding item in HTTPHeaderFieldValue. For example, if HTTPHeaderFieldName[5] = Content-Length, the value of the Content-Length header (in this example, 28) is in HTTPHeaderFieldValue[5].

Each header is also stored in a dedicated JobInfo (see HTTPHeader* below).

HTTPHeader*

Each response header received by the HTTP modifier or output module is stored in a dedicated JobInfo named HTTPHeader<header name>.

For example, if the value of the Content-Length response header is 28, Lasernet Core creates a HTTPHeaderContent-Length JobInfo and gives it the value 28.

InputBodyHTML The HTML contents of the mail body, if any, of an incoming email.
InputDefaultSource Set by the Print Input module to the value of the selected default source for the incoming document. If available, the value is presented as a number.
InputDuplexMode Set by the Print Input module to the value of the selected duplex mode for the incoming document. Known values are Simplex, Horizontal and Vertical.
InputFilename Set by the Exchange, Mail Input and Outlook Mail input modules to the filename of the attachment.
InputFromEmail Set by the Exchange and Mail Input modules to the email address of the sender.
InputFromName Set by the Exchange and Mail Input modules to the display name of the sender.

InputHeaderFieldName

InputHeaderFieldValue

A pair of JobInfo lists that contain the names and values of the custom (X- or x- prefixed) mail headers received by the Mail Input module and Outlook Mail input module. Each header’s name is an item in InputHeaderFieldName. That header’s value is the corresponding item in InputHeaderFieldValue. For example, if InputHeaderFieldName[5] = X-Priority, the value of the X-Priority mail header (in this example, 3) is in InputHeaderFieldValue[5].
InputHeaders Set by the Exchange module and contains transport-specific message envelope information if available.
InputLongFilename

Set by the Mail Input module to the long filename of the attachment.

Also set by the FTP and HTTP Input modules to the full name of the file – URL + filename.

InputMessageID Set by the Exchange and Mail Input modules to an unique identifier for the incoming email
InputMimeType Set by the Exchange and Mail Input modules to the MIME type of the attachment.
InputOrientation Set by the Printer Input module as the Paper orientation for the incoming print document as created by the Lasernet Core EMF driver.
InputPaperHeight Set by the Printer Input module as the length of the paper for the incoming print document in tenths of a millimetre as created by the Lasernet Core EMF driver. Margin size is not included.
InputPaperSize Set by the Printer Input module as the paper size for the incoming print document as created by the Lasernet Core EMF driver. Paper size is represented as a unique number (like A4 = 9)
InputPaperWidth Set by the Printer Input module as the width of the paper for the incoming print document in tenths of a millimetre as created by the Lasernet Core EMF driver. Margin size is not included.
InputPort

The InputPort JobInfo contains the full path to the module in which the job was originally created. That is usually the name of the Input module.

The Form Engine uses the InputPort JobInfo in Page To Job mode. It is used for grouping the pages from a Job into the right queues. In theory you could manipulate the InputPort JobInfo to force pages into the same or different queues.

InputPrintQuality Set by the Printer Input module as the print quality for the incoming print document as created by the Lasernet Core EMF driver. Value always contains a number set to 1.
InputScale Set by the Printer Input module as the print quality for the incoming print document as created by the Lasernet Core EMF driver. Value always contains a number set to 100
InputSubject Set by the Exchange and Mail Input modules to the subject of the mail.
InTempFilename Created by the Process Modifier. Contains the name of the temporary file (if any) created with data from the external application.
JobDate

The JobDate JobInfo is always available. It contains the date on which the job was created. The date is in the format yyyy-MM-dd. The corresponding time is in the JobInfo JobTime.

A more filename friendly version of this JobInfo is FJobDate.

JobID The JobID JobInfo contains a fully unique ID for the job. The format of the JobID may change between Lasernet Core versions, so do not rely on it.
JobSize The JobSize JobInfo is always available. It contains the size of the primary JobData (in bytes). Usually stored in the JobData JobInfo.
JobTime

The JobTime JobInfo is always available. It contains the time at which the job was created. The time is in the format hh:mm:ss.zzz. The corresponding date is in the JobDate JobInfo.

A filename friendly version of this JobInfo is FJobTime.

LastPageInJob The value will be set to 1 (boolean) when the Form module processes the last page in forms running in page to job mode. Otherwise, it is set to 0 (zero).
LastPageInSpoolJob Contains a Boolean that is set to true (1) by the Form module when last page in spool job is being processed. Otherwise, it is set to 0 (zero).
LocalHost The LocalHost JobInfo is a JobInfo created by system, that are available everywhere. It is automatically set to the name of the current computer.
MachineName

Created by Meta Input and Printer Input. The name of the machine on which the job was printed from. Example of machine name formats:

Lasernet (Meta Input) or \\Lasernet (Printer Input).

MailAttachment

The Exchange, Outlook Mail and Mail Output modules use the MailAttachment JobInfo array to add attachments to the email being sent. One attachment is added for each entry in this array. The following JobInfos are used together with this JobInfo:

  • MailAttachmentFilename

  • MailAttachmentMimeEncoding

  • MailAttachmentMimeType

MailAttachmentFilename

The Exchange, Outlook Mail and Mail Output modules use the MailAttachmentFilename JobInfo array to name the attachments added to the email being sent. The following JobInfos are used together with this JobInfo:

MailAttachment
MailAttachmentMimeEncoding,
MailAttachmentMimeType.

MailAttachmentMimeEncoding

The Exchange, Outlook Mail and Mail Output modules use the MailAttachmentMimeEncoding JobInfo array to set the mime encoding of the attachments added to the email being sent. If this JobInfo does not contain a corresponding entry for a MailAttachment entry, a default of base64 is used. The following JobInfos are used together with this JobInfo:

  • MailAttachment

  • MailAttachmentFilename

  • MailAttachmentMimeType

MailAttachmentMimeType

The Outlook Mail and Mail Output modules use the MailAttachmentMimeType JobInfo array to set the mime type of the attachments added to the email being sent. If this JobInfo does not contain a corresponding entry for a MailAttachment entry, a default of text/plain is used. The following JobInfos are used together with this JobInfo:

  • MailAttachmentFile

  • MailAttachmentFilename

  • MailAttachmentMimeEncoding.

MailBCC

The Exchange, Outlook Mail and Mail Output modules use the MailBCC JobInfo to set the bcc mail recipient. This is typically the actual email address in the standard internet format: name@domain.com.

Comma and semicolon are valid as separator characters if MailBCC contains multiple addresses.

MailBCCName The Exchange, Outlook Mail and Mail Output modules use the MailBCCName JobInfo to set the Display Name of the bcc mail recipient.
MailBody The Exchange, Outlook Mail and Mail Output modules use the MailBody JobInfo to set the actual contents of the mail. Please note that if you want to send html-email you should use MailBodyHTML instead.
MailBodyHTML The Exchange, Outlook Mail and Mail Output modules use the MailBodyHTML JobInfo to set the actual contents of the mail when sending HTML-email. A standard text email should use the MailBody JobInfo instead.
MailBodyMimeType Discontinued.
MailCC

The Exchange, Outlook Mail and Mail Output Modules use the MailCC JobInfo to set the cc mail recipient. This is typically the actual email address in the standard internet format: name@domain.com.

Comma and semicolon are valid as separator characters if MailCC contains multiple addresses.

MailCCName The Exchange, Outlook Mail and Mail Output modules use the MailCCName JobInfo to set the Display Name of the cc mail recipient e.g., John Doe.
MailDraft

Use the MailDraft JobInfo as a Boolean to overwrite the setting "Create draft without sending it" in the Outlook Mail Output module.

  • 0 = Do not create a draft before sending email

  • 1 = Create a draft before sending email

MailFolder The Mail Input and Outlook Mail modules use the MailFolder JobInfo.
MailFrom The Exchange, Outlook Mail and Mail Output modules use the MailFrom JobInfo to set the address of the mail sender. This is typically the actual email address in the standard internet format: name@domain.com.
MailFromName The Exchange, Outlook Mail and Mail Output modules use the MailFromName JobInfo to set the Display Name of the sender
MailJobData

The Exchange, Outlook Mail and Mail Output modules use the MailJobData as a Boolean to overwrite the setting “Do not insert job data in an attachment” which is available as a setting in the module.

  • 0 = Do not insert job data in an attachment

  • 1 = Insert job data in attachment

MailImportance

The Outlook Mail module uses this JobInfo.

  • 0 = Low

  • 1 = Normal

  • 2 = High

MailMessageID A unique identifier created after a successful delivery to the SMTP server via the Exchange, Outlook Mail and Mail Output modules. If a connection cannot be established the JobInfo will not be created.
MailReplyTo Responses to messages you send with an alternative MailReplyTo address, via the Exchange, Outlook Mail and Mail Output modules, are delivered to that address. Your MailTo address will still appears in the From field.
MailRequestDeliveryReceipt

The Outlook Mail module uses this JobInfo. At runtime, it will overrule the request delivery receipt selection in the module settings.

When set to true, a receipt is returned upon successful delivery to the recipient’s mailbox.

  • 0 = Do not send back

  • 1 = Send back

MailRequestReadReceipt

The Outlook Mail module uses this JobInfo. At runtime, it will overrule the request delivery receipt selection in the module settings.

When set to true, the receiver of the mail is asked to send back a receipt upon receiving the mail.

  • 0 = Do not send back

  • 1 = Send back

MailSubject The Exchange, Outlook Mail and Mail Output modules use the MailSubject JobInfo to set the subject of the mail.
MailTo

The Exchange, Outlook Mail and Mail Output modules use the MailTo JobInfo to set the mail recipient. This is typically the actual email address in the standard internet format: name@domain.com.

Comma and semicolon are valid as separator characters if MailTo contains multiple addresses.

MailToName The Exchange, Outlook Mail and Mail Output modules use the MailToName JobInfo to set the Display Name of the mail recipient e.g., John Doe.
MatchedMask The MatchedMask JobInfo is created by the File, FTP and HTTP Input modules. The value is set to the mask used when a file is picked up by the module e.g., ‘*.txt’.
MD5FileName Used to override the default name of the pre-uploaded checksum file. The ".md5" file extension indicates a checksum file containing 128-bit MD5 hashes in md5sum format.
MetaQueue Created by Meta Input. The name of the meta queue from which the document is sent in Lasernet Meta.
MimeEncoding MimeEncoding is used by the Mail Output modules to set the MimeEncoding of an optional attachment.
MimeType The Mail Output module uses the MimeType JobInfo to set the mime type of an optional attachment.
ModifierErrorMessage Please see ModifierFailed.
ModifierFailed

An error can be tracked as a failed modifier and will set the JobInfo ModifierFailed to 1 (true).

The JobInfo ModifierErrorMessage is set to the (internal) error message that caused the failure.

For a list of modifiers, it is possible to add a criterion that will only run them if ModifierFailed is not 1 (true).

MSMQLabel Label of the MSMQ message.
NB: Cannot be longer than 250 characters.
NotifyName Created by the Printer Input module. Contains the name of the user that should be notified about print progress.
NumberOfPages The NumberOfPages JobInfo is set in the Form Engine when the analysis has finished fitting the text to the page(s). It is set to the number of pages that the analysis has created.
NumInputPages Total number of physical pages in the EMF spool job as received by the Lasernet Core EMF driver on the Printer Input module.
OCRAutoCapture If OCRAutoCapture is equal 1 (true) the AutoCapture process was running in the OCR Engine and has created a temporary OCR Form. To differ from OCRMatch it will be true in both standard and AutoCapture OCR Forms.
OCRMatch If OCRMatch is equal to 0 (false) the job is not recognized by an OCR Form in the OCR Engine.
OCRValidated If OCRValidated is equal to 0 (false) the job is not validated successfully after being processed by the OCR Engine.
OffsetX The OffsetX JobInfo is set by the Printer Input module. It contains the offset of the EMF print from the side of the page.
OffsetY The OffsetY JobInfo is set by the Printer Input module. It contains the offset of the EMF print from the top of the page.
Orientation Manage the orientation of the paper in EMF2RAW and Printer Output modules. Valid values are Portrait or Landscape.
OneDriveSharePublicly Set the OneDriveSharePublicly JobInfo as a Boolean value to overwrite the setting for Share publicly property.
OneDriveURL URL to publicly shared file, returned after upload. The JobInfo is only set when sharing publicly is enabled in the GUI.
OneDriveURLExpiration This OneDriveURLExpiration JobInfo overwrites the offset of the Shared Link Expiration defined in the OneDrive module. An expiration time for a shared document must be defined in the format yyyy-MM-ddTHH:mm:ssZ.
Orientation

Manage the orientation of the paper. Example of values are Portrait or Landscape.

Supported by EMF2RAW, Printer Output and Printer Service modules.

OriginatingModule The OriginatingModule JobInfo contains the full path to the module in which the job was originally created. This is usually the name of the Input modules.
OutTempFilename Created by the Process Modifier. Contains the name of the temporary file (if any) created with data from the external application.
PageSeparators The PageSeparators JobInfo is created by the File Input module. It matches the value of the page separators entered in the setup when using the JobInfo Scanner feature.
PageWidth The PageWidth JobInfo is set by the Form Engine. The value is set to the maximum width of the page currently being processed.
PagesInSpoolJob Number of input pages in the spool job as detected by the Form module when running in Text input mode.
PagesCombined The PagesCombined JobInfo is set by the Form Engine. The value is set to the number of pages in the whole job being handled by the form. This is usually only relevant in connection with Page to Job forms.
PaperHeight

PaperHeight defines the height of the paper form.

Supported by EMF2RAW, Printer Output and Printer Service modules.

PaperSource

PaperSource selects the Paper Source in the printer. Example of values are: Auto, Tray 1, Tray 2, Upper Tray, Lower Tray.

Supported by EMF2RAW, Printer Output and Printer Service modules.

PaperWidth

PaperWidth defines the width of the paper form.

Supported by EMF2RAW, Printer Output and Printer Service modules.

PDMATT Specifies only metadata is being sent. Possible values are “Yes” and “No”.
PDFDecrypted Result of decryption check in the PDF Security Module. 1 if successfully decrypted, o (zero) if unsuccessfully decrypted.
PDFEmbedAdditionalMetadataElement Used by the PDF module and allows you to embed any number of additional XML metadata elements in the PDF by creating an array. Each entry must be valid XML.
PDFEmbedDescription Used by the PDF module. This JobInfo contains a description of the embedded file. The field is optional.
PDFEmbedData Used by the PDF module. This JobInfo must contain the (binary) content of the file to embed into the PDF.
PDFEmbedFilename Used by the PDF module. Defines the name of the embedded file inside the PDF.
PDFEmbedPDFAExtensionSchema Used by the PDF module for PDF/A Extension Schemas. Any number of schemas can be embedded by creating an array. Each entry must be valid XML.
PDFEmbedRelationship

Used by the PDF module. This field must be set to either Source, Data, Alternative or Supplement:
The standard describes which value to use, depending on the embedded files relation to the PDF:

Source
shall be used if this file specification is the original source material for the associated content.

Data
shall be used if this file specification represents information used to derive a visual presentation – such as for a table or a graph.

Alternative
shall be used if this file specification is an alternative representation of content, for example audio.

Supplement
shall be used if this file specification is a supplemental representation of the original source or data that may be more easily consumable (e.g., A MathML version of an equation).

If no PDFEmbedRelationship is defined, or it is set to an invalid value, this will default to Supplement.

PDFEmbedSubType Used by the PDF module. This JobInfo must contain the MIME type of the embedded file. If not specified it will default to application/octet-stream.
PDFOwnerPassword Used by the PDF Security module to set the owner password for an encrypted PDF file. The value will overwrite the defined owner password in the PDF Security module at runtime.
PDFSignatureValid Result of validation in the PDF Security Module. 1 if valid, 0 (zero) if not valid.
PDFSigned Result of signing check in the PDF Security Module. 1 if signed, 0 (zero) if not signed.
Reserved
PDFUaStructureTree JSON that describes the structure tree for PDF/UA documents.
PDFUserPassword Used by the PDF Security module to set the user password for an encrypted PDF file. Value will overwrite the defined user password in the PDF Security module at runtime.
PDMCUK Unique customer identification.
PDMDFMT Datetime format.
PDMDKEY1-15 Up to 15 datetime keys can be specified. The format is defined in the module.
PDMDOC Name of the document definition.
PDMLINE

JobInfos starting with PDMLINE are read as extended keys. Extended keys are setup in the archive and the data type must be used accordingly.

An example of an extended key:

PDMLINEaccountnumber=12345

PDMNKEY1-15 Up to 15 numeric keys can be specified. The format is defined in the module.
PDMSKEY1-25 Up to 25 string keys can be specified.
PDMUPD Specifies if an existing document should be updated. Possible values are “Yes” and “No”.
PreviewExtension

Created by Meta Input in Autofill mode or added by clicking “Add Copy JobInfo” button when adding a new JobInfo in Lasernet Developer (see also PreviewJobData).

PreviewExtension contains the filename extension to be used for the preview module. When a destination is set to preview, Lasernet Core tries to route the job back to the client for preview. The PreviewExtension then tells the client how to do the preview. If no PreviewExtension has been set, the default value is .pdf.

PreviewJobData Created by Meta Input in Autofill mode or added by clicking “Add Copy JobInfo” button when adding a new JobInfo in Lasernet Developer. PreviewJobData contains a copy of document data when created.
PreviewMode

Set to “1” by the Web Server module if the preview parameter is requested in the URL.

http://+:8080/webinputport/WebServer/?preview

PreviousJob The PreviousJob JobInfo is set each time a job is cloned. It is primarily used by the Lasernet Monitor to figure out the sequence of jobs.
PrimaryJobData

PrimaryJobData constantly keeps the name of the JobInfo that contains the primary job data. Usually that is the JobData JobInfo. By changing the value of PrimaryJobData you change the JobInfo that Lasernet Core typically uses when it handles data.

This can be done instead of copying the contents of JobData to another JobInfo. Changing PrimaryJobData is more efficient.

PrintAttachment The PrintAttachment JobInfo array is used by the Printer Output and Printer Service modules. It may contain a list of documents in binary representation for printing externally. It is used together with PrintAttachmentFilename and PrintAttachmentMimeType JobInfos.
PrintAttachmentCopies PrintAttachmentCopies setting is used by Printer Output and Printer Service modules and can be set to control the number of printed copies for attached documents in the format PDF and DOCX.
PrintAttachmentDocName PrintAttachmentDocName is used by the Printer Output and Printer Service modules to acompany PrintAttachmentFilename and PrintAttachmentMimeType to give the print attachment a custom name in the Windows Spooler System.
PrintDocName PrintDocName is used by the Printer Output and Printer Service modules to accompany PrintFilename and PrintMimeType to give the print job a custom name in the Windows Spooler System.
PrinterDriver The PrinterDriver JobInfo is a configuration specific JobInfo often used by the EMF2RAW and Printer Output modules, if the JobInfo substitution string #PrinterDriver# is defined as the Printer Name parameter.
PrinterFailureMessage PrinterFailureMessage contains the error message, if printing fails due to a Printer Failure Profile, attached to a Printer Output module.
PrinterName The PrinterName JobInfo is a configuration specific JobInfo, often defined in modules, if the JobInfo substitution string #PrinterName# is used as the name of the destination to the Printer Output module.

PrinterServiceAzureStorageAccountName

PrinterServiceAzureStorageContainerName

PrinterServiceAzureStorageSASToken

The Printer Service module can be configured to read connection settings (for the Shared Access Signature (SAS) authentication option for Azure Storage) from JobInfos. This is an alternative to specifying the connection settings directly on the Shared Access Signature Token (SAS) tab of the Add Print Server window (in the Lasernet Config web app).

If Overridable is selected on the Shared Access Signature Token (SAS) tab of the Add Print Server window (in the Lasernet Config web app), and any of the following three JobInfos exist, the value of the JobInfos that are present will override the corresponding print server settings’ values in the Lasernet Config web app:

  • PrinterServiceAzureStorageAccountName: The name of the storage account that the Printer Service needs to access. This JobInfo overrides the print server’s Storage account setting.

  • PrinterServiceAzureStorageContainerName: The name of the container that the Printer Service needs to access. This JobInfo overrides the print server’s Container name setting.

  • PrinterServiceAzureStorageSASToken: The storage account SAS token. This JobInfo overrides the print server’s SAS Token setting.

PrintFilename

Used by the Printer Output and Printer Service modules to extract and print jobs stored in a LnJob container. LnJob files are located in the runtime folder, as paused, scheduled or failed jobs. LnEMF and PDF documents are supported.

The PrintFilename must be defined with the extension of the job stored in the LnJob container, like test.lnemf or test.pdf, to ensure that the document is printed in the expected format by the Printer Output module.

This JobInfo is used combined with the PrintMimeType JobInfo.

PrintMimeType

The PrintMimeType JobInfo is used by the Printer Output and Printer Service modules. It contains the mime type of the file to be printed. Only used to accompany PrintFilename.

The MIME types application/Lasernet and application/pdf are supported.

PrintMode Set to “1” by the Web Server module if a print is requested.
PrintProcessor Set by the Printer Input module. Contains the name of the print processor that handled the job.
PrintToUNC Used by Printer Output module to direct jobs to a printer using a UNC path instead of a predetermined printer in Windows. By setting this JobInfo to \\Server\PrinterShare the Printer Output module will send the job to that share using the driver chosen in the setup.
Priority Set by the Printer Input module. It contains the priority of the print job.
ProcessTime Created by the Process Modifier. Contains the approximate number of seconds that the external application runs for. Since most applications only run for a short time this JobInfo is usually set to 0 (zero).
PublicID The PublicID JobInfo is another unique ID for a Job. The PublicID is different from the JobID in that it follows all clones of the job, whereas JobID is unique for each clone. The PublicID is usually assigned in an input module.
RecognizedForm The RecognizedForm JobInfo is created by the Form, Overlay and XML Transformer modules. The value is set to the name of the form that is recognized.
RecognizedSubJob The RecognizedSubjob JobInfo is set by the Form Engine. The value is set to the number of the current input page within the entire job.
RecordCount The RecordCount JobInfo is set by the Database Command when it returns records from a database. It is set to the number of records actually returned from the database. If it is 0 (zero) no records have been returned.

RequestHeaderNames

RequestHeaderValues

A pair of JobInfo lists that contain the names and values of the HTTP headers in a request received by the Web Server input module.

Each header’s name is an item in RequestHeaderNames. That header’s value is the corresponding item in RequestHeaderValues. For example, if the received HTTP request has a header Content-Length: 11, then RequestHeaderNames[0] = Content-Length and RequestHeaderValues[0] = 11. Other headers received in the request are added as discrete items in the RequestHeaderNames and RequestHeaderValues JobInfo lists.

Restarted The Restarted JobInfo is set when a failed job is restarted.
Scale Scale is used by EMF2RAW and Printer Output modules. Specifies the factor by which the printed output is to be scaled. The apparent page size is scaled from the physical page size by a factor of Scale /100.
ScaleMode

Specifies the factor by which the printed output is to be scaled, for PDF documents stored in the JobInfo PrintAttachment.

Legal values are:

  • Fit (Shrinks the size to fit the printer margins)

  • ActualSize (Default)

  • CustomScale (Set value for CustomScale (example: 90) as a procentage of the physical page.

Modules: EMF2RAW, Printer Output, Printer Service

SchedulerQueue The SchedulerQueue JobInfo is set by the scheduler on an engine or output module. It contains the name of the queue in which the job is placed. It is also set by the Scheduler Input module.
SFVFileName Used to override the default name of the pre-uploaded checksum file. The ".sfv" file extension indicates a checksum file containing 32-bit CRC32 checksums in simple file verification format.
Sheet Set by the Form Engine and Editor to the name of the sheet currently being processed (same as JobInfo for SheetName).
SheetName Set by the Form Engine and Editor to the name of the sheet currently being processed (same as JobInfo for Sheet).
Source The Source JobInfo is continuously updated with the names of the modules that the job has passed through.
StdOut Created by the Process Modifier. Contains the data output to stdout from the external application.
TimeOut The TimeOut JobInfo is created by the File Input module. The value is set to the time out value entered in the setup when using the JobInfo Scanner feature.
TransparentText If your overlay does not have a white background this jobinfo must be set to make the background of the text box transparent. Valid values are: '1' and 'yes'. Only applies to the overlay engine.
UserDomainName Create by Meta Input. Domain name for the user running Lasernet Meta.
UserName Created by Meta Input and Printer Input modules. Contains the name of the sender in Lasernet Meta or the user who printed the job to a Lasernet Input Printer.
WebServiceCustomBody

Set custom body section in XML format if simple parameters in the SOAP body are not enough for the web service call.

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<test xmlns="http://www.webservicex.net/">
<header>Header Section</header>
</test>
</soap:Header>
<soap:Body>

→ Value of WebServiceCustomBody is inserted here ←

<GetGeoIP xmlns="http://www.webservicex.net/">
<IPAddress />
<GetGeoIP />
</GetGeoIP>
</soap:Body>
</soap:Envelope>

WebServiceCustomHeader

Set custom header section in XML format if simple parameters in the SOAP header are not enough for the web service call.

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>

→ Value of WebServiceCustomHeader is inserted here ←

<test xmlns="http://www.webservicex.net/">
<header>Header Section</header>
</test>
</soap:Header>
<soap:Body>
<GetGeoIP xmlns="http://www.webservicex.net/">
<IPAddress />
<GetGeoIP />
</GetGeoIP>
</soap:Body>
</soap:Envelope>

WebServiceDetail SOAP Fault detail. The detail element is intended for carrying application specific error information related to the Body element. The absence of the detail element in the Fault element indicates that the fault is not related to the processing of the Body element.
WebServiceFaultCode SOAP Fault code. The fault code element is intended for use by software to provide an algorithmic mechanism for identifying the fault.
WebServiceFaultString SOAP Fault string. The fault string element is intended to provide a human readable explanation of the fault and is not intended for algorithmic processing.
WebServiceResult Default result JobInfo when used as modifier
WebserviceMethod Name of Web Service method that corresponds to the HTTP request.
WinJobId The WinJobId JobInfo is created by Printer Input module. The value is the job number assigned to the print job by the Windows Spooler.
WinPrinterName The WinPrinterName JobInfo is created by the Printer Input module. The value is the name of the printer that was used by the input module.
WinPrintNotifyName

Specifies the notification contact of the print job. Windows does not allow the notify name to be set across network printers.

Supported by Printer Output and Printer Service modules.

WinPrintUserName

Specifies the user name of the print job as shown in the job list for a local printer. This can be set to just about anything. Windows does not allow the user name to be set across network printers.

Supported by Printer Output and Printer Service modules.

XMLValidationError When running XML validation against a schema file, the XML Validation module will set this JobInfo to ‘1’ if a validation has not been completed successfully.
XMLValidationErrorMessage Description of the error that occurred in the XML Validation module when running XML validation against a schema file.

Was this page helpful? Let us know at knowledgebase.feedback@lasernetgroup.com