Verwenden von Variablen im Connector-Generator

Viele Drittanbieteranwendungen, mit denen UiPath® eine Verbindung herstellen kann, erfordern eine dynamische Einrichtung, insbesondere wenn der Connector für eine breitere Zielgruppe erstellt wird. Die Basis-URL erfordert möglicherweise einen Organisationsparameter, jeder API-Aufruf kann eine Eingabe erfordern, die bei der Authentifizierung zurückgegeben wurde usw.

Da es mehrere Möglichkeiten gibt, dieses Problem zu lösen, ist es am einfachsten, Variablen wie {organizationId} oder responseKey für diese Art von Prozessen zu verwenden.

Auf dieser Seite werden die Bereiche innerhalb des Connector-Generators beschrieben, in denen Sie diese Variablen hinzufügen können und wie Sie das tun.

Hinweis:

Die im Connector-Generator verwendete Variablennotation ist nur Zeichenfolgen, die geschweifte Klammern verwenden, z. B. {myVariable}.

Basis-URL

Die Basis-URL ist die URL, die standardmäßig für jede HTTP-Anforderung verwendet wird. In vielen Fällen ist diese URL für die Drittanbieteranwendung statisch, und daher liegt die Verwendung von Variablen außerhalb des Scopes. Einige Anbieter erfordern, dass alle API-Aufrufe an Ihre spezifische Instanz ihrer Anwendung adressiert werden, oder fügen Sie eine Art Bezeichner in den Basispfad ein, der Ihre Identität identifiziert.

Verwenden wir das Beispiel der Verbindung mit Ihrer UiPath Orchestrator-Instanz, für die Organisations- und Mandantendetails in der Basis-URL erforderlich sind. Dieser wird später als Basispfad für jede zukünftige Anforderung verwendet. Wenn Benutzer diesen Connector in ihren Mandanten importieren und eine Verbindung erstellen, können Sie sie nach diesen Informationen fragen, indem Sie diese Parameter als Variablen hinzufügen und auf dem Authentifizierungsbildschirm anfordern.

Dazu fügen Sie zunächst die Variablen in der Basis-URL mit der Notation {organization} und {tenant} hinzu.

Authentication

Bei der Authentifizierungseinrichtung werden die Details in der Tabelle lokalisiert, die alle Parameter auflistet, wobei der Authentifizierungstyp ignoriert wird. Die Tabelle bietet eine schnelle Inline-Bearbeitung oder einem erweiterten Bildschirm, indem Sie das Menü Weitere Optionen verwenden .

Im Beispiel der Orchestrator-API möchten wir der Tabelle zwei zusätzliche Parameter hinzufügen, da der Benutzer, der eine Verbindung erstellt, Eingaben für {organization} und {tenant} bereitstellen muss.

Wenn Sie einen neuen Authentifizierungsparameter hinzufügen, müssen Sie den Namen (wie ein bestimmtes Feld auf dem Verbindungsbildschirm angezeigt werden soll), den Wert (den Sie leer lassen können) und das Feld Benutzer fragen festlegen, wenn Sie den Parameter, der während der Authentifizierung erforderlich sein soll.

Um eine Variable für einen Parameter zu definieren, wählen Sie das Menü Weitere Optionen aus .

In diesem Beispiel wird der Parameter Organisationsname , der beim Benutzer angefordert wird (Benutzer fragen ist auf Ja festgelegt) als Organisation (Name) und Pfad (Typ) an den Anbieter gesendet.

Dasselbe gilt für den Mandanten. Im Authentifizierungsbildschirm sind dann die Felder Organisationsname und Mandantenname erforderlich und Organisation und Mandant sind Teil der Basis-URL.

Senden von Anforderungen

Die Verwendung von Variablen in Ihren Ressourcen funktioniert sehr ähnlich. Und nach dem Importieren von Swagger-Dateien ist dies möglicherweise bereits bei Ressourcen sichtbar, die GETBYID sind und ein {id} aufnehmen, das dann auch im Parameterabschnitt dargestellt wird.

Für den Orchestrator wird im folgenden Beispiel diese Variable für {key} verwendet.