Übung – CLI verwenden, um einen Konnektor herunterzuladen

Abgeschlossen

In dieser Übung verwenden Sie die CLI, um einen Konnektor herunterzuladen, die Definition zu überprüfen und Probleme zu beheben. Diese Übung simuliert, was Sie tun würden, um sich auf das Erstellen und Zertifizieren eines benutzerdefinierten Open Source-Konnektors vorzubereiten.

Für diese Übung müssen Sie Python installieren und auf die Eingabeaufforderung auf dem Computer zugreifen, den Sie für die Übung verwenden.

Wichtig

Verwenden Sie eine Testumgebung mit bereitgestelltem Microsoft Dataverse. Wenn Sie keine haben, können Sie sich für den Community-Plan anmelden.

Hinweis

Laden Sie die folgende Datei auf Ihren lokalen Computer herunter, um diese Übung Contoso Invoicing Triggers abzuschließen. Wählen Sie die Schaltfläche „Herunterladen“ im mittleren rechten Teil des Bildschirms aus.

Aufgabe 1: Die Lösung importieren

In dieser Aufgabe importieren Sie eine nicht verwaltete Lösung, die einen benutzerdefinierten Konnektor für die Contoso Invoicing enthält. Sie verwenden diesen Konnektor, um die Aufgaben in dieser Übung abzuschließen.

  1. Navigieren Sie zum Power Apps Maker Portal, und stellen Sie sicher, dass Sie sich in der richtigen Umgebung befinden.

  2. Wählen Sie Lösungen > Lösung importieren aus.

  3. Wählen Sie Durchsuchen aus.

  4. Wählen Sie die Lösung ContosoInvoicingOpenSource_1_0_0_0.zip und dann Öffnen aus.

  5. Wählen Sie Weiter aus.

  6. Wählen Sie Importieren aus, und warten Sie dann, bis der Import abgeschlossen ist. Nach Abschluss des Imports sollte eine Erfolgsmeldung angezeigt werden.

  7. Öffnen Sie die Lösung Contoso Invoicing - Open Source, die Sie erstellt haben, und öffnen Sie sie.

    Ihnen sollte die benutzerdefinierte Konnektorkomponente Contoso Invoicing - Open Source angezeigt werden.

    Screenshot der Lösungskomponenten in „Contoso Invoicing - Open Source“

Aufgabe 2: Microsoft Power Platform-CLI installieren

Die Microsoft Power Platform-CLI enthält das paconn-Befehlszeilentool, das zur Unterstützung der Entwicklung benutzerdefinierter Konnektoren in Microsoft Power Platform entwickelt wurde. Das paconn-Tool verwendet die Python-Laufzeit, daher installieren Sie auch diese Anwendung.

  1. Navigieren Sie zu Python herunterladen, und wählen Sie Python herunterladen aus. Sie können jede Version höher als 3.5 verwenden.

  2. Wählen Sie die heruntergeladene .exe-Datei aus, um die Installation zu starten.

  3. Aktivieren Sie das Kontrollkästchen Add Python xx to Path (Python xx zum Pfad hinzufügen), wählen Sie Jetzt installieren aus, und warten Sie dann, bis die Installation abgeschlossen ist.

    Screenshot des Dialogfelds „Python installieren“

  4. Schließen Sie den Installationsassistenten, nachdem die Installation abgeschlossen ist.

  5. Starten Sie die Eingabeaufforderung, und führen Sie den folgenden Befehl aus, um paconn zu installieren.

    pip install paconn

    Screenshot der Eingabeaufforderung mit dem Befehl „install paconn“

  6. Warten Sie, bis die Installation abgeschlossen ist.

Aufgabe 3: Den Konnektor lokal herunterladen

In dieser Aufgabe laden Sie die Konnektor-Definitionsdateien lokal herunter, damit Sie die Eigenschaft Host-URL hinzufügen können.

  1. Führen Sie den Anmeldebefehl aus.

    paconn login

  2. Kopieren Sie den bereitgestellten Code.

    Screenshot der Antwort des Anmeldebefehls mit einem zu kopierenden Code

  3. Melden Sie sich in einem Browser mit denselben Anmeldeinformationen wie Ihre Umgebung an. Navigieren Sie zu Microsoft-Geräteanmeldung, fügen Sie den kopierten Code ein, und wählen Sie dann Weiter aus.

  4. Geben Sie Ihre Anmeldeinformationen ein.

  5. Wählen Sie Fortsetzen aus.

    Sie sollten eine Nachricht über die erfolgreiche Anmeldung erhalten.

    Screenshot der Nachricht über die erfolgreiche Anmeldung

  6. Kehren Sie zur Eingabeaufforderung zurück, in der die Meldung „Anmeldung erfolgreich“ angezeigt werden soll.

  7. Führen Sie den Download-Befehl aus.

    paconn download

  8. Wenn Sie aufgefordert werden, eine Umgebung auszuwählen, geben Sie eine Nummer für die Umgebung ein, in der Sie die Lösung installiert haben, und drücken Sie dann die Eingabetaste.

  9. Geben Sie die Nummer des Konnektors Contoso Invoicing - Open Source ein, und drücken Sie dann den Schlüssel Eingabe.

  10. Der Download sollte erfolgreich abgeschlossen werden. Notieren Sie sich den Speicherort, in den der Konnektor heruntergeladen wurde.

Aufgabe 4: Überprüfen

In dieser Aufgabe überprüfen Sie den Konnektor und beheben einige häufig auftretende Fehler. Sie fügen auch die erforderlichen Metadaten von Konnektoren hinzu.

  1. Kopieren Sie den Pfad, in den der Konnektor heruntergeladen wurde.

    Screenshot des im Befehlsfenster ausgewählten Verbindungspfads

  2. Führen Sie den Befehl zum Überprüfen unter Verwendung des von Ihnen kopierten Pfads und des Swagger-Dateinamens \apiDefinition.swagger.json der API-Definition aus.

    paconn validate --api-def [Path to apiDefinition.swagger.json]

    Screenshot des im Befehlsfenster ausgewählten Befehls zum Überprüfen

  3. Sie sollten eine Fehlermeldung für eine fehlende Zusammenfassung für den vierten Parameter der Aktion „ListInvoices“ und eine fehlende Kontakteigenschaft erhalten.

    Screenshot der im Befehlsfenster ausgewählten Überprüfungsfehler

  4. Korrigieren Sie die fehlende Zusammenfassung. Navigieren Sie zum Power Apps Maker Portal, und stellen Sie sicher, dass Sie sich in der richtigen Umgebung befinden.

  5. Wählen Sie Lösungen aus, und öffnen Sie die Lösung Contoso Invoicing - Open Source.

  6. Wählen Sie den Konnektor Contoso Invoicing - Open Source und dann Bearbeiten aus.

    Ein Pfeil, der auf die Schaltfläche „Benutzerdefinierten Konnektor bearbeiten“ verweist

  7. Wählen Sie die Registerkarte Definition und dann die Aktion ListInvoices aus.

  8. Scrollen Sie nach unten zum Abschnitt Anfrage, und wählen Sie die Auslassungspunkte (Chevron) des Parameters toAmount sowie Bearbeiten aus.

    Ein Pfeil, der auf die Schaltfläche „Parameter bearbeiten“ verweist

  9. Geben Sie Bis-Betrag im Feld Zusammenfassung ein, und wählen Sie dann Konnektor aktualisieren aus.

    Ein Pfeil, der auf die Schaltfläche „Konnektor aktualisieren“ zeigt

  10. Warten Sie, bis das Konnektorupdate abgeschlossen ist.

  11. Löschen Sie den zuvor heruntergeladenen Konnektor (Sie werden ihn gleich wieder hinzufügen). Löschen Sie den Konnektor, den Sie von Ihrem Computer heruntergeladen haben.

  12. Laden Sie den Konnektor erneut herunter. Kehren Sie zur Eingabeaufforderung zurück, und führen Sie den Download-Befehl erneut aus.

    paconn download

  13. Wenn Sie aufgefordert werden, eine Umgebung auszuwählen, geben Sie eine Nummer für die Umgebung ein, in der Sie die Lösung installiert haben, und drücken Sie dann die Eingabetaste.

  14. Geben Sie die Nummer des Konnektors Contoso Invoicing - Open Source ein, und drücken Sie dann den Schlüssel Eingabe.

  15. Der Download sollte erfolgreich abgeschlossen werden. Notieren Sie sich den Speicherort, in den der Konnektor heruntergeladen wurde.

  16. Führen Sie den Befehl zum Überprüfen unter Verwendung des von Ihnen kopierten Pfads und des Swagger-Dateinamens \apiDefinition.swagger.json der API-Definition aus.

    paconn validate --api-def [Path to apiDefinition.swagger.json]

  17. Sie sollten jetzt nur einen Fehler für den fehlenden Kontaktparameter erhalten.

    Prüfungsfehler

  18. Wechseln Sie in den Konnektorordner, den Sie heruntergeladen haben, und öffnen Sie die Datei apiDefinition.swagger.json mit dem Texteditor Ihrer Wahl, z. B. Notepad.

    Die Datei „Konnektordefinition“ öffnen

  19. Fügen Sie den Informationen nach der Beschreibungseigenschaft eine Kontakteigenschaft hinzu.

    "contact": {
      "name": "Contoso Support",
      "url": "https://contosoinvoicingtest.azurewebsites.net",
      "email": "info@Contoso.com"
    }
    

    Screenshot des Kontaktparameters, der der Swagger-Definition mit einem Komma am Ende der Beschreibungseigenschaft hinzugefügt wurde.

  20. Fügen Sie nach den Informationen Metadaten von Konnektoren hinzu.

    "x-ms-connector-metadata": [
      {
       "propertyName": "Website",
       "propertyValue": "https://contosoinvoicingtest.azurewebsites.net"
      },
      {
       "propertyName": "Privacy policy",
       "propertyValue": "https://contosoinvoicingtest.azurewebsites.net"
      },
      {
       "propertyName": "Categories",
       "propertyValue": "Productivity"
      }
    ],
    

    Screenshot der nach der Info hinzugefügten Metadaten von Konnektoren mit einem Komma am Ende des Info-Abschnitts

  21. Wählen Sie Datei aus, und Speichern Sie Ihre Änderungen.

  22. Führen Sie den Befehl zum Überprüfen noch einmal aus.

    paconn validate --api-def [Path to apiDefinition.swagger.json]

  23. Der Konnektor sollte erfolgreich validiert werden.

Screenshot der erfolgreichen Konnektorüberprüfung

Sie haben den Konnektor erfolgreich vorbereitet, um ihn als Open Source zu erstellen und anschließend zu zertifizieren. Wenn Sie einen echten Konnektor erstellen, veröffentlichen Sie den Konnektor in GitHub.