CRM Analytics Lightning Web Components

Wire Adapters

getActions

Retrieves a collection of Salesforce actions available for the specified Analytics user. For more information on syntax and usage, see the getActions reference in the Lightning Web Components Developer Guide.

getAnalyticsLimits

Retrieves the Analytics limits for CRM Analytics. For more information on syntax and usage, see the getAnalyticsLimits reference in the Lightning Web Components Developer Guide.

getDataConnector

Retrieves a specific CRM Analytics data connector by ID or developer name. For more information on syntax and usage, see the getDataConnector reference in the Lightning Web Components Developer Guide.

getDataConnectors

Retrieves a collection of CRM Analytics data connectors. For more information on syntax and usage, see the getDataConnectors reference in the Lightning Web Components Developer Guide.

getDataConnectorSourceFields

Retrieves a collection of source fields for a source object used by a CRM Analytics data connector. For more information on syntax and usage, see the getDataConnectorSourceFields reference in the Lightning Web Components Developer Guide.

getDataConnectorSourceObject

Retrieves a source object used by a CRM Analytics data connector. For more information on syntax and usage, see the getDataConnectorSourceObject reference in the Lightning Web Components Developer Guide.

getDataConnectorSourceObjectDataPreviewWithFields

Retrieves the fields for a data preview for a source object used by a CRM Analytics data connector. For more information on syntax and usage, see the getDataConnectorSourceObjectDataPreviewWithFields reference in the Lightning Web Components Developer Guide.

getDataConnectorStatus

Retrieves the status for a specific CRM Analytics data connector by ID or developer name. For more information on syntax and usage, see the getDataConnectorStatus reference in the Lightning Web Components Developer Guide.

getDataConnectorTypes

Retrieves the collection of CRM Analytics data connector types. For more information on syntax and usage, see the getDataConnectorTypes reference in the Lightning Web Components Developer Guide.

getDataflowJob

Retrieves a specific CRM Analytics dataflow job. For more information on syntax and usage, see the getDataflowJob reference in the Lightning Web Components Developer Guide.

getDataflowJobs

Retrieves a collection of CRM Analytics dataflow jobs. For more information on syntax and usage, see the getDataflowJobs reference in the Lightning Web Components Developer Guide.

getDataflowJobNode

Retrieves a specific CRM Analytics dataflow job node for a recipe or dataflow. For more information on syntax and usage, see the getDataflowJobNode reference in the Lightning Web Components Developer Guide.

getDataflowJobNodes

Retrieves a collection of CRM Analytics dataflow job nodes for a recipe or dataflow. For more information on syntax and usage, see the getDataflowJobNodes reference in the Lightning Web Components Developer Guide.

getDataflows

Retrieves a collection of CRM Analytics dataflows. For more information on syntax and usage, see the getDataflows reference in the Lightning Web Components Developer Guide.

getDataset

Retrieves a specific CRM Analytics dataset by ID or developer name. For more information on syntax and usage, see the getDataset reference in the Lightning Web Components Developer Guide.

getDatasets

Retrieves a collection of CRM Analytics datasets. For more information on syntax and usage, see the getDatasets reference in the Lightning Web Components Developer Guide.

getDatasetVersion

Retrieves a specific CRM Analytics dataset version by ID or developer name. For more information on syntax and usage, see the getDatasetVersion reference in the Lightning Web Components Developer Guide.

getDatasetVersions

Retrieves a collection of versions for a CRM Analytics dataset. For more information on syntax and usage, see the getDatasetVersions reference in the Lightning Web Components Developer Guide.

getDependencies

Retrieves a collection of dependencies for a CRM Analytics asset. For more information on syntax and usage, see the getDependencies reference in the Lightning Web Components Developer Guide.

getRecipe

Retrieves a specific CRM Analytics recipe by ID. For more information on syntax and usage, see the getRecipe reference in the Lightning Web Components Developer Guide.

getRecipes

Retrieves a collection of CRM Analytics recipes. For more information on syntax and usage, see the getRecipes reference in the Lightning Web Components Developer Guide.

getReplicatedDataset

Retrieves a specific CRM Analytics replicated dataset by ID, also known as a connected object. For more information on syntax and usage, see the getReplicatedDataset reference in the Lightning Web Components Developer Guide.

getReplicatedDatasets

Retrieves a collection of CRM Analytics replicated datasets, also known as connected objects. For more information on syntax and usage, see the getReplicatedDatasets reference in the Lightning Web Components Developer Guide.

getReplicatedFields

Retrieves a collection of fields belonging to a CRM Analytics replicated dataset, also known as connected object. For more information on syntax and usage, see the getReplicatedFields reference in the Lightning Web Components Developer Guide.

getSchedule

Retrieves a schedule for a CRM Analytics recipe, dataflow, or data sync. For more information on syntax and usage, see the getSchedule reference in the Lightning Web Components Developer Guide.

getSecurityCoverageDatasetVersion

Retrieves the security coverage for a specific CRM Analytics dataset version by ID or developer name. For more information on syntax and usage, see the getSecurityCoverageDatasetVersion reference in the Lightning Web Components Developer Guide.

getStories

Retrieves a collection of Einstein Discovery stories. For more information on syntax and usage, see the getStories reference in the Lightning Web Components Developer Guide.

getWaveFolder

Retrieves a specific CRM Analytics app or folder. For more information on syntax and usage, see the getWaveFolder reference in the Lightning Web Components Developer Guide.

getWaveFolders

Retrieves a collection of CRM Analytics apps or folders. For more information on syntax and usage, see the getWaveFolders reference in the Lightning Web Components Developer Guide.

getWaveTemplate

Retrieves a CRM Analytics template by ID or API name. For more information on syntax and usage, see the getWaveTemplate reference in the Lightning Web Components Developer Guide.

getWaveTemplateConfig

Retrieves the configuration for a CRM Analytics template by ID or API name. For more information on syntax and usage, see the getWaveTemplateConfig reference in the Lightning Web Components Developer Guide.

getWaveTemplateReleaseNotes

Retrieves the release notes for a CRM Analytics template by ID or API name. For more information on syntax and usage, see the getWaveTemplateReleaseNotes reference in the Lightning Web Components Developer Guide.

getWaveTemplates

Retrieves a collection of CRM Analytics templates. For more information on syntax and usage, see the getWaveTemplates reference in the Lightning Web Components Developer Guide.

getXmd

Retrieves a specific CRM Analytics extended metadata type (Xmd) for a version of a dataset. For more information on syntax and usage, see the getXmd reference in the Lightning Web Components Developer Guide.

Functions

createDataConnector

Creates an instance of a CRM Analytics connector to connect to data in your Salesforce orgs, apps, data warehouses, and database services. For more information on syntax and usage, see the createDataConnector reference in the Lightning Web Components Developer Guide.

createDataflowJob

Creates a CRM Analytics dataflow job, which is the equivalent of clicking Run Now for a data prep recipe, a data sync, or a dataflow in the CRM Analytics Data Manager UI. For more information on syntax and usage, see the createDataflowJob reference in the Lightning Web Components Developer Guide.

createDataset

Creates a dataset. For more information on syntax and usage, see the createDataset reference in the Lightning Web Components Developer Guide.

createDatasetVersion

Creates a version for a specific CRM Analytics dataset by ID or developer name. For more information on syntax and usage, see the createDatasetVersion reference in the Lightning Web Components Developer Guide.

createReplicatedDataset

Creates a CRM Analytics replicated dataset, also known as a connected object. For more information on syntax and usage, see the createReplicatedDataset reference in the Lightning Web Components Developer Guide.

deleteDataConnector

Deletes a specific CRM Analytics connector by ID or developer name. For more information on syntax and usage, see the deleteDataConnector reference in the Lightning Web Components Developer Guide.

deleteDataset

Deletes a specific CRM Analytics dataset by ID or developer name. For more information on syntax and usage, see the deleteDataset reference in the Lightning Web Components Developer Guide.

deleteRecipe

Deletes a specific CRM Analytics recipe by ID. For more information on syntax and usage, see the deleteRecipe reference in the Lightning Web Components Developer Guide.

deleteReplicatedDataset

Deletes a specific CRM Analytics replicated dataset by ID. For more information on syntax and usage, see the deleteReplicatedDataset reference in the Lightning Web Components Developer Guide.

deleteWaveFolder

Deletes a specific CRM Analytics app or folder by ID. For more information on syntax and usage, see the deleteWaveFolder reference in the Lightning Web Components Developer Guide.

executeQuery

Executes a CRM Analytics query written in Salesforce Analytics Query Language (SAQL) or standard SQL. For more information on syntax and usage, see the executeQuery reference in the Lightning Web Components Developer Guide.

ingestDataConnector

Triggers the CRM Analytics to run a data sync. For more information on syntax and usage, see the ingestDataConnector reference in the Lightning Web Components Developer Guide.

postWaveFolders

Creates a CRM Analytics app or folder by ID. For more information on syntax and usage, see the postWaveFolders reference in the Lightning Web Components Developer Guide.

updateDataConnector

Updates a CRM Analytics data connector. For more information on syntax and usage, see the updateDataConnector reference in the Lightning Web Components Developer Guide.

updateDataflowJob

Updates a CRM Analytics dataflow job, which is the equivalent of clicking Stop for a data prep recipe, a data sync, or a dataflow in the CRM Analytics Data Manager UI. For more information on syntax and usage, see the updateDataflowJob reference in the Lightning Web Components Developer Guide.

updateDataset

Updates a specific CRM Analytics dataset by ID or developer name. For more information on syntax and usage, see the updateDataset reference in the Lightning Web Components Developer Guide.

updateDatasetVersion

Updates a specific CRM Analytics dataset version by ID or developer name. For more information on syntax and usage, see the updateDatasetVersion reference in the Lightning Web Components Developer Guide.

updatePartialWaveFolder

Performs a partial update for a CRM Analytics app or folder by ID. For more information on syntax and usage, see the updatePartialWaveFolder reference in the Lightning Web Components Developer Guide.

updateRecipe

Updates a CRM Analytics recipe. For more information on syntax and usage, see the updateRecipe reference in the Lightning Web Components Developer Guide.

updateReplicatedDataset

Updates a CRM Analytics replicated dataset by ID. For more information on syntax and usage, see the updateReplicatedDataset reference in the Lightning Web Components Developer Guide.

updateReplicatedFields

Updates the collection of fields for a CRM Analytics replicated dataset by ID. For more information on syntax and usage, see the updateReplicatedFields reference in the Lightning Web Components Developer Guide.

updateSchedule

Updates the schedule for a CRM Analytics data prep recipe, data sync, or dataflow. For more information on syntax and usage, see the updateSchedule reference in the Lightning Web Components Developer Guide.

updateXmd

Updates the user Xmd for a CRM Analytics dataset. For more information on syntax and usage, see the updateXmd reference in the Lightning Web Components Developer Guide.

updateWaveFolder

Updates a CRM Analytics app or folder by ID. For more information on syntax and usage, see the updateWaveFolder reference in the Lightning Web Components Developer Guide.

validateWaveTemplate

Validates a CRM Analytics template for org readiness. For more information on syntax and usage, see the valildateWaveTemplate reference in the Lightning Web Components Developer Guide.