Redmine Plug-in

Connect to an open source project management application - Redmine and assocaite Redmine tickets to Astah Diagrams.

Versions


How to Install

Choose your edition.
      


How to Install on Astah Professional

  1. Download the Plug-in file by clicking the blue Download button at the top of this page.
  2. Launch Astah and drag the downloaded .jar file to an open instance of Astah. A pop-up will appear asking you to confirm installation, choose [Yes]
  3. If the pop-up opens, restart Astah and open any project.
    astah plugin menu
    The [Plugin] menu exists in Astah Professional version 7.2 or later. If you are using other editions, read FAQ.
  4. Now you will have [Redmine Tickets] tab below the Diagram Editor.

    If there is no window below the diagram editor, go to [View] - [Show/Hide Extra View] to open.
    Open Extra View
  5. Go to "How to Use - setup"

How to Install on Astah SysML

  1. Download the Plug-in file by clicking the blue Download button at the top of this page.
  2. Launch Astah and go to [Help] - [Plugin List].
    astah-sysml plugin menu
  3. Click [Install] button and select the .jar file you donwloaded.
    astah-sysml plugin menu
  4. Restart Astah and open any project.
    astah-sysml plugin menu
  5. Now you will have [Redmine Tickets] tab below the Diagram Editor. (This is a screenshot of Astah Professional.)

    If there is no window below the diagram editor, go to [View] - [Show/Hide Extra View] to open.
    Open Extra View
  6. Go to "How to Use - setup"

How to Install on Astah GSN

  1. Save the downloaded .jar file under Userhome/.astah/gsn/plugins
  2. Restart Astah and open any project
  3. Now you will have [Redmine Tickets] tab below the Diagram Editor. (This is a screenshot of Astah Professional.)

    If there is no window below the diagram editor, go to [View] - [Show/Hide Extra View] to open.
    Open Extra View
  4. Go to "How to Use - setup"



How to Use

Setting up

  1. The [Redmine Tickets] view will look like the figure below when the Astah project is not associated with Redmine yet.
    astah redmine
  2. Input Redmine URI, API access key and your redmine project name.
    NOTE1: Use the [Paste] button for each other than keyboard shortcuts.
    astah redmine
    Note2: ''Redmine project name'' means the project id, not the project names:
  3. After filling out all the items, you can push [Setup Redmine].
    astah redmine
  4. If connecting to Redmine is succeeded, you will see menu buttons on the [Redmine Tickets] view, e.g. [Add Ticket].
    astah redmine

Creating a ticket

  1. If you push [Add Ticket] button, a browser will launch and open the Redmine page where you can create new tickets.
    astah redmine
  2. In the ticket page of Redmine, you can update, fill out or set properties of the ticket, e.g. the ticket subject, the priority, etc. After creating tickets, pushing [Sync: astah*<-Redmine] button in the [Redmine Tickets] tab will import those tickets information.
    astah redmine

Showing ticket lists

  • One ticket is associated with one diagram. When you move from a diagram to another, the ticket list will be also updated to show ones associated with the selected diagram.
  • [All Tickets] button will show all the tickets associated with all the diagrams in the currently-open Astah project.
    astah redmine
  • Clicking any [Item] column will sort listed items accordingly.
  • Width of each column is manually adjustable.
  • Clicking Ticket number or ticket subject will open your browser to take you to the ticket page in Redmine. After you update the ticket information, you can sync it by pushing [Sync: Astah <- Redmine] button.
  • Clicking Diagram name in the table will give a focus on the diagram. At the same time, the table will be updated to show the ticket list associated with that diagram.

Ticket data in an Astah project

  • Redmine information i.e. URI, API access key and redmine project id and all the ticket information associated with diagrams will be saved in the Astah file when closing Astah project. When you open the Astah project, those data in the table will be restored.
    • If the connection to the Redmine is not established when you open an Astah project, those data will not be restored.
    • Existing bug: When you open an Astah project right after launching Astah, restoring Redmine information may fail sometimes. In this case, open any other project you have, and then open the project you wanted again, then the data will be restored.

Others

  • Width of columns of the table will be restored in Astah project when you push [Sync: Astah<-Redmine] and when you save an Astah project, those width information will be saved in Astah file.

Existing bug

  • When you open an Astah project right after launching Astah, restoring Redmine information may fail sometimes. In this case, open any other project you have, and then open the project you wanted again, then the data will be restored.

Special Thanks!

  • Special thanks to : A member of Friends of Astah, akipii for inspiring me to create this Plug-in with his ideas.