Operation Document.Filter
Filter List
Description
Filter the input list of documents given a condition. The condition can be expressed using 4 parameters: types, facets, lifecycle and condition. If more than one parameter is specified an AND will be used to group conditions.The 'types' parameter can take a comma separated list of document type: File,Note.
The 'facet' parameter can take a single facet name.
The 'life cycle' parameter takes a name of a life cycle state the document should have.
The 'condition' parameter can take any EL expression.
Returns the list of documents that match the filter condition.
You can find an example using this operation here: Implement the News "publishing" process
Operation id | Document.Filter |
---|---|
Category | Document |
Label | Filter List |
Requires | |
Since |
Parameters
Name | Description | Type | Required | Default value |
---|---|---|---|---|
class | string | no | Any, Regular Document, Document Link, Published Document, Document Proxy, Document Version, Immutable Document, Mutable Document | |
condition | string | no | ||
facet | string | no | ||
lifecycle | string | no | ||
pathStartsWith | string | no | ||
types | string | no |
Signature
Inputs | documents |
---|---|
Outputs | documents |
Implementation information
Implementation class | org.nuxeo.ecm.automation.core.operations.document.FilterDocuments |
---|---|
Contributing component | org.nuxeo.ecm.core.automation.coreContrib |
JSON definition
{ "id" : "Document.Filter", "label" : "Filter List", "category" : "Document", "requires" : null, "description" : "Filter the input list of documents given a condition. The condition can be expressed using 4 parameters: types, facets, lifecycle and condition. If more than one parameter is specified an AND will be used to group conditions. <br>The 'types' parameter can take a comma separated list of document type: File,Note.<br>The 'facet' parameter can take a single facet name.<br> The 'life cycle' parameter takes a name of a life cycle state the document should have.<br>The 'condition' parameter can take any EL expression.<p>Returns the list of documents that match the filter condition.", "url" : "Document.Filter", "signature" : [ "document", "documents", "documents", "documents" ], "params" : [ { "name" : "class", "description" : "", "type" : "string", "required" : false, "widget" : "Option", "order" : 0, "values" : [ "Any", "Regular Document", "Document Link", "Published Document", "Document Proxy", "Document Version", "Immutable Document", "Mutable Document" ] }, { "name" : "condition", "description" : "", "type" : "string", "required" : false, "widget" : null, "order" : 0, "values" : [ ] }, { "name" : "facet", "description" : "", "type" : "string", "required" : false, "widget" : null, "order" : 0, "values" : [ ] }, { "name" : "lifecycle", "description" : "", "type" : "string", "required" : false, "widget" : null, "order" : 0, "values" : [ ] }, { "name" : "pathStartsWith", "description" : "", "type" : "string", "required" : false, "widget" : null, "order" : 0, "values" : [ ] }, { "name" : "types", "description" : "", "type" : "string", "required" : false, "widget" : null, "order" : 0, "values" : [ ] } ] }