次の JSON コードは、ウィジェットの構造とサポートされる属性を示します。属性の詳細については、下記の「JSON メタファイル属性」を参照してください。

{
		"name": "customWidgetName",
		"attributes": {
			"title": "A title is required",
			"description": "A description of your widget; optional.",
			"widgetCategory": "widgetCategory",
			"reportLocation": "widget/myWidgetData/myReport.jsp",
			"size_x": 2,
			"size_y": 1,
			"parameters": [
			{
				"type": "dropdown",
				"name": "parameterName",
				"required": true,
				"dropdownOptions": [{
				"key": "any",
				"value": " "
				}, {
				"key": "open",
				"value": "open"
				}]
			}, {
				"type": "text",
				"name": "textParameterName",
				"title": "textParameterTitle",
			}, {
				"type": "dropdown",
				"name": "filter",
				"title": "dropdownParameterTitle",
				"inheritable": true,
			}	
		],
		"widgetLabels": [
			{
				"title": "Label that will show in the UI",
				"name": "filterName"
			}
		],
	}
}

JSON メタファイル属性

以下のリストは、スキーマ構造内のファイル属性についての説明です。

name: 必須。ウィジェットの名前は、カスタムダッシュボードテンプレートにウィジェットを追加するための ID としての役割も果たします。使用できるのはテキスト (a-z) だけです。空白は使用できません。「カスタムダッシュボードテンプレート」を参照してください。
attributes:
- title: 必須。ウィジェット UI に表示されるウィジェットの題名。
- description: 任意。指定しない場合、空白。
- widgetCategory: 任意。ウィジェットが属するカテゴリを指定します。ウィジェットのカテゴリを指定するための 3 種類のオプションがあります。
  - 既存カテゴリ: DTP_HOME/grs/widget/builtin ディレクトリにある既存ウィジェットの JSON ファイルを参照し、その widgetCategory の値をコピーできます (たとえば projectCenter)。
  - カスタムカテゴリ: widgetCategory 属性を指定しない場合、デフォルトの custom カテゴリが使用されます。「カスタムウィジェット」を参照してください。
  - 新規カテゴリ: 既存カテゴリと同じ値を新規カテゴリに指定することはできません。空白は使用できません。widgetCategoryLabel 属性を設定し、[ウィジェットの追加] ダイアログに表示される新規カテゴリを指定します。
- widgetCategoryLabel: 任意。widgetCategory 属性で定義されるように、新規カテゴリを追加するときに [ウィジェットの追加] ダイアログに表示されるカテゴリ。
- reportLocation: 必須。これは DTP_HOME/tomcat/webapps/grs/custom からの相対パスです (たとえば myReports/myReport.jsp)。処理が発生したときにファイルをバックアップして復元できるよう、レポートファイル (HTML、JSP など) はカスタムフォルダーに置くべきです。パスを指定する際、最初のスラッシュ (/) は含めないでください。
- size_x: ウィジェットの幅 (「ダッシュボードの参照とナビゲーション」の「ダッシュボードのグリッド」を参照)
- size_y: ウィジェットの高さ (「ダッシュボードの参照とナビゲーション」の「ダッシュボードのグリッド」を参照)
- parameters:
  - type: 必須。許容値は text、checkbox、date、および dropdown。
  - name: 必須。パラメーターの名前を指定します。使用できるのはテキスト (a-z) だけです。空白は使用できません。type が dropdown に設定されている場合、次の特別な値も使用できます。
    - filter: ユーザーが DTP フィルターを選択できるようにします。
    - project: ユーザーが DTP プロジェクトを選択できるようにします。
    - period: ユーザーがデータ範囲を選択できるようにします。
  - required: 任意。許容値は true または false です。値の指定が必須かどうかを決定します。デフォルトは false です。
  - dropdownOptions: type が type が dropdown の場合にサポートされます。
    - key: ドロップダウン項目のためのパラメーター。
    - value: ドロップダウン項目のためのパラメーター。
  - title: 任意。UI でのパラメーターのラベル。指定しない場合、name 属性の値が使用されます。
  - inheritable: 任意。許容値は true または false です。ダッシュボードからの設定が継承可能かどうかを決定します。フィルター、プロジェクト、およびデータ範囲に適用されます。
- widgetLabels:
  - title: ウィジェットがダッシュボードに追加されるときに表示されるラベル。
  - name: ウィジェットがダッシュボードに追加されるときに選択されたパラメーターの名前。この名前は、filter を使用するのでない限り、パラメーターの名前に一致するべきです。また、filterName を使ってフィルターの名前を表示したり、filterId を使って ID を表示したりすることもできます。

Page tree

カスタム ウィジェットのスキーマ

JSON メタファイル属性

カスタムウィジェットのスキーマ