Jira

Ajouter le connecteur à partir de Atlassian Marketplace

1. Connectez-vous à votre instance Jira Software en tant qu'administrateur.
2. Cliquez sur l'icône Administration dans le coin supérieur droit et choisissez l'option Manage apps (Gérer les applications) du menu.
   
3. Le panneau Find new apps (Rechercher de nouvelles applications) s'affiche. Cliquez sur le champ Search the Marketplace (Rechercher sur Marketplace) et saisissez Jira ONLYOFFICE integration app (Application d'intégration Jira ONLYOFFICE).
4. Cliquez sur le bouton Install (Installer) pour télécharger et installer l'application.

Ajouter le connecteur compilé à partir du code source

Premièrement, il vous faut installer les éléments prérequis afin de pouvoir compiler le connecteur ONLYOFFICE pour Jira:

• 1.8.X Oracle Java SE Development Kit 8
• Atlassian Plugin SDK

Pour compiler le connecteur ONLYOFFICE pour Jira, procédez comme suit:

1. Clonez le référentiel onlyoffice-jira:

   git clone https://github.com/ONLYOFFICE/onlyoffice-jira.git

2. Accédez au référentiel onlyoffice-jira.

   cd onlyoffice-jira

3. Exécutez la commande suivante:

   atlas-package

   Attendez que la compilation du connecteur soit terminé. Une fois compilé, le connecteur se trouvera dans le dossier target.

Vous pouvez télécharger le connecteur compilé sur votre page Jira Software Administration -> Manage Apps (Administration du logiciel Jira -> Gestion des applications).

1. Connectez-vous à votre instance Jira Software en tant qu'administrateur.
2. Cliquez sur l'icône Administration dans le coin supérieur droit et choisissez l'option Manage apps (Gérer les applications) du menu.
3. Sélectionnez la rubrique Manage apps (Gérer les applications) à gauche de la page.
4. Cliquez sur Upload app (Télécharger l'application).
5. Cliquez sur le bouton Choose File (Choisir un fichier), parcourez pour rechercher le fichier compilé target/onlyoffice-jira-app.jar et cliquez sur Upload (Télécharger). Attendez que l'installation de l'application soit terminée.
   

Configurer le connecteur ONLYOFFICE pour Jira

Cliquez sur le bouton Configure (Configurer) au-dessous de Jira ONLYOFFICE integration app (Application d'intégration Jira ONLYOFFICE) sur la page Manage apps (Gérer les applications) ou recherchez l'application sous la rubrique OTHER (AUTRE) sur la page Manage apps (Gérer les applications).

Serveur de documents

1. Dans le champ Document Editing Service address (Adresse du service de modification des documents), indiquez l'adresse IP ou le nom d'hôte du serveur sur lequel ONLYOFFICE Docs est installé.
   L'adresse d'ONLYOFFICE Docs doit être accessible sur Jira et l'adresse de Jira doit être accessible sur ONLYOFFICE Docs.
2. Disable certificate verification (insecure) (Désactiver la vérification du certificat (non sécurisé) - activez cette option pour désactiver la vérification du certificat et autoriser Jira à établir une connexion avec ONLYOFFICE Docs si vous utilisez un certificat auto-signé. C'est une solution non sécurisée et nous vous recommandons vivement de remplacer ce certificat par un autre émis par une l'autorité de certification.
3. Indiquez Secret key (Clé secrète) - la clé secrète pour valider le jeton JSON dans la requête à ONLYOFFICE Docs.
   À partir de la version de ONLYOFFICE Docs v.7.2, JWT est activé par défaut et la clé secrète est générée automatiquement. Il vous faut également activer la validation du jeton du côté Jira: recherchez votre clé secrète dans le fichier de configuration ONLYOFFICE Docs, ensuite indiquez la même clé secrète dans les paramètres du connecteur. Pour en savoir plus, consulter la section Activer le jeton JWT de cet article.
4. Authorization header (En-tête d'autorisation) (laisser vide pour utiliser l'en-tête par défaut) - l'en-tête d'autorisation JWT utilisé dans ONLYOFFICE est Authorization. Si cet en-tête entre en conflit avec votre configuration, vous pouvez le remplacer par un en-tête personnalisé.
5. Connect to demo ONLYOFFICE Document Server (Se connecter au serveur de démonstration ONLYOFFICE Document Server) - lancer un serveur de test.
   ImportantIl s'agit d'un serveur de test public disponible pendant une période de 30 jours. Ne partagez pas vos données sensibles sur ce serveur.

Paramètres avancés du serveur

La rubrique Advanced server settings (Paramètres avancés du serveur) peut être utilisé lorsque la configuration de votre réseau ne permet pas d'exécuter les demandes entre le logiciel Jira et ONLYOFFICE Docs via des adresses publiques. Indiquez les adresses pour des demandes internes dans les champs appropriés:

1. Server address for internal requests from the Document Editing Service (Adresse du serveur pour les requêtes internes depuis le service de modification de documents) - adresse du serveur Jira Software pour les requêtes internes depuis ONLYOFFICE Docs.
2. Document Editing Service address for internal requests from the server - (Adresse du service de modification de documents pour les requêtes internes depuis le serveur) - adresse ONLYOFFICE Docs pour les requêtes internes depuis le serveur Jira Software.

Paramètres communs

1. Editable formats (Formats modifiables) - cochez la case en regard des formats pris en charge par votre environnement Jira.

   Une perte de données peut survenir lors de l'enregistrement dans les formats spécifiés en raison des restrictions de format.

2. Editor interface (Interface de l'éditeur) - personnalisez l'interface des éditeurs:
   • Display Chat menu button (Afficher le bouton du menu Chat) - masquer/afficher l'icône Chaten ligne intégré dans le panneau de gauche.
   • Display the header more compact (Afficher l'en-tête de manière plus compacte) - masquer/afficher le texte des icônes dans la barre d'outils supérieure.
   • Display Feedback & Support menu button (Afficher le bouton du menu Commentaires et assistance) - masquer/afficher le bouton Commentaires et assistance dans le panneau de gauche.
   • Display Help menu button (Afficher le bouton du menu Aide) - masquer/afficher le bouton Aide dans le panneau de gauche.
   • Display monochrome toolbar header (Afficher l'en-tête de la barre d'outils en monochrome) - passer la barre d'outils supérieure en palette de couleurs monochrome.

Sécurité

1. Enable plugins (Activer les modules complémentaires) - activer/désactiver la prise en charge des modules complémentaires dans les éditeurs.
2. Run document macros(Exécuter les macros du document) - activer/désactiver l'exécution des macros dans les éditeurs.
3. Enable document protection for (Activer la protection des documents pour) - choisissez si vous souhaitez autoriser tous les utilisateurs à activer la protection par mot de passe des documents, ou uniquement le propriétaire du document.

Cliquez sur Save (Enregistrer) pour valider la configuration.

Comment cela fonctionne

L'intégration ONLYOFFICE suit l'API disponible ici.

1. L'utilisateur doit passer aux pièces jointes Jira et sélectionner l'action Edit in ONLYOFFICE (Modifier dans ONLYOFFICE).
2. Jira envoie une requête vers OnlyOfficeEditorServlet (URL du formulaire: /plugins/servlet/onlyoffice/doceditor?attachmentId=$attachment.id).
3. Jira envoie le document vers le stockage de documents ONLYOFFICE et reçoit un lien temporaire.
4. Jira prépare un objet JSON ayant les caractéristiques suivantes:
   • url - le lien temporaire utilisé par ONLYOFFICE Docs pour télécharger le document;
   • callbackUrl - l'adresse URL utilisée par ONLYOFFICE Docs pour informer sur l'état de l'édition du document;
   • docserviceApiUrl - l'adresse URL envoyée par le client à ONLYOFFICE Docs (fourni par ifiles.docservice.url.api );
   • key - UUID à informer ONLYOFFICE Docs s'il faut télécharger le document encore une fois;
   • title - le titre de document (nom).
5. Jira prend cet objet pour construire une page à partir d'un modèle Freemarker et remplit toutes les valeurs pour que le navigateur du client puisse télécharger l'éditeur.
6. Le navigateur du client envoie une requête vers la bibliothèque JavaScript depuis ONLYOFFICE Docs et la configuration DocEditor vers ONLYOFFICE Docs avec les caractéristiques ci-dessous.
7. Ensuite, ONLYOFFICE Docs charge le document depuis le stockage de documents et l'utilisateur commence la rédaction.
8. Lorsque tous les utilisateurs et navigateurs clients ont terminé la rédaction, la fenêtre d'édition est fermée.
9. Après 10 secondes d'inactivité, ONLYOFFICE Docs envoie une requête POST vers callbackUrl pour notifier Jira que tous les clients ont terminé l'édition et ont fermé le document.
10. Le document avec toutes modifications est enregistré en tant que nouvelle pièce jointe avec une notation suffixée ajoutée au nom du fichier.

Activer JWT

Afin de protéger des documents contre un accès non autorisé, les éditeurs ONLYOFFICE utilisent le jeton JSON (JWT). Le jeton est ajouté à la configuration lorsque l'éditeur de documents est initialisé et l'échange de commandes entre les services internes de ONLYOFFICE Docs est effectué. La clé secrète est utilisée pour signer le jeton web JSON et valider le jeton sur requête à ONLYOFFICE Docs.

À partir de la version de ONLYOFFICE Docs v.7.2, JWT est activé par défaut et la clé secrète est générée automatiquement. Il vous faut rechercher votre clé secrète dans le fichier de configuration ONLYOFFICE Docs, ensuite indiquez la même clé secrète dans les paramètres du connecteur.

Étape 1: Recherchez votre clé secrète dans le fichier de configuration ONLYOFFICE Docs

1. Ouvrez le fichier local.json avec tout éditeur de texte disponible:
   • Sous Linux - /etc/onlyoffice/documentserver/local.json
   • Sous Windows - %ProgramFiles%\ONLYOFFICE\DocumentServer\config\local.json
   • Sous Docker: accédez au conteneur ONLYOFFICE Docs utilisant docker exec -it <containerID> bash et ouvrez /etc/onlyoffice/documentserver/local.json.

     Vous pouvez également utiliser la commande suivante pour rechercher la clé secrète par défaut et sans ouvrir le fichier local.json:

     sudo docker exec <containerID> /var/www/onlyoffice/documentserver/npm/json -f /etc/onlyoffice/documentserver/local.json 'services.CoAuthoring.secret.session.string'

   Le fichier local.json doit ressembler à ceci:

   { "services": { "CoAuthoring": { "token": { "enable": { "request": { "inbox": true, "outbox": true }, "browser": true } }, "secret": { "inbox": { "string": "yoursecret" }, "outbox": { "string": "yoursecret" }, "session": { "string": "yoursecret" } } } } }

2. La valeurtrue est spécifiée dans trois sections, ce qui signifie que la validation du jeton est activée:
   • services.CoAuthoring.token.enable.browser
   • services.CoAuthoring.token.enable.request.inbox
   • services.CoAuthoring.token.enable.request.outbox
3. La clé secrète qui a été généré automatiquement figure dans trois sections. Vous pouvez remplacer la valeur par défaut par votre clé secrète - celle-ci doit être identique dans les trois sections:
   • services.CoAuthoring.secret.inbox.string
   • services.CoAuthoring.secret.outbox.string
   • services.CoAuthoring.secret.session.string
4. Si vous apportez des modifications, enregistrez-les et redémarrez les services:

   supervisorctl restart all

Étape 2: Indiquez la même clé secrète dans la configuration du connecteur.

Dans la configuration du connecteur, indiquez la même clé secrète dans le champ Secret key (Clé secrète) et enregistrez les paramètres.

Se connecter à la version démo ONLYOFFICE Docs

À partir de la version 2.0.0 du connecteur ONLYOFFICE, il est possible d'essayer les éditeurs ONLYOFFICE en ligne au sein de Jira sans installer ONLYOFFICE Docs.

Pour activer la connexion, sélectionnez l'option Connect to demo ONLYOFFICE Document Server (Se connecter à la version démo du serveur ONLYOFFICE Docs) et cliquez sur le bouton Save (Enregistrer).