GenerateDocument

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 an HTML Document Template.

Syntax

Result 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 Document Template

format

You can specify CONSTANTS.DOCUMENT.HTML or CONSTANTS.DOCUMENT.PDF

Return

Result object

• Use result.getID() to retrieve the document ID
• Use [Functions classgetDocument(int) getDocument()] to get a Template:PlatformFileBean that contains the document

Example

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

String printTemplateID = "";
String leadID = "";
// Some code to populate printTemplateID.
// Some code to populate leadID.
Result result = Functions.generateDocument("LEAD", leadID, printTemplateID, CONSTANTS.DOCUMENT.HTML);
int resultCode = result.getCode();
if(resultCode < 0)
{
    String msg = "Some Message";
    Logger.info(msg + ":\n" + result.getMessage(), "Doc"); // Log details
    Functions.throwError(msg + ".");                       // Error message
}
else
{
    // Some business logic.
}