BusinessProcess

The BusinessProcess metadata type enables you to display different picklist values for users based on their profile.

Multiple business processes allow you to track separate sales, support, and lead lifecycles. A sales, support, lead, or solution process is assigned to a record type. The record type determines the user profiles that are associated with the business process.

Don’t use business processes as an access control mechanism. Profile assignment governs create and edit access for business process but doesn’t govern read access. For example, a user assigned to a profile that isn’t enabled for a particular business process can’t create or edit it, but they can read the business process record.

Users with access to a business process can read all information it stores. Don’t store sensitive information in the business process description, name, or picklist values. Instead, store sensitive information in a separate object or fields to which you’ve applied appropriate access controls.

Important

Parent Type

This type extends Metadata and inherits its fields.

File Suffix and Directory Location

Business processes are defined as part of the custom object or standard object definition. See CustomObject for more information.

Version

BusinessProcess components are available in API version 17.0 and later.

Special Access Rules

Access to this object requires the View Setup and Configuration permission.

Fields

description

Type: string
Required: No
Description: Description for the business process.

fullName

Type: string
Required: No
Description: Required. The name used as a unique identifier for API access. This field is inherited from the Metadata component, but the string it contains is created differently than the fullName strings for other types. For a fullName string BusinessProcess, the fullName is created combining the Entity Name and Business Process Name. For example, for a business process called “Bulk Orders” for opportunities, the fullName would be Opportunity.Bulk Orders. Use the object-qualified form (Opportunity. Bulk Orders) for API addressing, such as in a package.xml member in metadata retrieve results. When creating a business process in a CustomObject definition, use the bare process name (Bulk Orders) for the nested <businessProcesses><fullName> value. The enclosing object already supplies the entity context.

isActive

Type: boolean
Required: No
Description: Indicates if the business process is active (true) or not (false).

namespacePrefix

Type: string
Required: No
Description: The namespace of the developer organization where the package was created.

values

Type: PicklistValue[]
Required: No
Description: A list of picklist values associated with this business process.

PicklistValue Type

Parent Type

This type extends Metadata and inherits its fields.

Fields

allowEmail

Type: boolean
Required: No

closed

Type: boolean
Required: No

color

Type: string
Required: No

controllingFieldValues

Type: string[]
Required: No

converted

Type: boolean
Required: No

cssExposed

Type: boolean
Required: No

default

Type: boolean
Required: Yes

description

Type: string
Required: No
Description: A description of this component. The description should explain the component’s purpose and behavior so that administrators and developers understand when to use it.

forecastCategory

Type: ForecastCategories (enumeration of type string)
Required: No

highPriority

Type: boolean
Required: No

isActive

Type: boolean
Required: No
Description: Indicates whether this component is active (true) or inactive (false). Inactive components are deployed but not available for use at runtime.

probability

Type: int
Required: No

reverseRole

Type: string
Required: No

reviewed

Type: boolean
Required: No

won

Type: boolean
Required: No

Declarative Metadata Sample Definition

The following is a sample XML definition of a lead business process.

1<?xml version="1.0" encoding="UTF-8"?>
2<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
3....
4    <businessProcesses>
5        <fullName>HardwareLeadProcess</fullName>
6        <description>Lead Process for hardware division</description>
7        <isActive>true</isActive>
8        <values>
9            <fullName>Closed - Converted</fullName>
10            <default>false</default>
11        </values>
12        <values>
13            <fullName>CustomLeadStep1</fullName>
14            <default>false</default>
15        </values>
16        <values>
17            <fullName>CustomLeadStep2</fullName>
18            <default>false</default>
19        </values>
20        <values>
21            <fullName>Open - Not Contacted</fullName>
22            <default>false</default>
23        </values>
24        <values>
25            <fullName>Working - Contacted</fullName>
26            <default>true</default>
27        </values>
28    </businessProcesses>
29....
30</CustomObject>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file only when a RecordType is specified. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!