Documentation

La base de connaisance complète sur ARender - Comment l’installer et le configurer pour répondre à vos besoins

Alfresco

ARender for Alfresco

image

Cet article détaille l’intégration et l’installation du connecteur CMIS Arender. Ceci couvre la partie intégration dans Alfresco et la partie configuration HMI. La configuration du serveur de rendition n’est pas détaillée ici.

La partie installation Alfresco concerne les versions 4.X, 5.0, 5.1 et 5.2.

Il est à mentionner que le connecteur se base sur le protocole CMIS, donc potentiellement “intégrable” dans toutes les GED supportant le CMIS.

Le connecteur permet de gérer les enregistrements des annotations sur Alfresco, les fichiers XML d’annotations sont enregistrés dans un espace Alfresco configurable.

Le connecteur ne gère pas les métadonnées à l’enregistrement du document après une modification via documentBuilder. Il va cloner celles du document courant.

Paramètre Description
nodeRef Exemple : workspace://SpacesStore/6eb252b8-416b-40ad-a704-5fa39641a211 Identifiant unique d’un document
alf_ticket format : TICKET_d6396b6d866f19b5e2f70e36c6e21df551573610 Ticket d’authentification Alfresco.
ARenderContext Nom de la webapp déployée

Configuration ARender HMI

Définition du connecteur

Comme détaillé ci-dessous, le connecteur CMIS est composé de deux éléments. Le premier concerne l’accès à un l’entrepot Alfresco et ses documents. Le deuxième est chargé d’introduire un nouveau parser d’URL dans la configuration ARender.

Vous trouverez la configuration du connecteur CMIS dans le fichier arender-server.properties situé dans le fichier ARenderHMI.war : WEB-INF/classes.

Attention
  • Pour modifier les valeurs des propriétés contenues dans le fichier arender-server.properties, copiez les dans le fichier arender-server-custom-alfresco.properties avec les valeurs voulues

  • Vérifier l’URL du connecteur CMIS de la propriété « atomPubURL » en fonction de la version d’Alfresco installée (voir la description de la propriété arender.server.alfresco.atom.pub.url située ci-dessous).

Propriétés Alfresco modifiables :

Propriété Description
arender.server.alfresco.atom.pub.url URL du service CMIS, selon les versions Alfresco voir: https://community.alfresco.com/docs/DOC-5527-cmis#jive_content_id_CMIS_Service_URL. Le connecteur est testé avec les version CMIS 1.0 et 1.1
arender.server.alfresco.annotation.path Chemin sur Alfresco du stockage du dossier d’annotations.
arender.server.alfresco.annotation.folder.name Nom du dossier d’annotations.
arender.server.alfresco.use.soap.ws Faux par défaut. Si ce paramètre est configuré à vrai, ARender va utiliser les Web-Service SOAP pour récupérer le contenu du document.
arender.server.alfresco.soap.ws.url URL des Web-Services SOAP Afresco.
arender.server.alfresco.user Vide par défaut. Y configurer la valeur fera qu’ARender se connectera avec un login/mot de passe à Alfresco. Sinon le ticket Alfresco est utilisé.
arender.server.alfresco.password Password de l’utilisateur dans le cas d’une connexion en login/mot de passe à Alfresco.

Il est possible d’utiliser le paramètre alfDataAbsolutePath corespondant au contentStore Alfresco (chemin de stockage des fichiers Alfresco) (voir fichier arender-server.properties).

Attention
Ce dernier ne peut être utilisé que dans le cas où le HMI est installé sur le même serveur qu’Alfresco ou que le serveur HMI peut accéder a ce stockage. Dans le cas contraire, cette propriété doit être commentée.

Configuration de l’accès aux documents

Selon le mode d’authentification choisi, deux types de fournisseurs peuvent être utilisés pour fournir un accès aux documents.

Authentification avec ticket

L’authentification par ticket ne nécessite aucune configuration supplémentaire.

Authentification avec un compte service

Afin d’utiliser la visionneuse ARender avec un compte de service, les deux propriétés user et password doivent être définie dans le fichier arender-server-custom-alfresco.properties :

arender.server.alfresco.user=userName
arender.server.alfresco.password=password

Installation/Configuration Alfresco

L’intégration d’Arender sur Alfresco se fait via un module de type jar, ce dernier est à copier sur le serveur Alfresco.

Les modules packagés se basent sur l’architecture « HMI » et doivent être sur le même serveur d’application qu’Alfresco. Ils se trouvent dans le dossier webapps de tomcat avec pour nom : ARenderHMI.

L’installation d’un jar nécessite le redémarrage d’Alfresco.

Alfresco version 4.0.X-4.1.X

Déposez le jar “arender-for-alfresco-4.0-4.1-plugin.jar” dans tomcat/shared/lib

Redémarrer Alfresco.

Alfresco version 4.2.X-6.0.X

Déposez le jar “arender-for-alfresco-4.2-5.0-plugin.jar " dans tomcat/shared/lib

Redémarrer Alfresco.

Vous pouvez voir si le plugin est bien activé à cette adresse:

<votre_url_alfresco>/share/page/modules/deploy

Si ce n’est pas le cas, vérifier dans catalina.properties si les jar de shared/lib sont lus.

Exclusif à ce plugin

Choix de la rendition en fonction du type de document :

Pour choisir les types de fichier qui seront seulement convertis avec la rendition d’Alfresco, ajouter les lignes suivantes dans le fichier <chemin_alfresco>/tomcat/shared/classes/alfresco/web-extension/share-config-custom.xml entre les balises alfresco-config

<config evaluator="string-compare" condition="ArenderExclusion">
        <renditionMimeTypes>{mimeType1},{mimeType2},...,{mimeTypeN}</renditionMimeTypes>
    <!-- exemple : <renditionMimeTypes>"application/msword,image/vnd.dwg,image/x-dwg,image/x-dwf</renditionMimeTypes-->
</config>

Pour choisir les types de fichier qui ne seront pas ouvert dans ARender, ajouter les lignes suivantes dans le fichier <chemin_alfresco>/tomcat/shared/classes/alfresco/web-extension/share-config-custom.xml entre les balises alfresco-config

<config evaluator="string-compare" condition="ArenderExclusion">
        <viewerMimeTypes>{mimeType1},{mimeType2},...,{mimeTypeN}</viewerMimeTypes>
    <!-- exemple : <viewerMimeTypes>"application/msword,image/vnd.dwg,image/x-dwg,image/x-dwf</viewerMimeTypes-->
</config>

Déploiement de l’IHM ARender

Pour déployer ARender dans Alfresco, suivez l’une des section suivantes.

ARender sur le serveur d’Alfresco

  1. Arrêtez le service Alfresco.
  2. Copiez le fichier arondor-arender-hmi-alfresco-<version_arender>.war dans votre dossier <chemin_alfresco>/tomcat/webapps
  3. Renommez le fichier .war en : ARenderHMI.war.
  4. Démarrez le service Alfresco.

ARender sur un serveur séparé

Seulement pour les versions d’Alfresco: 4.2.X-6.0.X

  1. Arrêtez le service Alfresco.

  2. Copiez le fichier arondor-arender-hmi-alfresco-<version_arender>.war dans votre dossier <chemin_server_arender>/webapps

  3. Renommez le fichier .war en à votre convenance (exemple : ARenderHMI.war).

  4. Ajoutez les lignes suivante dans le fichier <chemin_alfresco>/tomcat/shared/classes/alfresco/web-extension/share-config-custom.xml entre les balises alfresco-config

    share-config-custom.xml
    <config evaluator="string-compare" condition="Arender">
        <url>http://{arender_serveur}:{arender_port}/{arender_contexte}</url>
        <!-- exemple : <url>http://192.168.1.8:8080/ARenderHMI</url-->
    </config>
    

  5. Modifiez le nom de d’hôte et le port Alfresco des paramètres arender.server.alfresco.atom.pub.url et arender.server.alfresco.soap.ws.url dans les propriétés d’ARender.

  6. Démarrez le service Alfresco et ARender.

Ouvrir un document

Pour ouvrir un document stocké dans Alfresco :

http://{arender_serveur}:{arender_port}/{ARenderContext}/ARender.html?nodeRef=workspace://SpacesStore/6eb252b8-416b-40ad-a704-5fa39641a211&alf_ticket=TICKET_XXX