30日間の無料評価版をお試しいただけます。

概要

ページトップ
このページは、DashXMLのフレームワークを使用して、ダッシュボードを作成し、表示することができるように支援することを目的としています。各要素で、利用可能な子要素を一覧にまとめました。この一覧は、独自の子の一覧の中でブランド化された子ノードの説明を参照します。

いくつかの要素は、特定の場合に限って使用することができます。これについては、説明で概略していますので参考にしてください。以下の一覧には、各要素の名前、使用可能な値（システムより生成される場合）、説明が表示されています。例：

<customhtml>

子要素値説明

styleClass

 

コンポーネントにスタイリングを適用するために使用する、CSSクラス名を指定します。
html

 

CDATAセクションの中にラップされた、コンポーネントとして使用するHTMLを指定します。例：

< ! [ CDATA [ < div > Your camp started on : < / div >

< div > You're viewing data for : <@ - test @>< / div > ] ] >

replacements

 

必要であれば、カスタムHTMLでパラメーターを配置し、フィルターまたはレポートの値を置き換えることができます。例えば、上記の例では、<@- test @>パラメーター（<replacements>の<replaceName>ノードでtestとして定義された）を呼び出します。testパラメーターは、<replacements>の<replacements>ノードで指定された値に置き換わります。<replacements> ノードの説明を参照してください。

上記は、<customhtml> ノードコンテンツの説明です。<replacements> ノードの参照内の置き換えに気が付くでしょう。それはつまり、XMLファイルが、以下のようになることを意味しています。

<customhtml>
    <styleClass>dashboardDates</styleClass>
        <html><![CDATA[<div>Your camp started on:</div>
        <div>You're viewing data for: <@- test @></div>]]></html>
        <replacements>
            <replaceName>test</replaceName>
            <filterName>datefilter</filterName>
        </replacements>
</customhtml>

 

要素

ページトップ

<application-definition>

子要素値説明
dashboard ダッシュボードコンテンツを説明する情報を含みます。<dashboard> ノードの説明を参照してください。


<sourcefilter>

子要素値説明

code

 Yellowfin内で定義されるソースフィルターコードです。

parameter

 

適用されたすべてのレポートに、ソースフィルターの値を渡すために、ダッシュボードURL内で使用するパラメーターです。例えば、パラメーターが「ISO」で、ソースフィルター値が「AU」の場合、URLは以下のようになります。

http://localhost:7171/DashXML/dashboard.jsp?id=1&ISO=AU


<dashboard>

子要素値説明
id 

XML内でタブを特定するために使用するユニークな番号です。タブを特定するために、URL内でも使用します。例えば、idが1の場合、URLは以下のようになります。

http://localhost:7171/DashboardPortal/dashboard.jsp?id=1

name

 XML内で参照するタブの名前です。値はユニークでなければなりません。

styleClass

 コンポーネントにスタイリングを適用するために使用する、CSSクラス名を指定します。

text

 タブ上に表示されるテキストを含んでおり、このテキストは、レポートから取得されるのではなく、XMLを通して定義されます。<text>ノードの説明の参照を指定します。

filter

 タブ上に使用されるフィルターの詳細を指定します。<filter>ノードの説明を参照してください。

report

 タブ上に表示される単一レポート周りの情報を指定します。<report> ノードの説明を参照してください。

modal

 ユーザーがクリックをすることで、モーダル内のレポートを参照することができる、リンク作成周りの情報が含まれています。<modal> ノードの説明を参照してください。

customhtml

 ヘルプのようなカスタムコンポーネントを作成するために、ダッシュボードにカスタムHTMLを挿入することができます。<customhtml> ノードの説明を参照してください。

subtab

 主要タブとのレイアウトの間に表示され、切り替えられるサブタブの詳細を指定します。<subtab> ノードの説明を参照してください。
<subtab>
子要素値説明

styleClass

 コンポーネントにスタイリングを適用するために使用する、CSSクラス名を指定します。

name

 XML内で参照するサブタブの名前です。

selectType

 サブタブをドロップダウンリストから選択したい場合は、この設定値をSELECTにします。必要ない場合は、省略してください。

options

 サブタブ内のコンテンツの表示とレポートを定義するノードを指定します。<options> ノードの説明を参照してください。
<options>

サブタブ内で使用します。

子要素値説明

styleClass

 コンポーネントにスタイリングを適用するために使用する、CSSクラス名を指定します。

title

 サブタブセレクターのためのテキストラベルです。（レポートのサブタブセット間を切り替える方法です）

description

 これはオプションです。サブタブセレクター内でサブタブタイトルの下部に表示される説明テキストです。

icon

 

これはオプションです。サブタブオプションエリア内で表示されるイメージの参照先を指定します。これは、イメージのソースです。例：

images/myimagename.png

iconURL

 

これはオプションです。アイコンを表示するためのHTMLを指定します。例：

<![CDATA[<div class="filterIconCamp"></div>]]>

defaultOption

TRUE

FALSE

サブタブノード内でどちらのオプションがデフォルト選択になるのかを指定します。1つの<option> ノードのみtrueに設定し、残りはfalseにするか、このノードを省略します。

summary

 フィルターボタン上に表示する集計値を、レポートから取得する方法を指定します。<summary>ノードの説明を参照してください。

hiddenOption

TRUE

FALSE

trueに設定した場合、サブタブの選択が解除されたときに、このオプションが適用されます。
<summary>

<filter><options> か <subtab><options>内で使用します。

子要素値説明

title

 これはオプションです。フィルターまたはサブタブのサマリーに表示されるラベルです。適用される値を説明するテキスト名です。

description

 これはオプションです。フィルターのタイトルか、サブタブオプションサマリーの下部に表示される説明テキストです。

reportId

 XML内のレポートがどこに含まれているのかを指定する場合はレポート名を使用し、集計値を取得し、表示する場合はレポートUUIDを使用します。

matchColumn

 表形式のレポートの列の配置番号です。行を特定するために値を一致させる必要があります。最初のカラム（列）は0、次は1と続きます。

matchValue

 行を特定するために<matchColumn>カラムで検索する値を指定します。

valueColumn

 <matchColumn> と<matchValue> ノードを使用して配置されている行から、データを取得したい列を指定します。この値は<matchColumn> ノードのように、0から始まります。
<text>
子要素値説明

styleClass

 コンポーネントにスタイリングを適用するために使用する、CSSクラス名を指定します。

text

 タイトル、説明、または他の用途として、ダッシュボード上に表示されるテキストを指定します。
<exportlist>
子要素値説明

styleClass

 コンポーネントにスタイリングを適用するために使用する、CSSクラス名を指定します。

export

 ダッシュボード上に表示したいエクスポート機能を指定します。<export>ノードの説明を参照してください。
<export>
子要素値説明

styleClass

 コンポーネントにスタイリングを適用するために使用する、CSSクラス名を指定します。

exporttype

PDF

XLS

PRINT

ダッシュボード上に表示したいエクスポート機能を指定します。

  • PDF: 現在のダッシュボードが、PDF形式でエクスポートされます。
  • XLS: 特定のレポートが、XLS形式でエクスポートされます。
  • PRINT: ダッシュボード全体を印刷するために、ブラウザ印刷機能が呼び出されます。

reportuuid

 exporttypeがXLSに設定された時のみ使用することができます。エクスポートされるレポートを定義します。
<filter>
子要素値説明

styleClass

 コンポーネントにスタイリングを適用するために使用する、CSSクラス名を指定します。

name

 値を受け取るレポート上で使用される<filterMap> ノードが、特定する際に使用するフィルターの名前を指定します。

sync

TRUE

FALSE

こちらの設定をTRUEにすると、ダッシュボードタブを通して、フィルター値を同期することができます。

datatype

NUMERIC

TEXT

DATE

TIMESTAMP

フィルターのデータ型を指定します。

operator

EQUAL

BETWEEN

INLIST

フィルターに渡すことができる値の数について説明します。Yellowfin内のレポートで選択された演算子とは直接的に関連しません。

  • EQUALに渡すことができる値は、1つの値のみです。このオプションは、「等しい」「以上」「以下」などにも使用ます。
  • BETWEENに渡すことができる値は、2つの値です。このオプションは、「の間」「の間でない」で使用します。
  • INLISTには、複数の値を渡すことができます。このオプションは、「一覧に含む」「一覧に含まない」で使用します。

disableDeselect

 

TRUE

FALSE

TRUEに設定すると、ユーザーはすでに選択されたフィルター値をクリックしても選択を解除することができません。これはつまり、常に1つの値が選択された状態になることを意味しています。
options コンテンツの表示と、考え得る値を定義するためのノードを指定します。<options> ノードの説明を参照してください。 
<options>

フィルター内で使用します。

子要素値説明
styleClass コンポーネントにスタイリングを適用するために使用する、CSS名を指定します。

title

 フィルター上に表示されるラベルです。適用される値を説明するテキスト名です。

description

 これはオプションです。フィルターオプションのタイトルの下部に表示される説明テキストです。

icon

 

これはオプションです。こちらには、フィルターエリアに表示されるイメージのための、参照先を含むことができます。これはイメージのソースです。例：

images/myimagename.png

iconURL

 

これはオプションです。アイコンを表示するHTMLを含みます。例：

< ! [ CDATA [ < div class = "filterIconGoogle" > < / div > ] ] >

typecode

PREDEF

定義された期間のように、事前に定義されたフィルターを使用するオプションを定義します。それから、<value> ノード内で、どの定義を使用するのかを指定する必要があります。

value

<value>

YEARTODATE

MONTHTODATE

ROLLINGYEAR

ROLLINGMONTH

PREVIOUSYEAR

PREVIOUSMONTH

これはオプションです。事前に定義されている場合、フィルターの値を含みます。複数の値が定義されている場合は、「/（スラッシュ）」や「|（パイプ）」を使用して、値を区別します。

例： 2014-08-07\|2014-08-22

<prompt> ノードがTRUEに設定される場合、このオプションは省略されます。

<typecode> ノードがTRUEに設定される場合、このオプションは以下の一つを含む必要があります。

  • YEARTODATEは現在の年の最初の日から、現在の日付です。
  • MONTHTODATEは現在の月の最初の日から、現在の日付です。
  • ROLLINGYEARは現在の日付の1年前から、現在の日付です。
  • ROLLINGMONTHは現在の日付の1か月前から、現在の日付です。
  • PREVIOUSYEARは、前年丸1年（暦年）です。
  • PREVIOUSMONTHは、前月丸1ヶ月（暦月）です。
defaultOption

TRUE

FALSE

フィルターノード内のどちらのオプションがデフォルト選択かを指定します。1つの<option>ノードのみtrueに設定することができ、残りはfalseにするか、このノードを省略します。
prompt

TRUE

FALSE

ユーザーに値やプロンプトを提供するかどうかを指定します。TRUEに設定した場合、ユーザーには値を入力するように促されるため、<value> ノードは省略されなくてはいけません。値の入力方法は、<filter><datatype>の値によって、日付選択カレンダー、テキストフィールド、数値フィールドが表示されます。
summary フィルターボタン上に集計値として表示するための、レポートからの値の取得方法を指定します。
<summary>

<filter><options> か <subtab><options>内で使用します。

子要素値説明

title

 これはオプションです。フィルター上かサブタブサマリー上に表示されるラベルです。適用される値を説明するテキスト名です。

description

 これはオプションです。フィルターのタイトルまたは、サブタブオプションサマリーの下部に表示される説明テキストです。

reportId

 XML内のレポートがどこに含まれているのかを指定する場合はレポート名を使用し、集計値を取得し、表示する場合はレポートUUIDを使用します。

matchColumn

 表形式のレポートの列の配置番号です。行を特定するために値を一致させる必要があります。最初のカラム（列）は0、次は1と続きます。

matchValue

 行を特定するために<matchColumn>カラムで検索する値を指定します。

valueColumn

 <matchColumn> と<matchValue> ノードを使用して配置されている行から、データを取得したい列を指定します。この値は<matchColumn> ノードのように、0から始まります。
<customhtml>
子要素値説明

styleClass

 コンポーネントにスタイリングを適用するために使用する、CSSクラス名を指定します。
html 

CDATAセクションの中にラップされた、コンポーネントとして使用するHTMLを指定します。例：

< ! [ CDATA [ < div > Your camp started on : < / div >

< div > You're viewing data for : < @ - test @ > < / div > ] ] >

replacements

 必要であれば、カスタムHTMLでパラメーターを配置し、フィルターまたはレポートの値を置き換えることができます。例えば、上記の例では、<@- test @>パラメーター（<replacements>の<replaceName>ノードでtestとして定義された）を呼び出します。testパラメーターは、<replacements>の<replacements>ノードで指定された値に置き換わります。<replacements> ノードの説明を参照してください。
<replacements>
子要素値説明
replaceName <customhtml> ノード内でパラメーターに与えられる名前です。このパラメーターは、<filtername>内で指定するフィルターのフィルター値と置き換えられます。

replaceValue

 置き換える値を設定したい場合は、ここで設定することができます。

reportName

 置き換える値を返すためにレポートを使用したい場合は、レポートuuidか名前を定義してください（XML内の他の場所に設定してください）

matchColumn

 表形式のレポートの列の配置番号です。行を特定するために値を一致させる必要があります。最初のカラム（列）は0、次は1と続きます。

matchValue

 行を特定するために<matchColumn>カラムで検索する値を指定します。

valueColumn

 <matchColumn> と<matchValue> ノードを使用して配置されている行から、データを取得したい列を指定します。この値は<matchColumn> ノードのように、0から始まります。

filterName

 フィルター値を置き換える値として使用する場合は、フィルターuuidと名前を定義してください。（XML内に設定してください）

type

DATE 

値が日付であり、カスタム書式を適用したい場合は、タイプをDATEに設定してください。
formatYYYY/MM/DD 等<type> ノードをDATEにした場合、値にカスタム書式を定義することができます。例：YYYY/MM/DD
<report>
子要素値説明

styleClass

 コンポーネントにスタイリングを適用するために使用する、CSSクラス名を指定します。
uuid ダッシュボード上で呼び出し、表示するための、レポートのYellowfin UUIDを指定します。

name

 XML内の他のノードに参照される、レポートの名前を指定します。

title

 ダッシュボード上に表示される、レポートのタイトルです。

description

 必要であれば、ダッシュボード上に表示することのできるレポートの説明です。

display

TABLE

HIDDEN

CHART

MAP

YFTABLE

レポートの表示方法です。

  • TABLEは、Yellowfinのデフォルトスタイリングではなく、カスタムCSSスタイリングを使用して、レポート結果を表形式で表示します。
  • HIDDENは、レポート結果を、表形式で表示するのではなく、ページの他のコンポーネント内で使用するために使用します。
  • CHARTは、レポート内で作成されたグラフやマルチグラフキャンバスを表示します。
  • MAPは、マップナビゲーションを、静的グラフのように表示するのではなく、マップ上に表示することができます。
  • YFTABLEは、Yellowfinの標準的なスタイルを使用して、レポート結果を表形式で表示します。
width 幅にCSSの定義を適用したくない場合に指定します。ダッシュボード上のレポートに割り当てる幅をピクセル単位で定義します。
height 高さにCSSの定義を適用したくない場合に指定します。ダッシュボード上のレポートに割り当てる高さをピクセル単位で定義します。
resultsPerPage 各ページに表示する行数を定義します。レポートがこの設定数を超過する場合は、<hidePagination>ノードが使用不可になっていない限り、ページ数が表示されます。
visibleSelectors ページセレクターをいくつ表示するのか定義します。
hidePagination ロウ（行）ページ数表示ボタンを表示することができます。
columnsPerPage 一度に表示される列数です。
nullConversion セルをブランクにしないために、レポート内のすべてのNULLの代わりに表示される文字、文字列、または値を指定します。

modalName

 ポップアップディスプレイ内にコンテンツを表示するために、XML内の他の場所に定義されたモーダルウィジェットを呼び出します。
modalLinkText モーダルウィンドウを開くためのリンクに表示するテキストです。 

filterMap

 受け取るフィルター値の情報を指定します。<filterMap> ノードの説明を参照してください。
replaceRow クロス集計レポートを、広げたり、畳んだりする機能とともに使用する場合、それを制御するために使用するロウ（行）フィールドです、フィールド名を特定してください。
dimensionReplace クロス集計レポートを、広げたり、畳んだりする機能とともに使用する場合、表を畳む際に、合計行として使用される<replaceRow>グループのロウ（行）です。セル値を特定してください。
<filterMap>
子要素値説明
filterUUID 選択された値をフィルターに適用するための、レポートフィルターのYellowfin UUIDを指定します。

mapToFilter

 モーダルウィンドウ内に表示されるレポートです。<report> ノードの説明を参照してください。
<modal>
子要素値説明

title

 モーダルウィンドウの上部に表示されるタイトルです。

linkText

 モーダルウィンドウを開くリンクの一部として表示されるテキストです。レポートからモーダルウィンドウを呼び出す場合は、こちらのオプションは省略してください。

name

 XML内の他のウィジェットにより呼び出される、モーダルウィンドウの名前です。

subcontent

 モーダルウィンドウのコンテンツを定義します。<subcontent>ノードの説明を参照してください。
<subcontent>
子要素値説明

name

 XML内の他の場所からサブコンテンツを呼び出すための名前です。一般的にモーダルウィンドウは、レポートの一部として呼び出されます。<report> ノードの説明を参照してください。

report

 モーダルウィンドウに表示されるレポートです。<report> ノードの説明を参照してください。こちらは大抵非表示レポートになります。


ページトップ

  • No labels