EA Connector for Jira - Guía de Usuario Contenidos 1 Contenidos 2 Introducción 3 Punto de Partida 4 Configuración de "EA Connector for Jira " 4.1 Establecimiento de la conexión con JIRA: 4.2 Mapeo de elementos entre Enterprise Architect y JIRA: 4.3 Modificación del idioma de complemento 5 Exportación de Elementos 6 Reexportación de Elementos 7 Importación de Elementos 8 Reimportación / Sincronzación 9 Usuario de GreenHopper? Sin problema! 10 Soporte Introducción El objetivo de este documento es explicar en detalle la operativa desde el punto de vista del usuario del software "EA Connector For Jira " para su correcto funcionamiento. Para ello, se describirán los pasos para exportar, importar y mantener sincronizados un conjunto de elementos entre las herramientas Enterprise Architect y Jira durante todo el ciclo de vida de los mismos. Punto de Partida Durante el desarrollo de este manual, se va a emplear el ejemplo que se describe a continuación. Se toma como punto de partida un Repositorio de Enterprise Architect en el que existe un conjunto de Requisitos Funcionales. Dichos elementos forman parte de un Perfil UML, y tienen un contenido como el que muestra el siguiente diagrama:
Configuración de "EA Connector for Jira " Establecimiento de la conexión con JIRA: Esta tarea solo deberá realizarla si un Administrador no la ha realizado por usted. Consulte EA Connector for Jira - Guía de Instalación si necesita conocer cómo establecer la conexión con la instancia de Jira. Mapeo de elementos entre Enterprise Architect y JIRA: Esta tarea solo deberá realizarla si un Administrador no la ha realizado por usted. Consulte EA Connector for Jira - Guía de Instalación si necesita conocer cómo establecer el Mapeo de Tipos y Campos entre Enterprise Architect y Jira. Modificación del idioma de complemento 1. Abrir Enterprise Architect, y acceder al menú Extensions EA Connector for Jira Cambiar Idioma 2. Definir el idioma y pulsar Aceptar : Exportación de Elementos Para realizar un proceso de Exportación de elementos de Enterprise Architect a Jira, es preciso seguir los siguientes pasos: 1. Seleccionar el Paquete que contenga los elementos que se desee exportar. 2. Ejecutar el menú Extensions EA Connector for Jira Exportar a Jira 3. En caso de no existir una autenticación previa, el complemento solicitará que se efectúe de cara a ofrecer una vista personalizada de los Proyectos de Jira a los que el usuario tenga acceso:
IMPORTANTE: Hay que tener en cuenta que el usuario que se autentique en el sistema será considerado como el Informador de las incidencias que se vayan a crear en Jira como consecuencia dela Exportación. 4. Se mostrará la ventana de Exportación de elementos. 5. Seleccionar en el desplegable Exportación de elementos al Proyecto el Proyecto de Jira al que se desea exportar los elementos, así como el Mapeo de Tipos que desea utilizar en el desplegable Seleccionar Mapeo de Tipos. Una vez seleccionado, se mostrarán los elementos que pueden ser exportados junto con un icono que indica su estados de sincronía (nuevos, modificados, eliminados y sin cambios). 6. Junto a cada icono, es posible activar o desactivar la casilla correspondiente para activar o desactivar todos los elementos que se encuentren en dicho estado de sincronía 7. Indicar mediante la casilla "Exportar Linked Documents" si se desea exportar los "Linked Documents" de los elementos de Enterprise Architect en caso de existir. Éstos serán creados como ficheros "Adjuntos" en la incidencia en Jira. Nota Tenga en cuenta que la exportación de "Linked Documents" puede alargar el proceso de exportación en función del tamaño de éstos.
8. Pulsar el botón Exportar para comenzar el proceso de exportación. Durante dicho proceso, se puede observar el avance en la exportación así como el estado de exportación de cada elemento. 9. Una vez finalizado el proceso de exportación, se mostrará el siguiente mensaje: 10. Por último, cerrar la ventana con el botón Cerrar :
11. Una vez finalizadala Exportación, los elementos en Enterprise Architect han recibido CUATRO actualizaciones: a) El Estado del elemento en EA será el estado que la incidencia tenga en Jira b) El Alias o el Tagged Value especificado (según el Mapeo establecido) del artefacto en Enterprise Architect será el Issue Key de la incidencia relacionada en Jira. c) Si se ha configurado en el Mapeo, la Prioridad aparecerá como un Tagged Value. d) En la pestaña Files de la ventana de propiedades del artefacto en Enterprise Architect aparecerá un hipervínculo a la URL de la incidencia que representa a dicho artefacto en Jira. 12. Las siguientes imágenes muestran ejemplos de estas cuatro actualizaciones: Diagrama con Estados, Prioridades y "Alias" actualizados Link a la URL
En cada Requisito recién exportado, se puede ver el color rojo (perteneciente al estado Proposed en la configuración del Repositorio de este ejemplo), el Alias correspondiente al Issue Key de la incidencia en Jira y el Tagged Value "Priority" con el valor exportado (en caso de haberlo establecido previamente a la exportación) o recibido de Jira (en caso de no haberse exportado, Jira habrá asignado una Prioridad por defecto). Pestaña Files de la ventana de propiedades de un recién exportado, en la que se puede ver el hipervínculo a la URL que contiene la correspondiente incidencia en Jira. 12. Se puede proceder a comprobar cómo han sido creadas las incidencias en Jira. Las siguientes imágenes muestran un ejemplo de la comprobación de la exportación: Reexportación de Elementos
En cualquier momento que el usuario desee, es posible realizar una reexportación de elementos desde Enterprise Architect hacia Jira. Esto puede ser útil, por ejemplo, cuando se han realizado modificaciones en los artefactos de EA que se desean propagar a Jira o bien cuando se han creado o eliminado artefactos de un Paquete previamente exportado. A continuación se va a explicar cómo los cambios que eventualmente se realicen en Enterprise Architect pueden ser trasladados a los elementos correspondientes en Jira a través de una reexportación. Para ello, se ha procedido a eliminar el Requisito "EAJIRA-12", se ha modificado la descripción (Notes) del Requisito "EAJIRA-9" y se ha creado un nuevo Requisito cuyo nombre es "Landing module": Tras estas modificaciones: 1. En primer lugar se selecciona el Paquete que contiene los elementos a reexportar, y se selecciona el menú Extensions EA Connector for Jira Exportar a Jira. 2. En caso de no existir una autenticación previa, el complemento nos solicitará que se efectúe de cara a ofrecer una vista personalizada de los Proyectos de Jira a los que el usuario tenga acceso. 3. Seleccionar en el desplegable el Proyecto de Jira al que se desea reexportar los elementos. Una vez
seleccionado, se mostrarán los elementos que pueden ser exportados junto con un icono que indica su estado de sincronía (nuevos, modificados, eliminados y sin cambios). 4. Junto a cada icono, es posible activar o desactivar la casilla correspondiente para activar o desactivar todos los elementos que se encuentren en dicho estado de sincronía: 5. El color del icono representa el estado del elemento respecto a la incidencia correspondiente en Jira. Los códigos de color son: Color Significado Consecuencia de marcar el elemento Elementos que se han creado en EA y que aún no existen en Jira o bien elementos que se han eliminado en Jira y que aun existen en EA Elementos modificados en EA Se creará el elemento en Jira Se exportarán las modificaciones de EA a Jira
Elementos eliminados en EA que aún existen en Jira Elementos idénticos (sin modificaciones) en ambas herramientas Se eliminará el elemento en Jira Se reexportará el elemento a Jira 6. Para este ejemplo, se procede a reexpotar únicamente el elemento creado ("Landing module") y el elemento modificado ("EAJIRA-9"). La selección del elemento "EAJIRA-12 - Vulcan language" implicaría el borrado en Jira de la correspondiente incidencia. 7. Pulsar el botón Exportar para comenzar el proceso de exportación. Durante dicho proceso, se puede observar el avance en la exportación así como el estado de exportación de cada elemento. 8. Una vez finalizado el proceso de exportación, se mostrará el siguiente mensaje:
9. La ventana de Exportación presentará el resultado de la reexportación de cada elemento seleccionado. Por último, se cierra la ventana con el botón Cerrar : Importación de Elementos En cualquier momento que el usuario desee, es posible realizar una importación de elementos de Jira a Enterprise Architect. Para este ejemplo, se ha procedido a eliminar en Enterprise Architect todos los elementos creados en los
puntos anteriores, trabajando sobre un Paquete completamente vacío. Esto permite simular una Importación completa de las incidencias creadas en Jira sobre un entorno vacío en Enterprise Architect. 1. En primer lugar se selecciona el Paquete en el que se desea alojar los elementos importados, y se selecciona el menú Extensions EA Connector for Jira Importar desde Jira. 2. En caso de no existir una autenticación previa, el complemento solicitará que se efectúe de cara a ofrecer una vista personalizada de los Proyectos de Jira a los que el usuario tenga acceso: 3. Aparecerá la ventana de importación de elementos. En ella, se selecciona en el desplegable el Proyecto o Filtro Jira que se desea importar al Paquete de Enterprise Architect, junto con el Mapeo de Tipos a utilizar en la importación:
4. El complemento mostrará los elementos a importar / sincronizar, e informará del estado de sincronía de cada elemento, identificándolo con un color diferente. Color Significado Consecuencia de marcar el elemento Elementos que se han creado en Jira y que aún no existen en EA o elementos que se han eliminado en EA y que aun existen en Jira Elementos modificados en Jira Elementos eliminados en Jira que aún existen en EA Elementos idénticos (sin modificaciones) en ambas herramientas Se creará el elemento en EA Se importarán las modificaciones de Jira a EA Se eliminará el elemento en EA Se reimportará el elemento a EA 5. Se seleccionan los elementos a importar y/o sincronizar y se pulsa el botón Actualizar :
6. Una vez finalizado el proceso de importación, aparecerá el mensaje: 7. La ventana de Importación mostrará el estado de la importación de cada incidencia. Tras eso, pulsar el botón "Cerrar".
8. Una vez finalizada la Importación, las incidencias en Jira habrán recibido UNA actualización: a) El GUID de los elementos creados en EA será ubicado en el Custom Field de Jira especificado en el mapeo. 9. Se puede proceder a comprobar cómo han sido importados y sincronizados los elementos en Enterprise Architect. Las siguientes imágenes muestran un ejemplo de la comprobación de la importación: Vista del Project Browser con los elementos importados Representación efectuada manualmente en el diagrama de Requisitos
Reimportación / Sincronzación Como último ejemplo, se va a proceder a efectuar modificaciones en Jira que posteriormente serán importadas a los correspondientes elementos en Enterprise Architect. Se van a efectuar las siguientes modificaciones en Jira: Insertar comentarios en incidencias Denegar dos Requisitos (transición de Workflow en Jira) Eliminar un Requisito Crear un nuevo Requisito en Jira Se procede a cada uno de ellos: 1. Insertar comentarios en las incidencias EAJIRA-9 y EAJIRA-6:
2. Denegar los Requisitos EAJIRA-9 y EAJIRA-6 (transición de Workflow en Jira): 3. Eliminar un Requisito:
4. Crear un nuevo Requisito en Jira: 5. Tras efectuar las modificaciones, se procede a ejecutar en Enterprise Architect el menú "Extensions EA Connector for Jira Importar desde Jira...". 6. Tras indicar el Proyecto y el Mapeo de Tipos, la ventana mostrará el estado de sincronía de los elementos:
7. Seleccionar los elementos a importar / sincronizar y pulsar el botón "Actualizar":
8. Tras el proceso, se mostrará el mensaje: 9. La ventana de Importación mostrará el estado de la importación / sincronización de cada elemento:
10. En Enterprise Architect estarán disponibles las últimas modificaciones efectuadas en Jira sobre los elementos. En este ejemplo final, se ha procedido también a la Aprobación en Jira de 4 Requisitos (mostrados en verde) cuyo estado también se ha actualizado en Enterprise Architect:
Usuario de GreenHopper? Sin problema! En caso de que sea usuario del complemento GreenHopper para Jira, no existe ninguna incompatibilidad que impida trabajar con "EA Connector for Jira " y dicho complemento: Soporte
En caso de tener consultas o problemas en la utilización de "EA Connector for Jira ", puede registrarse en nuestro entorno de Soporte y crear los tickets necesarios.