`updateReplicatedFields`

Updates the collection of fields for a CRM Analytics replicated dataset by ID. This method merges the target replicated dataset’s fields with the collection provided. Each field requires the name attribute, and a fieldType attribute is also required if it’s a new field. This method can’t be used to delete existing fields, but they can be skipped, which removes the field from active replication.

Syntax

1import { updateReplicatedFields } from 'lightning/analyticsWaveApi';
2updateReplicatedFields({ id: string, replicatedFields: ReplicatedFieldCollectionInput }): Promise<ReplicatedFieldCollection>

CRM Analytics API Resource

1PATCH /wave/replicatedDatasets/${id}/fields

updateReplicatedFields uses this CRM Analytics API resource.

Parameters

Parameter Name	Type	Description	Required?
`id`	String	The ID of the replicated dataset.
`replicatedFields`	Object	The collection of fields to merge into the existing fields for the replicated dataset. Use a Replicated Field Collection Input resource.

Returns

A Promise object that resolves with the Replicated Field Collection response.

Usage

There are several ways to use updateReplicatedFields. For example, you can display a list of replicated datasets and the fields for each replicated dataset.

This example adds an update button to a page with replicated datasets. The page must contain form elements for the information required to update or create fields for the replicated dataset, like the name and fieldType. Updating the fields for a replicated dataset displays a toast message using the lightning/platformShowToastEvent module.

1import { LightningElement, api } from 'lwc';
2import { updateReplicatedFields } from 'lightning/analyticsWaveApi';
3import { ShowToastEvent } from 'lightning/platformShowToastEvent';
4
5export default class UpdateReplicatedFields extends LightningElement {
6  @api rdId; // or fetch the ID of the replicated dataset
7  replicatedFields = {
8    "fields" : [
9      { "name" : "Field1","isSkipped" : true }, // Updating this field
10      { "name" : "Field2" } // Leaving this field unchanged
11      { "name" : "Field3", "fieldType" : "text", "label" : "Field Three" } // Adding a new field
12    ]
13  };
14
15  update(event) {
16    updateReplicatedFields({ id: this.rdId, replicatedFields : this.replicatedFields })
17      .then(() => {
18        this.dispatchEvent(
19          new ShowToastEvent({
20            title: 'Success',
21            message: 'Replicated dataset fields updated',
22            variant: 'success'
23          })
24        );
25      })
26      .catch(error => {
27        this.dispatchEvent(
28          new ShowToastEvent({
29            title: 'Error updating replicated dataset fields',
30            message: error.body.message,
31            variant: 'error'
32          })
33        );
34      });
35  }
36}

All fields in the existing collection must be present in the PATCH request. For fields that aren’t updated, only the name is required.

Note

This button calls the updateReplicatedFields() method.

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>