Input Arguments

Function / Meaning

Catalog

Used when printing a catalog from the sidebar or the selected objects in an opened catalog (it is the catalog).

In

Please see the common parameters/arguments.

Locale

An optional parameter which specifies the language in which the report will be generated (a string containing the language /e.g. 'en', 'de', 'it'/) and optionally also the country /e.g. 'US', 'DE'.../ separated by an underscore). By default, it is the current language.

Objects

When printing selected objects in an open catalog, it is a list of these objects. When printing from an open editor, it is the edited object. When printing from the sidebar, the parmeter is should be null.

OutputStream

An instance of OutputStream. When printing to PDF on the web server, the parameter is mandatory and it has to be the response output stream (you create it using the workflow activity CreateOutputStream).

When printing to PDF on the Rich Client, the parameter is optional but it could be a FileOutputStream or any other OutputStream.

RelationDescriptor

When printing objects in a reference catalog, it is the descriptor for the relation shown in the reference catalog.

ReportTemplate

Report Template which defines many prioperties such as the document size, font, margins, header & footer, table properties or view properties.

Title Page

The value of this optional parameter is a piece of HTML. If specified, the PDF document will start with a 'Title page' whose content will be created from this HTML. You can construct the HTML in a script or use a value of a rich text field.

View

When printing from an open editor, it is the view used for that editor.

Output Arguments

Function / Meaning

Out

Please see the common parameters/arguments.