Jira のインテグレーション
このガイドでは、Backtrace を Jira と統合するために必要な手順について説明します。Jira チケットシステムとのインテグレーションを設定するには、有効な Jira REST API URL、ユーザー、およびそのユーザーのパスワードまたは API トークンのいずれかが必要です。
OAuth
Backtrace では、Jira をセルフホスティングしているユーザー向けに、OAuth もサポートしています。OAuth を設定するプロセスを開始するには、Backtrace のサポートチーム（support@saucelabs.com）にお問い合わせください。
これには、Backtrace から提供された公開鍵を使用して Atlassian にアプリケーションリンクを作成すること、以下の説明と同じようなインテグレーションを設定すること、そして最後に Backtrace によって開始されたプロセスからリンクを開き、Backtrace のリクエストされたアクセスを受け入れることが関与します。
インテグレーションを追加する
インテグレーションを設定するには、「プロジェクト設定 > インテグレーション > 問題のトラッキング > JIRA（Project Settings Integrations Issue Trackers JIRA）」と移動し、インテグレーションの設定に移動します。
一方向同期または双方向同期を有効にする場合は、インテグレーションの設定中に動作を設定するタブから行うことができます。一方向同期は、Backtrace の問題の更新を JIRA に同期し、双方向同期は、JIRA の問題が更新されたときに Backtrace の問題を更新します。
Jira のインテグレーションでは、次の項目を設定できます。
「JIRA API」（必須）：Jira エンドポイント URL（例については以下を参照）
「メール」（必須）：Jira インスタンスに関連付けられているメール。ユーザーによっては、Jira インスタンスのユーザー名が使用される場合があります。
「API トークン」（必須）： こちらから取得した Jira API トークン。一部の Jira インスタンスでは API トークンの代わりにパスワードもサポートされていますが、その機能は非推奨であり、削除される予定です。
「Project Key（プロジェクトキー）」（必須）： Jira のプロジェクトキー
「Issue Type（問題の種類）」： Jira の問題の種類。 存在しない場合、デフォルトは「Bug（バグ）」です。
「Subject（件名）」（必須）： チケットの「Summary（サマリー）」フィールドに入力するコンテンツ。
「Custom Field Mapping（カスタムフィールドマッピング）」 - 「ラベル」： 以下を参照
「Custom Field Mapping（カスタムフィールドマッピング）」 - 「説明」： 以下を参照
「Custom Fields（カスタムフィールド）」： 以下を参照
Backtrace と Jira の同期
データ同期の制御 - 「動作を設定」タブ
Backtrace では、Jira と同期するためのさまざまなオプションがサポートされています。「動作を設定」タブには、データを同期するタイミングを設定するオプションがあります。
- Backtrace では、状態と割り当て先の値が Backtrace で変更されたときに、リンクされた Jira の問題をその新しい値で更新できます。
- Jira では、状態と割り当て先の値が Jira で変更されたときに、リンクされた Backtrace のフィンガープリントをその新しい値で更新できます。
Jira 修正バージョンの同期 - 「接続を設定」タブ
最初の「接続を設定」タブの下部には、Jira の修正バージョンを Backtrace の「Resolved Until...（次のときまで解決済み）」機能と連動させ、検出されたリグレッションのワークフローを推進することを許可する、新しいベータ版の機能があります。Backtrace では、この設定での UI の表示方法の柔軟性を高めるためにスキーマの再構築を検討しているため、この機能をベータ版と見なしています。このフェーズ中は、Backtrace のサポートチームと連携して作業を進めるようにしてください。
例
通常、Jira の URL は次のいずれかの形式を取ります。
- https://yourhost.yourdomain.com/rest/api/2/
- https://yourhost.yourdomain.com/jira/rest/api/2/
- https://yourname.atlassian.net/rest/api/2/（Atlassian によってホストされる Jira のサイトの場合）
Atlassian now also offers a v3 API that is currently in Beta, at this time v3 is not currently supported. Be sure to use a v2 endpoint.
詳細については、Jira の API に関するドキュメントを参照してください。
カスタムフィールドマッピング
Backtrace populates the default Jira description fields. If you use a customized screen where this is removed or renamed, you will need to specify alternate field name for Backtrace to use to populate with data under Field for Main Body Text.
カスタムフィールド
Backtrace では、Jira の他のカスタムフィールドの登録もサポートしています。 これは、必須のカスタムフィールドが追加された Jira 画面を使用しているときに便利です（必須のフィールドに入力しないと、そのインテグレーションで Jira チケットの作成が失敗します）。
「Custom Fields（カスタムフィールド）」では、Jira の問題に登録することを希望する、オプションの追加フィールドのリストを設定します。先頭に $ を付けることで、テキスト内で属性の値を使用できます（例：$version）。配列タイプのフィールド（ラベルなど）の場合は、値をカンマで区切ります。あるエラーグループ内に指定された属性の値が複数ある場合は、最も個数が多い値が使用されます。
リテラル文字列と属性値の組み合わせを使用できます。 たとえば、フィールドの値を「Hostname:$hostname, Version:$version」と設定すると、Jira のインテグレーションでは、想定したとおりに、それらの属性の値がその文字列の中に配置されます。
注： $attribute 構文を使用してカスタムフィールド内の属性を参照しているが、Jira のそのフィールド内に属性が入力されているのを確認できない場合は、この属性を「プロジェクト設定」の「属性」で追加していることを確認してください。 こちらを参照してください。
必須のフィールド
Backtrace では次のフィールドが必須であり、設定に基づいて自動的に入力されます。 Backtrace の該当する Jira の設定にそれぞれの値を指定するか、カスタムフィールドとして指定することで、これらの設定のコンテンツをオーバーライドできます。
Jira API では、無効なフィールドがあるリクエストや、必須のフィールドが入力されていないリクエストは拒否されるため、これらのフィールドが適切に指定されるようにすることが重要です。
- 「Project Key（プロジェクトキー）」 - これは「Project Key（プロジェクトキー）」設定で指定されます。
- 「Summary（サマリー）」 - これは「Subject（件名）」設定で指定されます。
- 「Issuetype（問題の種類）」 - これは「Issue Type（問題の種類）」設定で指定され、デフォルトでは「Bug（バグ）」に設定されています。
- 「Labels（ラベル）」 - Backtrace では、「labels」という名前のラベルタイプフィールドがあることを前提とし、このフィールドにラベル「Backtrace」を入力しますが、「labels」をカスタムフィールドとして追加することで、これをオーバーライドできます。 このフィールドの別名を「Custom Field Mapping（カスタムフィールドマッピング）」オプションで指定することもできます。
- 「Description（説明）」 - Backtrace では、「description」という名前のテキストフィールドがあることを前提とし、ここにメインのエラー情報を入力しますが、「description」をカスタムフィールドとして追加することで、これをオーバーライドできます（非推奨）。 このフィールドの別名を「Custom Field Mapping（カスタムフィールドマッピング）」オプションで指定することもできます。
トラブルシューティング
Jira のインテグレーションに関する問題をトラブルシューティングする方法については、こちらをご覧ください。
次は：インテグレーション固有の設定を入力したら、共通設定に進み、インテグレーションの設定を完了します。