次の 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 メタデータファイル属性

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

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

JSON メタデータ ファイル属性

JSON メタデータファイル属性