Redmine Integration

Connect with a project management tool – Redmine and associate Redmine tickets to Astah diagrams.

Details

Compatible with
Astah Professional 6.6 and UML or later and SysML 1.2 or later
Latest Version
1.0.0 (Jan. 17, 2018)
Developer
Change Vision, Inc.
Support
No technical support is provided.
Access on GitHub Download

Installation Instructions:

  1. Download the plug-in file.
  2. In Astah, go to [Plugin] – [Installed Plugin].
  3. In the dialog, click [Install] and select the downloaded .jar file.
  4. Restart Astah and create a new project or open an existing one.
  5. The installation is complete if the [Redmine Tickets] tab appears below the Diagram Editor. If it doesn’t, go to [View] – [Show/Hide Extra View] to open it.
    Redmine Tickets tab in Astah
  6. Continue with Setting up.

How to Use

 

Setting up

  1. Before the Astah project is linked to Redmine, the [Redmine Tickets] tab looks like this.
    Redmine Tickets tab before setup
  2. Enter the Redmine URI, your API access key and the Redmine project ID.
    Redmine connection fields and Paste buttons
  3. When all the fields are filled in, click [Setup Redmine].
    Setup Redmine button
  4. If the connection to Redmine succeeds, buttons such as [Add Ticket] appear in the [Redmine Tickets] tab.
    Redmine Tickets tab after setup

Note 1: To paste values into these fields, use the [Paste] button next to each field. Keyboard shortcuts do not work here.

Note 2: “Redmine project name” means the project identifier, not the display name of the project.

 

Creating a ticket

  1. Click [Add Ticket]. Your browser opens the Redmine page for creating a new ticket.
    Add Ticket button
  2. On the Redmine ticket page, set the ticket properties, such as the subject and priority. Then click [Sync: astah*<-Redmine] in the [Redmine Tickets] tab to import the ticket information.
    Sync astah from Redmine button

 

Showing ticket lists

  • Each ticket is associated with one diagram. When you switch diagrams, the list updates to show the tickets for the selected diagram.
  • The [All Tickets] button shows the tickets for all the diagrams in the open Astah project.
    All Tickets button
  • Click a column header to sort the list by that column.
  • You can adjust the width of each column.
  • Click a ticket number or subject to open the ticket in Redmine in your browser. After you update the ticket there, click [Sync: astah*<-Redmine] to sync it.
  • Click a diagram name in the table to open that diagram. The table then shows the tickets for that diagram.

 

Ticket data in an Astah project

  • The Redmine information (URI, API access key and project ID) and the ticket information for each diagram are saved in the Astah file. When you open the project again, the table is restored.
    • If Astah cannot connect to Redmine when you open the project, the data is not restored.
    • Because the API access key is saved in the Astah file, anyone who has the file can see it. Keep this in mind when you share the file.

 

Others

  • The column widths are restored when you click [Sync: astah*<-Redmine], and saved in the Astah file when you save the project.

 

Existing bug

  • If you open an Astah project right after launching Astah, the Redmine information sometimes fails to restore. In that case, open another project, then open the project you wanted again. The data is then restored.

 

Special Thanks!