Redmineと連携する

外部BTS設定ウィザードの最初の画面からRedmineの連携方法を次の順番で説明します。

  • Redmineの連携設定

  • 課題登録

  • 連携の更新

Redmineの連携設定

外部BTS設定ウィザード(1/6) - 接続情報の入力

はじめにRedmineへの接続情報を入力します。

image

項目名 説明

外部BTS連携

外部BTS連携を行うか決めます。

種別

Redmineを選択します。

URL

連携するRedmineホームのURLを入力します。

Redmineにベーシック認証がかかっている場合、認証情報を入力してください。

ベーシック認証

Redmineにベーシック認証がかかっている場合、チェックボックスをチェックして、ユーザー名・パスワードを入力してください。

APIアクセスキー

RedmineのAPIアクセスキーを入力します。Redmineの個人設定画面で確認することができます。

※管理者ユーザー以外のAPIキーを入力する場合、自動でユーザマッピングされないため、後述の別途ユーザー紐付け機能をご利用ください。

プロジェクト識別子

連携するRedmineのプロジェクト識別子を入力します。Redmineのプロジェクトの設定画面で確認することができます。

サブプロジェクト連携

サブプロジェクトのチケットも取り込む場合、ONに設定します。

その際、Redmineの次の点を確認してください。

  • Redmineのプロジェクトにサブプロジェクトがあること

  • Redmineの設定で「サブプロジェクトのチケットをメインプロジェクトに表示する」の設定をONになっていること(※)

※また「サブプロジェクトのチケットをメインプロジェクトに表示する」の設定をONにしているプロジェクトは必ずサブプロジェクト連携をONにして下さい。カスタムフィールドのマッピングができない場合があります。

Redmineの接続情報を入力してエラーになる場合、次の項目を確認してください。
  • 各種入力情報が誤っていないか。

  • CAT(インターネットもしくはサーバー)からRedmineへの接続経路があるか。
    →IPアクセス制限やF/W等を確認してください。

  • ログイン情報を設定しているユーザーに、プロジェクトの参照権限があるか

(参考)Redmineの各種情報の確認方法

APIアクセスキーやプロジェクト識別子等の確認箇所を順番に説明します。

  1. URLはRedmineにログインし、ホームへ移動したときに表示されるURLを入力してください。
    image

  2. APIアクセスキーを確認するには、個人設定をクリックします。
    image

  3. 画面右にAPIアクセスキー項目が表示されるので、”表示”のリンクをクリックすると、キーを確認できます。
    image
    image

    • ここで設定するキーはCATがRedmineから課題情報を取得する際に利用するアカウント情報となります。テスト実施時、Redmineに起票するためのアカウントは、ユーザー毎に作成する必要があります。

    • APIアクセスキーが表示されていない場合は、Redmineのメインメニューから、管理>設定>認証タブに表示されている「RESTによるWebサービスを有効にする」をONにしてください。

    • チケットの閲覧権限を持つユーザーのAPIアクセスキーが必要です。システム管理者のAPIキーであれば、メールアドレスをキーとして自動でのユーザー情報の連携も可能となります。

  4. プロジェクト識別子を確認するには、連携するRedmineのプロジェクトの設定を表示します。設定画面に表示される識別子を入力してください。
    image

外部BTS設定ウィザード(2/6) - 種別設定と取り込むチケットの範囲の指定

種別設定と取り込むチケットの範囲の指定を行う。

種別マッピングは、Redmineのトラッカーに対応するCATの分類をプルダウンから選択して設定します。連携しないを選択すると、そのトラッカーのチケットは同期しません。

カスタムクエリは、CATに同期するチケットを絞り込む設定です。ここで指定したカスタムクエリの対象外のチケットは同期しません。API連携キーを発行したユーザーが作成したカスタムクエリを利用できます。

課題種別とトラッカーのマッピング手順
  1. 選択 トラッカー(Redmine)をクリックして利用するトラッカーを選択します。
    image

  2. トラッカー(Redmine)・種別(CAT)にトラッカー表示されるので、行の種別欄をクリックしてマッピングする種別を選択します。
    image

  3. RedmineのトラッカーとCATの種別のマッピングがされます。
    image
    ※種別マッピングは最低一つを連携する必要があります。

画面項目の説明
項目名 説明

定義外

チケットの取込時、マッピングしていないトラッカーのチケットを取り込んだ場合の通知の有無を選択します。

連携しない

未マッピングのチケットを警告なく取込除外します。

警告する(連携しない)

警告して取込除外します。

トラッカー

(Redmine)・

種別(CAT)

RedmineのトラッカーとCATのどの種別として取り込むかのマッピングをします。

カスタムクエリ

Redmineで定義したカスタムクエリに基づいてCATに取り込むチケットをフィルタリングします。

外部BTS設定ウィザード(3/6) - 共通設定

共通設定項目では、次の項目を設定します。

  • 工程

  • ステータス

  • 優先度

  • 重要度

  • 機能

  • 開発者

  • 納期

それぞれRedmine側の値に対応するCATの値を設定します。 尚、再設定時等、次ページ以降の設定をそのまま引き継ぎ省略する場合、画面右上の「以降の設定をスキップする」ボタンを押してください。確認画面にジャンプします。

以下で各種マッピングの設定方法を説明します。

工程マッピング

工程マッピングではCATの工程に紐付けるフィールド及びマッピングする値の設定を行います。 まず、連携するフィールドをRedmineの対象バージョンもしくはカスタムフィールドから選択します。

Redmineの「対象バージョン」を選択した場合のみ、次の様なマッピング画面が表示されます。選択 対象バージョン(Redmine)からRedmineのバージョンを選択しリストに表示した後、マッピングする工程を設定します。

連携フィールドに「対象バージョン」を選択した場合のマッピング画面

image

画面項目の説明
項目名 説明

デフォルト工程

連携するフィールドでマッピングのない値が入っていた際のチケットの取込先工程を選択します。

連携するフィールド

RedmineのチケットをCATの各工程に取込む場合、キーとなるRedmineのフィールドを設定します。

対象バージョンもしくは任意のカスタムフィールドを選択します。

連携するフィールドに設定した項目と、取込の挙動
対象バージョン

下記のマッピング表の設定に基づいて工程に取込みます。

任意のカスタムフィールド

 カスタムフィールドの値が工程名と一致する工程に取込みます。
一致しない場合、デフォルト工程に取り込みます。

連携しない

全てのチケットをデフォルト工程に取込みます。

定義外

対象バージョン選択時のみ表示されます。下記のマッピング表で選択の無い対象バージョンの取込先と警告の有無を設定します。

デフォルト値

デフォルト工程に取込みます。

連携しない

取込みません。

警告する(連携しない)

取り込まず、警告のみ表示します。

対象バージョン(Redmine)と工程(CAT)のマッピング表

対象バージョン選択時のみ表示されます。対象バージョンから、マッピングしたい項目を選択して、CATの工程とマッピングします。

ステータスマッピング

ステータスマッピングでは取込対象とするRedmineのステータス及び、対応するCATのステータスを設定します。

選択 ステータス(Redmine)からステータスを選択後、ステータスのマッピング表で紐付けるCATのステータスを選択してください。

image

画面項目の説明
項目名 説明

デフォルトステータス

定義外もしくはマッピング表のステータス(CAT)でデフォルト値を選択した場合にマッピングするステータスです。

定義外

マッピング表で設定のないRedmineのステータスの対応を設定します。

デフォルト値

デフォルトステータスとして取込みます。

連携しない

取込みません。

警告する(連携しない)

取り込まず、警告のみ表示します。

優先度マッピング

優先度マッピングではCATの優先度に連携したいフィールド(Redmineの優先度もしくはカスタムフィールド)、及び対応する値の設定をします。 連携するフィールドにRedmineの優先度を設定した場合、連携フィールド選択後、マッピング表が表示されます。対応する優先度を設定してください。設定のない優先度についてはデフォルト優先度が割り当てられます。 連携するフィールドにRedmineのカスタムフィールドを設定した場合、マッピングしたフィールドの値とCATの優先度が一致すれば優先度が表示されます。(一致しない場合は空白)場合、CATのプロジェクト内で優先度を使用しない場合(連携するフィールドに優先度以外を設定した場合)、マッピング表は非表示となります。

image

重要度マッピング

重要度マッピングではCATの重要度に連携したいフィールド(Redmineの優先度もしくはカスタムフィールド)、及び対応する値の設定をします。

操作は①と同様です。連携するフィールドにRedmineの優先度を設定した場合、連携フィールド選択後、マッピング表が表示されます。対応する重要度を設定してください。設定のない重要度についてはデフォルト重要度が割り当てられます。

連携するフィールドにRedmineのカスタムフィールドを設定した場合、マッピングしたフィールドの値とCATの重要度が一致すれば重要度が表示されます。(一致しない場合は空白) + する場合、 CATのプロジェクト内で重要度を使用しない場合(連携するフィールドに優先度以外を設定した場合)、マッピング表は非表示となります。

image

機能マッピング

機能マッピングでは、CATの機能に紐付けたいカスタムフィールドを設定します。連携するカスタムフィールドをドロップダウンから選択してください。連携すると次の機能が利用できます。

  • 起票時にCATの機能名が登録されます。

  • 分析画面においてチケットに登録された機能を元に機能毎分析が利用できるようになります。

image

開発者マッピング

開発者マッピングでは、CATの開発担当者に紐付けたいカスタムフィールドを設定します。レ連携するフィールドにRedmineの担当者かユーザータイプのカスタムフィールドをマッピング選択してください。分析画面でチケットに登録された開発者を元に開発者分析ができるようになります。

納期マッピング

納期マッピングでは、CATの納期と期日フィールドの紐づけを設定します。

各項目の設定が完了したら次へボタンを押して、次の画面に進んで下さい。

外部BTS設定ウィザード(4/6) - 個別設定

個別設定を行います。トラッカー毎に連携キー及びカスタムフィールドを設定します。

image

画面項目の説明
項目名 説明

トラッカー

連携キーとカスタムフィールドのマッピングをするトラッカーを選択します。

連携キー

トラッカー毎に、連携キーとして利用するRedmineのカスタムフィールド(テキストフィールドタイプ)を設定すると、実行画面からの起票時にケースと障害の紐付けができます。

カスタムフィールド

(Redmine)・

フィールド(CAT)

マッピング表

トラッカー毎に、CATのカスタムフィールドとRedmineのカスタムフィールドを紐付け(マッピング)設定します。マッピングすると次の機能が利用できます

  • CATの課題一覧に表示しフィルタリング等に利用できます。

  • 次の特殊なフィールドをマッピングするとチケット起票時等にCATの情報を追加でき、規模の把握や分析などに利用できます。

特殊なフィールドと利用できる機能
関連ケース数

連携したフィールドに紐付きケース数を書き込みます。
ケース数が変わった場合、日次でRedmineを更新します。

テストケースURL

テスト実行画面から起票した際のテスト仕様書・ケースのURLが登録されます。

テスト仕様書名

テスト仕様書のシート名が登録されます。

課題とケースの紐付けの例

image

※上記のマッピング表にRedmineのカスタムフィールドを追加したとき、紐付先のCAT側フィールドとして選択肢に表示されるのは、RedmineのカスタムフィールドタイプにCATのフィールドタイプが対応している場合のみです。フィールドの対応関係についてはRedmineフィールド対応関係を参照してください。

※カスタムフィールドを選択するには、連携対象のトラッカーごとに、連携したRedmineに1つ以上の起票が必要です。起票がない場合、カスタムフィールドが表示されないため、ダミー等のチケットを登録してください。

各項目の設定が完了したら次へボタンを押して、次の画面に進んで下さい。

外部BTS設定ウィザード(5/6) - 詳細設定

詳細設定では連携時の警告について設定します。詳細設定では以下の2つの設定ができます。

image

画面項目
項目名 説明

ユーザー連携の警告

管理者権限をもったRedmineのAPIキーを連携に利用した際、CATとRedmineで紐付けできない(※)ユーザーが存在した場合の警告の有無を設定します。

※RedmineのユーザーとCATのユーザ(担当者・開発担当者等)はメールアドレスをキーとして紐付け連携します。

※管理者権限の無いユーザーで連携した場合、警告は発生しません。

エラー通知先

連携エラーが発生した場合に、メールで通知するメンバーを設定します。

ユーザー連携の警告は外部BTS連携詳細情報画面で確認できます。この画面は、課題一覧の上にある警告(詳細)リンクから開くことができます。CATに登録されていないメールアドレスのユーザーがチケットの担当者や作成者である場合に、そのメールアドレス、ユーザー名、チケット番号、プロジェクト名が表示されます。

課題管理画面、連携警告発生時の例

image
image
各項目の設定が完了したら次へボタンを押して、次の画面に進んで下さい。

外部BTS設定ウィザード(6/6) - 設定内容確認

設定を確認し、設定が正しければ登録ボタンを押してください。

image

外部BTSの設定を正常に登録完了すると下図のような画面が現れます。一覧に戻るボタン、または詳細に戻るボタンを押して外部BTSの設定を終了してください。

image

※外部BTS連携更新を行うとそのプロジェクトで登録していたCAT上の課題は削除されます。必要な課題は連携前にダウンロード等を行って下さい。

連携ステータス

連携設定完了後、設定した連携のステータスはプロジェクトトップ等で確認することができます。警告またはエラーの場合はステータスボタンをクリックし外部BTS連携詳細情報を確認してください。

image

課題登録

  1. 連携設定後にCAT上で課題報告ボタンを押すと、下図のようなポップアップが表示されます。

  2. 課題報告を行うRedmineのプロジェクトとトラッカーを選択してください。
    ※サブプロジェクトを連携していない場合はトラッカーだけの選択となります。
    image

  3. 連携するRedmineの課題作成画面が開きます。項目を入力し課題の作成を行ってください。
    image

  4. 入力を終えたら作成ボタンを押して下さい。
    image
    課題起票後、CATに取り込みされるのは通常1時間毎の同期時となります。即時で同期した場合、次の連携の更新を行って下さい。

連携の更新

課題管理画面・テスト実行画面から外部BTS連携更新ボタンを押すと、即時でRedmineの情報を取込みます。

image

連携時、確認事項の有無に応じて(定義の無い種別のチケットを取り込んだ等)次の様にステータスが表示されます。警告・エラーの場合、ステータスをクリックし内容を確認後、対応してください。

連携ステータスの状態
表示例 説明

image

警告・エラーなく正常に連携している状態です。

image

定義のないチケットを取り込んだ際、マッピングできないユーザーがいた場合等に表示されます。このボタンをクリックして警告内容を確認し、必要に応じて対応してください。

image

外部BTSへの接続が失敗した場合等に表示されます。このボタンをクリックしてエラー内容を確認し、対応してください。エラー発生時は対応後、再度外部BTS連携ウィザードを完了する必要があります。

RedmineとCATのユーザーを紐付ける

利用しているRedmineのAPIキーが管理者でない場合やRedmineのメールアドレスとCATのメールアドレスが一致しない場合は手動でマッピングができます。

※CATはEメールアドレスを参照してユーザ情報をマッピングしているため、RedmineのEメールアドレスを取得できない場合や、CATに登録されていないEメールアドレスがRedmineにあるとユーザのマッピングができません。

手動での紐付け方法
  1. 紐付けができなかったユーザがいた場合、課題一覧画面の「ユーザ紐付」ボタンが赤字表示となり、未紐付けのユーザー数が表示されます。このボタンをクリックします。
    image

  2. 表示されたポップアップで、マッピングされていないユーザに対してCATのユーザ名を紐付けて下さい。
    image

    画面項目の説明
    項目名 説明

    一括操作

    既存紐付利用

    同一URLの外部BTSを利用した別プロジェクトから紐付け情報を参照して設定します。

    クリーンアップ

    現在、CATに取り込まれていない課題に設定されていた外部BTSのユーザー名を一括削除します。

    フィルターのクリア

    グリッドのフィルターを解除します。

    ヘルプアイコン(i)

    紐付け機能のヘルプを表示します。

  3. 設定後、登録ボタンを押すと完了します。

Redmineフィールド対応関係

以下は外部BTSとCATのフィールド対応関係です。カスタムフィールドの連携マッピングを行う時等に参照してください。なお、外部BTS上に課題が存在しない場合カスタムフィールドの取り込みを行うことはできません。

カスタムフィールドマッピングで連携できるCATのフィールドと対応するタイプ
CATの項目・カスタムフィールド CATのフィールドタイプ Redmineのカスタムフィールドタイプ

連携キー

-

テキスト

テスト仕様書名

-

テキスト

テストケースURL

-

テキスト・リンクタイプ

関連ケース数

-

テキスト

カスタムフィールド

テキスト(1行)

テキスト

カスタムフィールド

テキスト(複数行)

長いテキスト、テキスト

カスタムフィールド

ラジオボタン

リストから選択、テキスト

カスタムフィールド

チェックボックス

真偽値

カスタムフィールド

単体選択

リストから選択、テキスト

カスタムフィールド

複数選択

リストから選択(複数選択可)、テキスト

カスタムフィールド

URL

テキスト

カスタムフィールド

ラベル

-

カスタムフィールド

日付

日付

カスタムフィールド

日付+時間

-