WaveXmd | メタデータ API 開発者ガイド

ファイルのサフィックスおよびディレクトリの場所

WaveXmd components コンポーネントのサフィックスは .xmd で、wave フォルダに保存されます。

バージョン

WaveXmd コンポーネントは、API バージョン 39.0 以降で使用できます。

項目

項目名	項目の型	説明
application	string	XMD が関連付けられた Analytics アプリケーションの名前。API バージョン 43.0 以降で利用できます。
dataset	string	必須。この XMD に関連付けられたデータセットを指定します。
datasetConnector	string	データセットのコネクタ取得元の名前。
datasetFullyQualifiedName	string	この XMD に関連付けられたデータセットバージョンの完全修飾名を指定します。
dates	WaveXmdDate	書式情報付きの日付リスト。
dimensions	WaveXmdDimension	書式情報付きのディメンションリスト。
measures	WaveXmdMeasure	書式情報付きの基準リスト。
organizations	WaveXmdOrganization	複数組織をサポートするための組織のリスト。
origin	string	データセットバージョンの発生源。
type	string	XMD の種別。有効な値は、次のとおりです。 `System` `User` `Main` `Asset` API バージョン 43.0 以降で利用できます。
waveVisualization	string	Analytics アセットの可視化動作。有効な値は、次のとおりです。 `dashboard` `lens` API バージョン 43.0 以降で利用できます。

WaveXmdDate

WaveXmdDate は日付を表します。

項目	項目の型	説明
alias	string	必須。日付列の別名。
compact	boolean	日付がコンパクト形式で表示されるか (`true`)、否か (`false`) を示します。
dateFieldDay	string	日項目。
dateFieldEpochDay	string	エポック日項目。
dateFieldEpochSecond	string	エポック秒項目。
dateFieldFiscalMonth	string	会計月項目。
dateFieldFiscalQuarter	string	会計四半期項目。
dateFieldFiscalWeek	string	会計週項目。
dateFieldFiscalYear	string	会計年度項目。
dateFieldFullYear	string	通年項目。
dateFieldHour	string	時間項目。
dateFieldMinute	string	分項目。
dateFieldMonth	string	月項目。
dateFieldQuarter	string	四半期項目。
dateFieldSecond	string	秒項目。
dateFieldWeek	string	週項目。
dateFieldYear	string	年項目。
description	string	日付列の説明。
firstDayOfWeek	int	必須。週の開始曜日を表します。
fiscalMonthOffset	int	必須。カレンダー年に対する会計年度のオフセット (月数)。
isYearEndFiscalYear	boolean	1 年の終わりが会計年度であるか (`true`)、否か (`false`) を示します。
label	string	日付列の表示ラベル。
showInExplorer	boolean	日付がエクスプローラに表示されるか (`true`)、否か (`false`) を示します。
sortIndex	int	必須。リスト内の項目の位置を示す、システムによって割り当てられるインデックス値。
type	string	必須。日付の種別。有効な値は、次のとおりです。 `Date` — 従来の日付種別。タイムゾーンが有効になっていない場合に使用できます。 `DateOnly` — 時間が関連付けられていない日付種別。タイムゾーンが有効になっている場合に使用できます。 `DateTime` — 日付と時間の両方の部分が含まれる日付種別。タイムゾーンが有効になっている場合に使用できます。

WaveXmdDimension

WaveXmdDimension はディメンションを表します。

項目	項目の型	説明
conditionalFormatting	WaveXmdFormattingProperty	ディメンションの件付き書式プロパティ。API バージョン 43.0 以降で利用できます。
customActions	WaveXmdDimensionCustomAction	このディメンションにリンクされているカスタムアクション。
customActionsEnabled	boolean	ディメンションでカスタムアクションが有効になっているか (`true`)、否か (`false`) を示します。
dateFormat	string	ディメンションである日付に使用される書式。
defaultAction	string	ディメンションに割り当てられたデフォルトアクション。ディメンションのアクションには、openSfdcRecord、openActionsMenu、none、またはドット記法による有効な API 名 (Global.LogACall や FeedItem.Post など) を指定できます。
description	string	ディメンションの説明。
field	string	必須。ディメンションの項目名 (クエリで使用)。
fullyQualifiedName	string	ディメンションの完全修飾名。
imageTemplate	string	画像テンプレート。
isDerived	boolean	必須。ディメンションが派生されたか (`true`)、否か (`false`) を示します。
isMultiValue	boolean	ディメンションが複数値であるか (`true`)、否か (`false`) を示します。
label	string	ディメンションの表示ラベル。
linkTemplate	string	リンクの書式設定用テンプレート。
linkTemplateEnabled	boolean	ディメンションでリンクテンプレートが有効になっているか (`true`)、否か (`false`) を示します。
linkTooltip	string	リンクに表示されるツールチップ。
members	WaveXmdDimensionMember	ディメンションのメンバーの上書き。
origin	string	このディメンションの発生源。
recordDisplayFields	WaveXmdRecordDisplayLookup	ディメンションの順序付きリスト。このリストは、ユーザインターフェースでディメンションが表示されるデフォルトの順序を定義します。
recordIdField	string	このディメンションのレコード ID。
recordOrganizationIdField	string	このディメンションのレコード組織 ID。
salesforceActions	WaveXmdDimensionSalesforceAction	このディメンションにリンクされている Salesforce アクション。
salesforceActionsEnabled	boolean	ディメンションで Salesforce アクションが有効になっているか (`true`)、否か (`false`) を示します。
showDetailsDefaultFieldIndex	int	ユーザインターフェースでディメンションが表示されるデフォルトの順序。
showInExplorer	boolean	ディメンションがエクスプローラに表示されるか (`true`)、否か (`false`) を示します。
sortIndex	int	必須。リスト内の項目の位置を示す、システムによって割り当てられるインデックス値。

WaveXmdFormattingProperty

WaveXmdFormattingProperty は、条件付き書式の XMD 書式プロパティを表します。

項目	項目の型	説明
formattingBins	WaveXmdFormattingBin	このプロパティの書式ビン。
formattingPredicates	WaveXmdFormattingPredicate	このプロパティの書式述語。
property	string	必須。プロパティ名。
referenceField	string	必須。このプロパティの書式項目。
sortIndex	int	必須。リスト内の項目の位置を示す、システムによって割り当てられるインデックス値。
type	string	必須。プロパティ種別。

WaveXmdFormattingBin

WaveXmdFormatttingBin は、条件付き書式の XMD 書式ビンを表します。

項目	項目の型	説明
bin	string	必須。書式ビン。
formatValue	string	必須。ビンの書式値。
label	string	必須。ビンの表示ラベル。
sortIndex	int	必須。リスト内の項目の位置を示す、システムによって割り当てられるインデックス値。

WaveXmdFormattingPredicate

WaveXmdFormattingPredicate は、条件付き書式の XMD 書式述語を表します。

項目	項目の型	説明
formatValue	string	必須。述語の書式値。
operator	string	必須。述語の演算子。
sortIndex	int	必須。リスト内の項目の位置を示す、システムによって割り当てられるインデックス値。
value	string	必須。述語の値。

WaveXmdDimensionCustomAction

WaveXmdDimensionCustomAction はディメンションのカスタムアクションを表します。

項目	項目の型	説明
customActionName	string	必須。このカスタムアクションの名前。
enabled	boolean	必須。特定のディメンションでアクションが有効になっているか (`true`)、否か (`false`) を示します。
icon	string	アクションのアイコン。
method	string	アクションのメソッド。
sortIndex	int	必須。リスト内の項目の位置を示す、システムによって割り当てられるインデックス値。
target	string	アクションの対象。
tooltip	string	アクションのツールチップ。
url	string	アクションの URL。

WaveXmdDimensionMember

WaveXmdDimensionMember はディメンションを表します。

項目	項目の型	説明
color	string	メンバーの色。
label	string	メンバーの表示ラベル。
member	string	必須。メンバー値。
sortIndex	int	必須。リスト内の項目の位置を示す、システムによって割り当てられるインデックス値。

WaveXmdRecordDisplayLookup

WaveXmdDimensionRecordDisplayLookup はレコード表示項目を表します。

項目	項目の型	説明
recordDisplayField	string	必須。表示する項目。
sortIndex	int	必須。リスト内の項目の位置を示す、システムによって割り当てられるインデックス値。

WaveXmdDimensionSalesforceAction

WaveXmdDimensionSalesforceAction はディメンションのアクションを表します。

項目	項目の型	説明
enabled	boolean	必須。特定のディメンションでアクションが有効になっているか (`true`)、否か (`false`) を示します。
salesforceActionName	string	必須。アクションの名前。
sortIndex	int	必須。リスト内の項目の位置を示す、システムによって割り当てられるインデックス値。

WaveXmdMeasure

WaveXmdMeasure は基準を表します。

項目	項目の型	説明
conditionalFormatting	WaveXmdFormattingProperty	基準の条件付き書式。API バージョン 43.0 以降で利用できます。
currencies	WaveXmdMeasure[]	マルチ通貨の通貨形式のリスト。この項目は、データセットで使用される各通貨の書式を設定する場合に使用します。
currencyCode	String	データセットのデフォルトの通貨コード。
dateFormat	string	基準である日付に使用される書式。
description	string	基準の説明。
field	string	必須。基準の項目名 (クエリで使用)。
formatCustomFormat	string	1 つの String 型としての元の形式 (XMD 1.1) の配列。
formatDecimalDigits	int	小数点の後に表示される桁数。
formatDecimalSeparator	string	小数点の位置のカスタム区切り文字。API バージョン 48.0 以降で利用できます。
formatIsNegativeParens	boolean	負の数値をマイナス記号ではなく括弧を使用して表示するか (`true`)、否か (`false`) を示します。
formatPrefix	string	項目値の前に置かれるプレフィックス。
formatSuffix	string	項目値の後に置かれるサフィックス。
formatThousandsSeparator	string	千の位のカスタム区切り文字。API バージョン 48.0 以降で利用できます。
formatUnit	string	基準の単位文字列。例: `cm`。
formatUnitMultiplier	double	単位乗数。
fullyQualifiedName	string	基準の完全修飾名。
isDerived	boolean	必須。基準が派生されたか (`true`)、否か (`false`) を示します。
isMultiCurrency	boolean	このデータセットで、マルチ通貨を使用できるか (`true`)、否か (`false`) を示します。
label	string	基準の表示ラベル。
origin	string	基準の発生源。
showDetailsDefaultFieldIndex	int	ユーザインターフェースで基準が表示されるデフォルトの順序。
showInExplorer	boolean	基準がエクスプローラに表示されるか (`true`)、否か (`false`) を示します。
sortIndex	int	必須。リスト内の項目の位置を示す、システムによって割り当てられるインデックス値。

WaveXmdOrganization

WaveXmdOrganization は Salesforce 組織を表します。

項目	項目の型	説明
instanceUrl	string	必須。組織のインスタンス URL。
label	string	必須。組織の表示ラベル。
organizationIdentifier	string	必須。組織の ID。
sortIndex	int	必須。リスト内の項目の位置を示す、システムによって割り当てられるインデックス値。

宣言的なメタデータの定義のサンプル

次に、ダッシュボードに属するアセット XMD の WaveXmd コンポーネントの例を示します。

1<WaveXmd>
2    <dataset xsi:nil="true"/>
3    <dimesions>
4        <conditionalFormatting>
5            <formattingBins>
6                <bin>*</bin>
7                <formatValue>#FFFFFF</formatValue>
8                <label xsi:nil="true"/>
9                <sortIndex>0</sortIndex>
10            </formattingBins>
11            <formattingBins>
12                <bin>0</bin>
13                <formatValue>#000000</formatValue>
14                <label xsi:nil="true"/>
15                <sortIndex>1</sortIndex>
16            </formattingBins>
17            <property>chartColor</property>
18            <referenceField>count</referenceField>
19            <sortIndex xsi:nil="true"/>
20            <type>multiple</type>
21        </conditionalFormatting>
22        <field>all_1.ALL</field>
23        <isDerived>false</isDerived>
24        <sortIndex>0</sortIndex>
25    </dimensions>
26    <measures>
27        <conditionalFormatting>
28            <formattingBins>
29                <bin>*</bin>
30                <formatValue>#FFFFFF</formatValue>
31                <label xsi:nil="true"/>
32                <sortIndex>0</sortIndex>
33            </formattingBins>
34            <formattingBins>
35                <bin>0</bin>
36                <formatValue>#000000</formatValue>
37                <label xsi:nil="true"/>
38                <sortIndex>1</sortIndex>
39            </formattingBins>
40            <property>chartColor</property>
41            <referenceField>count</referenceField>
42            <sortIndex xsi:nil="true"/>
43            <type>multiple</type>
44        </conditionalFormatting>
45        <field>all_1.count</field>
46        <formatCustomFormat>[&quot;#,###.##%&quot;,1]</formatCustomFormat>
47        <isDerived>false</isDerived>
48        <sortIndex>0</sortIndex>
49    </measures>
50    <type>Asset</type>
51    <waveVisualization>dashboard</waveVisualization>
52</WaveXmd>