Saltar al contenido

Configuración del esquema JSON de B2Brouter

La solicitud JSON define qué datos se envían a B2Brouter. Para ello, se utiliza un esquema de eDocuments en formato JSON. El esquema contiene todos los nodos JSON necesarios y especifica qué valores se deben determinar y transmitir para cada campo.

Document Dispatch proporciona una estructura estándar preconfigurada para la solicitud JSON de B2Brouter. Esta estructura puede utilizarse como punto de partida y ajustarse a los requisitos individuales según sea necesario. Después de crear el esquema, debe revisar los nodos incluidos y asegurarse de que todos los campos necesarios para su caso de uso estén presentes.

Crear un nuevo esquema JSON

Cree un nuevo esquema JSON para definir la estructura de datos para la solicitud JSON de B2Brouter. Después de crear el esquema, puede generar la estructura predefinida de B2Brouter y luego ajustarla a sus requisitos individuales.

Siga estos pasos para crear un nuevo esquema JSON:

  1. Inicie el centro de roles Document Dispatch - Administrador.
  2. Abra la página Esquemas XSD a través de la búsqueda global.
  3. Seleccione Nuevo para crear un nuevo esquema.
  4. Proporcione un Código único para el esquema JSON. El código se utiliza para identificar el esquema y diferenciarlo de otros esquemas.
  5. Opcionalmente, proporcione una Descripción. Esta se mostrará en la vista general del esquema y puede utilizarse para describir el propósito o contenido del esquema.
  6. En el campo Tipo de esquema, seleccione el valor JSON.
  7. Realice la acción Crear filas de esquema para generar la estructura JSON predefinida de B2Brouter.
  8. Ajuste los nodos y valores generados según sus requisitos.

Info

La estructura proporcionada por B2Brouter puede cambiar con el tiempo. Se pueden agregar nuevos nodos o campos. Por lo tanto, revise regularmente si su esquema JSON aún cumple con los requisitos actuales y complete los nodos faltantes si es necesario.

Crear filas de esquema

Después de la creación inicial de un esquema JSON, no se mostrarán nodos. Antes de que el esquema pueda ser utilizado o editado, primero deben crearse las filas de esquema requeridas. Estas definen la estructura del esquema y especifican qué nodos estarán disponibles más adelante.

Solo después de crear las filas de esquema, los nodos correspondientes se mostrarán en la vista general del esquema y podrán ser configurados.

Siga estos pasos para crear filas de esquema JSON:

  1. Inicie el centro de roles Document Dispatch - Administrador.
  2. Abra la página Esquemas XSD a través de la búsqueda global.
  3. Abra el esquema JSON deseado o cree un nuevo esquema utilizando la descripción Crear un nuevo esquema JSON.
  4. En el menú Datos, seleccione la acción Crear filas de esquema.
  5. Confirme los cuadros de diálogo mostrados.
  6. Las filas de esquema se crearán y los nodos disponibles se mostrarán en la vista general del esquema.

Establecer el tipo de valor JSON

Para cada nodo, puede establecer el Tipo de Valor JSON. El tipo de valor determina en qué formato se emitirán los datos en el JSON generado. Asegúrese de seleccionar el tipo adecuado para cada campo.

  • String para valores de texto
  • Number para valores numéricos
  • Boolean para valores verdadero/falso, por ejemplo, true/false, Sí/No o 1/0

Mostrar información del campo JSON

Seleccione una fila en el esquema JSON y realice la acción Información. La información detallada sobre el campo JSON seleccionado se mostrará en una ventana separada y le ayudará a comprender mejor el significado y uso del campo.

Agregar un valor a un nodo

A cada nodo se le puede asignar un valor. La asignación se realiza a través de un valor de datos XSD, que en tiempo de ejecución toma los datos correspondientes de Business Central y los incorpora al archivo JSON.

Ya en el alcance estándar de eDocuments, hay numerosos valores de datos predefinidos disponibles que se pueden seleccionar y utilizar directamente. De este modo, muchos campos se pueden completar sin esfuerzo adicional de configuración.

Info

eDocuments ya proporciona una variedad de valores de datos estándar. Si un valor necesario no está disponible, se puede complementar mediante una extensión o configuración individual.

Siga estos pasos para asignar un valor a un nodo:

  1. Inicie el centro de roles Document Dispatch - Administrador.
  2. Abra la página Esquemas XSD a través de la búsqueda global.
  3. Abra el esquema JSON deseado.
  4. Seleccione el nodo al que desea asignar un valor.
  5. Haga clic en el campo Valor en el botón ... para mostrar los valores de datos XSD disponibles.
  6. Seleccione el valor de datos deseado.

Info

Los campos de contacto transport_type_code y document_type_code no se gestionan directamente en las filas de esquema individuales. Los valores se toman automáticamente de la configuración del perfil de envío asociado.

Por lo tanto, los cambios en estos campos deben realizarse en el perfil de envío y no en el esquema JSON.

Probar el JSON de B2Brouter

Con la acción Probar JSON de B2Brouter, puede verificar si el esquema JSON actual genera datos válidos para B2Brouter. Para ello, se crea un documento JSON a partir de un comprobante seleccionado y se valida directamente a través de la API de B2Brouter. De este modo, puede detectar errores de configuración o mapeo durante la configuración, antes de que se envíen documentos de manera productiva.

  1. Inicie el centro de roles Document Dispatch - Administrador.
  2. Abra la página Esquemas XSD a través de la búsqueda global.
  3. Abra el esquema JSON deseado.
  4. En el menú Datos, seleccione la acción Probar JSON de B2Brouter.
  5. Seleccione cualquier factura y confirme la selección.

El sistema generará los datos JSON basados en el comprobante seleccionado y los enviará a B2Brouter para su validación. Luego, la transferencia de prueba se eliminará y se mostrará el resultado de la validación. Así, recibirá una respuesta directa sobre si el esquema JSON cumple con los requisitos de B2Brouter.

Exportar JSON

Con la acción Exportar JSON, puede generar un archivo JSON directamente desde un esquema JSON. Se tendrán en cuenta automáticamente los nodos, estructuras y valores definidos en el esquema. Esto permite una fácil verificación del esquema, así como la creación de archivos de ejemplo o prueba para validaciones e integraciones adicionales.

Siga estos pasos para exportar un JSON:

  1. Inicie el centro de roles Document Dispatch - Administrador.
  2. Abra la página Esquemas XSD a través de la búsqueda global.
  3. Abra el esquema JSON deseado.
  4. En el menú Datos, seleccione la acción Exportar JSON.
  5. Seleccione cualquier factura y confirme la selección.
  6. El archivo JSON generado se guardará en su carpeta de descargas.

Búsqueda de datos de esquema

Con la Búsqueda de datos de esquema, puede buscar nodos dentro de un esquema JSON de manera específica y encontrarlos rápidamente en la estructura del esquema.

Siga estos pasos para utilizar la búsqueda de datos de esquema:

  1. Inicie el centro de roles Document Dispatch - Administrador.
  2. Abra la página Esquemas XSD a través de la búsqueda global.
  3. Abra el esquema JSON deseado.
  4. Navegue al campo Búsqueda de datos de esquema.
  5. Ingrese el nombre del nodo deseado o una parte del nombre del nodo en el campo de búsqueda.
  6. La búsqueda se ejecutará al presionar Enter o al salir del campo. Si se encuentra un nodo correspondiente en el esquema, se mostrará automáticamente en la estructura del esquema.

Nota

También puede utilizar la Búsqueda de datos de esquema para buscar específicamente campos de transacción comercial (campos BT). Esto permite encontrar rápidamente los nodos correspondientes dentro del esquema JSON.

Datos vinculados

Con los datos vinculados, se pueden almacenar y gestionar valores para el procesamiento del esquema. Estos valores pueden utilizarse para proporcionar información, completar datos faltantes o reemplazar valores existentes durante la creación del archivo XML o JSON con otros valores.

Esto permite adaptar los esquemas de manera flexible a los requisitos individuales y garantizar una salida consistente de los datos. Los datos vinculados se utilizan especialmente para nodos de esquema que requieren ciertos valores o cuyo contenido debe ajustarse según reglas definidas.

Siga estos pasos para ajustar los datos:

  1. Inicie el centro de roles Document Dispatch - Administrador.
  2. Abra la página Esquemas XSD a través de la búsqueda global.
  3. Abra el esquema JSON deseado.
  4. En el menú Datos, seleccione la acción Datos vinculados.

Aquí puede editar entradas existentes o crear nuevas asignaciones. Los valores definidos se tendrán en cuenta automáticamente al crear el archivo XML o JSON y se aplicarán de acuerdo con las reglas establecidas.

Ver también