5.2.1.4.4. ダッシュボード定義ファイルの要素のXMLタグ¶

ダッシュボード定義ファイルの要素のXMLタグの定義について説明します。

5.2.1.4.4.1. ダッシュボードのXMLタグ定義¶

5.2.1.4.4.1.1. 定義の場所¶

ダッシュボードのXMLタグは下記索引定義ファイルに定義されています。

/senju/xml/sjDBD_ContainerIndexes.xml

5.2.1.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>

5.2.1.4.4.1.3. 属性タグ一覧¶

5.2.1.4.4.1.3.1. <Dashboard>属性タグ一覧¶

表 5.691 <Dashboard>属性タグ一覧¶
属性タグ	デフォルト	省略	変更可否	説明
<AutoUpdateInterval>	60	不可	○	自動更新間隔（秒）を定義します。０以下に設定した場合および別ウィンドウ表示となった場合、自動更新は行われていません。
<FadeIn>	-	不可	○	フェードイン通知諸元を定義します。項目が更新されたことをフェードイン効果で通知するようにします。
<NodesEndPoint>	/live/{domainName}/nodes? filters=nodeId,nodeGroupList	不可	×	千手ノード定義一覧を取得するためのWebAPIエンドポイントを定義します。 XMLエンコードされる必要があります。取得項目千手ノードID 所属する千手ノードグループID一覧
<MonTasksEndPoint>	/db/{domainName}/monitoring/tasks? filters=ID,MonItemName,CategoryID, CategoryName,ExtensionID,NodeID,Status	不可	×	千手監視タスク定義一覧を取得するためのWebAPIエンドポイントを定義します。 XMLエンコードされる必要があります。取得項目千手監視タスクID 千手監視項目名千手監視カテゴリID 千手監視カテゴリ名千手監視エクステンションID 千手監視対象ノードID 千手監視タスクステータス
<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>

5.2.1.4.4.1.3.2. <Indexes>属性タグ一覧¶

表 5.692 <Indexes>属性タグ一覧¶
属性タグ	デフォルト	省略	変更可否	説明
<Index>	-	不可	○	ダッシュボード詳細情報定義ファイルパスを定義します。ダッシュボード詳細情報定義ファイルパスは、ベースURL（/senju/）を除いた相対仮想パスとなります。ダッシュボード詳細情報定義ファイルパスは以下のフォーマットとなります。 /senju/xml/sjDBD_Container_[対象クラウドに関連付けられている千手ノードグループID].xml

注釈

<Index>羅列の順番はダッシュボード表示画面での左上から右下までタイルの表示順となります。
<Index>の個数に制限はありません。

5.2.1.4.4.2. コンテナのXMLタグ定義¶

5.2.1.4.4.2.1. 定義の場所¶

コンテナのXMLタグは下記ダッシュボード詳細情報定義ファイルに定義されています。

/senju/xml/sjDBD_Container_[対象クラウドに関連付けられている千手ノードグループID].xml

5.2.1.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>

5.2.1.4.4.2.3. 属性タグ一覧¶

5.2.1.4.4.2.3.1. <Container>属性タグ一覧¶

表 5.693 <Container>属性タグ一覧¶
属性タグ	デフォルト	省略	変更可否	説明
<DisplayName>	-	不可	○	コンテナの表示名を定義します。 `&` `<` は使用できません。
<SenjuNodeGroupId>	-	不可	○	対象クラウドに関連付けられている千手ノードグループIDを定義します。
<IconPath>	-	不可	○	対象クラウドをイメージする画像ファイルの相対仮想パスを定義します。画像ファイルの格納先が「 ../../img/ 」です。
<Categories>	-	不可	○	カテゴリ一覧を定義します。

注釈

画像ファイルの相対仮想パスは、ダッシュボードのベースURL（/senju/view/dbd/）を基準にして相対する仮想パスとなります。

5.2.1.4.4.2.3.2. <DisplayName>属性タグ一覧¶

表 5.694 <DisplayName>属性タグ一覧¶
属性タグ	デフォルト	省略	変更可否	説明
<jp>	-	不可	○	コンテナの日本語表示名を定義します。 `&` `<` は使用できません。
<en>	-	不可	○	コンテナの英語表示名を定義します。 `&` `<` は使用できません。

5.2.1.4.4.2.3.3. <Categories>属性タグ一覧¶

表 5.695 <Categories>属性タグ一覧¶
属性タグ	デフォルト	省略	変更可否	説明
<Category>	-	可	○	コンテナに所属されているカテゴリ一覧の個々のカテゴリを定義します。

注釈

表示名「概要」のカテゴリを必ずカテゴリ一覧の先頭に定義しておいてください。
<Category>羅列の順番はダッシュボード詳細表示画面での左上から右下までタイルの表示順となります。
<Category>の個数に制限はありません。

5.2.1.4.4.3. カテゴリのXMLタグ定義¶

5.2.1.4.4.3.1. 定義の場所¶

カテゴリのXMLタグは下記ダッシュボード詳細情報定義ファイルに定義されています。

/senju/xml/sjDBD_Container_[対象クラウドに関連付けられている千手ノードグループID].xml

5.2.1.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>

5.2.1.4.4.3.3. 属性タグ一覧¶

5.2.1.4.4.3.3.1. <Category>属性タグ一覧¶

表 5.696 <Category>属性タグ一覧¶
属性タグ	デフォルト	省略	変更可否	説明
<DisplayName>	-	不可	○	カテゴリの表示名を定義します。 `&` `<` は使用できません。
<Types>	-	不可	○	タイプ一覧を定義します。

5.2.1.4.4.3.3.2. <DisplayName>属性タグ一覧¶

表 5.697 <DisplayName>属性タグ一覧¶
属性タグ	デフォルト	省略	変更可否	説明
<jp>	-	不可	○	カテゴリの日本語表示名を定義します。
<en>	-	不可	○	カテゴリの英語表示名を定義します。

5.2.1.4.4.3.3.3. <Types>属性タグ一覧¶

表 5.698 <Types>属性タグ一覧¶
属性タグ	デフォルト	省略	変更可否	説明
<Type>	-	可	○	カテゴリに所属されているタイプ一覧の個々のタイプを定義します。

注釈

<Type>羅列の順番はダッシュボード詳細表示画面の各タイルでの左上から右下までタイルの表示順となります。
<Type>の個数に制限はありません。

5.2.1.4.4.4. タイプのXMLタグ定義¶

5.2.1.4.4.4.1. 定義の場所¶

タイプのXMLタグは下記ダッシュボード詳細情報定義ファイルに定義されています。

/senju/xml/sjDBD_Container_[対象クラウドに関連付けられている千手ノードグループID].xml

5.2.1.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>

5.2.1.4.4.4.3. 属性タグ一覧¶

5.2.1.4.4.4.3.1. <Type>属性タグ一覧¶

属性タグ

デフォルト

省略

変更可否

説明

-

不可

○

タイプの表示名を定義します。
& < は使用できません。

<URL>

-

不可

○

タイプのリンク先URLを定義します。

-

可

○

グラフの種類を定義します。
ダッシュボード表示画面 の場合のみ、利用可となります。
ダッシュボード表示画面 の場合のみ、省略不可となります。

利用可能なグラフは以下の10種類となります。

CategoryHBar	カテゴリ横棒グラフ
CategoryVBar	カテゴリ縦棒グラフ
TimeSeriesHBar	時系列横棒グラフ
TimeSeriesVBar	時系列縦棒グラフ
TimeSeriesStackedHBar	時系列積み上げ横棒グラフ
TimeSeriesStackedVBar	時系列積み上げ縦棒グラフ
Area	エリアグラフ
StackedArea	積み上げエリアグラフ
Donut	ドーナツグラフ
Pie	円グラフ

<KPIs>

-

可

○

KPI要素一覧を定義します。
ダッシュボード表示画面 の場合のみ、利用可となります。
ダッシュボード表示画面 の場合のみ、省略不可となります。

<Items>

-

不可

○

タイプの項目一覧を定義します。
「概要」カテゴリ以外の場合、利用可となります。

5.2.1.4.4.4.3.2. <DisplayName>属性タグ一覧¶

表 5.700 <DisplayName>属性タグ一覧¶
属性タグ	デフォルト	省略	変更可否	説明
<jp>	-	不可	○	タイプの日本語表示名を定義します。
<en>	-	不可	○	タイプの英語表示名を定義します。

5.2.1.4.4.4.3.3. <KPIs>属性タグ一覧¶

表 5.701 <KPIs>属性タグ一覧¶
属性タグ	デフォルト	省略	変更可否	説明
<KPI>	-	可	○	「概要」カテゴリに所属されているタイプのKPI一覧の個々の<KPI>を定義します。千手監視項目名によって構成されます。「概要」カテゴリの場合のみ、利用可となります。

注釈

<KPI>羅列の順番は任意となります。
<KPI>の個数に制限はありません。

5.2.1.4.4.4.3.4. <KPI>属性タグ一覧¶

表 5.702 <KPI>属性タグ一覧¶
属性タグ	デフォルト	省略	変更可否	説明
<jp>	-	不可	○	日本語の千手監視項目名を定義します。
<en>	-	不可	○	英語の千手監視項目名を定義します。

注釈

千手監視項目は、履歴データを保存する必要があります。

5.2.1.4.4.4.3.5. <Items>属性タグ一覧¶

表 5.703 <Items>属性タグ一覧¶
属性タグ	デフォルト	省略	変更可否	説明
<Item>	-	可	○	カテゴリに所属されているタイプのアイテムの個々のアイテムを定義します。

注釈

<Item>羅列の順番はダッシュボード詳細表示画面の各タイルの各セルでの左から右まで項目の表示順となります。
<Item>の個数制限は 9個まで となります。

5.2.1.4.4.5. アイテムのXMLタグ定義¶

5.2.1.4.4.5.1. 定義の場所¶

アイテムのXMLタグは下記ダッシュボード詳細情報定義ファイルに定義されています。

/senju/xml/sjDBD_Container_[対象クラウドに関連付けられている千手ノードグループID].xml

5.2.1.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>

5.2.1.4.4.5.3. 属性タグ一覧¶

5.2.1.4.4.5.3.1. <Item>属性タグ一覧¶