Platform Explorer / Nuxeo Platform 5.6

Operation LocalConfiguration.PutSimpleConfigurationParameter

Put a Simple Configuration Parameter

Description

Put a Simple Configuration parameter on the input document. Add the 'SimpleConfiguration' facet on the input document if needed. The user adding a parameter must have WRITE access on the input document
Operation id LocalConfiguration.PutSimpleConfigurationParameter
Category Local Configuration
Label Put a Simple Configuration Parameter
Requires
Since

Parameters

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

Signature

Inputs document
Outputs document

Implementation information

Implementation class org.nuxeo.ecm.platform.localconfiguration.simple.operations.PutSimpleConfigurationParameter
Contributing component org.nuxeo.ecm.platform.local.configuration.simple.operations

JSON definition

{
  "id" : "LocalConfiguration.PutSimpleConfigurationParameter",
  "label" : "Put a Simple Configuration Parameter",
  "category" : "Local Configuration",
  "requires" : null,
  "description" : "Put a Simple Configuration parameter on the input document. Add the 'SimpleConfiguration' facet on the input document if needed. The user adding a parameter must have WRITE access on the input document",
  "url" : "LocalConfiguration.PutSimpleConfigurationParameter",
  "signature" : [ "document", "document" ],
  "params" : [ {
    "name" : "key",
    "description" : "",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "value",
    "description" : "",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "save",
    "description" : "",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "true" ]
  } ]
}