Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
WaveRecipe
Represents the WaveRecipe type in an Analytics application. A
recipe is a saved set of steps to perform on a specific source dataset or connected data.
This type extends the MetadataWithContent metadata type and inherits its
content and fullName fields.
File Suffix and Directory Location
WaveRecipe components have the suffix .wdpr and are stored in the wave folder.
Version
WaveRecipe components are available in API version 41.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| application | string | The internal name of the application. |
| dataflow | string | Required. The dataflow ID for the Analytics recipe. |
| format | string | The format of the current recipe definition. Valid values are:
|
| masterLabel | string | Required. The recipe name that appears in the user interface. |
| securityPredicate | string | A filter condition that defines row-level access to records in a recipe. |
| targetDatasetAlias | string | The name of the dataset the recipe saves data results into. |
| templateAssetSourceName | string | Links the recipe to the template used to create it. Null for assets not created from a template. |
Declarative Metadata Sample Definition
The following is an example of a WaveRecipe component.
<?xml version="1.0" encoding="UTF-8"?>
<WaveRecipe xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <content xsi:nil="true"/>
<dataflow>02KB0000000b5c7MAA</dataflow>
<format>R3</format>
<masterLabel>recipe1</masterLabel>
<securityPredicate>'UserId' == "$User.Id"</securityPredicate>
<targetDatasetAlias>Dataset One</targetDatasetAlias>
</WaveRecipe>Deleting a WaveRecipe Component
Use a simple destructiveChanges.xml file with only the WaveRecipe component declared. This deletes the WaveRecipe and any related WaveDataflow components. For more information, see Delete Components from an Organization.
Wildcard Support in the Manifest File
This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.