CRM Analytics Template SDK Aura Component
Discover CRM Analytics templates and apps created from them. Create, update, and delete CRM Analytics apps created from templates.
To call the SDK, declare the wave:sdk component in your component or app.
<wave:sdk aura:id="sdk"/>
Use sdk.invokeMethod to specify the method and any parameters.
sdk.invokeMethod(context, methodName, methodParameters, callback)
For example, here’s a call that uses listFolders as methodName.
Each method has its own set of parameters (methodParameters)—except listTemplates, which doesn’t need any.
Retrieves a list of all templates that the user has access to. Has no parameters.
Retrieves information for the specified template.
| Parameter Name | Description | Required | Type |
|---|---|---|---|
templateId | ID of the template. | TRUE | String, in either the internal 'sfdc_internal__' or base platform object ID format |
Retrieves variable and UI information for the template.
| Parameter Name | Description | Required | Type |
|---|---|---|---|
templateId | ID of the template. | TRUE | String, in either the internal 'sfdc_internal__' or base platform object ID format |
Runs validation on a CRM Analytics template to check for org readiness.
| Parameter Name | Description | Required | Type |
|---|---|---|---|
templateId | ID of the template. | TRUE | String, in either the internal 'sfdc_internal__' or base platform object ID format |
validationInput | The input to use during the validation. | TRUE | A map of template variable values to validate the template with. These values override any template defaults. |
Creates a folder from the specified template. Not used for apps that aren’t created from templates.
| Parameter Name | Description | Required | Type |
|---|---|---|---|
name | Developer name of the folder. | TRUE | String |
label | Display label of the folder. | TRUE | String |
description | Description of the folder. | FALSE | String |
dynamicOptions | Map of configuration options for folder creation. | FALSE | Object; map of name-value pairs, such as {'runtimeLogEntryLevel' : 'Warning'}. For supported names and values, see Template Options Input. |
templateSourceId | ID of the template used to create the folder. | TRUE | String, in either the internal 'sfdc_internal__' or base platform object ID format |
templateValues | Variable values for the template. | FALSE | Object; map of name-value pairs, such as {'Can_Continue' : true} |
Retrieves a list of folders that the user has access to. Can be filtered by specifying parameters.
| Parameter Name | Description | Required | Type |
|---|---|---|---|
templateSourceId | Limit the results to folders created from the specified template. | FALSE | String, in either the internal 'sfdc_internal__' or base platform object ID format |
pageSize | Limit the results by page. | FALSE | Number |
q | Limit the results by query string. | FALSE | String |
sort | Sort the results alphabetically or by most recently used. | FALSE | Enum: 'alpha' or 'mru' |
scope | Return only folders within the specified scope. | FALSE | Enum: 'createdByMe' or 'sharedWithMe' |
page | Return the specified page of results. | FALSE | Number |
isPinned | Limit the results to pinned or unpinned folders. | FALSE | Boolean |
mobileOnly | Limit the results to mobileOnly folders. | FALSE | Boolean |
Updates a folder’s metadata. Can cancel an in-progress app.
| Parameter Name | Description | Required | Type |
|---|---|---|---|
folderId | ID of the folder. | TRUE | String |
label | New display label for the folder. | FALSE | String |
description | New description for the folder. | FALSE | String |
applicationStatus | When specified, cancels an app that is in progress. | FALSE | 'cancelledstatus' is the only value |
Resets or upgrades the specified folder. If the version of the template matches the version used to create the app, resets the app using the template. If the versions don’t match, upgrades the app using the new template version. Can specify dynamic options or template values that differ from the values used when the app was originally created.
| Parameter Name | Description | Required | Type |
|---|---|---|---|
dynamicOptions | Map of configuration options for folder upgrade. | FALSE | Object; map of name-value pairs, such as {'runtimeLogEntryLevel' : 'Warning'}. For supported names and values, see Template Options Input. |
folderId | ID of the folder. | TRUE | String |
templateValues | Variable values for the template. | FALSE | Object; map of name-value pairs, such as {'Can_Continue' : true} |
Deletes the specified folder.
| Parameter Name | Description | Required | Type |
|---|---|---|---|
folderId | ID of the folder. | TRUE | String |