Saltar al contenido

Actividad de lectura de VTEX

Introducción

Una actividad de Lectura de VTEX, utilizando su conexión VTEX, recupera datos de objetos de VTEX y está destinada a ser utilizada como una fuente para proporcionar datos en una operación.

Acciones personalizadas

La actividad de Lectura de VTEX tiene una acción personalizada (Leer detalles de Feed y Pedido) para el objeto Pedidos > subobjeto Feed v3 que implementa tanto las APIs de Recuperar elementos de Feed como Obtener Pedido, permitiendo recuperar elementos de feed y pedidos juntos en la misma actividad en lugar de crear múltiples actividades.

Limitación de la API de VTEX

La actividad de Lectura de VTEX no puede recuperar precios personalizados del objeto Simulación de Precios debido a una limitación presente en la API REST de VTEX.

Crear una actividad de lectura de VTEX

Una instancia de una actividad de Lectura de VTEX se crea a partir de una conexión VTEX utilizando su tipo de actividad Lectura.

Para crear una instancia de una actividad, arrastre el tipo de actividad al lienzo de diseño o copie el tipo de actividad y péguelo en el lienzo de diseño. Para más detalles, consulte Crear una instancia de actividad o herramienta en Reutilización de componentes.

Una actividad de Lectura de VTEX existente se puede editar desde estas ubicaciones:

Configurar una actividad de lectura de VTEX

Sigue estos pasos para configurar una actividad de lectura de VTEX Read:

Paso 1: Ingresa un nombre y selecciona un objeto

En este paso, proporciona un nombre para la actividad y selecciona el objeto que contiene los datos. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

Consejo

Los campos con un ícono de variable admiten el uso de variables globales, variables de proyecto y variables de Jitterbit. Comienza escribiendo un corchete cuadrado abierto [ en el campo o haciendo clic en el ícono de variable para mostrar un menú con las variables existentes para elegir.

  • Nombre: Ingresa un nombre para identificar la actividad. El nombre debe ser único para cada actividad de lectura de VTEX Read y no debe contener barras diagonales / ni dos puntos :.

  • Seleccionar un Objeto: Esta sección muestra los objetos disponibles en el endpoint de VTEX.

    • Objeto Seleccionado: Después de seleccionar un objeto, se lista aquí.

    • Buscar: Ingresa el valor de cualquier columna en el cuadro de búsqueda para filtrar la lista de objetos. La búsqueda no distingue entre mayúsculas y minúsculas. Si los objetos ya se muestran en la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para recargar objetos desde el endpoint al buscar, ingresa criterios de búsqueda y luego actualiza, como se describe a continuación.

    • Actualizar: Haz clic en el ícono de actualizar o en la palabra Actualizar para recargar objetos desde el endpoint de VTEX. Esto puede ser útil si se han agregado objetos a VTEX. Esta acción actualiza todos los metadatos utilizados para construir la tabla de objetos mostrada en la configuración.

    • Seleccionar un Objeto: Dentro de la tabla, haz clic en cualquier parte de una fila para seleccionar un objeto. Solo se puede seleccionar un objeto. La información disponible para cada objeto se obtiene del endpoint de VTEX:

      • Nombre: El nombre del objeto.

      • Descripción: La descripción del objeto.

    Consejo

    Si la tabla no se llena con los objetos disponibles, la conexión a VTEX puede no haber sido exitosa. Asegúrate de estar conectado volviendo a abrir la conexión y volviendo a probar las credenciales.

  • Nombre de la Cuenta: Ingresa un nombre de cuenta para anular la tienda especificada en la configuración de la conexión a VTEX (opcional).

    Nota

    Este es un campo opcional que se puede usar si tienes más de una cuenta de VTEX y deseas anular el Nombre de la Cuenta especificado en la configuración de la conexión a VTEX. La cuenta debe ser compatible para su uso con la Clave de Aplicación y el Token de Aplicación especificados en la conexión.

  • Continuar en Caso de Error: Selecciona continuar la ejecución de la actividad si se encuentra un error para un conjunto de datos en una solicitud por lotes. Si se encuentran errores, se escriben en el registro de operaciones.

  • Guardar y Salir: Si está habilitado, haz clic para guardar la configuración de este paso y cerrar la configuración de la actividad.

  • Siguiente: Haz clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que hagas clic en el botón Finalizado en el último paso.

  • Descartar Cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pedirá que confirmes que deseas descartar los cambios.

Paso 2: Seleccionar un subobjeto

En este paso, selecciona el subobjeto que contiene los datos. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

  • Seleccionar un Subobjeto: Esta sección muestra los subobjetos disponibles en el endpoint de VTEX.

    • Objeto Seleccionado: El objeto seleccionado en el paso anterior se lista aquí.

    • Seleccionar un Subobjeto: Después de seleccionar un subobjeto, se lista aquí.

    • Buscar: Ingresa el valor de cualquier columna en el cuadro de búsqueda para filtrar la lista de subobjetos. La búsqueda no distingue entre mayúsculas y minúsculas. Si los subobjetos ya se muestran en la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para recargar subobjetos desde el endpoint al buscar, ingresa criterios de búsqueda y luego actualiza, como se describe a continuación.

    • Actualizar: Haz clic en el ícono de actualizar o en la palabra Actualizar para recargar subobjetos desde el endpoint de VTEX. Esto puede ser útil si se han agregado subobjetos a VTEX. Esta acción actualiza todos los metadatos utilizados para construir la tabla de subobjetos mostrada en la configuración.

    • Seleccionando un Subobjeto: Dentro de la tabla, haz clic en cualquier parte de una fila para seleccionar un subobjeto. Solo se puede seleccionar un subobjeto. La información disponible para cada subobjeto se obtiene del endpoint de VTEX:

      • Nombre: El nombre del subobjeto.

      • Descripción: La descripción del subobjeto.

    Consejo

    Si la tabla no se llena con los subobjetos disponibles, la conexión a VTEX puede no ser exitosa. Asegúrate de estar conectado volviendo a abrir la conexión y volviendo a probar las credenciales.

  • Atrás: Haz clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.

  • Siguiente: Haz clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que hagas clic en el botón Finalizado en el último paso.

  • Descartar Cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pedirá que confirmes que deseas descartar los cambios.

Paso 3: Seleccionar una acción

En este paso, selecciona una acción para realizar en el subobjeto. Cada elemento de la interfaz de usuario de este paso se describe a continuación.

  • Seleccionar una acción: Esta sección muestra las acciones disponibles en el endpoint de VTEX.

    • Subobjeto seleccionado: El subobjeto seleccionado en el paso anterior se lista aquí.

    • Seleccionar acción: Después de seleccionar una acción, se lista aquí.

    • Buscar: Ingresa el valor de cualquier columna en el cuadro de búsqueda para filtrar la lista de acciones. La búsqueda no distingue entre mayúsculas y minúsculas. Si las acciones ya se muestran en la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para recargar acciones desde el endpoint al buscar, ingresa criterios de búsqueda y luego actualiza, como se describe a continuación.

    • Actualizar: Haz clic en el ícono de actualizar o en la palabra Actualizar para recargar acciones desde el endpoint de VTEX. Esto puede ser útil si se han agregado acciones a VTEX. Esta acción actualiza todos los metadatos utilizados para construir la tabla de acciones mostrada en la configuración.

    • Seleccionar una acción: Dentro de la tabla, haz clic en cualquier parte de una fila para seleccionar una acción. Solo se puede seleccionar una acción. La información disponible para cada acción se obtiene del endpoint de VTEX:

      • Nombre: El nombre de la acción.

      • Descripción: La descripción de la acción.

    Consejo

    Si la tabla no se llena con acciones disponibles, la conexión a VTEX puede no ser exitosa. Asegúrate de estar conectado volviendo a abrir la conexión y volviendo a probar las credenciales.

  • Atrás: Haz clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.

  • Siguiente: Haz clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que hagas clic en el botón Finalizado en el último paso.

  • Descartar cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pedirá que confirmes que deseas descartar los cambios.

Paso 4: Revisar los esquemas de datos

Se muestran los esquemas de solicitud o respuesta. A continuación se describe cada elemento de la interfaz de usuario de este paso.

  • Esquemas de Datos: Estos esquemas de datos son heredados por transformaciones adyacentes y se muestran nuevamente durante el mapeo de transformaciones.

    Nota

    Los datos suministrados en una transformación tienen prioridad sobre la configuración de la actividad.

    El conector de VTEX utiliza la API REST de VTEX. Consulta la documentación de la API para obtener información sobre los nodos y campos del esquema.

    Importante

    En la respuesta, hay un campo schema_request (en el nodo error) que se devuelve cuando se recibe un código de estado no exitoso y Continuar en Error está habilitado (en Paso 1). El campo schema_request contiene una cadena de la entrada proporcionada en la solicitud no exitosa.

  • Actualizar: Haz clic en el ícono de actualizar o en la palabra Actualizar para regenerar los esquemas desde el punto final de VTEX. Esta acción también regenera un esquema en otras ubicaciones a lo largo del proyecto donde se hace referencia al mismo esquema, como en una transformación adyacente.

  • Editar: Haz clic en el ícono de editar sobre cada esquema de datos para ingresar al editor de ese esquema de datos. El editor te permite agregar, eliminar y reorganizar nodos y campos, así como cambiar sus tipos de datos. Todos los nodos y campos recién agregados se establecen en [0, 1] cardinalidad. Los cambios realizados en los esquemas de datos deben ser aceptables para el punto final y deben hacerse solo después de consultar cualquier documentación disponible para el punto final. Después de realizar ediciones en el esquema, se muestra una fecha de última edición en la parte superior del esquema aplicable para indicar que el esquema ha tenido ediciones manuales. Actualizar los esquemas restablecerá los esquemas a sus estructuras predeterminadas.

  • Atrás: Haz clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.

  • Terminado: Haz clic para guardar la configuración de todos los pasos y cerrar la configuración de la actividad.

  • Descartar cambios: Después de realizar cambios, haz clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje te pide que confirmes que deseas descartar los cambios.

Siguientes pasos

Después de configurar una actividad de VTEX Leer, completa la configuración de la operación añadiendo y configurando otras actividades o herramientas como pasos de la operación. También puedes configurar los ajustes de la operación, que incluyen la capacidad de encadenar operaciones que están en los mismos o diferentes flujos de trabajo.

Las acciones del menú para una actividad son accesibles desde el panel del proyecto y el lienzo de diseño. Para más detalles, consulta el menú de acciones de actividad en Conceptos básicos de conectores.

Las actividades de VTEX Leer pueden ser utilizadas como fuente con estos patrones de operación:

Para usar la actividad con funciones de scripting, escribe los datos en una ubicación temporal y luego utiliza esa ubicación temporal en la función de scripting.

Cuando estés listo, despliega y ejecuta la operación y valida el comportamiento revisando los registros de operación.