› Batch & Output Management Scripting Language Developer's Guide › Batch & Output Management scripting language › Scripting contexts › StreamingPage › Properties of the StreamingPage context

Properties of the StreamingPage context

Property Description
RequestReference*

Reference of the request from which the document originates.

CorrespondenceReference*

Reference of the correspondence from which the document originates.

CommunicationLabel*

Label of the communication from which the document originates.

SlotName*

Slot name of the document (it refers to the Slot Identifier in the Document Pack Template).

SlotTypeName*

Name of the slot type of the document.

GetOrganisationalMetadata (key) Function that produces the value of a key in the organisational metadata of the current communication. If a key is not present, an exception is thrown.
HasRecipient Flag that indicates whether the recipient information is available for the distributed communication.
PrinterName Name of the printer used to distribute the communication.
RecipientType Recipient type of the distributed communication.
GetRecipientData (key) Function that produces the value of a contact field in the recipient information of the distributed communication. Throws an exception if the contact field does not exist.
HasSender Flag that indicates whether the sender information is available for the distributed communication.
GetSenderData (key) Function that produces the value of a contact field in the sender information of the distributed communication. Throws an exception if no sender information is available, or the contact field does not exist.
GetScriptData (level, key) Retrieves a key/value pair. Throws an exception if the script tries to access an unavailable level, or if the key is not present for the level (see the table about levels and scopes later in this section).
SetScriptData (level, key, value) Function that writes a key/value pair at the specified level. Allows the streaming scripts to transfer data between the exit points. Throws an exception if the script tries to access an unavailable level, or if the key is not present for the level.
int LogicalPageNumber Contains the logical page number within the document.
IsFirstPage True if this is the first page in a document.
IsLastPage True if this is the last page in a document.
PageCount Returns the number of pages in the current document.
IsPortrait Returns the portrait mode.
IsDuplex Returns the duplex mode.
InputBin Combines GetInputBin() and SetInputBin().

*These properties are not set for cover letters added in the Bundling step.

Level Scope Availability
0 Stack Available in all exit points.
1 Envelope Available in the OnEnvelope, OnDocument, and OnPage exit points.
2 Document Available in the OnDocument and OnPage exit points.