ツイートはてブ LINE Pocket

アプリパッケージの概要

このページでは、アプリパッケージとそのコンポーネントの概要を説明します。

アプリパッケージ

サンプルアプリパッケージのファイル構造は次のとおりです。

パッケージの主なコンポーネントは次のとおりです。

アプリマニフェストは、アプリパッケージのルートレベルに保存される JSON ファイルです。
アプリ設定のカスタムスキーマ。
各ウィジェットのサブフォルダーを含む widgets フォルダー。
管理ウィジェットのサブフォルダー。このサブフォルダーには、このウィジェットで使用される index.html ファイルおよびその他の補足ファイルが含まれています。
追加モジュールのスクリプトを含む JavaScript ファイル。

App Manifest

各アプリパッケージには、パッケージディレクトリのルートに manifest.json ファイルが含まれている必要があります。マニフェストファイルには、タイトル、説明、アプリに含まれるモジュールのリストなど、アプリに関する一般的な情報が記載されています。

アプリマニフェストの詳細については、App Manifest を参照してください。

アプリの設定

アプリ開発者は、アプリのカスタム設定のスキーマを提供するオプションがあります。設定スキーマは settings.json ファイルに記述されます。これらの設定は、アプリの設定タブで構成するためにアクセスできます。

アプリのカスタム設定の詳細については、アプリの設定を参照してください。

ウィジェット

YouTrack の外観を変更し、YouTrack UI の独自の拡張機能を開発するには、ウィジェットを作成します。ウィジェットは、YouTrack UI のいくつかの拡張ポイントに埋め込むことができます。これらの拡張ポイントの完全なリストについては、拡張ポイントを参照してください。

ここでは、マニフェストに記述されているウィジェットの例を見ることができます。

            {
              "name": "Sample Widget",
              "key": "sample-widget",
              "indexPath": "index.html",
              "place": "ISSUE_FIELD_PANEL_FIRST",
              "description": "Optional widget description",
              "iconPath": "icon.png"
            }
        

ここでは、このウィジェットのソースコードを含むサンプル index.html ファイルを確認できます。

            <!doctype html>
            <html>
                <head>
                    <link rel="stylesheet" href="../index.css">
                </head>
                <body class="plugin" style="padding: 0; overflow: hidden;">
                    <img src="logo.jpeg" style="width: 100%; height: 100%; object-fit: cover;"/>
                    <script type="module">
                        const host = await YTApp.register();
                    </script>
                </body>
            </html>
        

JavaScript モジュール

カスタム HTTP ハンドラー、ワークフロールール、インポートスクリプト、SLA ルールなど、さまざまな JavaScript ベースのモジュールをアプリに追加できます。アプリの JavaScript モジュールの詳細については、アプリリファレンスを参照してください。

各モジュールのソースコードを個別のファイル .js ファイルに保存する必要があります。

最終更新日: 2024 年 11 月 7 日

関連ページ：

App Manifest

各アプリパッケージには、パッケージディレクトリのルートにファイルが含まれている必要があります。マニフェストファイルには、アプリの名前、説明、アプリに含まれるモジュールのリストなど、アプリに関する一般的な情報が記載されています。サンプルマニフェスト：以下はアプリのサンプルマニフェストです。{

拡張ポイント

YouTrack は、アプリ開発者が UI にウィジェットを埋め込むことができる拡張ポイントのコレクションを提供します。これらのウィジェットは、ユーザーがアプリをインストールしてアクティブ化しない限り利用できない特定の操作をサポートします。このページでは、これらの拡張ポイントに関する情報を確認できます。ここでは、すべての可能な拡張ポイントとそのスコープの概要を示します。ウィジェットのスコープの詳細については、スコープを参照してください。ADMINISTRATION_MENU_ITEM グローバル管...

アプリクイックスタートガイド

アプリは、YouTrack に特定の機能を追加するソフトウェアコンポーネントです。アプリを使用すると、システムのコア構造を変更することなく、システムの基本機能をカスタマイズおよび拡張できます。このモジュール方式により、YouTrack の機能を動的に強化し、組織のニーズに合わせてより柔軟かつ適応性の高いものにすることができます。アプリを作成して YouTrack で使用を開始するには、次の手順に従います。アプリパッケージを作成する、アプリのマニフェストを作成する、アプリのカスタム設定のスキーマを...