OutputAction ReturnAction

This Output Action returns the generated document via the web services interface.

Parameters

Note

The parameter names of the Output Actions are not case-sensitive. All parameter names may contain data fields (exceptions are described in the relevant parameters).

Example: FileName = "Application_<%Citizen.Name%>.pdf"

Parameter name	Requirement	Description
`Format`	mandatory	Defines the file format of the document (.docx, .xlsx, .pptx, .pdf, .html, emf …).
`Filename`	optional	Defines the document’s file name. Example: `Contract.pdf` To generate a dynamic file name, use the following syntax: `Contract_<%employee.fullname%>.pdf`
`Mode`	optional	Defines how the generated document should be returned: `File` (default): document will be returned as file `ServiceResult.GeneratedDocs` `Text`: document will be returned as text in `ServiceResult.ResultMessage`
`SpecialFormat`	optional	Specifies a special format (dox42 Server For Documents only): For PDF files: `PDFA1b` `PDFForm`(form fields are preserved in the PDF). For HTML files: `HTMLCode`: this will cause the text of the generated document to be interpreted in HTML code. `EMFZIP`
`Sign`	optional	Value: `true` The format PDF may bear a digital signature (dox42 Server For Documents only). Certificate and corresponding password have to be defined in the web.config file.
`Condition`	optional	If value `false`, the Output Action will not be performed.
`Numberofcopies`	optional	Specifies how many copies should be generated within one file. Example: `1,2,3`