Zum Hauptinhalt springen

Initialisierung des Digital SDK

Note: Dieses Dokument behandelt die Unterschiede bei der Verwendung eines mit dem Jutro CLI-Befehl generierten Digital SDK.

Informationen zu ohne Verwendung der Jutro CLI erstellten Digital SDKs finden Sie in der Dokumentation zum Digital SDK.

Überblick​

Bevor das generierte SDK verwendet werden kann, müssen Sie es initialisieren. Bei diesem Initialisierungsprozess wird das SDK mit der erforderlichen Konfiguration eingerichtet, damit es ordnungsgemäß funktioniert.

Es gibt zwei Möglichkeiten, das SDK zu initialisieren:

  • Verwenden Sie für Jutro-Anwendungen die Funktion initSdkJutro.
  • Verwenden Sie für Nicht-Jutro-Anwendungen die Funktion initSdk.

Der Unterschied zwischen diesen beiden Methoden besteht darin, dass für initSdk ein Konfigurationsobjekt erforderlich ist, während bei der Verwendung von initSdkJutro dieses Objekts optional ist, da die Informationen standardmäßig von den Jutro-Umgebungsvariablen übernommen werden.

Note: Die für die UI-Erweiterungen des Digital SDK generierten Komponenten haben in beiden Szenarios keine Auswirkungen. Diese Komponenten werden während des Generierungsschritts erstellt und funktionieren gleich, unabhängig davon, welche Initialisierungsfunktion verwendet wird.

Sie können diese Funktionen direkt aus dem bzw. den generierten SDKs importieren. Wenn Sie mehrere SDKs generiert haben, muss jedes einzelne davon initialisiert werden.

Warning: Vergewissern Sie sich, dass der Initialisierungsprozess abgeschlossen ist, bevor Sie das SDK in Ihrer Anwendung verwenden.

Nicht-Jutro-Anwendungen​

Wenn Sie die Funktion initSDK zum Initialisieren eines Digital SDK verwenden, lesen Sie die Dokumentation zum Digital SDK.

Jutro-Anwendungen​

Wenn Sie die Funktion initSdkJutro zum Initialisieren eines Digital SDK verwenden, ist das Konfigurationsobjekt optional. Die Standardwerte werden von Ihren Umgebungsvariablen übernommen. In den meisten Fällen können Sie das SDK in Jutro-Anwendungen mit einer einzigen Codezeile initialisieren:

import { initSdkJutro } from 'src/generated/<your-sdk-name>';

initSdkJutro();

Objekt zum Überschreiben einer Konfiguration​

Die Funktion initSdkJutro unterstützt ein optionales Konfigurationsobjekt. Sie können dieses Objekt verwenden, um die von den Umgebungsvariablen übernommenen Informationen zu überschreiben, oder falls diese Variablen in Ihrer Jutro-Anwendung aus irgendeinem Grund nicht eingerichtet sind.

Das von der Funktion initSdkJutro unterstützte Konfigurationsobjekt verwendet die gleichen Optionen wie die Funktion initSdk, aber alle Eigenschaften sind optional.

type InitSdkParamObjectJutro = {
  auth?: AuthParam;
  backendUrl?: string;
  enableStickySession?: boolean;
  language?: string | null;
};

Standardwerte der Konfigurationsparameter​

Bei Verwendung der Funktion initSdkJutro lauten die Standardeigenschaften der Konfigurationsobjekte wie folgt:

auth​

Der Parameter auth ist ein Objekt, das die Authentifizierungsinformationen enthält, die das generierte SDK für die API-Anforderungen verwendet. Weitere Informationen zur Eigenschaft auth und zu den verfügbaren Authentifizierungsoptionen finden Sie in der Dokumentation zum Digital SDK.

Wenn kein auth-Parameter angegeben ist, leitet das SDK die Authentifizierungsmethode mithilfe der folgenden Regeln und Umgebungsvariablen ab:

  • Wenn die Umgebungsvariablen REACT_APP_BASIC_PASSWORD und REACT_APP_BASIC_USERNAME festgelegt sind, verwendet das SDK die Basisauthentifizierung.

  • Wenn die Umgebungsvariable JUTRO_AUTH_ENABLED auf true festgelegt ist, verwendet das SDK die JWT-Authentifizierung, und als Parameter ist eine getAccessToken-Funktion erforderlich. Die Funktion getAccessToken wird von @jutro/auth bereitgestellt.

  • Wenn die Umgebungsvariable ENABLE_ANONYMOUS_AUTH auf true festgelegt ist, verwendet das SDK die anonyme Authentifizierung.

  • Wenn keine der oben genannten Umgebungsvariablen festgelegt ist, führt das SDK die API-Anforderungen als nicht authentifiziert aus.

backendUrl​

Der Parameter backendUrl ist die URL der InsuranceSuite-Anwendungsinstanz, die das SDK als Basis-URL für die API-Anforderungen verwendet. Dabei muss es sich um eine API-URL der InsuranceSuite-Anwendung handeln, z. B. https://pc-environment-starsystemid-tenant.api.guidewire.net/rest.

Der Standardparameter backendUrl wird von Ihren Jutro-Umgebungsvariablen übernommen. Wenn Sie beispielsweise PolicyCenter verwenden, übernimmt das SDK den backendUrl-Parameter standardmäßig von der Umgebungsvariablen JUTRO_PC_CLOUD_API_URL.

enableStickySession​

Sticky Sessions ist eine Funktion für Clusterumgebungen, mit der die Sitzungsaffinität im Transportdienst aktiviert werden kann. Eine ausführlichere Erläuterung dieser Funktion finden Sie in der Dokumentation zum Digital SDK.

Wenn Sie die Funktion initSdkJutro verwenden, ist der Standardwert für die Eigenschaft enableStickySession der Wert der Umgebungsvariablen JUTRO_ENABLE_STICKY_SESSION.

Note: Wenn Sie das Digital SDK in einer Anwendung verwenden, die aus einer Shell-Anwendung und mehreren Micro Frontends besteht, führt enableStickySession möglicherweise nicht zu konsistenten Werten für Sticky Session Header.

Weitere Informationen finden Sie in der Dokumentation zu Micro Frontends.

language​

Die Eigenschaft language wird verwendet, um das SDK mit einer bevorzugten Sprache zu initialisieren. Die Eigenschaft ist optional, unabhängig davon, welche Initialisierungsversion verwendet wird, und verhält sich in beiden Szenarios identisch. Weitere Informationen zu dieser Eigenschaft finden Sie in der Dokumentation zum Digital SDK.

Beispiel für das Überschreiben einer Konfiguration​

In diesem Beispiel konfigurieren wir das SDK so, dass es eine Anonymous-Authentifizierung anstelle der von den Umgebungsvariablen übernommenen Authentifizierungsmethode verwendet.

import { initSdkJutro, AuthType } from 'src/generated/<your-sdk-name>';

initSdkJutro({
  auth: {
    authType: AuthType.Anonymous,
  },
});

Zugriff auf die Axios-Instanz​

Eine Anleitung für den direkten Zugriff auf die Axios-Instanz aus einem initialisierten SDK finden Sie in der Dokumentation zum Digital SDK.

Arbeiten mit Ausgaben​

Eine Anleitung zum Festlegen oder Abrufen der Ausgabe für Sparten mit einem initialisierten SDK finden Sie in der Dokumentation zum Digital SDK.