Platform Explorer / server 10.10

Operation Repository.PageProvider

PageProvider

Description

Perform a named provider query on the repository. Result is paginated. The query result will become the input for the next operation.
Operation id Repository.PageProvider
AliasesDocument.PageProvider
Category Fetch
Label PageProvider
Requires
Since

Parameters

Name Description Type Required Default value
providerName string yes  
currentPageIndex integer no  
documentLinkBuilder string no  
highlights Highlight properties (separated by comma) stringlist no  
language string no NXQL 
namedParameters Named parameters to pass to the page provider to fill in query variables. properties no  
pageSize integer no  
queryParams stringlist no  
quickFilters Quick filter properties (separated by comma) stringlist no  
sortBy Sort by properties (separated by comma) stringlist no  
sortOrder Sort order, ASC or DESC stringlist no ASC, DESC 

Signature

Inputs void
Outputs documents

Implementation information

Implementation class org.nuxeo.ecm.automation.core.operations.services.DocumentPageProviderOperation
Contributing component org.nuxeo.ecm.core.automation.features.operations

JSON definition

{
  "id" : "Repository.PageProvider",
  "aliases" : [ "Document.PageProvider" ],
  "label" : "PageProvider",
  "category" : "Fetch",
  "requires" : null,
  "description" : "Perform a named provider query on the repository. Result is paginated. The query result will become the input for the next operation.",
  "url" : "Repository.PageProvider",
  "signature" : [ "void", "documents" ],
  "params" : [ {
    "name" : "providerName",
    "description" : "",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "currentPageIndex",
    "description" : "",
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "documentLinkBuilder",
    "description" : "",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "highlights",
    "description" : "Highlight properties (separated by comma)",
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "language",
    "description" : "",
    "type" : "string",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "NXQL" ]
  }, {
    "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" : "pageSize",
    "description" : "",
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "queryParams",
    "description" : "",
    "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" : "sortBy",
    "description" : "Sort by properties (separated by comma)",
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "sortOrder",
    "description" : "Sort order, ASC or DESC",
    "type" : "stringlist",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "ASC", "DESC" ]
  } ],
  "widgets" : [ {
    "name" : "query",
    "type" : "codearea",
    "labels" : {
      "any" : "NXQL query"
    },
    "translated" : true,
    "handlingLabels" : false,
    "fields" : [ {
      "fieldName" : "query",
      "propertyName" : "query"
    } ],
    "properties" : {
      "any" : {
        "height" : "100%",
        "language" : "nxql",
        "width" : "100%"
      }
    }
  } ]
}