Platform Explorer / Nuxeo Platform LTS 2019 10.10

Operation RunDocumentOperation (Run Document Chain)

Description

Run an operation chain which is returning a document in the current context. The input for the chain ro run is the current input of the operation. Return the output of the chain as a document. The 'parameters' injected are accessible in the subcontext ChainParameters. For instance, @{ChainParameters['parameterKey']}.
Operation id RunDocumentOperation
AliasesContext.RunDocumentOperation
Category Execution Flow
Label Run Document Chain
Requires
Since

Parameters

Name Description Type Required Default value
id string yes  
isolate boolean no false 
newTx Define if the chain in parameter should be executed in new transaction. boolean no false 
parameters Accessible in the subcontext ChainParameters. For instance, @{ChainParameters['parameterKey']}. properties no  
rollbackGlobalOnError Define if transaction should rollback or not (default to true) boolean no true 
timeout Define transaction timeout (default to 60 sec). integer no  

Signature

Inputs document, documents
Outputs document, documents

Implementation Information

JSON Definition

{
  "id" : "RunDocumentOperation",
  "aliases" : [ "Context.RunDocumentOperation" ],
  "label" : "Run Document Chain",
  "category" : "Execution Flow",
  "requires" : null,
  "description" : "Run an operation chain which is returning a document in the current context. The input for the chain ro run is the current input of the operation. Return the output of the chain as a document. The 'parameters' injected are accessible in the subcontext ChainParameters. For instance, @{ChainParameters['parameterKey']}.",
  "url" : "RunDocumentOperation",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "id",
    "description" : "",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "isolate",
    "description" : "",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "false" ]
  }, {
    "name" : "newTx",
    "description" : "Define if the chain in parameter should be executed in new transaction.",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "false" ]
  }, {
    "name" : "parameters",
    "description" : "Accessible in the subcontext ChainParameters. For instance, @{ChainParameters['parameterKey']}.",
    "type" : "properties",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "rollbackGlobalOnError",
    "description" : "Define if transaction should rollback or not (default to true)",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "true" ]
  }, {
    "name" : "timeout",
    "description" : "Define transaction timeout (default to 60 sec).",
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}