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 MetadataWithContent and inherits its fields.

WaveRecipe components have the suffix .wdpr and are stored in the wave folder.

Introduced in API version 41.0.

• Type: string
• Required: No
• Description: The internal name of the application.

• Type: string
• Required: Yes
• Description: Required. The dataflow ID for the Analytics recipe.

• Type: string (enumeration of type string)
• Required: No
• Description: The format of the current recipe definition.
• Possible values:
  • R2 — recipes created with Data Prep
  • R3 — recipes created with Data Prep (API version 49.0)

• Type: string
• Required: Yes
• Description: Required. The recipe name that appears in the user interface.

• Type: string
• Required: No
• Description: A filter condition that defines row-level access to records in a recipe.

• Type: string
• Required: No
• Description: The name of the dataset the recipe saves data results into.

• Type: string
• Required: No
• Description: Links the recipe to the template used to create it. Null for assets not created from a template.

The following is an example of a WaveRecipe component.

1<?xml version="1.0" encoding="UTF-8"?>
2<WaveRecipe xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">    <content xsi:nil="true"/>
3    <dataflow>02KB0000000b5c7MAA</dataflow>
4    <format>R3</format>
5    <masterLabel>recipe1</masterLabel>
6    <securityPredicate>'UserId' == "$User.Id"</securityPredicate>
7    <targetDatasetAlias>Dataset One</targetDatasetAlias>
8</WaveRecipe>

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.

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.