`createDataflowJob`

CRM Analytics データフロージョブを作成します。これは、CRM Analytics データマネージャの UI でデータプレップレシピ、データ同期、またはデータフローの [今すぐ実行] をクリックすることと同じです。

構文

1import { createDataflowJob } from 'lightning/analyticsWaveApi';
2createDataflowJob({ dataflowJob: { DATAFLOWID: string, COMMAND: string } }): Promise<DataflowJob>

CRM Analytics API リソース

1POST /wave/dataflowjobs

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

パラメータ

dataflowId — (必須) ジョブのデータフロー、データプレップレシピ、またはデータ同期 ID。
command — (必須) 実行するジョブコマンド。
- start
- stop

データフロージョブを作成するには start である必要があります。

戻り値

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

使用方法

createDataflowJob を使用するには、いくつかの方法があります。たとえば、レシピのリストを表示し、リストの各レシピに対して開始を有効にすることができます。

次の例では、レシピが含まれるページに開始ボタンを追加します。レシピを開始すると、lightning/platformShowToastEvent モジュールを使用して、トーストメッセージが表示されます。

1import { LightningElement, api } from "lwc";
2import { createDataflowJob } from "lightning/analyticsWaveApi";
3import { ShowToastEvent } from "lightning/platformShowToastEvent";
4
5export default class CreateDataflowJob extends LightningElement {
6  @api dfId; // or fetch the dataflowId of the data prep recipe
7  command = "start";
8
9  start(event) {
10    createDataflowJob({ dataflowJob: { dataflowId: this.dfId, command: this.command } })
11      .then(() => {
12        this.dispatchEvent(
13          new ShowToastEvent({
14            title: "Success",
15            message: "Recipe Started",
16            variant: "success",
17          }),
18        );
19      })
20      .catch((error) => {
21        this.dispatchEvent(
22          new ShowToastEvent({
23            title: "Error starting recipe",
24            message: error.body.message,
25            variant: "error",
26          }),
27        );
28      });
29  }
30}

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

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

The Japanese Summer '24 guide is now live

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