AnimationRule

Represents criteria for determining when an animation is displayed to Path users.

This type extends Metadata and inherits its fields.

AnimationRule components have the suffix animationRule and are stored in the animationRules folder.

Introduced in API version 46.0.

• Type: string (enumeration of type string)
• Required: Yes
• Description: Required. The frequency with which an animation is displayed when a user selects the designated picklist values in a path. A value of always triggers an animation every time. The values often, sometimes, and rarely trigger an animation progressively less frequently.
• Possible values:
  • always
  • often
  • sometimes
  • rarely

• Type: string
• Required: Yes
• Description: Required. The developer name for the animation rule.

• Type: boolean
• Required: Yes
• Description: Required. Indicates whether the animation rule is active (true) or not (false).

• Type: string
• Required: Yes
• Description: Required. The label for the animation rule.

• Type: string
• Required: Yes
• Description: Required. An enum to track whether this AnimationRule applies to all record types for the associated sObject, or only to a single or main record type. Valid values are All, Master, or Custom.

• Type: string
• Required: No
• Description: The record type selected for the sObject in which the animation is displayed.

• Type: string
• Required: Yes
• Description: The object on which the animation rule is run.

• Type: string
• Required: Yes
• Description: Required. Name of the field used to determine when to display an animation.

• Type: string
• Required: Yes
• Description: Required. Values used to determine when to display an animation. When a user selects a value in targetField that matches a value stored in targetFieldChangeToValues, the animation is displayed.

The following is an example of an AnimationRule component.

1<?xml version="1.0" encoding="UTF-8"?>
2<AnimationRule xmlns="http://soap.sforce.com/2006/04/metadata">
3    <animationFrequency>Always</animationFrequency>
4    <developerName>AnimationRule_DeveloperName</developerName>
5    <isActive>true</isActive>
6    <masterLabel>AnimationRule Label</masterLabel>
7    <recordTypeContext>All</recordTypeContext>
8    <recordTypeName>__MASTER__</recordTypeName>
9    <sobjectType>Opportunity</sobjectType>
10    <targetField>StageName</targetField>
11    <targetFieldChangeToValues>Delivered, Negotiating, Closed Won</targetFieldChangeToValues>
12</AnimationRule>

The following is an example package.xml that references the AnimationRule component.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>PathAssistant</members>
5        <name>Settings</name>
6    </types>
7    <types>
8        <members>AnimationRule_Developer_Name</members>
9        <name>AnimationRule</name>
10    </types>
11    <version>46.0</version>
12</Package>

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.