Guía completa para crear un servicio de búsqueda

Creado por Rhoz Anne Bayani, Modificado el Mar, 2 Dic a 5:49 P. M. por Rhoz Anne Bayani

Descripción General del Comportamiento de Búsqueda (Overview of Lookup Behavior)

El Comportamiento de Búsqueda (Lookup Behavior) en WizyVision automatiza la entrada de datos al rellenar automáticamente los campos con información relevante. Cuando el valor de un campo específico cambia, WizyVision dispara el proceso de Comportamiento de Búsqueda.

WizyVision envía una solicitud al Servicio de Búsqueda (Lookup Service), que luego obtiene datos de una fuente externa utilizando la clave y el valor del campo. El Servicio de Búsqueda prepara una respuesta JSON con los datos recuperados.

WizyVision recibe la respuesta JSON y auto-completa los campos de destino basándose en los datos proporcionados. Esta integración perfecta con sistemas existentes como CRM o ERP agiliza la captura de datos, mejora la eficiencia y reduce errores.

Definición de Requisitos de Búsqueda (Defining Lookup Requirements)

Antes de construir el Servicio de Búsqueda, es esencial definir los requisitos para la recuperación de datos y la integración con tu aplicación WizyVision. Aquí están los pasos clave a considerar:

Identify Data Source (Identificar Fuente de Datos): Determina la fuente de datos externa (ej., CRM, ERP, hoja de cálculo) de la que el Servicio de Búsqueda obtendrá la información. Comprende la estructura de datos, los endpoints y los métodos de autenticación del sistema de origen.
Field Mapping (Mapeo de Campos): Define el mapeo entre los campos en WizyVision y los campos correspondientes en la fuente de datos externa. Asegúrate de que las claves y valores de los campos estén alineados para facilitar una recuperación de datos precisa.
Data Filtering (Filtro de Datos): Decide sobre cualquier criterio de filtro o búsqueda específico para obtener los datos relevantes del sistema externo. Considera parámetros como identificadores únicos, etiquetas o categorías para recuperar registros específicos.
JSON Response Format (Formato de Respuesta JSON): Establece el formato de respuesta JSON que el Servicio de Búsqueda proporcionará a WizyVision. Incluye mensajes personalizados y pares clave-valor para las claves de campo y sus valores correspondientes.
Authentication (Autenticación): Determina el método de autenticación requerido por la fuente de datos externa. Esto puede involucrar claves API, tokens OAuth u otros mecanismos de autenticación.

Configuración del Servicio Web (Setting Up the Web Service)

Para construir el Servicio de Búsqueda, debes configurar un servicio web que manejará la recuperación de datos y la generación de respuestas para el Comportamiento de Búsqueda. Así es cómo puedes empezar:

Choosing the Technology Stack (Elección de la Pila Tecnológica):

Selecciona la pila tecnológica que mejor se adapte a tus requisitos y a la infraestructura existente. Las opciones comunes incluyen Node.js, Python, Java o PHP. Considera factores como el rendimiento, la escalabilidad y la compatibilidad con tu fuente de datos.

(¿Qué Datos Recibiré en Mi Servicio de Búsqueda?

Cuando WizyVision dispara el Comportamiento de Búsqueda, tu servicio web recibirá una solicitud HTTP estructurada con datos esenciales en la sección de consulta de la URL. El desglose de estos datos incluye:

namespace: ID de la Cuenta (Account ID)
appId: ID de la Aplicación donde ocurrió la búsqueda
fk: La clave del campo donde ocurrió la búsqueda
fv: El valor del campo que dispara la búsqueda (fk)
lang: Código de idioma del usuario
uId: ID del usuario

How to Structure the Data in the Lookup Service Response? (¿Cómo Estructurar los Datos en la Respuesta del Servicio de Búsqueda?)

El Servicio de Búsqueda debe preparar una respuesta JSON con el siguiente formato:

JSON

La clave "message" en la respuesta te permite incluir un mensaje personalizado que se mostrará en el diálogo de respuesta en WizyVision cuando reciba la respuesta de tu Servicio de Búsqueda. Esta característica es útil para informar al usuario sobre cualquier paso o acción extra requerida. Por ejemplo:

"Product found! Confirm the price tag if correct." (¡Producto encontrado! Confirma la etiqueta de precio si es correcta.)
"Product not found. Please try rescanning the barcode." (Producto no encontrado. Intenta escanear el código de barras de nuevo.)

Al proporcionar un mensaje personalizado, puedes guiar a los usuarios a través del proceso de captura de datos, asegurando una experiencia fluida e intuitiva dentro de WizyVision.

El objeto "data" incluye las claves de los campos a actualizar en WizyVision y sus valores correspondientes. El tipo de dato del valor dependerá del tipo de dato del campo. Por ejemplo, para un campo toggle, el valor debe ser un boolean, mientras que para un campo dropdown, debe ser un string.

Asegúrate de que tu respuesta se adhiera a los tipos de datos apropiados, como se indica en la siguiente tabla:

Data type (Tipo de dato)	Request data type (Tipo de dato de solicitud)	Response format (Formato de respuesta)	Note (Nota)
Toggle	NOT APPLICABLE (NO APLICABLE)	`boolean`
Checkbox	NOT APPLICABLE (NO APLICABLE)	`Array<String>` ["checkbox 1", "checkbox 2"]
Date	`String`	`String`	Las fechas siempre deben estar en formato ISO UTC.
Number	`String`	`Number`	`Number`
Location	`String` `lat,lon`	`{ "info": String \| 'location display' "geoPoint": { "lat": double, "lon": double } }`
Dropdown	`String`	`String`
Text	`String`	`String`
Paragraph	NOT APPLICABLE (NO APLICABLE)	`String`
People	`String` Ej: 'USER,1'	`{ "type": "ROLE" \| "USER", "id": number }`	El tipo de dato de solicitud será una cadena separada por comas de id e id. API Pública - PENDIENTE - AÑADIR ENLACE A LA API PÚBLICA.
People List	NOT APPLICABLE (NO APLICABLE)	NOT APPLICABLE (NO APLICABLE)
Signature Field	NOT APPLICABLE (NO APLICABLE)	NOT APPLICABLE (NO APLICABLE)	La lista de posibles valores se puede encontrar a través de nuestras APIs públicas dependiendo del parser de los parámetros de consulta; el tipo de dato de solicitud podría ser Number o String.
Status	`String`	`Number`	`Number`
Privacy	`String`	`Number`	`Number`

Implementación (Deployment)

Choose a Publicly Accessible Hosting Infrastructure (Elegir una Infraestructura de Alojamiento de Acceso Público): Selecciona un entorno de alojamiento que permita que tu servicio web sea de acceso público. Esto es crucial para permitir que WizyVision envíe solicitudes HTTP a tu Servicio de Búsqueda. Las opciones comunes incluyen plataformas en la nube como AWS, Azure o Google Cloud, o puedes usar un servidor dedicado.

Secure Using the Authorization Header (Asegurar Usando el Encabezado de Autorización): Como una capa adicional de seguridad, puedes implementar autorización para tu Servicio de Búsqueda. Esto se logra utilizando el encabezado de Autorización en la solicitud HTTP enviada por WizyVision. El encabezado puede contener un token o clave API, permitiendo que tu Servicio de Búsqueda valide la autenticidad de la solicitud y responda solo a las solicitudes autorizadas.

Integración con WizyVision (Integrating with WizyVision)

Para integrar tu Servicio de Búsqueda con la función de Comportamiento de Búsqueda de WizyVision:

Get Lookup Service URL (Obtener URL del Servicio de Búsqueda): Obtén la URL pública de tu Servicio de Búsqueda implementado.
Access Admin Settings (Acceder a la Configuración de Administración): En WizyVision, ve a Admin → Applications (Administración → Aplicaciones).
Choose Application (Elegir Aplicación): Selecciona la aplicación específica para la que deseas configurar el Comportamiento de Búsqueda.
Edit Source Field (Editar Campo de Origen): Navega a la sección Fields (Campos) y edita el campo que será la fuente del Comportamiento de Búsqueda.
Configure Lookup Tab (Configurar Pestaña de Búsqueda): En la configuración del campo, ve a la pestaña Lookup (Búsqueda).
Fill in URL (Rellenar URL): Introduce la URL del Servicio de Búsqueda en el campo designado.
Optional: Authorization Header (Opcional: Encabezado de Autorización): Si tu Servicio de Búsqueda requiere autenticación, incluye el valor del encabezado de Autorización.
Save and Test (Guardar y Probar): Guarda la configuración y prueba la integración para asegurar que funcione como se espera.