YouTrack サーバー 2024.2 ヘルプ

カスタムウィジェットの管理

カスタムウィジェットページを使用すると、カスタムウィジェットのステータスを一元管理できます。ここには、YouTrack に手動でアップロードされたすべてのウィジェットと、JetBrains マーケットプレイスからの互換性のあるウィジェットのコレクションが表示されます。

このページにアクセスするには、 管理メニューを開き、サーバー設定> カスタムウィジェットを選択します。

Custom widget list

カスタムウィジェットページのヘッダーでは、次のアクションを使用できます。

アクション

説明

新しいウィジェット

サイドバーで新しいウィジェットダイアログを開きます。ここで、YouTrack に新しいカスタムウィジェットをアップロードできます。手順については、新しいカスタムウィジェットをアップロードするを参照してください。

無効 / 有効

選択したウィジェットのステータスを切り替えます。詳細については、カスタムウィジェットを無効にするを参照してください。

削除

選択したウィジェットを削除します。詳細については、カスタムウィジェットを削除するを参照してください。

更新

JetBrains マーケットプレイスからインストールされたウィジェットの場合、このボタンによりウィジェットが利用可能な最新バージョンに更新されます。

ウィジェット遊び場

ウィジェットの遊び場ページを開きます。ここでは、作成中のウィジェットの機能をテストできます。詳細については、カスタムウィジェットをテストするを参照してください。

詳細

サイドバーの詳細パネルの表示と非表示を切り替えます。

ウィジェット一覧

ウィジェットのリストは 2 つのセクションに分かれています。

  • インストールされたウィジェットセクションには、現在 YouTrack にインストールされているウィジェットが表示されます。これは、手動でアップロードされたウィジェットまたは JetBrains マーケットプレイスからインストールされたウィジェットの組み合わせにすることができます。

  • リポジトリで利用可能セクションには、JetBrains マーケットプレイスからインストールできるウィジェットが表示されます。

    リストはフィルター処理され、使用している YouTrack のバージョンと互換性のあるウィジェットのみが表示されます。YouTrack インストールが古い場合は、新しいバージョンとのみ互換性のある追加のウィジェットがマーケットプレイスに存在する可能性があります。利用可能なウィジェットの完全なリストを確認するには、JetBrains マーケットプレイスを参照してください(英語)

リスト内の各ウィジェットについて、次の属性が表示されます。

属性

説明

アイコン

ダッシュボードにウィジェットアイコンとして表示されるイメージ。

名前

カスタムウィジェットの名前。この属性は、ダッシュボードのウィジェットの追加ドロップダウンリストに表示されます。

ウィジェットの説明の最初の部分は、名前の横に表示されます。完全な説明を表示するには、サイドバーの詳細パネルを開きます。

ウィジェットの状態

名前の右側にあるバッジのコレクションは、さまざまなステータスインジケーターを提供します。次のバッジが使用されます。

  • enabled — ウィジェットは有効であり、ダッシュボードで使用できます。

  • disabled — ウィジェットはインストールされていますが、使用できません。詳細については、カスタムウィジェットを無効にするを参照してください。

  • 手動アップロード - ウィジェットは手動で YouTrack にアップロードされました。マーケットプレイスからの自動アップデートはサポートされていません。ウィジェットの更新も手動で適用する必要があります。詳細については、「カスタムウィジェットを更新する」を参照してください。

  • 古い — 新しいバージョンのウィジェットがマーケットプレイスから入手できます。利用可能なバージョンはサイドバーに示されています。アップデートはカスタムウィジェットページで直接適用できます。

バージョン

カスタムウィジェットの現在のバージョン。

作成者

ウィジェットを作成した開発者の名前とメールアドレス。

許可されたアプリケーション

カスタムウィジェットが接続されたサービスから情報をプルして表示できるようにするアプリケーションのリスト。アクセス可能なサービスの完全なリストは、詳細パネルに表示されます。

新しいカスタムウィジェットをアップロードする

JetBrains マーケットプレイスにアップロードされていないウィジェットを使用したい場合は、手動で YouTrack にアップロードする必要があります。YouTrack がプライベートネットワークにインストールされている場合、このオプションを使用して、マーケットプレイスからダウンロードしたウィジェットをインストールすることもできます。

新しいカスタムウィジェットをアップロードするには:

  1. 管理メニューから、サーバー設定> カスタムウィジェットを選択します。

  2. 新しいウィジェットボタンをクリックしてください。

    • 新しいウィジェットダイアログが開きます。

    New custom widget
  3. カスタムウィジェットの ZIP ファイルをドロップゾーンにドラッグするか、ドロップゾーンをクリックしてローカルディレクトリから ZIP ファイルを選択します。

    • Hub は ZIP アーカイブをチェックして、サイズ制限に準拠していることを確認します。これらの制限は、JetBrains マーケットプレイスからダウンロードされたカスタムウィジェットを含む、すべてのアップロードに適用されます。詳細については、「サイズ制限」を参照してください。

    • YouTrack は、ウィジェットマニフェストファイルで指定されている属性を表示します。これには、ウィジェットによってアクセスされるサービスのリストと、各アプリケーションのサポートされているバージョンが含まれます。

    New custom widget details
  4. アップロードウィジェットボタンをクリックしてください。

    • 新しいウィジェットのカスタムウィジェットページが開きます。

    • カスタムウィジェットが有効になり、使用可能になります。

JetBrains マーケットプレイスからウィジェットをインストールする

JetBrains マーケットプレイスは YouTrack と直接統合されています。これは、YouTrack を移動せずにマーケットプレイスからウィジェットをインストールできることを意味します。YouTrack インストールバージョンと互換性のあるウィジェットのリストは、リストのリポジトリから入手可能セクションに表示されます。

Install widget from JetBrains Marketplace.

マーケットプレイスへの接続を確立するには、YouTrack インストールがインターネットにアクセスできる必要があります。YouTrack サーバーインストールにプライベートネットワーク内からのみアクセスできる場合は、マーケットプレイスに直接アクセスできません。ただし、マーケットプレイスからウィジェットをダウンロードし、YouTrack インストールに手動でアップロードするオプションもまだあります。

マーケットプレイスからウィジェットをインストールするには:

  1. 管理メニューから、サーバー設定> カスタムウィジェットを選択します。

  2. リストのリポジトリから入手可能セクションでウィジェットを選択します。複数のウィジェットを選択できます。

  3. ツールバーのインストールボタンをクリックします。

    • 選択したウィジェットがリストのインストールされたウィジェットセクションに追加されます。

    • 選択した 1 つまたは複数のウィジェットが有効になり、使用可能になります。

カスタムウィジェットを更新する

カスタムウィジェットを更新するプロセスは、手動でアップロードされたウィジェットとマーケットプレイスからインストールされたウィジェットでは異なります。

手動アップロードを更新する

カスタムウィジェットの機能を拡張したら、これらの更新を既存のウィジェットに適用できます。これは、ユーザーがダッシュボードのウィジェットを置き換えることなく、更新された機能にアクセスできることを意味します。

リストの手動アップロードバッジは、ウィジェットが手動でアップロードされ、手動で更新する必要があることを示します。

既存のカスタムウィジェットを手動で更新するには:

  1. 管理メニューから、サーバー設定> カスタムウィジェットを選択します。

  2. 更新するウィジェットの名前をクリックします。

    • カスタムウィジェットページでウィジェットプロファイルが開きます。

  3. ウィジェットを更新ボタンをクリックしてください。

    • 新しいバージョンをアップロードダイアログが開きます。

    Upload new version
  4. カスタムウィジェットの更新バージョンを含む ZIP ファイルをドロップゾーンにドラッグするか、ドロップゾーンをクリックしてローカルディレクトリから ZIP ファイルを選択します。

    • YouTrack は、ウィジェットマニフェストファイルで指定されている属性を表示します。これには、ウィジェットによってアクセスされるサービスのリストと、各アプリケーションのサポートされているバージョンが含まれます。

    Upload new version attributes
  5. ウィジェットを更新ボタンをクリックしてください。

    • 更新は既存のウィジェットに適用されます。

    • 新しいバージョンでサポートされている追加機能はすぐに利用できます。

JetBrains マーケットプレイスからウィジェットを更新する

JetBrains マーケットプレイスからインストールされたウィジェットは、毎週自動的に更新されます。マーケットプレイスからの最新バージョンがまだインストールに適用されていない場合は、更新を YouTrack に直接プルできます。

リスト内の古いバッジは、新しいバージョンのウィジェットが利用可能であることを示しています。利用可能なバージョンはサイドバーに表示されます。

マーケットプレイスからウィジェットを更新するには:

  1. 管理メニューから、サーバー設定> カスタムウィジェットを選択します。

  2. 更新するウィジェットを選択します。期限切れとしてマークされているウィジェットが複数ある場合は、一度に選択して更新できます。

  3. ヘッダーのウィジェットを更新ボタンをクリックしてください。

    • 更新は既存のウィジェットに適用されます。

    • 新しいバージョンでサポートされている追加機能はすぐに利用できます。

カスタムウィジェットを無効にする

ユーザーがカスタムウィジェットを使用したくないが、YouTrack から削除したくない場合は、ウィジェットを無期限に無効にすることができます。

例: 開発者が修正したい既存のウィジェットに課題またはバグがあります。カスタムウィジェットを無効にして、ユーザーが現在の動作に課題が発生しないようにし、更新バージョンで課題が修正されたときにウィジェットを有効にできます。

ウィジェットが無効になると、ダッシュボードにウィジェットをインストールしたユーザーには、ウィジェットがシステムで見つからなかったというメッセージが表示されます。編集およびリフレッシュコントロールは表示されません。代わりに、ユーザーにはダッシュボードからウィジェットを削除するオプションが表示されます。

Widget removed

カスタムウィジェットを無効にするには:

  1. 管理メニューからサーバー設定> カスタムウィジェットを選択します。

  2. リストで無効にするウィジェットを選択します。

    Disable widget
  3. ウィジェットを無効にするボタンをクリックしてください。

    • 選択したウィジェットは無効になっています。

無効なウィジェットの場合、ヘッダーとウィジェットのプロファイルページのオプションは、それぞれ有効とウィジェットを有効にするに変わります。これらのコントロールを使用して、無効なウィジェットを再アクティブ化します。

カスタムウィジェットを削除する

YouTrack にサポートされなくなったカスタムウィジェットがある場合は、削除できます。例: カスタムウィジェットが、チームが使用しなくなったアプリケーションからの情報を表示する場合。

ウィジェットを削除すると、ダッシュボードにウィジェットをインストールしたユーザーには、システムでウィジェットが見つからなかったというメッセージが表示されます。編集およびリフレッシュコントロールは表示されません。代わりに、ユーザーにはダッシュボードからウィジェットを削除するオプションが表示されます。

カスタムウィジェットを削除するには:

  1. 管理メニューから、サーバー設定> カスタムウィジェットを選択します。

  2. リストから削除するウィジェットを選択します。

    Delete custom widget
  3. ウィジェットを削除するボタンをクリックしてください。

  4. ダイアログでアクションを確認します。

    • 選択したウィジェットが削除されます。

    • ウィジェットが手動でアップロードされた場合、YouTrack から完全に削除されます。

    • ウィジェットがマーケットプレイスからインストールされた場合は、インストールされたウィジェットのリストから削除され、マーケットプレイスから入手可能なウィジェットのリストに戻ります。

関連ページ:

カスタムウィジェットをテストする

カスタムウィジェットページには、ウィジェット遊び場ページへのリンクが含まれています。ウィジェットプレイグラウンドを使用すると、ウィジェットを開発中にプレビューおよびテストできます。このページでは、基本的に、サンドボックス環境でウィジェットをロードできます。ウィジェットプレイグラウンドにカスタムウィジェットをロードする:ウィジェットをテストするには、ウィジェットのプレイグラウンドにウィジェットをロードする必要があります。ウィジェットをウィジェットのプレイグラウンドに読み込むには、次の手順を実行す

ウィジェット開発ガイド

カスタムウィジェットは YouTrack ダッシュボードに埋め込むことができるミニチュアアプリケーションビューです。YouTrack データのカスタムビューや組み込み Hub サービスに格納されている情報など、ソフトウェアエコシステムの一部であるアプリケーションを表示して対話するためのウィジェットを作成できます。このページには、ウィジェットパッケージとマニフェストファイルの基本的な概要が含まれています。カスタムウィジェットを段階的に紹介するには、カスタムウィジェットチュートリアルを参照してくださ...