Erste Schritte mit dem Test Manager SDK

Die in diesem Thema beschriebenen Autorisierungsmethoden enthalten Informationen darüber, wie eine Dienst-zu-Dienst-Verbindung zwischen dem Test Manager und Ihrer Anwendung oder anderen Partneranwendungen hergestellt werden kann.

Voraussetzungen

• Aktivieren Sie die Testautomatisierung im Orchestrator. Weitere Informationen finden Sie unter Funktionen aktivieren/deaktivieren.
• Generieren Sie ein Installationstoken in Orchestrator Identity Management. Sie benötigen es für die Bereitstellung über die Befehlszeile. Informationen zum Abrufen des Orchestrator Identity-Zugriffstokens finden Sie unter Generieren eines Installationszugriffstokens.

Autorisierungsmethoden

Für die Bereitstellung eines externen OAuth-Clients können Sie zwischen zwei Methoden wählen, die auf spezifischen Anwendungsfällen basieren und von den Versionen abhängig sind, die in Ihrer UiPath-Produktinfrastruktur verwendet werden:

• Wenn Sie sowohl die Test Manager- als auch die Orchestrator-Version 21.4 oder höher ausführen, können Sie die Bereitstellung über die Identitätsverwaltung verwenden.
• Wenn Sie die Test Manager-Version 21.4 und die Orchestrator Version 20.10 ausführen oder den mandantenübergreifenden Zugriff aktivieren möchten, können Sie die Bereitstellung über die Test Manager-CLI verwenden.

Bereitstellen durch Identitätsverwaltung

Sie können Ihre Anwendung im Identity Management registrieren, die Test Manager-Scopes definieren und eine Verbindung zwischen den Anwendungen herstellen.

Um Ihre Anwendung zu konfigurieren und zu autorisieren, müssen Sie eine externe Anwendung hinzufügen.

Wenn Sie die Scopes für die Integration definieren, wählen Sie Test Manager als Ressource aus. Weitere Informationen finden Sie unter Scopes.

Bereitstellen über die Test Manager-CLI

Über die Test Manager CLI-Autorisierung können Sie den Client bereitstellen, Scopes zuweisen und anschließend eine Dienst-zu-Dienst-Verbindung zwischen den Anwendungen herstellen.

Damit Sie Ihre Anwendung in Test Manager integrieren und verwenden können, müssen Sie die Autorisierung konfigurieren: Bereitstellen von Client und Scopes und Abrufen einer Client-ID und eines geheimen Clientschlüssels.

Autorisierung konfigurieren

Um eine Dienst-zu-Dienst-Verbindung zwischen dem Test Manager und Ihrer Anwendung herzustellen, verwenden Sie das Test Manager-Bereitstellungstool als wichtigstes CLI-Tool. Damit können Sie einen Client abrufen sowie Zugriffsrechte und Bereiche für Ihre Integration festlegen. Dieses Tool wird mit jedem Build als testmanager.exe in den Standardinstallationsordner gepackt. Dies geschieht wie folgt:

C:\Program Files (x86)\UiPath\TestManager\Tools\TestManagerProvisioner.

Alternativ können Sie die ausführbare Datei in Ihrem benutzerdefinierten Installationsordner finden. Eine Liste der Befehle und Optionen, die außerhalb des Scopes Ihrer Integration liegen, finden Sie in der Kurzübersicht über das Test Manager-Bereitstellungstool.

Im folgenden Abschnitt sind die verfügbaren Befehlszeilenparameter aufgeführt, einschließlich Optionen und Standardwerte, sodass Sie Zugriffsrechte und Scopes bereitstellen und dann eine Client-ID und einen geheimen Clientschlüssel für Ihre Anwendung abrufen können.

Hinweis:

• Sie benötigen das über Orchestrator Identity Management generierte Installationstoken, wie im Abschnitt Voraussetzungen gefordert.
• Sie müssen Test Manager-Scopes definieren.

Befehl	Option	Beschreibung
register third-party-s2sclient	-iu, --identityUrl (Erforderlich)	Die absolute URL, unter der sich Identity Server befindet.
	-iit, --identityInstallationToken <identityinstallationtoken> (Erforderlich)	Das Authentifizierungstoken für die Bereitstellung von Clients in Identity Server.
	cscopes, --clientScopes <clientscopes> (Erforderlich)	Zeigt Client-Scopes an, die beim Erstellen des Clients verwendet werden sollen.
	`-cid, --clientID <clientid>`	Zeigt die Client-ID an, die beim Erstellen des Clients verwendet werden soll. Wird automatisch generiert, wenn Sie keine Client-ID angeben.
	-cname, --clientName <clientname>	Zeigt den Clientnamen an, der beim Erstellen des Clients verwendet werden soll. Wird automatisch generiert, wenn Sie keinen Clientnamen angeben.
	-csecret, --clientSecret <clientsecret>	Zeigt den geheimen Clientschlüssel an, der beim Erstellen des Clients verwendet werden soll. Wird automatisch generiert, wenn Sie keinen geheimen Clientschlüssel angeben.
	-lang, --language <language>	Geben Sie die Sprache der Fehlermeldungen an.
	-?, -h?, --help	Zeigen Sie Hilfe- und Nutzungsinformationen an.

Shell-Skriptbeispiel

In diesem Beispiel wird nach dem Befehl register third-party-s2sclient die Orchestrator Identity-URL, das Token für die Identitätsinstallation und der Projekt-Scope des Test Managers angegeben.

testmanager.exe <code>
register third-party-s2sclient</code>
-iu "https://orchestratorURL/identity" <code>
-iit "e908741iofjikasjijfapuosf09210-012opjawdfsaodgfsadgu90029183i1jiratjapo" </code>
-cscopes "TM.Projects" "TM.Requirements.Read"
Client created successfully. Please note the data below right away. You will not be able to retrieve the secret afterwards.
ClientID: TestManager.ThirdPartyClient.36512487-1rfasdf-11451-321535
ClientName: TestManager.ThirdPartyClient.36512487-1rfasdf-11451-321535
ClientSecret: 43sdgj@efg145!fgdsg53125sfdg12a*gbj9

API-Beispiele

Um einen API-Aufruf an den Test Manager durchzuführen, können Sie sich das folgende Beispiel für das Abrufen von Test Manager-Projekten ansehen.

API-Aufruf für die Autorisierung der Identitätsverwaltung

GET https://[test-manager-URL.com]/api/projects

Headers
    Content-Type: application/json
  Authorization: "Bearer [Oauth Access Token]"Content-Type: application/json<code> </code>{
  "data": [
    {
      "projectPrefix": "INS",
      "id": "96a80aa7-5a7f-4117-c342-08d7add64671",
      "name": "Insurance Calculator",
      "description": "\)\)"The virtual insurance calculator creates sample quotes for different types of insurance.\)\)"",
      "created": "2020-02-10T07:07:33.167Z",
      "createdBy": "74dde091-4a16-4225-aea9-5c3a27b2d996",
      "updated": "2020-02-10T07:07:33.167Z",
      "updatedBy": "74dde091-4a16-4225-aea9-5c3a27b2d996"
    },
    {
      "projectPrefix": "ELI",
      "id": "609f7c5b-c798-46b1-c343-08d7add64671",
      "name": "Eligibility",
      "description": "Eligibility for credit",
      "created": "2020-02-10T09:24:18.63Z",
      "createdBy": "74dde091-4a16-4225-aea9-5c3a27b2d996",
      "updated": "2020-02-10T09:24:18.63Z",
      "updatedBy": "74dde091-4a16-4225-aea9-5c3a27b2d996"
    }
  ],
  "paging": {
    "total": 2,
    "page": 1,
    "pages": 1,
    "pageSize": 12,
    "returned": 2,
    "previousPage": false,
    "nextPage": false
  }
}

API-Aufruf für Test Manager CLI-Autorisierung

GET https://[test-manager-URL.com]/api/projects

Headers
    Content-Type: application/json
  Authorization: "Bearer [Oauth Access Token]"
    X-UiPath-TenantGlobalId: [Tenant ID]Content-Type: application/json
{
  "data": [
    {
      "projectPrefix": "INS",
      "id": "96a80aa7-5a7f-4117-c342-08d7add64671",
      "name": "Insurance Calculator",
      "description": "\)\)"The virtual insurance calculator creates sample quotes for different types of insurance.\)\)"",
      "created": "2020-02-10T07:07:33.167Z",
      "createdBy": "74dde091-4a16-4225-aea9-5c3a27b2d996",
      "updated": "2020-02-10T07:07:33.167Z",
      "updatedBy": "74dde091-4a16-4225-aea9-5c3a27b2d996"
    },
    {
      "projectPrefix": "ELI",
      "id": "609f7c5b-c798-46b1-c343-08d7add64671",
      "name": "Eligibility",
      "description": "Eligibility for credit",
      "created": "2020-02-10T09:24:18.63Z",
      "createdBy": "74dde091-4a16-4225-aea9-5c3a27b2d996",
      "updated": "2020-02-10T09:24:18.63Z",
      "updatedBy": "74dde091-4a16-4225-aea9-5c3a27b2d996"
    }
  ],
  "paging": {
    "total": 2,
    "page": 1,
    "pages": 1,
    "pageSize": 12,
    "returned": 2,
    "previousPage": false,
    "nextPage": false
  }
}