The aim of this guide is to explain in detail the user operationating point of view of "EA Connector for Jira ".

Transcription

1 User Guide Contents Contents Introduction Get Started "EA Connector for Jira " Configuration Establishing a connection with JIRA: Elements mapping between Enterprise Architect y JIRA: Changing Language Export Elements Reexport Elements Import Elements Reimport / Synchronization GreenHopper user? No problem! Support Introduction The aim of this guide is to explain in detail the user operationating point of view of "EA Connector for Jira ". It will describe the steps to export, import and maintain synchronized a set of items between Enterprise Architect and Jira during the entire life cycle. Get Started All the explanations used in this guide are based in the example described below. Given as the starting point an Enterprise Architect Repository in which there are a set of Functional Requirements. These elements are part of an UML profile, and its contents are like shown in the following diagram:

2 "EA Connector for Jira " Configuration Establishing a connection with JIRA: You have to do this point if a manager has not already done it for you. Refer to the Installation Guide if you need to know how to set up the connection with the Jira instance. Elements mapping between Enterprise Architect y JIRA: You have to do this point if a manager has not already done it for you. Refer to the Installation Guide if you need to know how to set up the mapping of elements and fields between Enterprise Architect and Jira. Changing Language 1. Open Enterprise Architect, and access the Menu Extensions EA Connector for Jira Change Language 2. Select the language and click OK : Export Elements To perform an element export process to Jira, you must follow the following steps: 1. Select the Package that contains the elements that you want to export. 2. Open the Extensions EA Connector for Jira Export to Jira menu. 3. In the absence of a prior authentication, the Add-In is going to request you to authenticate, in order to provide a customized view of Jira projects for which your user has permissions: IMPORTANT: Keep in mind that the user that is authenticated in the system will be considered as the Informer of the Issues to be created in Jira as a result of the export process.

3 4. This will display the elements Export window: 5. Select from the drop down Element export to Project the Jira project that it is desired to export the elements as well as the Type Mapping to be used in the drop down Select Types Mapping. Once selected, you will see the elements that can be exported with an icon indicating the state of synchronization (new, modified, deleted and no changes). The icon color represents the element status respect the corresponding Jira issue. The color codes are: Color Meaning Marking item... Elements that have been created in EA and still do not exist in Jira or elements that have been deleted in Jira and still exist in EA The element will be created in Jira Elements modified in EA The EA modifications will be exported to Jira Elements deleted in EA that still exist in Jira The element will be deleted in Jira

4 Identical elements (unchanged) in both tools The element will be re-exported to Jira 6. Next to each icon, it is possible to activate or deactivate the checkbox to enable or disable all the elements that are in the same status of synchrony. 7. Check the "Export Linked Documents" checkbox if you wish to export the "Linked Documents" of Enterprise Architect elements, if any. These "L inked Documents" will be created as "Attachments" in the Jira issue. Note Note that the export of "Linked Documents" can extend the export process depending on their size.

5 8. Click Export button to start the export process. During this process, you can see the progress and the export status of each item. 9. Once the process is done, the following message is displayed: 10. Finally, close the window by clicking Close button:

6 11. Once the export is done, each Enterprise Architect element has received 4 updates: a) The element status in Enterprise Architect will be the same that the element has in Jira b) The element Alias or the Tagged Value (it depends on the mapping established) is the Jira Issue Key of the corresponding issue. c) If it has been set up the mappings, the Priority will be shown as a Tagged Value in Enterprise Architect. d) In the Files tab of the element properties window, will appear a hyperlink to the corresponding Jira issue URL. 12. The following images show examples of these 4 updates: Diagram with updated Statuses, Priorities and Aliases URL hyperlink

7 In each exported Requirement, you will see the red color (related to the "Proposed" status in the Repository configuration), the Alias corresponding to the Jira "Issue Key" and the "Priority" Tagged Value with the exported value (in case of this value has been set prior the export) or received from Jira (in case of not being exported, then Jira sets a default value). Properties window "Files" tab of an exported element, in which you can see the hyperlink to the URL that references the Issue in Jira. 13. You can now proceed to verify how the Issues have been created in Jira. The following images show an example of the export verification process: Reexport Elements Whenever the user desires, it is possible to re-export the elements from Enterprise Architect to Jira. This can be useful, for example, when there have been changes made in Enterprise Architect elements that you want to send to Jira or when you have created or removed elements from a previously exported package. The following example will explain how changes in Enterprise Architect can be transferred to the corresponding elements in Jira through a reexport. To do this, we have proceeded to delete the requirement "EAJIRA-36", the Requirement "EAJIRA-33" description (Notes) has been changed and we have created a new requirement named "Landing module":

8 After these modifications: 1. First, select the package that contains the items to re-export and select the Extensions EA Connector for Jira Export to Jira " menu. 2. In the absence of a prior authentication, the Add-In is going to request you to authenticate, in order to provide a personalized view of Jira projects for which your user has permissions. 3. The Element Export window is displayed. Select from the drop down "Export elements to Project" the Jira project which the elements are desired to be re-exported. Once selected, you will see the elements that can be re-exported with an icon indicating the state of synchronization (n ew, modified, deleted and no changes)., you will find the elements that can be exported with an icon indicating the status of sync (new, modified, deleted and no changes). 4. Next to each icon, it is possible to activate or deactivate the checkbox to enable or disable all the elements that are in the same status of synchrony.

9 5. The icon color represents the element status respect the corresponding Jira issue. The color codes are: Color Meaning Marking item... Elements that have been created in EA and still do not exist in Jira or elements that have been deleted in Jira and still exist in EA The element will be created in Jira

10 Elements modified in EA The EA modifications will be exported to Jira Elements deleted in EA that still exist in Jira The element will be deleted in Jira Identical elements (unchanged) in both tools The element will be re-exported to Jira 6. In this example, we proceeded to re-export only the created element ("Landing module") and the modified one ("EAJIRA-33"). The selection of the "EAJIRA-36 - Vulcan language" element will imply the corresponding Jira issue deletion.

11 7. Click Export button to begin the export process. During this process, you can see the progress and the status of each item. 8. Once the process is done, the following message will appear: 9. The Export window shows the re-export results for each selected element. Finally, close the window by clicking Close button:

12 Import Elements Whenever the user desires, it is possible to import / synchronize elements between Enterprise Architect and Jira. In this example, we have proceeded to delete in Enterprise Architect all the previously created elements, working on a completely empty package. This allows simulating a full import of issues created in Jira on an empty Enterprise Architect environment. 1. First, select the package that will be the target of the imported elements and select the Extensions EA Connector for Jira Import from Jira menu. 2. In the absence of a prior authentication, the Add-In is going to request you to authenticate, in order to provide a personalized view of Jira projects for which your user has permissions:

13 3. Once the authentication is done, the Import Elements window will appear. Select from the drop down the Jira Project or Filter from where you want to import to the Enterprise Architect Package, as well as the kind of mapping that is going to be used in the import process. 4. The Add-In list the elements to import and reports the synchronization status of each item, identifying it with a different color: Color Meaning Marking item...

14 Elements that have been created in Jira and still do not exist in EA or elements that have been deleted in EA and that still exist in Jira The element will be created in EA Elements modified in Jira The modifications will be imported from Jira to EA Elements deleted in Jira that still exist in EA The element will be deleted in EA Identical elements (unchanged) in both tools The element will be re-imported in EA

15 5. Select the elements that you want to Import and click Update button: 6. Once the Import process is done, the following message will appear: 7. The Import window shows the import results for each selected element. Finally, close the window by clicking Close button.

16 8. Once completed, the Jira issues have received ONE update: a) The GUID of the elements created in EA will be placed in the Jira Custom Field specified in the mapping.. 9. You can now proceed to verify how the elements have been imported in Enterprise Architect. The following images show an example of the verification process: Project Browser with the imported elements Manually requirements diagram representation

17 Reimport / Synchronization As a last example, we will proceed to make changes in Jira that will be later imported to the corresponding Enterprise Architect elements. We will make the following changes in Jira Insert issue Comments Deny two Requirements (Jira workflow transition) Delete a Requirement Create a new Requirement in Jira We proceed to each one of them: 1. Insert Jira Comments in EAJIRA-33 and EAJIRA-29 issues:

18 2. Deny the EAJIRA-33 y EAJIRA-29 Requirements (Jira workflow transition):

19 3. Delete a Requirement: 4. Create a new Requirement in Jira:

20 5. After this modification, we proceeded to click the "Extensions EA Connector for Jira Import from Jira..." menu. 6. Set the Jira Project and the Types Mapping:

21 7. The Add-In list the elements to import / synchronize and reports the synchronization status of each item, identifying it with a different color: Color Meaning Marking item... Elements that have been created in Jira and still do not exist in EA or elements that have been deleted in EA and that still exist in Jira The element will be created in EA

22 Elements modified in Jira The modifications will be imported from Jira to EA Elements deleted in Jira that still exist in EA The element will be deleted in EA Identical elements (unchanged) in both tools The element will be re-imported in EA 8. Select the elements to import / synchronize and click "Update":

23 9. Once the import / synchronization process is done, the following message will appear: 10. The Import window shows the import / synchronization results for each selected element. Finally, close the window by clicking Close button:

24 11. In Enterprise Architect will be available the latest modifications made in Jira. In this final example, we have proceeded to the Jira "Approve" of four Requirements too (shown in green) which status has also been updated in Enterprise Architect:

25 GreenHopper user? No problem! If you're a GreenHopper user, there isn't any incompatibility stopping you from working with "EA Connector for Jira ".

26 Support If you have any question or problem while using "EA Connector for Jira ", you will sign-up for an account in our Support environment and create support tickets as needed.