Deals | Catálogo de Documentos

Qué es el catálogo de documentos

El catálogo de documentos es la pantalla donde se ven, crean, editan y eliminan los documentos de Deals.

Cada documento define cómo se guarda y cómo se envía la información. Los métodos de entrada y de salida se apoyan en un documento: un método siempre pertenece a un documento.

Documentos de Integration Server y documentos privados de Deals

Los dos aparecen en el catálogo, pero se crean desde lugares distintos y tienen alcances diferentes:

  • Documento creado desde Integration Server: es público y visible para todos los espacios de trabajo. Sus métodos también son públicos. Desde Integration Server se pueden crear y editar sus métodos.
  • Documento privado creado desde Deals: se crea desde el Catálogo de Documentos con privacidad Privado. Solo es accesible para la empresa en la que se creó, y sus métodos también son privados.

Desde Deals no se crean métodos en un documento público. Los métodos públicos solo se pueden activar y configurar su activación, por ejemplo habilitar el webhook.

Catálogo de Documentos

Deals opera y conecta los métodos de entrada y de salida a través de un documento. Sin un documento, los métodos no tienen sentido.

Los documentos de Deals sirven como estructuras que definen cómo se persiste y se envía la información.

En el catálogo se encuentran todos los documentos que ya existen para la empresa, y desde ahí se pueden crear nuevos documentos.

Al seleccionar Catálogo de Documentos se abre el listado.

Tipos de documentos

Existen dos tipos de documentos:

  • Documentos públicos: disponibles para todas las empresas. Los crea y mantiene Finnegans. Vienen con sus integraciones armadas y con un formato normalizado para facilitar las operaciones con sistemas externos.
  • Documentos privados: creados desde Deals por la empresa. Son accesibles para los usuarios de la empresa en la que fueron creados.

Notas importantes

  • Documentos privados con métodos públicos: esta combinación no es posible. Los documentos privados solo tienen métodos privados. El listado de documentos de Integration Server muestra solo los documentos públicos, y las configuraciones privadas son de uso exclusivo de la empresa en la que se crearon.
  • Métodos en documentos públicos: si se generan métodos en un documento desde Integration Server, esos métodos son públicos y visibles para todos los espacios de trabajo.

Listado de documentos y acciones

El listado del catálogo muestra los documentos de la empresa con sus APIs de publicación y descarga. Desde ahí se crean, consultan y eliminan documentos.

:round_pushpin: Menú → Deals → Catálogo de Documentos

La opción aparece deshabilitada mientras la empresa no esté activada.

Columnas del listado:

  • Documento: nombre del documento.
  • Grupo: vertical a la que pertenece el documento.
  • API para Descargar: enlace para descargar el documento.
  • API para Publicar: enlace para publicar el documento.
  • Privacidad: indica si el documento es privado o público.

Los documentos privados se muestran primero y, dentro de cada privacidad, ordenados por nombre. Sobre el listado se puede filtrar, elegir las columnas visibles y actualizar los datos.

Acciones del listado:

  • Nuevo: abre el alta de un documento con privacidad Privado.
  • Eliminar: elimina los documentos seleccionados, previa confirmación.
  • Ver json: muestra el formato JSON del documento en modo solo lectura. Si el documento no tiene JSON, el sistema avisa que no existe.
  • Ver schema: muestra el schema del documento en modo solo lectura. Si no tiene schema, el sistema avisa que no existe.
  • Clic en una fila: abre el documento para editarlo.