GenerateDocument

Generates a document based on an HTML Document Template.

Syntax

Result result;
result = Functions.generateDocument(String object, String recordID, 
                                    String printTemplate, String format);

Parameters

object

The name or identifier of the object that contains the record of interest.

recordID

The identifier of the record to pass to the template.

printTemplate

The name or identifier of the Document Template

format

CONSTANTS.DOCUMENT.HTML -or- CONSTANTS.DOCUMENT.PDF

Return

Result object

Usage

• Find the object name in the Object Properties
• Get the template name from the Document Template
• Get the record ID from the method's incoming parameters
• Use result.getID() to retrieve the document ID
• Pass it to the Functions class getDocument() method to get a PlatformFileBean that contains the document

Example

This example calls generateDocument on a case to create an HTML document.

String printTemplate = "";     // Code this value
String recordID = "";          // Get this value from incoming parameters
  ...
Result result = Functions.generateDocument("cases", recordID, printTemplate, 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
{
    String doc_id = result.getID();
    PlatformFileBean file = Functions.getDocument(doc_id);

    // Additional business logic...
}