com.adobe.pdfservices.operation.pdfops

Class DocumentMergeOperation

java.lang.Object

com.adobe.pdfservices.operation.pdfops.DocumentMergeOperation

All Implemented Interfaces:

Operation

public class DocumentMergeOperation
extends Object
implements Operation

An operation that enables the clients to produce high fidelity PDF and Word documents with dynamic data inputs. This operation merges the JSON data with the Word template to create dynamic documents for contracts and agreements, invoices, proposals, reports, forms, branded marketing documents and more.

To know more about document generation and document templates, please see the documentation

Sample Usage:

   JSONObject jsonDataForMerge = new JSONObject("{\"customerName\": \"James\",\"customerVisits\": 100}");
   DocumentMergeOptions documentMergeOptions = new DocumentMergeOptions(jsonDataForMerge, OutputFormat.PDF);
   DocumentMergeOperation docMergeOperation = DocumentMergeOperation.createNew(documentMergeOptions);
   documentMergeOptions.setInput(FileRef.createFromLocalFile("~/Documents/documentTemplate.docx",
                                                           DocumentMergeOptions.SupportedSourceFormat.DOCX.getMediaType()));
   Credentials credentials = Credentials.serviceAccountCredentialsBuilder().fromFile("pdfservices-api-credentials.json").build();
   FileRef result = createPdfOperation.execute(ExecutionContext.create(credentials));
   result.saveAs("output/DocumentMergeOutput.pdf");
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentMergeOperation.SupportedSourceFormat Supported source file formats for DocumentMergeOperation.

Method Summary

Modifier and Type	Method and Description
static DocumentMergeOperation	createNew(DocumentMergeOptions documentMergeOptions) Constructs a DocumentMergeOperation instance.
FileRef	execute(ExecutionContext context) Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting Merged file.
void	setInput(FileRef documentTemplate) Sets the input MS Word based document template

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setInput

public void setInput(FileRef documentTemplate)

Sets the input MS Word based document template

Parameters:

documentTemplate - an input file; Cannot be null

createNew

public static DocumentMergeOperation createNew(DocumentMergeOptions documentMergeOptions)

Constructs a DocumentMergeOperation instance.

Parameters:

documentMergeOptions - for merging document template with provided input JSON data; Cannot be null

Returns:

a new DocumentMergeOperation instance

execute

public FileRef execute(ExecutionContext context)
                throws ServiceApiException,
                       IOException,
                       ServiceUsageException

Executes this operation synchronously using the supplied context and returns a new FileRef instance for the resulting Merged file.

The resulting file may be stored in the system temporary directory (per java.io.tmpdir System property). See FileRef for how temporary resources are cleaned up.

Specified by:

execute in interface Operation

Parameters:

context - the context in which to execute the operation

Returns:

the resulting merged document

Throws:

ServiceApiException - if an API call results in an error response

IOException - if there is an error in reading either the input source or the resulting PDF file

ServiceUsageException - if service usage limits have been reached or credentials quota has been exhausted