Actualización de parche del conector Four51 en Jitterbit Design Studio
La actividad de actualización de parche de Four51 disponible dentro del conector Four51 permite actualizar datos existentes en Four51 a través de la API de OrderCloud. A diferencia de la actividad de actualización de Four51, la actividad de actualización de parche de Four51 permite actualizar solo aquellos campos que se desean modificar, en lugar de todos los campos del objeto asociado.
Actualizar parcialmente o actualizar completamente los campos de un objeto es una diferencia importante entre las actividades de actualización de parche de Four51 y de actualización de Four51. Si en su lugar desea reemplazar todos los campos o crear un nuevo registro si no existe ninguno, consulte actualización del conector Four51.
Nota
Antes de configurar una operación de actualización de parche de Four51, necesitará tener un endpoint de Four51 definido. Para obtener más información sobre cómo crear un endpoint, consulte endpoint del conector Four51.
Esta página describe cómo actualizar varios campos de objeto existentes en Four51 utilizando un ejemplo de actualización parcial de una dirección de comprador existente usando Jitterbit. Este ejemplo actualiza la misma dirección de comprador que se creó como ejemplo dentro de crear conector Four51 y se reemplazó dentro de actualización del conector Four51.
Importante
Este ejemplo se utiliza solo con fines de demostración y no cubre todas las opciones disponibles en el producto; consulte Design Studio para obtener documentación más completa.
Las siguientes secciones se dividen en el inicio de la actividad de actualización de parche, 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 actualización de parche de Four51
Nota
Si no estás familiarizado con Jitterbit, consulta Comenzar o Estudio de Diseño para obtener información detallada sobre cómo usar el producto.
-
Dentro de tu proyecto en Jitterbit Studio, hay varias formas de comenzar una nueva actividad de actualización de parches de Four51. Cada una de las siguientes opciones iniciará el Asistente de Actualización de Parches de Four51 para guiarte a través del proceso.
- Ve a Archivo > Nuevo > Conectores > Nueva Actualización de Parches de Four51.
- En el árbol a la izquierda bajo Conectores, haz clic derecho en la categoría Four51, luego selecciona Nueva Actualización de Parches 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 Actualización de Parches de Four51 y selecciona Nueva Actualización de Parches 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 Actualización de Parches de Four51.
-
La pantalla de Endpoint del Asistente de Actualización de Parches de Four51 debería abrirse en la vista principal de Studio. Esta pantalla solicita seleccionar el endpoint del cual deseas obtener datos de actualización de parches. Ya deberías haber configurado tu endpoint en endpoint del conector Four51. Usa el menú desplegable para seleccionar el endpoint apropiado. Haz clic en Siguiente cuando termines.
-
Las siguientes pantallas en el Asistente de Actualización de Parches de Four51 te ayudan a profundizar en el objeto específico en el que deseas obtener datos de actualización de parches. La primera de estas pantallas, Sección, te pide que selecciones 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 que se enumeran 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 actualizar parcialmente una dirección de comprador existente, así que seleccionamos la sección "Buyer" y hacemos clic en Next para continuar.
-
La siguiente pantalla en el Asistente de Actualización Patch de Four51, llamada Resource, muestra los recursos disponibles dentro de la sección seleccionada. En el ejemplo, dado que queremos actualizar parcialmente una dirección existente, seleccionamos "Addresses" y hacemos clic en Next para continuar.
-
La pantalla de selección final en el Asistente de Actualización Patch de Four51, llamada Resource Endpoint, muestra los objetos finales disponibles para el recurso seleccionado. En el ejemplo, para actualizar parcialmente una dirección existente, seleccionamos la opción "Partially Update Address". Haga clic en Finish para continuar.
Nota
Los puntos finales 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, actualización parcial o eliminar actividad).
-
Jitterbit procederá a crear una estructura de solicitud y respuesta de API que permitirá que los datos se actualicen a través de la API de OrderCloud. Debería aparecer una nueva pestaña en Studio llamada Actividades de Actualización Patch de Four51. Puede renombrar su actividad de actualización patch aquí si lo desea; en el ejemplo, la nuestra se llama "Actualización Patch de Four51 - Buyer > Addresses > Partially Update Address." También puede 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 le permite agregar campos personalizados a la mayoría de los objetos. Para obtener más información sobre cómo usar la propiedad XP, consulte conector avanzado de Four51.
-
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 actualizará parcialmente una dirección de comprador existente en Four51. Los campos especificados para actualizar se definirán durante la parte de transformación de la operación descrita en la siguiente sección a continuación.
-
Se debería abrir una nueva pestaña en Studio llamada Operaciones, que contiene una representación gráfica de la actividad de actualización por parches.
Nota
Los íconos de Fuente, Solicitud, Respuesta y Destino 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 simple 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 actualización por parches 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 Destino.
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 la Fuente, Solicitud, Respuesta y Destino por separado y luego arrastrarlas y soltarlas 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.
-
Fuente: 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 fuente en el gráfico de la operación y seleccionando Eliminar del Gráfico.
Nota
Hay una variedad de tipos de origen disponibles en Jitterbit. Consulta Sources para más información.
-
Destino: Haz doble clic en el ícono de Destino. 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 el fracaso. Haz clic en el botón Crear Nuevo Destino, asigna un Nombre a tu destino (por ejemplo, 'Destino de Actualización de Patch'). A continuación, para este ejemplo queremos escribir en la ubicación de almacenamiento temporal predeterminada en nuestro agente privado, así que seleccionamos un Tipo de "Almacenamiento Temporal" y ingresamos un Nombre de Archivo de 'Patch_File.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 origen. Consulta Targets para ver las opciones.
-
Solicitud: Haz doble clic en el ícono de Solicitud 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 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 Origen para seleccionar el origen de la transformación. En el ejemplo, nuestro origen está codificado, así que seleccionaremos "Ninguno." Haz clic en Finalizar para continuar.
-
La pestaña de 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 a otro. Para este ejemplo, para codificar el origen, haz doble clic en cada campo del lado del destino y escribe los siguientes valores utilizados en el ejemplo en el script:
DESTINO: ENTRADA > PartiallyUpdateAddress > 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.
TARGET: INPUT > PartiallyUpdateAddress > RequestParameters Script FirstName <trans>
"Nombre Actualizado"
</trans>
LastName <trans>
"Apellido Actualizado"
</trans>
Nota
Los campos listados anteriormente, creados originalmente durante el ejemplo de creación del conector Four51 y reemplazados durante el ejemplo de actualización del conector Four51, se actualizarán con los nuevos valores proporcionados. Los campos restantes del objeto no se actualizarán.
Después de codificar la fuente, tu mapeo de transformación debería verse similar al que se muestra a continuación.
-
-
Response: Haz doble clic en el ícono de Response y selecciona Create New Transformation. 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, Name, proporciona un Nombre para tu transformación o déjalo como el predeterminado. Luego utiliza el menú desplegable Target para seleccionar el objetivo 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 Next para continuar.
-
En la siguiente pantalla, Target, 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 actualización de parche que acabamos de configurar, así que elige "Patch_update." Haz clic en Next para continuar.
-
La pantalla Target ahora mostrará un menú desplegable para seleccionar la actividad. Elige la actividad de actualización de parche que acabas de configurar. Las estructuras de solicitud y respuesta asociadas con la actividad de actualización de parche seleccionada deberían aparecer ahora. Haz clic en Finish para continuar.
-
La pestaña Transformations 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.
-
Tu operación configurada debería verse similar al ejemplo mostrado a continuación.
Implementación y ejecución de la operación
Con la actividad de actualización de parche de Four51 completamente configurada, estamos listos para desplegar y ejecutar la operación.
-
Desde la pestaña Operations, 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 Operation monitor debería indicar que tu operación se ejecutó con éxito. Si no, puedes hacer doble clic en el icono de Status para ver cualquier mensaje de registro.
-
También deberías ver ahora la respuesta de salida que se mapeó a tu archivo de destino 'Patch_File.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"> <PartiallyUpdateAddress> <Status>1</Status> <Items> <Item> <ID>TestAddressID0000</ID> <CompanyName>Test 2 Company</CompanyName> <FirstName>Updated First</FirstName> <LastName>Updated Last</LastName> <Street1>1234 Main Street</Street1> <City>Los Angeles</City> <State>CA</State> <Zip>654321</Zip> <Country>US</Country> <Phone>987654321</Phone> <AddressName>Test_2_Address</AddressName> </Item> </Items> </PartiallyUpdateAddress> </ns:OUTPUT>
-
Además, cuando revises la Consola de API de OrderCloud bajo Comprador > Direcciones, deberías encontrar la dirección del comprador actualizada con la nueva información.