Code:Generate an Attachment
From AgileApps Support Wiki
Revision as of 02:20, 21 January 2014 by imported>Aeric
This example uses a Document Template to generate a PDF or HTML document, and then attaches the document to the current case.
In outline, the process is:
- Get the record ID from the incoming method parameters.
- Use the generateDocument API to create a PDF (or HTML) document from an existing template.
- Use the getDocument API to retrieve it, in the form of a PlatformFileBean.
- Use the addRecord API to attach the document to the case.
package com.platform.yourCompany.yourPackage; import com.platform.api.*; import com.platform.beans.*; //import java.util.*; public class UtilityFunctions { // This signature allows the method to be invoked from a rule. // We assume it is invoked on a Case record. public void generateAttachment(com.platform.api.Parameters inParams) throws Exception { String documentTitle = "PUT TITLE OF GENERATED DOCUMENT HERE"; String templateID = "PUT ID OF DOCUMENT TEMPLATE HERE"; // Get the record ID from the incoming parameters String objectID = inParams.get("object_id"); String recordID = inParams.get("id"); // Generate the document Result result = Functions.generateDocument(objectID, recordID, templateID, CONSTANTS.DOCUMENT.HTML); // or CONSTANTS.DOCUMENT.PDF int resultCode = result.getCode(); if (resultCode < 0) { String msg = "Document generation failed"; Logger.info(msg + ":\n" + result.getMessage(), "genAttachment"); Functions.throwError(msg + "."); return; } // Retrieve the document as a PlatformFileBean String docID = result.getId(); result = Functions.getDocument(docID); resultCode = result.getCode(); if (resultCode < 0) { String msg = "Failed to retrieve the document"; Logger.info(msg + ":\n" + result.getMessage(), "genAttachment"); Functions.throwError(msg + "."); return; } Parameters docParams = result.getParameters(); PlatformFileBean fileBean = docParams.getPlatformFileBean(docID); // Add the document as an attachment Parameters params = Functions.getParametersInstance(); params.add("title", documentTitle); params.add("file_field", fileBean ); params.add("related_to", objectID+":"+recordID); result = Functions.addRecord("attachments", params); resultCode = result.getCode(); if (resultCode < 0) { String msg = "Failed to attach document to case"; Logger.info(msg + ":\n" + result.getMessage(), "genAttachment"); Functions.throwError(msg + "."); return; } } }
Tip: For a more generalized solution, add a function parameter that identifies the template to use. Then write a wrapper method to supply a specific template, something like this:
public void generateA1Attachment(com.platform.api.Parameters inParams) { String A1_TemplateID = "9ewr8aasd923234ased0897234d"; generateAttachment(inParams, A1_TemplateID); }