Exportar diccionario de aplicación a OpenSearch

[EdwinBetanc0urt]

Este paso a paso es para exportar el diccionario de aplicación, por ahora solo Ventanas, Procesos/Reportes, Consultas Inteligentes y Menú al motor de búsquedas OpenSearch, tomando como ejemplo base el stack de cache https://github.com/adempiere/adempiere-ui-gateway/blob/main/docker-compose/docker-compose-cache.yml.

Requisitos previos:

1. Es necesario que el proyecto https://github.com/adempiere/adempiere-kafka-connector este integrado y sus xml de migración.
2. Un servicio de kafka y zookeeper.
3. Un servicio de OpneSearch Gateway RS.
4. Un servicio con el motor de búsquedas OpenSearch.
5. Un servicio con la interfaz gráfica de OpenSearch Dashboars para gestionar los indices.

Pasos

1. Ejecutar el Crear Configuración de Funcionalidad (Functionality Setup Process).

El Functionality Setup Process a ejecutar se llama Spin Contribution (Kafka Connecto)_Create Config, es parte del proyecto adempiere-kafka-connector.

2. Abrir el Registro de Aplicación (App Registration) y establecer los parámetros de kafka correctos.

Considerando que si están en la misma red, o si es una red docker, el Host (Servidor debe ser el nombre del contenedor de kafa y el puerto es el que se establece en el primer valor del la variable de entorno KAFKA_ADVERTISED_LISTENERS (por defecto PLAINTEXT://kafka:9092), que toma de la variable de entrono KAFKA_BROKERCONNECT del proyecto adempiere-ui-gateway.

En caso de estar en otra red, o esta en un servidor totalmente externo el host debe ser la ip o dominio de ese servidor kafka y el puerto expuesto para kafka definido en el segundo parámetro de KAFKA_ADVERTISED_LISTENERS (por ejemplo PLAINTEXT_HOST://tu_dominio.com:1234), que toma de la variable de entrono KAFKA_EXTERNAL_BROKERCONNECT del proyecto adempiere-ui-gateway.

3. Se deben dar acceso a los roles que puedan ejecutar el proceso ECA56_ExportDictionaryDefinition_Export Dictionary Definition (ECA56_ExportDictionaryDefinition_Exportar Definición del Diccionario.

4. Se ejecuta el proceso de exportación por cada compañía.

Se recomienda marcar un check a la vez para su exportación ya que puede tardar mucho, considerando que las Consultas Inteligentes son los que menos tardan y las Ventanas las que mas tardan es exportarse.

5. Verificación

Se puede verificar cuantos documentos (registros) se exportaron abriendo la interfaz gráfica llamada OpenSearch Dashboards.

Abriendo el menú, en la sección de Management > Index Management.

Luego en la sección del menú Indexes.

Esto se ve en el log del servicio de OpenSearch Gateway RS donde se visualiza que efectivamente pudo exportar y comunicar.

Notas

• En el nginx del ui.gateway, el volumen ./nginx/api/opensearch/:/etc/nginx/api_conf.d/opensearch/.

Es el que indica que se hará un redireccionamiento de la rutas api/dictionary/windows, api/dictionary/browsers, api/dictionary/menus, api/dictionary/processes, si se establece ese volumen apuntara al OpenSearch Gateway RS -> OpenSearch, de no establecerse ese volumen ADempiere Vue consultara los datos de la forma normal al backend ADempiere gRPC Server -> Postgres.

• Futuramente se agregara soporte a Formas (Form).
  De forma que los metadatos o diccionario de aplicación de consulte de OpenSearch Gateway RS -> OpenSearch y no de ADempiere gRPC Server -> Postgres.

• En el proceso de exportación se agregaran los parámetros como tipo búsqueda para Ventana, Proceso, Consulta Inteligente y Menú de forma que se pueda exportar directamente un solo registro en caso de tener modificación y no exportar todo.

• Siguiendo la idea del punto anterior quizas sea bueno tambien agregar un proceso en las ventanas de Ventana, Proceso, Consulta Inteligente y Menú para exportar directamente el registro en el que se esta editando.

• Existe un Model Validator que esta en el mismo proyecto de adempiere-kafka-connector, org.spin.eca56.model.validator.EngineAsQueue que se encarga de enviar automáticamente a la cola cuando existe un cambio a nivel de Ventana, Proceso o Consulta Inteligente, sin embargo en ADempiere esta un problema que no están operando los validadores de modelo en la compañía System y esas ediciones solo se hacen en esa compañía.

[EdwinBetanc0urt]

En caso de hacer modificaciones en el diccionario de aplicación se debe seguir el paso 4.

[EdwinBetanc0urt]

En caso de error con el menú, eliminar los indices de OpenSearch con OpenSearch Dashboards que es la interfaz gráfica:

• Abrir el proceso de Exportar Definición de Diccionario, en caso de ser la primera vez y no se tenga nada en la ruta abrir el acceso directo /export-dictionary ejemolo http://localhost:9572/#/export-dictionary.
• Dejar marcado todos los check menos el del campo Exportar Menú.
• Abrir OpenSearch Dasboards.
• Ir a Index Management.
• Luego a Indexes escribir el ID de la compañía para filtrar.
• Seleccionar los indices del menú solamente.
• Ir a Actions.
• Seleccionar Delete.
• Validar que los indices a ser eliminados comiencen con menu y contengan luego del idioma el id de la compañía.
• Ir al proceso y ejecutar.

export-menu.mp4

Se deben esperar algunos minutos, ya que transcurre un tiempo desde que adempiere envía los elementos a ser exportados (menu) a la cola de kafka, luego los servicios que están suscritos a esta cola (en este caso dictionary_rs) reciben una notificación para leer los datos de esa cola, procesarlos y empezar a escribir datos en OpenSearch.