Platform Explorer / server 10.10

Operation Render.Document

Render Document

Description

Get a document or a list of document in input and outputs one or more blobs that contain a rendered view for each input document given a rendering template. The template attribute may contain either the template content either a template URI. Template URis are strings in the form 'template:template_name' and will be located using the runtime resource service. Return the rendered file(s) as blob(s)
Operation id Render.Document
Category Conversion
Label Render Document
Requires
Since

Parameters

Name Description Type Required Default value
template string yes  
filename string no output.ftl 
mimetype string no text/xml 
type string no ftl, mvel 

Signature

Inputs document, documents
Outputs blob, bloblist

Implementation information

Implementation class org.nuxeo.ecm.automation.core.rendering.operations.RenderDocument
Contributing component org.nuxeo.ecm.core.automation.coreContrib

JSON definition

{
  "id" : "Render.Document",
  "label" : "Render Document",
  "category" : "Conversion",
  "requires" : null,
  "description" : "Get a document or a list of document in input and outputs one or more blobs that contain a rendered view for each input document given a rendering template. The template attribute may contain either the template content either a template URI. Template URis are strings in the form 'template:template_name' and will be located using the runtime resource service. Return the rendered file(s) as blob(s)",
  "url" : "Render.Document",
  "signature" : [ "document", "blob", "documents", "bloblist" ],
  "params" : [ {
    "name" : "template",
    "description" : "",
    "type" : "string",
    "required" : true,
    "widget" : "TemplateResource",
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "filename",
    "description" : "",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "output.ftl" ]
  }, {
    "name" : "mimetype",
    "description" : "",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "text/xml" ]
  }, {
    "name" : "type",
    "description" : "",
    "type" : "string",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "ftl", "mvel" ]
  } ]
}