Metadata API Developer Guide
jNewer Version Available
BusinessProcess
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. For more information, see “ Managing Multiple Business Processes ” in the Salesforce online help.
Declarative Metadata 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.
Fields
| Field | Field Type | Description |
|---|---|---|
| description | string | Description for the business process. |
| fullName | string | 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 opportunties, the fullName would be Opportunity.Bulk Orders. |
| isActive | boolean | Indicates if the business process is active (true) or not (false). |
| namespacePrefix | string | The namespace of the developer organization where the package was created. |
| values | PicklistValue[] | A list of picklist values associated with this business process. |
Declarative Metadata Sample Definition
A sample XML definition of a lead business process is shown below.
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>