Web Search

Web Search

Scripting in StreamServe

The script editor

Checking the script syntax

Script execution

Job execution phases

Formatting phase

Retrieved scripts

StreamServe scripting language specifics

Global variables

Local variables

Field references

Array variables

Multi dimensional arrays

Example of array usage

Variables in numeric expressions

String Extraction Expression (PageIN only)

Assignment statements

Conditional statements

The if statement

The if...else statement

The switch...case statement

The while statement

The do...while statement

The for statement

Script functions

Numeric precision

Escape sequences

Built-in script functions

When to use function files

User created script functions with arguments

Using local variable names as arguments to a function

Substitution tables

Script functions reference

General functions

Array handling functions

Block handling functions

Job ID handling functions

Job resource handling functions

Job status handling functions

Log file functions

Overlay handling functions

Page handling functions

PageIN specific functions

StreamIN specific functions

Ungrouped functions

Check digit calculation functions

Collector functions

Date and time functions

Dispatcher functions

Document sorting and bundling functions

Email functions

File handling functions

Connecting to the directory server

Non-persistent connections

Persistent connections

Lotus Notes functions

Lotus Notes examples

Message traversing functions

Message traversing examples

Numeric operation functions

Position formatting functions

Preview functions

Preview examples

Project related functions

Queue and repository functions

Session handling functions

StoryTeller functions

String handling functions

Substitution table functions

Executing a substitution table function only once

Test output functions

Type and conversion functions

ODBC startup argument

Script functions in alphabetical order

AttachmentBegin

Base64DecodeString

Base64DecodeStringUsingCodepage

Base64EncodeFile

Base64EncodeString

Base64EncodeStringUsingCodepage

COMCreateObject

COMDestroyObject

ConnectorPageActual

ConvCurrMsgToUC

CreateGlobalSerNo

CurrDocProperty

CurrJobProperty

CurrReposProperty

DeclareMetadata

DeleteJobResource

DocInsertedPages

FindStringExactInArray

FirstBlockOnPage

GetAttachmentContentType

GetAttachmentCount

GetAttachmentFile

GetAttachmentOriginalFile

GetConnectorValue

GetCurrModuleinfo

GetDesignCenterVersion

GetDistributionChannelsForRole

GetDistributionChannelsForUser

GetDocActualInserts

GetDocEnvelopeCount

GetDocInsertCount

GetDocInsertEquivals

GetDocSheetCount

GetDocumentDefinitionId

GetDocumentDefinitionName

GetDynamicOverlayURI

GetGlobalSerNoRange

GetHTTPHeaderValue

GetJobIDAttribute

GetJobIDDateAttribute

GetJobIDNumAttribute

GetJobQueueItemId

GetJobResourceIndex

GetMetaDataDocument

GetMetaDataMessage

GetPhysicalPlatform

GetPPDocProperty

GetPPJobProperty

GetPPReposProperty

GetProjectRevision

GetProjectVersion

GetRequestedPreviewContentType

GetRequestedPreviewChannel

GetRequestedTestOutputChannel

GetRolesForUser

GetSegDocProperty

GetSegJobProperty

GetSegReposProperty

GetSubstColCount

GetSubstKeyCount

GetTextFormattingInfo

InConnectorName

IncProcStatCounter

IsDocDefAvailable

IsFirstDocInEnvelope

IsFirstPageInEnvelope

IsInsertingPage

IsLastDocInEnvelope

IsLastPageInEnvelope

JavaDestroyObject

JavaInvokeMethod

JavaInvokeStaticMethod

JobInsertedPages

LastBlockOnPage

LdapAddAttrBinaryValue

LdapAddAttrValue

LdapConnectPersistent

LdapConnectSSLCCA

LdapConnectSSLCCAPersistent

LdapConnectSSLPersistent

LdapGetAttrValue

LdapGetAttrValueCount

LdapGetEntryCount

LdapGetObjectByDN

LdapReleaseNewEntries

LdapReleaseResultSet

LdapReplaceAttrBinaryValue

LdapReplaceAttrValue

LdapUpdateEntry

LdapWriteAttrBinaryValue

LotusNotesAddNote

LotusNotesAttachFile

LotusNotesConnect

LotusNotesDisconnect

LotusNotesFirst

LotusNotesSetDateTime

LotusNotesSetNumber

LotusNotesSetText

MIMESetPartProperty

MsgFrameCountId

MsgFrameGetValue

MsgFrameValueExist

MsgProcGetValue

MsgProcValueExist

NumberOfEventsEx

OdbcCommitTrans

OdbcClearReorderText

OdbcRollbackTrans

OdbcSetCodepage

OdbcSetReorderText

OutputLXFJobResource

OutputLXFJobResourcePrnOffs

OverlayGetNumPages

PPBeginDocMDUpdate

PPCommitDocMDUpdate

PPRollbackDocMDUpdate

ReplaceJobIDAttribute

ReplaceJobIDDateAttribute

ReplaceJobIDNumAttribute

SaveSegMetadata

SessionGetVariable

SessionSetVariable

SetCurrMetadata

SetCurrMetadataNum

SetFontProperties

SetOutputExpireDate

SetPPMetadataNum

SetSegMetadataNum

StGetParagraphPageXMm

StGetParagraphPageXPt

StGetParagraphPageYMm

StGetParagraphPageYPt

StGetParagraphXMm

StGetParagraphXPt

StGetParagraphYMm

StGetParagraphYPt

StGetProcessingProperty

StGetPropertyMm

StGetPropertyPt

StLanguageLookup

StMsgAttachXMLFile

StMsgSaveToFile

StSetPropertyMm

StSetPropertyPt

StoreJobIDAttribute

StoreJobIDDateAttribute

StoreJobIDNumAttribute

StXPathNextPosition

StXPathPopNodeSet

StXPathPushNodeSet

StXPathSetPosition

StXPathSortNodeSet

UpdateExternalCompletionStatus

UpdateJobStatus

UpdatePPDocStatus

UpdatePPJobStatus

UpdateSegDocStatus

UpdateSegJobStatus

Utf8DecodeString

Utf8EncodeString

Lotus Notes Fetch Wizard

Generating a code block with the Lotus Notes Fetch wizard

Information required by the Lotus Notes Fetch wizard

Generating the code block

Editing a generated code block

Deleting a generated code block