Platform Explorer / Nuxeo Platform 5.8

Operation Document.SetProperty (Update Property)

In component BuiltIn

Description

Set a single property value on the input document. The property is specified using its xpath. The document is automatically saved if 'save' parameter is true. If you unset the 'save' you need to save it later using Save Document operation. Return the modified document.
Operation id Document.SetProperty
Category Document
Label Update Property
Requires
Since

Parameters

Name Description Type Required Default value
value serializable yes  
xpath string yes  
save boolean no true 

Signature

Inputs document, documents
Outputs document, documents

Implementation Information

Implementation Class Javadoc: org.nuxeo.ecm.automation.core.operations.document.SetDocumentProperty
Contributing Component BuiltIn

JSON Definition

{
  "id" : "Document.SetProperty",
  "label" : "Update Property",
  "category" : "Document",
  "requires" : "",
  "description" : "Set a single property value on the input document. The property is specified using its xpath. The document is automatically saved if 'save' parameter is true. If you unset the 'save' you need to save it later using Save Document operation. Return the modified document.",
  "url" : "Document.SetProperty",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "value",
    "description" : null,
    "type" : "serializable",
    "required" : true,
    "widget" : "",
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "xpath",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : "",
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "save",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : "",
    "order" : 0,
    "values" : [ "true" ]
  } ]
}