`ingestDataConnector`

Triggers the CRM Analytics data connector to run a data sync. This call is the equivalent of clicking Run Now in the CRM Analytics Data Manager UI.

Syntax

1import { ingestDataConnector } from 'lightning/analyticsWaveApi';
2ingestDataConnector({ connectorIdOrApiName: string }): Promise<RestoreDatasetVersion>

CRM Analytics API Resource

1POST /wave/dataConnectors/${connectorIdOrApiName}/ingest

ingestDataConnector uses this CRM Analytics API resource.

Parameters

This parameter is optional.

Parameter Name	Type	Description
`connectorIdOrApiName`	String	The ID or developer name of the data connector.

Returns

A Promise object that resolves with the Restore Dataset Version response.

Usage

Use ingestDataConnector to trigger a data sync for a CRM Analytics connector. For example, you can display a list of data connectors and enable data sync for each connector on the list. Running a data connector displays a toast message using the lightning/platformShowToastEvent module.

1import { LightningElement, api } from 'lwc';
2import { ingestDataConnector } from 'lightning/analyticsWaveApi';
3import { ShowToastEvent } from 'lightning/platformShowToastEvent';
4
5export default class IngestDataConnector extends LightningElement {
6  @api idOrApiName;
7
8  ingest(event) {
9    ingestDataConnector({ connectorIdOrApiName : this.idOrApiName } })
10      .then(() => {
11        this.dispatchEvent(
12          new ShowToastEvent({
13            title: 'Success',
14            message: 'Data Connector Ingested',
15            variant: 'success'
16          })
17        );
18      })
19    .catch(error => {
20      this.dispatchEvent(
21        new ShowToastEvent({
22          title: 'Error ingesting data connector',
23          message: error.body.message,
24          variant: 'error'
25        })
26      );
27    });
28  }
29}

This button calls the ingestDataConnector() method.

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