Debuggen Ihres ereignisbasierten outlook-Add-Ins oder Spam-Berichterstellung

In diesem Artikel werden die wichtigsten Debugphasen zum Aktivieren und Festlegen von Breakpoints in Ihrem Code erläutert, wenn Sie die ereignisbasierte Aktivierung oder integrierte Spamberichterstattung in Ihrem Add-In implementieren. Bevor Sie fortfahren, empfiehlt es sich, den Leitfaden zur Problembehandlung zu lesen, um weitere Schritte zum Beheben von Entwicklungsfehlern zu erhalten.

Um mit dem Debuggen zu beginnen, wählen Sie die Registerkarte für Den entsprechenden Client aus.

Web

Verwenden Sie die Entwicklertools Ihres bevorzugten Browsers, um Ihr ereignisbasiertes Add-In in Outlook im Web zu debuggen. Weitere Informationen finden Sie unter Debuggen von Add-Ins in Office im Web.

Windows (neu)

Um Ihr Add-In in einem neuen Outlook auf Windows-Desktopclient (Vorschau) zu debuggen, müssen Sie den folgenden Befehl ausführen, um Microsoft Edge DevTools zu öffnen.

olk.exe --devtools

Weitere Informationen finden Sie im Abschnitt "Debuggen Ihres Add-Ins" unter Entwickeln von Outlook-Add-Ins für das neue Outlook unter Windows.

Windows (klassisch)

Wenn Sie den Yeoman-Generator für Office-Add-Ins verwendet haben, um Ihr Add-In-Projekt zu erstellen (z. B. durch Ausführen einer exemplarischen Vorgehensweise für eine ereignisbasierte Aktivierung), befolgen Sie die Option Mit Yeoman-Generator erstellt in diesem Artikel. Führen Sie andernfalls die Anderen Schritte aus. Visual Studio Code sollte mindestens Version 1.56.1 aufweisen.

Markieren Des Add-Ins zum Debuggen und Festlegen des Debuggerports

1. Rufen Sie die ID Ihres Add-Ins aus dem Manifest ab.

   • Nur Add-In-Manifest: Verwenden Sie den Wert des <untergeordneten Id-Elements> des OfficeApp-Stammelements<>.
   • Einheitliches Manifest für Microsoft 365: Verwenden Sie den Wert der Eigenschaft "id" des anonymen { ... } Stammobjekts.

2. Erstellen Sie einen Registrierungswert DWORD namens UseDirectDebugger in HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Wef\Developer\[Add-in ID]. Ersetzen Sie durch [Add-in ID] die ID Ihres Add-Ins aus dem Manifest.

   Hinweis

   Wenn der Developer Schlüssel (Ordner) noch nicht unter HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\WEF\vorhanden ist, führen Sie die folgenden Schritte aus, um ihn zu erstellen.

   1. Klicken Sie mit der rechten Maustaste auf den WEF-Schlüssel (Ordner), und wählen Sie Neuer>Schlüssel aus.
   2. Nennen Sie den neuen Schlüssel Entwickler.

   Mit Yeoman-Generator erstellt: Navigieren Sie in einem Befehlszeilenfenster zum Stammverzeichnis Ihres Add-In-Ordners, und führen Sie dann den folgenden Befehl aus.

   npm start
   

   Zusätzlich zum Erstellen des Codes und Starten des lokalen Servers legt dieser Befehl die UseDirectDebugger DWORD-Registrierungswertdaten für dieses Add-In auf fest 1.

   Sonstiges: Legen Sie im HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\WEF\Developer\[Add-in ID]\UseDirectDebugger DWORD-Registrierungswert, wobei [Add-in ID] die ID Ihres Add-Ins aus dem Manifest ist, die Wertdaten auf 1fest.

3. Erstellen Sie im Registrierungsschlüssel HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Wef\Developer\[Add-in ID], wobei [Add-in ID] die ID Ihres Add-Ins aus dem Manifest ist, einen neuen DWORD Wert mit der folgenden Konfiguration.

   • Wertname: DebuggerPort
   • Wertdaten (hexadezimal): 00002407

   Dadurch wird der Debuggerport auf 9223festgelegt.

4. Starten Sie Outlook, oder starten Sie es neu, wenn es bereits geöffnet ist.

5. Führen Sie die Aktion aus, um das Ereignis zu initiieren, für das Sie entwickeln, z. B. erstellen Sie eine neue Nachricht, um das OnNewMessageCompose Ereignis zu initiieren, oder melden Sie Spamnachrichten. Das Dialogfeld Ereignisbasierter Debughandler sollte angezeigt werden. Interagieren Sie noch nicht mit dem Dialogfeld.

   

Konfigurieren von Visual Studio Code

Erstellt mit dem Yeoman-Generator

1. Führen Sie im Befehlszeilenfenster Folgendes aus, um Das Add-In-Projekt in Visual Studio Code zu öffnen.

   code .
   

2. Öffnen Sie in Visual Studio Code die Datei ./.vscode/launch.json , und fügen Sie der Liste der Konfigurationen den folgenden Auszug hinzu. Speichern Sie Ihre Änderungen.

   {
     "name": "Direct Debugging",
     "type": "node",
     "request": "attach",
     "port": 9223,
     "timeout": 600000,
     "trace": true
   }
   

Andere

1. Erstellen Sie einen neuen Ordner namens Debugging (möglicherweise in Ihrem Desktopordner ).

2. Öffnen Sie Visual Studio Code.

3. Wechseln Sie zu Datei>Ordner öffnen, navigieren Sie zu dem Ordner, den Sie gerade erstellt haben, und wählen Sie dann Ordner auswählen aus.

4. Klicken Sie auf der Aktivitätsleiste auf Ausführen und Debuggen (STRG+UMSCHALT+D).

   

5. Wählen Sie den Link launch.json Datei erstellen aus.

   

6. Wählen Sie in der Dropdownliste Umgebung auswählendie Option Edge: Starten aus, um eine launch.json-Datei zu erstellen.

7. Fügen Sie der Liste der Konfigurationen den folgenden Auszug hinzu. Speichern Sie Ihre Änderungen.

   {
     "name": "Direct Debugging",
     "type": "node",
     "request": "attach",
     "port": 9223,
     "timeout": 600000,
     "trace": true
   }
   

Anfügen des Debuggers

Die bundle.js-Datei eines Add-Ins enthält den JavaScript-Code Ihres Add-Ins. Es wird erstellt, wenn das klassische Outlook unter Windows geöffnet wird. Wenn Outlook gestartet wird, wird die bundle.js-Datei jedes installierten Add-Ins im Wef-Ordner Ihres Computers zwischengespeichert.

1. Navigieren Sie zum folgenden Ordner in Explorer, um die bundle.js-Datei des Add-Ins zu suchen. Ersetzen Sie den in [] eingeschlossenen Text durch Ihre entsprechenden Outlook- und Add-In-Informationen.

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

   Tipp

   Wenn die bundle.js-Datei nicht im Ordner Wef angezeigt wird, versuchen Sie Folgendes:

   • Wenn Ihr Add-In installiert oder quergeladen ist, starten Sie Outlook neu.
   • Entfernen Sie Ihr Add-In aus Outlook, und laden Sie es dann erneut quer.

2. Öffnen Sie bundle.js in Visual Studio Code.

3. Platzieren Sie Haltepunkte in bundle.js , an der der Debugger beendet werden soll.

4. Wählen Sie in der Dropdownliste DEBUGGENdie Option Direktes Debuggen und dann das Symbol Debuggen starten aus.

   

Ausführen des Debuggers

1. Nachdem Sie bestätigt haben, dass der Debugger angefügt ist, kehren Sie zu Outlook zurück, und wählen Sie im Dialogfeld Ereignisbasierten Handler debuggendie Option OK aus.

2. Sie können jetzt Ihre Breakpoints in Visual Studio Code erreichen, sodass Sie Ihren ereignisbasierten Aktivierungs- oder Spamberichtscode debuggen können.

Beenden des Debuggers

Um das Debuggen der restlichen Outlook unter Windows-Sitzung zu beenden, wählen Sie im Dialogfeld Ereignisbasierten Handler debuggendie Option Abbrechen aus. Starten Sie Outlook neu, um das Debuggen erneut zu aktivieren.

Um zu verhindern, dass das Dialogfeld Ereignisbasierter Handler debuggen angezeigt wird und das Debuggen für nachfolgende Outlook-Sitzungen beendet wird, löschen Sie den zugeordneten Registrierungsschlüssel, HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Wef\Developer\[Add-in ID]\UseDirectDebuggeroder legen Sie den Wert auf fest 0.

Beenden des lokalen Servers

Wenn Sie den lokalen Webserver beenden und das Add-In deinstallieren möchten, befolgen Sie die entsprechenden Anweisungen:

• Führen Sie den folgenden Befehl aus, um den Server zu beenden. Wenn Sie verwendet haben npm start, sollte auch der folgende Befehl das Add-In deinstallieren.

  npm stop
  

• Wenn Sie das Add-In manuell quergeladen haben, lesen Sie Entfernen eines quergeladenen Add-Ins.

Mac

Ereignisbasierte Add-Ins, die in Outlook auf Mac ausgeführt werden, verwenden die Browserruntime. Aus diesem Gründen können Sie Ihr Add-In mithilfe von Safari Web Inspector debuggen.

1. Um den Safari-Webinspektor in Outlook zu verwenden, führen Sie die Schritte unter Debuggen mit Safari Web Inspector auf einem Mac aus.
2. Öffnen Sie Outlook, und laden Sie ihr Add-In quer.
3. Führen Sie eine Aktion aus, die das Ereignis initiiert, das Ihr Add-In behandelt. Erstellen Sie beispielsweise eine neue Nachricht, um das OnNewMessageCompose Ereignis zu initiieren. Dadurch wird ein leeres Entwicklerfenster geöffnet. Der Name des Add-Ins wird in der Titelleiste des Fensters angezeigt.
4. Klicken Sie mit der rechten Maustaste auf eine beliebige Stelle im Entwicklerfenster (oder wählen Und halten Sie es gedrückt), und wählen Sie dann Element untersuchen aus. Dadurch wird der Inspektor geöffnet, in dem Sie Haltepunkte festlegen und Ihr Add-In debuggen können.

Siehe auch

• Konfigurieren Ihres Outlook-Add-Ins für die ereignisbasierte Aktivierung
• Implementieren eines integrierten Add-Ins für die Spamberichterstattung
• Problembehandlung bei ereignisbasierten Add-Ins und Spam-Berichts-Add-Ins
• Debuggen des Add-Ins mit Laufzeitprotokollierung