redmine.tokyo » Unofficial Redmine Cooking

■現象/要望¶

Redmine以外でのデータ表示/操作例
REST等を利用し、Redmine外でデータ表示/操作する方法もある。
事例蓄積用チケット

■解決策¶

注：動作検証は一部しか行っていません。
バージョン、DB,権限設定に依存する場合もあります。

Redmine API(本家）¶

http://www.redmine.org/projects/redmine/wiki/Rest_api
紹介記事
https://www.farend.co.jp/blog/2017/02/redmine-api/

Redmine DB データモデル(Redmine1.0.1時点）
https://www.redmine.org/projects/redmine/wiki/DatabaseModel

---

プログラム言語¶

Ruby¶

• REST APIを使ってユーザーを一括登録する
  http://blog.redmine.jp/articles/opc/user-rest-api/
  curl,Rubyによる実現例

• 利用・活用 Redmine API
  https://www.farend.co.jp/blog/2017/02/redmine-api/
  curl,rubyの利用例

JavaScript¶

• RedmineのJavaScriptから各種データを取得する方法
  https://qiita.com/forenoonM/items/7f42701b2ea40353a820
  RedmineのJavaScriptからRedmineの内部データを取得する方法の中で、
  authenticity_tokenを使う方法と、REST APIを使う方法を紹介する。
  （注：view customize1.2にて、内部データを直接取得可能となった）

• View customize でAPIKEYを取得しJavaScriptからRedmineのREST APIへアクセスする黒魔術
  https://github.com/forenoon/ViewCustomizeRecipe

• RedmineのJavaScriptからbulk_updateを使用する
  https://qiita.com/forenoonM/items/517d10e6a6b08c89f8f9
  viewcustomizeにより、フロントエンドのJavaScriptからはRedmineのデータの参照やチケットの更新を行う

python¶

• python-redmine
  https://python-redmine.com/

• Python Redmineを使用してRedmineを操作する
  https://qiita.com/mima_ita/items/1a939db423d8ee295c85
  　
• Redmine REST APIを操作するpython_redmineを試してみた
  https://www.yamamanx.com/redmine-rest-api-redmine_python/

• Redmine本家コピー＋投票サイト作成(Python-Redmine利用事例）
  https://www.slideshare.net/y503unavailable/redminepythonredmine/y503unavailable/redminepythonredmine

• Redmine本家チケットのコピー/VoteCount集計 （python-redmineによるコードサンプル）
  https://redmine.tokyo/issues/902

• Redmine APIで、プロジェクトにユーザ登録して本人に案内を送るところまでを自動化する
  https://acokikoy.hatenablog.com/entry/2019/10/13/110254

• Python で Redmine CLI ツールを作ってみる！
  https://mmll.hatenablog.com/entry/category/tools/redmine/python-redmine-cli
  2020/5時点では、Projectの作成/削除/リストが可能
  （Redmine-pythonの機能範囲内なら、比較的容易に対応可能と思われる）
  Docker-ComposeとPython利用

Perl¶

• MetricsTools_for_Redmine
  https://github.com/Mattani/MetricsTools_for_Redmine
  ↓上記の紹介
  Redmineでメトリクスを見える化する方法
  https://www.slideshare.net/HidehisaMatsutani1/redmine-62029136
  (平均完了日数や放置日数分布、信頼度成長曲線やバグ収束率など)

• RedmineのREST APIを叩いてチケットの情報を見るPerlスクリプト
  http://dqn.sakusakutto.jp/2013/02/redmine_rest_api_perl.html

• RedmineのREST APIを叩いてチケットのタイトルを見るワンライナー
  http://dqn.sakusakutto.jp/2013/02/redminerest_api.html

• Using the REST API with Perl
  https://www.redmine.org/projects/redmine/wiki/Rest_api_with_perl
  https://metacpan.org/pod/Redmine::API
  https://metacpan.org/pod/WebService::Redmine

PHP¶

• PHP Redmine API
  A simple Object Oriented wrapper for Redmine API, written with PHP5.
  https://github.com/kbsali/php-redmine-api

• CandyCane
  https://yandod.github.io/candycane/ja/index.html
  　
  「CandyCaneについて」しながわRedmine第2回勉強会
  https://www.slideshare.net/yandod/introducing-candycane-2redmine

Java¶

• Redmine/Chiliproject Java API.
  https://github.com/taskadapter/redmine-java-api

• RedmineのREST APIをWrapしてくれるJavaライブラリの調査
  https://qiita.com/digdagdag/items/9ec32c18c75ac3042ac4

Powershell¶

• PSmine (PowerShell for Redmine )
  https://github.com/kongou-ae/psmine

• PowershellとOutlookVBAを使ってRedmineAPIで既存のチケットにファイルを(ほぼ)自動添付する#005
  https://qiita.com/koichiro-h/items/d1a170da0f66f582a196

golang¶

• コマンドラインからredmineを扱える「godmine」作った。
  https://mattn.kaoriya.net/software/lang/go/20121119213020.htm
  https://github.com/mattn/go-redmine

• golangでRedmineの情報をExcelにするコマンドラインクライアントを作った
  http://twinbird-htn.hatenablog.com/entry/2016/07/22/002039

• GoでRedmineの作業時間を登録するcliを作った。
  https://tech-note.bikunbikun.com/entry/2020/03/23/200000

C#¶

• 【C#】redmine-net-apiでRedmineからRESTAPIで作業時間を取得
  https://matsumu.com/2020/03/29/1-179/
  .NET Frameworkからredmine-net-apiを利用し、作業時間を取得し加工して表示するWindowsアプリ

---

Office関連¶

Excel、EXCEL＋VBA¶

• Excelからチケットを作成・更新できる「Redmineチケット★一括★」
  http://www.vector.co.jp/soft/winnt/util/se503347.html
  　
  紹介記事
  http://blog.redmine.jp/articles/redmine-ticket-ikkatsu/

• ExcelからRedmineへの情報移行（Handsontableの利用）
  http://ankosoft.co.jp/manual/ankosoft_2018_yamasaki.pdf

• VBAで、REST-API,XML利用しEXCELに取込、＋JSON利用
  Excel から Redmine の情報を取得する方法
  http://d.hatena.ne.jp/chiheisen/touch/20130421/1366543773

Excel（UIとして利用）¶

• EXCELシートのVBAマクロでRedmineをREST呼出し、構成例
  https://qiita.com/EasyCording/items/c3b62c9e5ca3f0cc379f

• Excel中毒者のためにRedmineワクチンを施してみた（Redmine.Tokyo 20回勉強会）
  https://redmine.tokyo/attachments/download/626/%E7%AC%AC20%E5%9B%9Eredmine.tokyo%E5%8B%89%E5%BC%B7%E4%BC%9A_Excel%E4%B8%AD%E6%AF%92%E8%80%85%E3%81%AE%E3%81%9F%E3%82%81%E3%81%ABRedmine%E3%83%AF%E3%82%AF%E3%83%81%E3%83%B3%E3%82%92%E6%96%BD%E3%81%97%E3%81%A6%E3%81%BF%E3%81%9F.pdf
  EXCEL画面上でRedmineと基幹システムを連携、EXCELユーザが利用し易くした。
  データはRedmineと基幹システム側に持ち、EXCELはUIとしてのみ利用。

• Redmine APIとExcelを使ってバグチケットダッシュボードを作ってみた
  https://tech-blog.optim.co.jp/entry/2021/08/26/100000

MS-Project¶

• RedmineのチケットをMicrosoft Project上で参照・保存できるツール。
  https://github.com/conveniencable/microsoft_project_connector
  親子チケット、チケット間の関連、カスタムフィールドにも対応。
  XML/MPPファイルのimport/exportではない。

• MS-ProjectからRedmineへの情報移行
  http://ankosoft.co.jp/manual/ankosoft_2018_yamasaki.pdf
  msproject_import プラグインの利用

Outlook/VBA¶

• OutlookからRedmineを制御　顧客管理の自動化
  http://www.ankosoft.co.jp/manual/20171118_ankosoft_2017_%E6%9D%B1%E4%BA%AC%E5%8B%89%E5%BC%B7%E4%BC%9A%E7%99%BA%E8%A1%A8%E8%B3%87%E6%96%99.pdf
  Outlook VBAからチケットの登録
  入力フォームの改善

Slack¶

• Redmine からSlackへの情報移行
  http://ankosoft.co.jp/manual/ankosoft_2018_yamasaki.pdf
  双方向の事例

• Node.jsとFirebaseを使ってRedmineチケットの更新を通知してくれるSlack Appのバックエンドメモ
  https://qiita.com/s-yoshida/items/1b6d85eaaf4aaab2ca4e

• 【ヘルプデスク】流れちゃうSlackの投稿からRedmineチケット作ってみた【タスク管理】
  https://note.com/hirokazu_nezu/n/n0172c4695bb6

• Redmine issue assign notice plugin
  https://blog.enjoyxstudy.com/entry/2020/12/17/125402
  https://github.com/onozaty/redmine_issue_assign_notice/
  チケットの担当者が変わったときに、SlackやRocket.Chatなどに通知するプラグイン
  RedmineのProject/Userカスタムフィールドで、Project毎のWebHook、ユーザ単位の送信先IDを設定できる。

• チケットごとにSlackスレッドを分けて通知するRedmineプラグインを作成しました！
  https://future-architect.github.io/articles/20210413b/
  ＞スレッド内で過去の更新を確認でき、議論しやすくなります。
  ＞またプロジェクトやユーザごとに通知を無効化できる機能もつけています。

Teams¶

• redmine上操作でteamsのチャットを起動
  https://github.com/RedminePower/redmine_teams_button

• redmineとTeamsをMicrosoft PowerAutomateを使って連携する
  PowerAutomateによりIssue毎に返信処理としている。
  https://qiita.com/snemesk/items/74a88911802515e8190e

Thunderbird¶

• 受信メールからRedmineのチケットを作成/更新するThunderbirdのアドオン
  https://addons.thunderbird.net/ja/thunderbird/addon/redthunderminebird-plus/

---

開発ツール関連¶

GitBucket¶

• Redmine + GitBucketで実現する Redmineでプルリクエスト
  GitBucket側でRedmineの番号に合わせる事で対応
  https://speakerdeck.com/kounoike/redmine-plus-gitbucketteshi-xian-suru-redminetehururikuesuto
  https://github.com/kounoike/gitbucket-redmine-plugin

Github¶

• Github連携プラグイン
  https://github.com/agileware-jp/redmine_github

• GitHubとRedmineの連携 －Webhooks編－
  https://www.macnica.net/github/blog_20190109.html/
  Redmine GitHub Hookプラグインを利用し、GitHub側のcommitをチケットに紐付けて連携する事例
  https://github.com/koppen/redmine_github_hook

GitLab¶

• RedmineとGitLabの連携プラグインを開発
  https://future-architect.github.io/articles/20210908a/
  https://github.com/future-architect/redmine_gitlab_adapter
  Redmineプラグイン側では、GitLabのAPIを経由しリポジトリ情報を取得

• GitLabとRedmineの連携
  http://cream-worker.blog.jp/archives/1074844243.html

• GitlabとRedmineを連携させる方法の覚書。
  https://qiita.com/sakatukitukasa/items/b00b9d9ce5412ac315af

• Project integrations Redmine ServiceGitlab本家）
  https://docs.gitlab.com/ee/user/project/integrations/redmine.html

Visual Studio Code¶

• Redmine extension for Visual Studio Code.
  https://github.com/rozpuszczalny/vscode-redmine
  Create issue, open.list,action,,

TFS¶

• TFSのチェックインをトリガーにRedmineのAPIを叩く
  チケットから開発プロセスを追跡できるように、チェックインとチケットを紐づける操作を自動化。
  TFSのチェックインをトリガーにRedmineにメール送信、Redmine側では受信メールからチケット処理実行し反映。チェックイン時にRedmineのチケット番号入力要。
  https://speakerdeck.com/miokakusu/20190518di-16hui-redmine-dot-tokyomian-qiang-hui-shou-yu-xian

Jenkins¶

• Jenkinsビルド後の処理でRedmineにチケット登録ができるプラグインを作った話
  https://qiita.com/Kokawa_Takashi/items/6ffd7f51bdc95549e8ab
  Jenkinsの「ビルド後の処理」に、「ビルド失敗時にRedmineにチケット登録をする」処理を追加

• Redmine Metrics Report
  https://github.com/jenkinsci/redmine-metrics-report-plugin

---

Angular¶

• AngularからRedmineのチケット一覧を取得する
  http://qiita.com/8amjp/items/6788ff2c87c81b175a65
  JSONP、Angular.js 利用して、チケット一覧を表示する例

• Angular で Redmine のフロントエンドアプリケーション
  https://github.com/8amjp/ng-redmine-admin
  CORS対策必要

Express,Node.js¶

• Excelファイル(.xlsx)をインポート/エクスポートできる機能を追加
  https://github.com/8amjp/redmine-xlsx

• redmine-eml
  https://github.com/8amjp/redmine-eml
  チケットの担当者などの情報を元に、電子メールファイル(.eml)を出力

• Redmine を API 経由で操作する node-redmine
  http://neos21.hatenablog.com/entry/2018/09/24/080000

• Node.js meets Redmine
  https://note.mu/8am/n/n32c0c17f86fb

• Redmineの運用をnode.jsが手助けします。
  https://github.com/8amjp/redmine-helper
  DBバックアップ・メール受信(imap)・shutdown -r
  Linux上bitnami対応

• Node.jsでRedmineにカスタムAPIを追加してみる！
  https://mmll.hatenablog.com/entry/category/tools/redmine/api/custom-redmine-api-by-node-js
  既存のRESTAPIを利用し、カスタムAPIを追加している。（既存RESTAPIの機能範囲内の処理が実現できる）

Node-Red¶

• Redmineの情報を自分好みに見える化した話
  https://www.slideshare.net/ToshiharuSakai/redmine-82416057/ToshiharuSakai/redmine-82416057
  Node-Red連携
  https://flows.nodered.org/node/node-red-contrib-redmine

Electron¶

• Redmine上で更新されたチケットをステータス別に一覧表示するElectronアプリの作り方
  https://qiita.com/emsk/items/acfa74ad5ab442802497
  「Redmine Now」は、Redmine 上で更新されたチケットをほぼリアルタイムに検知し、
  ステータス別に一覧表示してくれるデスクトップアプリです。
  https://github.com/emsk/redmine-now

• RedmineとElectronで新人の育成状況を可視化した話
  https://www.slideshare.net/sawayakadehanai/redmineelectron

curl,shell¶

• プログラミング無しで使ってみるREST API
  https://vividtone.github.io/redmine-tokyo-slide-20180526/

• Redmine API を利用してチケット ID からチケット情報を出力するシェルスクリプトを書いた
  http://neos21.hatenablog.com/entry/2018/09/25/080000
  curl,jq,Bash

• Redmineのチケットを複数条件でフィルタした結果をAPIで取得してみる
  http://blog.serverworks.co.jp/tech/2020/02/07/redmine-api/
  カスタムクエリの検索結果を、コマンドラインで一発取得する例（REST-APU,curl,jq利用）

• Redmine API を試してみる【 curl 編 】
  https://mmll.hatenablog.com/entry/category/tools/redmine/api/curl-and-redmine-api
  curl コマンドを使って、Redmine API 経由でプロジェクトを作成するサンプル

Zabbix¶

• 【インシデント管理】ZabbixのアラートをRedmine上に自動起票する方法
  https://jonkara.net/2018/03/15/zabbix_redmine/
  Redmine起票用Pythonスクリプトを作成し、アラート発生時に実行

• 【Zabbix5.0 × Redmine】障害チケットを自動起票する
  https://mitomito.hatenablog.jp/entry/2020/06/22/070000
  Zabbix5.0で追加されたRedmineのWebhookを使って、障害チケットを自動起票させた事例
  https://www.zabbix.com/jp/integrations/redmine

Vuls¶

• vuls-to-redmine
  https://github.com/nakacya/vuls-to-redmine

• vuls と redmine を連携してみよう
  https://qiita.com/nakacya/items/04937a34c226ab93f0c6
  https://qiita.com/nakacya/items/b00db47d8f2566aeaf12
  vulsで脆弱性を検出すると自動でチケット起票、チケットCloseまで

GAS（google apps script）¶

• google spread sheetでRedmineのチケットを操作してみる
  http://akerun.hateblo.jp/entry/2017/12/24/204017
  RESTAPIとgoogle apps script(GAS)を利用した、チケット参照、作成のサンプル

• redmineチケットの情報をGoogleカレンダーに登録する
  https://shinscope.com/gas-redmine-regster/

R言語¶

• redmineR is an R API client for the Redmine
  https://github.com/openanalytics/redmineR

---

BIツール関連（データ可視化）¶

ELK,Kibana¶

• マネージャーがうれしいRedmineデータのダッシュボード表示方法を公開します！！
  https://future-architect.github.io/articles/20170510/

• その問い合わせ、AIが解決します！～Redmineチケットレコメンドシステムのご紹介～
  https://future-architect.github.io/articles/20181031/

• Redmineのチケット量をグラフ化した話
  https://note.com/kabineko/n/ne9f87df9fb1f
  Windows上、ElasticsearchとKibanaで構築した記事

Re:dash¶

• Re:dashでRedmineのチケットを可視化する
  http://qiita.com/cactaceae/items/beb042aa3f3a5d72756e
  Redmineが使用しているMysqlに接続してダッシュボードとして表示

Metabase¶

RedmineのOpen/Closeチケット数の推移をMetabaseでグラフ表示する方法
https://qiita.com/moni-hide/items/1646f532838956433d5b

Metabase自体については下記参照
OSSのデータ可視化ツール「Metabase」が超使いやすい
https://qiita.com/acro5piano/items/0920550d297651b04387

Tableau¶

とあるメーカーのRedmine 活用事例 – RedmineとTableau
https://www.slideshare.net/crosspoints/redmineosaka-20-talkcrosspoints

---

その他¶

アプリ/その他¶

• Redmine を Azure AD で SAML SSO してみた
  https://qiita.com/bsdmad/items/62b6df8c448409094fe5
  redmine_omniauth_samlを利用し、Microsoft365 の AzureAD でSSOした事例。

• チケット一覧画面＆ガントチャート画面を2ペイン化
  https://github.com/sk-ys/redmine-view-customize-scripts/blob/master/html/2-pane_issue_list/2-pane_issue_list.md
  対象の画面を2ペイン化し，対象の画面とチケット詳細を1画面内に同時に表示します．
  これにより，対象の画面を確認しながら，チケット詳細の確認と編集が可能になります．
  また，チケット詳細画面で行った変更は都度対象の画面に反映されます．
  現在，チケット一覧画面，ガントチャート画面に対応しています．
  紹介 https://forza.cocolog-nifty.com/blog/2020/11/post-62e3af.html

• RedminePM（iPhone,Android アプリ）
  http://redminepm.jp/
  　
  iPhone,Android アプリ
  RESTとHTML画面から取得し表示
  紹介記事
  https://www.slideshare.net/projectmode/redmine-pm
  http://blog.redmine.jp/articles/redminepm/

• RedmineのユーザーをCSVから一括登録するプログラムを作った
  https://yoshinorin.net/2017/04/16/create-redmine-user-import-from-csv/
  Windows .NET

• 複数Redmineでagile開発する 20170513
  https://www.slideshare.net/secret/g7stE4mgvAeZcP

• CSVを読み込んでRedmineのチケットを新規作成、更新するツール(redmine-issue-loader)
  http://blog.enjoyxstudy.com/entry/2019/01/06/000000
  https://github.com/onozaty/redmine-issue-loader/blob/master/README.ja.md
  　
  下記特長があり、定型処理を自動実行する場合に有利
  ・コマンドラインで実行できる（他システムと連携し自動処理など）
  ・設定ファイルにマッピング情報を記載
  ・カスタムフィールドをキーとしてチケットを更新できる（勿論一意性必要）
  　
  Java(JDK8以上)で動作
  Redmineのユーザ認証にはAPIアクセスキーまたはBasic認証を利用可能

• Rebuild the Redmine front end with REST API.
  https://qiita.com/yoshiokaCB/items/18d4e6e8ba4b81e5ec11
  複数Redmineサーバを、単一のUIから操作可能にした事例
  AWS Amplify , 認証はcognito、AppSync(GraphQL)+DynamoDB
  →RedMica Bridge に進化したと思われる。
  https://redmica-bridge.farend.jp/index.html

• Redmine REST API をProxyさせる方法
  https://qiita.com/yoshiokaCB/items/ea648520565660221316
  AWS Amplifyを利用して、フロントエンドとバックエンドをサーバレスで構築する

■対応状況¶

■補足¶