9.4.4. ダッシュボード定義ファイルの要素のXMLタグ¶
ダッシュボード定義ファイルの要素のXMLタグの定義について説明します。
9.4.4.1. ダッシュボードのXMLタグ定義¶
9.4.4.1.1. 定義の場所¶
- ダッシュボードのXMLタグは下記索引定義ファイルに定義されています。
/senju/xml/sjDBD_ContainerIndexes.xml
9.4.4.1.2. XMLタグ仕様¶
- ダッシュボードのXMLタグは下記に示すように <Dashboard> で定義されています。 Dashboard を名前空間とします。
<Dashboard xmlns="Dashboard"> <AutoUpdateInterval>...</AutoUpdateInterval> <FadeIn> ... ... </FadeIn> <NodesEndPoint>...</NodesEndPoint> <MonTasksEndPoint>...</MonTasksEndPoint> <Indexes> ... ... </Indexes> </Dashboard>
- ダッシュボード詳細情報定義ファイル索引グループのXMLタグは下記のように <Indexes> で定義されています。
<Dashboard xmlns="Dashboard"> <Indexes> <Index>...</Index> <Index>...</Index> ... ... </Indexes> </Dashboard>
9.4.4.1.3. 属性タグ一覧¶
9.4.4.1.3.1. <Dashboard>属性タグ一覧¶
属性タグ |
デフォルト
|
省略
|
変更可否
|
説明
|
---|---|---|---|---|
<AutoUpdateInterval> |
60
|
不可
|
○
|
|
<FadeIn> |
-
|
不可
|
○
|
|
<NodesEndPoint> |
/live/{domainName}/nodes?
filters=nodeId,nodeGroupList
|
不可
|
×
|
|
<MonTasksEndPoint> |
/db/{domainName}/monitoring/tasks?
filters=ID,MonItemName,CategoryID,
CategoryName,ExtensionID,NodeID,Status
|
不可
|
×
|
|
<Indexes> |
-
|
不可
|
○
|
|
注釈
監視タスクの最少監視間隔(分)およびWebAPIのキャッシュ有効期限を参照に、自動更新間隔(秒)を設定することによってリアルの情報更新に近い効果が得られます。
WebAPIのキャッシュ有効期限の設定例は下記に示します。
- api/Web.config
<configuration> ... ... <appSettings> ... ... <add key="EnableCacheMode" value="true" /> <add key="CacheExpirationTimeInSeconds" value="60" /> ... ... </appSettings> ... ... </configuration>
- api/SulCustomWeb.config
<customCacheExpirationTimeInSeconds> ... ... <add key="/v1/live/{domainName}/nodes" value="300" /> <add key="/v1/live/{domainName}/monitoring/summaries" value="60" /> <add key="/v1/db/{domainName}/monitoring/tasks" value="300" /> <add key="/v1/db/{domainName}/monitoring/metrics" value="60" /> <add key="/v1/db/{domainName}/monitoring/statistics/latest" value="60" /> <add key="/v1/db/{domainName}/event/message/statistics/msginfo" value="30" /> <add key="/v1/db/{domainName}/jobscheduler/statistics/jobinfo" value="30" /> <add key="/v1/db/{domainName}/event/message/statistics/timeline" value="30" /> <add key="/v1/db/{domainName}/jobscheduler/statistics/timeline" value="30" /> ... ... </customCacheExpirationTimeInSeconds>
9.4.4.1.3.2. <Indexes>属性タグ一覧¶
属性タグ |
デフォルト
|
省略
|
変更可否
|
説明
|
---|---|---|---|---|
<Index> |
-
|
不可
|
○
|
|
注釈
<Index>羅列の順番はダッシュボード表示画面での左上から右下までタイルの表示順となります。
<Index>の個数に制限はありません。
9.4.4.2. コンテナのXMLタグ定義¶
9.4.4.2.1. 定義の場所¶
- コンテナのXMLタグは下記ダッシュボード詳細情報定義ファイルに定義されています。
/senju/xml/sjDBD_Container_[対象クラウドに関連付けられている千手ノードグループID].xml
9.4.4.2.2. XMLタグ仕様¶
- コンテナのXMLタグは以下のように <Container> で定義されています。 Dashboard.Container を名前空間とします。
<Container xmlns="Dashboard.Container"> <DisplayName> ... ... </DisplayName> <SenjuNodeGroupId>...</SenjuNodeGroupId> <IconPath>...</IconPath> <Categories> ... ... </Categories> </Container>
- コンテナ表示名のXMLタグは以下のように <DisplayName> で定義されています。
<Container xmlns="Dashboard.Container"> <DisplayName> <jp>...</jp> <en>...</en> ... ... </DisplayName> </Container>
- カテゴリグループのXMLタグは以下のように <Categories> で定義されています。
<Container xmlns="Dashboard.Container"> <Categories> <Category> ... ... </Category> <Category> ... ... </Category> ... ... </Categories> </Container>
9.4.4.2.3. 属性タグ一覧¶
9.4.4.2.3.1. <Container>属性タグ一覧¶
属性タグ |
デフォルト
|
省略
|
変更可否
|
説明
|
---|---|---|---|---|
<DisplayName> |
-
|
不可
|
○
|
|
<SenjuNodeGroupId> |
-
|
不可
|
○
|
|
<IconPath> |
-
|
不可
|
○
|
|
<Categories> |
-
|
不可
|
○
|
|
注釈
画像ファイルの相対仮想パスは、ダッシュボードのベースURL(/senju/view/dbd/)を基準にして相対する仮想パスとなります。
9.4.4.2.3.2. <DisplayName>属性タグ一覧¶
属性タグ |
デフォルト
|
省略
|
変更可否
|
説明
|
---|---|---|---|---|
<jp> |
-
|
不可
|
○
|
|
<en> |
-
|
不可
|
○
|
|
9.4.4.2.3.3. <Categories>属性タグ一覧¶
属性タグ |
デフォルト
|
省略
|
変更可否
|
説明
|
---|---|---|---|---|
<Category> |
-
|
可
|
○
|
|
注釈
表示名「 概要 」のカテゴリを必ずカテゴリ一覧の先頭に定義しておいてください。
<Category>羅列の順番はダッシュボード詳細表示画面での左上から右下までタイルの表示順となります。
<Category>の個数に制限はありません。
9.4.4.3. カテゴリのXMLタグ定義¶
9.4.4.3.1. 定義の場所¶
- カテゴリのXMLタグは下記ダッシュボード詳細情報定義ファイルに定義されています。
/senju/xml/sjDBD_Container_[対象クラウドに関連付けられている千手ノードグループID].xml
9.4.4.3.2. XMLタグ仕様¶
- カテゴリのXMLタグは以下のように <Category> で定義されています。
<Container xmlns="Dashboard.Container"> <Categories> <Category> <DisplayName> ... ... </DisplayName> <Types> ... ... </Types> </Category> ... ... </Categories> </Container>
- カテゴリ表示名のXMLタグは以下のように <DisplayName> で定義されています。
<Container xmlns="Dashboard.Container"> <Categories> <Category> <DisplayName> <jp>...</jp> <en>...</en> ... ... </DisplayName> </Category> ... ... </Categories> </Container>
- タイプグループのXMLタグは以下のように <Types> で定義されています。
<Container xmlns="Dashboard.Container"> <Categories> <Category> <Types> <Type> ... ... </Type> <Type> ... ... </Type> ... ... </Types> </Category> ... ... </Categories> </Container>
9.4.4.3.3. 属性タグ一覧¶
9.4.4.3.3.1. <Category>属性タグ一覧¶
属性タグ |
デフォルト
|
省略
|
変更可否
|
説明
|
---|---|---|---|---|
<DisplayName> |
-
|
不可
|
○
|
|
<Types> |
-
|
不可
|
○
|
|
9.4.4.3.3.2. <DisplayName>属性タグ一覧¶
属性タグ |
デフォルト
|
省略
|
変更可否
|
説明
|
---|---|---|---|---|
<jp> |
-
|
不可
|
○
|
|
<en> |
-
|
不可
|
○
|
|
9.4.4.3.3.3. <Types>属性タグ一覧¶
属性タグ |
デフォルト
|
省略
|
変更可否
|
説明
|
---|---|---|---|---|
<Type> |
-
|
可
|
○
|
|
注釈
<Type>羅列の順番はダッシュボード詳細表示画面の各タイルでの左上から右下までタイルの表示順となります。
<Type>の個数に制限はありません。
9.4.4.4. タイプのXMLタグ定義¶
9.4.4.4.1. 定義の場所¶
- タイプのXMLタグは下記ダッシュボード詳細情報定義ファイルに定義されています。
/senju/xml/sjDBD_Container_[対象クラウドに関連付けられている千手ノードグループID].xml
9.4.4.4.2. XMLタグ仕様¶
- タイプのXMLタグは以下のように <Type> で定義されています。
<Container xmlns="Dashboard.Container"> <Categories> <Category> <Types> <Type> <DisplayName> ... ... </DisplayName> <URL>...</URL> <ChartType>...</ChartType> <KPIs> ... ... </KPIs> <Items> ... ... </Items> </Type> ... ... </Types> </Category> ... ... </Categories> </Container>
- タイプ表示名のXMLタグは以下のように <DisplayName> で定義されています。
<Container xmlns="Dashboard.Container"> <Categories> <Category> <Types> <Type> <DisplayName> <jp>...</jp> <en>...</en> ... ... </DisplayName> </Type> ... ... </Types> </Category> ... ... </Categories> </Container>
- KPIグループのXMLタグは以下のように <KPIs> で定義されています。
<Container xmlns="Dashboard.Container"> <Categories> <Category> <Types> <Type> <KPIs> <KPI> ... ... </KPI> <KPI> ... ... </KPI> ... ... </KPIs> </Type> ... ... </Types> </Category> ... ... </Categories> </Container>
- KPIのXMLタグは以下のように <KPI> で定義されています。
<Container xmlns="Dashboard.Container"> <Categories> <Category> <Types> <Type> <KPIs> <KPI> <jp>...</jp> <en>...</en> ... ... </KPI> ... ... </KPIs> </Type> ... ... </Types> </Category> ... ... </Categories> </Container>
- アイテムグループのXMLタグは以下のように <Items> で定義されています。
<Container xmlns="Dashboard.Container"> <Categories> <Category> <Types> <Type> <Items> <Item> ... ... </Item> <Item> ... ... </Item> ... ... </Items> </Type> ... ... </Types> </Category> ... ... </Categories> </Container>
9.4.4.4.3. 属性タグ一覧¶
9.4.4.4.3.1. <Type>属性タグ一覧¶
属性タグ |
デフォルト
|
省略
|
変更可否
|
説明
|
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
<DisplayName> |
-
|
不可
|
○
|
|
||||||||||||||||||||
<URL> |
-
|
不可
|
○
|
|
||||||||||||||||||||
<ChartType> |
-
|
可
|
○
|
|
||||||||||||||||||||
<KPIs> |
-
|
可
|
○
|
|
||||||||||||||||||||
<Items> |
-
|
不可
|
○
|
|
9.4.4.4.3.2. <DisplayName>属性タグ一覧¶
属性タグ |
デフォルト
|
省略
|
変更可否
|
説明
|
---|---|---|---|---|
<jp> |
-
|
不可
|
○
|
|
<en> |
-
|
不可
|
○
|
|
9.4.4.4.3.3. <KPIs>属性タグ一覧¶
属性タグ |
デフォルト
|
省略
|
変更可否
|
説明
|
---|---|---|---|---|
<KPI> |
-
|
可
|
○
|
|
注釈
<KPI>羅列の順番は任意となります。
<KPI>の個数に制限はありません。
9.4.4.4.3.4. <KPI>属性タグ一覧¶
属性タグ |
デフォルト
|
省略
|
変更可否
|
説明
|
---|---|---|---|---|
<jp> |
-
|
不可
|
○
|
|
<en> |
-
|
不可
|
○
|
|
注釈
千手監視項目は、履歴データを保存する必要があります。
9.4.4.4.3.5. <Items>属性タグ一覧¶
属性タグ |
デフォルト
|
省略
|
変更可否
|
説明
|
---|---|---|---|---|
<Item> |
-
|
可
|
○
|
|
注釈
<Item>羅列の順番はダッシュボード詳細表示画面の各タイルの各セルでの左から右まで項目の表示順となります。
<Item>の個数制限は 9個まで となります。
9.4.4.5. アイテムのXMLタグ定義¶
9.4.4.5.1. 定義の場所¶
- アイテムのXMLタグは下記ダッシュボード詳細情報定義ファイルに定義されています。
/senju/xml/sjDBD_Container_[対象クラウドに関連付けられている千手ノードグループID].xml
9.4.4.5.2. XMLタグ仕様¶
- アイテムのXMLタグは以下のように <Item> で定義されています。
<Container xmlns="Dashboard.Container"> <Categories> <Category> <Types> <Type> <Items> <Item> <DisplayName>...</DisplayName> <Color>...</Color> <ThresholdA>...</ThresholdA> <ThresholdW>...</ThresholdW> <EndPoint>...</EndPoint> <HookFunc>...</HookFunc> <SummaryId>...</SummaryId> <Filters>...</Filters> <DbQuery>...</DbQuery> <PeriodUnit>...</PeriodUnit> <PeriodCount>...</PeriodCount> <Range>...</Range> <CategoryName>...</CategoryName> <ExtensionId>...</ExtensionId> <TaskType>...</TaskType> </Item> ... ... </Items> </Type> ... ... </Types> </Category> ... ... </Categories> </Container>
- アイテム表示名のXMLタグは以下のように <DisplayName> で定義されています。
<Container xmlns="Dashboard.Container"> <Categories> <Category> <Types> <Type> <Items> <Item> <DisplayName> <jp>...</jp> <en>...</en> ... ... </DisplayName> </Item> ... ... </Items> </Type> ... ... </Types> </Category> ... ... </Categories> </Container>
9.4.4.5.3. 属性タグ一覧¶
9.4.4.5.3.1. <Item>属性タグ一覧¶
属性タグ |
デフォルト
|
省略
|
変更可否
|
説明
|
||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
<DisplayName> |
-
|
不可
|
○
|
|
||||||||||||||||||||||||||||||||||||||||
<Color> |
green
|
不可
|
○
|
|
||||||||||||||||||||||||||||||||||||||||
<ThresholdA> |
0
|
可
|
○
|
|
||||||||||||||||||||||||||||||||||||||||
<ThresholdW> |
0
|
可
|
○
|
|
||||||||||||||||||||||||||||||||||||||||
<EndPoint> |
-
|
不可
|
×
|
|
||||||||||||||||||||||||||||||||||||||||
<HookFunc> |
-
|
可
|
×
|
|
||||||||||||||||||||||||||||||||||||||||
<SummaryId> |
avg
|
可
|
○
|
|
||||||||||||||||||||||||||||||||||||||||
<Filters> |
-
|
可
|
×
|
|
||||||||||||||||||||||||||||||||||||||||
<DbQuery> |
-
|
可
|
○
|
|
||||||||||||||||||||||||||||||||||||||||
<PeriodUnit> |
-
|
可
|
○
|
|
||||||||||||||||||||||||||||||||||||||||
<PeriodCount> |
-
|
可
|
○
|
|
||||||||||||||||||||||||||||||||||||||||
<Range> |
-
|
可
|
○
|
|
||||||||||||||||||||||||||||||||||||||||
<CategoryName> |
-
|
可
|
○
|
|
||||||||||||||||||||||||||||||||||||||||
<ExtensionId> |
-
|
可
|
○
|
|
||||||||||||||||||||||||||||||||||||||||
<TaskType> |
-
|
可
|
×
|
|
9.4.4.5.3.2. <DisplayName>属性タグ一覧¶
属性タグ |
デフォルト
|
省略
|
変更可否
|
説明
|
---|---|---|---|---|
<jp> |
-
|
不可
|
○
|
|
<en> |
-
|
不可
|
○
|
|
注釈
千手監視項目は、履歴データを保存する必要があります。