Connecteur Digitech

Installation et configuration du module

Ajouter ce module avec le gestionnaire de modules depuis l'administration technique et redémarrer JPlatform.

Renseigner l'URL de l'API REST Digitech (devant se terminer par /), l'utilisateur et le mot de passe dans les propriétés du module.

Configuration avancée

Chaque endpoint REST utilisé par le module (création/mise à jour/suppression de documents et de pièces jointes, recherche, téléchargement...) est individuellement reconfigurable via une propriété dédiée, pour s'adapter à une évolution de l'API Digitech sans mise à jour du module.

Une fonctionnalité d'administration permet par ailleurs de télécharger un fichier de configuration XML de mapping des types de contenu, accessible depuis l'administration technique.

Format d'échange

Le format d'échange des données avec l'API Digitech est JSON, via des appels REST.

Services de l'API REST Digitech implémentés

Gestion des documents

• Création d'un document : Avec, en option, ses fichiers joints.
• Mise à jour d'un document : Avec, en option, ses fichiers joints. Attention : pour la mise à jour, le rapprochement des fichiers se fait sur leur nom.
• Suppression d'un document : Sans ses fichiers joints, qui doivent être supprimés séparément.

Gestion des pièces jointes

• Création d'une pièce jointe.
• Mise à jour d'une pièce jointe : Attention : le rapprochement se fait sur le nom du fichier.
• Suppression d'une pièce jointe.
• Téléchargement d'une pièce jointe.

Recherche

• Recherche d'un document par son identifiant.
• Comptage du nombre de documents : Via le moteur de recherche Digitech.
• Recherche de documents : Via le moteur de recherche Digitech.
• Recherche étendue de documents : Via le moteur de recherche Digitech, en remontant également les pièces jointes associées.
• Recherche des pièces jointes associées à un document.
• Recherche d'une pièce jointe associée à un document : Avec possibilité de la télécharger directement.

Utilisation de la javadoc

Comment utiliser les différents services

La Javadoc donne l'ensemble des informations nécessaires pour utiliser les services.

Accès à la javadoc : *domaine*/plugins/DigitechPlugin/docs/javadoc/index.html (lien visible depuis la documentation du module).

Propriétés non administrables

# URL de recherche d'un Document par son ID
jcmsplugin.digitech.api-rest.search-document-by-docid.url: rest/document/{0}

# URL de recherche des Attachment avec l'ID d'un Document
jcmsplugin.digitech.api-rest.search-attachment-by-docid.url: rest/attachment/{0}

# URL de recherche d'un Attachment avec son ID et avec l'ID d'un Document
jcmsplugin.digitech.api-rest.search-attachment-by-docid-and-attachmentid.url: rest/attachment/{0}/{1}

# URL du moteur de recherche d'un Document
jcmsplugin.digitech.api-rest.search-document-by-airs.url: rest/search/v2/results

# URL du moteur de recherche d'un Document afin de connaitre le nombre de Document disponible
jcmsplugin.digitech.api-rest.search-document-count-by-airs.url: rest/search/docCount

# URL du moteur de recherche étendue d'un Document
jcmsplugin.digitech.api-rest.extendsearch-document-by-airs.url: rest/extendSearch/results

# URL pour le téléchargement d'un Attachment
jcmsplugin.digitech.api-rest.download-attachment-by-attachmentid.url: rest/attachment/download/{0}

# URL pour la création d'un Document
jcmsplugin.digitech.api-rest.create-document.url: rest/document

# URL pour la mise à jour d'un Document
jcmsplugin.digitech.api-rest.update-document.url: rest/document/{0}

# URL pour la suppression d'un Document
jcmsplugin.digitech.api-rest.delete-document.url: rest/document/{0}

# URL pour la suppression définitive d'un Document
jcmsplugin.digitech.api-rest.delete-definitely-document.url: rest/document/remove/{0}

# URL pour ajouter/modifier des Attachment
jcmsplugin.digitech.api-rest.add-or-update-attachment.url: rest/attachment/{0}

# URL pour la suppression d'un Attachment
jcmsplugin.digitech.api-rest.delete-attachment.url: rest/attachment/{0}/{1}

# URL pour le téléchargement des fichier de configuration XML
jcmsplugin.digitech.api-rest.admin-xml-config-file.url: rest/admin/xmlConfigFile?fileName={0}