次の 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) だけです。空白は使用できません。「カスタム ダッシュボード テンプレート」 を参照してください。string必須
attributes以下の属性を含むオブジェクト：array必須

titleウィジェット UI に表示されるウィジェットの題名。string必須

descriptionウィジェット UI に表示されるウィジェットの説明。string任意

widgetCategory

ウィジェットが属するカテゴリを指定します。widgetCategory 属性を指定しない場合、デフォルトの custom カテゴリが使用されます。 

string任意

widgetCategoryLabel

widgetCategory 属性で定義されるように、新規カテゴリを追加するときに [ウィジェットの追加] ダイアログに表示されるカテゴリ。

string任意

reportLocationこれは <DTP_INSTALL>/tomcat/webapps/grs/custom からの相対パスです (たとえば myReports/myReport.jsp)。処理が発生したときにファイルをバックアップして復元できるよう、レポート ファイル (HTML、JSP など) はカスタム フォルダーに置くべきです。パスを指定する際、最初のスラッシュ (/) は含めないでください。string必須

size_xウィジェットの幅 (「ダッシュボードの参照とナビゲーション」の「ダッシュボードのグリッド」 を参照)integer必須

size_y

ウィジェットの高さ (「ダッシュボードの参照とナビゲーション」の「ダッシュボードのグリッド」 を参照)

integer必須

parametersウィジェットのパラメーターを表すオブジェクトの配列が含まれます。各オブジェクトは以下の属性を持ちます:
必須


type

パラメーターの入力タイプを指定します。有効な値は次のとおりです:

  • text 
  • checkbox 
  • date 
  • dropdown

値が dropdown の場合、次の属性を設定できます。

string必須



dropdownOptionsドロップダウン メニュー UI を表すオブジェクトの配列が含まれます。array任意




keyドロップダウン項目のパラメーター。string必須




valueドロップダウン項目のパラメーター。string必須


name

パラメーター入力のラベルを指定します。使用できるのはテキストのみの文字列です。空白は使用できません。

type が dropdown に設定されている場合、次の特別な値も使用できます:

  • filter: ユーザーが DTP フィルターを選択できるようにします。
  • project: ユーザーが DTP プロジェクトを選択できるようにします。
  • period: ユーザーがデータ範囲を選択できるようにします。
string必須


requiredウィジェットを設定するために値の指定が必須かどうかを決定します。デフォルトは false です。Boolean任意


titleUI でのパラメーターのラベル。  指定しない場合、name 属性の値が使用されます。string任意


inheritableフィルター、プロジェクト、およびデータ範囲の設定が継承可能かどうかを決定します。Boolean任意

widgetLabelsUI に表示されるウィジェット ラベルを表すオブジェクトの配列を含みます:array必須


titleウィジェットがダッシュボードに追加されるときに表示されるラベル。string必須


name

ウィジェットがダッシュボードに追加されるときに選択されたパラメーターの名前。この名前は、filter を使用するのでない限り、パラメーターの名前に一致するべきです。また、filterName を使ってフィルターの名前を表示したり、filterId を使って ID を表示したりすることもできます。

string必須
  • No labels

Need assistance? Visit our support page