Difference between revisions of "GenerateDocument"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
Line 6: | Line 6: | ||
: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 <tt>objectId</tt> and record identifier <tt>recordId</tt>. | :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 <tt>objectId</tt> and record identifier <tt>recordId</tt>. | ||
Generates a document based on | Generates a document based on an [[Print_Templates#Edit_a_Print_Template_based_on_a_Local_HTML_Page|HTML Print Template]]. | ||
;Considerations: | |||
:[[Print_Templates#Edit_a_Print_Template_based_on_a_Platform_JSP/HTML_Page|JSP Print Templates]] cannot be used, currently. | |||
'''Syntax''' | '''Syntax''' |
Revision as of 19:26, 7 February 2012
- 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 Print Template.
- Considerations
- JSP Print Templates cannot be used, currently.
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 CONSTANTS.DOCUMENT.FORMAT.HTML or CONSTANTS.DOCUMENT.FORMAT.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.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>