課題コレクターの利用
What is an "issue collector"?
The issue collector allows you to easily embed a Jira feedback form into your own website. This form is typically accessed by clicking a 'trigger' tab exposed along the edge of pages in your website.
Web サイトを訪れた訪問者がこのトリガータブをクリックして、記入した Jira フィードバックフォームを送信すると、Jira で課題が簡単に作成されます。
Web サイトの訪問者は Jira フィードバックフォームを使用するために Jira のログインアカウントを持っている必要はありません。
Managing Jira's issue collectors
次のすべての手順を行うには、Jira 管理者 グローバル権限 を持つユーザーとしてログインする必要があります。
Jira の課題コレクターにアクセスする
Jira アプリケーションでは、課題コレクターはプロジェクトごとに設定されます (したがって編成も同様)。
Jira で設定されたすべての課題コレクターにアクセスするには:
- 画面右上で [管理
] > [システム] の順に選択します。 - In the sidebar, select Issue collectors to open the Issue Collectors page, which shows a list of all existing issue collectors in your Jira system.
- プロジェクトの名前をクリックして、そのプロジェクトに属している課題コレクターの詳細リストにアクセスするか、課題コレクターの名前をクリックして、詳細情報にアクセスします。課題コレクターページ (詳細情報を含む) では以下にアクセスできます。
- アクティビティグラフ。この課題コレクターを通じて作成された課題の数 (Y 軸) が日単位 (X 軸) で表示されます。
- この課題コレクターを通じて作成された最近の課題のリスト (新しい順)。
On this page:
関連ページ
特定のプロジェクトに属す課題コレクターにアクセスするには:
- 画面右上で [管理] > [プロジェクト] の順に選択します。
- Select a project's name to oepn it.
- In the sidebar, select the Issue collectors tab. The Issue collectors page is displayed, listing any issue collectors that have already been set up in your project:
- Select the name of an issue collector to access detailed information about it — in particular, its recent activity and details on how to embed the issue collector into your web site.
Add an issue collector
- 画面右上で [管理] > [プロジェクト] の順に選択します。
- サイドバーで [課題コレクター] タブを選択します。課題コレクターページが表示され、プロジェクトで既に設定済みの課題コレクターがリストされます。
- Select the Add issue collector button to open the Add issue collector page.
課題コレクターの追加ページの最上部で、次の項目を指定します。
名前 Jira ユーザーインターフェイスで一貫して表示される課題コレクターの名前を指定します。 説明 課題コレクターの説明を指定します。この説明は、Jira ユーザーインターフェイスで一貫して課題コレクターの名前の隣に表示されます。 課題タイプ Web サイトの訪問者が課題コレクターの Jira フィードバックフォームを送信したときに Jira で作成される課題のタイプを選択します。 課題の報告者 Web サイトの訪問者が課題コレクターの Jira フィードバックフォームを送信すると作成される Jira 課題の既定の報告者となるユーザー名を指定します。 報告者と一致? 以下のいずれかを選択します。- 常に課題の報告者を使う — 上記で指定する既定の課題報告者が、自身の Web サイトの Jira フィードバック フォームの送信によって作成される課題の報告者に必ず設定されるようにするには、このオプションを選択します。
- 送信者のメール アドレスと一致するか試す — 自身の Web サイトの Jira フィードバック フォームの送信によって作成される課題の報告者を、Jira フィードバック フォームで指定されたメール アドレスに一致する Jira ユーザーにする場合は、このオプションを選択します。
Jira ユーザーが Jira プロジェクトで課題の作成プロジェクト権限を持っていない場合、上記で指定する既定の課題報告者が課題の報告者として使用されます。
ブラウザ情報の収集 ブラウザの統計に関するメタ情報を収集する場合はこのオプションを選択します。この情報は Web サイトで Jira フィードバックを送信することで、作成された課題に組み込まれます。 In the middle section of the Add issue collector page (entitled "Trigger"), specify the following:
テキストのトリガー Web サイトのトリガータブに表示される短い簡潔なフレーズを指定します。 スタイルのトリガー Choose the style in which the trigger tab will appear on your web site. "Custom" will not display a trigger, but will add additional javascript to the generated script, so you can create a custom trigger on your web page. 「課題コレクターの追加」ページの下のセクション (「課題コレクターフォーム」) で、次の項目を指定します。
テンプレート 提供されているオプションから選択します。一般的に、選択内容は作成する課題タイプを反映します (例: 上記で選択したもの)。選択肢は次のとおりです。
- Jira フィードバックフォーム用の事前定義されたテンプレート — 「フィードバックの送信」または「バグの報告」。
- カスタムはカスタムの Jira フィードバックフォームを作成します。ダイアログボックス上で独自の用語を指定、フォーム上の他のフィールドを追加または削除、フォーム内の位置を変更できます。
- 選択した課題タイプでフィールドが必須となっており、フィールドが以下にあてはまる場合は注意してください:
既定値が指定されていない場合。フィールドはフォーム上に自動的に表示されます。フォーム上でこのフィールドの位置を変更できが、削除することはできません。
- フィールド以外の既定値がフォームに追加されていない場合。課題コレクターから課題を作成する際、フィールドの既定値が使用されます。
- 一部のフィールドは匿名ユーザーに表示できないため、すべてのタイプのフィールドをフォームに追加することはできません。表示可能なフィールドは次のとおりです。
- 標準フィールド: サマリー、説明、コンポーネント、影響を受けるバージョン、環境、優先度、添付ファイル
- カスタムフィールドタイプ: 日付と時刻、ラジオボタン、複数チェックボックス、マルチ選択、数字、選択リスト、URL フィールド、バージョンピッカー、カスケーディング選択、プロジェクトピッカー、単一バージョンピッカー、テキストフィールド、自由テキストフィールド
- 選択した課題タイプでフィールドが必須となっており、フィールドが以下にあてはまる場合は注意してください:
メッセージ ダイアログボックスの一番上の青い「情報」ペインに表示されるメッセージを入力します。 Select the Submit button to save your changes.
Embed an issue collector into your web site
「送信」ボタンをクリックして新しい課題コレクターを保存すると、コードスニペットを含むページが表示されます。提供されたコードと情報を使用して、新しい課題コレクターを自分の Web サイトに埋め込みます。
If you accidentally click away from this page, you can easily retrieve the information that was on it by accessing your issue collector's details (above) and scrolling to the end of the page.
課題コレクターを編集する
トリガー スタイルや、カスタム トリガーを変更しない限り、課題コレクターを編集するために、課題コレクターを含む Web ページを変更する必要はありません。トリガースタイルとカスタム トリガーを切り替えることで、生成される javascript が変わります。そのため、課題コレクターに含める Web ページへ埋め込む内容を変更する必要があります。
- プロジェクト管理者または Jira 管理者グローバル権限を持つユーザーとして Jira にログインします。
- 関連プロジェクトの課題コレクターのリストにアクセスします (上記)。
- In the Operation dropdown for the issue collector you would like to edit, select Edit to open the Edit issue collector page.
- 必要に応じて課題コレクターを更新します。
- Select Update to save your changes.
課題コレクターをコピーする
課題コレクターをコピーすると、完全に新しいコレクターが作成され、既存の課題コレクターには影響を与えません。新しい課題コレクターを作成した場合と同じように、希望する Web ページにコピーした課題コレクターを埋め込む必要があります。
- プロジェクト管理者または Jira 管理者グローバル権限を持つユーザーとして Jira にログインします。
- 関連プロジェクトの課題コレクターのリストにアクセスします (上記)。
- コピーする課題コレクターの「操作」ドロップダウンで「コピー」を選択すると、「課題コレクターの追加」ページが開きます。
- コピーされた課題コレクターからのすべての情報は、コピーされた課題コレクターと同じになります。ただし、名前 (コピーされた課題コレクターの名前 + "のコピー") を除きます。
- 必要に応じて課題コレクターを更新します。
- Select Submit to save your changes
課題コレクターを無効化または削除する
- 関連プロジェクトの課題コレクターのリストにアクセスします (上記)。
- On the list of the project's issue collectors, select Disable or Delete to respectively disable or delete the associated issue collector.
課題コレクターは無効化されますが、トリガータブはユーザーがページを更新するまで、課題コレクターコードが追加された Web サイトのページ上に引き続き表示されます。ただし、これらのトリガーの結果クリックすると、課題コレクターを現在操作できないことを示すメッセージが表示されます。
既知の制限事項
- セキュリティを向上するため、フィードバックを送信したあとの成功メッセージにはプロジェクトおよび課題キーが表示されなくなりました (プロジェクトが Web 上の全員に公開されている場合を除く)。これらを表示する必要がある場合は、この回避策を使用できます。
- iframe 内に課題コレクター プラグインを配置した場合、プロンプト画面は自動的に閉じられません。
- これは Issue Collector プラグインに関する既知の問題であり、 JRASERVER-41400 - Getting issue details... STATUS で追跡されています。
- 匿名ユーザーがプロジェクトで課題コレクターを作成しようとしたときに、そのプロジェクトに必須フィールドがあった場合、匿名ユーザーにそれらのフィールドは表示されません。結果として、ユーザーはコレクターを作成できません。
回避策として、フィールドを任意にします。 - これは Issue Collector プラグインに関する既知の問題であり、 JRASERVER-67094 - Getting issue details... STATUS で追跡されています。