Platform Explorer / Nuxeo Platform LTS 2019 10.10

Operation Document.SetProperty (Update Property)

Description

Set a single property value on the input document. The property is specified using its xpath. Save parameter automatically saves the document in the database. It has to be turned off when this operation is used in the context of the empty document created, about to create, before document modification, document modified events. Returns the modified document.
Operation id Document.SetProperty
Category Document
Label Update Property
Requires
Since

Parameters

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

Signature

Inputs document, documents
Outputs document, documents

Implementation Information

JSON Definition

{
  "id" : "Document.SetProperty",
  "label" : "Update Property",
  "category" : "Document",
  "requires" : null,
  "description" : "Set a single property value on the input document. The property is specified using its xpath. Save parameter automatically saves the document in the database. It has to be turned off when this operation is used in the context of the empty document created, about to create, before document modification, document modified events. Returns the modified document.",
  "url" : "Document.SetProperty",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "xpath",
    "description" : "",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "save",
    "description" : "",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "true" ]
  }, {
    "name" : "value",
    "description" : "",
    "type" : "serializable",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}