assemble (Java class AssembleFile)
The assemble
file object merges several files into one file. In the array of files to be merged, you can merge any of the described file types: generate
, pid
, xquery
, template
, assemble
, or data
.
Attribute name | Value | Type | Description |
---|---|---|---|
type | "assemble" | string | The file object type. |
files | file object array | An array of file objects. The files are merged into one single pdf file, in the order they are specified. The assemble file type is not allowed. |
|
filename | Example: "MyAssembledFile.pdf" | string | Name of the file to be generated. This value is used if you send the document as an attachment or save it back to Document Management. |
pdfA |
Optional True / False Ignored if file extension differs from .pdf. Default value is False. |
boolean | Indicates whether to generate the pdf as a pdf/A. |
item |
Optional File object containing a data file object |
data file object | If there is an item target defined, then you can override the item defined in the item target with this value. If no item target is defined, then this value is ignored. For an example, see the generate object. |
This is an example of this input type in JSon:
{
"type": "assemble",
"files": [
{
"type": "generate",
"data": {
"type": "data",
"filename": "mydata.xml",
"base64": "dGVzdA=="
},
"pid": {
"type": "pid",
"pid": "MDS_File-27-1-LATEST"
},
"filename": "MyGeneratedFile.pdf",
},
{
"type": "xquery",
"xquery": "/MDS_File[@MDS_name=\"FileName\"]"
}
],
"filename": "MyAssambledFile.pdf",
}