AgileApps Support Wiki Pre Release

generateDocument

From AgileApps Support Wiki
Revision as of 20:46, 23 May 2011 by imported>Aeric
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Functions.generateDocument(String objectId, String recordId, String templateId, String format)
Generates document of templateId evaluated with params in the format.
If the format is PDF, it generates the document in PDF format, otherwise HTML format. It relates this generated document to the object of type objectId and record identifier recordId.

Generates a document based on a Print Template.

Syntax

Result result = Functions.generateDocument(String objectID, String recordID, String printTemplateID, String format)

Parameters

objectID
The identifier of the related object
recordID
The identifier of the related record
printTemplateID
The name of the print template
format
You can specify CONSTANT.DOCUMENT.FORMAT.HTML or CONSTANT.DOCUMENT.FORMAT.PDF

Return

Result object

Example
This example calls generateDocument for a lead, creating a HTML document.

<syntaxhighlight lang="java" enclose="div"> String printTemplateID = ""; String leadID = ""; // Some code to populate printTemplateID. // Some code to populate leadID. Result result = Functions.generateDocument("LEAD", leadID, printTemplateID, CONSTANT.FILE.FORMAT.HTML); int resultCode = result.getCode(); if(resultCode < 0) {

   String msg = "Some Message";
   Functions.debug(msg + ":\n" + result.getMessage());  // Log details
   Functions.throwError(msg + ".");                     // Error dialog

} else {

   // Some business logic.

} </syntaxhighlight>