`updateDataConnector`

CRM Analytics データコネクタを更新します。

構文

1import { updateDataConnector } from 'lightning/analyticsWaveApi';
2updateDataConnector({ connectorIdOrApiName: string, dataConnector : DataConnectorInput }): Promise<DataConnector>

CRM Analytics API リソース

1PATCH /wave/dataConnectors/${connectorIdOrApiName}

updateDataflowJob は、この CRM Analytics API リソースを使用します。

パラメータ

connectorIdOrApiName — (必須) データコネクタの ID または開発者名。
dataConnector — (必須) 更新するデータコネクタインスタンス。Data Connector Input リソースを使用します。

戻り値

Data Connector 応答を使用して解決される Promise オブジェクト。

使用方法

updateDataConnector を使用するには、いくつかの方法があります。たとえば、データコネクタのリストを表示し、接続のプロパティ、ラベル、説明などを更新できます。

次の例では、データコネクタが含まれるページに更新ボタンを追加します。ページには、ラベルなど、コネクタの更新に必要な情報についてのフォーム要素が含まれている必要があります。データコネクタを更新すると、lightning/platformShowToastEvent モジュールを使用してトーストメッセージが表示されます。

1import { LightningElement, api } from "lwc";
2import { updateDataConnector } from "lightning/analyticsWaveApi";
3import { ShowToastEvent } from "lightning/platformShowToastEvent";
4
5export default class UpdateDataConnector extends LightningElement {
6  @api dcId; // or fetch the ID of the data connector
7  dataConnector = {
8    label: "My SFDC Ext Connector",
9    description: "My updated connection to another SFDC org",
10  };
11
12  update(event) {
13    updateDataConnector({ connectorIdOrApiName: this.dcId, dataConnector: this.dataConnector })
14      .then(() => {
15        this.dispatchEvent(
16          new ShowToastEvent({
17            title: "Success",
18            message: "Data Connector updated",
19            variant: "success",
20          }),
21        );
22      })
23      .catch((error) => {
24        this.dispatchEvent(
25          new ShowToastEvent({
26            title: "Error updating data connector",
27            message: error.body.message,
28            variant: "error",
29          }),
30        );
31      });
32  }
33}

このボタンは、updateDataConnector() メソッドをコールします。

1<template>
2  <lightning-button
3    label="Update"
4    icon-name="utility:play"
5    icon-position="right"
6    onclick={Update}
7  ></lightning-button>
8</template>

The Japanese Summer '24 guide is now live

日本語の Summer '24 ガイドが公開されました! 「Component Reference (コンポーネントリファレンス)」は、以前と同様にコンポーネントライブラリにあります。