Platform Explorer / Nuxeo Platform 2023.23

Operation Bulk.RunAction (Run a bulk command)

In component org.nuxeo.ecm.core.automation.features.operations

Description

Run a bulk action on a set of documents expressed by a NXQL.
Operation id Bulk.RunAction
Category Services
Label Run a bulk command
Requires
Since

Parameters

Name Description Type Required Default value
action string yes  
batchSize int no  
bucketSize int no  
excludeDocs stringlist no  
namedParameters Named parameters to pass to the page provider to fill in query variables. properties no  
parameters string no  
providerName string no  
query string no  
queryLimit long no  
queryParams stringlist no  
quickFilters Quick filter properties (separated by comma) stringlist no  
repositoryName string no  

Signature

Inputs void
Outputs bulkstatus

Implementation Information

Implementation Class Class: org.nuxeo.ecm.automation.core.operations.services.bulk.BulkRunAction
Contributing Component org.nuxeo.ecm.core.automation.features.operations

JSON Definition

{
  "id" : "Bulk.RunAction",
  "label" : "Run a bulk command",
  "category" : "Services",
  "requires" : null,
  "description" : "Run a bulk action on a set of documents expressed by a NXQL.",
  "url" : "Bulk.RunAction",
  "signature" : [ "void", "bulkstatus" ],
  "params" : [ {
    "name" : "action",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "batchSize",
    "description" : null,
    "type" : "int",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "bucketSize",
    "description" : null,
    "type" : "int",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "excludeDocs",
    "description" : null,
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "namedParameters",
    "description" : "Named parameters to pass to the page provider to fill in query variables.",
    "type" : "properties",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "parameters",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "providerName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "query",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "queryLimit",
    "description" : null,
    "type" : "long",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "queryParams",
    "description" : null,
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "quickFilters",
    "description" : "Quick filter properties (separated by comma)",
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "repositoryName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}