Platform Explorer / CMF 1.8

Operation Document.Update (Update Properties)

In component

Description

Set multiple properties on the input document. The properties are specified as key=value pairs separated by a new line. The key used for a property is the property xpath. To specify multi-line values you can use a \ charcater followed by a new line.

Example:

dc:title=The Document Title
dc:description=foo bar
. Returns back the updated document.
Operation id Document.Update
Category Document
Label Update Properties
Requires
Since

Parameters

Name Description Type Required Default value
properties properties yes  
save boolean no true 

Signature

Inputs document, documents
Outputs document, documents

Implementation Information

Implementation Class
Contributing Component

JSON Definition

{
  "id" : "Document.Update",
  "label" : "Update Properties",
  "category" : "Document",
  "requires" : "",
  "description" : "Set multiple properties on the input document. The properties are specified as <i>key=value</i> pairs separated by a new line. The key used for a property is the property xpath. To specify multi-line values you can use a \\ charcater followed by a new line. <p>Example:<pre>dc:title=The Document Title<br>dc:description=foo bar</pre>. Returns back the updated document.",
  "url" : "Document.Update",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "properties",
    "description" : null,
    "type" : "properties",
    "required" : true,
    "widget" : "",
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "save",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : "",
    "order" : 0,
    "values" : [ "true" ]
  } ]
}