Fournisseurs d'entités InsuranceSuite

Présentation

Les fournisseurs d'entités InsuranceSuite sont des composants React générés qui utilisent le contexte React pour rendre les informations pertinentes sur l'entité InsuranceSuite correspondante disponibles pour tous les composants qu'ils encapsulent. Ils n'affichent aucun élément d'interface utilisateur eux-mêmes, ils gèrent et distribuent simplement ces données.

Lorsque vous utilisez un fournisseur d'entité, il crée automatiquement l'état React à l'aide de la définition du type de SDK Digital de l'entité correspondante. Ensuite, chaque fois que cet état change, le fournisseur exécute la fonction de schéma du SDK Digital pour cette entité à l'aide du nouvel état, puis la fonction de validation. Après avoir traité toutes ces données, elles sont mises à la disposition des composants descendants via des crochets d'entité personnalisés et des composants de champ d'entité prégénérés.

Utilisation de fournisseurs d'entités

Comme expliqué dans le cahier des charges de l'API des extensions d'interface utilisateur du SDK Digital, le générateur créera des dossiers dans le répertoire de sortie de votre application avec des fichiers d'index pour faciliter les importations. Pour chaque entité InsuranceSuite, les fournisseurs d'entité seront importés via un chemin tel que src/generated/JutroUtils/<your-sdk-name>/<api-name>/<entity-name>

Tous les fournisseurs suivent le modèle de dénomination : EntityNameProvider. Par exemple, le fournisseur de l'entité account/AccountLocation serait AccountLocationProvider.

L’importation se présente comme suit :

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

Par exemple, vous importeriez le fournisseur de l’entité account/AccountLocation depuis PolicyCenter avec un code tel que :

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

Propriétés

Les fournisseurs d'entités ont deux propriétés communes.

`defaultValue`

La propriété defaultValue est utilisée pour définir l'état par défaut d'une entité. Si aucune valeur n'est transmise à cette propriété, il s'agira d'une instance vide de la définition du type de SDK Digital appropriée pour l'entité.

Par exemple, le PhoneNumberProvider définirait {} as PhoneNumber comme la defaultValue. Vous pouvez remplacer cela par votre propre objet si vous souhaitez que la valeur par défaut ait un espace réservé ou une valeur standard.

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>
    )
}

Pour en savoir plus sur les types d'entité, reportez-vous à la documentation sur le SDK Digital.

`showValidationErrors`

Le showValidationErrors permet d'indiquer aux éléments enfants qu'ils doivent afficher dynamiquement les erreurs de validation du schéma. Pour en savoir plus sur les erreurs de validation de schéma, reportez-vous à la documentation sur le SDK Digital.

Cette valeur est transmise via son contexte React et peut être récupérée par des crochets d'entité. Cela vous permet d'intégrer une logique de validation personnalisée ou des mécanismes d'affichage des erreurs dans vos propres composants. Pour en savoir plus, reportez-vous à la section showSchemaValidationErrors de la page des crochets d'entité.

Les composants de champ d'entité sont créés à l'aide de crochets d'entité et conçus pour récupérer cette propriété. Lorsque showValidationErrors est défini sur true, il affiche toutes les erreurs de validation de schéma pertinentes pour le champ.

Dans l'exemple ci-dessous, les composants de champs d'entité Field_countryCode et Field_number sont des valeurs obligatoires pour PhoneNumber. L'élément PhoneNumberProvider a showValidationErrors défini sur true, il affichera donc des erreurs jusqu'à ce que des valeurs soient sélectionnées.

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>
    )
}

Fournisseurs d'entités pour les entités JobLines

Warning: Les fournisseurs d'entités sont différents pour les entités JobLine.

Les fournisseurs d'entités pour les entités JobLines doivent être encapsulés dans un JobLinesProvider.
Les fournisseurs d'entités pour JobLines nécessitent une propriété path supplémentaire.
L'état est créé au niveau de JobLinesProvider au lieu du niveau du fournisseur d'entité, ce qui signifie que ces fournisseurs d'entité n'ont pas de propriété defaultValue.
La validation et l'application des règles porteront sur l'ensemble de l'état de JobLines.

Pour en savoir plus, reportez-vous à la page Utilisation des entités JobLines

Présentation​

Utilisation de fournisseurs d'entités​

Propriétés​

defaultValue​

showValidationErrors​