アプリケーション・マニフェストの構造

マニフェストは、アプリケーションが提供する機能を IBM® QRadar® に対して示す JSON ファイルです。

次の表で、manifest.json ファイルに含めることができるフィールドについて説明します。

表 1. アプリケーション・マニフェストのフィールド
フィールド	必須	タイプ	説明
名前	はい	ストリング	ユーザーが判読可能なアプリケーションの名前。アプリケーションがグローバル化されている場合、このフィールドでは、オプションでリソース・バンドル・キーを示すことができます。
説明	はい	ストリング	ユーザーが判読可能なアプリケーションの説明。アプリケーションがグローバル化されている場合、このフィールドでは、オプションでリソース・バンドルを示すことができます。
バージョン	はい	ストリング	アプリケーションのバージョン・ストリング。ここでは任意の形式を使用できます。
UUID	はい	ストリング	アプリケーションの RFC 4122 準拠の汎用固有 ID。 create コマンドは Python UUID パッケージを使用して、uuid 値に対してランダムの 128 ビットの数値を生成します。アプリケーション・マニフェスト・ファイルの作成に SDK を使用しない場合、uuid フィールドに固有値を手動で入力する必要があります。
authentication	はい	ストリング	アプリケーションが QRadar にアクセスするための許可。唯一の必須項目は `「requested_capabilities」`: ["<`capability`>"] です。例えば、admin はよく使用されるユーザー機能です。サポートされている QRadar ユーザー機能を少なくとも 1 つ入力してください。いずれかの `requested_capabilities` が QRadar で定義されていない場合、インストールは失敗します。
load_flask	いいえ	ブール値	Python Flask フレームワークをアプリケーションで使用できないようにする場合は、false に設定します。通常、アプリケーションで異なる Web アプリケーション・フレームワークを使用する場合に、Flask を無効にします。未指定の場合、このフィールドは、true にデフォルト設定されます。 QRadar コンソール V7.3.0 およびそれ以降によるサポートおよび V7.3.1
node_only	いいえ	ブール値	アプリケーションをアプリケーション・ノードのみにインストールし、QRadar コンソールコンソールにはインストールしない場合、true に設定します。アプリケーションにより大量のリソースが消費される場合に便利です。このフィールドを使用する場合は、アプリケーションがアプリケーション・ノード・アプライアンス (管理対象外のホスト) でのみ実行されることをユーザーに通知してください。未指定の場合、このフィールドは、false にデフォルト設定されます。 QRadar コンソール V7.3.0 およびそれ以降によるサポート。
デバッグ	いいえ	ブール値	true に設定すると、アプリケーションのロギングがオンになります。未指定の場合、このフィールドは、false にデフォルト設定されます。
区域	いいえ	領域タイプの配列	1 つ以上の領域オブジェクトで、アプリケーションの新しい完成ページを示します。 QRadar では、領域オブジェクトはタブとして表されます。
rest_methods	いいえ	REST メソッド・タイプの配列	1 つ以上の REST メソッド・オブジェクトで、アプリケーションが公開している REST メソッドを示します。 REST メソッド・オブジェクトは、ダッシュボード項目とメタデータ・プロバイダーについては必須パラメーターですが、アクションについてはオプションです。
dashboard_items	いいえ	ダッシュボード項目タイプの配列	1 つ以上のダッシュボード項目オブジェクトで、QRadar ダッシュボードに公開する新しい項目の内容を示します。
configuration_pages	いいえ	構成ページ・タイプの配列	1 つ以上の構成ページ・オブジェクトで、構成を表すアプリケーションの新しい完成ページを示します。 QRadar では、構成ページは「管理」タブから開きます。
gui_actions	いいえ	GUI アクション・タイプの配列	1 つ以上の GUI アクション・オブジェクトで、ページ・ツールバーまたは右クリック・メニューによりユーザー・インターフェース内の項目に対して実行できる新しいアクションを示します。
page_scripts	いいえ	ページ・スクリプト・タイプの配列	1 つ以上のページ・スクリプト・オブジェクトで、QRadar の既存のページ内に含める新しい JavaScript ファイルを示します。デフォルトでは、これらのスクリプトは独自の名前空間で実行されます。
metadata_providers	いいえ	メタデータ・プロバイダー・タイプの配列	1 つ以上のメタデータ・プロバイダー・オブジェクトで、QRadar の特定データ・タイプの新しいメタデータ情報をフェッチするために呼び出すことができる REST メソッドを示します。項目の上にマウス・ポインターを置くと、ツールチップにメタデータが表示されます。
resource_bundles	いいえ	リソース・バンドル・タイプの配列	1 つ以上のリソース・バンドル・オブジェクト。言語ロケールおよびロケール・プロパティー・ファイル・ロケーション用にこれらのオブジェクトを使用します。
dev_opts	いいえ	開発者オプション・タイプの配列	1 つ以上の開発者オプション・オブジェクト。これらのオブジェクトを使用して、ローカルでの開発時に使用する値を指定します。
リソース	いいえ	整数	1 つ以上のリソース・オブジェクト。これらのオブジェクトを使用して、アプリケーションで使用できるメモリー容量 (メガバイト単位) を構成します。 QRadar V7.2.7 以降でサポートされています。
フラグメント	いいえ	フラグメント・タイプの配列	これらのオブジェクトを使用して、コンテンツの追加先となる QRadar UI 内の挿入ポイント、およびコンテンツを取得するために使用する REST エンドポイントを決定します。 QRadar V7.2.8 以降でサポートされています。
custom_columns	いいえ	カスタム列タイプの配列	1 つ以上のカスタム列オブジェクト。これらのオブジェクトを使用して、カスタム列の追加先となるコンテキスト (QRadar UI 内のページおよび表)、列ヘッダーのラベル、追加するデータのタイプ、および列の内容を追加するために使用する REST エンドポイントを指定します。 QRadar V7.2.8 以降でサポートされています。