Apprendre à connecter les applications de bureau ONLYOFFICE à une GED tierce

ONLYOFFICE

Pour réagir au contenu de cet article, un espace de dialogue vous est proposé sur le forum. Commentez

- Titre : Apprendre à connecter les applications de bureau ONLYOFFICE à une GED tierce

- Auteur : ONLYOFFICE

- Parution : 16 avril 2021

- Licence : Copyright ® 2020 ONLYOFFICE . Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

Sommaire

- I. Introduction

- II. Créer le dossier de la GED

- III. Spécifier les paramètres de l’intégration

- IV. Ajouter des icônes

- V. Rendre la connexion opérationnelle

- VI. Remerciements Developpez.com

I - Introduction

Les applications de bureau ONLYOFFICE, dont le code source est disponible sur GitHub sous les termes de la licence AGPL v.3., permettent de travailler pleinement sur les documents en mode hors connexion ou de passer en mode en ligne en vous connectant au cloud (le cloud ONLYOFFICE, Nextcloud, ownCloud, Seafile) pour coéditer en temps réel les documents qui y sont stockés.

Pour de plus amples informations sur les options d’installation et les aspects fonctionnels de la suite, consultez cet article.

À partir de la dernière version, dont les nouveautés sont présentées ici, vous êtes capable non seulement d’accéder aux documents stockés dans les services nommés ci-dessus, mais aussi de connecter votre solution de GED afin de commencer l’édition ou la rédaction collaborative avec vos collègues.

Pour relier les éditeurs de bureau avec votre propre service web afin d’éditer les fichiers en ligne ou même lancer la rédaction collaborative, suivez les étapes de ce tutoriel.

II - Créer le dossier de la GED

Créez le dossier en indiquant le fournisseur de solution de GED en tant que nom dans le répertoire des fournisseurs (par exemple : onlyoffice). Le chemin vers le dossier dépend de votre système d’exploitation :

Pour Linux : - /opt/onlyoffice/desktopeditors/editors/providers/

Pour Windows : - %ProgramFiles%\ONLYOFFICE\DesktopEditors\providers\

III - Spécifier les paramètres de l’intégration

Créez le fichier de configuration config.json pour spécifier les paramètres de l’intégration qui sont listés ci-dessous :

Nom

Rôle

Type

Exemple

Provider

Définit l’ID du fournisseur qui est utilisé pour se référer aux applications de bureau dans les commandes JavaScript.

string

« onlyoffice »

name

Définit le nom affiché dans la section du choix de service GED lors de l’ajout d’un cloud.

string

« ONLYOFFICE »

check

Définit les paramètres pour vérifier la disponibilité du portail. Lorsque la requête GET est envoyée, la réponse suivante doit s’afficher : HTTP_STATUS_CODE = 200

- url - l’adresse URL utilisée dans la requête,
type : string,
exemple : « status.php »;

- headers - les en-têtes ajoutés à la requête ajax,
type : object,
exemple : {« OCS-APIREQUEST »: true}.

object

editorPage

Définit l’URL relative qui indique le type du fichier qui s’ouvre en tant qu’un document.
Note :
pour ce paramètre, vous pouvez aussi utiliser les expressions régulières, par exemple : « regex:\/lib\/(?:[\w-]{32,})\/file\/ ».

string

« /apps/onlyoffice/ »

startPage

Définit l’URL relative ajoutée à l’adresse IP ou au domaine lors de la création d’une nouvelle connexion.

string

« / »

icons

Définit les icônes pour les portails :

- connectionsList - le chemin d’accès vers l’icône pour la liste des connexions,

type : string,
exemple :
« ./assets/listicon.svg »;

- buttonLogo - le chemin d’accès vers l’icône du bouton du fournisseur sur la page de connexion lorsque la liste du portail est vide.
type : string,
exemple : « ./assets/buttonlogo.svg ».

object

Voici l’exemple de code que vous pouvez utiliser pour relier les éditeurs de bureau avec votre logiciel de GED :

1. {

2. "provider": "nextcloud",

3. "name" : "Nextcloud",

4. "check": {

5. "url": "status.php",

6. "headers": {

7. "OCS-APIREQUEST": true

8. }

9. },

10. "editorPage" : "/apps/onlyoffice/",

11. "startPage" : "/",

12. "cryptoSupport" : true,

13. "icons" : {

14. "connectionsList" :  "./assets/listicon.svg",

15. "buttonLogo" : "./assets/buttonlogo.svg"

16. }

17. }

IV - Ajouter des icônes

Créez deux icônes pour la page de l’application et ajoutez-les dans le dossier dédié du fichier de configuration config.json :

1. une icône pour la liste des connexions disponibles. La taille requise est 36 sur 36 :

2. une icône pour le bouton du fournisseur de service pour la page de connexion si la liste des clouds connectés est vide. La taille requise est 148 sur 38 :

Les formats d’image supportés sont .png, .jpeg, .svg. Nous suggérons d’utiliser les fichiers .svg

pour assurer un affichage correct sur les écrans HiDPI avec la mise à l’échelle à 200 %.

V - Rendre la connexion opérationnelle

Lancez les applications de bureau ONLYOFFICE ou redémarrez-les si besoin et passez la section « Se connecter au cloud » afin de vérifier que la GED a été bien connectée et que tout fonctionne correctement.

En suivant cette démarche, vous allez ajouter un bouton de votre logiciel de GED dans la section
« Connecter au cloud » pour y accéder depuis l’interface des éditeurs de bureau ONLYOFFICE. Pour ouvrir les documents, les modifier ou lancer la collaboration, il vous faudra faire quelques ajustements dans votre GED.

VI - Remerciements Developpez.com

Nous tenons à remercier Malick pour la mise au gabarit et escartefigue pour la relecture orthographique.