Saltar al contenido

Conector de Clarizen Eliminar en Jitterbit Design Studio

La actividad de eliminación de Clarizen disponible dentro del conector de Clarizen permite eliminar registros existentes en una instancia de Clarizen conectada utilizando Jitterbit.

Nota

Antes de configurar una operación de actualización de Clarizen, necesitarás tener un endpoint de Clarizen definido. Para obtener más información sobre cómo crear un endpoint, consulta endpoint del conector de Clarizen.

Esta página describe cómo eliminar registros existentes de Clarizen utilizando un ejemplo de eliminación de una tarea existente por ID en Clarizen a partir de datos de origen proporcionados en un archivo XML a través de Jitterbit. Este ejemplo elimina el mismo archivo de ejemplo utilizado en los ejemplos de crear conector de Clarizen y actualizar conector de Clarizen.

Ejemplo

Para referencia, consulta el Jitterpak ClarizenExample.jpk y los archivos acompañantes en ClarizenSampleFiles.zip. Descomprime el ClarizenSampleFiles.zip en tu unidad "C:\" o, si lo descomprimes en otro directorio, asegúrate de editar los directorios de origen y destino en las operaciones. Si es tu primera vez usando un Jitterpak, consulta Importando un Jitterpak.

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 eliminación, 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 eliminación de Clarizen

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.

  1. Dentro de tu proyecto en Jitterbit Studio, hay varias formas de iniciar una nueva actividad de eliminación de Clarizen. Cada una de las siguientes opciones iniciará el Asistente de Eliminación de Clarizen para guiarte a través del proceso.

    • Ve a Archivo > Nuevo > Conectores > Nueva Eliminación de Clarizen.
    • En el árbol a la izquierda bajo Conectores, haz clic derecho en la categoría Clarizen, luego selecciona Nueva Eliminación de Clarizen.
    • En el árbol a la izquierda bajo Conectores, haz doble clic en la categoría Clarizen, luego haz clic derecho en Actividades de Eliminación de Clarizen y selecciona Nueva Eliminación de Clarizen.
    • En la barra de herramientas superior, haz clic en el ícono del conector (pieza de rompecabezas naranja) attachment. En la ventana emergente, selecciona Clarizen, luego selecciona Eliminación de Clarizen.
  2. La pantalla de Endpoint del Asistente de Eliminación de Clarizen debería abrirse en la vista principal de Studio. Esta pantalla solicita seleccionar el endpoint del cual te gustaría eliminar registros. Ya deberías haber configurado tu endpoint en endpoint del conector de Clarizen. Usa el menú desplegable para seleccionar el endpoint apropiado. Haz clic en Siguiente cuando termines.

    attachment

  3. La pantalla de Objeto del Asistente de Eliminación de Clarizen te pide que selecciones el objeto del cual te gustaría eliminar registros. En este ejemplo, queremos eliminar una tarea existente en Clarizen, así que seleccionamos el objeto "Tarea", luego hacemos clic en Finalizar para continuar.

    Nota

    Si tienes muchos objetos disponibles en tu instancia de Clarizen, es posible que necesites esperar un momento para que se carguen. También puedes ingresar un nombre de objeto en el campo Filtro. Prueba el botón Actualizar si los resultados no son lo que esperabas.

    attachment

  4. Jitterbit procederá a crear una estructura de solicitud y respuesta de la API de Clarizen que permitirá eliminar registros dentro de su instancia de Clarizen conectada. Debería aparecer una nueva pestaña en Studio llamada Clarizen Delete Activities. Puede renombrar su actividad de eliminación aquí si lo desea; en el ejemplo, la nuestra se llama "Example Clarizen Delete Task." También puede usar los botones + - o las flechas para expandir todos los elementos dentro de cada estructura.

    attachment

  5. A continuación, en la misma pantalla, haga clic en el botón Create Operation ubicado bajo Use in an Integration en la esquina superior derecha. Esto creará la operación de Jitterbit que eliminará la tarea existente en Clarizen.

  6. Debería abrirse una nueva pestaña en Studio llamada Operations, que contiene una representación gráfica de la actividad de eliminación.

    attachment

    Nota

    Los íconos de Source, Request, Response y Target en la imagen anterior son marcadores de posición para los componentes de la operación, que definiremos en la siguiente sección.

    Guarde su 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 su proyecto de integración. Debería ver el asterisco en la pestaña Operations y el título de la operación desaparecer a medida que su nueva actividad de actualización se crea y guarda en su 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 Source, Request, Response y Target.

Para cada uno, las instrucciones a continuación le indican que regrese a la representación gráfica de la operación que ha creado y haga doble clic en cada ícono para configurar cada componente. Como alternativa, también podría 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 su operación.

Para los propósitos de este recorrido, proporcionamos los siguientes ejemplos para referencia: Jitterpak ClarizenExample.jpk y archivos acompañantes en ClarizenSampleFiles.zip. 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: En el ejemplo, utilizamos un archivo XML como la solicitud de entrada para eliminar una tarea existente con el ID proporcionado a continuación. Se debe incluir un ID en la fuente para una actividad de eliminación, y puede ser el ID externo o el ID interno (ID completo) en el formato de /\<object_type>/\<external_id>.

    <ns:INPUT xmlns:ns="urn:czoln:document:czoln:oln:entities">
        <Task>
            <id>jw47joqmno25rh7l5azcmo3o26</id>
        </Task>
    </ns:INPUT>
    

    Nota

    Una actividad de eliminación de Clarizen debe usar el ID interno o externo de la entidad dentro de Clarizen para asociar la eliminación con el objeto correcto. El ID interno completo de Clarizen incluye el nombre de la entidad en el formato de /\<object_type>/\<external_id> (por ejemplo, /Task/jw47joqmno25rh7l5azcmo3o26), mientras que el ID externo de Clarizen se ajustará al ID solamente, por ejemplo, jw47joqmno25rh7l5azcmo3o26.

    Nota

    En el ejemplo, utilizamos el ID de Clarizen devuelto en la respuesta del ejemplo utilizado en Clarizen connector create y Clarizen connector update. Si estás siguiendo el ejemplo, necesitarás reemplazar este ID con el de la tarea específica en tu instancia de Clarizen.

    Nota

    Hay una variedad de tipos de fuente disponibles en Jitterbit. Consulta Sources para más información.

    Para usar el archivo XML, primero haz doble clic en el ícono de Fuente, luego haz clic en el botón Crear Nueva Fuente y dale a tu fuente un Nombre (por ejemplo, ClarizenDelete_Task_Request.xml). A continuación, para este ejemplo, estamos utilizando un agente privado con archivos locales habilitados, y por lo tanto seleccionamos un Tipo de "Archivo Local" y luego Examinar para la ubicación. Si estás utilizando los archivos de ejemplo, la Carpeta es 'C:\ClarizenSampleFiles' y el Obtener Archivos es 'ClarizenDelete_Task_Request.xml'.

  • Objetivo: Haz doble clic en el ícono de Objetivo. En el ejemplo, vamos a exportar el ID y el estado a un archivo XML para asegurarnos de que la operación fue exitosa. Haz clic en el botón Crear Nuevo Objetivo, asigna un Nombre a tu objetivo (por ejemplo, ClarizenDelete_Task_Response.xml), y nuevamente selecciona un Tipo de "Archivo Local" y Navega hasta una ubicación en el agente privado donde queremos guardar los datos. En el ejemplo, la Carpeta es 'C:\ClarizenSampleFiles' y el Nombre de Archivo es 'ClarizenDelete_Task_Response.xml'.

    Nota

    También puedes exportar a una variedad de diferentes tipos de objetivo. El tipo no tiene que ser el mismo que el tipo de origen. Consulta Objetivos 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 Transformaciones.

    1. En la primera pantalla, Nombre, proporciona un Nombre para tu transformación o déjalo como el predeterminado. Luego utiliza el menú desplegable de Origen para seleccionar "Solicitud de Función de Clarizen." Haz clic en Siguiente para continuar.

    2. En la siguiente pantalla, Origen, selecciona el botón de opción para Eliminar, luego haz clic en Siguiente. En la pantalla siguiente, utiliza el menú desplegable para seleccionar la operación de eliminación (por ejemplo, "Ejemplo de Eliminar Tarea de Clarizen"), luego haz clic en Finalizar.

    3. La pestaña de Transformaciones debería abrirse donde puedes completar tu mapeo. Usa el + para expandir los elementos de origen y objetivo en cada árbol. Luego arrastra y suelta cada campo que te gustaría mapear de un árbol al otro. Arrastra el campo 'id' del lado de entrada al campo 'id' del lado de salida. Tu mapeo de transformación debería verse similar al que se muestra a continuación:

      attachment

  • 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

    Información adicional sobre las estructuras de respuesta se proporciona en Transformaciones.

    1. En la primera pantalla, Nombre, proporciona un Nombre para tu transformación o déjalo como el predeterminado. Luego utiliza el menú desplegable Objetivo para seleccionar "Respuesta de Función de Clarizen". Haz clic en Siguiente para continuar.

    2. En la siguiente pantalla, Objetivo, selecciona el botón de opción para Eliminar, luego haz clic en Siguiente. En la pantalla siguiente, utiliza el menú desplegable para seleccionar la operación de eliminación (por ejemplo, "Ejemplo de Eliminar Tarea de Clarizen"), luego haz clic en Finalizar.

    3. La pestaña Transformaciones debería abrirse donde puedes completar tu mapeo. Usa el + para expandir los lados de origen y destino. En este ejemplo, crearemos la respuesta de salida para que incluya el ID, el estado y cualquier mensaje de error en la respuesta. Haz clic y arrastra la carpeta "OUTPUT" desde el lado izquierdo (lado de origen) a la carpeta "OUTPUT" en el lado derecho (lado de destino). Tu pantalla de mapeo ahora debería verse similar a la de abajo.

      attachment

Desplegando y ejecutando la operación

Con la actividad de actualización de Clarizen completamente configurada, estamos listos para desplegar y ejecutar la operación.

  1. Desde la pestaña Operaciones, haz clic en el icono de desplegar attachment.

  2. Luego haz clic en el icono de ejecutar attachment para colocar la operación en la cola para su ejecución.

  3. En la parte inferior de la pantalla, el Monitor de operaciones debería indicar que tu operación se ejecutó con éxito. Si no, puedes hacer doble clic en el icono de Estado para ver cualquier mensaje de registro.

    attachment

  4. También deberías ver ahora la respuesta de salida que se mapeó a tu archivo de destino. En el ejemplo, el archivo ahora se crea en 'C:\ClarizenSampleFiles\ClarizenDelete_Task_Response.xml'. Dado que la operación se ejecutó con éxito, vemos el ID de la tarea en Clarizen y un estado de '1' que indica éxito.

    <ns:OUTPUT xmlns:ns="urn:czoln-res:document:czoln:oln:entities">
        <Task>
            <id>jw47joqmno25rh7l5azcmo3o26</id>
            <status>1</status>
        </Task>
    </ns:OUTPUT>
    
  5. Además, cuando verifiques tu instancia de Clarizen, deberías encontrar que la tarea eliminada ya no existe.

    attachment