Proveedores de entidades de InsuranceSuite

Descripción general

Los proveedores de entidades de InsuranceSuite son componentes de React generados que utilizan el contexto de React para hacer que la información relevante sobre la entidad de InsuranceSuite correspondiente esté disponible para cualquier componente que encapsulen. No renderizan ningún elemento de interfaz de usuario por sí mismos, simplemente administran y distribuyen estos datos.

Cuando utiliza un proveedor de entidades, este crea automáticamente el estado de React mediante la definición de tipo del SDK de Digital de la entidad correspondiente. A continuación, cada vez que este estado cambie, el proveedor ejecutará la función de esquema del SDK de Digital para esta entidad mediante el nuevo estado y, a continuación, la función de validación. Después de procesar todos estos datos, los pondrá a disposición de los componentes descendientes a través de ganchos de entidad personalizados y componentes de campo de entidad generados previamente.

Uso de proveedores de entidades

Como se explica en el contrato de la API de extensiones de interfaz de usuario del SDK de Digital, el generador creará carpetas en el directorio de salida de la aplicación con archivos de índice para facilitar la importación. Los proveedores de entidad para cada entidad de InsuranceSuite se importarán mediante una ruta como src/generated/JutroUtils/<your-sdk-name>/<api-name>/<entity-name>.

Todos los proveedores siguen el patrón de asignación de nombres: EntityNameProvider. Por ejemplo, el proveedor de la entidad account/AccountLocation sería AccountLocationProvider.

La importación tendrá un aspecto similar al siguiente:

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

Por ejemplo, importaría el proveedor para la entidad account/AccountLocation de PolicyCenter con algo similar a esto:

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

Propiedades

Los proveedores de entidad tienen dos propiedades frecuentes.

defaultValue

La propiedad defaultValue se utiliza para definir un estado predeterminado para una entidad. Si no se pasa ningún valor a esta propiedad, será una instancia vacía de la definición de tipo del SDK de Digital adecuada para la entidad.

Por ejemplo, el PhoneNumberProvider establecería {} as PhoneNumber como el defaultValue. Puede invalidar esto con su propio objeto si desea que el valor predeterminado tenga un marcador de posición o un valor estándar.

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

Para obtener más información sobre los tipos de entidades, consulte los documentos del SDK de Digital.

showValidationErrors

La propiedad showValidationErrors se utiliza para indicar a los elementos secundarios que muestren dinámicamente los errores de validación del esquema. Para obtener más información sobre los errores de validación del esquema, consulte los documentos del SDK de Digital.

Este valor se pasa a través de su contexto de React y puede ser recuperado por ganchos de entidad. Esto le permite integrar lógica de validación personalizada o mecanismos de visualización de errores en sus propios componentes. Para obtener más detalles, consulte la sección showSchemaValidationErrors de la página de ganchos de entidad.

Los componentes de campo de entidad se crean con ganchos de entidad y están diseñados para recuperar esta propiedad. Cuando showValidationErrors se establece en true, mostrará cualquier error de validación de esquema relevante para el campo.

En el siguiente ejemplo, los componentes del campo de entidad Field_countryCode y Field_number son valores obligatorios para PhoneNumber. El elemento PhoneNumberProvider tiene showValidationErrors establecido en true, por eso, mostrará errores hasta que se seleccionen los valores.

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

Proveedores de entidades para entidades JobLines

Warning: Los proveedores de entidades son diferentes para las entidades JobLine.

• Deben estar encapsulados en un JobLinesProvider.
• Requieren una propiedad path adicional.
• El estado se crea al nivel del JobLinesProvider, en lugar del nivel del proveedor de entidades, lo que significa que dichos proveedores de entidades no tienen una propiedad defaultValue.
• La validación y aplicación de las reglas incluirá todo el estado JobLines.

Para obtener más información, consulte la página Cómo trabajar con entidades de JobLines.