Ungrouped 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
AtJobEnd	Triggers a specific Event at the end of a job. Typically used to produce a closing page showing the number of invoices printed so far, or the total sum of all invoices.
CallProc	Invokes a Process in the Message from which it is called.
CancelJob	Cancels the current job. The cancellation is executed after pre-processing, i.e. all Events are pre-processed before the job is interrupted.
Clear	Clears the specified variables.
ClearVars	Clears all variables in a job.
CreateGlobalSerNo	Creates a serial number key in the repository.
CurrJobOwner	Returns the current job owner.
DumpVariables	Writes all variables that have values to a file.
EndDocument	Forces a Document Begin at the end of the Process from which the script function is called.
EndMessage	Used in a Retrieved script to set Event Order Last for the Event.
Execute	Executes an external program, script, bat file or process.
Exist	Checks if a directory or file exists.
FlushOutput	Used during the processing of a job. Sends portions of a large output job to the printer, even though processing of the job has not yet been completed.
ForcePoll	Signals an input connector to poll data.
GetConnectorValue	Returns the value of a named field from a connector.
GetCurrModuleinfo	Returns the current Event or Process status, depending on where the script is executed.
GetGlobalSerNo	Calculates the next counter value in a number sequence according to a specified key stored in the repository.
GetGlobalSerNoRange	Reserves a specified range of counter values and calculates the next counter value in the number sequence according to a specified key stored in the repository.
GetHTTPHeaderValue	Returns the value of a named field in the HTTP header of a job created by a request on an HTTP input connector.
GetMetaDataMessage	Returns the current value of a metadata.
GetMetaDataMessageFrom	Retrieves a metadata value from a paused Message in the Message storage and assigns it to a variable.
GetSerNo	Calculates the next counter value in a number sequence according to a specified key stored in a file.
GetTextFormattingInfo	Enables splitting of LXF text into separate areas, for example to create multi-column output.
GetXoffs	Returns the current X offset value in millimeters.
GetYoffs	Returns the current Y offset value in millimeters.
InConnectorName	Returns the name of the current input connector.
IncProcStatCounter	Increases the value of the argument with 1.
NewJob	Replaces the JobBegin and JobEnd functions, and is used to split large input jobs into smaller jobs.
NoFormFeed	Suppresses the form feed sequence output at end of page.
NumberOfEvents	Counts the number of Events in a job.
NumberOfEventsEx	Returns the number of the specified Event.
OutputString	Outputs a line of text directly to the output buffer of a StreamOUT or XMLOUT Process.
PreProc	Determines whether or not StreamServer is running in pre-process phase.
RGBcolor	Specifies an RGB color. For example, the color of a font or an area.
StartTimer	Starts a timer in the StreamServer to measure processing time. See also StopTimer.
StopTimer	Stops a timer in the StreamServer, and if required displays the elapsed time in the log and/or writes it to a file. See also StartTimer.
SetCopies	Sets the number of copies of the current Process.
SetDestPath	Sets a destination path, and optionally, a destination file.
SetFontProperties	Specifies a font. For example, when using a variable alias for font formatting, you use this scripting function to assign a font to the font variable.
SetJobDescr	Sets the description of the current job. The job description is used in the log and as the title of spooled job (Windows/NetWare).
SetJobOwner	Sets the owner of the print job created by the Spool output connector.
SetLanguage	Sets the language to be used for the current job. This setting is used with the StreamServe Language Set (*.sls) file.
SetSerNo	Sets the value of a serial number in a number sequence.
Skip	Skips the current operation, i.e. the operation to which the script is associated. It can also be used to skip Events, Processes, blocks and fields.
Sleep	Suspends the script execution for the specified amount of time.
Sort	Used in a Before Process script to assign one or more sort keys to a Message. StreamServe sorts the Messages in the job according to the specified sort keys.
Terminate	Makes the StreamServer shutdown gracefully when all jobs being processed have been completed, including the one that called the Terminate function.