Difference between revisions of "GenerateDocument"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
Line 18: | Line 18: | ||
:;objectID:The identifier of the related object | :;objectID:The identifier of the related object | ||
:;recordID:The identifier of the related record | :;recordID:The identifier of the related record | ||
:;printTemplateID:The name of the [[Document | :;printTemplateID:The name of the [[Document Template]] | ||
:;format:You can specify <tt>CONSTANTS.DOCUMENT.HTML</tt> or <tt>CONSTANTS.DOCUMENT.PDF</tt> | :;format:You can specify <tt>CONSTANTS.DOCUMENT.HTML</tt> or <tt>CONSTANTS.DOCUMENT.PDF</tt> | ||
Revision as of 23:20, 12 November 2013
- 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
- <syntaxhighlight lang="java" enclose="div">
Result result; result = Functions.generateDocument(String objectID, String recordID,
String printTemplateID, String format);
</syntaxhighlight>
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
- 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, 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.
} </syntaxhighlight>