Metadata コンポーネント | Consumer Goods Cloud 開発者ガイド

Text

表 1. コンポーネントのプロパティ
プロパティ	型	式をサポートするか?	デフォルト値	必須かどうか	説明
id	String	いいえ		はい	コンポーネントのインスタンスの一意の識別子。大文字と小文字が区別されます。この ID は、ウィザードのメタデータ設定のすべてのコンポーネント間で一意でなければなりません。
type	String	いいえ		はい	値は Text です。
visible	Boolean	はい	true	いいえ	コンポーネントを表示するかどうかを指定します。コンポーネントが表示されない場合でも、入力規則が実行され、値がウィザードの結果に設定されます。
editable	Boolean	はい	true	いいえ	コンポーネントの値を編集可能にするかどうかを指定します。
active	Boolean	はい	true	いいえ	コンポーネントの値をウィザードの結果の一部として設定するかどうかを指定します。
label	String	はい	<空>	いいえ	項目の表示ラベルを表示します。
required	Boolean	いいえ	false	いいえ	項目を必須にするかどうかを指定します。項目が必須であるのに値を入力していない場合、ユーザーはウィザードを送信できません。
outputProperty	String	いいえ	<空>	いいえ	入力値が設定される結果のプロパティ。
defaultValue	String	はい	<空>	いいえ	コンポーネントのデフォルト値。
maxLength	Number	はい	Infinity	いいえ	入力の最大長。この長さを超えると、入力は有効とみなされず、ウィザードを送信できません。
minLength	Number	はい	-Infinity	いいえ	入力の最小長。入力の長さが最小長より短いと、入力は無効となり、ウィザードを送信できません。
placeholder	String	はい	<空>	いいえ	値が未設定である場合の入力項目のプレースホルダー。

例

式の値: 式で参照されると、このコンポーネントは入力の現在のテキスト値を返します。

結果の値: 結果の生成時、このコンポーネントは、結果オブジェクトの outputProperty 属性で定義されたプロパティにテキスト入力の値を設定します。outputProperty が設定されていない場合、または有効なプロパティが false に解決された場合、出力オブジェクトにデータは設定されません。

Number

このコンポーネントは数値項目を表示します。

表 2. コンポーネント
プロパティ	型	式をサポートするか?	デフォルト値	必須	説明
id	String	いいえ		はい	コンポーネントのインスタンスの一意の識別子。大文字と小文字が区別されます。この ID は、ウィザードのメタデータ設定のすべてのコンポーネント間で一意でなければなりません。
defaultValue	String	はい	<空>	いいえ	コンポーネントのデフォルト値。
visible	Boolean	はい	true	いいえ	コンポーネントを表示するかどうかを指定します。コンポーネントが表示されない場合でも、入力規則が実行され、値がウィザードの結果に設定されます。
required	Boolean	いいえ	false	いいえ	項目を必須にするかどうかを指定します。項目が必須であるのに値を入力していない場合、ユーザーはウィザードを送信できません。
editable	Boolean	はい	true	いいえ	コンポーネントの値を編集可能にするかどうかを指定します。
active	Boolean	はい	true	いいえ	コンポーネントの値をウィザードの結果の一部として設定するかどうかを指定します。
label	String	はい	<空>	いいえ	項目の表示ラベルを表示します。
autoAdjust	Boolean	いいえ	false	いいえ	有効にすると、ユーザーが入力値を設定した後、その値を有効にするために、`max` と `min` のプロパティで定義された境界に合わせて入力値が調整されます。無効にすると、不適切な入力は、無効な入力としてユーザーに通知されます。
decimalPlaces	Number	はい	Infinity	いいえ	値の小数点以下の最大桁数。この桁数を超える桁は切り捨てられます。
max	Number	はい	Infinity	いいえ	入力の最大値。入力値が最大値を超えると、入力は有効とみなされず、ウィザードを送信できません。
min	Number	はい	-Infinity	いいえ	入力の最小値。入力値が最小値を下回ると、入力は有効とみなされず、ウィザードを送信できません。
placeholder	String	はい	<空>	いいえ	値が未設定である場合の入力項目のプレースホルダー。
outputProperty	String	いいえ	<空>	いいえ	入力値が設定される結果のプロパティ。
type	String	いいえ		はい	値は Number です。

例

式の値: 式で参照されると、このコンポーネントは入力の現在の数値を返します。

結果の値: 結果の生成時、このコンポーネントは、結果オブジェクトの outputProperty 属性で定義されたプロパティに数値入力の値を設定します。outputProperty が設定されていない場合、または有効なプロパティが false に解決された場合、出力オブジェクトにデータは設定されません。

Label

このコンポーネントは、編集できないテキストを表示します。

プロパティ

プロパティ	型	式をサポートするか?	デフォルト値	必須	説明
id	String	いいえ		はい	コンポーネントのインスタンスの一意の識別子。大文字と小文字が区別されます。この ID は、ウィザードのメタデータ設定のすべてのコンポーネント間で一意でなければなりません。
type	String	いいえ		はい	値は Label です。
visible	Boolean	はい	true	いいえ	コンポーネントを表示するかどうかを指定します。コンポーネントが表示されない場合でも、入力規則が実行され、値がウィザードの結果に設定されます。
color	String	いいえ	black	いいえ	テキストの色。
message	String	はい	<空>	いいえ	表示ラベルに表示するメッセージ。

例

式の値: 式で参照されると、このコンポーネントは空の値を返します。

結果の値: このコンポーネントは結果の構造体に値を転送しません。

Empty

このコンポーネントは入力を表示しません。他に入力があれば占有されているスペースを占有します。

表 3. プロパティ
プロパティ	型	式をサポートするか?	デフォルト値	必須かどうか	説明
id	String	いいえ		はい	コンポーネントのインスタンスの一意の識別子。大文字と小文字が区別されます。この ID は、ウィザードのメタデータ設定のすべてのコンポーネント間で一意でなければなりません。
type	String	いいえ		はい	値は Empty です。
visible	Boolean	はい	true	いいえ	コンポーネントを表示するかどうかを指定します。コンポーネントが表示されない場合でも、入力規則が実行され、値がウィザードの結果に設定されます。

例

式の値: 式で参照されると、このコンポーネントは空の値を返します。

結果の値: このコンポーネントは結果の構造体に値を転送しません。

Date

このコンポーネントは Date Picker 項目を表示します。Date Picker の日付値は、ユーザーのロケールに応じて表示されます。

表 4. プロパティ
プロパティ	型	式をサポートするか?	デフォルト値	必須かどうか	説明
id	String	いいえ		はい	コンポーネントのインスタンスの一意の識別子。大文字と小文字が区別されます。この ID は、ウィザードのメタデータ設定のすべてのコンポーネント間で一意でなければなりません。
type	String	いいえ		はい	値は Date です。
visible	Boolean	はい	true	いいえ	コンポーネントを表示するかどうかを指定し��す。コンポーネントが表示されない場合でも、入力規則が実行され、値がウィザードの結果に設定されます。
editable	Boolean	はい	true	いいえ	コンポーネントの値を編集可能にするかどうかを指定します。
active	Boolean	はい	true	いいえ	コンポーネントの値をウィザードの結果の一部として設定するかどうかを指定します。
label	String	はい	<空>	いいえ	項目の表示ラベルを表示します。
required	Boolean	いいえ	false	いいえ	項目を必須にするかどうかを指定します。項目が必須であるのに値を入力していない場合、ユーザーはウィザードを送信できません。
outputProperty	String	いいえ	<空>	いいえ	入力値が設定される結果のプロパティ。
defaultValue	String	はい	<空>	いいえ	コンポーネントのデフォルト値。日付の値は、YYYY-MM-DD 形式の文字列として指定する必要があります。

例

式の値: 式で参照されると、このコンポーネントは、コントロールの現在の日付を YYYY-MM-DD 形式の文字列として返します。

結果の値: 結果の生成時、このコンポーネントは、結果オブジェクトの outputProperty 属性で定義されたプロパティに日付入力の値を設定します。outputProperty が設定されていない場合、または有効なプロパティが false に解決された場合、出力オブジェクトにデータは設定されません。結果データは、YYYY-MM-DD 形式の文字列として設定されます。

Duration

このコンポーネントは、数値項目と選択リスト項目の 2 つの入力がある。コントロールを表示します。数値項目には数値を入力できます。選択リスト項目では、日、週、月を選択できます。このコントロールは、別の参照日を基準にして、その参照日に週数または月数を追加して 2 番目の日付を計算するために使用されます。

プロパティ	型	式をサポートするか?	デフォルト値	必須	説明
id	String	いいえ		はい	コンポーネントのインスタンスの一意の識別子。大文字と小文字が区別されます。この ID は、ウィザードのメタデータ設定のすべてのコンポーネント間で一意でなければなりません。

type	String	いいえ		はい	値は Duration です。
visible	Boolean	はい	true	いいえ	コンポーネントを表示するかどうかを指定します。コンポーネントが表示されない場合でも、入力規則が実行され、値がウィザードの結果に設定されます。
editable	Boolean	はい	true	いいえ	コンポーネントの値を編集可能にするかどうかを指定します。
active	Boolean	はい	true	いいえ	コンポーネントの値をウィザードの結果の一部として設定するかどうかを指定します。
label	String	はい	<空>	いいえ	項目の表示ラベルを表示します。
required	Boolean	いいえ	false	いいえ	項目を必須にするかどうかを指定します。項目が必須であるのに値を入力していない場合、ユーザーはウィザードを送信できません。
outputProperty	String	いいえ	<空>	いいえ	入力値が設定される結果のプロパティ。
defaultValue	Object	はい		いいえ	コンポーネントの数値項目と週/月選択リストのデフォルト値。可能な値は次のとおりです。 day week month
referenceDate	String	はい		はい	選択した週数/月数を追加する開始日。形式は YYYY-MM-DD です。

例

式の値: 式で参照されると、このコンポーネントは、コントロールの計算済みの日付を YYYY-MM-DD 形式の文字列として返します。

結果の値: 結果の生成時、このコンポーネントは、結果オブジェクトの outputProperty 属性で定義されたプロパティに計算済みの日付値を設定します。outputProperty が設定されていない場合、または有効なプロパティが false に解決された場合、出力オブジェクトにデータは設定されません。結果データは、YYYY-MM-DD 形式の文字列として設定されます。

Checkbox

このコンポーネントはチェックボックス項目を表示します。

表 5. プロパティ
プロパティ	型	式をサポートするか?	デフォルト値	必須	説明
id	String	いいえ		はい	コンポーネントのインスタンスの一意の識別子。大文字と小文字が区別されます。この ID は、ウィザードのメタデータ設定のすべてのコンポーネント間で一意でなければなりません。
type	String	いいえ		はい	値は Checkbox です。
visible	Boolean	はい	true	いいえ	コンポーネントを表示するかどうかを指定します。コンポーネントが表示されない場合でも、入力規則が実行され、値がウィザードの結果に設定されます。
editable	Boolean	はい	true	いいえ	コンポーネントの値を編集可能にするかどうかを指定します。
active	Boolean	はい	true	いいえ	コンポーネントの値をウィザードの結果の一部として設定するかどうかを指定します。
label	String	はい	<空>	いいえ	項目の表示ラベルを表示します。
outputProperty	String	いいえ	<空>	いいえ	入力値が設定される結果のプロパティ。
defaultValue	Boolean	はい	false	いいえ	コンポーネントのデフォルト値。

例

式の値: 式で参照されると、このコンポーネントは、コントロールの現在の値を Boolean として返します。

結果の値: 結果の生成時、このコンポーネントは、結果オブジェクトの outputProperty 属性で定義されたプロパティにコントロールの値を設定します。outputProperty が設定されていない場合、または有効なプロパティが false に解決された場合、出力オブジェクトにデータは設定されません。結果データは Boolean として設定されます。

Picklist

このコンポーネントは選択リスト項目を表示します。

表 6. プロパティ
プロパティ	型	式をサポートするか?	デフォルト値	必須かどうか	説明
id	String	いいえ		はい	コンポーネントのインスタンスの一意の識別子。大文字と小文字が区別されます。この ID は、ウィザードのメタデータ設定のすべてのコンポーネント間で一意でなければなりません。
type	String	いいえ		はい	値は Picklist です。
visible	Boolean	はい	true	いいえ	コンポーネントを表示するかどうかを指定します。コンポーネントが表示されない場合でも、入力規則が実行され、値がウィザードの結果に設定されます。
editable	Boolean	はい	true	いいえ	コンポーネントの値を編集可能にするかどうかを指定します。
active	Boolean	はい	true	いいえ	コンポーネントの値をウィザードの結果の一部として設定するかどうかを指定します。
label	String	はい	<空>	いいえ	項目の表示ラベルを表示します。
required	Boolean	いいえ	false	いいえ	項目を必須にするかどうかを指定します。項目が必須であるのに値を入力していない場合、ユーザーはウィザードを送信できません。
outputProperty	String	いいえ	<空>	いいえ	入力値が設定される結果のプロパティ。
defaultValue	String \|\| List<String>	はい	<空>	いいえ	コンポーネントのデフォルト値。
autoSelectFirstItem	Boolean	いいえ	false	いいえ	設定した場合、選択リストの表示時に有効な値がないときは、最初のデータセット項目が自動的に値として選択されます。
defaultValueIndex	Number	はい	<空>	いいえ	設定した場合、選択リストの表示時に有効な値がないときは、指定されたインデックスを持つデータセット項目が値として選択されます。
multiselect	Boolean	いいえ	false	いいえ	有効にすると、ユーザーは、選択リストで 1 つの項目だけではなく、複数の項目を選択できます。
maxSelectedItems	Number	いいえ	Infinity	いいえ	選択リストが複数選択の場合、選択可能な項目の最大数を定義します。制限に達した後にさらに項目を選択すると、最初に選択した項目が選択解除されます。メモ
source	List<Object> \|\| Object	いいえ		はい	詳細は、選択リストのソースに関するセクションを参照してください。
itemLabelField	String	いいえ	Name	いいえ	ソース内にある (またはソースによって解決される) 各項目のプロパティ名。選択リストの表示ラベルとして使用されます。
itemValueField	String	いいえ	Id	いいえ	ソース内にある (またはソースによって解決される) 各項目のプロパティ名。選択リストの値として使用されます。

選択リストのソース: 選択リストで選択できる値は、2 つの方法で定義できます。

選択リスト項目のデータセットに含まれるオブジェクトレコードは、プロパティを必要な数だけ持つことができる点に注意することが重要です。例に示すように、これらのプロパティは他のコンポーネントの式を通じてアクセスできます。
メモ

静的な値のリスト: 選択リストの静的な値のリストを定義するには、ソースプロパティをオブジェクトのリストとして設定します。このリストの各レコードは、選択リストで使用できる値を表します。

APEX が提供する値のリスト: 選択リストで使用できる値のリストを取得できます。値を取得するには、APEX のコール可能なクラスをコールします。APEX のどのコール可能なクラスとメソッドから値を取得するかは、WizardComponent メタデータで指定します。

表 7. ソース属性のプロパティ
プロパティ	型	デフォルト値	必須かどうか	説明
class	String		はい	APEX のコール可能なクラスの名前。
method	String	<空>	いいえ	コール可能なクラスに渡される省略可能なメソッドの名前。このメソッドを使用すると、単一の APEX のコール可能なクラスが、指定されたメソッドに応じてさまざまなデータセットを返すことができます。
cache	Boolean	false	いいえ	設定した場合、コール可能な APEX クラスの応答がブラウザーでキャッシュされます。これは、同じ APEX のコール可能なクラスへの要求、同じメソッドへの要求、および同じパラメーターを使用した要求は 1 回だけ実行され、後続のコールでは以前の実行で得られた値が再利用され��ことを意味します。
params	Object	{}	いいえ	params プロパティを使用すると、APEX のコール可能なクラスに追加のパラメーターを渡すことができます。APEX クラスをコールするときは、要求の一部として params オブジェクトが APEX クラスに渡されます。 params オブジェクトでは、式がそのプロパティの値としてサポートされます。これらの式の値は、APEX のコール可能なクラスをコールする前に解決されます。

params プロパティで式を使用するときは、他の WizardComponents と同じルールが適用されます。参照先コンポーネントが変化すると、そのたびに APEX のコール可能なクラスへの要求が再実行されます。Salesforce サーバーへのコールが重複しないようにし、パフォーマンスを大幅に向上させるため、ソースでキャッシュを有効化 (cache : true) することを強くお勧めします。

メモ

コール可能なクラスの例

例

式の値

項目が��数選択であるのか、単一選択であるのかによって、式からアクセスできる値は異なります。

単一選択

式で参照されると、このコンポーネントは、選択リストで現在選択されているデータセットオブジェクトを返します。たとえば、上記の例を考慮すると次のようになります。

選択リストはオブジェクトを式の値として公開するため、これらのデータセットレコードのプロパティは、式でドット表記を用いて使用できます。

複数選択

式で参照されると、このコンポーネントは、選択リストで現在選択されているデータセットオブジェクトのリストを返します。

選択リストは配列を式の値として公開するため、配列の項目は、角括弧表記 [0] を使用してアクセスできます。また、これらのデータセットレコードのプロパティは、式でドット表記を用いて使用することもできます。

結果の値: 単一選択; 複数選択

ListController

このコンポーネントは、ユーザーが項目を配列に追加できるようにするコントロールを表示します。項目ごとに WizardComponent メタデータのパラメーターリストが複製され、リストの各項目を処理するコンポーネントが提供されます。

表 8. プロパティ
プロパティ	型	式をサポートするか?	デフォルト値	必須	説明
active	Boolean	はい	true	いいえ	コンポーネントの値をウィザードの結果の一部として設定するかどうかを指定します。
columns	Number	いいえ	3	いいえ	リスト内の各項目がレイアウトとして所有する列の数を定義します。
components	List<WizardComponent>	いいえ	[ ]	いいえ	リストの項目ごとに複製されるコンポーネントのメタデータ。
defaultItems	Number	はい	0	いいえ	コントロールを最初に表示するときにデフォルトで作成される項目の数。
editable	Boolean	はい	true	いいえ	コンポーネントの値を編集可能にするかどうかを指定します。
id	String	いいえ		はい	コンポーネントのインスタンスの一意の識別子。大文字と小文字が区別されます。この ID は、ウィザードのメタデータ設定のすべてのコンポーネント間で一意でなければなりません。
itemUniqueKey	String	はい	<空>	いいえ	定義した場合、コンポーネントは渡された式をリストの項目ごとに評価します。評価の結果、重複する値が見つかった場合は、エラーメッセージを表示し、重複項目があるためにウィザードを送信できないことがユーザーに通知されます。
label	String	はい	<空>	いいえ	項目の表示ラベルを表示します。
maxItems	Number	はい	Infinity	いいえ	コントロールの項目の最大数。
outputProperty	String	いいえ	<空>	いいえ	入力値が設定される結果のプロパティ。
type	String	いいえ		はい	値は Checkbox です。
visible	Boolean	はい	true	いいえ	コンポーネントを表示するかどうかを指定します。コンポーネントが表示されない場合でも、入力規則が実行され、値がウィザードの結果に設定されます。

例

式の値: メタデータの設定の例; 式の範囲

結果の値: 結果の生成時、このコンポーネントは、結果オブジェクトの outputProperty 属性で定義されたプロパティに、生成された項目の配列を設定します。outputProperty が設定されていない場合、または有効なプロパティが false に解決された場合、出力オブジェクトにデータは設定されません。