Zum Hauptinhalt springen

InsuranceSuite-Entitätsanbieter

Überblick​

InsuranceSuite-Entitätsanbieter sind generierte React-Komponenten, die React Context verwenden, um die relevanten Informationen über die entsprechende InsuranceSuite-Entität für jede von ihnen umschlossene Komponente verfügbar zu machen. Sie rendern selbst keine UI-Elemente, sondern verwalten und verteilen diese Daten lediglich.

Wenn Sie einen Entitätsanbieter verwenden, wird mithilfe der Digital SDK-Typdefinition der entsprechenden Entität automatisch ein React-Status erstellt. Jedes Mal, wenn sich dieser Status ändert, führt der Anbieter dann die Digital SDK-Schemafunktion für diese Entität mit dem neuen Status und anschließend die Validierungsfunktion aus. Nach der Verarbeitung all dieser Daten werden sie über benutzerdefinierte Entitäts-Hooks und im Voraus generierte Entitätsfeldkomponenten für untergeordnete Komponenten verfügbar gemacht.

Verwenden von Entitätsanbietern​

Wie im Digital SDK UI Extensions API-Vertrag erläutert, erstellt der Generator im Ausgabeverzeichnis Ihrer Anwendung Ordner mit Indexdateien für einfache Importe. Entitätsanbieter für jede InsuranceSuite-Entität werden unter Verwendung eines Pfades wie src/generated/JutroUtils/<your-sdk-name>/<api-name>/<entity-name> importiert

Alle Anbieter folgen dem Benennungsmuster: EntityNameProvider. Der Anbieter für die Entität account/AccountLocation wäre beispielsweise AccountLocationProvider.

Der Import sieht in etwa so aus:

import { EntityNameProvider } from 'src/generated/JutroUtils/<your-sdk-name>/<api-name>/<entity-name>'

Der Anbieter für die Entität account/AccountLocation wird beispielsweise wie folgt aus PolicyCenter importiert:

import { AccountLocationProvider } from `src/generated/JutroUtils/PcSDK/account/AccountLocation`

Eigenschaften​

Entitätsanbieter haben zwei gemeinsame Eigenschaften.

defaultValue​

Die Eigenschaft defaultValue wird verwendet, um einen Standardzustand für eine Entität zu definieren. Wenn kein Wert an diese Eigenschaft übergeben wird, ist sie eine leere Instanz der entsprechenden Digital SDK-Typdefinition für die Entität.

Beispielsweise würde PhoneNumberProvider das {} as PhoneNumber als defaultValue festlegen. Sie können dies mit einem eigenen Objekt überschreiben, wenn Sie möchten, dass der Standardwert einen Platzhalter oder einen Standardwert enthält.

import { 
    PhoneNumberProvider,
    Field_countryCode,
    Field_number,
    } from `src/generated/JutroUtils/<your-sdk-name>/<api-name>/PhoneNumber`

export const defaultPhoneNumberForm = (): JSX.Element => {
    const defaultPhoneNumber = {countryCode: {code: "US"}, number: "123456789"}

    return (
        <PhoneNumberProvider defaultValue={defaultPhoneNumber}>
            <Field_countryCode/>
            <Field_number/>
        </PhoneNumberProvider>
    )
}

Weitere Informationen zu Entitätstypen finden Sie in den Digital SDK-Dokumenten.

showValidationErrors​

Mit showValidationErrors werden untergeordnete Elemente angewiesen, Schemavalidierungsfehler dynamisch anzuzeigen. Weitere Informationen zu Schemavalidierungsfehlern finden Sie in den Digital SDK-Dokumenten.

Dieser Wert wird über seinen React-Kontext übergeben und kann durch Entitäts-Hooks abgerufen werden. So können Sie benutzerdefinierte Validierungslogik oder Fehleranzeigemechanismen in Ihre eigenen Komponenten integrieren. Weitere Informationen finden Sie im Abschnitt showSchemaValidationErrors der Seite Entitäts-Hooks.

Entitätsfeldkomponenten werden mithilfe von Entitäts-Hooks erstellt und dienen dem Abrufen dieser Eigenschaft. Wenn showValidationErrors auf true gesetzt ist, werden alle für das Feld relevanten Schemavalidierungsfehler angezeigt.

Im folgenden Beispiel sind die Entitätsfeldkomponenten Field_countryCode und Field_number erforderliche Werte für PhoneNumber. Durch das PhoneNumberProvider-Element ist showValidationErrors auf true gesetzt, sodass Fehler angezeigt werden, bis Werte ausgewählt werden.

import { 
    PhoneNumberProvider,
    Field_countryCode,
    Field_number,
    } from `src/generated/JutroUtils/<your-sdk-name>/<api-name>/PhoneNumber` 

export const errorsPhoneNumberForm = (): JSX.Element => {

    return (
        <PhoneNumberProvider showValidationErrors>
            <Field_countryCode/>
            <Field_number/>
        </PhoneNumberProvider>
    )
}

Entitätsanbieter für JobLines-Entitäten​

Warning: Entitätsanbieter sind für JobLine-Entitäten unterschiedlich.
  • Entitätsanbieter für JobLines-Entitäten müssen in eine JobLinesProvider eingeschlossen werden.
  • Entitätsanbieter für JobLines erfordern eine zusätzliche path-Eigenschaft.
  • Der Status wird auf der JobLinesProvider-Ebene und nicht auf der Ebene des Entitätsanbieters erstellt, was bedeutet, dass solche Entitätsanbieter keine defaultValue-Eigenschaft haben.
  • Die Validierung und Anwendung der Regeln erstreckt sich auf den gesamten JobLines-Zustand.

Weitere Informationen finden Sie auf der Seite Arbeiten mit JobLines-Entitäten