Parameter query for Nuxeo

This chapter outlines how to specify the query parameter when using a Hyland Nuxeo repository.

Parameter	Mandatory	Type	Default	Description
type	Yes	String		As this chapter describes the parameter for Hyland Nuxeo, the value is nuxeo.
language	No	String	NXQL	The language used for the query (refer to next row).
query	Yes	String		The query to be executed against the Nuxeo repository to find documents. It should include an exclusion criterion for documents that have already been processed. Refer to the Nuxeo Documentation on NXQL for the required syntax.
properties	No	String	* (all Properties)	A comma-separated list of properties to be returned from the documents of the query above. Only these data will be available in the result.
sortBy	No	String		The property name to sort the result set in the query.
sortOrder	No	String	DESC	The sort order used to sort the property specified in sortBy. Options are ASC for ascending or DESC for descending.

warning

Remember to always include an exclusion criterion for the documents in the query!

Example Nuxeo query with all properties

Here is a full specified example of the query parameter object for Hyland Nuxeo.

Example

query:
  type: nuxeo
  language: NXQL
  query: SELECT * FROM Document WHERE NOT dc:title = 'My Doc' AND ecm:isTrashed = 0
  properties: '*'
  sortBy: 'dc:created'
  sortOrder: 'DESC'

Integration with aqilink: Utilizing Properties

tip

This chapter is relevant only if you also use the SAP-certified interface aqilink (Document Exchange) to store documents from SAP to Hyland Nuxeo. In this case, you can leverage the data model of aqilink to create the query and the recommended exclusion criteria.

In this case, we recommend including the name of the SAP Repository Connection (defined in the sapHttp.yaml file) as a criterion in the query. This ensures that only documents from the relevant SAP Content Repository are processed by the task. The name is stored in the source property of the sapHttpContent facet. You can also make use of the status field of the sapTaskStatus facet.

Example

query:
  type: nuxeo
  language: NXQL
  query: SELECT * FROM File WHERE sapHttpContent:source = 'nuxeo-al' AND ecm:mixinType = 'fct_sap_http_content' AND sapTaskStatus:status <> 'Error' AND ecm:isTrashed = 0
  properties: '*'
  sortBy: 'dc:created'
  sortOrder: 'DESC'