Actividad de búsqueda de Jira
Introducción
Una actividad de Búsqueda de Jira, utilizando su conexión de Jira, recupera datos de objetos de un proyecto de Jira y está destinada a ser utilizada como una fuente para proporcionar datos en una operación.
Crear una actividad de búsqueda de Jira
Una instancia de una actividad de Búsqueda de Jira se crea a partir de una conexión de Jira utilizando su tipo de actividad Búsqueda.
Para crear una instancia de una actividad, arrastre el tipo de actividad al lienzo de diseño o copie el tipo de actividad y péguelo en el lienzo de diseño. Para más detalles, consulte Crear una instancia de actividad o herramienta en Reutilización de componentes.
Una actividad de Búsqueda de Jira existente se puede editar desde estas ubicaciones:
- El lienzo de diseño (consulte Menú de acciones de componentes en Lienzo de diseño).
- La pestaña Componentes del panel del proyecto (consulte Menú de acciones de componentes en Pestaña de componentes del panel del proyecto).
Configurar una actividad de búsqueda de Jira
Siga estos pasos para configurar una actividad de Búsqueda de Jira:
-
Paso 1: Ingrese un nombre y seleccione un proyecto
Proporcione un nombre para la actividad y seleccione un proyecto. -
Paso 2: Seleccione un objeto
Seleccione un objeto. -
Paso 3: Especifique configuraciones
Especifique los criterios de búsqueda. -
Paso 4: Revise los esquemas de datos
Se mostrarán los esquemas de solicitud o respuesta.
Paso 1: Ingrese un nombre y seleccione un proyecto
En este paso, proporciona un nombre para la actividad y selecciona un proyecto. 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 Jira y no debe contener barras diagonales
/
ni dos puntos:
. -
Seleccionar un Proyecto: Esta sección muestra los proyectos disponibles en el punto final de Jira.
-
Proyecto de Jira Seleccionado: Después de seleccionar un proyecto, se lista aquí.
-
Buscar: Ingresa el valor de cualquier columna en el cuadro de búsqueda para filtrar la lista de proyectos. La búsqueda no distingue entre mayúsculas y minúsculas. Si los proyectos ya se muestran en la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para recargar proyectos desde el punto final al buscar, ingresa criterios de búsqueda y luego actualiza, como se describe a continuación.
-
Actualizar: Recarga los proyectos desde el punto final de Jira. Esto puede ser útil si se han agregado proyectos a Jira. Esta acción actualiza todos los metadatos utilizados para construir la tabla de proyectos mostrada en la configuración.
-
Seleccionando un proyecto: Dentro de la tabla, haz clic en cualquier parte de una fila para seleccionar un proyecto. Solo se puede seleccionar un proyecto. La información disponible para cada proyecto se obtiene del punto final de Jira:
-
Nombre: El nombre del proyecto.
-
Descripción: La descripción del proyecto.
-
Consejo
Si la tabla no se llena con proyectos disponibles, la conexión de Jira puede no haber sido exitosa. Asegúrate de estar conectado volviendo a abrir la conexión y volviendo a probar las credenciales.
-
-
Configuraciones opcionales: Haz clic para expandir esta configuración opcional:
- Fallar la operación en caso de error: Selecciona para forzar que una operación devuelva un
Error
estado de operación cuando la carga útil de respuesta de la API de Jira contenga un código de estado no exitoso. Cuando no está seleccionada (por defecto), la carga útil de respuesta debe ser verificada para determinar su éxito en Jira.
- Fallar la operación en caso de error: Selecciona para forzar que una operación devuelva un
-
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 al siguiente paso. La configuración no se guardará hasta que haga clic en el botón Finalizado 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 pide que confirme que desea descartar los cambios.
Paso 2: Seleccionar un objeto
En este paso, seleccione un objeto. Cada elemento de la interfaz de usuario de este paso se describe a continuación.
-
Seleccionar un objeto: Esta sección muestra los objetos disponibles en el punto final de Jira.
-
Proyecto de Jira seleccionado: El proyecto de Jira seleccionado en el paso anterior se lista aquí.
-
Objeto de Jira seleccionado: Después de seleccionar un objeto, se lista 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 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, ingrese criterios de búsqueda y luego actualice, como se describe a continuación.
-
Actualizar: Recarga los objetos desde el punto final de Jira. Esto puede ser útil si se han agregado objetos a Jira. Esta acción actualiza todos los metadatos utilizados para construir la tabla de objetos mostrada en la configuración.
-
Seleccionando 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 punto final de Jira:
-
Nombre: El nombre del objeto.
-
Descripción: La descripción del objeto.
-
Consejo
Si la tabla no se llena con objetos disponibles, la conexión de Jira puede no ser exitosa. Asegúrese de estar conectado volviendo a abrir la conexión y volviendo a probar las credenciales.
-
-
Atrás: Haz clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.
-
Siguiente: Haz clic para almacenar temporalmente la configuración de 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 3: Especificar configuraciones
En este paso, especifica los criterios de búsqueda. Cada elemento de la interfaz de usuario de este paso se describe a continuación.
Consejo
Los campos con un ícono de variable admiten el uso de variables globales, variables de proyecto y variables de Jitterbit. Comienza escribiendo un corchete cuadrado abierto [
en el campo o haciendo clic en el ícono de variable para mostrar una lista de las variables existentes de las que elegir.
-
JQL: Ingresa los criterios de búsqueda utilizando la sintaxis del lenguaje de consulta de Jira (JQL). Se admiten variables globales en la declaración JQL.
Nota
Puedes usar el campo JQL para especificar múltiples proyectos (más allá del proyecto especificado en Paso 1).
-
Expandir (solo para problemas y proyectos): Ingresa una lista de entidades separadas por comas que deseas incluir en la respuesta. Estas entidades no se devuelven por defecto y se pueden especificar:
Entidad Descripción renderedFields
Devuelve los valores de los campos renderizados en formato HTML. names
Devuelve el nombre de visualización de cada campo. schema
Devuelve el esquema que describe un tipo de campo. transitions
Devuelve todas las transiciones posibles para el problema. operations
Devuelve todas las operaciones posibles para el problema. editmeta
Devuelve información sobre cómo se puede editar cada campo. changelog
Devuelve una lista de actualizaciones recientes a un problema, ordenadas por fecha, comenzando por la más reciente. Importante
Cuando se especifica una entidad en este campo, se debe editar el esquema de respuesta (en paso 4) para incluir cada entidad como un campo en el esquema. De lo contrario, los datos de la entidad no se incluirán en la respuesta.
Nota
Este campo solo funciona al interactuar con proyectos o problemas de Jira (especificados en paso 2).
-
Resultados máximos: Ingrese el número máximo de resultados a devolver en una página. Si no se especifica, se devuelven todos los registros del objeto seleccionado sin paginación.
-
Comenzar en: Ingrese el índice del primer elemento que se devolverá en la página.
-
Atrás: Haga clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.
-
Siguiente: Haga clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que haga clic en el botón Finalizado 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 pedirá que confirme que desea descartar los cambios.
Paso 4: 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: Estos esquemas de datos son heredados por transformaciones adyacentes y se muestran nuevamente durante el mapeo de transformaciones.
Nota
Los datos suministrados en una transformación tienen prioridad sobre la configuración de la actividad.
El conector de Jira utiliza la API REST de Jira v3 para el tipo de instancia Jira Cloud y la API REST de Jira v2 para el tipo de instancia Jira On-premise. Consulte la documentación de la API para obtener información sobre los nodos y campos del esquema.
Información
Para instancias de Jira Cloud, Atlassian ha descontinuado su JQL (POST) punto final de API. A partir de la versión Harmony 11.50, la actividad de Búsqueda ahora utiliza la búsqueda mejorada de JQL (POST). Consulte el registro de cambios de Atlassian para ver las diferencias entre los nuevos y antiguos puntos finales de API.
-
Actualizar: Regenera esquemas desde el punto final de Jira. 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.
-
Editar: Permite ingresar al editor para el esquema de datos. El editor permite agregar, eliminar y reorganizar nodos y campos, así como cambiar sus tipos de datos. Todos los nodos y campos recién agregados se establecen en
[0, 1]
cardinalidad. Los cambios realizados en los esquemas de datos deben ser aceptables para el punto final y deben hacerse solo después de consultar cualquier documentación disponible para el punto final. Después de realizar ediciones en el esquema, se muestra una fecha de última edición en la parte superior del esquema aplicable para indicar que el esquema ha tenido ediciones manuales. Actualizar los esquemas restablecerá los esquemas a sus estructuras predeterminadas. -
Atrás: Haga clic para almacenar temporalmente la configuración para este paso y regresar al paso anterior.
-
Terminado: Haga clic para guardar la configuración para todos los pasos y cerrar la configuración de la actividad.
-
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 pide que confirme que desea descartar los cambios.
Siguientes pasos
Después de configurar una actividad de Búsqueda de Jira, complete la configuración de la operación agregando y configurando otras actividades o herramientas como pasos de operación. También puede 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 Jira pueden usarse 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 usar la actividad con funciones de scripting, escribe los datos en una ubicación temporal y luego usa 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 operación.