`createDataConnector`

Creates an instance of a prebuilt CRM Analytics connector to connect to data in your Salesforce orgs, apps, data warehouses, and database services.

Syntax

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

CRM Analytics API Resource

1POST /wave/dataConnectors

createDataConnector uses this CRM Analytics API resource.

Parameters

Parameter Name	Type	Description	Required?
`dataConnector`	Object	The data connector instance to create. Use a Data Connector Input resource.

Returns

A Promise object that resolves with the Data Connector response.

Usage

Use createDataConnector to create an instance of a prebuilt CRM Analytics connector. For example, create a connector to another Salesforce org to pull in Account data.

This example adds a create button to a page. The page must contain form elements for the information required to create the connector, like the properties. Creating a data connector displays a toast message using the lightning/platformShowToastEvent module.

1import { LightningElement, api } from 'lwc';
2import { createDataConnector } from 'lightning/analyticsWaveApi';
3import { ShowToastEvent } from 'lightning/platformShowToastEvent';
4
5export default class CreateDataConnector extends LightningElement {
6  dataConnector = {
7    "name" : "mySFDCExt",
8    "label" : "My SFDC External Connector",
9    "description" : "My connection to another SFDC org",
10    "connectionProperties" : [
11      { "name" : "Password", "value" : "*******" },
12      { "name" : "Service_URL", "value" : "https://MyDomainName.my.salesforce.com/services/Soap/u/53.0" },
13      { "name" : "Username", "value" : "user@yourSFDCorg.com" },
14      { "name" : "APIType", "value" : "BULKV2" }
15    ],
16    "connectorType" : "SalesforceExternal",
17    "connectorHandler" : "Legacy"
18  };
19
20  create(event) {
21      createDataConnector({ dataConnector : this.dataConnector } })
22        .then(() => {
23          this.dispatchEvent(
24              new ShowToastEvent({
25                title: 'Success',
26                message: 'Data Connector Created',
27                variant: 'success'
28              })
29          );
30        })
31        .catch(error => {
32          this.dispatchEvent(
33              new ShowToastEvent({
34                title: 'Error creating data connector',
35                message: error.body.message,
36                variant: 'error'
37              })
38          );
39      });
40  }
41}

This button calls the createDataConnector() method.

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