Freigeben über

Best Practices bei Zeichenfolgenfeldern

Dieser Artikel enthält eine allgemeine Anleitung für Zeichenfolgenfelder innerhalb eines Connectors für Microsoft Power Automate, Microsoft Power Apps, Microsoft Copilot Studio und Azure Logic Apps.

Konnektorinformationen

Es ist wichtig, dass Sie grundlegende Informationen zu Ihrem Konnektor angeben. Befolgen Sie zunächst die grundlegenden Richtlinien in diesem Abschnitt. Der Name Ihres Connectors steht im Feld Titel. Die Beschreibung Ihres Connectors gehört in das Feld „Beschreibung“. Beide Felder werden im Abschnitt Info der OpenAPI-Definition (der apiDefinition.swagger.json-Datei) angezeigt.

Hier sind einige Mindestanforderungen, die Sie für Konnektortitel und -beschreibungen erfüllen müssen:

  • Der Connector-Titel darf maximal 30 Zeichen lang sein.
  • Connectortitel und -beschreibung dürfen das Wort API nicht enthalten.
  • Der Titel und die Beschreibung des Connectors dürfen sich nicht auf Microsoft Copilot Studio oder ein anderes Microsoft Power Platform-Produkt beziehen.
  • Connectortitel und -beschreibung dürfen nicht auf ein Produkt verweisen, für das Sie die Back-End-APIs nicht besitzen.

Weitere Informationen zu den Richtlinien für zertifizierte Connectors finden Sie im Artikel zur Einreichung zur Zertifizierung. Best Practices finden Sie hier.

Vorgänge

Jeder Pfad und jedes Verb in der OpenAPI-Definition entspricht einem Vorgang. Eine korrekte Beschreibung des Vorgangs mit jeder/m der folgenden Zeichenfolgen/Tags hilft dem Endbenutzenden bei der richtigen Anwendung. Hier sind einige Beispiele für Zeichenfolgenfelder für einen Vorgang:

  • Zusammenfassung wird als Name des Vorgangs angezeigt.

    • Fall: Satz

    • Hinweise:

      • Der Name sollte keinen Schrägstrich („/“) enthalten.
      • Es darf nicht länger als 80 Zeichen sein.
      • Er darf nicht mit einem nicht alphanumerischen Zeichen enden, einschließlich Interpunktions- oder Leerzeichen.

  • Beschreibung wird als Beschreibung des Vorgangs angezeigt, wenn Sie die Informationsschaltfläche auswählen. Screenshot, der die Schaltfläche „Information“ zeigt. .

    • Fall: Satz.
    • Anmerkungen: Kurz halten, damit alles in das Textfeld passt. Bei einem einzelnen Wort ist kein Punkt erforderlich.

  • operationId ist die eindeutige ID, die mit dem Vorgang verbunden ist.

    • Fall: Camel (keine Leerzeichen oder Satzzeichen).
    • Anmerkungen: Dient dazu, die Bedeutung des Vorgangs zu vermitteln, wie z. B. GetContacts oder CreateContact.

    Das folgende Bild zeigt, wie die Felder Zusammenfassung – E-Mail senden und Beschreibung – Dieser Vorgang schickt eine E-Mail-Nachricht angezeigt werden, während Sie einen Workflow erstellen.

    Screenshot, der zeigt, wie die Zusammenfassungs- und Beschreibungsfelder angezeigt werden.

Trigger im Vergleich zu Aktionen

Ein Trigger startet einen Workflow oder Prozess. Einige Beispiele sind:

  • Jeden Montag um 3 Uhr einen Workflow starten
  • Wenn ein Objekt erstellt wird

Stellen Sie sicher, dass Ihre Trigger-Zusammenfassungs- und Beschreibungsfelder lesbar sein und eine semantische Bedeutung haben. Trigger Zusammenfassung hat normalerweise das Format: „Wenn __________________.“

Beispiel:

Trigger Übersicht
Erzeugen Wenn eine Aufgabe erstellt wird
Aktualisieren Wenn eine Aufgabe aktualisiert wird
gelöscht wird Wenn eine Aufgabe gelöscht wird

Der Trigger Beschreibung hat normalerweise das Format: „Dieser Vorgang wird ausgelöst, wenn _______________.“

Beispiel:

  • Diese Operation wird ausgelöst, wenn eine neue Aufgabe hinzugefügt wird.

Eine Aktion ist eine Aufgabe, die innerhalb des Workflows abgeschlossen werden muss, z. B. E-Mail senden, Zeile aktualisieren, Benachrichtigung senden. Hier sind einige Beispiele für die Aktion Zusammenfassung:

Aktion Übersicht
Erzeugen Neue Aufgabe erstellen
Gelesen Aufgabe nach ID abrufen
Aktualisieren Objekt aktualisieren
gelöscht wird Objekt löschen
Auflisten Alle Objekte auflisten

Parameter

Jeder Vorgang (ob Auslöser oder Aktion) hat Parameter, die der Benutzer als Eingabe bereitstellt. Einige der wichtigen String-Felder für einen Parameter sind:

  • x-ms-summary wird als Parametername angezeigt.

    • Fall: Titel
    • Hinweise: Dieses Zeichenfolgenfeld ist auf 80 Zeichen begrenzt

  • Beschreibung wird als Parameterbeschreibung im Eingabefeld angezeigt.

    • Fall: Satz
    • Anmerkungen: Fassen Sie sich bei der Beschreibung kurz, damit alles in das Textfeld passt. Bei einem einzelnen Wort ist kein Punkt erforderlich.

    Dieses Bild zeigt den Parameter Betreff als Wert für das Feld x-ms-summary und Geben Sie den Betreff der E-Mail an für das Feld Beschreibung.

    Screenshot, der die x-ms-summary- und description-Parameterwerte in der Benutzeroberfläche zeigt.

Response

Jeder Vorgang hat eine Antwort, die später im Workflow als Eingabe für einen nachfolgenden Vorgang verwendet werden kann. Das Ergebnisschema besteht aus mehreren Eigenschaften. Einige wichtige Zeichenfolgenfelder für jede Eigenschaft sind:

  • x-ms-summary wird als Name der Ergebniseigenschaft angezeigt.

    • Fall: Titel
    • Anmerkungen: Verwenden Sie einen kurzen Namen.

  • Beschreibung wird als Beschreibung für die Ergebnis-Eigenschaft angezeigt.

    • Fall: Satz
    • Anmerkungen: Die Beschreibung sollte kurz und prägnant sein und einen Punkt am Ende haben.

    Das Bild zeigt das Ergebnisschema des Vorgangs Flow manuell auslösen angezeigt, wenn Sie versuchen, dynamischen Inhalt in einem der nachfolgenden Vorgänge im Workflow hinzuzufügen. Hier ist Benutzer-E-Mail der Wert des Felds x-ms-summary und der Text darunter ist die Beschreibung für eine Eigenschaft in der Antwort auf den Vorgang Flow manuell auslösen.

Antwort

Hier sind einige wichtige Hinweise, die bei den Felder Zusammenfassung/x-ms-summary und Beschreibung generell zu beachten sind:

  • Der Zusammenfassungs- und Beschreibungstext sollten nicht identisch sein.
  • Die Beschreibung gibt den Benutzenden zusätzliche Informationen, wie das Ausgabeformat oder das Objekt, auf das sich die Eigenschaft bezieht. Zum Beispiel: Zusammenfassung: ID, Beschreibung: Benutzer-ID.
  • Bei einem Objekt mit geschachtelten Werten wird der Wert im Feld x-ms-summary des übergeordneten Namens an das untergeordnete Element angefügt.

Sichtbarkeitspriorität

Die Sichtbarkeitspriorität der Entität wird durch x-ms-visibility angegeben. Wenn keine Sichtbarkeit angegeben ist, wird der Wert der „normalen“ Sichtbarkeit angenommen. Die möglichen Werte sind wichtig, erweitert und intern. Entitäten, die als intern gekennzeichnet sind, werden nicht auf der Benutzeroberfläche angezeigt.

Sichtbarkeit gilt für:

  • Vorgänge
  • Parameter
  • Antworteigenschaften

Im Folgenden finden Sie ein Beispiel:

Auf der Benutzeroberfläche als wichtig gekennzeichnete Entitäten werden in der Regel zuerst angezeigt, als erweitert gekennzeichnete Elemente sind hinter einer Umschaltfläche ausgeblendet (hervorgehoben), und als intern gekennzeichnete Elemente werden nicht angezeigt. Das Bild zeigt ein Beispiel für Parameter, die als wichtig gekennzeichnet sind und standardmäßig angezeigt werden. Sie sehen auch als erweitert gekennzeichnete Parameter, die nach Auswahl der Schaltfläche Erweiterte Optionen anzeigen angezeigt werden.

Screenshot, der eine Dropdown-Liste für erweiterte Optionen zeigt.

Screenshot mit den erweiterten versteckten, erweiterten Optionen.

Feedback senden

Wir freuen uns sehr über Feedback zu Problemen mit unserer Connector-Plattform oder neuen Feature-Ideen. Wenn Sie Feedback geben möchten, gehen Sie zu Probleme melden oder Hilfe zu Connectors und wählen Sie einen Feedbacktyp aus.

  • Last updated on