Document sorting and bundling functions

The table below contains a short description of each script function. For information about syntax, examples, etc., see the full description of each script function.

Function name	Description
ConnectorPageActual	Returns the number of logical pages sent to the output connector, including inserts but excluding skipped pages.
CurrDocProperty	Returns the specified document property for the current document.
CurrJobProperty	Returns the specified job property.
CurrMetadata	Returns the value of the specified metadata for the current document.
CurrReposProperty	Returns the specified repository property.
DeclareMetadata	Declares metadata that can be used in post-processor scripting. If the specified metadata exists in the post-processor repository, the metadata is retrieved with the documents when they are retrieved from the repository.
DocInsertedPages	Returns the number of pages inserted in the output queue within the current document.
DocPage	Returns the current page number of the current document.
DocPageActual	Returns the number of document pages sent to the output connector, including inserts but excluding skipped pages.
EnableEnvelopeCheck	Enables or disables a check for an inconsistent number of sheets when using enveloping.
GetCurrSegDoc	Returns an index that identifies the current document, in the current segment, in the set of documents sent to the output connector.
GetDocActualInserts	Returns the inserts assigned to the document.
GetDocEnvelopeCount	Returns the number of envelopes for the current document.
GetDocInsertCount	Returns the number of inserts for the current document.
GetDocInsertEquivals	Returns the insert equivalent count for the current document.
GetDocSheetCount	Returns the number of sheets within the current document.
GetEnvelNr	Returns the envelope number of the current document.
GetFirstPPDoc	Returns a counter index that identifies the first document, in a set of documents sent to the output connector in a Post-processor job.
GetFirstSegDoc	Returns the index that identifies the first document in the current segment, in the set of documents sent to the output connector.
GetMailMachine	Returns the name of the enveloping machine to which the current document was assigned.
GetNextPPDoc	Returns a counter index that identifies the next document in a set of documents in the post-processor job sent to the output connector.
GetNextSegDoc	Returns an index that identifies the next document, in the current segment, in the set of documents sent to the output connector.
GetPPDocId	Returns the document ID of a document stored in a Post-processor repository.
GetPPDocProperty	Returns the value of the specified property for the specified document.
GetPPError	Returns the last error that occurred during the Post-processor job.
GetPPJobId	Returns the job ID of a job stored in a Post-processor repository.
GetPPJobProperty	Returns the value of the specified property for the job containing the specified document.
GetPPMetadata	Returns the value of the specified metadata for the specified document.
GetPPReposProperty	Returns the value of the specified repository property storing the specified document.
GetSegDocProperty	Returns the specified document property for the specified document.
GetSegJobProperty	Returns the specified job property for the specified document.
GetSegment	Returns the current segment number. This is the same number that replaces the %{SEGMENT} variable in the output file name.
GetSegMetadata	Returns the value of the specified metadata for the document in the specified segment.
GetSegReposProperty	Returns the specified repository property for the specified document.
InsertOverlay	Adds an overlay to the current page.
InsertPage	Inserts a new page in the output stream.
IsFirstDocInEnvelope	Checks if the current document is the first document in the envelope.
IsFirstPageInEnvelope	Checks if the current page is the first page in the envelope.
IsFirstSegment	Checks if the current segment is the first segment of post-processor job.
IsInsertingPage	Checks if the current page is being inserted to the output queue.
IsLastDocInEnvelope	Checks if the current document is the last document in the envelope.
IsLastPageInEnvelope	Checks if the current page is the last page in the envelope.
IsLastSegment	Checks if the current segment is the last segment of post-processor job.
JobInsertedPages	Returns the number of pages inserted to the output queue within the current job.
NextDoc	Skips the current document and processes the next document.
NextPage	Skips the current page and processes the next page.
NextProc	Skips the rest of the current Process, and processes the next Process.
NextSegment	Skips the rest of the current segment, and processes the next segment.
PPBeginDocMDUpdate	This script function is called before a SaveCurrMetadata, SaveSegMetadata or SavePPMetadata script function. It makes StreamServer cache the metadata updated by the Save<xx>Metadata function instead of storing the metadata directly in the Document Broker repository.
PPCommitDocMDUpdate	This script function is used together with PPBeginDocMDUpdate, and is called after a SaveCurrMetadata, SaveSegMetadata or SavePPMetadata script function. It is used to store the cached metadata in the Document Broker repository.
PPDocCount	Returns the number of documents sent to the output connector.
PPRollbackDocMDUpdate	This script function is used together with PPBeginDocMDUpdate and PPCommitDocMDUpdate, and is called after a SaveCurrMetadata, SaveSegMetadata or SavePPMetadata script function. It is used to clear all metadata in the cache.
SaveCurrMetadata	Saves the metadata for the current document in the repository.
SavePPMetadata	Saves the metadata for the document specified in the doc_handle parameter returned by either the GetFirstPPDoc or GetNextPPDoc function.
SaveSegMetadata	Saves the metadata for the document specified in the doc_handle parameter returned by either the GetFirstSegDoc, GetCurrSegDoc, or GetNextSegDoc function.
SetCurrMetadata	Sets string metadata for the current document.
SetCurrMetadataNum	Sets numeric metadata for the current document.
SetSegMetadata	Sets string metadata for the document specified in the doc_handle parameter returned by either the GetFirstSegDoc, GetCurrSegDoc, or GetNextSegDoc function.
SetSegMetadataNum	Sets numeric metadata for the document specified in the doc_handle parameter returned by either the GetFirstSegDoc, GetCurrSegDoc, or GetNextSegDoc function
SortSegDoc	Sorts the documents in the current segment according to the specified sort keys.
UpdateDocStatus	Updates status of the current document in the repository.
UpdateJobStatus	Updates the status of the current post-processor job in the Post-processor repository.
UpdatePPDocStatus	Updates repository status of the document specified in the doc_handle parameter returned by either the GetFirstPPDoc or GetNextPPDoc function.
UpdatePPJobStatus	Updates status of the current post-processor job in the repository.
UpdateSegDocStatus	Updates repository status of the document specified in the doc_handle parameter returned by either the GetFirstSegDoc, GetCurrSegDoc, or GetNextSegDoc function.
UpdateSegJobStatus	Updates repository status of the post-processor job that contains the document specified in the doc_handle parameter returned by either the GetFirstSegDoc, GetCurrSegDoc, or GetNextSegDoc function.