Redmineで新規にチケットを起こす時のテンプレート設定方法[追記あり]

2017年7月24日NAS,パソコン・インターネット

一人Redmineをやっています。

だんだん使い方のこつがわかって来て、ガンガンにチケットを発行しています。昨日なんて、「粗大ごみを廃棄する」チケットを切っちゃいました。(笑)

チケットを発行する時、ひな形(テンプレート)を設定できない物だろうか? と思っていたら、Issue Templateと言うプラグインがある事を、次のウェブページで知りました。

ご紹介ありがとうございます。より詳しい解説は、次の開発者ページにあります。(英語です)

ここのやり方に沿えば、使える様になります。

  1. Issue Templateのダウンロード
  2. インストールと起動設定
  3. ユーザー権限設定

私は、Freebsd9.1に、Redmine2.3.3をインストールして運用しています。その前提で解説を書きます。

(追記 2017-06-27 23:26 FreeBSD11.0+Redmine3.2.3+redmine_issue_templates0.1.6でも確認できました。)

(追記 2017-07-24 00:22 FreeBSD11.0+Redmine3.2.3+redmine_issue_templates0.1.7でも確認できました。)

[amazonjs asin="B000BKVMD8" locale="JP"] [amazonjs asin="B001VB37KC" locale="JP"]

1. Issue Templateのダウンロード

次のページからダウンロードできます。

redmine issue template

Clone or downloadボタンを押し、Download ZIPボタンでZIPファイルをダウンロードできます。

2. インストールと起動設定

2.1 インストール

# cd /usr/local/www/redmine/plugins
# unzip redmine_issue_templates-master.zip
# mv redmine_issue_templates-master redmine_issue_templates
# bundle install
# rake db:migrate_plugins RAILS_ENV=production
# apachectl restart

ディレクトリ名を"redmine_issue_templates"に変えないと、migrationに失敗する場合があるようです。

apachectl restartで再起動すると、なぜかRedmineの表示がおかしくなりました。何故でしょうか?

管理者権限を持つIDでログインし、管理プラグインで確認できます。

Issue Templateプラグイン

きちんと、プラグインが認識されました。インストール後、次の起動設定をします。これを設定すれば、「管理者」は使える様になります。

2.2 新規プロジェクトのための設定

まずは、新規プロジェクトのための設定です。

  1. Redmineの管理メニューから、設定プロジェクト選択
  2. 「新規プロジェクトにおいてデフォルトで有効になるモジュール」のチケットテンプレートにチェックを入れて保存

新規プロジェクト用設定

2.3 既存プロジェクトのための設定

次は、既存プロジェクトに対する設定です。

  1. プロジェクトで対象となるプロジェクトを選択する
  2. プロジェクトの、設定モジュールを選択し、チケットテンプレートにチェックを入れて保存
  3. プロジェクトの設定メニューにテンプレートというタブが表示されるので、必要に応じて設定し保存 (ヘルプメッセージとなります)

既存プロジェクト用設定

2.4 ユーザー権限設定

ところがこのままでは、「開発者」などはテンプレートを使えないのです。「ロールと権限」で、「権限」(Permission)を設定する必要があります。

まず、Redmineの管理者から、管理メニューを選びます。

Redmine Admin

そして、ロールと権限を選びます。そうすると、ユーザーの選択画面になります。開発者を選びます。

Redmine Roles

クリック後、権限の設定画面が開くので、「チケットテンプレート」の項目に適切にチェックを入れます。

Issue Template Permission

これで、「開発者」でも、テンプレートを自由に使える様になっているはずです。

3. テンプレートの作り方

3.1 新規テンプレートの作成

新規テンプレート

  • テンプレート名 … わかり易い名前を設定して下さい
  • トラッカー … テンプレートの対象となるトラッカーです
  • チケットタイトル … タイトルもテンプレート化したい場合、入力しておきます
  • チケット本文 … チケット本文にコピーされる内容です
  • メモ … テンプレートのメモを記載できます
  • デフォルト値 … ここにチェックを入れると、チケットを起こす時に自動的にコピーされます
  • 有効 … ここにチェックを入れないと、そのテンプレートは有効になりません
  • プロジェクトツリーでの共有を許可 … ここにチェックを入れると、サブプロジェクトでも同じテンプレートを利用できます

記入が終わったら、保存ボタンで保存します。

「メモ」欄に入力しておくと、テンプレート一覧を表示した時に、ツールチップとして表示されます。

テンプレート一覧

後は、プロジェクトやトラッカー毎に、テンプレートを設定して下さい。複数のテンプレートを作っておくと、チケットを作る際に、追記されて行くようです。

(追記 2017-06-25 18:05 Redmine Issue Templateの機能として、タイトルと詳細をクリアボタンが追加されています。このボタンを押すと、説明欄がクリアされます。)

説明クリア

3.2 サブプロジェクトへの継承

「プロジェクトツリーでの共有を許可」が、ちょっとわかりにくいと思います。ここにチェックを入れ、設定チケットテンプレートを選ぶと、次の画面になります。

サブプロジェクトで継承

親プロジェクトのテンプレートを継承にチェックを入れておくと、親プロジェクトで「プロジェクトツリーでの共有を許可」を設定したテンプレートが使えるようになります。

継承されたテンプレート

4. 効用

チケットのテンプレートを作っておくと、定形作業とか、必ずやらなきゃ行けない事をチケットに書き忘れる事が無くなって、良いですね。

次の本にIssue Templateも紹介されていました。パラパラとめくってみましたが、役に立ちそうな感じでした。

[amazonjs asin="4822279952" locale="JP"]

(追記 2017-06-28 00:06)

最新バージョンで確認し、加筆しました。

(追記 2017-06-29 23:06)

Redmine Issue Templateの追加機能の記載漏れがありましたので、加筆しました。

(追記 2017-07-24 00:22)

Redmine Issue Templateが更新されましたので、動作を確認しました。

Posted by お市のかた