For the complete documentation index, see llms.txt. This page is also available as Markdown.
CMIS

Recherche (query)

Syntaxe des requêtes de recherche CMIS (fonction query) exposées par le connecteur MG Connect : objets atteignables, métadonnées, opérateurs et exemples.

Principe de fonctionnement

La norme CMIS définit un appel unique par lequel passent toutes les requêtes de recherche : la fonction query(). Un de ses paramètres est une requête dans un format dérivé du SQL-92.

L'appel retourne une liste d'objets — dossiers ou documents — correspondant aux critères de recherche exprimés dans la requête. Le second paramètre est l'identifiant de l'armoire sur laquelle la recherche s'effectue : les éléments retournés sont nécessairement contenus dans cette armoire, à l'exception du cas des liens inter-armoire (voir plus bas).

Objets atteignables par les requêtes

Tous les dossiers et tous les documents stockés dans les armoires Multigest peuvent être recherchés via query().

Les objets créés via le connecteur CMIS sont bien évidemment atteignables par les requêtes. Les objets créés par d'autres méthodes (par exemple depuis l'application web Multigest) le sont également : lorsqu'ils sont retournés, ils sont « habillés » CMIS, c'est-à-dire que les propriétés nécessaires leur sont ajoutées (type cmis:document, etc.).

Métadonnées dossier et métadonnées document comme filtres

Multigest fonctionne avec 2 jeux de métadonnées : un jeu associé au dossier et un jeu associé au document. Cela évite de dupliquer, sur chaque document, les métadonnées communes à tout un dossier.

Par exemple, pour un dossier représentant un client (n° de client « 456 », nom « Martin »), tous les documents de ce dossier partagent ces métadonnées. Pour retrouver tous les RIB de ce client, il suffit de chercher les documents avec n° de client = 456 ET type de document = RIB.

Le connecteur distingue automatiquement métadonnée dossier et métadonnée document dans une requête :

  • lorsqu'une ou plusieurs métadonnées dossier sont définies, elles jouent le rôle de filtre : seuls les documents contenus dans le ou les dossiers correspondants sont retournés ;

  • s'il y a également une ou plusieurs métadonnées document, elles ne sont appliquées que sur les documents déjà sélectionnés par le filtre dossier.

Il serait en effet inutile de retourner les documents d'un autre dossier, même si leurs métadonnées document correspondent, dès lors que la métadonnée dossier cible un dossier précis.

Liens inter-armoire

Lorsque 2 dossiers sont liés par un lien inter-armoire, ils sont vus par la fonction de recherche comme un seul et même dossier : les documents des deux dossiers peuvent donc être retournés, y compris ceux d'une autre armoire que celle interrogée.

Le lien inter-armoire n'est suivi que lorsque le paramètre crossRepositorySearch est défini à true dans le fichier de configuration cmis.xml. Voir Installation pour le détail de ce paramétrage.

Recherche multi-armoire

Bien que la norme CMIS ne le supporte pas nativement, il est possible de lancer une recherche multi-armoire depuis une requête. Cette fonctionnalité doit être activée au préalable via les paramètres activeRepositoriesCompleteSearch et repositoriesCompleteSearch du fichier cmis.xml — voir Installation pour le détail de ce paramétrage XML.

Une fois activée, une requête lancée depuis une armoire déclenche automatiquement la même requête sur l'ensemble des armoires définies dans cmis.xml, et retourne tous les résultats dans un seul et même retour.

Fiches de métadonnées : FROM cmis:document vs FROM mdata:NOMFICHE

La recherche CMIS repose sur des requêtes proches du SQL classique. Une adaptation notable porte sur la clause FROM : en SQL, elle définit la ou les tables sur lesquelles chercher ; pour CMIS, elle définit le type d'objet recherché.

Les deux types les plus courants sont cmis:folder et cmis:document — le premier recherche des dossiers, le second des documents.

Lorsqu'un document est associé à une fiche de métadonnées particulière, son type n'est plus cmis:document mais mdata:NOMDELAFICHEDEMETADONNEES. Par exemple :

  • SELECT * FROM cmis:document retourne tous les documents sans fiche de métadonnées particulière ;

  • SELECT * FROM mdata:MULTIGEST retourne tous les documents associés à la fiche de métadonnées MULTIGEST.

Dans le cas où une même métadonnée se retrouve sur plusieurs fiches, il est conseillé d'utiliser le type cmis:document : le connecteur recherche alors toutes les fiches de métadonnées possédant cette métadonnée. Par exemple :

  • SELECT * FROM mdata:MULTIGEST WHERE mdata:VERSION = "9" retourne tous les documents associés à la fiche MULTIGEST avec la métadonnée VERSION = 9 ;

  • SELECT * FROM cmis:document WHERE mdata:VERSION = "9" retourne tous les documents reliés à une fiche de métadonnées contenant la métadonnée VERSION avec la valeur 9, quelle que soit la fiche.

La métadonnée MgTypeDoc

La métadonnée MgTypeDoc est systématiquement retournée comme propriété de tous les objets document. Elle contient le type de document du plan de classement, sous forme de concaténation dossier / sous-dossier / document.

Elle permet donc d'appeler les documents ayant ce type dans le plan de classement, sans avoir à connaître le détail des métadonnées dossier ou document :

  • SELECT * FROM cmis:document WHERE mdata:mgTypeDoc = "CONTRAT/D-06 CCP" retourne tous les documents importés dans Multigest via ce chemin du plan de classement ;

  • SELECT * FROM cmis:document WHERE mdata:mgTypeDoc = "CCP" — pour éviter à l'utilisateur de taper toute l'arborescence, il est possible de n'en taper qu'une partie : la recherche fonctionne alors comme un LIKE "%CCP%".

Console CMIS Workbench, onglet Properties d'un document, montrant la métadonnée MgTypeDoc avec la valeur CONTRAT/4-06 CCP
La métadonnée MgTypeDoc observée dans CMIS Workbench (voir Référence des services)

Opérateurs supportés

Opérateurs de comparaison

Tous les opérateurs suivants sont implémentés : =, >, >=, <, <=, IN, LIKE, BETWEEN, CONTAINS, IN_TREE.

Opérateurs logiques

Les opérateurs AND et OR sont entièrement supportés.

L'opérateur =, s'il contient une étoile en dernière position, se transforme automatiquement en LIKE :

SELECT * FROM cmis:document WHERE mdata:NOM = "toto*"

est équivalent à

SELECT * FROM cmis:document WHERE mdata:NOM LIKE "toto%"

Exemples de requêtes

Requête utilisant uniquement les métadonnées dossier

Requête mixant les métadonnées dossier et document

Requête utilisant la commande IN_TREE

Mis à jour