Generate

Overview

The Generate operation is used to request document processing based on transaction data included in the request. This operation is an asynchronous call back that takes transaction data, a Content URI (for callback servicing), and an account ID (AccountID) for the calling application and returns status information. This is typically followed by a call to the GetRequestResult operation to return the generated package documents as requested by the calling application in the Generate request.

The operation is used to request processing of a specified package, including options for 1) generating a text watermark, 2) generating multiple output formats for each document, 3) generating documents as a merged output file or individual files, and 4) assigning a specific barcode format.


Operation	Generate
Style	document
Operation Type	Request-response. The endpoint receives a message, and sends a correlated message.
SOAP Action	http://www.wolterskluwerfs.com/2012/12/DocGenServices/IDocumentService/Generate
Input	Generate_InputMessage (soap:body, use = literal) parameterstype GenerateRequest
Output	Generate_OutputMessage (soap:body, use = literal) parameters type GenerateResponse

Request Message

The operation input is GenerateRequest. The request (request) requires a GenerateRequest object containing transaction data defining the requested document as a parameter on the input message.


Parameter	Type	Constraints	Description
request	GenerateRequest	Required	The input message for the Generate operation used to request processing of a specified package.

Response Element

The operation output is GenerateResponse. The response returns a GenerateResponse object containing status information for the request.


Element	Name	Description
GenerateResponse	GenerateResult	The output message for the Generate operation used to return the details of the request.

Request and Response Samples

For sample code, see: Generate.