IdentifiantMot de passe
Loading...
Mot de passe oublié ?Je m'inscris ! (gratuit)

Vous êtes nouveau sur Developpez.com ? Créez votre compte ou connectez-vous afin de pouvoir participer !

Vous devez avoir un compte Developpez.com et être connecté pour pouvoir participer aux discussions.

Vous n'avez pas encore de compte Developpez.com ? Créez-en un en quelques instants, c'est entièrement gratuit !

Si vous disposez déjà d'un compte et qu'il est bien activé, connectez-vous à l'aide du formulaire ci-dessous.

Identifiez-vous
Identifiant
Mot de passe
Mot de passe oublié ?
Créer un compte

L'inscription est gratuite et ne vous prendra que quelques instants !

Je m'inscris !

Apprendre comment comparer automatiquement deux documents avec l'API ONLYOFFICE Docs

Le , par Daria Lapikhina

21PARTAGES

3  0 
Introduction

Comparer deux versions d’un contrat, d’une spécification ou d’un rapport est une tâche courante. Dans les éditeurs ONLYOFFICE, l’utilisateur lance habituellement la comparaison lui-même depuis le menu Comparer. Mais lorsque votre application sait déjà quels fichiers comparer, cette étape manuelle devient superflue.

Le nouvel exemple « Comparing documents » de l’API Docs, ajouté dans la version 10.0.0 du journal des modifications de la documentation, montre comment ouvrir un document et le comparer à une version révisée dès que l’éditeur est prêt. Les différences s’affichent sous forme de modifications suivies.

Dans ce tutoriel, nous verrons comment fonctionne cet exemple, quels sont les paramètres de la méthode utilisée, comment signer la requête lorsque JWT est activé, et comment comparer des documents côté serveur avec ONLYOFFICE Document Builder.


Présentation de l’exemple

L’exemple ouvre un fichier .docx en mode lecture dans l’éditeur de documents texte (Document Editor). Dès que le document est chargé, la comparaison avec le fichier révisé démarre d’elle-même, sans que l’utilisateur clique sur Comparer.

Il repose sur deux éléments de l’API Docs :

  • onDocumentReady — événement appelé lorsque le document est chargé dans l’éditeur ;
  • setRequestedDocument() — méthode qui sélectionne un document pour la comparaison, la fusion ou l’insertion de texte.

Ce scénario convient aux flux que votre application contrôle : relecture d’une nouvelle révision, écran d’approbation, vérification d’un fichier par rapport à sa version précédente.

Prérequis

  • une instance ONLYOFFICE Docs intégrée à votre application avec le constructeur DocsAPI.DocEditor ;
  • le fichier d’origine et le fichier révisé, accessibles par URL ;
  • le secret JWT utilisé pour signer la configuration de l’éditeur, si JWT est activé sur le serveur de documents.

Mettre en place la comparaison automatique

Ouvrir le fichier d’origine en mode lecture

La configuration de l’éditeur pointe vers le fichier d’origine et définit editorConfig.mode sur view :
Code : Sélectionner tout
1
2
3
4
5
6
7
8
9
10
11
12
const config = {
  document: {
    fileType: "docx",
    key: "original-key",
    title: "original.docx",
    url: "https://example.com/original.docx",
  },
  documentType: "word",
  editorConfig: {
    mode: "view",
  },
};
Remplacez les valeurs d’exemple de key, title et url par celles de votre fichier d’origine.

Demander le fichier révisé dans onDocumentReady

Lorsque l’éditeur déclenche l’événement onDocumentReady, l’exemple appelle setRequestedDocument() avec le type compare et l’URL du fichier révisé :

Code : Sélectionner tout
1
2
3
4
5
6
7
8
9
10
11
12
config.events = {
  onDocumentReady() {
    docEditor.setRequestedDocument({
      c: "compare",
      fileType: "docx",
      url: "https://example.com/revised.docx",
      token: "<token>",
    });
  },
};

const docEditor = new DocsAPI.DocEditor("placeholder", config);
Comme onDocumentReady est appelé une fois le document chargé, le fichier révisé n’est transmis qu’après l’ouverture complète du fichier d’origine.

Paramètres de setRequestedDocument()

Paramètre Présence Description
c Obligatoire Type de sélection : compare, combine ou insert-text (par défaut compare)
fileType Obligatoire Type du document : doc, docm, docx, dot, dotm, dotx, epub, fodt, odt, ott, rtf, wps
url Obligatoire URL absolue du document révisé
token Facultatif Signature chiffrée sous forme de jeton

Signer la requête avec JWT

Si JWT est activé sur le serveur de documents, signez l’objet transmis à setRequestedDocument() avec le même secret que la configuration de l’éditeur, puis placez le jeton obtenu dans token.

Attention : si vous utilisez des liens locaux, ajoutez un jeton, sinon une erreur se produira.

Différence avec le flux standard

Habituellement, setRequestedDocument() est appelée dans le gestionnaire de l’événement onRequestSelectDocument : l’utilisateur ouvre le menu Comparer, clique sur Document from Storage, puis l’application lui fait choisir un fichier. L’exemple supprime cette étape et appelle la méthode directement après onDocumentReady.

Comment utiliser l’exemple dans ONLYOFFICE Docs

1. Ajoutez la configuration de l’éditeur à votre page.
2. Ajoutez le gestionnaire `onDocumentReady` et indiquez l’URL du fichier révisé.
3. Générez sur votre serveur le jeton de l’objet `setRequestedDocument()` si JWT est activé.
4. Ouvrez la page : le fichier d’origine se charge et les différences apparaissent sous forme de modifications suivies.

Comparer des documents côté serveur

Pour comparer des documents sans ouvrir d’éditeur, utilisez la méthode CompareDocuments d’ONLYOFFICE Document Builder. Elle nécessite un fichier ouvert avec builderJS.OpenTmpFile, disponible uniquement dans Document Builder :

Code : Sélectionner tout
1
2
3
4
5
6
builderJS.OpenFile("file1.docx");
const file = builderJS.OpenTmpFile("file2.docx");
Api.CompareDocuments(file);
file.Close();
builderJS.SaveFile("docx", "Result.docx");
builderJS.CloseFile();


Le script utilise builderJS, car la méthode OpenTmpFile n’est disponible que sur cet objet. Le fichier obtenu contient les différences sous forme de modifications suivies.

Conclusion

L’exemple « Comparing documents » montre que setRequestedDocument() ne se limite pas au gestionnaire onRequestSelectDocument : appelée après onDocumentReady, elle permet d’afficher les différences entre deux versions dès l’ouverture du document, sans action de l’utilisateur.

Associée à la signature JWT et, côté serveur, à la méthode CompareDocuments de Document Builder, cette approche permet d’intégrer la comparaison de documents dans les flux de relecture et d’approbation de vos applications.

Ressources utiles

Exemple « Comparing documents »

Documentation de la méthode setRequestedDocument

Documentation de l’événement onDocumentReady

Signature de setRequestedDocument

Fonctionnement de la comparaison de documents

Méthode CompareDocuments

Comparer des documents avec Document Builder

Dépôt GitHub de la documentation de l’exemple

ONLYOFFICE Docs Developer
Vous avez lu gratuitement 2 497 articles depuis plus d'un an.
Soutenez le club developpez.com en souscrivant un abonnement pour que nous puissions continuer à vous proposer des publications.

Une erreur dans cette actualité ? Signalez-nous-la !