Conector Four51 Leer en Jitterbit Design Studio
La actividad de lectura de Four51 disponible dentro del conector Four51 permite leer datos existentes en Four51 a través de la API de OrderCloud utilizando Jitterbit.
Nota
Antes de configurar una operación de lectura de Four51, necesitarás tener un endpoint de Four51 definido. Para más información sobre cómo crear un endpoint, consulta endpoint del conector Four51.
Esta página describe cómo leer datos existentes en Four51 utilizando un ejemplo de obtención de una dirección de comprador existente mediante Jitterbit. Este ejemplo utiliza la misma dirección de comprador que se creó como ejemplo dentro de crear conector Four51.
Importante
Este ejemplo se utiliza solo con fines de demostración y no cubre todas las opciones disponibles en el producto; consulta Design Studio para obtener documentación más completa.
Las siguientes secciones se dividen en el inicio de la actividad de lectura, la definición de los componentes de la operación y el despliegue y ejecución de la operación.
Creando una operación de lectura de Four51
Nota
Si no estás familiarizado con Jitterbit, consulta Comenzar o Design Studio para obtener información detallada sobre cómo utilizar el producto.
-
Dentro de tu proyecto en Jitterbit Studio, hay varias formas de comenzar una nueva actividad de lectura de Four51. Cada una de las siguientes opciones iniciará el Asistente de Lectura de Four51 para guiarte a través del proceso.
- Ve a Archivo > Nuevo > Conectores > Nueva Lectura de Four51.
- En el árbol a la izquierda bajo Conectores, haz clic derecho en la categoría Four51, luego selecciona Nueva Lectura de Four51.
- En el árbol a la izquierda bajo Conectores, haz doble clic en la categoría Four51, luego haz clic derecho en Actividades de Lectura de Four51 y selecciona Nueva Lectura de Four51.
- En la barra de herramientas superior, haz clic en el ícono del conector (pieza de rompecabezas naranja)
. En la ventana emergente, selecciona Four51, luego selecciona Lectura de Four51.
-
La pantalla de Endpoint del Asistente de Lectura de Four51 debería abrirse en la vista principal de Studio. Esta pantalla solicita seleccionar el endpoint del cual te gustaría obtener datos existentes. Ya deberías haber configurado tu endpoint en el endpoint del conector de Four51. Usa el menú desplegable para seleccionar el endpoint apropiado. Haz clic en Siguiente cuando termines.
-
Las siguientes pantallas en el Asistente de Lectura de Four51 te ayudan a profundizar en el objeto específico del cual deseas obtener datos. La primera de estas pantallas, Sección, te pide seleccionar una de las categorías de nivel superior listadas dentro de Four51: "Autenticación", "Comprador", "Pedido", "Organización" o "Perspectiva del Usuario".
Nota
Puedes averiguar qué selecciones hacer consultando la API de OrderCloud. Por ejemplo, estas cinco categorías de nivel superior corresponden directamente con las listadas en el lado izquierdo de la Consola de API de OrderCloud. Las pantallas de selección de objetos restantes también siguen la organización de la API de OrderCloud.
En el ejemplo, queremos obtener una dirección de comprador existente, así que seleccionamos la sección "Comprador" y hacemos clic en Siguiente para continuar.
-
La siguiente pantalla en el Asistente de Lectura de Four51, llamada Recurso, muestra los recursos disponibles dentro de la sección seleccionada. En el ejemplo, dado que queremos obtener una dirección existente, seleccionamos "Direcciones" y hacemos clic en Siguiente para continuar.
-
La pantalla de selección final en el Asistente de Lectura de Four51, llamada Endpoint de Recurso, muestra los objetos finales disponibles para el recurso seleccionado. En el ejemplo, para leer una dirección existente, seleccionamos la opción "Obtener una Dirección Única". Haz clic en Finalizar para continuar.
Nota
Los endpoints de recursos disponibles para cada recurso de sección dependen del tipo de actividad de Four51 seleccionada para la operación (es decir, crear, leer, actualizar, actualizar por parches o eliminar actividad).
-
Jitterbit procederá a crear una estructura de solicitud y respuesta de API que permitirá leer datos a través de la API de OrderCloud. Debería aparecer una nueva pestaña en Studio llamada Actividades de Lectura de Four51. Puedes renombrar tu actividad de lectura aquí si lo deseas; en el ejemplo, la nuestra se llama "Four51 Read - Buyer > Addresses > Get a Single Address." También puedes usar los botones + - o las flechas para expandir todos los elementos dentro de cada estructura.
Nota
El "xp" en la estructura anterior significa "Propiedades Extendidas" y es parte de la API de OrderCloud. Esta propiedad te permite agregar campos personalizados a la mayoría de los objetos. Para aprender más sobre cómo usar la propiedad XP, consulta conector de Four51 avanzado.
-
A continuación, en la misma pantalla, haz clic en el botón Crear Operación ubicado bajo Usar en una Integración en la esquina superior derecha. Esto creará la operación de Jitterbit que obtendrá la dirección de comprador existente de Four51.
-
Debería abrirse una nueva pestaña en Studio llamada Operaciones, que contiene una representación gráfica de la actividad de lectura.
Nota
Los íconos de Fuente, Solicitud, Respuesta y Objetivo en la imagen anterior son marcadores de posición para los componentes de la operación, que definiremos en la siguiente sección.
Guarda tu operación haciendo clic en el ícono de disco único para guardar solo esta operación o en el ícono de discos múltiples para guardar todos los cambios en tu proyecto de integración. Deberías ver que el asterisco en la pestaña Operaciones y el título de la operación desaparecen, ya que tu nueva actividad de lectura ahora está creada y guardada en tu proyecto.
Definiendo los componentes de la operación
A continuación, necesitamos definir los otros componentes de la operación que aparecen dentro de la representación gráfica, incluyendo Fuente, Solicitud, Respuesta y Objetivo.
Puedes regresar a la representación gráfica de la operación que has creado y hacer doble clic en cada ícono para configurar cada componente, o puedes crear el Source, Request, Response y Target por separado y luego arrastrarlos y soltarlos desde el árbol a la izquierda directamente sobre los íconos en la representación visual de tu operación.
Se pueden utilizar muchos tipos diferentes de datos para cada componente de la operación. Para aprender más sobre opciones de personalización adicionales, consulta la sección de Design Studio de nuestra documentación.
-
Source: Con el propósito de simplificar este ejemplo, la fuente estará codificada de forma fija. Por lo tanto, eliminaremos la fuente haciendo clic derecho en el ícono de la fuente en el gráfico de operación y seleccionando Remove From Graph.
Nota
Hay una variedad de tipos de fuente disponibles en Jitterbit. Consulta Sources para más información.
-
Target: Haz doble clic en el ícono de Target. En el ejemplo, registraremos la respuesta de la API de OrderCloud en un archivo de texto temporal para proporcionar información sobre el éxito o fracaso. Haz clic en el botón Create New Target, dale a tu objetivo un Name (por ejemplo, 'Read Single Target'). A continuación, para este ejemplo queremos escribir en la ubicación de almacenamiento temporal predeterminada en nuestro agente privado, así que seleccionamos un Type de "Temporary Storage" y entramos un Filename de 'Read_Single.txt' para el ejemplo.
Nota
También puedes enviar la salida a una variedad de diferentes tipos de destino. El tipo no tiene que ser el mismo que el tipo de fuente. Consulta Sources and targets para ver las opciones.
-
Request: Haz doble clic en el ícono de Request y selecciona Create New Transformation. Esto abrirá el Transformation Wizard que te guiará a través de la creación de la solicitud.
Nota
Se proporciona información adicional sobre las estructuras de solicitud en Transformations.
-
En la primera pantalla, Nombre, proporciona un Nombre para tu transformación o déjalo como el predeterminado. Luego utiliza el menú desplegable Fuente para seleccionar la fuente de la transformación. En el ejemplo, nuestra fuente está codificada, así que seleccionaremos "Ninguno". Haz clic en Finalizar para continuar.
-
La pestaña Transformaciones debería abrirse donde puedes completar tu mapeo. Usa el + para expandir los elementos en el árbol de destino a la derecha. En una transformación estándar, arrastrarías y soltarías cada campo que te gustaría mapear de un árbol al otro. Para este ejemplo, para codificar la fuente, haz doble clic en cada campo del lado de destino y escribe los siguientes valores utilizados en el ejemplo en el script:
DESTINO: ENTRADA > GetaSingleAddress > Parámetros Script buyerID <trans>
"TestBuyerID0001"
</trans>
addressID <trans>
"TestAddressID0000"
</trans>
Nota
El buyerID anterior es el ID existente de la Organización Compradora a la que pertenece la dirección, y el addressID anterior es el ID existente de la nueva dirección que se creó durante el ejemplo de creación del conector Four51.
Después de codificar la fuente, tu mapeo de transformación debería verse similar al que se muestra a continuación.
-
-
Respuesta: Haz doble clic en el ícono de Respuesta y selecciona Crear Nueva Transformación. Esto abrirá el Asistente de Transformación que te guiará a través de la creación de la respuesta.
Nota
Se proporciona información adicional sobre las estructuras de respuesta en Transformaciones.
-
En la primera pantalla, Nombre, proporciona un Nombre para tu transformación o déjalo como el predeterminado. Luego utiliza el menú desplegable Destino para seleccionar el destino de la transformación. En el ejemplo queremos usar la respuesta de la API de OrderCloud, así que seleccionamos "Respuesta de Función Four51." Haz clic en Siguiente para continuar.
-
En la siguiente pantalla, Destino, selecciona el botón de opción para el tipo de actividad de la que deseas usar la respuesta. En este caso, queremos usar la respuesta de la actividad de lectura que acabamos de configurar, así que elige "Leer." Haz clic en Siguiente para continuar.
-
La pantalla de Destino ahora mostrará un menú desplegable para seleccionar la actividad. Elige la actividad de lectura que acabas de configurar. Las estructuras de solicitud y respuesta asociadas con la actividad de lectura seleccionada deberían aparecer ahora. Haz clic en Finalizar para continuar.
-
La pestaña de Transformaciones debería abrirse donde puedes completar tu mapeo. Usa el + para expandir los lados de origen y destino. Haz clic y arrastra la carpeta "OUTPUT" del lado izquierdo (lado de origen) a la carpeta "OUTPUT" del lado derecho (lado de destino). Tu pantalla de mapeo debería verse similar a la de abajo.
Nota
Si estás manejando grandes cantidades de datos, también puedes usar las opciones de paginación, búsqueda, filtrado o clasificación descritas en conector avanzado de Four51.
-
Tu operación configurada debería verse similar al ejemplo mostrado a continuación.
Desplegando y ejecutando la operación
Con la actividad de lectura de Four51 completamente configurada, estamos listos para desplegar y ejecutar la operación.
-
Desde la pestaña de Operaciones, haz clic en el icono de desplegar
.
-
Luego haz clic en el icono de ejecutar
para colocar la operación en la cola para su ejecución.
-
En la parte inferior de la pantalla, el Monitor de operaciones debería indicar que su operación se ejecutó con éxito. Si no, puede hacer doble clic en el ícono de Estado para ver cualquier mensaje de registro.
-
También debería ver ahora la respuesta de salida que se mapeó a su archivo de destino 'Read_Single.txt'. En el ejemplo, el archivo ahora se crea en el almacenamiento temporal en el agente privado (es decir, por defecto '/tmp/jitterbit/TemporaryStorage' para Linux o 'C:\Windows\Temp\Jitterbit\' para Windows). El estado de '1' indica que la operación fue exitosa.
<?xml version="1.0" encoding="UTF-8"?> <ns:OUTPUT xmlns:ns="urn:F51oln-res:document:F51oln:oln:entities"> <GetaSingleAddress> <Status>1</Status> <Meta> <ItemRange/></Meta> <Items> <Item> <ID>TestAddressID0000</ID> <CompanyName>Test Company</CompanyName> <FirstName>First</FirstName> <LastName>Last</LastName> <Street1>Main Street</Street1> <City>San Francisco</City> <State>CA</State> <Zip>123456</Zip> <Country>US</Country> <Phone>123456789</Phone> <AddressName>Test_Address</AddressName> </Item> </Items> </GetaSingleAddress> </ns:OUTPUT>
-
Dado que esta fue una operación de lectura, no hay cambios dentro de la API de OrderCloud. Sin embargo, aún puede leer la misma información desde la Consola de API de OrderCloud en Comprador > Direcciones.