詳細情報:
アクション Lightning Web コンポーネント ReadMe (管理パッケージ)
管理パッケージランタイムの場合、このページには各 Vlocity リリースのアクション LWC ReadMe が含まれます。
この情報は、OmniStudio for Managed Packages 用です。標準ランタイムの OmniStudio については、OmniStudio ヘルプを参照してください。
使用可能な C アクション属性
データソースからデータを取得した後にページを移動するには、次の属性を使用します。
属性 |
値 |
型 |
必須 |
説明 |
|---|---|---|---|---|
debug |
true、false (デフォルト: false) |
boolean |
デバッグモードを有効にするには、true に設定します。取得したデータをテンプレート内に出力し、テスト用に JSON を更新します。 |
|
定義 |
JSON |
object |
はい |
必須オブジェクトが含まれます。「使用可能な定義属性」を参照 |
disableCache |
true、false (デフォルト: false) |
boolean |
キャッシュを無効にするには、true に設定します。 |
|
url |
URL |
string |
補間された URL を読み取ります。 |
c-アクションコンポーネントの例
<c-action
onclick={fetchData}
ondata={onsuccesscallback}
onerror={onerrorcallback}
>
<c-button label="Fetch Contact" type="button" variant="neutral"></c-button>
<c-navigate-action
target-type={_targetType}
target-id={_targetId}
target-name={_targetName}
target-params={_targetParams}
target-action={_targetAction}
replace
>
<p>URL: {url}</p>
</c-navigate-action>
</c-action>
@track
query = JSON.stringify({
datasource: {
type: "query",
value: {
query: "SELECT Id, name FROM Contact LIMIT 1"
}
},
url: "/${data[0].Id}",
target: "_blank",
parameters: {},
navigate: false
});
fetchData(ev) {
let action = ev.currentTarget;
let def = JSON.parse(this.query);
action.definition = this.query;
action.triggerAction();
}
// Passing these properties down to the navigate-action using attributes.
onsuccesscallback(ev) {
let result = ev.detail.result;
this._targetType = "Record";
this._targetId = result[0].Id;
// Because attribute values are set using attributes, give the ui a chance to re-render.
Promise.resolve().then(() => {
let navigateAction = this.template.querySelector("c-navigate-action");
navigateAction.navigate();
this.url = ev.target.url;
this.onResult(
result.map(obj => {
var rObj = obj;
rObj.isEdit = false;
return rObj;
})
);
});
}
onerrorcallback(error) {
console.log(error);
}
使用可能な定義の属性
属性 |
値 |
型 |
必須 |
説明 |
|---|---|---|---|---|
datasource |
JSON |
object |
はい |
データの取得元を定義します。詳細は、「データソース Lightning Web コンポーネント」を参照してください。 |
data |
JSON |
object |
データソースから取得したデータを定義内で直接使用するには、ここにデータを追加します。 |
|
isTrackingDisabled |
true、false (デフォルト: true) |
string |
追跡を無効にするには、false に設定します。 |
|
navigateTo |
JSON |
object |
ナビゲーションサービスオブジェクトを定義します。URL が存在しない場合、このオブジェクトはナビゲーションの対象とみなされ、type と value が渡された場合に補間されます。ナビゲーションに関する Salesforce ドキュメントを参照してください |
|
移動 |
true または false (デフォルト: false) |
boolean |
URL を移動するかどうかを指定します。 |
|
パラメータ |
JSON |
object |
url が設定されている場合のみ、すべてのフィールドを url パラメータとして追加します。 |
|
target |
現在のウィンドウまたは新しいウィンドウ |
string |
URL が開くウィンドウを指定します。URL が相対的で salesforce オブジェクトデータではない場合にのみ機能します。 |
|
trackingObj |
string |
コンテナ Flexcard の追跡オブジェクトを指定します。 |
||
url |
string |
type と value が渡された場合に補間されるナビゲーション URL を定義します。URL は、navigateTo オブジェクトよりも優先されます。 |
リンクで使用可能な c-action 属性
リンクをクリックしてアクションを実行するには、次の属性を使用します。
属性 |
値 |
型 |
必須 |
説明 |
|---|---|---|---|---|
action-labelclass |
string |
action label 要素にクラスを追加します。複数のクラスを追加するには、「classone classtwo」のように各クラスをスペースで区切ります。 |
||
action-wrapperclass |
string |
アクションラッパー要素にクラスを追加します。複数のクラスを追加するには、「classone classtwo」のように各クラスをスペースで区切ります。 |
||
context-id |
string |
アクションコンテキスト ID を設定します。 |
||
icon-color |
string |
アイコンの色を設定します。 |
||
icon-extraclass |
string |
icon 要素にクラスを追加します。複数のクラスを追加するには、「classone classtwo」のように各クラスをスペースで区切ります。 |
||
icon-size |
xx-small、small、medium、large、x-large |
string |
アイコンのサイズを設定します。 |
|
icon-url |
URL |
string |
アイコンの URL を設定します。Newport Design System (NDS) テーマでのみ使用します。 |
|
icon-wrapperclass |
string |
アイコンラッパー要素にクラスを追加します。複数のクラスを追加するには、「classone classtwo」のように各クラスをスペースで区切ります。 |
||
s-object-type |
sObject |
string |
アクション sObject 種別を設定します。 |
|
state-action |
JSON |
object |
はい |
アクション情報を設定します。 |
state-obj |
JSON |
object |
レイアウト/カードレコードが含まれます。 |
|
スタイル |
string |
label および text-align プロパティのインラインスタイルを設定する。it should be in this formt |
||
テーマ |
SLDS、nds (デフォルト: SLDS) |
string |
使用するテーマを指定します。 |
c-アクションコンポーネントの例 (Vlocity Card 状態テンプレート内)
<c-action
icon-extraclass="slds-m-right_small"
state-obj={obj}
context-id={contextId}
s-object-type={sObjectType}
state-action={item}
action-wrapperclass="slds-size--1-of-1"
action-labelclass="slds-size--7-of-8"
icon-wrapperclass="slds-size--1-of-8"
></c-action>使用可能な C アクション属性
データソースからデータを取得した後にページを移動するには、次の属性を使用します。
属性 |
値 |
型 |
必須 |
説明 |
|---|---|---|---|---|
debug |
true、false (デフォルト: false) |
boolean |
デバッグモードを有効にするには、true に設定します。取得したデータをテンプレート内に出力し、テスト用に JSON を更新します。 |
|
定義 |
JSON |
object |
はい |
必要なオブジェクトが含まれます。「Available definitionAttributes」を参照してください。 |
disableCache |
true、false (デフォルト: false) |
boolean |
キャッシュを無効にするには、true に設定します。 |
|
url |
URL |
string |
補間された URL を読み取ります。 |
使用可能な定義の属性
属性 |
値 |
型 |
必須 |
説明 |
|---|---|---|---|---|
datasource |
JSON |
object |
はい |
データの取得元を定義します。詳細は、「データソース Lightning Web コンポーネント」を参照してください。 |
data |
JSON |
object |
データソースから取得したデータを定義内で直接使用するには、ここにデータを追加します。 |
|
navigateTo |
JSON |
object |
ナビゲーションサービスオブジェクトを定義します。URL が存在しない場合、このオブジェクトはナビゲーションの対象とみなされ、種別と値が渡されると補間されます。ナビゲーションに関する Salesforce ドキュメントを参照してください |
|
移動 |
true または false (デフォルト: false) |
boolean |
URL を移動するかどうかを指定します。 |
|
パラメータ |
JSON |
object |
url が設定されている場合のみ、すべてのフィールドを URL パラメータとして追加します。 |
|
target |
現在のウィンドウまたは新しいウィンドウ |
string |
URL が開くウィンドウを指定します。URL が相対 URL で salesforce オブジェクトデータではない場合にのみ機能します。 |
|
url |
string |
type と value が渡された場合に補間されるナビゲーション URL を定義します。この URL には、navigateTo オブジェクトよりも高い優先順位が設定されます。 |
c-アクションコンポーネントの例
<c-action
onclick={fetchData}
ondata={onsuccesscallback}
onerror={onerrorcallback}
>
<c-button label="Fetch Contact" type="button" variant="neutral"></c-button>
<c-navigate-action
target-type={_targetType}
target-id={_targetId}
target-name={_targetName}
target-params={_targetParams}
target-action={_targetAction}
replace
>
<p>URL: {url}</p>
</c-navigate-action>
</c-action>
@track
query = JSON.stringify({
datasource: {
type: "query",
value: {
query: "SELECT Id, name FROM Contact LIMIT 1"
}
},
url: "/${data[0].Id}",
target: "_blank",
parameters: {},
navigate: false
});
fetchData(ev) {
let action = ev.currentTarget;
let def = JSON.parse(this.query);
action.definition = this.query;
action.triggerAction();
}
// I'm passing these properties down to the navigate-action via
// attributes.
onsuccesscallback(ev) {
let result = ev.detail.result;
this._targetType = "Record";
this._targetId = result[0].Id;
// Because we're setting the attribute values via attributes,
// we need to give the ui a chance to re-render.
Promise.resolve().then(() => {
let navigateAction = this.template.querySelector("c-navigate-action");
navigateAction.navigate();
this.url = ev.target.url;
this.onResult(
result.map(obj => {
var rObj = obj;
rObj.isEdit = false;
return rObj;
})
);
});
}
onerrorcallback(error) {
console.log(error);
}
リンクで使用可能な c-action 属性
リンクをクリックしてアクションを実行するには、次の属性を使用します。
属性 |
値 |
型 |
必須 |
説明 |
|---|---|---|---|---|
action-labelclass |
string |
action label 要素にクラスを追加します。複数のクラスを追加するには、「classone classtwo」のように各クラスをスペースで区切ります。 |
||
action-wrapperclass |
string |
アクションラッパー要素にクラスを追加します。複数のクラスを追加するには、「classone classtwo」のように各クラスをスペースで区切ります。 |
||
context-id |
string |
アクションコンテキスト ID を設定します。 |
||
icon-extraclass |
string |
icon 要素にクラスを追加します。複数のクラスを追加するには、「classone classtwo」のように各クラスをスペースで区切ります。 |
||
icon-size |
xx-small、small、medium、large、x-large |
string |
アイコンのサイズを設定します。 |
|
icon-url |
URL |
string |
アイコンの URL を設定します。Newport Design System (NDS) テーマでのみ使用します。 |
|
icon-wrapperclass |
string |
アイコンラッパー要素にクラスを追加します。複数のクラスを追加するには、「classone classtwo」のように各クラスをスペースで区切ります。 |
||
s-object-type |
sObject |
string |
アクション sObject 種別を設定します。 |
|
state-action |
JSON |
object |
はい |
アクション情報を設定します。 |
state-obj |
JSON |
object |
レイアウト/カードレコードが含まれます。 |
|
テーマ |
SLDS、nds (デフォルト: SLDS) |
string |
使用するテーマを指定します。 |
c-アクションコンポーネントの例 (Vlocity Card 状態テンプレート内)
<c-action
icon-extraclass="slds-m-right_small"
state-obj={obj}
context-id={contextId}
s-object-type={sObjectType}
state-action={item}
action-wrapperclass="slds-size--1-of-1"
action-labelclass="slds-size--7-of-8"
icon-wrapperclass="slds-size--1-of-8"
></c-action>Vlocity Insurance and Health Winter '20 および Vlocity CME Spring '20
アクション Lightning Web コンポーネントは、すべてのアクションコンポーネントのベースコンポーネントです。
使用可能な定義属性
属性 |
値 |
型 |
必須 |
説明 |
|---|---|---|---|---|
datasource |
JSON |
object |
はい |
データの取得元を定義します。詳細は、「データソース Lightning Web コンポーネント」を参照してください。 |
data |
JSON |
object |
データソースから取得したデータを定義内で直接使用するには、ここにデータを追加します。 |
|
navigateTo |
JSON |
object |
ナビゲーションサービスオブジェクトを定義します。URL が存在しない場合、このオブジェクトはナビゲーションの対象とみなされ、type と value が渡された場合に補間されます。 |
|
移動 |
true または false (デフォルト: false) |
boolean |
URL を移動する必要があるかどうかを指定します。 |
|
パラメータ |
JSON |
object |
url が設定されている場合のみ、すべてのフィールドを url パラメータとして追加します。 |
|
target |
現在のウィンドウまたは新しいウィンドウ |
string |
URL が開くウィンドウを指定します。URL が相対的で salesforce オブジェクトデータではない場合にのみ機能します。 |
|
url |
string |
type と value が渡された場合に補間されるナビゲーション URL を定義します。URL は、navigateTo オブジェクトよりも優先されます。 |
c-アクションコンポーネントの例
<c-action
onclick={fetchData}
ondata={onsuccesscallback}
onerror={onerrorcallback}
>
<c-button label="Fetch Contact" type="button" variant="neutral"></c-button>
<c-navigate-action
target-type={_targetType}
target-id={_targetId}
target-name={_targetName}
target-params={_targetParams}
target-action={_targetAction}
replace
>
<p>URL: {url}</p>
</c-navigate-action>
</c-action>@track
query = JSON.stringify({
datasource: {
type: "query",
value: {
query: "SELECT Id, name FROM Contact LIMIT 1"
}
},
url: "/${data[0].Id}",
target: "_blank",
parameters: {},
navigate: false
});
fetchData(ev) {
let action = ev.currentTarget;
let def = JSON.parse(this.query);
action.definition = this.query;
action.triggerAction();
}
// I'm passing these properties down to the navigate-action via
// attributes.
onsuccesscallback(ev) {
let result = ev.detail.result;
this._targetType = "Record";
this._targetId = result[0].Id;
// Because we're setting the attribute values via attributes,
// we need to give the ui a chance to re-render.
Promise.resolve().then(() => {
let navigateAction = this.template.querySelector("c-navigate-action");
navigateAction.navigate();
this.url = ev.target.url;
this.onResult(
result.map(obj => {
var rObj = obj;
rObj.isEdit = false;
return rObj;
})
);
});
}
onerrorcallback(error) {
console.log(error);
}リンクで使用可能な c-action 属性
リンクをクリックしてアクションを実行するには、次の属性を使用します。
属性 |
値 |
型 |
必須 |
説明 |
|---|---|---|---|---|
action-labelclass |
string |
クラスをアクション表示ラベル要素に追加します。複数のクラスを追加するには、「classone classtwo」のように各クラスをスペースで区切ります。 |
||
action-wrapperclass |
string |
アクションラッパー要素にクラスを追加します。複数のクラスを追加するには、「classone classtwo」のように各クラスをスペースで区切ります。 |
||
context-id |
string |
アクションコンテキスト ID を設定します。 |
||
icon-extraclass |
string |
icon 要素にクラスを追加します。複数のクラスを追加するには、「classone classtwo」のように各クラスをスペースで区切ります。 |
||
icon-size |
xx-small、small、medium、large、x-large |
string |
アイコンのサイズを設定します。 |
|
icon-url |
URL |
string |
アイコンの URL を設定します。Newport Design System (NDS) テーマでのみ使用します。 |
|
icon-wrapperclass |
string |
アイコンラッパー要素にクラスを追加します。複数のクラスを追加するには、「classone classtwo」のように各クラスをスペースで区切ります。 |
||
s-object-type |
sObject |
string |
アクション sObject 種別を設定します。 |
|
state-action |
JSON |
object |
はい |
アクション情報を設定します。 |
state-obj |
JSON |
object |
レイアウト/カードレコードが含まれます。 |
|
テーマ |
SLDS、nds (デフォルト: SLDS) |
string |
使用するテーマを指定します。 |
c-アクションコンポーネントの例 (Vlocity Card 状態テンプレート内)
<c-action
icon-extraclass="slds-m-right_small"
state-obj={obj}
context-id={contextId}
s-object-type={sObjectType}
state-action={item}
action-wrapperclass="slds-size--1-of-1"
action-labelclass="slds-size--7-of-8"
icon-wrapperclass="slds-size--1-of-8"
></c-action>Vlocity Insurance and Health Summer '19 および Vlocity CME Fall '19
アクション Lightning Web コンポーネントは、すべてのアクションコンポーネントのベースコンポーネントです。
使用可能な定義の属性
属性 |
値 |
型 |
必須 |
説明 |
|---|---|---|---|---|
datasource |
JSON |
object |
はい |
データの取得元を定義します。詳細は、「データソース Lightning Web コンポーネント」を参照してください。 |
data |
JSON |
object |
データソースから取得したデータを定義内で直接使用するには、ここにデータを追加します。 |
|
navigateTo |
JSON |
object |
ナビゲーションサービスオブジェクトを定義します。URL が存在しない場合、このオブジェクトはナビゲーションの対象とみなされ、type と value が渡された場合に補間されます。ナビゲーションの Salesforce ドキュメントを参照してください。 |
|
移動 |
true または false (デフォルト: false) |
boolean |
URL を移動する必要があるかどうかを指定します。 |
|
パラメータ |
JSON |
object |
url が設定されている場合のみ、すべてのフィールドを url パラメータとして追加します。 |
|
target |
現在のウィンドウまたは新しいウィンドウ |
string |
URL が開くウィンドウを指定します。URL が相対的で salesforce オブジェクトデータではない場合にのみ機能します。 |
|
url |
string |
type と value が渡された場合に補間されるナビゲーション URL を定義します。この URL は、navigateTo オブジェクトよりも優先されます。 |
c-アクションコンポーネントの例
<c-action
onclick={fetchData}
ondata={onsuccesscallback}
onerror={onerrorcallback}
>
<c-button label="Fetch Contact" type="button" variant="neutral"></c-button>
<c-navigate-action
target-type={_targetType}
target-id={_targetId}
target-name={_targetName}
target-params={_targetParams}
target-action={_targetAction}
replace
>
<p>URL: {url}</p>
</c-navigate-action>
</c-action>@track
query == JSON.stringify({
datasource: {
type: "query",
value: {
query: "SELECT Id, name FROM Contact LIMIT 1"
}
},
url: "/${data[0].Id}",
target: "_blank",
parameters: {},
navigate: false
});
fetchData(ev) {
let action == ev.currentTarget;
let def == JSON.parse(this.query);
action.definition == this.query;
action.triggerAction();
}
// I'm passing these properties down to the navigate-action via
// attributes.
onsuccesscallback(ev) {
let result == ev.detail.result;
this._targetType == "Record";
this._targetId == result[0].Id;
// Because we're setting the attribute values via attributes,
// we need to give the ui a chance to re-render.
Promise.resolve().then(() => {
let navigateAction == this.template.querySelector("c-navigate-action");
navigateAction.navigate();
this.url == ev.target.url;
this.onResult(
result.map(obj => {
var rObj == obj;
rObj.isEdit == false;
return rObj;
})
);
});
}
onerrorcallback(error) {
console.log(error);
}リンクで使用可能な c-action 属性
リンクをクリックしてアクションを実行するには、次の属性を使用します。
属性 |
値 |
型 |
必須 |
説明 |
|---|---|---|---|---|
action-labelclass |
string |
クラスを 1 つ追加します。複数のクラスを追加するには、「classone classtwo」のように各クラスをスペースで区切ります。 |
||
action-wrapperclass |
string |
アクションラッパー要素にクラスを追加します。複数のクラスを追加するには、「classone classtwo」のように各クラスをスペースで区切ります。 |
||
context-id |
string |
アクションコンテキスト ID を設定します。 |
||
icon-extraclass |
string |
icon 要素にクラスを追加します。複数のクラスを追加するには、「classone classtwo」のように各クラスをスペースで区切ります。 |
||
icon-size |
xx-small、small、medium、large、x-large |
string |
アイコンのサイズを設定します。 |
|
icon-url |
URL |
string |
アイコンの URL を設定します。Newport Design System (NDS) テーマでのみ使用します。 |
|
icon-wrapperclass |
string |
アイコンラッパー要素にクラスを追加します。複数のクラスを追加するには、「classone classtwo」のように各クラスをスペースで区切ります。 |
||
s-object-type |
sObject |
string |
アクション sObject 種別を設定します。 |
|
state-action |
JSON |
object |
はい |
アクション情報を設定します。 |
state-obj |
JSON |
object |
レイアウト/カードレコードが含まれます。 |
|
テーマ |
SLDS、nds (デフォルト: SLDS) |
string |
使用するテーマを指定します。 |
c-アクションコンポーネントの例 (Vlocity Card 状態テンプレート内)
<c-action
icon-extraclass="slds-m-right_small"
state-obj={obj}
context-id={contextId}
s-object-type={sObjectType}
state-action={item}
action-wrapperclass="slds-size--1-of-1"
action-labelclass="slds-size--7-of-8"
icon-wrapperclass="slds-size--1-of-8"
></c-action>