KIU SNAPSHOTS Documents (TKT/EMD/RFND)

DRAFT

1 Introducción
2 Estructura del archivo
3 Estructura event_details
4 Origen y Aplicaciones

Introducción

KIU SNAPSHOTS Documents es un servicio para el envío de las emisiones y cancelaciones de documentos de cualquier tipo de transacción, TKT, EMD, RFND. En un segundo alcance se incluirán las modificaciones de los documentos

Este servicio permite obtener en tiempo real una copia de cada emisión o void, enviando un archivo json al destino configurado.

Estructura del archivo

El nombre del archivo json generado tiene un prefijo con el código del carrier emisior y el tipo de transacción, seguido por el número de documento y timestamp UTC, quedando el siguiente patrón DOCUMENTS_YYYYMMDDTHHMMSSFFFZ.json

Internamente, el archivo contiene un objeto “event_details” que contiene la información sobre el evento que generó la emisión, cambio o cancelación del docuemento. Además se incluye una lista de docuementos document_list end donde cada objeto del array representa un documento afectado.

La estructura del mismo está representada en el schema de la api get_document

Ejemplo

{
  "event_details": {
    "system_from": "XX",
    "company": "00XX",
    "channel": "HOST",
    "subchannel": "OFFICE SALES",
    "device": "SST00XXG07",
    "agent": "KIUHELPER",
    "transaction_type": "DIRECT",
    "origin": "AGENT",
    "application": "KIU_COMMAND",
    "timestamp": "2023-08-01T13:28:14.947Z",
    "document_action": "ISSUE"
  },
  "document_list": [
    {
      "transaction_code": "TKTT",
      "main_document_number": "9990210004401",
      "plating_carrier": "XX",
      "year_of_issue": 2023
      ....
    }
  ]
}

Estructura event_details

El objeto event_details tiene la sieguiente estrucura:

Key	Tipo Dato	Valores posibles	Descripción	Ejemplo

Key	Tipo Dato	Valores posibles	Descripción	Ejemplo
system_from	string(2:3)		C1 o código operador de aerolinea, depende si es terminal de PSS o de Kiu GDS	Z8
company	string(4)		Código único de la empresa, aerolinea o agencia, dentro de Kiu	00Z8
channel	string	HOST, GDS		HOST
subchannel	string		En el caso de GDS es el código de gds (C1, 1A, etc). En el caso de HOST, es el valor que se configuró en la tabla de oficinas, comando DNO / BI STAT.SUB-CHANNEL	SALES OFFICE
device	string(0:10)		Dispositivo de Kiu que generó la transacción	LPB00Z8205
agent	string(0:9)		Dispositivo de Kiu que generó la transacción.	HDQ00Z8SM
transaction_type	string	DIRECT, INDIRECT	Identifica si la modificación sobre el documento se da por una intervención directa de un usuario/api o si la modificación es indirecta relacionada a otro proceso.
document_action	string	ISSUE VOID SSR_TKNE_NOTIFICATION (pediente) REVALIDATE (pediente) STATUS_CHANGED (pediente)	Identifica la acción sobre el documento	ISSUE
origin	string	AGENT WEBSERVICES FROM_EXTERNAL_MESSAGE (pediente) INTERNAL_PROCESS (pediente)	Identifica el origen que afecta al documento relacionado al transaction_type. Si es DIRECT, este campo podrá ser: AGENT → cambio desde KiuCommand/algunos escenarios de click) WEBSERVICES → cambio desde WS/APIS/ algunos escenarios de click FROM_EXTERNAL_MESSAGE → procesamiento de mensajeria TTY Type B/Type A Si es INDIRECT, este campo podrá ser: INTERNAL_PROCESS → cambios en el ETS de estado, exchange involuntario automático FROM_EXTERNAL_MESSAGE → procesamiento de mensajeria TTY Type B/Type A
application	string	KIU_COMMAND OTHER	Detallado en “Origen y Aplicaciones”
timestamp	datetime		fecha y hora de generación del file	2023-04-20T22:02:32.750Z

Origen y Aplicaciones

Al existir distintos escenarios en los cuales se puede emitir o modificar el estado de los cupones de un documento, se clasifican en base al tipo de transacción, directa o indirecta, el origen de la modificación y la aplicación que la desencadenó.

En base a estas variables se construyen las siguientes combinaciones:

origin	application	agent	descripción

origin	application	agent	descripción
AGENT/WEBSERVICES	KIU_COMMAND / OTHER	el que genera la transacción	Procesos de emisión, void, cambio de status manual por comandos o Apis
WEBSERVICES	OTHER	el que genera la transacción	Procesos de emisión, void, cambio de status manual por webservices (v1 y v2)
FROM_EXTERNAL_MESSAGE	SSR_TKNE_NOTIFICATION	KIUSYSTEM	Proceso de notificación por mensajería tipo B. En este caso el device será el de la oficina configurada para el host con terminal address 00