通知テンプレート
通知テンプレートは、ユーザーの通信要件に合わせてメール通知をカスタマイズするツールを提供します。デフォルトのフリーマーカー(英語)ベースのテンプレートを編集できます。独自の件名を追加し、言語を変更し、メッセージテキストを調整します。
デフォルトの通知テンプレートでは、メッセージプレビューでスキャンしやすい形式で各メッセージの主要コンポーネントが表示されます。ほとんどの受信者は、最新の情報を入手するためにメール通知を開く必要すらありません。メールヘッダーのコンポーネントも最適化されているため、ユーザーは受信トレイをフィルタリングして YouTrack 通知を専用のフォルダーに収集できます。
ただし、組織内で使用しているメールクライアントは、この情報をわかりやすい方法で提示しない可能性があります。メールメッセージの形式を変更するには、通知テンプレートをカスタマイズします。
通知テンプレートをカスタマイズすることにより、YouTrack によって送信されるメールメッセージを変更できます。これらのテンプレートは、グローバル設定ページの通知タブからアクセスできる通知テンプレートページから入手できます。
通知テンプレートページにテンプレートのリストが表示されます。リスト内の各項目を展開して、テンプレートコンポーネントを表示および編集することができます。テンプレートコンポーネントは、メッセージの「構成要素」として使用される実際の Freemarker の .ftl ファイルです。
同時変更
YouTrack は、通知のダイジェストスキームに従います。これは、アプリケーションによって生成される通知スパムの量を減らすことを目的としています。単一の通知の課題の変更は、次のように追跡および収集されます。
1 人のユーザーが行った更新の通知は 1 分間停止しました。このユーザーが行った各変更は、1 分が経過するまでカウンターをリセットします。その後、このユーザーが行った変更のコレクション全体を含む単一の通知が生成されます。
別のユーザーが同じ課題に変更を適用すると、別のカウンターが開始されます。この時点から、対応するカウンターをリセットせずに 1 分間進むユーザーが通知を生成します。通知を生成するイベントの前に他のユーザーによって適用された変更に関する未送信の通知は収集され、個別の通知として送信されます。
つまり、John Doe が課題 TS-1 を更新し、彼の同僚、たとえば Jane Doe が気を散らして、1 分以内に課題に何もしないようにすると、TS に加えられた変更について通知が送信されます。気晴らしの前に -1。
同様の状況は、John Doe が課題 TS-1 を更新しているときに、誰か (おそらく彼のライバル) が同時に TS-1 の更新を開始した場合です。別のユーザーの変更が登録されるとすぐに、その時点までに John Doe によって行われた変更に関する通知が送信されます。
通知テンプレートの編集
通知テンプレートは、メールで送信される通知に使用できます。特定のプロトコルのテンプレートを更新するには、対応するファイルを開いて編集します。
通知テンプレートを編集するには
管理メニューから、 を選択します。
通知タブを選択します。
ページの一番下までスクロールして、通知テンプレートを構成するリンクをクリックします。
変更するメッセージコンポーネントを見つけます。特定のメッセージテンプレートに統合されているコンポーネントの場合は、通知リストの項目を展開します。
編集するテンプレートコンポーネントの名前(<component_name> .ftl ファイル)をクリックします。
メッセージテンプレートエディターで必要な変更を加えます。
ヘッダーの「変更を保存」ボタンをクリックします。
通知テンプレートを編集するには、以下のコントロールを使用できます。
コントロール | 説明 |
---|---|
使可能な変数 | このテンプレートで使用できる変数を一覧表示します。詳しくは、ローカル変数を参照してください。 |
変更を保存しますか | 現在の変更を保存します。 |
元に戻す | 最新の変更を元に戻します。 |
やり直し | 最後に戻された変更を復元します。 |
デフォルトにリセット | 現在および以前に保存されたすべての変更を破棄し、デフォルトの通知に戻します。 |
変更のプレビューとテスト
変更がテンプレートまたはテンプレートコンポーネントにどのように影響するかを確認するには、プレビュー用に選択された課題ドロップダウンリストで課題を選択します。リストから通知を選択すると、選択した課題のデータを含むプレビューが詳細サイドバーに表示されます。
ブラウザーウィンドウに変更を表示するプレビューに加えて、メールまたは Jabber クライアントで変更を確認することもできます。テンプレートのメールまたは Jabber ブランチを選択し、ツールバーのテストメッセージを送信するボタンをクリックします。
ローカル変数
ローカル変数は使用できますが、ユーザーが変更することはできません。ローカル変数は事前定義されており、読み取り専用です。
ローカル変数 | タイプ | 説明 |
---|---|---|
|
| 通知の |
|
| 通知送信者の詳細を表します |
|
| 通知受信者の詳細を表します |
|
| 「YouTrack」に評価します |
|
| 現在のバージョンに評価する |
|
| ビルド番号を評価します |
|
| ユーザーが通知を受け取る理由の説明を評価します。説明フォームは、jabber とメール通知で異なります。 |
|
| 通知が送信される課題を評価します。 |
|
| 通知を開始した変更に関する情報(プロジェクト、概要、説明、カスタムフィールド、可視性グループ、リンク、アタッチファイル)が含まれます。 |
|
| 編集または投稿されたコメントを評価し、通知を送信します。 |
|
| true - コメントが編集されました、false - 新しいコメントが投稿されました |
|
| 課題に追加または削除されたタグを評価します。 |
|
| 課題がタグ付けされている / タグ付けされていないことを示すインジケータ |
|
| 課題が投票 / 投票解除されたことを示します |
|
| インポートしたプロジェクトまたはプロジェクトのインポートに失敗しました(ID、フルネーム、課題、リーダー ...)。変数は「インポート状態」通知で使用されます。 |
|
| Java Throwable オブジェクト |
|
| 「インポートステータス」通知のメッセージのテキスト。 |
ディレクティブ
FTL タグを使用してディレクティブを呼び出します。#list
ディレクティブのようなビルトインディレクティブ(英語)に加えて、Freemarker で独自のディレクティブを定義できます。詳細については、ユーザー定義のディレクティブマニュアル(英語)を参照してください。
wiki
- Wiki の構文とキーワードを使用して埋め込みテキストを処理します。ディレクティブは HTML エスケープを適用します。parameter
- パラメーターなしbody
- 処理するテキスト
例:
diff
- テキストに適用された変更をハイライトする HTML 要素をレンダリングします。テキストの削除されたセクションと追加されたセクションは、異なるスタイルでマークされます。パラメーター:
oldText
- 古いバージョンのテキストnewText
- 新しいバージョンのテキストinsStyle
- 挿入テキストの HTML スタイルdelStyle
- 削除されたテキストの HTML スタイル
body
- 体なし
例:
stacktrace は、Throwable のスタックトレースを表す HTML コンポーネントをレンダリングします
パラメーター:
throwable
- ThrowableJava クラスのインスタンス
body
- 体なし
例:
Utils
戻り値に割り当てられた型が
list<?>
の場合、#list
ディレクティブを使用して結果を反復処理できます。
メソッドの概要 | |
---|---|
静的な文字列 | getAttachmentUrl (アタッチメントアタッチメント ) 添付リソースの URL を返します |
静的な文字列 | getAvatarUrl (ユーザー user) ユーザーアバターの URL を返します |
静的な文字列 | getCommentReplyUrl (コメントコメント ) 課題ビューが返信テキスト領域にフォーカスされた Web ページの URL を返します |
静的な文字列 | getCommentUrl (コメントコメント ) コメントに焦点を当てた課題ビューを含む Web ページの URL を返します |
静的リスト <ProjectCustomField> | getCustomFields (課題の課題 ) 課題のカスタムフィールドのリストを返します |
静的な課題 | getDuplicate (発行元 ) ソースの課題と重複する課題を返します。そのような課題がない場合は null を返します |
静的な文字列 | getEditProjectUrl (プロジェクトプロジェクト ) プロジェクトを編集できるアドミニストレーションの Web ページの URL を返します |
静的リスト <タグ> | getExplicitTags (課題の課題 ) 通知受信者に表示されるタグ「スター」を除く課題のタグのリストを返します |
静的 int | getInvisibleAttachmentsCount (課題の課題 ) 通知の受信者に表示されない課題の添付ファイルの数を返します |
静的な文字列 | getIssuesUrl (プロジェクトプロジェクト ) プロジェクトのコンテキストで開かれた課題リストを含む Web ページの URL を返します |
静的な文字列 | getJiraIntegrationUrl () Jira 統合を設定した管理の Web ページの URL を返します |
静的リスト <発行> | getLinkedIssues (発行元、文字列 linkRole) linkRole 課題リンクタイプの名前 (例: 関係する、複製 ) 指定された linkRole を使用してソース課題にリンクされた課題のリストを返します |
静的リスト <文字列> | getLinkRoles (発行元 ) ソースの課題のリンクのすべての可能なロールを返します |
静的な文字列 | getPossessiveName (ユーザーあなた、ユーザーから) you と from が同じユーザーの場合は「you」を返し、それ以外の場合はユーザープレゼンテーションからを返します。 |
静的な文字列 | getResolveStatus (課題の課題 ) 課題が解決された場合は「解決済み」を返し、そうでない場合は「」を返します。 |
静的な文字列 | getSettingUrl (ユーザー user) 通知タブにフォーカスがある指定されたユーザーの YouTrack プロファイルの URL を返します |
静的な文字列 | getStarSrc (Issue issue) は、スタータグのイメージリソースの URL を返します。 |
静的な文字列 | getTaggedIssuesUrl (タグタグ ) タグによってタグ付けされた課題のコンテキストで開かれた課題リストを含む Web ページの URL を返します |
静的な文字列 | getTrimmedTagName (タグタグ ) 指定されたタグの名前を返します。最初の 25 文字に制限されます |
静的な文字列 | getUrl (課題の課題 ) 課題のある Web ページの URL を返します |
静的リスト <添付> | getVisibleAttachments (課題の課題 ) 通知の受信者に表示される、指定された課題に添付されたファイルのリストを返します。 |
静的ブール | hasLinks (課題の課題 ) いずれかの課題にリンクがあるかどうかを返します |
静的な文字列 | inUserTimeZone (インスタントタイム ) メッセージ受信者のローカルタイムゾーンに変換された、人間が判読できる形式の時刻値を返します。 |
静的ブール | 固定されています (課題の課題 ) 課題が修正されたかどうかのいずれかを返します |
関連ページ:
プロジェクト通知設定の管理
YouTrack では、プロジェクトごとに通知設定を構成できます。プロジェクトに関連付けられたメールアドレスや、メール通知に使用されるテンプレートをカスタマイズできます。通知テンプレートのプロジェクトレベルのカスタマイズは、グローバルレベルで適用された変更を上書きします。プロジェクトプロファイルの通知タブでプロジェクト通知設定を管理できます。差出人アドレスと返信先アドレスの管理:プロジェクトプロファイルの通知タブでは、プロジェクトのカスタム送信元アドレスおよび返信先アドレスを設定できます。値を...
送信元アドレスと返信先アドレス
グローバル設定ページには、YouTrack でメール通知を送信するためのアドレスを設定できる設定が含まれています。これにより、メールヘッダーのフィールドの値が設定されます。ただし、このフィールドの値を指定できるのは、YouTrack 内の唯一の場所ではありません。送信元アドレス設定は、YouTrack からメール通知を送信するために使用されるアドレスを決定します。これにより、メールヘッダーのフィールドの値が設定されます。ただし、このフィールドの値を指定できるのは、YouTrack 内の唯一の場所...
オプションフィーチャー
グローバル設定ページのオプションフィーチャータブの設定を使用すると、YouTrack インストールでアクティブにするオプション機能を管理できます。オプション機能には、特定の状況で役立つ機能と、他の状況では不利になる機能が含まれます。YouTrack がチームとそのビジネスロジックのニーズに合わせて最適化されていることを確認するために、これらの機能を特定のグループで利用できるようにするか、単に完全にオフにする機能を提供します。このページで管理できるその他の機能は、実験的に利用できます。システム全体...