Platform Explorer / Nuxeo Platform 11.3

Operation PDF.MergeWithDocs (PDF: Merge with Document(s))

Description

The input document(s) always is(are) the first PDFs, and their PDF is read in the xpath field (but it is ok for the input doc to have no blob). The operation appends the blob referenced in the toAppendVarName Context variable. It then appends all the blobs stored in the toAppendListVarName Context variable. It then append the blobs stored in the docs whose IDs are passed in toAppendDocIDsVarName (the same xpath is used). Returns the final PDF.
Operation id PDF.MergeWithDocs
Category Conversion
Label PDF: Merge with Document(s)
Requires
Since

Parameters

Name Description Type Required Default value
fileName string no  
pdfAuthor string no  
pdfSubject string no  
pdfTitle string no  
toAppendDocIDsVarName string no  
toAppendListVarName string no  
toAppendVarName string no  
xpath string no file:content 

Signature

Inputs document, documents
Outputs blob, blob

Implementation Information

JSON Definition

{
  "id" : "PDF.MergeWithDocs",
  "label" : "PDF: Merge with Document(s)",
  "category" : "Conversion",
  "requires" : null,
  "description" : "The input document(s) always is(are) the first PDFs, and their PDF is read in the <code>xpath</code> field (but it is ok for the input doc to have no blob). The operation appends the blob referenced in the <code>toAppendVarName</code> Context variable. It then appends all the blobs stored in the <code>toAppendListVarName</code> Context variable. It then append the blobs stored in the docs whose IDs are passed in <code>toAppendDocIDsVarName</code> (the same <code>xpath</code> is used). Returns the final PDF.",
  "url" : "PDF.MergeWithDocs",
  "signature" : [ "document", "blob", "documents", "blob" ],
  "params" : [ {
    "name" : "fileName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "pdfAuthor",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "pdfSubject",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "pdfTitle",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "toAppendDocIDsVarName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "toAppendListVarName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "toAppendVarName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "xpath",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "file:content" ]
  } ]
}