Actividad de búsqueda de Zendesk

Introducción

Una actividad de Búsqueda de Zendesk, utilizando su conexión de Zendesk, recupera un objeto de Zendesk y está destinada a ser utilizada como una fuente para proporcionar datos en una operación.

Límites de tasa

La API REST de Zendesk, que es utilizada por el conector de Zendesk, impone una serie de límites de tasa dependiendo de varios factores. Lee sobre los límites en la documentación de Zendesk.

Crear una actividad de búsqueda de Zendesk

Una instancia de una actividad de Búsqueda de Zendesk se crea a partir de una conexión de Zendesk utilizando su tipo de actividad Búsqueda.

Para crear una instancia de una actividad, arrastra el tipo de actividad al lienzo de diseño o copia el tipo de actividad y pégalo en el lienzo de diseño. Para más detalles, consulta Crear una instancia de actividad o herramienta en Reutilización de componentes.

Una actividad de Búsqueda de Zendesk existente se puede editar desde estas ubicaciones:

• El lienzo de diseño (consulta Menú de acciones de componentes en Lienzo de diseño).
• La pestaña Componentes del panel del proyecto (consulta Menú de acciones de componentes en Pestaña de componentes del panel del proyecto).

Configurar una actividad de búsqueda de Zendesk

Sigue estos pasos para configurar una actividad de Búsqueda de Zendesk:

• Paso 1: Ingresa un nombre y selecciona un objeto
  Proporciona un nombre para la actividad y selecciona un objeto.

• Paso 2: Revisar los esquemas de datos
  Se muestran los esquemas de solicitud o respuesta.

Paso 1: Ingresar un nombre y seleccionar un objeto

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

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

• Seleccionar un Objeto: Esta sección muestra los objetos disponibles en el punto final de Zendesk.

  • Objeto Zendesk 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 punto final 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 punto final de Zendesk. Esto puede ser útil si se han agregado objetos a Zendesk. Esta acción actualiza todos los metadatos utilizados para construir la tabla de objetos mostrados 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 punto final de Zendesk:

    • Nombre: El nombre del objeto de Zendesk.

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

  Consejo

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

• Número de Página: El número de páginas que se devolverán. El valor predeterminado es 1. Debes establecer este campo en uno más que el número esperado de páginas. Por ejemplo, para recuperar 350 registros, establece un límite de paginación de 5 o más, ya que necesitas cuatro páginas (3 de 100 y 1 de 50) más una página adicional vacía que interrumpe el flujo.

• Tamaño de Página: El número de resultados por página que se devolverán. El valor predeterminado es 100, que también es el máximo. Si alteras este campo, es posible que necesites recalcular cuántas páginas necesitas en el campo Número de Página arriba.

• Siguiente: Haz clic para almacenar temporalmente la configuración para 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: Revisar los esquemas de datos

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

• Esquemas de Datos: Se mostrarán los esquemas de datos de solicitud y respuesta para Zendesk. Si la operación utiliza una transformación, los esquemas de datos se mostrarán nuevamente más adelante durante el proceso de mapeo de transformación, donde podrás mapear a campos de destino utilizando objetos de origen, scripts, variables, valores personalizados y más.

  Nota

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

  El conector de Zendesk utiliza la API Rest de Zendesk; consulta la API para obtener información sobre los campos de esquema de los objetos soportados.

  Los esquemas de datos de solicitud y respuesta constan de estos nodos y campos:

  • Solicitud:

    Campo/Nodo del Esquema de Solicitud	Notas
    searchRequest	Solicitud de búsqueda
    pageNumber	El número de páginas que se devolverán. El máximo es 10.
    pageSize	El número de resultados por página que se devolverán. El máximo es 100
    criteria	El nodo que contiene los criterios de búsqueda que limitan aún más la búsqueda
    item	El nodo del ítem que contiene los criterios de búsqueda
    property	Una [palabra clave de propiedad de grupo], ya sea name o created
    operator	Un [operador de búsqueda], uno de :, <, >, <=, >=, " ", -, o *
    searchTerm	Un [término de búsqueda] que consiste en una palabra, frase o valor definido por el usuario

    Nota

    La API REST de Zendesk devuelve hasta 1,000 resultados por consulta, con un máximo de 100 resultados por página. Si se solicita un número de páginas más allá del límite (por ejemplo, especificando un pageNumber de 11 con un pageSize máximo de 100 resultados por página), se devuelve un error 422 de Recursos Insuficientes.

    Si necesita recuperar grandes conjuntos de datos, Zendesk recomienda dividir la búsqueda en partes más pequeñas limitando los resultados a un rango de fechas específico.

  • Respuesta:

    Campo/Nodo del Esquema de Respuesta	Notas
    searchResponse	Respuesta de búsqueda
    records	El nodo de registros devueltos por la búsqueda
    item	El nodo del elemento del registro
    deleted	Un booleano que indica si el grupo está marcado como eliminado
    updated_at	La hora de la última actualización del grupo
    name	El nombre del grupo
    created_at	La hora en que se creó el grupo
    id	Un entero asignado durante la creación del grupo
    url	La URL de la API del grupo
    nextPage	Cuando los resultados no caben todos en una página, este campo muestra la URL de la siguiente página. El valor por defecto es null
    count	Número de resultados
    prevPage	Cuando los resultados no caben todos en una página, este campo muestra la URL de la página anterior. El valor por defecto es null

    Nota

    La propiedad count muestra el número real de resultados. Por ejemplo, si hay 5,000 resultados, el valor de count será 5,000, incluso si la API solo devuelve los primeros 1,000 resultados.

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

• Regresar: Haz clic para almacenar temporalmente la configuración de este paso y volver 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 Búsqueda de Zendesk, completa la configuración de la operación agregando y configurando otras actividades o herramientas como pasos de operación. También puedes configurar la configuración de la operación, que incluye 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 Búsqueda de Zendesk se pueden utilizar como fuente con estos patrones de operación:

• Patrón de transformación
• Patrón de archivo de dos objetivos (como la primera fuente únicamente)
• Patrón de archivo HTTP de dos objetivos (como la primera fuente únicamente)
• Patrón de dos transformaciones (como la primera o segunda fuente)

Para utilizar 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 la operación.