Saltar al contenido

Actividad de lectura de VTEX

Introducción

Una actividad de Lectura de VTEX, que utiliza su conexión VTEX, recupera datos de objetos de VTEX y está destinado a ser utilizado como fuente para proporcionar datos en una operación.

Acciones personalizadas

La actividad Lectura de VTEX tiene una acción personalizada (Leer feed y detalles de pedidos) para el objeto Pedidos > subobjeto Feed v3 que implementa tanto Recuperar elementos del feed y Obtener pedido APIs que le permiten 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 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

Se crea una instancia de una actividad VTEX Read a partir de una conexión VTEX utilizando su tipo de actividad Leer.

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

Se puede editar una actividad de Lectura de VTEX existente desde estas ubicaciones:

Configurar una actividad de lectura de VTEX

Siga estos pasos para configurar una actividad de Lectura de VTEX:

Paso 1: Ingrese un nombre y seleccione un objeto

En este paso, proporcione un nombre para la actividad y seleccione el objeto que contiene los datos. A continuación se describe cada elemento de la interfaz de usuario de este paso.

Paso 1 de configuración de la actividad de lectura de VTEX

Sugerencia

Campos con un ícono de variable Ícono de variable admite el uso de variables globales, variables del proyecto y variables Jitterbit. Comience escribiendo un corchete abierto [ en el campo o haciendo clic en el ícono de variable para mostrar una lista de las variables existentes para elegir.

  • Nombre: Ingrese un nombre para identificar la actividad. El nombre debe ser único para cada actividad de Lectura de VTEX y no debe contener barras diagonales. /o dos puntos :.

  • Seleccionar un objeto: Esta sección muestra los objetos disponibles en el extremo VTEX.

    • Objeto seleccionado: Después de seleccionar un objeto, este aparece aquí.

    • Buscar: Ingrese 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 ya se muestran objetos en la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para volver a cargar objetos desde el extremo durante la búsqueda, ingrese los criterios de búsqueda y luego actualice, como se describe a continuación.

    • Actualizar: Haga clic en el ícono de actualización Ícono de actualización o la palabra Refresh para recargar objetos desde el extremo de VTEX. Esto puede ser útil si se han agregado objetos a VTEX. Esta acción actualiza todos los metadatos utilizados para crear la tabla de objetos que se muestran en la configuración.

    • Selección de un objeto: Dentro de la tabla, haga 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 extremo 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 VTEX puede no funcionar correctamente. Asegúrese de estar conectado volviendo a abrir la conexión y probando nuevamente las credenciales.

  • Nombre de cuenta: Ingrese un nombre de cuenta para anular el almacenamiento especificado en la configuración de la conexión VTEX (opcional).

    Nota

    Este es un campo opcional que se puede usar si tiene más de una cuenta VTEX y desea anular el Nombre de cuenta especificado en la configuración de la conexión 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: Seleccione esta opción para continuar con la ejecución de la actividad si se encuentra un error en un conjunto de datos en una solicitud lote. Si se encuentran errores, se escriben en el registro de operación.

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

  • Siguiente: Haga clic para almacenar temporalmente la configuración de este paso y continuar con el siguiente paso. La configuración no se guardará hasta que haga clic en el botón Terminado en el último paso.

  • Descartar cambios: Después de realizar cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le solicitará que confirme que desea descartar los cambios.

Paso 2: Seleccione un subobjeto

En este paso, seleccione el subobjeto que contiene los datos. A continuación se describe cada elemento de la interfaz de usuario de este paso.

Paso 2 de configuración de la actividad de lectura de VTEX

  • Seleccionar un subobjeto: Esta sección muestra los subobjetos disponibles en el extremo VTEX.

    • Objeto seleccionado: El objeto seleccionado en el paso anterior aparece aquí.

    • Seleccionar un subobjeto: Después de seleccionar un subobjeto, este aparece aquí.

    • Buscar: Ingrese 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 ya se muestran subobjetos en la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para volver a cargar subobjetos desde el extremo al realizar una búsqueda, ingrese los criterios de búsqueda y luego actualice, como se describe a continuación.

    • Actualizar: Haga clic en el ícono de actualización Ícono de actualización o la palabra Refresh para volver a cargar los subobjetos desde el extremo de VTEX. Esto puede resultar útil si se han agregado subobjetos a VTEX. Esta acción actualiza todos los metadatos utilizados para crear la tabla de subobjetos que se muestra en la configuración.

    • Selección de un subobjeto: Dentro de la tabla, haga 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 extremo 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 VTEX puede no funcionar correctamente. Asegúrese de estar conectado volviendo a abrir la conexión y volviendo a probar las credenciales.

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

  • Siguiente: Haga clic para almacenar temporalmente la configuración de este paso y continuar con el siguiente paso. La configuración no se guardará hasta que haga clic en el botón Terminado en el último paso.

  • Descartar cambios: Después de realizar cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le solicitará que confirme que desea descartar los cambios.

Paso 3: Seleccione una acción

En este paso, seleccione una acción para realizar en el subobjeto. A continuación se describe cada elemento de la interfaz de usuario de este paso.

Paso 3 de configuración de la actividad de lectura de VTEX

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

    • Subobjeto seleccionado: Aquí se muestra el subobjeto seleccionado en el paso anterior.

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

    • Buscar: Ingrese 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 ya se muestran acciones dentro de la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para volver a cargar acciones desde el extremo al realizar una búsqueda, ingrese los criterios de búsqueda y luego actualice, como se describe a continuación.

    • Actualizar: Haga clic en el ícono de actualización Ícono de actualización o la palabra Refresh para recargar las acciones desde el extremo de VTEX. Esto puede ser útil si se han agregado acciones a VTEX. Esta acción actualiza todos los metadatos utilizados para crear la tabla de acciones que se muestra en la configuración.

    • Selección de una acción: Dentro de la tabla, haga 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 extremo de VTEX:

      • Nombre: El nombre de la acción.

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

    Consejo

    Si la tabla no se completa con las acciones disponibles, la conexión VTEX puede no funcionar correctamente. Asegúrese de estar conectado volviendo a abrir la conexión y volviendo a probar las credenciales.

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

  • Siguiente: Haga clic para almacenar temporalmente la configuración de este paso y continuar con el siguiente paso. La configuración no se guardará hasta que haga clic en el botón Terminado en el último paso.

  • Descartar cambios: Después de realizar cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le solicitará que confirme que desea descartar los cambios.

Paso 4: Revisar los esquemas de datos

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

Paso 4 de configuración de la actividad de lectura de VTEX

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

    Nota

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

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

    Importante

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

  • Actualizar: Haga clic en el ícono de actualización Ícono de actualización o la palabra Actualizar para regenerar esquemas desde el extremo de VTEX. Esta acción también regenera un esquema en otras ubicaciones en todo el proyecto donde se hace referencia al mismo esquema, como en una transformación adyacente.

  • Editar: Haga clic en el ícono de edición Ícono de edición sobre cada esquema de datos para ingresar al editor de ese esquema de datos. El editor le permite agregar, eliminar y reorganizar nodos y campos y cambiar sus tipos de datos. Todos los nodos y campos agregados recientemente se configuran en [0, 1]cardinalidad. Los cambios realizados en los esquemas de datos deben ser aceptables para el extremo y deben realizarse solo después de consultar la documentación disponible para el extremo.

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

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

  • Descartar cambios: Después de realizar los cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le solicitará que confirme que desea descartar los cambios.

Próximos pasos

Después de configurar una actividad de Lectura de VTEX, complete la configuración de la operación agregando y configurando otras actividades, transformaciones o secuencias de comandos como pasos de la operación. También puede configurar los ajustes de la operación, que incluyen la capacidad de encadenar operaciones que se encuentran en el mismo flujo de trabajo o en flujos de trabajo diferentes.

Se puede acceder a las acciones del menú de una actividad desde el panel del proyecto y el tela de diseño. Para obtener más información, consulte menú de acciones de la actividad en Conceptos básicos del conector.

Las actividades de Lectura de VTEX se pueden utilizar como fuente con estos patrones de operación:

Para utilizar la actividad con funciones de script, escriba los datos en una ubicación temporal y luego use esa ubicación temporal en la función de script.

Cuando esté listo, desplegar y ejecute la operación y validar el comportamiento comprobando los registros de operación.