Partager via


Résoudre les problèmes liés aux modules complémentaires de signalement d'événements et de spams

Lorsque vous développez votre complément basé sur les événements ou la création de rapports de courrier indésirable , vous pouvez rencontrer des problèmes, tels que le fait que votre complément ne se charge pas ou qu’un événement ne se produit pas. Les sections suivantes fournissent des conseils sur la façon de résoudre les problèmes de votre complément.

Passer en revue les prérequis des fonctionnalités

Vérifier la configuration requise pour le manifeste et JavaScript

  • Vérifiez que les conditions suivantes sont remplies dans le manifeste de votre complément.

    • Vérifiez que l’URL de l’emplacement du fichier source de votre complément est disponible publiquement et n’est pas bloquée par un pare-feu. Cette URL est spécifiée dans l’élément SourceLocation du manifeste de complément uniquement ou la "extensions.runtimes.code.page" propriété du manifeste unifié pour Microsoft 365.

    • Vérifiez que l’élément <Runtimes> (manifeste de complément uniquement) ou "extensions.runtimes.code" la propriété (manifeste unifié) référence correctement le fichier HTML ou JavaScript contenant les gestionnaires d’événements. Outlook classique sur Windows et d’autres applications Office windows utilisent le fichier JavaScript pendant l’exécution, tandis que Office sur le Web, la nouvelle interface utilisateur Outlook Mac et la nouvelle version d’Outlook sur Windows utilisent le fichier HTML. Pour obtenir un exemple de configuration dans le manifeste, consultez la section « Configurer le manifeste » de Définir automatiquement l’objet d’un nouveau message ou d’un nouveau rendez-vous.

      Pour les clients Windows (à l’exception des nouveaux outlook sur Windows), vous devez regrouper tout votre code JavaScript de gestion des événements dans ce fichier JavaScript référencé dans le manifeste. Notez qu’un ensemble JavaScript volumineux peut entraîner des problèmes de performances de votre complément. Nous vous recommandons de prétraiter les opérations lourdes afin qu’elles ne soient pas incluses dans votre code de gestion des événements.

  • Pour les clients Windows (à l’exception des nouveaux outlook sur Windows), lorsque la fonction JavaScript spécifiée dans le manifeste pour gérer un événement s’exécute, le code dans Office.onReady() et Office.initialize n’est pas exécuté. Nous vous recommandons d’ajouter aux gestionnaires d’événements toute logique de démarrage requise par les gestionnaires d’événements, comme la vérification de la version du client de l’utilisateur.

  • Vérifiez que votre fichier JavaScript de gestion des événements appelle Office.actions.associate. Cela garantit que le nom du gestionnaire d’événements spécifié dans le manifeste est mappé à son équivalent JavaScript. Voici un exemple de code.

    Office.actions.associate("onNewMessageComposeHandler", onNewMessageComposeHandler);
    
  • Dans les versions classiques d’Outlook sur Windows antérieures à la version 2403 (build 17425.20000), le code JavaScript des compléments de création de rapports de courrier indésirable et basés sur les événements prend uniquement en charge les spécifications ECMAScript 2016 et antérieures. Voici quelques exemples de syntaxe de programmation à éviter.

    • Évitez d’utiliser des async instructions et await dans votre code. L’inclusion de ces éléments dans votre code JavaScript entraîne l’expiration du délai d’attente du complément.
    • Évitez d’utiliser l’opérateur conditionnel (ternaire), car il empêchera le chargement de votre complément.

    Si votre complément n’a qu’un seul fichier JavaScript référencé par Outlook sur le web, sur Windows (nouveau et classique) et sur Mac, vous devez limiter votre code à ECMAScript 2016 pour vous assurer que votre complément s’exécute dans les versions antérieures d’Outlook classique sur Windows. Toutefois, si vous avez un fichier JavaScript distinct référencé par Outlook sur le web, sur Mac, les versions récentes d’Outlook classique sur Windows et la nouvelle version d’Outlook sur Windows, vous pouvez implémenter une spécification ECMAScript ultérieure dans ce fichier.

Vérifier la configuration de votre webpack

Sur les clients Windows (à l’exception du nouvel Outlook sur Windows), si votre complément basé sur les événements utilise webpack pour regrouper des fichiers et que les gestionnaires d’événements ne s’exécutent jamais, configurez le serveur de développement webpack de votre complément pour qu’il serve les fichiers statiques. Cette approche empêche webpack d’ajouter du code aux fichiers de votre complément qui peut être incompatible avec le runtime JavaScript. Configurez votre complément pour utiliser des fichiers statiques comme suit :

  1. Dans le webpack.config.js fichier de votre complément, importez le module Node.js path .

    const path = require("path");
    
  2. Dans le même fichier, configurez le serveur de développement webpack pour qu’il serve les fichiers statiques à partir du dist dossier .

    ...
    devServer: {
      static: {
        directory: path.join(__dirname, "dist"),
        publicPath: "/public",
      },
      ...
    }
    ...
    
  3. Exécutez npm run build.

  4. Dans le manifeste de votre complément, mettez à jour le chemin du fichier JavaScript de gestion des événements pour référencer le fichier généré servi à partir du répertoire statique. Par exemple : https://localhost:3000/public/launchevent.js.

Déboguer votre complément

  • Lorsque vous apportez des modifications à votre complément, n’oubliez pas que :

    • Si vous mettez à jour le manifeste, supprimez le complément, puis rechargez-le. Pour plus d’informations sur la suppression d’un complément chargé de manière indépendante d’Outlook, voir Charger une version test des compléments Outlook à des fins de test. Si vous utilisez Outlook sur Windows, vous devez également fermer et rouvrir Outlook.
    • Si vous apportez des modifications à des fichiers autres que le manifeste, fermez et rouvrez le client Office sur Windows ou sur Mac, ou actualisez l’onglet du navigateur en exécutant Office sur le Web.
    • Si vous ne parvenez toujours pas à voir vos modifications après avoir effectué ces étapes, effacez votre cache Office.
  • Lorsque vous testez votre complément dans Office sur Windows (à l’exception du nouvel Outlook sur Windows) :

    • Pour les compléments basés sur des événements, case activée observateur d'événements pour toutes les erreurs de complément signalées.

      1. Dans observateur d'événements, sélectionnezApplicationjournaux> Windows.
      2. Dans le panneau Actions , sélectionnez Filtrer le journal actuel.
      3. Dans la liste déroulante Journalisation , sélectionnez la période de journalisation de votre choix.
      4. Cochez la case Erreur .
      5. Dans le champ ID d’événement , entrez 63.
      6. Sélectionnez OK pour appliquer vos filtres.

      Exemple de paramètres de filtre du journal actuel de observateur d'événements configurés pour afficher uniquement les erreurs Outlook avec l’ID d’événement 63 qui se sont produites au cours de la dernière heure.

    • Vérifiez que le fichier bundle.js est téléchargé dans le dossier suivant dans Explorateur de fichiers. Le texte placé dans [] représente vos informations Office et complément applicables.

      %LOCALAPPDATA%\Microsoft\Office\16.0\Wef\{[Office profile GUID]}\[Office account encoding]\Javascript\[Add-in ID]_[Add-in Version]_[locale]
      

      Conseil

      • Pour plus de lisibilité, cet article fait référence au nom de fichier en tant que bundle.js, mais le nom exact dépend de l’application Office.
        • Excel : bundle_excel.js
        • Outlook : bundle.js.
        • PowerPoint : bundle_powerpoint.js
        • Word : bundle_word.js
      • Il n’existe aucune méthode directe pour déterminer le GUID de profil Office et l’encodage de compte utilisés dans le chemin d’accès au fichierbundle.js . L’approche la plus efficace pour localiser le fichier bundle.js de votre complément consiste à inspecter manuellement chaque dossier jusqu’à ce que vous localisiez le dossier Javascript qui contient l’ID de votre complément.
      • Le fichier bundle.js est téléchargé dans le dossier Wef local lors de la première installation du complément. Il est actualisé chaque fois que l’application Office démarre ou redémarre. Si le fichier bundle.js n’apparaît pas dans le dossier Wef et que votre complément est installé ou chargé de manière indépendante, redémarrez Office. Pour Outlook, vous devrez peut-être supprimer votre complément, puis le charger à nouveau.
  • Lorsque vous testez votre complément sur les clients de bureau (à l’exception des nouveaux Outlook sur Windows), activez la journalisation du runtime pour identifier les éventuels problèmes d’installation du manifeste et du complément. Pour obtenir des conseils sur l’utilisation de la journalisation du runtime, consultez Déboguer votre complément avec la journalisation du runtime.

  • Définissez des points d’arrêt dans votre code pour déboguer votre complément. Pour obtenir des instructions spécifiques à la plateforme, consultez Déboguer les compléments basés sur les événements et les rapports de courrier indésirable.

Demander de l’aide supplémentaire

Si vous avez toujours besoin d’aide après avoir effectué les étapes de résolution des problèmes recommandées, ouvrez un problème GitHub. Incluez des captures d’écran, des enregistrements vidéo ou des journaux d’exécution pour compléter votre rapport.

Voir aussi