{"id":447,"date":"2021-02-18T15:14:56","date_gmt":"2021-02-18T15:14:56","guid":{"rendered":"http:\/\/167.71.55.215\/?page_id=447"},"modified":"2023-03-07T09:33:48","modified_gmt":"2023-03-07T09:33:48","slug":"custom-pipelines","status":"publish","type":"page","link":"https:\/\/info.documotor.com\/?page_id=447","title":{"rendered":"Custom Pipelines"},"content":{"rendered":"\n

Pipeline templates are used for the flexibility of combining procedures not covered by the graphical UI.<\/p>\n\n\n\n

A pipeline template consist of a yaml definition of processors with input\/output defined for each step.<\/p>\n\n\n\n

The output of pipelines can be stored by using the output syntax $(outputName)<\/code> and then referenced in the subsequent processors as input.<\/p>\n\n\n\n

Input parameters can either be literals or references defined in the pipeline definition.<\/p>\n\n\n\n

DocumentToHtml<\/h2>\n\n\n\n

Converts a document to a HTML representation. Currently Word only.<\/p>\n\n\n\n

Returns a HTML document as a text string.<\/p>\n\n\n\n

- !DocumentToHtml\n  inputs:\n    fileFormat: docx<\/strong>\n    data: document to convert<\/strong>\n  output: $(outputName<\/strong>) <\/code><\/pre>\n\n\n\n
fileFormat <\/strong>specifies the input format.<\/p>\n\n\n\n
data <\/strong>specifies the binary document to convert.<\/p>\n\n\n\n
DocumentToPlainText<\/h2>\n\n\n\n
Converts a document to a plain text representation. Currently Word only.<\/p>\n\n\n\n
Returns a plain text string.<\/p>\n\n\n\n
- !DocumentToPlainText\n  inputs:\n    fileFormat: docx<\/strong>\n    data: document to convert<\/strong>\n  output: $(outputName<\/strong>) <\/code><\/pre>\n\n\n\n
fileFormat <\/strong>specifies the input format.<\/p>\n\n\n\n
data <\/strong>specifies the binary document to convert.<\/p>\n\n\n\n
GenerateTemplafy<\/h2>\n\n\n\n
Generate a document from a Templafy One template using a service account.<\/p>\n\n\n\n
Returns a binary document.<\/p>\n\n\n\n
- !GenerateTemplafy\n  inputs:\n    token: token<\/strong>\n    templateId: templafy template identifier<\/strong>\n    userProfileId: service account profile id<\/strong>\n    data: input to the form data bindings<\/strong>\noutput: $(outputName<\/strong>) <\/code><\/pre>\n\n\n\n
token<\/strong> specifies the service account token used to generate the document\/presentation from Templafy. Token can be acquired by Omnidocs, valid for a single Templafy tenant.<\/p>\n\n\n\n
templateId <\/strong>specifies the unique identifier for a template in Templafy.<\/p>\n\n\n\n
userProfileId<\/strong> specifies the service account user profile used for generating the document. Identifier can be acquired by Omnidocs, valid for a single Templafy tenant.<\/p>\n\n\n\n
data<\/strong> specifies the data json forwarded as input to the Templafy dynamic template.<\/p>\n\n\n\n
JmesPath<\/h2>\n\n\n\n
Perform data transformation beyond the input data transformation.<\/p>\n\n\n\n
Returns a json text string.<\/p>\n\n\n\n
- !JmesPath\n  inputs:\n    json: json to transform<\/strong>\n    jmes: data transformation<\/strong>\n  output: $(outputName<\/strong>) <\/code><\/pre>\n\n\n\n
json<\/strong> specifies the data to transform.<\/p>\n\n\n\n
jmes <\/strong>specifies the transformation to perform.<\/p>\n\n\n\n
OfficeToPdf<\/h2>\n\n\n\n
Converts a binary document\/presentation to a PDF.<\/p>\n\n\n\n
Returns binary PDF.<\/p>\n\n\n\n
- !OfficeToPdf\n  inputs:\n    fileFormat: docx\/pptx<\/strong>\n    document: document to convert<\/strong>\n  output: $(outputName<\/strong>) <\/code><\/pre>\n\n\n\n
fileFormat <\/strong>specifies the input format.<\/p>\n\n\n\n
document <\/strong>specifies the binary document to convert.<\/p>\n\n\n\n
QueryString<\/h2>\n\n\n\n
Read additional data from a custom API query parameter and use it in the pipeline.<\/p>\n\n\n\n
Returns the string value of the query parameter.<\/p>\n\n\n\n
- !QueryString\n  inputs:\n    paramKey: parameter name<\/strong>\n    defaultValue: default value<\/strong>\n  output: $(outputName<\/strong>) <\/code><\/pre>\n\n\n\n
paramKey <\/strong>specifies the name of the query parameter to read from in the pipeline.<\/p>\n\n\n\n
defaultValue <\/strong>specifies the default value if the parameter is omitted from the request.<\/p>\n\n\n\n
ReadBack<\/h2>\n\n\n\n
Provides the ability to read back the original input dataset updated with user changes to the document content controls in Word.<\/p>\n\n\n\n
- !ReadBack\n  inputs:\n    fileFormat: docx\/pptx<\/strong>\n    data: base64 encoded document<\/strong>\noutput: $(outputName<\/strong>)<\/code><\/pre>\n\n\n\n
fileFormat <\/strong>specifies the type of input file.<\/p>\n\n\n\n
data<\/strong> specifies the base 64 encoded document. Use body of request $(body).<\/p>\n\n\n\n
Response<\/h2>\n\n\n\n
Can be used as a last step of the pipeline to set the return value for the response.<\/p>\n\n\n\n
- !Response\n  inputs:\n    body: value<\/strong>\n    mimeType: mime type<\/strong> <\/code><\/pre>\n\n\n\n
body <\/strong>specifies the value to set as the response<\/p>\n\n\n\n
mimeType <\/strong>specifies the mime type for the pipeline handler to finalize.<\/p>\n\n\n\n
RunTemplate<\/h2>\n\n\n\n
Executes the DocuMotor templating engine on the input document\/presentation template.<\/p>\n\n\n\n
Returns the document as binary.<\/p>\n\n\n\n
- !RunTemplate\n  inputs:\n    fileFormat: docx\/pptx<\/strong>\n    template: binary template<\/strong>\n    data: data to insert<\/strong>\n    trimPageBreaks: true\/false<\/strong>\n    removeContentControls: true\/false<\/strong>\n    enableReadBack: true\/false<\/strong>\n  output: $(outputName<\/strong>) <\/code><\/pre>\n\n\n\n
fileFormat <\/strong>specifies the type of templating engine to engage.<\/p>\n\n\n\n
template<\/strong> specifies the binary document\/presentation template to execute on.<\/p>\n\n\n\n
data<\/strong> specifies the data to apply on the template document<\/p>\n\n\n\n
trimPageBreaks<\/strong> specifies whether to remove or keep blank page breaks in the end of the document.<\/p>\n\n\n\n
removeContentControls<\/strong> (word only) specifies whether to remove or keep content controls after applying data in the document.<\/p>\n\n\n\n
enableReadBack <\/strong>(word only) stores the input data in a CutomXml file inside the document and keeps bound content controls in order to retrieve the input data updated with manual changes to the document.<\/p>\n\n\n\n
<\/div>\n","protected":false},"excerpt":{"rendered":"
Pipeline templates are used for the flexibility of combining procedures not covered by the graphical UI. A pipeline template consist of a yaml definition of processors with input\/output defined for each step. The output of pipelines can be stored by using the output syntax $(outputName) and then referenced in the subsequent processors as input. Input […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":3160,"menu_order":9,"comment_status":"closed","ping_status":"closed","template":"","meta":[],"_links":{"self":[{"href":"https:\/\/info.documotor.com\/index.php?rest_route=\/wp\/v2\/pages\/447"}],"collection":[{"href":"https:\/\/info.documotor.com\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/info.documotor.com\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/info.documotor.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/info.documotor.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=447"}],"version-history":[{"count":13,"href":"https:\/\/info.documotor.com\/index.php?rest_route=\/wp\/v2\/pages\/447\/revisions"}],"predecessor-version":[{"id":3257,"href":"https:\/\/info.documotor.com\/index.php?rest_route=\/wp\/v2\/pages\/447\/revisions\/3257"}],"up":[{"embeddable":true,"href":"https:\/\/info.documotor.com\/index.php?rest_route=\/wp\/v2\/pages\/3160"}],"wp:attachment":[{"href":"https:\/\/info.documotor.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=447"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}