Apps

Module CMIS 3.1

Description

Ce module ajoute des fonctionnalités de connexion et de parcours concernant des système de GED (Gestion Electronique de Document) compatible CMIS (Content Management Interoperability Services). Il se base sur ce que propose la bibliothèque Apache Chemistry : http://chemistry.apache.org/java/opencmis.html


Installation

Installation du module

L'installation du module s'effectue en suivant la procédure standard d'installation de module de JCMS.

Il faut noter pour fonctionner ce module peut avoir besoin de module spécifique à la GED visée.

Actuellement les GED supportées (via un autre plugin) sont :

Configuration

Une configuration spécifique au plugin n'est nécessaire, toutefois pour pouvoir l'utiliser, il faut configurer au moins un entrepôt.

Pour configurer un entrepôt :

  • dans la zone d'administration, cliquer sur le lien "Entrepôt CMIS"
  • préciser un nom d'entrepôt (nom utilisé dans le reste de JCMS, il ne pourra pas être modifié une fois l'entrepôt créé)
  • une application associée (voir le § Pour les développeurs pour en rajouter une)
  • le mode de connexion (via atomPub ou webservices selon la GED visée)
  • l'URL de base du service de GED (URL à partir de laquelle les URL réelles de connexion seront contruites)
  • les informations d'authentification nécessaires à la récupération de l'identifiant de l'entrepôt (non sauvegardé)

Note : L'URL attendue est l'URL du serveur dans les extensions éventuelles  ( comme par exemple /service/cmis)

Dans le cas d'une connexion via un webservice, l'accès au serveur peut être vérifié en demande le wsdl dans un navigateur.

 

Une fois créé les entrepôts sont affichés :

cmis entrepot

Exemple de serveur de test accessible : 

  • Alfresco test server : documentation disponible à  https://www.alfresco.com/cmis

Utilisation

Une fois un entrepôt configuré, il peut être utilisé avec les objets suivants:

La portlet CMIS

Création

La portlet CMIS est semblable à l'explorateur de document mais elle permet de naviguer au sein de la GED. Les données présentés ne sont nullement présentes dans JCMS.

Tout d'abord créer une portlet CMIS

cmis portlet

Préciser un répertoire de base via le sélecteur CMIS

cmis portlet edit

Dans cet écran, seul un répertoire distant peut être sélectionné. Le nom de l'entrepôt et l'identifiant du répertoire est alors recopié dans le champ Répertoire racine de la portlet.

  • Fermer l'édition de la portlet
  • La première fois que l'entrepôt est affiché par l'utilisateur courant, un mire de login est affichée

mire

  • Une fois l'authentification effectuée, la portlet affiche le contenu de la GED (en respectant les droits de l'utilisateur GED utilisé).

La portlet peut alors être inséré dans un portail.

Utilisation

cmis fulldisplay

A partir de cette interface il est possible de naviguer dans la GED et d'effectuer plusieurs actions : 

Action sur les répertoires

Un clic sur le menu actions affiche un menu déroulant concernant le répertoire courant (si les droits le permettent)

folder ctx menu

Le dépôt de document sur la GED

Le dépôt est disponible en haut de l'interface si le répertoire courant le permet.

cmis upload

Note : cette interface est plus restreinte que celle présente sur la GED car elle n'affiche que les champs communs. Chaque GED a un fonctionnement différent et il est impossible de prévoir une interface générique à toutes les GED (Voir le § Pour les développeurs).

Sur un document

Il est possible de télécharger le document à partir de la GED en cliquant dessus.

Plusieurs actions sont disponibles dans le menu déroulant accessible en cliquant sur l'icône document. Ces actions sont disponibles si l'utilisateur courant possède les droits nécessaires coté GED.

cmis document ctx

  • Voir les informations : Visualiser les metadonnées GED concernant le document
  • Modifier les informations : Modifier certaines métadonnées (Nom, titre, description)
  • Télécharger : Télécharger le document
  • Créer une copie de travail : Créer une copie de travail (le résultat dépend de la GED utilisé)
  • Supprimer : Supprimer le document dans la GED
  • Références : Affiche le sous-menu concernant les références CMIS
  • Rafraîchir : Rafraîchir les données en mémoire en provenance de la GED

Le contenu du menu contextuel dépend de l'état du document. Si le document est une copie de travail, le menu est :

cmis publish doc

Les références (voir § le type CMISDocument) sont des instances d'un type JCMS nommé CMISDocument. Chaque CMISDocument contient un lien vers un document CMIS externe. Dans ce menu, il possible de créer une référence sur un document CMIS ou d'ouvrir les différentes références existantes.

cmis create ref

Déplacement d'un document

Le déplacement d'un document dans un autre répertoire se fait en effectuant un glisser/déposer.

cmis move document

Les répertoires en gras sont les répertoires qui peuvent accepter le fichier. Le fichier est déplacé du répertoire parent, la notion de répertoires multiples présente dans CMIS et dans certaines GED n'est pas traitée.

La recherche dans la portlet

La recherche d'un document est disponible dans la portlet via le champ de recherche en haut à droite.

Cette recherche s'effectue sur le nom ou le contenu des meta-data du document et est focalisé sur le répertoire courant et ses enfants.

Attention: en fonction des GED, les possibilités de recherche ne sont pas identiques.

cmis search

 

Quelques captures d'écrans des autres actions possibles sur les documents

Voir les informations sur le document

cmis doc info

Le lien proposé dans cet écran est le document dans la GED (non pas la fiche document de la GED mais le document). Ce lien peut ne pas être présent car toutes les GED ne le proposent pas via CMIS.

 

Editer les informations sur le document

cmis doc edit

 

Historique des versions du document

cmis doc history

 

Créer une référérence (voir  le § sur le type CMISDocument)

cmis create reference

La portlet Requête CMIS

Un autre type de portlet est proposé par le plugin : la portlet Requête CMIS. Le but de cette portlet est d'afficher une liste de document CMIS obtenue par l'éxécution d'une ou plusieurs requêtes CMIS.

Les documents affichés ont le même menu contextuel que lorsqu'ils sont présentés dans la portlet CMIS.

cmis portlet request

Les requêtes CMIS sont configurés dans la portlet et peuvent prendre plusieurs formats :

  • une requête CMIS valide (voir la norme CMIS pour l'écrire et il faut aussi prendre en compte les contraintes des GED).
  • l'identifiant d'un réperoire (dans ce cas le contenu direct du répertoire sera présenté)
  • l'identifiant d'un document (ce document sera rajouté à la liste)

Le type CMISDocument

La recherche

Il est possible d'intégrer les résultats en provenance des entrepôts (selon leurs possibilités) dans une recherche globale de JCMS.

Par contre, vu que la recherche peut être assez couteuse, cette fonction n'est pas disponible dans la recherche à partir de la top bar mais uniquement en rajoutant un facette sur un entrepôt CMIS dans une recherche existante.

Il faut noter que via l'API CMIS, les requêtes de recherche ne sont pas capables de fournir le nombre d'éléments trouvés.  Les éléments sont récupérés via pagination et donc le nombre de résultats contenant une recherche CMIS est donc une approximation (nombre JCMS + approximation CMIS).

cmis search result

Utilisation dans les structures de données

Le plugin CMIS permet aussi de mettre un lien vers un ou plusieurs contenus dans les données de JCMS.

Le control CMIS

Il s'agit d'un contrôle ressemblant à un PublicationChooser, permettant de sélectionner un document ou un répertoire dans la GED. Son nom d'entrepôt ainsi que son identifiant sont alors stocké dans le champ JCMS.

L'utilisation de ce contrôle n'est pas disponible dans l'éditeur de type de JCMS. Il convient donc de créer un champ de type texte et de modifier la JSP d'édition pour y ajouter la partie CMIS :

  • étendre le contrôle existant
<jalios:field name="rootFolderId" formHandler="<%= formHandler %>">
  <jalios:control >
  <jalios:buffer name="BTN_ACTION">
     <button type="button" class="btn btn-default hide" data-jalios-action="widget:clear"><jalios:icon src="clear"/></button>
     <button type="button" class="btn btn-default" data-jalios-action="chooser:cmisRepository" data-jalios-cmis-onlyFolder="true">
       <jalios:icon src="jcmsplugin-cmis-icon"/>
     </button>
   </jalios:buffer>
  </jalios:control>
</jalios:field>

 

Le wiki

Le sélecteur CMIS est accessible via l'icône CMIS cmis.

cmis wiki

 

Le principe de fonctionnement est identique au publicationChooser. Le wiki étant un formatage dynamique, seul les identifiants CMIS sont stockés dans le champ. Dans ce cas, un composant de rendu particulier remplace ces identifiants par un lien vers le document CMIS.
Si un répertoire est sélectionné, l'affichage sera alors une liste des documents qu'il comporte.

Le wikiwyg

Du fait que le wysiwig est non dymanique dans ses formatages, le mécanisme est un peu différent par rapport à celui du wiki.
Les répertoires ne peuvent pas être sélectionnés et les documents sont remplacés par un lien qui les pointent au moment de la sauvegarde du champ. Ils pourraient ne plus être valides si le document disparait de la GED.

Le wysiwyg

Le plugin CMIS dans le wysiwyg se comporte comme pour le wikiwyg (non dynamique, seulement les documents, ...).

cmis wysiwyg

Edition des paramètres d'authentification

Le module propose plusieurs interfaces pour modifier/effacer les paramètres d'authentification CMIS :

  • Sur son profil (interface standard)

editon_membre

  • Sur l'édition de son profil (avec l'ESN)

edition membre

Etendre le module

Ce module permet d'être étendu afin de s'adapter aux spécificités des GED visée.

En plus des extensions Jalios habituelles (target, policyfilter, ...), ce module propose la possibilité de modifier certains éléments liés à CMIS via la dériviation de la classe com.jalios.jcmsplugin.cmis.CMISProviderHandler.

Cette classe permet, entre autres,  la configuration de la connexion (authentification par exemple), la gestion de fonctionnalités CMIS qui diffèrent entre les GED (identifiant de données vérrouillées par exemple), ...

Afin d'utiliser ce mécanisme, il faut créer une sous-classe de com.jalios.jcmsplugin.cmis.CMISProviderHandler et déclarer un type de repository avec cette classe. Cela se fait par l'ajout d'une propriété telle que :

jcmsplugin.cmis.providers.MyCMISRepository.defaultPropertiesHandler:com.jalios.jcmsplugin.cmis_mycmisrepository.MyCMISRepositoryProviderHandler

Exemple de modification du mécanisme d'authentification comme proposé par  la librairie utilisée :  Apache Chemistry

package com.jalios.jcmsplugin.cmis_mycmisrepository;
...
public class MyCMISRepositoryProviderHandler extends CMISProviderHandler {
/* (non-Javadoc)
* @see com.jalios.jcmsplugin.cmis.CMISProviderHandler#getProviderIconURL()
*/
@Override
public String getProviderIconURL() {
   return "plugins/MyCMISRepositoryProviderHandler/images/icon.gif";
}

@Override
public Map<String, String> addConnectionParameters(Map<String, String> parameters){
   parameters.put(SessionParameter.AUTHENTICATION_PROVIDER_CLASS, "org.apache.chemistry.opencmis.client.bindings.spi.StandardAuthenticationProvider");
   return parameters;
}
}

Informations

Version
  • 3.1
Stabilité
  • Stable
Compatibilité
  • JCMS 9 SP2
    JCMS 9 SP3
    JCMS 9 SP4
    JCMS 9 SP5
    JPlatform 10
Certifié Jalios
  • Oui
Prix
  • Module payant
Support
  • Jalios Support
Auteur
  • Jalios SA
Licence
  • Jalios
Taille
  • 6,32 Mo
Mis-à-jour
  • 28/06/18
Téléchargements
  • 18