Metadata API Developer Guide

User Manual:

Open the PDF directly: View PDF .
Page Count: 765 [warning: Documents this large are best viewed by clicking the View PDF Link!]

Getting Started
- Understanding Metadata API
- Quick Start
Using Metadata API
Reference
Appendices
Glossary
Index

Version 39.0, Spring ’17

@salesforcedocs

Last updated: April 17, 2017

as are other names and marks. Other marks appearing herein may be trademarks of their respective owners.

CONTENTS

GETTING STARTED .................................................1

Chapter 1: Understanding Metadata API ...................................1

Supported Salesforce Editions ..............................................1

Development Platforms ..................................................2

Standards Compliance ..................................................2

Metadata API Support Policy ..............................................3

Related Resources .....................................................3

Chapter 2: Quick Start .................................................4

Prerequisites .........................................................4

Step 1: Generate or Obtain the Web Service WSDLs for Your Organization ................4

Step 2: Import the WSDL Files Into Your Development Platform ........................5

Step 3: Walk Through the Java Sample Code ...................................6

USING METADATA API ............................................15

Chapter 3: Declarative (File-Based) Metadata API Calls .......................15

Working with the Zip File ................................................15

Sample package.xml Manifest Files .........................................17

Running Tests in a Deployment ...........................................23

Running a Subset of Tests in a Deployment ...................................24

Run the Same Tests in Sandbox and Production Deployments .......................25

Maintaining User References .............................................25

Chapter 4: CRUD-Based Metadata API Calls ...............................27

Chapter 5: Error Handling .............................................32

Error Handling for Session Expiration .......................................32

REFERENCE ......................................................33

Chapter 6: File-Based Calls ............................................33

deploy() ...........................................................33

Deleting Components from an Organization ...............................41

checkDeployStatus() ...............................................42

cancelDeploy() ...................................................43

deployRecentValidation() ................................................45

retrieve() ...........................................................50

RetrieveRequest ..................................................55

checkRetrieveStatus() ...............................................56

Chapter 7: CRUD-Based Calls ..........................................59

createMetadata() .....................................................59

readMetadata() ......................................................62

updateMetadata() ....................................................63

upsertMetadata() .....................................................66

deleteMetadata() .....................................................68

renameMetadata() ....................................................70

create() ............................................................71

delete() ............................................................73

update() ...........................................................75

Chapter 8: Utility Calls ................................................79

checkStatus() ........................................................79

describeMetadata() ...................................................80

describeValueType() ...................................................81

listMetadata() .......................................................84

ListMetadataQuery ................................................86

Chapter 9: Result Objects .............................................87

AsyncResult ........................................................87

CancelDeployResult ...................................................91

DeployResult ........................................................91

DescribeMetadataResult ................................................98

DescribeValueTypeResult ...............................................99

ReadResult ........................................................100

RetrieveResult .......................................................101

SaveResult .........................................................103

DeleteResult ........................................................103

UpsertResult .......................................................104

Error .............................................................104

Chapter 10: Metadata Types ..........................................106

Metadata Components and Types .........................................117

Unsupported Metadata Types ............................................118

Special Behavior in Metadata API Deployments ................................119

ActionLinkGroupTemplate ..............................................120

AnalyticSnapshot ....................................................124

ArticleType .........................................................127

ArticleType Layout ................................................130

ChannelLayout ..................................................132

ArticleType CustomField ............................................133

ApexClass .........................................................136

ApexComponent ....................................................138

Contents

ApexPage .........................................................139

ApexTestSuite .......................................................141

ApexTrigger ........................................................142

AppMenu .........................................................144

ApprovalProcess ....................................................147

AssignmentRules ....................................................158

AuraDefinitionBundle .................................................160

AuthProvider .......................................................163

AutoResponseRules ..................................................167

CallCenter .........................................................170

CampaignInfluenceModel ..............................................172

Certificate .........................................................173

CleanDataService ....................................................174

Community (Zone) ....................................................179

CommunityTemplateDefinition ...........................................182

CommunityThemeDefinition .............................................186

ConnectedApp ......................................................187

ContentAsset .......................................................196

CorsWhitelistOrigin ...................................................198

CspTrustedSite ......................................................200

CustomApplication ...................................................201

CustomApplicationComponent ..........................................220

CustomFeedFilter ....................................................222

CustomLabels ......................................................224

Custom Metadata Types (CustomObject) ....................................226

CustomMetadata ................................................229

CustomObject ......................................................233

ActionOverride ..................................................244

BusinessProcess .................................................246

CompactLayout .................................................248

CustomField ....................................................250

FieldSet .......................................................261

HistoryRetentionPolicy .............................................262

ListView .......................................................263

NamedFilter ....................................................266

Picklist (Including Dependent Picklist) ...................................269

RecordType ....................................................273

SearchLayouts ..................................................275

SharingReason ..................................................278

SharingRecalculation ..............................................279

ValidationRule ..................................................279

WebLink .......................................................281

Metadata Field Types .............................................285

CustomObjectTranslation ..............................................288

Contents

CustomPageWebLink .................................................297

CustomPermission ...................................................300

CustomSite ........................................................302

CustomTab ........................................................308

CustomValue .......................................................311

Dashboard ........................................................314

DataCategoryGroup ..................................................333

DelegateGroup .....................................................338

Document .........................................................340

DuplicateRule ......................................................342

EclairGeoData ......................................................347

EmailTemplate ......................................................349

EntitlementProcess ...................................................353

EntitlementTemplate ..................................................357

EscalationRules .....................................................358

ExternalDataSource ...................................................361

FlexiPage .........................................................365

Flow .............................................................373

ExternalServiceRegistration ..............................................401

FlowDefinition ......................................................402

Folder ...........................................................403

FolderShare ....................................................405

GlobalPicklist .......................................................407

GlobalPicklistValue ...................................................408

GlobalValueSet ......................................................411

GlobalValueSetTranslation ..............................................413

Group ............................................................414

HomePageComponent ................................................415

HomePageLayout ....................................................417

InstalledPackage ....................................................418

KeywordList ........................................................419

Layout ............................................................421

Letterhead .........................................................441

LiveChatAgentConfig .................................................444

LiveChatButton ......................................................448

LiveChatDeployment ..................................................451

LiveChatSensitiveDataRule ..............................................453

ManagedTopics ....................................................455

MatchingRule ......................................................457

Metadata .........................................................460

MetadataWithContent .................................................461

MilestoneType ......................................................461

ModerationRule .....................................................462

NamedCredential ...................................................466

Contents

Network ..........................................................467

Package ..........................................................480

PathAssistant ......................................................482

PermissionSet ......................................................484

PlatformCachePartition ................................................491

Portal ............................................................493

PostTemplate ......................................................495

Profile ...........................................................496

ProfileActionOverride .................................................509

Queue ............................................................511

QuickAction ........................................................512

RemoteSiteSetting ....................................................517

Report ............................................................519

ReportType ........................................................545

Role .............................................................549

RoleOrTerritory ......................................................550

SamlSsoConfig .....................................................552

Scontrol ..........................................................555

Settings ..........................................................557

AccountSettings .................................................558

ActivitiesSettings .................................................559

AddressSettings .................................................563

BusinessHoursSettings .............................................567

CaseSettings ....................................................571

ChatterAnswersSettings ............................................578

CompanySettings ................................................580

ContractSettings .................................................581

EntitlementSettings ...............................................582

FileUploadAndDownloadSecuritySettings ................................584

ForecastingSettings ...............................................588

IdeasSettings ...................................................598

KnowledgeSettings ...............................................599

LeadConvertSettings ..............................................605

LiveAgentSettings ................................................607

MobileSettings ..................................................607

NameSettings ...................................................610

OpportunitySettings ...............................................611

OrderSettings ...................................................613

OrgPreferenceSettings .............................................614

PathAssistantSettings ..............................................616

PersonalJourneySettings ............................................617

ProductSettings ..................................................617

QuoteSettings ...................................................618

SearchSettings ..................................................619

Contents

SecuritySettings ..................................................622

Territory2Settings ................................................628

SharedTo .........................................................629

SharingBaseRule ....................................................631

SharingRules .......................................................633

BaseSharingRule ................................................639

CriteriaBasedSharingRule ...........................................640

OwnerSharingRule ...............................................646

SharingSet ........................................................652

SiteDotCom ........................................................655

Skill .............................................................656

StandardValueSet ...................................................658

StandardValueSetTranslation ............................................659

StaticResource ......................................................660

SynonymDictionary ...................................................662

Territory ..........................................................664

Territory2 .........................................................665

Territory2Model .....................................................669

Territory2Rule .......................................................671

Territory2Type ......................................................673

TransactionSecurityPolicy ...............................................675

Translations .......................................................677

UserCriteria ........................................................686

WaveApplication ....................................................687

WaveDataflow ......................................................688

WaveDashboard ....................................................689

WaveDataset .......................................................690

WaveLens .........................................................690

WaveTemplateBundle .................................................692

Wavexmd .........................................................693

Workflow .........................................................698

Chapter 11: Headers ................................................714

AllOrNoneHeader ....................................................714

CallOptions ........................................................716

DebuggingHeader ...................................................717

SessionHeader ......................................................719

APPENDICES ....................................................720

Appendix A: CustomObjectTranslation Language Support: Fully Supported

Languages ......................................................720

Contents

Appendix B: CustomObjectTranslation Language Support: End-User

Languages ......................................................726

Appendix C: StandardValueSet Names and Standard Picklist Fields ...733

GLOSSARY ......................................................736

INDEX ..........................................................750

Contents

GETTING STARTED

CHAPTER 1 Understanding Metadata API

Use Metadata API to retrieve, deploy, create, update or delete customization information, such as custom object definitions and page

layouts, for your organization. This API is intended for managing customizations and for building tools that can manage the metadata

model, not the data itself. To create, retrieve, update or delete records, such as accounts or leads, use data SOAP API or REST API.

The easiest way to access the functionality in Metadata API is to use the Force.com IDE or Force.com Migration Tool. Both tools are built

on top of Metadata API and use the standard Eclipse and Ant tools, respectively, to simplify working with Metadata API.

•Force.com IDE is built on the Eclipse platform, for programmers familiar with integrated development environments. Code, compile,

test, and deploy from within the IDE.

•The Force.com Migration Tool is ideal if you use a script or the command line for moving metadata between a local directory and a

Salesforce org.

For more information about the Force.com IDE or Force.com Migration Tool, see developer.salesforce.com.

The underlying calls of Metadata API have been exposed for you to use directly, if you prefer to build your own client applications. This

guide gives you more information about working directly with Metadata API.

You can use the Metadata API to manage setup and customization information (metadata) for your organizations. For example:

•Export the customizations in your organization as XML metadata files. See Working with the Zip File and retrieve().

•Migrate configuration changes between organizations. See deploy() and retrieve().

•Modify existing customizations in your organization using XML metadata files. See deploy() and retrieve().

•Manage customizations in your organization programmatically. See CRUD-Based Metadata Development.

You can modify metadata in test organizations on Developer Edition or sandbox, and then deploy tested changes to production

organizations on Enterprise, Unlimited, or Performance Editions. You can also create scripts to populate a new organization with your

custom objects, custom fields, and other components.

SEE ALSO:

Deploying and Retrieving Metadata

CRUD-Based Metadata Development

Metadata Components and Types

Supported Salesforce Editions

To use Metadata API, your organization must use Enterprise Edition, Unlimited Edition, Performance Edition, or Developer Edition.

If you are an existing Salesforce customer and want to upgrade to Enterprise, Unlimited, or Performance Edition, contact your account

representative.

It is strongly recommended that you use a sandbox, which is an exact replica of your production organization. Enterprise, Unlimited,

and Performance Editions come with free developer sandboxes. For more information, see

http://www.salesforce.com/platform/cloud-infrastructure/sandbox.jsp.

Alternatively, you can use a Developer Edition org, which provides access to all of the features available with Enterprise Edition, but is

limited by the number of users and the amount of storage space. A Developer Edition org isn’t a copy of your production org, but it

provides an environment where you can build and test your solutions without affecting your organization’s data. Developer Edition

accounts are available for free at http://developer.salesforce.com/signup.

Note: A metadata component must be visible in the org for Metadata API to act on it. Also, a user must have the “API Enabled”

permission to have access to metadata components.

Metadata API Access for Professional Edition

ISV partners can request Metadata API access to Professional Edition orgs for apps that have passed the AppExchange Security Review.

Access is granted through an API token (client ID). This special key enables the app to make Metadata API calls to customers’ Professional

Edition orgs.

As an ISV partner, you can request Metadata API access by following these steps.

1. Submit your app for security review. See Steps in the Security Review in the ISVForce Guide.

2. After your app is approved, log a case in the Partner Community in AppExchange and Feature Requests > API Token Request,

and specify SOAP for the type of token.

To make calls to the Metadata API, append the API token to the CallOptions SOAP header in your calls.

Development Platforms

Metadata API supports both file-based and CRUD-based development.

File-Based Development

The declarative or file-based asynchronous Metadata API deploy() and retrieve() operations deploy or retrieve a .zip file

that holds components in a set of folders, and a manifest file named package.xml. For more information, see Deploying and Retrieving

Metadata on page 15. The easiest way to access the file-based functionality is to use the Force.com IDE or Force.com Migration Tool.

CRUD-Based Development

The CRUD Metadata API calls act upon the metadata components in a manner similar to the way synchronous API calls in the enterprise

WSDL act upon objects. For more information about the enterprise WSDL, see the SOAP API Developer's Guide.

Standards Compliance

Metadata API is implemented to comply with the following specifications:

WebsiteStandard Name

http://www.w3.org/TR/2000/NOTE-SOAP-20000508/Simple Object Access Protocol (SOAP) 1.1

http://www.w3.org/TR/2001/NOTE-wsdl-20010315Web Service Description Language (WSDL)

1.1

http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.htmlWS-I Basic Profile 1.1

Development PlatformsUnderstanding Metadata API

Metadata API Support Policy

Salesforce supports previous versions of Metadata API. However, your new client applications should use the most recent version of the

Force.com Metadata API WSDL file to fully exploit the benefits of richer features and greater efficiency.

Backward Compatibility

Salesforce strives to make backward compatibility easy when using the Force.com platform.

Each new Salesforce release consists of two components:

•A new release of platform software that resides on Salesforce systems

•A new version of the API

For example, the Spring '07 release included API version 9.0 and the Summer '07 release included API version 10.0.

We maintain support for each API version across releases of the platform software. The API is backward compatible in that an application

created to work with a given API version will continue to work with that same API version in future platform software releases.

Salesforce does not guarantee that an application written against one API version will work with future API versions: Changes in method

signatures and data representations are often required as we continue to enhance the API. However, we strive to keep the API consistent

from version to version with minimal, if any, changes required to port applications to newer API versions.

For example, an application written using API version 9.0, which shipped with the Spring ’07 release, will continue to work with API

version 9.0 on the Summer ’07 release, and on future releases beyond that. However, that same application might not work with API

version 10.0 without modifications to the application.

API End-of-Life

Salesforce is committed to supporting each API version for a minimum of three years from the date of first release. In order to mature

and improve the quality and performance of the API, versions that are more than three years old might cease to be supported.

When an API version is to be deprecated, advance notice is given at least one year before support ends. Salesforce will directly notify

customers using API versions planned for deprecation.

Related Resources

The Salesforce developer website provides a full suite of developer toolkits, sample code, sample SOAP messages, community-based

support, and other resources to help you with your development projects. Be sure to visit

https://developer.salesforce.com/page/Getting_Started for more information, or visit

http://developer.salesforce.com/signup to sign up for a free Developer Edition account.

You can visit these websites to find out more about Salesforce applications:

•Salesforce Developers provides a wealth of information for developers.

•Salesforce for information about the Salesforce application.

•Force.com AppExchange for access to apps created for Salesforce.

•Salesforce.com Community for services to ensure Salesforce customer success.

Metadata API Support PolicyUnderstanding Metadata API

CHAPTER 2 Quick Start

Use Metadata API to retrieve, deploy, create, update, or delete customizations for your org. The most common use is to migrate changes

from a sandbox or testing org to your production environment. Metadata API is intended for managing customizations and for building

tools that can manage the metadata model, not the data itself.

However, the underlying calls of Metadata API have been exposed for you to use directly, if you prefer to build your own client applications.

This quick start gives you all the information you need to start writing applications that directly use Metadata API to manage customizations

for your organization. It shows you how to get started with File-Based Development. For an example of CRUD-Based Development, see

Java Sample for CRUD-Based Development with Synchronous Calls.

Prerequisites

Make sure you complete these prerequisites before you start using Metadata API.

•Create a development environment.

It is strongly recommended that you use a sandbox, which is an exact replica of your production organization. Enterprise, Unlimited,

and Performance Editions come with free developer sandboxes. For more information, see

http://www.salesforce.com/platform/cloud-infrastructure/sandbox.jsp.

Alternatively, you can use a Developer Edition org, which provides access to all of the features available with Enterprise Edition, but

is limited by the number of users and the amount of storage space. A Developer Edition org isn’t a copy of your production org, but

it provides an environment where you can build and test your solutions without affecting your organization’s data. Developer Edition

accounts are available for free at http://developer.salesforce.com/signup.

•Identify a user that has the “API Enabled” and “Modify All Data” permissions. These permissions are required to access Metadata API

calls.

•Install a SOAP client. Metadata API works with current SOAP development environments, including, but not limited to, Visual Studio®

.NET and the Force.com Web Service Connector (WSC).

In this document, we provide Java examples based on WSC and JDK 6 (Java Platform Standard Edition Development Kit 6). To run

the samples, first download the latest force-wsc JAR file and its dependencies (dependencies are listed on the page when you select

a version) from mvnrepository.com/artifact/com.force.api/force-wsc/.

Note: Development platforms vary in their SOAP implementations. Implementation differences in certain development

platforms might prevent access to some or all of the features in Metadata API.

Step 1: Generate or Obtain the Web Service WSDLs for Your

Organization

To access Metadata API calls, you need a Web Service Description Language (WSDL) file. The WSDL file defines the Web service that is

available to you. Your development platform uses this WSDL to generate stub code to access the Web service it defines. You can either

obtain the WSDL file from your organization’s Salesforce administrator, or you can generate it yourself if you have access to the WSDL

download page in the Salesforce user interface. For more information about WSDL, see http://www.w3.org/TR/wsdl.

Before you can access Metadata API calls, you must authenticate to use the Web service using the login() call, which is defined in

the enterprise WSDL and the partner WSDL. Therefore, you must also obtain one of these WSDLs.

Any user with the “Modify All Data” permission can download the WSDL file to integrate and extend the Salesforce platform. (The System

Administrator profile has this permission.)

The sample code in Step 3: Walk Through the Java Sample Code on page 6 uses the enterprise WSDL, though the partner WSDL works

equally well.

To generate the metadata and enterprise WSDL files for your organization:

1. Log in to your Salesforce account. You must log in as an administrator or as a user who has the “Modify All Data” permission.

2. From Setup, enter API in the Quick Find box, then select API.

3. Click Generate Metadata WSDL and save the XML WSDL file to your file system.

4. Click Generate Enterprise WSDL and save the XML WSDL file to your file system.

Step 2: Import the WSDL Files Into Your Development Platform

Once you have the WSDL files, import them into your development platform so that your development environment can generate the

necessary objects for use in building client Web service applications. This section provides sample instructions for WSC. For instructions

about other development platforms, see your platform’s product documentation.

Note: The process for importing WSDL files is identical for the metadata and enterprise WSDL files.

Instructions for Java Environments (WSC)

Java environments access the API through Java objects that serve as proxies for their server-side counterparts. Before using the API, you

must first generate these objects from your organization’s WSDL file.

Each SOAP client has its own tool for this process. For WSC, use the wsdlc utility.

Note: Before you run wsdlc, you must have the WSC JAR file installed on your system and referenced in your classpath. You

can download the latest force-wsc JAR file and its dependencies (dependencies are listed on the page when you select a version)

from mvnrepository.com/artifact/com.force.api/force-wsc/.

The basic syntax for wsdlc is:

java -classpath pathToWsc;pathToWscDependencies com.sforce.ws.tools.wsdlc

pathToWsdl/WsdlFilename pathToOutputJar/OutputJarFilename

For example, on Windows:

java –classpath force-wsc-30.0.0.jar;ST4-4.0.7.jar;antlr-runtime-3.5.jar

com.sforce.ws.tools.wsdlc metadata.wsdl metadata.jar

On Mac OS X and Unix, use a colon instead of a semicolon in between items in the classpath:

java –classpath force-wsc-30.0.0.jar:ST4-4.0.7.jar:antlr-runtime-3.5.jar

com.sforce.ws.tools.wsdlc metadata.wsdl metadata.jar

wsdlc generates a JAR file and Java source code and bytecode files for use in creating client applications. Repeat this process for the

enterprise WSDL to create an enterprise.JAR file.

Step 2: Import the WSDL Files Into Your Development PlatformQuick Start

Step 3: Walk Through the Java Sample Code

When you have imported the WSDL files, you can build client applications that use Metadata API. The sample is a good starting point

for writing your own code.

Before you run the sample, modify your project and the code to:

1. Include the WSC JAR, its dependencies, and the JAR files you generated from the WSDLs.

Note: Although WSC has other dependencies, the following sample only requires Rhino (js-1.7R2.jar), which you can

download from mvnrepository.com/artifact/rhino/js.

2. Update USERNAME and PASSWORD variables in the MetadataLoginUtil.login() method with your user name and

password. If your current IP address isn’t in your organization's trusted IP range, you'll need to append a security token to the password.

3. If you are using a sandbox, be sure to change the login URL.

Java users can use ConnectorConfig to connect to Enterprise, Partner, and Metadata SOAP API. MetadataLoginUtil creates

a ConnectorConfig object and logs in using the Enterprise WSDL login method. Then it retrieves sessionId and

metadataServerUrl to create a ConnectorConfig and connects to Metadata API endpoint. ConnectorConfig is

defined in WSC.

The MetadataLoginUtil class abstracts the login code from the other parts of the sample, allowing portions of this code to be

reused without change across different Salesforce APIs.

import com.sforce.soap.enterprise.EnterpriseConnection;

import com.sforce.soap.enterprise.LoginResult;

import com.sforce.soap.metadata.MetadataConnection;

import com.sforce.ws.ConnectionException;

import com.sforce.ws.ConnectorConfig;

/**

* Login utility.

public class MetadataLoginUtil {

public static MetadataConnection login() throws ConnectionException {

final String USERNAME = "user@company.com";

// This is only a sample. Hard coding passwords in source files is a bad practice.

final String PASSWORD = "password";

final String URL = "https://login.salesforce.com/services/Soap/c/39.0";

final LoginResult loginResult = loginToSalesforce(USERNAME, PASSWORD, URL);

return createMetadataConnection(loginResult);

}

private static MetadataConnection createMetadataConnection(

final LoginResult loginResult) throws ConnectionException {

final ConnectorConfig config = new ConnectorConfig();

config.setServiceEndpoint(loginResult.getMetadataServerUrl());

config.setSessionId(loginResult.getSessionId());

return new MetadataConnection(config);

}

Step 3: Walk Through the Java Sample CodeQuick Start

private static LoginResult loginToSalesforce(

final String username,

final String password,

final String loginUrl) throws ConnectionException {

final ConnectorConfig config = new ConnectorConfig();

config.setAuthEndpoint(loginUrl);

config.setServiceEndpoint(loginUrl);

config.setManualLogin(true);

return (new EnterpriseConnection(config)).login(username, password);

}

Note: This example uses user and password authentication to obtain a session ID, which is then used for making calls to Metadata

API. Alternatively, you can use OAuth authentication. After you athenticate with OAuth to Salesforce, pass the returned access

token instead of the session ID. For example, pass the access token to the setSessionId() call on ConnectorConfig.

To learn how to use OAuth authentication in Salesforce, see Authenticating Apps with OAuth in the Salesforce Help.

Java Sample Code for File-Based Development

The sample code logs in using the login utility. Then it displays a menu with retrieve, deploy, and exit.

The retrieve() and deploy() calls both operate on a .zip file named components.zip. The retrieve() call retrieves

components from your organization into components.zip, and the deploy() call deploys the components in

components.zip to your organization. If you save the sample to your computer and execute it, run the retrieve option first so that

you have a components.zip file that you can subsequently deploy. After a retrieve call, the sample calls

checkRetrieveStatus() in a loop until the operation is completed. Similarly, after a deploy call, the sample checks

checkDeployStatus() in a loop until the operation is completed.

The retrieve() call uses a manifest file to determine the components to retrieve from your organization. A sample package.xml

manifest file follows. For more details on the manifest file structure, see Working with the Zip File. For this sample, the manifest file

retrieves all custom objects, custom tabs, and page layouts.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>CustomObject</name>

</types>

<types>

<name>CustomTab</name>

</types>

<types>

<name>Layout</name>

</types>

</Package>

Note the error handling code that follows each API call.

Step 3: Walk Through the Java Sample CodeQuick Start

Note: This sample requires API version 34.0 or later.

import java.io.*;

import java.nio.channels.Channels;

import java.nio.channels.FileChannel;

import java.nio.channels.ReadableByteChannel;

import java.rmi.RemoteException;

import java.util.*;

import javax.xml.parsers.*;

import org.w3c.dom.*;

import org.xml.sax.SAXException;

import com.sforce.soap.metadata.*;

/**

* Sample that logs in and shows a menu of retrieve and deploy metadata options.

public class FileBasedDeployAndRetrieve {

private MetadataConnection metadataConnection;

private static final String ZIP_FILE = "components.zip";

// manifest file that controls which components get retrieved

private static final String MANIFEST_FILE = "package.xml";

private static final double API_VERSION = 29.0;

// one second in milliseconds

private static final long ONE_SECOND = 1000;

// maximum number of attempts to deploy the zip file

private static final int MAX_NUM_POLL_REQUESTS = 50;

private BufferedReader reader = new BufferedReader(new InputStreamReader(System.in));

public static void main(String[] args) throws Exception {

FileBasedDeployAndRetrieve sample = new FileBasedDeployAndRetrieve();

sample.run();

}

public FileBasedDeployAndRetrieve() {

}

private void run() throws Exception {

this.metadataConnection = MetadataLoginUtil.login();

// Show the options to retrieve or deploy until user exits

String choice = getUsersChoice();

while (choice != null && !choice.equals("99")) {

if (choice.equals("1")) {

Step 3: Walk Through the Java Sample CodeQuick Start

retrieveZip();

}else if (choice.equals("2")) {

deployZip();

}else {

break;

}

// show the options again

choice = getUsersChoice();

}

* Utility method to present options to retrieve or deploy.

private String getUsersChoice() throws IOException {

System.out.println(" 1: Retrieve");

System.out.println(" 2: Deploy");

System.out.println("99: Exit");

System.out.println();

System.out.print("Enter 1 to retrieve, 2 to deploy, or 99 to exit: ");

// wait for the user input.

String choice = reader.readLine();

return choice != null ? choice.trim() : "";

}

private void deployZip() throws Exception {

byte zipBytes[] = readZipFile();

DeployOptions deployOptions = new DeployOptions();

deployOptions.setPerformRetrieve(false);

deployOptions.setRollbackOnError(true);

AsyncResult asyncResult = metadataConnection.deploy(zipBytes, deployOptions);

DeployResult result = waitForDeployCompletion(asyncResult.getId());

if (!result.isSuccess()) {

printErrors(result, "Final list of failures:\n");

throw new Exception("The files were not successfully deployed");

}

System.out.println("The file " + ZIP_FILE + " was successfully deployed\n");

}

* Read the zip file contents into a byte array.

private byte[] readZipFile() throws Exception {

byte[] result = null;

// We assume here that you have a deploy.zip file.

// See the retrieve sample for how to retrieve a zip file.

File zipFile = new File(ZIP_FILE);

if (!zipFile.exists() || !zipFile.isFile()) {

throw new Exception("Cannot find the zip file for deploy() on path:"

+ zipFile.getAbsolutePath());

}

FileInputStream fileInputStream = new FileInputStream(zipFile);

try {

Step 3: Walk Through the Java Sample CodeQuick Start

ByteArrayOutputStream bos = new ByteArrayOutputStream();

byte[] buffer = new byte[4096];

int bytesRead = 0;

while (-1 != (bytesRead = fileInputStream.read(buffer))) {

bos.write(buffer, 0, bytesRead);

}

result = bos.toByteArray();

}finally {

fileInputStream.close();

}

return result;

}

* Print out any errors, if any, related to the deploy.

* @param result - DeployResult

private void printErrors(DeployResult result, String messageHeader) {

DeployDetails details = result.getDetails();

StringBuilder stringBuilder = new StringBuilder();

if (details != null) {

DeployMessage[] componentFailures = details.getComponentFailures();

for (DeployMessage failure : componentFailures) {

String loc = "(" + failure.getLineNumber() + ", " +

failure.getColumnNumber();

if (loc.length() == 0 &&

!failure.getFileName().equals(failure.getFullName()))

{

loc = "(" + failure.getFullName() + ")";

}

stringBuilder.append(failure.getFileName() + loc + ":"

+ failure.getProblem()).append('\n');

}

RunTestsResult rtr = details.getRunTestResult();

if (rtr.getFailures() != null) {

for (RunTestFailure failure : rtr.getFailures()) {

String n = (failure.getNamespace() == null ?"" :

(failure.getNamespace() + ".")) + failure.getName();

stringBuilder.append("Test failure, method: " +n+"." +

failure.getMethodName() + " -- " + failure.getMessage() +

" stack " + failure.getStackTrace() + "\n\n");

}

if (rtr.getCodeCoverageWarnings() != null) {

for (CodeCoverageWarning ccw : rtr.getCodeCoverageWarnings()) {

stringBuilder.append("Code coverage issue");

if (ccw.getName() != null) {

String n = (ccw.getNamespace() == null ?"" :

(ccw.getNamespace() + ".")) + ccw.getName();

stringBuilder.append(", class: " + n);

}

stringBuilder.append(" -- " + ccw.getMessage() + "\n");

}

Step 3: Walk Through the Java Sample CodeQuick Start

}

if (stringBuilder.length() > 0) {

stringBuilder.insert(0, messageHeader);

System.out.println(stringBuilder.toString());

}

private void retrieveZip() throws Exception {

RetrieveRequest retrieveRequest = new RetrieveRequest();

// The version in package.xml overrides the version in RetrieveRequest

retrieveRequest.setApiVersion(API_VERSION);

setUnpackaged(retrieveRequest);

AsyncResult asyncResult = metadataConnection.retrieve(retrieveRequest);

RetrieveResult result = waitForRetrieveCompletion(asyncResult);

if (result.getStatus() == RetrieveStatus.Failed) {

throw new Exception(result.getErrorStatusCode() + " msg: " +

result.getErrorMessage());

}else if (result.getStatus() == RetrieveStatus.Succeeded) {

// Print out any warning messages

StringBuilder stringBuilder = new StringBuilder();

if (result.getMessages() != null) {

for (RetrieveMessage rm : result.getMessages()) {

stringBuilder.append(rm.getFileName() + "-"+ rm.getProblem() + "\n");

}

if (stringBuilder.length() > 0) {

System.out.println("Retrieve warnings:\n" + stringBuilder);

}

System.out.println("Writing results to zip file");

File resultsFile = new File(ZIP_FILE);

FileOutputStream os = new FileOutputStream(resultsFile);

try {

os.write(result.getZipFile());

}finally {

os.close();

}

private DeployResult waitForDeployCompletion(String asyncResultId) throws Exception {

int poll = 0;

long waitTimeMilliSecs = ONE_SECOND;

DeployResult deployResult;

boolean fetchDetails;

do {

Thread.sleep(waitTimeMilliSecs);

Step 3: Walk Through the Java Sample CodeQuick Start

// double the wait time for the next iteration

waitTimeMilliSecs *= 2;

if (poll++ > MAX_NUM_POLL_REQUESTS) {

throw new Exception(

"Request timed out. If this is a large set of metadata components, "

"ensure that MAX_NUM_POLL_REQUESTS is sufficient.");

}

// Fetch in-progress details once for every 3 polls

fetchDetails = (poll % 3 == 0);

deployResult = metadataConnection.checkDeployStatus(asyncResultId, fetchDetails);

System.out.println("Status is: " + deployResult.getStatus());

if (!deployResult.isDone() && fetchDetails) {

printErrors(deployResult, "Failures for deployment in progress:\n");

}

while (!deployResult.isDone());

if (!deployResult.isSuccess() && deployResult.getErrorStatusCode() != null) {

throw new Exception(deployResult.getErrorStatusCode() + " msg: " +

deployResult.getErrorMessage());

}

if (!fetchDetails) {

// Get the final result with details if we didn't do it in the last attempt.

deployResult = metadataConnection.checkDeployStatus(asyncResultId, true);

}

return deployResult;

}

private RetrieveResult waitForRetrieveCompletion(AsyncResult asyncResult) throws

Exception {

// Wait for the retrieve to complete

int poll = 0;

long waitTimeMilliSecs = ONE_SECOND;

String asyncResultId = asyncResult.getId();

RetrieveResult result = null;

do {

Thread.sleep(waitTimeMilliSecs);

// Double the wait time for the next iteration

waitTimeMilliSecs *= 2;

if (poll++ > MAX_NUM_POLL_REQUESTS) {

throw new Exception("Request timed out. If this is a large set " +

"of metadata components, check that the time allowed " +

"by MAX_NUM_POLL_REQUESTS is sufficient.");

}

result = metadataConnection.checkRetrieveStatus(

asyncResultId, true);

System.out.println("Retrieve Status: " + result.getStatus());

}while (!result.isDone());

Step 3: Walk Through the Java Sample CodeQuick Start

return result;

}

private void setUnpackaged(RetrieveRequest request) throws Exception {

// Edit the path, if necessary, if your package.xml file is located elsewhere

File unpackedManifest = new File(MANIFEST_FILE);

System.out.println("Manifest file: " + unpackedManifest.getAbsolutePath());

if (!unpackedManifest.exists() || !unpackedManifest.isFile()) {

throw new Exception("Should provide a valid retrieve manifest " +

"for unpackaged content. Looking for " +

unpackedManifest.getAbsolutePath());

}

// Note that we use the fully quualified class name because

// of a collision with the java.lang.Package class

com.sforce.soap.metadata.Package p = parsePackageManifest(unpackedManifest);

request.setUnpackaged(p);

}

private com.sforce.soap.metadata.Package parsePackageManifest(File file)

throws ParserConfigurationException, IOException, SAXException {

com.sforce.soap.metadata.Package packageManifest = null;

List<PackageTypeMembers> listPackageTypes = new ArrayList<PackageTypeMembers>();

DocumentBuilder db =

DocumentBuilderFactory.newInstance().newDocumentBuilder();

InputStream inputStream = new FileInputStream(file);

Element d = db.parse(inputStream).getDocumentElement();

for (Node c = d.getFirstChild(); c != null; c = c.getNextSibling()) {

if (c instanceof Element) {

Element ce = (Element) c;

NodeList nodeList = ce.getElementsByTagName("name");

if (nodeList.getLength() == 0) {

continue;

}

String name = nodeList.item(0).getTextContent();

NodeList m = ce.getElementsByTagName("members");

List<String> members = new ArrayList<String>();

for (int i = 0; i < m.getLength(); i++) {

Node mm = m.item(i);

members.add(mm.getTextContent());

}

PackageTypeMembers packageTypes = new PackageTypeMembers();

packageTypes.setName(name);

packageTypes.setMembers(members.toArray(new String[members.size()]));

listPackageTypes.add(packageTypes);

}

packageManifest = new com.sforce.soap.metadata.Package();

PackageTypeMembers[] packageTypesArray =

new PackageTypeMembers[listPackageTypes.size()];

packageManifest.setTypes(listPackageTypes.toArray(packageTypesArray));

packageManifest.setVersion(API_VERSION + "");

Step 3: Walk Through the Java Sample CodeQuick Start

return packageManifest;

}

Step 3: Walk Through the Java Sample CodeQuick Start

USING METADATA API

CHAPTER 3 Deploying and Retrieving Metadata

Use the deploy() and retrieve() calls to move metadata (XML files) between a Salesforce organization and a local file system.

Once you retrieve your XML files into a file system, you can manage changes in a source-code control system, copy and paste code or

setup configurations, diff changes to components, and perform many other file-based development operations. At any time you can

deploy those changes to another Salesforce organization.

Note: The Force.com IDE and the Force.com Migration Tool use the deploy() and retrieve() calls to move metadata. If

you use these tools, interaction with Metadata API is seamless and invisible. Therefore, most developers will find it much easier to

use these tools than write code that calls deploy() and retrieve() directly.

Data in XML files is formatted using the English (United States) locale. This ensures that fields that depend on locale, such as date fields,

are interpreted consistently during data migrations between organizations using different languages. Organizations can support multiple

languages for presentation to their users.

The deploy() and retrieve() calls are used primarily for the following development scenarios:

•Development of a custom application (or customization) in a sandbox organization. After development and testing is completed,

the application or customization is then deployed into a production organization using Metadata API.

•Team development of an application in a Developer Edition organization. After development and testing is completed, you can then

distribute the application via Force.com AppExchange.

SEE ALSO:

Metadata Components and Types

Unsupported Metadata Types

Working with the Zip File

The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest

(package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.

Note: A component is an instance of a metadata type. For example, CustomObject is a metadata type for custom objects,

and the MyCustomObject__c component is an instance of a custom object.

The files that are retrieved or deployed in a .zip file might be unpackaged components that reside in your organization (such as standard

objects) or packaged components that reside within named packages.

Note: You can deploy or retrieve up to 10,000 files at once and the maximum size of the deployed or retrieved .zip file is 39 MB.

Note the following:

•If using the Force.com Migration Tool to deploy an unzipped folder, all files in the folder are compressed first. The maximum

size of uncompressed components in an unzipped folder is 400 MB or less depending on the compression ratio. If the files

have a high compression ratio, you can migrate a total of approximately 400 MB because the compressed size would be under

39 MB. However, if the components can't be compressed much, like binary static resources, you can migrate less than 400 MB.

•Metadata API base-64 encodes components after they’re compressed. The resulting .zip file can't exceed 50 MB, which is the

limit for SOAP messages. Base-64 encoding increases the size of the payload, so your compressed payload can't exceed

approximately 39 MB before encoding.

Every .zip file contains a project manifest, a file that’s named package.xml, and a set of directories that contain the components.

The manifest file defines the components that you’re trying to retrieve or deploy in the .zip file and the API version that’s used for the

deployment or retrieval.

The following is a sample package.xml file. Note that you can retrieve an individual component for a metadata type by specifying

its fullName field value in a members element, or you can also retrieve all components of a metadata type by using

<members>*</members>.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>MyCustomObject__c</members>

<name>CustomObject</name>

</types>

<types>

<name>CustomTab</name>

</types>

<types>

<members>Standard</members>

<name>Profile</name>

</types>

</Package>

The following elements can be defined in package.xml.

•<fullName> contains the name of the server-side package. If no <fullName> exists, this is a client-side unpackaged

package.

•<types> contains the name of the metadata type (for example, CustomObject) and the named members (for example,

myCustomObject__c) to be retrieved or deployed. You can add multiple <types> elements in a manifest file.

•<members> contains the fullName of the component, for example MyCustomObject__c. The listMetadata()

call is useful for determining the fullName for components of a particular metadata type, if you want to retrieve an individual

component. For many metadata types, you can replace the value in members with the wildcard character * (asterisk) instead of

listing each member separately. For a list of metadata types that allow the wildcard character, see the “Allows Wildcard (*)?” column

in Metadata Types.

Note: You specify Security in the <members> element and Settings in the name element when retrieving the SecuritySettings

component type.

•<name> contains the metadata type, for example CustomObject or Profile. There is one name defined for each metadata

type in the directory. Any metadata type that extends Metadata is a valid value. The name that’s entered must match a metadata

type that’s defined in the Metadata API WSDL. See Metadata Types for a list.

•<version> is the API version number that’s used when the .zip file is deployed or retrieved. Currently the valid value is 39.0.

For more sample package.xml manifest files that show you how to work with different subsets of metadata, see Sample

package.xml Manifest Files.

Working with the Zip FileDeploying and Retrieving Metadata

To delete components, see Deleting Components from an Organization.

SEE ALSO:

Metadata Types

Sample package.xml Manifest Files

This section includes sample package.xml manifest files that show you how to work with different subsets of metadata. A manifest

file can include multiple <types> elements so you could combine the individual samples into one package.xml manifest file if

you want to work with all the metadata in one batch. For more information about the structure of a manifest file, see Working with the

Zip File. The following samples are listed:

•Standard Objects

•All Custom Objects

•Standard Picklist Fields

•Custom and Standard Fields

•List Views for Standard Objects

•Packages

•Security Settings

•Assignment Rules, Auto-response Rules, Escalation Rules

•Sharing Rules

•Managed Component Access

Standard Objects

This sample package.xml manifest file illustrates how to work with the standard Account object. Retrieving or deploying a standard

object includes all custom and standard fields except for standard fields that aren’t customizable. All custom fields are supported. Only

standard fields that you can customize are supported, that is, standard fields to which you can add help text or enable history tracking

or Chatter feed tracking. Other standard fields aren't supported, including system fields (such as CreatedById or

LastModifiedDate) and autonumber fields.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Account</members>

<name>CustomObject</name>

</types>

</Package>

Note how you work with the standard Account object by specifying it as a member of a CustomObject type. However, you cannot use

an asterisk wildcard to work with all standard objects; each standard object must be specified by name.

Sample package.xml Manifest FilesDeploying and Retrieving Metadata

All Custom Objects

This sample package.xml manifest file illustrates how to work with all custom objects.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>CustomObject</name>

</types>

</Package>

This manifest file can be used to retrieve or deploy all custom objects. This does not include all standard objects.

Standard Picklist Fields

In API version 38.0 and later, the StandardValueSet type represents standard picklists. Picklists are no longer represented by fields as in

earlier versions. This sample package.xml represents the Industry standard picklist as a StandardValueSet type.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Industry</members>

<name>StandardValueSet</name>

</types>

</Package>

Note: The name of a standard value set is case-sensitive.

The Industry standard value set corresponds to the Account.Industry or Lead.Industry field in API version 37.0 and

earlier. This example shows a package.xml sample for the Account.Industry picklist.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Account.Industry</members>

<name>CustomField</name>

</types>

</Package>

Note: The name of a picklist field is case-sensitive.

Note the objectName.picklistField syntax in the <members> field where objectName is the name of the object, such

as Account, and picklistField is the name of the standard picklist field, such as Industry.

This next package.xml sample represents opportunity team roles in API version 38.0 and later. Specify opportunity team roles as a

SalesTeamRole standard value set. Opportunity team roles have the same picklist values as the account team roles.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>SalesTeamRole</members>

Sample package.xml Manifest FilesDeploying and Retrieving Metadata

<name>StandardValueSet</name>

</types>

</Package>

The SalesTeamRole standard value set corresponds to one of these field names in API version 37.0 and earlier:

OpportunityTeamMember.TeamMemberRole, UserAccountTeamMember.TeamMemberRole,

UserTeamMember.TeamMemberRole, and AccountTeamMember.TeamMemberRole. Opportunity team roles are

represented in this sample package.xml as the OpportunityTeamMember.TeamMemberRole field.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>OpportunityTeamMember.TeamMemberRole</members>

<name>CustomField</name>

</types>

</Package>

To learn about the names of standard value sets and how they map to picklist field names, see StandardValueSet Names and Standard

Picklist Fields.

Custom and Standard Fields

This sample package.xml manifest file illustrates how to work with custom fields in custom and standard objects and standard

fields in a standard object.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>MyCustomObject__c.MyCustomField__c</members>

<name>CustomField</name>

</types>

<types>

<members>Account.SLA__c</members>

<members>Account.Phone</members>

<name>CustomField</name>

</types>

</Package>

Note the objectName.field syntax in the <members> field where objectName is the name of the object, such as Account,

and field is the name of the custom or standard field, such as an SLA picklist field representing a service-level agreement option.

The MyCustomField custom field in the MyCustomObject custom object is uniquely identified by its full name,

MyCustomObject__c.MyCustomField__c. Similarly, the Phone standard field in the Account standard object is uniquely

identified by its full name, Account.Phone.

All custom fields are supported. Only standard fields that you can customize are supported, that is, standard fields to which you can add

help text or enable history tracking or Chatter feed tracking. Other standard fields aren't supported, including system fields (such as

CreatedById or LastModifiedDate) and autonumber fields.

Sample package.xml Manifest FilesDeploying and Retrieving Metadata

List Views for Standard Objects

The easiest way to retrieve list views for a standard object is to retrieve the object. The list views are included in the retrieved component.

See Standard Objects on page 17.

You can also work with individual list views if you do not want to retrieve all the details for the object. This sample package.xml

manifest file illustrates how to work with a list view for the standard Account object.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Account.AccountTeam</members>

<name>ListView</name>

</types>

</Package>

Note the objectName.listViewUniqueName syntax in the <members> field where objectName is the name of the

object, such as Account, and listViewUniqueName is the View Unique Name for the list view. If you retrieve this list view,

the component is stored in objects/Account.object.

Packages

To retrieve a package, set the name of the package in the packageNames field in RetrieveRequest when you call retrieve().

The package.xml manifest file is automatically populated in the retrieved .zip file. The <fullName> element in package.xml

contains the name of the retrieved package.

If you use an asterisk wildcard in a <members> element to retrieve all the components of a particular metadata type, the retrieved

contents do not include components in managed packages. For more information about managed packages, see the ISVforce Guide.

The easiest way to retrieve a component in a managed package is to retrieve the complete package by setting the name of the package

in the packageNames field in RetrieveRequest, as described above. The following sample package.xml manifest file illustrates

an alternative to retrieve an individual component in a package.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>myns__MyCustomObject__c</members>

<name>CustomObject</name>

</types>

</Package>

Note the namespacePrefix__objectName syntax in the <members> field where namespacePrefix is the namespace

prefix of the package and objectName is the name of the object. A namespace prefix is a 1 to 15-character alphanumeric identifier

that distinguishes your package and its contents from other publishers’ packages. For more information, see “Register a Namespace

Prefix” in the Salesforce Help.

Sample package.xml Manifest FilesDeploying and Retrieving Metadata

Security Settings

This sample package.xml manifest file illustrates how to work with an organization’s security settings. You specify Security in the

<members> element and Settings in the name element when retrieving the SecuritySettings component type.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Security</members>

<name>Settings</name>

</types>

</Package>

Assignment Rules, Auto-response Rules, Escalation Rules

Assignment rules, auto-response rules and escalation rules use different package.xml type names to access sets of rules or individual

rules for object types. For example, the following sample package.xml manifest file illustrates how to access an organization’s

assignment rules for just Cases and Leads.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>AssignmentRules</name>

</types>

</Package>

The following sample package.xml manifest file illustrates how to access just the “samplerule” Case assignment rule and the

“newrule” Lead assignment rule. Notice that the type name is AssignmentRule and not AssignmentRules.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Case.samplerule</members>

<members>Lead.newrule</members>

<name>AssignmentRule</name>

</types>

</Package>

Similarly, for accessing individual auto-response rules and escalation rules, use AutoResponseRule and EscalationRule

instead of AutoResponseRules and EscalationRules.

Sharing Rules

In API version 33.0 and later, you can retrieve and deploy sharing rules for all standard and custom objects. This sample package.xml

manifest file illustrates how to work with an organization’s sharing rules, which includes retrieving a specific criteria-based sharing rule

Sample package.xml Manifest FilesDeploying and Retrieving Metadata

for the lead object, retrieving all ownership-based sharing rules for all objects, and retrieving all territory-based sharing rules for the

account object.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Lead.testShareRule</members>

<name>SharingCriteriaRule</name>

</types>

<types>

<name>SharingOwnerRule</name>

</types>

<types>

<members>Account.*</members>

<name>SharingTerritoryRule</name>

</types>

</Package>

Managed Component Access

In API version 29.0 and later, you can retrieve and deploy access settings for the following managed components in profiles and permission

sets:

•Apex classes

•Apps

•Custom field permissions

•Custom object permissions

•Custom tab settings

•External data sources

•Record types

•Visualforce pages

When retrieving and deploying managed component permissions, specify the namespace followed by two underscores. Wildcards are

not supported.

For example, let’s say you install a managed package with the namespace MyNamespace and the custom object JobRequest__c.

To set object permissions for JobRequest__c in the package to the custom profile MyProfile, you would add the following to the

.profile file.

To deploy:

<viewAllRecords>false</viewAllRecords>

<modifyAllRecords>false</modifyAllRecords>

</objectPermissions>

Sample package.xml Manifest FilesDeploying and Retrieving Metadata

To retrieve:

<types>

<members>MyNamespace__JobRequest__c</members>

<name>CustomObject</name>

</types>

<types>

<members>MyProfile</members>

<name>Profile</name>

</types>

When retrieving permission sets and profiles, make sure that you also retrieve any components that are related to the permissions and

settings. For example, when retrieving app visibilities, you must also retrieve the associated app, and when retrieving object or field

permissions, you must also retrieve the associated object.

Running Tests in a Deployment

Default Test Execution in Production

When no test level is specified in the deployment options, the default test execution behavior depends on the contents of your deployment

package. When deploying to production, all tests, except those that originate from managed packages, are executed if your deployment

package contains Apex classes or triggers. If your package doesn’t contain Apex components, no tests are run by default.

In API version 33.0 and earlier, tests were run for components that required tests, such as custom objects, and not only for Apex

components. For example, if your package contains a custom object, all tests are run in API version 33.0 and earlier. In contrast, starting

with API version 34.0, no tests are run for this package. The API version corresponds to the version of your API client or the version of the

tool you’re using (Force.com Migration Tool).

You can run tests for a deployment of non-Apex components. You can override the default test execution behavior by setting the test

level in your deployment options. Test levels are enforced regardless of the types of components present in your deployment package.

We recommend that you run all local tests in your development environment, such as sandbox, before deploying to production. Running

tests in your development environment reduces the number of tests needed to run in a production deployment.

Default Test Execution in Production for API Version 33.0 and Earlier

For deployment to a production organization, all local tests in your organization are run by default. Tests that originate from installed

managed packages aren’t run by default. If any test fails, the entire deployment is rolled back.

If the deployment includes components for the following metadata types, all local tests are run.

•ApexClass

•ApexComponent

•ApexPage

•ApexTrigger

•ArticleType

•BaseSharingRule

•CriteriaBasedSharingRule

•CustomDataType

•CustomField

•CustomObject

Running Tests in a DeploymentDeploying and Retrieving Metadata

•DataCategoryGroup

•Flow

•InstalledPackage

•NamedFilter

•OwnerSharingRule

•PermissionSet

•Profile

•Queue

•RecordType

•RemoteSiteSetting

•Role

•SharingReason

•Territory

•Validation Rules

•Workflow

For example, no tests are run for the following deployments:

•1 CustomApplication component

•100 Report components and 40 Dashboard components

All tests are run for the following deployments:

•1 CustomField component

•1 ApexComponent component and 1 ApexClass component

•5 CustomField components and 1 ApexPage component

•100 Report components, 40 Dashboard components, and 1 CustomField component

SEE ALSO:

deploy()

Running a Subset of Tests in a Deployment

Test levels enable you to have more control over which tests are run in a deployment. To shorten deployment time to production, run

a subset of tests when deploying Apex components. The default test execution behavior in production has also changed. By default, if

no test level is specified, no tests are executed, unless your deployment package contains Apex classes or triggers.

If the code coverage of an Apex component in the deployment is less than 75%, the deployment fails. If one of the specified tests fails,

the deployment also fails. We recommend that you test your deployment in sandbox first to ensure that the specified tests cover each

component sufficiently. Even if your organization’s overall code coverage is 75% or more, the individual coverage of the Apex components

being deployed can be less. If the code coverage requirement isn’t met, write more tests and include them in the deployment.

To run a subset of tests, set the RunSpecifiedTests test level on the DeployOptions object. Next, specify each test class to

run in DeployOptions. Finally, pass DeployOptions as an argument to the deploy() call. The following example performs

those steps to run only the specified test classes.

// Create the DeployOptions object.

DeployOptions deployOptions = new DeployOptions();

Running a Subset of Tests in a DeploymentDeploying and Retrieving Metadata

// Set the appropriate test level.

deployOptions.setTestLevel(TestLevel.RunSpecifiedTests);

// Specify the test classes to run.

// String array contains test class names.

String[] tests = {"TestClass1","TestClass2","TestClass3"};

// Add the test class names array to the deployment options.

deployOptions.setRunTests(tests);

// Call deploy() by passing the deployment options object as an argument.

AsyncResult asyncResult = metadatabinding.deploy(zipBytes,deployOptions);

Notes About Running Specific Tests

•You can specify only test classes. You can’t specify individual test methods.

•We recommend that you refactor test classes to include the minimum number of tests that meet code coverage requirements.

Refactoring your test classes can contribute to shorter test execution times, and as a result, shorter deployment times.

•You can deactivate a trigger in the target organization by deploying it with an inactive state. However, the trigger must have been

previously deployed with an active state.

Run the Same Tests in Sandbox and Production Deployments

Starting in API version 34.0, you can choose which tests to run in your development environment, such as only local tests, to match the

tests run in production. In earlier versions, if you enabled tests in your sandbox deployment, you couldn’t exclude managed package

tests.

By default, no tests are run in a deployment to a non-production organization, such as a sandbox or a Developer Edition organization.

To specify tests to run in your development environment, set a testLevel deployment option. For example, to run local tests in a

deployment and to exclude managed package tests, set testLevel on the DeployOptions object to

TestLevel.RunLocalTests. Next, pass this object as an argument to the deploy() call as follows.

// Create the DeployOptions object.

DeployOptions deployOptions = new DeployOptions();

// Set the appropriate test level.

deployOptions.setTestLevel(TestLevel.RunLocalTests);

// Call deploy() by passing the deployment options object as an argument.

AsyncResult asyncResult = metadatabinding.deploy(zipBytes,deployOptions);

Note: The RunLocalTests test level is enforced regardless of the contents of the deployment package. In contrast, tests are

executed by default in production only if your deployment package contains Apex classes or triggers. You can use

RunLocalTests for sandbox and production deployments.

Maintaining User References

User fields are preserved during a metadata deployment.

Run the Same Tests in Sandbox and Production DeploymentsDeploying and Retrieving Metadata

When a component in your deployment refers to a specific user, such as a recipient of a workflow email notification or a dashboard

running user, then Salesforce attempts to locate a matching user in the destination organization by comparing usernames during the

deployment.

For example, when you copy data to a sandbox, the fields containing usernames from the production organization are altered to include

the sandbox name. In a sandbox named test, the username user@acme.com becomes user@acme.com.test. When you

deploy the metadata in the sandbox to another organization, the test in the username is ignored.

For user references in deployments, Salesforce performs the following sequence:

1. Salesforce compares usernames in the source environment to the destination environment and adapts the organization domain

name.

2. If two or more usernames match, Salesforce lists the matching names and requests one of the users in the source environment be

renamed.

3. If a username in the source environment doesn’t exist in the destination environment, Salesforce displays an error, and the deployment

stops until the usernames are removed or resolved to users in the destination environment.

Maintaining User ReferencesDeploying and Retrieving Metadata

CHAPTER 4 CRUD-Based Metadata Development

Use the CRUD-based metadata calls to create, update, or delete setup and configuration components for your organization or application.

These configuration components include custom objects, custom fields, and other configuration metadata. The metadata calls mimic

the behavior in the Salesforce user interface for creating, updating, or deleting components. Whatever rules apply there also apply to

these calls.

Metadata calls are different from the core, synchronous API calls in the following ways:

•Metadata API calls are available in a separate WSDL. To download the WSDL, log into Salesforce, from Setup, enter API in the

Quick Find box, then select API and click the Download Metadata WSDL link.

•After logging in, you must send Metadata API calls to the Metadata API endpoint, which has a different URL than the SOAP API.

Retrieve the metadataServerUrl from the LoginResult returned by your SOAP API login() call. For more information

about the SOAP API, see the SOAP API Developer's Guide.

•Metadata calls are either synchronous or asynchronous. CRUD calls are synchronous in API version 30.0 and later, and similar to the

API core calls the results are returned in a single call. In earlier API versions, create, update, and delete are only asynchronous, which

means that the results are not immediately returned in one call.

•There are synchronous metadata calls that map to the corresponding core SOAP API synchronous calls.

–createMetadata() maps to the create() SOAP API call.

–updateMetadata() maps to the update() SOAP API call.

–deleteMetadata() maps to the delete() SOAP API call.

Note: Metadata API also supports retrieve() and deploy() calls for retrieving and deploying metadata components.

For more information, see Deploying and Retrieving Metadata.

Java Sample for CRUD-Based Development with Synchronous Calls

This section guides you through a sample Java client application that uses CRUD-based calls. This sample application performs the

following main tasks.

1. Uses the MetadataLoginUtil.java class to create a Metadata connection. For more information, see Step 3: Walk Through

the Java Sample Code.

2. Calls createMetadata() to create a custom object. This call returns the result in one call.

3. Inspects the returned SaveResult object to check if the operation succeeded, and if it didn’t, writes the component name, error

message, and status code to the output.

import com.sforce.soap.metadata.*;

/**

* Sample that logs in and creates a custom object through the metadata API

public class CRUDSampleCreate {

private MetadataConnection metadataConnection;

// one second in milliseconds

private static final long ONE_SECOND = 1000;

public CRUDSampleCreate() {

}

public static void main(String[] args) throws Exception {

CRUDSampleCreate crudSample = new CRUDSampleCreate();

crudSample.runCreate();

}

/**

* Create a custom object. This method demonstrates usage of the

* create() and checkStatus() calls.

* @param uniqueName Custom object name should be unique.

private void createCustomObjectSync(final String uniqueName) throws Exception {

final String label = "My Custom Object";

CustomObject co = new CustomObject();

co.setFullName(uniqueName);

co.setDeploymentStatus(DeploymentStatus.Deployed);

co.setDescription("Created by the Metadata API Sample");

co.setEnableActivities(true);

co.setLabel(label);

co.setPluralLabel(label + "s");

co.setSharingModel(SharingModel.ReadWrite);

// The name field appears in page layouts, related lists, and elsewhere.

CustomField nf = new CustomField();

nf.setType(FieldType.Text);

nf.setDescription("The custom object identifier on page layouts, related lists

etc");

nf.setLabel(label);

nf.setFullName(uniqueName);

customObject.setNameField(nf);

SaveResult[] results = metadataConnection

.createMetadata(new Metadata[] { co });

for (SaveResult r : results) {

if (r.isSuccess()) {

System.out.println("Created component: " + r.getFullName());

}else {

System.out

.println("Errors were encountered while creating "

+ r.getFullName());

for (Error e : r.getErrors()) {

System.out.println("Error message: " + e.getMessage());

System.out.println("Status code: " + e.getStatusCode());

}

CRUD-Based Metadata Development

}

private void runCreate() throws Exception {

metadataConnection = MetadataLoginUtil.login();

// Custom objects and fields must have __c suffix in the full name.

final String uniqueObjectName = "MyCustomObject__c";

createCustomObjectSync(uniqueObjectName);

}

Java Sample for CRUD-Based Development with Asynchronous Calls

Important: The sample in this section depends on the asynchronous create() CRUD call. Asynchronous CRUD calls are no

longer available as of API version 31.0 and are available only in earlier API versions.

This section guides you through a sample Java client application that uses asynchronous CRUD-based calls. This sample application

performs the following main tasks:

1. Uses the MetadataLoginUtil.java class to create a Metadata connection. For more information, see Step 3: Walk Through

the Java Sample Code.

2. Calls create() to create a new custom object.

Salesforce returns an AsyncResult object for each component you tried to create. The AsyncResult object is updated with status

information as the operation moves from a queue to completed or error state.

3. Calls checkStatus() in a loop until the status value in AsyncResult indicates that the create operation is completed.

Note the error handling code that follows each API call.

import com.sforce.soap.metadata.*;

/**

* Sample that logs in and creates a custom object through the metadata api

public class CRUDSample {

private MetadataConnection metadataConnection;

// one second in milliseconds

private static final long ONE_SECOND = 1000;

public CRUDSample() {

}

public static void main(String[] args) throws Exception {

CRUDSample crudSample = new CRUDSample();

crudSample.runCreate();

}

/**

* Create a custom object. This method demonstrates usage of the

* create() and checkStatus() calls.

* @param uniqueName Custom object name should be unique.

CRUD-Based Metadata Development

private void createCustomObject(final String uniqueName) throws Exception {

final String label = "My Custom Object";

CustomObject customObject = new CustomObject();

customObject.setFullName(uniqueName);

customObject.setDeploymentStatus(DeploymentStatus.Deployed);

customObject.setDescription("Created by the Metadata API Sample");

customObject.setLabel(label);

customObject.setPluralLabel(label + "s");

customObject.setSharingModel(SharingModel.ReadWrite);

// The name field appears in page layouts, related lists, and elsewhere.

CustomField nf = new CustomField();

nf.setType(FieldType.Text);

nf.setDescription("The custom object identifier on page layouts, related lists

etc");

nf.setLabel(label);

nf.setFullName(uniqueName);

customObject.setNameField(nf);

AsyncResult[] asyncResults = metadataConnection.create(

new CustomObject[]{customObject});

if (asyncResults == null) {

System.out.println("The object was not created successfully");

return;

}

long waitTimeMilliSecs = ONE_SECOND;

// After the create() call completes, we must poll the results of the checkStatus()

// call until it indicates that the create operation has completed.

do {

printAsyncResultStatus(asyncResults);

waitTimeMilliSecs *= 2;

Thread.sleep(waitTimeMilliSecs);

asyncResults = metadataConnection.checkStatus(new

String[]{asyncResults[0].getId()});

}while (!asyncResults[0].isDone());

printAsyncResultStatus(asyncResults);

}

private void printAsyncResultStatus(AsyncResult[] asyncResults) throws Exception {

if (asyncResults == null || asyncResults.length == 0 || asyncResults[0] == null)

{

throw new Exception("The object status cannot be retrieved");

}

AsyncResult asyncResult = asyncResults[0]; //we are creating only 1 metadata object

if (asyncResult.getStatusCode() != null) {

System.out.println("Error status code: " +

CRUD-Based Metadata Development

asyncResult.getStatusCode());

System.out.println("Error message: " + asyncResult.getMessage());

}

System.out.println("Object with id:" + asyncResult.getId() + " is " +

asyncResult.getState());

}

private void runCreate() throws Exception {

metadataConnection = MetadataLoginUtil.login();

// Custom objects and fields must have __c suffix in the full name.

final String uniqueObjectName = "MyCustomObject__c";

createCustomObject(uniqueObjectName);

}

CRUD-Based Metadata Development

CHAPTER 5 Error Handling

Metadata API calls return error information that your client application can use to identify and resolve runtime errors. The Metadata API

provides the following types of error handling:

•Since the Metadata API uses the enterprise or partner WSDLs to authenticate, it uses SOAP fault messages defined in those WSDLs

for errors resulting from badly formed messages, failed authentication, or similar problems. Each SOAP fault has an associated

ExceptionCode. For more details, see “Error Handling” in the SOAP API Developer's Guide.

•For errors with the asynchronous create(), update(), and delete() calls, see the error status code in the statusCode

field in the AsyncResult object for the associated component.

•For errors with the synchronous CRUD calls, see the error status code in the statusCode field of the Error object corresponding

to each error in the array returned by the errors field of the appropriate result object. For example, the result object of

createMetadata() is SaveResult.

•For errors with deploy(), see the problem and success fields in the DeployMessage object for the associated component.

•For errors with retrieve(), see the problem field in the RetrieveMessage object for the associated component.

For sample code, see Step 3: Walk Through the Java Sample Code on page 6.

Error Handling for Session Expiration

When you sign on via the login() call, a new client session begins and a corresponding unique session ID is generated. Sessions

automatically expire after the amount of time specified in the Security Controls setup area of the Salesforce application (default two

hours). When your session expires, the exception code INVALID_SESSION_ID is returned. If this happens, you must invoke the login()

call again. For more information about login(), see the SOAP API Developer's Guide.

REFERENCE

CHAPTER 6 File-Based Calls

Use the following file-based calls to deploy or retrieve XML components.

•deploy()

•deployRecentValidation()

•retrieve()

deploy()

Uses file representations of components to create, update, or delete those components in a Salesforce org.

Syntax

AsyncResult = metadatabinding.deploy(base64 zipFile,DeployOptions deployOptions)

Usage

Use this call to take file representations of components and deploy them into an org by creating, updating, or deleting the components

they represent.

Note: You can deploy or retrieve up to 10,000 files at once and the maximum size of the deployed or retrieved .zip file is 39 MB.

Note the following:

•If using the Force.com Migration Tool to deploy an unzipped folder, all files in the folder are compressed first. The maximum

size of uncompressed components in an unzipped folder is 400 MB or less depending on the compression ratio. If the files

have a high compression ratio, you can migrate a total of approximately 400 MB because the compressed size would be under

39 MB. However, if the components can't be compressed much, like binary static resources, you can migrate less than 400 MB.

•Metadata API base-64 encodes components after they’re compressed. The resulting .zip file can't exceed 50 MB, which is the

limit for SOAP messages. Base-64 encoding increases the size of the payload, so your compressed payload can't exceed

approximately 39 MB before encoding.

In API version 29.0, Salesforce improved the deployment status properties and removed the requirement to use checkStatus()

after a deploy() call to get information about deployments. Salesforce continues to support the use of checkStatus() when

using deploy() with API version 28.0 or earlier.

For API version 29.0 or later, deploy (create or update) packaged or unpackaged components using the following steps.

1. Issue a deploy() call to start the asynchronous deployment. An AsyncResult object is returned. Note the value in the id field

and use it for the next step.

2. Issue a checkDeployStatus() call in a loop until the done field of the returned DeployResult contains true, which means

that the call is completed. The DeployResult object contains information about an in-progress or completed deployment started

using the deploy() call. When calling checkDeployStatus(), pass in the id value from the AsyncResult object from the

first step.

For API version 28.0 or earlier, deploy (create or update) packaged or unpackaged components using the following steps.

1. Issue a deploy() call to start the asynchronous deployment. An AsyncResult object is returned. If the call is completed, the done

field contains true. Most often, the call is not completed quickly enough to be noted in the first result. If it is completed, note the

value in the id field returned and skip the next step.

2. If the call is not complete, issue a checkStatus() call in a loop using the value in the id field of the AsyncResult object returned

by the deploy() call in the previous step. Check the AsyncResult object which is returned until the done field contains true.

The time taken to complete a deploy() call depends on the size of the zip file being deployed, so a longer wait time between

iterations should be used as the size of the zip file increases.

3. Issue a checkDeployStatus() call to obtain the results of the deploy() call, using the id value returned in the first step.

To track the status of deployments that are in progress or completed in the last 30 days, from Setup, enter Deployment Status

in the Quick Find box, then select Deployment Status.

You can cancel a deployment while it’s in progress or in the queue by clicking Cancel next to the deployment. The deployment then

has the status Cancel Requested until the deployment is completely canceled. A canceled deployment is listed in the Failed

section.

The package.xml file is a project manifest that lists all the components that you want to retrieve or deploy. You can use

package.xml to add components. To delete components, add another manifest file. See Deleting Components from an Organization.

Permissions

Your client application must be logged in with the “Modify All Data” permission.

Arguments

DescriptionTypeName

Base 64-encoded binary data. Client applications must encode the binary data as base64.base64zipFile

Encapsulates options for determining which packages or files are deployed.DeployOptionsdeployOptions

DeployOptions

The following deployment options can be selected for this call:

DescriptionTypeName

If files that are specified in package.xml are not in the

.zip file, specifies whether a deployment can still succeed.

Do not set this argument for deployment to production orgs.

booleanallowMissingFiles

If a file is in the .zip file but not specified in package.xml,

specifies whether the file is automatically added to the package.

booleanautoUpdatePackage

A retrieve() is issued with the updated package.xml

that includes the .zip file.

deploy()File-Based Calls

DescriptionTypeName

Do not set this argument for deployment to production orgs.

Defaults to false. Set to true to perform a test deployment

(validation) of components without saving the components

booleancheckOnly

in the target org. A validation enables you to verify the results

of tests that would be generated in a deployment, but doesn’t

commit any changes. After a validation finishes with passing

tests, it might qualify for deployment without rerunning tests.

See deployRecentValidation().

Indicates whether a warning should allow a deployment to

complete successfully (true) or not (false). Defaults to

false.

The DeployMessage object for a warning contains the following

values:

booleanignoreWarnings

•problemType—Warning

•problem—The text of the warning.

If a warning occurs and ignoreWarnings is set to true,

the success field in DeployMessage is true. If

ignoreWarnings is set to false, success is set to

false and the warning is treated like an error.

This field is available in API version 18.0 and later. Prior to

version 18.0, there was no distinction between warnings and

errors. All problems were treated as errors and prevented a

successful deployment.

Indicates whether a retrieve() call is performed

immediately after the deployment (true) or not (false).

Set to true in order to retrieve whatever was just deployed.

booleanperformRetrieve

If true, the deleted components in the

destructiveChanges.xml manifest file aren't stored

booleanpurgeOnDelete

in the Recycle Bin. Instead, they become immediately eligible

for deletion.

This field is available in API version 22.0 and later.

This option only works in Developer Edition or sandbox orgs;

it doesn't work in production orgs.

Indicates whether any failure causes a complete rollback

(true) or not (false). If false, whatever actions can be

booleanrollbackOnError

performed without errors are performed, and errors are

returned for the remaining actions. This parameter must be

set to true if you are deploying to a production org. The

default is false.

deploy()File-Based Calls

DescriptionTypeName

(Deprecated and only available in API version 33.0 and earlier.)

This field defaults to false. Set to true to run all Apex tests

booleanrunAllTests

after deployment, including tests that originate from installed

managed packages.

Note: Apex tests that run as part of a deployment

always run synchronously and serially.

A list of Apex tests to run during deployment. Specify the class

name, one name per instance. The class name can also specify

string[]runTests

a namespace with a dot notation. For more information, see

Running a Subset of Tests in a Deployment.

To use this option, set testLevel to

RunSpecifiedTests.

Indicates whether the specified .zip file points to a directory

structure with a single package (true) or a set of packages

(false).

booleansinglePackage

Optional. Specifies which tests are run as part of a deployment.

The test level is enforced regardless of the types of components

that are present in the deployment package. Valid values are:

TestLevel (enumeration of type

string)

testLevel

•NoTestRun—No tests are run. This test level applies

only to deployments to development environments, such

as sandbox, Developer Edition, or trial organizations. This

test level is the default for development environments.

•RunSpecifiedTests—Only the tests that you specify

in the runTests option are run. Code coverage

requirements differ from the default coverage requirements

when using this test level. Each class and trigger in the

deployment package must be covered by the executed

tests for a minimum of 75% code coverage. This coverage

is computed for each class and trigger individually and is

different than the overall coverage percentage.

•RunLocalTests—All tests in your org are run, except

the ones that originate from installed managed packages.

This test level is the default for production deployments

that include Apex classes or triggers.

•RunAllTestsInOrg—All tests are run. The tests

include all tests in your org, including tests of managed

packages.

If you don’t specify a test level, the default test execution

behavior is used. See Running Tests in a Deployment.

Note: Apex tests that run as part of a deployment

always run synchronously and serially.

deploy()File-Based Calls

DescriptionTypeName

This field is available in API version 34.0 and later.

Response

AsyncResult

Sample Code—Java

This sample shows how to deploy components in a zip file. See the retrieve() sample code for details on how to retrieve a zip file.

package com.doc.samples;

import java.io.*;

import java.rmi.RemoteException;

import com.sforce.soap.metadata.AsyncResult;

import com.sforce.soap.metadata.DeployDetails;

import com.sforce.soap.metadata.MetadataConnection;

import com.sforce.soap.metadata.DeployOptions;

import com.sforce.soap.metadata.DeployResult;

import com.sforce.soap.metadata.DeployMessage;

import com.sforce.soap.metadata.RunTestsResult;

import com.sforce.soap.metadata.RunTestFailure;

import com.sforce.soap.metadata.CodeCoverageWarning;

import com.sforce.soap.enterprise.LoginResult;

import com.sforce.soap.enterprise.EnterpriseConnection;

import com.sforce.ws.ConnectionException;

import com.sforce.ws.ConnectorConfig;

/**

* Deploy a zip file of metadata components.

* Prerequisite: Have a deploy.zip file that includes a package.xml manifest file that

* details the contents of the zip file.

public class DeploySample {

// binding for the metadata WSDL used for making metadata API calls

private MetadataConnection metadataConnection;

static BufferedReader rdr = new BufferedReader(new InputStreamReader(System.in));

private static final String ZIP_FILE = "deploy.zip";

// one second in milliseconds

private static final long ONE_SECOND = 1000;

// maximum number of attempts to deploy the zip file

private static final int MAX_NUM_POLL_REQUESTS = 50;

public static void main(String[] args) throws Exception {

final String USERNAME = "user@company.com";

deploy()File-Based Calls

// This is only a sample. Hard coding passwords in source files is a bad practice.

final String PASSWORD = "password";

final String URL = "https://login.salesforce.com/services/Soap/c/29.0";

DeploySample sample = new DeploySample(USERNAME, PASSWORD, URL);

sample.deployZip();

}

public DeploySample(String username, String password, String loginUrl)

throws ConnectionException {

createMetadataConnection(username, password, loginUrl);

}

public void deployZip()

throws RemoteException, Exception

{

byte zipBytes[] = readZipFile();

DeployOptions deployOptions = new DeployOptions();

deployOptions.setPerformRetrieve(false);

deployOptions.setRollbackOnError(true);

AsyncResult asyncResult = metadataConnection.deploy(zipBytes, deployOptions);

String asyncResultId = asyncResult.getId();

// Wait for the deploy to complete

int poll = 0;

long waitTimeMilliSecs = ONE_SECOND;

DeployResult deployResult = null;

boolean fetchDetails;

do {

Thread.sleep(waitTimeMilliSecs);

// double the wait time for the next iteration

waitTimeMilliSecs *= 2;

if (poll++ > MAX_NUM_POLL_REQUESTS) {

throw new Exception("Request timed out. If this is a large set " +

"of metadata components, check that the time allowed by " +

"MAX_NUM_POLL_REQUESTS is sufficient.");

}

// Fetch in-progress details once for every 3 polls

fetchDetails = (poll % 3 == 0);

deployResult = metadataConnection.checkDeployStatus(asyncResultId, fetchDetails);

System.out.println("Status is: " + deployResult.getStatus());

if (!deployResult.isDone() && fetchDetails) {

printErrors(deployResult, "Failures for deployment in progress:\n");

}

while (!deployResult.isDone());

if (!deployResult.isSuccess() && deployResult.getErrorStatusCode() != null) {

throw new Exception(deployResult.getErrorStatusCode() + " msg: " +

deployResult.getErrorMessage());

}

deploy()File-Based Calls

if (!fetchDetails) {

// Get the final result with details if we didn't do it in the last attempt.

deployResult = metadataConnection.checkDeployStatus(asyncResultId, true);

}

if (!deployResult.isSuccess()) {

printErrors(deployResult, "Final list of failures:\n");

throw new Exception("The files were not successfully deployed");

}

System.out.println("The file " + ZIP_FILE + " was successfully deployed");

}

/**

* Read the zip file contents into a byte array.

* @return byte[]

* @throws Exception - if cannot find the zip file to deploy

private byte[] readZipFile()

throws Exception

{

// We assume here that you have a deploy.zip file.

// See the retrieve sample for how to retrieve a zip file.

File deployZip = new File(ZIP_FILE);

if (!deployZip.exists() || !deployZip.isFile())

throw new Exception("Cannot find the zip file to deploy. Looking for " +

deployZip.getAbsolutePath());

FileInputStream fos = new FileInputStream(deployZip);

ByteArrayOutputStream bos = new ByteArrayOutputStream();

int readbyte = -1;

while ((readbyte = fos.read()) != -1) {

bos.write(readbyte);

}

fos.close();

bos.close();

return bos.toByteArray();

}

/**

* Print out any errors, if any, related to the deploy.

* @param result - DeployResult

private void printErrors(DeployResult result, String messageHeader)

{

DeployDetails deployDetails = result.getDetails();

StringBuilder errorMessageBuilder = new StringBuilder();

if (deployDetails != null) {

DeployMessage[] componentFailures = deployDetails.getComponentFailures();

for (DeployMessage message : componentFailures) {

String loc = (message.getLineNumber() == 0 ? "" :

deploy()File-Based Calls

("(" + message.getLineNumber() + "," +

message.getColumnNumber() + ")"));

if (loc.length() == 0

&& !message.getFileName().equals(message.getFullName())) {

loc = "(" + message.getFullName() + ")";

}

errorMessageBuilder.append(message.getFileName() + loc + ":" +

message.getProblem()).append('\n');

}

RunTestsResult rtr = deployDetails.getRunTestResult();

if (rtr.getFailures() != null) {

for (RunTestFailure failure : rtr.getFailures()) {

String n = (failure.getNamespace() == null ?"" :

(failure.getNamespace() + ".")) + failure.getName();

errorMessageBuilder.append("Test failure, method: " +n+"." +

failure.getMethodName() + " -- " +

failure.getMessage() + " stack " +

failure.getStackTrace() + "\n\n");

}

if (rtr.getCodeCoverageWarnings() != null) {

for (CodeCoverageWarning ccw : rtr.getCodeCoverageWarnings()) {

errorMessageBuilder.append("Code coverage issue");

if (ccw.getName() != null) {

String n = (ccw.getNamespace() == null ?"" :

(ccw.getNamespace() + ".")) + ccw.getName();

errorMessageBuilder.append(", class: " + n);

}

errorMessageBuilder.append(" -- " + ccw.getMessage() + "\n");

}

if (errorMessageBuilder.length() > 0) {

errorMessageBuilder.insert(0, messageHeader);

System.out.println(errorMessageBuilder.toString());

}

private void createMetadataConnection(

final String username,

final String password,

final String loginUrl) throws ConnectionException {

final ConnectorConfig loginConfig = new ConnectorConfig();

loginConfig.setAuthEndpoint(loginUrl);

loginConfig.setServiceEndpoint(loginUrl);

loginConfig.setManualLogin(true);

LoginResult loginResult = (new EnterpriseConnection(loginConfig)).login(

username, password);

final ConnectorConfig metadataConfig = new ConnectorConfig();

metadataConfig.setServiceEndpoint(loginResult.getMetadataServerUrl());

metadataConfig.setSessionId(loginResult.getSessionId());

deploy()File-Based Calls

this.metadataConnection = new MetadataConnection(metadataConfig);

}

IN THIS SECTION:

1. Deleting Components from an Organization

To delete components, perform a deployment with the deploy() call by using a destructive changes manifest file that lists the

components to remove from your organization. You can perform a deployment that only deletes components, or a deployment

that deletes and adds components. In API version 33.0 and later, you can specify components to delete before and after other

components are added or updated. In earlier API versions, if deletions and additions are specified for the same deployment, the

deploy() call performs the deletions first.

2. checkDeployStatus()

3. cancelDeploy()

SEE ALSO:

Running Tests in a Deployment

Deleting Components from an Organization

To delete components, perform a deployment with the deploy() call by using a destructive changes manifest file that lists the

components to remove from your organization. You can perform a deployment that only deletes components, or a deployment that

deletes and adds components. In API version 33.0 and later, you can specify components to delete before and after other components

are added or updated. In earlier API versions, if deletions and additions are specified for the same deployment, the deploy() call

performs the deletions first.

Deleting Components in a Deployment

To delete components, use the same procedure as with deploying components, but also include a delete manifest file that’s named

destructiveChanges.xml and list the components to delete in this manifest. The format of this manifest is the same as

package.xml except that wildcards aren’t supported.

The following sample destructiveChanges.xml file names a single custom object to be deleted:

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>MyCustomObject__c</members>

<name>CustomObject</name>

</types>

</Package>

To deploy the destructive changes, you must also have a package.xml file that lists no components to deploy, includes the API

version, and is in the same directory as destructiveChanges.xml:

<?xml version="1.0" encoding="UTF-8"?>

</Package>

Deleting Components from an OrganizationFile-Based Calls

Note:

•To bypass the Recycle Bin, set the purgeOnDelete option to true.

•If you try to delete some components that don’t exist in the organization, the rest of the deletions are still attempted.

Adding and Deleting Components in a Single Deployment

You can perform a deployment that specifies components to delete in destructiveChanges.xml and components to add or

update in package.xml. The process is the same as with performing a delete-only deployment except that package.xml contains

the components to add or update.

By default, deletions are processed before component additions. In API version 33.0 and later, you can specify components to be deleted

before and after component additions. The process is the same as with performing a delete-only deployment except that the name of

the deletion manifest file is different.

•To delete components before adding or updating other components, create a manifest file that’s named

destructiveChangesPre.xml and include the components to delete.

•To delete components after adding or updating other components, create a manifest file that’s named

destructiveChangesPost.xml and include the components to delete.

The ability to specify when deletions are processed is useful when you’re deleting components with dependencies. For example, if a

custom object is referenced in an Apex class, you can’t delete it unless you modify the Apex class first to remove the dependency on

the custom object. In this example, you can perform a single deployment that updates the Apex class to clear the dependency and then

deletes the custom object by using destructiveChangesPost.xml. The following are samples of the package.xml and

destructiveChangesPost.xml manifests that would be used in this example.

Sample package.xml, which specifies the class to update:

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>SampleClass</members>

<name>ApexClass</name>

</types>

</Package>

Sample destructiveChangesPost.xml, which specifies the custom object to delete after the class update:

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>MyCustomObject__c</members>

<name>CustomObject</name>

</types>

</Package>

Note: The API version that the deployment uses is the API version that’s specified in package.xml.

checkDeployStatus()

Checks the status of declarative metadata call deploy().

checkDeployStatus()File-Based Calls

Syntax

DeployResult = metadatabinding.checkDeployStatus(ID id, includeDetails boolean);

Usage

checkDeployStatus is used as part of the process for deploying packaged or unpackaged components to an organization:

1. Issue a deploy() call to start the asynchronous deployment. An AsyncResult object is returned. Note the value in the id field

and use it for the next step.

2. Issue a checkDeployStatus() call in a loop until the done field of the returned DeployResult contains true, which means

that the call is completed. The DeployResult object contains information about an in-progress or completed deployment started

using the deploy() call. When calling checkDeployStatus(), pass in the id value from the AsyncResult object from the

first step.

In API version 29.0, Salesforce improved the deployment status properties and removed the requirement to use checkStatus()

after a deploy() call to get information about deployments. Salesforce continues to support the use of checkStatus() when

using deploy() with API version 28.0 or earlier.

Sample Code—Java

See the deploy() sample code for sample usage of this call.

Arguments

DescriptionTypeName

ID obtained from an AsyncResult object returned by deploy() or a subsequent

checkDeployStatus() call.

IDid

Sets the DeployResult object to include DeployDetails information ((true) or not (false).

The default is false. Available in API version 29.0 and later.

booleanincludeDetails

Response

DeployResult

cancelDeploy()

Cancels a deployment that hasn’t completed yet.

Syntax

CancelDeployResult = metadatabinding.cancelDeploy(string id)

cancelDeploy()File-Based Calls

Usage

Use the cancelDeploy() operation to cancel a deployment in your organization started by the deploy() operation, which

includes deployments started by the Force.com Migration Tool and the Force.com IDE. The deployment can be in a queue waiting to

get started, or can be in progress. This operation takes the ID of the deployment you wish to cancel and returns a CancelDeployResult

object. When the deployment is in the queue and hasn’t started yet, calling cancelDeploy() cancels the deployment immediately.

When the deployment has started and is in progress, it might not get canceled immediately, so you should call

checkDeployStatus() to check the status of the cancellation.

Cancel a deployment using these steps.

1. Obtain the ID of the deployment you wish to cancel. For example, you can obtain the ID from the deploy() call in the

AsyncResult object id field. Alternatively, you can obtain the ID in the Salesforce user interface from Setup by entering

Deployment Status in the Quick Find box, selecting Deployment Status, and then noting the ID of a deployment

started by the API.

2. Issue a cancelDeploy() call to start the cancellation process. This call returns a CancelDeployResult object.

3. Check the value in the done field of the returned CancelDeployResult. If the done field value is true, the deployment

has been canceled and you’re done. If the done field value is false, the cancellation is in progress, and follow these steps to

check the cancellation status.

a. Call checkDeployStatus() using the deployment ID you obtained earlier.

b. In the returned DeployResult object, check the status field. If the status is Canceling, this means the cancellation is still

in progress, and repeat steps a and b. Otherwise, if the status is Canceled, this means the deployment has been canceled

and you’re done.

The deploy() operation throws these API faults.

INVALID_ID_FIELD with the message Invalid deploy ID

The specified ID argument doesn’t correspond to a valid deployment.

INVALID_ID_FIELD with the message Deployment already completed

The specified deployment has already completed.

Version

Available in API version 30.0 and later.

Permissions

Your client application must be logged in with the “Modify All Data” permission.

Arguments

DescriptionTypeName

The ID of the deployment to cancel.stringid

Response

CancelDeployResult

cancelDeploy()File-Based Calls

Sample Code—Java

This sample shows how to cancel a deployment. The sample calls cancelDeploy() by passing it a given deployment ID. Next, it

checks whether the cancellation has completed, and if not, calls checkDeployStatus in a loop.

public void cancelDeploy(String asyncId) throws Exception {

// Issue the deployment cancellation request

CancelDeployResult result = metadataConnection.cancelDeploy(asyncId);

// If the deployment cancellation completed, write a message to the output.

if (result.isDone()) {

System.out.println("Your deployment was canceled successfully!");

}

else {

// The deployment cancellation is still in progress, so get a new status

DeployResult deployResult = metadataConnection.checkDeployStatus(asyncId, false);

// Check whether the deployment is done. If not done, this means

// that the cancellation is still in progress and the status is Canceling.

while (!deployResult.isDone()) {

// Assert that the deployment status is Canceling

assert deployResult.getStatus() == DeployStatus.Canceling;

// Wait 2 seconds

Thread.sleep(2000);

// Get the deployment status again

deployResult = metadataConnection.checkDeployStatus(asyncId, false);

}

// The deployment is done. Write the status to the output.

// (When the deployment is done, the cancellation should have completed

// and the status should be Canceled. However, in very rare cases,

// the deployment can complete before it is canceled.)

System.out.println("Final deploy status = >" + deployResult.getStatus());

}

deployRecentValidation()

Deploys a recently validated component set without running Apex tests.

Syntax

string = metadatabinding.deployRecentValidation(ID validationID)

Usage

Use deployRecentValidation() to deploy your components to production in less time by skipping the execution of Apex

tests. Ensure that the following requirements are met before deploying a recent validation.

deployRecentValidation()File-Based Calls

•The components have been validated successfully for the target environment within the last 10 days.

•As part of the validation, Apex tests in the target org have passed.

•Code coverage requirements are met.

–If all tests in the org or all local tests are run, overall code coverage is at least 75%, and Apex triggers have some coverage.

–If specific tests are run with the RunSpecifiedTests test level, each class and trigger that was deployed is covered by at

least 75% individually.

This call is equivalent to performing a quick deployment of a recent validation on the Deployment Status page in the Salesforce user

interface.

Before you call deployRecentValidation(), your organization must have a validation that was recently run. You can run a

validation on a set of components by calling deploy() with the checkOnly property of the deployOptions parameter set to

true. Note the ID that you obtained from the deploy() call. You’ll use this ID for the deployRecentValidation() call in

the next step.

After you’ve run a validation successfully, use these steps to quick-deploy the validation to the same target environment.

1. To start an asynchronous quick deployment, call deployRecentValidation() and pass it the ID of a recent validation. This

ID is obtained from the previous deploy() call. The deployRecentValidation() call returns the ID of the quick deployment.

Note this value. You’ll use it in the next step.

2. Check for the completion of the call. This process is similar to that of deploy(). Issue a checkDeployStatus() call in a loop

until the done field of the returned DeployResult contains true, which means that the call is completed. The DeployResult object

contains information about an in-progress or completed deployment that was started by using the

deployRecentValidation() call. When calling checkDeployStatus(), pass in the ID value that you obtained in

the first step.

Version

Available in API version 33.0 and later.

Arguments

DescriptionTypeName

The ID of a recent validation.stringvalidationID

Response

Type: string

The ID of the quick deployment.

Sample Code—Java

package com.salesforce.test.metadata;

import java.rmi.RemoteException;

import com.sforce.soap.metadata.CodeCoverageWarning;

deployRecentValidation()File-Based Calls

import com.sforce.soap.metadata.DeployDetails;

import com.sforce.soap.metadata.DeployMessage;

import com.sforce.soap.metadata.DeployResult;

import com.sforce.soap.metadata.MetadataConnection;

import com.sforce.soap.metadata.RunTestFailure;

import com.sforce.soap.metadata.RunTestsResult;

import com.sforce.soap.partner.Connector;

import com.sforce.ws.ConnectionException;

import com.sforce.ws.ConnectorConfig;

/**

* Quick-deploy a recent validation.

* Prerequisite: A successful validation (check-only deploy) has been done in the org

recently.

public class DeployRecentValidationSample {

// binding for the metadata WSDL used for making metadata API calls

private MetadataConnection metadataConnection;

// one second in milliseconds

private static final long ONE_SECOND = 1000;

// maximum number of attempts to deploy the zip file

private static final int MAX_NUM_POLL_REQUESTS = 50;

public static void main(String[] args) throws Exception {

final String USERNAME = args[0];

final String PASSWORD = args[1];

final String URL = args[2];

final String recentValidationId = args[3];

DeployRecentValidationSample sample = new DeployRecentValidationSample(

USERNAME, PASSWORD, URL);

sample.deployRecentValidation(recentValidationId);

}

public DeployRecentValidationSample(String username, String password, String loginUrl)

throws ConnectionException {

createMetadataConnection(username, password, loginUrl);

}

public void deployRecentValidation(String recentValidationId)

throws RemoteException, Exception

{

String asyncResultId = metadataConnection.deployRecentValidation(recentValidationId);

// Wait for the deploy to complete

int poll = 0;

long waitTimeMilliSecs = ONE_SECOND;

DeployResult deployResult = null;

boolean fetchDetails;

do {

deployRecentValidation()File-Based Calls

Thread.sleep(waitTimeMilliSecs);

// double the wait time for the next iteration

waitTimeMilliSecs *= 2;

if (poll++ > MAX_NUM_POLL_REQUESTS) {

throw new Exception("Request timed out. If this is a large set " +

"of metadata components, check that the time allowed by " +

"MAX_NUM_POLL_REQUESTS is sufficient.");

}

// Fetch in-progress details once for every 3 polls

fetchDetails = (poll % 3 == 0);

deployResult = metadataConnection.checkDeployStatus(asyncResultId, fetchDetails);

System.out.println("Status is: " + deployResult.getStatus());

if (!deployResult.isDone() && fetchDetails) {

printErrors(deployResult, "Failures for deployment in progress:\n");

}

while (!deployResult.isDone());

if (!deployResult.isSuccess() && deployResult.getErrorStatusCode() != null) {

throw new Exception(deployResult.getErrorStatusCode() + " msg: " +

deployResult.getErrorMessage());

}

if (!fetchDetails) {

// Get the final result with details if we didn't do it in the last attempt.

deployResult = metadataConnection.checkDeployStatus(asyncResultId, true);

}

if (!deployResult.isSuccess()) {

printErrors(deployResult, "Final list of failures:\n");

throw new Exception("The files were not successfully deployed");

}

System.out.println("The recent validation " + recentValidationId +

" was successfully deployed");

}

/**

* Print out any errors, if any, related to the deploy.

* @param result - DeployResult

private void printErrors(DeployResult result, String messageHeader)

{

DeployDetails deployDetails = result.getDetails();

StringBuilder errorMessageBuilder = new StringBuilder();

if (deployDetails != null) {

DeployMessage[] componentFailures = deployDetails.getComponentFailures();

for (DeployMessage message : componentFailures) {

String loc = (message.getLineNumber() == 0 ? "" :

("(" + message.getLineNumber() + "," +

message.getColumnNumber() + ")"));

deployRecentValidation()File-Based Calls

if (loc.length() == 0

&& !message.getFileName().equals(message.getFullName())) {

loc = "(" + message.getFullName() + ")";

}

errorMessageBuilder.append(message.getFileName() + loc + ":" +

message.getProblem()).append('\n');

}

RunTestsResult rtr = deployDetails.getRunTestResult();

if (rtr.getFailures() != null) {

for (RunTestFailure failure : rtr.getFailures()) {

String n = (failure.getNamespace() == null ? "" :

(failure.getNamespace() + ".")) + failure.getName();

errorMessageBuilder.append("Test failure, method: " +n+"." +

failure.getMethodName() + " -- " +

failure.getMessage() + " stack " +

failure.getStackTrace() + "\n\n");

}

if (rtr.getCodeCoverageWarnings() != null) {

for (CodeCoverageWarning ccw : rtr.getCodeCoverageWarnings()) {

errorMessageBuilder.append("Code coverage issue");

if (ccw.getName() != null) {

String n = (ccw.getNamespace() == null ? "" :

(ccw.getNamespace() + ".")) + ccw.getName();

errorMessageBuilder.append(", class: " + n);

}

errorMessageBuilder.append(" -- " + ccw.getMessage() + "\n");

}

if (errorMessageBuilder.length() > 0) {

errorMessageBuilder.insert(0, messageHeader);

System.out.println(errorMessageBuilder.toString());

}

private void createMetadataConnection(

final String username,

final String password,

final String loginUrl) throws ConnectionException {

final ConnectorConfig loginConfig = new ConnectorConfig();

loginConfig.setUsername(username);

loginConfig.setPassword(password);

loginConfig.setAuthEndpoint(loginUrl);

Connector.newConnection(loginConfig);

final ConnectorConfig metadataConfig = new ConnectorConfig();

metadataConfig.setServiceEndpoint(

loginConfig.getServiceEndpoint().replace("/u/","/m/"));

metadataConfig.setSessionId(loginConfig.getSessionId());

deployRecentValidation()File-Based Calls

this.metadataConnection = com.sforce.soap.metadata.Connector.

newConnection(metadataConfig);

}

retrieve()

This call retrieves XML file representations of components in an organization.

Syntax

AsyncResult = metadatabinding.retrieve(RetrieveRequest retrieveRequest)

Usage

Use this call to retrieve file representations of components in an organization.

Note: You can deploy or retrieve up to 10,000 files at once and the maximum size of the deployed or retrieved .zip file is 39 MB.

In API version 31.0 and later, the process of making a retrieve() call has been simplified. You no longer have to call

checkStatus() after a retrieve() call to obtain the status of the retrieve operation. Instead, make calls to

checkRetrieveStatus() only. If the retrieve operation is in progress, call checkRetrieveStatus() again until the

retrieve operation is completed. The checkStatus() call is still supported in versions API version 30.0 or earlier, but is not available

in API version 31.0 and later.

For API version 31.0 or later, retrieve packaged or unpackaged components by using the following steps.

1. Issue a retrieve() call to start the asynchronous retrieval. An AsyncResult object is returned. Note the value in the id field and

use it for the next step.

2. Issue a checkRetrieveStatus() call and pass in the id value from the AsyncResult object from the first step. Check the

value of the done field of the returned RetrieveResult. If it is true, this means that the call is completed and proceed to the next

step. Otherwise, repeat this step to call checkRetrieveStatus() again until the done field is true.

3. Retrieve the zip file (zipFile field) and other desired fields from RetrieveResult that was returned by the final call to

checkRetrieveStatus() in the previous step.

For API version 30.0 or earlier, retrieve packaged or unpackaged components by using the following steps.

1. Issue a retrieve() call to start the asynchronous retrieval. An AsyncResult object is returned. If the call is completed, the done

field contains true. Most often, the call is not completed quickly enough to be noted in the result. If it is completed, note the value

in the id field returned and skip the next step.

2. If the call is not complete, issue a checkStatus() call in a loop using the value in the id field of the AsyncResult object, returned

by the retrieve() call in the previous step. Check the AsyncResult object returned until the done field contains true. The

time taken to complete a retrieve() call depends on the size of the zip file being deployed, so use a longer wait time between

iterations as the size of the zip file increases.

3. Issue a checkRetrieveStatus() call to obtain the results of the retrieve() call, using the id value returned in the first

step.

For examples of manifest files, see Sample package.xml Manifest Files.

retrieve()File-Based Calls

Permissions

Your client application must be logged in with the “Modify All Data” permission.

Arguments

DescriptionTypeName

Encapsulates options for determining which packages or files are retrieved.RetrieveRequestretrieveRequest

Response

AsyncResult

Sample Code—Java

This sample shows how to retrieve components into a zip file. See the deploy() sample code for details on how to deploy a zip file.

Note: This sample requires API version 34.0 or later.

package com.doc.samples;

import java.io.*;

import java.util.*;

import java.nio.ByteBuffer;

import java.nio.channels.*;

import java.rmi.RemoteException;

import javax.xml.parsers.DocumentBuilder;

import javax.xml.parsers.DocumentBuilderFactory;

import javax.xml.parsers.ParserConfigurationException;

import org.w3c.dom.Element;

import org.w3c.dom.Node;

import org.w3c.dom.NodeList;

import org.xml.sax.SAXException;

import com.sforce.soap.metadata.AsyncResult;

import com.sforce.soap.metadata.MetadataConnection;

import com.sforce.soap.enterprise.EnterpriseConnection;

import com.sforce.soap.metadata.RetrieveMessage;

import com.sforce.soap.metadata.RetrieveRequest;

import com.sforce.soap.metadata.RetrieveResult;

import com.sforce.soap.metadata.RetrieveStatus;

import com.sforce.soap.enterprise.LoginResult;

import com.sforce.ws.ConnectionException;

import com.sforce.ws.ConnectorConfig;

import com.sforce.soap.metadata.PackageTypeMembers;

public class RetrieveSample {

// Binding for the metadata WSDL used for making metadata API calls

private MetadataConnection metadataConnection;

retrieve()File-Based Calls

static BufferedReader rdr = new BufferedReader(new InputStreamReader(System.in));

// one second in milliseconds

private static final long ONE_SECOND = 1000;

// maximum number of attempts to retrieve the results

private static final int MAX_NUM_POLL_REQUESTS = 50;

// manifest file that controls which components get retrieved

private static final String MANIFEST_FILE = "package.xml";

private static final double API_VERSION = 31.0;

public static void main(String[] args) throws Exception {

final String USERNAME = "user@company.com";

// This is only a sample. Hard coding passwords in source files is a bad practice.

final String PASSWORD = "password";

final String URL = "https://login.salesforce.com/services/Soap/c/31.0";

RetrieveSample sample = new RetrieveSample(USERNAME, PASSWORD, URL);

sample.retrieveZip();

}

public RetrieveSample(String username, String password, String loginUrl)

throws ConnectionException {

createMetadataConnection(username, password, loginUrl);

}

private void retrieveZip() throws RemoteException, Exception

{

RetrieveRequest retrieveRequest = new RetrieveRequest();

// The version in package.xml overrides the version in RetrieveRequest

retrieveRequest.setApiVersion(API_VERSION);

setUnpackaged(retrieveRequest);

// Start the retrieve operation

AsyncResult asyncResult = metadataConnection.retrieve(retrieveRequest);

String asyncResultId = asyncResult.getId();

// Wait for the retrieve to complete

int poll = 0;

long waitTimeMilliSecs = ONE_SECOND;

RetrieveResult result = null;

do {

Thread.sleep(waitTimeMilliSecs);

// Double the wait time for the next iteration

waitTimeMilliSecs *= 2;

if (poll++ > MAX_NUM_POLL_REQUESTS) {

throw new Exception("Request timed out. If this is a large set " +

"of metadata components, check that the time allowed " +

"by MAX_NUM_POLL_REQUESTS is sufficient.");

}

retrieve()File-Based Calls

result = metadataConnection.checkRetrieveStatus(

asyncResultId, true);

System.out.println("Retrieve Status: " + result.getStatus());

}while (!result.isDone());

if (result.getStatus() == RetrieveStatus.Failed) {

throw new Exception(result.getErrorStatusCode() + " msg: " +

result.getErrorMessage());

}else if (result.getStatus() == RetrieveStatus.Succeeded) {

// Print out any warning messages

StringBuilder buf = new StringBuilder();

if (result.getMessages() != null) {

for (RetrieveMessage rm : result.getMessages()) {

buf.append(rm.getFileName() + "-"+ rm.getProblem());

}

if (buf.length() > 0) {

System.out.println("Retrieve warnings:\n" + buf);

}

// Write the zip to the file system

System.out.println("Writing results to zip file");

ByteArrayInputStream bais = new ByteArrayInputStream(result.getZipFile());

File resultsFile = new File("retrieveResults.zip");

FileOutputStream os = new FileOutputStream(resultsFile);

try {

ReadableByteChannel src = Channels.newChannel(bais);

FileChannel dest = os.getChannel();

copy(src, dest);

System.out.println("Results written to " + resultsFile.getAbsolutePath());

}finally {

os.close();

}

/**

* Helper method to copy from a readable channel to a writable channel,

* using an in-memory buffer.

private void copy(ReadableByteChannel src, WritableByteChannel dest)

throws IOException

{

// Use an in-memory byte buffer

ByteBuffer buffer = ByteBuffer.allocate(8092);

while (src.read(buffer) != -1) {

buffer.flip();

while(buffer.hasRemaining()) {

dest.write(buffer);

}

buffer.clear();

}

retrieve()File-Based Calls

}

private void setUnpackaged(RetrieveRequest request) throws Exception

{

// Edit the path, if necessary, if your package.xml file is located elsewhere

File unpackedManifest = new File(MANIFEST_FILE);

System.out.println("Manifest file: " + unpackedManifest.getAbsolutePath());

if (!unpackedManifest.exists() || !unpackedManifest.isFile())

throw new Exception("Should provide a valid retrieve manifest " +

"for unpackaged content. " +

"Looking for " + unpackedManifest.getAbsolutePath());

// Note that we populate the _package object by parsing a manifest file here.

// You could populate the _package based on any source for your

// particular application.

com.sforce.soap.metadata.Package p = parsePackage(unpackedManifest);

request.setUnpackaged(p);

}

private com.sforce.soap.metadata.Package parsePackage(File file) throws Exception {

try {

InputStream is =new FileInputStream(file);

List<PackageTypeMembers> pd = new ArrayList<PackageTypeMembers>();

DocumentBuilder db =

DocumentBuilderFactory.newInstance().newDocumentBuilder();

Element d = db.parse(is).getDocumentElement();

for (Node c = d.getFirstChild(); c != null; c = c.getNextSibling()) {

if (c instanceof Element) {

Element ce = (Element)c;

NodeList namee = ce.getElementsByTagName("name");

if (namee.getLength() == 0) {

// not

continue;

}

String name = namee.item(0).getTextContent();

NodeList m = ce.getElementsByTagName("members");

List<String> members = new ArrayList<String>();

for (int i = 0; i < m.getLength(); i++) {

Node mm = m.item(i);

members.add(mm.getTextContent());

}

PackageTypeMembers pdi = new PackageTypeMembers();

pdi.setName(name);

pdi.setMembers(members.toArray(new String[members.size()]));

pd.add(pdi);

}

com.sforce.soap.metadata.Package r = new com.sforce.soap.metadata.Package();

r.setTypes(pd.toArray(new PackageTypeMembers[pd.size()]));

r.setVersion(API_VERSION + "");

return r;

}catch (ParserConfigurationException pce) {

retrieve()File-Based Calls

throw new Exception("Cannot create XML parser", pce);

}catch (IOException ioe) {

throw new Exception(ioe);

}catch (SAXException se) {

throw new Exception(se);

}

private void createMetadataConnection(final String username,

final String password, final String loginUrl)

throws ConnectionException {

final ConnectorConfig loginConfig = new ConnectorConfig();

loginConfig.setAuthEndpoint(loginUrl);

loginConfig.setServiceEndpoint(loginUrl);

loginConfig.setManualLogin(true);

LoginResult loginResult = (new EnterpriseConnection(loginConfig)).login(

username, password);

final ConnectorConfig metadataConfig = new ConnectorConfig();

metadataConfig.setServiceEndpoint(loginResult.getMetadataServerUrl());

metadataConfig.setSessionId(loginResult.getSessionId());

this.metadataConnection = new MetadataConnection(metadataConfig);

}

//The sample client application retrieves the user's login credentials.

// Helper function for retrieving user input from the console

String getUserInput(String prompt) {

System.out.print(prompt);

try {

return rdr.readLine();

}

catch (IOException ex) {

return null;

}

RetrieveRequest

The RetrieveRequest object specified in a retrieve() call consists of the following properties:

DescriptionTypeName

Required. The API version for the retrieve request. The API

version determines the fields retrieved for each metadata type.

doubleapiVersion

For example, an icon field was added to the CustomTab

for API version 14.0. If you retrieve components for version 13.0

or earlier, the components will not include the icon field.

RetrieveRequestFile-Based Calls

DescriptionTypeName

Note: In API version 31.0 and later, the API version

that’s specified in package.xml is used for the

retrieve() call and overrides the version in the

apiVersion field. If the version is not specified in

package.xml, the version in this field is used.

A list of package names to be retrieved. If you are retrieving

only unpackaged components, do not specify a name here.

string[]packageNames

You can retrieve packaged and unpackaged components in

the same retrieve.

Specifies whether only a single package is being retrieved

(true) or not (false). If false, then more than one

package is being retrieved.

booleansinglePackage

A list of file names to be retrieved. If a value is specified for this

property, packageNames must be set to null and

singlePackage must be set to true.

string[]specificFiles

A list of components to retrieve that are not in a package.Packageunpackaged

checkRetrieveStatus()

Checks the status of the declarative metadata call retrieve() and returns the zip file contents.

Syntax

In API version 34.0 and later:

RetrieveResult = metadatabinding.checkRetrieveStatus(ID id, boolean includeZip);

In API version 33.0 and earlier:

RetrieveResult = metadatabinding.checkRetrieveStatus(ID id);

Usage

Use checkRetrieveStatus() to check the progress of the metadata retrieve() operation. The RetrieveResult object that

this method returns indicates when the asynchronous retrieve() call is completed. If the retrieval is completed, RetrieveResult

contains the zip file contents by default. Use the following process to retrieve metadata components with the retrieve() call.

1. Issue a retrieve() call to start the asynchronous retrieval. An AsyncResult object is returned. Note the value in the id field and

use it for the next step.

2. Issue a checkRetrieveStatus() call and pass in the id value from the AsyncResult object from the first step. Check the

value of the done field of the returned RetrieveResult. If it is true, this means that the call is completed and proceed to the next

step. Otherwise, repeat this step to call checkRetrieveStatus() again until the done field is true.

3. Retrieve the zip file (zipFile field) and other desired fields from RetrieveResult that was returned by the final call to

checkRetrieveStatus() in the previous step.

checkRetrieveStatus()File-Based Calls

In API version 31.0 and later, the process of making a retrieve() call has been simplified. You no longer have to call

checkStatus() after a retrieve() call to obtain the status of the retrieve operation. Instead, make calls to

checkRetrieveStatus() only. If the retrieve operation is in progress, call checkRetrieveStatus() again until the

retrieve operation is completed. The checkStatus() call is still supported in versions API version 30.0 or earlier, but is not available

in API version 31.0 and later.

Retrieving the Zip File in a Second Process

By default, checkRetrieveStatus() returns the zip file on the last call to this operation when the retrieval is completed

(RetrieveResult.isDone() == true) and then deletes the zip file from the server. Subsequent calls to

checkRetrieveStatus() for the same retrieve operation can’t retrieve the zip file after it has been deleted. Starting with API

version 34.0, pass a boolean value for the includeZip argument of checkRetrieveStatus() to indicate whether to retrieve

the zip file. The includeZip argument gives you the option to retrieve the file in a separate process after the retrieval operation is

completed. For example, a service polls the retrieval status by calling checkRetrieveStatus(id, false) in a loop. This call

returns the status of the retrieval operation, but doesn’t retrieve the zip file. After the retrieval operation is completed, another process,

such as a background file transfer service, calls checkRetrieveStatus(id, true) to retrieve the zip file. This last call causes

the zip file to be deleted from the server.

// First process: Poll the retrieval but don’t retrieve the zip file.

AsyncResult asyncResult = metadataConnection.retrieve(retrieveRequest);

String asyncResultId = asyncResult.getId();

// Wait for the retrieve to complete

int poll = 0;

long waitTimeMilliSecs = ONE_SECOND;

RetrieveResult result = null;

do {

Thread.sleep(waitTimeMilliSecs);

// Check the status but don’t retrieve zip file.

result = metadataConnection.checkRetrieveStatus(asyncResultId, false);

}while (!result.isDone());

// Second process: Retrieve the zip file.

// For example, this process can be a background file transfer service.

// Retrieve the zip file.

result = metadataConnection.checkRetrieveStatus(asyncResultId, true);

// Get the zip file from the RetrieveResult (result) variable

if (result.getStatus() == RetrieveStatus.Succeeded) {

ByteArrayInputStream bais = new ByteArrayInputStream(result.getZipFile());

// ...

}

Sample Code—Java

See the retrieve() sample code for sample usage of this call.

Arguments

DescriptionTypeName

ID obtained from an AsyncResult object returned by a retrieve() call or a subsequent

RetrieveResult object returned by a checkRetrieveStatus() call.

IDid

checkRetrieveStatus()File-Based Calls

DescriptionTypeName

Set to true to retrieve the zip file. You can retrieve the zip file only after the retrieval operation

is completed. After the zip file is retrieved, it is deleted from the server. Set to false to check

booleanincludeZip

the status of the retrieval without attempting to retrieve the zip file. If set to null, this argument

defaults to true, which means that the zip file is retrieved on the last call to

checkRetrieveStatus() when the retrieval has finished.

This argument is available in API version 34.0 and later.

Response

RetrieveResult

checkRetrieveStatus()File-Based Calls

CHAPTER 7 CRUD-Based Calls

Use the following CRUD-based calls to work with metadata components in a manner similar to how synchronous API calls in the enterprise

WSDL act upon objects.

IN THIS SECTION:

createMetadata()

Adds one or more new metadata components to your organization synchronously.

readMetadata()

Returns one or more metadata components from your organization synchronously.

updateMetadata()

Updates one or more metadata components in your organization synchronously.

upsertMetadata()

Creates or updates one or more metadata components in your organization synchronously.

deleteMetadata()

Deletes one or more metadata components from your organization synchronously.

renameMetadata()

Renames a metadata component in your organization synchronously.

create()

Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version

31.0 and is available in earlier versions only. Use createMetadata() instead.

delete()

Deprecated. Deletes one or more components from your organization asynchronously. This call is removed as of API version 31.0

and is available in earlier versions only. Use deleteMetadata() instead.

update()

Deprecated. Updates one or more components in your organization asynchronously. This call is removed as of API version 31.0 and

is available in earlier versions only. Use updateMetadata() or renameMetadata() instead.

createMetadata()

Adds one or more new metadata components to your organization synchronously.

Syntax

SaveResult[] = metadatabinding.createMetadata(Metadata[] metadata);

Usage

Use the createMetadata() call to create any component that extends Metadata. All components must be of the same type in

the same call. For more details, see Metadata Components and Types.

This call executes synchronously, which means that the call returns only when the operation completes.

Starting in API version 34.0, this call supports the AllOrNoneHeader header. By default, if AllOrNoneHeader isn’t used in API version

34.0 and later, this call can save a partial set of records for records with no errors (equivalent to AllOrNoneHeader=false). In API

version 33.0 and earlier, the default behavior is to only save all records when there are no failures in any record in the call (equivalent to

AllOrNoneHeader=true).

Version

Available in API version 30.0 and later.

Permissions

Your client application must be logged in with the “Modify All Data” permission.

Required Fields

Required fields are determined by the metadata components being created. For more information about specific component types, see

Metadata Components and Types.

Valid Data Values

You must supply values that are valid for the field’s data type, such as integers for integer fields (not alphabetic characters). In your client

application, follow the data formatting rules specified for your programming language and development tool. (Your development tool

handles the appropriate mapping of data types in SOAP messages.)

String Values

When storing values in string fields, the API trims any leading and trailing whitespace. For example, if the value of a label field is

entered as "MyObject ", the value is stored in the database as "MyObject".

Basic Steps for Creating Metadata Components

Use the following process to create metadata components:

1. Design an array and populate it with the components that you want to create. All components must be of the same type.

2. Call createMetadata() with the component array passed in as an argument.

3. A SaveResult object is returned for each component you tried to create. It contains information about whether the operation

was successful, the name of the component created, and any errors returned if the operation wasn’t successful.

createMetadata()CRUD-Based Calls

Sample Code—Java

public void createCustomObjectSync() {

try {

CustomObject co = new CustomObject();

String name = "MyCustomObject1";

co.setFullName(name + "__c");

co.setDeploymentStatus(DeploymentStatus.Deployed);

co.setDescription("Created by the Metadata API");

co.setEnableActivities(true);

co.setLabel(name + " Object");

co.setPluralLabel(co.getLabel() + "s");

co.setSharingModel(SharingModel.ReadWrite);

CustomField nf = new CustomField();

nf.setType(FieldType.Text);

nf.setLabel(co.getFullName() + " Name");

co.setNameField(nf);

SaveResult[] results = metadataConnection

.createMetadata(new Metadata[] { co });

for (SaveResult r : results) {

if (r.isSuccess()) {

System.out.println("Created component: " + r.getFullName());

}else {

System.out

.println("Errors were encountered while creating "

+ r.getFullName());

for (Error e : r.getErrors()) {

System.out.println("Error message: " + e.getMessage());

System.out.println("Status code: " + e.getStatusCode());

}

}catch (ConnectionException ce) {

ce.printStackTrace();

}

Arguments

DescriptionTypeName

Array of one or more metadata components.

Limit: 10. (For CustomMetadata and CustomApplication only, the limit is 200.)

Metadata[]metadata

You must submit arrays of only one type of component. For example, you can submit an array

of 10 custom objects or 10 profiles, but not a mix of both types.

createMetadata()CRUD-Based Calls

Response

SaveResult[]

readMetadata()

Returns one or more metadata components from your organization synchronously.

Syntax

ReadResult = metadataConnection.readMetadata(string metadataType, string[] fullNames);

Usage

Use the readMetadata() call to retrieve any component that extends Metadata. All components must be of the same type in the

same call. For more details, see Metadata Components and Types.

This call executes synchronously, which means that the call returns only when the operation completes.

Version

Available in API version 30.0 and later.

Permissions

Your client application must be logged in with the “Modify All Data” permission.

Basic Steps for Reading Metadata Components

Use the following process to read metadata components:

1. Determine the metadata type of the components you want to read, and the fullName of each component to read. See Metadata

for more details on the fullName field. You can read only components of the same type in a single call.

2. Invoke the readMetadata() call. For the first argument, pass in the name of the metadata type. The metadata type must match

one of the values returned by the describeMetadata() call. For the second argument, pass in an array of full names

corresponding to the components you wish to get. The full names must match one or more full names returned by the

listMetadata() call.

3. A ReadResult is returned that contains an array of Metadata components. Cast each returned Metadata object to the

metadata type you specified in the call to get the component’s properties.

Sample Code—Java

public void readCustomObjectSync() {

try {

ReadResult readResult = metadataConnection

.readMetadata("CustomObject",new String[] {

"MyCustomObject1__c","MyCustomObject2__c" });

readMetadata()CRUD-Based Calls

Metadata[] mdInfo = readResult.getRecords();

System.out.println("Number of component info returned: "

+ mdInfo.length);

for (Metadata md : mdInfo) {

if (md != null) {

CustomObject obj = (CustomObject) md;

System.out.println("Custom object full name: "

+ obj.getFullName());

System.out.println("Label: " + obj.getLabel());

System.out.println("Number of custom fields: "

+ obj.getFields().length);

System.out.println("Sharing model: "

+ obj.getSharingModel());

}else {

System.out.println("Empty metadata.");

}

}catch (ConnectionException ce) {

ce.printStackTrace();

}

Arguments

DescriptionTypeName

The metadata type of the components to read.stringmetadataType

Array of full names of the components to read.

Limit: 10. (For CustomMetadata and CustomApplication only, the limit is 200.)

string[]fullNames

You must submit arrays of only one type of component. For example, you can submit an array

of 10 custom objects or 10 profiles, but not a mix of both types.

Response

ReadResult

updateMetadata()

Updates one or more metadata components in your organization synchronously.

Syntax

SaveResult[] = metadataConnection.updateMetadata(Metadata[] metadata);

updateMetadata()CRUD-Based Calls

Usage

Use the updateMetadata() call to update any component that extends Metadata. All components must be of the same type in

the same call. For more details, see Metadata Components and Types.

This call executes synchronously, which means that the call returns only when the operation completes.

Starting in API version 34.0, this call supports the AllOrNoneHeader header. By default, if AllOrNoneHeader isn’t used in API version

34.0 and later, this call can save a partial set of records for records with no errors (equivalent to AllOrNoneHeader=false). In API

version 33.0 and earlier, the default behavior is to only save all records when there are no failures in any record in the call (equivalent to

AllOrNoneHeader=true).

Version

Available in API version 30.0 and later.

Permissions

Your client application must be logged in with the “Modify All Data” permission.

Required Fields

You must supply values for all the required fields in the component.

Valid Field Values

You must supply values that are valid for the field’s data type, such as integers for integer fields (not alphabetic characters). In your client

application, follow the data formatting rules specified for your programming language and development tool. (Your development tool

handles the appropriate mapping of data types in SOAP messages.)

String Values

When storing values in string fields, the API trims any leading and trailing white space. For example, if the value of a label field is

entered as "MyObject " the value is stored in the database as "MyObject".

Basic Steps for Updating Metadata Components

Use this process to update metadata components:

1. Create an array of the components you wish to update. All components must be of the same type.

2. Invoke the updateMetadata() call, passing in the array of metadata components to update.

A SaveResult object is returned for each component you tried to update. It contains information about whether the operation

was successful, the name of the component updated, and any errors returned if the operation wasn’t successful.

Sample Code—Java

public void updateCustomObjectSync() {

try {

updateMetadata()CRUD-Based Calls

CustomObject co = new CustomObject();

String name = "MyCustomObject1";

co.setFullName(name + "__c");

co.setDeploymentStatus(DeploymentStatus.Deployed);

co.setDescription("Updated description");

co.setLabel(name + " Object Update");

co.setPluralLabel(co.getLabel() + "s");

co.setSharingModel(SharingModel.ReadWrite);

// Name field with a type and label is required

CustomField cf = new CustomField();

cf.setType(FieldType.Text);

cf.setLabel(co.getFullName() + " Name");

co.setNameField(cf);

SaveResult[] results = metadataConnection

.updateMetadata(new Metadata[] { co });

for (SaveResult r : results) {

if (r.isSuccess()) {

System.out.println("Updated component: " + r.getFullName());

}else {

System.out

.println("Errors were encountered while updating "

+ r.getFullName());

for (Error e : r.getErrors()) {

System.out.println("Error message: " + e.getMessage());

System.out.println("Status code: " + e.getStatusCode());

}

}catch (ConnectionException ce) {

ce.printStackTrace();

}

Arguments

DescriptionTypeName

Array of one or more metadata components you wish to update.

Limit: 10. (For CustomMetadata and CustomApplication only, the limit is

200.)

Metadata[]metadata

You must submit arrays of only one type of component. For example, you

can submit an array of 10 custom objects or 10 profiles, but not a mix of

both types.

Response

SaveResult[]

updateMetadata()CRUD-Based Calls

upsertMetadata()

Creates or updates one or more metadata components in your organization synchronously.

Syntax

UpsertResult[] = metadataConnection.upsertMetadata(Metadata[] metadata);

Usage

Use the upsertMetadata() call to create or update any component that extends Metadata. All components must be of the same

type in the same call. For more details, see Metadata Components and Types.

If the specified components already exist in your organization, the upsertMetadata() call updates them. Otherwise,

upsertMetadata() creates these components. Components are matched by the fullname field. This call executes synchronously,

which means that the call returns only after the operation is completed.

Starting in API version 34.0, this call supports the AllOrNoneHeader header. By default, if AllOrNoneHeader isn’t used in API version

34.0 and later, this call can save a partial set of records for records with no errors (equivalent to AllOrNoneHeader=false). In API

version 33.0 and earlier, the default behavior is to only save all records when there are no failures in any record in the call (equivalent to

AllOrNoneHeader=true).

Version

Available in API version 31.0 and later.

Permissions

Your client application must be logged in with the “Modify All Data” permission.

Required Fields

You must supply values for all the required fields in the component.

Valid Field Values

You must supply values that are valid for the field’s data type, such as integers (not alphabetic characters) for integer fields. In your client

application, follow the data formatting rules that are specified for your programming language and development tool. (Your development

tool handles the appropriate mapping of data types in SOAP messages.)

String Values

The API trims any leading and trailing white space when storing values in string fields. For example, if the value of a label field is

entered as " MyObject ", the value is stored in the database as "MyObject".

upsertMetadata()CRUD-Based Calls

Basic Steps for Upserting Metadata Components

Use this process to upsert metadata components.

1. Create an array of Metadata objects that correspond to the components that you want to create or update. All components must

be of the same type.

2. Invoke upsertMetadata(), passing in the array of metadata components that you created in the previous step.

The upsertMetadata() call returns an array of UpsertResult objects. Each returned UpsertResult corresponds

to a component that you upserted and contains information about the upsert operation—whether the operation was successful,

the name of the component that was upserted, a flag indicating whether the component was created, and any errors that were

returned if the operation wasn’t successful.

Sample Code—Java

public void upsertMetadataSample() {

try {

// Create custom object to upsert

CustomObject co = new CustomObject();

String name = "MyCustomObject";

co.setFullName(name + "__c");

co.setDeploymentStatus(DeploymentStatus.Deployed);

co.setDescription("Upserted by the Metadata API");

co.setEnableActivities(true);

co.setLabel(name + " Object");

co.setPluralLabel(co.getLabel() + "s");

co.setSharingModel(SharingModel.ReadWrite);

CustomField nf = new CustomField();

nf.setType(FieldType.Text);

nf.setLabel("CustomField1");

co.setNameField(nf);

// Upsert the custom object

UpsertResult[] results = metadataConnection

.upsertMetadata(new Metadata[] { co });

for (UpsertResult r : results) {

if (r.isSuccess()) {

System.out.println("Success!");

if (r.isCreated()) {

System.out.println("Created component: "

+ r.getFullName());

}else {

System.out.println("Updated component: "

+ r.getFullName());

}

}else {

System.out

.println("Errors were encountered while upserting "

+ r.getFullName());

for (Error e : r.getErrors()) {

System.out.println("Error message: " + e.getMessage());

upsertMetadata()CRUD-Based Calls

System.out.println("Status code: " + e.getStatusCode());

}

}catch (ConnectionException ce) {

ce.printStackTrace();

}

Arguments

DescriptionTypeName

An array of one or more metadata components that you want to create

or update

Limit: 10.

Metadata[]metadata

You must submit arrays of only one type of component. For example, you

can submit an array of 10 custom objects or 10 profiles, but not a mix of

both types.

Response

UpsertResult[]

deleteMetadata()

Deletes one or more metadata components from your organization synchronously.

Syntax

DeleteResult[] = metadataConnection.delete(string metadataType, string[] fullNames);

Usage

Use the deleteMetadata() call to delete any component that extends Metadata. All components must be of the same type in

the same call. For more details, see Metadata Components and Types.

This call executes synchronously, which means that the call returns only when the operation completes.

Starting in API version 34.0, this call supports the AllOrNoneHeader header. By default, if the AllOrNoneHeader isn’t used in any

API version, this call can delete a partial set of records for records with no errors (equivalent to AllOrNoneHeader=false). If

AllOrNoneHeader is set to true, no records are deleted if one or more records cause a failure.

Version

Available in API version 30.0 and later.

deleteMetadata()CRUD-Based Calls

Permissions

Your client application must be logged in with the “Modify All Data” permission.

Rules and Guidelines

When deleting components, consider the following rules and guidelines:

•Your client application must be logged in with sufficient access rights to delete individual components within the specified component.

For more information, see “Factors that Affect Data Access” in the SOAP API Developer's Guide.

•In addition, you might also need permission to access this component’s parent component.

•To ensure referential integrity, this call supports cascading deletions. If you delete a parent component, you delete its children

automatically, as long as each child component can be deleted.

Basic Steps for Deleting Metadata Components

Use the following process to delete metadata components:

1. Determine the metadata type of the components you want to delete and the fullName of each component to delete. You can

delete only components of the same type in a single call. The full names must match one or more full names returned by the

listMetadata() call. See Metadata for more details on the fullName field.

2. Invoke the deleteMetadata() call. For the first argument, pass in the name of the metadata type. For the second argument,

pass in an array of full names corresponding to the components you wish to delete.

A DeleteResult object is returned for each component you try to delete. It contains information about whether the operation

was successful, the name of the deleted component, and any errors returned if the operation wasn’t successful.

Sample Code—Java

public void deleteCustomObjectSync() {

try {

DeleteResult[] results = metadataConnection.deleteMetadata(

"CustomObject",new String[] { "MyCustomObject1__c",

"MyCustomObject2__c" });

for (DeleteResult r : results) {

if (r.isSuccess()) {

System.out.println("Deleted component: " + r.getFullName());

}else {

System.out

.println("Errors were encountered while deleting "

+ r.getFullName());

for (Error e : r.getErrors()) {

System.out.println("Error message: " + e.getMessage());

System.out.println("Status code: " + e.getStatusCode());

}

}catch (ConnectionException ce) {

ce.printStackTrace();

}

deleteMetadata()CRUD-Based Calls

Arguments

DescriptionTypeName

The metadata type of the components to delete.stringmetadataType

Array of full names of the components to delete.

Limit: 10. (For CustomMetadata and CustomApplication only, the limit is 200.)

string[]fullNames

You must submit arrays of only one type of component. For example, you can submit an array

of 10 custom objects or 10 profiles, but not a mix of both types.

Response

DeleteResult[]

renameMetadata()

Renames a metadata component in your organization synchronously.

Syntax

SaveResult = metadataConnection.renameMetadata(string metadataType, String oldFullname,

String newFullname);

Usage

Use the renameMetadata() call to rename one metadata component in your organization. This call executes synchronously,

meaning the call returns only when the operation completes.

You can use this call to rename any of the objects that extend Metadata. For more details, see Metadata Components and Types.

Version

Available in API version 30.0 and later.

Permissions

Your client application must be logged in with the “Modify All Data” permission.

Basic Steps for Renaming Metadata Components

Use the following process to rename a metadata component:

1. Determine the metadata type of the component you want to rename, its current full name, and the new full name. See Metadata

for more details on the fullName field.

renameMetadata()CRUD-Based Calls

2. Invoke the renameMetadata() call. For the first argument, pass in the name of the metadata type. Pass in the old full name

as the second argument and the new full name as the last argument.

A SaveResult object is returned that contains information about whether the operation was successful, the name of the renamed

component (which is the new name if the renaming was successful), and any errors returned if the operation wasn’t successful.

Sample Code—Java

public void renameCustomObjectSync() {

try {

SaveResult[] results = metadataConnection.renameMetadata(

"CustomObject","MyCustomObject1__c","MyCustomObject1New__c");

for (SaveResult r : results) {

if (r.isSuccess()) {

System.out.println("Renamed component: " + r.getName());

}

else {

System.out.println("Errors were encountered while renaming " + r.getName());

for(Error e : r.getErrors()) {

System.out.println("Error message: " + e.getMessage());

System.out.println("Status code: " + e.getStatusCode());

}

}catch (ConnectionException ce) {

ce.printStackTrace();

}catch (InterruptedException ie) {

ie.printStackTrace();

}

Arguments

DescriptionTypeName

The metadata type of the components to rename.stringmetadataType

The current component full name.stringoldFullName

The new component full name.stringnewFullName

Response

SaveResult

create()

Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version

31.0 and is available in earlier versions only. Use createMetadata() instead.

create()CRUD-Based Calls

This call can be used to create any of the objects that extend Metadata. For more details, see Metadata Components and Types on page

117.

Syntax

AsyncResult[] = metadatabinding.create(Metadata[] metadata);

Usage

Use this call to add one or more metadata components to your organization.

Version

This call is available in API version 30.0 and earlier only. This call is not available in API version 31.0 and later. Use createMetadata()

instead.

Permissions

Your client application must be logged in with the “Modify All Data” permission.

Required Fields

Required fields are determined by the metadata components being created. For more information about specific component types, see

Metadata Components and Types on page 117.

Valid Data Values

You must supply values that are valid for the field’s data type, such as integers for integer fields (not alphabetic characters). In your client

application, follow the data formatting rules specified for your programming language and development tool (your development tool

handles the appropriate mapping of data types in SOAP messages).

String Values

When storing values in string fields, the API trims any leading and trailing whitespace. For example, if the value of a label field is

entered as "MyObject " the value is stored in the database as "MyObject".

Basic Steps for Creating Metadata Components

Use the following process to create metadata components:

1. Design an array and populate it with the components you want to create. All components must be of the same type.

2. Call create() with the component array passed in as an argument.

3. An AsyncResult object is returned for each component you triy to create, and is updated with status information as the operation

moves from a queue to completed or error state. Call checkStatus() in a loop until the status values in AsyncResult indicate

that all create operations are completed. Start with a wait time of one second between iterations of checkStatus() calls, and

double the wait time each time you make a subsequent call.

create()CRUD-Based Calls

Sample Code—Java

See Step 3: Walk Through the Java Sample Code on page 6 for sample Java code using the create() call.

Arguments

DescriptionTypeName

Array of one or more metadata components.

Metadata[]metadata

Limit: 10.

You must submit arrays of only one type of component. For example, you could submit an

array of 10 custom objects or 10 profiles, but not a mix of both types.

Response

AsyncResult[]

SEE ALSO:

createMetadata()

update()

delete()

checkStatus()

delete()

Deprecated. Deletes one or more components from your organization asynchronously. This call is removed as of API version 31.0 and is

available in earlier versions only. Use deleteMetadata() instead.

You can use this call to delete any of the objects that extend Metadata. For more details, see Metadata Components and Types on page

117.

Syntax

AsyncResult[] = metadataConnection.delete(Metadata[] metadata);

Usage

Use this call to delete one or more components from your organization.

Version

This call is available in API version 30.0 and earlier only. This call is not available in API version 31.0 and later. Use deleteMetadata()

instead.

delete()CRUD-Based Calls

Permissions

Your client application must be logged in with the “Modify All Data” permission.

Rules and Guidelines

When deleting components, consider the following rules and guidelines:

•Your client application must be logged in with sufficient access rights to delete individual components within the specified component.

For more information, see “Factors that Affect Data Access” in the SOAP API Developer's Guide.

•In addition, you might also need permission to access this component’s parent component.

•To ensure referential integrity, this call supports cascading deletions. If you delete a parent component, you delete its children

automatically, as long as each child component can be deleted.

Basic Steps for Deleting Metadata Components

Use the following process to delete metadata components:

1. Determine the fullName of each component you want to delete. See Metadata for more details on the fullName field. You

can only delete components of the same type in a single call.

2. Invoke the delete() call, passing in the array of metadata components with fullName specified.

3. An AsyncResult object is returned for each component you try to delete, and is updated with status information as the operation

moves from a queue to completed or error state. Call checkStatus() in a loop until the status values in AsyncResult indicate

that all the delete operations are completed. Start with a wait time of one second between iterations of checkStatus() calls,

and double the wait time each time you make a subsequent call.

Sample Code—Java

public void deleteCustomObject() {

try {

CustomObject co = new CustomObject();

co.setFullName("MyCustomObject__c");

AsyncResult[] ars = metadataConnection.create(new Metadata[]

{co});

AsyncResult asyncResult = ars[0];

long waitTimeMilliSecs = 1000;

while (!asyncResult.isDone()) {

Thread.sleep(waitTimeMilliSecs);

// double the wait time for the next iteration

waitTimeMilliSecs *= 2;

asyncResult = mdConnection.checkStatus(

new String[] {asyncResult.getId()})[0];

System.out.println("Status is: " + asyncResult.getState());

}

}catch (ConnectionException ce) {

ce.printStackTrace();

}catch (InterruptedException ie) {

ie.printStackTrace();

}

delete()CRUD-Based Calls

Arguments

DescriptionTypeName

Array of one or more metadata components. You only need to set the fullName field in

the Metadata object.

Metadata[]metadata

Limit: 10.

You must submit arrays of only one type of component. For example, you could submit an

array of 10 custom objects or 10 profiles, but not a mix of both types.

Response

AsyncResult[]

SEE ALSO:

deleteMetadata()

create()

update()

checkStatus()

update()

Deprecated. Updates one or more components in your organization asynchronously. This call is removed as of API version 31.0 and is

available in earlier versions only. Use updateMetadata() or renameMetadata() instead.

This call can be used to update any of the objects that extend Metadata. For more details, see Metadata Components and Types on page

117.

Syntax

AsyncResult[] = metadataConnection.update(UpdateMetadata[] metadata);

Usage

Use this call to update one or more components. This call is analogous to the ALTER TABLE statement in SQL.

Version

This call is available in API version 30.0 and earlier only. This call is not available in API version 31.0 and later. Use updateMetadata()

instead to update metadata components or renameMetadata() to rename a metadata component.

update()CRUD-Based Calls

Permissions

Your client application must be logged in with the “Modify All Data” permission.

Required Fields

You must supply values for all the required fields in the component.

Valid Field Values

You must supply values that are valid for the field’s data type, such as integers for integer fields (not alphabetic characters). In your client

application, follow the data formatting rules specified for your programming language and development tool (your development tool

handles the appropriate mapping of data types in SOAP messages).

String Values

When storing values in string fields, the API trims any leading and trailing white space. For example, if the value of a label field is

entered as "MyObject " the value is stored in the database as "MyObject".

Basic Steps for Updating Metadata Components

Use this process to update metadata components:

1. Create an array of UpdateMetadata components and populate it with the components you wish to update. All components

must be of the same type.

2. Invoke the update() call, passing in the array of metadata components to update.

3. An AsyncResult object is returned for each component you try to update, and is updated with status information as the operation

moves from a queue to completed or error state. In a loop, call checkStatus() until the status values in AsyncResult indicate

that all the update operations are completed. Start with a wait time of one second between iterations of checkStatus() calls,

and double the wait time each time you make a subsequent call.

Sample Code—Java

public void updateCustomObject() {

try {

CustomObject co = new CustomObject();

String name = "MyCustomObject";

co.setFullName(name + "__c");

co.setDeploymentStatus(DeploymentStatus.Deployed);

co.setDescription("Created by the Metadata API");

co.setEnableActivities(true);

co.setLabel(name + " Object");

co.setPluralLabel(co.getLabel() + "s");

co.setSharingModel(SharingModel.ReadWrite);

CustomField nf = new CustomField();

nf.setType(FieldType.Text);

nf.setLabel(co.getFullName() + " Name");

update()CRUD-Based Calls

co.setNameField(nf);

UpdateMetadata updateMetadata = new UpdateMetadata();

updateMetadata.setMetadata(co);

updateMetadata.setCurrentName("TheCurrentName");

AsyncResult[] ars = metadataConnection.update(new UpdateMetadata[]

{ updateMetadata });

AsyncResult asyncResult = ars[0];

// set initial wait time to one second in milliseconds

long waitTimeMilliSecs = 1000;

while (!asyncResult.isDone()) {

Thread.sleep(waitTimeMilliSecs);

// double the wait time for the next iteration

waitTimeMilliSecs *= 2;

asyncResult = metadataConnection.checkStatus(

new String[] {asyncResult.getId()})[0];

System.out.println("Status is: " + asyncResult.getState());

}

if (asyncResult.getState() != AsyncRequestState.Completed) {

System.out.println(asyncResult.getStatusCode() + " msg: " +

asyncResult.getMessage());

}

}catch (InterruptedException ie) {

ie.printStackTrace();

}catch (ConnectionException ce) {

ce.printStackTrace();

}

Arguments

DescriptionTypeName

Array of one or more UpdateMetadata data structures that represent the

components you wish to update.

Limit: 10.

UpdateMetadata[]metadata

You must submit arrays of only one type of component. For example, you

could submit an array of 10 custom objects or 10 profiles, but not a mix

of both types.

UpdateMetadata

One or more UpdateMetadata objects are defined in the metadata argument. This object can be used to update any of the objects

that extend Metadata. For more details, see Metadata Components and Types on page 117. Each UpdateMetadata object has the following

fields:

update()CRUD-Based Calls

DescriptionField TypeField

The API name of the component or field before the update. For example,

if you wanted to update a CustomObject named Foo, the value of this

stringcurrentName

field would be Foo__c. This value is supplied because this call may

change the name, and the value here provides mapping.

Full specification of the component or field you wish to update.Metadatametadata

Response

AsyncResult[]

SEE ALSO:

updateMetadata()

create()

delete()

checkStatus()

update()CRUD-Based Calls

CHAPTER 8 Utility Calls

Use the following utility calls to gather information that is useful for working with the file-based or CRUD-based calls.

•(Deprecated) checkStatus()

•describeMetadata()

•describeValueType()

•listMetadata()

checkStatus()

Deprecated. Checks the status of asynchronous metadata calls create(), update(), or delete(), or the declarative metadata

call retrieve(). This call is removed as of API version 31.0 and is available only in earlier versions.

Note: Starting in API version 29.0, you no longer have to call checkStatus() after a deploy() call to get information

about deployments. Similarly, starting in API version 31.0, you no longer have to call checkStatus() after a retrieve()

call. The checkStatus() call has been replaced by checkDeployStatus() and checkRetrieveStatus() for deploy and retrieve

operations respectively.

Syntax

AsyncResult[] = metadatabinding.checkStatus(ID[] ids);

Usage

Use this call to check whether or not an asynchronous metadata call or declarative metadata call has completed.

Version

This call is available only in API version 30.0 and earlier. This call is not available in API version 31.0 and later.

Sample Code—Java

See Step 3: Walk Through the Java Sample Code on page 6 for sample Java code using this call.

Arguments

DescriptionTypeName

Array of one or more IDs. Each ID is returned in an AsyncResult and corresponds to a component

being created, updated, deleted, deployed, or retrieved.

ID[]ids

Response

AsyncResult[]

describeMetadata()

This call retrieves the metadata that describes your organization. This information includes Apex classes and triggers, custom objects,

custom fields on standard objects, tab sets that define an app, and many other metadata types.

Syntax

DescribeMetadataResult = metadataConnection.describeMetadata(double apiVersion);

Arguments

DescriptionTypeName

The API version for which you want metadata; for example, 39.0.doubleapiVersion

Permissions

Your client application must be logged in with the “Modify All Data” permission.

Sample Code—Java

public void describeMetadata() {

try {

double apiVersion = 21.0;

// Assuming that the SOAP binding has already been established.

DescribeMetadataResult res =

metadataConnection.describeMetadata(apiVersion);

StringBuffer sb = new StringBuffer();

if (res != null && res.getMetadataObjects().length > 0) {

for (DescribeMetadataObject obj : res.getMetadataObjects()) {

sb.append("***************************************************\n");

sb.append("XMLName: " + obj.getXmlName() + "\n");

sb.append("DirName: " + obj.getDirectoryName() + "\n");

sb.append("Suffix: " + obj.getSuffix() + "\n");

describeMetadata()Utility Calls

sb.append("***************************************************\n");

}

}else {

sb.append("Failed to obtain metadata types.");

}

System.out.println(sb.toString());

}catch (ConnectionException ce) {

ce.printStackTrace();

}

Response

DescribeMetadataResult

When to Use describeMetadata() and describeValueType()?

Use the describeMetadata() call to get high-level information about all the metadata types that are available for your organization,

such as type names and file suffixes. Use the describeValueType() call to get granular information about a specific metadata

type, such as fields contained within the type.

describeValueType()

Retrieves the metadata describing a given metadata type (value type).

describeValueType() accepts a namespace and a type name, and returns a DescribeValueTypeResult object. This

call is available in API version 33.0 and later.

Syntax

DescribeValueTypeResult = connection.describeValueType("{namespace}type_name");

Example

Describe Apex class metadata in the Metadata namespace:

DescribeValueTypeResult =

metadataConnection.describeValueType("{http://soap.sforce.com/2006/04/metadata}ApexClass");

Describe Apex class metadata in the Tooling namespace:

DescribeValueTypeResult =

toolingConnection.describeValueType("{urn:metadata.tooling.soap.sforce.com}ApexClass");

describeValueType()Utility Calls

Arguments

DescriptionTypeName

The name of the metadata type for which you want metadata; for example, ApexClass.

Include the namespace.

stringtype

Permissions

Your client application must be logged in with the “Modify All Data” permission.

Sample Code—Java

The following example describes several metadata types by specifying the Metadata namespace. Each metadata type is described using

the helper method, doDescribe(), which calls the describeValueType() Metadata API call. The sample retrieves information

from the returned DescribeValueTypeResult: a property, the parent field (if any), and the fields. Next, the sample iterates

through the fields and outputs information about each field.

public void describeValueType() throws ConnectionException {

doDescribe("{http://soap.sforce.com/2006/04/metadata}CustomObject");

doDescribe("{http://soap.sforce.com/2006/04/metadata}CustomField");

doDescribe("{http://soap.sforce.com/2006/04/metadata}EmailTemplate");

}

public void doDescribe(String type) throws ConnectionException {

DescribeValueTypeResult result = metadataConnection.describeValueType(type);

StringBuffer sb = new StringBuffer();

sb.append("Describing " + type + " ...\n");

if (result.getApiCreatable() == true) {

sb.append("Is API creatable.\n");

}else {

sb.append("Is not API creatable.\n");

}

ValueTypeField parentField = result.getParentField();

if (parentField != null) {

sb.append("** Parent type fields **\n");

if (parentField.getIsForeignKey()) {

sb.append("This field is a foreign key.\n");

for (String fkDomain : parentField.getForeignKeyDomain()) {

sb.append("Foreign key domain: " + fkDomain + "\n");

}

sb.append("** Value type fields **\n");

for(ValueTypeField field : result.getValueTypeFields()) {

sb.append("***************************************************\n");

sb.append("Name: " + field.getName() + "\n");

describeValueType()Utility Calls

sb.append("SoapType: " + field.getSoapType() + "\n");

if (field.getIsForeignKey()) {

sb.append("This field is a foreign key.\n");

for (String fkDomain : field.getForeignKeyDomain()) {

sb.append("Foreign key domain: " + fkDomain + "\n");

}

sb.append("***************************************************\n");

}

System.out.println(sb.toString());

}

To run the previous example with the Tooling WSDL, replace the namespace with the Tooling namespace in the helper function call as

follows. Also, use the Tooling connection instead of the Metadata connection to make the describeValueType() call.

doDescribe("{urn:metadata.tooling.soap.sforce.com}CustomObject");

doDescribe("{urn:metadata.tooling.soap.sforce.com}CustomField");

doDescribe("{urn:metadata.tooling.soap.sforce.com}EmailTemplate");

After you run the sample, the output looks similar to the following.

Describing {http://soap.sforce.com/2006/04/metadata}CustomObject ...

Is API creatable.

** Value type fields **

***************************************************

Name: actionOverrides

SoapType: ActionOverride

***************************************************

Name: allowInChatterGroups

SoapType: boolean

***************************************************

Name: articleTypeChannelDisplay

SoapType: ArticleTypeChannelDisplay

***************************************************

Name: businessProcesses

SoapType: BusinessProcess

***************************************************

Name: compactLayoutAssignment

SoapType: string

***************************************************

Name: compactLayouts

SoapType: CompactLayout

***************************************************

Name: customHelp

SoapType: string

This field is a foreign key.

Foreign key domain: ApexPage

Foreign key domain: Scontrol

describeValueType()Utility Calls

***************************************************

Describing {http://soap.sforce.com/2006/04/metadata}CustomField ...

Is API creatable.

** Parent type fields **

This field is a foreign key.

Foreign key domain: CustomObject

** Value type fields **

***************************************************

Name: caseSensitive

SoapType: boolean

***************************************************

Name: customDataType

SoapType: string

***************************************************

Name: defaultValue

SoapType: string

***************************************************

Response

DescribeValueTypeResult

listMetadata()

This call retrieves property information about metadata components in your organization. Data is returned for the components that

match the criteria specified in the queries parameter. The queries array can contain up to three ListMetadataQuery queries for

each call. This call supports every metadata type: both top-level, such as CustomObject and ApexClass, and child types, such as CustomField

and RecordType.

Syntax

FileProperties[] = metadataConnection.listMetadata(ListMetadataQuery[] queries, double

asOfVersion);

Usage

This call is useful when you want to identify individual components in package.xml for a retrieve() call or if you want a

high-level view of particular metadata types in your organization. For example, you could use this call to return a list of names of all the

CustomObject or Layout components in your organization, and use this information to make a subsequent retrieve() call to return

a subset of these components. For more information about working with package.xml, see Deploying and Retrieving Metadata on

page 15.

listMetadata()Utility Calls

Note: This is a synchronous call so the results are returned in one call. This differs from asynchronous calls, such as retrieve(),

where at least one subsequent call is needed to get the results.

Permissions

Your client application must be logged in with the “Modify All Data” permission.

Sample Code—Java

The sample code below lists information about your custom objects. The code assumes that the SOAP binding has already been

established.

public void listMetadata() {

try {

ListMetadataQuery query = new ListMetadataQuery();

query.setType("CustomObject");

//query.setFolder(null);

double asOfVersion = 39.0;

// Assuming that the SOAP binding has already been established.

FileProperties[] lmr = metadataConnection.listMetadata(

new ListMetadataQuery[] {query}, asOfVersion);

if (lmr != null) {

for (FileProperties n : lmr) {

System.out.println("Component fullName: " + n.getFullName());

System.out.println("Component type: " + n.getType());

}

}catch (ConnectionException ce) {

ce.printStackTrace();

}

Arguments

DescriptionTypeName

A list of objects that specify which components you are interested in.ListMetadataQuery[]queries

The API version for the metadata listing request. If you don't specify a value in this field, it

defaults to the API version specified when you logged in. This field allows you to override

doubleasOfVersion

the default and set another API version so that, for example, you could list the metadata for

a metadata type that was added in a later version than the API version specified when you

logged in. This field is available in API version 18.0 and later.

Response

FileProperties

listMetadata()Utility Calls

ListMetadataQuery

The ListMetadataQuery parameter specified in a listMetadata() call consists of the following properties:

DescriptionTypeName

The folder associated with the component. This field is required

for components that use folders, such as Dashboard, Document,

EmailTemplate, or Report.

stringfolder

Required. The metadata type, such as CustomObject,

CustomField, or ApexClass.

stringtype

ListMetadataQueryUtility Calls

CHAPTER 9 Result Objects

Use the following objects to get the results of your file-based or CRUD-based calls.

IN THIS SECTION:

AsyncResult

Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata

call.

CancelDeployResult

Contains information about a deployment cancellation—whether the cancellation completed and the deployment ID.

DeployResult

Contains information about the success or failure of the associated deploy() call.

DescribeMetadataResult

Contains information about the organization that is useful for developers working with declarative metadata.

DescribeValueTypeResult

Contains information about a value type that is useful for developers working with declarative metadata.

ReadResult

Contains result information for the readMetadata call.

RetrieveResult

Contains information about the success or failure of the associated retrieve() call.

SaveResult

Contains result information for the createMetadata, updateMetadata, or renameMetadata call.

DeleteResult

Contains result information for the deleteMetadata call.

UpsertResult

Contains information about the result of the associated upsertMetadata() call.

Error

Represents an error that occurred during a synchronous CRUD (createMetadata(), updateMetadata(), or

deleteMetadata()) operation.

AsyncResult

Contains the ID of a deployment or retrieval. In API version 28.0 and earlier, contains status information of any asynchronous metadata

call.

API Version 31.0 and Later

In API version 31.0, the process of retrieving metadata has been simplified and retrieval properties have been moved to RetrieveResult.

Also, the asynchronous create(), update(), and delete() calls have been removed. Therefore, only the id field in AsyncResult

is used. The id field is the ID of a deployment or retrieval.

AsyncResult is returned by the following asynchronous calls.

•deploy()

•retrieve()

AsyncResult has the following field that is in use.

DescriptionTypeName

Required. The ID of the component that’s being deployed or retrieved.IDid

All fields in AsyncResult other than id are deprecated as of API version 31.0. These fields exist but are no longer in use.

•done

•message

•state

•statusCode

API Versions 29.0 and 30.0

In API version 29.0, Salesforce moved several properties from the AsyncResult object to the DeployResult object and added several new

ones, to improve the process for getting information about deployments. For more information about these changes, see deploy().

In API versions 29.0 and 30.0, AsyncResult is returned by the same asynchronous calls as in API version 28.0 and earlier, but it has different

fields.

DescriptionTypeName

Required. Indicates whether the call has been completed (true) or not

(false).

booleandone

Required. The ID of the component that’s being created, updated, deleted,

deployed, or retrieved.

IDid

The message that corresponds to the returned statusCode field, if any.stringmessage

Required. The AsyncRequestState object has one of four possible values.AsyncRequestState

(enumeration of

type string)

state

•Queued: This call has not started. It is waiting in a queue.

•InProgress: This call has started but has not been completed.

•Completed: This call has been completed.

•Error: An error occurred. See the statusCode for more information.

AsyncResultResult Objects

DescriptionTypeName

If an error occurred during the create(), update(), or delete() call,

a status code is returned, and the message that corresponds to the status code

is returned in the message field.

For a description of each StatusCode value, see “StatusCode” in the SOAP API

Developer's Guide.

StatusCode

(enumeration of

type string)

statusCode

API Version 28.0 and Earlier

In API version 28.0 and earlier, AsyncResult is returned by the following asynchronous calls.

•deploy()

•retrieve()

•create()

•update()

•delete()

Use the checkStatus() call against each object to discover when the call is completed for that object. Salesforce updates each

AsyncResult object as the call is completed or when errors occur.

Similarly, the deploy() and retrieve() calls use AsyncResult, though you must subsequently use checkDeployStatus()

or checkRetrieveStatus() respectively to get more status information for the deployment or retrieval.

AsyncResult has the following fields.

DescriptionTypeName

Indicates whether this deployment is being used to check the validity of the

deployed files without making any changes in the organization (true) or not

booleancheckOnly

(false). A check-only deployment does not deploy any components or

change the organization in any way. This field is available in API version 16.0

and later and is relevant only for the deploy() call.

Required. Indicates whether the call has been completed (true) or not

(false).

booleandone

Required. The ID of the component that’s being created, updated, deleted,

deployed, or retrieved.

IDid

The message that corresponds to the returned statusCode field, if any.stringmessage

The number of components that generated errors during this deployment.

This field is available in API version 16.0 and later and is relevant only for the

deploy() call.

intnumberComponentErrors

The number of components that have been deployed for this deployment.

This field in conjunction with the numberComponentsTotal field gives

intnumberComponentsDeployed

you an indication of the progress of the deployment. This field is available in

API version 16.0 and later and is relevant only for the deploy() call.

AsyncResultResult Objects

DescriptionTypeName

The total number of components in the deployment. This field in conjunction

with the numberComponentsDeployed field gives you an indication of

intnumberComponentsTotal

the progress of the deployment. This field is available in API version 16.0 and

later and is relevant only for the deploy() call.

The number of Apex tests that generated errors during this deployment. This

field is available in API version 16.0 and later and is relevant only for the

deploy() call.

intnumberTestErrors

The number of Apex tests that have been completed for this deployment. This

field in conjunction with the numberTestsTotal field gives you an

intnumberTestsCompleted

indication of the progress of tests for the deployment. This field is available in

API version 16.0 and later and is relevant only for the deploy() call.

The total number of Apex tests in the deployment. This field in conjunction

with the numberTestsCompleted field gives you an indication of the

intnumberTestsTotal

progress of tests for the deployment. The value in this field is not accurate until

the deployment has started running tests for the components that are being

deployed. This field is available in API version 16.0 and later and is relevant only

for the deploy() call.

This field is no longer supported for API version 13.0 and later and is provided

only for backward compatibility. The field was removed in API version 17.0.

Indicates the number of seconds before the call is likel to be completed. This

is an estimate only. A reasonable approach is to wait one second before calling

intsecondsToWait

checkStatus() to see if the operation is complete. Double your wait time

for each successive iteration of checkStatus() calls until the operation

is complete.

Required. The AsyncRequestState object has one of four possible values.AsyncRequestState

(enumeration of

type string)

state

•Queued: This call has not started. It is waiting in a queue.

•InProgress: This call has started but has not been completed.

•Completed: This call has been completed.

•Error: An error occurred. See the statusCode for more information.

Indicates which component is being deployed or which Apex test class is

running. This field is available in API version 16.0 and later and is relevant only

for the deploy() call.

stringstateDetail

The date and time when the stateDetail field was last modified. This field

is available in API version 16.0 and later and is relevant only for the deploy()

call.

dateTimestateDetailLastModifiedDate

If an error occurred during the create(), update(), delete(), or

deploy() call, a status code is returned, and the message that corresponds

to the status code is returned in the message field.

For a description of each StatusCode value, see “StatusCode” in the SOAP API

Developer's Guide.

StatusCode

(enumeration of

type string)

statusCode

AsyncResultResult Objects

CancelDeployResult

Contains information about a deployment cancellation—whether the cancellation completed and the deployment ID.

The asynchronous metadata call cancelDeploy() returns a CancelDeployResult object.

Version

Available in API version 30.0 and later.

CancelDeployResult has the following properties.

DescriptionTypeName

Indicates whether the deployment cancellation, which is started through

cancelDeploy(), has completed (true) or not (false).

When a deployment hasn’t started yet and is still in the queue, the deployment

is canceled immediately with the cancelDeploy() call and this field returns

true. Otherwise, this field returns false when the cancellation is in progress.

booleandone

ID of the deployment being canceled.IDid

DeployResult

Contains information about the success or failure of the associated deploy() call.

The asynchronous metadata call checkDeployStatus() returns a DeployResult object.

In API version 29.0, Salesforce moved several properties from the AsyncResult on page 87 object to the DeployResult object to improve

the process for getting information about deployments. For more information about these changes, see deploy() on page 33.

For API version 29.0 and later, the DeployResult object has the following properties.

DescriptionTypeName

ID of the component being deployed.IDid

The ID of the user who canceled the deployment.

This field is available in API version 30.0 and later.

IDcanceledBy

The full name of the user who canceled the deployment.

This field is available in API version 30.0 and later.

stringcanceledByName

Indicates whether this deployment is being used to check the validity of the

deployed files without making any changes in the organization (true) or not

booleancheckOnly

(false). A check-only deployment does not deploy any components or change

the organization in any way.

Timestamp for when the deployment process ended.dateTimecompletedDate

CancelDeployResultResult Objects

DescriptionTypeName

The ID of the user who created the deployment.

This field is available in API version 30.0 and later.

IDcreatedBy

The full name of the user who created the deployment.

This field is available in API version 30.0 and later.

stringcreatedByName

Timestamp for when the deploy() call was received.dateTimecreatedDate

Provides the details of a deployment that is in-progress or ended, if the

includeDetails parameter is set to true in the

checkDeployStatus() call.

DeployDetails[]details

Indicates whether the server finished processing the deploy() call for the

specified id.

booleandone

Message corresponding to the values in the errorStatusCode field, if any.stringerrorMessage

If an error occurred during the deploy() call, a status code is returned, and the

message corresponding to the status code is returned in the

errorMessagefield.

For a description of each StatusCode value, see “StatusCode” in the SOAP API

Developer's Guide.

stringerrorStatusCode

Optional. Defaults to false. Specifies whether a deployment should continue

even if the deployment generates warnings. Do not set this argument to true

for deployments to production organizations.

booleanignoreWarnings

Timestamp of the last update for the deployment process.dateTimelastModifiedDate

The number of components that generated errors during this deployment.intnumberComponentErrors

The number of components deployed in the deployment process. Use this value

with the numberComponentsTotal value to get an estimate of the

deployment’s progress.

intnumberComponentsDeployed

The total number of components in the deployment. Use this value with the

numberComponentsDeployed value to get an estimate of the deployment’s

progress.

intnumberComponentsTotal

The number of Apex tests that have generated errors during this deployment.intnumberTestErrors

The number of completedApex tests for this deployment. Use this value with the

numberTestsTotal value to get an estimate of the deployment’s test

progress.

intnumberTestsCompleted

The total number of Apex tests for this deployment. Use this value with the

numberTestsCompleted value to get an estimate of the deployment’s test

intnumberTestsTotal

progress. The value in this field is not accurate until the deployment has started

running tests for the components being deployed.

DeployResultResult Objects

DescriptionTypeName

Indicates whether Apex tests were run as part of this deployment (true) or not

(false). Tests are either automatically run as part of a deployment or can be set

booleanrunTestsEnabled

to run in DeployOptions for the deploy() call. For information on when

tests are automatically run, see Running Tests in a Deployment.

This field is available in API version 30.0 and later.

Optional. Defaults to true. Indicates whether any failure causes a complete rollback

(true) or not (false). If false, whatever set of actions can be performed

booleanrollbackOnError

without errors are performed, and errors are returned for the remaining actions.

This parameter must be set to true if you are deploying to a production

organization.

Timestamp for when the deployment process began.dateTimestartDate

Indicates which component is being deployed or which Apex test class is running.stringstateDetail

Indicates the current state of the deployment. The valid values are:DeployStatus

(enumeration of

type string)

status

•Pending

•InProgress

•Succeeded

•SucceededPartial

•Failed

•Canceling

•Canceled

Indicates whether the deployment was successful (true) or not (false).booleansuccess

DeployDetails

These fields provide more information for the details field of the DeployResult object, if the includeDetails parameter is set

to (true in the deploy() call.

Note: While a deployment is still in-progress, the DeployDetails object only contains componentFailures data. After the

deployment process finishes, the other fields populate with the data for the entire deployment.

DescriptionTypeName

One or more DeployMessage objects containing deployment errors for each

component.

DeployMessage[]componentFailures

One or more DeployMessage objects containing successful deployment details for

each component.

DeployMessage[]componentSuccesses

If the performRetrieve parameter was specified for the deploy() call, a

retrieve() call is performed immediately after the deploy() process

completes. This field contains the results of that retrieval.

RetrieveResultretrieveResult

DeployResultResult Objects

DescriptionTypeName

If tests were run for the deploy() call, this field contains the test results. While a

deployment is still in-progress, this field only contains error data. After the deployment

process finishes, this field populates with the data for the entire deployment.

RunTestsResultrunTestResult

For API version 28.0 and earlier, the DeployResult object has the following properties.

DescriptionTypeName

ID of the component being deployed.IDid

Contains information about the success or failure of a deploy() call.DeployMessage[]messages

If the performRetrieve parameter was specified for the deploy() call, a

retrieve() call is performed immediately after the deploy() process completes.

This field contains the results of that retrieval.

RetrieveResultretrieveResult

If tests were run for the deploy() call, this field contains the test results.RunTestsResultrunTestResult

Indicates whether the deployment was successful (true) or not (false).booleansuccess

DeployMessage

Each DeployResult object contains one or more DeployMessage objects. Each DeployMessage object contains information about the

deployment success or failure of a component in the deployment .zip file:

DescriptionTypeName

If true, the component was changed as a result of this deployment. If false, the

deployed component was the same as the corresponding component already in the

organization.

booleanchanged

Each component is represented by a text file. If an error occurred during deployment,

this field represents the column of the text file where the error occurred.

intcolumnNumber

The metadata type of the component in this deployment.

This field is available in API version 30.0 and later.

stringcomponentType

If true, the component was created as a result of this deployment. If false, the

component was either deleted or modified as a result of the deployment.

booleancreated

The date and time when the component was created as a result of this deployment.

This field is available in API version 30.0 and later.

dateTimecreatedDate

If true, the component was deleted as a result of this deployment. If false, the

component was either new or modified as result of the deployment.

booleandeleted

The name of the file in the .zip file used to deploy this component.stringfileName

DeployResultResult Objects

DescriptionTypeName

The full name of the component.

Inherited from Metadata, this field is not defined in the WSDL for this metadata type.

It must be specified when creating, updating, or deleting. See create() to see an

example of this field specified for a call.

stringfullName

ID of the component being deployed.IDid

Each component is represented by a text file. If an error occurred during deployment,

this field represents the line number of the text file where the error occurred.

intlineNumber

If an error or warning occurred, this field contains a description of the problem that

caused the compile to fail.

stringproblem

Indicates the problem type. The problem details are tracked in the problem field.

The valid values are:

DeployProblemType

(enumeration of

type string)

problemType

•Warning

•Error

This field is available in API version 18.0 and later. Prior to version 18.0, there was no

distinction between warnings and errors. All problems were treated as errors and

prevented a successful deployment.

Indicates whether the component was successfully deployed (true) or not (false).booleansuccess

RunTestsResult

Contains information about the execution of unit tests, including whether unit tests were completed successfully, code coverage results,

and failures.

A RunTestsResult object has the following properties

DescriptionTypeName

The ID of an ApexLog object that is created at the end of a test run. The ApexLog

object is created if there is an active trace flag on the user running an Apex test,

or on a class or trigger being executed.

stringapexLogId

This field is available in API version 35.0 and later.

An array of one or more CodeCoverageResult objects that contains the details

of the code coverage for the specified unit tests.

CodeCoverageResult[]codeCoverage

An array of one or more code coverage warnings for the test run. The results

include both the total number of lines that could have been executed, as well

as the number, line, and column positions of code that was not executed.

CodeCoverageWarning[]codeCoverageWarnings

An array of one or more RunTestFailure objects that contain information about

the unit test failures, if there are any.

RunTestFailure[]failures

The number of failures for the unit tests.intnumFailures

DeployResultResult Objects

DescriptionTypeName

The number of unit tests that were run.intnumTestsRun

An array of one or more RunTestSuccess objects that contain information about

successes, if there are any.

RunTestSuccess[]successes

The total cumulative time spent running tests. This can be helpful for

performance monitoring.

doubletotalTime

CodeCoverageResult

The RunTestsResult object contains this object. It contains information about whether or not the compile of the specified Apex and run

of the unit tests was successful.

DescriptionTypeName

For each class or trigger tested, for each portion of code tested, this property contains

the DML statement locations, the number of times the code was executed, and the

CodeLocation[]dmlInfo

total cumulative time spent in these calls. This can be helpful for performance

monitoring.

The ID of the CodeLocation. The ID is unique within an organization.IDid

For each class or trigger tested, if any code is not covered, the line and column of the

code not tested, and the number of times the code was executed.

CodeLocation[]locationsNotCovered

For each class or trigger tested, the method invocation locations, the number of times

the code was executed, and the total cumulative time spent in these calls. This can

be helpful for performance monitoring.

CodeLocation[]methodInfo

The name of the class or trigger covered.stringname

The namespace that contained the unit tests, if one is specified.stringnamespace

The total number of code locations.intnumLocations

For each class or trigger tested, the location of SOQL statements in the code, the

number of times this code was executed, and the total cumulative time spent in

these calls. This can be helpful for performance monitoring.

CodeLocation[]soqlInfo

Do not use. In early, unsupported releases, used to specify class or package.stringtype

CodeCoverageWarning

The RunTestsResult object contains this object. It contains information about the Apex class which generated warnings.

This object has the following properties.

DescriptionTypeName

The ID of the CodeLocation. The ID is unique within an organization.IDid

The message of the warning generated.stringmessage

DeployResultResult Objects

DescriptionTypeName

The namespace that contained the unit tests, if one is specified.stringname

The namespace that contained the unit tests, if one is specified.stringnamespace

RunTestFailure

The RunTestsResult object returns information about failures during the unit test run.

This object has the following properties.

DescriptionTypeName

The ID of the class which generated failures.IDid

The failure message.stringmessage

The name of the method that failed.stringmethodName

The name of the class that failed.stringname

The namespace that contained the class, if one was specified.stringnamespace

Indicates whether the test method has access to organization data (true) or not

(false).

This field is available in API version 33.0 and later.

booleanseeAllData

The stack trace for the failure.stringstackTrace

The time spent running tests for this failed operation. This can be helpful for

performance monitoring.

doubletime

Do not use. In early, unsupported releases, used to specify class or package.stringtype

RunTestSuccess

The RunTestsResult object returns information about successes during the unit test run.

This object has the following properties.

DescriptionTypeName

The ID of the class which generated the success.IDid

The name of the method that succeeded.stringmethodName

The name of the class that succeeded.stringname

The namespace that contained the unit tests, if one is specified.stringnamespace

Indicates whether the test method has access to organization data (true) or not

(false).

This field is available in API version 33.0 and later.

booleanseeAllData

DeployResultResult Objects

DescriptionTypeName

The time spent running tests for this operation. This can be helpful for performance

monitoring.

doubletime

CodeLocation

The RunTestsResult object contains this object in a number of fields.

This object has the following properties.

DescriptionTypeName

The column location of the Apex tested.intcolumn

The line location of the Apex tested.intline

The number of times the Apex was executed in the test run.intnumExecutions

The total cumulative time spent at this location. This can be helpful for performance

monitoring.

doubletime

DescribeMetadataResult

Contains information about the organization that is useful for developers working with declarative metadata.

The describeMetadata() call returns a DescribeMetadataResult object.

Each DescribeMetadataResult object has the following properties:

DescriptionTypeName

One or more metadata components and their attributes.DescribeMetadataObject[]metadataObjects

The namespace of the organization. Specify only for Developer Edition

organizations that can contain a managed package. The managed package has

a namespace specified when it is created.

stringorganizationNamespace

Indicates whether rollbackOnError is allowed (true) or not (false).

This value is always :

booleanpartialSaveAllowed

•false in production organizations.

•the opposite of testRequired.

Indicates whether tests are required (true) or not (false).

This value is always the opposite of partialSaveAllowed.

booleantestRequired

DescribeMetadataObject

This object is returned as part of the DescribeMetadataResult. Each DescribeMetadataObject has the following properties:

DescribeMetadataResultResult Objects

DescriptionTypeName

List of child sub-components for this component.string[]childXmlNames

The name of the directory in the .zip file that contains this component.stringdirectoryName

Indicates whether the component is in a folder (true) or not (false). For example,

documents, email templates and reports are stored in folders.

booleaninFolder

Indicates whether the component requires an accompanying metadata file. For example,

documents, classes, and s-controls are components that require an additional metadata

file.

booleanmetaFile

The file suffix for this component.stringsuffix

The name of the root element in the metadata file for this component. This name also

appears in the Packages > types > name field in the manifest file package.xml.

stringxmlName

DescribeValueTypeResult

Contains information about a value type that is useful for developers working with declarative metadata.

The describeValueType() call returns a DescribeValueTypeResult object.

Each DescribeValueTypeResult object has the following properties.

DescriptionTypeName

Indicates whether this value type can be created through the createMetadata()

call (true) or not (false).

This field is available in API version 36.0 and later.

booleanapiCreatable

Indicates whether this value type can be created through the deleteMetadata()

call (true) or not (false).

This field is available in API version 36.0 and later.

booleanapiDeletable

Indicates whether this value type can be created through the readMetadata()

call (true) or not (false).

This field is available in API version 36.0 and later.

booleanapiReadable

Indicates whether this value type can be created through the updateMetadata()

call (true) or not (false).

This field is available in API version 36.0 and later.

booleanapiUpdatable

Information about the parent of this value type. Parent field information is useful

for metadata types that are specified with the parent in their name, such as

ValueTypeFieldparentField

custom fields, email templates, workflow rules, and reports. For example, the

full name of a custom field includes the sObject that contains it (for example,

Account.field1__c). Similarly, the full name of an email template includes

DescribeValueTypeResultResult Objects

DescriptionTypeName

the folder where the template is stored (for example,

MyFolder/EmailTemplate1).

If the value type has no parent, this field is null.

This field is available in API version 36.0 and later.

One or more metadata components and their attributes.ValueTypeField[]valueTypeFields

ValueTypeField

This object is returned as part of the DescribeValueTypeResult and represents the metadata for one field. Each ValueTypeField has the

following properties.

DescriptionTypeName

The ValueTypeField object for the next field, if any.ValueTypeFieldfields

If isForeignKey is True, foreignKeyDomain is the type

of object, such as Account or Opportunity.

stringforeignKeyDomain

True if the field is a foreign key. That means this field is the primary

key in a different database table.

booleanisForeignKey

True if this value type field is a fullName field, otherwise False.booleanisNameField

1 if this field is required, 0 otherwise.intminOccurs

The name of this value type field. The name is null for parent fields.stringname

The individual picklist values if the field is a picklist.PicklistEntrypicklistValues

The data type of the field, such as boolean or double.stringsoapType

Required. Indicates whether this value type field must have a value

(true) or can be null (false).

booleanvalueRequired

ReadResult

Contains result information for the readMetadata call.

Version

Available in API version 30.0 and later.

100

ReadResultResult Objects

Properties

DescriptionTypeName

An array of metadata components returned from readMetadata().Metadata[]records

RetrieveResult

Contains information about the success or failure of the associated retrieve() call.

The metadata retrieve() call returns a RetrieveResult object.

Each RetrieveResult object has the following fields:

DescriptionTypeName

Required. Indicates whether the retrieve() call is completed (true) or not (false).

This field is available in API version 31.0 and later.

booleandone

If an error occurs during the retrieve() call, this field contains a descriptive message

about this error. This field is available in API version 31.0 and later.

stringerrorMessage

If an error occurs during the retrieve() call, this field contains the status code for

this error. This field is available in API version 31.0 and later.

For a description of each StatusCode value, see “StatusCode” in the SOAP API Developer's

Guide.

StatusCodeerrorStatusCode

Contains information about the properties of each component in the .zip file, and the

manifest file package.xml. One object per component is returned.

FileProperties[]fileProperties

ID of the component being retrieved.IDid

Contains information about the success or failure of the retrieve() call.RetrieveMessage[]messages

The status of the retrieve() call. Valid values are:RetrieveStatus

(enumeration of type

string)

status

•Pending

•InProgress

•Succeeded

•Failed

This field is available in API version 31.0 and later.

Indicates whether the retrieve() call was successful (true) or not (false). This

field is available in API version 31.0 and later.

booleansuccess

The zip file returned by the retrieve request. Base 64-encoded binary data. Prior to making

an API call, client applications must encode the binary attachment data as base64. Upon

base64BinaryzipFile

receiving a response, client applications must decode the base64 data to binary. This

conversion is usually handled for you by a SOAP client.

101

RetrieveResultResult Objects

FileProperties

This component contains information about the properties of each component in the .zip file, and the manifest file package.xml.

One object per component is returned. Note that this component does not contain information about any associated metadata files in

the .zip file, only the component files and manifest file. FileProperties contains the following properties:

DescriptionTypeName

Required. ID of the user who created the file.stringcreatedById

Required. Name of the user who created the file.stringcreatedByName

Required. Date and time when the file was created.dateTimecreatedDate

Required. Name of the file.stringfileName

Required. The file developer name used as a unique identifier for API access.

The value is based on the fileName but the characters allowed are more

stringfullName

restrictive. The fullName can contain only underscores and alphanumeric

characters. It must be unique, begin with a letter, not include spaces, not end

with an underscore, and not contain two consecutive underscores.

Required. ID of the file.stringid

Required. ID of the user who last modified the file.stringlastModifiedById

Required. Name of the user who last modified the file.stringlastModifiedByName

Required. Date and time that the file was last modified.dateTimelastModifiedDate

Indicates the manageable state of the specified component if it is contained in

a package:

ManageableState

(enumeration of type

string)

manageableState

•beta

•deleted

•deprecated

•installed

•released

•unmanaged

For more information about states of manageability for components in

Force.com AppExchange packages, see “Planning the Release of Managed

Packages” in the Salesforce online help.

If any, the namespace prefix of the component.stringnamespacePrefix

Required. The metadata type, such as CustomObject, CustomField,

or ApexClass.

stringtype

RetrieveMessage

RetrieveResult returns this object, which contains information about the success or failure of the retrieve() call. One object per

problem is returned:

102

RetrieveResultResult Objects

DescriptionTypeName

The name of the file in the retrieved .zip file where a problem occurred.stringfileName

A description of the problem that occurred.stringproblem

SEE ALSO:

retrieve()

SaveResult

Contains result information for the createMetadata, updateMetadata, or renameMetadata call.

Version

Available in API version 30.0 and later.

Properties

DescriptionTypeName

An array of errors returned if the operation wasn’t successful.Error[]errors

The full name of the component processed.stringfullName

Indicates whether the operation was successful (true) or not (false).booleansuccess

DeleteResult

Contains result information for the deleteMetadata call.

Version

Available in API version 30.0 and later.

Properties

DescriptionTypeName

An array of errors returned if the operation wasn’t successful.Error[]errors

The full name of the deleted component.stringfullName

Indicates whether the deletion was successful (true) or not (false).booleansuccess

103

SaveResultResult Objects

UpsertResult

Contains information about the result of the associated upsertMetadata() call.

Version

Available in API version 31.0 and later.

Properties

DescriptionTypeName

Indicates whether the upsert operation resulted in the creation of the

component (true) or not (false). If false and the upsert operation was

successful, this means that the component was updated.

booleancreated

An array of errors that were returned if the operation wasn’t successful.Error[]errors

The full name of the component that was created or updated if the operation

was successful.

stringfullName

Indicates whether the operation was successful (true) or not (false).booleansuccess

Error

Represents an error that occurred during a synchronous CRUD (createMetadata(), updateMetadata(), or

deleteMetadata()) operation.

Version

Available in API version 30.0 and later.

Properties

DescriptionTypeName

More details about the error, including an extended error code and

extra error properties, when available. Reserved for future use.

For a description of the ExtendedErrorDetails element, see

“ExtendedErrorDetails” in the SOAP API Developer's Guide.

ExtendedErrorDetailsextendedErrorDetails

An array containing names of fields that affected the error condition.string[]fields

The error message text.stringmessage

104

UpsertResultResult Objects

DescriptionTypeName

A status code corresponding to the error.

For a description of each StatusCode value, see “StatusCode” in the

SOAP API Developer's Guide.

StatusCodestatusCode

105

ErrorResult Objects

CHAPTER 10 Metadata Types

Metadata API enables you to access some entities and feature settings that you can customize in the user interface. The following table

lists the metadata types that you can retrieve or deploy and whether you can retrieve the metadata type with the wildcard character (*)

in package.xml. For more information about using wildcards, see Working with the Zip File.

Note:

•Metadata type names are case-sensitive. Specifying a type name with an invalid case results in a deployment error.

•Metadata types don’t always correspond directly to their related data types. In some cases, the information is accessible but

not organized as expected. For example, dependent picklists are exposed as a type of picklist, not a separate metadata type.

•The wildcard character doesn’t apply to metadata types for feature settings, like AccountSettings. The wildcard applies only

when retrieving all settings and not an individual setting. See Settings.

DescriptionAllows Wildcard

(*)?

Metadata Type

Represents an organization’s account settings for account teams, account

owner report, and the View Hierarchy link.

Not ApplicableAccountSettings

Represents the action link group template. Action link templates let you reuse

action link definitions and package and distribute action links. An action link

YesActionLinkGroupTemplate

is a button on a feed element. Clicking on an action link can take a user to

another Web page, initiate a file download, or invoke an API call to an external

server or Salesforce. Use action links to integrate Salesforce and third-party

services into the feed. Every action link belongs to an action link group and

action links within the group are mutually exclusive.

Represents an action override on a standard or custom object. Use it to create,

update, edit, or delete action overrides.

NoActionOverride

Represents an organization’s activity settings, and its user interface settings

for the calendar.

Not ApplicableActivitiesSettings

Represents the configuration of country and state picklists.Not ApplicableAddressSettings

Represents a reporting snapshot. A reporting snapshot lets you report on

historical data. Authorized users can save tabular or summary report results

NoAnalyticSnapshot

to fields on a custom object, then map those fields to corresponding fields

on a target object. They can then schedule when to run the report to load

the custom object's fields with the report's data. Reporting snapshots enable

you to work with report data similarly to how you work with other records in

Salesforce.

106

DescriptionAllows Wildcard

(*)?

Metadata Type

Represents an Apex class. An Apex class is a template or blueprint from which

Apex objects are created. Classes consist of other classes, user-defined

methods, variables, exception types, and static initialization code.

YesApexClass

Represents a Visualforce component.YesApexComponent

Represents a Visualforce page.YesApexPage

Represents an Apex trigger. A trigger is Apex code that executes before or

after specific data manipulation language (DML) events occur, such as before

YesApexTrigger

object records are inserted into the database, or after records have been

deleted.

Represents the Force.com app menu or the Salesforce1 navigation menu.YesAppMenu

Represents the metadata associated with an approval process. An approval

process automates how records are approved in Salesforce. An approval

Yes

(See description.)

ApprovalProcess

process specifies each step of approval, including who to request approval

from and what to do at each point of the process.

Use the wildcard (*) symbol to retrieve all approval processes for all objects.

You can’t use it to retrieve a subset of approval processes; syntax such as

Lead.* is not supported.

Represents the metadata associated with an article type.YesArticleType

Represents assignment rules that allow you to automatically route cases to

the appropriate users or queues.

YesAssignmentRules

Represents an authentication provider (or auth provider) in your organization.

An auth provider enables users to log in to your Salesforce organization using

YesAuthProvider

their login credentials from an external service provider such as Facebook©

or Janrain©.

Represents a Lightning definition bundle. A bundle contains a Lightning

definition and all its related resources. The definition can be a component,

application, event, interface, or a tokens collection.

YesAuraDefinitionBundle

Represents an auto-response rule that sets conditions for sending automatic

email responses to lead or case submissions based on the attributes of the

submitted record.

YesAutoResponseRules

Represents the base container for criteria-based and owner-based sharing

rules.

YesBaseSharingRule

Represents the metadata used to manage settings for business hours and

holidays in entitlements, entitlement templates, campaigns, and cases.

Not ApplicableBusinessHoursSettings

The BusinessProcess metadata type enables you to display different picklist

values for users based on their profile.

Supports wildcard (*) only if a RecordType is specified.

(See description.)BusinessProcess

107

Metadata Types

DescriptionAllows Wildcard

(*)?

Metadata Type

Represents the Call Center definition used to integrate Salesforce with a

third-party computer-telephony integration (CTI) system.

YesCallCenter

Represents an organization’s case settings, such as the default case owner,

which case-related features are enabled, and which email templates are used

for various case activities.

Not ApplicableCaseSettings

Represents a certificate used for digital signatures which verify that requests

are coming from your org. Certificates are used for either authenticated single

YesCertificate

sign-on with an external website, or when using your org as an identity

provider.

Represents the metadata used to manage settings for Chatter Answers.Not ApplicableChatterAnswersSettings

Represents a data service that adds and updates data in standard objects.YesCleanDataService

Represents global settings that affect multiple features in your organization.Not ApplicableCompanySettings

Represents a zone that contains Ideas or Chatter Answers objects. Zones are

shared by the Ideas, Answers, and Chatter Answers features, allowing you to

view and create zones from those locations.

YesCommunity (Zone)

Represents the definition of a community template.YesCommunityTemplateDefinition

Represents the definition of a community theme.YesCommunityThemeDefinition

Represents the metadata associated with a compact layout.YesCompactLayout

Represents a connected app configuration. A connected app integrates an

application with Salesforce using APIs. Connected apps use standard SAML

YesConnectedApp

and OAuth protocols to authenticate, provide single sign-on, and provide

tokens for use with Salesforce APIs. In addition to standard OAuth capabilities,

connected apps allow Salesforce admins to set various security policies and

have explicit control over who can use the corresponding apps.

Represents the metadata for creating an asset file.YesContentAsset

Represents contract settings.Not ApplicableContractSettings

Represents an origin in the CORS whitelist.YesCorsWhitelistOrigin

Represents a criteria-based sharing rule. CriteriaBasedSharingRule enables

you to share records based on specific criteria. It contains metadata for the

YesCriteriaBasedSharingRule

following criteria-based sharing rules: Accounts, Campaigns, Cases, Contacts,

Custom Objects, Leads, and Opportunities.

CustomApplication represents a custom or standard application. In API version

29.0 and earlier, CustomApplication represents only a custom application. An

application is a list of tab references, with a description and a logo.

YesCustomApplication

Represents a custom console component (Visualforce page) assigned to a

CustomApplication that is marked as a Salesforce console. Custom console

components extend the capabilities of Salesforce console apps.

YesCustomApplicationComponent

108

Metadata Types

DescriptionAllows Wildcard

(*)?

Metadata Type

Represents a custom feed filter that limits the feed view to feeds from the

Cases object. The custom feed filter shows only feed items that satisfy the

criteria specified in the CustomFeedFilter definition.

YesCustomFeedFilter

Represents the metadata associated with a field. Use this metadata type to

create, update, or delete custom field definitions on standard, custom, and

external objects or standard field definitions on standard objects.

NoCustomField

Represents a custom label that can be localized and used in different

languages, countries, and currencies. Use this type instead of CustomLabels

if you want to retrieve custom labels by name.

NoCustomLabel

Represents the metadata associated with a custom metadata type.YesCustom Metadata Types

(CustomObject)

Represents a record of a custom metadata type.YesCustomMetadata

This metadata type allows you to create custom labels that can be localized

for use in different languages, countries, and currencies.

YesCustomLabels

Represents a custom object that stores data unique to your organization or

an external object that maps to data stored outside Salesforce.

You can also use this metadata type to work with customizations of standard

objects, such as Accounts. It contains the following types: Action Overrides,

(See description.)CustomObject

Business Processes, Custom Fields, Field Sets, List Views, Named Filters (Lookup

Filters), Picklists (including Dependent Picklists), Record Types, Search Layouts,

Sharing Reasons, Sharing Recalculations, Validation Rules, Weblinks, and Field

Types.

Supports wildcard (*) for Field Sets and Record Types, but not for other

components.

This metadata type allows you to translate custom objects for a variety of

languages.

YesCustomObjectTranslation

Represents a custom link defined in a home page component.YesCustomPageWebLink

Represents a permission that grants access to a custom feature.YesCustomPermission

Represents a Force.com site. Force.com Sites enables you to create public

websites and applications that are directly integrated with your Salesforce

YesCustomSite

organization—without requiring users to log in with a username and

password.

Represents a custom tab. Custom tabs let you display custom object data or

other web content in Salesforce. When you add a custom tab to an app in

YesCustomTab

Salesforce Classic, it displays as a tab. When you add a custom tab to an app

in Lightning Experience, it displays as an item in the app’s navigation bar.

When a tab displays a custom object, the tab name is the same as the custom

object name; for page, s-control, or URL tabs, the name is arbitrary.

109

Metadata Types

DescriptionAllows Wildcard

(*)?

Metadata Type

Represents a dashboard. Dashboards are visual representations of data that

allow you to see key metrics and performance at a glance.

NoDashboard

Represents a data category group.YesDataCategoryGroup

Represents a group of users who have the same administrative privileges.

These groups are different from public groups used for sharing.

YesDelegateGroup

Represents a Document. All documents must be in a document folder, for

example sampleFolder/TestDocument.

NoDocument

Represents a rule that specifies how duplicate records in an object are

detected.

YesDuplicateRule

Represents a Wave custom map chart. Custom maps are user-defined maps

that are uploaded to Wave and are used just as standard maps are. Custom

YesEclairGeoData

maps are accessed in Wave from the list of maps available with the map chart

type.

Represents an email template.NoEmailTemplate

Represents the settings for an entitlement process.YesEntitlementProcess

Represents an organization’s entitlement settings.Not ApplicableEntitlementSettings

Represents an entitlement template. Entitlement templates are predefined

terms of customer support that you can quickly add to products. For example,

YesEntitlementTemplate

you can create entitlement templates for Web or phone support so that users

can easily add entitlements to products offered to customers.

Reserved for future use.YesEventDelivery

Reserved for future use.YesEventSubscription

Represents the External Service configuration for an org.YesExternalServiceRegistration

Represents the metadata associated with an external data source. Create

external data sources to manage connection details for integration with data

and content that are stored outside your Salesforce org.

YesExternalDataSource

Represents a field set. A field set is a grouping of fields. For example, you could

have a field set that contains fields describing a user's first name, middle name,

last name, and business title.

YesFieldSet

Represents the security settings for uploading and downloading files.Not ApplicableFileUploadAndDownloadSecuritySettings

Represents the metadata associated with a Lightning Page. A Lightning Page

represents a customizable screen containing Lightning components.

YesFlexiPage

Represents the metadata associated with a flow. With Flow, you can create

an application that navigates users through a series of screens to query and

YesFlow

update records in the database. You can also execute logic and provide

branching capability based on user input to build dynamic applications.

110

Metadata Types

DescriptionAllows Wildcard

(*)?

Metadata Type

Represents the flow definition’s description and active flow version number.YesFlowDefinition

Represents a folder. A folder can contain documents, email templates, reports,

or dashboards. You must specify the folder type (Document, EmailTemplate,

Report, or Dashboard) to retrieve or deploy.

NoFolder

Represents the settings for enhanced analytics folder sharing. Users can control

access to reports or dashboards by giving others Viewer, Editor or Manager

access to the folder that contains the report or dashboard.

NoFolderShare

Represents the Collaborative Forecasts settings options.Not ApplicableForecastingSettings

Represents the metadata for a global picklist value set, which is the set of

shared values that custom picklist fields can use. A global value set isn't a field

YesGlobalValueSet

itself. (In contrast, the custom picklist fields that are based on a global picklist

are of type ValueSet.)

Contains details for a global value set translation. Global value sets are lists

of values that can be shared by multiple custom picklist fields, optionally

across objects.

YesGlobalValueSetTranslation

Represents the definition of a value used in a global picklist. Custom picklist

fields can inherit the picklist value set from a global picklist. This type extends

the Metadata metadata type and inherits its fullName field.

NoGlobalPicklistValue

Represents a set of public groups, which can have users, roles, and other

groups.

YesGroup

Represents the metadata associated with a home page component. You can

customize the Home tab to include components such as sidebar links, a

company logo, a dashboard snapshot, or custom components that you create.

YesHomePageComponent

Represents the metadata associated with a home page layout. You can

customize home page layouts and assign the layouts to users based on their

user profile.

YesHomePageLayout

Represents the metadata used to manage settings for Ideas.Not ApplicableIdeasSettings

Represents a package to be installed or uninstalled. Deploying a newer version

of a currently installed package upgrades the package.

YesInstalledPackage

Represents a list of keywords used in community moderation. This keyword

list is a type of moderation criteria that defines offensive language or

inappropriate content that you don’t want in your community.

YesKeywordList

Represents the metadata used to manage settings for Salesforce Knowledge.Not ApplicableKnowledgeSettings

Represents the metadata associated with a page layout.YesLayout

Represents formatting options for the letterhead in an email template.

Letterheads define the look and feel of your HTML email templates. Your

NoLetterhead

HTML email templates can inherit the logo, color, and text settings from a

letterhead.

111

Metadata Types

DescriptionAllows Wildcard

(*)?

Metadata Type

ListView allows you to see a filtered list of records, such as contacts, accounts,

or custom objects.

NoListView

Represents an organization’s Live Agent settings, such as whether or not Live

Agent is enabled.

Not ApplicableLiveAgentSettings

Represents the configuration of an organization’s Live Agent deployment,

such as how many chats can be assigned to an agent and whether or not

chat sounds are enabled.

YesLiveChatAgentConfig

Represents a Live Agent deployment’s settings for the button that customers

click to chat with an agent and the chat window, such as the label that appears

on the button and the pre-chat form that appears before a live chat begins.

YesLiveChatButton

Represents the configuration settings for a specific Live Agent deployment,

such as the branding image for the deployment and whether or not chat

transcripts are automatically saved.

YesLiveChatDeployment

Represents a rule for masking or deleting data of a specified pattern. Written

as a regular expression (regex). This object is available in API version 35.0 and

later.

YesLiveChatSensitiveDataRule

Represents navigational and featured topics managed in a community.YesManagedTopics

Represents a matching rule that is used to identify duplicate records.YesMatchingRule

This is the base class for all metadata types. You cannot edit this object. A

component is an instance of a metadata type.

NoMetadata

This is the base type for all metadata types that contain content, such as

documents or email templates.

NoMetadataWithContent

Represents the name and description of a milestone, which you can use in

an entitlement process to track important steps in cases.

YesMilestoneType

Represents an organization’s mobile settings.Not ApplicableMobileSettings

Represents a rule used in your community to moderate member-generated

content.Each rule specifies the member-generated content the rule applies

YesModerationRule

to, the criteria to enforce the rule on, and the moderation action to take.

Moderation rules help protect your community from spammers, bots, and

offensive or inappropriate content.

Represents a named credential, which specifies the URL of a callout endpoint

and its required authentication parameters in one definition. A named

YesNamedCredential

credential can be specified as an endpoint to simplify the setup of

authenticated callouts.

This component has been removed as of API version 30.0 and is only provided

for backward compatibility. The metadata associated with a lookup filter is

NoNamedFilter

now represented by the lookupFilter field in the CustomField

component.

112

Metadata Types

DescriptionAllows Wildcard

(*)?

Metadata Type

Represents the metadata associated with a lookup filter. Use this metadata

type to create, update, or delete lookup filter definitions.

Enables or disables middle name and suffix attributes for the following person

objects: Contact, Lead, Person Account, and User.

Not ApplicableNameSettings

Represents a community. Communities are branded spaces for your

employees, customers, and partners to connect. You can customize and create

YesNetwork

communities to meet your business needs, then transition seamlessly between

them. Use the Network component for Salesforce Communities. If you want

to create zones that contain Chatter Answers and Ideas, use the Community

(Zone) component.

Represents organization preferences for features such as automatic

opportunity updates and similar-opportunity filters.

Not ApplicableOpportunitySettings

Represents order settings.Not ApplicableOrderSettings

Represents the unique org preference settings in a Salesforce org.No applicableOrgPreferenceSettings

Represents an ownership-based sharing rule. OwnerSharingRule enables you

to share records owned by a set of users with another set, using rules that

YesOwnerSharingRule

specify the access level of the target user group. It contains metadata for the

following specific owner-sharing rules: Accounts, Campaigns, Cases, Contacts,

Custom Objects, Leads, Account Territory and Opportunities.

Specifies which metadata components to retrieve as part of a retrieve()

call or defines a package of components.

NoPackage

Represents Path records.YesPathAssistant

Represents the Path preference setting.Not ApplicablePathAssistantSettings

Represents a set of permissions that's used to grant additional access to one

or more users without changing their profile or reassigning profiles. You can

use permission sets to grant access, but not to deny access.

YesPermissionSet

Represents an organization’s Adoption Manager setting, which enables or

disables the Adoption Manager tool.

NoPersonalJourneySettings

Deprecated. Represents a picklist (or dependent picklist) definition for a

custom field in a custom object or a custom or standard field in a standard

object, such as an account.

NoPicklist (Including Dependent

Picklist)

Represents a partition in the Platform Cache.YesPlatformCachePartition

The Portal metadata type represents a partner portal or Customer Portal.YesPortal

Represents the metadata associated with an approval post template for

Approvals in Chatter. With approval post templates, you can customize the

information included in approval request posts that appear in Chatter feeds.

YesPostTemplate

113

Metadata Types

DescriptionAllows Wildcard

(*)?

Metadata Type

Represents organization preferences for quantity schedules, revenue

schedules, and active flag interaction with prices.

Not ApplicableProductSettings

Represents a user profile. A profile defines a user’s permission to perform

different functions within Salesforce.

YesProfile

Represents an override of an ActionOverride by a user profile. You can use it

to override an ActionOverride on a standard Home tab or object record page

NoProfileActionOverride

in Lightning Experience. When a user logs in with a profile, a matching

ProfileActionOverride assignment takes precedence over existing overrides

for the Home tab or record page specified in ActionOverride.

Represents a holding area for items before they are processed.YesQueue

Represents a specified create or update quick action for an object that then

becomes available in the Chatter publisher. For example, you can create an

YesQuickAction

action that, on the detail page of an account, allows a user to create a contact

related to that account from the Chatter feed on that page. QuickAction can

be created on objects that allow custom fields.

Enables or disables Quotes, which show proposed prices for products and

services.

Not ApplicableQuoteSettings

Represents the metadata associated with a record type. Record types let you

offer different business processes, picklist values, and page layouts to different

users.

NoRecordType

Represents a remote site setting. Before any Visualforce page, Apex callout,

or JavaScript code using XmlHttpRequest in an s-control or custom button

Not ApplicableRemoteSiteSetting

can call an external site, that site must be registered in the Remote Site Settings

page, or the call fails.

Represents a custom report.NoReport

Represents the metadata associated with a custom report type. Custom report

types allow you to build a framework from which users can create and

customize reports.

YesReportType

Represents a role in your organization.YesRole

Represents a SAML Single Sign-On configuration.YesSamlSsoConfig

Deprecated. Represents an Scontrol component, corresponding to an s-control

in the Salesforce user interface.

YesScontrol

Represents the metadata associated with the Search Layouts for an object.

You can customize which fields to display for users in search results, search

filter fields, lookup dialogs, and recent record lists on tab home pages.

NoSearchLayouts

Represents an org's search settings.NoSearchSettings

114

Metadata Types

DescriptionAllows Wildcard

(*)?

Metadata Type

Represents an organization’s security settings. Security settings define trusted

IP ranges for network access, password and login requirements, and session

expiration and security settings.

Not ApplicableSecuritySettings

Represents sharing rule settings such as access level and to whom access is

granted.

NoSharingBaseRule

Represents an Apex sharing reason, which is used to indicate why sharing

was implemented for a custom object.

NoSharingReason

Represents Apex classes that recalculate the Apex managed sharing for a

specific custom object.

NoSharingRecalculation

Represents the base container for sharing rules, which can be criteria-based,

ownership-based, or territory-based. SharingRules enables you to share records

YesSharingRules

with a set of users, using rules that specify the access level for the target user

group.

Represents a sharing set. A sharing set defines an access mapping that grants

portal or community users access to objects that are associated with their

accounts or contacts.

YesSharingSet

Represents a site for deployment. It extends the MetadataWithContent type

and inherits its fullName and content fields.

YesSiteDotCom

Represents the settings for a skill used for field service or to route chats to

agents in Live Agent, such as the name of the skill and which agents the skills

are assigned to.

YesSkill

Represents the set of values in a standard picklist field. This type extends the

Metadata metadata type and inherits its fullName field.

NoStandardValueSet

Contains details for a standard picklist translation. It returns a translated

standard value set.

YesStandardValueSetTranslation

Represents a static resource file, often a code library in a ZIP file.YesStaticResource

Represents a set of synonym groups, which are groups of words or phrases

that are treated as equivalent in users’ searches. You can define synonym

YesSynonymDictionary

groups to optimize search results for acronyms, variations of product names,

and other terminology unique to your organization.

Represents a territory in your organization.YesTerritory

Represents the metadata associated with a sales territory in Territory

Management 2.0.

YesTerritory2

Represents the metadata associated with a territory model in Territory

Management 2.0.

YesTerritory2Model

Represents the metadata associated with a territory assignment rule associated

with an object, such as Account, in Territory Management 2.0.

YesTerritory2Rule

115

Metadata Types

DescriptionAllows Wildcard

(*)?

Metadata Type

Represents the metadata for the default settings for Territory Management

2.0 users to access and modify records associated with sales territories. The

NoTerritory2Settings

standard record access settings apply to accounts and opportunities. If your

Salesforce org uses Private default internal access for contacts or cases,

you can also set access for those records.

Represents the metadata for a category of territories in Territory Management

2.0. Every Territory2 must have a Territory2Type.

YesTerritory2Type

Represents a transaction security policy definition. Transaction Security policies

give you a way to look through events in your organization and specify actions

to take when certain combinations occur.

YesTransactionSecurityPolicy

This metadata type allows you to work with translations for various supported

languages.

YesTranslations

Represents a validation rule, which is used to verify that the data a user enters

in a record is valid and can be saved. A validation rule contains a formula or

NoValidationRule

expression that evaluates the data in one or more fields and returns a value

of true or false. Validation rules also include an error message that your

client application can display to the user when the rule returns a value of

true due to invalid data.

Represents the Wave Analytics application.YesWaveApplication

Represents the WaveDashboard object in the Wave Analytics application.YesWaveDashboard

Represents the WaveDataflow object in the Wave Analytics application.YesWaveDataflow

Represents the WaveDataset object in the Wave Analytics application.YesWaveDataset

Represents the WaveLens object in the Wave Analytics application.YesWaveLens

Represents a Wave Analytics template bundle, which can be used to create

Wave apps. A bundle contains a Wave template definition and all its related

resources.

YesWaveTemplateBundle

Represents the WaveXmd object in the Wave Analytics application.YesWavexmd

Represents a custom button or link defined in a custom object.NoWebLink

Represents the metadata associated with a workflow rule. A workflow rule

sets workflow actions into motion when its designated conditions are met.

YesWorkflow

You can configure workflow actions to execute immediately when a record

meets the conditions in your workflow rule, or set time triggers that execute

the workflow actions on a specific day.

116

Metadata Types

Metadata Components and Types

Metadata components are not based on sObjects, like objects in the API. Instead, they are based on metadata types, such as ApexClass

and CustomObject, which extend Metadata. A component is an instance of a metadata type. For example, CustomObject is a

metadata type for custom objects, and the MyCustomObject__c component is an instance of a custom object.

A metadata type can be identified in the metadata WSDL as any complexType that extends the Metadata complexType. A complexType

that is a metadata type includes the following element in its WSDL definition:

<xsd:extension base="tns:Metadata">

CustomObject and BusinessProcess extend Metadata so they are metadata types; ActionOverride doesn't extend Metadata so it's not a

metadata type.

You can individually deploy or retrieve a component for a metadata type. For example, you can retrieve an individual BusinessProcess

component, but you can't retrieve an individual ActionOverride component. You can only retrieve an ActionOverride component by

retrieving its encompassing CustomObject component.

Metadata components can be manipulated by asynchronous Metadata API calls or declarative (or file-based) Metadata API calls.

Most of the components can be accessed using Force.com IDE. Exceptions are noted in the description of the object.

Field Data Types

Each component field has a specific field type. These field types can correspond to other components defined in the WSDL, or primitive

data types, like string, that are commonly used in strongly typed programming languages.

These field data types are used in the SOAP messages that are exchanged between your client application and the API. When writing

your client application, follow the data typing rules defined for your programming language and development environment. Your

development tool handles the mapping of typed data in your programming language with these SOAP data types.

For more information about primitive data types, see the SOAP API Developer's Guide.

Enumeration Fields

Some component fields have a data type that is an enumeration. An enumeration is the API equivalent of a picklist. The valid values of

the field are restricted to a strict set of possible values, all having the same data type. These values are listed in the field description

column for each enumeration field. See sortBy for an example of an enumeration field of type string. The XML below shows a sample

definition of an enumeration of type string in the WSDL.

<xsd:simpleType name="DashboardComponentFilter">

<xsd:restriction base="xsd:string">

<xsd:enumeration value="RowLabelAscending"/>

<xsd:enumeration value="RowLabelDescending"/>

<xsd:enumeration value="RowValueAscending"/>

<xsd:enumeration value="RowValueDescending"/>

</xsd:restriction>

</xsd:simpleType>

Supported Calls

All of the metadata types are supported by the main calls, unless it is stated otherwise in the individual component sections. The main

Metadata API calls are:

117

Metadata Components and TypesMetadata Types

•CRUD calls, such as createMetadata() and deleteMetadata()

•File-based calls, such as deploy() and retrieve()

•Utility calls, such as listMetadata() and describeMetadata()

Unsupported Metadata Types

Some things you can customize in a Salesforce organization aren’t available in Metadata API.

The following components can’t be retrieved or deployed with Metadata API, and changes to them must be made manually in each of

your organizations:

•Account Teams

•Activity Button Overrides

•Analytic Settings

•Automated Case User Settings

•Auto-number on Customizable Standard Fields

•Campaign Influences

•Case Contact Roles

•Case Feed Layouts

•Case Team Roles

•Console Layouts

•Currency Exchange Rates

•Data Category Visibility Settings

•Delegated Administration

•Divisions

•Email Services

•Fiscal Year

•HTML Document and Attachment Settings

•Lead Settings

•Mail Merge Templates

•Mobile Administration

•Mobile Users and Devices

•Multiline layout fields for opportunity teams

•Offline Briefcase Configurations

•Opportunity Big Deal Alerts

•Opportunity Update Reminders

•Organization Wide Email Addresses

•Partner Management

•The following standard picklists: IdeaTheme.Categories, Order.Status, Question.Origin. (All other standard picklists are supported.)

•Predefined Case Teams

•Product Schedule Setup

•Public and Resource Calendars

118

Unsupported Metadata TypesMetadata Types

•Quote Templates

•Salesforce to Salesforce

•Standard fields that aren’t customizable, such as autonumber fields or system fields

•Self-Service Portal Font and Colors

•Self-Service Portal Settings

•Self-Service Portal Users

•Self-Service Public Solutions

•Self-Service Web-to-Case

•Site.com

•Social Account/Contact Settings

•SoftPhone Layout

•Solution Categories

•Solution Settings

•Tag Settings

•Territory Assignment Rules

•User Interface Settings (except calendar features, which are supported in ActivitiesSettings on page 559)

•Web Links on Person Account Page Layouts

•Web-to-Lead

Special Behavior in Metadata API Deployments

Important considerations for specific types and contents of a deployment.

When deploying changes to a Salesforce org, consider how individual components in your deployment behave so you’re including all

the necessary changes. Use the following information to determine what to include in your deployment, and how the changes appear

in the destination org.

Apex Classes and Apex Triggers

By default, changes to Apex code that have Apex jobs pending or in progress can’t be deployed. To deploy these changes, do one

of the following.

•Cancel Apex jobs before deploying changes to Apex code. Reschedule the jobs after the deployment.

•Enable deployments with Apex jobs in the Salesforce user interface in the Deployment Settings page.

Approval Processes

•To use approval processes on Salesforce Knowledge articles with the Metadata API, the article type must be deployed. For article

version (_kav) in approval processes, the supported action types are: Knowledge Action, Email Alert, Field Update, and Outbound

Message.

•If the approval process references any post templates that contain custom fields, then you need to resave those post templates

in the originating organization before adding them to the change set. From Setup, enter Post Templates in the Quick

Find box, then select Post Templates. For each post template, click Edit and then Save.

•The metadata doesn’t include the order of active approval processes. You might need to reorder the approval processes in the

destination org after deployment.

•If you change the Unique Name of an approval process that was previously included in a change set and deployed in another

organization, and you resend the approval process via a change set, a new approval process will be created upon deployment

in the other organization. The previously deployed approval process will not be modified.

119

Special Behavior in Metadata API DeploymentsMetadata Types

Custom Fields

Starting in API version 30.0, when deploying a new custom field, the default values for the editable and readable fields in

profile field permissions are false. To override the default values, include field permissions for the new field in your profiles.

Custom Objects

Using API version 29.0, you can’t change the sharingModel of an object using the Metadata API. You must manually make this

change to the target org through the user interface.

Starting with API version 30.0, you can change the sharingModel of an object for internal users using the Metadata API and

the user interface.

Connected App

•You cannot set the consumerKey in the Metadata API. It is included in a retrieve operation for informational purposes. If you

try to move the connected app to another org, you must remove the consumerKey from the .zip file before the deployment

to an org. A new key will be generated in the destination org.

•Mobile settings of connected apps are not supported in change sets and must be manually migrated.

Named Credentials

The following callout options for named credentials can be set only via the user interface. If the default values aren’t appropriate in

the destination org, the admin for that org must manually configure the named credential after deployment.

•Generate Authorization Header—Default: Enabled

•Allow Merge Fields in HTTP Header—Default: Disabled

•Allow Merge Fields in HTTP Body—Default: Disabled

Page Layout

A deployment containing page layout assignments replaces all existing page layout assignments in the destination org with those

specified in the .zip file. Existing page layouts in the org disappear if they’re not included in the .zip file. Always include all page

layouts for all required record types in the .zip file.

Profiles

If a package includes a profile with a name that doesn’t exist in the target org, a new profile is created with that name. If the deployed

profile doesn’t specify any permissions or settings, the resulting profile consists of all the permissions and settings in the Standard

Profile.

Sharing

•Simultaneously updating the sharingModel field for an object and adding a new sharing rule isn’t supported in the Metadata

API, regardless of which object you’re updating. For example, you can add a sharing rule when the org-wide default is public,

and subsequently update the sharingModel. This would result in a single sharing recalculation.

•You might encounter an error if you’re deploying a change set with a custom object that has a parent-child relationship without

the master/detail field in the same change set. To resolve this error, include the master/detail custom field in the change set,

even if you haven’t changed the org-wide default.

Workflow

Test mode for flow triggers isn’t supported in the Metadata API. If you want a flow trigger to run the latest flow version when an

administrator causes the workflow rule to fire, enable test mode via the user interface after deployment.

ActionLinkGroupTemplate

Represents the action link group template. Action link templates let you reuse action link definitions and package and distribute action

links. An action link is a button on a feed element. Clicking on an action link can take a user to another Web page, initiate a file download,

or invoke an API call to an external server or Salesforce. Use action links to integrate Salesforce and third-party services into the feed.

120

ActionLinkGroupTemplateMetadata Types

Every action link belongs to an action link group and action links within the group are mutually exclusive. This type extends the Metadata

metadata type and inherits its fullName field.

File Suffix and Directory Location

ActionLinkGroupTemplate components have the suffix .actionLinkGroupTemplate and are stored in the

actionLinkGroupTemplates folder.

Version

ActionLinkGroupTemplate components are available in API version 33.0 and later.

Fields

DescriptionField TypeField Name

Action link templates that are associated with the action link group

template.

ActionLinkTemplate

on page 122[]

actionLinkTemplates

Required. The location of the action link group within the feed element.

Values are:

PlatformAction

GroupCategory

(enumeration of

type string)

SEE ALSO:

Report

126

AnalyticSnapshotMetadata Types

ArticleType

Represents the metadata associated with an article type.

All articles in Salesforce Knowledge are assigned to an article type. An article's type determines the type of content it contains, its

appearance, and which users can access it. For example, a simple FAQ article type might have two custom fields, Question and

Answer, where article managers enter data when creating or updating FAQ articles. A more complex article type may require dozens

of fields organized into several sections. Using layouts and templates, administrators can structure the article type in the most effective

way for its particular content. User access to article types is controlled by permissions. For each article type, an administrator can grant

“Create,” “Read,” “Edit,” or “Delete” permissions to users. For example, the article manager might want to allow internal users to read,

create, and edit FAQ article types, but let partner users only read FAQs. See “Knowledge Article Types” in the Salesforce online help and

“Articles” in the SOAP API Developer's Guide.

Declarative Metadata File Suffix and Directory Location

An ArticleType is defined as a custom object and is stored in the objects folder. ArticleTypes have a suffix __kav (instead of __c

for custom objects). ArticleType field names have a suffix of __c like other custom objects, and must be dot-qualified with the name

of the article type to which they belong. This is shown in the following sample package.xml file:

<?xml version="1.0" encoding="UTF-8"?>

<fullName>articlefilemetadata</fullName>

<apiAccessLevel>Unrestricted</apiAccessLevel>

<types>

<members>newarticle__kav.description__c</members>

<name>CustomField</name>

</types>

<types>

<members>newarticle__kav</members>

<name>CustomObject</name>

</types>

</Package>

Version

ArticleTypes are available in API version 19.0 and later.

Fields

DescriptionField TypeField Name

Represents the article-type templates used to display an article in the

various channels. See “Article Type Templates” in the Salesforce online

help.

articleTypeChannelDisplayarticleTypeChannel

Display

127

ArticleTypeMetadata Types

DescriptionField TypeField Name

A string which represents the deployment status of a custom object or

field. Valid values are:

DeploymentStatus

(enumeration of type string)

deploymentStatus

•InDevelopment

•Deployed

A description of the article type. Maximum of 1000 characters.stringdescription

Represents one or more fields in the article type.CustomField[]fields

Indicates the gender of the noun that represents the object. This is used

for languages where words need different treatment depending on their

gender.

Gendergender

Label that represents the object throughout the Salesforce user interface.stringlabel

Plural version of the label value.stringpluralLabel

Indicates whether the noun starts with a vowel, consonant, or is a special

character. This is used for languages where words need different treatment

depending on the first character. Valid values are listed in StartsWith.

StartsWith (enumeration of

type string)

startsWith

articleTypeChannelDisplay

Determines the article-type templates that are used to display an article in its channels. Unless otherwise noted, all fields are createable,

filterable, and nillable.

DescriptionField TypeField Name

Indicates which article-type template applies in the specified channel.articleTypeTemplatesarticleTypeTemplates

articleTypeTemplates

Sets the article-type template for a specific channel. If not specified, the default article-type template applies.

DescriptionField TypeField Name

Specifies the channel where the article-type template applies:stringchannel

•AllChannels: all the available channels.

•App: the Articles tab in Salesforce Knowledge.

•Pkb: the public knowledge base.

•Csp: the Customer Portal.

•Prm: the partner portal.

Represents the name of the custom Visualforce page used as a custom

article-type template. Use this field when you select Page in the

template field.

stringpage

128

ArticleTypeMetadata Types

DescriptionField TypeField Name

Indicates the article-type template used for the specified channel:stringtemplate

•Page: custom Visualforce page. When specifying this value, you

must also set the page field with the Visualforce page name.

•Tab: display the sections you defined in the layout as tabs.

•Toc: display the sections you defined in the layout as table of content.

Declarative Metadata Sample Definitions

A sample article type definition follows:

<?xml version="1.0" encoding="UTF-8"?>

</articleTypeTemplates>

</articleTypeTemplates>

</articleTypeTemplates>

</articleTypeTemplates>

</articleTypeChannelDisplay>

<deploymentStatus>Deployed</deploymentStatus>

<description>Article type with custom fields</description>

<fullName>description__c</fullName>

<label>Description</label>

</fields>

<label>newarticle</label>

<pluralLabel>newarticles</pluralLabel>

</CustomObject>

SEE ALSO:

ArticleType Layout

ArticleType CustomField

129

ArticleTypeMetadata Types

ArticleType Layout

Represents the metadata associated with an article type page layout. Article type layouts determine which fields users can view and edit

when entering data for an article, they also determine which sections appear when users view articles.

The format of the article, for example whether layout sections display as subtabs or as a single page with links, is defined by the article-type

template. Each article type has only one layout, but you can choose a different template for each of the article type's four channels. For

more information, see "Knowledge Article Types" in the Salesforce online help and “Articles” in the SOAP API Developer's Guide

File Suffix and Directory Location

ArticleType layouts are stored in the layouts directory of the corresponding package directory. The prefix must match with the article

type API name. The extension is .layout.

Version

ArticleType layouts are available in API version 19.0 and later.

Fields

DescriptionField TypeField Name

The main sections of the layout containing the article fields. The

order here determines the layout order.

LayoutSection[]layoutSections

LayoutSection

LayoutSection represents a section of an ArticleType layout.

DescriptionField TypeField Name

Indicates if this section's label is custom or standard (built-in). Custom

labels can be any text, but must be translated. Standard labels have a

booleancustomLabel

predefined set of valid values, for example 'System Information', which

are automatically translated.

The label; either standard or custom, based on the customLabel flag.stringlabel

The columns of the layout, depending on the style. Salesforce Knowledge

only supports one column in article type layouts.

LayoutColumn[]layoutColumns

The style of the layout. Salesforce Knowledge only supports the value

OneColumn which displays a one column page.

LayoutSectionStyle

(enumeration of type

string)

style

LayoutColumn

LayoutColumn represents the items in a column within a layout section.

130

ArticleType LayoutMetadata Types

DescriptionField TypeField Name

The individual items within a column (ordered from top to bottom).LayoutItem[]layoutItems

LayoutItem

LayoutItem represents the valid values that define a layout item.

DescriptionField TypeField Name

The field name reference, for example MyField__c.stringfield

Declarative Metadata Sample Definition

The following is the definition of an ArticleType page layout:

<?xml version="1.0" encoding="UTF-8"?>

<label>Description</label>

<field>description__c</field>

</layoutItems>

<field>dateTime__c</field>

</layoutItems>

</layoutColumns>

</layoutSections>

<label>Data Sheet</label>

</layoutItems>

</layoutColumns>

</layoutSections>

</Layout>

SEE ALSO:

ArticleType

ArticleType CustomField

131

ArticleType LayoutMetadata Types

ChannelLayout

Represents the metadata associated with an communication channel layout. Communication channel layouts allow admins to share

article contents inline into communication channels (eg. email publisher, portal publisher, social publisher etc.). Admins can create a list

of fields of an article type that they want to share for each communication channels and customize its order.

File Suffix and Directory Location

Channel layout components have the suffix .channelLayout and are stored in the channelLayouts folder of the

corresponding package directory. The prefix must match with the article type API name.

Version

Channel layout components are available in API version 32.0 and later.

Fields

DescriptionField TypeField Name

The labelstringlabel

The article fields contained in the layout. The order here determines the

field order.

layoutItemlayoutItems

The channels where this layout applies.enabledChannelenabledChannels

layoutItem

DescriptionField TypeField Name

Name of the field. The format is <ArticleType name>.<Field name>stringfield

Enum name of the communcation channel (eg. email, portal etc)enumenabledChannel

Declarative Metadata Sample Definition

The following is an example of a Channel Layout component.

<?xml version="1.0" encoding="UTF-8"?>

<label>layoutaaaa</label>

<field>ArticleTypeA.FieldA</field>

</layoutItems>

<field>ArticleTypeA.FieldC</field>

</layoutItems>

<enabledChannels>email</enabledChannels>

<enabledChannels>portal</enabledChannels>

</ChannelLayout>

132

ChannelLayoutMetadata Types

The following is an example package.xml that references the previous definition.

ArticleType CustomField

Represents the metadata associated with an article type custom field. Use this metadata type to create, update, or delete article type

custom field definitions.

This type extends the Metadata metadata type and inherits its fullName field.

Always specify the full name whenever you create or update a custom field. For example, a custom field on a custom object:

MyArticleType__kav.MyCustomField__c

Declarative Metadata File Suffix and Directory Location

Custom fields are defined as part of the article type. ArticleType field names have a suffix of __c like other custom objects, and must

be dot-qualified with the name of the article type to which they belong. See ArticleType for more information.

Retrieving Custom Fields on Custom or Standard Objects

When you retrieve a custom or standard object, you return everything associated with the object. However, you can also retrieve only

the custom fields for an object by explicitly naming the object and fields in package.xml. The following definition in package.xml

retrieves the files objects/MyCustomObject__c.object, objects/Account.object__c.object, and

objects/MyArticleType__kav.object, each containing one custom field definition.

<types>

<members>MyCustomObject__c.MyCustomField__c</members>

<members>Account.MyCustomAccountField__c</members>

<members>MyArticleType__kav.MyOtherCustomField__c</members>

<name>CustomField</name>

</types>

Version

ArticleTypes custom fields are available in API version 19.0 and later.

Fields for ArticleType

Unless otherwise noted, all fields are createable, filterable, and nillable.

Note: If you create a knowledge validation rule, the errors always display at the top of the page, even if you add it beside the

field. Therefore, write the errors descriptively so authors know how to satisfy the validation rule. For example, identify which field

is causing the error. The Salesforce Classic user interface does not support field level error messages for articles.

DescriptionField TypeField Name

If specified, represents the default value of the field.stringdefaultValue

133

ArticleType CustomFieldMetadata Types

DescriptionField TypeField Name

Provides deletion options for lookup relationships. Valid values

are:

SetNull

This is the default. If the lookup record is deleted, the

lookup field is cleared.

DeleteConstraint

(enumeration of type

string)

deleteConstraint

Restrict

Prevents the record from being deleted if it’s in a lookup

relationship.

Cascade

Deletes the lookup record as well as associated lookup

fields.

For more information on lookup relationships, see “Object

Relationships” in the Salesforce Help.

Description of the field.stringdescription

If specified, represents a formula on the field.stringformula

Indicates how to treat blanks in a formula. Valid values are

BlankAsBlank and BlankAsZero.

TreatBlanksAs

(enumeration of type

string)

formulaTreatBlankAs

Inherited from Metadata, this field is not defined in the WSDL

for this metadata type. It must be specified when creating,

stringfullName

updating, or deleting. See create() to see an example of

this field specified for a call.

This value cannot be null.

Represents the content of field-level help. For more information,

see “Define Field-Level Help” in the Salesforce Help.

stringinlineHelpText

Label for the field. You cannot update the label for standard

fields in Article Type such as Title, UrlName, Summary, etc.

stringlabel

Length of the field.intlength

(Deprecated. Use this field in API version 37.0 and earlier only.

In later versions, use valueSet instead.) If specified, the field

Picklist (Including

Dependent Picklist)

picklist

is a picklist, and this field enumerates the picklist values and

labels.

If specified, indicates a reference this field has to another object.stringreferenceTo

Label for the relationship.stringrelationshipLabel

If specified, indicates the value for one-to-many relationships.

For example, in the object MyObject that had a relationship to

YourObject, the relationship name might be YourObjects.

stringrelationshipName

134

ArticleType CustomFieldMetadata Types

DescriptionField TypeField Name

Indicates whether the field requires a value on creation (true)

or not (false).

booleanrequired

Required. Indicates the field type for the field. Valid values are:FieldTypetype

•Checkbox available in version 30.0 and later

•Currency

•ArticleCurrency

•Date

•DateTime

•Email

•File

•Formula

•Html

•Lookup

•Number

•Percent

•Phone

•Picklist

•DependentPicklist

•MultiselectPicklist

•Text

•TextArea

•LongTextArea

•URL

Indicates the number of lines displayed for the field.intvisibleLines

Declarative Metadata Sample Definition

<?xml version="1.0" encoding="UTF-8"?>

....

<fullName>Comments__c</fullName>

<description>add your comments about this object here</description>

<label>Comments</label>

<type>LongTextArea</type>

</fields>

135

ArticleType CustomFieldMetadata Types

....

</CustomObject>

SEE ALSO:

ArticleType

ArticleType Layout

ApexClass

Represents an Apex class. An Apex class is a template or blueprint from which Apex objects are created. Classes consist of other classes,

user-defined methods, variables, exception types, and static initialization code. For more information, see the Force.com Apex Code

Developer's Guide. This type extends the MetadataWithContent metadata type and inherits its content and fullName fields.

Note: By default, you can’t deploy updates to an Apex class if there are one or more active jobs for that class. To deploy updates

in this case, do one of the following.

•Cancel Apex jobs before deploying changes to Apex code. Reschedule the jobs after the deployment.

•Enable deployments with Apex jobs in the Salesforce user interface in the Deployment Settings page.

Supported Calls

All Metadata API calls except CRUD-Based Calls.

Declarative Metadata File Suffix and Directory Location

The file suffix is .cls for the class file. The accompanying metadata file is named ClassName-meta.xml.

Apex classes are stored in the classes folder in the corresponding package directory.

Version

Apex classes are available in API version 10.0 and later.

Fields

This metadata type contains the following fields:

DescriptionField TypeField Name

The API version for this class. Every class has an API version specified at creation.

doubleapiVersion

The Apex class definition. Base 64-encoded binary data. Prior to making an API

call, client applications must encode the binary attachment data as base64. Upon

base64content

receiving a response, client applications must decode the base64 data to binary.

This conversion is usually handled for you by a SOAP client. This field is inherited

from the MetadataWithContent component.

136

ApexClassMetadata Types

DescriptionField TypeField Name

The Apex class name. The name can only contain characters, letters, and the

underscore (_) character, must start with a letter, and cannot end with an

stringfullName

underscore or contain two consecutive underscore characters. This field is

inherited from the Metadata component.

The list of installed managed package versions that are referenced by this Apex

class.

For more information about managed packages, see the Force.com Quick

Reference for Developing Packages. For more information about package

PackageVersion[]packageVersions

versions, see “About Package Versions” in the Salesforce online help. This field

is available in API version 16.0 and later.

The current status of the Apex class. The following string values are valid:

ApexCodeUnitStatus

(enumeration of type string)

status

•Active - The class is active.

•Deleted - The class is marked for deletion. This is useful for managed

packages, because it allows a class to be deleted when a managed package

is updated.

Note: ApexCodeUnitStatus includes an Inactive option, but it is

only supported for ApexTrigger; it is not supported for ApexClass.

PackageVersion

PackageVersion identifies a version of a managed package. A package version is a number that identifies the set of components uploaded

in a package. The version number has the format majorNumber.minorNumber.patchNumber (for example, 2.1.3). The major

and minor numbers increase to a chosen value during every major release. The patchNumber is generated and updated only for a

patch release. It is available in API version 16.0 and later.

DescriptionField TypeField Name

Required. In a packaging context, a namespace prefix is a one to 15-character

alphanumeric identifier that distinguishes your package and its contents from

stringnamespace

packages of other developers on AppExchange. Namespace prefixes are

case-insensitive. For example, ABC and abc are not recognized as unique. Your

namespace prefix must be globally unique across all Salesforce organizations.

It keeps your managed package under your control exclusively.

Salesforce automatically prepends your namespace prefix, followed by two

underscores (“__”), to all unique component names in your Salesforce

organization. A unique package component is one that requires a name that no

other component has within Salesforce, such as custom objects, custom fields,

custom links, s-controls, and validation rules. For more information about

namespaces, see “Register a Namespace Prefix” in the Salesforce online help.

Required. The major number of the package version. A package version number

has a majorNumber.minorNumber format.

intmajorNumber

137

ApexClassMetadata Types

DescriptionField TypeField Name

Required. The minor number of the package version. A package version number

has a majorNumber.minorNumber format.

intminorNumber

Declarative Metadata Sample Definition

The following sample creates the MyhelloWorld.cls class, and the corresponding MyHelloWorld.cls-meta.xml

metadata file.

MyHelloWorld.cls file:

public class MyHelloWorld {

// This method updates the Hello field on a list

// of accounts.

public static void addHelloWorld(Account[] accs){

for (Account a:accs){

if (a.Hello__c != 'World')

a.Hello__c = 'World';

}

MyHelloWorld.cls-meta.xml:

<?xml version="1.0" encoding="UTF-8"?>

</ApexClass>

SEE ALSO:

ApexTrigger

ApexComponent

Represents a Visualforce component. For more information, see “Visualforce” in the Salesforce online help. This type extends the

MetadataWithContent metadata type and inherits its content and fullName fields.

Declarative Metadata File Suffix and Directory Location

The file suffix is .component for the page file. The accompanying metadata file is named ComponentName-meta.xml.

Visualforce components are stored in the components folder in the corresponding package directory.

Version

Visualforce components are available in API version 12.0 and later.

138

ApexComponentMetadata Types

Fields

This metadata type contains the following fields:

DescriptionField TypeField Name

The API version for this Visualforce component. Every component has an API

version specified at creation. This field is available in API version 16.0 and later.

doubleapiVersion

The component content. Base 64-encoded binary data. Prior to making an API

call, client applications must encode the binary attachment data as base64. Upon

base64Binarycontent

receiving a response, client applications must decode the base64 data to binary.

This conversion is usually handled for you by a SOAP client. This field is inherited

from the MetadataWithContent component.

A description of what the component does.stringdescription

The component developer name used as a unique identifier for API access. The

fullName can contain only underscores and alphanumeric characters. It must

stringfullName

be unique, begin with a letter, not include spaces, not end with an underscore,

and not contain two consecutive underscores. This field is inherited from the

Metadata component.

Required. The label for this component.stringlabel

The list of installed managed package versions that are referenced by this

Visualforce component.

PackageVersion[]packageVersions

Note: Package components and Visualforce custom component are

distinct concepts. A package is comprised of many elements, such as

custom objects, Apex classes and triggers, and custom pages and

components.

For more information about managed packages, see the Force.com Quick

Reference for Developing Packages. For more information about package

versions, see “About Package Versions” in the Salesforce online help. This field

is available in API version 16.0 and later.

SEE ALSO:

ApexPage

Represents a Visualforce page. For more information, see “Visualforce” in the Salesforce online help. This type extends the

MetadataWithContent metadata type and inherits its content and fullName fields.

Declarative Metadata File Suffix and Directory Location

The file suffix is .page for the page file. The accompanying metadata file is named PageName-meta.xml.

Visualforce pages are stored in the pages folder in the corresponding package directory.

139

ApexPageMetadata Types

Version

Visualforce pages are available in API version 11.0 and later.

Fields

This metadata type contains the following fields:

DescriptionField TypeField Name

Required. The API version for this page. Every page has an API version

specified at creation. This field is available in API version 15.0 and later.

doubleapiVersion

If you set this field to a number lower than 15.0, it will be changed to

15.0.

The page content. Base 64-encoded binary data. Prior to making an

API call, client applications must encode the binary attachment data

base64Binarycontent

as base64. Upon receiving a response, client applications must decode

the base64 data to binary. This conversion is usually handled for you

by a SOAP client. This field is inherited from the MetadataWithContent

component.

A description of what the page does.stringdescription

The page developer name used as a unique identifier for API access.

The fullName can contain only underscores and alphanumeric

stringfullName

characters. It must be unique, begin with a letter, not include spaces,

not end with an underscore, and not contain two consecutive

underscores. This field is inherited from the Metadata component.

Indicates if Visualforce tabs associated with the Visualforce page can

be used in the Salesforce1 app. (Use of this field for Salesforce Touch

is deprecated.). This field is available in API version 27.0 and later.

Standard object tabs that are overridden with a Visualforce page aren’t

supported in Salesforce1, even if you set this field for the page. The

booleanavailableInTouch

default Salesforce1 page for the object is displayed instead of the

Visualforce page.

Indicates whether GET requests for the page require a CSRF

confirmation token. This field is available in API version 28.0 and later.

If you change this field’s value from false to true, links to the

page require a CSRF token to be added to them, or the page will be

inaccessible.

booleanconfirmationTokenRequired

Required. The label for this page.stringlabel

The list of installed managed package versions that are referenced by

this Visualforce page.

For more information about managed packages, see the Force.com

Quick Reference for Developing Packages. For more information about

PackageVersion[]packageVersions

140

ApexPageMetadata Types

DescriptionField TypeField Name

package versions, see “About Package Versions” in the Salesforce

online help. This field is available in API version 16.0 and later.

Declarative Metadata Sample Definition

The following sample creates the MyPage.page page, and the corresponding MyPage.page-meta.xml metadata file.

SampleApexPage.page file:

<apex:page>

<h1>Congratulations</h1>

This is your new Page.

</apex:page>

SampleApexPage.page-meta.xml:

<?xml version="1.0" encoding="UTF-8"?>

<description>This is a sample Visualforce page.</description>

<label>SampleApexPage</label>

</ApexPage>

SEE ALSO:

ApexComponent

ApexTestSuite

Represents a suite of Apex test classes to include in a test run.

File Suffix and Directory Location

ApexTestSuite components have the suffix .testSuite and are stored in the testSuites folder.

Version

ApexTestSuite components are available in API version 38.0 and later.

Fields

DescriptionField TypeField Name

A list of Apex test classes, specified by name, to include in this

test suite.

string[]testClassName

141

ApexTestSuiteMetadata Types

Declarative Metadata Sample Definition

To include namespaced tests in an Apex test suite, specify each namespace individually. Local Apex tests consist of all tests in the org

that don’t originate from managed packages.

<?xml version="1.0" encoding="UTF-8"?>

<testClassName>LocalTestClass</testClassName>

<testClassName>A*Class</testClassName>

<testClassName>Namespace1.NamespacedTestClass</testClassName>

<testClassName>Namespace1.*</testClassName>

<testClassName>Namespace2.*</testClassName>

</ApexTestSuite>

These syntaxes are supported in package.xml. If the test classes in your suites are already present in the target org, you can omit

the ApexClass type in package.xml.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>ApexClass</name>

</types>

<types>

<name>ApexTestSuite</name>

</types>

</Package>

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>ApexClass</name>

</types>

<types>

<members>Suite1</members>

<members>Suite2</members>

<name>ApexTestSuite</name>

</types>

</Package>

ApexTrigger

Represents an Apex trigger. A trigger is Apex code that executes before or after specific data manipulation language (DML) events occur,

such as before object records are inserted into the database, or after records have been deleted. For more information, see “Manage

142

ApexTriggerMetadata Types

Apex Triggers” in the Salesforce online help. This type extends the MetadataWithContent metadata type and inherits its content and

fullName fields.

Supported Calls

All Metadata API calls except CRUD-Based Calls.

Declarative Metadata File Suffix and Directory Location

The file suffix is .trigger for the trigger file. The accompanying metadata file is named TriggerName-meta.xml.

Apex triggers are stored in the triggers folder in the corresponding package directory.

Version

Triggers are available in API version 10.0 and later.

Fields

This metadata type contains the following fields:

DescriptionField TypeField Name

Required. The API version for this trigger. Every trigger has an API version specified

at creation.

doubleapiVersion

The Apex trigger definition. This field is inherited from the MetadataWithContent

component.

base64content

The Apex trigger name. The name can only contain characters, letters, and the

underscore (_) character, must start with a letter, and cannot end with an

stringfullName

underscore or contain two consecutive underscore characters. This field is

inherited from the Metadata component.

The list of installed managed package versions that are referenced by this Apex

trigger.

For more information about managed packages, see the Force.com Quick

Reference for Developing Packages. For more information about package

PackageVersion[]packageVersions

versions, see “About Package Versions” in the Salesforce online help. This field

is available in API version 16.0 and later.

Required. The current status of the Apex trigger. The following string values are

valid:

ApexCodeUnitStatus

(enumeration of type string)

status

•Active - The trigger is active.

•Inactive - The trigger is inactive, but not deleted.

•Deleted - The trigger is marked for deletion. This is useful for managed

packages, because it allows a trigger to be deleted when a managed package

is updated.

143

ApexTriggerMetadata Types

Declarative Metadata Sample Definition

The following sample creates the MyhelloWorld.trigger trigger, and the corresponding

MyHelloWorld.trigger-meta.xml metadata file.

MyHelloWorld.trigger file:

trigger helloWorldAccountTrigger on Account (before insert) {

Account[] accs = Trigger.new;

MyHelloWorld.addHelloWorld(accs);

}

MyHelloWorld.trigger-meta.xml:

<?xml version="1.0" encoding="UTF-8"?>

</ApexTrigger>

SEE ALSO:

ApexClass

AppMenu

Represents the Force.com app menu or the Salesforce1 navigation menu.

File Suffix and Directory Location

Each AppMenu component gets stored in a single file in the folder of the corresponding package directory. The filename uses the format

Feature.appMenu.

•There’s one app switcher app menu file stored in a file named AppSwitcher.appMenu.

•There’s one Salesforce1 app menu file stored in a file named Salesforce1.appMenu.

These two files are located in the appMenus folder. The .appMenu files are different from other named components, as there’s

only one file for each AppMenu component. App menu files can’t be created or deleted.

Version

AppMenu components are available in API version 30.0 and later.

Fields

DescriptionField TypeField Name

A list of menu items in the app menu.AppMenuItem[]appMenuItems

144

AppMenuMetadata Types

AppMenuItem

Represents a menu item in the app menu.

DescriptionField TypeField Name

The API name of the item.stringname

The type of application represented by this item.

Acceptable values for AppSwitcher.appMenu are:

stringtype

•ConnectedApp

•CustomApplication

•ServiceProvider

Acceptable values for Salesforce1.appMenu are:

•CustomApplication

•CustomTab

•StandardAppMenuItem.

The name for this item can be:

–MyDay

–Feed

–Tasks

–Dashboards

–Search

–People (available only when Chatter is enabled)

–Groups (available only when Chatter is enabled)

Declarative Metadata Sample Definition

The following is an example of an AppSwitcher.appMenu file.

<?xml version="1.0" encoding="UTF-8"?>

<name>standard__Sales</name>

<type>CustomApplication</type>

</appMenuItem>

<name>standard__Support</name>

<type>CustomApplication</type>

</appMenuItem>

<name>CustomApp1</name>

<type>CustomApplication</type>

</appMenuItem>

145

AppMenuMetadata Types

<name>CustomApp2</name>

<type>CustomApplication</type>

</appMenuItem>

<name>ConnectedApp1</name>

<type>ConnectedApp</type>

</appMenuItem>

</appMenuItems>

</AppMenu>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>AppSwitcher</members>

<name>AppMenu</name>

</types>

The following is an example of a Salesforce1.appMenu component.

<?xml version="1.0" encoding="UTF-8"?>

<name>StandardItem1</name>

<type>StandardAppMenuItem</type>

</appMenuItem>

<name>StandardItem2</name>

<type>StandardAppMenuItem</type>

</appMenuItem>

<name>StandardItem3</name>

<type>StandardAppMenuItem</type>

</appMenuItem>

<name>CustomTab1</name>

<type>CustomTab</type>

</appMenuItem>

</appMenuItems>

</AppMenu>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Salesforce1</members>

<name>AppMenu</name>

</types>

146

AppMenuMetadata Types

The following is an example of a package manifest used to deploy or retrieve all the available app menu metadata for an organization,

using a wildcard:

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>AppMenu</name>

</types>

</Package>

Usage

Use AppSwitcher.appMenu to reorder the list of menu items that appears in the Force.com app menu. You can’t add app menu

items to or remove app menu items from AppSwitcher.appMenu.

Use Salesforce1.appMenu to customize the list of menu items that appears in the Salesforce1 navigation menu by reordering,

adding, or removing the app menu items.

ApprovalProcess

Represents the metadata associated with an approval process. An approval process automates how records are approved in Salesforce.

An approval process specifies each step of approval, including who to request approval from and what to do at each point of the process.

This type extends the Metadata metadata type and inherits its fullName field.

Note:

•To use approval processes on Salesforce Knowledge articles with the Metadata API, the article type must be deployed. For

article version (_kav) in approval processes, the supported action types are: Knowledge Action, Email Alert, Field Update, and

Outbound Message.

•Send actions and approval processes for email drafts aren’t supported in the Metadata API.

•The metadata doesn’t include the order of active approval processes. You might need to reorder the approval processes in

the destination org after deployment.

•Before you implement an approval process for your organization, see “Considerations for Approvals” in the Salesforce Help.

File Suffix and Directory Location

ApprovalProcess components have the suffix .approvalProcess and are stored in the approvalProcesses folder.

Version

ApprovalProcess components are available in API version 28.0 and later.

147

ApprovalProcessMetadata Types

Fields

DescriptionField TypeField Name

Required. Whether the approval process is active.

After an approval process is activated, you can’t add, delete,

or change the order of the steps or change its reject or skip

behavior, even if the process is inactive.

booleanactive

Whether to allow submitters to recall approval requests.

If set to false, only administrators can recall approval

requests.

booleanallowRecall

Required. An array of users who are allowed to submit records

for approval.

ApprovalSubmitter[]allowedSubmitters

Specifies which fields to display on the approval page, where

the approver goes to approve or reject the record. By default,

the approval page displays the following:

ApprovalPageFieldapprovalPageFields

•Name field

•Owner field (except for child objects)

If you enable notifications in Salesforce1, keep in mind that

approvers may view this list of fields on a mobile device. Select

only the fields necessary for users to decide whether to

approve or reject records.

An array of approval step definitions.ApprovalStep[]approvalStep

Describes the approval process.stringdescription

Specifies which email template to use for approval requests.

If not specified, the default email template is used.

When an approval process assigns an approval request to a

user, Salesforce sends the user an approval request email.

stringemailTemplate

Whether users can access an external version of the approval

page from any browser, including those on mobile devices,

booleanenableMobileDeviceAccess

without logging in to Salesforce. Corresponds to Security

Settings in the user interface.

If set to true, approval steps can’t have approvers of type

adhoc.

If set to false, approvers must log in to Salesforce to access

the approval page.

Determines which records can enter the approval process.

Exclude this field to allow all records to enter the approval

process.

ApprovalEntryCriteriaentryCriteria

148

ApprovalProcessMetadata Types

DescriptionField TypeField Name

Specifies which workflow actions to execute when all required

approvals have been given for a record.

ApprovalActionfinalApprovalActions

Whether to keep the record locked after it receives all necessary

approvals. Default: false.

booleanfinalApprovalRecordLock

Specifies which workflow actions to execute after a record

enters the final rejection state.

ApprovalActionfinalRejectionActions

Whether to keep the record locked after it’s finally rejected.

Default: false.

booleanfinalRejectionRecordLock

Specifies which workflow actions to execute when a record is

initially submitted for approval.

ApprovalActioninitialSubmissionActions

Required. Name of the approval process.stringlabel

Specifies a standard or custom user hierarchy field that can be

used to automatically assign the approver for an approval step.

If you exclude this field, then no approval step can use a user

hierarchy field to automatically assign the approver.

NextAutomatedApprovernextAutomatedApprover

Post template to use for Approvals in Chatter.

Chatter post approval notifications are only available for

approval processes associated with an object that has been

enabled for feed tracking.

stringpostTemplate

Specifies which workflow actions to execute when a pending

approval request is withdrawn.

ApprovalActionrecallActions

Specifies which users can edit records that are pending

approval. When a record is submitted for approval, it is

RecordEditabilityType

(enumeration of type string)

recordEditability

automatically locked to prevent other users from editing it

during the approval process. Valid values are:

•AdminOnly—Records pending approval can be edited

by:

–Users with the “Modify All Data” permission

–Users with the “Modify All” object-level permission for

the given object

•AdminOrCurrentApprover—Records pending

approval can be edited by:

–Users with the “Modify All Data” permission

–Users with the “Modify All” object-level permission for

the given object

–The assigned approver, who must have edit access to

the record through user permissions and the

organization-wide sharing defaults for the given object

149

ApprovalProcessMetadata Types

DescriptionField TypeField Name

Whether to add the Approval History related list to the

approval page, which is where the approver can view the

booleanshowApprovalHistory

approval request details and approve or reject the record. The

Approval History related list tracks a record through the

approval process.

If you also want to add the Approval History related list to

record detail and edit pages, use the Salesforce user interface

to customize the page layouts for the given object.

ApprovalSubmitter

Represents a user or set of users who can submit records for approval.

DescriptionField TypeField Name

Identifies a specific user or set of users who can submit records for approval. This field

is required, except when the following types are specified and the submitter

field is ignored:

stringsubmitter

•owner

•creator

•allInternalUsers

Example:

<type>allInternalUsers</type>

</allowedSubmitters>

<submitter>myGroup</submitter>

<type>group</type>

</allowedSubmitters>

Required. Type of user or set of users who can submit records for approval. Valid values

are:

ProcessSubmitterType

(enumeration of type

string)

type

•group

•role

•user

•roleSubordinates

•roleSubordinatesInternal

•owner

•creator

•partnerUser

•customerPortalUser

•portalRole

150

ApprovalProcessMetadata Types

DescriptionField TypeField Name

•portalRoleSubordinates

•allInternalUsers—all Salesforce users in the organization

ApprovalPageField

Represents the selection of fields to display on the approval page, where an approver can view the approval request details and approve

or reject the record.

DescriptionField TypeField Name

An array of fields that are displayed on the page for the approver to approve

or reject the record.

string[]field

ApprovalStep

Represents a step in the approval process. Approval steps define the chain of approval for a particular approval process. Each step

determines which records can advance to that step, who to assign approval requests to, and whether to let each approver’s delegate

respond to the requests. The first step specifies what to do if a record doesn’t advance to that step. Later steps specify what happens if

an approver rejects the request.

Note:

•The order of the ApprovalStep entries in the approval process definition determines the order in which the approval

steps are executed.

•After an approval process is activated, you can’t add, delete, or change the order of the steps or change its reject or skip

behavior, even if the process is inactive.

•Each approval process supports up to 30 steps.

DescriptionField TypeField Name

Whether to allow delegated approvers in this step of the

approval process. A delegated approver is a user appointed by

an assigned approver as an alternate for approval requests.

booleanallowDelegate

Specifies which workflow actions to execute when a record is

approved in this step of the approval process.

ApprovalActionapprovalActions

Specifies the assigned approvers for this step of the approval

process.

ApprovalStepApproverassignedApprover

Describes the approval step.stringdescription

Determines which records can enter this step of the approval

process.

ApprovalEntryCriteriaentryCriteria

151

ApprovalProcessMetadata Types

DescriptionField TypeField Name

Specifies what to do for records that don’t meet the entry

criteria. Valid values are:

StepCriteriaNotMetType

(enumeration of type string)

ifCriteriaNotMet

•ApproveRecord—Approve the request and execute

all final approval actions.

•RejectRecord—Reject the request and execute all

final rejection actions. This option is available only for the

first step in the approval process.

•GotoNextStep—Skip to the next approval step. If you

select this option for the first approval step, and a record

doesn’t meet the entry criteria for any other step, the record

is rejected.

Required. Name of the approval step.stringlabel

Required. Unique name of the approval step. It must contain

only underscores and alphanumeric characters, begin with a

stringname

letter, not include spaces, not end with an underscore, and not

contain two consecutive underscores. The requirement for

uniqueness is only within the specific approval process.

Required, except for the first step in the approval process.

Specifies what happens if the approver rejects the request

ApprovalStepRejectBehaviorrejectBehavior

during this approval step, unless it’s the first step in the approval

process.

If the approver rejects the request in the first step in the approval

process, the reject behavior is determined by the

finalRejectionActions.

Specifies which workflow actions to execute when a record is

rejected in this step of the approval process.

ApprovalActionrejectionActions

ApprovalAction

Represents the actions that occur as a result of an approval process.

DescriptionField TypeField Name

An array of workflow actions to execute.WorkflowActionReference[]action

ApprovalStepApprover

Represents the assigned approvers for an approval step. Each step supports up to 25 approvers.

DescriptionField TypeField Name

An array of assigned approvers for this step of the approval process.Approver[]approver

152

ApprovalProcessMetadata Types

DescriptionField TypeField Name

Specifies how to handle approval or rejection when multiple approvers

are assigned to the step. Valid values are:

RoutingType

(enumeration of

type string)

whenMultipleApprovers

•Unanimous—(Default) Require unanimous approval from all

approvers for this step. The approval request for this step is rejected

if any of the approvers reject the request.

•FirstResponse—Approve or reject based on the first response.

Approver

Represents an assigned approver for an approval step. Check out the Salesforce Help for Considerations for Setting Approvers.

DescriptionField TypeField Name

Identifies an assigned approver. This field is required, except when the type is one of

the following and the name is ignored:

stringname

•adhoc

•userHierarchyField

Combined with the specified name, this identifies an assigned approver. Valid values are:NextOwnerType

(enumeration of type

string)

type

•adhoc—The approver for the step must be selected manually. For the first step, the

submitter selects the approver. For the second and later steps, the approver for the

previous step selects the approver. For this value, exclude the name field.

•user—A user in your organization. For this value, enter a username for the name

field.

•userHierarchyField—A user specified in a standard or custom user hierarchy

field, such as the standard Manager field. For this value, exclude the name field.

The user hierarchy field must be defined in the nextAutomatedApprover for

the approval process.

•relatedUserField—A user specified in a user lookup field on the submitted

record, such as the Last Modified By field. For this value, enter the name of

the user lookup field for the name field.

•queue—Automatically assign to a queue. For this value, enter the name of the queue

for the name field.

ApprovalEntryCriteria

Represents the criteria that records must meet to enter the approval process or an approval step. Specify either filter criteria or a formula,

but not both.

DescriptionField TypeField Name

Filter logic for criteriaItems. Exclude this field if you enter a formula.stringbooleanFilter

153

ApprovalProcessMetadata Types

DescriptionField TypeField Name

Filter criteria that a record must meet to enter the approval process or approval

step.

Approval processes don’t support valueField entries in filter criteria.

FilterItem[]criteriaItems

Formula that must evaluate to true for a record to enter the approval process

or approval step.

stringformula

ApprovalStepRejectBehavior

Represents what happens if the approver rejects the request during this approval step, unless it’s the first step in the approval process.

For the first step in the approval process, the reject behavior is determined by the approval process’s final rejection actions.

DescriptionField TypeField Name

Not allowed in the first step of the approval process. Valid values are:StepRejectBehaviorType

(enumeration of type string)

type

•RejectRequest—Rejects the request completely even if previous steps were

approved. Salesforce performs all rejection actions specified for this step and all

final rejection actions.

•BackToPrevious—Rejects the request, and returns the approval request to

the previous approver. Salesforce performs all rejection actions specified for this

step.

NextAutomatedApprover

Represents the user hierarchy field to use as the next automated approver for the approval process. If defined, the user specified in the

hierarchy field can be automatically assigned as the approver in one or more approval steps.

DescriptionField

Type

Field Name

Required. Whether the first executed approval step should use the

specified userHierarchyField in the record owner’s user

booleanuseApproverFieldOfRecordOwner

record—instead of the submitter’s user record—as the approver. All

remaining steps use the specified userHierarchyField in the

user record of the preceding step’s approver.

Required. Standard or custom user hierarchy field whose value specifies

which user to assign as the approver. For example, the standard

stringuserHierarchyField

Manager hierarchy field can be used to assign approvers for employee

PTO (paid time off) requests.

154

ApprovalProcessMetadata Types

Declarative Metadata Sample Definition

The following is an example of an ApprovalProcess component:

<?xml version="1.0" encoding="UTF-8"?>

<active>false</active>

<allowRecall>false</allowRecall>

<type>owner</type>

</allowedSubmitters>

<submitter>USSalesRep</submitter>

</allowedSubmitters>

<submitter>MarketingGroup</submitter>

<type>group</type>

</allowedSubmitters>

<submitter>kcooper@example.com</submitter>

</allowedSubmitters>

<field>Owner</field>

<field>MyLeadCustomField__c</field>

<field>Address</field>

</approvalPageFields>

<allowDelegate>false</allowDelegate>

<name>LeadApprovedTask1</name>

</action>

<name>LeadApprovedTask2</name>

</action>

</approvalActions>

<type>adhoc</type>

</approver>

</assignedApprover>

<name>LeadRejectedTask</name>

</action>

</rejectionActions>

</approvalStep>

155

ApprovalProcessMetadata Types

<allowDelegate>false</allowDelegate>

<type>userHierarchyField</type>

</approver>

</assignedApprover>

<field>Lead.CreatedDate</field>

<operation>greaterThan</operation>

</criteriaItems>

<field>User.IsActive</field>

<operation>notEqual</operation>

</criteriaItems>

</entryCriteria>

<ifCriteriaNotMet>ApproveRecord</ifCriteriaNotMet>

<type>RejectRequest</type>

</rejectBehavior>

</approvalStep>

<name>MarketingTeamQueue</name>

<type>queue</type>

</approver>

<name>LastModifiedBy</name>

<type>relatedUserField</type>

</approver>

<name>awheeler@example.com</name>

</approver>

<whenMultipleApprovers>FirstResponse</whenMultipleApprovers>

</assignedApprover>

<formula>CONTAINS( MyLeadCustomField__c , 'Salesforce')</formula>

</entryCriteria>

<type>BackToPrevious</type>

</rejectBehavior>

</approvalStep>

<emailTemplate>MyFolder/LeadsNewassignmentnotification</emailTemplate>

<enableMobileDeviceAccess>false</enableMobileDeviceAccess>

156

ApprovalProcessMetadata Types

<field>Lead.AnnualRevenue</field>

<operation>greaterThan</operation>

</criteriaItems>

<field>Lead.MyLeadCustomField__c</field>

<operation>equals</operation>

<value>Salesforce</value>

</criteriaItems>

</entryCriteria>

<name>LeadEmailContacted</name>

<type>Alert</type>

</action>

</finalApprovalActions>

<name>ProcessRejectedMessageAction</name>

<type>OutboundMessage</type>

</action>

</finalRejectionActions>

<finalRejectionRecordLock>false</finalRejectionRecordLock>

<name>LeadFieldUpdate</name>

<type>FieldUpdate</type>

</action>

<name>NewLeadEmail</name>

<type>Alert</type>

</action>

</initialSubmissionActions>

<label>SampleProcess</label>

<useApproverFieldOfRecordOwner>false</useApproverFieldOfRecordOwner>

<userHierarchyField>customlookupuserfield__c</userHierarchyField>

</nextAutomatedApprover>

<postTemplate>MyPostTemplate</postTemplate>

<name>ProcessRecalledMessageAction</name>

<type>OutboundMessage</type>

</action>

</recallActions>

<recordEditability>AdminOnly</recordEditability>

<showApprovalHistory>false</showApprovalHistory>

</ApprovalProcess>

157

ApprovalProcessMetadata Types

AssignmentRules

Represents assignment rules that allow you to automatically route cases to the appropriate users or queues. You can access rules metadata

for all applicable objects, for a specific object, or for a specific rule on a specific object. The package.xml syntax for accessing all

assignment rules for all objects is:

<types>

<name>AssignmentRules</name>

</types>

All rules for a specific object uses a similar syntax without the wildcard. For example, all assignment rules for the Case object would use

this syntax:

<types>

<name>AssignmentRules</name>

</types>

You can also access specific assignment rules for an object. The following example only accesses the “samplerule” and “newrule”

assignment rules on the Case object. Notice that for this example the type name syntax is AssignmentRule and not

AssignmentRules.

<types>

<members>Case.samplerule</members>

<members>Case.newrule</members>

<name>AssignmentRule</name>

</types>

File Suffix and Directory Location

Assignment rules for an object have the suffix .assignmentRules and are stored in the assignmentRules folder. For example,

all Case assignment rules are stored in the Case.assignmentRules file.

Version

AssignmentRules components are available in API version 27.0 and later.

Fields

DescriptionField TypeField Name

Represents the definitions of the named assignment rules.AssignmentRule[]assignmentRule

AssignmentRule

Specifies whether the rule is active or not and its definition. Rules are processed in the order they appear within the AssignmentRules

container.

158

AssignmentRulesMetadata Types

DescriptionField TypeField Name

Indicates whether the assignment rule is active (true) or

not (false).

booleanactive

Inherited from Metadata, this field is not defined in the

WSDL for this metadata type. It must be specified when

stringfullname

creating, updating, or deleting. See create() to see an

example of this field specified for a call.

This value cannot be null.

Represents the type and description for the assignment

rule.

RuleEntry[]ruleEntry

RuleEntry

Represents the fields used by the rule.

DescriptionField TypeField Name

The name of the user or queue the item is assigned to.stringassignedTo

Valid values are:AssignToLookupValueType

(enumeration of type string)

assignedToType

•User

•Queue

Advanced filter conditions that were specified for the rule.stringbooleanFilter

The items in the list that define the assignment criteria.FilterItem[]criteriaItems

The validation formula.stringformula

Note: Specify either formula or

criteriaItems, but not both fields.

Specifies whether email addresses included on the Cc line

of an incoming Email-to-Case or Web-to-Lead message

booleannotifyCcRecipients

should be included on the Cc line of the auto-response to

that message (true) or not (false). Available in API

version 32.0 and later.

Specifies whether the case team should be reset when the

assignment is done true) or if the current team is added

to the case instead of replacing the previous team (false).

booleanoverrideExistingTeams

The name of the case team. It may occur 0 or more times.string[]team

Specifies the template to use for the email that is

automatically sent to the designated recipient.

stringtemplate

159

AssignmentRulesMetadata Types

Declarative Metadata Sample Definition

The following is an example file showing two assignment rules on the Case object:

<AssignmentRules xmlns="http://soap.sforce.com/2006/04/metadata"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<fullName>samplerule</fullName>

<active>false</active>

<assignedTo>testUser@org.com</assignedTo>

<field>Case.IsEscalated</field>

<operation>equals</operation>

</criteriaItems>

<template>emailtemplate</template>

</ruleEntry>

</assignmentRule>

<fullName>Another samplerule</fullName>

<active>false</active>

<assignedTo>otherUser@org.com</assignedTo>

<field>Case.IsEscalated</field>

<operation>equals</operation>

<value>False</value>

</criteriaItems>

<template>emailtemplate</template>

</ruleEntry>

</assignmentRule>

</AssignmentRules>

AuraDefinitionBundle

Represents a Lightning definition bundle. A bundle contains a Lightning definition and all its related resources. The definition can be a

component, application, event, interface, or a tokens collection.

File Suffix and Directory Location

A Lightning bundle is a folder that contains definition files. Unlike other metadata components, an AuraDefinitionBundle component

isn’t represented by a single component file but instead by a collection of component definition files. Each definition file represents a

resource in a bundle, such as markup, applications, code files (including controllers and helpers), events, documentation, and interfaces.

For example, this directory structure shows the hierarchy of the folders and files for two bundles: bundle1 and bundle2.

aura

bundle1

bundle1.cmp

bundle1Controller.js

160

AuraDefinitionBundleMetadata Types

bundle2

bundle2.app

bundle2.cmp

bundle2Controller.js

bundle2.auradoc

Lightning bundles must be under a top-level folder that’s named aura. Each bundle must have its own subfolder under the aura

folder. The name of each definition file must start with the bundle name.

A bundle doesn’t have a suffix. Definition files can have one of these suffixes:

Component TypeSuffix

Application.app

Component.cmp

Design.design

Event.evt

Interface.intf

Controller, Helper, or Renderer.js

SVG image.svg

Style.css

Documentation.auradoc

Tokens collection.tokens

Each bundle can have only one file each with a suffix of .app, .cmp, .design, .evt, .intf, or .tokens.

Version

AuraDefinitionBundle components are available in API version 32.0 and later.

Design and SVG components are available in API version 33.0 and later.

Special Access Rules

Definitions can be created only in organizations with defined namespaces.

Fields

DescriptionField TypeField Name

The API version for this definition bundle. When you create an Aura

bundle, you can specify the API version to save it with. Available in API

version 35.0 and later.

doubleapiVersion

161

AuraDefinitionBundleMetadata Types

DescriptionField TypeField Name

The content of a JavaScript client-side controller.base64BinarycontrollerContent

The specification of the Aura bundle. Available in API version 35.0 and

later.

stringdescription

The content of a design definition. Only valid inside a component bundle.base64BinarydesignContent

The content of a documentation definition.base64BinarydocumentationContent

The content of a JavaScript helper.base64BinaryhelperContent

The content of the markup for a definition.base64Binarymarkup

Deprecated. Do not use.base64BinarymodelContent

The list of installed managed package versions that this Aura definition

bundle references. Available in API version 35.0 and later.

PackageVersion[]packageVersions

The content of a JavaScript client-side renderer.base64BinaryrendererContent

The CSS for the definition.base64BinarystyleContent

The SVG image for the definition.base64BinarySVGContent

Reserved for future use.base64BinarytestsuiteContent

The definition type. Valid values are:AuraBundleType

(enumeration of

type string)

type

•Application

•Component

•Event

•Interface

•Tokens

Declarative Metadata Sample Definition

This example shows the directory structure of an AuraDefinitionBundle component.

aura

sampleCmp

sampleCmp.cmp

sampleCmpController.js

The following samples show the contents of the metadata definition files that correspond to the sample aura directory.

Content of sampleCmp.cmp:

<aura:component>

<aura:attribute name="val1" type="String" default="Value"/>

<aura:attribute name="val2" type="String" />

<aura:handler name="init" value="{!this}" action="{!c.myAction}"/>

<ui:outputText value='Hello world!'/>

<ui:outputText value='{!v.val1}'/>

162

AuraDefinitionBundleMetadata Types

<ui:outputText value='{!v.val2}'/>

</aura:component>

Content of sampleCmpController.js:

({

myAction : function(component) {

component.set('v.val1','Value1');

component.set('v.val2','Value2');

}

})

This package.xml references the definitions of all Lightning components that are present in the sampleCmp bundle.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>sampleCmp</members>

<name>AuraDefinitionBundle</name>

</types>

</Package>

AuthProvider

Represents an authentication provider (or auth provider) in your organization. An auth provider enables users to log in to your Salesforce

organization using their login credentials from an external service provider such as Facebook© or Janrain©. This type extends the Metadata

metadata type and inherits its fullName field.

File Suffix and Directory Location

Authentication providers are stored in the authproviders directory. The file name matches the URL suffix and the extension is

.authprovider. For example, an auth provider with URL suffix FacebookProvider is stored in

authproviders/FacebookProvider.authprovider.

Version

Authentication providers are available in API version 27.0 and later.

Special Access Rules

Only users with the “Customize Application” and “Manage AuthProviders” permissions can access this object.

163

AuthProviderMetadata Types

Fields

DescriptionField TypeField Name

Required, but only if providerType is OpenIdConnect. The OAuth

authorization endpoint URL. Used only with OpenID Connect authentication

providers. Available in API version 29.0 and later.

In API version 33.0 and later, the behavior of this field changed to support

the Salesforce-managed auth provider configuration, which allows

stringauthorizeUrl

Salesforce to manage the value for Facebook, Salesforce, LinkedIn, Twitter

or Google authentication. For more information, see the Usage section.

Required. The app’s key that is registered at the third-party single sign-on

provider.

In API version 33.0 and later, the behavior of this field changed to support

the Salesforce-managed auth provider configuration, which allows

stringconsumerKey

Salesforce to manage the value for Facebook, Salesforce, LinkedIn, Twitter

or Google authentication. For more information, see the Usage section.

Required. The consumer secret of the app that is registered at the

third-party single sign-on provider. This field cannot be updated. When

stringconsumerSecret

using create() this field must be encrypted. To create an encrypted

form of the consumer secret from plain text:

1. Create an auth provider with the consumerSecret plain text

value.

2. Save the auth provider.

3. Create an outbound change set that includes the auth provider

component.

The new change set .xml file will have an entry in the form

<consumerSecret>++XYZ++</consumerSecret> where

++XYZ++ is the encrypted secret.

In API version 33.0 and later, the behavior of this field changed to support

the Salesforce-managed auth provider configuration, which allows

Salesforce to manage the value for Facebook, Salesforce, LinkedIn, Twitter

or Google authentication. For more information, see the Usage section.

Required, but only with custom authentication provider plug-ins, when

ProviderType is Custom. The API name of the authentication

provider. Available in API version 36.0 and later.

stringcustomMetadataTypeRecord

Required, but only if providerType is OpenIdConnect The scopes

to be sent with the authorization request, if not specified when a flow is

stringdefaultScopes

started. Used only with OpenID Connect authentication providers. Available

in API version 29.0 and later.

In API version 33.0 and later, the behavior of this field changed to support

the Salesforce-managed auth provider configuration, which allows

164

AuthProviderMetadata Types

DescriptionField TypeField Name

Salesforce to manage the value for Facebook, Salesforce, LinkedIn, Twitter

or Google authentication. For more information, see the Usage section.

Required. Used when referring to the auth provider from a program.stringDeveloperName

A custom error URL for the provider to use to report any errors.stringerrorUrl

The user that runs the Apex handler class. The user must have the “Manage

Users” permission. A user is required if you specify a registration handler

class.

stringexecutionUserId

Required. A user-friendly name for the provider.stringfriendlyName

The path to an icon to use as a button on the login page for a community.

Users click the button to log in to a community with the associated

stringiconUrl

authentication provider, such as Twitter© or LinkedIn©. Available in API

version 32.0 and later.

Only available if providerType is OpenIdConnect. This value

identifies the source of the authentication token in the form https:

stringidTokenIssuer

URI. Used only with OpenID Connect authentication providers. If provided,

Salesforce validates the returned id_token value. The OpenID Connect

specification requires an id_token value to be returned with the

access_token value. Available in API version 30.0 and later.

Provides a specific destination for users after they log out if they

authenticated using the single sign-on flow. The URL must be fully qualified

stringlogoutUrl

with an http or https prefix, such as

https://acme.my.salesforce.com. Available in API version

33.0 and later.

An existing Apex class that extends the

Auth.AuthProviderPluginClass abstract class. Available in

API version 36.0 and later.

stringplugin

Required. The third-party single sign-on provider to use. Valid values are:AuthProviderType

(enumeration of

type string)

providerType

•Facebook

•Google

•Salesforce

•Janrain

•LinkedIn (Available in API version 32.0 and later.)

•Twitter (Available in API version 32.0 and later.)

•OpenIdConnect (Available in API version 29.0 and later.)

Note: This type requires values for the following fields:

–authorizeUrl

–defaultScopes

–tokenUrl

165

AuthProviderMetadata Types

DescriptionField TypeField Name

–userInfoUrl

•MicrosoftACS Microsoft Access Control Service typically provides

authentication for a Microsoft Office 365 service like SharePoint® Online.

(Available in API version 31.0 and later.)

•GitHub—Use the GitHub provider to log in users of your Force.com

app to GitHub using OAuth. When logged in to GitHub, your app can

make calls to GitHub APIs. The GitHub provider isn’t available as a

single sign-on provider, so users can’t log in to your Salesforce org

using their GitHub login credentials. (Available in API version 35.0 and

later.)

•Custom—A provider configured with a custom authentication

provider plug-in. (Available in API version 36.0 and later.)

An existing Apex class that implements the

Auth.RegistrationHandler interface.

stringregistrationHandler

Required only if providerType is OpenIdConnect. When true,

the access token is sent to the userInfoUrl in a header instead of a

booleansendAccessTokenInHeader

query string. Used only with OpenID Connect authentication providers.

Available in API version 30.0 and later.

Required only if providerType is OpenIdConnect. When true,

the client credentials are sent in a header, instead of a query string, to the

booleansendClientCredentialsInHeader

tokenUrl. The credentials are in the standard OpenID Connect Basic

Credentials header form, which is Basic <token>, where <token>

is the base64-encoded string "clientkey:clientsecret". Used

only with OpenID Connect authentication providers. Available in API version

30.0 and later.

Required, but only if providerType is OpenIdConnect. The OAuth

token endpoint URL. Used only with OpenID Connect authentication

providers. Available in API version 29.0 and later.

In API version 33.0 and later, the behavior of this field changed to support

the Salesforce-managed auth provider configuration, which allows

stringtokenUrl

Salesforce to manage the value for Facebook, Salesforce, LinkedIn, Twitter

or Google authentication. For more information, see the Usage section.

Required, but only if providerType is OpenIdConnect. The

OpenID Connect endpoint URL. Used only with OpenID Connect

authentication providers. Available in API version 29.0 and later.

In API version 33.0 and later, the behavior of this field changed to support

the Salesforce-managed auth provider configuration, which allows

stringuserInfoUrl

Salesforce to manage the value for Facebook, Salesforce, LinkedIn, Twitter

or Google authentication. For more information, see the Usage section.

166

AuthProviderMetadata Types

Declarative Metadata Sample Definition

<?xml version="1.0" encoding="UTF-8"?>

<consumerKey>yourappkey</consumerKey>

<consumerSecret>PwdVxXjzu3NCZ3MD4He+wA==</consumerSecret>

<executionUser>admin@your.org</executionUser>

<friendlyName>FacebookAuthProvider</friendlyName>

<providerType>Facebook</providerType>

<registrationHandler>RegistrationHandler</registrationHandler>

</AuthProvider>

The following is an example package manifest that references the previous AuthProvider definition.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>FacebookAuthProvider</members>

<name>AuthProvider</name>

</types>

</Package>

Usage

For API version 33.0 and later when implementing the Salesforce-managed authentication provider configuration, you can have Salesforce

create and manage the following fields for you:

•authorizeUrl

•consumerKey

•consumerSecret

•defaultScopes

•tokenURL

•userInfoUrl

To configure a Salesforce-managed authentication provider, set up a Facebook, Salesforce, LinkedIn, Twitter or Google auth provider

and leave all of the listed fields blank. Salesforce automatically creates values for you. However, if you provide a value for any of these

fields, then consumerKey and consumerSecret must also be specified.

AutoResponseRules

Represents an auto-response rule that sets conditions for sending automatic email responses to lead or case submissions based on the

attributes of the submitted record. You can access rules metadata for all applicable objects, for a specific object, or for a specific rule on

a specific object. The package.xml syntax for accessing all auto-response rules for all objects is:

<types>

<name>AutoResponseRules</name>

</types>

167

AutoResponseRulesMetadata Types

All rules for a specific object uses a similar syntax without the wildcard. For example, all auto-response rules for the Case object would

use this syntax:

<types>

<name>AutoResponseRules</name>

</types>

You can also access specific auto-response rules for an object. The following example only accesses the “samplerule” and “newrule”

auto-response rules on the Case object. Notice that for this example the type name syntax is AutoResponseRule and not

AutoResponseRules.

<types>

<members>Case.samplerule</members>

<members>Case.newrule</members>

<name>AutoResponseRule</name>

</types>

File Suffix and Directory Location

AutoResponseRules for an object have the suffix .autoResponseRules and are stored in the autoResponseRules folder.

For example, all Case auto-response rules are stored in the Case.autoResponseRules file.

Version

AutoResponseRules components are available in API version 27.0 and later.

Fields

DescriptionField TypeField Name

Represents the definitions of the named auto-response rules.AutoResponseRule[]autoresponseRule

AutoResponseRule

Represents whether a rule is active or not and the order in which the entry is processed in the rule.

DescriptionField TypeField Name

Indicates whether the autoresponse rule is active (true)

or not (false).

booleanactive

Inherited from Metadata, this field is not defined in the

WSDL for this metadata type. It must be specified when

stringfullname

creating, updating, or deleting. See create() to see an

example of this field specified for a call.

This value cannot be null.

168

AutoResponseRulesMetadata Types

DescriptionField TypeField Name

Represents the type and description for the auto-response

rule.

RuleEntry[]ruleEntry

RuleEntry

Represents the fields used by the rule.

DescriptionField TypeField Name

Advanced filter conditions that were specified for the rule.stringbooleanFilter

The items in the list that define the assignment criteria.FilterItem[]criteriaItems

The validation formula.stringformula

Note: Specify either formula or

criteriaItems, but not both fields.

The email address that appears in the reply-to header.stringreplyToEmail

The email address of the person or queue sending the email

notification.

stringsenderEmail

The name of the person or queue sending the email

notification.

stringsenderName

Specifies the template to use for the email that is

automatically sent to the designated recipient.

stringtemplate

Declarative Metadata Sample Definition

The following is an example AutoResponseRules component:

<fullName>ajbdeploytest2</fullName>

<active>false</active>

<field>Case.Description</field>

<operation>contains</operation>

<value>testing</value>

</criteriaItems>

<senderName>tester name j</senderName>

<template>emailtemplate</template>

</ruleEntry>

</autoResponseRule>

</AutoResponseRules>

169

AutoResponseRulesMetadata Types

CallCenter

Represents the Call Center definition used to integrate Salesforce with a third-party computer-telephony integration (CTI) system.

File Suffix and Directory Location

CallCenter components have the suffix callCenter and are stored in the callCenters folder.

Version

CallCenter components are available in API version 27.0 and later.

Fields

DescriptionField TypeField Name

Optional field. A URL that points to a CTI 4 adapter.stringadapterUrl

The display name of this call center.stringdisplayName

The label of the displayName field in Call Center setup page.stringdisplayNameLabel

The label of the internalName field in Call Center setup page.stringinternalNameLabel

The version of this call center.stringversion

Custom setup items defined for this call center.CallCenterSection[]sections

CallCenterSection

DescriptionField TypeField Name

Contains the label, name, and value that

describe the sections.

CallCenterItem[] on page 170items

The label of the section.stringlabel

The name of the section.stringname

CallCenterItem

DescriptionField TypeField Name

The label of the custom setup item.stringlabel

The name of the custom setup item.stringname

The value of the custom setup item.int or URLvalue

170

CallCenterMetadata Types

Declarative Metadata Sample Definition

The following is an example of a CallCenter component:

<?xml version="1.0" encoding="UTF-8"?>

<adapterUrl>http://localhost:11000</adapterUrl>

<displayName>Demo Call Center Adapter</displayName>

<displayNameLabel>Display Name</displayNameLabel>

<internalNameLabel>Internal Name</internalNameLabel>

<items>

<label>Description</label>

<name>reqDescription</name>

<value>Demo Call Center Adapter</value>

</items>

<items>

<label>CTI Connector ProgId</label>

<name>reqProgId</name>

<value>DemoAdapter.DemoAdapter.1</value>

</items>

<items>

<label>Version</label>

<name>reqVersion</name>

</items>

<items>

<label>CTI Adapter URL</label>

<name>reqAdapterUrl</name>

<value>http://localhost:11000</value>

</items>

<label>General Information</label>

<name>reqGeneralInfo</name>

</sections>

<items>

<label>Outside Prefix</label>

<name>reqOutsidePrefix</name>

</items>

<items>

<label>Long Distance Prefix</label>

<name>reqLongDistPrefix</name>

</items>

<items>

<label>International Prefix</label>

<name>reqInternationalPrefix</name>

</items>

<label>Dialing Options</label>

<name>reqDialingOptions</name>

</sections>

</CallCenter>

171

CallCenterMetadata Types

CampaignInfluenceModel

Represents a campaign influence model used by Customizable Campaign Influence.

You can’t configure Customizable Campaign Influence via the Metadata API, but you can add a campaign influence model.

Note: This information applies only to Customizable Campaign Influence and not to the original version of Campaign Influence.

File Suffix and Directory Location

CampaignInfluenceModel values are stored in the campaignInfluenceModels directory of the corresponding package directory.

The file name matches the model name, and the extension is .campaignInfluenceModel.

Version

CampaignInfluenceModel components are available in API version 38.0 and later.

Fields

DescriptionField TypeField Name

Indicates if the model is the primary model or not. Only campaign

influence records associated with the primary model appear on

Campaigns and Opportunities.

booleanisDefaultModel

Indicates if the model is locked or not. Campaign Influence records for

locked models can be manipulated only via the API.

booleanisModelLocked

A description of the influence model.stringmodelDescription

A unique name for the model.stringname

Declarative Metadata Sample Definition

The following is an example of a CampaignInfluenceModel component that represents the default Salesforce campaign influence

attribution model. The default isDefaultModel value of true can be changed if another model is created and set as the primary

model. The isModelLocked value of true means that Campaign Influence records for this model can be seen in the UI, but not

created, updated, or deleted.

<?xml version="1.0" encoding="UTF-8"?>

<modelDescription>Primary Campaign gets 100% of the revenue share</modelDescription>

<name>Salesforce Model</name>

</CampaignInfluenceModel>

172

CampaignInfluenceModelMetadata Types

The following is an example of a CampaignInfluenceModel component that creates an influence model called Last Touch, which will

not be the primary model.

<?xml version="1.0" encoding="UTF-8"?>

<isDefaultModel>false</isDefaultModel>

<modelDescription>This model gives 100% influence attribution to the last campaign

that touched the contact.</modelDescription>

<name>Last Touch</name>

</CampaignInfluenceModel>

Certificate

Represents a certificate used for digital signatures which verify that requests are coming from your org. Certificates are used for either

authenticated single sign-on with an external website, or when using your org as an identity provider. This type extends the

MetadataWithContent metadata type and inherits its content and fullName fields.

File Suffix and Directory Location

Certificate components have the suffix .crt and are stored in the certs folder.

Version

Certificate components are available in API version 36.0 and later.

Fields

DescriptionField TypeField Name

Required. Indicates whether this certificate is signed by the issuer (true)

or not (false).

booleancaSigned

Indicates whether this certificate is encrypted with Platform Encryption.booleanencryptedWithPlatformEncryption

The date that this certificate expires and is no longer usable. For

self-signed certificates, if keySize is 2048 bits, the expiration date is

dateTimeexpirationDate

automatically 1 year after you create the certificate. If keySize is 4096

bits, the expiration date is automatically 2 years after you create the

certificate. For CA-signed certificates, expirationDate is

automatically updated to the signed certificate’s expiration date when

a signed certificate chain is uploaded. The date format is YYYY-MM-DD.

Certificate keys can be either 2048 bits or 4096 bits. A certificate with

4096-bit keys lasts 2 years, and a certificate with 2048-bit keys lasts 1

intkeySize

year. Certificates with 2048-bit keys are faster than certificates with

4096-bit keys. If keySize isn’t specified when you create a certificate,

the key size defaults to 2048 bits.

173

CertificateMetadata Types

DescriptionField TypeField Name

Required. A user-friendly name for the certificate that appears in the

Salesforce user interface, such as in Certificate and Key Management.

Limit: 64 characters.

stringmasterLabel

Indicates whether this certificate’s private key is exportable. If

privateKeyExportable isn’t specified when you create a

certificate, its default value is true.

booleanprivateKeyExportable

Usage

The Metadata API can be used to create a self-signed or a CA-signed certificate. The .crt file’s contents are the certificate chain, which

can be updated when you renew or update the intermediate certificate chain of a CA-signed certificate. After creating a CA-signed

certificate, the .crt file contains a certificate signing request (CSR). For details, see About Salesforce Certificates and Keys in the Salesforce

Help.

To copy an existing certificate’s X.509 parameter data to a new certificate, upload the existing certificate. You can also use this procedure

to renew a certificate. A new private+public key pair is created with a new certificate. Salesforce doesn’t allow the import or export of

the private key via the API. For details, see Repeating an Upload of a CA-Signed Certificate in Salesforce Help.

Using the Metadata API, you can download a CSR. After it’s CA-signed, you can upload it back to Salesforce.

•Downloading a CSR. The CSR is downloadable after a CA-signed cert is created. If a signed certificate hasn’t been uploaded to that

certificate, the content of the downloaded .crt file is the CSR.

•Uploading a CA-Signed Certificate. To upload the signed certificate chain back to Salesforce, save the signed certificate chain as

the content of the .crt file and update it via the Metadata API.

Note: After the signed certificate chain is uploaded via the Metadata API, the CSR of that certificate can’t be downloaded via the

API anymore. This is because the content of the .crt file is the signed certificate chain. However, the CSR can still be downloaded

via the UI.

Declarative Metadata Sample Definition

The following is an example of a Certificate component.

<?xml version="1.0" encoding="UTF-8"?>

<masterLabel>My Certificate Name</masterLabel>

</Certificate>

CleanDataService

Represents a data service that adds and updates data in standard objects. This type extends the Metadata metadata type and inherits

its fullName field.

174

CleanDataServiceMetadata Types

File Suffix and Directory Location

CleanDataService components have the .cleanDataService suffix and are stored in the cleanDataServices directory.

The name of the component file is based on the name of the object associated with the data service. For example, the component file

name cleanDataServices/DataCloudCompanyMatch.cleanDataService describes a data service component

called DataCloudCompanyMatch that's associated with the company name in account objects.

Version

CleanDataService components are available in API version 39.0 and later.

Fields

DescriptionField TypeField Name

Required. A list of data integration rulesCleanRule[]cleanRules

Required. A description of the data servicestringdescription

Required. Master label for this data service. Although this value is

displayed, it’s an internal label for the data service and isn’t translated.

stringmasterLabel

Required. A key that maps to the internal data service identifier.stringmatchEngine

CleanRule

Represents information that controls how the data service adds and updates data in an org.

DescriptionField TypeField Name

Required. If this field is set to true, Salesforce applies the data integration

rule to existing records whenever the rule is updated or saved.

booleanbulkEnabled

Required. If this field is set to true, Salesforce bypasses triggers when it applies

the rule; otherwise, it applies triggers after it applies the rule.

booleanbypassTriggers

Required. If this field is set to true, Salesforce bypasses workflow rules when

it applies the data integration rule; otherwise, it applies workflow rules after it

applies the rule.

booleanbypassWorkflow

Required. User-friendly text that describes the data integration rule.stringdescription

Required. This name can contain only underscores and alphanumeric characters,

and must be unique in your org. It must begin with a letter, not include spaces,

stringdeveloperName

not end with an underscore, and not contain two consecutive underscores.

This unique name prevents conflicts with rules from other packages that have

the same MasterLabel.

Required. A list of FieldMapping entries for the rule.FieldMapping[]fieldMappings

Required. Master label for this object. This display value is the internal label

that is not translated.

stringmasterLabel

175

CleanDataServiceMetadata Types

DescriptionField TypeField Name

Required. An internal label for a matching rule in the data service that’s

associated with the CleanRule.

stringmatchRule

Required. A virtual object in the data service that is associated with the

CleanRule. Specifying a non-existent object causes an error.

stringsourceSobjectType

Required. Status of the data integration rule. Valid values are Active and

Inactive.

stringstatus

Required. A standard object that’s the target of additions and updates specified

by this CleanRule. Specifying an object that the data service does not support

causes an error.

stringtargetSobjectType

FieldMapping

Represents a mapping between fields in the data service and fields in an object in the org.

DescriptionField TypeField Name

Required. This name can contain only underscores and alphanumeric characters,

and must be unique in your org. It must begin with a letter, not include spaces,

stringdeveloperName

not end with an underscore, and not contain two consecutive underscores.

This unique name prevents conflicts with field mappings from other packages

that have the same MasterLabel.

Required. A list of FieldMappingRow entries. Each entry represents a field in a

standard object that maps to a field in the data service.

FieldMappingRow[]fieldMappingRows

Required. Master label for this object. This display value is the internal label

that is not translated.

stringmasterLabel

Required. The standard object associated with this FieldMapping. Specifying

an object that the data service does not support causes an error.

stringSObjectType

FieldMappingRow

Represents the status of a CleanRule.

DescriptionField TypeField Name

The display name for the field represented by the FieldMappingRow.stringfieldName

Required. A list of FieldMappingField entries. Each entry is a field in a standard

object that maps to a field in the data service.

FieldMappingField[]fieldMappingFields

The comparison operation the data service applies when it compares the value

of this FieldMappingRow to the mapped field in the object specified in

stringmappingOperation

SObjectType. The value of this field is AutoFill, which indicates that the

data service only adds data if the object field is blank.

176

CleanDataServiceMetadata Types

DescriptionField TypeField Name

The standard object for the field mapped to the FieldMappingRow. Specifying

an object that the data service does not support causes an error.

stringSObjectType

FieldMappingField

Represents a field in a standard object. A FieldMappingField maps to a FieldMappingRow entry in a data service.

DescriptionField TypeField Name

Required. A field in the data service that is mapped to this field.stringdataServiceField

Required. An object in the data service that contains the FieldMappingRow

associated with this FieldMappingField. Specifying a non-existent object causes

an error.

stringdataServiceObjectName

Required. Represents the priority that the data service uses when it updates

the field, relative to other update rules for the same field. Valid values are 1-100.

intpriority

Declarative Metadata Sample Definition

The following is an example of a CleanDataService component for the lead standard object.

<?xml version="1.0" encoding="UTF-8"?>

<bulkEnabled>false</bulkEnabled>

<bypassTriggers>false</bypassTriggers>

<bypassWorkflow>false</bypassWorkflow>

<description>Adds data info to leads</description>

<developerName>DataService_Leads_Enrichment</developerName>

<SObjectType>DataServiceCompanyObject</SObjectType>

<developerName>DataService_Leads_Enrichment_InputMapping</developerName>

<SObjectType>DataServiceCompanyObject</SObjectType>

<dataServiceField>Email</dataServiceField>

</fieldMappingFields>

<fieldName>Email</fieldName>

<mappingOperation>Autofill</mappingOperation>

</fieldMappingRows>

<SObjectType>DataServiceCompanyObject</SObjectType>

<dataServiceField>Company</dataServiceField>

</fieldMappingFields>

177

CleanDataServiceMetadata Types

<mappingOperation>Autofill</mappingOperation>

</fieldMappingRows>

<masterLabel>DataServiceInputMapping</masterLabel>

</fieldMappings>

<developerName>DataService_Leads_Enrichment_OutputMapping</developerName>

<dataServiceField>EmployeesTotal</dataServiceField>

<dataServiceObjectName>DataServiceCompanyObject</dataServiceObjectName>

</fieldMappingFields>

<fieldName>NumberOfEmployees</fieldName>

<mappingOperation>Autofill</mappingOperation>

</fieldMappingRows>

<dataServiceField>Revenue</dataServiceField>

<dataServiceObjectName>DataServiceCompanyObject</dataServiceObjectName>

</fieldMappingFields>

<fieldName>AnnualRevenue</fieldName>

<mappingOperation>Autofill</mappingOperation>

</fieldMappingRows>

<dataServiceField>Industry</dataServiceField>

<dataServiceObjectName>DataServiceCompanyObject</dataServiceObjectName>

</fieldMappingFields>

<fieldName>Industry</fieldName>

<mappingOperation>Autofill</mappingOperation>

</fieldMappingRows>

<masterLabel>DataServiceOutputMapping</masterLabel>

</fieldMappings>

<masterLabel>Data Service Company Info for Leads</masterLabel>

<matchRule>DataServiceLeadAppendMatchRule</matchRule>

<sourceSobjectType>DataServiceCompanyObject</sourceSobjectType>

<status>Active</status>

</cleanRules>

<description>Data Service Companies for Leads</description>

<masterLabel>Data Service Companies for Leads</masterLabel>

<matchEngine>LeadEnrichmentMatchEngine</matchEngine>

</CleanDataService>

178

CleanDataServiceMetadata Types

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>DataService_Leads_Enrichment</members>

<name>CleanDataService</name>

</types>

</Package>

Usage

Use CleanDataService to retrieve all the metadata that describes a data enrichment service. To configure the service in a new org, deploy

the metadata you retrieved. Avoid using CRUD-Based Calls with CleanDataService.

To make small modifications to the CleanDataService component, use the Tooling API.

Community (Zone)

Note: Starting with the Summer ’13 release, Chatter Answers and Ideas “communities” have been renamed to “zones.” In API

version 28, the API object label has changed to Zone, but the API type is still Community.

Represents a zone that contains Ideas or Chatter Answers objects. Zones are shared by the Ideas, Answers, and Chatter Answers features,

allowing you to view and create zones from those locations. This type extends the Metadata metadata type and inherits its fullName

field.

Note: When enableChatterAnswers is set to false, values specified for the following fields are ignored and not saved:

communityFeedPage, emailFooterDocument, emailHeaderDocument, enablePrivateQuestions,

emailNotificationUrl, and site.

File Suffix and Directory Location

Zones have the suffix community and are stored in the communities folder.

Version

Community (Zone) components are available in API version 27.0 and later.

Fields

DescriptionField TypeField Name

Indicates whether the zone is active (true) or not (false).booleanactive

(Read only) The Facebook sign-on URL, which is based on the Facebook

authentication provider selected in your Chatter Answers settings. This

stringchatterAnswersFacebookSsoUrl

field is available only if Chatter Answers and Facebook Single Sign-On

for Chatter Answers are enabled.

179

Community (Zone)Metadata Types

DescriptionField TypeField Name

The Visualforce page that hosts the zone’s feeds. This field is available

when Chatter Answers is enabled in the organization.

stringcommunityFeedPage

The description of the zone.stringdescription

The text or HTML file that incorporates your organization’s branding into

the footer of email notifications. This field is available when Chatter

Answers is enabled in the organization.

stringemailFooterDocument

The text or HTML file that incorporates your organization’s branding into

the header of email notifications. This field is available when Chatter

Answers is enabled in the organization.

stringemailHeaderDocument

The URL that’s included in email notifications. This field is available when

Chatter Answers is enabled in the organization. This field replaces

portalEmailNotificationUrl in API version 28.0 and later.

stringemailNotificationUrl

Indicates whether the zone has Chatter Answers enabled (true) or not

(false). This field is available when Chatter Answers is enabled in the

organization.

booleanenableChatterAnswers

Indicates whether Chatter Answers questions can be escalated to cases

(true) or not (false). This field is available when Chatter Answers is

enabled in the organization.

booleanenablePrivateQuestions

The name of the public group that act as experts in the zone. This field

is available when eitherIdeas or Answers are enabled in the organization.

stringexpertsGroup

The name of the portal in which to display the zone.stringportal

The portal URL that’s included in email notifications. This field is available

when Chatter Answers is enabled in the organization. This field has been

replaced by emailNotificationUrl in API version 28.0 and later.

stringportalEmailNotificationUrl

The fields that define the points and name of each reputation level you

define. You can create up to 25 reputation levels per zone.

ReputationLevelsreputationLevels

Indicates whether the zone is available to all portals (true) or not

available to any portals (false).

booleanshowInPortal

The name of the site for the zone. This field is available when Chatter

Answers is enabled in the organization.

stringsite

ReputationLevels

Represents the points and reputation label that displays on hover over a user’s photo in the feed.

DescriptionField TypeField Name

Contains the name and value pair that describes the

reputation level for Chatter Answers. Available in API version

28.0 and later.

ChatterAnswersReputationLevel

[]

chatterAnswersReputationLevels

180

Community (Zone)Metadata Types

DescriptionField TypeField Name

Contains the name and value pair that describes the

reputation for Ideas. Available in API version 28.0 and later.

IdeaReputationLevelideaReputationLevels

ChatterAnswersReputationLevel

Represents the reputation name and the number of points for that level for Chatter Answers.

DescriptionField TypeField Name

The name of the reputation level, for example, “Expert.”stringname

The minimum number of points for the reputation level.intvalue

IdeaReputationLevel

Represents the reputation name and the number of points for that level for Ideas. Available in API version 28.0 and later.

DescriptionField TypeField Name

The name of the reputation level, for example, “Expert.”stringname

The minimum number of points for the reputation level.intvalue

Declarative Metadata Sample Definition

The following is the definition of a community (zone) component:

<?xml version="1.0" encoding="UTF-8"?>

<communityFeedPage>communityWithHeaderAndFooter_main</communityFeedPage>

<description>Metadata Test</description>

<emailFooterDocument>sampleFolder/emailFooter.html</emailFooterDocument>

<emailHeaderDocument>sampleFolder/emailHeader.html</emailHeaderDocument>

<expertsGroup>CommunityExperts</expertsGroup>

<portal>Customer Portal</portal>

<emailNotificationUrl>http://yourURL</emailNotificationUrl>

<name>Newbie</name>

</chatterAnswersReputationLevels>

<name>Smartie</name>

</chatterAnswersReputationLevels>

181

Community (Zone)Metadata Types

</chatterAnswersReputationLevels>

</chatterAnswersReputationLevels>

<name>Observer</name>

</ideaReputationLevels>

<name>Contributor</name>

</ideaReputationLevels>

<name>Influencer</name>

</ideaReputationLevels>

<name>Thought Leader</name>

</ideaReputationLevels>

</reputationLevels>

<site>ChatterAnswersSite</site>

</Community>

CommunityTemplateDefinition

Represents the definition of a community template. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

CommunityTemplateDefinition components have the suffix .communityTemplateDefinition and are stored in the

communityTemplateDefinitions folder.

Version

CommunityTemplateDefinition components are available in API version 38.0 and later.

Special Access Rules

This object is available only if Salesforce Communities is enabled in your org.

182

CommunityTemplateDefinitionMetadata Types

Fields

DescriptionField TypeField Name

Required. The list of preview images and feature descriptions of this

CommunityTemplateDefinition.

CommunityTemplate

BundleInfo [ ]

bundlesInfo

Required. The optimized use case of this CommunityTemplateDefinition.

Valid values are:

CommunityTemplate

SEE ALSO:

CustomTab

CustomApplicationComponent

Represents a custom console component (Visualforce page) assigned to a CustomApplication that is marked as a Salesforce console.

Custom console components extend the capabilities of Salesforce console apps. See “Customize a Console with Custom Components

in Salesforce Classic” in the Salesforce online help.

File Suffix and Directory Location

Custom application components have the suffix .customApplicationComponent and are stored in the

customApplicationComponents folder.

Version

Custom applications are available in API version 25.0 and later.

220

CustomApplicationComponentMetadata Types

Fields

DescriptionField TypeField Name

The address of a page that hosts an icon for the button.stringbuttonIconUrl

The inline style used to define how the button looks.stringbuttonStyle

The label on the button used to launch the custom console component.stringbuttonText

The pixel width of the button as it should display in the Salesforce

console.

intbuttonWidth

The pixel height of the window used to display the custom console

component.

intheight

Required. Indicates whether users can change the custom console

component height (false) or not (true).

booleanisHeightFixed

Required. Indicates whether the custom console component is hidden

from users (true) or not (false).

booleanisHidden

Required. Indicates whether users can change the component width

(false) or not (true).

booleanisWidthFixed

Required. Name of the Visualforce page that represents the custom

console component.

stringvisualforcePage

The pixel width of the window used to display the custom console

component.

intwidth

Declarative Metadata Sample Definition

The following is the definition of a custom application component:

<?xml version="1.0" encoding="UTF-8"?>

<buttonIconUrl>http://www.salesforce.com</buttonIconUrl>

<buttonStyle>buttonStyleCSS</buttonStyle>

<buttonText>buttonText</buttonText>

<isHeightFixed>false</isHeightFixed>

<isHidden>false</isHidden>

<isWidthFixed>false</isWidthFixed>

<visualforcePage>MyVisualforcePage</visualforcePage>

</CustomApplicationComponent>

221

CustomApplicationComponentMetadata Types

CustomFeedFilter

Represents a custom feed filter that limits the feed view to feeds from the Cases object. The custom feed filter shows only feed items

that satisfy the criteria specified in the CustomFeedFilter definition.This type extends the Metadata metadata type and inherits its

fullName field.

File Suffix and Directory Location

CustomFeedFilter components have the suffix .feedFilter and are stored in the feedFilters folder.

Version

CustomFeedFilter components are available in API version 35.0 and later.

Fields

DescriptionField TypeField Name

The description of the custom feed filter. For example, specify what feed

items that filter shows.

stringdescription

The criterion that defines which feed items are shown when the filter is

applied. The feed filter displays all feed items that satisfy the criteria.

FeedFilterCriterion

[]

criteria

Required. The API label of the custom feed filter.stringlabel

FeedFilterCriterion

Represents the conditions that a feed item must satisfy to be displayed when a feed filter is applied.

DescriptionField TypeField Name

Required. The type of feed items that the filter shows.

FeedItemType (enumeration of type

string)

feedItemType

The feed item type can be one of the following values:

•AttachArticleEvent

•CallLogPost

•CanvasPost

•CaseCommentPost

•ChangeStatusPost

•ChatTranscriptPost

•ContentPost

•CreateRecordEvent

•EmailMessageEvent

•LinkPost

222

CustomFeedFilterMetadata Types

DescriptionField TypeField Name

•MilestoneEvent

•QuestionPost

•PollPost

•ReplyPost

•SocialPost

•TextPost

The visibility of feed items that the filter shows. For

example, you can show only poll posts that are visible

internally.

FeedItemVisibility (enumeration of

type string)

feedItemVisibility

Valid values are:

•AllUsers

•InternalUsers

The API name of the object that the feed item refers to.

This field is typically used with the CreateRecordEvent

feed item type.

stringrelatedSObjectType

For example, a feed filter can show CreateRecordEvent

feed items for the Cases object.

Declarative Metadata Sample Definition

The following is an example of a CustomFeedFilter component.

<?xml version="1.0" encoding="UTF-8"?>

<feedItemType>CreateRecordEvent</feedItemType>

</criteria>

<feedItemType>CreateRecordEvent</feedItemType>

</criteria>

<feedItemType>PollPost</feedItemType>

<feedItemVisibility>InternalUsers</feedItemVisibility>

</criteria>

<label>Sample Custom Feed Filter</label>

</CustomFeedFilter>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>

<types>

223

CustomFeedFilterMetadata Types

<members>myCaseFeedFilter</members>

<name>CustomFeedFilter</name>

</types>

</Package>

CustomLabels

This metadata type allows you to create custom labels that can be localized for use in different languages, countries, and currencies.

This type extends the Metadata metadata type and inherits its fullName field. Custom labels are custom text values, up to 1,000

characters in length, that can be accessed from Apex classes or Visualforce pages. For more information, see “Custom Labels” in the

Salesforce online help.

Declarative Metadata File Suffix and Directory Location

Master custom label values are stored in the CustomLabels.labels file. Translations are stored in a file with a name format of

Translation-localeCode.translation, where localeCode is the locale code of the translation language. The

supported locale codes are listed in Language on page 677.

Custom label translations are stored in the labels folder in the corresponding package directory.

Version

CustomLabels components are available in API version 14.0 and later.

Fields

DescriptionField TypeField

Required. The name of the custom label bundle.

Inherited from Metadata, this field is not defined in the WSDL

for this metadata type. It must be specified when creating,

stringfullName

updating, or deleting. See create() to see an example of

this field specified for a call.

A list of custom labels.CustomLabel[]labels

CustomLabel

This metadata type represents a custom label. This type extends the Metadata metadata type and inherits its fullName field.

DescriptionField TypeField

A comma-separated list of categories for the label. This field can

be used in filter criteria when creating custom label list views.

Maximum of 255 characters.

stringcategories

224

CustomLabelsMetadata Types

DescriptionField TypeField

Required. The name of the custom label.

Inherited from Metadata, this field is not defined in the WSDL

for this metadata type. It must be specified when creating,

stringfullName

updating, or deleting. See create() to see an example of

this field specified for a call.

Required. The language of the translated custom label.stringlanguage

Required. Indicates whether this component is protected (true)

or not (false). Protected components cannot be linked to or

referenced by components created in the installing organization.

booleanprotected

Required. An easily recognizable term to identify this custom

label. This description is used in merge fields.

stringshortDescription

Required. The translated custom label. Maximum of 1000

characters.

stringvalue

Usage

Use CustomLabels with the wildcard character (*) for members in the package.xml manifest file to retrieve all custom labels that

are defined in your organization. CustomLabels doesn’t support retrieving one or more custom labels by name. To retrieve specific labels

by name, use CustomLabel and specify the label names as members.

Declarative Metadata Sample Definition

A sample XML definition of a custom label components is shown below.

<?xml version="1.0" encoding="UTF-8"?>

<fullName>quoteManual</fullName>

<value>This is a manual quote.</label>

<protected>false</protected>

<shortDescription>Manual Quote</shortDescription>

</labels>

<fullName>quoteAuto</fullName>

<value>This is an automatically generated quote.</label>

<protected>false</protected>

<shortDescription>Automatic Quote</shortDescription>

</labels>

</CustomLabels>

This is a sample manifest file for retrieving all custom labels in the organization by using the CustomLabels type.

<?xml version="1.0" encoding="UTF-8"?>

225

CustomLabelsMetadata Types

<fullName>MyPkg</fullName>

<types>

<name>CustomLabels</name>

</types>

</Package>

This is a sample manifest file for retrieving two custom labels by name. Notice it uses the CustomLabel singular type.

<?xml version="1.0" encoding="UTF-8"?>

<fullName>MyPkg</fullName>

<types>

<members>quoteManual</members>

<members>quoteAuto</members>

<name>CustomLabel</name>

</types>

</Package>

SEE ALSO:

Translations

Custom Metadata Types (CustomObject)

Represents the metadata associated with a custom metadata type.

For more information, see the Custom Metadata Types Implementation Guide.

File Suffix and Directory Location

A custom metadata type is defined as a custom object and is stored in the objects folder. Custom metadata types have a suffix of __mdt

(instead of __c for custom objects). Custom metadata type field names have a suffix of __c, like other custom fields. Custom metadata

type field names must be dot-qualified with the name of the custom metadata type to which they belong.

Names of custom metadata types must be unique within their namespace. All custom metadata types belong to the CustomMetadata

namespace and can optionally belong to a second namespace. In your organization, you can use custom metadata types with your

namespace as well as other organizations’ namespaces.

Version

Custom metadata type components are available in API version 31.0 and later.

Special Access Rules

To create custom metadata types, you must have the “Author Apex” permission. Only managed package developers can add new fields

to the custom metadata types in their managed packages. Customers who install a managed custom metadata type can’t add new

custom fields to it.

226

Custom Metadata Types (CustomObject)Metadata Types

Fields

Custom metadata types can contain the following CustomObject fields.

To make the fields on your custom metadata types unique and indexable, mark your fields as Unique and ExternalId.

DescriptionField TypeField Name

A description of the custom metadata type. This field can

contain a maximum of 1,000 characters.

stringdescription

Represents one or more custom fields in the custom

metadata type.

CustomField[]fields

Indicates the gender of the noun that represents the object.

This field is used for languages where words need different

treatment depending on their gender.

Gendergender

When a custom metadata type is released in a managed

package, access is limited in specific ways.

booleanProtected

•Code that’s in the same managed package as custom

metadata records can read the records.

•Code that’s in the same managed package as custom

metadata types can read the records that belong to

that type.

•Code that’s in a managed package that doesn’t contain

either the type or the protected record can’t read the

protected records.

•Code that the subscriber creates and code that’s in an

unmanaged package can’t read the protected records.

•The developer can modify protected records only with

a package upgrade. The subscriber can’t read or modify

protected records. The developer name of a protected

record can’t be changed after release.

•The subscriber can’t create records of a protected type.

Records that are hidden by these access rules are also

unavailable to REST, SOAP, SOQL, and Setup.

A label that represents the object throughout the Salesforce

Setup user interface. Custom metadata types are visible

stringlabel

only through the recently used objects list on the Force.com

Home Page and in the packaging user interface.

The plural version of the label value.stringpluralLabel

Indicates whether the noun starts with a vowel, a

consonant, or a special character. This field is used for

StartsWith (enumeration of type string)startsWith

languages where words need different treatment

depending on their first character.

227

Custom Metadata Types (CustomObject)Metadata Types

DescriptionField TypeField Name

When this field is present, this component is not a custom

object, but a custom setting or custom metadata type. This

SetupObjectVisibility (enumeration of type

string)

visibility

field returns the visibility of the custom setting or custom

metadata type. The following values are valid.

•Public—If the custom setting or custom metadata

type is packaged, it’s accessible to all subscribing

organizations.

•Protected—If the custom setting or custom

metadata type is in a managed package, it’s only

accessible to the developer organization; subscribing

organizations can’t access it.

The default value is Public.

Declarative Metadata Sample Definition

In this example, Picklists R Us creates its Reusable Picklist custom metadata type by deploying a file in the objects folder, named

ReusablePicklistOption__mdt.object, with these contents.

<?xml version="1.0" encoding="UTF-8"?>

<fullName>AlphaSort__c</fullName>

<defaultValue>false</defaultValue>

<externalId>false</externalId>

<label>Sorted Alphabetically</label>

<type>Checkbox</type>

</fields>

<label>Reusable Picklist</label>

<pluralLabel>Reusable Picklist</pluralLabel>

<visibility>Public</visibility>

</CustomObject>

This excerpt from a package.xml file shows the use of dot notation and the __mdt suffix. If you’re using a namespace, for example

picklist1234, the full name of ReusablePicklistOption__mdt would be picklist1234

__ReusablePicklistOption__mdt.

<?xml version="1.0" encoding="UTF-8"?>

...

<types>

<members>PicklistTest__c.PicklistTestField__c</members>

<members>ReusablePicklistOption__mdt.Picklist__c</members>

<members>ReusablePicklistOption__mdt.SortOrder__c</members>

<members>PicklistUsage__mdt.Field__c</members>

<members>PicklistUsage__mdt.Picklist__c</members>

<members>PicklistUsage__mdt.SObjectType__c</members>

<members>ReusablePicklist__mdt.AlphaSort__c</members>

<name>CustomField</name>

</types>

228

Custom Metadata Types (CustomObject)Metadata Types

...

<types>

<members>PicklistTest__c</members>

<members>ReusablePicklistOption__mdt</members>

<members>PicklistUsage__mdt</members>

<members>ReusablePicklist__mdt</members>

<name>CustomObject</name>

</types>

...

</Package>

CustomMetadata

Represents a record of a custom metadata type.

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

CustomMetadata components have the suffix .md and are stored in the customMetadata folder. Unlike custom metadata types,

custom metadata records don’t have a double-underscore suffix. Custom metadata record names are prepended with their custom

metadata type name, excluding the __mdt suffix but including the namespace of any types in an installed managed package.

Version

CustomMetadata components are available in API version 31.0 and later.

Special Access Rules

To create custom metadata records, you must have the “Customize Application” permission.

Fields

DescriptionField TypeField Name

A description of the custom metadata record. This field

can contain a maximum of 1,000 characters.

stringdescription

A label that represents the object throughout the

Salesforce Setup user interface. Custom metadata records

stringlabel

are currently visible only through the packaging user

interface.

Represents one or more values for custom fields on the

custom metadata record.

CustomMetadataValue[]values

CustomMetadataValue

Represents a value for a custom field on the custom metadata record.

229

CustomMetadataMetadata Types

DescriptionField TypeField Name

Required. The non-object-qualified name of a custom

field in the custom metadata type. This value corresponds

stringfield

to the name of a field on the custom metadata record’s

custom metadata type. Include the namespace (if the

type is from a managed package) and the __c suffix.

The name of the custom metadata type isn’t required.

For example, picklist1234__AlphaSort__c.

The value on a custom metadata record. Where fields are

EntityDefinition and FieldDefinition, the qualified API

Any typevalue

names of the entity and the field it points to. This value

can be null.

For more information, see Usage on page 233.

Declarative Metadata Sample Definitions

The following is an example of a CustomMetadata component. In this example, the sample app TravelApp deploys a Planets picklist,

specifies its sort order, and adds picklist items to it.

Assuming Picklists R Us’s namespace is picklist1234, to define the Planets picklist, TravelApp deploys a file in the

customMetadata folder, named picklist1234__ReusablePicklist.Planets.md, with these contents. The

xsi:type attribute specifies the type for the value of the AlphaSort__c checkbox field.

<?xml version="1.0" encoding="UTF-8"?>

<CustomMetadata xmlns="http://soap.sforce.com/2006/04/metadata"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<description>All the planets in the solar system. Does not

include asteroids.</description>

<label>Planets</label>

<field>picklist1234__AlphaSort__c</field>

<value xsi:type="xsd:boolean">false</value>

</values>

</CustomMetadata>

Picklists R Us creates its Reusable Picklist Option custom metadata type by deploying a file in the objects folder, named

ReusablePicklist__mdt.object, with these contents.

<?xml version="1.0" encoding="UTF-8"?>

<fullName>Picklist__c</fullName>

<externalId>false</externalId>

<label>Picklist</label>

<unique>false</unique>

</fields>

230

CustomMetadataMetadata Types

<fullName>SortOrder__c</fullName>

<externalId>false</externalId>

<label>Non-Alphabetical Sort Order</label>

<required>false</required>

<type>Number</type>

<unique>false</unique>

</fields>

<label>Reusable Picklist Option</label>

<pluralLabel>Reusable Picklist Options</pluralLabel>

</CustomObject>

To define the Mars picklist item, TravelApp deploys a file, named picklist1234__ReusablePicklistOption.Mars.md,

with these contents. This component file specifies types that apply to the ReusablePicklistOption__mdt custom fields.

<?xml version="1.0" encoding="UTF-8"?>

<CustomMetadata xmlns="http://soap.sforce.com/2006/04/metadata"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<field>picklist1234__Picklist__c</field>

<value xsi:type="xsd:string">Planets</value>

</values>

<field>picklist1234__SortOrder__c</field>

</values>

</CustomMetadata>

To define the Motel6 picklist item, TravelApp deploys a file, named

picklist1234__ReusablePicklistOption.Motel6.md, with these contents.

<?xml version="1.0" encoding="UTF-8"?>

<CustomMetadata xmlns="http://soap.sforce.com/2006/04/metadata"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<label>Motel 6</label>

<field>picklist1234__Picklist__c</field>

<value xsi:type="xsd:string">Hotels</value>

</values>

</CustomMetadata>

Because the SortOrder__c field isn’t required, this file doesn’t require a value for SortOrder__c. Alternatively, the file could

have explicitly specified a value with xsi:nil to ensure that SortOrder__c was cleared of any previous value.

<?xml version="1.0" encoding="UTF-8"?>

<CustomMetadata xmlns="http://soap.sforce.com/2006/04/metadata"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<label>Motel 6</label>

231

CustomMetadataMetadata Types

<field>picklist1234__Picklist__c</field>

<value xsi:type="xsd:string">Hotels</value>

</values>

<field>picklist1234__SortOrder__c</field>

</values>

</CustomMetadata>

This excerpt from a package.xml file illustrates the inclusion of custom metadata types and their namespaces in custom metadata

records’ names. Assume that Picklists R Us’s namespace is picklist1234.

<?xml version="1.0" encoding="UTF-8"?>

…

<types>

<members>picklist1234__ReusablePicklist.Hotels</members>

<members>picklist1234__ReusablePicklist.Planets</members>

<members>picklist1234__ReusablePicklistOption.Bellagio</members>

<members>picklist1234__ReusablePicklistOption.Motel6</members>

<members>picklist1234__ReusablePicklistOption.Mercury</members>

<members>picklist1234__ReusablePicklistOption.Venus</members>

<members>picklist1234__ReusablePicklistOption.Earth</members>

<members>picklist1234__PicklistUsage.BookedHotel</members>

picklist1234__PicklistUsage.DestinationPlanetPL

</members>

<members>picklist1234__PicklistUsage.PlanetVisitedPl</members>

<name>CustomMetadata</name>

</types>

…

</package>

TravelApp, Inc.’s package.xml file uses a wildcard to install custom metadata, as is shown in this excerpt from their package.xml

file. Unless you want to deploy or retrieve specific records, using a wildcard is easier than listing all of your custom metadata records in

your package.xml file.

<types>

<name>CustomMetadata</name>

</types>

If the custom metadata is from a managed package, the name after the dot in the package.xml file—between the two dots in the

file name—is qualified by the managed package’s namespace. For example, assuming TravelApp uses the namespace travelApp1234,

the first member element in the TravelApp package.xml file appears to Galactic Tours as:

<members>picklist1234__ReusablePicklist.travelApp1234__Hotels</members>

Here’s another example. In this case, we have an instance of custom metadata record, whose EntityDefinition field points to a custom

object named SalesAgreement__c. The FieldDefinition field points to the custom field CustomerReference__c on

SalesAgreement__c. You can deploy new custom metadata records and retrieve existing ones with EntityDefinition and

FieldDefinition fields using qualified API names of custom and standard entities and their fields.

<?xml version="1.0" encoding="UTF-8"?><values>

<field>EntityDefintionField__c</field>

232

CustomMetadataMetadata Types

<value xsi:type="xsd:string">v1__SalesAgreement__c</value>

</values>

<field>FieldDefinitionField__c</field>

<value xsi:type="xsd:string">v1__CustomerReference__c</value>

</values>

Usage

When specifying the value field in the CustomMetadataValue subtype, specify an appropriately typed object that’s based on your

field type definition. In declarative metadata definitions for CustomMetadataValue, use the xsi:type attribute of the value element.

For example, to specify a boolean value: <value xsi:type="xsd:boolean">true</value>. Valid xsi:type attributes

are:

Custom field definitionCustom metadata value

Checkboxxsi:type="xsd:boolean"

Datexsi:type="xsd:date"

Date/Timexsi:type="xsd:dateTime"

Picklistxsi:type="xsd:picklist"

Textxsi:type="xsd:string"

Phonexsi:type="xsd:string"

TextAreaxsi:type="xsd:string"

URLxsi:type="xsd:string"

Emailxsi:type="xsd:string"

Number/Percent, with scale equal to 0xsi:type="xsd:int"

Number/Percent, with scale not equal to 0xsi:type="xsd:double"

You can also omit the xsi:type attribute. For example, <value>true</value>.

Although this attribute must be specified for any CustomMetadataValue, you can use an element with the xsi:nil attribute set to

true to explicitly set the field’s value to null. For example, <value xsi:nil="true"/>.

Using null field values differs from leaving out the CustomMetadataValue for a particular field entirely. If you leave out the

CustomMetadataValue, the value of the field doesn’t change. The field’s value is null for newly deployed custom metadata records

and left at its previous value for updated custom metadata records.

When you retrieve CustomMetadataValue objects, the value field of the returned object holds a value of the correct type, specified

by xsi:type in the case of declarative metadata definitions.

CustomObject

Represents a custom object that stores data unique to your organization or an external object that maps to data stored outside Salesforce.

This type extends the Metadata metadata type and inherits its fullName field. You must specify all relevant fields when you create

233

CustomObjectMetadata Types

or update a custom object. You cannot update a single field on the object. For more information about custom objects, see Administer

Custom Objects in the Salesforce online help.

You can also use this metadata type to work with customizations of standard objects, such as accounts. For an example, see Standard

Objects on page 17.

All metadata components have a fullName field, which must be fully specified for any custom object.

For example, the following are fully specified names for a standard object and a custom object respectively:

Account

MyCustomObject__c

And the following is a fully specified name for an external object:

MyExternalObject__x

For sample Java code that creates a custom object, see Step 3: Walk Through the Java Sample Code on page 6.

Declarative Metadata File Suffix and Directory Location

Custom object names are automatically appended with __c. The file suffix is .object for the custom object or standard object file.

External object names are automatically appended with __x. The file suffix is .object for the external object file.

Custom, standard, and external objects are stored in the objects folder in the corresponding package directory.

Note: Retrieving a component of this metadata type in a project makes the component appear in any Profile and PermissionSet

components that are retrieved in the same package.

Version

Custom objects are available in API version 10.0 and later. External objects are available in API version 32.0 and later.

Fields

Unless otherwise noted, all fields are createable, filterable, and nillable.

DescriptionField TypeField Name

A list of action overrides on the object.

This field is available in API version 18.0 and later.

ActionOverride[]actionOverrides

Indicates whether records of this custom object type can be

added to Chatter groups.

This field is available in API version 34.0 and later.

booleanallowInChatterGroups

A list of business processes associated with the object.

This field is available in API version 17.0 and later.

BusinessProcess[]businessProcesses

The compact layout assigned to the object.

This field is available in API version 29.0 and later.

stringcompactLayoutAssignment

234

CustomObjectMetadata Types

DescriptionField TypeField Name

A list of compact layouts associated with the object.

This field is available in API version 29.0 and later.

CompactLayout[]compactLayouts

The s-control that contains the help content if the object has

customized help content. This field is available in API version

14.0 and later.

stringcustomHelp

The Visualforce page that contains the help content if the

object has customized help content. This field is available in

API version 16.0 and later.

stringcustomHelpPage

When this field is present, this component is not a custom

object, but a custom setting. This field returns the type of

custom setting. The following string values are valid:

CustomSettingsType

(enumeration of type string)

customSettingsType

•List—static data stored in cache and accessed as part

of your application and available organization-wide.

•Hierarchy—static data stored in cache and accessed

as part of your application and available based on a

hierarchy of user, profile or organization. This is the default

value.

This field is available in API version 17.0 and later.

When this field is present, this component is not a custom

object, but a custom setting. This field returns the visibility of

the custom setting. The following string values are valid:

CustomSettingsVisibility

(enumeration of type string)

customSettingsVisibility

•Public—if the custom setting is packaged, it is

accessible to all subscribing organizations.

•Protected—if the custom setting is in a managed

package, it is only accessible to the developer

organization. Subscribing organizations cannot access it.

This is the default value.

This field is available in API versions 17.0 through 33.0. In

versions 34.0 and later, use the visibility field instead

of this field.

Indicates the deployment status of the object.DeploymentStatus

(enumeration of type string)

deploymentStatus

Reserved for future use.booleandeprecated

A description of the object. Maximum of 1000 characters.stringdescription

Indicates whether the object is enabled for activities (true)

or not (false).

Not available for external objects.

booleanenableActivities

235

CustomObjectMetadata Types

DescriptionField TypeField Name

When enabled, the object is classified as an Enterprise

Application object for usage tracking.

When enabled, enableSharing and

enableStreamingApi must also be enabled.

booleanenableBulkApi

This field is available in API version 31.0 and later.

Indicates whether the object is enabled for divisions (true)

or not (false). For more information about the Division

object, see the SOAP API Developer's Guide.

booleanenableDivisions

Indicates whether the object is enabled for enhanced lookups

(true) or not (false). In API version 28.0 and later, this

booleanenableEnhancedLookup

field can also be used for the Account, Contact, and User

objects. Enhanced lookups provide an updated lookup dialog

interface that gives users the ability to filter, sort, and page

through search results as well as customize search result

columns. For more information about enhanced lookups, see

“Enable Enhanced Lookups” in the Salesforce online help.

Indicates whether the object is enabled for feed tracking

(true) or not (false). For more information, see “Customize

Chatter Feed Tracking” in the Salesforce online help.

This field is available in API version 18.0 and later.

booleanenableFeeds

Indicates whether the object is enabled for history tracking

(true) or not (false). Also available for standard objects

in API version 29.0 and later.

booleanenableHistory

Indicates whether the object is enabled for reports (true)

or not (false). Support for external objects is available in

API version 38.0 and later.

booleanenableReports

Indicates whether the object’s records can be found via SOSL

and Salesforce searches. Corresponds to Allow Search

in the user interface.

By default, search is disabled for new custom objects. This

field is available for custom objects in API version 35.0 and

later.

booleanenableSearch

By default, search is disabled for new external objects.

However, you can validate and sync an external data source

to automatically create external objects. Syncing always

enables search on the external object when search is enabled

on the external data source, and vice versa. This field is

available for external objects in API version 37.0 and later.

236

CustomObjectMetadata Types

DescriptionField TypeField Name

When enabled, the object is classified as an Enterprise

Application object for usage tracking.

When enabled, enableBulkApi and

enableStreamingApi must also be enabled.

booleanenableSharing

This field is available in API version 31.0 and later.

When enabled, the object is classified as an Enterprise

Application object for usage tracking.

When enabled, enableBulkApi and enableSharing

must also be enabled.

booleanenableStreamingApi

This field is available in API version 31.0 and later.

Required and available for external objects only. The name of

the external data source that stores the data for the external

stringexternalDataSource

object. The data source is represented by the

ExternalDataSource component.

This field is available in API version 32.0 and later.

Required and available for external objects only. The name of

the table in the external data source that contains the data

for the external object.

This field is available in API version 32.0 and later.

stringexternalName

Available for Salesforce Connect external objects only.

Corresponds to Display URL Reference Field

in the user interface.

The external object’s Display URL standard field values

are automatically generated from the external system. For

stringexternalRepository

example, with the OData 2.0 adapter for Salesforce Connect,

the value is based on the link href that’s defined on the

OData producer. You can override the default values with the

values of a custom field on the same external object. Select

the field name, and make sure that the custom field’s values

are valid URLs.

This field is available in API version 32.0 and later.

Indicates the external organization-wide defaults for the

object, which determines the access level for external users,

SharingModel(enumeration

of type string)

externalSharingModel

such as portal and community users. This field is supported

for these objects:

•Accounts and their associated contracts and assets

•Cases

•Contacts

237

CustomObjectMetadata Types

DescriptionField TypeField Name

•Opportunities

•Custom Objects

•Users

This field is available in API version 31.0 and later.

Represents one or more fields in the object.CustomField[]fields

Defines the field set that exists on this object.FieldSetfieldSets

Inherited from Metadata, this field is not defined in the WSDL

for this metadata type. It must be specified when creating,

stringfullName

updating, or deleting. See create() to see an example of

this field specified for a call.

This value cannot be null.

Indicates the gender of the noun that represents the object.

This is used for languages where words need different

treatment depending on their gender.

Gendergender

This field supports relationship groups, a feature available only

with Salesforce for Wealth Management. For more

booleanhousehold

information, see “Salesforce for Wealth Management

Overview” in the Salesforce online help.

Reserved for future use.HistoryRetentionPolicyhistoryRetentionPolicy

Label that represents the object throughout the Salesforce

user interface.

We recommend that you make object labels unique across

all standard, custom, and external objects in the org.

stringlabel

Represents one or more list views associated with the object.ListView[]listViews

Represents the metadata associated with a lookup filter. Use

this metadata type to create, update, or delete lookup filter

definitions.

This field is available in API version 17.0 and later.

NamedFilter[]namedFilter

This field has been removed as of API version 30.0 and is only

available in prior versions. The metadata associated with a

lookup filter is now represented by the lookupFilter

field in the CustomField component.

Required for custom objects. External objects may instead

specify the name field by setting isNameField to true

in the CustomField component.

The field that this object's name is stored in. Every custom

object must have a name, usually a string or autonumber.

CustomFieldnameField

238

CustomObjectMetadata Types

DescriptionField TypeField Name

Identifier for the custom object record. This name appears in

page layouts, related lists, lookup dialogs, search results, and

key lists on tab home pages. By default, this field is added to

the custom object page layout as a required field.

Plural version of the label value.stringpluralLabel

An array of one or more record types defined for this object.RecordType[]recordTypes

Indicates whether the record type is enabled for feed tracking

(true) or not (false). To set this field to true, the

booleanrecordTypeTrackFeedHistory

enableFeeds field on the associated CustomObject must

also be true. For more information, see “Customize Chatter

Feed Tracking” in the Salesforce online help.

This field is available in API version 19.0 and later.

Indicates whether history tracking is enabled for this record

type (true) or not (false). To set

booleanrecordTypeTrackHistory

recordTypeTrackHistory to true the

enableHistory field on the associated custom object

must also be true.

This field is available in API version 19.0 and later.

The Search Layouts related list information for the object.SearchLayoutssearchLayouts

Indicates the organization-wide defaults for the object.SharingModel(enumeration

of type string)

sharingModel

Note: Using API version 29.0 and earlier, this field is

read-only and you can't set this field through Metadata

API; you must use the Salesforce user interface. Using

API version 30.0 and later, you can set this field for

internal users using the API and the Salesforce user

interface.

The reasons why the object is being shared.SharingReason[]sharingReasons

A list of custom sharing recalculations associated with the

object.

SharingRecalculation[]sharingRecalculations

Indicates whether the noun starts with a vowel, consonant,

or is a special character. This is used for languages where

StartsWith (enumeration of

type string)

startsWith

words need different treatment depending on the first

character. Valid values are listed in StartsWith.

An array of one or more validation rules on the object.ValidationRule[]validationRules

When this field is present, this component is not a custom

object, but a custom setting or custom metadata type. This

SetupObjectVisibility

(enumeration of type string)

visibility

field returns the visibility of the custom setting or custom

metadata type. The following values are valid.

239

CustomObjectMetadata Types

DescriptionField TypeField Name

•Public—If the custom setting or custom metadata

type is packaged, it’s accessible to all subscribing

organizations.

•Protected—If the custom setting or custom metadata

type is in a managed package, it’s only accessible to the

developer organization; subscribing organizations can’t

access it.

The default value is Public.

This field is available in API version 34.0 and later. For custom

settings, this field replaces the

customSettingsVisibility field.

An array of one or more weblinks defined for the object.WebLink[]webLinks

Declarative Metadata Additional Components

CustomObject definitions may include additional components which are defined in the custom object for declarative metadata. The

following components are defined in the CustomObject:

•ActionOverride

•BusinessProcess

•CompactLayout

•CustomField

•FieldSet

•HistoryRetentionPolicy

•ListView

•RecordType

•SearchLayouts

•SharingReason

•SharingRecalculation

•ValidationRule

•WebLink

Declarative Metadata Sample Definition

<?xml version="1.0" encoding="UTF-8"?>

<deploymentStatus>Deployed</deploymentStatus>

<description>test object with one field for eclipse ide testing</description>

<fullName>Comments__c</fullName>

<description>add your comments about this object here</description>

<inlineHelpText>This field contains comments made about this object</inlineHelpText>

240

CustomObjectMetadata Types

<label>Comments</label>

<type>LongTextArea</type>

</fields>

<label>MyFirstObject</label>

<label>MyFirstObject Name</label>

</nameField>

<pluralLabel>MyFirstObjects</pluralLabel>

<sharingModel>ReadWrite</sharingModel>

</CustomObject>

The following is the metadata definition of an external object for Salesforce Connect.

<?xml version="1.0" encoding="UTF-8"?>

<actionName>CancelEdit</actionName>

<type>Default</type>

</actionOverrides>

<actionName>Delete</actionName>

<type>Default</type>

</actionOverrides>

<type>Default</type>

</actionOverrides>

<actionName>Follow</actionName>

<type>Default</type>

</actionOverrides>

<type>Default</type>

</actionOverrides>

<type>Default</type>

</actionOverrides>

<actionName>SaveEdit</actionName>

<type>Default</type>

</actionOverrides>

<type>Default</type>

</actionOverrides>

<type>Default</type>

</actionOverrides>

241

CustomObjectMetadata Types

<deploymentStatus>InDevelopment</deploymentStatus>

<description>Products</description>

<enableFeeds>false</enableFeeds>

<externalDataSource>OData</externalDataSource>

<externalIndexAvailable>false</externalIndexAvailable>

<externalName>Products</externalName>

<fullName>DiscontinuedDate__c</fullName>

<description>DiscontinuedDate</description>

<externalDeveloperName>DiscontinuedDate</externalDeveloperName>

<externalId>false</externalId>

<isFilteringDisabled>false</isFilteringDisabled>

<isNameField>false</isNameField>

<isSortingDisabled>false</isSortingDisabled>

<label>DiscontinuedDate</label>

<required>false</required>

<type>DateTime</type>

</fields>

<externalId>false</externalId>

<isFilteringDisabled>false</isFilteringDisabled>

<isNameField>false</isNameField>

<isSortingDisabled>false</isSortingDisabled>

<required>false</required>

<type>Number</type>

<unique>false</unique>

</fields>

<externalId>false</externalId>

<isFilteringDisabled>false</isFilteringDisabled>

<isNameField>false</isNameField>

<isSortingDisabled>false</isSortingDisabled>

<required>false</required>

<unique>false</unique>

</fields>

<fullName>Price__c</fullName>

<description>Price</description>

<externalDeveloperName>Price</externalDeveloperName>

<externalId>false</externalId>

<isFilteringDisabled>false</isFilteringDisabled>

<isNameField>false</isNameField>

242

CustomObjectMetadata Types

<isSortingDisabled>false</isSortingDisabled>

<label>Price</label>

<required>false</required>

<type>Number</type>

<unique>false</unique>

</fields>

<fullName>Products__c</fullName>

<externalDeveloperName>Products</externalDeveloperName>

<externalId>false</externalId>

<isFilteringDisabled>false</isFilteringDisabled>

<isNameField>false</isNameField>

<isSortingDisabled>false</isSortingDisabled>

<label>Products</label>

<referenceTo>Products__x</referenceTo>

<relationshipLabel>Products</relationshipLabel>

<relationshipName>Products</relationshipName>

<type>ExternalLookup</type>

</fields>

<fullName>Rating__c</fullName>

<description>Rating</description>

<externalDeveloperName>Rating</externalDeveloperName>

<externalId>false</externalId>

<isFilteringDisabled>false</isFilteringDisabled>

<isNameField>false</isNameField>

<isSortingDisabled>false</isSortingDisabled>

<label>Rating</label>

<required>false</required>

<type>Number</type>

<unique>false</unique>

</fields>

<fullName>ReleaseDate__c</fullName>

<description>ReleaseDate</description>

<externalDeveloperName>ReleaseDate</externalDeveloperName>

<externalId>false</externalId>

<isFilteringDisabled>false</isFilteringDisabled>

<isNameField>false</isNameField>

<isSortingDisabled>false</isSortingDisabled>

<label>ReleaseDate</label>

<required>false</required>

<type>DateTime</type>

</fields>

<label>Products</label>

<pluralLabel>Products</pluralLabel>

<customTabListAdditionalFields>ExternalId</customTabListAdditionalFields>

<lookupDialogsAdditionalFields>ExternalId</lookupDialogsAdditionalFields>

243

CustomObjectMetadata Types

<lookupPhoneDialogsAdditionalFields>ExternalId</lookupPhoneDialogsAdditionalFields>

<searchResultsAdditionalFields>ExternalId</searchResultsAdditionalFields>

<searchResultsAdditionalFields>DisplayUrl</searchResultsAdditionalFields>

</searchLayouts>

</CustomObject>

SEE ALSO:

CustomField

Metadata

Picklist (Including Dependent Picklist)

SearchLayouts

WebLink

CustomObjectTranslation

ListView

CompactLayout

ActionOverride

Represents an action override on a standard or custom object. Use it to create, update, edit, or delete action overrides. You can only

access ActionOverride by accessing its encompassing CustomObject.

Declarative Metadata File Suffix and Directory Location

Action overrides are defined as part of a standard or custom object.

Version

Action overrides are available in API version 18.0 and later. Beginning in Summer ’13, action overrides can be applied to both standard

or custom objects. Previously, action overrides only applied to custom objects.

Fields

Unless otherwise noted, all fields are createable, filterable, and nillable.

DescriptionField TypeField Name

Required. The possible values are the same as the actions you can override:stringactionName

•accept

•clone

•delete

•edit

•list

•new

244

ActionOverrideMetadata Types

DescriptionField TypeField Name

•tab

•view

Any comments you want associated with the override.stringcomment

Set this field if type is set to flexipage, scontrol, or

visualforce. It refers to the name of the Lightning Page, s-control,

stringcontent

or Visualforce page to use as the override. To reference installed

components, use the format of

Component_namespace__Component_name.

The size of the page being overridden. Only the Large value is

supported. The other values, Small and Medium, are reserved for

future use.

If the type field is set to flexipage, set this field to Large to

override the View action with a Lightning Page in Lightning Experience.

FormFactor (enumeration of

type string)

formFactor

The Large value represents the Lightning Experience desktop

environment, and is only valid for the flexipage type. For the

scontrol and visualforce types, this field defaults to null.

This field is available in API version 37.0 and later, and is part of the feature

for creating and editing record pages in Lightning Experience.

Set this field to true if you prefer that any new records created by this

action override aren’t forwarded to the record type selection page. This

booleanskipRecordTypeSelect

field is only valid if the actionName is a “create” type (like new), and

type is set to visualforce. This field is available in API version 21.0

and later.

Required. Represents the type of action override. Valid values are described

in ActionOverrideType.

ActionOverrideType

(enumeration of type string)

type

ActionOverrideType

ActionOverrideType is an enumeration of type string that defines which kind of action override to use. The valid values are:

•default—The override uses a custom override provided by an installed package. If there isn’t one available, the standard Salesforce

behavior is used.

•flexipage—The override uses behavior from a Lightning Page, and is only valid for the View action in Lightning Experience.

•scontrol—The override uses behavior from an s-control.

•standard—The override uses regular Salesforce behavior.

•visualforce—The override uses behavior from a Visualforce page.

245

ActionOverrideMetadata Types

Declarative Metadata Sample Definitions

You can define an action like this:

<type>visualforce</type>

<content>myEditVFPage</content>

<comment>This edit action is a lot safer.</comment>

</actionOverrides>

</CustomObject>

With the previous definition, calling retrieve() presents:

<type>default</type>

</actionOverrides>

</CustomObject>

If a subscriber installed a package with the previous metadata, you can override the behavior by editing the XML. For example, if you

want the regular Salesforce behavior, use:

<type>standard</type>

</actionOverrides>

</CustomObject>

To set a Lightning Page action override on the View standard button in Lightning Experience, use:

<content>myLightningPage</content>

<formFactor>Large</formFactor>

<type>flexipage</type>

</actionOverrides>

</CustomObject>

SEE ALSO:

CustomObject

BusinessProcess

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

Metadata metadata type and inherits its fullName field.

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.

246

BusinessProcessMetadata Types

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

DescriptionField TypeField

Description for the business process.stringdescription

The name used as a unique identifier for API access. The

fullName can contain only underscores and alphanumeric

stringfullName

characters. It must be unique, begin with a letter, not include

spaces, not end with an underscore, and not contain two

consecutive underscores. This field is inherited from the

Metadata component.

Indicates if the business process is active (true) or not

(false).

booleanisActive

The namespace of the developer organization where the

package was created.

stringnamespacePrefix

A list of picklist values associated with this business process.PicklistValue[]values

Declarative Metadata Sample Definition

A sample XML definition of a lead business process is shown below.

<?xml version="1.0" encoding="UTF-8"?>

....

<fullName>HardwareLeadProcess</fullName>

<description>Lead Process for hardware division</description>

<fullName>Closed - Converted</fullName>

<default>false</default>

</values>

<fullName>CustomLeadStep1</fullName>

<default>false</default>

</values>

<fullName>CustomLeadStep2</fullName>

<default>false</default>

</values>

247

BusinessProcessMetadata Types

<fullName>Open - Not Contacted</fullName>

<default>false</default>

</values>

<fullName>Working - Contacted</fullName>

</values>

</businessProcesses>

....

</CustomObject>

SEE ALSO:

CustomObject

CompactLayout

Represents the metadata associated with a compact layout. This type extends the Metadata metadata type and inherits its fullName

field.

Compact layouts display a record’s key fields at a glance in both Salesforce1 and Lightning Experience.

Compact layouts support all field types except:

•text area

•long text area

•rich text area

•multi-select picklist

For more information on compact layouts, see “Compact Layouts” in the Salesforce Help.

File Suffix and Directory Location

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

Version

CompactLayout components are available in API version 29.0 and later.

Fields

DescriptionField TypeField Name

The fields assigned to the compact layout. Their order represents the

prioritization given to them when defining the compact layout.

stringfields

Label that represents the object throughout the Salesforce user interface.stringlabel

248

CompactLayoutMetadata Types

Declarative Metadata Sample Definition

The following is an example of a CompactLayout component:

<actionName>Accept</actionName>

<type>Default</type>

</actionOverrides>

<actionName>Clone</actionName>

<type>Default</type>

</actionOverrides>

<actionName>Delete</actionName>

<type>Default</type>

</actionOverrides>

<type>Default</type>

</actionOverrides>

<type>Default</type>

</actionOverrides>

<type>Default</type>

</actionOverrides>

<type>Default</type>

</actionOverrides>

<type>Default</type>

</actionOverrides>

<fullName>testCompactLayout</fullName>

<compactLayoutItems>textfield__c</compactLayoutItems>

<label>testCompactLayoutLabel</label>

</compactLayouts>

<defaultCompactLayoutAssignment>SYSTEM</defaultCompactLayoutAssignment>

<deploymentStatus>Deployed</deploymentStatus>

<enableActivities>false</enableActivities>

<enableFeeds>false</enableFeeds>

<enableHistory>false</enableHistory>

<enableReports>false</enableReports>

<fullName>textfield__c</fullName>

<externalId>false</externalId>

<label>textfield</label>

<required>false</required>

249

CompactLayoutMetadata Types

<unique>false</unique>

</fields>

<label>customObj</label>

<label>customObj Name</label>

</nameField>

<pluralLabel>customObjs</pluralLabel>

<compactLayoutAssignment>testCompactLayout</compactLayoutAssignment>

</recordTypes>

</recordTypes>

<sharingModel>ReadWrite</sharingModel>

</CustomObject>

CustomField

Represents the metadata associated with a field. Use this metadata type to create, update, or delete custom field definitions on standard,

custom, and external objects or standard field definitions on standard objects. This type extends the Metadata metadata type and inherits

its fullName field.

Only standard fields that you can customize are supported, that is, standard fields to which you can add help text or enable history

tracking or Chatter feed tracking. Other standard fields aren't supported, including system fields (such as CreatedById or

LastModifiedDate) and autonumber fields.Some standard picklist fields aren’t supported. See Unsupported Metadata Types.

Specify the full name whenever you create or update a field. For example, a custom field on a custom object:

MyCustomObject__c.MyCustomField__c

An example of a custom field on a standard object:

Account.MyAcctCustomField__c

An example of a standard field on a standard object:

Account.Phone

An example of a custom field on an external object:

MyExternalObject__x.MyCustomField__c

Note: In the Metadata API, external objects are represented by the CustomObject metadata type.

The following custom field types aren’t available for external objects.

•Auto-number (available only with the cross-org adapter for Salesforce Connect)

•Currency

•Formula

250

CustomFieldMetadata Types

•Geolocation

•Master-detail relationship

•Picklist (available only with the cross-org adapter for Salesforce Connect)

•Picklist (multi-select)

•Roll-up summary

•Text (encrypted)

•Text Area (rich)

Declarative Metadata File Suffix and Directory Location

Custom fields are user-defined fields and are part of the custom object or standard object definition. See CustomObject for more

information. Standard fields are predefined on standard objects.

Note: Retrieving a component of this metadata type in a project makes the component appear in any Profile and PermissionSet

components that are retrieved in the same package.

Retrieving Fields on Custom or Standard Objects

When you retrieve a custom or standard object, you return everything associated with the object, except for standard fields that aren’t

customizable. You can also retrieve only specific fields for an object by explicitly naming the object and fields in package.xml. The

following definition in package.xml will create the files objects/MyCustomObject__c.object and

objects/Account.object, each containing the requested field definitions.

<types>

<members>MyCustomObject__c.MyCustomField__c</members>

<members>Account.MyCustomAccountField__c</members>

<members>Account.Phone</members>

<name>CustomField</name>

</types>

Version

Custom and standard fields are available in API version 10.0 and later.

Fields

Unless otherwise noted, all fields are createable, filterable, and nillable.

DescriptionField TypeField Name

Indicates whether the field is case-sensitive (true) or not

(false).

For indirect lookup relationship fields on external objects, this

attribute affects how this custom field’s values are matched against

the values of the referenceTargetField.

booleancaseSensitive

Reserved for future use.stringcustomDataType

251

CustomFieldMetadata Types

DescriptionField TypeField Name

If specified, represents the default value of the field.stringdefaultValue

Provides deletion options for lookup relationships. Valid values are:

SetNull

This is the default. If the lookup record is deleted, the lookup

field is cleared.

DeleteConstraint (enumeration

of type string)

deleteConstraint

Restrict

Prevents the record from being deleted if it’s in a lookup

relationship.

Cascade

Deletes the lookup record as well as associated lookup fields.

For more information on lookup relationships, see “Object

Relationships” in the Salesforce Help.

Reserved for future use.booleandeprecated

Description of the field.stringdescription

The display format.stringdisplayFormat

Indicates how the value of a Geolocation custom field appears in

the user interface. If true, the geolocation appears in decimal

booleandisplayLocationInDecimal

notation. If false, the geolocation appears as degrees, minutes,

and seconds.

booleanencrypted Note: This page is about Shield Platform Encryption, not

Classic Encryption. What's the difference?

Indicates whether this field is encrypted (true) or not (false).

This field is available in API version 34.0 and later.

Available only for external objects. Name of the table column on

the external data source that maps to this custom field in Salesforce.

stringexternalDeveloperName

Corresponds to External Column Name in the user

interface. This field is available in API version 32.0 and later.

Indicates whether the field is an external ID field (true) or not

(false).

booleanexternalId

Determines who can update the field after it’s released in a

managed package. Valid values:

stringfieldManageability

•Locked—The field can’t be updated.

•DeveloperControlled—The creator of the record can update

the field with a package upgrade.

•SubscriberControlled—Anyone with proper permissions can

update the field. The field can’t be updated with a package

upgrade.

252

CustomFieldMetadata Types

DescriptionField TypeField Name

Available only for fields on custom metadata types. If the field type

is MetadataRelationship, and the manageability of the

entity definition field is:

•Subscriber-controlled, then the Field Definition field must be

subscriber-controlled.

•Upgradeable, then the Field Definition field must be either

upgradeable or subscriber-controlled.

If specified, represents a formula on the field.stringformula

Indicates how to treat blanks in a formula. Valid values are

BlankAsBlank and BlankAsZero.

TreatBlanksAs (enumeration of

type string)

formulaTreatBlankAs

Inherited from Metadata, this field is not defined in the WSDL for

this metadata type. It must be specified when creating, updating,

stringfullName

or deleting. See create() to see an example of this field

specified for a call.

This value cannot be null.

(This field is available in API version 37.0 only and removed from

later versions.) If this custom field is a picklist that’s based on a

string.globalPicklist

global picklist, globalPicklist is the name of the global

picklist whose value set this picklist inherits. A custom picklist that’s

based on a global picklist is restricted. You can only add or remove

values by editing the global picklist.

Indicates if the field is indexed. If this field is unique or the

externalId is set true, the isIndexed value is set to true.

booleanindexed

This field has been deprecated as of version 14.0 and is only

provided for backward compatibility.

Represents the content of field-level help. For more information,

see “Define Field-Level Help” in the Salesforce Help.

stringinlineHelpText

Available only for external objects. Indicates whether the custom

field is available in filters. This field is available in API version 32.0

and later.

booleanisFilteringDisabled

Available only for external object fields of type text. For each

external object, you can specify one field as the name field. If you

booleanisNameField

set this to true, make sure that the external table column

identified by the externalDeveloperName attribute

contains name values. This field is available in API version 32.0 and

later.

Available only for external objects. Indicates whether the custom

field is sortable. This field is available in API version 32.0 and later.

booleanisSortingDisabled

253

CustomFieldMetadata Types

DescriptionField TypeField Name

Indicates whether the child records in a master-detail relationship

on a custom object can be reparented to different parent records.

The default value is false.

This field is available in API version 25.0 and later.

booleanreparentableMasterDetail

Label for the field. You cannot update the label for standard picklist

fields, such as the Industry field for accounts.

stringlabel

Length of the field.intlength

Represents the metadata associated with a lookup filter. Use this

metadata type to create, update, or delete lookup filter definitions.

This field is available in API version 30.0 and later.

LookupFilterlookupFilter

Note: LookupFilter is not supported on the article type

object.

EncryptedFieldMaskChar

(enumeration of type string)

maskChar Note: This page is about Classic Encryption, not Shield

Platform Encryption. What's the difference?

For encrypted fields, specifies the character to be used as a mask.

Valid values are enumerated in EncryptedFieldMaskChar.

For more information on encrypted fields, see “Classic Encryption

for Custom Fields” in the Salesforce Help.

EncryptedFieldMaskType

(enumeration of type string)

maskType Note: This page is about Classic Encryption, not Shield

Platform Encryption. What's the difference?

For encrypted text fields, specifies the format of the masked and

unmasked characters in the field. Valid values are enumerated in

EncryptedFieldMaskType For more information on encrypted fields,

see “Classic Encryption for Custom Fields” in the Salesforce Help.

In custom metadata relationships, represents the controlling field

that specifies the standard or custom object in an entity definition

stringmetadataRelationship

ControllingField

metadata relationship. Required when creating a field definition

metadata relationship on a custom metadata type. The object

specified in the controlling field determines the values available

in its dependent field definition. For example, specifying the

Account object filters the available fields in the field definition to

Account fields only. This field is available in API version 39.0 and

later.

(Deprecated. Use this field in API version 37.0 and earlier only. In

later versions, use valueSet instead.) If specified, the field is a

picklist, and this field enumerates the picklist values and labels.

Picklistpicklist

Indicates whether existing rows will be populated (true) or not

(false).

booleanpopulateExistingRows

254

CustomFieldMetadata Types

DescriptionField TypeField Name

The precision for number values. Precision is the number of digits

in a number. For example, the number 256.99 has a precision of

intprecision

Available only for indirect lookup relationship fields on external

objects. Specifies the custom field on the parent object to match

stringreferenceTargetField

against this indirect lookup relationship field, whose values come

from an external data source. The specified custom field on the

parent object must have both externalId and unique set

to true. This field is available in API version 32.0 and later.

If specified, indicates a reference this field has to another object.stringreferenceTo

Label for the relationship.stringrelationshipLabel

If specified, indicates the value for one-to-many relationships. For

example, in the object MyObject that had a relationship to

YourObject, the relationship name might be YourObjects.

stringrelationshipName

This field is valid for all master-detail relationships, but the value is

only non-zero for junction objects. A junction object has two

intrelationshipOrder

master-detail relationships, and is analogous to an association table

in a many-to-many relationship. Junction objects must define one

parent object as primary (0), the other as secondary (1). The

definition of primary or secondary affects delete behavior and

inheritance of look and feel, and record ownership for junction

objects. For more information, see the Salesforce Help.

0 or 1 are the only valid values, and 0 is always the value for objects

that are not junction objects.

Indicates whether the field requires a value on creation (true) or

not (false).

booleanrequired

The scale for the field. Scale is the number of digits to the right of

the decimal point in a number. For example, the number 256.99

has a scale of 2.

intscale

If specified, indicates the starting number for the field. When you

create records, Starting Number’s value increments to store

intstartingNumber

the number that will be assigned to the next auto-number field

created.

Note:

•You can’t retrieve the starting number of an

auto-number field through Metadata API. To specify a

Starting Number while deploying, add a

startingNumber tag for your field to your

package.xml file. For example:

255

CustomFieldMetadata Types

DescriptionField TypeField Name

•If you deploy without specifying a Starting

Number value in your package.xml file, the

default starting number for standard fields is 0. The

default starting number for custom fields is 1.

Set to true to remove markup, or false to preserve markup.

Used when converting a rich text area to a long text area.

booleanstripMarkup

Represents the field on the detail row that is being summarized.

This field cannot be null unless the summaryOperation value

is count.

stringsummarizedField

Represents the set of filter conditions for this field if it is a summary

field. This field will be summed on the child if the filter conditions

are met.

FilterItem[]summaryFilterItems

Represents the master-detail field on the child that defines the

relationship between the parent and the child.

stringsummaryForeignKey

Represents the sum operation to be performed. Valid values are

enumerated in SummaryOperations.

SummaryOperations

(enumeration of type string)

summaryOperation

Indicates whether the field is enabled for feed tracking (true) or

not (false). To set this field to true, the enableFeeds field

booleantrackFeedHistory

on the associated CustomObject must also be true. For more

information, see “Customize Chatter Feed Tracking” in the

Salesforce Help.

This field is available in API version 18.0 and later.

Indicates whether history tracking is enabled for the field (true)

or not (false). Also available for standard object fields (picklist

and lookup fields only) in API version 30.0 and later.

To set trackHistory to true, the enableHistory field

on the associated standard or custom object must also be true.

booleantrackHistory

For more information, see “Field History Tracking” in the Salesforce

Help.

Field history tracking isn’t available for external objects.

Indicates whether historical trending data is captured for the field

(true) or not (false). An object is enabled for historical trending

booleantrackTrending

if this attribute is true for at least one field. Available in API

version 29.0 and later.

For more information, see “Report on Historical Changes” in the

Salesforce Help.

256

CustomFieldMetadata Types

DescriptionField TypeField Name

This is only relevant for a checkbox field. If set, true values are built

into the index. This field has been deprecated as of API version 14.0

and is only provided for backward compatibility.

booleantrueValueIndexed

Indicates the field type for the field. Valid values are enumerated

in FieldType.

For standard fields on standard objects, the type field is optional.

This field is included for some standard field types, such as Picklist

FieldTypetype

or Lookup, but not for others. The type field is included for

custom fields.

Indicates whether the field is unique (true) or not (false).booleanunique

Represents the set of values that make up a picklist on a custom

field. Each value is defined as a CustomValue on page 311. If this

ValueSetvalueSet

custom field is a picklist that uses a global value set, valueSet

is the name of the global value set whose values this picklist

inherits. A custom picklist that uses a global value set is restricted.

You can only add or remove values by editing the global value set.

Note: A ValueSet component has either a

valueSetDefinition or a valueName specified,

but never both.

This field is available in API version 38.0 and later.

Indicates the number of lines displayed for the field.intvisibleLines

Sets the minimum sharing access level required on the master

record to create, edit, or delete child records. This field applies only

to master-detail or junction object custom field types.

booleanwriteRequiresMasterRead

•true—Allows users with “Read” access to the master record

permission to create, edit, or delete child records. This setting

makes sharing less restrictive.

•false—Allows users with “Read/Write” access to the master

record permission to create, edit, or delete child records. This

setting is more restrictive than true, and is the default value.

For junction objects, the most restrictive access from the two

parents is enforced. For example, if you set to true on both

master-detail fields, but users have “Read” access to one master

record and “Read/Write” access to the other master record, users

won't be able to create, edit, or delete child records.

Fields use additional data types. For more information, see Metadata Field Types on page 285.

257

CustomFieldMetadata Types

EncryptedFieldMaskChar

This field type is used in maskChar. It is a string with two valid values: asterisk or X. For more information on encrypted fields,

see Classic Encryption for Custom Fields in the Salesforce online help.

EncryptedFieldMaskType

This field type is used in maskType. Valid values are:

all

All characters in the field are hidden. This option is equivalent to the Mask All Characters option in Salesforce.

creditCard

The first 12 characters are hidden and the last four display. This option is equivalent to the Credit Card Number option in

Salesforce.

ssn

The first five characters are hidden and the last four display. This option is equivalent to the Social Security Number

option in Salesforce.

lastFour

All characters are hidden but the last four display. This option is equivalent to the Last Four Characters Clear option

in Salesforce.

sin

All characters are hidden but the last four display. This option is equivalent to the Social Insurance Number option in

Salesforce.

nino

All characters are hidden. Salesforce automatically inserts spaces after each pair of characters if the field contains nine characters.

This option is equivalent to the National Insurance Number option in Salesforce.

For more information on encrypted fields, see Classic Encryption for Custom Fields in the Salesforce online help.

LookupFilter

Represents the metadata associated with a lookup filter. Replaces the NamedFilter component, which was removed as of API version

30.0. LookupFilter is available in API version 30.0 and later.

DescriptionField TypeField

Required. Indicates whether or not the lookup filter is active.booleanactive

Specifies advanced filter conditions. For more information on

advanced filter conditions, see “Getting the Most Out of Filter Logic”

in the Salesforce Help.

stringbooleanFilter

A description of what this filter does.stringdescription

The error message that appears if the lookup filter fails.stringerrorMessage

Required. The set of filter conditions. You can have up to 10 FilterItems

per lookup filter.

FilterItem[]filterItems

258

CustomFieldMetadata Types

DescriptionField TypeField

The information message displayed on the page. Use to describe

things the user might not understand, such as why certain items are

excluded in the lookup filter.

stringinfoMessage

Required. Indicates whether or not the lookup filter is optional.booleanisOptional

Lookup filters use additional data types. For more information, see Metadata Field Types.

FilterItem

Represents one entry in a set of filter criteria.

DescriptionField TypeField

Represents the field specified in the filter.stringfield

Represents the filter operation for this filter item. Valid values are

enumerated in FilterOperation.

FilterOperation

(enumeration of

type string)

operation

Represents the value of the filter item being operated upon, for

example, if the filter is my_number_field__c > 1, the value

of value is 1.

stringvalue

Specifies if the final column in the filter contains a field or a field value.

Approval processes don’t support valueField entries in filter

criteria.

stringvalueField

FilterOperation

This is an enumeration of type string that lists different filter operations. Valid values are:

•equals

•notEqual

•lessThan

•greaterThan

•lessOrEqual

•greaterOrEqual

•contains

•notContain

•startsWith

•includes

•excludes

•within (DISTANCE criteria only)

259

CustomFieldMetadata Types

SummaryOperations

Represents the type of a summaryOperation. Valid values are:

•Count

•Min

•Max

•Sum

Declarative Metadata Sample Definition

The following example shows a field definition for a custom field that is named Comments__c.

<?xml version="1.0" encoding="UTF-8"?>

....

<fullName>Comments__c</fullName>

<description>Add your comments about this object here</description>

<inlineHelpText>This field contains help text for this object</inlineHelpText>

<label>Comments</label>

<type>LongTextArea</type>

</fields>

....

</CustomObject>

The following is the definition for two fields on the Account standard object—a custom field (MyCustomAccountField__c), and

a standard field (Phone) that has history tracking enabled.

<?xml version="1.0" encoding="UTF-8"?>

<fullName>MyCustomAccountField__c</fullName>

<description>A custom field on the Account standard object.</description>

<externalId>false</externalId>

<label>MyCustomAccountField</label>

<required>false</required>

<trackFeedHistory>false</trackFeedHistory>

<trackHistory>false</trackHistory>

<unique>false</unique>

</fields>

<fullName>Phone</fullName>

<trackFeedHistory>false</trackFeedHistory>

260

CustomFieldMetadata Types

</fields>

</CustomObject>

SEE ALSO:

CustomObject

Picklist (Including Dependent Picklist)

Metadata

NamedFilter

FieldSet

Represents a field set. A field set is a grouping of fields. For example, you could have a field set that contains fields describing a user's

first name, middle name, last name, and business title. Field sets can be referenced on Visualforce pages dynamically. If the page is added

to a managed package, administrators can add, remove, or reorder fields in a field set to modify the fields presented on the Visualforce

page without modifying any code.

Version

FieldSet components are available in API version 21.0 and later.

Fields

DescriptionField TypeField

An array containing all the possible fields in the field set.FieldSetItem[]availableFields

Required. A description provided by the developer that describes

the field set. This is required.

stringdescription

An array containing all the fields that are presented on the

Visualforce page. The order in which a field is listed determines

the order of appearance on the page.

FieldSetItem[]displayedFields

Required. The label used to reference the field set.stringlabel

FieldSetItem

FieldSetItem represents an individual field in a field set.

DescriptionField TypeField

Required. The name of a field in a standard or custom object.stringfield

Read-only. Denotes whether the field was added to the field set

via a managed or unmanaged package.

booleanisFieldManaged

Read-only. Indicates whether the field is universally required

(true) or not (false).

booleanisRequired

261

FieldSetMetadata Types

Declarative Metadata Sample Definition

A sample XML definition of a FieldSet component is shown below.

<?xml version="1.0" encoding="UTF-8"?>

<fullName>FieldSetNames</fullName>

<field>MiddleName__c</field>

</availableFields>

<field>Title__c</field>

</availableFields>

<description>FieldSet containing how to properly address someone</description>

<field>FirstName__c</field>

</displayedFields>

<field>LastName__c</field>

</displayedFields>

<label>FieldSet Names</label>

</fieldSets>

</CustomObject>

HistoryRetentionPolicy

Represents the policy for retaining field history data. By setting a policy, you can specify the number of months you want to maintain

field history in Salesforce, and the number of years that you want to retain field history in the archive.

This component is only available to users with the “RetainFieldHistory” permission.

Declarative Metadata File Suffix and Directory Location

Field history retention policies are defined as part of a standard or custom object. You can set field history retention policies for objects

individually. See CustomObject for more information.

Version

Available in API version 31.0 and later.

Fields

DescriptionField TypeField Name

Required. The number of months that you want to keep field history data

in Salesforce before archiving. You can set a minimum of 1 month and a

intarchiveAfterMonths

maximum of 18 months. If you don’t set a number, the default is 18

months. (That is, Salesforce maintains data for 18 months before

archiving.)

262

HistoryRetentionPolicyMetadata Types

DescriptionField TypeField Name

Required. The number of years that you want to retain data in the archive.

You can set a minimum of zero years, and a maximum of 10 years. If no

number is set, the default is 10 years.

intarchiveRetentionYears

A text description for the history retention.stringdescription

The number of days of extra time after the archiveAfterMonths

period before the data is archived. The gracePeriodDays interval

intgracePeriodDays

applies only to the first time that the data is archived; because all the data

is copied the first time, the operation may take longer than subsequent

times when only the data that changed since the last archival operation

is copied. The gracePeriodDays provides extra time for the

administrator to prepare the organization before the initial archive

operation. You can set a minimum of zero days and a maximum of 10

days. If no number is set, the default is 1 day.

Declarative Metadata Sample Definition

This sample shows the definition of a history retention policy for a custom object:

<?xml version="1.0" encoding="UTF-8"?>

<description>My field history retention</description>

</historyRetentionPolicy>

<fullName>AccountSource</fullName>

...

</CustomObject>

ListView

ListView allows you to see a filtered list of records, such as contacts, accounts, or custom objects. This type extends the Metadata metadata

type and inherits its fullName field. See “Create a Custom List View in Salesforce Classic” in the Salesforce online help.

Note: List views with the Visible only to me Restrict Visibility option are not accessible in Metadata API. Each of

these list views is associated with a particular user.

Declarative Metadata File Suffix and Directory Location

List views are stored within a CustomObject component. The component can represent a custom object or a standard object, such as

an account.

Version

ListView components for custom objects are available in API version 14.0 and later. ListView components for standard objects, such as

accounts, are available in API version 17.0 and later.

263

ListViewMetadata Types

Fields

DescriptionField TypeField

This field represents an Advanced Option for a filter. Advanced

Options in filters allow you to build up filtering conditions that

stringbooleanFilter

use a mixture of AND and OR boolean operators across multiple

filter line items. For example, (1 AND 2) OR 3 finds records

that match both the first two filter line items or the third. See

“Getting the Most Out of Filter Logic” in the Salesforce online

help.

The list of fields in the list view. The field name relative to the

object name, for example MyCustomField__c, is specified

for each custom field.

string[]columns

Note: Field names in the ListView columns don’t always

match their API name counterparts. In particular, if person

accounts is enabled in your organization, standard fields

merged from a contact into an account start with the

PC_ prefix, while the corresponding API name starts

with the Person prefix. For example, the ListView

column name is PC_Email for a corresponding API

field name of PersonEmail.

If your organization uses divisions to segment data and you have

the “Affected by Divisions” permission, records in the list view

stringdivision

must match this division. This field is only available if you are

searching all records.

This field is available in API version 17.0 and later.

Required. This field indicates whether you are filtering by owner

or viewing all records.

FilterScope (enumeration of

type string)

filterScope

The list of filter line items.ListViewFilter[]filters

Required. Inherited from Metadata, this field is not defined in

the WSDL for this metadata type. It must be specified when

stringfullName

creating, updating, or deleting. See create() to see an

example of this field specified for a call.

Required. The list view name.stringlabel

The language used for filtering if your organization uses the

Translation Workbench and you are using the startsWith

Languagelanguage

or contains operator. The values entered as search terms

must be in the same language as the filter language. See “Enter

Filter Criteria” in the Salesforce online help.

For a list of valid language values, see Language.

This field is available in API version 17.0 and later.

264

ListViewMetadata Types

DescriptionField TypeField

The name of a queue. Objects are sometimes assigned to a

queue so that the users who have access to the queue can

stringqueue

monitor and manage them. When you create a queue, a

corresponding list view is automatically created. See “Create

Queues” in the Salesforce online help.

Sharing access for the list view.

This field is available in API version 17.0 and later.

SharedTosharedTo

ListViewFilter

ListViewFilter represents a filter line item.

DescriptionField TypeField

Required. Represents the field specified in the filter.stringfilter

Required. The operation used by the filter, such as equals.

The valid values are listed in FilterOperation.

FilterOperation (enumeration of

type string)

operation

Represents the value of the filter item being operated upon, for

example, if the filter is my_number_field__c > 1, the

value of value is 1.

stringvalue

FilterScope

This is an enumeration of type string that represents the filtering criteria for the records. The valid values are listed in the table below:

DescriptionEnumeration Value

All records, for example All Opportunities.Everything

Records owned by the user running the list view, for example My Opportunities.Mine

Records assigned to a queue.Queue

Records delegated to another user for action: for example, a delegated task. This option is

available in API version 17.0 and later.

Delegated

Records in the territory of the user seeing the list view. This option is available if territory

management is enabled for your organization. This option is available in API version 17.0 and

later.

MyTerritory

Records in the territory of the team of the user seeing the list view. This option is available if

territory management is enabled for your organization. This option is available in API version

17.0 and later.

MyTeamTerritory

Records assigned to a team. This option is available in API version 17.0 and later.Team

265

ListViewMetadata Types

Declarative Metadata Sample Definition

A sample XML definition of a list view in a custom object is shown below.

<?xml version="1.0" encoding="UTF-8"?>

...

<fullName>All_Mileages</fullName>

<label>All Mileages</label>

</listViews>

<fullName>My_Mileages</fullName>

<columns>CREATED_DATE</columns>

<operation>equals</operation>

<value>Eric Bristow</value>

</filters>

<operation>equals</operation>

<value>Paris</value>

</filters>

<label>My Mileages</label>

</listViews>

...

</CustomObject>

SEE ALSO:

CustomObject

Sample package.xml Manifest Files

NamedFilter

Note: This component has been removed as of API version 30.0 and is only available in previous API versions. The metadata

associated with a lookup filter is now represented by the lookupFilter field in the CustomField component.

Represents the metadata associated with a lookup filter. Use this metadata type to create, update, or delete lookup filter definitions. This

type extends the Metadata metadata type and inherits its fullName field. You can also use this metadata type to work with

customizations of lookup filters on standard fields.

Note: The namedFilter appears as a child of the target object of the associated lookup field.

Declarative Metadata File Suffix and Directory Location

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

266

NamedFilterMetadata Types

Note: Retrieving a component of this metadata type in a project makes the component appear in any Profile and PermissionSet

components that are retrieved in the same package.

Version

Lookup filters are available in API version 17.0 and later.

Fields

Unless otherwise noted, all fields are createable, filterable, and nillable.

DescriptionField TypeField Name

Required. Indicates whether or not the lookup filter is active.booleanactive

Specifies advanced filter conditions. For more information on

advanced filter conditions, see “Getting the Most Out of Filter

Logic” in the Salesforce online help.

stringbooleanFilter

A description of what this filter does.stringdescription

The error message that appears if the lookup filter fails.stringerrorMessage

Required. The fullName of the custom or standard field

associated with the lookup filter. You can associate one

relationship field with each lookup filter, and vice-versa.

stringfield

Note: You cannot update a field associated with a

lookup filter.

Required. The set of filter conditions.FilterItems[]filterItems

The information message displayed on the page. Use to

describe things the user might not understand, such as why

certain items are excluded in the lookup filter.

stringinfoMessage

Inherited from Metadata, this field is not defined in the WSDL

for this metadata type. It must be specified when creating,

stringfullName

updating, or deleting. See create() to see an example of

this field specified for a call.

This value cannot be null.

Required. Indicates whether or not the lookup filter is optional.booleanisOptional

Required. The name of the lookup filter. If you create this field

in the user interface, a name is automatically assigned. If you

stringname

create this field through Metadata API, you must include the

name field.

The object that contains the lookup field that uses this lookup

filter. Set this field if the lookup filter references fields on the

source object.

stringsourceObject

267

NamedFilterMetadata Types

Lookup filters use additional data types. For more information, see Metadata Field Types.

FilterItems

FilterItems contains the following properties:

DescriptionField TypeField

Represents the field specified in the filter.stringfield

Represents the filter operation for this filter item. Valid values are

enumerated in FilterOperation.

FilterOperation

(enumeration of

type string)

operation

Represents the value of the filter item being operated upon, for

example, if the filter is my_number_field__c > 1, the value

of value is 1.

stringvalue

FilterOperation

This is an enumeration of type string that lists different filter operations. Valid values are:

•equals

•notEqual

•lessThan

•greaterThan

•lessOrEqual

•greaterOrEqual

•contains

•notContain

•startsWith

•includes

•excludes

Declarative Metadata Sample Definition

<?xml version="1.0" encoding="UTF-8"?>

....

<field>Account.lk__c</field>

<field>Account.Phone</field>

<operation>notEqual</operation>

</filterItems>

268

NamedFilterMetadata Types

<field>Account.Fax</field>

<operation>notEqual</operation>

</filterItems>

<sourceObject>Account</sourceObject>

</namedfilters>

....

</CustomObject>

SEE ALSO:

CustomObject

Picklist (Including Dependent Picklist)

Metadata

CustomField

Picklist (Including Dependent Picklist)

Deprecated. Represents a picklist (or dependent picklist) definition for a custom field in a custom object or a custom or standard field

in a standard object, such as an account.

Version

Use this type in API version 37.0 and earlier only. In later versions, Picklist is replaced by ValueSet. Picklists for custom fields in custom

objects are available in API version 12.0 and later. Picklists for custom or standard fields in standard objects, such as accounts, are available

in API version 16.0 and later.

Declarative Metadata File Suffix and Directory Location

Picklist definitions are included in the custom object and field with which they are associated.

Fields

Picklist contains the following fields:

DescriptionField TypeField Name

The fullName of the controlling field if this is a dependent picklist. A

dependent picklist works in conjunction with a controlling picklist or

stringcontrollingField

checkbox to filter the available options. The value chosen in the

controlling field affects the values available in the dependent field. This

field is available in API version 14.0 and later.

Required. Represents a set of values for a picklist.

PicklistValue[]picklistValues

269

Picklist (Including Dependent Picklist)Metadata Types

DescriptionField TypeField Name

Indicates whether the picklist’s value list is restricted. With a restricted

picklist, only an admin can add or change values; users can’t load or

remove values through the API. By default this value is false.

This field is available in API version 37.0 and later.

booleanrestrictedPicklist

Indicates whether values should be sorted (true), or not (false). By

default this value is false.

booleansorted

Java Sample

The following sample uses a picklist. For a complete sample of using a picklist with record types and profiles, see Profile on page 496.

public void setPicklistValues() {

// Create a picklist

Picklist expenseStatus = new Picklist();

PicklistValue unsubmitted = new PicklistValue();

unsubmitted.setFullName("Unsubmitted");

PicklistValue submitted = new PicklistValue();

submitted.setFullName("Submitted");

PicklistValue approved = new PicklistValue();

approved.setFullName("Approved");

PicklistValue rejected = new PicklistValue();

rejected.setFullName("Rejected");

expenseStatus.setPicklistValues(new PicklistValue[]

{unsubmitted, submitted, approved, rejected});

CustomField expenseStatusField = new CustomField();

expenseStatusField.setFullName(

"ExpenseReport__c.ExpenseStatus__c");

expenseStatusField.setLabel("Expense Report Status");

expenseStatusField.setType(FieldType.Picklist);

expenseStatusField.setPicklist(expenseStatus);

try {

AsyncResult[] ars =

metadataConnection.create(new Metadata[] {expenseStatusField});

}catch (ConnectionException ce) {

ce.printStackTrace();

}

Declarative Metadata Sample Definition

The following sample shows usage for picklists, including dependent picklists, in a custom object. The isAmerican__c checkbox

controls the list of manufacturers shown in the manufacturer__c picklist. The manufacturer__c checkbox in turn controls

the list of models shown in the model__c picklist.

<?xml version="1.0" encoding="UTF-8"?>

<deploymentStatus>Deployed</deploymentStatus>

270

Picklist (Including Dependent Picklist)Metadata Types

<fullName>isAmerican__c</fullName>

<defaultValue>false</defaultValue>

<label>American Only</label>

<type>Checkbox</type>

</fields>

<fullName>manufacturer__c</fullName>

<label>Manufacturer</label>

<controllingField>isAmerican__c</controllingField>

<fullName>Chrysler</fullName>

<controllingFieldValues>checked</controllingFieldValues>

<default>false</default>

</picklistValues>

<controllingFieldValues>checked</controllingFieldValues>

<default>false</default>

</picklistValues>

<fullName>Honda</fullName>

<controllingFieldValues>unchecked</controllingFieldValues>

<default>false</default>

</picklistValues>

<fullName>Toyota</fullName>

<controllingFieldValues>unchecked</controllingFieldValues>

<default>false</default>

</picklistValues>

<sorted>false</sorted>

</picklist>

<type>Picklist</type>

</fields>

<fullName>model__c</fullName>

<label>Model</label>

<controllingField>manufacturer__c</controllingField>

<fullName>Mustang</fullName>

<default>false</default>

</picklistValues>

<fullName>Taurus</fullName>

<default>false</default>

</picklistValues>

<fullName>PT Cruiser</fullName>

<controllingFieldValues>Chrysler</controllingFieldValues>

271

Picklist (Including Dependent Picklist)Metadata Types

<default>false</default>

</picklistValues>

<fullName>Pacifica</fullName>

<controllingFieldValues>Chrysler</controllingFieldValues>

<default>false</default>

</picklistValues>

<fullName>Accord</fullName>

<controllingFieldValues>Honda</controllingFieldValues>

<default>false</default>

</picklistValues>

<fullName>Civic</fullName>

<controllingFieldValues>Honda</controllingFieldValues>

<default>false</default>

</picklistValues>

<fullName>Prius</fullName>

<controllingFieldValues>Toyota</controllingFieldValues>

<default>false</default>

</picklistValues>

<fullName>Camry</fullName>

<controllingFieldValues>Toyota</controllingFieldValues>

<default>false</default>

</picklistValues>

<sorted>false</sorted>

</picklist>

<type>Picklist</type>

</fields>

....

</CustomObject>

The following sample shows usage for the standard Stage field in opportunities.

<?xml version="1.0" encoding="UTF-8"?>

<fullName>StageName</fullName>

<fullName>Prospecting</fullName>

<default>false</default>

<forecastCategory>Pipeline</forecastCategory>

</picklistValues>

<fullName>Qualification</fullName>

<default>false</default>

<forecastCategory>Pipeline</forecastCategory>

</picklistValues>

<fullName>Needs Analysis</fullName>

272

Picklist (Including Dependent Picklist)Metadata Types

<default>false</default>

<forecastCategory>Pipeline</forecastCategory>

</picklistValues>

...

</picklist>

</fields>

RecordType

Represents the metadata associated with a record type. Record types let you offer different business processes, picklist values, and page

layouts to different users. For more information, see “Tailor Business Processes to Different Users” in the Salesforce online help. Use this

metadata type to create, update, or delete record type definitions for a custom object. This type extends the Metadata metadata type

and inherits its fullName field.

Note: Retrieving a component of this metadata type in a project makes the component appear in any Profile and PermissionSet

components that are retrieved in the same package.

Version

Record types are available in API version 12.0 and later.

Fields

DescriptionField TypeField

Required. Indicates whether or not the record type is active.booleanactive

The fullName of the business process associated with

the record type. This field is required in record types for lead,

stringbusinessProcess

opportunity, solution, and case, and not allowed otherwise.

See BusinessProcess on page 246.

This field is available in API version 17.0 and later.

Represents the compact layout that is assigned to the record

type.

This field is available in API version 29.0 and later.

stringcompactLayoutAssignment

Record type description. Maximum of 255 characters.stringdescription

Record type name. The fullName can contain only

underscores and alphanumeric characters. It must be unique,

stringfullName

begin with a letter, not include spaces, not end with an

underscore, and not contain two consecutive underscores.

If this field contained characters before version 14.0 that are

no longer allowed, the characters were stripped out of this

field, and the previous value of the field was saved in the

label field.

273

RecordTypeMetadata Types

DescriptionField TypeField

Inherited from the Metadata component, this field is not

defined in the WSDL for this component. It must be specified

when creating, updating, or deleting. See create() to

see an example of this field specified for a call.

This value cannot be null.

Required. Descriptive label for the record type. The list of

characters allowed in the fullName field has been reduced

stringlabel

for versions 14.0 and later. This field contains the value

contained in the fullName field before version 14.0.

Represents a set of values for a picklist.RecordTypePicklistValue[]picklistValues

RecordTypePicklistValue

RecordTypePicklistValue represents the combination of picklists and valid values that define a record type:

DescriptionField TypeField Name

Required. The name of the picklist.stringpicklist

One or more of the picklist values in the picklist. Each value defined is

available in the record type that contains this component.

PicklistValuevalues

Java Sample

The following sample uses two record types. For the complete sample that includes profiles and picklists, see Profile on page 496.

public void recordTypeSample() {

try {

// Employees and managers have different access

// to the state of the expense sheet

RecordType edit = new RecordType();

edit.setFullName("ExpenseReport__c.Edit");

edit.setLabel("ExpenseReport__c.Label");

PicklistValue unsubmitted = new PicklistValue();

unsubmitted.setFullName("Unsubmitted");

PicklistValue submitted = new PicklistValue();

submitted.setFullName("Submitted");

RecordTypePicklistValue editStatuses =

new RecordTypePicklistValue();

editStatuses.setPicklist("ExpenseStatus__c");

editStatuses.setValues(

new PicklistValue[] {unsubmitted, submitted});

edit.setPicklistValues(

new RecordTypePicklistValue[] {editStatuses});

AsyncResult[] arsEdit =

metadataConnection.create(new Metadata[] {edit});

274

RecordTypeMetadata Types

RecordType approve = new RecordType();

approve.setFullName("ExpenseReport__c.Approve");

PicklistValue approved = new PicklistValue();

approved.setFullName("Approved");

PicklistValue rejected = new PicklistValue();

rejected.setFullName("Rejected");

RecordTypePicklistValue approveStatuses =

new RecordTypePicklistValue();

approveStatuses.setPicklist("ExpenseStatus__c");

approveStatuses.setValues(

new PicklistValue[] {approved, rejected});

approve.setPicklistValues(

new RecordTypePicklistValue[] {approveStatuses});

AsyncResult[] arsApprove =

metadataConnection.create(new Metadata[] {approve});

}catch (ConnectionException ce) {

ce.printStackTrace();

}

Declarative Metadata Sample Definition

The definition of a record type in a custom object is shown below:

...

<fullName>My First Recordtype</fullName>

</recordTypes>

...

</CustomObject>

SearchLayouts

Represents the metadata associated with the Search Layouts for an object. You can customize which fields to display for users in search

results, search filter fields, lookup dialogs, and recent record lists on tab home pages.

For more information, see ”Customize Search Layouts” and ”Customize Search Layouts for Custom Objects” in the Salesforce online help.

Version

Search layouts for custom objects are available in API version 14.0 and later. The ability to modify search layouts for standard objects

(except events and tasks) is available in API version 27.0 and later.

Fields

DescriptionField TypeField

The list of fields displayed in the Recent Object Name

list view on a tab associated with the object. The name field

string[]customTabListAdditionalFields

275

SearchLayoutsMetadata Types

DescriptionField TypeField

is mandatory and is always displayed as the first column

header, so it is not included in this list; all additional fields

are included. The field name relative to the object name, for

example MyCustomField__c, is specified for each

custom field.

The list of standard buttons excluded from the search layout.string[]excludedStandardButtons

The list of buttons available in list views for an object.

This field is equivalent to the Buttons Displayed value in the

Object Name List View in the Search Layouts

string[]listViewButtons

related list on the object detail page in the Salesforce user

interface. For more information, see “Standard and Enhanced

Lookups in Salesforce Classic” in the Salesforce online help.

The list of fields displayed in a lookup dialog for the object.

The name field is mandatory and is always displayed as the

string[]lookupDialogsAdditionalFields

first column header, so it is not included in this list; all

additional fields are included. The field name relative to the

object name, for example MyCustomField__c, is

specified for each custom field.

Salesforce objects often include one or more lookup fields

that allow users to associate two records together in a

relationship. For example, a contact record includes an

Account lookup field that represents the relationship

between the contact and the organization with which the

contact is associated. A lookup search dialog helps you search

for the record associated with the one being edited. Lookup

filter fields allow you to filter your lookup search by a

customized list of fields in the object.

This field is equivalent to the Lookup Dialogs in the

Search Layouts related list on the object detail page in the

application user interface. For more information, see

“Standard and Enhanced Lookups in Salesforce Classic” in

the Salesforce online help.

The list of fields that can be used to filter enhanced lookups

for an object. Enhanced lookups are optionally enabled by

string[]lookupFilterFields

your administrator. The field name relative to the object

name, for example MyCustomField__c, is specified for

each custom field.

This field is equivalent to the Lookup Filter Fields

in the Search Layouts related list on the object detail page

in the application user interface. For more information, see

“Standard and Enhanced Lookups in Salesforce Classic” in

the Salesforce online help.

276

SearchLayoutsMetadata Types

DescriptionField TypeField

The list of phone-related fields displayed in a lookup dialog

for the object. The name field is mandatory and is always

string[]lookupPhoneDialogsAdditionalFields

displayed as the first column header, so it is not included in

this list; all additional fields are included. The field name

relative to the object name, for example

MyCustomField__c, is specified for each custom field.

This list enables integration of the fields with a SoftPhone

dial pad. For more information, see “About CTI 1.0 and 2.0

SoftPhones” in the Salesforce online help.

This field is equivalent to the Lookup Phone Dialogs

in the Search Layouts related list on the object detail page

in the application user interface.

The list of fields that can be used to filter a search for the

object. The field name relative to the object name, for

string[]searchFilterFields

example MyCustomField__c, is specified for each

custom field.

This field is equivalent to the Search Filter Fields

in the Search Layouts related list on the object detail page

in the application user interface.

The list of fields displayed in a search result for the object.

The name field is mandatory and is always displayed as the

string[]searchResultsAdditionalFields

first column header, so it is not included in this list; all

additional fields are included. The field name relative to the

object name, for example MyCustomField__c, is

specified for each custom field.

This field is equivalent to the Search Results in the

Search Layouts related list on the object detail page in the

application user interface.

The list of custom buttons available in a search result for the

object. The actions associated with the buttons can be

applied to any of the records returned in the search result.

string[]searchResultsCustomButtons

Declarative Metadata Sample Definition

A sample definition of search layouts in an object is shown below.

<?xml version="1.0" encoding="UTF-8"?>

...

<listViewButtons>Accept</listViewButtons>

<listViewButtons>ChangeOwner</listViewButtons>

277

SearchLayoutsMetadata Types

<lookupDialogsAdditionalFields>firstQuote__c</lookupDialogsAdditionalFields>

<lookupDialogsAdditionalFields>finalQuote__c</lookupDialogsAdditionalFields>

<searchResultsAdditionalFields>CREATEDBY_USER</searchResultsAdditionalFields>

</searchLayouts>

...

</CustomObject>

SEE ALSO:

CustomObject

SharingReason

Represents an Apex sharing reason, which is used to indicate why sharing was implemented for a custom object. Apex managed sharing

allows developers to use Apex to programmatically share custom objects. When you use Apex managed sharing to share a custom

object, only users with the “Modify All Data” permission can add or change the sharing on the custom object's record, and the sharing

access is maintained across record owner changes. For more information, see “Sharing Settings” in the Salesforce online help.

Use SharingReason to create, update, or delete sharing reason definitions for a custom object. This type extends the Metadata metadata

type and inherits its fullName field.

Version

Sharing reasons are available in API version 14.0 and later.

Fields

DescriptionField TypeField

Required. Sharing reason name. The __c suffix is appended to custom

sharing reasons.

Inherited from Metadata, this field is not defined in the WSDL for this

metadata type. It must be specified when creating, updating, or deleting.

See create() to see an example of this field specified for a call.

stringfullName

Required. Descriptive label for the sharing reason. Maximum of 40

characters.

stringlabel

Declarative Metadata Sample Definition

The definition of a sharing reason in a custom object:

...

278

SharingReasonMetadata Types

<fullName>recruiter__c</fullName>

<label>Recruiter</label>

</sharingReasons>

...

</CustomObject>

SharingRecalculation

Represents Apex classes that recalculate the Apex managed sharing for a specific custom object. For more information, see “Recalculate

Apex Managed Sharing” in the Salesforce online help.

Version

Sharing recalculations are available in API version 14.0 and later.

Fields

DescriptionField TypeField

Required. The Apex class that recalculates the Apex sharing for a custom

object. This class must implement the Database.Batchable

interface.

stringclassName

Declarative Metadata Sample Definition

The definition of a sharing recalculation in a custom object:

...

<className>RecruiterRecalculation</className>

</sharingRecalculations>

...

</CustomObject>

ValidationRule

Represents a validation rule, which is used to verify that the data a user enters in a record is valid and can be saved. A validation rule

contains a formula or expression that evaluates the data in one or more fields and returns a value of true or false. Validation rules

also include an error message that your client application can display to the user when the rule returns a value of true due to invalid

data. This type extends the Metadata metadata type and inherits its fullName field.

As of API version 20.0, validation rules can't have compound fields. Examples of compound fields include addresses, first and last names,

dependent picklists, and dependent lookups.

Version

Validation rules are available in API version 12.0 and later.

279

SharingRecalculationMetadata Types

Fields

DescriptionField TypeField Name

Required. Indicates whether this validation rule is active, (true), or not

active (false).

booleanactive

A description of the validation rule.stringdescription

Required. The formula defined in the validation rule. If the formula returns

a value of true, an error message is displayed.

See “Define Validation Rules” in the Salesforce online help.

stringerrorConditionFormula

The fully specified name of a field in the application. If a value is supplied,

the error message appears next to the specified field. If you do not specify

stringerrorDisplayField

a value or the field isn’t visible on the page layout, the value changes

automatically to Top of Page.

Required. The message that appears if the validation rule fails. The

message must be 255 characters or less.

stringerrorMessage

The internal name of the object. White spaces and special characters are

escaped for validity. The name must:

stringfullName

•Contain characters, letters, or the underscore (_) character

•Must start with a letter

•Can’t end with an underscore

•Can't contain two consecutive underscore characters.

Inherited from the Metadata component, this field is not defined in the

WSDL for this component. It must be specified when creating, updating,

or deleting. See create() to see an example of this field specified for

a call.

Declarative Metadata Sample Definition

A sample XML definition of a validation rule in a custom object is shown below.

<?xml version="1.0" encoding="UTF-8"?>

<deploymentStatus>Deployed</deploymentStatus>

<fullName>Mommy_Cat__c</fullName>

<label>Mommy Cat</label>

<type>Lookup</type>

</fields>

280

ValidationRuleMetadata Types

</nameField>

<sharingModel>ReadWrite</sharingModel>

<fullName>CatsRule</fullName>

<errorConditionFormula>OR(Name = 'Milo',Name =

'Moop')</errorConditionFormula>

</validationRules>

</CustomObject>

WebLink

Represents a custom button or link defined in a custom object. This type extends the Metadata metadata type and inherits its fullName

field.

Version

WebLinks are available in API version 12.0 and later.

Fields

DescriptionField TypeField Name

Required. Indicates whether the button or link is only available online

(online, or if it is also available offline (offline).

WebLinkAvailability

(enumeration of type string)

availability

A description of the button or link.stringdescription

Represents how ththe button or link is rendered. Valid values are:WebLinkDisplayType

(enumeration of type string)

displayType

•link for a hyperlink

•button for a button

•massAction for a button attached to a related list

Required. The default encoding setting is Unicode: UTF-8. Change it

if your template requires data in a different format. This is available if

your content source is URL.

Valid values include:

Encoding (enumeration of type

string)

encodingKey

•UTF-8—Unicode (UTF-8)

•ISO-8859-1—General US & Western Europe (ISO-8859–1,

ISO-LATIN-1)

•Shift_JIS—Japanese (Shift-JIS)

•ISO-2022-JP—Japanese (JIS)

•EUC-JP—Japanese (EUC-JP)

•x-SJIS_0213—Japanese (Shift-JIS_2004)

•ks_c_5601-1987—Korean (ks_c_5601-1987)

281

WebLinkMetadata Types

DescriptionField TypeField Name

•Big5—Traditional Chinese (Big5)

•GB2312—Simplified Chinese (GB2312)

•Big5-HKSCS—Traditional Chinese Hong Kong (Big5–HKSCS)

The name of the custom button or link with white spaces and special

characters escaped for validity. The name can only contain characters,

stringfullName

letters, and the underscore (_) character, must start with a letter, and

cannot end with an underscore or contain two consecutive underscore

characters.

Inherited from the Metadata component, this field is not defined in the

WSDL for this component. It must be specified when creating, updating,

or deleting. See create() to see an example of this field specified

for a call.

If the openType is newWindow, this field indicates whether to show

the browser menu bar for the window (true) or not (false).

Otherwise, leave this field empty.

booleanhasMenubar

If the openType is newWindow, this field indicates whether to show

the scroll bars for the window (true) or not (false). Otherwise, leave

this field empty.

booleanhasScrollbars

If the openType is newWindow, this field indicates whether to show

the browser toolbar for the window (true) or not (false). Otherwise,

leave this field empty.

booleanhasToolbar

Height in pixels of the window opened by the custom button or link.

Required if the openType is newWindow. Otherwise, leave this field

empty.

intheight

If the openType is newWindow, this field indicates whether to allow

resizing of the window (true) or not (false). Otherwise, leave this

field empty.

booleanisResizable

Required. Represents whether the content of the button or link is

specified by a URL, an sControl, a JavaScript code block, or a Visualforce

page.

WebLinkType (enumeration of

type string)

linkType

•url

•sControl

•javascript

•page

•flow—Reserved for future use.

Master label for this object. This display value is the internal label that is

not translated.

stringmasterLabel

282

WebLinkMetadata Types

DescriptionField TypeField Name

Required. When the button or link is clicked, specifies the window style

that will be used to display the content. Valid values:

WebLinkWindowType

(enumeration of type string)

openType

•newWindow

•sidebar

•noSidebar

•replace

•onClickJavaScript

If the value of linkType is page, this field represents the Visualforce

page. Otherwise, leave this field empty.

stringpage

If the value of OpenType is newWindow, this field indicates how

the new window should be displayed. Otherwise, don’t specify a value.

Valid values are:

WebLinkPosition (enumeration

of type string)

position

•fullScreen

•none

•topLeft

Required. Indicates whether this sub-component is protected (true)

or not (false). Protected sub-components can’t be linked to or

booleanprotected

referenced by components or sub-components created in the installing

organization.

If the openType is massAction, this field indicates whether to

require individual row selection to execute the action for this button

(true) or not (false). Otherwise, leave this field empty.

booleanrequireRowSelection

If the value of linkType is sControl, this field represents the name

of the sControl. Otherwise, leave this field empty.

stringscontrol

If the openType is newWindow, this field indicates whether to show

the browser location bar for the window (true) or not (false).

Otherwise, leave this field empty.

booleanshowsLocation

If the openType is newWindow, this field indicates whether or not

to show the browser status bar for the window. Otherwise, leave this

field empty.

booleanshowsStatus

If the value of linkType is url, this is the URL value. If the value of

linkType is javascript, this is the JavaScript content. If the value

is neither of these, leave this field empty.

stringurl

Content must be escaped in a manner consistent with XML parsing

rules.

Width in pixels of the window opened by the button or link.

Required if the openType is newWindow. Otherwise, leave this field

empty.

intwidth

283

WebLinkMetadata Types

Java Sample

The following Java sample shows sample values for WebLink fields:

public void WebLinkSample(String name) throws Exception {

WebLink WebLink = new WebLink();

// name variable represents the full name of the object

// on which to create the WebLink, for example, customObject__c

WebLink.setFullName(name + ".googleButton");

WebLink.setUrl("http://www.google.com");

WebLink.setAvailability(WebLinkAvailability.online);

WebLink.setLinkType(WebLinkType.url);

WebLink.setEncodingKey(Encoding.fromString("UTF-8"));

WebLink.setOpenType(WebLinkWindowType.newWindow);

WebLink.setHeight(600);

WebLink.setWidth(600);

WebLink.setShowsLocation(false);

WebLink.setHasScrollbars(true);

WebLink.setHasToolbar(false);

WebLink.setHasMenubar(false);

WebLink.setShowsStatus(false);

WebLink.setIsResizable(true);

WebLink.setPosition(WebLinkPosition.none);

WebLink.setMasterLabel("google");

WebLink.setDisplayType(WebLinkDisplayType.link);

AsyncResult[] asyncResults = metadataConnection.create(new WebLink[]{WebLink});

// After the create() call completes, we must poll the results of checkStatus()

}

Declarative Metadata Sample Definition

The following is the definition of a WebLink in a custom object. For related samples, see HomePageComponent and HomePageLayout.

<?xml version="1.0" encoding="UTF-8"?>

....

<fullName>googleButton</fullName>

<availability>online</availability>

<hasMenubar>false</hasMenubar>

<hasToolbar>false</hasToolbar>

<masterLabel>google</masterLabel>

<openType>newWindow</openType>

<protected>false</protected>

284

WebLinkMetadata Types

<showsLocation>false</showsLocation>

<showsStatus>false</showsStatus>

<url>http://www.google.com</url>

</WebLinks>

....

</CustomObject>

SEE ALSO:

HomePageComponent

HomePageLayout

CustomPageWebLink

Metadata Field Types

These field types extend the field types described in the SOAP API Developer's Guide.

What the Field ContainsObjectsField Type

Represents a custom field.Custom object

Custom field

CustomField

A string that represents deletion options for lookup relationships. Valid values

are:

Custom fieldDeleteConstraint

•SetNull

•Restrict

•Cascade

A string which represents the deployment status of a custom object or field. Valid

values are:

Custom object

Custom field

DeploymentStatus

•InDevelopment

•Deployed

Indicates the type of a custom field. Valid values are:Custom fieldFieldType

•AutoNumber

•Lookup

•MasterDetail

•MetadataRelationship

•Checkbox

•Currency

•Date

•DateTime

•Email

•EncryptedText

285

Metadata Field TypesMetadata Types

What the Field ContainsObjectsField Type

Note: This page is about Classic Encryption, not Shield Platform

Encryption. What's the difference?

•ExternalLookup

•IndirectLookup

•Number1

•Percent

•Phone

•Picklist

•MultiselectPicklist

•Summary

•Text

•TextArea

•LongTextArea

•Summary

•Url

•Hierarchy

•File

•CustomDataType

•Html

•Geolocation

1 A Number custom field is internally represented as a field of type double.

Setting the scale of the Number field to 0 gives you a double that behaves like

an int.

Indicates the gender of the noun that represents the object. This is used for

languages where words need different treatment depending on their gender.

Valid values are:

Custom objectGender

•Masculine

•Feminine

•Neuter

•AnimateMasculine (Slavic languages—currently Czech, Polish, Russian,

Slovak, Slovenian, and Ukrainian)

Note: The following genders are displayed on the Rename Tabs and

Labels page in Setup but are stored internally as “Feminine”. When setting

them through the Metadata API, use “Feminine”.

•Euter (Swedish)

•Common (Dutch)

286

Metadata Field TypesMetadata Types

What the Field ContainsObjectsField Type

(This field type isn’t used in Metadata API. CustomField includes this field type for

Tooling API support). Represents a picklist, a set of labels and values that can be

selected from a picklist.

Custom fieldPicklist (Including Dependent

Picklist)

Represents the sharing model for the custom object. Depending on the object,

valid values are:

Custom objectSharingModel

•Private

•Read

•ReadWrite

•ReadWriteTransfer

•FullAccess

•ControlledByParent

For example, the User object supports Private and Read values. Accounts,

opportunities, and custom objects support Private, Read and ReadWrite

values.

Indicates whether the noun starts with a vowel, consonant, or is a special character.

This is used for languages where words need different treatment depending on

the first character. Valid values are:

Custom object

Custom field

StartsWith

•Consonant

•Vowel

•Special (for nouns starting with z, or s plus

consonants)

Indicates how blanks should be treated. Valid values are:Custom fieldTreatBlanksAs

•BlankAsBlank

•BlankAsZero

Represents a set of values that can be selected from a custom picklist field. Defines

the valueSet of a the custom picklist field.

Custom fieldValueSet

ValueSet

Represents a set of values that can be selected from a custom picklist field. Defines the valueSet of a the custom picklist field.

DescriptionField TypeField Type

The fullname of the controlling field if this is a dependent picklist. A

controlling field can be a checkbox or picklist field, but in this case it’s a picklist.

The controlling picklist filters the available values in the dependent picklist.

stringcontrollingField

Whether the picklist’s values are limited to only the values defined by a

Salesforce admin. Values are true or false.

booleanrestricted

287

Metadata Field TypesMetadata Types

DescriptionField TypeField Type

Defines value-specific settings for a custom dependent picklist. Indicates

whether the value set of the custom picklist field is sorted alphabetically.

ValueSetValuesDefinitionvalueSetDefinition

The masterLabel of the global value set to be used for this picklist field.stringvalueSetName

Used for the settings that describe a value in a custom picklist field. The picklist

can have its own unique value set, or inherit the values from a global value

set.

ValueSettingsvalueSettings

ValueSetValuesDefinition

DescriptionField TypeField Name

Whether the picklist’s value set is displayed in alphabetical order in the user

interface.

booleansorted

Required. The list of values for this local, custom picklist.CustomValuevalue

ValueSettings

DescriptionField TypeField Name

Applies only to dependent custom picklists. A list of values in the controlling

or parent picklist (that the custom picklist values depend on).

string[]controllingFieldValue

Defines the values in the custom dependent picklist.stringvalueName

CustomObjectTranslation

This metadata type allows you to translate custom objects for a variety of languages. This type extends the Metadata metadata type and

inherits its fullName field. The ability to translate component labels is part of the Translation Workbench. For more information, see

“Enable and Disable the Translation Workbench” in the Salesforce online help.

Declarative Metadata File Suffix and Directory Location

Translations are stored in a file with a format of customObjectName__c-lang.objectTranslation, where

customObjectName__c is the custom object name, and lang is the translation language. A sample file name for German

translations is myCustomObject__c-de.objectTranslation.

Custom object translations are stored in the objectTranslations folder in the corresponding package directory.

Version

CustomObjectTranslation components are available in API version 14.0 and later.

288

CustomObjectTranslationMetadata Types

Fields

DescriptionField TypeField

Different combinations of the custom object with regard to

article, plural, possessive, and case.

ObjectNameCaseValue[]caseValues

A list of translations for the custom fields associated with the

custom object.

CustomFieldTranslation[]fields

The name of the custom object and the translation language

with a format of customObjectName-lang, where

stringfullName

customObjectName is the custom object name, and lang

is the translation language.

Inherited from Metadata, this field is not defined in the WSDL

for this metadata type. It must be specified when creating,

updating, or deleting. See create() to see an example of

this field specified for a call.

Indicates the gender of the noun that represents the object. This

is used for languages where words need different treatment

depending on their gender.

Gendergender

A list of page layout translations.LayoutTranslation[]layouts

The label for the name field. Maximum of 765 characters.stringnameFieldLabel

A list of translations for lookup filter error messages associated

with the custom object.

This field has been removed as of API version 30.0 and is only

available in prior versions. The translation metadata associated

NamedFilterTranslation[]namedFilters

with a lookup filter is now represented by the lookupFilter

field in the CustomFieldTranslation subtype.

A list of translations for actions.QuickActionTranslation[]quickActions

A list of record type translations.RecordTypeTranslation[]recordTypes

A list of sharing reason translations.SharingReasonTranslation[]sharingReasons

Indicates whether the noun starts with a vowel, consonant, or

is a special character. This is used for languages where words

need different treatment depending on the first character.

StartsWith (enumeration of type

string)

startsWith

A list of validation rule translations.ValidationRuleTranslation[]validationRules

A list of web link translations.WebLinkTranslation[]webLinks

A list of workflow task translations.WorkflowTaskTranslation[]workflowTasks

289

CustomObjectTranslationMetadata Types

CustomFieldTranslation

CustomFieldTranslation contains details for a custom field translation. In API versions 37.0 and earlier standard picklist values could be

translated with CustomFieldTranslation. In API version 38.0, use StandardValueSetTranslation instead. For more details, see CustomField.

Note: Not every language supports all the possible values for the fields in CustomFieldTranslation. For language-specific supported

values, see the fully supported languages and end-user languages appendices.

DescriptionField TypeField

Different combinations of the custom object with regard to

article, plural, possessive, and case. Available in API version 29.0

and later.

ObjectNameCaseValue[]caseValues

Translation for the custom field description.stringdescription

Indicates the gender of the noun that represents the object. This

is used for languages where words need different treatment

Gendergender

depending on their gender. Available in API version 29.0 and

later.

Translation for the text that displays in the field-level help hover

text for this field.

stringhelp

Translation for the label. Maximum of 765 characters.stringlabel

Represents the translation metadata associated with a lookup

filter.

This field is available in API version 30.0 and later.

LookupFilterTranslationlookupFilter

Note: LookupFilter is not supported on the article type

object.

Required. The name of the field relative to the custom object;

for example, MyField__c.

stringname

List of translations for picklist values. See PicklistValue.

Note: “Subject” on the Task object is a text field, not a picklist

value. It can’t be retrieved via the Metadata API. Translations can

be provided via the Translation Workbench.

PicklistValueTranslation[]picklistValues

Translation for a lookup relationship label. A lookup relationship

allows a field to be associated with another field. The relationship

stringrelationshipLabel

field allows users to select an option from a list of values defined

by the other field. Maximum of 765 characters.

Indicates whether the noun starts with a vowel, consonant, or

is a special character. This is used for languages where words

StartsWith (enumeration of type

string)

startsWith

need different treatment depending on the first character.

Available in API version 29.0 and later.

290

CustomObjectTranslationMetadata Types

LayoutTranslation

LayoutTranslation contains details for a page layout translation. For more details, see Fields.

DescriptionField TypeField

Required. The layout name.stringlayout

stringlayoutType

An array of layout section translations.LayoutSectionTranslation[]sections

LayoutSectionTranslation

LayoutSectionTranslation contains details for a page layout section translation. For more details, see LayoutSection.

DescriptionField TypeField

Required. Translation for the label. Maximum of 765 characters.stringlabel

Required. The section name.stringsection

LookupFilterTranslation

LookupFilterTranslation shows a translation for a lookup filter error message associated with the custom object. Replaces

NamedFilterTranslation.

LookupFilterTranslation is available in API version 30.0 and later.

DescriptionField TypeField

The error message that appears if the lookup filter fails.stringerrorMessage

The information message displayed on the page. Use to describe

things the user might not understand, such as why certain items

are excluded in the lookup filter.

stringinformationalMessage

NamedFilterTranslation

NamedFilterTranslation has been removed as of API version 30.0 and is only available in previous API versions.

NamedFilterTranslation shows a list of translations for lookup filter error messages associated with the custom object. See NamedFilter

for more information.

DescriptionField TypeField

The error message that appears if the lookup filter fails.stringerrorMessage

The information message displayed on the page. Use to describe

things the user might not understand, such as why certain items

are excluded in the lookup filter.

stringinformationalMessage

291

CustomObjectTranslationMetadata Types

DescriptionField TypeField

Required. The name of the lookup filter. If you create this field

in the user interface, a name is automatically assigned. If you

stringname

create this field through Metadata API, you must include the

name field.

ObjectNameCaseValue

ObjectNameCaseValue supports multiple cases and definitions of the custom object name to allow usage in various grammatical contexts.

Note: Not every language supports all the possible values for the fields in ObjectNameCaseValue. For language-specific supported

values, see the fully supported languages and end-user languages appendices.

DescriptionField TypeField

English has two types of articles: definite (the) and indefinite

(a, an). The usage of these articles depends mainly on whether

Article (enumeration of type

string)

article

you are referring to any member of a group, or to a specific

member of a group. The valid values are:

•Definite

•Indefinite

•None

The case of the custom object name. The valid values are:CaseType (enumeration of type

string)

caseType

•Ablative

•Accusative

•Adessive

•Allative

•Causalfinal

•Dative

•Delative

•Distributive

•Elative

•Essive

•Essiveformal

•Genitive

•Illative

•Inessive

•Instrumental

•Lative

•Locative

•Nominative

•Objective

292

CustomObjectTranslationMetadata Types

DescriptionField TypeField

•Partitive

•Prepositional

•Subjective

•Sublative

•Superessive

•Termanative

•Translative

•Vocative

Indicates whether the value field is plural (true) or singular

(false).

booleanplural

The possessive case of a language is a grammatical case used

to indicate a relationship of possession.The valid values are:

Possessive (enumeration of type

string)

possessive

•First

•None

•Second

Required. The value or label in this grammatical context.stringvalue

PicklistValueTranslation

PicklistValueTranslation contains details for translation of a picklist value from a local, custom picklist field. For more details, see Picklist

(Including Dependent Picklist).

DescriptionField TypeField

Required. The picklist value defined on the setup page in the

application is your master label. The master label is displayed

wherever a translated label is not available.

stringmasterLabel

Required. Translation for the value.stringtranslation

QuickActionTranslation

QuickActionTranslation contains details for an action label in the user interface. For more information, see QuickAction.

DescriptionField TypeField

Required. Translation for the label. Maximum of 765 characters.stringlabel

Required. The quick action name.stringname

293

CustomObjectTranslationMetadata Types

RecordTypeTranslation

RecordTypeTranslation contains details for a record type name translation. For more details, see RecordType.

DescriptionField TypeField

Required. Translation for the label. Maximum of 765 characters.stringlabel

Required. The record type name.stringname

SharingReasonTranslation

SharingReasonTranslation contains details for a sharing reason translation. For more details, see SharingReason.

DescriptionField TypeField

Required. Translation for the sharing reason.stringlabel

Required. The sharing reason name.stringname

ValidationRuleTranslation

ValidationRuleTranslation contains details for a validation rule translation. For more details, see ValidationRule.

DescriptionField TypeField

Required. Translation for the error message associated with the

validation rule failure.

stringerrorMessage

Required. The validation rule name.stringname

WebLinkTranslation

WebLinkTranslation contains details for a web link translation. For more details, see WebLink.

DescriptionField TypeField

Required. Translation for the web link label. Maximum of 765

characters.

stringlabel

Required. The web link name.stringname

WorkflowTaskTranslation

WorkflowTaskTranslation contains details for a workflow task translation. For more details, see Workflow.

DescriptionField TypeField

Translation for the workflow task description.stringdescription

294

CustomObjectTranslationMetadata Types

DescriptionField TypeField

Required. The workflow task name.stringname

Translation for the workflow task subject.stringsubject

Declarative Metadata Sample Definitions

This is a sample XML definition of a CustomObjectTranslation for the Description__c object in German, with one custom field, Summary__c.

The name and location of the file containing this definition would be

objectTranslations/Description__c-de.objectTranslation.

<?xml version="1.0" encoding="UTF-8"?>

<caseType>Nominative</caseType>

<plural>false</plural>

<value>Beschreibung</value>

</caseValues>

<caseType>Nominative</caseType>

<value>Beschreibungen</value>

</caseValues>

<caseType>Accusative</caseType>

<plural>false</plural>

<value>Beschreibung</value>

</caseValues>

<caseType>Accusative</caseType>

<value>Beschreibungen</value>

</caseValues>

<caseType>Genitive</caseType>

<plural>false</plural>

<value>Beschreibung</value>

</caseValues>

<caseType>Genitive</caseType>

<value>Beschreibungen</value>

</caseValues>

<caseType>Dative</caseType>

<plural>false</plural>

<value>Beschreibung</value>

</caseValues>

<caseType>Dative</caseType>

<value>Beschreibungen</value>

295

CustomObjectTranslationMetadata Types

</caseValues>

<label>Zusammenfassung</label>

<name>Summary__c</name>

</fields>

<gender>Feminine</gender>

<nameFieldLabel>Beschreibungen</nameFieldLabel>

</CustomObjectTranslation>

This is a sample XML definition of a CustomObjectTranslation for the Account object, renaming Account to Client (Kunde) in German.

The Account object has one standard field, account_number, and one custom field, Account_Code__c. The name and location of the

file containing this definition would be objectTranslations/Account-de.objectTranslation.

<?xml version="1.0" encoding="UTF-8"?>

<caseType>Nominative</caseType>

<plural>false</plural>

<value>Kunde</value>

</caseValues>

<caseType>Nominative</caseType>

<value>Kunden</value>

</caseValues>

<caseType>Accusative</caseType>

<plural>false</plural>

<value>Kunden</value>

</caseValues>

<caseType>Accusative</caseType>

<value>Kunden</value>

</caseValues>

<caseType>Genitive</caseType>

<plural>false</plural>

<value>Kunden</value>

</caseValues>

<caseType>Genitive</caseType>

<value>Kunden</value>

</caseValues>

<caseType>Dative</caseType>

<plural>false</plural>

<value>Kunden</value>

</caseValues>

<caseType>Dative</caseType>

<value>Kunden</value>

</caseValues>

296

CustomObjectTranslationMetadata Types

<caseType>Nominative</caseType>

<plural>false</plural>

<value>Kundennummer</value>

</caseValues>

<caseType>Nominative</caseType>

<value>Kundennummern</value>

</caseValues>

<gender>Feminine</gender>

<name>account_number</name>

</fields>

<label>Kunden-Code</label>

<name>Account_Code__c</name>

</fields>

<gender>Masculine</gender>

</CustomObjectTranslation>

SEE ALSO:

CustomObject

Translations

CustomPageWebLink

Represents a custom link defined in a home page component. This type extends the Metadata metadata type and inherits its fullName

field. All other custom links are stored as a WebLink in a CustomObject.

Declarative Metadata File Suffix and Directory Location

There is one file per custom link definition, stored in the weblinks folder in the corresponding package directory. The file suffix is

.weblink.

Version

CustomPageWebLinks are available in API version 13.0 and later.

Fields

DescriptionField TypeField Name

Required. Indicates whether the link is only available online (online,

or if it is also available offline (offline).

WebLinkAvailability

(enumeration of type string)

availability

A description of the link.stringdescription

297

CustomPageWebLinkMetadata Types

DescriptionField TypeField Name

Represents how this link is rendered.

Valid values:

WebLinkDisplayType

(enumeration of type string)

displayType

•link for a hyperlink

•button for a button

•massAction for a button attached to a related list

Required. The default encoding setting is Unicode: UTF-8. Change it if

your template requires data in a different format. This is available if your

content source is URL.Valid values include:

Encoding (enumeration of type

string)

encodingKey

•UTF-8—Unicode (UTF-8)

•ISO-8859-1—General US & Western Europe (ISO-8859–1,

ISO-LATIN-1)

•Shift_JIS—Japanese (Shift-JIS)

•ISO-2022-JP—Japanese (JIS)

•EUC-JP—Japanese (EUC-JP)

•x-SJIS_0213—Japanese (Shift-JIS_2004)

•ks_c_5601-1987—Korean (ks_c_5601-1987)

•Big5—Traditional Chinese (Big5)

•GB2312—Simplified Chinese (GB2312)

•Big5-HKSCS—Traditional Chinese Hong Kong (Big5–HKSCS)

The name used as a unique identifier for API access. The fullName

can contain only underscores and alphanumeric characters. It must be

stringfullName

unique, begin with a letter, not include spaces, not end with an

underscore, and not contain two consecutive underscores.

If the openType is newWindow, this field indicates whether to show

the browser menu bar for the window (true or not (false). Otherwise,

leave this field empty.

booleanhasMenubar

If the openType is newWindow, this field indicates whether to show

the scroll bars for the window (true) or not (false). Otherwise, leave

this field empty.

booleanhasScrollbars

If the openType is newWindow, this field indicates whether to show

the browser toolbar for the window (true) or not (false). Otherwise,

leave this field empty.

booleanhasToolbar

Height in pixels of the window opened by the link. Required if the

openType is newWindow. Otherwise, leave this field empty.

intheight

If the openType is newWindow, this field indicates whether to allow

resizing of the window (true) or not (false). Otherwise, leave this

field empty.

booleanisResizable

298

CustomPageWebLinkMetadata Types

DescriptionField TypeField Name

Required. Represents whether the content of the button or link is specified

by a URL, an sControl, a JavaScript code block, or a Visualforce page.

WebLinkType (enumeration of

type string)

linkType

•url

•sControl

•javascript

•page

•flow—Reserved for future use.

The master label for the link.stringmasterLabel

Required. When the link is clicked, this field specifies the window style

used to display the content.

Valid values are:

WebLinkWindowType

(enumeration of type string)

openType

•newWindow

•sidebar

•noSidebar

•replace

•onClickJavaScript

If the value of linkType is page, this field represents the Visualforce

page. Otherwise, leave this field empty.

stringpage

If the openType is newWindow, this field indicates how the new

window should be displayed. Otherwise, leave this field empty.

Valid values are:

WebLinkPosition (enumeration

of type string)

position

•fullScreen

•none

•topLeft

Required. Indicates whether this component is protected (true) or not

(false). Protected components cannot be linked to or referenced by

components created in the installing organization.

booleanprotected

If the openType is massAction, this field indicates whether to require

individual row selection to execute the action for this button (true) or

not (false). Otherwise, leave this field empty.

booleanrequireRowSelection

If the value of linkType is sControl, this field represents the name

of the sControl. Otherwise, leave this field empty.

stringscontrol

If the openType is newWindow, this field indicates whether or not to

show the browser location bar for the window. Otherwise, leave this field

empty.

booleanshowsLocation

299

CustomPageWebLinkMetadata Types

DescriptionField TypeField Name

If the openType is newWindow, this field indicates whether or not to

show the browser status bar for the window. Otherwise, leave this field

empty.

booleanshowsStatus

If the value of linkType is url, this field represents the URL value. If

the value of linkType is javascript, this field represents the

JavaScript content. If the value is neither of these, leave this field empty.

stringurl

Content must be escaped in a manner consistent with XML parsing rules.

Width in pixels of the window opened by the link.

Required if the openType is newWindow. Otherwise, leave this field

empty.

intwidth

Declarative Metadata Sample Definition

The following is the definition of a Weblink. For related samples, see HomePageComponent and HomePageLayout.

<?xml version="1.0" encoding="UTF-8"?>

<availability>online</availability>

<displayType>button</displayType>

<encodingKey>UTF-8</encodingKey

<hasMenubar>false</hasMenubar>

<hasToolbar>false</hasToolbar>

<masterLabel>detailPageButon</masterLabel>

<openType>newWindow</openType>

<protected>false</protected>

<showsLocation>false</showsLocation>

<showsStatus>false</showsStatus>

<url>http://google.com</url>

</CustomPageWebLink>

SEE ALSO:

HomePageComponent

HomePageLayout

WebLink

CustomPermission

Represents a permission that grants access to a custom feature. This type extends the Metadata metadata type and inherits its fullName

field.

300

CustomPermissionMetadata Types

File Suffix and Directory Location

CustomPermission components have the suffix .customPermission and are stored in the customPermissions folder.

Version

CustomPermission components are available in API version 31.0 and later.

Fields

DescriptionField TypeField Name

The name of the connected app that’s

associated with this permission. Limit: 80

characters.

stringconnectedApp

The custom permission description. Limit:

255 characters.

stringdescription

Required. The custom permission label.

Limit: 80 characters.

stringlabel

Indicates which custom permissions are

required by the parent custom permission.

CustomPermissionDependencyRequired[]requiredPermission

This field is available in API version 32.0 and

later.

CustomPermissionDependencyRequired

CustomPermissionDependencyRequired determines whether a custom permission is required by the parent custom permission. A

required custom permission must be enabled when its parent is enabled.

DescriptionField TypeField Name

Required. The custom permission name.stringcustomPermission

Required. Indicates whether this custom permission is required by the

parent custom permission (true) or not (false).

booleandependency

Declarative Metadata Sample Definition

The following is an example of a CustomPermission component.

<?xml version="1.0" encoding="UTF-8"?>

<description>Read and edit access for Acme accounts.</description>

<label>Acme Account Full Access</label>

<customPermission>Acme_Account_Read</customPermission>

301

CustomPermissionMetadata Types

</requiredPermission>

</CustomPermission>

The following is an example package.xml that references the previous definition, as well as other custom permissions that are

associated with a connected app.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>ConnectedApp</name>

</types>

<types>

<members>Acme_Account_Email_Read</members>

<members>Acme_Account_Phone_Edit</members>

<members>Acme_Account_Full_Access</members>

<members>Acme_Account_Read</members>

<name>CustomPermission</name>

</types>

<types>

<members>Acme_Account_Email_Read</members>

<members>Acme_Account_Phone_Edit</members>

<members>Acme_Account_Full_Access</members>

<members>Acme_Account_Read</members>

<name>PermissionSet</name>

</types>

</Package>

CustomSite

Represents a Force.com site. Force.com Sites enables you to create public websites and applications that are directly integrated with

your Salesforce organization—without requiring users to log in with a username and password. For more information, see “Force.com

Sites” in the Salesforce online help.

Note: CustomSite does not support syndication feeds at this time.

This type extends the Metadata metadata type and inherits its fullName field.

Declarative Metadata File Suffix and Directory Location

Force.com CustomSite components are stored in the sites directory of the corresponding package directory. The file name matches

the site name, and the extension is .site.

Version

Force.com CustomSite components are available in API version 14.0 and later.

302

CustomSiteMetadata Types

Fields

DescriptionField TypeField

Required. Determines whether or not the site is active.booleanactive

Required. Determines whether or not the standard

home page is visible to public users. This is a new field

in API version 15.0.

booleanallowHomePage

Determines whether the standard answer pages are

visible to public users. This is a new field in API version

19.0.

booleanallowStandardAnswersPages

Required. Determines whether or not the standard

Ideas pages are visible to public users. This is a new

field in API version 15.0.

booleanallowStandardIdeasPages

Required. Determines whether or not the standard

lookup pages are visible to public users. This is a new

field in API version 15.0.

booleanallowStandardLookups

Required. When enabled, authenticated users in this

site can access standard Salesforce pages as allowed

booleanallowStandardPortalPages

by their access controls. When disabled, authenticated

users in this site can't access standard Salesforce

pages, even if their access controls allow it. If your site

serves only Visualforce pages, disabling this setting

helps add a layer of access protection to your site. This

is a new field in API version 39.0.

Determines whether or not the standard search pages

are visible to public users. This is a new field in API

version 15.0.

booleanallowStandardSearch

The tracking code associated with your site. This code

can be used by services like Google Analytics to track

stringanalyticsTrackingCode

page request data for your site. This field is available

in API version 17.0 and later.

The name of the Visualforce page to be displayed

when the guest user tries to access a page for which

they are not authorized.

stringauthorizationRequiredPage

The name of the Visualforce page to be displayed

when the site has exceeded its bandwidth quota.

stringbandwidthExceededPage

The name of the Visualforce page to be displayed

when the portal user attempts to change his or her

stringchangePasswordPage

password for either the portal or for Chatter Answers,

when enabled.

The name of the Visualforce page to be displayed that

informs the user that an email has been sent to them

stringchatterAnswersForgotPasswordConfirmPage

303

CustomSiteMetadata Types

DescriptionField TypeField

with a temporary password. This field is available if

Chatter Answers is enabled for your organization. This

field is available in API version 27.0 and later.

The name of the Visualforce page to be displayed

when a user clicks the link to retrieve a forgotten

stringchatterAnswersForgotPasswordPage

password. This field is available if Chatter Answers is

enabled for your organization. This field is available in

API version 27.0 and later.

The name of the Visualforce page to be displayed

when the user clicks the help link. This field is available

stringchatterAnswersHelpPage

if Chatter Answers is enabled for your organization.

This field is available in API version 27.0 and later.

The name of the Visualforce page to be displayed to

allow users to log in to the portal. This field is available

stringchatterAnswersLoginPage

if Chatter Answers is enabled for your organization.

This field is available in API version 27.0 and later.

The name of the Visualforce page to be displayed to

allow users to register themselves and access the

stringchatterAnswersRegistrationPage

portal. This field is available in API version 27.0 and

later.

Required. Sets the clickjack protection level. The

options are:

SiteClickjackProtectionLevel

(enumeration of type

string)

clickjackProtectionLevel

•AllowAllFraming — Allow framing by any

page (no protection)

•SameOriginOnly — Allow framing by the

same origin only (recommended)

•NoFraming — Don’t allow framing by any

page (most protection)

This field is available in API version 30.0 and later.

The root custom URLs associated with the site. Saving

or deploying a CustomSite replaces all root custom

SiteWebAddress[]customWebAddresses

URLs in the site with the root custom URLs in this list.

Custom URLs that use a non-root path prefix are not

included in this list and are not affected when saving

or deploying a CustomSite. This field is available in API

version 21.0 and later.

The site description.stringdescription

The name of the file to be used for the icon that

appears in the browser's address field when visiting

the site. Sets the favorite icon for the entire site.

stringfavoriteIcon

304

CustomSiteMetadata Types

DescriptionField TypeField

The name of the Visualforce page to be displayed

when the guest user tries to access a non-existent

page.

stringfileNotFoundPage

The name of the Visualforce page to be displayed

when a user clicks the Forgot Password link on the

stringforgotPasswordPage

site’s login page. This field is only applicable for

Communities sites.

The name of the Visualforce page to be displayed for

errors not otherwise specified.

stringgenericErrorPage

Read only. The name of the profile associated with

the guest user.

stringguestProfile

The name of the Visualforce page to be displayed

when the site is down for maintenance.

stringinMaintenancePage

The name of the Visualforce page set as the inactive

site home page.

stringinactiveIndexPage

Required. The name of the Visualforce page set as the

active site home page.

stringindexPage

The name of the site label in the Salesforce user

interface.

stringmasterLabel

The name of the portal associated with this site for

stringportal

Determines whether the site requires secure

connections (true) or not (false). When false, the site

booleanrequireHttps

operates normally via insecure connections instead

of redirecting to a secure connection.

Required. Determines whether to override your

organization's security settings and exclusively use

booleanrequireInsecurePortalAccess

HTTP when logging in to the associated portal from

your site.

The name of the Visualforce page to be displayed for

the robots.txt file used by web crawlers.

stringrobotsTxtPage

The name of the static resource to be displayed from

the cache server when Salesforce servers are down.

stringserverIsDown

The static resource must be a public zip file 1 MB or

smaller and must contain a page named

maintenance.html at the root level of the zip

file. Other resources in the zip file, such as images or

CSS files, can follow any directory structure. This field

is available in API version 17.0 and later.

305

CustomSiteMetadata Types

DescriptionField TypeField

An array of all URL redirect rules set for your site. This

field is available in API version 20.0 and later.

SiteRedirectMapping[]siteRedirectMappings

The username of the site administrator.stringsiteAdmin

The name of the Visualforce page to be used as the

site template.

stringsiteTemplate

Identifies whether the site is a Visualforce (Force.com

Sites) or a Site.com site.

If Salesforce Communities is enabled for your

organization, the site could also be a ChatterNetwork

siteTypesiteType

(Force.com Sites) or ChatterNetworkPicasso (Site.com)

site.

This is a new field in API version 27.0.

Required. Read only. The custom subdomain prefix

for the site. For example, if your site URL is

stringsubdomain

mycompany.force.com/partners,

mycompany.force.com is the subdomain.

The first part of the path on the site's URL that

distinguishes this site from other sites. For example,

stringurlPathPrefix

if your site URL is

mycompany.force.com/partners,

partners is the urlPathPrefix.

SiteRedirectMapping

SiteRedirectMapping represents a URL redirect rule on your Force.com site. For more information, see “Force.com Sites URL Redirects”

in the Salesforce online help.

DescriptionField TypeField

The type of the redirect. Available string

values are:

SiteRedirect (enumeration of type string)action

•Permanent

•Temporary

The status of the redirect: active or inactive.booleanisActive

The URL that you want to redirect. It must

be a relative URL, but can have any valid

extension type, such as .html or .php.

stringsource

The new URL you want users to visit. It can

be a relative URL or a fully-qualified URL with

an http:// or https:// prefix.

stringtarget

306

CustomSiteMetadata Types

SiteWebAddress

Represents the web address of a Force.com site.

DescriptionField TypeField

Although this field is visible in the Metadata

API version 39.0, it’s not functional and

should be left blank.

stringcertificate

The domain of the website, in the form of

www.acme.com.

stringdomainName

Indicates whether this is the primary domain

(true). If false, this is not the primary

domain.

booleanprimary

Declarative Metadata Sample Definition

A sample XML definition of a site is shown below.

<?xml version="1.0" encoding="UTF-8"?>

<authorizationRequiredPage>Unauthorized</authorizationRequiredPage>

<bandwidthExceededPage>BandwidthExceeded</bandwidthExceededPage>

<changePasswordPage>ChangePassword</changePasswordPage>

<chatterAnswersForgotPasswordConfirmPage>ChatterAnswersForgotPasswordConfirm</chatterAnswersForgotPasswordConfirmPage>

<chatterAnswersForgotPasswordPage>ChatterAnswersForgotPassword</chatterAnswersForgotPasswordPage>

<chatterAnswersHelpPage>ChatterAnswersHelp</chatterAnswersHelpPage>

<chatterAnswersLoginPage>ChatterAnswersLogin</chatterAnswersLoginPage>

<chatterAnswersRegistrationPage>ChatterAnswersRegistration</chatterAnswersRegistrationPage>

<clickjackProtectionLevel>SameOriginOnly</clickjackProtectionLevel>

<domainName>www.testing123.com</domainName>

</customWebAddress>

<favoriteIcon>myFavIcon</favoriteIcon>

<fileNotFoundPage>FileNotFound</fileNotFoundPage>

<genericErrorPage>Exception</genericErrorPage>

<inMaintenancePage>InMaintenance</inMaintenancePage>

<serverIsDown>MyServerDownResource</serverIsDown>

307

CustomSiteMetadata Types

<indexPage>UnderConstruction</indexPage>

<masterLabel>customSite</masterLabel>

<portal>Customer Portal</portal>

<requireInsecurePortalAccess>false</requireInsecurePortalAccess>

<siteAdmin>admin@myco.org</siteAdmin>

<siteTemplate>SiteTemplate</siteTemplate>

</CustomSite>

SEE ALSO:

Portal

CustomTab

Represents a custom tab. Custom tabs let you display custom object data or other web content in Salesforce. When you add a custom

tab to an app in Salesforce Classic, it displays as a tab. When you add a custom tab to an app in Lightning Experience, it displays as an

item in the app’s navigation bar. When a tab displays a custom object, the tab name is the same as the custom object name; for page,

s-control, or URL tabs, the name is arbitrary. For more information, see “Show Custom Object Data for Your Users” in the Salesforce online

help. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

The file suffix is .tab. There is one file for each tab, stored in the tabs folder in the corresponding package directory.

Note: Retrieving a component of this metadata type in a project makes the component appear in any Profile and PermissionSet

components that are retrieved in the same package.

Version

Tabs are available in API version 10.0 and later.

Fields

This metadata type contains the following fields:

DescriptionField TypeField Name

A list of the action overrides that are assigned to the tab. Only one

override is allowed per formFactor for a given tab.

This field is available in API version 37.0 and later.

ActionOverride[]actionOverrides

Indicates whether this tab is for a Lightning component (true) or not

(false). If set to true, the name of the tab matches the name of the

Lightning component.

Only one of these fields should have a value set:

stringauraComponent

•auraComponent

308

CustomTabMetadata Types

DescriptionField TypeField Name

•customObject

•flexiPage

•page

•scontrol

•url

Note: auraComponent is part of the Lightning Components

(Beta) feature.

Indicates whether this tab is for a custom object (true) or not (false).

If set to true, the name of the tab matches the name of the custom

object.

Only one of these fields should have a value set:

booleancustomObject

•auraComponent

•customObject

•flexiPage

•page

•scontrol

•url

The optional description text for the tab.stringdescription

The name of the Lightning Page to display in this tab.

Only one of these fields should have a value set:

stringflexiPage

•auraComponent

•customObject

•flexiPage

•page

•scontrol

•url

The height, in pixels of the tab frame. Required for s-control and page

tabs.

intframeHeight

The name of the tab. The value of this field depends on the type of tab,

and the API version.

stringfullName

•For custom object tabs, the fullName is the developer-assigned

name of the custom object (MyCustomObject__c, for example). For

custom object tabs, this name must be the same as the custom

object name, and customObject should be set to true.

•For Web tabs, the fullName is the developer-assigned name of

the tab (MyWebTab, for example).

309

CustomTabMetadata Types

DescriptionField TypeField Name

The fullName can contain only underscores and alphanumeric

characters. It must be unique, begin with a letter, not include spaces,

not end with an underscore, and not contain two consecutive

underscores. This field is inherited from the Metadata component.

Indicates if the tab displays the sidebar panel.booleanhasSidebar

The optional reference to the image document for the tab if the tab is

not using one of the standard tab styles. This is a new field in API version

14.0.

stringicon

This is the label of the tab, for Web tabs only.stringlabel

Required. Indicates if the custom tab is available for Mobile Edition

(true) or not (false).

booleanmobileReady

Required. The tab style for the color scheme and icon for the custom

tab. For example, “'Custom70: Handsaw,” is the handsaw icon.

stringmotif

The name of the Visualforce page to display in this tab.

Only one of these fields should have a value set:

stringpage

•auraComponent

•customObject

•flexiPage

•page

•scontrol

•url

The name of the s-control to display in this tab.

Only one of these fields should have a value set:

stringscontrol

•auraComponent

•customObject

•flexiPage

•page

•scontrol

•url

The custom link used as the introductory splash page when users click

the tab. References a HomePageComponent.

stringsplashPageLink

The URL for the external web-page to embed in this tab.

Only one of these fields should have a value set:

stringurl

•auraComponent

•customObject

•flexiPage

310

CustomTabMetadata Types

DescriptionField TypeField Name

•page

•scontrol

•url

The default encoding setting is Unicode: UTF-8. Change it if you are

passing information to a URL that requires data in a different format. This

option is available when the value URL is selected in the tab type.

Encoding

(enumeration of

type string)

urlEncodingKey

Declarative Metadata Sample Definition

The following is the definition of a tab:

<?xml version="1.0" encoding="UTF-8"?>

<description>Myriad Publishing</description>

<motif>Custom53: Bell</motif>

<url>http://www.myriadpubs.com</url>

</CustomTab>

SEE ALSO:

CustomApplication

CustomValue

Represents the definition of a value used in a global value set or local custom picklist. Custom picklist fields can be local and unique, or

can inherit their values from a global picklist (called a global value set in API version 38.0). This type extends the Metadata metadata type

and inherits its fullName field.

To deactivate a global picklist value, you can invoke an update() call on GlobalPicklist (API version 37.0) or GlobalValueSet (API

version 38.0 and later) with the value omitted, or with the value’s isActive field set to false. Or, you can invoke an update()

call directly on GlobalPicklistValue (API version 37.0) or CustomValue (API version 38.0 and later) with the isActive field set to false.

Note: If picklist values are missing from a component definition, they get deactivated when deployed. Deactivation occurs for

picklist values of both standard and custom fields.

CustomValue doesn’t support file-based operations and only supports CRUD-based calls. CustomValue is retrieved or deployed together

with a GlobalValueSet or CustomObject component.

File Suffix and Directory Location

CustomValue components have the suffix .customValue. A CustomValue component is returned with either a GlobalValueSet or

CustomObject component.

311

CustomValueMetadata Types

Version

CustomValue components are available in API version 38.0 and later. CustomValue replaces GlobalPicklistValue from API version 37.0.

Fields

DescriptionField TypeField Name

The color assigned to the picklist value when it’s used in charts on reports

and dashboards. The color is in hexadecimal format; for example,

stringcolor

#FF6600. If a color is not specified, it’s assigned dynamically upon chart

generation.

Required. Indicates whether this value is the default selection for the

global picklist and the custom picklists that share its picklist value set.

This field is set to true by default.

booleandefault

A picklist value’s description. It’s useful to include a description for a

picklist value so the reason for creating it can be tracked. Limit: 255

characters.

stringdescription

Indicates whether this value is currently active or inactive. The default

value is true. Users can select only active values from a picklist. An API

booleanisActive

retrieve operation for global picklist values returns all active and inactive

values in the picklist. (Meanwhile, retrieving the values of a non-global,

unrestricted picklist returns only the active values.)

The value’s display label. If you don’t specify the label when creating a

value it defaults to the API name. Available in API version 39.0 and later.

stringlabel

StandardValue

This metadata type defines a value in a value set for a standard picklist and specifies whether this value is the default value. This type

extends the CustomValue metadata type and inherits all its fields.

When you deploy changes to standard picklist fields, picklist values are added as needed.

DescriptionField TypeField Name

Indicates whether this value lets users email a quote PDF (true), or not

(false). This field is only relevant for the Status field in quotes. This

field is available in API version 18.0 and later.

booleanallowEmail

Indicates whether this value is associated with a closed status (true),

or not (false). This field is only relevant for the standard Status

booleanclosed

field in cases and tasks. This field is available in API version 16.0 and up

to version 36.0. In version 37.0, this field is in GlobalPicklistValue.

Indicates whether this value is associated with a converted status (true),

or not (false). This field is relevant for only the standard Lead

booleanconverted

Status field in leads. Your organization can set its own guidelines for

312

CustomValueMetadata Types

DescriptionField TypeField Name

determining when a lead is qualified, but typically, you want to convert

a lead as soon as it becomes a real opportunity that you want to forecast.

For more information, see “Convert Qualified Leads” in the Salesforce

online help. This field is available in API version 16.0 and later.

Indicates whether this value is available in your Self-Service Portal (true),

or not (false). This field is only relevant for the standard Case

Reason field in cases.

Self-Service provides an online support channel for your customers -

allowing them to resolve their inquiries without contacting a customer

booleancssExposed

service representative. For more information about Self-Service, see

“Setting Up Self-Service” in the Salesforce online help.

Note: Starting with Spring ’12, the Self-Service portal isn’t

available for new orgs. Existing orgs continue to have access to

the Self-Service portal.

This field is available in API version 16.0 and later.

Indicates whether this value is associated with a forecast category

(true), or not (false). This field is only relevant for the standard

ForecastCategories

(enumeration of

type string)

forecastCategory

Stage field in opportunities. For more information about forecast

categories, including the valid string values listed below, see “ Working

with Forecast Categories ” in the Salesforce online help.

•Omitted

•Pipeline

•BestCase

•Forecast

•Closed

This field is available in API version 16.0 and later.

Indicates whether this value is a high priority item (true), or not

(false). This field is only relevant for the standard Priority field

booleanhighPriority

in tasks. For more information about tasks, see “Considerations for Using

Tasks” in the Salesforce online help. This field is available in API version

16.0 and later.

Indicates whether this value is a probability percentage (true), or not

(false). This field is only relevant for the standard Stage field in

opportunities. This field is available in API version 16.0 and later.

intprobability

A picklist value corresponding to a reverse role name for a partner. If the

role is “subcontractor”, then the reverse role might be “general

stringreverseRole

contractor”. Assigning a partner role to an account in Salesforce creates

a reverse partner relationship so that both accounts list the other as a

partner. This field is only relevant for partner roles.

For more information, see “Partner Fields” in the Salesforce online help.

313

CustomValueMetadata Types

DescriptionField TypeField Name

This field is available in API version 18.0 and later.

Indicates whether this value is associated with a reviewed status (true),

or not (false). This field is only relevant for the standard Status

booleanreviewed

field in solutions. For more information about opportunities, see “Creating

Solutions” in the Salesforce online help. This field is available in API

version 16.0 and later.

Indicates whether this value is associated with a closed or won status

(true), or not (false). This field is only relevant for the standard

booleanwon

Stage field in opportunities. This field is available in API version 16.0

and later.

Declarative Metadata Sample Definition

For an example of CustomValue components within a GlobalValueSet component that’s referenced by a package.xml, see

GlobalValueSet.

Dashboard

Represents a dashboard. Dashboards are visual representations of data that allow you to see key metrics and performance at a glance.

This type extends the Metadata metadata type and inherits its fullName field. For more information, see “Edit Dashboards in

Accessibility Mode in Salesforce Classic” in the Salesforce online help.

Declarative Metadata File Suffix and Directory Location

Dashboards are stored in the dashboards directory of the corresponding package directory. The file name matches the dashboard

title and the extension is .dashboard.

Retrieving Dashboards

You can’t use the wildcard (*) symbol with dashboards in package.xml. To retrieve the list of dashboards for populating

package.xml with explicit names, call listMetadata() and pass in DashboardFolder as the type. Note that

DashboardFolder is not returned as a type in describeMetadata(). Dashboard is returned from describeMetadata()

with an associated attribute of inFolder set to true. If that attribute is set to true, you can construct the type by using the component

name with the word Folder, such as DashboardFolder.

The following example shows folders in package.xml:

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>MyDBFolder/MyDBName</members>

<name>Dashboard</name>

</types>

<types>

<members>MyDocumentFolder/MyDocumentName</members>

314

DashboardMetadata Types

<name>Document</name>

</types>

<types>

<members>unfiled$public/MarketingProductInquiryResponse</members>

<members>unfiled$public/SalesNewCustomerEmail</members>

<name>EmailTemplate</name>

</types>

<types>

<members>MyReportFolder/MyReportName</members>

<name>Report</name>

</types>

</Package>

Version

Dashboard components are available in API version 14.0 and later.

Fields

DescriptionField TypeField

Required. A dashboard can have a gradient color change on its

charts. This field defines the second color for the gradient and

stringbackgroundEndColor

backgroundStartColor defines the first color. If you

prefer your background to be all one color or do not want a

gradient color change, select the same color for this field and

backgroundStartColor. The color is in hexadecimal

format; for example #FF6600.

Required. The direction of the gradient color change, defined

by the backgroundStartColor and

backgroundEndColor fields. The valid values are:

ChartBackgroundDirection

(enumeration of type string)

backgroundFadeDirection

•diagonal

•leftToRight

•topToBottom

Required. The starting color for the gradient color change on

the dashboard's charts. See backgroundEndColor for

stringbackgroundStartColor

more information. The color is in hexadecimal format; for

example #FF6600.

The list of filters in a dashboard.

This field is available in API version 23.0 and later.

DashboardFilters[]dashboardFilters

315

DashboardMetadata Types

DescriptionField TypeField

Lists the included DashboardGridComponent objects, specifies

the number of dashboard columns, and sets each dashboard

row’s height in pixels.

This field is available in API version 35.0 and later.

DashboardGridLayoutdashboardGridLayout

Determines the way visibility settings are set for a dashboard.

The valid values are:

DashboardType (enumeration

of type string)

dashboardType

•SpecifiedUser—All users see data at the access level

of one specific running user, specified in the

runningUser field, regardless of their own security

settings.

•LoggedInUser—Each logged-in user sees data

according to his or her own access level.

•MyTeamUser—Managers can choose to view the

dashboard from the point of view of their subordinates in

the role hierarchy. This value is available in API version 20.0

and later.

This field is available in API version 19.0 and later.

Description for the dashboard. Maximum of 255 characters.stringdescription

Name of the folder that houses the dashboard.

This field is available in API version 35.0 and later.

stringfolderName

Inherited from Metadata, this field is not defined in the WSDL

for this metadata type. It must be specified when creating,

stringfullName

updating, or deleting. See create() to see an example of

this field specified for a call.

This field specifies the folder and dashboard title; for example

folderSales/California.

Specifies whether a dashboard uses the Lightning Experience

layout (true) or not (false).

Lightning Experience allows dashboards with more than three

columns with components that span multiple columns and

multiple rows in size.

booleanisGridLayout

This field is available in API version 35.0 and later.

Required. The left section or column of the dashboard.DashboardComponentSectionleftSection

The middle section or column of the dashboard.DashboardComponentSectionmiddleSection

Required. The right section or column of the dashboard.DashboardComponentSectionrightSection

316

DashboardMetadata Types

DescriptionField TypeField

The username of the user whose role and sharing settings are

used to determine the data shown in the dashboard.

When you deploy a dashboard and the value in this field is not

defined or does not correspond to a valid user, the field is

stringrunningUser

populated with the username of the user performing the

deployment.

Regardless of their security settings, all users viewing a

dashboard see exactly the same data, because dashboards are

always run using the security settings of a particular user.

Tip: To avoid inappropriate exposure of sensitive data,

save the dashboard to a folder that is visible only to

appropriate users.

Required. Color of the text on each chart in the dashboard. The

color is in hexadecimal format; for example #FF6600.

stringtextColor

Required. The dashboard title.stringtitle

Required. Color of the titles on each dashboard component. The

color is in hexadecimal format; for example #FF6600.

stringtitleColor

Required. Size of characters in title text. For example, a value of

12 indicates 12pt text.

inttitleSize

DashboardComponentSection

DashboardComponentSection represents one of the sections or columns in a dashboard.

DescriptionField TypeField

Required. The size of the column in the dashboard. See

DashboardComponentSize for details on valid values.

DashboardComponentSize

(enumeration of type string)

columnSize

The list of DashboardComponent objects in the dashboard

column.

DashboardComponent[]components

DashboardComponentSize

DashboardComponentSize is an enumeration of type string that lists different size categories. The valid values are listed in the table

below:

DescriptionEnumeration Value

Medium component size.medium

Smallest component size.narrow

Largest component size.wide

317

DashboardMetadata Types

DashboardComponent

A dashboard consists of a group of different components or elements that display data. Each component can use a custom report or a

custom s-control as their data source to display corporate metrics or key performance indicators. You can create several dashboard

components and display them all in one dashboard aligned in up to three columns.

DescriptionField TypeField

A manual or automatic axis range for bar or line charts.

The valid values are:

ChartRangeType (enumeration of type

string)

chartAxisRange

•auto

•manual

The maximum axis range to be displayed. This only applies

to bar and line charts in which the manual axis range

is selected for the chartAxisRange field.

doublechartAxisRangeMax

The minimum axis range to be displayed. This only applies

to bar and line charts in which the manual axis range

is selected for the chartAxisRange field.

doublechartAxisRangeMin

Specifies the summary field for the chart data. Required

if isAutoSelectFromReport is set to false.

This field is available in API version 25.0 and later.

ChartSummarychartSummary

Required. Dashboard component type. The valid values

are:

DashboardComponentType

(enumeration of type string)

componentType

•Bar

•BarGrouped

•BarStacked

•BarStacked100

•Column

•ColumnGrouped

•ColumnLine

•ColumnLineGrouped

•ColumnLineStacked

•ColumnLineStacked100

•ColumnStacked

•ColumnStacked100

•Donut

•Funnel

•Gauge

•Line

•lineCumulative

•LineGrouped

318

DashboardMetadata Types

DescriptionField TypeField

•lineGroupedCumulative

•Metric

•Pie

•Scatter

•ScatterGrouped

•Scontrol

•Table

A list of dashboard filter columns. Each report-based

component must have a dashboard filter column that

defines the column that the filter applies to.

This field is available in API version 23.0 and later.

DashboardFilterColumns[]dashboardFilterColumns

Represents a list of columns on a customized dashboard

table component.

DashboardTableColumn[]dashboardTableColumn

Chart Units. The valid values are:ChartUnits (enumeration of type

string)

displayUnits

•Auto

•Integer

•Hundreds

•Thousands

•Millions

•Billions

•Trillions

For charts, specifies a URL that users go to when they click

the dashboard component. Use this option to send users

stringdrillDownUrl

to another dashboard, report, record detail page, or other

system that uses a Web interface. This field overrides the

drillEnabled and drillToDetailEnabled

fields.

Specifies whether to take users to the full or filtered source

report when they click the dashboard component. Set to

booleandrillEnabled

false to drill to the full source report; set to true to

drill to the source report filtered by what they clicked. If

set to true, users can click individual groups, axis values,

or legend entries.

This overrides the drillToDetailEnabled field.

This field is available in API version 17.0 and later.

When enabled, users are taken to the record detail page

when they click a record name, record owner, or feed post

booleandrillToDetailEnabled

in a table or chart. When set to true users can click axis

319

DashboardMetadata Types

DescriptionField TypeField

and legend values, chart elements, and table entries. The

drillDownUrl and drillEnabled fields override

this field. This field is available in API version 20.0 and later.

Specifies whether to display values, labels, and

percentages when hovering over charts. Hover details

booleanenableHover

depend on chart type. Percentages apply to pie, donut,

and funnel charts only. This field is available in API version

17.0 and later.

Specifies whether to combine all groups less than or equal

to 3% of the total into a single 'Others' wedge or segment.

booleanexpandOthers

This only applies to pie, donut, and funnel charts. Set to

true to show all values individually on the chart; set to

false to combine small groups into 'Others.' This field

is available in API version 17.0 and later.

Footer displayed at the bottom of the dashboard

component. Maximum of 255 characters.

stringfooter

The maximum value on a gauge. A gauge is used to see

how far you are from reaching a goal. It looks like a

speedometer in a car.

doublegaugeMax

The minimum value on a gauge.doublegaugeMin

Specifies the field by which to group data. This data is

displayed on the X-axis for vertical column charts and on

the Y-axis for horizontal bar charts.

This field is available in API version 25.0 and later.

stringgroupingColumn

Header displayed at the top of the dashboard component.

Maximum of 80 characters.

stringheader

The value that separates the indicatorLowColor

from the indicatorMiddleColor on the

dashboard.

doubleindicatorBreakpoint1

The value that separates the

indicatorMiddleColor from the

indicatorHighColor on the dashboard.

doubleindicatorBreakpoint2

The color representing a high number range on the

gauge.

stringindicatorHighColor

The color representing a low number range on the gauge.stringindicatorLowColor

The color representing a medium number range on the

gauge.

stringindicatorMiddleColor

320

DashboardMetadata Types

DescriptionField TypeField

The location of the legend with respect to the chart. The

valid values are:

ChartLegendPosition (enumeration of

type string)

legendPosition

•Bottom

•OnChart

•Right

The maximum number of elements to include in the

top-level grouping of the horizontal axis of a horizontal

intmaxValuesDisplayed

chart, vertical axis of a vertical chart, or selected axis of a

stacked bar chart. For example, if you want to list only

your top five salespeople, create an opportunity report

that lists total opportunity amounts by owner and enter

5 in this field.

Descriptive label for the metric. This is relevant if metric

is the value of the componentType field.

stringmetricLabel

Visualforce page associated with the component.stringpage

Display height of the Visualforce page in pixels.intpageHeightInPixels

Name of the report associated with the component.stringreport

S-control associated with component if scontrol is

the value of the componentType field. For more

stringscontrol

information, see “Defining Custom S-Controls” in the

Salesforce online help.

Display height of the s-control in pixels.intscontrolHeightInPixels

Indicates if percentages are displayed for regions of

gauges and wedges and segments of pie, donut, and

funnel charts (true), or not (false).

booleanshowPercentage

Display Chatter photos for up to 20 records in a horizontal

bar chart component whose source report is grouped by

booleanshowPicturesOnCharts

a user or group name field. If there are more than 20

records with photos, record names are shown instead of

photos. Set Grouping Display to None to show

photos. Set the Drill Down to option to Record

Detail Page to take users directly to user profile or

group pages when they click photos. Chatter must be

enabled for photos to be displayed. Depending on your

organization's setup, you may not see photos on tables

and charts.

Display Chatter photos for up to 20 records in a horizontal

bar chart component whose source report is grouped by

booleanshowPicturesOnTables

a user or group name field. If there are more than 20

records with photos, record names are shown instead of

321

DashboardMetadata Types

DescriptionField TypeField

photos. Set Grouping Display to None to show

photos. Set the Drill Down to option to Record

Detail Page to take users directly to user profile or

group pages when they click photos. Chatter must be

enabled for photos to be displayed. Depending on your

organization's setup, you may not see photos on tables

and charts.

Indicates if the total of all wedges is displayed for gauges

and donut charts (true), or not (false).

booleanshowTotal

Indicates if the values of individual records or groups are

displayed for charts (true), or not (false).

booleanshowValues

The sort option for the dashboard component.DashboardComponentFilter

(enumeration of type string)

sortBy

The title of the dashboard component. Maximum of 40

characters.

stringtitle

Specifies whether to use the chart defined in the source

report on this dashboard component. The chart settings

booleanuseReportChart

in the source report determine how the chart displays in

the dashboard, and any chart settings you define for the

dashboard are overridden. If you defined a combination

chart in the source report, use this option to use that

combination chart on this dashboard.

DashboardFilters

DashboardFilters represents a filter in a dashboard.

DescriptionField TypeField

The list of items you can select in the Filter Options

section of the Add Filter dialog.

DashboardFilterOptions[]dashboardFilterOptions

Required. The filter label.stringname

DashboardFilterColumns

DashboardFilterColumns represents a filter column in a dashboard.

DescriptionField TypeField

Required. The report column code for the filter.stringcolumn

322

DashboardMetadata Types

DashboardFilterOptions

DashboardFilterOptions represents a filter option in a dashboard.

DescriptionField TypeField

Required. Represents the filter operation for this filter item. Valid

values are enumerated in DashboardFilterOperation. This field

is available in API version 24.0 and later.

With API version 23.0, valid values are enumerated in

FilterOperation.

DashboardFilterOperation

(enumeration of type string)

operator

Required. The value in the Filter Options area of the

Add Filter dialog. This field is available in API version 23.0.

stringvalue

Required. One or more values in the Filter Options area

of the Add Filter dialog. This field is available in API version

24.0 and later.

string[]values

DashboardFilterOperation

This is an enumeration of type string that lists dashboard filter operations. Valid values are:

•equals

•notEqual

•lessThan

•greaterThan

•lessOrEqual

•greaterOrEqual

•contains

•notContain

•startsWith

•includes

•excludes

•between

Note: The “between” operator takes two operands (for example, “between MinimumValue, MaximumValue”). Note also that

the minimum value is inclusive, while the maximum value is exclusive. All other dashboard filter operations take a single

operand only.

DashboardTableColumn

DashboardTableColumn represents a column in a customized table component in a dashboard.

323

DashboardMetadata Types

DescriptionField TypeField

Specifies the aggregation type for the table column.ReportSummaryType[]

(enumeration of type string)

aggregateType

Required. The label of the column to use in the table.stringcolumn

Displays the totals for each summarizable column in the

dashboard table. This field is available in API version 19.0 and

later.

booleanshowTotal

The sort option for the dashboard table component. Sort on just

one column per table.

DashboardComponentFilter

(enumeration of type string)

sortBy

DashboardComponentFilter

DashboardComponentFilter is an enumeration of type string that lists the sort values for dashboard components. The valid values are:

DescriptionEnumeration Value

Sorts in alphabetical order by the label.RowLabelAscending

Sorts in reverse alphabetical order by the label.RowLabelDescending

Sorts lowest to highest by the value.RowValueAscending

Sorts highest to lowest by the value.RowValueDescending

DashboardGridComponent

Lightning Experience features dashboards with more than three columns and components that span multiple columns and multiple

rows in size. DashboardGridComponent specifies location and size of a given dashboard component.

DescriptionField TypeField

Required. The width of the dashboard component in columns.

For example, if colSpan is 5, then the dashboard component

spans five columns.

intcolSpan

Required. The left-most column that is occupied by the

dashboard component.

intcolumnIndex

Required. The dashboard component that is being sized and

placed.

DashboardComponentdashboardComponent

Required. The top-most row that is occupied by the dashboard

component.

introwIndex

Required. The height of the dashboard component in rows.introwSpan

324

DashboardMetadata Types

DashboardGridLayout

Lightning Experience features dashboards with more than three columns and components that span multiple columns and multiple

rows in size. DashboardGridLayout lists the included dashboard components, specifies the number of dashboard columns, and sets each

dashboard row’s height in pixels.

DescriptionField TypeField

List of DashboardGridComponent objects in the dashboard.DashboardGridComponent[]dashboardGridComponents

Required. Total number of columns in the dashboard.intnumberOfColumns

Required. Height of each row in pixels.introwHeight

Declarative Metadata Sample Definition — Filtered Dashboard

A sample XML definition of a filtered dashboard is shown below. Note that this example is supported in API version 24.0 and later. The

file name matches the dashboard title and the extension is .dashboard.

<?xml version="1.0" encoding="UTF-8"?>

<backgroundEndColor>#FFFFFF</backgroundEndColor>

<backgroundFadeDirection>Diagonal</backgroundFadeDirection>

<backgroundStartColor>#FFFFFF</backgroundStartColor>

<operator>equals</operator>

<values>Media</values>

</dashboardFilterOptions>

<operator>lessThan</operator>

<values>Working</values>

</dashboardFilterOptions>

<operator>between</operator>

</dashboardFilterOptions>

<name>Industry</name>

</dashboardFilters>

<operator>equals</operator>

<values>Analyst,Partner</values>

</dashboardFilterOptions>

<operator>startsWith</operator>

<values>Integrator</values>

</dashboardFilterOptions>

<name>Account Type</name>

</dashboardFilters>

<dashboardType>SpecifiedUser</dashboardType>

325

DashboardMetadata Types

<columnSize>Medium</columnSize>

<column>INDUSTRY</column>

</dashboardFilterColumns>

</dashboardFilterColumns>

<drillEnabled>false</drillEnabled>

<drillToDetailEnabled>false</drillToDetailEnabled>

<enableHover>false</enableHover>

<expandOthers>false</expandOthers>

<legendPosition>Bottom</legendPosition>

<report>unfiled$public/SampleReportofAccounts</report>

<showPercentage>false</showPercentage>

<showPicturesOnCharts>false</showPicturesOnCharts>

<showValues>false</showValues>

<sortBy>RowLabelAscending</sortBy>

<useReportChart>false</useReportChart>

</components>

</leftSection>

<columnSize>Medium</columnSize>

<componentType>Funnel</componentType>

<column>ACCOUNT_INDUSTRY</column>

</dashboardFilterColumns>

<column>ACCOUNT.TYPE</column>

</dashboardFilterColumns>

<drillEnabled>false</drillEnabled>

<drillToDetailEnabled>false</drillToDetailEnabled>

<enableHover>false</enableHover>

<expandOthers>false</expandOthers>

<legendPosition>Bottom</legendPosition>

<report>unfiled$public/SampleReportofCases</report>

<showPercentage>false</showPercentage>

<sortBy>RowLabelAscending</sortBy>

<useReportChart>false</useReportChart>

</components>

</middleSection>

<columnSize>Medium</columnSize>

<componentType>Column</componentType>

326

DashboardMetadata Types

<column>INDUSTRY</column>

</dashboardFilterColumns>

<column>ACCOUNT_TYPE</column>

</dashboardFilterColumns>

<drillEnabled>false</drillEnabled>

<drillToDetailEnabled>false</drillToDetailEnabled>

<enableHover>false</enableHover>

<expandOthers>false</expandOthers>

<legendPosition>Bottom</legendPosition>

<report>unfiled$public/SampleReportofOpportunities</report>

<showPercentage>false</showPercentage>

<showValues>false</showValues>

<sortBy>RowLabelAscending</sortBy>

<useReportChart>false</useReportChart>

</components>

</rightSection>

<runningUser>admin@TESTORGNUM</runningUser>

<title>My Dashboard</title>

</Dashboard>

Declarative Metadata Sample Definition — Unfiltered Dashboard

A sample XML definition of a dashboard is shown below. The file name matches the dashboard title and the extension is .dashboard.

<?xml version="1.0" encoding="UTF-8"?>

<backgroundEndColor>#FFFFFF</backgroundEndColor>

<backgroundFadeDirection>LeftToRight</backgroundFadeDirection>

<backgroundStartColor>#FFFFFF</backgroundStartColor>

<description>Dashboard with all possible chart types</description>

<columnSize>Medium</columnSize>

<componentType>BarStacked100</componentType>

<report>testFolder/sourceRep</report>

<sortBy>RowLabelAscending</sortBy>

</components>

<componentType>Table</componentType>

<column>CLOSE_DATE</column>

<sortBy>RowLabelAscending</sortBy>

</dashboardTableColumn>

327

DashboardMetadata Types

<column>AMOUNT</column>

</dashboardTableColumn>

<column>STAGE_NAME</column>

</dashboardTableColumn>

<column>PROBABILITY</column>

<aggregateType>Maximum</aggregateType>

</dashboardTableColumn>

<displayUnits>Integer</displayUnits>

<header>Opportunities Table</header>

<report>testFolder/sourceRep</report>

</components>

<report>testFolder/sourceRep</report>

<sortBy>RowLabelAscending</sortBy>

</components>

<componentType>Column</componentType>

<legendPosition>Bottom</legendPosition>

<report>testFolder/sourceRep</report>

<sortBy>RowLabelAscending</sortBy>

</components>

<componentType>Funnel</componentType>

<legendPosition>Bottom</legendPosition>

<report>testFolder/sourceRep</report>

<sortBy>RowLabelAscending</sortBy>

</components>

</leftSection>

<columnSize>Medium</columnSize>

<componentType>ColumnStacked100</componentType>

328

DashboardMetadata Types

<report>testFolder/sourceRep</report>

<sortBy>RowLabelAscending</sortBy>

</components>

<componentType>ColumnStacked</componentType>

<report>testFolder/sourceRep</report>

<sortBy>RowLabelAscending</sortBy>

</components>

<componentType>ColumnStacked</componentType>

<report>testFolder/sourceRep</report>

<sortBy>RowLabelAscending</sortBy>

</components>

<componentType>ColumnGrouped</componentType>

<report>testFolder/sourceRep</report>

<sortBy>RowLabelAscending</sortBy>

</components>

<componentType>Column</componentType>

<report>testFolder/sourceRep</report>

<sortBy>RowLabelAscending</sortBy>

</components>

</middleSection>

<columnSize>Medium</columnSize>

<report>testFolder/sourceRep</report>

<sortBy>RowLabelAscending</sortBy>

</components>

329

DashboardMetadata Types

<report>testFolder/sourceRep</report>

<sortBy>RowLabelAscending</sortBy>

</components>

<componentType>LineGroupedCumulative</componentType>

<report>testFolder/sourceRep</report>

<sortBy>RowLabelAscending</sortBy>

</components>

<componentType>LineGrouped</componentType>

<report>testFolder/sourceRep</report>

<sortBy>RowLabelAscending</sortBy>

</components>

<componentType>LineCumulative</componentType>

<report>testFolder/sourceRep</report>

<sortBy>RowLabelAscending</sortBy>

</components>

<componentType>Donut</componentType>

<report>testFolder/sourceRep</report>

<sortBy>RowLabelAscending</sortBy>

</components>

</rightSection>

<runningUser>admin@TESTORGNUM</runningUser>

<title>Db Title</title>

</Dashboard>

330

DashboardMetadata Types

Declarative Metadata Sample Definition — Lightning Experience Dashboard

with isGridLayout Equals true

A sample XML definition of a Lightning Experience dashboard with isGridLayout equals true is shown below. Note that this

example is supported in API version 35.0 and later. The file name matches the dashboard title and the extension is .dashboard.

<?xml version="1.0" encoding="UTF-8"?>

<backgroundEndColor>#FFFFFF</backgroundEndColor>

<backgroundFadeDirection>Diagonal</backgroundFadeDirection>

<backgroundStartColor>#FFFFFF</backgroundStartColor>

<dashboardType>SpecifiedUser</dashboardType>

<autoselectColumnsFromReport>false</autoselectColumnsFromReport>

<column>RowCount</column>

</chartSummary>

<componentType>Donut</componentType>

<drillEnabled>false</drillEnabled>

<drillToDetailEnabled>false</drillToDetailEnabled>

<enableHover>false</enableHover>

<expandOthers>false</expandOthers>

<groupingColumn>TITLE</groupingColumn>

<legendPosition>Bottom</legendPosition>

<report>unfiled$public/lead_rpt</report>

<showPercentage>false</showPercentage>

<showTotal>false</showTotal>

<sortBy>RowLabelAscending</sortBy>

<useReportChart>false</useReportChart>

</dashboardComponent>

</dashboardGridComponents>

<autoselectColumnsFromReport>false</autoselectColumnsFromReport>

<column>RowCount</column>

</chartSummary>

<drillEnabled>false</drillEnabled>

<drillToDetailEnabled>false</drillToDetailEnabled>

<enableHover>false</enableHover>

331

DashboardMetadata Types

<expandOthers>false</expandOthers>

<groupingColumn>TITLE</groupingColumn>

<legendPosition>Bottom</legendPosition>

<report>unfiled$public/lead_rpt</report>

<showPercentage>false</showPercentage>

<sortBy>RowLabelAscending</sortBy>

<useReportChart>false</useReportChart>

</dashboardComponent>

</dashboardGridComponents>

<autoselectColumnsFromReport>false</autoselectColumnsFromReport>

<column>RowCount</column>

</chartSummary>

<componentType>Column</componentType>

<drillEnabled>false</drillEnabled>

<drillToDetailEnabled>false</drillToDetailEnabled>

<enableHover>false</enableHover>

<expandOthers>false</expandOthers>

<groupingColumn>TITLE</groupingColumn>

<legendPosition>Bottom</legendPosition>

<report>unfiled$public/lead_rpt</report>

<showPercentage>false</showPercentage>

<showValues>false</showValues>

<sortBy>RowLabelAscending</sortBy>

<useReportChart>false</useReportChart>

</dashboardComponent>

</dashboardGridComponents>

</gridLayout>

<runningUser>admin@s1.com</runningUser>

</Dashboard>

SEE ALSO:

Folder

Report

332

DashboardMetadata Types

DataCategoryGroup

Represents a data category group.

This type extends the Metadata metadata type and inherits its fullName field.

Warning: Using Metadata API to deploy category changes from one organization to another permanently removes categories

and record categorizations that are not specified in your XML file. Salesforce recommends that you manually create data categories

and record associations in an organization from Setup by entering Data Categories in the Quick Find box, then

selecting Data Categories rather than deploying changes from a sandbox to a production organization. For more information,

see Usage.

Data category groups are provided to:

•Classify and filter data.

•Share data among users.

Every data category group contains items or data categories that can be organized hierarchically.

The example below shows the Geography data category group and its data categories.

Geography

Worldwide

North America

United States of America

Canada

Mexico

Europe

Asia

Note: See "Data Categories in Salesforce.com" in the Salesforce online help for more information on data category groups, data

categories, parent and sub categories.

File Suffix and Directory Location

The file suffix is .datacategorygroup. There is one file for each data category group stored in the datacategorygroups

folder in the corresponding package directory.

Version

Data category groups are available in API version 18.0 and later.

Fields

This metadata type contains the following fields:

DescriptionField TypeField Name

Required. The status of the category group. Indicates whether this

category group is active, (true), or not active (false).

booleanactive

Required. The top-level category within the data category group.DataCategorydataCategory

333

DataCategoryGroupMetadata Types

DescriptionField TypeField Name

The description of the data category group.stringdescription

Required. The unique name of the data category group. When creating

a data category group, the fullName field and the file name (without

stringfullName

its suffix) must match.The fullName can contain only underscores

and alphanumeric characters. It must be unique, begin with a letter, not

include spaces, not end with an underscore, and not contain two

consecutive underscores. This field is inherited from the Metadata

component.

Required. Label that represents the object in Salesforce.stringlabel

The objects that are associated with the data category group.ObjectUsageobjectUsage

DataCategory

Represents an item (or data category) in the data category group. A data category can recursively contain a list of other data categories.

DescriptionField TypeField Name

A recursive list of sub data categories. For example, a list of countries

within a continent. You can create up to 100 categories in a data category

group and have up to 5 levels in a data category group hierarchy.

DataCategory[]dataCategory

Required. Label for the data category throughout the Salesforce user

interface.

stringlabel

Required. The developer name of the data category used as a unique

identifier for API access. The name can only contain characters, letters,

stringname

and the underscore (_) character, must start with a letter, and cannot

end with an underscore or contain two consecutive underscore

characters.

Important: The value for this field is defined once and cannot

be changed later.

Warning: If you deploy a category group that already exists in

an organization, any category that is not defined in the XML file

is permanently removed from your organization. For more

information see Usage.

ObjectUsage

Represents the objects that can be associated with the data category group. This association allows the object to be classified and filtered

using the data categories.

334

DataCategoryGroupMetadata Types

DescriptionField TypeField Name

A list of the object names that can be associated with the data category

group. Valid values are:

string[]object

•KnowledgeArticleVersion—to associate articles. See

"Modify Default Category Group Assignments for Articles" in the

Salesforce online help for more information on data category groups

association to articles.

•Question—to associate questions. You can associate the

Question object with at most one category group. See "Assigning

Data Categories to Answers" in the Salesforce online help for more

information on data category groups association to questions.

Warning: If you deploy a category group that already exists in

an organization, any object association that is not defined in the

XML file is permanently removed from your organization. Ensure

that your XML file specifies all the records associated with your

category group in the organization. For more information see

Usage.

Declarative Metadata Sample Definition

This sample is the definition of the Geography data category group and its data categories:

<?xml version="1.0" encoding="UTF-8"?>

<label>Geography</label>

<description>Geography structure of service center locations</description>

<dataCategory><name>WW</name><label>Worldwide</label>

<dataCategory><name>AMER</name><label>North America</label>

<label>United States of America</label>

</dataCategory>

<label>Canada</label>

</dataCategory>

<label>Mexico</label>

</dataCategory>

<dataCategory><name>EMEA</name><label>Europe, Middle East, Africa</label>

<label>France</label>

</dataCategory>

335

DataCategoryGroupMetadata Types

<label>Spain</label>

</dataCategory>

<label>United-Kingdom</label>

</dataCategory>

</dataCategory>

</DataCategoryGroup>

Usage

When you deploy a category group XML file, Metadata API checks whether the category group exists in the target organization. If the

category group does not exist, it is created. If the category group already exists, then Metadata API:

•Adds any new category or object defined in the XML file.

•Deletes any category that is not defined in the XML file. Records associated with the deleted categories are re-associated with the

parent category.

•Deletes any object association that is not defined in the XML file.

•Moves any category if its hierarchical position differs from the position specified in the XML file.

Note: When a category moves to a new parent category, users that have no visibility on the new parent category lose their

visibility to the repositioned category.

Note: For more information about category deletion, category repositioning and its impact on record categorization and visibility

see "Delete a Data Category" and "Modify and Arrange Data Categories" in the Salesforce online help.

Using Metadata API to deploy category changes from one organization to another permanently removes categories and record

categorizations that are not specified in your XML file. Salesforce recommends that you manually create data categories and record

associations in an organization from Setup by entering Data Categories in the Quick Find box, then selecting Data

Categories rather than deploying changes from a sandbox to a production organization.

The following example illustrates what happens if you deploy an XML representation of a Geography data category group hierarchy

to an organization that already has this data category group defined. Note that the organization contains a US category, while the XML

file includes a USA category in the same hierarchical position. The Metadata API deployment process deletes the US category from

the organization and moves associations for any records from US to the parent AMER category. It also adds the USA category under

AMER. Note that all records that were previously categorized with US are now associated with the AMER category.

336

DataCategoryGroupMetadata Types

The next example illustrates what can happen when you delete or move a category in a data category group and deploy its XML

representation from a sandbox to a production organization that already has this data category group defined. Hierarchy 1 shows the

initial data category group in the sandbox organization. In hierarchy 2, we add an EU category under EMEA and move FR, SP and

UK below EU. In hierarchy 3, we delete FR and associate its records with its new parent, EU. Finally, we deploy the changes from the

sandbox to the production organization.

337

DataCategoryGroupMetadata Types

Metadata API has no concept of the order of the changes made to the sandbox organization. It just deploys the changes from one

organization to another. During the deployment, it first notices the deletion of the FR category and removes it from the production

organization. Consequently, it moves associations for any records from FR to its parent on the production organization, EMEA. Metadata

API then adds the EU category and moves SP and UK below it. Although the category group hierarchy looks the same in both

organizations, record categorization in production is different from the sandbox organization. The records that were originally associated

with FR in hierarchy 1 are associated with EU in the sandbox organization, but are associated with EMEA in the production organization.

DelegateGroup

Represents a group of users who have the same administrative privileges. These groups are different from public groups used for sharing.

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

DelegateGroup components have the suffix .delegateGroup and are stored in the delegateGroups folder. The file prefix

must match the developer name of the delegate group. For example, a delegate group with a developer name of MyDelegateGroup

would have a file name of MyDelegateGroup.delegateGroup.

Version

DelegateGroup components are available in API version 36.0 and later.

Special Access Rules

Only users with the “View Setup and Configuration” permission can be delegated administrators.

338

DelegateGroupMetadata Types

Fields

DescriptionField TypeField Name

The custom objects associated with the group. Delegated administrators

can customize nearly every aspect of each of those custom objects,

string[]customObjects

including creating a custom tab. However, they cannot create or modify

relationships on the objects or set organization-wide sharing defaults.

Delegated administrators must have access to custom objects to access

the merge fields on those objects from formulas.

The groups with users assigned by delegated administrators.string[]groups

Required. The delegated group’s non-API name.stringlabel

Required. Allows users in this group to log in as users in the role hierarchy

that they administer (true) or not (false). Depending on your

booleanloginAccess

organization settings, individual users must grant login access to allow

their administrators to log in as them.

The permission sets assignable to users in specified roles and all

subordinate roles by delegated administrators.

string[]permissionSets

The profiles assignable to users by delegated administrators.string[]profiles

The roles and subordinates for which delegated administrators of the

group can create and edit users.

string[]roles

Declarative Metadata Sample Definition

The following is an example of a DelegateGroup component.

<?xml version="1.0" encoding="UTF-8"?>

<label>MyDelegateGroup</label>

<name>MyDelegateGroup</name>

<profiles>Chatter Free User</profiles>

<profiles>Chatter Moderator User</profiles>

<profiles>Marketing User</profiles>

<permissionSets>My Permset</permissionSets>

<roles>LesserBossMan</roles>

</DelegateGroup>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>DelegateGroup</name>

</types>

</Package>

339

DelegateGroupMetadata Types

Document

Represents a Document. All documents must be in a document folder, for example sampleFolder/TestDocument. This type

extends the MetadataWithContent metadata type and inherits its content and fullName fields.

Currently, users are not able to export document metadata to a local file system using the Force.com IDE.

Retrieving Documents

You can’t use the wildcard (*) symbol with documents in package.xml. To retrieve the list of documents for populating

package.xml with explicit names, call listMetadata() and pass in DocumentFolder as the type. Note that DocumentFolder

is not returned as a type in describeMetadata(). Document is returned from describeMetadata() with an associated

attribute of inFolder set to true. If that attribute is set to true, you can construct the type by using the component name with the

word Folder, such as DocumentFolder.

The following example shows folders in package.xml:

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>MyDBFolder/MyDBName</members>

<name>Dashboard</name>

</types>

<types>

<members>MyDocumentFolder/MyDocumentName</members>

<name>Document</name>

</types>

<types>

<members>unfiled$public/MarketingProductInquiryResponse</members>

<members>unfiled$public/SalesNewCustomerEmail</members>

<name>EmailTemplate</name>

</types>

<types>

<members>MyReportFolder/MyReportName</members>

<name>Report</name>

</types>

</Package>

For each document an accompanying metadata file named DocumentFilename-meta.xml is created in the document folder.

For example, for a document TestDocument.png in the sampleFolder folder, there’s a TestDocument.png-meta.xml in

the documents/sampleFolder of the package.

Version

Documents are available in API version 10.0 and later.

In API version 17.0 and later, you can delete a folder containing documents moved to the Recycle Bin. When you delete the folder, any

related documents in the Recycle Bin are permanently deleted.

In API version 18.0 and later, documents do not need an extension.

340

DocumentMetadata Types

Fields

This metadata type contains the following fields:

DescriptionField TypeField Name

Content of the document. Base 64-encoded binary data. Prior to making

an API call, client applications must encode the binary attachment data

base64content

as base64. Upon receiving a response, client applications must decode

the base64 data to binary. This conversion is usually handled for you by

a SOAP client. This field is inherited from the MetadataWithContent

component.

A description of the document. Enter a description to distinguish this

document from others.

stringdescription

The name of the document, including the folder name. In version 17.0

and earlier, the fullName included the document extension. In version

stringfullName

18.0 and later, the fullName does not include the file extension. The

fullName can contain only underscores and alphanumeric characters.

It must be unique, begin with a letter, not include spaces, not end with

an underscore, and not contain two consecutive underscores. If this field

contained characters before version 14.0 that are no longer allowed, the

characters were stripped out of this field, and the previous value of the

field was saved in the name field. This field is inherited from the Metadata

component.

Required. Indicates whether the document is confidential (true) or not

(false). This field and public are mutually exclusive; you cannot

set both to true.

booleaninternalUseOnly

Contains one or more words that describe the document. A check for

matches to words in this field is performed when doing a search.

stringkeywords

The list of characters allowed in the fullName field has been reduced

for versions 14.0 and later. This field contains the value contained in the

stringname

fullName field before version 14.0. This field is only populated if the

value of the fullName field contained characters that are no longer

accepted in that field.

Required. Indicates whether the document is an image available for

HTML email templates and does not require a Salesforce username and

booleanpublic

password to view in an email (true) or not (false). If the images will

be used as a custom app logo or custom tab icon, both of which require

a Salesforce username and password to view, set this field to false.

This field and internalUseOnly are mutually exclusive; you cannot

set both to true.

341

DocumentMetadata Types

Declarative Metadata Sample Definition

The following is the definition of a document:

<?xml version="1.0" encoding="UTF-8"?>

<internalUseOnly>false</internalUseOnly>

<name>Q2 Campaign Analysis</name>

<public>false</public>

<description>Analyze Q2 campaign effectiveness</description>

</Document>

SEE ALSO:

Folder

DuplicateRule

Represents a rule that specifies how duplicate records in an object are detected. This type extends the Metadata metadata type and

inherits its fullName field.

File Suffix and Directory Location

DuplicateRule components have the .duplicateRule suffix and are stored in the duplicateRules/ directory. The name

of the component file is based on the name of the object associated with the rule. For example, the component file name

duplicateRules/Account.Standard_Account_Duplicate_Rule.duplicateRule describes a duplicate rule

component associated with the Account object.

Version

DuplicateRule components are available in API version 39.0 and later.

Fields

DescriptionField TypeField Name

Required. Determines what the duplicate rule does when users or the

DuplicateRule API try to insert a record that is a duplicate. Valid values

are:

Allow

For users, if operationsOnInsert is set to alert, the UI

displays the value of alertText in a dialog. The dialog prompts

DupeActionType

(enumeration of

type string)

actionOnInsert

users to continue or cancel. If the user chooses to continue, the

insertion proceeds. If the user chooses to cancel, the record isn’t

inserted.

342

DuplicateRuleMetadata Types

DescriptionField TypeField Name

The DuplicateRule API returns an error code and a message. To

complete the insertion, the code must set the allowSave field

in DuplicateRuleHeader to true and reissue the request.

If operationsOnInsertisn’t set to alert, the UI inserts the

record without issuing an alert. The API inserts the record and doesn’t

return an error code.

Block

For users, the UI displays an error message and prevents them from

inserting the new record. The DuplicateRule API returns an error and

doesn’t insert the record.

Required. Determines what the duplicate rule does when users or the

DuplicateRule API try to update a record, and the result is a duplicate.

Valid values are:

Allow

For users, if operationsOnUpdate is set to alert, the UI

displays the value of alertText in a dialog. The dialog prompts

DupeActionType

(enumeration of

type string)

actionOnUpdate

users to continue or cancel. If the user chooses to continue, the

update proceeds. If the user chooses to cancel, the record isn’t

updated.

The DuplicateRule API returns a message. To complete the update,

the code must set the allowSave field in DuplicateRuleHeader

to true and reissue the request.

If operationsOnUpdateisn’t set to alert, the UI updates

the record without issuing an alert. The API updates the record and

doesn’t return an error code.

Block

For users, the UI displays an error message and prevents them from

continuing. The DuplicateRule API returns an error.

Text that’s sent when the duplicate rule is triggered. The text is only sent

if isActive is true. In the UI, the text displays as a message. The

DuplicateRule API returns the message in its response.

You can set a value for alertText only when you have

actionOnInsert or actionOnUpdate (or both) set to Allow.

stringalertText

Otherwise, you receive a validation error when you add or update this

component.

Required. Text that describes the duplicate rule. The value is

customer-supplied, but is not visible in the UI.

stringdescription

Required. Criteria that define how to find records to consider when

looking for duplicates. For example, use duplicateRuleFilter

to exclude records from the match when looking for duplicates.

DuplicateRuleFilterduplicateRuleFilter

343

DuplicateRuleMetadata Types

DescriptionField TypeField Name

Required. One or more MatchingRule components for the DuplicateRule.

A MatchingRule controls what constitutes a match between records.

DuplicateRuleMatchRule[]duplicateRuleMatchRules

Required. If true, the DuplicateRule detects duplicate records.

Otherwise, the rule has no effect.

booleanisActive

Required. Master label for this DuplicateRule. This value is the internal

label for the rule.

stringmasterLabel

Required. Controls the action to take when actionOnInsert is set

to Allow and the duplicate rule is triggered. Either one or both of

these values can be set in the array:

alert

If set, the action specified in actionOnInsert occurs; otherwise,

the insert proceeds.

string[]operationsOnInsert

report

If set, the insert operation is added to the report of duplicates.

Required. Controls the action to take when actionOnUpdate is set

to Allow and the duplicate rule is triggered. Either one or both of

these values can be set in the array:

alert

If set, the action specified in actionOnUpdate occurs; otherwise,

the update proceeds.

string[]operationsOnUpdate

report

If set, the update operation is added to the report of duplicates.

Required. Determines how record sharing rules affect duplicate

management. Valid values are:

EnforceSharingRules

Sharing rules affect duplicate management. If a duplicate rule is

triggered because an insert or update duplicates an existing record,

DupeSecurityOptionType

(enumeration of

type string)

securityOption

but the running user doesn’t have sharing access to that record, the

insert or update proceeds. The sharing rule doesn’t prevent the user

from creating or updating the record because the record is hidden

from the user. No message is issued.

BypassSharingRules

Sharing rules don’t affect duplicate management. If a duplicate rule

is triggered because an insert or update duplicates an existing record,

sharing rules are ignored, but other access restrictions apply.

Required. Determines the order in which duplicate rules are applied.intsortOrder

DuplicateRuleMatchRule

Describes the MatchingRule associated with the DuplicateRule. The MatchingRule identifies duplicate records.

344

DuplicateRuleMetadata Types

DescriptionField TypeField Name

Required. The name of the target object of the matching rule. For

example, if you define a duplicate rule for Contact records, and you want

stringmatchRuleSObjectType

to match with Lead records, the value of matchRuleSObjectType

is Lead.

Required. Value that corresponds to the value of developerName

in the MatchingRule for this duplicate rule.

stringmatchingRule

Required. Foreign key to an ObjectMapping that maps fields from the

duplicate rule’s object to fields in the target object specified by

matchRuleSObjectType.

ObjectMappingobjectMapping

DuplicateRuleFilter

Specifies filter criteria for a DuplicateRule. Salesforce only applies the DuplicateRule if the record matches the criteria.

DescriptionField TypeField Name

Required. A string of boolean operators that establishes the filter logic

for the filter items specified in duplicateRuleFilterItems.

stringbooleanFilter

Required. A list of DuplicateRuleFilterItem components.DuplicateRuleFilterItem[]duplicateRuleFilterItems

DuplicateRuleFilterItem

This type extends the FilterItem type and inherits all its fields.

DescriptionField TypeField Name

Required. The order of this item in the duplicate rule filter.intsortOrder

Required. The object that has the field specified in the field field of

DuplicateRuleFilterItem. See the documentation for FilterItem for the

definition of field.

stringtable

ObjectMapping

Represents a map of fields in the input object of the DuplicateRule to fields in the output object of DuplicateRule. The input object is

the object associated with the DuplicateRule. The output object can be the same object or a different object with similar fields.

For example, you can have a DuplicateRule that looks for duplicates between the Contact object and the Lead object. In this case, the

input object is Contact, and the output object is Lead.

DescriptionField TypeField Name

Required. The input object for the duplicate rule. The DuplicateRule is

associated with this object. For example, if you define a duplicate rule

stringinputObject

345

DuplicateRuleMetadata Types

DescriptionField TypeField Name

for Contact records, and you want to match with Lead records, the value

of inputObject is Contact.

Required. The mapping of source object fields to target object fields for

the duplicate rule.

ObjectMappingField[]mappingFields

Required. The output object for the duplicate rule. This value is the same

as the value of the matchRuleSObjectType field in

stringoutputObject

DuplicateRuleMatchRule. Any duplicate rules that this object has are

ignored when the DuplicateRule API uses the ObjectMapping.

ObjectMappingField

A field name in the input object of the DuplicateRule, and the corresponding field name in the output object.

DescriptionField TypeField Name

Required. Field in the object specified by the inputObject field in

ObjectMapping. This field is mapped to the field in outputField,

stringinputField

which is assumed to be a field in the object specified by the

outputObject field in ObjectMapping.

Required. Field in the object specified by the outputObject field

in ObjectMapping. The field is mapped to the field name in

stringoutputField

inputField, which is assumed to be a field in the object specified

by the inputObject in ObjectMapping.

Declarative Metadata Sample Definition

The following is an example of a DuplicateRule component.

<?xml version="1.0" encoding="UTF-8"?>

<DuplicateRule xmlns="http://soap.sforce.com/2006/04/metadata"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<actionOnInsert>Allow</actionOnInsert>

<actionOnUpdate>Allow</actionOnUpdate>

<alertText>You are creating a duplicate record. Use an existing record

instead.</alertText>

<description>Detects a contact that duplicates a Lead</description>

<field>Username</field>

<operation>equals</operation>

<value>user@example.com</value>

</duplicateRuleFilterItems>

</duplicateRuleFilter>

346

DuplicateRuleMetadata Types

<matchingRule>ContactToLeadDuplicate_matching_rule</matchingRule>

<inputObject>Contact</inputObject>

<inputField>FirstName</inputField>

<outputField>FirstName</outputField>

</mappingFields>

<inputField>LastName</inputField>

<outputField>LastName</outputField>

</mappingFields>

</objectMapping>

</duplicateRuleMatchRules>

<masterLabel>ContactToLeadDuplicate</masterLabel>

<operationsOnInsert>Alert</operationsOnInsert>

<operationsOnInsert>Report</operationsOnInsert>

<operationsOnUpdate>Alert</operationsOnUpdate>

<operationsOnUpdate>Report</operationsOnUpdate>

<securityOption>EnforceSharingRules</securityOption>

</DuplicateRule>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>ContactToLeadDuplicate</members>

<name>DuplicateRule</name>

</types>

</Package>

EclairGeoData

Represents a Wave custom map chart. Custom maps are user-defined maps that are uploaded to Wave and are used just as standard

maps are. Custom maps are accessed in Wave from the list of maps available with the map chart type.

File Suffix and Directory Location

EclairGeoData components have the suffix geodata and are stored in the eclair folder.

Version

EclairGeoData components are available in API version 39.0 and later.

347

EclairGeoDataMetadata Types

Fields

DescriptionField TypeField Name

A list of EclairMap objects. Each EclairMap object specifies the bounding

box (if any) and the map name that appears in the user interface.

EclairMap[]maps

Required. Master label for this object. This display value is the internal

label that is not translated.

stringmasterLabel

EclairMap

DescriptionField TypeField Name

When bounding-box coordinates are used, this contains the bottom coordinate.doubleboundingBoxBottom

When bounding-box coordinates are used, this contains the left side coordinate.doubleboundingBoxLeft

When bounding-box coordinates are used, this contains the right side

coordinate.

doubleboundingBoxRight

When bounding-box coordinates are used, this contains the top coordinate.doubleboundingBoxTop

Required. The user-interface name of the map. This name appears in the maps

list for the map chart in Wave.

stringmapLabel

Required. Label for this object. This display value is the internal label that is not

translated.

stringmapName

Required. The type of map projection used to create the map. Valid values are:stringprojection

•Equirectangular

•Mercator

•AlbersUSA

Declarative Metadata Sample Definition

The following is an example of an EclairGeoData component:

<EclairGeoData xmlns="http://soap.sforce.com/2006/04/metadata"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<maps>

<mapLabel>WorldMap0 Label</mapLabel>

<mapName>WorldMap0</mapName>

<projection>Equirectangular</projection>

348

EclairGeoDataMetadata Types

</maps>

<maps>

<mapLabel>WorldMap1 Label</mapLabel>

<mapName>WorldMap1</mapName>

<projection>Mercator</projection>

</maps>

<masterLabel>WorldMapGeoDataToCreate Label</masterLabel>

</EclairGeoData>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>EclairGeoData</name>

</types>

</Package>

EmailTemplate

Represents an email template. This type extends the MetadataWithContent metadata type and inherits its content and fullName

fields.

File Suffix and Directory Location

The file suffix is .email for the template file. The accompanying metadata file is named EmailTemplateName-meta.xml.

EmailTemplate components are stored in the email folder in the corresponding package directory. For example, for an email template

named SampleTemplate in the sampleFolder folder, there’s a SampleTemplate-meta.xml in the email/sampleFolder

of the package.

Retrieving Email Templates

You can’t use the wildcard (*) symbol with email templates in package.xml. To retrieve the list of email templates for populating

package.xml with explicit names, call listMetadata() and pass in EmailTemplate as the type.

The following example shows folders in package.xml:

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>MyDBFolder/MyDBName</members>

<name>Dashboard</name>

349

EmailTemplateMetadata Types

</types>

<types>

<members>MyDocumentFolder/MyDocumentName</members>

<name>Document</name>

</types>

<types>

<members>unfiled$public/MarketingProductInquiryResponse</members>

<members>unfiled$public/SalesNewCustomerEmail</members>

<name>EmailTemplate</name>

</types>

<types>

<members>MyReportFolder/MyReportName</members>

<name>Report</name>

</types>

</Package>

Version

Email templates are available in API version 12.0 and later.

Fields

This metadata type contains the following fields:

DescriptionField TypeField Name

The API version if this is a Visualforce email template. Every Visualforce email

template has an API version specified at creation. This field is available in API

version 16.0 and later.

doubleapiVersion

A list of references to documents in your organization. These documents are

included as attachments in the email template. Each document is referenced

by its path, for example MyFolder/MyDocument.txt.

string[]attachedDocuments

A list of attachments for the email template.Attachment[]attachments

Required. Indicates whether this template is offered to users when sending an

email (true) or not (false).

booleanavailable

Content of the email template. Base 64-encoded binary data. Prior to making

an API call, client applications must encode the binary attachment data as base64.

base64Binarycontent

Upon receiving a response, client applications must decode the base64 data to

binary. This conversion is usually handled for you by a SOAP client. This field

contains:

•Binary content of the email body if type is set to text

•HTML email content if type is set to html

•HTML body if type is set to custom

•Visualforce body if type is set to visualforce

This field is inherited from the MetadataWithContent component.

350

EmailTemplateMetadata Types

DescriptionField TypeField Name

The email template description. This can be useful to describe the reason for

creating the template.

stringdescription

Required. The default encoding setting is Unicode: UTF-8. Change it if your

template requires data in a different format.

Valid values include:

Encoding (enumeration

of type string)

encodingKey

•UTF-8—Unicode (UTF-8)

•ISO-8859-1—General US & Western Europe (ISO-8859–1, ISO-LATIN-1)

•Shift_JIS—Japanese (Shift-JIS)

•ISO-2022-JP—Japanese (JIS)

•EUC-JP—Japanese (EUC-JP)

•x-SJIS_0213—Japanese (Shift-JIS_2004)

•ks_c_5601-1987—Korean (ks_c_5601-1987)

•Big5—Traditional Chinese (Big5)

•GB2312—Simplified Chinese (GB2312)

•Big5-HKSCS—Traditional Chinese Hong Kong (Big5–HKSCS)

The email template developer name used as a unique identifier for API access.

The fullName can contain only underscores and alphanumeric characters.

stringfullName

It must be unique, begin with a letter, not include spaces, not end with an

underscore, and not contain two consecutive underscores. If this field contained

characters before version 14.0 that are no longer allowed, the characters were

stripped out of this field, and the previous value of the field was saved in the

name field. This field is inherited from the Metadata component.

The letterhead name associated with this email template. Only available when

type is set to html.

stringletterhead

Required. Email template name. The list of characters allowed in the fullName

field has been reduced for versions 14.0 and later. This field contains the value

contained in the fullName field before version 14.0.

stringname

The list of package versions for any managed packages containing components

that are referenced by this email template. This field is only relevant for Visualforce

email templates.

For more information about managed packages, see the Force.com Quick

Reference for Developing Packages. For more information about package

PackageVersion[]packageVersions

versions, see “About Package Versions” in the Salesforce online help. This field

is available in API version 16.0 and later.

Required. The style of the template. This field is only available when type is set

to html.

Valid style values include:

EmailTemplateStyle

(enumeration of type

string)

style

•none

•freeForm

351

EmailTemplateMetadata Types

DescriptionField TypeField Name

•formalLetter

•promotionRight

•promotionLeft

•newsletter

•products

The email subject.stringsubject

The text of the email body if type is set to html or custom.stringtextOnly

Required. The email template type.

The valid values are:

EmailTemplateType

(enumeration of type

string)

type

•text -all users can create or change text email templates.

•html - administrators and users with the “Edit HTML Templates” permission

can create HTML email templates based on a letterhead.

•custom - administrators and users with the “Edit HTML Templates”

permission can create custom HTML email templates without using a

letterhead. You must either know HTML or obtain the HTML code to insert

in your email template.

•visualforce - administrators and users with the “Customize Application”

permission can create email templates using Visualforce.

Attachment

Attachment represents an email attachment.

DescriptionField TypeField

Required. The attachment content. Base 64-encoded binary

data. Prior to making an API call, client applications must encode

base64Binarycontent

the binary attachment data as base64. Upon receiving a

response, client applications must decode the base64 data to

binary. This conversion is usually handled for you by a SOAP

client.

Required. The attachment file name.stringname

Declarative Metadata Sample Definition

A sample XML definition of an email template is shown below.

<?xml version="1.0" encoding="UTF-8"?>

<description>Sample Email Template</description>

352

EmailTemplateMetadata Types

<name>Sample Email Template</name>

<subject>Sample email subject</subject>

<textOnly>Your case has been resolved.</textOnly>

<type>custom</type>

</EmailTemplate>

SEE ALSO:

Letterhead

EntitlementProcess

Represents the settings for an entitlement process. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

Entitlement process values are stored in files in the entitlementProcesses directory. Each file has the name of a process and

the suffix .entitlementProcess. Each file contains one entitlement process or, if entitlement versioning is enabled, one version

of an entitlement process. The name of the file is the name of the entitlement process with the version appended to the end, if applicable

(for example, an entitlement process named ”gold_support” might have the file name “gold_support_v2.entitlementProcess”). This file

name corresponds to the slaProcess.NameNorm field exposed through the SOAP API. This file name is distinct from the name

field, which represents what displays in the user interface and, if versioning is enabled, might be shared among multiple versions of the

same entitlement process.

Version

Entitlement processes are available in API version 27.0 and later.

Fields

DescriptionField TypeField Name

Indicates whether the entitlement process is active

(true) or not (false).

booleanactive

The business hours that apply to the entitlement process.

This field is available in API version 30.0 and later.

stringbusinessHours

The description of the entitlement process.stringdescription

For milestone processes on which a case enters the

process based on a custom date/time field on the case,

specifies which date and time are used. Valid values are:

stringentryStartDateField

•SlaStartDate (entitlement process start date)

•CreatedDate (date case was opened)

353

EntitlementProcessMetadata Types

DescriptionField TypeField Name

•ClosedDate (date case was closed)

•LastModifiedDate (date case was last modified)

•StopStartDate (date case was stopped)

For milestone processes on which a case exits the process

when custom criteria are met, and for which filter logic

is added, specifies that logic.

stringexitCriteriaBooleanFilter

For milestone processes on which a case exits the process

when custom criteria are met, specifies those criteria.

FilterItem[]exitCriteriaFilterItems

For milestone processes on which a case exits the process

when a custom formula evaluates to true, specifies that

formula.

stringexitCriteriaFormula

Indicates whether the entitlement process is the default

version (true) or not (false).

This field is available in API version 28.0 and later.

booleanisVersionDefault

Represents a milestone on the entitlement process.EntitlementProcessMilestoneItem[]milestones

The name of the entitlement process as it displays in the

user interface.

stringname

Indicates the type of record that the entitlement process

can run on.

stringSObjectType

Identifies the sequence of versions to which this

entitlement process belongs. This field’s contents can be

stringversionMaster

any value as long as it is identical among all versions of

the entitlement process.

This field is available in API version 28.0 and later.

The description of the entitlement process version.

This field is available in API version 28.0 and later.

stringversionNotes

The version number of the entitlement process. Must be

1 or greater.

This field is available in API version 28.0 and later.

intversionNumber

EntitlementProcessMilestoneItem

Represents a milestone item on an entitlement process.

354

EntitlementProcessMetadata Types

Fields

DescriptionField TypeField Name

The business hours that apply to the milestone.

This field is available in API version 30.0 and later.

stringbusinessHours

For milestones that apply only when criteria are met

and for which filter logic is added, specifies that logic.

stringcriteriaBooleanFilter

For milestones that apply only when criteria are met,

specifies those criteria.

FilterItem[]milestoneCriteriaFilterItems

For milestones that apply only when a formula

evaluates to true, specifies that formula.

stringmilestoneCriteriaFormula

The name of the milestone.stringmilestoneName

The name of the Apex class that is used to calculate

the trigger time. This field is available in API version

30.0 and later.

stringminutesCustomClass

The number of minutes from when the case enters the

entitlement process that the milestone occurs.

intminutesToComplete

The actions triggered when the milestone is completed.WorkflowActionReference[]successActions

The time triggers on an entitlement process milestone.EntitlementProcessMilestoneTimeTrigger[]timeTriggers

When the milestone starts: when the milestone criteria

are met (true) or when the case enters the entitlement

process (false).

booleanuseCriteriaStartTime

EntitlementProcessMilestoneTimeTrigger

Represents the time trigger on an entitlement process milestone.

Fields

DescriptionField TypeField Name

The actions to take when the time trigger is reached, if, at that time,

the milestone is not completed.

WorkflowActionReference[]actions

The length of time between the time trigger activation and the

milestone target completion date. This may be a negative or positive

inttimeLength

value. Negative values indicate that the target completion date has

not yet arrived and correspond to warning time triggers. Positive

values indicate that the target completion date has passed and

correspond to violation time triggers.

355

EntitlementProcessMetadata Types

DescriptionField TypeField Name

Specifies the type of unit used to determine when a workflow should

be triggered. Valid values are:

MilestoneTimeUnits

(enumeration of type

string)

workflowTimeTriggerUnit

•Minutes

•Hours

•Days

Declarative Metadata Sample Definition

This is a sample entitlement process.

<?xml version="1.0" encoding="UTF-8"?>

<description>eppersone</description>

<entryStartDateField>SlaStartDate</entryStartDateField>

<field>Case.IsClosed</field>

<operation>equals</operation>

</exitCriteriaFilterItems>

<field>Case.Description</field>

<operation>startsWith</operation>

</exitCriteriaFilterItems>

<name>emailBob</name>

<type>Alert</type>

</successActions>

<name>emailAlice</name>

<type>Alert</type>

</actions>

<name>setEscalateToTrue</name>

<type>FieldUpdate</type>

</actions>

<workflowTimeTriggerUnit>Minutes</workflowTimeTriggerUnit>

</timeTriggers>

<name>setStopToTrue</name>

<type>FieldUpdate</type>

356

EntitlementProcessMetadata Types

</actions>

<workflowTimeTriggerUnit>Minutes</workflowTimeTriggerUnit>

</timeTriggers>

<useCriteriaStartTime>false</useCriteriaStartTime>

</milestones>

<field>Case.Priority</field>

<operation>equals</operation>

</milestoneCriteriaFilterItems>

<name>emailBob</name>

<type>Alert</type>

</successActions>

</milestones>

</EntitlementProcess>

EntitlementTemplate

Represents an entitlement template. Entitlement templates are predefined terms of customer support that you can quickly add to

products. For example, you can create entitlement templates for Web or phone support so that users can easily add entitlements to

products offered to customers. EntitlementTemplate extends the Metadata metadata type and inherits its fullName field.

Declarative Metadata File Suffix and Directory Location

EntitlementTemplate components are stored in the entitlementTemplates directory of the corresponding package directory.

The file name matches the unique name of the entitlement template, and the extension is .entitlementTemplate.

Version

Force.com EntitlementTemplate components are available in API version 18.0 and higher.

Fields

DescriptionField TypeField

The entitlement's supported business hours.stringbusinessHours

Lets you limit the number of cases the entitlement supports.intcasesPerEntitlement

The entitlement process associated with the entitlement.stringentitlementProcess

true if entitlements created from this template service a

limited number of cases; false otherwise.

booleanisPerIncident

357

EntitlementTemplateMetadata Types

DescriptionField TypeField

The number of days the entitlement is in effect.intterm

The type of entitlement, such as Web or phone support.stringtype

Declarative Metadata Sample Definition

A sample XML definition of an entitlement template is shown below.

<?xml version="1.0" encoding="UTF-8"?>

<businessHours>AlternateBusinessHours</businessHours>

<entitlementProcess>Process1</entitlementProcess>

<type>Phone Support</type>

</EntitlementTemplate>

EscalationRules

Represents case escalation rules to escalate cases automatically if they are not resolved within a certain period of time. You can access

rules metadata for all applicable objects, for a specific object, or for a specific rule on a specific object. The package.xml syntax for

accessing all escalation rules for all objects is:

<types>

<name>EscalationRules</name>

</types>

All rules for a specific object uses a similar syntax without the wildcard. For example, all escalation rules for the Case object would use

this syntax:

<types>

<name>EscalationRules</name>

</types>

You can also access specific escalation rules for an object. The following example only accesses the “samplerule” and “newrule” escalation

rules on the Case object. Notice that for this example the type name syntax is EscalationRule and not EscalationRules.

<types>

<members>Case.samplerule</members>

<members>Case.newrule</members>

<name>EscalationRule</name>

</types>

File Suffix and Directory Location

EscalationRules for an object have the suffix .escalationRules and are stored in the escalationRules folder. For example,

all Case escalation rules are stored in the Case.escalationRules file.

358

EscalationRulesMetadata Types

Version

EscalationRules components are available in API version 27.0 and later.

Fields

DescriptionField TypeField Name

Represents one escalation rule and specifies whether it is active or

not. Escalation rules are processed in the order they appear in the

EscalationRules container.

EscalationRule[]escalationRule

EscalationRule

DescriptionField TypeField Name

Indicates whether the escalation rule is active (true) or

not (false).

booleanactive

Inherited from Metadata, this field is not defined in the

WSDL for this metadata type. It must be specified when

stringfullname

creating, updating, or deleting. See create() to see an

example of this field specified for a call.

This value cannot be null.

Contains the definitions of the rule entries in the escalation

rule.

RuleEntry[]ruleEntry

RuleEntry

Represents the fields used by the rule.

DescriptionField TypeField Name

Advanced filter conditions that were specified for the rule.stringbooleanFilter

The hours at which escalation actions are performed. Specify

only if businessHoursSource is set to Static.

stringbusinessHours

Valid values are:BusinessHoursSourceType

(enumeration of type string)

businessHoursSource

•None

•Case

•Static

The items in the list that define the assignment criteria.FilterItemcriteriaItems

Indicates whether the escalation is disabled when the

record is modified true) or not (false).

booleandisableEscalationWhenModified

359

EscalationRulesMetadata Types

DescriptionField TypeField Name

The actions to perform when the escalation criteria are met.EscalationAction[] on

page 360

escalationAction

Indicates the start time for the escalation. Valid values are:EscalationStartTimeType

(enumeration of type string)

escalationStartTime

•CaseCreation

•CaseLastModified

The validation formula.stringformula

Note: Specify either formula or

criteriaItems, but not both fields.

EscalationAction

Describes the action to take for an escalation rule.

DescriptionField TypeField Name

The name of the user or queue the item is assigned to.stringassignedTo

Specifies the template to use for the email that is

automatically sent to the new owner specified by the

escalation rule.

stringassignedToTemplate

Valid values are:AssignToLookupValueType

(enumeration of type string)

assignedToType

•User

•Queue

The number of minutes until the escalation occurs.intminutesToEscalation

Indicates that the owner of the case is notified when the

case is escalated true) or not (false).

booleannotifyCaseOwner

Specifies the email address of the user to notify.stringnotifyEmail

Specifies the user to notify.stringnotifyTo

Specifies the template to user for the notification email.stringnotifyToTemplate

Declarative Metadata Sample Definition

The following is an example EscalationRules component:

<fullName>samplerule</fullName>

<active>false</active>

360

EscalationRulesMetadata Types

<businessHoursSource>Static</businessHoursSource>

<field>Case.Description</field>

<operation>contains</operation>

</criteriaItems>

<assignedTo>someuser@org.com</assignedTo>

<assignedToTemplate>emailtemplatename</assignedToTemplate>

<notifyCaseOwner>false</notifyCaseOwner>

</escalationAction>

<escalationStartTime>CaseLastModified</escalationStartTime>

</ruleEntry>

</escalationRule>

</EscalationRules>

ExternalDataSource

Represents the metadata associated with an external data source. Create external data sources to manage connection details for

integration with data and content that are stored outside your Salesforce org.

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

ExternalDataSource components are stored in the dataSources directory of the corresponding package directory. ExternalDataSource

components have the suffix .dataSource, and the prefix is the name of the external data source.

Version

ExternalDataSource components are available in API version 28.0 and later.

Fields

DescriptionField TypeField Name

The authentication provider that is represented by the AuthProvider

component.

stringauthProvider

If you specify a certificate, your Salesforce org supplies it when

establishing each two-way SSL connection with the external system.

stringcertificate

The certificate is used for digital signatures, which verify that requests

are coming from your Salesforce org.

A string of configuration parameters that are specific to the external data

source’s type.

stringcustomConfiguration

•customConfiguration for Salesforce Connect—Cross-Org Adapter

361

ExternalDataSourceMetadata Types

DescriptionField TypeField Name

•customConfiguration for Salesforce Connect—OData 2.0 or 4.0

Adapter

•customConfiguration for Salesforce Connect—Custom Adapter

The URL of the external system, or if that URL is defined in a named

credential, the named credential URL. Corresponds to URL in the user

interface.

A named credential URL contains the scheme callout:, the name

of the named credential, and an optional path. For example:

callout:My_Named_Credential/some_path.

stringendpoint

You can append a query string to a named credential URL. Use a question

mark (?) as the separator between the named credential URL and the

query string. For example:

callout:My_Named_Credential/some_path?format=json.

Lets the Force.com platform and users in this org create, update, and

delete records for external objects associated with the external data

booleanisWritable

source. The external object data is stored outside the org. By default,

external objects are read only. Corresponds to Writable External

Objects in the user interface.

Available in API version 35.0 and later. However, with the cross-org

adapter for Salesforce Connect, you can set this field to true only in

API version 39.0 and later.

A user-friendly name for the external data source. The label is displayed

in the Salesforce user interface, such as in list views.

Examples include Acme Team Marketing Site, or Acme SharePoint.

stringlabel

The OAuth refresh token. Used to obtain a new access token for an end

user when a token expires.

stringoauthRefreshToken

Specifies the scope of permissions to request for the access token.

Corresponds to Scope in the user interface.

stringoauthScope

The access token issued by the external system.stringoauthToken

The password to be used by your org to access the external system.

Ensure that the credentials you use have adequate privileges to access

stringpassword

the external system, perform searches, return data, and return information

about the external system’s metadata.

Determines whether you're using one set or multiple sets of credentials

to access the external system. Corresponds to Identity Type in

the user interface. The valid values are:

External

PrincipalType

(enumeration of

type string)

principalType

•Anonymous

•PerUser

362

ExternalDataSourceMetadata Types

DescriptionField TypeField Name

•NamedUser

The authentication protocol that’s required to access the external system.

The valid values are:

Authentication

Protocol

(enumeration of

type string)

protocol

•NoAuthentication

•Oauth

•Password

For cloud-based Files Connect external systems, select Oauth 2.0. For

on-premises systems, select Password Authentication.

For Simple URL data sources, select No Authentication.

Used for SharePoint Online. If metadata is not accessible, use this field

to create tables and default table fields.

stringrepository

For Salesforce Connect, specifies the adapter that connects to the external

system. The valid values are:

ExternalData

SourceType

(enumeration of

type string)

type

•OData—OData 2.0 adapter

•OData4—OData 4.0 adapter

•SfdcOrg—cross-org adapter

•ApexClassId—DataSource.Provider class that defines

the custom adapter created via the Apex Connector Framework

For Files Connect, specifies the data source type. The valid values are:

•ContentHubSharepoint—SharePoint 2010 or 2013

•ContentHubSharepointOffice365—SharePoint Online

•ContentHubSharepointOneDrive—OneDrive for Business

•ContentHubGDrive—Google Drive

If Chatter is enabled, you can also specify SimpleURL to access data

hosted on a web server that doesn’t require authentication.

•outgoingemail—A data source used for sending an email

through a quick action.

The Identity and Wrapper types are reserved for future use.

The username to be used by your org to access the external system.

Ensure that the credentials you use have adequate privileges to access

stringusername

the external system, perform searches, return data, and return information

about the external system’s metadata.

Reserved for future use.stringversion

363

ExternalDataSourceMetadata Types

customConfiguration for Salesforce Connect—Cross-Org Adapter

The following sample JSON-encoded configuration string defines parameters that apply when the external data source’s type is set

to SfdcOrg.

{"apiVersion":"32.0","environment":"CUSTOM",

"searchEnabled":"true","timeout":"120"}

The parameters correspond to these fields in the user interface:

•apiVersion—API Version

•environment—Connect to

•searchEnabled—Enable Search

•timeout—Connection Timeout

customConfiguration for Salesforce Connect—OData 2.0 or 4.0 Adapter

The following JSON-encoded configuration string defines parameters that apply when the external data source’s type is set to OData

or OData4.

{"inlineCountEnabled":"true","csrfTokenName":"X-CSRF-Token",

"requestCompression":"false","pagination":"CLIENT",

"noIdMapping":"false","format":"ATOM",

"searchFunc":"","compatibility":"DEFAULT",

"csrfTokenEnabled":"true","timeout":"120",

"searchEnabled":"true"}

The parameters correspond to these fields in the user interface.

•compatibility—Special Compatibility

•csrfTokenEnabled—CSRF Protection

•csrfTokenName—Anti-CSRF Token Name

•format—Format

•inlineCountEnabled—Request Row Counts

•noIdMapping—High Data Volume

•pagination—Server Driven Pagination

•requestCompression—Compress Requests

•searchEnabled—Enable Search

•searchFunc—Custom Query Option for Salesforce Search

•timeout—Connection Timeout

customConfiguration for Salesforce Connect—Custom Adapter

The following sample JSON-encoded configuration string defines the parameter that applies when the external data source’s type is

set to the ID of a DataSource.Provider class.

{"noIdMapping":"false"}

The noIdMapping parameter corresponds to the High Data Volume field in the user interface.

364

ExternalDataSourceMetadata Types

Declarative Metadata Sample Definition

The following is the definition of an external data source for Salesforce Connect—OData 2.0 or 4.0 adapter.

<?xml version="1.0" encoding="UTF-8"?>

<authProvider>FacebookAuth</authProvider>

<customConfiguration>{"compatibility":"DEFAULT",

"noIdMapping":"false","inlineCountEnabled":"true",

"searchEnabled":"true","format":"ATOM",

"requestCompression":"false","pagination":"SERVER",

"timeout":"120"}</customConfiguration>

<endpoint>http://myappname.herokuapp.com/DataHub.svc</endpoint>

<label>DataHub</label>

<principalType>NamedUser</principalType>

<protocol>Oauth</protocol>

<type>OData</type>

</ExternalDataSource>

FlexiPage

Represents the metadata associated with a Lightning Page. A Lightning Page represents a customizable screen containing Lightning

components.

Lightning Pages are used in several places.

•In Salesforce1, a Lightning Page is the home page for an app that appears in the navigation menu.

•In Lightning Experience, Lightning Pages can be used as the home page for an app, and to customize the layout of record pages

and the Home page.

This type extends the Metadata metadata type and inherits its fullName field.

Note: These pages are known as FlexiPages in the API, but are referred to as Lightning Pages in the rest of the Salesforce

documentation and UI.

For more information on Lightning Pages, see the Salesforce Help.

File Suffix and Directory Location

FlexiPage components have the suffix .flexipage and are stored in the flexipages folder.

Version

FlexiPage components are available in API version 29.0 and later.

Fields

DescriptionField TypeField Name

The optional description text of the Lightning Page.stringdescription

Required. The list of regions of a page.FlexiPageRegion[]flexiPageRegions

365

FlexiPageMetadata Types

DescriptionField TypeField Name

Required. The label for this FlexiPage, which displays in Setup.stringmasterLabel

Deprecated. Use this field in API versions 33.0 to 38.0 only. In

later versions, use template.

Required. The template associated with the FlexiPage.

stringpageTemplate

The name of the FlexiPage that this page inherits behavior

from.

This field is available in API version 37.0 or later.

stringparentFlexiPage

The list of all actions, and their order, that display on the

Lightning Page. In Salesforce1, the actions appear in the action

bar.

This field is available in API version 34.0 and later.

PlatformActionListplatformActionList

The list of quick actions associated with the Lightning Page.QuickActionListquickActionList

The object the FlexiPage is associated with. For Lightning Pages

of type AppPage or HomePage, this field is null.

After the value of this field is set, it can’t be changed.

stringsobjectType

This field is available in API version 37.0 or later.

Required. The template associated with the FlexiPage.

This field is available in API version 39.0 and later.

FlexiPageTemplateInstancetemplate

Required. The type of a page. In API versions 32.0 through 36.0,

this field can only have a value of AppPage.

Valid values are:

FlexiPageType (enumeration

of type string)

type

•AppPage—A Lightning Page that is used as the home

page for a custom app.

•CommAppPage—A Lightning Page that is used to

represent a custom page, as created in the Community

Builder, in Communities. This value is available in API

version 37.0 and later.

•CommForgotPasswordPage—A Lightning Page

that’s used to override a forgot-password page, as created

in Community Builder, in Communities. This value is

available in API version 39.0 and later.

•CommLoginPage—A Lightning Page that’s used to

override the login page, as created in Community Builder,

in Communities. This value is available in API version 39.0

and later.

•CommObjectPage—A Lightning Page used to override

an object page, as created in Community Builder, in

366

FlexiPageMetadata Types

DescriptionField TypeField Name

Communities. This value is available in API version 38.0

and later.

•CommQuickActionCreatePage—A Lightning

Page used to override the create record page, as created

in Community Builder, in Communities. This value is

available in API version 38.0 and later.

•CommRecordPage—A Lightning Page used to override

a record page , as created in the Community Builder, in

Communities. This value is available in API version 38.0

and later.

•CommRelatedListPage—A Lightning Page used

to override a related list page, as created in the Community

Builder, in Communities. This value is available in API

version 38.0 and later.

•CommSearchResultPage—A Lightning Page used

to override the search result page, as created in

Community Builder, in Communities. This value is available

in API version 38.0 and later.

•CommSelfRegisterPage—A Lightning Page used

to override the self-registration page, as created in

Community Builder, in Communities. This value is available

in API version 39.0 and later.

•CommThemeLayoutPage—A Lightning Page used

to override a theme layout page, as created in the

Community Builder, in Communities. This value is available

in API version 38.0 and later.

•HomePage—A Lightning Page that is used to override

the Home page in Lightning Experience. This value is

available in API version 37.0 and later.

•MailAppAppPage—An email application pane used

to override the default layout for Lightning for Outlook.

This value is available in API version 38.0 and later.

•RecordPage—A Lightning Page used to override an

object record page in Lightning Experience. This value is

available in API version 37.0 and later.

•UtilityBar—A Lightning Page used as the utility bar

in Lightning Experience apps. This value is available in API

version 38.0 and later.

This field is available in API version 32.0 and later.

367

FlexiPageMetadata Types

FlexiPageRegion

FlexiPage Region represents the properties of a region of a page. A region can contain a record list component or a recent items

component that can be scoped to a set of entities.

DescriptionField TypeField Name

This field is reserved for future use.

Valid values are:

RegionFlagStatus

(enumeration of type string)

appendable

•disabled

•enabled

This field is available in API version 35.0 or later.

Properties and name of the component instance.ComponentInstance[]componentInstances

This field is reserved for future use.

Valid values are:

FlexiPageRegionMode

(enumeration of type string)

mode

•Append

•Prepend

•Replace

This field is available in API version 35.0 or later.

Required. Unique name of the FlexiPage region.stringname

This field is reserved for future use.

Valid values are:

RegionFlagStatus

(enumeration of type string)

prependable

•disabled

•enabled

This field is available in API version 35.0 or later.

This field is reserved for future use.

Valid values are:

RegionFlagStatus

(enumeration of type string)

replaceable

•disabled

•enabled

This field is available in API version 35.0 or later.

Required. The type of FlexiPage region.

Valid values are:

FlexiPageRegionType

(enumeration of type string)

type

•Facet

•Region

This field is available in API version 35.0 or later.

368

FlexiPageMetadata Types

ComponentInstance

Instance of a component in a page, such as a filter list.

DescriptionField TypeField Name

The value of a single property in a component instance.

A component instance can have no properties.

ComponentInstanceProperty[]componentInstanceProperties

Required. The name of a single instance of a

component.

stringcomponentName

ComponentInstanceProperty

Value of a single property in a component instance.

DescriptionField TypeField Name

Name of the property, unique within the component instance.

For Lightning components, this value is the

<aura:attribute> as defined in the .cmp file.

stringname

If this field value is null, then the

ComponentInstanceProperty values apply to the Lightning

ComponentInstancePropertyTypeEnum

(enumeration of type string)

type

component. If this field value is decorator, then the

ComponentInstanceProperty values apply to the component

decorator for the Lightning component.

The component decorator is a wrapper around a Lightning

component. The decorator can apply additional capabilities

to the component when it renders on a specific page in

Lightning Experience. For example, you can configure a

component decorator around a component on the Lightning

Experience utility bar to set the component’s height or width

when opened. The UtilityBar is the only page type that

supports component decorators.

Valid values are:

•decorator

This field is available in API version 38.0 or later.

Reference or value of the property.

When defining a Related List component, to use a parent

record set the parentFieldApiName value to

stringvalue

object.field_name. If you don’t want to use a parent

record, set the value to object.Id.

When you give a standard label to a tab in a Tabs component—such as Activity, Collaborate, or Details—and when the name field is

set to title, the value field uses a system-defined value instead of the label. Here are some examples of the system-defined values:

369

FlexiPageMetadata Types

•Standard.Tab.activity

•Standard.Tab.collaborate

•Standard.Tab.detail

•Standard.Tab.feed

•Standard.Tab.preview

•Standard.Tab.relatedLists

For example, let’s say you have a Lightning Page that contains a tab with the standard label “Activity”. If you query the definition that

page, you see the system-defined name of the tab, not the label, in value.

<name>title</name>

<value>Standard.Tab.activity</value>

</componentInstanceProperties>

<componentName>flexipage:tab</componentName>

</componentInstances>

PlatformActionList

PlatformActionList represents the list of actions, and their order, that display on the Lightning Page. Available in API version 34.0 and

later.

DescriptionField TypeField Name

Required. The context of the action list. Valid values are:PlatformActionListContext

(enumeration of

type string)

actionListContext

•Assistant

•BannerPhoto

•Chatter

•Dockable

•FeedElement

•FlexiPage

•Global

•ListView

•ListViewDefinition

•ListViewRecord

•Lookup

•MruList

•MruRow

•ObjectHomeChart

•Photo

•Record

•RecordEdit

•RelatedList

•RelatedListRecord

370

FlexiPageMetadata Types

DescriptionField TypeField Name

The actions in the PlatformActionList.PlatformActionListItem[]platformActionListItems

When the ActionListContext is RelatedList or RelatedListRecord,

this field represents the API name of the related list to which the action

belongs.

stringrelatedSourceEntity

PlatformActionListItem

PlatformActionListItem represents an action in the PlatformActionList. Available in API version 34.0 and later.

DescriptionField TypeField Name

The API name for the action in the list.stringactionName

The type of action. Valid values are:PlatformActionType

(enumeration of type

string)

actionType

•ActionLink—An indicator on a feed element that targets an API, a

web page, or a file, represented by a button in the Salesforce Chatter feed

UI.

•CustomButton—When clicked, opens a URL or a Visualforce page in

a window or executes JavaScript.

•InvocableAction

•ProductivityAction—Productivity actions are predefined by

Salesforce and are attached to a limited set of objects. You can’t edit or

delete productivity actions.

•QuickAction—A global or object-specific action.

•StandardButton—A predefined Salesforce button such as New, Edit,

and Delete.

The placement of the action in the list.intsortOrder

The subtype of the action. For quick actions, the subtype is

QuickActionType. For custom buttons, the subtype is

stringsubtype

WebLinkTypeEnum. For action links, subtypes are Api, ApiAsync,

Download, and Ui. Standard buttons and productivity actions have no

subtype.

FlexiPageTemplateInstance

FlexiPageTemplateInstance represents an instance of a FlexiPage template.

DescriptionField TypeField Name

Required. The name of a single instance of a template.stringname

371

FlexiPageMetadata Types

DescriptionField TypeField Name

The value of a single property in a template instance.

Valid only for CommThemeLayoutPage. Contains

a name and value pair for each theme layout property

ComponentInstanceProperty[]properties

associated with the FlexiPage template. In Community

Builder, the theme layout and its properties appear in

the Theme area.

Declarative Metadata Sample Definition

Here’s a sample XML FlexiPage component definition for a travel app that tracks the user’s trips, expense reports, and other relevant

data:

<?xml version="1.0" encoding="UTF-8"?>

<description>Page to view recent trips</description>

<name>entityName</name>

<value>Trips__c</value>

</componentInstanceProperties>

<name>filterName</name>

<value>My_Trips</value>

</componentInstanceProperties>

<componentName>flexipage:filterListCard</componentName>

</componentInstances>

<name>entityName</name>

<value>Expense_Report__c</value>

</componentInstanceProperties>

<name>filterName</name>

<value>My_Reports</value>

</componentInstanceProperties>

<componentName>flexipage:filterListCard</componentName>

</componentInstances>

<name>entityNames</name>

<value>["User","Trips__c","Expense__c","Receipt__c"]</value>

</componentInstanceProperties>

<componentName>flexipage:recentItems</componentName>

</componentInstances>

</flexiPageRegions>

<masterLabel>My Travel, Inc.</masterLabel>

372

FlexiPageMetadata Types

<quickActionName>customAction1</quickActionName>

</quickActionListItems>

<quickActionName>customAction2</quickActionName>

</quickActionListItems>

</quickActionList>

<type>AppPage</type>

</FlexiPage>

And, here’s the sample package.xml file that references the FlexiPage component definition:

<?xml version="1.0" encoding="UTF-8"?>

<fullName>Travel, Inc.</fullName>

<types>

<members>TravelIncFlexiPage</members>

<name>CustomTab</name>

</types>

<types>

<members>TravelIncFlexiPage</members>

<name>FlexiPage</name>

</types>

<types>

<members>TravelIncQuickActions</members>

<name>QuickAction</name>

</types>

</Package>

Flow

Represents the metadata associated with a flow. With Flow, you can create an application that navigates users through a series of screens

to query and update records in the database. You can also execute logic and provide branching capability based on user input to build

dynamic applications. For information about the corresponding UI-based flow building tool, see “Cloud Flow Designer” in the Salesforce

Help.

When using the file-based Metadata API to work with flows, consider that:

•You can’t use Metadata API to access a flow installed from a managed package.

•Flow filenames shouldn’t contain spaces, which can cause errors at deployment. Heading and trailing spaces are allowed, but are

trimmed during deployment.

•You can’t overwrite an active flow or one that was once active when deploying a flow using Metadata API.

•You can create a new version of a flow by giving the file a new version number and deploying it.

Warning: Don't edit the metadata of retrieved Process Builder processes (Flow components whose processType is Workflow or

InvocableProcess.) If you deploy process metadata that you've edited, you might not be able to open the process in the target

org.

Declarative Metadata File Suffix and Directory Location

Flows are stored in the Flow directory of the corresponding package directory. The file name matches the flow’s unique full name,

and the extension is .flow.

373

FlowMetadata Types

Version

The flow Metadata API is available in API version 24.0 and later.

Flow

This metadata type represents a valid definition of a flow. This type extends the Metadata metadata type and inherits its fullName

field.

DescriptionField TypeField Name

An array of nodes that define calls to actions. This field is available

in API version 31.0 and later.

FlowActionCall[]actionCalls

An array of nodes that define calls to Apex plug-ins.FlowApexPluginCall[]apexPluginCalls

An array of assignment nodes.FlowAssignment[]assignments

An array of static choice options.FlowChoice[]choices

An array of constants.FlowConstant[]constants

An array of decision nodes.FlowDecision[]decisions

Description of the flow.stringdescription

An array that constructs a set of choice options based on a

database lookup.

FlowDynamicChoiceSet[]dynamicChoiceSets

An array of formulas.FlowFormula[]formulas

Required; inherited from the Metadata component. Name of

the file in Metadata API.

The fullName consists of two parts, separated by a hyphen:

stringfullName

•Unique name for the flow that contains only underscores

and alphanumeric characters. It must be unique across the

organization, begin with a letter, not include spaces, not

end with an underscore, and not contain two consecutive

underscores.

•Version number for the flow.

For example, “sampleFlow-3” specifies version 3 of the flow

whose unique name is sampleFlow.

Label for the interview. This label helps users and administrators

differentiate interviews from the same flow.

In the user interface, this label appears in the Paused Flow

Interviews component on the user’s Home tab and in the Paused

and Waiting Interviews list on the flow management page.

stringinterviewLabel

Required. Label for the flow.stringlabel

374

FlowMetadata Types

DescriptionField TypeField Name

An array of nodes for iterating through collections. This field is

available in API version 30.0 and later.

FlowLoop[]loops

Metadata values for the flow.

This field is available in API version 31.0 and later.

FlowMetadataValue[]processMetadataValues

The type of the flow, as determined by the active version (or

latest version, if there’s no active version). Valid values are:

FlowProcessType (enumeration

of type string)

processType

•AutoLaunchedFlow—A flow that doesn’t require user

interaction

•Flow—A flow that requires user interaction because it

contains one or more screens, choices, or dynamic choices

•InvocableProcess—A process that can be invoked

by another process. This value is available in API version 38.0

and later.

•Workflow—A process created by using Process Builder

These values are reserved for future use.

•ActionPlan

•JourneyBuilderIntegration

•LoginFlow

•UserProvisioningFlow

Across versions, you can change the type from Flow to

AutoLaunchedFlow or vice versa.

This field is available in API version 31.0 and later.

An array of nodes for creating records in the database.FlowRecordCreate[]recordCreates

An array of nodes for deleting records in the database.FlowRecordDelete[]recordDeletes

An array of nodes for looking up records in the database.FlowRecordLookup[]recordLookups

An array of nodes for updating records in the database.FlowRecordUpdate[]recordUpdates

An array of screen nodes.FlowScreen[]screens

Specifies which node or element is the starting point in the flow.stringstartElementReference

An array of step nodes.FlowStep[]steps

An array of subflows. This field is available in API version 25.0

and later.

FlowSubflow[]subflows

An array of text templates.FlowTextTemplate[]textTemplates

An array of variable definitions.FlowVariable[]variables

An array of wait nodes. This field is available in API version 32.0

and later.

FlowWait[]waits

375

FlowMetadata Types

FlowActionCall

Defines a call to an action from the flow. It extends FlowNode.

Available in API version 31.0 and later.

DescriptionField TypeField Name

Required. Name for the action. Must be unique across

actions with the same actionType.

stringactionName

Required. The action type. Valid values are:InvocableActionType (enumeration of type

string)

actionType

•apex—invokes an Apex method that has the

@invocableMethod annotation

•chatterPost—posts to Chatter

•contentWorkspaceEnableFolders—enables

folders in a library

•emailAlert—sends an email by referencing a

workflow email alert

•emailSimple—sends an email by using flow

resources

•flow—invokes an autolaunched flow. This action type

isn’t available for flows with a processType of “Flow” or

“AutolaunchedFlow”. To invoke an autolaunched flow

from one of those types, use FlowSubflow. Available in

API version 32.0 and later.

•quickAction—invokes a QuickAction

•submit—submits a record for approval

These values are reserved for future use.

•thanks

•metricRefresh

Specifies which node to execute after this action call.FlowConnectorconnector

Specifies which node to execute if the action call results in

an error.

FlowConnectorfaultConnector

An array of input parameters from the flow to the action.FlowActionCallInputParameter[]inputParameters

An array of output parameters from the action to the flow.FlowActionCallOutputParameter[]outputParameters

FlowActionCallInputParameter

Defines an input parameter from the flow to the action. It extends FlowBaseElement and inherits all of its fields. Available in API version

31.0 and later.

376

FlowMetadata Types

DescriptionField TypeField Name

Required. Unique name for the input parameter.stringname

Defines the value of the input parameter.FlowElementReferenceOrValuevalue

FlowActionCallOutputParameter

Defines an output parameter from the action to the flow. It extends FlowBaseElement and inherits all of its fields. Available in API version

31.0 and later.

DescriptionField TypeField Name

Required. Specifies the variable to which you want to assign the

output parameter value.

stringassignToReference

Required. Unique name for the output parameter.stringname

FlowApexPluginCall

Defines a call to an Apex plug-in from the flow. It extends FlowNode and inherits all of its fields.

DescriptionField TypeField Name

Required. The name of the Apex class.stringapexClass

Specifies which node to execute after this Apex plug-in call.FlowConnectorconnector

Specifies which node to execute if the Apex plug-in call

results in an error.

FlowConnectorfaultConnector

An array of input parameters from the flow to the Apex

plug-in.

FlowApexPluginCallInputParameter[]inputParameters

An array of output parameters from the Apex plug-in to the

flow.

FlowApexPluginCallOutputParameter[]outputParameters

FlowApexPluginCallInputParameter

Defines an input parameter from the flow to the Apex plug-in. It extends FlowBaseElement and inherits all of its fields.

DescriptionField TypeField Name

Required. Unique name for the input parameter.stringname

Defines the value of the input parameter.FlowElementReferenceOrValuevalue

FlowApexPluginCallOutputParameter

Defines an output parameter from the Apex plug-in to the flow. It extends FlowBaseElement and inherits all of its fields.

377

FlowMetadata Types

DescriptionField TypeField Name

Required. Specifies the variable to which you want to assign the

output parameter value.

stringassignToReference

Required. Unique name for the output parameter.stringname

FlowAssignment

Defines an assignment node that can dynamically change the value of a variable in the flow. It extends FlowNode and inherits all of its

fields.

DescriptionField TypeField Name

An array of assignment operations that is executed in the given

order, starting from the index 0.

FlowAssignmentItem[]assignmentItems

Specifies which node to execute after this assignment node.FlowConnectorconnector

FlowAssignmentItem

Defines an operation to apply to a variable. It extends FlowBaseElement and inherits all of its fields.

DescriptionField TypeField Name

Required. Reference to the variable to which you want to

apply the specified operator.

stringassignToReference

Required. Operation to apply to the variable reference in

the assignToReference field. Valid values are:

FlowAssignmentOperator

(enumeration of type string)

operator

•Assign–assigns the specified value to the variable in

the assignToReference field.

•Add–adds the specified value to the variable in the

assignToReference field.

•AddItem–adds the specified value as a new item to

the variable in the assignToReference field. Supported

for only variables that have a data type of Multipicklist.

This operator automatically adds the semi-colon

required to mark a value as a separate item. This

operator is available in API version 34.0 and later.

•Subtract–subtracts the specified value from the

variable in the assignToReference field.

Defines the value that you want the operator to apply to

the variable reference in the assignToReference field.

FlowElementReferenceOrValuevalue

378

FlowMetadata Types

FlowChoice

A choice resource is a standalone choice option that you can reference or reuse throughout the flow. It extends FlowElement and inherits

all of its fields.

DescriptionField TypeField Name

Required. Choice label to display in the screen.stringchoiceText

Required. Valid types are:FlowDataType (enumeration of type

string)

dataType

•Currency

•Date

•Number

•String

•Boolean

Enables the choice to allow user input when the choice is

selected. Not supported for choices in multi-select fields.

FlowChoiceUserInputuserInput

Actual value that’s used during flow execution, for example,

in assignments, calls to Apex plug-ins, and record elements. If

null, this choice always has the value of null.

FlowElementReferenceOrValuevalue

FlowChoiceUserInput

Allows the choice to include a user input field that appears when the choice is selected by the user. User input isn’t supported for choices

in multi-select fields. It extends FlowBaseElement and inherits all of its fields.

DescriptionField TypeField Name

Indicates whether users are required to enter something into the

field when they select the choice.

booleanisRequired

Text that is displayed to prompt the user for input at runtime.

Supports merge fields.

stringpromptText

Rule used at runtime to validate the user input.FlowInputValidationRulevalidationRule

FlowCondition

Defines a condition for a rule. It extends FlowBaseElement and inherits all of its fields.

DescriptionField TypeField Name

Required. Unique name of the element that serves as the

left side of the condition expression.

stringleftValueReference

Required. Valid values are:FlowComparisonOperator

(enumeration of type string)

operator

•EqualTo

379

FlowMetadata Types

DescriptionField TypeField Name

•NotEqualTo

•GreaterThan

•LessThan

•GreaterThanOrEqualTo

•LessThanOrEqualTo

•StartsWith

•EndsWith

•Contains

•IsNull

•WasSet—This value is available in API version 30.0 and

later.

•WasSelected—Requires a choice on the left side.

•WasVisited—Requires a node on the left side.

Unique name of an element or the actual value (such as text

or a number) for the right side of the condition expression.

FlowElementReferenceOrValuerightValue

FlowConnector

Connectors determine the order in which the nodes of the flow are executed. A connector defines and links to the subsequent node. It

extends FlowBaseElement and inherits all of its fields.

DescriptionField TypeField Name

Required. Which node to execute after completing the current

node.

stringtargetReference

FlowConstant

A constant resource defines a fixed value that can be used throughout your flow. It extends FlowElement and inherits all of its fields.

DescriptionField TypeField Name

Required. Valid types are:FlowDataType (enumeration of type

string)

dataType

•Currency

•Date

•Number

•String

•Boolean

380

FlowMetadata Types

DescriptionField TypeField Name

Default value of the constant. This field can't have merge fields, nor

can it reference another resource besides

$GlobalConstant.EmptyString.

FlowElementReferenceOrValuevalue

FlowDecision

Decision node that evaluates a set of rules and routes the flow execution based on the first rule that evaluates to true. It extends FlowNode

and inherits all of its fields.

DescriptionField TypeField Name

Specifies which node to execute if none of the rules evaluate to

true.

FlowConnectordefaultConnector

Label for the default connector.stringdefaultConnectorLabel

An array of rules for the decision. The rules are evaluated in the

order they're listed, and the connector of the first true rule is used.

FlowRule[]rules

If no rules are true, then the default connector is used. In the Cloud

Flow Designer, rules are referred to as “outcomes.”

FlowDynamicChoiceSet

Looks up data or metadata from an sObject and dynamically generates a set of choices at run time. It extends FlowElement and inherits

all of its fields. Depending on the fields that are set, this element represents either a record choice or a picklist choice.

•A record choice dynamically generates choices based on records that meet specified filter criteria. If a dynamic choice doesn’t have

the picklistField and picklistObject parameters set, it is a record choice and can’t have a data type of Picklist

or Multipicklist.

•A picklist choice dynamically generates choices based on the available values for a picklist or multi-select picklist field. If a dynamic

choice has the picklistField and picklistObject parameters set, it is a picklist choice and must have a data type of

Picklist or Multipicklist.

Note: You can’t reference sObject custom fields of type Geolocation anywhere in a flow. For example, Geolocation fields can’t

be used in record filters, in input or output field assignments, or as display, value, or sort fields.

DescriptionField TypeField Name

Required. Valid types are:FlowDataType (enumeration of type

string)

dataType

•Currency

•Date

•Number

•String

•Boolean

•Picklist—Picklist choices only

•Multipicklist—Picklist choices only

381

FlowMetadata Types

DescriptionField TypeField Name

Picklist and Multipicklist are available in API

version 35.0 and later.

Required for record choices. Which field from the sObject

to display to the user as choice labels.

For example, for an account, use the DisplayField “Name” if

you want the dynamically generated choices to be displayed

stringdisplayField

as the account names from the records that are retrieved

from the database.

Not supported for picklist choices. Picklist choices always

display the labels for the retrieved picklist values.

An array of filters to apply to the records that are retrieved

from the database. For example, you may want to filter

FlowRecordFilter[]filters

accounts to include only those that were created in the past

three months.

Not supported for picklist choices.

Maximum number of choices to include in the generated

set of choices. Maximum and default: 200.

If sortField and sortOrder are also specified, the

records are sorted before the limit takes effect.

intlimit

This field is available in API version 25.0 and later.

Required for record choices. The sObject whose fields you

want to retrieve from the database and use to generate the

stringobject

set of choices. For example, use “Account” to dynamically

generate choices from the information in account records

in the database.

Not supported for picklist choices.

An array that assigns fields from the user-selected record to

variables that can be used elsewhere in the flow. For

FlowOutputFieldAssignment[]outputAssignments

example, when the user selects an account name from the

dynamically generated list of choice options,

outputAssignments can assign the Id and AnnualRevenue

from the user-selected account to variables that you specify.

Not supported for picklist choices.

Required for picklist choices. The field whose available values

you want to retrieve from the database and use to generate

stringpicklistField

the picklist choice. For example, use “Industry” to dynamically

generate one choice for each available value on the Industry

picklist field.

Not supported for record choices.

382

FlowMetadata Types

DescriptionField TypeField Name

This field is available in API version 35.0 and later.

Required for picklist choices. The sObject whose field

metadata you want to retrieve from the database and use

stringpicklistObject

to generate the picklist choice. For example, use “Account”

to dynamically generate choices from a picklist field on the

Account object.

Not supported for record choices.

This field is available in API version 35.0 and later.

Field that is used for sorting the records that meet the filter

criteria. If this field isn’t specified then the returned records

are not sorted.

You can only sort records by fields that have the Sort API

field property, as specified in SOAP API.

stringsortField

Not supported for picklist choices.

This field is available in API version 25.0 and later.

Order in which to sort the records. If this field isn’t specified,

then the results are not sorted.

Valid values are:

SortOrder (enumeration of type string)sortOrder

•Asc—Ascending

•Desc—Descending

Not supported for picklist choices.

This field is available in API version 25.0 and later.

Stored value for the choice, which may differ from what is

displayed to the user as the choice options

stringvalueField

(displayField). For example, the displayField

may be the account “Name” while the valueField is the

account “Id.”

Not supported for picklist choices. Picklist choices always

store the API value for the retrieved picklist values.

FlowElement

Base class for all flow elements. This is an abstract class. It extends FlowBaseElement and inherits all of its fields.

DescriptionField TypeField Name

Description of the flow element.stringdescription

Required. Unique name of the flow element.stringname

383

FlowMetadata Types

FlowBaseElement

Base class for all flow elements that require contextual information in metadata values. This is an abstract class. FlowBaseElement is

available in API version 32.0 and later.

DescriptionField TypeField Name

Contextual information for the element.FlowMetadataValue[]processMetadataValues

FlowMetadataValue

Defines contextual information that can be passed between elements in a flow. Flow metadata values can be used in an application

that produces or consumes flows. FlowMetadataValue is available in API version 31.0 and later.

DescriptionField TypeField Name

Required. Name for the metadata value. This name doesn’t need

to be unique across all elements.

stringname

Reference or value for the metadata value.FlowElementReferenceOrValuevalue

FlowElementReferenceOrValue

Defines a reference to an existing element or a particular value that you specify. Make sure that you specify only one of the fields.

DescriptionField TypeField Name

Use this field to specify a boolean value. Do not use this field if you want to

specify a different data type or an element reference.

booleanbooleanValue

Use this field to specify a dateTime value. Do not use this field if you want to

specify a different data type or an element reference. This field is available in API

version 30.0 and later.

dateTimedateTimeValue

Use this field to specify a date value. Do not use this field if you want to specify

a different data type or an element reference.

datedateValue

Use this field to specify the name of an existing element. Do not use this field if

you want to specify a value instead of an element reference.

stringelementReference

Use this field to specify a double value. Do not use this field if you want to specify

a different data type or an element reference.

doublenumberValue

Use this field to specify a string value. Do not use this field if you want to specify

a different data type or an element reference.

stringstringValue

FlowFormula

Calculates a value using functions and elements in the flow. It extends FlowElement and inherits all of its fields.

384

FlowMetadata Types

DescriptionField TypeField Name

The data type for the formula. Valid values are:FlowDataType (enumeration

of type string)

dataType

•Boolean

•Currency

•Date

•DateTime

•Number

•String

dataType defaults to Number if it isn’t defined in a formula.

This field is available in API version 31.0 and later.

Required. Salesforce formula expression. The return value must

match the data type. See “Limitations for Flow Formulas” in the

Salesforce Help.

For API version 30.0 and earlier, the return value must be numeric.

stringexpression

Scale of the return value, specifically, the number of digits to the

right of the decimal point. Only supported for Currency and Number

data types.

intscale

FlowInputFieldAssignment

Assigns the value for a record field based on a resource or static value. It extends FlowBaseElement and inherits all of its fields.

Note: You can’t reference sObject custom fields of type Geolocation anywhere in a flow. For example, Geolocation fields can’t

be used in record filters, in input or output field assignments, or as display, value, or sort fields.

DescriptionField TypeField Name

Required. Name of the field that is to be assigned a value while a

record is being created or updated.

stringfield

Value that is to be assigned to the field.FlowElementReferenceOrValuevalue

FlowInputValidationRule

Validation rules verify that the data entered by the user meets the specified requirements. If the validation rule evaluates to false, then

the specified error message is displayed.

DescriptionField TypeField Name

Required. Error message to display when formulaExpression

evaluates to false.

stringerrorMessage

Required. Boolean formula used to validate the user input. See

“Limitations for Flow Formulas” in the Salesforce Help.

stringformulaExpression

385

FlowMetadata Types

FlowLoop

A construct for iterating through a collection. It extends FlowNode and inherits all of its fields. FlowLoop is available in API version 30.0

and later.

DescriptionField TypeField Name

Points to the element that the flow navigates to for each of the entries in the

collection. This is where the flow goes for the next value in the collection.

FlowConnectornextValueConnector

Points to the element to navigate to when all entries in the collection have been

looped through.

FlowConnectornoMoreValuesConnector

Required. The collection being looped through.stringcollectionReference

Required. The variable to which the current value in the collection is assigned

before navigating to the target of nextValueConnector.

stringassignNextValueToReference

Valid values are:iterationOrder

(enumeration of

type string)

iterationOrder

•Asc—Iterate through the collection in the order the values are listed (first

to last).

•Desc—Iterate through the collection in the reverse order the values are

listed (last to first).

FlowNode

A node is a type of element that is visible in the flow diagram. It extends FlowElement and inherits all of its fields.

DescriptionField TypeField Name

Required. Name of the node. This non-unique label is different from the unique

name of the node, which is inherited from FlowElement.

stringlabel

Required. Horizontal location of the node, in pixels from the left.intlocationX

Required. Vertical location of the node, in pixels from the top.intlocationY

FlowOutputFieldAssignment

Assigns an record field’s value from a record to a variable that can be used elsewhere in the flow. The record may be selected by a record

lookup or via a user selection for a choice. It extends FlowBaseElement and inherits all of its fields.

Note: You can’t reference sObject custom fields of type Geolocation anywhere in a flow. For example, Geolocation fields can’t

be used in record filters, in input or output field assignments, or as display, value, or sort fields.

DescriptionField TypeField Name

Required. Reference to the variable where you want to store the

value of the record field.

stringassignToReference

386

FlowMetadata Types

DescriptionField TypeField Name

Required. Name of the field whose value is to be assigned after a

record lookup.

stringfield

FlowRecordCreate

Create a new record in the database using values from the flow. It extends FlowNode and inherits all of its properties.

Note: The flow record create, lookup, update, and delete operations are different from the CRUD-based metadata calls create(),

retrieve(), update(), and delete(). The flow record methods apply to record operations from within a flow, which

aren’t the same as doing any metadata calls to CRUD setup entities.

You can’t reference sObject custom fields of type Geolocation anywhere in a flow. For example, Geolocation fields can’t be used

in record filters, in input or output field assignments, or as display, value, or sort fields.

DescriptionField TypeField Name

Reference to the variable where you want to store the

ID after the record is created.

stringassignRecordIdToReference

Specifies which node to execute after creating the record.FlowConnectorconnector

Specifies which node to execute if the attempt to create

a record results in an error.

FlowConnectorfaultConnector

An array that assigns values to the specified fields of the

record being created.

FlowInputFieldAssignment[]inputAssignments

Required. sObject for the record to be created by this

element

stringobject

Specifies the sObject variable whose field values are used

to populate the new record’s fields.

stringinputReference

FlowRecordDelete

Deletes one or more records in the database. It extends FlowNode and inherits all of its fields.

Note: The flow record create, lookup, update, and delete operations are different from the CRUD-based metadata calls create(),

retrieve(), update(), and delete(). The flow record methods apply to record operations from within a flow, which

aren’t the same as doing any metadata calls to CRUD setup entities.

You can’t reference sObject custom fields of type Geolocation anywhere in a flow. For example, Geolocation fields can’t be used

in record filters, in input or output field assignments, or as display, value, or sort fields.

DescriptionField TypeField Name

Specifies which node to execute after deleting the record.FlowConnectorconnector

Specifies which node to execute if the attempt to delete a record results

in an error.

FlowConnectorfaultConnector

387

FlowMetadata Types

DescriptionField TypeField Name

An array that specifies the criteria used to select which records to delete

from the database. For example, you may want to delete accounts whose

last activity was older than a specified date.

FlowRecordFilter[]filters

Required. The name of the object whose records are deleted.stringobject

Specifies the sObject variable whose record ID is used to identify which

record to delete in the database.

stringinputReference

FlowRecordFilter

Sets the criteria for searching records in the database. It extends FlowBaseElement and inherits all of its fields.

Note: You can’t reference sObject custom fields of type Geolocation anywhere in a flow. For example, Geolocation fields can’t

be used in record filters, in input or output field assignments, or as display, value, or sort fields.

DescriptionField TypeField Name

Required. The field to be used for filtering records.stringfield

Required. Valid values are:FlowRecordFilterOperator (enumeration

of type string)

operator

•EqualTo

•NotEqualTo

•GreaterThan

•LessThan

•GreaterThanOrEqualTo

•LessThanOrEqualTo

•StartsWith

•EndsWith

•Contains

•IsNull

Reference or value used with the field and operator to filter records.FlowElementReferenceOrValuevalue

FlowRecordLookup

Finds a record in the database and uses or stores the values from its fields in the flow. It extends FlowNode and inherits all of its fields.

Note: The flow record create, lookup, update, and delete operations are different from the CRUD-based metadata calls create(),

retrieve(), update(), and delete(). The flow record methods apply to record operations from within a flow, which

aren’t the same as doing any metadata calls to CRUD setup entities.

You can’t reference sObject custom fields of type Geolocation anywhere in a flow. For example, Geolocation fields can’t be used

in record filters, in input or output field assignments, or as display, value, or sort fields.

388

FlowMetadata Types

DescriptionField TypeField Name

Specifies that all values are set to null if the record is not

found. This field is available in API version 30.0 and later.

booleanassignNullValuesIfNoRecordFound

Specifies which node to execute after completing the record

lookup.

FlowConnectorconnector

Specifies which node to execute if the attempt to look up a

record results in an error.

FlowConnectorfaultConnector

An array that specifies the criteria used to select the record

from the database.

If the filters return more than one record, they are sorted

according to the specified sortField and sortOrder.

The first record in the sorted list is then selected.

FlowRecordFilter[]filters

If either the sortField or sortOrder is not specified,

then the first record returned is selected. Note, however, that

records are not returned in any particular order.

The maximum number of records to return, to limit the

amount of data received. This field is available in API version

30.0 and later.

intlimit

Required. Name of the sObject from which to select the

record.

stringobject

An array that assigns fields from the selected record to

variables that can be used elsewhere in the flow.

FlowOutputFieldAssignment[]outputAssignments

Specifies the sObject variable that stores the queried fields’

values.

stringoutputReference

An array that specifies which fields from the selected record

is saved to the specified sObject variable.

string[]queriedFields

Field that is used for sorting the records that meet the filter

criteria. If this field isn’t specified then the returned records

are not sorted.

You can only sort records by fields that have the Sort API

field property, as specified in SOAP API.

stringsortField

This field is available in API version 25.0 and later.

Order in which to sort the records. If this field isn’t specified,

then the results are not sorted.

Valid values are:

SortOrder (enumeration of type

string)

sortOrder

•Asc—Ascending

•Desc—Descending

This field is available in API version 25.0 and later.

389

FlowMetadata Types

FlowRecordUpdate

Finds records in the database and updates them with values from the flow. It extends FlowNode and inherits all of its fields.

Note: The flow record create, lookup, update, and delete operations are different from the CRUD-based metadata calls create(),

retrieve(), update(), and delete(). The flow record methods apply to record operations from within a flow, which

aren’t the same as doing any metadata calls to CRUD setup entities.

You can’t reference sObject custom fields of type Geolocation anywhere in a flow. For example, Geolocation fields can’t be used

in record filters, in input or output field assignments, or as display, value, or sort fields.

DescriptionField TypeField Name

Specifies which node to execute after completing the record

update.

FlowConnectorconnector

Specifies which node to execute if the attempt to update a

record results in an error.

FlowConnectorfaultConnector

An array that specifies the criteria used to select the records to

update in the database.

FlowRecordFilter[]filters

An array that assigns values to the specified fields of the record

being updated.

FlowInputFieldAssignment[]inputAssignments

Required. Name of the sObject whose records are updated.stringobject

Specifies the sObject variable whose field values is used to

update the record’s fields.

stringinputReference

FlowRule

Defines the conditions and logic that would enable a rule to evaluate to true. It extends FlowElement and inherits all of its fields.

DescriptionField TypeField Name

Specifies logic for the conditions. Value can be:stringconditionLogic

•and—evaluates to true only if all of its conditions evaluate to

true

•or—evaluates to true if any of its conditions evaluate to true

•Advanced logic like 1 AND (2 OR 3)—evaluates to true

if the first condition is true and either the second or third

condition is true

When you use advanced logic, the string must consist of 1,000

or fewer characters.

Advanced logic is available in API version 33.0 and later.

An array of conditions for the rule.FlowCondition[]conditions

Specifies which node to execute if this is the first rule that evaluates

to true in a decision.

FlowConnectorconnector

390

FlowMetadata Types

DescriptionField TypeField Name

Required. Label for the connector.stringlabel

FlowScreen

Screens provide the ability to capture information from users and display information to users. It extends FlowNode and inherits all of

its fields.

DescriptionField TypeField Name

Indicates whether to show (true) or hide (false) the Previous button

on the screen at runtime. When true, the Previous button appears

booleanallowBack

only if the user visited a previous screen in the flow path. Set this

to false when revisiting the previous screen would trigger an action

that should not be repeated, such as a credit card transaction.

This field is available in API version 26.0 and later.

Default: true

You can set either allowBack or allowFinish to false, but

not both.

Indicates whether to show (true) or hide (false) the Finish button

on the screen at runtime. When true, the Finish button appears

booleanallowFinish

only if the screen element is the end of a flow path. Set this to false

if you need the user to go back to a previous screen to continue or

complete the flow. For example, you wouldn’t want to offer a Finish

button on a screen that tells the user to go back and make

corrections on a previous screen.

This field is available in API version 26.0 and later.

Default: true

You can set either allowBack or allowFinish to false, but

not both.

Indicates whether to show (true) or hide (false) the Pause button

on the screen at runtime.

A flow screen displays the Pause button if all of the following

conditions are true.

booleanallowPause

•In the organization’s process automation settings, “Enable Users

to Pause Flows” is enabled.

•allowPause for the screen is set to true.

•If the flow is embedded in a Visualforce page, the

<flow:interview> component has its showAllowPause

attribute set to true.

This field is available in API version 33.0 and later.

Default: true

391

FlowMetadata Types

DescriptionField TypeField Name

Specifies which node to execute after the screen node.FlowConnectorconnector

An array of fields to display on the screen.FlowScreenField[]fields

Text that appears if the end user clicks the “Help for this form” link.

Supports merge fields in API version 26.0 and later.

stringhelpText

Confirmation message that appears when an end-user clicks Pause.

This field is available in API version 33.0 and later.

stringpausedText

Reserved for future use.FlowScreenRule[][]rules

FlowScreenField

Configurable field on a screen. It extends FlowElement and inherits all of its fields.

DescriptionField TypeField Name

An array of references to FlowChoices or

FlowDynamicChoiceSets. The resulting choice

string[]choiceReferences

options appear in the order specified in this

array, where the element at index 0 provides

the top-most choice option. Supported for the

following screen field types:

•RadioButtons

•DropdownBox

•MultiSelectCheckboxes

•MultiSelectPicklist

Multi-select checkboxes and multi-select

picklist fields are available in API version 26.0

and later.

Required. Data type of this screen field. Only

supported for the InputField, RadioButtons, and

FlowDataType (enumeration of type

string)

dataType

DropdownBox screen field types. Valid types

are:

•Currency

•Date

•Number

•String

•Boolean

A boolean InputField appears as a checkbox

field at runtime. Checkbox input fields are

available in API version 26.0 and later.

392

FlowMetadata Types

DescriptionField TypeField Name

Only the string data type is supported for

multi-select checkboxes and multi-select

picklist fields. Multi-select fields are available

in API version 26.0 and later.

The name of the FlowChoice element to use

as the default value for the screen field.

Supported for the following screen field types:

stringdefaultSelectedChoiceReference

•RadioButtons

•DropdownBox

•MultiSelectCheckboxes

•MultiSelectPicklist

For DropdownBox field types only, if the

defaultSelectedChoiceReference is empty or

null, the reference at index 0 of

choiceReferences are used as the default value.

You can specify only one FlowChoice element

as the default value for multi-select checkboxes

and multi-select picklist fields. Multi-select

fields are available in API version 26.0 and later.

The value that is used by default when this

screen field requires users to provide input.

FlowElementReferenceOrValuedefaultValue

Only supported for InputField, LargeTextArea,

and PasswordField.

Field label that is displayed on the screen.

Supports merge fields.

stringfieldText

Required. Valid values are:FlowScreenFieldType (enumeration

of type string)

fieldType

•DisplayText

•InputField

•LargeTextArea

•PasswordField

•RadioButtons

•DropdownBox

•MultiSelectCheckboxes

•MultiSelectPicklist

At runtime, each multi-select field stores its

field value as a concatenation of the

user-selected choice values, separated by

semicolons. Any semicolons in the selected

choice values are removed when added to the

multi-select field value.

393

FlowMetadata Types

DescriptionField TypeField Name

Multi-select checkboxes and multi-select

picklist fields are available in API version 26.0

and later.

Required. Text that appears if the end user

clicks the help icon ( ) for the screen field.

Supports merge fields in API version 26.0 and

later.

stringhelpText

Indicates whether the user must select a choice

or provide input. Not supported for DisplayText

or boolean inputField.

booleanisRequired

Reserved for future use.booleanisVisible

The scale of this screen field if its data type is

number or currency. The scale sets the number

of digits to the right of the decimal point.

intscale

Rule used to validate the user input when this

screen field is of type InputField, LargeTextArea,

or PasswordField.

FlowInputValidationRulevalidationRule

FlowStep

Steps function as placeholders when you're building a flow. It extends FlowNode and inherits all of its fields.

DescriptionField TypeField Name

Specifies which node to execute after the step node.FlowConnector[]connectors

FlowSubflow

A subflow element references another flow, which it calls at run time. The flow that contains the subflow element is referred to as the

master flow. FlowSubflow extends FlowNode and inherits all of its fields. It is available in API version 25.0 and later.

DescriptionField TypeField Name

Specifies which node to execute after the subflow.FlowConnectorconnector

References the flow to call at runtime. The value must

be a unique name of a flow and can’t contain an

stringflowName

appended hyphen and version number. The referenced

flow must have been created in the Cloud Flow Designer.

An array of input variable assignments that are set at the

start of the referenced flow.

FlowSubflowInputAssignment[]inputAssignments

394

FlowMetadata Types

DescriptionField TypeField Name

An array of output variable assignments that are set at

the end of the referenced flow.

FlowSubflowOutputAssignment[]outputAssignments

FlowSubflowInputAssignment

Assigns an element or value from the master flow to a variable in the referenced flow. Input assignments occur when the subflow calls

the referenced flow. It extends FlowBaseElement and inherits all of its fields. It is available in API version 25.0 and later.

DescriptionField TypeField Name

Required. Unique name for the variable in the referenced

flow.

stringname

Defines the value to assign to the variable.FlowElementReferenceOrValuevalue

FlowSubflowOutputAssignment

Assigns the value of a variable from the referenced flow to a variable in the master flow. Output assignments occur when the referenced

flow is finished running. It extends FlowBaseElement and inherits all of its fields. It is available in API version 25.0 and later.

DescriptionField TypeField Name

Required. Unique name for the variable in the master flow.stringassignToReference

Required. Unique name for the variable in the referenced flow.stringname

FlowTextTemplate

Defines a text template that can be used throughout the flow. It extends FlowElement and inherits all of its fields.

DescriptionField TypeField Name

Actual text of the template. Supports merge fields.stringtext

FlowVariable

Variables allow you to create updatable values to use in the flow. FlowVariable extends FlowElement and inherits all of its fields.

DescriptionField TypeField Name

Required. Valid types are:FlowDataType (enumeration of type string)dataType

•Boolean

•Currency

•Date

395

FlowMetadata Types

DescriptionField TypeField Name

•DateTime—This value is available in

API version 30.0 and later.

•Number

•Multipicklist—This value is

available in API version 34.0 and later.

•Picklist—This value is available in

API version 34.0 and later.

•String

•sObject

Indicates whether the variable is a collection

of values. This field is available in API version

booleanisCollection

30.0 and later. In API version 32.0 and later,

a collection variable can be of any data type.

Default value is False.

Indicates whether the variable can be set at

the start of the flow using URL parameters,

booleanisInput

Visualforce controllers, or subflow inputs.

This field is available in API version 25.0 and

later.

Default value:

•False for a variable created in API

version 25.0 and later or in the Cloud

Flow Designer in Summer ’12 and later.

•True for a variable created in API

version 24.0 or in the Cloud Flow

Designer in Spring ’12 and earlier.

Warning: Disabling input or output

access for an existing variable can

break the functionality of

applications and pages that call the

flow and access the variable. For

example, you can access variables

from URL parameters, Visualforce

controllers, subflows, and processes.

Indicates whether the variable’s value can

be accessed from Visualforce controllers and

booleanisOutput

other flows. This field is available in API

version 25.0 and later.

Default value:

396

FlowMetadata Types

DescriptionField TypeField Name

•False for a variable created in API

version 25.0 and later or in the Cloud

Flow Designer in Summer ’12 and later.

•True for a variable created in API

version 24.0 or in the Cloud Flow

Designer in Spring ’12 and earlier.

Warning: Disabling input or output

access for an existing variable can

break the functionality of

applications and pages that call the

flow and access the variable. For

example, you can access variables

from URL parameters, Visualforce

controllers, subflows, and processes.

Object type of this variable if its data type is

sObject.

stringobjectType

Scale of this variable if its data type is

Number or Currency.

intscale

Default value of this variable.

Default values aren’t supported if the

variable’s data type is Picklist or

Multipicklist.

FlowElementReferenceOrValuevalue

FlowWait

Waits for one or more defined events to occur. FlowWait extends FlowNode and inherits all of its fields. FlowWait is available in API

version 32.0 and later.

DescriptionField TypeField Name

Specifies which node to execute if the

conditions are false for every event in the

Wait element.

FlowConnectordefaultConnector

Label for the default connector.stringdefaultConnectorLabel

Specifies which node to execute if the

attempt to wait results in an error. If any of

FlowConnectorfaultConnector

the wait events fail, the flow takes the fault

connector.

397

FlowMetadata Types

DescriptionField TypeField Name

An array of events that the Wait element is

waiting for.

If the conditions for every event evaluate to

false, the defaultConnector is

used.

FlowWaitEvent[]waitEvents

FlowWaitEvent

An event that a FlowWait element is waiting for. FlowWaitEvent extends FlowElement and inherits all of its fields. FlowWaitEvent is

available in API version 32.0 and later.

DescriptionField TypeField Name

Specifies logic for the conditions. Value can

be:

stringconditionLogic

•and—evaluates to true only if all of its

conditions evaluate to true

•or—evaluates to true if any of its

conditions evaluate to true

•Advanced logic like 1 AND (2 OR

3)—evaluates to true if the first

condition is true and either the second

or third condition is true

When you use advanced logic, the

string must consist of 1,000 or fewer

characters.

Advanced logic is available in API version

33.0 and later.

An array of conditions that must be true for

the flow to wait for this event.

FlowConditionconditions

Specifies which node to execute if this is the

first event that occurs.

FlowConnectorconnector

Required. The event’s type. The type

determines which input parameters are

stringeventType

available to define this event. Valid values

are:

•AlarmEvent—This event is an alarm

based off of an absolute date/time

value.

•DateRefAlarmEvent—This event

is an alarm based off of a date/time field

on a record.

398

FlowMetadata Types

DescriptionField TypeField Name

An array of the event’s input parameters.

The parameter values are set by using values

from the flow.

FlowWaitEventInputParameter[]inputParameters

Required. Label for the wait event.stringlabel

An array of the event’s output parameters.

The parameter values are assigned from the

event to variables in the flow.

FlowWaitEventOutputParameter[]outputParameters

FlowWaitEventInputParameter

An input parameter for FlowWaitEvent. The parameter’s value is set by using values from the flow. It extends FlowBaseElement and

inherits all of its fields. FlowWaitEventInputParameter is available in API version 32.0 and later.

DescriptionField TypeField Name

Required. Unique name for the input

parameter.

stringname

Defines the value of the input parameter.FlowElementReferenceOrValuevalue

FlowWaitEventOutputParameter

An output parameter for FlowWaitEvent. The parameter’s value is assigned to a variable in the flow so that it can be referenced in another

part of the flow. It extends FlowBaseElement and inherits all of its fields. FlowWaitEventOutputParameter is available in API version 32.0

and later.

DescriptionField TypeField Name

Required. Specifies the variable to which

you want to assign the output parameter

value.

stringassignToReference

Required. Unique name for the output

parameter.

stringname

Declarative Metadata Sample Definition

A sample XML definition of a flow is shown below.

<?xml version="1.0" encoding="UTF-8"?>

<dataType>Number</dataType>

<value>

399

FlowMetadata Types

</value>

</choices>

<name>Excellent</name>

<choiceText>Excellent</choiceText>

<dataType>Number</dataType>

<value>

</value>

</choices>

<dataType>Number</dataType>

<value>

</value>

</choices>

<dataType>Number</dataType>

<value>

</value>

</choices>

<description>Simple Flow app to calculate a Tip according to corporate

policies</description>

<name>fTipAmount</name>

<dataType>Number</dataType>

<expression>{!Bill_Amount} * {!Service_Quality} / 100</expression>

</formulas>

<name>fTotalAmount</name>

<dataType>Number</dataType>

<expression>{!fTipAmount} + {!Bill_Amount}</expression>

</formulas>

<label>Tip Calculator App</label>

<name>Simple_Tip_Calculator</name>

<label>Simple Tip Calculator</label>

<targetReference>TipAmount</targetReference>

</connector>

<name>Bill_Amount</name>

<dataType>Currency</dataType>

<fieldText>Bill Amount</fieldText>

400

FlowMetadata Types

<fieldType>InputField</fieldType>

<isRequired>false</isRequired>

</fields>

<name>Service_Quality</name>

<choiceReferences>Excellent</choiceReferences>

<dataType>Number</dataType>

<fieldText>Service Quality</fieldText>

<fieldType>RadioButtons</fieldType>

<isRequired>false</isRequired>

</fields>

</screens>

<name>TipAmount</name>

<label>Tip Amount</label>

<name>TipSUmmary</name>

<fieldText><TEXTFORMAT

LEADING="2"><P

ALIGN="LEFT"><FONT

FACE="Arial"

STYLE="font-size:12px"

COLOR="#000000"

LETTERSPACING="0"

KERNING="0">If you think the quality of

service is <FONT

KERNING="1">{!Service_Quality},

</FONT>for a meal of {!Bill_Amount} you should tip

{!fTipAmount}, so the total recommended amount should be

{!fTotalAmount}</FONT></P></TEXTFORMAT></fieldText>

<fieldType>DisplayText</fieldType>

</fields>

</screens>

<startElementReference>Simple_Tip_Calculator</startElementReference>

</Flow>

ExternalServiceRegistration

Represents the External Service configuration for an org. This type extends the Metadata metadata type and inherits its fullName

field.

File Suffix and Directory Location

ExternalServiceRegistration components have the suffix .externalServiceRegistration and are stored in the

externalServiceRegistrations folder.

401

ExternalServiceRegistrationMetadata Types

Version

ExternalServiceRegistration components are available as a Beta release in API version 39.0.

Note: This release contains a beta version of External Services, which means it’s a high-quality feature with known limitations.

This feature isn’t generally available unless or until Salesforce announces its general availability in documentation or in press

releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase

decisions only on the basis of generally available products and features. You can provide feedback and suggestions for External

Services in the IdeaExchange App Cloud (Platform) Integration group in the Success Community.

Fields

DescriptionField TypeField Name

Required. The external service description defined when the service is

created.

stringdescription

The service name as it appears on the External Services wizard.stringlabel

Required. The reference of the named credential to be used for the

service.

stringnamedCredential

Required. The content of the JSON schema in the Interagent format.

Nillable.

stringschema

Required. ID format of the schema, which is InteragentHyperSchema.

Nillable.

stringschemaType

Required. The schema URL defined when registering a service. The path

should begin with “/” and be a relative path.

stringschemaUrl

Indicates whether the service registration is finished (complete) or not

(incomplete).

stringstatus

Declarative Metadata Sample Definition

The following is an example of an ExternalServiceRegistration component that references an external credit service.

<?xml version="1.0" encoding="UTF-8"?>

<label>creditService</label>

<namedCredential>AcmeCreditService</namedCredential>

<schema>/schema</schema>

<schemaType>InteragentHyperSchema</schemaType>

<schemaUrl>http://interagent.github.io/interagent-hyper-schema</schemaUrl>

<status>complete</status>

</ExternalServicesRegistration>

FlowDefinition

Represents the flow definition’s description and active flow version number.

402

FlowDefinitionMetadata Types

To activate a flow, modify the metadata object and set the activeVersionNumber to the version number to activate. To deactivate

an active flow version, set the activeVersionNumber to 0 (zero) or omit the value.

Declarative Metadata File Suffix and Directory Location

FlowDefinitions are stored in the flowDefinitions directory of the corresponding package directory. The file name matches the

flow definition’s unique full name, and the extension is .flowDefinition.

Version

FlowDefinition is available in API version 34.0 and later.

DescriptionField TypeField Name

The version number of the active flow.intactiveVersionNumber

Description of the flow definition.stringdescription

Label for the flow definition.stringmasterLabel

Folder

Represents a folder. This type extends the Metadata metadata type and inherits its fullName field. Four folder types currently exist

in Salesforce:

•Document folder

•Email folder

•Report folder

•Dashboard folder

Folder type names end with the “Folder” suffix. For example, the type name of an email folder is “EmailFolder”.

File Suffix and Directory Location

Folders are stored in the corresponding component directory of the package. These directories are named documents, email,

reports, and dashboards. Folders do not have a text file representation—they are containers for files. For each folder, an

accompanying metadata file named FolderName-meta.xml is created at the same directory level. The

FolderName-meta.xml metadata file contains the metadata information for that folder, such as the accessType. For example,

for a documents folder named sampleFolder, there’s a sampleFolder-meta.xml within the documents folder of the package.

Version

Folders are available in API version 11.0 and later.

Fields

This metadata type contains the following fields:

403

FolderMetadata Types

DescriptionField TypeField Name

Required. The type of access for this folder. Valid values are:FolderAccessTypes

(enumeration of

type string)

accessType

•Shared. This folder is accessible only by the specified set of users.

•Public. This folder is accessible by all users, including portal users.

•PublicInternal. This folder is accessible by all users, excluding

portal users. This setting is available for report and dashboard folders

in organizations with a partner portal or Customer Portal enabled.

•Hidden. This folder is hidden from all users.

The name used as a unique identifier for API access. The fullName

can contain only underscores and alphanumeric characters. It must be

stringfullName

unique, begin with a letter, not include spaces, not end with an

underscore, and not contain two consecutive underscores. This field is

inherited from the Metadata component.

Required. The name of the document folder.stringname

If Public is the value for accessType, this field indicates the type

of access all users will have to the contents of the folder. Valid values

include:

PublicFolderAccess

(enumeration of

type string)

publicFolderAccess

•ReadOnly. All users can read the contents of the folder, but no

user can change the contents.

•ReadWrite. All users can read or change the contents of the

folder.

Sharing access for the folder. See “Sharing Considerations” in the

Salesforce online help.

SharedTosharedTo

Declarative Metadata Sample Definition

The following is the package manifest definition of a document folder that contains a document:

<?xml version="1.0" encoding="UTF-8"?>

<fullName>basic</fullName>

<types>

<members>sampleFolder</members>

<members>sampleFolder/TestDocument.txt</members>

<name>Document</name>

</types>

</Package>

The following is an example of the sampleFolder-meta.xml metadata file for the sampleFolder document folder:

<?xml version="1.0" encoding="UTF-8"?>

<accessType>Public</accessType>

<name>sampleFolder</name>

404

FolderMetadata Types

<publicFolderAccess>ReadWrite</publicFolderAccess>

</DocumentFolder>

SEE ALSO:

Dashboard

Document

EmailTemplate

Report

FolderShare

Represents the settings for enhanced analytics folder sharing. Users can control access to reports or dashboards by giving others Viewer,

Editor or Manager access to the folder that contains the report or dashboard.

File Suffix and Directory Location

FolderShare objects are stored in the reports and dashboards directories. For each report or dashboard folder it contains, there

is a metadata file named FolderName-meta.xml. The FolderName-meta.xml metadata file contains the metadata

information for that folder, such as the accessLevel. For example, if the reports directory contains a reports folder named

myReportsFolder, it also has a myReportsFolder-meta.xml file at the same level as myReportsFolder.

Version

FolderShare components are available in API version 28 and later.

Fields

DescriptionField TypeField Name

Required. Specifies the combination of actions that can be taken on

the folder. Valid values are:

FolderShareAccessLevel

(enumeration of type string)

accessLevel

•View. User can run a report or refresh a dashboard, but can’t edit

them. All users have at least Viewer access to report and dashboard

folders that have been shared with them. (Some users may have

administrative permissions that give them greater access.)

•EditAllContents. Users can view and modify the reports or

dashboards in the folder, and move them to and from any other

folders that they have equivalent access to.

•Manage. Users can do everything Viewers and Editors can do,

plus control other users’ access to a folder.

Required. Specifies the user, group, or role that has the specified access

level to the folder.

stringsharedTo

405

FolderShareMetadata Types

DescriptionField TypeField Name

Required. Specifies the type of entity that the folder is shared with.

Valid values are:

FolderSharedToType(enumeration

of type string)

sharedToType

•Group. Users in a specified public group have the specified access

level to the folder.

•Manager. Available in API version 29.0 and later.

•ManagerAndSubordinatesInternal. Available in API

version 29.0 and later.

•Role. Users with a specified role have the specified access level

to the folder.

•RoleAndSubordinates. Users with a specified role, and users

with a role subordinate to that role, have the specified access level

to the folder.

•RoleAndSubordinatesInternal. Users with a specified

role and users with a role subordinate to that role, except public

portal users, have the specified access level to the folder.

•Organization. All internal users have the specified access level

to the folder.

•Territory. Users in a specified territory have the specified

access level to the folder.

•TerritoryAndSubordinates. Users in a specified territory,

and users in territories subordinate to that, have the specified access

level to the folder.

•AllPrmUsers. All PRM Portal users have the specified level of

access to the folder.

•User. The specified individual user has the specified level of access

to the folder.

•PartnerUser. The specified individual user of a partner portal

has the specified level of access to the folder.

•AllCspUsers. All Customer Success Portal users have the

specified level of access to the folder.

•CustomerPortalUser. The specified individual user of a

customer portal has the specified level of access to the folder.

•PortalRole. Users with a specified role in a portal have the

specified access level to the folder.

•PortalRoleAndSubordinates. Portal users with a specified

role, and portal users with a role subordinate to that role, have the

specified access level to the folder.

406

FolderShareMetadata Types

Declarative Metadata Sample Definition

The following is an example of a FolderShare component for a dashboard folder:

<?xml version="1.0" encoding="UTF-8"?>

</folderShares>

</DashboardFolder>

This is an example of a FolderShare component for a report folder:

<?xml version="1.0" encoding="UTF-8"?>

</folderShares>

</ReportFolder>

GlobalPicklist

Represents a global picklist, or the set of shared picklist values that custom picklist fields can use. (In contrast, the custom picklist fields

that are based on a global picklist are of type CustomValue.) This type extends the Metadata metadata type and inherits its fullName

field.

File Suffix and Directory Location

GlobalPicklist components have the suffix .globalPicklist and are stored in the globalPicklist folder.

Version

GlobalPicklist components are available in API version 37.0 only. In API version 38.0 and later, GlobalPicklist is replaced by the GlobalValueSet

on page 411 type.

Fields

DescriptionField TypeField Name

It’s useful to state the global picklist’s purpose, and which objects it’s intended

for. Limit: 255 characters.

stringdescription

Requires at least one value. The list of values (or “picklist value set”) that’s defined

for a global picklist. The picklist value set is inherited by any custom picklist

GlobalPicklistValue on

page 408[]

globalPicklistValues

field that’s based on that global picklist. Each value is of type GlobalPicklistValue.

A global picklist can have up to 1,000 total values (inclusive of inactive values).

407

GlobalPicklistMetadata Types

DescriptionField TypeField Name

Required. A global picklist’s name, which is defined when the global picklist is

created. Appears as Label in the user interface.

stringmasterLabel

Indicates whether a global picklist’s value set is sorted in alphabetical order.

By default this value is false.

stringsorted

Declarative Metadata Sample Definition

The following Territories.globalPicklist is an example of a GlobalPicklist component.

<?xml version="1.0" encoding="UTF-8"?>

<description>Updated:This is a basic global picklist</description>

<fullName>Northwest</fullName>

<default>false</default>

</globalPicklistValues>

<fullName>Northeast</fullName>

<default>false</default>

</globalPicklistValues>

<fullName>South</fullName>

</globalPicklistValues>

<fullName>Southwest</fullName>

<default>false</default>

<isActive>false</isActive>

</globalPicklistValues>

<masterLabel>Territories</masterLabel>

</GlobalPicklist>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Territories</members>

<name>GlobalPicklist</name>

</types>

</Package>

GlobalPicklistValue

Represents the definition of a value used in a global picklist. Custom picklist fields can inherit the picklist value set from a global picklist.

This type extends the Metadata metadata type and inherits its fullName field.

408

GlobalPicklistValueMetadata Types

Note: GlobalPicklistValue components don’t have file suffixes or directories because they’re lists of values and not custom fields.

For file-based operations they can be accessed through GlobalPicklist (which is in API v37.0 only).

Version

GlobalPicklistValue components are available in API version 37.0 only. In API version 38.0 and later, GlobalPicklistValue is replaced by

CustomValue on page 311.

Fields

DescriptionField TypeField Name

The color assigned to the picklist value when it’s used in charts on reports

and dashboards. The color is in hexadecimal format; for example,

stringcolor

#FF6600. If a color is not specified, it’s assigned dynamically upon chart

generation.

Required. Indicates whether this value is the default selection for the

global picklist and the custom picklists that share its picklist value set.

This field is set to true by default.

booleandefault

The global picklist value’s description. It’s useful to include a description

for a global picklist value so the reason for creating it can be tracked.

Limit: 255 characters.

stringdescription

Indicates whether this value is currently active or inactive. The default

value is true. Users can select only active values from a picklist. An API

booleanisActive

retrieve operation for global picklist values returns all active and inactive

values in the picklist. (Meanwhile, retrieving the values of a non-global,

unrestricted picklist returns only the active values.)

PicklistValue

This metadata type defines a value in the picklist and specifies whether this value is the default value. This type extends the

GlobalPicklistValue metadata type and inherits all its fields. In API version 36.0 and earlier, PicklistValue extends the Metadata type and

inherits its fullName field.

Note the following when working with picklist values:

•When you retrieve a standard object, all picklist values are retrieved, not just the customized picklist values.

•When you deploy changes to standard picklist fields, picklist values are added as needed.

•To deactivate a global picklist value, you can invoke an update() call on GlobalPicklist with the value omitted, or with the value’s

isActive field set to false. Or, you can invoke an update() call directly on GlobalPicklistValue with the isActive field

set to false.

•If picklist values are missing from a component definition, they get deactivated when deployed. Deactivation occurs for picklist

values of both standard and custom fields.

409

GlobalPicklistValueMetadata Types

DescriptionField TypeField Name

Indicates whether this value lets users email a quote PDF (true), or not

(false). This field is only relevant for the Status field in quotes. This

field is available in API version 18.0 and later.

booleanallowEmail

Indicates whether this value is associated with a closed status (true),

or not (false). This field is only relevant for the standard Status

booleanclosed

field in cases and tasks. This field is available in API version 16.0 and up

to version 36.0. In version 37.0, this field is in GlobalPicklistValue.

A list of values in the controlling field that are linked to this picklist value.

The controlling field can be a checkbox or a picklist. This field is available

string[]controllingFieldValues

in API version 14.0 and later. The values in the list depend on the field

type:

•Checkbox: checked or unchecked.

•Picklist: The fullname of the picklist value in the controlling

field.

Indicates whether this value is associated with a converted status (true),

or not (false). This field is relevant for only the standard Lead

booleanconverted

Status field in leads. Your organization can set its own guidelines for

determining when a lead is qualified, but typically, you want to convert

a lead as soon as it becomes a real opportunity that you want to forecast.

For more information, see “Convert Qualified Leads” in the Salesforce

online help. This field is available in API version 16.0 and later.

Indicates whether this value is available in your Self-Service Portal (true),

or not (false). This field is only relevant for the standard Case

Reason field in cases.

Self-Service provides an online support channel for your customers -

allowing them to resolve their inquiries without contacting a customer

booleancssExposed

service representative. For more information about Self-Service, see

“Setting Up Self-Service” in the Salesforce online help.

Note: Starting with Spring ’12, the Self-Service portal isn’t

available for new orgs. Existing orgs continue to have access to

the Self-Service portal.

This field is available in API version 16.0 and later.

Indicates whether this value is associated with a forecast category

(true), or not (false). This field is only relevant for the standard

ForecastCategories

(enumeration of

type string)

forecastCategory

Stage field in opportunities. For more information about forecast

categories, including the valid string values listed below, see “ Working

with Forecast Categories ” in the Salesforce online help.

•Omitted

•Pipeline

•BestCase

•Forecast

410

GlobalPicklistValueMetadata Types

DescriptionField TypeField Name

•Closed

This field is available in API version 16.0 and later.

Indicates whether this value is a high priority item (true), or not

(false). This field is only relevant for the standard Priority field

booleanhighPriority

in tasks. For more information about tasks, see “Considerations for Using

Tasks” in the Salesforce online help. This field is available in API version

16.0 and later.

Indicates whether this value is a probability percentage (true), or not

(false). This field is only relevant for the standard Stage field in

opportunities. This field is available in API version 16.0 and later.

intprobability

A picklist value corresponding to a reverse role name for a partner. If the

role is “subcontractor”, then the reverse role might be “general

stringreverseRole

contractor”. Assigning a partner role to an account in Salesforce creates

a reverse partner relationship so that both accounts list the other as a

partner. This field is only relevant for partner roles.

For more information, see “Partner Fields” in the Salesforce online help.

This field is available in API version 18.0 and later.

Indicates whether this value is associated with a reviewed status (true),

or not (false). This field is only relevant for the standard Status

booleanreviewed

field in solutions. For more information about opportunities, see “Creating

Solutions” in the Salesforce online help. This field is available in API

version 16.0 and later.

Indicates whether this value is associated with a closed or won status

(true), or not (false). This field is only relevant for the standard

booleanwon

Stage field in opportunities. This field is available in API version 16.0

and later.

Declarative Metadata Sample Definition

For an example of GlobalPicklistValue components with a package.xml that references them, see GlobalPicklist.

GlobalValueSet

Represents the metadata for a global picklist value set, which is the set of shared values that custom picklist fields can use. A global value

set isn't a field itself. (In contrast, the custom picklist fields that are based on a global picklist are of type ValueSet.) This type extends the

Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

GlobalValueSet components have the suffix .globalValueSet and are stored in the globalValueSets folder.

411

GlobalValueSetMetadata Types

Version

GlobalValueSet components are available in API version 38.0 and later. In API version 37.0, this is the GlobalPicklist type.

Fields

DescriptionField TypeField Name

Requires at least one value. The list of values (or “global value set”) that’s defined

for a global picklist. The global value set is inherited by any custom picklist field

CustomValue[]customValue

that uses that value set. Each value is of type customValue. A global value set

can have up to 1,000 total values (inclusive of inactive values).

It’s useful to state the global value set’s purpose, and which objects it’s intended

for. Limit: 255 characters.

stringdescription

Required. A global value set’s name, which is defined when the global value

set is created. Appears as Label in the user interface.

stringmasterLabel

Required. Indicates whether a global value set is sorted in alphabetical order.

By default this value is false.

booleansorted

Declarative Metadata Sample Definition

The following Territories.globalValueSet is an example of a GlobalValueSet component.

<?xml version="1.0" encoding="UTF-8"?>

<description>Updated:This is a basic global value set.</description>

<masterLabel>Territories</masterLabel>

<fullName>North</fullName>

</customValue>

<fullName>South</fullName>

</customValue>

</customValue>

</customValue>

</GlobalValueSet>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>

412

GlobalValueSetMetadata Types

<types>

<members>Territories</members>

<name>GlobalValueSet</name>

</types>

</Package>

GlobalValueSetTranslation

Contains details for a global value set translation. Global value sets are lists of values that can be shared by multiple custom picklist fields,

optionally across objects.This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

GlobalValueSetTranslation components have the suffix .globalValueSetTranslation and are stored in the

globalValueSetTranslations folder.

Translations are stored in a file with a format of ValueSetName-lang.globalValueSetTranslation, where

ValueSetName is the global value set’s name, and lang is the translation language.

Version

GlobalValueSetTranslation components are available in API version 38.0 and later.

Fields

DescriptionField TypeField

The translated name of a value in a translated global value set.

Each valueTranslation is paired with a masterLabel,

which is the original (untranslated) name of the value.

ValueTranslation[]valueTranslation

ValueTranslation

The original value name and the translated value name in a translated global value set.

DescriptionField TypeField

Required. The original (untranslated) name of a value in a global

value set. Each valueTranslation has a masterLabel

paired with its translation..

stringmasterLabel

The translated name of a value in a translated global value set.stringtranslation

413

GlobalValueSetTranslationMetadata Types

Declarative Metadata Sample Definition

The following is an example of a GlobalValueSetTranslation component. When a value isn’t translated, its translation becomes a comment

that’s paired with its masterLabel.

<?xml version="1.0" encoding="UTF-8"?>

<masterLabel>Three</masterLabel>

<translation>Trois</translation>

</valueTranslation>

<translation>Quatre</translation>

</valueTranslation>

</valueTranslation>

</GlobalValueSetTranslation>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Numbers-fr</members>

<name>GlobalValueSetTranslation</name>

</types>

</Package>

SEE ALSO:

Translations

Group

Represents a set of public groups, which can have users, roles, and other groups.

Declarative Metadata File Suffix and Directory Location

The file suffix for group components is .group and components are stored in the groups directory of the corresponding package

directory.

Version

Group components are available in API version 24.0 and later.

414

GroupMetadata Types

Fields

This metadata type represents the valid values that define a group:

DescriptionField TypeField Name

Indicates whether the managers have access (true) or do not have

access (false) to records shared with members of the group. This field

is only available for public groups.

booleandoesIncludeBosses

The unique identifier for API access. The fullName can contain only

underscores and alphanumeric characters. It must be unique, begin with

stringfullName

a letter, not include spaces, not end with an underscore, and not contain

two consecutive underscores. This field is inherited from the Metadata

component. Corresponds to Group Name in the user interface.

Required. The name of the group. Corresponds to Label in the user

interface.

stringname

Declarative Metadata Sample Definition

The following is the definition of a group.

<?xml version="1.0" encoding="UTF-8"?>

<fullName>admin</fullName>

</Group>

HomePageComponent

Represents the metadata associated with a home page component. You can customize the Home tab to include components such as

sidebar links, a company logo, a dashboard snapshot, or custom components that you create. For more information, see “Customizing

Home Tab Page Layouts” in the Salesforce online help. This type extends the Metadata metadata type and inherits its fullName field.

Use to create, update, or delete home page component definitions.

Declarative Metadata File Suffix and Directory Location

The file suffix for home page components is .homePageComponent and components are stored in the homepagecomponents

directory of the corresponding package directory.

Version

Home page components are available in API version 12.0 and later.

415

HomePageComponentMetadata Types

HomePageComponent

This metadata type represents the valid values that define a home page component:

DescriptionField TypeField Name

If this is an HTML page component, this is the body of the HTML.stringbody

The name can only contain characters, letters, and the underscore (_)

character, must start with a letter, and cannot end with an underscore

or contain two consecutive underscore characters.

Inherited from the Metadata component, this field is not defined in the

WSDL for this component. It must be specified when creating, updating,

stringfullName

or deleting. See create() to see an example of this field specified for

a call.

Required for Visualforce Area components. Indicates the height (in pixels)

of the component.

This field is available in API version 31.0 and later.

intheight

If the pageComponentType is links, then zero or more names

of custom page links can be specified.

string[]links

•ObjectWebLink

•CustomPageWebLink

This field is only available for Visualforce Area components and indicates

the API name of the Visualforce page that is associated with the

component.

This field is available in API version 31.0 and later.

stringpage

Required. Valid values are:PageComponentType

(enumeration of type

string)

pageComponentType

•links

•htmlArea

•imageOrNote

•visualforcePage (This value is available in API version 31.0

and later.)

This field is only available for Visualforce Area components and specifies

whether the component displays with a label (true) or not (false).

This field is available in API version 31.0 and later.

booleanshowLabel

This field is only available for Visualforce Area components and specifies

whether the component displays with scrollbars (true) or not (false).

This field is available in API version 31.0 and later.

booleanshowScrollbars

416

HomePageComponentMetadata Types

DescriptionField TypeField Name

This field is only available for HTML and Visualforce Area components,

and indicates whether this is a narrow or wide home page component.

Valid values are:

PageComponentWidth

(enumeration of type

string)

width

•narrowComponents

•wideComponents

Declarative Metadata Sample Definition

The following is the definition of a home page component. See HomePageLayout and WebLink for related samples.

<?xml version="1.0" encoding="UTF-8"?>

<page>MyVisualforcePage</page>

<pageComponentType>visualforcePage</pageComponentType>

<width>wideComponents</width>

</HomePageComponent>

SEE ALSO:

HomePageLayout

WebLink

HomePageLayout

Represents the metadata associated with a home page layout. You can customize home page layouts and assign the layouts to users

based on their user profile. For more information, see “Customizing Home Tab Page Layouts” in the Salesforce online help.

File Suffix and Directory Location

Home page layouts are stored in the homePageLayouts directory of the corresponding package directory. The extension is

.homePageLayout.

Version

Home page components are available in API version 12.0 and later. This type extends the Metadata metadata type and inherits its

fullName field.

Fields

This metadata type represents the valid values that define a home page layout:

417

HomePageLayoutMetadata Types

DescriptionField TypeField Name

The name can only contain characters, letters, and the underscore (_)

character, must start with a letter, and cannot end with an underscore

or contain two consecutive underscore characters.

Inherited from the Metadata component, this field is not defined in the

WSDL for this component. It must be specified when creating, updating,

stringfullName

or deleting. See create() to see an example of this field specified for

a call.

The list of elements in the narrow column on the left side of the home

page.

string[]narrowComponents

The list of elements in the wide column on the right side of the home

page.

string[]wideComponents

Declarative Metadata Sample Definition

The following is the definition of a home page layout. See HomePageComponent on page 417 and WebLink on page 284 for related

samples.

<?xml version="1.0" encoding="UTF-8"?>

<narrowComponents>google</narrowComponents>

</HomePageLayout>

SEE ALSO:

HomePageComponent

WebLink

InstalledPackage

Represents a package to be installed or uninstalled. Deploying a newer version of a currently installed package upgrades the package.

Note: You can’t deploy a package along with other metadata types. Hence, InstalledPackage must be the only metadata

type specified in the manifest file.

File Suffix and Directory Location

The package is specified in the installedPackages directory, in a file named after the package’s namespace prefix. The file

extension is .installedPackage.

Version

InstalledPackage is available in API version 28.0 and later.

418

InstalledPackageMetadata Types

Fields

DescriptionField TypeField Name

The version number of the package. This has the format

majorNumber.minorNumber.patchNumber (for example,

2.1.3).

stringversionNumber

An optional field specifying the package password.stringpassword

Declarative Metadata Sample Definition

This specifies a sample package to be installed or uninstalled.

<?xml version="1.0" encoding="UTF-8"?>

<password>optional_password</password>

</InstalledPackage>

KeywordList

Represents a list of keywords used in community moderation. This keyword list is a type of moderation criteria that defines offensive

language or inappropriate content that you don’t want in your community. This type extends the Metadata metadata type and inherits

its fullName field.

Keep the following things in mind when creating keyword list criteria:

•Your org can have up to 30 keyword list criteria. This limit is per org, not per community.

•A keyword list can have up to 2,000 keywords.

•Capitalization and trailing punctuation are ignored when matching your keywords to user-generated content. For example, if your

criteria includes BadWord, it’s matched when a user types BADWORD or badword.

File Suffix and Directory Location

KeywordList components have the suffix .keywords and are stored in the moderation directory of the corresponding package

directory. The file name format follows community_name.keyword_list_developer_name.keywords.

Version

KeywordList components are available in API version 36.0 and later.

Special Access Rules

To view, create, edit, and delete a keyword list, you need the Manage Communities or Create and Set Up Communities permission.

419

KeywordListMetadata Types

Fields

DescriptionField TypeField Name

A description of the keyword list.stringDescription

The keywords you want moderate in your community.Keyword[]keywords

Required. Label for the keyword list.stringmasterLabel

Keyword

Keywords in the keyword list.

DescriptionField TypeField Name

Required. Keywords you want to moderate.stringkeyword

•Keywords can only be up to 100 characters and can include letters,

numbers, spaces, and special characters.

•Wildcard characters aren’t supported.

Declarative Metadata Sample Definition

The following is an example of a KeywordList component.

<?xml version="1.0" encoding="UTF-8"?>

<description>List of bad words updated by Joe in Nov 2015.</description>

</keywords>

</keywords>

<keyword>b@dword</keyword>

</keywords>

</KeywordList>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>KeywordList</name>

<members>community1.badword_list</members>

</types>

</Package>

420

KeywordListMetadata Types

Layout

Represents the metadata associated with a page layout. For more information, see “Page Layouts” in the Salesforce online help. This

type extends the Metadata metadata type and inherits its fullName field.

Note: To edit the Ideas layout, specify it by name in the package.xml file. In package.xml, use the following code to

retrieve the Ideas layout:

<types>

<members>Idea-Idea Layout</members>

<name>Layout</name>

</types>

File Suffix and Directory Location

Layouts are stored in the layouts directory of the corresponding package directory. The extension is .layout.

Note: Retrieving a component of this metadata type in a project makes the component appear in any Profile and PermissionSet

components that are retrieved in the same package.

Version

Layouts are available in API version 13.0 and later.

Fields

This metadata type represents the valid values that define a page layout.

DescriptionField TypeField Name

The custom buttons for this layout. Each button is a

reference to a WebLink on the same object. For example,

string[]customButtons

a ButtonLink refers to a Weblink on the same standard or

custom object named 'ButtonLink'.

Represents custom console components (Visualforce pages,

lookup fields, or related lists; Force.com Canvas apps not

CustomConsoleComponentscustomConsoleComponents

available) on a page layout. Custom console components

only display in the Salesforce console.

Only relevant if showEmailCheckbox is set; indicates

the default value of that checkbox.

booleanemailDefault

List of standard buttons to exclude from this layout. For

example,

string[]excludeButtons

<excludeButtons>Delete</excludeButtons>

excludes the Delete button from this layout.

Represents the values that define the feed view of a

feed-based page layout. Feed-based layouts are available

FeedLayoutfeedLayout

421

LayoutMetadata Types

DescriptionField TypeField Name

on Account, Case, Contact, Lead, Opportunity, custom, and

external objects. They include a feed view and a detail view.

Layout headers are currently only used for tagging, and

only appear in the UI if tagging is enabled. Valid string

values are:

LayoutHeader[]

(enumeration of type string)

headers

•PersonalTagging—tag is private to user.

•PublicTagging—tag is viewable any other user

who can access the record.

The main sections of the layout containing fields, s-controls,

and custom links. The order here determines the layout

order.

LayoutSection[]layoutSections

A mini layout is used in the mini view of a record in the

Console tab, hover details, and event overlays.

MiniLayoutminiLayout

Fields for the special multiline layout fields which appear

in OpportunityProduct layouts. These fields are otherwise

similar to miniLayoutFields miniLayout.

string[]multilineLayoutFields

The list of actions, and their order, that display in the

Salesforce1 action bar for the layout.

This field is available in API version 34.0 and later.

PlatformActionListplatformActionList

The list of quick actions that display in the full Salesforce

site for the page layout. This field is available in API version

28.0 and later.

QuickActionListquickActionList

The Related Content section of the page layout. This field

is available in API version 29.0 and later.

RelatedContentrelatedContent

The related lists for the layout, listed in the order they

appear in the user interface.

RelatedListItem[]relatedLists

The list of related objects that appears in the mini view of

the console. In database terms, these objects are foreign

string[]relatedObjects

key fields on the object for the layout. For more information,

see “Choose Related Objects for the Agent Console's Mini

View” in the Salesforce online help.

Only relevant if

showRunAssignmentRulesCheckbox is set;

indicates the default value of that checkbox.

booleanrunAssignmentRulesDefault

Only allowed on Case, CaseClose, and Task layouts. If set, a

checkbox appears to show email.

booleanshowEmailCheckbox

If set, the highlights panel displays on pages in the

Salesforce console. This field is available in API version 22.0

and later.

booleanshowHighlightsPanel

422

LayoutMetadata Types

DescriptionField TypeField Name

If set, the interaction log displays on pages in the Salesforce

console. This field is available in API version 22.0 and later.

booleanshowInteractionLogPanel

Only allowed on Case layouts. If set, the Knowledge sidebar

displays on cases in the Salesforce console. This field is

available in API version 20.0 and later.

booleanshowKnowledgeComponent

Only allowed on Lead and Case objects. If set, a checkbox

appears on the page to show assignment rules.

booleanshowRunAssignmentRulesCheckbox

Only allowed on CaseClose layout. If set, the built-in solution

information section shows up on the page.

booleanshowSolutionSection

Only allowed on Case layout. If set, the Submit & Add

Attachment button displays on case edit pages to portal

users in the Customer Portal.

booleanshowSubmitAndAttachButton

CustomConsoleComponents

Represents custom console components (Visualforce pages, lookup fields, or related lists; Force.com Canvas apps not available) on a

page layout. Custom console components only display in the Salesforce console. Available in API version 25.0 and later.

DescriptionField TypeField Name

Represents custom console components on primary tabs in the Salesforce

console. Available in API version 25.0 and later.

PrimaryTabComponentsprimaryTabComponents

Represents custom console components on subtabs in the Salesforce

console. Available in API version 25.0 and later.

SubtabComponentssubtabComponents

PrimaryTabComponents

Represents custom console components on primary tabs in the Salesforce console. Available in API version 25.0 and later.

DescriptionField TypeField Name

Represents a custom console component (Visualforce page, lookup field,

or related lists; Force.com Canvas apps not available) on a section of a

ConsoleComponent[]component

page layout. Custom console components only display in the Salesforce

console. This field is available in API version 29.0 and earlier.

Represents a location and style in which to display more than one custom

console component on the sidebars of the Salesforce console. You can

Container[]containers

specify up to five components for each of the four locations (left, right,

top, and bottom). This field is available in API version 30.0 and later.

423

LayoutMetadata Types

ConsoleComponent

Represents a custom console component (Visualforce page, lookup field, or related lists; Force.com Canvas apps not available) on a

section of a page layout. Custom console components only display in the Salesforce console. Available in API version 25.0 and later.

DescriptionField TypeField Name

Required for components with a location of top or bottom. The height

of the custom console component. The value must be specified in pixels

and be greater than 0 but less than 999.

intheight

Required. The location of the custom console component on the page

layout. Valid values are right, left, top, and bottom. A component can

have one location for each page layout.

stringlocation

Required. The unique name of the custom console component. For

example, ConsoleComponentPage.

stringvisualforcePage

Required for components with a location of left or right. The width of the

custom console component. The value must be specified in pixels and

be greater than 0 but less than 999.

intwidth

Container

Represents a location and style in which to display more than one custom console component in the sidebars of the Salesforce console.

For example, you can display multiple components in the right sidebar of the console with a style of either stack, tabs, or accordion.

Available in API version 30.0 and later.

DescriptionField TypeField Name

Required for components with a location of top or bottom. The height

of the components’ container. The unit field determines the unit of

measurement, in pixels or percent.

intheight

Required. If set to true, stacked console components in the sidebars

autosize vertically. Set to true by default for newly created console

components. Available in API version 32.0 and later.

booleanisContainerAutoSizeEnabled

Required. The location of the components’ container. Valid values include:stringregion

•right

•left

•top

•bottom

Represents a specific custom console component to display in the

components’ container.

SidebarComponent[]sidebarComponents

Required. The style of the container in which to display multiple

components. Valid values include:

stringstyle

•stack—a content area with multiple frames.

424

LayoutMetadata Types

DescriptionField TypeField Name

•tabs—a single content area with a list of multiple panels.

•accordian—a collapsible content area.

Required. The unit of measurement, in pixels or percent, for the height

or width of the components’ container.

Pixel values are simply the number of pixels, for example, 500, and must

be greater than 0 but less than 999. Percentage values must include the

stringunit

percent sign, for example, 20%, and must be greater than 0 but less than

100.

Required for components with a location of right or left. The width of the

components’ container. The unit field determines the unit of

measurement, in pixels or percent.

intwidth

SidebarComponent

Represents a specific custom console component to display in a container that hosts multiple components in one of the sidebars of the

Salesforce console. You can specify up to five components for each of the four container locations (left, right, top, and bottom). Available

in API version 30.0 and later.

DescriptionField TypeField Name

Specifies the component type. Valid values are KnowledgeOne,

Lookup, Milestones, RelatedList, Topics, Files, and

stringcomponentType

CaseExperts. This field is available in API version 31.0 and later. The

Files and CaseExperts values are available in API version 32.0

and later.

Note: Case Experts is available through a pilot program.

Required for components with a location of top or bottom. The height

of the component in the container. The unit field determines the unit

of measurement, in pixels or percent.

intheight

The name of the component as it displays to console users. Available for

components in a container with the style of tabs or accordion.

stringlabel

If the component is a lookup field, the name of the field.stringlookup

If the component is a Visualforce page, the name of the Visualforce page.stringpage

If the component is a related list, the name of the list. This field is available

in API version 31.0 and later.

RelatedList[]relatedlists

The unit of measurement, in pixels or percent, for the height or width of

the component in the container.

Pixel values are simply the number of pixels, for example, 500, and must

be greater than 0 but less than 999. Percentage values must include the

stringunit

425

LayoutMetadata Types

DescriptionField TypeField Name

percent sign, for example, 20%, and must be greater than 0 but less than

100.

Required for components with a location of right or left. The width of the

component in the container. The unit field determines the unit of

measurement, in pixels or percent.

intwidth

RelatedList

Represents related list custom components on the sidebars of the Salesforce console. Available in API version 31.0 and later.

DescriptionField TypeField Name

If set to true, the related list is hidden from detail pages where it

appears as a component to prevent duplicate information from showing.

booleanhideOnDetail

The name of the component as it appears to console users.stringname

SubtabComponents

Represents custom console components on subtabs in the Salesforce console. Available in API version 25.0 and later.

DescriptionField TypeField Name

Represents a custom console component (Visualforce page, lookup field,

or related lists; Force.com Canvas apps not available) on a section of a

ConsoleComponent[]component

page layout. Custom console components only display in the Salesforce

console. This field is available in API version 29.0 and earlier.

Represents a location and style in which to display more than one custom

console component on the sidebars of the Salesforce console. You can

Container[]containers

specify up to five components for each of the four locations (left, right,

top, and bottom). This field is available in API version 30.0 and later.

FeedLayout

Represents the values that define the feed view of a feed-based page layout. Feed-based layouts are available on Account, Case, Contact,

Lead, Opportunity, custom, and external objects. They include a feed view and a detail view. Available in API version 30.0 and later.

DescriptionField TypeField Name

Specifies whether the publisher is automatically collapsed when the

page loads (true) or not (false).

booleanautocollapsePublisher

Specifies whether the feed-based page layout uses a compact feed

(true) or not (false). If set to true, feed items on the page are

collapsed by default, and the feed view has an updated design.

booleancompactFeed

426

LayoutMetadata Types

DescriptionField TypeField Name

Where the feed filters list is included in the layout. Valid values are:FeedLayoutFilterPosition

(enumeration of type

string)

feedFilterPosition

•centerDropDown—as a drop-down list in the center column.

•leftFixed—as a fixed list in the left column.

•leftFloat—as a floating list in the left column.

The individual filters displayed in the feed filters list.FeedLayoutFilter[]feedFilters

Specifies whether the feed expands horizontally to take up all available

space on the page (true) or not (false).

booleanfullWidthFeed

Specifies whether the sidebar is hidden (true) or not (false).booleanhideSidebar

The individual components displayed in the left column of the feed view.FeedLayoutComponent[]leftComponents

The individual components displayed in the right column of the feed

view.

FeedLayoutComponent[]rightComponents

FeedLayoutComponent

Represents a component in the feed view of a feed-based page layout. Available in API version 30.0 and later.

DescriptionField TypeField Name

Required. The type of component. Valid values are:FeedLayoutComponentType

(enumeration of type

string)

componentType

•HelpAndToolLinks—icons that link to the help topic for the

page, the page layout, and, the printable view of the page. Available

only on Case layouts.

•CustomButtons—a custom button.

•Following—an icon that toggles between a Follow button (if

the user viewing a record doesn’t already follow it) and a Following

indicator (if the user viewing a record does follow it).

•Followers—a list of users who follow the record.

•CustomLinks—a custom link.

•Milestones—the milestone tracker, which lets users see the

status of a milestone on a case. Available only on Case layouts.

•Topics—a list of topics related to the record.

•CaseUnifiedFiles—a list of all files that are attached to the

case.

•Visualforce—a custom Visualforce component.

The height, in pixels, of the component. Doesn’t apply to

standardComponents

intheight

The name of a Visualforce page being used as a custom component.stringpage

427

LayoutMetadata Types

FeedLayoutFilter

Represents a feed filter option in the feed view of a feed-based page layout. A filter must have only standardFilter or

feedItemType set. Available in API version 30.0 and later.

DescriptionField TypeField Name

The name of a CustomFeedFilter component. Names are prefixed with

the name of the parent object. For example,

Case.MyCustomFeedFilter.

stringfeedFilterName

The type of filter. Valid values are:FeedLayoutFilterType

(enumeration of type

string)

feedFilterType

•AllUpdates—shows all feed items on a record.

•FeedItemType—shows feed items only for a particular type of

activity on the record.

The type of feed item to display. Valid values are:FeedItemType

(enumeration of type

string)

feedItemType

•ActivityEvent—feed items related to activity on tasks and

events associated with a case. Available only on Case layouts.

•AdvancedTextPost–feed items related to group

announcements posted on a feed. This value is available in API

version 31.0 and later.

•AnnouncementPost–Not used.

•ApprovalPost—feed items related to approvals that are

submitted on a feed.

•AttachArticleEvent—feed items for activity related to

attaching articles to cases. Available only on Case layouts.

•BasicTemplateFeedItem—Not used.

•CallLogPost—feed items for activity from the Log a Call action.

Available only on layouts for objects that support Activities (tasks

and events).

•CanvasPost—feed items related to posts a canvas app makes

on a feed.

•CaseCommentPost—feed items for activity from the Case Note

action. Available only on Case layouts.

•ChangeStatusPost—feed items for activity from the Change

Status action. Available only on Case layouts.

•ChatTranscriptPost—feed items for activity related to

attaching Live Agent chat transcripts to cases. Available only on Case

layouts.

•CollaborationGroupCreated—feed items related to

creating a public group.

•CollaborationGroupUnarchived—Not used.

•ContentPost—feed items related to attaching a file to a post.

•CreatedRecordEvent—feed items related to creating a record

from the publisher.

428

LayoutMetadata Types

DescriptionField TypeField Name

•DashboardComponentSnapshot—feed items related to

posting a dashboard snapshot on a feed.

•EmailMessageEvent—feed items for activity from the Email

action. Available only on Case layouts.

•FacebookPost—Not used.

•LinkPost—feed items related to attaching a URL to a post.

•MilestoneEvent—feed items for changes to the milestone

status on a case. Available only on Case layouts.

•PollPost—feed items related to posting a poll on a feed.

•ProfileSkillPost—feed items related to skills added to a

user’s Chatter profile. This value is available in API version 31.0 and

later.

•QuestionPost—feed items related to posting a question on a

feed. This value is available in API version 31.0 and later.

•ReplyPost—feed items for activity from the Portal action.

Available only on Case layouts.

•RypplePost—feed items related to creating a Thanks badge in

Work.com.

•SocialPost—feed items for activity on Twitter from the Social

Post action.

•TextPost—feed items for creating a text post from the publisher.

•TrackedChange—feed items related to a change or group of

changes to a tracked field.

•UserStatus—Not used.

MiniLayout

Represents a mini view of a record in the Console tab, hover details, and event overlays.

DescriptionField TypeField Name

The fields for the mini-layout, listed in the order they appear in the UI.

Fields that appear here must appear in the main layout.

string[]fields

The mini related list, listed in the order they appear in the UI. You cannot

set sorting on mini related lists. Fields that appear here must appear in

the main layout.

RelatedListItem[]relatedLists

LayoutSection

LayoutSection represents a section of a page layout, such as the Custom Links section.

429

LayoutMetadata Types

DescriptionField TypeField Name

Indicates if this section's label is custom or standard (built-in). Custom

labels can be any text, but must be translated. Standard labels have a

booleancustomLabel

predefined set of valid values, for example 'System Information', which

are automatically translated.

Controls if this section appears in the detail page. In the UI, this setting

corresponds to the checkbox in the section details dialog.

booleandetailHeading

Controls if this section appears in the edit page.booleaneditHeading

The label; either standard or custom, based on the customLabel

flag.

stringlabel

The columns of the layout, depending on the style. 1, 2, or 3 columns,

ordered left to right, are possible.

LayoutColumn[]layoutColumns

The style of the layout:LayoutSectionStyle

(enumeration of type

string)

style

•TwoColumnsTopToBottom - Two columns, tab goes top to

bottom

•TwoColumnsLeftToRight - Two columns, tab goes left to

right

•OneColumn - One column

•CustomLinks - Contains custom links only

Reserved for future use.SummaryLayoutsummaryLayout

LayoutColumn

LayoutColumn represents the items in a column within a layout section.

DescriptionField TypeField Name

The individual items within a column (ordered from top to bottom).LayoutItem[]layoutItems

This field is reserved for Salesforce. The field resolves an issue with some

SOAP libraries. Any value entered in the field is ignored.

stringreserved

LayoutItem

LayoutItem represents the valid values that define a layout item. An item must have only one of the following values set: component,

customLink, field, scontrol, page, analyticsCloudComponent, or reportChartComponent.

DescriptionField TypeField Name

Determines the field behavior. Valid string values:UiBehavior (enumeration of type string)behavior

•Edit—The layout field can be edited but is not

required

430

LayoutMetadata Types

DescriptionField TypeField Name

•Required—The layout field can be edited and is

required

•Readonly—The layout field is read-only

Reference to a canvas app.

This field is available in API version 31.0 and later.

stringcanvas

Reference to a component. Value must be

sfa:socialCard.

This field is available in API version 30.0 and later. This is

only allowed inside a RelatedContentItem.

stringcomponent

sfa:socialCard is only supported on page layouts

for contacts, accounts, and leads.

The customLink reference. This is only allowed inside

a CustomLink layoutSection.

stringcustomLink

Controls if this layout item is a blank space.booleanemptySpace

The field name reference, relative to the layout object,

for example Description or MyField__c.

stringfield

For s-control and pages only, the height in pixels.intheight

Reference to a Visualforce page.stringpage

Refers to a Wave Analytics dashboard that you can add

to a standard or custom object page.

This field is available in API version 34.0 and later.

AnalyticsCloudComponentLayoutItemanalyticsCloudComponent

Refers to a report chart that you can add to a standard

or custom object page.

ReportChartComponentLayoutItemreportChartComponent

Reference to an s-control.stringscontrol

For s-control and pages only, whether to show the label.booleanshowLabel

For s-control and pages only, whether to show scrollbars.booleanshowScrollbars

For s-control and pages only, the width in pixels or

percent. Pixel values are simply the number of pixels, for

stringwidth

example, 500. Percentage values must include the

percent sign, for example, 20%.

AnalyticsCloudComponentLayoutItem

Represents the settings for a Wave Analytics dashboard on a standard or custom page. Available in API version 34.0 and later.

431

LayoutMetadata Types

DescriptionField TypeField Name

Required. Specifies the type of Wave Analytics asset to add. The available

asset type is dashboard.

stringassetType

Required. Unique development name of the dashboard to add.stringdevName

Error string; only populated if an error occurred in the underlying

dashboard.

stringerror

Communicates initial dashboard filters for mapping data fields in the

dashboard to the object’s fields, so that the dashboard shows only the

data that’s relevant for the record being viewed.

stringfilter

Specifies the height of the dashboard, in pixels. The default is 400.intheight

Controls whether users see a dashboard that has an error. When this

attribute is set to true, if the dashboard has an error, the dashboard

booleanhideOnError

doesn’t appear on the page. When set to false, the dashboard appears

but doesn’t show any data except the error. An error can happen when

a user doesn’t have access to Wave Analytics or to the dashboard. The

default is true.

If set to true, and the dashboard is shareable, then the dashboard

shows the Share icon. Users can click the icon to open the Share dialog

booleanshowSharing

and post or download from the dashboard. If set to false, the

dashboard doesn't show the Share icon. This field is available in API

version 37.0 and later.

If true, includes the dashboard’s title above the dashboard. If false,

the dashboard appears without a title. The default is true.

booleanshowTitle

Specifies the width of the dashboard, in pixels or percent. Pixel values

are simply the number of pixels, for example, 500. Percentage values

must include the percent sign, for example, 20%. The default is 100%.

stringwidth

ReportChartComponentLayoutItem

Represents the settings for a report chart on a standard or custom page.

DescriptionField TypeField Name

Indicates whether to use cached data when displaying the chart. When

the attribute is set to true, data is cached for 24 hours. If the attribute

is set to false, the report is run every time the page is refreshed.

This field is available in API version 29.0 and later.

booleancacheData

Unique development name of the field by which a report chart is filtered

to return data relevant to the page. If set, the ID field for the parent object

stringcontextFilterableField

of the page or report type is the chart data filter. The parent object for

the report type and the page must match for a chart to return relevant

data.

432

LayoutMetadata Types

DescriptionField TypeField Name

Error string; only populated if an error occurred in the underlying report.

This field is available in API version 31.0 and later.

stringerror

Controls whether users see a chart that has an error. When there’s an

error and this attribute is not set, the chart doesn’t show any data except

booleanhideOnError

the error. An error can happen for many reasons, such as when a user

doesn’t have access to fields used by the chart or a chart has been

removed from the report. Set the attribute to true to hide the chart

from a page on error.

This field is available in API version 29.0 and later.

If true, filters the report chart to return data that’s relevant to the page.booleanincludeContext

Unique development name of a report that includes a chart.stringreportName

If true, applies the title from the report to the chart.booleanshowTitle

The chart size is medium when no value is specified. Valid values:

ReportChartComponentSize

size

•SMALL

(enumeration of type

string) •MEDIUM

•LARGE

PlatformActionList

PlatformActionList represents the list of actions, and their order, that display in the Salesforce1 action bar for the layout. Available in API

version 34.0 and later.

DescriptionField TypeField Name

Required. The context of the action list. Valid values are:PlatformActionListContext

(enumeration of

type string)

actionListContext

•Assistant

•BannerPhoto

•Chatter

•Dockable

•FeedElement

•FlexiPage

•Global

•ListView

•ListViewDefinition

•ListViewRecord

•Lookup

•MruList

•MruRow

433

LayoutMetadata Types

DescriptionField TypeField Name

•ObjectHomeChart

•Photo

•Record

•RecordEdit

•RelatedList

•RelatedListRecord

The actions in the PlatformActionList.PlatformActionListItem[]platformActionListItems

When the ActionListContext is RelatedList or RelatedListRecord,

this field represents the API name of the related list to which the action

belongs.

stringrelatedSourceEntity

PlatformActionListItem

PlatformActionListItem represents an action in the PlatformActionList. Available in API version 34.0 and later.

DescriptionField TypeField Name

The API name for the action in the list.stringactionName

The type of action. Valid values are:PlatformActionType

(enumeration of type

string)

actionType

•ActionLink—An indicator on a feed element that targets an API, a

web page, or a file, represented by a button in the Salesforce Chatter feed

UI.

•CustomButton—When clicked, opens a URL or a Visualforce page in

a window or executes JavaScript.

•InvocableAction

•ProductivityAction—Productivity actions are predefined by

Salesforce and are attached to a limited set of objects. You can’t edit or

delete productivity actions.

•QuickAction—A global or object-specific action.

•StandardButton—A predefined Salesforce button such as New, Edit,

and Delete.

The placement of the action in the list.intsortOrder

The subtype of the action. For quick actions, the subtype is

QuickActionType. For custom buttons, the subtype is

stringsubtype

WebLinkTypeEnum. For action links, subtypes are Api, ApiAsync,

Download, and Ui. Standard buttons and productivity actions have no

subtype.

434

LayoutMetadata Types

QuickActionList

QuickActionList represents the list of actions associated with the page layout. Available in API version 28.0 and later.

DescriptionField TypeField Name

Array of zero or more QuickActionList objects.QuickActionListItem[]quickActionListItems

QuickActionListItem

QuickActionListItem represents an action in the QuickActionList. Available in API version 28.0 and later.

DescriptionField TypeField Name

The API name of the action.stringquickActionName

RelatedContent

RelatedContent represents the Mobile Cards section of the page layout. Available in API version 29.0 and later.

DescriptionField TypeField Name

A list of layout items in the Mobile Cards section of the page layout.RelatedContentItem[]relatedContentItems

RelatedContentItem

RelatedContentItem represents an individual item in the RelatedContentItem list. Available in API version 29.0 and later.

DescriptionField TypeField Name

An individual LayoutItem in the Mobile Cards section.LayoutItemlayoutItem

RelatedListItem

RelatedListItem represents a related list in a page layout.

DescriptionField TypeField Name

A list of custom buttons used in the related list. For more information,

see “Define Custom Buttons and Links” in the Salesforce online help.

string[]customButtons

A list of excluded related-list buttons.string[]excludeButtons

A list of fields displayed in the related list.

Retrieval of standard fields on related lists uses aliases instead of field or

API names. For example, the Fax, Mobile, and Home Phone fields

are retrieved as Phone2, Phone3, and Phone4, respectively.

string[]fields

435

LayoutMetadata Types

DescriptionField TypeField Name

Required. The name of the related list.stringrelatedList

The name of the field that is used for sorting.stringsortField

If the sortField is set, the sortOrder field determines the sort

order.

SortOrder

(enumeration of type

string)

sortOrder

•Asc - sort in ascending order

•Desc - sort in descending order

SummaryLayout

Controls the appearance of the highlights panel, which summarizes key fields in a grid at the top of a page layout, when Case Feed is

enabled. Available in API version 25.0 and later.

DescriptionField TypeField Name

Required. The name of the layout label.stringmasterLabel

Required. Number of columns in the highlights pane, between 1 and 4

(inclusive).

intsizeX

Required. Number of rows in each column, either 1 or 2.intsizeY

Reserved for future use. If provided, the setting is not visible to users.intsizeZ

Controls the appearance of an individual field and its column and row

position within the highlights panel grid, when Case Feed is enabled. At

least one is required.

SummaryLayoutItem[]summaryLayoutItems

Highlights panel style. Valid string values are:SummaryLayoutStyle

(enumeration of type

string)

summaryLayoutStyle

•Default

•QuoteTemplate

•DefaultQuoteTemplate

•CaseInteraction

•QuickActionLayoutLeftRight (Available in API version 28.0 and later.)

•QuickActionLayoutTopDown (Available in API version 28.0 and later.)

SummaryLayoutItem

Controls the appearance of an individual field and its column and row position within the highlights panel grid, when Case Feed is

enabled. You can have two fields per each grid in a highlights panel. Available in API version 25.0 and later.

DescriptionField TypeField Name

If the item is a custom link, this is the customLink reference.stringcustomLink

436

LayoutMetadata Types

DescriptionField TypeField Name

The field name reference, relative to the page layout. Must be a standard

or custom field that also exists on the detail page.

stringfield

Required. The item's column position in the highlights panel grid. Must

be within the range of sizeX.

intposX

Required. The item's row position in the highlights panel grid. Must be

within the range of sizeY.

intposY

Reserved for future use. If provided, the setting is not visible to users.intposZ

Declarative Metadata Sample Definition

The following is the definition of a page layout:

<?xml version="1.0" encoding="UTF-8"?>

<unit>Pixel</unit>

<page>simplepage1</page>

<unit>Percentage</unit>

</sidebarComponent>

<page>Hello_World</page>

<unit>Percentage</unit>

</sidebarComponent>

</container>

</primaryTabComponents>

<visualforcePage>ConsoleComponentPage2</visualforcePage>

</component>

</subtabComponents>

</customConsoleComponents>

<customButtons>ButtonLink</customButtons>

<label>Information</label>

<behavior>Required</behavior>

437

LayoutMetadata Types

</layoutItems>

<scontrol>LayoutSControl</scontrol>

</layoutItems>

<reportName>Open_Accounts_by_Cases</reportName>

<showTitle>false</showTitle>

<size>LARGE</size>

</layoutItems>

</layoutColumns>

<field>OwnerId</field>

</layoutItems>

<field>CurrencyIsoCode</field>

</layoutItems>

</layoutColumns>

</layoutSections>

<label>System Information</label>

<behavior>Readonly</behavior>

<field>CreatedById</field>

</layoutItems>

<behavior>Readonly</behavior>

<field>Alpha1__c</field>

</layoutItems>

<page>mcanvasPage</page>

<showScrollbars>false</showScrollbars>

</layoutItems>

</layoutColumns>

<behavior>Readonly</behavior>

<field>LastModifiedById</field>

438

LayoutMetadata Types

</layoutItems>

<field>TextArea__c</field>

</layoutItems>

</layoutColumns>

</layoutSections>

<label>Custom Links</label>

<customLink>CustomWebLink</customLink>

</layoutItems>

</layoutColumns>

</layoutSections>

<quickActionName>FeedItem.TextPost</quickActionName>

</quickActionListItems>

<quickActionName>FeedItem.ContentPost</quickActionName>

</quickActionListItems>

<quickActionName>FeedItem.LinkPost</quickActionName>

</quickActionListItems>

<quickActionName>FeedItem.PollPost</quickActionName>

</quickActionListItems>

</quickActionList>

<component>sfa:socialPanel</component>

</layoutItem>

</relatedContent>

<miniLayoutFields>OwnerId</miniLayoutFields>

<miniLayoutFields>CurrencyIsoCode</miniLayoutFields>

<miniLayoutFields>Alpha1__c</miniLayoutFields>

<miniLayoutFields>TextArea__c</miniLayoutFields>

<relatedList>RelatedNoteList</relatedList>

</miniRelatedLists>

<fields>StepStatus</fields>

<fields>CreatedDate</fields>

<fields>OriginalActor</fields>

<fields>Actor</fields>

<fields>Comments</fields>

439

LayoutMetadata Types

<fields>Actor.Alias</fields>

<fields>OriginalActor.Alias</fields>

<relatedList>RelatedProcessHistoryList</relatedList>

</relatedLists>

<relatedList>RelatedNoteList</relatedList>

</relatedLists>

</Layout>

The following is an example of a layout using <summaryLayout>:

<?xml version="1.0" encoding="UTF-8"?>

<label>System Information</label>

<behavior>Readonly</behavior>

<field>CreatedById</field>

</layoutItems>

<behavior>Required</behavior>

</layoutItems>

</layoutColumns>

<behavior>Readonly</behavior>

<field>LastModifiedById</field>

</layoutItems>

</layoutColumns>

</layoutSections>

<masterLabel>Great Name</masterLabel>

</summaryLayoutItems>

</summaryLayout>

</Layout>

The following is an example of a feed-based layout:

...

<componentType>customLinks</componentType>

</leftComponents>

440

LayoutMetadata Types

<componentType>follow</componentType>

</rightComponents>

<componentType>followers</componentType>

</rightComponents>

<componentType>visualforce</componentType>

<page>accountCustomWidget</page>

</rightComponents>

<feedFilterPosition>centerDropDown</feedFilterPosition>

<feedFilerType>allUpdates</feedFilerType>

</feedFilters>

<feedFilerType>feedItemType</feedFilerType>

<feedItemType>CallLogPost</feedItemType>

</feedFilters>

<feedFilerType>feedItemType</feedFilerType>

<feedItemType>TextPost</feedItemType>

</feedFilters>

</feedLayout>

...

</Layout>

Letterhead

Represents formatting options for the letterhead in an email template. Letterheads define the look and feel of your HTML email templates.

Your HTML email templates can inherit the logo, color, and text settings from a letterhead. For more information, see “Create a Letterhead”

in the Salesforce online help. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

The file suffix for letterheads is .letter and components are stored in the letterhead directory of the corresponding package

directory.

Version

Letterheads are available in API version 12.0 and later.

Fields

With the exception of logo, and horizontal and vertical alignment, all of these fields are required.

DescriptionField TypeField Name

Required. Indicates whether this letterhead can be used

(true) or not (false), for example, in an email template.

booleanavailable

441

LetterheadMetadata Types

DescriptionField TypeField Name

Required. The background color, in hexadecimal, for example

#FF6600.

stringbackgroundColor

Required. The body color in hexadecimal.stringbodyColor

Required. The style for the bottom line. Valid style values

include:

LetterheadLine (enumeration of type string)bottomLine

•color. The color of the line in hexadecimal, as a string

value.

•height. The height of the line, as an int value.

Text description of how this letterhead differs from other

letterheads.

stringdescription

The internal name of the letterhead, based on the name,

but with white spaces and special characters escaped out

for validity.

stringfullName

Required. The style for the footer.LetterheadHeaderFooterfooter

Required. The style for the header.LetterheadHeaderFooterheader

Required. The style for the middle border line in your

letterhead. Valid style values include:

LetterheadLinemiddleLine

•color. The color of the line in hexadecimal, as a string

value.

•height. The height of the line, as an int value.

Required. The name of the letterhead.stringname

Required. The style for the top horizontal line below the

header. Valid style values include:

LetterheadLinetopLine

•color. The color of the line in hexadecimal, as a string

value.

•height. The height of the line, as an int value.

LetterheadHeaderFooter

LetterheadHeaderFooter represents the properties of a header or footer.

DescriptionField TypeField

Required. The background color of the header or footer in

hexadecimal format.

stringbackgroundColor

Required. The height of the header or footer.DashboardComponent[]height

442

LetterheadMetadata Types

DescriptionField TypeField

The horizontal alignment of the header or footer. Valid values

are:

LetterheadHorizontalAlignment

(enumeration of type string)

horizontalAlignment

•None

•Left

•Center

•Right

The logo which is a reference to a document, for example

MyFolder/MyDocument.gif.

stringlogo

The vertical alignment of the header or footer. Valid values are:LetterheadVerticalAlignment

(enumeration of type string)

verticalAlignment

•None

•Top

•Middle

•Bottom

LetterheadLine

LetterheadLine represents the properties of a line.

DescriptionField TypeField

Required. The color of the line in hexadecimal format.stringcolor

Required. The height of the line.intheight

Declarative Metadata Sample Definition

<?xml version="1.0" encoding="UTF-8"?>

<backgroundColor>#CCCCCC</backgroundColor>

</bottomLine>

<description>INITIAL</description>

<backgroundColor>#FFFFFF</backgroundColor>

</footer>

<backgroundColor>#FFFFFF</backgroundColor>

443

LetterheadMetadata Types

</header>

<color>#AAAAFF</color>

</middleLine>

<name>SimpleLetterheadLabel</name>

</topLine>

</Letterhead>

LiveChatAgentConfig

Represents the configuration of an organization’s Live Agent deployment, such as how many chats can be assigned to an agent and

whether or not chat sounds are enabled. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

LiveChatAgentConfig configurations are referenced in the <developer_name>.liveChatAgentConfig file in the

liveChatAgentConfigs directory.

Version

LiveChatAgentConfig is available in API version 28.0 and later.

Fields

DescriptionField TypeField Name

Specifies how agent configurations are assigned to Live

Agent users. Agent configurations can be assigned to sets

of users or sets of profiles.

AgentConfigAssignmentsassignments

Specifies the greeting that displays when a customer begins

a chat with an agent.

stringautoGreeting

Specifies the maximum number of chats in which an agent

can be engaged at a time.

intcapacity

Specifies the number of seconds an agent can wait to answer

an engaged chat before the chat tab flashes to alert the agent

to answer it.

intcriticalWaitTime

Specifies whether a supervisor can see the content of an

agent’s message before they send it to a customer (true)

or not (false).

booleanenableAgentSneakPeek

444

LiveChatAgentConfigMetadata Types

DescriptionField TypeField Name

Indicates whether agents can raise an assistance flag to notify

a supervisor that they need help. Available in API version

35.0 and later.

booleanenableAssistanceFlag

Indicates whether an agent appears as “away” (true) or

not (false) when an agent declines a chat with a customer.

booleanenableAutoAwayOnDecline

Indicates whether an agent appears as “away” (true) or

not (false) when a chat request that's been pushed to the

agent times out. Available in API version 34.0 and later.

booleanenableAutoAwayOnPushTimeout

Indicates whether file transfer is enabled for agents (true)

or not (false). Available in API version 31.0 and later.

booleanenableAgentFileTransfer

Indicates whether chat conferencing is enabled for agents

(true) or not (false). Available in API version 34.0 and

later.

booleanenableChatConferencing

Indicates whether chat transfer is enabled for agents (true)

or not (false). Available in API version 31.0 and later.

booleanenableChatTransfer

Indicates whether a sound will play (true) or not (false)

when an agent logs out of Live Agent.

booleanenableLogoutSound

Indicates whether notifications of incoming chats appear for

agents (true) or not (false).

booleanenableNotifications

Indicates whether a sound will play (true) or not (false)

when a customer requests to chat with an agent.

booleanenableRequestSound

Indicates whether previews of customers’ messages are

displayed as customers type (true) or not (false) in the

booleanenableSneakPeek

agent’s Live Agent window. Available in API version 29.0 and

later.

Indicates whether an agent can block a visitor by IP address

(true) or not (false). Available in API version 34.0 and

later.

booleanenableVisitorBlocking

Specifies the name of the configuration for agents’ default

chat settings.

stringlabel

Specifies the Live Agent status for filtering the Agent Status

list in the Supervisor Panel. Valid values are:

SupervisorAgentStatusFilter

(enumeration of type

string)

supervisorDefaultAgentStatusFilter

•Online

•Away

•Offline

Available in API version 29.0 and later.

445

LiveChatAgentConfigMetadata Types

DescriptionField TypeField Name

Specifies the default button for filtering the Agent Status list

in the Supervisor Panel. Available in API version 29.0 and

later.

stringsupervisorDefaultButtonFilter

Specifies the default skill for filtering the Agent Status list in

the Supervisor Panel. Available in API version 29.0 and later.

stringsupervisorDefaultSkillFilter

Specifies the list of agent skills that are assigned to a

supervisor, as specified in their assigned Live Agent

configuration. Available in API version 29.0 and later.

SupervisorAgentConfigSkillssupervisorSkills

Specifies the list of chat buttons that agents can transfer

chats to. Available in API version 31.0 and later.

AgentConfigButtonstransferableButtons

Specifies the list of skill groups that agents can transfer chats

to. Available in API version 31.0 and later.

AgentConfigSkillstransferableSkills

AgentConfigAssignments

Represents the assignments of an organization’s profiles and users to a Live Agent configuration.

Fields

DescriptionField TypeField Name

Specifies the profiles that are associated with a specific

agent configuration.

AgentConfigProfileAssignmentsprofiles

Specifies the users that are associated with a specific agent

configuration.

AgentConfigUserAssignmentsusers

AgentConfigButtons

Represents the chat buttons that agents who are associated with the Live Agent configuration can transfer chats to.

Fields

DescriptionField TypeField Name

Specifies the chat buttons that agents can transfer chats

to.

string[]button

AgentConfigProfileAssignments

Represents the profiles associated with a specific Live Agent configuration.

446

LiveChatAgentConfigMetadata Types

Fields

DescriptionField TypeField Name

Specifies the custom name of the profile associated with a

specific agent configuration.

stringprofile

AgentConfigSkills

Represents the skill groups that agents who are associated with the Live Agent configuration can transfer chats to.

Fields

DescriptionField TypeField Name

Specifies the skill groups that agents can transfer chats to.string[]skill

AgentConfigUserAssignments

Represents the users associated with a specific Live Agent configuration.

Fields

DescriptionField TypeField Name

Specifies the username of the user associated with a specific

agent configuration.

stringuser

SupervisorAgentConfigSkills

Represents the agent skills associated with a supervisor’s Live Agent configuration. Available in API version 29.0 and later.

Fields

DescriptionField TypeField Name

Specifies the agent skills available for filtering the Agent

Status list in the Supervisor Panel.

stringskill

447

LiveChatAgentConfigMetadata Types

Declarative Metadata Sample Definition

This is a sample of a liveChatAgentConfig file.

<?xml version="1.0" encoding="UTF-8"?>

<label>My Agent Configuration 1</label>

<profile>standard</profile>

</profiles>

<users>

</users>

</assignments>

</LiveChatAgentConfig>

LiveChatButton

Represents a Live Agent deployment’s settings for the button that customers click to chat with an agent and the chat window, such as

the label that appears on the button and the pre-chat form that appears before a live chat begins. This type extends the Metadata

metadata type and inherits its fullName field.

File Suffix and Directory Location

LiveChatButton configurations are stored in the <developer_name>.liveChatButton file in the liveChatButtons

directory.

Version

LiveChatButton is available in API version 28.0 and later.

Fields

DescriptionField TypeField Name

Specifies the amount of idle time before the chat

times out. The idle time starts being counted

intchasitorIdleTimeout

after the agent sends the last chat message.

Available in API version 35.0 and later.

448

LiveChatButtonMetadata Types

DescriptionField TypeField Name

Specifies the amount of idle time before a

warning appears. The idle time starts being

intchasitorIdleTimeoutWarning

counted after the agent sends the last chat

message. Available in API version 35.0 and later.

Specifies the page that hosts your chat if that

page differs from the Live Agent chat window.

stringchatPage

Indicates whether queuing is enabled (true)

or not (false).

booleanenableQueue

Specifies the text that appears on the button.stringlabel

Specifies the number of times a chat request can

be rerouted to available agents if all agents reject

intnumberOfReroutingAttempts

the chat request. Available in API version 30.0

and later.

Specifies the image that appears on the button

when no agents are available to chat.

stringofflineImage

Specifies the image that appears on the button

when agents are available to chat.

stringonlineImage

Indicates whether custom routing is enabled for

incoming chat requests (true) or not (false).

Available in API version 30.0 and later.

booleanoptionsCustomRoutingIsEnabled

Indicates whether the visitor idle timeout feature

is enabled. Available in API version 35.0 and later.

booleanoptionsHasChasitorIdleTimeout

Indicates whether a new chat invitation triggers

after a customer accepts a previous chat

invitation (true) or not (false).

booleanoptionsHasInviteAfterAccept

Indicates whether a new chat invitation triggers

after a customer rejects a previous chat invitation

(true) or not (false).

booleanoptionsHasInviteAfterReject

Indicates whether a chat request, which has been

rejected by all available agents, should be

booleanoptionsHasRerouteDeclinedRequest

rerouted to available agents again (true) or not

(false). Available in API version 30.0 and later.

Indicates whether a chat request should be

automatically accepted by the agent it’s assigned

booleanoptionsIsAutoAccept

to (true) or not (false). For chat buttons and

automated chat invitations with

routingType set to MostAvailable or

LeastActive. Available in API version 30.0

and later.

449

LiveChatButtonMetadata Types

DescriptionField TypeField Name

Indicates whether a chat invitation is set to

automatically disappear from a customer’s screen

booleanoptionsIsInviteAutoRemove

after a certain amount of time (true) or not

(false).

Specifies the maximum number of chat requests

that are allowed to queue.

intoverallQueueLength

Specifies the number of chat requests that are

allowed to queue for an agent with the required

skills.

intperAgentQueueLength

Specifies the name of the post-chat form to

which customers are routed when the chat ends.

stringpostChatPage

Specifies the URL of the post-chat form to which

customers are routed when the chat ends.

stringpostChatUrl

Specifies the name of the pre-chat form to which

customers are routed before a chat begins.

stringpreChatFormPage

Specifies the URL of the pre-chat form to which

customers are routed when the chat begins.

stringpreChatFormUrl

Specifies the number of seconds an agent has

to answer an incoming chat request before the

request is routed to another agent.

intpushTimeOut

Specifies how incoming chats should be routed

to agents when a customer pushes a button.

Valid values are:

LiveChatButtonRoutingType (enumeration

of type string)

routingType

•Choice

•LeastActive

•MostAvailable

Specifies the Force.com site that hosts your

custom chat button images or custom chat page.

stringsite

Note: You must have the

“CustomDomain” permission enabled in

your organization before you can use a

Force.com site with Live Agent.

Specifies the skills associated with the button.

When a customer clicks the button to chat, they

LiveChatButtonSkillsskills

are automatically routed to agents with those

skills.

Specifies the language preferences for the chat

window associated with the button.

LanguagewindowLanguage

450

LiveChatButtonMetadata Types

LiveChatButtonSkills

Represents the skills associated with a chat button.

Fields

DescriptionField TypeField Name

Specifies the name of the skill.stringskill

Declarative Metadata Sample Definition

This is a sample of a liveChatButton file.

<?xml version="1.0" encoding="UTF-8"?>

<label>My Button 1</label>

<chatPage>ChatterAnswersLogin</chatPage>

<offlineImage>MyOfflineButton</offlineImage>

<onlineImage>MyOnlineButton</onlineImage>

<postchatPage>AnswersHome</postchatPage>

<prechatFormPage>AccountVF</prechatFormPage>

<routingType>LeastActive</routingType>

<site>LiveAgentSite</site>

<skill>Skill1</skill>

<skill>Skill2</skill>

</skills>

</LiveChatButton>

Note: If you update your chat button through the Metadata API, be sure to update all Web pages that use the same chat button

code.

LiveChatDeployment

Represents the configuration settings for a specific Live Agent deployment, such as the branding image for the deployment and whether

or not chat transcripts are automatically saved. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

LiveChatDeployment values are stored in the <developer_name>.liveChatDeployment file in the

liveChatDeployments directory.

451

LiveChatDeploymentMetadata Types

Version

LiveChatDeployment is available in API version 28.0 and later.

Fields

DescriptionField TypeField Name

Specifies the branding image for the

deployment.

stringbrandingImage

Indicates the amount of time before the chat

times out, in seconds.

intconnectionTimeoutDuration

Indicates the amount of time before a time-out

warning is displayed to the agent, in seconds.

intConnectionWarningDuration

(Pilot) Determines whether a customer’s queue

position is displayed in a standard chat window

booleandisplayQueuePosition

while the customer waits for an agent to

respond to the chat request (true) or not

(false). This field is available as a pilot in API

version 32.0. To enable this field, contact

Salesforce.

Specifies the list of domains that can host the

deployment.

LiveChatDeploymentDomainWhiteListdomainWhiteList

Indicates whether or not the pre-chat API is

enabled for the deployment (true) or not

(false).

booleanenablePrechatApi

Indicates whether chat transcripts are

automatically saved after a chat ends (true)

or not (false).

booleanenableTranscriptSave

Specifies the name of the deployment.stringlabel

Specifies the branding image for the

deployment that appears when customers

access the deployment on a mobile device.

stringmobileBrandingImage

Specifies the site that hosts the images for the

deployment.

stringsite

Note: You must have the

“CustomDomain” permission enabled

in your organization before you can use

a Force.com site with Live Agent.

Specifies the title of the window associated

with the deployment.

stringwindowTitle

452

LiveChatDeploymentMetadata Types

LiveChatDeploymentDomainWhiteList

Represents a Live Agent deployment’s domain whitelist.

Fields

DescriptionField TypeField Name

Specifies a domain that can host the deployment.stringdomain

Declarative Metadata Sample Definition

This is a sample of a liveChatDeployment file.

<?xml version="1.0" encoding="UTF-8"?>

<label>My Deployment 1</label>

<brandingImage>pkb_image_bannerBg</brandingImage>

<mobileBrandingImage>pkb_image_bgBottom</mobileBrandingImage>

<domain>mydomain</domain>

</domainWhiteList>

<site>GL_Knowledge_Base</site>

<windowTitle>My window title</windowTitle>

</LiveChatDeployment>

Note: If you update your deployment through the Metadata API, be sure to update all Web pages that use the same deployment

code.

LiveChatSensitiveDataRule

Represents a rule for masking or deleting data of a specified pattern. Written as a regular expression (regex).

Use this object to mask or delete data of specified patterns, such as credit card, social security, phone and account numbers, or even

profanity. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

LiveChatSensitiveDataRule components have the suffix .liveChatSensitiveDataRule and are stored in the

liveChatSensitiveDataRule folder.

Version

LiveChatSensitiveDataRule components are available in API version 35.0 and later.

453

LiveChatSensitiveDataRuleMetadata Types

Fields

DescriptionField TypeField Name

Required. The action to take on the text when the sensitive data rule is

triggered. Possbile values are:

SensitiveDataActionType

(enumeration of

type string)

actionType

•Remove

•Replace

The description of the sensitive data rule—for example, “Block social

security numbers.”

stringdescription

Required. Determines the roles on which the rule is enforced. The value

is determined using bitwise OR operation. There are seven possible

values:

intenforceOn

1. Rule enforced on Agent

2. Rule enforced on Visitor

3. Rule enforced on Agent and Visitor

4. Rule enforced on Supervisor

5. Rule enforced on Agent and Supervisor

6. Rule enforced on Visitor and Supervisor

7. Rule enforced on Agent, Visitor, and Supervisor

Required. Specifies whether a sensitive data rule is active (true) or not

(false). Default value (if none is provided) is false.

booleanisEnabled

Required. The pattern of text blocked by the rule. Written as a JavaScript

regular expression (regex).

stringpattern

The string of characters that replaces the blocked text (if ActionType

Replace is selected).

stringreplacement

Declarative Metadata Sample Definition

The following is an example of a LiveChatSensitiveDataRule component.

<actionType>REPLACE</actionType>

<pattern>[aeiou]</pattern>

</LiveChatSensitiveDataRule>

The following is an example package.xml that references the previous definition.

<!-- To be used from

454

LiveChatSensitiveDataRuleMetadata Types

support.liveagent.testsuite.unifiedouting.testDeployButtonMDAPIWithExistingQueue -->

<apiAccessLevel>Unrestricted</apiAccessLevel>

<types>

<members>Change_For_all</members>

<name>LiveChatSensitiveDataRule</name>

</types>

</Package>

ManagedTopics

Represents navigational and featured topics managed in a community. A specific community is represented by the Network component.

Note: The related network must exist before you deploy managed topics. (This occurs automatically when deploying an entire

organization.)

File Suffix and Directory Location

Components have the suffix managedTopics and are stored in the managedTopics folder. In that folder, you’ll find separate files for each

network (for example, NetworkNameA.managedTopics and NetworkNameB.managedTopics).

Version

ManagedTopics components are available in API version 32.0 and later.

Fields

DescriptionField TypeField Name

Represents a specific navigational or featured topic.ManagedTopicManagedTopic

ManagedTopic

DescriptionField TypeField Name

The topic name.stringname

The topic type: “Navigational” or “Featured”stringmanagedTopicType

An optional description of topic contents. This field is accessible only via

the API; there is no corollary in the user interface.

stringtopicDescription

The name of a parent topic for which this topic is a child. Child topics are

accessible from the subtopics section of the parent topic page and their

feeds are added to the parent topic feed.

Only navigational topics support parent-child relationships.

stringparentName

455

ManagedTopicsMetadata Types

DescriptionField TypeField Name

The placement of this topic relative to others of the same type. The results

differ depending on topic type:

intposition

•For top-level navigational topics, position arranges the Topics

menu in the community.

•For child navigational topics, it arranges sibling topics in the subtopics

section.

•For featured topics, it arranges topic thumbnail images on the

community home page.

Enter a number between 0 and 24. (The maximum amount of navigational

or featured topics is 25.)

Declarative Metadata Sample Definition

The following example retrieves or deploys managed topics for all networks:

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>ManagedTopics</name>

</types>

</Package>

The following example shows a package.xml file referencing the ManagedTopics component:

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>NetworkName</members>

<name>ManagedTopics</name>

</types>

</Package>

The following example shows the ManagedTopics component itself:

<?xml version="1.0" encoding="UTF-8"?>

<name>Running</name>

<managedTopicType>Navigational</managedTopicType>

<topicDescription>Training advice</topicDescription>

</ManagedTopic>

<name>Hiking</name>

<managedTopicType>Navigational</managedTopicType>

<topicDescription>Routes and gear</topicDescription>

456

ManagedTopicsMetadata Types

</ManagedTopic>

<name>Trails</name>

<managedTopicType>Navigational</managedTopicType>

<topicDescription>Maps for local favorites</topicDescription>

<parentName>Hiking</parentName>

</ManagedTopic>

<name>Backpacks</name>

<managedTopicType>Navigational</managedTopicType>

<topicDescription>Recommended models</topicDescription>

<parentName>Hiking</parentName>

</ManagedTopic>

<name>Footwear</name>

<managedTopicType>Featured</managedTopicType>

<topicDescription>Suggested types for each sport</topicDescription>

</ManagedTopic>

<name>Conditioning</name>

<managedTopicType>Featured</managedTopicType>

<topicDescription>How to get fit for any activity</topicDescription>

</ManagedTopic>

</ManagedTopics>

MatchingRule

Represents a matching rule that is used to identify duplicate records. This type extends the Metadata metadata type and inherits its

fullName field.

File Suffix and Directory Location

Matching rule components have the .matchingRule suffix and are stored in the matchingRules folder. The name of the

component file is the standard or custom object name that is associated with the matching rule.

In API version 39.0 and later, MatchingRule supports the Person Account object.

•The component file name is PersonAccount.matchingRule.

•The component directory is matchingRules.

Version

MatchingRule is available in API version 33.0 and later.

457

MatchingRuleMetadata Types

Fields

DescriptionField TypeField Name

Specifies filter logic conditions. For more information on filter logic, see

“Getting the Most Out of Filter Logic” in the Salesforce Help.

stringbooleanFilter

The description of the matching rule.stringdescription

Required. The name of the matching rule.stringlabel

The criteria that make up a matching rule.MatchingRuleItemmatchingRuleItems

Required. The activation status of the matching rule. Values are:MatchingRuleStatus

(enumeration of

type string)

ruleStatus

•Inactive

•Deactivating

•DeactivationFailed

•Active

•Activating

•ActivationFailed

Important: The only valid values you can declare when

deploying a package are Active and Inactive.

MatchingRuleItem

DescriptionField TypeField Name

Specifies how blank fields affect whether the fields being compared are

considered matches. Valid values are:

BlankValueBehavior

(enumeration of type

string)

blankValueBehavior

•MatchBlanks

•NullNotAllowed (default)

Required. Indicates which field to compare when determining if a record is

similar enough to an existing record to be considered a match.

stringfieldName

Required. Defines how the fields are compared. Choose between the exact

matching method and various fuzzy matching methods. Valid values are:

MatchingMethod

(enumeration of type

string)

matchingMethod

•Exact

•FirstName

•LastName

•CompanyName

•Phone

•City

•Street

•Zip

458

MatchingRuleMetadata Types

DescriptionField TypeField Name

•Title

For details on each matching method, see “Matching Methods Used with

Matching Rules” in the Salesforce Help.

Declarative Metadata Sample Definition

The following is a sample XML definition of a matching rule. A matching rule can be associated with either a standard or a custom object.

<?xml version="1.0" encoding="UTF-8"?>

<fullName>AccountMatchingRule</fullName>

<label>Matching rule for accounts</label>

<description>this is sample rule description</description>

<blankValueBehavior>NullNotAllowed</blankValueBehavior>

<fieldName>BillingCity</fieldName>

</matchingRuleItems>

<blankValueBehavior>NullNotAllowed</blankValueBehavior>

<matchingMethod>CompanyName</matchingMethod>

</matchingRuleItems>

<ruleStatus>Inactive</ruleStatus>

</matchingRules>

</MatchingRules>

The following package.xml shows how to reference a matching rule by name. It specifies the type name of MatchingRule.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Account.AccountMatchingRule</members>

<name>MatchingRule</name>

</types>

</Package>

The following package.xml shows how to reference all matching rules by specifying the plural MatchingRules type name and using

a wildcard to include all members.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>MatchingRules</name>

</types>

459

MatchingRuleMetadata Types

</Package>

Metadata

This is the base class for all metadata types. You cannot edit this object. A component is an instance of a metadata type.

Metadata is analogous to sObject, which represents all standard objects. Metadata represents all components and fields in Metadata

API. Instead of identifying each component with an ID, each custom object or custom field has a unique fullName, which must be

distinct from standard object names, as it must be when you create custom objects or custom fields in the Salesforce user interface.

Version

Metadata components are available in API version 10.0 and later.

Fields

DescriptionField TypeField Name

Required. The name of the component. If a field, the name must specify

the parent object, for example Account.FirstName. The __c suffix

stringfullName

must be appended to custom object names and custom field names

when you are setting the fullName. For example, a custom field in a

custom object could have a fullName of

MyCustomObject__c.MyCustomField__c.

To reference a component in a package, prepend the package’s

namespace prefix to the component name in the fullName field. Use

the following syntax: namespacePrefix__ComponentName.

For example, for the custom field component

MyCustomObject__c.MyCustomField__c and the namespace

MyNS, the full name is

MyNS__MyCustomObject__c.MyCustomField__c.

Note: A namespace prefix is a 1 to 15-character alphanumeric

identifier that distinguishes your package and its contents from

other publishers’ packages. For more information, see “Register a

Namespace Prefix” in the Salesforce Help.

SEE ALSO:

CustomObject

CustomField

MetadataWithContent

460

MetadataMetadata Types

MetadataWithContent

This is the base type for all metadata types that contain content, such as documents or email templates. It extends Metadata. You cannot

edit this object.

Version

MetadataWithContent components are available in API version 14.0 and later.

Fields

DescriptionField TypeField Name

Base 64-encoded binary data. Prior to making an API call, client

applications must encode the binary attachment data as base64. Upon

base64Binarycontent

receiving a response, client applications must decode the base64 data

to binary. This conversion is usually handled for you by a SOAP client.

Required. The name of the component. The fullName can contain

only underscores and alphanumeric characters. It must be unique, begin

stringfullName

with a letter, not include spaces, not end with an underscore, and not

contain two consecutive underscores.

Inherited from the Metadata component, this field is not defined in the

WSDL for this component. It must be specified when creating, updating,

or deleting. See create() to see an example of this field specified for

a call.

SEE ALSO:

Metadata

MilestoneType

Represents the name and description of a milestone, which you can use in an entitlement process to track important steps in cases. This

type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

Milestone types are stored in the milestoneTypes directory of the corresponding package directory. The extension is

.milestoneType.

Version

MilestoneType is available in API version 27.0 and later.

461

MetadataWithContentMetadata Types

Fields

DescriptionField TypeField Name

The description of the milestone.stringdescription

The type of recurrence for the milestone. Available in API version 29.0

and later. Valid values are:

MilestoneTypeRecurrenceType

(enumeration of

type string)

RecurrenceType

•none—Specifies no recurrence for the milestone. The milestone

occurs only once until the entitlement process exits.

•recursIndependently—Specifies independent recurrence

for the milestone.

•recursChained—Specifies sequential recurrence for the

milestone.

Declarative Metadata Sample Definition

This is a sample milestone type.

<?xml version="1.0" encoding="UTF-8"?>

<description>First Response Time</description>

</MilestoneType>

And, here’s the sample package.xml file that references the MilestoneType component definition:

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>* or a valid name of a milestone type</members>

<name>MilestoneType</name>

</types>

</Package>

ModerationRule

Represents a rule used in your community to moderate member-generated content.Each rule specifies the member-generated content

the rule applies to, the criteria to enforce the rule on, and the moderation action to take. Moderation rules help protect your community

from spammers, bots, and offensive or inappropriate content. This type extends the Metadata metadata type and inherits its fullName

field.

Community moderation rules created with the Metadata API are more powerful than moderation rules set up in the Community

Management UI. For example, in the UI you could create a rule that moderates posts and comments. In the Metadata API you could

create a rule that moderates only the Link Name of a Link feed type. Use the Metadata API to express complex moderation rules.

Important: Don’t update moderation rules you create using the Metadata API in the Community Management UI. If you do, you

overwrite relevant Metadata API fields or the fields are ignored.

Keep the following things in mind when creating moderation rules:

462

ModerationRuleMetadata Types

•Your org can have up to 30 rules. This limit is per org, not per community. This limit includes both content rules and rate rules.

•Each rule can have up to three keyword criteria.

•Rules that block content run first, followed by rules to review and approve content, then rules that replace content, and last by rules

that flag content. If two or more rules perform the same action, the oldest rule runs first, based on the date the rule was created.

Rules to replace content don’t run when the content also applies to a review rule—we want community managers to review the

original content.

File Suffix and Directory Location

ModerationRule components have the suffix .rule and are stored in the moderation directory of the corresponding package

directory. The file name format follows community_name.moderation_rule_developer_name.rule.

Version

ModerationRule components are available in API version 36.0 and later.

Special Access Rules

To view, create, edit, and delete moderation rules, you need the Manage Communities or Create and Set Up Communities permission.

Fields

DescriptionField TypeField Name

Required. Indicates the moderation action that you want to take. The

valid values are:

ModerationRuleAction

(enumeration of

type string)

action

•Block

•Review

•Replace

•Flag

•FreezeAndNotify (Reserved for future use.)

Indicates the moderation action limit. Available in API 39.0 and later.intactionLimit

Required. Indicates whether the moderation rule is active (true) or

inactive (false).

booleanactive

A description of the moderation rule.stringdescription

Indicates the types of user-generated content this moderation rule

applies to.

ModeratedEntityField[]entitiesAndFields

Required. Label for the moderation rule.stringmasterLabel

Indicates the notification limit of the moderation rule. Available in API

39.0 and later.

intnotifyLimit

463

ModerationRuleMetadata Types

DescriptionField TypeField Name

Represents the member criteria to use in community moderation rules.

Available in API 39.0 and later.

stringuserCriteria

The message you want your community members to see when their

content is blocked. Use the %BLOCKED_KEYWORD% variable to display

stringuserMessage

up to five blocked words in the user message. If you don’t specify a

message, the member sees the standard message: “You can’t use

%BLOCKED_KEYWORD% or other inappropriate words in this

community. Review your content and try again.”

ModeratedEntityField

The fields and entities you want to moderate.

DescriptionField TypeField Name

Required. Indicates the types of user-generated content the moderation rule

applies to. Post and comments only apply to content created in groups and

user profiles. All feed types, such as polls and links, are supported.

stringentityName

Indicates the field the moderation rule applies to.stringfieldName

Note: To moderate feed posts, use entityName FeedItem with

fieldName RawBody. To moderate feed comments, use

entityName FeedComment with fieldName

RawCommentBody. The RawBody and RawCommentBody

fields aren’t available in any other API.

Indicates the keyword list that you want to moderate against.KeywordList stringkeywordList

ModerationRuleType

Required. Indicates the type of rule to run on user-generated content.

DescriptionField TypeField Name

Required. Indicates the type of rule to run on user-generated content. Valid

values are:

(enumeration of type

string)

type

•Content

•Rate

Available in API 39.0 and later.

RateLimitTimePeriod

Required. Indicates the time period that is applied to the rate limit.

464

ModerationRuleMetadata Types

DescriptionField TypeField Name

Required. Indicates the time period that is applied to the rate limit. Valid values

are:

(enumeration of type

string)

timePeriod

•Short

•Medium

Available in API 39.0 and later.

Declarative Metadata Sample Definition

The following is an example of a ModerationRule component.

<?xml version="1.0" encoding="UTF-8"?>

<description>Blocks Bad Word List in posts, comments, Link URLs, titles, and poll

choices.</description>

<masterLabel>Blocking Rule</masterLabel>

<action>Block</action>

<userMessage>You can't use %BLOCKED_KEYWORD% or other inappropriate words in this

community. Review your content and try again.</userMessage>

<!-- Applies the rule to FeedComment.RawCommentBody (an internal only field), if it

contains words from the keyword list specified -->

<entityName>FeedComment</entityName>

<fieldName>RawCommentBody</fieldName>

<keywordList>community1.badword_list</keywordList>

</entitiesAndFields>

<entityName>FeedItem</entityName>

<fieldName>LinkUrl</fieldName>

<keywordList>community1.badword_list</keywordList>

</entitiesAndFields>

<!-- Applies the rule to FeedItem.RawBody (an internal only field), if it contains words

from the keyword list specified -->

<entityName>FeedItem</entityName>

<fieldName>RawBody</fieldName>

<keywordList>community1.badword_list</keywordList>

</entitiesAndFields>

<entityName>FeedItem</entityName>

<fieldName>Title</fieldName>

<keywordList>community1.badword_list</keywordList>

</entitiesAndFields>

<entityName>FeedPollChoice</entityName>

<fieldName>ChoiceBody</fieldName>

<keywordList>community1.badword_list</keywordList>

</entitiesAndFields>

</ModerationRule>

465

ModerationRuleMetadata Types

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>ModerationRule</name>

<members>community1.blocking_rule</members>

</types>

</Package>

NamedCredential

Represents a named credential, which specifies the URL of a callout endpoint and its required authentication parameters in one definition.

A named credential can be specified as an endpoint to simplify the setup of authenticated callouts.

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

NamedCredential components have the suffix .namedCredential and are stored in the namedCredentials folder.

Version

NamedCredential components are available in API version 33.0 and later.

Fields

DescriptionField TypeField Name

The authentication provider that the AuthProvider component represents.stringauthProvider

If you specify a certificate, your Salesforce org supplies it when

establishing each two-way SSL connection with the external system.

stringcertificate

The certificate is used for digital signatures, which verify that requests

are coming from your Salesforce org.

The URL or root URL of the callout endpoint. Corresponds to URL in the

user interface.

stringendpoint

A user-friendly name for the named credential that appears in the

Salesforce user interface, such as in list views.

stringlabel

The OAuth refresh token. Used to obtain a new access token for an end

user when a token expires.

stringoauthRefreshToken

Specifies the scope of permissions to request for the access token.

Corresponds to Scope in the user interface.

stringoauthScope

The access token that’s issued by your authorization server.stringoauthToken

466

NamedCredentialMetadata Types

DescriptionField TypeField Name

The password to be used by your org to access the external system.

Ensure that the credentials have adequate privileges to access the

stringpassword

external system. Depending on how you set up access, you might need

to provide the administrator password.

Determines whether you're using one set or multiple sets of credentials

to access the external system. Corresponds to Identity Type in

the user interface. The valid values are:

External

PrincipalType

(enumeration of

type string)

principalType

•Anonymous

•PerUser

•NamedUser

The authentication protocol for accessing the external system. The valid

values are:

Authentication

Protocol

(enumeration of

type string)

protocol

•NoAuthentication

•Oauth

•Password

The username to be used by your org to access the external system.

Ensure that the credentials have adequate privileges for performing

stringusername

callouts to the external system. Depending on how you set up access,

you might need to provide the administrator username.

Declarative Metadata Sample Definition

The following is an example of a NamedCredential component.

<?xml version="1.0" encoding="UTF-8"?>

<endpoint>https://my_endpoint.example.com</endpoint>

<label>My Named Credential</label>

<principalType>PerUser</principalType>

<protocol>NoAuthentication</protocol>

</NamedCredential>

Network

Represents a community. Communities are branded spaces for your employees, customers, and partners to connect. You can customize

and create communities to meet your business needs, then transition seamlessly between them. Use the Network component for

Salesforce Communities. If you want to create zones that contain Chatter Answers and Ideas, use the Community (Zone) component.

This type extends the Metadata metadata type and inherits its fullName field.

467

NetworkMetadata Types

Declarative Metadata File Suffix and Directory Location

Network components are stored in the networks directory of the corresponding package directory. The file name matches the

community name, and the extension is .network.

Version

This object is available in API version 28.0 and later.

Fields

DescriptionField TypeField

Specifies the types of files allowed in your community.

This whitelist of file types lets you control what your

stringallowedExtensions

community members upload and also prevents spammers

from polluting your community with inappropriate files.

Available in API version 36.0 and later.

Determines whether users in the community can flag

posts or comments as inappropriate. Flagged items are

booleanallowMembersToFlag

sent to a community moderator for review. Available in

API version 29.0 and later.

The color scheme, header, and footer used in the

community.

Brandingbranding

Email template used when notifying community members

when a case comment has been modified or added to a

case.

stringcaseCommentEmailTemplate

Email template used when notifying a user that their

password has been reset.

stringchangePasswordTemplate

Description of the community.stringdescription

Email address from which community emails are sent.stringemailSenderAddress

Name from which community emails are sent.stringemailSenderName

Specifies whether guest users can access public Chatter

groups in the community without logging in.

booleanenableGuestChatter

Determines whether users can invite others to the

community.

booleanenableInvitation

Determines if community members can see who’s

knowledgeable on topics and endorse people for their

booleanenableKnowledgeable

knowledge on a topic. Available in API version 30.0 and

later.

468

NetworkMetadata Types

DescriptionField TypeField

Determines if user nicknames display instead of their first

and last names in most places in the community. Set to

false by default. Available in API version 32.0 and later.

booleanenableNicknameDisplay

Determines if community members can send and receive

private messages. Available in API version 30.0 and later.

booleanenablePrivateMessages

Determines if reputation is calculated and displayed for

community members. Available in API version 31.0 and

later.

If enabled, reputationLevels and

reputationPointsRules are used. If no

booleanenableReputation

reputationLevels or

reputationPointsRules are not defined in the

data file, the default values are used.

Determines whether the community uses Site.com pages

instead of tabs.

booleanenableSiteAsContainer

The email template used when a user forgets their

password.

stringforgotPasswordTemplate

Specifies the maximum file size (in KBs) that members can

upload in your community. Available in API version 36.0

intmaxFileSizeKb

and later. Enter a number between 3072 KB and your org’s

maximum file size. To use the default limit of 2 GB, leave

this field empty.

Represents the navigation menu in a community. A

navigation menu consists of items that users can click to

NavigationLinkSetnavigationLinkSet

go to other parts of the community. This field is available

in API version 37.0 and later.

The profiles and permission sets that have access to the

community. Users with these profiles or permission sets

are members of the community.

NetworkMemberGroupsnetworkMemberGroups

Note: If a Chatter customer (from a customer

group) is assigned a permission set that is also

associated with a community, the Chatter customer

isn’t added to the community.

Email address that has been entered as the new value for

EmailSenderAddress but has not been verified

stringnewSenderAddress

yet. After a user has requested to change the sender email

address and has successfully responded to the verification

email, the NewSenderAddress value overwrites the

value in EmailSenderAddress. This becomes the

email address from which community emails are sent.

469

NetworkMetadata Types

DescriptionField TypeField

Name of the Site.com site linked to the community.stringpicassoSite

The reputation levels assigned to members when they

accrue points by performing certain actions.

ReputationLevelDefinitionsreputationLevels

The points members accrue when they perform certain

defined actions.

ReputationPointsRulesreputationPointsRules

The profile assigned to users who self register. This value

is used only if selfRegistration is enabled for the

community. Available in API version 29.0 and later.

stringselfRegProfile

Determines whether self-registration is available for the

community.

booleanselfRegistration

Determines whether a welcome email is sent when a new

user is added to the community.

booleansendWelcomeEmail

The CustomSite associated with the community.stringsite

Status of the community. Available values are:NetworkStatus[]status

•Live—The community is online and members can

access it.

•DownForMaintenance—The community was

previously published, but was taken offline. Members

with “Create and Set Up Communities” can still access

the setup for offline communities regardless of profile

or membership. Members are not able to access offline

communities, but they still appear in the user interface

drop-down as CommunityName (Offline).

•UnderConstruction—The community has not yet

been published. Users with “Create and Set Up

Communities” can access communities in this status

if their profile is associated with the community.

Once a community is published, it can never be in

this status again.

The tabs that are available in the community. The user

that created the community selected these tabs.

NetworkTabSettabs

The first part of the path on the site's URL that

distinguishes this site from other sites. For example, if your

stringurlPathPrefix

site URL is mycompany.force.com/partners,

then partners is the urlPathPrefix.

The email template used when sending welcome emails

to new community members.

stringwelcomeTemplate

470

NetworkMetadata Types

Branding

Represents the branding and color scheme applied to the community.

DescriptionField TypeField

The text that appears in the footer of the

community login page.

stringloginFooterText

The logo that appears on the community

stringloginLogo

An image that appears on the footer of the

community pages. Must be an .html file.

stringpageFooter

An image that appears on the header of the

community pages. Can be an .html, .gif, .jpg,

or .png file.

stringpageHeader

The color used for the active tab.stringprimaryColor

Font color used with primaryColor.stringprimaryComplementColor

The background color for pages in the

community.

stringquaternaryColor

Font color used with

quaternaryColor.

stringquaternaryComplementColor

The color used for the top borders of lists

and tables.

stringsecondaryColor

The background color for section headers

on edit and detail pages.

stringtertiaryColor

Font color used with tertiaryColor.stringtertiaryComplementColor

The background color for the header.stringzeronaryColor

Font color used with zeronaryColor.stringzeronaryComplementColor

NavigationLinkSet

Represents the navigation menu in a community. A navigation menu consists of items that users can click to go to other parts of the

community.

DescriptionField TypeField

A list of menu items in a NavigationLinkSet.

Use this object to create, delete, or update

NavigationMenuItem[]navigationMenuItem

menu items in your community’s navigation

menu.

471

NetworkMetadata Types

NavigationMenuItem

Represents a single menu item in a NavigationLinkSet. Use this object to create, delete, or update menu items in your community’s

navigation menu.

DescriptionField TypeField

If the value of the type field is

SalesforceObject, the value is the

ID of the default list view for the object.

stringdefaultListViewId

Required. The text that appears in the

navigation menu for this item.

stringlabel

Required. The location of the menu item in

the navigation menu.

intposition

When set to true, gives access to guest

users.

booleanpubliclyAvailable

A list of child menu items. This field is

available in API 39.0 and later.

NavigationSubMenusubMenu

Required if type is ExternalLink,

InternalLink, or

stringtarget

SalesforceObject. If type is

ExternalLink or InternalLink,

the target is the URL that the link points to.

For ExternalLink, your entry looks like

this: http://www.salesforce.com.

For InternalLink, use a relative URL,

such as /contactsupport. If type

is MenuLabel or

NavigationalTopic, target is not

used.

Backed by a picklist that includes

preferences for the target field. Valid values

are:

stringtargetPreference

•None

•OpenInExternalTab—Used for

external links to determine whether to

open in an external tab.

Required. The type of navigation menu item.

Valid values are:

stringtype

•SalesforceObject—Available

objects include accounts, cases,

contacts, and custom objects.

•ExternalLink—Links to a URL

outside of your community. For

472

NetworkMetadata Types

DescriptionField TypeField

example,

http://www.salesforce.com.

•InternalLink—Links to a relative

URL inside your community. For

example, /contactsupport.

•MenuLabel—A parent heading for

your navigation menu. See

NavigationSubMenufor how to nest

items underneath the menu label. This

value is available in API 39.0 and later.

•NavigationalTopic—A

drop-down list with links to the

navigational topics in your community.

You cannot nest other items of type

MenuLabel or items of type

NavigationalTopic under

MenuLabel.

NavigationSubMenu

A list of child menu items. Only NavigationMenuItem items of type MenuLabel can have items in a NavigationSubMenu. Available

in API 39.0 and later.

DescriptionField TypeField

A list of menu items in a

NavigationSubMenu. Use

NavigationMenuItem[]navigationMenuItem

navigationMenuItem to create,

delete, or update child items under a parent

heading.

NetworkMemberGroup

Represents the profiles and permission sets that are assigned to the community. Users with one of the profiles or permission sets are

members of the community, unless the user is a Chatter customer (from a customer group).

DescriptionField TypeField

A permission set that is assigned to the

community.

stringpermissionSet

Note: If a Chatter customer (from a

customer group) is assigned a

permission set that is also associated

with a community, the Chatter

473

NetworkMetadata Types

DescriptionField TypeField

customer isn’t added to the

community.

A profile that is part of the community.stringprofile

ReputationBranding

Branding for the reputation level.

DescriptionField TypeField

Custom image associated with a reputation

level. Use files with these extensions: .jpeg,

stringsmallImage

.png, or .gif. Images are stored as

documents. If not specified, the default

reputation level image is used. Available in

API version 32.0 and later.

ReputationLevelDefinitions

Represents reputation levels members can achieve by performing certain defined actions in a community.

DescriptionField TypeField

Represents reputation levels.ReputationLevel[]level

ReputationLevel

Represents the name and lower value of the reputation level. The upper value is calculated by the application.

DescriptionField TypeField

Represents any branding associated with

the reputation level, specifically, the custom

image for the reputation level.

This field is optional. If not specified, the

default reputation level image is used.

Available in API version 32.0 and later.

ReputationBranding[]branding

Name of the reputation level.

This field is optional. If not specified, one of

the 10 defaults are used.

stringlabel

•Level 1

•Level 2

474

NetworkMetadata Types

DescriptionField TypeField

•Level 3

•Level 4

•Level 5

•Level 6

•Level 7

•Level 8

•Level 9

•Level 10

Required. The lower value in the range for

this reputation level. For example, if this

doublelowerThreshold

reputation level is for points 1–50, 1 is the

lowerThreshold.

ReputationPointsRules

Represents points rules in a community’s point system.

DescriptionField TypeField

Represents events and their associated

points.

ReputationPointsRule[]pointsRule

ReputationPointsRule

Represents the event and associated point value for a points rule. When a user acts, they accrue the associated points.

DescriptionField TypeField

Required. The type of event a member has to perform to get points.

The available values are:

stringeventType

•FeedItemWriteAPost

•FeedItemWriteAComment

•FeedItemReceiveAComment

•FeedItemLikeSomething

•FeedItemReceiveALike

•FeedItemMentionSomeone

•FeedItemSomeoneMentionsYou

•FeedItemShareAPost

•FeedItemSomeoneSharesYourPost

•FeedItemPostAQuestion

•FeedItemAnswerAQuestion

475

NetworkMetadata Types

DescriptionField TypeField

•FeedItemReceiveAnAnswer

•FeedItemMarkAnswerAsBest

•FeedItemYourAnswerMarkedBest

•FeedItemEndorseSomeoneForKnowledgeOnATopic

•FeedItemEndorsedForKnowledgeOnATopic

Required. The number of points a member gets for performing the

event. The default number of points per event is:

intpoints

•FeedItemWriteAPost +1

•FeedItemWriteAComment: +1

•FeedItemReceiveAComment: +5

•FeedItemLikeSomething: +1

•FeedItemReceiveALike: +5

•FeedItemMentionSomeone: +1

•FeedItemSomeoneMentionsYou: +5

•FeedItemShareAPost: +1

•FeedItemSomeoneSharesYourPost: +5

•FeedItemPostAQuestion: +1

•FeedItemAnswerAQuestion: +5

•FeedItemReceiveAnAnswer: +5

•FeedItemMarkAnswerAsBest: +5

•FeedItemYourAnswerMarkedBest: +20

•FeedItemEndorseSomeoneForKnowledgeOnATopic: +5

•FeedItemEndorsedForKnowledgeOnATopic: +20

NetworkTabSet

DescriptionField TypeField

Custom tab that is part of the community.stringcustomTab

The Home tab for the community. When

members log in, this tab is the first page

they see.

stringdefaultTab

Standard tab that is part of the community.stringstandardTab

476

NetworkMetadata Types

Declarative Metadata Sample Definition

A sample XML definition of a network.

<?xml version="1.0" encoding="UTF-8"?>

<loginFooterText>salesforce.com</loginFooterText>

<loginLogo>Communities_Shared_Document_Folder/header2_png.png</loginLogo>

<pageFooter>Branding/footer_html.html</pageFooter>

<pageHeader>Branding/header_Image.jpg</pageHeader>

<primaryComplementColor>#FFFFFF</primaryComplementColor>

<quaternaryComplementColor>#FFFFFF</quaternaryComplementColor>

<tertiaryColor>#FFFFFF</tertiaryColor>

<zeronaryComplementColor>#FFFFFF</zeronaryComplementColor>

</branding>

<changePasswordTemplate>unfiled$public/CommunityChangePasswordEmailTemplate</changePasswordTemplate>

<description>Metadata Community</description>

<emailSenderAddress>admin@networkMetadata.com</emailSenderAddress>

<emailSenderName>Admin User</emailSenderName>

<enableInvitation>false</enableInvitation>

<enableNicknameDisplay>false</enableNicknameDisplay>

<forgotPasswordTemplate>unfiled$public/CommunityForgotPasswordEmailTemplate</forgotPasswordTemplate>

<permissionSet>Admin</permissionSet>

<permissionSet>Standard</permissionSet>

<permissionSet>ReadOnly</permissionSet>

<profile>Admin</profile>

<profile>Standard</profile>

<profile>ReadOnly</profile>

</networkMemberGroups>

<level>

<smallImage>communities_shared

_document_folder/replevel_beginner.png</smallImage>

</branding>

<label>Beginner</label>

</level>

<level>

477

NetworkMetadata Types

<smallImage>communities_shared

_document_folder/replevel_apprentice.png</smallImage>

</branding>

<label>Apprentice</label>

</level>

<level>

<smallImage>communities_shared

_document_folder/replevel_gettingthere.png</smallImage>

</branding>

<label>Getting There</label>

</level>

<level>

<smallImage>communities_shared

_document_folder/replevel_skilled.png</smallImage>

</branding>

<label>Skilled</label>

</level>

<level>

<smallImage>communities_shared

_document_folder/replevel_expert.png</smallImage>

</branding>

<label>Expert</label>

</level>

<level>

<smallImage>communities_shared

_document_folder/replevel_mentor.png</smallImage>

</branding>

<label>Mentor</label>

</level>

<level>

<smallImage>communities_shared

_document_folder/replevel_guru.png</smallImage>

</branding>

</level>

</reputationLevels>

<eventType>FeedItemWriteAPost</eventType>

</pointsRule>

<eventType>FeedItemWriteAComment</eventType>

478

NetworkMetadata Types

</pointsRule>

<eventType>FeedItemReceiveAComment</eventType>

</pointsRule>

<eventType>FeedItemLikeSomething</eventType>

</pointsRule>

<eventType>FeedItemReceiveALike</eventType>

</pointsRule>

<eventType>FeedItemMentionSomeone</eventType>

</pointsRule>

<eventType>FeedItemSomeoneMentionsYou</eventType>

</pointsRule>

<eventType>FeedItemShareAPost</eventType>

</pointsRule>

<eventType>FeedItemSomeoneSharesYourPost</eventType>

</pointsRule>

</reputationPointsRules>

<selfRegistration>false</selfRegistration>

<site>Network_11</site>

<status>UnderConstruction</status>

<tabs>

<defaultTab>Chatter</defaultTab>

<standardTab>Chatter</standardTab>

<standardTab>Account</standardTab>

<standardTab>Campaign</standardTab>

<standardTab>Console</standardTab>

<standardTab>Contact</standardTab>

<standardTab>Contract</standardTab>

<standardTab>Dashboard</standardTab>

<standardTab>JigsawSearch</standardTab>

<standardTab>CollaborationGroup</standardTab>

<standardTab>Opportunity</standardTab>

<standardTab>Product2</standardTab>

<standardTab>UserProfile</standardTab>

479

NetworkMetadata Types

<standardTab>report</standardTab>

<standardTab>Solution</standardTab>

</tabs>

<urlPathPrefix>network1</urlPathPrefix>

<welcomeTemplate>unfiled$public/CommunityWelcomeEmailTemplate</welcomeTemplate>

</Network>

SEE ALSO:

Community (Zone)

Package

Specifies which metadata components to retrieve as part of a retrieve() call or defines a package of components.

DescriptionTypeName

Package components have access via dynamic Apex and the

API to standard and custom objects in the organization where

APIAccessLevel (enumeration of

type string)

apiAccessLevel

they are installed. Administrators who install packages may

wish to restrict this access after installation for improved

security. The valid values are:

•Unrestricted—Package components have the same API

access to standard objects as the user who is logged in

when the component sends a request to the API.

•Restricted—The administrator can select which standard

objects the components can access. Further, the

components in restricted packages can only access custom

objects in the current package if the user's permissions

allow access to them.

For more information, see “About API and Dynamic Apex Access

in Packages” in the Salesforce online help.

A short description of the package.stringdescription

The package name used as a unique identifier for API access.

The fullName can contain only underscores and

stringfullName

alphanumeric characters. It must be unique, begin with a letter,

not include spaces, not end with an underscore, and not

contain two consecutive underscores. This field is inherited

from the Metadata component.

The namespace of the developer organization where the

package was created.

stringnamespacePrefix

Indicates which objects are accessible to the package, and the

kind of access available (create, read, update, delete).

ProfileObjectPermissions[]objectPermissions

Reserved for future use.stringpackageType

480

PackageMetadata Types

DescriptionTypeName

The name of the Apex class that specifies the actions to execute

after the package has been installed or upgraded. The Apex

stringpostInstallClass

class must be a member of the package and must implement

the Apex InstallHandler interface. In patch upgrades,

you can't change the class name in this field but you can

change the contents of the Apex class. The class name can be

changed in major upgrades.

This field is available in API version 24.0 and later.

The weblink used to describe package installation.stringsetupWeblink

The type of component being retrieved.PackageTypeMembers[]types

The name of the Apex class that specifies the actions to execute

after the package has been uninstalled. The Apex class must

stringuninstallClass

be a member of the package and must implement the Apex

UninstallHandler interface. In patch upgrades, you

can't change the class name in this field but you can change

the contents of the Apex class. The class name can be changed

in major upgrades.

This field is available in API version 25.0 and later.

Required. The version of the component type.stringversion

PackageTypeMembers

Use to specify the name and type of components to be retrieved in a package.

DescriptionTypeName

One or more named components, or the wildcard character

(*) to retrieve all metadata components of the type specified

stringmembers

in the <name> element. To retrieve a standard object, specify

it by name. For example,

<members>Account</members> retrieves the standard

Account object.

The type of metadata component to be retrieved. For example,

<name>CustomObject</name> retrieves one or more

custom objects as specified in the <members> element.

stringname

SEE ALSO:

Sample package.xml Manifest Files

481

PackageMetadata Types

PathAssistant

Represents Path records.This type extends the Metadata metadata type and inherits its fullName field.

Note the following when working with PathAssistant:

•Only one path can be created per record type for each object, including __Master__ record type.

•Rich text guidance information cannot be retrieved or deployed from or to translation workbench.

•The preference does not need to be on to retrieve or deploy PathAssistant.

File Suffix and Directory Location

PathAssistant components have the suffix .pathAssistant and are stored in the pathAssistants folder.

Version

PathAssistant components are available in API version 34.0 and later.

Fields

DescriptionField TypeField Name

Indicates whether the path is active (true) or not (false).booleanactive

Required. The entity name. This is hard coded for Opportunity, Lead, and

Quote. For a custom object, this field must be specified and should be

the name of the custom object. This field is not updateable.

stringentityName

Required. The field name. This is hard coded for StageName and Status.

For a custom object, this field must be specified and should be the name

stringfieldName

of the picklist field that determines the steps in the path. This field is not

updateable.

Required. The master label of the path.stringmasterLabel

List of all the steps that have been configured with fields and guidance

information. Note that a missing step in the .xml file means it has not

been configured, not that it doesn’t exist.

PathAssistantStep[]

on page 482

pathAssistantSteps

Required. The name of the record type associated with the path. This

field is not updateable.

stringrecordTypeName

PathAssistantStep

Represents the steps or stages in a Path.

DescriptionField TypeField Name

All the fields in entityName that will display in this step.stringfieldNames

482

PathAssistantMetadata Types

DescriptionField TypeField Name

The guidance information displayed in this step.stringinfo

Required. The picklist value associated with the step.stringpicklistValueName

Declarative Metadata Sample Definition

The following is an example of a PathAssistant component.

<?xml version="1.0" encoding="UTF-8"?>

<entityName>Opportunity</entityName>

<fieldName>StageName</fieldName>

<fieldNames>Amount</fieldNames>

<fieldNames>CloseDate</fieldNames>

<picklistValueName>Id. Decision Makers</picklistValueName>

</pathAssistantSteps>

<fieldNames>Amount</fieldNames>

<fieldNames>CloseDate</fieldNames>

<picklistValueName>Proposal/Price Quote</picklistValueName>

</pathAssistantSteps>

<recordTypeName>Test_Record_Type</recordTypeName>

</PathAssistant>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Opportunity.Test_Busines_Process</members>

<name>BusinessProcess</name>

</types>

<types>

<members>Opportunity.StageName</members>

<members>Lead.LeadSource</members>

<members>Opportunity.Type</members>

<name>CustomField</name>

</types>

<types>

<name>PathAssistant</name>

</types>

<types>

<members>Opportunity.Test_Record_Type</members>

<name>RecordType</name>

</types>

<types>

483

PathAssistantMetadata Types

<members>PathAssistant</members>

<name>Settings</name>

</types>

</Package>

PermissionSet

Represents a set of permissions that's used to grant additional access to one or more users without changing their profile or reassigning

profiles. You can use permission sets to grant access, but not to deny access. This type extends the Metadata metadata type and inherits

its fullName field.

In API version 29.0 and later, you can retrieve and deploy access settings for the following managed components in profiles and permission

sets:

•Apex classes

•Apps

•Custom field permissions

•Custom object permissions

•Custom tab settings

•External data sources

•Record types

•Visualforce pages

For more information, see Managed Component Access in Sample package.xml Manifest Files on page 22.

Declarative Metadata File Suffix and Directory Location

Permission sets are stored in the permissionsets directory. The file name matches the permission set API name and the extension

is .permissionset. For example, a permission set with the name User_Management_Perms is stored in

permissionsets/User_Management_Perms.permissionset.

Version

Permission sets are available in API version 22.0 and later.

Fields

DescriptionField TypeField

Indicates which apps are visible to users assigned to this

permission set. Available in API version 29.0 and later. In

PermissionSetApplicationVisibility[]applicationVisibilities

API version 29.0, this field supports custom apps only. In

API version 30.0 and later, this field supports both

standard and custom apps.

484

PermissionSetMetadata Types

DescriptionField TypeField

Indicates which top-level Apex classes have methods

that users assigned to this permission set can execute.

Available in API version 23.0 and later.

PermissionSetApexClassAccess[]classAccesses

Indicates which custom permissions are available to users

assigned to this permission set. Available in API version

31.0 and later.

PermissionSetCustomPermissions[]customPermissions

The permission set description. Limit: 255 characters.stringdescription

Indicates which data sources with identity type of Per

User are available to users assigned to this permission

set. Available in API version 27.0 and later.

PermissionSetExternal

DataSourceAccess[]

externalDataSourceAccesses

Indicates which fields are accessible to a user assigned

to this permission set, and the kind of access available

PermissionSetFieldPermissions[]fieldPermissions

(readable or editable). Available in API version 23.0 and

later.

Indicates whether the permission set requires an

associated active session (true) or not (false).

Available in API version 37.0 and later.

booleanhasActivationRequired

Required. The permission set label. Limit: 80 characters.stringlabel

Indicates the objects that are accessible to a user assigned

to this permission set, and the kind of access available

PermissionSetObjectPermissions[]objectPermissions

(create, read, edit, delete, and so on). Available in API

version 23.0 and later.

Indicates which Visualforce pages that users assigned to

this permission set can execute. Available in API version

23.0 and later.

PermissionSetApexPageAccess[]pageAccesses

Indicates which record types are visible to users assigned

to this permission set. Available in API version 29.0 and

PermissionSetRecordTypeVisibility[]recordTypeVisibilities

later. This field is never retrieved or deployed for inactive

record types.

Indicates the tab visibility settings for this permission set.

Available in API version 26.0 and later.

PermissionSetTabSetting[]tabSettings

Either the related permission set license or the user

license associated with this permission set. Available in

stringlicense

API version 38.0 and later. Use this field instead of

userLicense, which is deprecated and only available

up to API Version 37.0.

Deprecated. The user license for the permission set. A

user license determines the baseline of features that the

stringuserLicense

user can access. Every user must have exactly one user

485

PermissionSetMetadata Types

DescriptionField TypeField

license. Available up to API version 37.0. In API version

38.0 and later, use license.

Specifies an app or system permission (such as “API

Enabled”) and whether it's enabled for this permission

PermissionSetUserPermission[]userPermissions

set. In API version 28.0 and earlier, this field retrieves all

user permissions, enabled or disabled. In API version 29.0

and later, this field retrieves only enabled user

permissions.

PermissionSetApplicationVisibility

PermissionSetApplicationVisibility determines whether an app is visible to a user assigned to this permission set.

DescriptionField TypeField Name

Required. The app name.stringapplication

Required. Indicates whether this app is visible to users assigned to this

permission set (true) or not (false).

booleanvisible

PermissionSetApexClassAccess

PermissionSetApexClassAccess represents the Apex class access for users assigned to a permission set.

DescriptionField TypeField

Required. The Apex class name.stringapexClass

Required. Indicates whether users assigned to this permission set

can execute methods in the top-level class (true) or not (false).

booleanenabled

PermissionSetCustomPermissions

PermissionSetCustomPermissions represents the custom permissions access for users assigned to a permission set. Only enabled custom

permissions are retrieved.

DescriptionField TypeField Name

Required. Indicates whether the custom permission is enabled (true)

or not (false).

booleanenabled

Required. The custom permission name.stringname

486

PermissionSetMetadata Types

PermissionSetExternalDataSourceAccess

PermissionSetExternalDataSourceAccess represents the data source access for users with identity type of Per User. Available in API

version 27.0 and later.

DescriptionField TypeField

Required. Indicates whether the data source is enabled (true) or

not (false).

booleanenabled

The name of the external data source.stringexternalDataSource

PermissionSetFieldPermissions

PermissionSetFieldPermissions represents the field permissions for users assigned to a permission set. In API version 30.0 and later,

permissions for required fields can’t be retrieved or deployed.

Note: As of API version 38.0, you can change field permissions to make a field editable using the Metadata API for fields that you

can't change through the user interface. For example, you can deploy Asset.ProductCode as an editable field even though

you can't through the user interface.

DescriptionField TypeField

Required. Indicates whether the field can be edited by the users

assigned to this permission set (true) or not (false).

booleaneditable

Required. The API name of the field (such as

Warehouse__c.Description__c).

stringfield

Indicates whether the field can be read by the users assigned to

this permission set (true) or not (false).

booleanreadable

PermissionSetObjectPermissions

PermissionSetObjectPermissions represents the object permissions for a permission set. Use one of these elements for each permission.

DescriptionField TypeField

Required. Indicates whether the object referenced by the object

field can be created by the users assigned to this permission set

(true) or not (false).

booleanallowCreate

Required. Indicates whether the object referenced by the object

field can be deleted by the users assigned to this permission set

(true) or not (false).

booleanallowDelete

Required. Indicates whether the object referenced by the object

field can be edited by the users assigned to this permission set

(true) or not (false).

booleanallowEdit

487

PermissionSetMetadata Types

DescriptionField TypeField

Required. Indicates whether the object referenced by the object

field can be viewed by the users assigned to this permission set

(true) or not (false).

booleanallowRead

Required. Indicates whether the object referenced by the object

field can be viewed, edited, or deleted by the users assigned to

booleanmodifyAllRecords

this permission set (true) or not (false), regardless of the

sharing settings for the object. This includes private records (records

with no parent object). This is similar to the “Modify All Data” user

permission, but limited to the individual object level.

Required. The API name of the object (such as Warehouse__c).stringobject

Required. Indicates whether the object referenced by the object

field can be viewed by the users assigned to this permission set

booleanviewAllRecords

(true) or not (false), regardless of the sharing settings for the

object. This includes private records (records with no parent object).

This is similar to the “View All Data” user permission, but limited

to the individual object level.

PermissionSetApexPageAccess

PermissionSetApexPageAccess represents the Visualforce page access for users assigned to a permission set.

DescriptionField TypeField

Required. The Visualforce page name.stringapexPage

Required. Indicates whether users assigned to this permission set

can execute the Visualforce page (true) or not (false).

booleanenabled

PermissionSetRecordTypeVisibility

PermissionSetRecordTypeVisibility represents the visibility of record types for this permission set.

DescriptionField TypeField

Required. The record type name, for example

Account.MyRecordType.

stringrecordType

Required. Indicates whether the record type is visible to users

assigned to this permission set (true) or not (false).

booleanvisible

PermissionSetTabSetting

PermissionSetTabSetting represents the tab settings for a permission set.

488

PermissionSetMetadata Types

DescriptionField TypeField

Required. The tab name.stringtab

Required. Indicates the visibility settings for the tab. Valid values

are:

PermissionSetTabVisibility

(enumeration of type string)

visibility

•Available—The tab is available on the All Tabs page.

Individual users can customize their display to make the tab

visible in any app.

•None—The tab isn’t available on the All Tabs page or visible

in any apps.

•Visible—The tab is available on the All Tabs page and

appears in the visible tabs for its associated app. Individual

users can customize their display to hide the tab or make it

visible in other apps.

PermissionSetUserPermission

PermissionSetUserPermission represents an app or system permission for a permission set. Use one of these elements for each permission.

DescriptionField TypeField

Required. Indicates whether the permission is enabled (true) or

disabled (false).

booleanenabled

Required. The name of the permission.stringname

Declarative Metadata Sample Definition

When adding or changing a permission set, you don't need to include all permissions—you only need to include the permissions you're

adding or changing.

<?xml version="1.0" encoding="UTF-8"?>

<description>Grants all rights needed for an HR administrator to manage

employees.</description>

<label>HR Administration</label>

<userLicense>Salesforce</userLicense>

<application>JobApps__Recruiting</application>

</applicationVisibilities>

<name>APIEnabled</name>

</userPermissions>

489

PermissionSetMetadata Types

</objectPermissions>

<field>Job_Request__c.Salary__c</field>

</fieldPermissions>

<apexPage>Job_Request_Web_Form</apexPage>

</pageAccesses>

<apexClass>Send_Email_Confirmation</apexClass>

</classAccesses>

<tab>Job_Request__c</tab>

<visibility>Available</visibility>

</tabSettings>

<recordType>Recruiting.DevManager</recordType>

</recordTypeVisibilities>

</PermissionSet>

The following is an example package.xml manifest used to retrieve the PermissionSet metadata for an organization. When you retrieve

permission sets, you should also retrieve the related components with assigned permissions. For example, to retrieve

objectPermissions and fieldPermissions for a custom object, you must also retrieve the CustomObject component.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Job_Request__c</members>

<name>CustomTab</name>

</types>

<types>

<members>Job_Request__c</members>

<name>CustomObject</name>

</types>

<types>

<members>JobApps__Recruiting</members>

<name>CustomApplication</name>

</types>

<types>

<members>Recruiting.DevManager</members>

<name>RecordType</name>

</types>

<types>

<name>PermissionSet</name>

</types>

490

PermissionSetMetadata Types

</Package>

PlatformCachePartition

Represents a partition in the Platform Cache. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

PlatformCachePartition components have the suffix .cachePartition and are stored in the cachePartitions folder.

Version

PlatformCachePartition components are available in API version 35.0 and later.

Special Access Rules

The “Author Apex” permission is required to deploy and retrieve PlatformCachePartition components.

Fields

DescriptionField TypeField Name

Describes the cache partition.stringdescription

Required. Indicates whether this cache partition is the default

partition in your organization (true) or not (false).

booleanisDefaultPartition

Required. The label of the cache partition that appears in the

Salesforce user interface.

stringmasterLabel

An array of cache types that the partition can store.PlatformCachePartitionType[]platformCachePartitionTypes

PlatformCachePartitionType

Contains information about a partition type, including its minimum and allocated capacity.

DescriptionField TypeField Name

Required. The total storage capacity, in MB, that is allocated for the cache

type, including free, purchased, and trial cache. Purchased capacity

intallocatedCapacity

includes organization-wide cache, which can be used in any partition,

and namespace-specific cache, which can be used only in partitions

associated with a namespace.

Required. The amount of namespace-specific purchased storage capacity,

in MB, that is allocated for the cache type.

intallocatedPurchasedCapacity

491

PlatformCachePartitionMetadata Types

DescriptionField TypeField Name

Required. The amount of trial cache space, in MB, that is allocated for the

cache type.

intallocatedTrialCapacity

The type of cache. Valid values are:PlatformCacheType

(enumeration of type

string)

cacheType

•Session—Session cache

•Organization—Org cache

Declarative Metadata Sample Definition

The following is an example of a PlatformCachePartition component.

<?xml version="1.0" encoding="UTF-8"?>

<description>Custom partition and marked as default.</description>

<masterLabel>myPartition</masterLabel>

<cacheType>Session</cacheType>

</platformCachePartitionTypes>

<cacheType>Organization</cacheType>

</platformCachePartitionTypes>

</PlatformCachePartition>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>myPartition</members>

<name>PlatformCachePartition</name>

</types>

</Package>

If a namespace is defined in your organization, add the namespace prefix to your partition name. For example:

<members>Namespace.myPartition</members>

To retrieve all cache partitions from your organization, use the wildcard character (*) as follows.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>PlatformCachePartition</name>

</types>

492

PlatformCachePartitionMetadata Types

</Package>

Portal

The Portal metadata type represents a partner portal or Customer Portal. It extends Metadata and inherits its fullName field. To use

this metadata type, you must have a partner portal or Customer Portal enabled for your organization. For more information, see “Partner

Portal Overview” and “Enabling Your Customer Portal” in the Salesforce online help.

Declarative Metadata File Suffix and Directory Location

Force.com Portal components are stored in the portals directory of the corresponding package directory. The file name matches

the portal name, and the extension is .portal.

Version

Force.com Portal components are available in API version 15.0 and later.

Fields

DescriptionField TypeField

Required. Denotes whether this portal is active.booleanactive

The full name of the user designated to administer the portal.stringadmin

The default language for HTML messages for the portal. Use the

abbreviation for the language, for example, en_US for United

States English.

stringdefaultLanguage

The portal description.stringdescription

Required. The email address used when sending emails using

templates configured from the portal (for example, for resetting

the password).

stringemailSenderAddress

Required. The name to display when sending emails using

templates configured from the portal (for example, for resetting

the password).

stringemailSenderName

For the Customer Portal, allows portal users to close their own

cases.

booleanenableSelfCloseCase

The file to be used as the footer for this portal.stringfooterDocument

The email template to use when a user clicks the Forgot

Password link.

stringforgotPassTemplate

493

PortalMetadata Types

DescriptionField TypeField

Required. The name of the portal.

Inherited from Metadata, this field is not defined in the WSDL

for this metadata type. It must be specified when creating,

stringfullName

updating, or deleting. See create() to see an example of

this field specified for a call.

The file to be used as the header for this portal.stringheaderDocument

Determines whether self-registration is active or not for this

portal.

booleanisSelfRegistrationActivated

The file to be used as the header for this portal's login page.stringloginHeaderDocument

The file to be used as the logo for this portal.stringlogoDocument

The URL that the user should be redirected to on logout.stringlogoutUrl

The email template to be used for auto-notifications on new

case comments.

stringnewCommentTemplate

The email template to be used for auto-notifications on

password reset.

stringnewPassTemplate

The email template to be used for auto-notifications on new

user creation.

stringnewUserTemplate

The email template to be used for auto-notifications on owner

change.

stringownerNotifyTemplate

The URL of the self-registration page.stringselfRegNewUserUrl

The default profile for self-registered users.stringselfRegUserDefaultProfile

The default role for self-registered users. The valid values are:PortalRoles (enumeration of

type string)

selfRegUserDefaultRole

•Executive

•Manager

•User

•PersonAccount

The email template to be used for auto-notifications on

self-registration.

stringselfRegUserTemplate

Determines whether or not confirmation messages are displayed

for actions in the portal.

booleanshowActionConfirmation

The Document object to be used as the CSS stylesheet for this

portal.

stringstylesheetDocument

Required. The type for this portal. The valid values are:PortalType (enumeration of type

string)

type

•CustomerSuccess

•Partner

494

PortalMetadata Types

Declarative Metadata Sample Definition

A sample XML definition of a portal is shown below.

<?xml version="1.0" encoding="UTF-8"?>

<description>Customer Portal</description>

<emailSenderName>rguest@albany.com</emailSenderName>

<enableSelfCloseCase>false</enableSelfCloseCase>

<forgotPassTemplate>unfiled$public/ChangePwdEmail</forgotPassTemplate>

<isSelfRegistrationActivated>false</isSelfRegistrationActivated>

<newPassTemplate>unfiled$public/ChangePwdEmail</newPassTemplate>

<newUserTemplate>unfiled$public/NewUserEmail</newUserTemplate>

<selfRegUserTemplate>unfiled$public/SelfRegUserEmail</selfRegUserTemplate>

<showActionConfirmation>false</showActionConfirmation>

<type>CustomerSuccess</type>

</Portal>

SEE ALSO:

CustomSite

PostTemplate

Represents the metadata associated with an approval post template for Approvals in Chatter. With approval post templates, you can

customize the information included in approval request posts that appear in Chatter feeds. This type extends the Metadata metadata

type and inherits its fullName field.

Note: Review Chatter Post Templates for Approval Requests in the Salesforce Help before you create a post template.

File Suffix and Directory Location

PostTemplate components have the suffix .postTemplate and are stored in the postTemplates folder.

Version

PostTemplate components are available in API version 29.0 and later.

Fields

DescriptionField TypeField Name

Required. Specifies whether this is the default post template for the given object.

When set to true, this post template is used by approval processes that are

associated with the same object and don’t specify a post template.

booleandefault

495

PostTemplateMetadata Types

DescriptionField TypeField Name

When an object has no default post template, each of its approval processes uses

the system default post template, unless the approval process specifies its own

post template.

Optional description of the post template.stringdescription

Required. An array of up to four fields to include in approval request posts.

If the approval object is a detail object in a master-detail relationship, Owner

isn’t available for approval page layouts or approval post templates.

string[]fields

Required. Name of the post template. This non-unique label is different from the

unique name of the post template.

stringlabel

Declarative Metadata Sample Definition

The following is an example of a PostTemplate component:

<default>false</default>

<fields>NumberOfEmployees</fields>

<fields>NumberofLocations__c</fields>

<fields>PartnerAccount</fields>

<fields>LeadCustomFieldNumber__c</fields>

<label>My Lead Post Template</label>

</PostTemplate>

The following is an example package manifest that references the previous PostTemplate component.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Lead.leadtemplate</members>

<name>PostTemplate</name>

</types>

</Package>

Profile

Represents a user profile. A profile defines a user’s permission to perform different functions within Salesforce. This type extends the

Metadata metadata type and inherits its fullName field.

In API version 29.0 and later, you can retrieve and deploy access settings for the following managed components in profiles and permission

sets:

•Apex classes

•Apps

•Custom field permissions

•Custom object permissions

496

ProfileMetadata Types

•Custom tab settings

•External data sources

•Record types

•Visualforce pages

For more information, see Managed Component Access in Sample package.xml Manifest Files on page 22.

Declarative Metadata File Suffix and Directory Location

The file suffix is .profile. There is one file for each profile, stored in the profiles folder in the corresponding package directory.

Version

Profiles are available in API version 10.0 and later.

Fields

The content of a profile returned by Metadata API depends on the content requested in the RetrieveRequest message. For example,

profiles only include field-level security for fields included in custom objects returned in the same RetrieveRequest as the profiles.

Note: As of API version 38.0, you can change field permissions to make a field editable using the Metadata API for fields that you

can't change through the user interface. For example, you can deploy Asset.ProductCode as an editable field even though

you can't through the user interface.

The profile definition contains the following fields:

DescriptionField TypeField Name

Indicates which apps are visible to users assigned to this

profile. In API version 29.0 and earlier, this field supports

ProfileApplicationVisibility[]applicationVisibilities

custom apps only. In API version 30.0 and later, this field

supports both standard and custom apps.

Indicates which top-level Apex classes have methods

that users assigned to this profile can execute.

ProfileApexClassAccess[]classAccesses

Indicates whether the profile is a custom (true) or

standard (false) profile. Available in API version 30.0

and later.

booleancustom

Indicates which custom permissions are available to users

assigned to this profile. Available in API version 31.0 and

later.

ProfileCustomPermissions[]customPermissions

The profile description. Limit: 255 characters. Available

in API version 30.0 and later.

stringdescription

Indicates which data sources with identity type of Per

User are available to users assigned to this profile.

Available in API version 27.0 and later.

ProfileExternalDataSourceAccess[]externalDataSourceAccesses

497

ProfileMetadata Types

DescriptionField TypeField Name

Indicates which fields are visible to a user assigned to this

profile, and the kind of access available (editable or

ProfileFieldLevelSecurity[]fieldLevelSecurities

hidden). This field is available in API version 22.0 and

earlier.

Indicates which fields are visible to a user assigned to this

profile, and the kind of access available (editable or

ProfileFieldLevelSecurity[]fieldPermissions

readable). This field is available in API version 23.0 and

later.

The name can only contain characters, letters, and the

underscore (_) character, must start with a letter, and

stringfullName

cannot end with an underscore or contain two

consecutive underscore characters.

Inherited from the Metadata component, this field is not

defined in the WSDL for this component. It must be

specified when creating, updating, or deleting. See

create() to see an example of this field specified for

a call.

Indicates which layout to use for this profile.ProfileLayoutAssignments[]layoutAssignments

Indicates the hours within which a user with this profile

may log in. If not specified, the profile doesn’t restrict a

user’s login hours.

This field is available in API version 25.0 and later.

ProfileLoginHours[]loginHours

The list of IP address ranges from which users with a

particular profile can log in.

This field is available in API version 17.0 and later.

ProfileLoginIpRange[]loginIpRanges

Indicates which objects are accessible to a user assigned

to this profile, and the kind of access available (create,

ProfileObjectPermissions[]objectPermissions

read, edit, delete, and so on). In API version 28.0 and later,

this field is only retrieved when allowRead is true.

Indicates which Visualforce pages that users assigned to

this profile can execute.

ProfileApexPageAccess[]pageAccesses

A list of the Lightning Experience Home page action

overrides that are assigned to this profile. When a user

ProfileActionOverride[]profileActionOverrides

logs in with a profile, a matching ProfileActionOverride

assignment takes precedence over existing overrides for

the Home tab specified in ActionOverride.

This field is available in API version 37.0 and later.

498

ProfileMetadata Types

DescriptionField TypeField Name

Indicates the visibility of record types for users assigned

to this profile. In API version 29.0 and later, this field is

not retrieved or deployed for inactive record types.

ProfileRecordTypeVisibility[]recordTypeVisibilities

Indicates which record types are visible to a user assigned

to this profile, and therefore which tabs within an app

are visible.

ProfileTabVisibility[]tabVisibilities

The User License for the profile. A user license

determines the baseline of features that the user can

access. Every user must have exactly one user license.

This field is available in API version 17.0 and later.

stringuserLicense

Specifies a user permission (such as “API Enabled”) and

whether it’s enabled for this profile. This field retrieves

ProfileUserPermission[]userPermissions

only enabled user permissions. Available in API version

29.0 and later.

ProfileActionOverride

ProfileActionOverride represents a user profile-based override of an ActionOverride on a standard Home tab in Lightning Experience.

DescriptionField TypeField Name

Required. The possible values are the same as the actions you can

override:

stringactionName

•accept

•clone

•delete

•edit

•list

•new

•tab

•view

Set this field if type is set to flexipage, scontrol, or

visualforce. It refers to the name of the Lightning Page, s-control,

stringcontent

or Visualforce page to use as the override. To reference installed

components, use the format of

Component_namespace__Component_name.

499

ProfileMetadata Types

DescriptionField TypeField Name

The size of the page being overridden. Only the Large value is

supported. The other values, Small and Medium, are reserved for

future use.

The Large value represents the Lightning Experience desktop

environment, and is only valid for the flexipage type. For the

scontrol and visualforce types, this field defaults to null.

FormFactor

(enumeration of type

string)

formFactor

The name of the sObject type being overridden. Valid values are

standard and custom.

stringpageOrSobjectType

The record type assigned to the ProfileActionOverride. If the

PageOrSobjectType is standard-home, this field is null.

stringrecordType

Required. Represents the type of action override. Valid values are

described in ActionOverrideType.

ActionOverrideType

(enumeration of type

string)

type

ProfileApplicationVisibility

ProfileApplicationVisibility determines whether an app is visible to a user assigned to this profile.

DescriptionField TypeField Name

Required. The name of the app.stringapplication

Required. Indicates whether the app is the default app (true) or not

(false). Only one app per profile can be set to true.

booleandefault

Required. Indicates whether this app is visible to users assigned to this

profile (true) or not (false).

booleanvisible

ProfileApexClassAccess

ProfileApexClassAccess determines which top-level Apex classes have methods that users assigned to this profile can execute.

DescriptionField TypeField Name

Required. The Apex class name.stringapexClass

Required. Indicates whether users assigned to this profile can execute

methods in the top-level class (true) or not (false).

booleanenabled

ProfileCustomPermissions

ProfileCustomPermissions represents the custom permissions access for users assigned to a profile. Only enabled custom permissions

are retrieved.

500

ProfileMetadata Types

DescriptionField TypeField Name

Required. Indicates whether the custom permission is enabled (true)

or not (false).

booleanenabled

Required. The custom permission name.stringname

ProfileExternalDataSourceAccess

ProfileExternalDataSourceAccess represents the data source access for users with identity type of Per User. Available in API version

27.0 and later.

DescriptionField TypeField Name

Required. Indicates whether the data source is enabled (true) or not

(false).

booleanenabled

The name of the external data source.stringexternalDataSource

ProfileFieldLevelSecurity

ProfileFieldLevelSecurity represents the field level security for users assigned to a profile. In API version 30.0 and later, permissions for

required fields can’t be retrieved or deployed.

DescriptionField TypeField Name

Required. Indicates whether this field is editable (true) or not (false).

In API version 30.0 and later, when deploying a new custom field, this

field is false by default.

booleaneditable

Required. Indicates the name of the field.stringfield

Indicates whether this field is hidden (true) or not (false). This field

is available in API version 22.0 and earlier.

For portal profiles, this is set to true by default in API version 19.0 and

later.

booleanhidden

Indicates whether this field is readable (true) or not (false). This field

is available in API version 23.0 and later. It replaces the hidden field.

In API version 30.0 and later, when deploying a new custom field, this

field is false by default.

booleanreadable

For portal profiles, this is set to false by default.

ProfileLayoutAssignments

ProfileLayoutAssignments determines which layout to use for a profile and a given entity.

501

ProfileMetadata Types

DescriptionField TypeField Name

Required. Indicates the layout for this particular entity.stringlayout

This field is optional. If the recordType of the record matches a layout

assignment rule, it will use the specified layout.

stringrecordType

ProfileLoginHours

ProfileLoginHours restricts the days and times within which users with a particular profile can log in.

DescriptionField TypeField Name

Specifies the earliest time on that day that a user with this profile may

stringweekdayStart

day must be specified as well. Start can’t be greater than end for a

particular day.

•Valid values for weekday: monday, tuesday, wednesday,

thursday, friday, saturday, or sunday. For example,

mondayStart indicates the beginning of the login period for

Monday.

•Valid values for Start: the number of minutes since midnight. Must

be evenly divisible by 60 (full hours). For example, 300 is 5:00 a.m.

Specifies the time on that day by which a user with this profile must log

out.

stringweekdayEnd

•Valid values for weekday: monday, tuesday, wednesday,

thursday, friday, saturday, or sunday. For example,

mondayEnd indicates the close of the login period for Monday.

•Valid values for End: the number of minutes since midnight. Must be

evenly divisible by 60 (full hours). For example, 1020 is 5:00 p.m.

To delete login hour restrictions from a profile that previously had them, you must explicitly include an empty loginHours tag without

any start or end times.

ProfileLoginIpRange

ProfileLoginIpRange IP defines an IP address ranges from which users with a particular profile can log in.

DescriptionField TypeField Name

Use this field to identify the purpose of the range, such as which part of

a network corresponds to this range. This field is available in API version

31.0 and later.

stringdescription

Required. The end IP address for the range.stringendAddress

Required. The start IP address for the range.stringstartAddress

502

ProfileMetadata Types

ProfileObjectPermissions

ProfileObjectPermissions represents a user's access to objects.

Note: In API version 18.0 and later, these permissions are disabled in new custom objects for any profiles in which “View All Data”

or “Modify All Data” is disabled.

DescriptionField TypeField Name

Indicates whether the object referenced by the object field can be

created by the users assigned to this profile (true) or not (false).

This field is named revokeCreate before version 14.0 and the logic

is reversed. The field name change and the update from true to

booleanallowCreate

false and vice versa is automatically handled between versions and

does not require any manual editing of existing XML component files.

The field name change and the update from true to false and vice

versa is automatically handled between versions and does not require

any manual editing of existing XML component files.

Indicates whether the object referenced by the object field can be

deleted by the users assigned to this profile (true) or not (false).

This field is named revokeDelete before version 14.0 and the logic

is reversed. The field name change and the update from true to

booleanallowDelete

false and vice versa is automatically handled between versions and

does not require any manual editing of existing XML component files.

Indicates whether the object referenced by the object field can be

edited by the users assigned to this profile (true) or not (false).

This field is named revokeEdit before version 14.0 and the logic is

reversed. The field name change and the update from true to false

booleanallowEdit

and vice versa is automatically handled between versions and does not

require any manual editing of existing XML component files.

Indicates whether the object referenced by the object field can be

seen by the users assigned to this profile (true) or not (false).

This field is named revokeRead before version 14.0 and the logic is

reversed. The field name change and the update from true to false

booleanallowRead

and vice versa is automatically handled between versions and does not

require any manual editing of existing XML component files.

Indicates whether the object referenced by the object field can be

read, edited, or deleted by the users assigned to this profile (true) or

booleanmodifyAllRecords

not (false), regardless of the sharing settings for the object. This is

equivalent to the “Modify All Data” user permission limited to the

individual object level. This is a new field in API version 15.0.

Note: This field is not available for all objects. Refer to the profile

in the user interface to determine which objects currently support

these permissions. Profiles with "Modify All Data" ignore

503

ProfileMetadata Types

DescriptionField TypeField Name

modifyAllRecords entries in Metadata API and don't return

an error if "Modify All Data" is enabled on the profile.

Required. The name of the object whose permissions are altered by this

profile, for example, MyCustomObject__c.

stringobject

Indicates whether the object referenced by the object field can be

read by the users assigned to this profile (true) or not (false),

booleanviewAllRecords

regardless of the sharing settings for the object. This includes private

records (records with no parent object). This is equivalent to the “View

All Data” user permission limited to the individual object level. This is a

new field in API version 15.0.

Note: This field is not available for all objects. Refer to the profile

in the user interface to determine which objects currently support

these permissions. Profiles with "View All Data" ignore

viewAllRecords entries in the Metadata API and don't return

an error if "View All Data" is enabled on the profile.

ProfileApexPageAccess

ProfileApexPageAccess determines which Visualforce pages that users assigned to this profile can execute.

DescriptionField TypeField Name

Required. The Visualforce page name.stringapexPage

Required. Indicates whether users assigned to this profile can execute

the Visualforce page (true) or not (false).

booleanenabled

ProfileRecordTypeVisibility

ProfileRecordTypeVisibility represents the visibility of record types for this profile. Record types let you offer different business processes,

picklist values, and page layouts to different users.

DescriptionField TypeField Name

Required. Indicates whether the record type is the default for this pair of

profile and object (true) or not (false). Only one default is allowed

per object.

booleandefault

Indicates whether the record type is the default person account record

type for this pair of profile and object (true) or not (false). Only one

booleanpersonAccountDefault

person account record type default is allowed per object. This field is

only relevant for record types for account or contact objects.

504

ProfileMetadata Types

DescriptionField TypeField Name

For more information about person accounts, see “What Is a Person

Account?” in the Salesforce online help. Person accounts are not enabled

by default in Salesforce. To request person accounts, contact Salesforce.

Required. The record type name, for example

Account.MyRecordType.

stringrecordType

Required. Indicates whether this record type is visible to users assigned

to this profile (true) or not (false).

booleanvisible

ProfileTabVisibility

ProfileTabVisibility represents the visibility of tabs for this profile. For version 17.0 and later, ProfileTabVisibility supports visibility of tabs

for standard objects. The manifest file must include the standard object corresponding to a standard tab to retrieve the tab visibility in

a profile.

DescriptionField TypeField Name

Required. The name of the tab.stringtab

Required. Indicates the visibility of the tab. Valid values are:TabVisibility

(enumeration of type

string)

visibility

•DefaultOff—The tab is available on the All Tabs page. Users

can individually customize their display to make the tab visible in

any app.

•DefaultOn—The tab is available on the All Tabs page and appears

in the visible tabs for its associated app. Users can individually

customize their display to hide the tab or make it visible in other

apps.

•Hidden—The tab isn’t available on the All Tabs page or visible in

any apps.

Note: In version 36.0 and earlier, Hidden is returned only if

visibility was set using the API. If it was set to Hidden

from the profile in Salesforce, the API doesn’t return a visibility

value. For version 37.0 and later, when tab visibility is set to hidden,

the API returns Hidden, regardless of how the value was set.

ProfileUserPermission

ProfileUserPermission represents an app or system permission for a profile. Use one of these elements for each permission.

DescriptionField TypeField

Required. Indicates whether the permission is enabled (true) or

disabled (false).

booleanenabled

Required. The permission name.stringname

505

ProfileMetadata Types

Java Sample

The following sample uses picklists, profiles, record types, and a custom app:

public void profileSample() {

try {

// Create an expense report record, tab and app...

CustomObject expenseRecord = new CustomObject();

expenseRecord.setFullName("ExpenseReport__c");

expenseRecord.setLabel("Expense Report");

expenseRecord.setPluralLabel("Expense Reports");

expenseRecord.setDeploymentStatus(DeploymentStatus.Deployed);

expenseRecord.setSharingModel(SharingModel.ReadWrite);

CustomField nameField = new CustomField();

nameField.setType(FieldType.AutoNumber);

nameField.setLabel("Expense Report Number");

nameField.setDisplayFormat("ER-{0000}");

expenseRecord.setNameField(nameField);

AsyncResult[] arsExpenseRecord =

metadataConnection.create(new Metadata[] {expenseRecord});

Picklist expenseStatus = new Picklist();

PicklistValue unsubmitted = new PicklistValue();

unsubmitted.setFullName("Unsubmitted");

PicklistValue submitted = new PicklistValue();

submitted.setFullName("Submitted");

PicklistValue approved = new PicklistValue();

approved.setFullName("Approved");

PicklistValue rejected = new PicklistValue();

rejected.setFullName("Rejected");

expenseStatus.setPicklistValues(new PicklistValue[] {

unsubmitted, submitted, approved, rejected}

);

CustomField expenseStatusField = new CustomField();

expenseStatusField.setFullName(

"ExpenseReport__c.ExpenseStatus__c"

);

expenseStatusField.setLabel("Expense Report Status");

expenseStatusField.setType(FieldType.Picklist);

expenseStatusField.setPicklist(expenseStatus);

AsyncResult[] arsStatusField =

metadataConnection.create(new Metadata[]

{expenseStatusField});

CustomTab expenseTab = new CustomTab();

expenseTab.setFullName("ExpenseReport__c");

expenseTab.setMotif("Custom70: Handsaw");

expenseTab.setCustomObject(true);

AsyncResult[] arsTab =

metadataConnection.create(new Metadata[] {expenseTab});

506

ProfileMetadata Types

CustomApplication application = new CustomApplication();

application.setFullName("ExpenseForce");

application.setTab(new String[] {expenseTab.getFullName()});

AsyncResult[] arsApp =

metadataConnection.create(new Metadata[] {application});

// Employees and managers have the same app visibility...

ProfileApplicationVisibility appVisibility =

new ProfileApplicationVisibility();

appVisibility.setApplication("ExpenseForce");

appVisibility.setVisible(true);

Profile employee = new Profile();

employee.setFullName("Employee");

employee.setApplicationVisibilities(

new ProfileApplicationVisibility[] {appVisibility}

);

AsyncResult[] arsProfileEmp =

metadataConnection.create(new Metadata[] {employee});

Profile manager = new Profile();

manager.setFullName("Manager");

manager.setApplicationVisibilities(

new ProfileApplicationVisibility[] {appVisibility}

);

AsyncResult[] arsProfileMgr =

metadataConnection.create(new Metadata[] {manager});

// But employees and managers have different access

// to the state of the expense sheet

RecordType edit = new RecordType();

edit.setFullName("ExpenseReport__c.Edit");

RecordTypePicklistValue editStatuses =

new RecordTypePicklistValue();

editStatuses.setPicklist("ExpenseStatus__c");

editStatuses.setValues(new PicklistValue[]

{unsubmitted, submitted});

edit.setPicklistValues(new RecordTypePicklistValue[]

{editStatuses});

AsyncResult[] arsRecTypeEdit =

metadataConnection.create(new Metadata[] {edit});

RecordType approve = new RecordType();

approve.setFullName("ExpenseReport__c.Approve");

RecordTypePicklistValue approveStatuses =

new RecordTypePicklistValue();

approveStatuses.setPicklist("ExpenseStatus__c");

approveStatuses.setValues(new PicklistValue[]

{approved, rejected});

approve.setPicklistValues(new RecordTypePicklistValue[]

{approveStatuses});

AsyncResult[] arsRecTypeApp =

metadataConnection.create(new Metadata[] {approve});

}catch (ConnectionException ce) {

507

ProfileMetadata Types

ce.printStackTrace();

}

Declarative Metadata Sample Definition

The following is the definition of a profile in an organization with a custom app, custom object, record type, tab, and user permission:

<?xml version="1.0" encoding="UTF-8"?>

<application>PubApps__Myriad_Publishing</application>

<default>false</default>

</applicationVisibilities>

</objectPermissions>

<recordType>TestWeblinks__c.My First Recordtype</recordType>

</recordTypeVisibilities>

<tab>Myriad Publications</tab>

<visibility>DefaultOn</visibility>

</tabVisibilities>

<name>APIEnabled</name>

</userpermissions>

</Profile>

Usage

When you use the retrieve() call to get information about profiles in your organization, the returned .profile files only include

security settings for the other metadata types referenced in the retrieve request (with the exception of user permissions, IP address

ranges, and login hours, which are always retrieved). For example, the package.xml file below contains a types element that

matches all custom objects, so the returned profiles contain object and field permissions for all custom objects in your organization, but

do not include permissions for standard objects, such as Account, and standard fields.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>CustomObject</name>

</types>

<types>

<name>Profile</name>

</types>

508

ProfileMetadata Types

</Package>

The wildcard “*” on CustomObject does not match standard objects and this helps to avoid making unintended, high-impact profile

changes. If you create a few custom objects in a Developer Edition organization, retrieve() the information, and subsequently

deploy() the custom objects to your production organization, the profile and field-level security for all your standard objects, such

as Account, and standard fields are not overwritten unless you explicitly create separate types elements for the standard objects or

fields.

Metadata API intentionally makes it somewhat difficult to include standard fields in retrieve() calls in order to prevent unexpected

profile changes. However, you can still retrieve and deploy profile permissions for custom and standard fields in standard objects, such

as Account.

The next package.xml file allows you to return profile permissions for Account standard and custom fields. Note how the standard

Account object is defined in a types element by specifying it as a member of a CustomObject type.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Account</members>

<name>CustomObject</name>

</types>

<types>

<name>Profile</name>

</types>

</Package>

The final package.xml file allows you to return profile permissions for the MyCustomField__c custom field in the Account

object.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Account.MyCustomField__c</members>

<name>CustomField</name>

</types>

<types>

<name>Profile</name>

</types>

</Package>

ProfileActionOverride

Represents an override of an ActionOverride by a user profile. You can use it to override an ActionOverride on a standard Home tab or

object record page in Lightning Experience. When a user logs in with a profile, a matching ProfileActionOverride assignment takes

precedence over existing overrides for the Home tab or record page specified in ActionOverride. You can only access ProfileActionOverride

by accessing its encompassing CustomApplication or Profile. Available in API version 39.0 and later.

509

ProfileActionOverrideMetadata Types

File Suffix and Directory Location

Profile-based action overrides are defined as part of a custom application or profile.

Version

ProfileActionOverrides are available in API version 39.0 and later.

Fields

DescriptionField TypeField Name

The name of the action. The only valid values are Tab.and View.

If pageOrSobjectType is standard-home, this field must be

Tab. The Tab action is supported only when ProfileActionOverride is

being specified as part of a Profile.

stringactionName

If pageOrSobjectType is record-home, this field must be

View. The View action is supported only when ProfileActionOverride

is being specified as part of a CustomApplication.

Read-only. Represents the name of the Lightning Page being used as

the override.

stringcontent

The size of the page being overridden. Only the Large value is

supported. The other values, Small and Medium, are reserved for

FormFactor

(enumeration of

type string)

formFactor

future use. The Large value represents the Lightning Experience

desktop environment.

The name of the page being overridden. The only valid values are

record-home and standard-home.

stringpageOrSobjectType

The record type associated with the override. If

pageOrSobjectType is standard-home, this field must be

null. This field is required when actionName is set to View.

stringrecordType

Read-only. The type of action override. The only valid value is

flexipage.

ActionOverrideType

(enumeration of

type string)

type

Declarative Metadata Sample Definition

You can define a ProfileActionOverride like this.

<content>CustomObjectFlexiPage</content>

<formFactor>Large</formFactor>

<pageOrSobjectType>TestObj__c</pageOrSobjectType>

510

ProfileActionOverrideMetadata Types

<type>Flexipage</type>

<profile>standard</profile>

<recordType>TestObj__c.TestRecordType</recordType>

</profileActionOverrides>

<defaultLandingTab>standard-home</defaultLandingTab>

<formFactors>Large</formFactors>

<label>My Custom App</label>

<tab>standard-Account</tab>

<tab>standard-Opportunity</tab>

<uiType>Lightning</uiType>

<navType>Standard</navType>

</CustomApplication>

Here is an example package.xml.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>MyCustomApp</members>

<name>CustomApplication</name>

</types>

</Package>

Queue

Represents a holding area for items before they are processed.

Declarative Metadata File Suffix and Directory Location

The file suffix for queue components is .queue and components are stored in the queues directory of the corresponding package

directory. This component supports cases, leads, service contracts (if Entitlements are enabled), and custom objects.

Version

Queue components are available in API version 24.0 and later.

Fields

This metadata type represents the valid values that define a queue:

DescriptionField TypeField Name

Indicates whether emails are sent to queue members (true) or not

(false) when a new record is added to the queue.

booleandoesSendEmailToMembers

The email address of the queue owner.stringemail

The unique identifier for API access. The fullName can contain only

underscores and alphanumeric characters. It must be unique, begin with

stringfullName

a letter, not include spaces, not end with an underscore, and not contain

511

QueueMetadata Types

DescriptionField TypeField Name

two consecutive underscores. This field is inherited from the Metadata

component. Corresponds to Queue Name in the user interface.

Required. The name of the queue. Corresponds to Label in the user

interface.

stringname

Indicates the supported entity types.QueueSobject[]queueSobject

QueueSobject

QueueSobject represents an entity type that the queue supports.

DescriptionField TypeField Name

Valid values are:stringsobjectType

•Case

•Lead

•ServiceContract

•Custom objects (e.g. ObjA_c)

Declarative Metadata Sample Definition

The following is the definition of a queue, which supports Case, Lead, and a custom object named ObjA.

<?xml version="1.0" encoding="UTF-8"?>

<email>member@company.com</email>

<name>memberQueue</name>

</queueSobject>

</queueSobject>

</queueSobject>

</Queue>

QuickAction

Represents a specified create or update quick action for an object that then becomes available in the Chatter publisher. For example,

you can create an action that, on the detail page of an account, allows a user to create a contact related to that account from the Chatter

feed on that page. QuickAction can be created on objects that allow custom fields. The parent objects supported include:

512

QuickActionMetadata Types

•Account

•Campaign

•Case

•Contact

•Custom objects

•Group

•Lead

•Opportunity

File Suffix and Directory Location

QuickAction components have the suffix quickAction and are stored in the quickActions folder.

Version

QuickAction components are available in API version 28.0 and later.

Fields

DescriptionField TypeField Name

If the custom action invokes a canvas app, the app name. Returns the

fully qualified name of the canvas app in the format

stringcanvas

<namespace>__<dev_name>, if the quick action type is Canvas;

otherwise, returns null.

This field is available in API version 29.0 and later.

The description of the action.stringdescription

The specific field that may be overridden within a QuickAction.FieldOverride on

page 515[]

fieldOverrides

If a custom action is created, this field represents the height in pixels of

the action pane.

intheight

The icon used to identify the action.

API version 32.0 and later returns different icons than in earlier API

versions.

stringicon

Indicates whether this component is protected (true) or not (false).

Protected components cannot be linked to or referenced by components

created in the installing organization.

booleanisProtected

Identifies the action and displays to users. This is also the default identifier

used for the API and managed packages.

stringlabel

513

QuickActionMetadata Types

DescriptionField TypeField Name

If the custom action invokes a Lightning component, this field represents

the fully qualified name of the component. Otherwise, this field is null.

Available in API version 38.0 and later.

stringlightningComponent

Required. Indicates whether successful completion of the action creates

a feed item (true) or not (false). Applies only to Create Record,

Update Record, and Log a Call quick action types.

Available in API version 36.0 and later.

booleanoptionsCreateFeedItem

If the custom action invokes a Visualforce page, this field identifies the

page.

stringpage

The layout of fields on the action.QuickActionLayoutquickActionLayout

Specifies the standard label to use for the action. The valid values are:QuickActionLabel

(enumeration of

type string)

standardLabel

•LogACall

•LogANote

•New (A new record)

•NewRecordType (For example, a label with something like “New

Idea”)

•Update

•UpdateRecordType

•NewChild (A new child record)

•NewChildRecordType

•CreateNew

•CreateNewRecordType (For example, a label with something

like “Create New Idea”)

•SendEmail (This value is available in API version 31.0 and later.)

•QuickRecordType

•Quick (A quick record)

The message that displays to the user upon successful completion of

the action.

Available in API version 36.0 and later.

stringsuccessMessage

The object for which the action is created and performed.

For example, you can create an action that, on the detail page of an

account, allows a user to create a contact related to that account from

stringtargetObject

the Chatter feed on that page. In this case, Contact is the

targetObject.

The parent object type of the action. Links the target object to the parent

object. For example, use Account if the target object is Contact and the

parent object is Account.

stringtargetParentField

514

QuickActionMetadata Types

DescriptionField TypeField Name

Specifies which record type to create. Valid values are:stringtargetRecordType

•Business Account

•Person Account

•Master

Required. The type of quick action. Valid values are:QuickActionType

(enumeration of

type string)

type

•Canvas

•Create

•LightningComponent (This value is available in API version

38.0 and later.)

•LogACall

•Post

•SendEmail (This value is available in API version 31.0 and later.)

•SocialPost

•Update

•VisualforcePage

If a custom action is created, this field represents the width in pixels of

the action pane.

intwidth

FieldOverride

Represents the field names and their respective formulas and literal values that comprise overrides in a QuickAction.

DescriptionField TypeField Name

The name of the specific field to allow overrides on.stringfield

Specifies the formula to use when overriding a field.stringformula

The value of the field without overrides.stringliteralValue

QuickActionLayout

The layout of fields on the action. There is no hard limit to the number of fields you can add to an action layout. However, for optimum

usability, we recommend a maximum of eight fields. Adding more than 20 fields can severely affect user efficiency.

DescriptionField TypeField Name

The type of layout structure used. The valid values are:LayoutSectionStyle

(enumeration of type

string)

layoutSectionStyle

•TwoColumnsTopToBottom

•TwoColumnsLeftToRight

•OneColumn

515

QuickActionMetadata Types

DescriptionField TypeField Name

•CustomLinks

Specifies columns in a QuickActionLayout.QuickActionLayoutColumn[]quickActionLayoutColumns

QuickActionLayoutColumn

A column defined for a QuickActionLayout.

DescriptionField TypeField Name

Specifies row items in a QuickActionLayoutColumn.QuickActionLayoutItem

[]

quickActionLayoutItems

QuickActionLayoutItem

A row item comprised of fields and defined for a QuickActionLayoutColumn.

DescriptionField TypeField Name

Controls if this layout item is a blank space (true) or not (false).booleanemptySpace

Represents a specific field in QuickActionLayoutItem. There is no hard

limit to the number of fields you can add to an action layout. However,

stringfield

for optimum usability, we recommend a maximum of eight fields. Adding

more than 20 fields can severely affect user efficiency.

Specifies user input behavior for specific fields in QuickActionLayoutItem.

The valid values are:

UiBehavior

(enumeration of type

string)

uiBehavior

•Edit

•Required

•Readonly

Declarative Metadata Sample Definition

The following is an example of a QuickAction component:

<?xml version="1.0" encoding="UTF-8"?>

<description>testActionDefinitionTypesCreateTask</description>

<label>testActionDefinitionTypesCreateTask</label>

<layoutSectionStyle>TwoColumnsLeftToRight</layoutSectionStyle>

516

QuickActionMetadata Types

<emptySpace>false</emptySpace>

<field>OwnerId</field>

<uiBehavior>Required</uiBehavior>

</quickActionLayoutItems>

<emptySpace>false</emptySpace>

<field>WhoId</field>

</quickActionLayoutItems>

<emptySpace>false</emptySpace>

<field>WhatId</field>

</quickActionLayoutItems>

<emptySpace>false</emptySpace>

<field>ActivityDate</field>

</quickActionLayoutItems>

<emptySpace>false</emptySpace>

<field>Subject</field>

</quickActionLayoutItems>

<emptySpace>false</emptySpace>

<field>Status</field>

<uiBehavior>Required</uiBehavior>

</quickActionLayoutItems>

<emptySpace>false</emptySpace>

<field>Priority</field>

<uiBehavior>Required</uiBehavior>

</quickActionLayoutItems>

</quickActionLayoutColumns>

</quickActionLayout>

<successMessage>This is a success message</successMessage>

<type>Create</type>

</QuickAction>

RemoteSiteSetting

Represents a remote site setting. Before any Visualforce page, Apex callout, or JavaScript code using XmlHttpRequest in an s-control or

custom button can call an external site, that site must be registered in the Remote Site Settings page, or the call fails. RemoteSiteSetting

extends the Metadata metadata type and inherits its fullName field.

517

RemoteSiteSettingMetadata Types

Declarative Metadata File Suffix and Directory Location

RemoteSiteSetting components are stored in the remoteSiteSettings directory of the corresponding package directory. The

file name matches the unique name of the remote site setting, and the extension is .remoteSite.

Version

RemoteSiteSetting components are available in API version 19.0 and later.

Fields

DescriptionField TypeField

The description explaining what this remote site setting is used

for.

stringdescription

Required. Indicates whether code within Salesforce can access

the remote site regardless of whether the user's connection is

booleandisableProtocolSecurity

over HTTP or HTTPS (true) or not (false). When true, code

within Salesforce can pass data from an HTTPS session to an

HTTP session, and vice versa.

Warning: Only set to true if you understand the

security implications.

The name can only contain characters, letters, and the

underscore (_) character, must start with a letter, and cannot

stringfullName

end with an underscore or contain two consecutive underscore

characters.

Inherited from the Metadata component, this field is not defined

in the WSDL for this component. It must be specified when

creating, updating, or deleting. See create() to see an

example of this field specified for a call.

Required. Indicates if the remote site setting is active (true) or

not (false).

booleanisActive

Required. The URL for the remote site.stringurl

Declarative Metadata Sample Definition

A sample XML definition of a remote site setting is shown below.

<?xml version="1.0" encoding="UTF-8"?>

<description>Used for Apex callout to mapping web service</description>

<disableProtocolSecurity>false</disableProtocolSecurity>

518

RemoteSiteSettingMetadata Types

<url>https://www.maptestsite.net/mapping1</url>

</RemoteSiteSetting>

Report

Represents a custom report. This type extends the Metadata metadata type and inherits its fullName field. This metadata type only

supports custom reports; standard reports are not supported.

Declarative Metadata File Suffix and Directory Location

Reports are stored in the reports directory of the corresponding package directory. The file name matches the report title and the

extension is .report.

Retrieving Reports

You can’t use the wildcard (*) symbol with reports in package.xml. To retrieve the list of reports for populating package.xml

with explicit names, call listMetadata() and pass in ReportFolder as the type. Note that ReportFolder is not returned as a

type in describeMetadata(). Report is returned from describeMetadata() with an associated attribute of inFolder

set to true. If that attribute is set to true, you can construct the type by using the component name with the word Folder, such as

ReportFolder.

The following example shows folders in package.xml:

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>MyDBFolder/MyDBName</members>

<name>Dashboard</name>

</types>

<types>

<members>MyDocumentFolder/MyDocumentName</members>

<name>Document</name>

</types>

<types>

<members>unfiled$public/MarketingProductInquiryResponse</members>

<members>unfiled$public/SalesNewCustomerEmail</members>

<name>EmailTemplate</name>

</types>

<types>

<members>MyReportFolder/MyReportName</members>

<name>Report</name>

</types>

</Package>

Version

Report components are available in API version 14.0 and later.

519

ReportMetadata Types

Fields

The following information assumes that you are familiar with creating and running reports. For more information on these fields, see

“Create a Report” in the Salesforce online help.

DescriptionField TypeField

List that defines custom summary formulas for

summary, matrix, and joined reports.

ReportAggregate[]aggregates

Represents each block in a joined report where

every block can be of a different report type.

Report[]block

Defines attributes for each block in a joined

report.

ReportBlockInfoblockInfo

Defines a bucket field to be used in the report.

This field is available in API version 24.0 and later.

ReportBucketField[]buckets

Defines a chart for summary and matrix reports

ReportChartchart

List that specifies conditional highlighting for

report summary data.

ReportColorRange[]colorRanges

List that specifies the fields displayed in the

report. Fields appear in the report in the same

order as they appear in the Metadata API file.

ReportColumn[]columns

Defines a cross filter's object, related object, and

condition (WITH or WITHOUT). This field is

available in API version 39.0 and later.

ReportCrossFilter[]crossFilters

When using multiple currencies, some reports

allow you to display converted amounts by

CurrencyIsoCode (enumeration of type

string)

currency

selecting the appropriate column to display. For

example, in opportunity reports, you can include

the Amount (converted) column on the report.

This field is an enumeration of type string that

defines the currency in which to display

converted amounts. Valid values: Must be one

of the valid alphabetic, three-letter currency ISO

codes defined by the ISO 4217 standard, such

as USD, GBP, or JPY.

Specifies a general description, which is

displayed with the report name. Maximum

characters: 255 characters.

stringdescription

If your organization uses divisions to segment

data and you have the “Affected by Divisions”

stringdivision

permission, records in the report must match

this division.

This field is available in API version 17.0 and later.

520

ReportMetadata Types

DescriptionField TypeField

Limits report results to records with specific data.

For example, you can limit report results to

ReportFilterfilter

opportunities for which the amount is greater

than $1,000:

<column>AMOUNT</column>

<operator>greaterThan</operator>

</criteriaItems>

</filter>

For more information, see “Enter Filter Criteria”

in the Salesforce online help.

Name of the folder that houses the report.

This field is available in API version 35.0 and later.

stringfolderName

Defines the report format. For example,

Tabular for a simple data list without

subtotals.

ReportFormat (enumeration of type string)format

The report unique developer name used as an

identifier for API access. The fullName can

stringfullName

contain only underscores and alphanumeric

characters. It must be unique, begin with a letter,

not include spaces, not end with an underscore,

and not contain two consecutive underscores.

This field is inherited from the Metadata

component.

List that defines the fields by which you want to

group and subtotal data across a matrix report

ReportGrouping[]groupingsAcross

(row headings). When grouping by a date field,

you can further group the data by a specific time

period such as days, weeks, or months.

Maximum: 2 fields.

For Summary and Matrix reports: List that defines

the fields by which you want to group and

ReportGrouping[]groupingsDown

subtotal. For summary reports, choosing more

than one sort field allows you to subsort your

data. For matrix reports, specifies summary fields

for column headings. When grouping by a date

field, you can further group the data by a specific

time period such as days, weeks, or months.

521

ReportMetadata Types

DescriptionField TypeField

Maximum for matrix reports: 2. Maximum for

summary reports: 3

Defines a date range for which historical trend

reporting data is to be captured. Default is “Any

Historical Date.”

Available in API version 29.0 and later.

ReportHistoricalSelectorhistoricalSelector

Required. The report name. For example,

Opportunity Pipeline

stringname

Indicates whether a user has subscribed to this

report Lightning Experience (1) or not (0). Tied

to user context.

This field is available in API version 38.0 and later.

intnumSubscriptions

List that specifies settings specific to each report

type, in particular options that let you filter a

ReportParam[]params

report to obtain useful subsets. For example, the

Activities report type lets you specify whether

you want to see open or closed activities or both

and whether you want to see tasks or events or

both. Valid values depend on the report type.

Required. Defines the type of data in the report.

For example, Opportunity to create a report

of opportunities data.

stringreportType

The role name for a report drill down. Some

reports, such as opportunity and activity reports,

stringroleHierarchyFilter

display Hierarchy links that allow you to drill

down to different data sets based on the role

hierarchy.

This field is available in API version 17.0 and later.

Defines the maximum number of rows that can

be returned for the report.

introwLimit

Defines the scope of data on which you run the

report. For example, whether you want to run

stringscope

the report against all opportunities,

opportunities you own, or opportunities your

team owns. Valid values depend on the

reportType. For example, for Accounts

reports:

•MyAccounts

•MyTeamsAccounts

•AllAccounts

522

ReportMetadata Types

DescriptionField TypeField

Can be set to true for historical trending

reports in matrix format.

Available in API version 29.0 and later.

booleanshowCurrentDate

false shows a collapsed view of the report

with only the headings, subtotals, and total.

Default: true

booleanshowDetails

Specifies the field on which to sort data in the

report. Use sortOrder to specify the sort

order.

stringsortColumn

Specifies the sort order. Use sortColumn to

specify the field on which to sort.

SortOrder (enumeration of type string)sortOrder

The territory name for a report drill down. If your

organization uses territory management, some

stringterritoryHierarchyFilter

reports display Hierarchy links that allow you to

drill down to different data sets based on the

territory hierarchy.

This field is available in API version 17.0 and later.

Limits report results to records within a specified

time frame.

ReportTimeFrameFiltertimeFrameFilter

The user name for a report drill down. Some

reports, such as opportunity and activity reports,

stringuserFilter

display Hierarchy links that allow you to drill

down to different data sets based on the user

hierarchy.

This field is available in API version 17.0 and later.

ReportAggregate

ReportAggregate defines custom summary formulas on summary, matrix, and joined reports. For more information on these fields, see

“Build a Custom Summary Formula” in the Salesforce online help.

DescriptionField TypeField

Defines the row grouping level at which you want your custom

summary formula to be displayed. This is a new field in API

version 15.0.

stringacrossGroupingContext

Required. The custom summary formula. For example,

AMOUNT:SUM + OPP_QUANTITY:SUM

stringcalculatedFormula

Required. Specifies the data type for formatting and display of

the custom summary formula results.

ReportAggregateDatatype

(enumeration of type string)

datatype

523

ReportMetadata Types

DescriptionField TypeField

The custom summary formula description. Maximum: 255

characters.

stringdescription

Required. The internal development name of the custom

summary formula, for example, FORMULA1. This is used to

stringdeveloperName

reference custom summary formulas from other report

components, including conditional highlighting.

Defines the column grouping level at which you want your

custom summary formula to be displayed. This field is available

in API version 15.0 and later.

stringdownGroupingContext

Required. true displays the formula result in the report.

false does not display the result in the report.

booleanbloisActive

Determines whether the custom summary formula is a

cross-block formula, which is available with joined reports.

booleanisCrossBlock

true indicates a cross-block custom summary formula.

false indicates a standard custom summary formula.

This field is available in API version 25.0 and later.

Required. The custom summary formula label (name).stringmasterLabel

Required for joined reports. Specifies the reportType of the

blocks to which the aggregate can be added.

stringreportType

The formula result is calculated to the specified number of

decimal places. Valid values 0 through 18.

intscale

ReportBlockInfo

ReportBlockInfo defines blocks in a joined report.

DescriptionField TypeField

Lists the aggregates that represent the custom summary

formulas used in a joined report block.

ReportAggregateReference[]aggregateReferences

Required. blockId is used in cross-block custom summary

formulas and joined report charts to identify the block containing

stringblockId

each summary field. blockId is assigned automatically. Valid

values are B1 through B5.

This field is available in API version 25.0 and later.

Required. Refers to the entity used to join blocks in a joined

report. The entity provides a list of fields that are available for

globally grouping across the blocks.

stringjoinTable

524

ReportMetadata Types

ReportAggregateReference

ReportAggregateReference defines the developer name used for custom summary formulas in joined reports.

DescriptionField TypeField

Required. The developerName of the ReportAggregate,

which specifies the custom summary formula used in a block

of a joined report.

stringaggregate

ReportBucketField

ReportBucketField defines a bucket to be used in the report.

DescriptionField TypeField

Required. Specifies the type of bucket. Valid values:ReportBucketFieldType

(enumeration of type string)

bucketType

•text

•number

•picklist

Required. A unique name used as the <field> value to

display a bucket field in the column list and other report

stringdeveloperName

components, including sort, filter, list, group, and chart. Must

be of the format BucketField_name. For example,

BucketField_BusinessSize.

Required. The bucket field label. Maximum 40 characters. Any

line breaks, tabs, or multiple spaces at the beginning or end of

stringmasterLabel

the label are removed. Any of these characters within the label

are reduced to a single space.

For numeric bucket fields only. Specifies whether empty values

are treated as zeros (z) or not (n).

ReportBucketFieldNullTreatment

(enumeration of type string)

nullTreatment

The label of the container for unbucketed values.stringotherBucketLabel

Required. The source field that the bucket is applied to. For

example, SALES or INDUSTRY.

stringsourceColumnName

Defines one bucket value used in the bucket field.ReportBucketFieldValue

(enumeration of type string)

values

Note: While this name is plural, it represents a single

bucket. In typical use, a bucket field contains multiple

buckets.

ReportBucketFieldValue

ReportBucketFieldValue defines a bucket value used in the bucket field.

525

ReportMetadata Types

DescriptionField TypeField

The value of a bucket in the bucket field. Valid values:ReportBucketFieldSourceValue

(enumeration of type string)

sourceValues

•sourceValue—Used for picklist and text bucket fields.

For picklists, describes the picklist item in the bucket. For

example, the sourceValue of a bucket on TYPE could be

Customer. For text, the full string for the item in the

bucket. For example, the sourceValue of a bucket on

ADDRESS_STATE1 could be NY.

•from—Used only on numeric bucket fields. A non-inclusive

lower bound for a numeric bucket range. This value must

be a number.

•to—Used only on numeric bucket fields. The inclusive

upper bound for a numeric bucket range. This value must

be a number.

In numeric buckets, the first value must only have to and last

value must only have from. All other values must have both

to and from.

Required. The name of a specific bucket value within the bucket

field.

stringvalue

ReportGrouping

ReportGrouping defines how to group, subtotal, and sort data for summary, matrix, and joined reports.

DescriptionField TypeField

The type of aggregate value to sort by. Valid values are:ReportAggrType (enumeration

of type string)

aggregateType

•Sum

•Average

•Maximum

•Minimum

•RowCount

When grouping by a date field, the time period by which to

group.

UserDateGranularity

(enumeration of type string)

dateGranularity

Required. The field by which you want to summarize data. For

example, CAMPAIGN_SOURCE

stringfield

The API name of the column, aggregate or custom summary

field used to order the grouping.

stringsortByName

Required. Whether to sort data in ascending or descending

alphabetical and numerical order.

SortOrdersortOrder

526

ReportMetadata Types

DescriptionField TypeField

Indicates if the grouping is sorted by a column, aggregate or

custom summary field. Valid values are:

ReportSortType (enumeration

of type string)

sortType

•Column

•Aggregate

•CustomSummaryFormula

ReportHistoricalSelector

ReportHistoricalSelector defines a date range for historical data.

DescriptionField TypeField

Represents the date value to apply a historical filter, either

relative (in the format N_DAYS_AGO:2) or absolute (in the

stringsnapshot

format yyyy-MM-dd). If unspecified, it’s assumed that the

filter will be applied to all the columns the user sees.

Available in API version 29.0 and later.

SortOrder

An enumeration of type string that defines the order in which data is sorted in the report fields. Valid values:

DescriptionField

Sorts data in ascending alphabetical and numerical order.Asc

Sorts data in descending alphabetical and numerical order.Desc

UserDateGranularity

An enumeration of type string that defines the time period by which to group data. Valid values:

DescriptionEnumeration Value

No grouping by dateNone

By dayDay

By weekWeek

By monthMonth

By quarterQuarter

By yearYear

527

ReportMetadata Types

DescriptionEnumeration Value

By fiscal quarter. You can set the fiscal year for your organization. See “Set the Fiscal Year” in the

Salesforce online help.

FiscalQuarter

By fiscal yearFiscalYear

By calendar month in yearMonthInYear

By calendar day in monthDayInMonth

When custom fiscal years are enabled: By fiscal periodFiscalPeriod

When custom fiscal years are enabled: By fiscal weekFiscalWeek

ReportSummaryType

An enumeration of type string that defines how report fields are summarized. Valid values:

DescriptionEnumeration Value

TotalSum

AverageAverage

Largest valueMaximum

Smallest valueMinimum

The field is not summarized.None

ReportColorRange

ReportColorRange defines conditional highlighting for report summary data.

DescriptionField TypeField

Required. Defines how the field specified in columnName is

summarized. For example, Sum.

ReportSummaryType

(enumeration of type string)

aggregate

Required. Specifies the field whose value ranges are represented

by colors.

stringcolumnName

Required. Specifies the number that separates the mid color

from the high color.

doublehighBreakpoint

Required. Specifies the color (in HTML format) to represent data

that falls into the high number range. This color spans from the

highBreakpoint value.

stringhighColor

Required. Specifies the number that separates the low color

from the mid color.

doublelowBreakpoint

528

ReportMetadata Types

DescriptionField TypeField

Required. Specifies a color (in HTML format) to represent data

that falls into the low value range, below the

lowBreakpoint value.

stringlowColor

Required. Specifies a color (in HTML format) to represent data

that falls into the mid value range.

stringmidColor

ReportColumn

ReportColumn defines how fields (columns) are displayed in the report.

DescriptionField TypeField

List that defines if and how each report field is summarized.ReportSummaryType[]

(enumeration of type string)

aggregateTypes

Required. The field name. For example, AGE or

OPPORTUNITY_NAME

stringfield

In historical trend reports, displays greater Date values as green

and greater Amount values as red, reversing the default colors.

Available in API version 29.0 and later.

booleanreverseColors

In historical trend reports, adds a column displaying the

difference between current and historical Date and Amount

values.

Available in API version 29.0 and later.

booleanshowChanges

ReportFilter

ReportFilter limits the report results by filtering data on specified fields.

DescriptionField TypeField

Specifies filter logic conditions. For more information on filter

logic, see “Getting the Most Out of Filter Logic” in the Salesforce

online help.

stringbooleanFilter

The criteria by which you want to filter report data, either by

comparing historical values or by applying a date range.

criteriaItems ReportFilterItem

ReportFilterItemcriteriaItems

<column>Opportunity.Opportunity__hd$Amount__hst</column>

<columnToColumn>false</columnToColumn>

529

ReportMetadata Types

DescriptionField TypeField

<operator>equals</operator>

</criteriaItems>

The language used when a report filters against a picklist value

using the operators contains or startsWith. For a list

of valid language values, see Language.

Language (enumeration of type

string)

language

ReportFilterItem

ReportFilterItem limits the report results by filtering data on specified fields.

DescriptionField TypeField

Required. The field on which you want to filter data. For example,

AMOUNT

stringcolumn

Indicates that the field contains data from a historical snapshot.

Available in API version 29.0 and later.

booleancolumnToColumn

Optional. Indicates whether the report filter is unlocked (true)

or locked (false). You can edit unlocked filters on the report

booleanisUnlocked

run page in Lightning Experience. If unspecified, the default

value is false.

Available in API version 38.0 and later.

Required. An enumeration of type string that defines the

operator used to filter the data, for example, greaterThan.

For valid values, see FilterOperation.

FilterOperation (enumeration of

type string)

operator

Represents the date value, either relative (in the format

N_DAYS_AGO:2) or absolute (in the format yyyy-MM-dd).

Available in API version 29.0 and later.

stringsnapshot

The value by which you want to filter the data, for example,

1000. Note that the Metadata API filter condition values do

stringvalue

not always match those that you enter in the report wizard. For

example, in the Metadata API dates are always converted to the

US date format and values entered in a non-US English language

may be converted to a standard US English equivalent.

ReportFormat

An enumeration of type string that defines the report format. Valid values:

530

ReportMetadata Types

DescriptionEnumeration Value

Summarizes data in a grid. Use to compare related totals.Matrix

Lists, sorts, and subtotals data.Summary

Lists data with no sorting or subtotals.Tabular

Joins data from different report types storing each report’s data in its own block.Joined

ReportParam

ReportParam represents settings specific to a report type, especially options that let you filter a report to certain useful subsets.

DescriptionField TypeField

Required. Specifies a specific reportType setting.stringname

Required. The setting value.stringvalue

ReportAggregateDatatype

An enumeration of type string that specifies the data type for formatting and display of custom summary formula results. Valid values:

Enumeration Value

currency

number

percent

ReportChart

ReportChart represents charts on summary, matrix, and joined reports.

DescriptionField TypeField

Specifies the beginning color (in HTML format) for a gradient

color background.

stringbackgroundColor1

Specifies the end color (in HTML format) for a gradient color

background.

stringbackgroundColor2

Specifies the direction for a gradient color background. Use with

backgroundColor1 to specify the beginning color and

ChartBackgroundDirection

(enumeration of type string)

backgroundFadeDir

backgroundColor2 to specify the end color for the gradient

design. Use white for both if you do not want a background

design. Valid values:

•diagonal

531

ReportMetadata Types

DescriptionField TypeField

•leftToRight

•topToBottom

Specifies the summaries you want to use for the chart. Invalid

summaries are ignored without notification. If there are no valid

ChartSummary[]chartSummaries

summaries, RowCount is used by default for the axis value. This

field is available in API version 17.0 and later.

Required. Specifies the chart type. Available chart types depend

on the report type.

ChartType (enumeration of type

string)

chartType

Specifies whether to display values, labels, and percentages

when hovering over charts. Hover details depend on chart type.

booleanenableHoverLabels

Percentages apply to pie, donut, and funnel charts only. This

field is available in API version 17.0 and later.

Specifies whether to combine all groups less than or equal to

3% of the total into a single 'Others' wedge or segment. This

booleanexpandOthers

only applies to pie, donut, and funnel charts. Set to true to

show all values individually on the chart; set to false to

combine small groups into 'Others.' This field is available in API

version 17.0 and later.

Specifies the field by which to group data. This data is displayed

on the X-axis for vertical column charts and on the Y-axis for

horizontal bar charts.

stringgroupingColumn

Required.

The location of the legend with respect to the chart. The valid

values are:

ChartLegendPosition

(enumeration of type string)

legendPosition

•Bottom

•OnChart

•Right

Required. Specifies whether the chart is displayed at the top or

bottom of the report.

ChartPosition (enumeration of

type string)

location

For grouped chart types: Specifies the field by which to group

the data.

stringsecondaryGroupingColumn

For bar and line charts: Specifies whether the chart displays

names for each axis.

booleanshowAxisLabels

Indicates if percentages are displayed for wedges and segments

of pie, donut, and funnel charts, as well as for gauges (true),

or not (false).

booleanshowPercentage

Indicates if the total is displayed for donut charts and gauges

(true), or not (false).

booleanshowTotal

532

ReportMetadata Types

DescriptionField TypeField

Indicates if the values of individual records or groups are

displayed for charts (true), or not (false).

booleanshowValues

Required. Specifies the chart size.ReportChartSize (enumeration

of type string)

size

Defines how to summarize the chart data. For example, Sum.

No longer supported in version API 17.0 and later. See

chartSummaries.

ReportSummaryType

(enumeration of type string)

summaryAggregate

When specifying the axis range manually: Defines the ending

value.

doublesummaryAxisManualRangeEnd

When specifying the axis range manually: Defines the starting

value.

doublesummaryAxisManualRangeStart

Required. For bar, line, and column charts: Defines whether to

specify the axis range manually or automatically.

ChartRangeType (enumeration

of type string)

summaryAxisRange

Required. Specifies the field by which to summarize the chart

data. Typically this field is displayed on the Y-axis. No longer

stringsummaryColumn

supported in version API 17.0 and later. See

chartSummaries.

The color (in HTML format) of the chart text and labels.stringtextColor

The size of the chart text and labels. Valid values:inttextSize

•8

•9

•10

•12

•14

•18

•24

•36

The maximum size is 18. Larger values are shown at 18 points.

The chart title. Max 255 characters.stringtitle

The color (in HTML format) of the title text.stringtitleColor

The size of the title text. Valid values:inttitleSize

•8

•9

•10

•12

•14

•18

533

ReportMetadata Types

DescriptionField TypeField

•24

•36

The maximum size is 18. Larger values are shown at 18 points.

ChartType

An enumeration of type string that defines the chart type. For information on each of these chart types, see “Chart Types” in the Salesforce

online help. Valid values:

Enumeration Value

None

HorizontalBar

HorizontalBarGrouped

HorizontalBarStacked

HorizontalBarStackedTo100

VerticalColumn

VerticalColumnGrouped

VerticalColumnStacked

VerticalColumnStackedTo100

Line

LineGrouped

LineCumulative

LineCumulativeGrouped

Pie

Donut

Funnel

Scatter

ScatterGrouped

VerticalColumnLine

VerticalColumnGroupedLine

VerticalColumnStackedLine

Plugin

534

ReportMetadata Types

Enumeration Value

Reserved for future use. This value is available in API version 31.0 and later.

ChartPosition

An enumeration of type string that specifies the position of the chart in the report. Valid values:

Enumeration Value

CHART_TOP

CHART_BOTTOM

ChartSummary

ChartSummary defines how data in the chart is summarized. Valid values:

DescriptionField TypeField

Specifies the aggregation method—such as Sum, Average,

Min, and Max—for the summary value. Use the column field

ReportSummaryTypeaggregate

to specify the summary value to use for the aggregation. You

don't need to specify this field for RowCount or custom summary

formulas.

Specifies the axis or axes to use on the chart. Use the column

field to specify the summary value to use for the axis.

ChartAxisaxisBinding

Required. Specifies the summary field for the chart data. If all

columns are invalid, RowCount is used by default for the axis

stringcolumn

value. For vertical column and horizontal bar combination charts,

you can specify up to four values.

ChartAxis

An enumeration of type string that specifies the axis or axes to be used in charts. Valid values:

DescriptionEnumeration Value

The summary value to use for the X-axis of a scatter chart.x

The Y-axis for the chart.y

The secondary Y-axis for vertical column combination charts with a line added.y2

ReportChartSize

An enumeration of type string that specifies the chart size. Valid values:

535

ReportMetadata Types

Enumeration Value

Tiny

Small

Medium

Large

Huge

ChartRangeType

An enumeration of type string that defines the report format. Valid values:

Enumeration Value

Auto

Manual

ReportTimeFrameFilter

ReportTimeFrameFilter represents the report time period.

DescriptionField TypeField

Required. The date field on which to filter data. For example,

CLOSE_DATE

stringdateColumn

When interval is INTERVAL_CUSTOM, specifies the end

of the custom time period.

dateendDate

Required. Specifies the period of time.UserDateInterval (enumeration

of type string)

interval

When interval is INTERVAL_CUSTOM, specifies the start

of the custom time period.

datestartDate

ReportCrossFilter

ReportCrossFilter represents the cross filter functionality in reports.

DescriptionField TypeField

Represents the subfilters of a cross filter. There can be up to five

subfilters. This field requires the following attributes.

ReportFilterItemcriteriaItems

•Column

•Operator

536

ReportMetadata Types

DescriptionField TypeField

•Value

The action indicating whether to include or exclude an object.

Valid values: with and without.

ObjectFilterOperator.

Enumeration of type string

operation

The parent object used for the cross filter.stringprimaryTableColumn

The child object used for the cross filter.stringrelatedTable

The field from the child object that is used to join the parent.stringrelatedTableJoinColumn

Declarative Metadata Sample Definition

A sample XML snippet using cross filters to build an Accounts report for cases where case status is not closed:

<column>Status</column>

<operator>notequal</operator>

<value>Closed</value>

</criteriaItems>

<primaryTableColumn>ACCOUNT_ID</primaryTableColumn>

<relatedTableJoinColumn>Account</relatedTableJoinColumn>

</crossFilters>

Note: This sample was generated using the API version 23.0.

UserDateInterval

An enumeration of type string that defines the period of time. Valid values:

DescriptionEnumeration Value

Current fiscal quarterINTERVAL_CURRENT

Current and next fiscal quartersINTERVAL_CURNEXT1

Current and previous fiscal quartersINTERVAL_CURPREV1

Next fiscal quarterINTERVAL_NEXT1

Previous fiscal quarterINTERVAL_PREV1

Current and next three fiscal quartersINTERVAL_CURNEXT3

Current fiscal yearINTERVAL_CURFY

Previous fiscal yearINTERVAL_PREVFY

Previous two fiscal yearsINTERVAL_PREV2FY

537

ReportMetadata Types

DescriptionEnumeration Value

Two fiscal years agoINTERVAL_AGO2FY

Next fiscal yearINTERVAL_NEXTFY

Current and previous fiscal yearsINTERVAL_PREVCURFY

Current and previous two fiscal yearsINTERVAL_PREVCUR2FY

Current and next fiscal yearINTERVAL_CURNEXTFY

A custom time period. Use startDate and endDate fields to specify the

time period's start date and end date.

INTERVAL_CUSTOM

YesterdayINTERVAL_YESTERDAY

TodayINTERVAL_TODAY

TomorrowINTERVAL_TOMORROW

Last calendar weekINTERVAL_LASTWEEK

This calendar weekINTERVAL_THISWEEK

Next calendar weekINTERVAL_NEXTWEEK

Last calendar monthINTERVAL_LASTMONTH

This calendar monthINTERVAL_THISMONTH

Next calendar monthINTERVAL_NEXTMONTH

Current and previous calendar monthsINTERVAL_LASTTHISMONTH

Current and next calendar monthsINTERVAL_THISNEXTMONTH

Current calendar quarterINTERVAL_CURRENTQ

Current and next calendar quartersINTERVAL_CURNEXTQ

Current and previous calendar quartersINTERVAL_CURPREVQ

Next calendar quarterINTERVAL_NEXTQ

Previous calendar quarterINTERVAL_PREVQ

Current and next three calendar quartersINTERVAL_CURNEXT3Q

Current calendar yearINTERVAL_CURY

Previous calendar yearINTERVAL_PREVY

Previous two calendar yearsINTERVAL_PREV2Y

Two calendar years agoINTERVAL_AGO2Y

Next calendar yearINTERVAL_NEXTY

Current and previous calendar yearsINTERVAL_PREVCURY

Current and previous two calendar yearsINTERVAL_PREVCUR2Y

538

ReportMetadata Types

DescriptionEnumeration Value

Current and next calendar yearsINTERVAL_CURNEXTY

Last 7 daysINTERVAL_LAST7

Last 30 daysINTERVAL_LAST30

Last 60 daysINTERVAL_LAST60

Last 90 daysINTERVAL_LAST90

Last 120 daysINTERVAL_LAST120

Next 7 daysINTERVAL_NEXT7

Next 30 daysINTERVAL_NEXT30

Next 60 daysINTERVAL_NEXT60

Next 90 daysINTERVAL_NEXT90

Next 120 daysINTERVAL_NEXT120

When custom fiscal years are enabled: Last fiscal weekLAST_FISCALWEEK

When custom fiscal years are enabled: This fiscal weekTHIS_FISCALWEEK

When custom fiscal years are enabled: Next fiscal weekNEXT_FISCALWEEK

When custom fiscal years are enabled: Last fiscal periodLAST_FISCALPERIOD

When custom fiscal years are enabled: This fiscal periodTHIS_FISCALPERIOD

When custom fiscal years are enabled: Next fiscal periodNEXT_FISCALPERIOD

When custom fiscal years are enabled: This fiscal period and last fiscal periodLASTTHIS_FISCALPERIOD

When custom fiscal years are enabled: This fiscal period and next fiscal periodTHISNEXT_FISCALPERIOD

Current entitlement periodCURRENT_ENTITLEMENT_PERIOD

Previous entitlement periodPREVIOUS_ENTITLEMENT_PERIOD

Previous two entitlement periodsPREVIOUS_TWO_ENTITLEMENT_PERIODS

Two entitlement periods agoTWO_ENTITLEMENT_PERIODS_AGO

Current and previous entitlement periodCURRENT_AND_PREVIOUS_ENTITLEMENT_PERIOD

Current and previous two entitlement periodsCURRENT_AND_PREVIOUS_TWO_ENTITLEMENT_PERIODS

Declarative Metadata Sample Definition

A sample XML report definition:

<?xml version="1.0" encoding="UTF-8"?>

539

ReportMetadata Types

<acrossGroupingContext>CRT_Object__c$Id</acrossGroupingContext>

<calculatedFormula>PREVGROUPVAL(CRT_Object__c.Currency__c:AVG, CRT_Object__c.Id)

PARENTGROUPVAL(CRT_Object__c.Number__c:MAX, CRT_Object__c.CreatedBy.Name,

COLUMN_GRAND_SUMMARY)/RowCount</calculatedFormula>

<datatype>number</datatype>

<developerName>FORMULA1</developerName>

<downGroupingContext>CRT_Object__c$CreatedBy</downGroupingContext>

<masterLabel>CurrCSF</masterLabel>

</aggregates>

<acrossGroupingContext>CRT_Object__c$LastModifiedDate</acrossGroupingContext>

<calculatedFormula>IF(RowCount>10,

BLANKVALUE(ROUND(PREVGROUPVAL(CRT_Object__c.Currency__c:SUM,

CRT_Object__c.LastModifiedDate),3),

PARENTGROUPVAL(CRT_Object__c.Number__c:SUM, ROW_GRAND_SUMMARY,

CRT_Object__c.Id)) , 1000)</calculatedFormula>

<datatype>number</datatype>

<developerName>FORMULA2</developerName>

<downGroupingContext>GRAND_SUMMARY</downGroupingContext>

<masterLabel>numCSF</masterLabel>

</aggregates>

<bucketType>number</bucketType>

<developerName>BucketField_BusinessSize</developerName>

<masterLabel>NumericBucket</masterLabel>

<sourceColumnName>SALES</sourceColumnName>

</sourceValues>

</values>

</sourceValues>

</values>

</sourceValues>

</values>

</buckets>

540

ReportMetadata Types

<developerName>BucketField_Region</developerName>

<masterLabel>TextBucket</masterLabel>

<otherBucketLabel>Other</otherBucketLabel>

<sourceColumnName>ADDRESS1_STATE</sourceColumnName>

</sourceValues>

</values>

</sourceValues>

<sourceValue>Ontario</sourceValue>

</sourceValues>

</values>

</buckets>

<chart>

<backgroundColor1>#FFFFFF</backgroundColor1>

<backgroundColor2>#FFFFFF</backgroundColor2>

<backgroundFadeDir>Diagonal</backgroundFadeDir>

<column>FORMULA1</column>

</chartSummaries>

<column>FORMULA2</column>

</chartSummaries>

<aggregate>Maximum</aggregate>

<column>CRT_Object__c$Number__c</column>

</chartSummaries>

<column>RowCount</column>

</chartSummaries>

<chartType>VerticalColumn</chartType>

<groupingColumn>CRT_Object__c$LastModifiedDate</groupingColumn>

<legendPosition>Right</legendPosition>

<location>CHART_TOP</location>

<size>Medium</size>

</chart>

541

ReportMetadata Types

<field>CRT_Object__c$Name</field>

</columns>

<aggregateTypes>Average</aggregateTypes>

<field>CRT_Object__c$Currency__c</field>

</columns>

<aggregateTypes>Maximum</aggregateTypes>

<field>CRT_Object__c$Number__c</field>

</columns>

<field>BucketField__Region</field>

</columns>

<format>Matrix</format>

<field>CRT_Object__c$Id</field>

</groupingsAcross>

<field>CRT_Object__c$LastModifiedDate</field>

</groupingsAcross>

<field>CRT_Object__c$CreatedBy</field>

</groupingsDown>

<field>CRT_Object__c$Currency__c</field>

</groupingsDown>

<name>CrtMMVC</name>

<scope>organization</scope>

<showDetails>false</showDetails>

<dateColumn>CRT_Object__c$CreatedDate</dateColumn>

<interval>INTERVAL_CUSTOM</interval>

</timeFrameFilter>

</Report>

Declarative Metadata Sample Definition for a Joined Report

A sample XML report definition:

<?xml version="1.0" encoding="UTF-8"?>

<!-- This is a cross-block custom summary formula. Note that the calculated formula reference

for a blocks reference uses the BlockId#Aggregate. -->

542

ReportMetadata Types

<calculatedFormula>B1#AMOUNT:SUM+B2#EMPLOYEES:SUM</calculatedFormula>

<datatype>number</datatype>

<developerName>FORMULA</developerName>

<masterLabel>Cross-Block CSF Example</masterLabel>

</aggregates>

<!-- This is a standard custom summary formula. Note that the calculated formula reference

does not have block reference but just the aggregate name of the report type associated

(Opportunity).-->

<calculatedFormula>AMOUNT:SUM</calculatedFormula>

<developerName>FORMULA2</developerName>

<isCrossBlock>false</isCrossBlock>

<masterLabel>Standard CSF Example</masterLabel>

<reportType>Opportunity</reportType>

</aggregates>

<block>

<!-- This is how the block defines that the custom summary formula should be referenced.

In this example, it’s the in standard FORMULA 2 defined above. This block report has blockID

B1.-->

<aggregate>FORMULA2</aggregate>

</aggregateReference>

</blockInfo>

</columns>

<format>Summary</format>

<name>Opportunities BLock 3</name>

<name>role_territory</name>

</params>

</params>

</params>

<name>probability</name>

</params>

543

ReportMetadata Types

</params>

<reportType>Opportunity</reportType>

<scope>organization</scope>

<dateColumn>CLOSE_DATE</dateColumn>

<interval>INTERVAL_CUSTOM</interval>

</timeFrameFilter>

</block>

<block>

<!-- This is how the block defines that the custom summary formula should be referenced.

In this example, it’s the cross-block custom summary formula FORMULA 1 defined above. This

block report has blockId B2.-->

<aggregate>FORMULA1</aggregate>

</aggregateReferences>

</blockInfo>

<field>USERS.NAME</field>

</columns>

</columns>

</columns>

<field>LAST_UPDATE</field>

</columns>

<field>ADDRESS1_STATE</field>

</columns>

<format>Summary</format

<name>Accounts block 5</name>

</params>

</params>

<reportType>AccountList</reportType>

<scope>organization</scope>

<dateColumn>CREATED_DATE</dateColumn>

<interval>INTERVAL_CUSTOM</interval>

</timeFrameFilter>

</block>

544

ReportMetadata Types

</blockInfo>

<chart>

<backgroundColor1>#FFFFFF</backgroundColor1>

<backgroundColor2>#FFFFFF</backgroundColor2>

<backgroundFadeDir>Diagonal</backgroundFadeDir>

<!-- This is how chart aggregates are designed in multiblock. We're using RowCount from

Block 1.-->

<column>B1#RowCount</column>

</chartSummaries>

<chartType>HorizontalBar</chartType>

<enableHoverLabels>false</enableHoverLabels>

<groupingColumn>ACCOUNT_NAME</groupingColumn>

<location>CHART_TOP</location>

<showPercentage>false</showPercentage>

<showTotal>false</showTotal>

<showValues>false</showValues>

<size>Medium</size>

</chart>

<format>MultiBlock</format>

<field>ACCOUNT_NAME</field>

</groupingsDown>

<name>mb_mbapi</name>

<reportType>Opportunity</reportType>

</Report>

SEE ALSO:

Dashboard

ReportType

Represents the metadata associated with a custom report type. This type extends the Metadata metadata type and inherits its fullName

field. Custom report types allow you to build a framework from which users can create and customize reports. For more information,

see “Set Up a Custom Report Type” in the Salesforce online help.

545

ReportTypeMetadata Types

Declarative Metadata File Suffix and Directory Location

The file suffix is .reportType for the custom report type definition. There is one file per custom report type. Report types are stored

in the reportTypes directory of the corresponding package directory.

Version

Custom report types are available in API version 14.0 and later.

Fields

DescriptionField TypeField Name

Indicates that the report type was automatically generated when historical

trending was enabled for an entity.

Available in API version 29 and later.

booleanautogenerated

Required. The primary object for the custom report type, for example,

Account. All objects, including custom and external objects, are supported.

You cannot edit this field after initial creation.

Support for external objects is available in API version 38.0 and later.

stringbaseObject

Required. This field controls the category for the report. The valid values

are:

ReportTypeCategory

(enumeration of type string)

SEE ALSO:

Role

Territory

SamlSsoConfig

Represents a SAML Single Sign-On configuration. This type extends the Metadata metadata type and inherits its fullName field.

Single sign-on (SSO) lets users access authorized network resources with one login. You validate usernames and passwords against your

corporate user database or other client app rather than Salesforce managing separate passwords for each resource.

File Suffix and Directory Location

SamlSsoConfig components have the suffix .samlssoconfig and are stored in the samlssoconfigs folder.

Version

SamlSsoConfig components are available in API version 28.0 and later.

Fields

DescriptionField TypeField Name

The name of the identity provider’s application. Get this from your identity

provider.

stringattributeName

For SAML 2.0 only and when identityLocation is set to

Attribute. Possible values include unspecified,

stringattributeNameIdFormat

emailAddress or persistent. All legal values can be found in

552

SamlSsoConfigMetadata Types

DescriptionField TypeField Name

the “Name Identifier Format Identifiers” section of the Assertions and

Protocols SAML 2.0 specification.

The name of the certificate to use for decrypting incoming SAML

assertions. This certificate is saved in the organization’s Certificate and

Key Management list. Available in API version 30.0 and later.

stringdecryptionCertificate

The URL of the page users should be directed to if there’s an error during

SAML login. It must be a publicly accessible page, such as a public site

Visualforce page. The URL can be absolute or relative.

stringerrorUrl

The user that runs the Apex handler class. The user must have the

“Manage Users” permission. A user is required if you specify a SAML JIT

handler class.

stringexecutionUserId

The location in the assertion where a user should be identified. Valid

values are:

SamlIdentityLocationType

(enumeration of type

string)

identityLocation

•SubjectNameId — The identity is in the <Subject>

statement of the assertion.

•Attribute — The identity is specified in an

<AttributeValue>, located in the <Attribute> of the

assertion.

The identifier the service provider uses for the user during Just-in-Time

user provisioning. Valid values are:

SamlIdentityType

(enumeration of type

string)

identityMapping

•Username — The user’s Salesforce username.

•FederationId — The federation ID from the user object; the

identifier used by the service provider for the user.

•UserId — The user ID from the user’s Salesforce organization.

The identification string for the Identity Provider.stringissuer

For SAML 2.0 only: The URL where Salesforce sends a SAML request to

start the login sequence.

stringloginUrl

For SAML 2.0 only: The URL to direct the user to when they click the

Logout link. The default is http://www.salesforce.com.

stringlogoutUrl

The unique name used by the API and managed packages. The name

must begin with a letter and use only alphanumeric characters and

stringname

underscores. The name cannot end with an underscore or have two

consecutive underscores.

For SAML 2.0 only: The ACS URL used with enabling Salesforce as an

identity provider in the Web single sign-on OAuth assertion flow.

stringoauthTokenEndpoint

If you’re using My Domain, chose the binding mechanism your identity

provider requests for your SAML messages. Values are:

booleanredirectBinding

•HTTP POST — HTTP POST binding sends SAML messages using

base64-encoded HTML forms.

553

SamlSsoConfigMetadata Types

DescriptionField TypeField Name

•HTTP Redirect — HTTP Redirect binding sends base64-encoded

and URL-encoded SAML messages within URL parameters.

The method that’s used to sign the SAML request. Valid values are

RSA-SHA1 and RSA-SHA256.

stringrequestSignatureMethod

The URL associated with login for the Web single sign-on flow.stringsalesforceLoginUrl

The issuer in SAML requests generated by Salesforce, and is also the

expected audience of any inbound SAML Responses. If you don’t have

stringsamlEntityId

domains deployed, this value is always

https://saml.salesforce.com. If you have domains deployed,

Salesforce recommends that you use your custom domain name.

The name of an existing Apex class that implements the

Auth.SamlJitHandler interface.

stringsamlJitHandlerId

The SAML version in use. Valid values are:SamlType (enumeration of

type string)

samlVersion

•SAML1_1 — SAML 1.1

•SAML2_0 — SAML 2.0

If true, Just-in-Time user provisioning is enabled, which creates users

on the fly the first time they try to log in. Specify Federation ID

for the identityMapping value to use this feature.

booleanuserProvisioning

The certificate used to validate the request. Get this from your identity

provider.

stringvalidationCert

Declarative Metadata Sample Definition

The following is an example of a SamlSsoConfig component. The validation certificate string has been truncated for readability.

<?xml version="1.0" encoding="UTF-8"?>

<identityLocation>SubjectNameId</identityLocation>

<identityMapping>FederationId</identityMapping>

<issuer>https://my-idp.my.salesforce.com</issuer>

https://my-idp.my.salesforce.com/idp/endpoint/HttpRedirect

</loginUrl>

<logoutUrl>https://www.salesforce.com</logoutUrl>

<name>SomeCompany</name>

https://login.salesforce.com/services/oauth2/token?so=00DD0000000JxeI

</oauthTokenEndpoint>

https://login.salesforce.com?so=00DD0000000JxeI

</salesforceLoginUrl>

554

SamlSsoConfigMetadata Types

https://saml.salesforce.com/customPath

</samlEntityId>

<userProvisioning>false</userProvisioning>

MIIEojCCA4qgAwIBAgIOATtxsoBFAAAAAD4...

</validationCert>

</SamlSsoConfig>

Scontrol

Important: Visualforce pages supersede s-controls. Organizations that haven’t previously used s-controls can’t create them.

Existing s-controls are unaffected, and can still be edited.

Deprecated. Represents an Scontrol component, corresponding to an s-control in the Salesforce user interface. For more information,

see “About S-Controls” in the Salesforce online help. This type extends the MetadataWithContent metadata type and inherits its content

and fullName fields.

Declarative Metadata File Suffix and Directory Location

The file suffix is .scf for the s-control file. The accompanying metadata file is named ScontrolName-meta.xml.

Scontrol components are stored in the scontrols folder in the corresponding package directory.

Version

Scontrols are available in API version 10.0 and later.

Fields

This metadata type contains the following fields:

DescriptionField TypeField Name

Content of the s-control. Base 64-encoded binary data. Prior to making

an API call, client applications must encode the binary attachment

base64Binarycontent

data as base64. Upon receiving a response, client applications must

decode the base64 data to binary. This conversion is usually handled

for you by a SOAP client. This field is inherited from the

MetadataWithContent component.

Required. Determines how you plan to use the s-control:SControlContentSource (enumeration

of type string)

contentSource

•HTML: Select this option if you want to enter the content for your

s-control in content.

•URL: Select this option if you want to enter the link or URL of an

external website in content.

555

ScontrolMetadata Types

DescriptionField TypeField Name

•Snippet: Snippets are s-controls that are designed to be

included in other s-controls. Select this option if you want to enter

the content for your s-control snippet in content.

Optional text that describes the s-control. This only displays to users

with “View All Data” permission (administrator).

stringdescription

Required. The default encoding setting is Unicode: UTF-8. Change

it if you are passing information to a URL that requires data in a different

Encoding (enumeration of type string)encodingKey

format. This option is available when you select URL as the value for

contentSource.

File contents displayed if you add this s-control to a custom link. The

file can contain a Java applet, Active-X control, or any other type of

base64fileContent

content you want. This option only applies to s-controls with a value

of HTML for contentSource.

The unique name for the s-control. This name can contain only

underscores and alphanumeric characters, and must be unique in

stringfileName

your org. It must begin with a letter, not include spaces, not end with

an underscore, and not contain two consecutive underscores. This

field cannot be changed for components installed by a managed

package. It is only relevant if the fileContent field also has a value.

This is a new field in API version 14.0.

The s-control developer name used as a unique identifier for API access.

The fullName can contain only underscores and alphanumeric

stringfullName

characters. It must be unique, begin with a letter, not include spaces,

not end with an underscore, and not contain two consecutive

underscores. If this field contained characters before version 14.0 that

are no longer allowed, the characters were stripped out of this field,

and the previous value of the field was saved in the name field. This

field is inherited from the Metadata component.

Required. The unique name for the s-control. It must contain

alphanumeric characters only and begin with a letter. For example

example_s_control.

stringname

Required. Indicates whether the s-control supports caching (true)

or not (false). Caching optimizes the page so that it remembers

booleansupportsCaching

which s-controls are on the page when it reloads. This option only

applies to HTML s-controls.

Declarative Metadata Sample Definition

The following sample creates the Myriad_Publishing.scf s-control, which creates a link to the website specified in the s-control.

The corresponding Myriad_Publishing.scf-meta.xml metadata file follows the s-control file.

556

ScontrolMetadata Types

Myriad_Publishing.scf file:

http://www.myriadpubs.com

Myriad_Publishing.scf-meta.xml:

<?xml version="1.0" encoding="UTF-8"?>

<description>s-control to open Myriad Publishing website.</description>

<name>Myriad Publishing</name>

</Scontrol>

Settings

Represents the organization settings related to a feature. For example, your password policies, session settings and network access

controls are all available in the SecuritySettings component type. Not all feature settings are available in the Metadata API. See Unsupported

Metadata Types on page 118 for information on which feature settings are not available.

Settings can be accessed using the specific component member or via wildcard. For example, in the package manifest file you would

use the following section to access SecuritySettings:

<types>

<members>Security</members>

<name>Settings</name>

</types>

The member format when used in the package manifest is the component metadata type name without the “Settings” suffix, so in the

preceding example “Security” is used instead of “SecuritySettings”.

File Suffix and Directory Location

Each settings component gets stored in a single file in the settings directory of the corresponding package directory. The filename

uses the format Setting feature.settings. For example, the SecuritySettings file would be Security.settings. See

“File Suffix and Directory Location” information for the individual settings components to determine the exact filename.

Version

Settings is available in API version 27.0 and later. See the version information for the individual setting component to determine which

API version the settings component became available.

Declarative Metadata Sample Definition

The following is an example package manifest used to deploy or retrieve only the MobileSettings for an organization:

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Mobile</members>

<name>Settings</name>

557

SettingsMetadata Types

</types>

</Package>

The following is an example package manifest used to deploy or retrieve all the available settings metadata for an organization, using

a wildcard:

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>Settings</name>

</types>

</Package>

SEE ALSO:

AccountSettings

ActivitiesSettings

AddressSettings

CaseSettings

ChatterAnswersSettings

CompanySettings

ContractSettings

EntitlementSettings

ForecastingSettings

IdeasSettings

KnowledgeSettings

MobileSettings

SecuritySettings

AccountSettings

Represents an organization’s account settings for account teams, account owner report, and the View Hierarchy link. This type extends

the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

AccountSettings values are stored in the Account.settings file in the settings folder. The .settings files are different

from other named components because there is only one settings file for each settings component.

Version

AccountSettings is available in API versions 29.0 and later.

558

AccountSettingsMetadata Types

Fields

DescriptionField TypeField Name

Indicates whether Account Owner Report may (true) or may not

(false) be run by all users.

booleanenableAccountOwnerReport

Indicates whether Account Teams are enabled (true) or not (false).

The Metadata API cant’ be used to disable Account Teams.

booleanenableAccountTeams

Indicates whether the default View Hierarchy link on all business

account detail pages is visible (true) or hidden (false).

booleanshowViewHierarchyLink

Declarative Metadata Sample Definition

The following is an example of the Account.settings file:

<?xml version="1.0" encoding="UTF-8"?>

</AccountSettings>

Example Package Manifest

The following is an example package manifest used to deploy or retrieve the Account settings metadata for an organization:

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Account</members>

<name>Settings</name>

</types>

</Package>

SEE ALSO:

Settings

ActivitiesSettings

Represents an organization’s activity settings, and its user interface settings for the calendar. Use the ActivitiesSettings component type

to control the following activity settings:

•Configure group and recurring tasks, recurring and multiday events, and email tracking

•Relate multiple contacts to tasks and events (shared activities)

•Display custom logos in meeting requests

559

ActivitiesSettingsMetadata Types

Also use the ActivitiesSettings component type to control user interface settings for the calendar, including hover links and drag-and-drop

editing.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

ActivitiesSettings values are stored in the Activities.settings file in the settings directory. The .settings files are

different from other named components because there is only one settings file for each settings component.

Version

ActivitiesSettings is available in API versions 28.0 and later.

Fields

Settings for all types listed below are controlled on the Activity settings page or the User Interface settings page as noted.

DescriptionField TypeField Name

This read only field indicates whether Shared Activities is enabled. When

the value is true, allows users to relate multiple contacts to a task or

event.

booleanallowUsersToRelateMultipleContactsToTasksAndEvents

Important: Beginning with API v36.0, this field is read-only in

all versions of the API. You can’t change the value of this field.

Even though this field was updateable before Spring '16, changing

this field’s value wasn't supported and could have resulted in an

incorrect integration. If you have code in older API versions that

changes the value of this field, ensure you update that code to

prevent any errors.

Enables popup activity reminders for an organization.

Administrators control this field on the Activity settings page.

booleanenableActivityReminders

Lets users create events in day and weekly calendar views by

double-clicking a specific time slot and entering the details of the event

booleanenableClickCreateEvents

in an overlay. Hovering over an event displays an overlay where users

can view the event details or delete the event without leaving the page.

Administrators use a mini page layout to configure the fields shown in

the overlays. Does not support recurring events or multi-person events.

Administrators control this field on the User Interface settings page.

Lets users create events associated with records by dragging a record

from a list view onto a calendar view and entering the details of the

booleanenableDragAndDropScheduling

event in an overlay. Hovering over an event displays an overlay where

users can view the event details or delete the event without leaving the

page. Administrators use a mini page layout to configure the fields shown

in the overlays.

560

ActivitiesSettingsMetadata Types

DescriptionField TypeField Name

Administrators control this field on the User Interface settings page.

Enables tracking of outbound HTML emails if an organization uses HTML

email templates.

Administrators control this field on the Activity settings page.

booleanenableEmailTracking

Lets users assign independent copies of a new task to multiple users.

Administrators control this field on the Activity settings page.

booleanenableGroupTasks

Extends the functionality of enableDragAndDropScheduling

and enableClickCreateEvents to list view calendars.

Administrators control this field on the User Interface settings page.

booleanenableListViewScheduling

Enables creation of events that end more than 24 hours after they start.

Administrators control this field on the Activity settings page.

booleanenableMultidayEvents

Enables creation of events that repeat at specified intervals.

Administrators control this field on the Activity settings page.

booleanenableRecurringEvents

Enables creation of tasks that repeat at specified intervals.

Administrators control this field on the Activity settings page.

booleanenableRecurringTasks

In the sidebar, displays a shortcut link to a user’s last-used calendar view.

Administrators control this field on the Activity settings page.

booleanenableSidebarCalendarShortcut

Allows administrators to specify whether tapping New Task in Salesforce1

opens a regular task record edit page or a page that displays key task

fields first.

Administrators control this field on the Activity settings page.

booleanenableSimpleTaskCreateUI

On the Activity settings page, exposes a setting for administrators to

hide or show a user setting that lets individual users enable or disable

email notifications when tasks are assigned to them.

booleanenableUNSTaskDelegatedToNotifications

Available when showCustomLogoMeetingRequests is enabled.

Uploads a custom logo. An administrator can select only a logo that has

been uploaded to certain folders in the Documents tab.

Administrators control this field on the Activity settings page.

stringmeetingRequestsLogo

Displays a custom logo in meeting request emails and on a meeting’s

Web page. Invitees see the logo when a user either invites them to an

event or requests a meeting.

Administrators control this field on the Activity settings page.

booleanshowCustomLogoMeetingRequests

561

ActivitiesSettingsMetadata Types

DescriptionField TypeField Name

Displays event details on-screen rather than in hover text.

Administrators control this field on the Activity settings page.

booleanshowEventDetailsMultiUserCalendar

In the calendar section of the Home tab:booleanshowHomePageHoverLinksForEvents

•When a user hovers over the subject of an event, a hover link displays

an overlay with selected event details. (Hover links are always

available in other calendar views.)

•When a user clicks the subject of an event, displays the event detail

page.

Administrators use a mini page layout to configure the fields shown in

the overlay.

Administrators control this field on the User Interface settings page.

In the My Tasks section of the Home tab and on the calendar day view:booleanshowMyTasksHoverLinks

•When a user hovers over the subject of a task, a hover link displays

an overlay with selected task details.

•When a user clicks the subject of a task, displays the task detail page.

Administrators use a mini page layout to configure the fields shown in

the overlay.

Administrators control this field on the User Interface settings page.

In the Calendar on the Home tab, displays the Requested Meetings

subtab, listing the meetings a user has requested but not confirmed.

booleanshowRequestedMeetingsOnHomePage

Disabling this feature removes the New Meeting Request button from

the calendar on the Home tab.

Administrators control this field on the Activity settings page.

Example Package Manifest

The following is an example package manifest used to deploy or retrieve the Activity settings metadata for an organization:

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Activities</members>

<name>Settings</name>

</types>

</Package>

562

ActivitiesSettingsMetadata Types

Declarative Metadata Sample Definition

The following is an example of an activity settings file:

<?xml version="1.0" encoding="UTF-8"?>

<meetingRequestsLogo>Folder02/logo03.png</meetingRequestsLogo>

</ActivitiesSettings>

SEE ALSO:

Document

AddressSettings

Represents the configuration of country and state picklists. Use the AddressSettings component type to configure state and country

data in your organization so that you can convert text-based values into standard picklist values. To convert your state and country

values, from Setup, enter State and Country Picklists in the Quick Find box, then select State and Country Picklists

. For more information, see “Let Users Select State and Country from Picklists” in the Salesforce online help.

This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

Declarative Metadata File Suffix and Directory Location

AddressSettings values are stored in a single file named Address.settings in the settings directory. The .settings files

are different from other named components because there is only one settings file for each settings component.

Version

AddressSettings is available in API versions 27.0 and later.

CountriesAndStates

This complex metadata type represents valid definitions of states and countries in picklists.

563

AddressSettingsMetadata Types

Note: You can use the Metadata API to edit existing states and countries in state and country picklists. You can’t use the Metadata

API to create or delete new states or countries.

DescriptionField TypeField

The countries available in picklists.Country[]countries

Country

This metadata type provides the definition for a country in a picklist.

DescriptionField TypeField

Determines whether the value is available in the API.booleanactive

Important: After you enable state and country picklists

in your Salesforce organization, you can’t set the

active status to false.

A customizable text value that is linked to a state or country

code. Integration values for standard states and countries default

stringintegrationValue

to the full ISO-standard state and country names. Integration

values function similarly to the API names of custom fields and

objects. Configuring integration values allows integrations that

you set up before enabling state and country picklists to

continue to work.

Important: If you don’t specify integration values before

enabling state and country picklists in your organization,

records use the default value provided by Salesforce. If

you change integration values later, records created or

updated from that point on use your edited values.

The ISO-standard code populates this field when you issue a

retrieve() call. This field is read only in the API but you

stringisoCode

can edit the label in Setup. You can’t edit the isoCode of

standard states and countries.

The label is what users see in picklists in Salesforce. This field is

read only in the API but you can edit the label in Setup.

stringlabel

Sets a country as the default value for new records in the

Salesforce organization.

booleanorgDefault

Standard states and countries are states and countries that are

included with Salesforce. You can’t edit the standard

attribute.

booleanstandard

The states or provinces that are part of the country.State[]states

Makes the state or country available to users in Salesforce. States

or countries that are visible must also be active.

booleanvisible

564

AddressSettingsMetadata Types

State

This metadata type provides the definition for a state in a picklist.

DescriptionField TypeField

Determines whether the value is available in the API.booleanactive

Important: After you enable state and country picklists

in your Salesforce organization, you can’t set the

active status to false.

A customizable text value that is linked to a state or country

code. Integration values for standard states and countries default

stringintegrationValue

to the full ISO-standard state and country names. Integration

values function similarly to the API names of custom fields and

objects. Configuring integration values allows integrations that

you set up before enabling state and country picklists to

continue to work.

Important: If you don’t specify integration values before

enabling state and country picklists in your organization,

records use the default value provided by Salesforce. If

you change integration values later, records created or

updated from that point on use your edited values.

The ISO-standard code populates this field when you issue a

retrieve() call. This field is read only in the API but you

can edit the label in Setup.

stringisoCode

The label is what users see in picklists in Salesforce. This field is

read only in the API but you can edit the label in Setup.

stringlabel

Standard states and countries are states and countries that are

included with Salesforce. You can’t edit the standard

attribute.

booleanstandard

Makes the state or country available to users in Salesforce. States

or countries that are visible must also be active.

booleanvisible

Declarative Metadata Sample Definition

The following is sample XML that configures state and country picklists for the United States and Canada for use in an organization. It

also makes the country of Greenland available only in the API. This example is supported in API version 39.0.

<?xml version="1.0" encoding="UTF-8"?>

<integrationValue>United States</integrationValue>

565

AddressSettingsMetadata Types

<label>United States</label>

<state>

<integrationValue>Alabama</integrationValue>

<label>Alabama</label>

</state>

<state>

<integrationValue>Alaska</integrationValue>

<label>Alaska</label>

</state>

</states>

</country>

<integrationValue>Canada</integrationValue>

<label>Canada</label>

<orgDefault>false</orgDefault>

<state>

<integrationValue>Alberta</integrationValue>

<label>Alberta</label>

</state>

<state>

<integrationValue>British Columbia</integrationValue>

<label>British Columbia</label>

</state>

</states>

</country>

<integrationValue>Greenland</integrationValue>

566

AddressSettingsMetadata Types

<label>Greenland</label>

<visible>false</visible>

</country>

</countries>

</countriesAndStates>

</AddressSettings>

SEE ALSO:

Settings

BusinessHoursSettings

Represents the metadata used to manage settings for business hours and holidays in entitlements, entitlement templates, campaigns,

and cases. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

Business hours and holidays settings are stored in a single file named businessHours.settings in the settings directory.

The .settings files are different from other named components because there is only one settings file for each settings component.

Version

BusinessHoursSettings is available in API version 29.0 and later.

Fields

DescriptionField TypeField Name

Represents the application of business hours to entitlements,

entitlement templates, campaigns, and cases.

BusinessHoursEntry[]businessHours

Represents a holiday and its usage in businessHours.Holidays[]holidays

BusinessHoursEntry

Represents the application of business hours to entitlements, entitlement templates, campaigns, and cases.

DescriptionField TypeField Name

The time zone for the time that defines business hours.stringtimeZoneId

Name of the business hours. This name should be unique.stringname

Indicates whether the business hours are active.stringactive

Indicates whether the business hours are used as the default business

hours.

stringdefault

567

BusinessHoursSettingsMetadata Types

DescriptionField TypeField Name

Start time for the business hours on Monday. Uses the format

HH:mm:ss.SSSZ.

stringmondayStartTime

End time for the business hours on Monday. Uses the format

HH:mm:ss.SSSZ. The value 00:00:00.000Z specifies midnight

on Monday.

stringmondayEndTime

Start time for the business hours on Tuesday. Uses the format

HH:mm:ss.SSSZ.

stringtuesdayStartTime

End time for the business hours on Tuesday. Uses the format

HH:mm:ss.SSSZ. The value 00:00:00.000Z specifies midnight

on Tuesday.

stringtuesdayEndTime

Start time for the business hours on Wednesday. Uses the format

HH:mm:ss.SSSZ.

stringwednesdayStartTime

End time for the business hours on Wednesday. Uses the format

HH:mm:ss.SSSZ. The value 00:00:00.000Z specifies midnight

on Wednesday.

stringwednesdayEndTime

Start time for the business hours on Thursday. Uses the format

HH:mm:ss.SSSZ.

stringthursdayStartTime

End time for the business hours on Thursday. Uses the format

HH:mm:ss.SSSZ. The value 00:00:00.000Z specifies midnight

on Thursday.

stringthursdayEndTime

Start time for the business hours on Friday. Uses the format

HH:mm:ss.SSSZ.

stringfridayStartTime

End time for the business hours on Friday. Uses the format

HH:mm:ss.SSSZ. The value 00:00:00.000Z specifies midnight

on Friday.

stringfridayEndTime

Start time for the business hours on Saturday. Uses the format

HH:mm:ss.SSSZ.

stringsaturdayStartTime

End time for the business hours on Saturday. Uses the format

HH:mm:ss.SSSZ. The value 00:00:00.000Z specifies midnight

on Saturday.

stringsaturdayEndTime

Start time for the business hours on Sunday. Uses the format

HH:mm:ss.SSSZ.

stringsundayStartTime

End time for the business hours on Sunday. Uses the format

HH:mm:ss.SSSZ. The value 00:00:00.000Z specifies midnight

on Sunday.

stringsundayEndTime

Holidays

Represents a holiday and its usage in businessHours.

568

BusinessHoursSettingsMetadata Types

DescriptionField TypeField Name

Name of the holiday. This name does not have to be unique.stringname

The description of the holiday.stringdescription

Indicates whether the holiday is recurring.stringisRecurring

The date of the holiday. Use for non-recurring holidays. Uses the format

HH:mm:ss.SSSZ.

stringactivityDate

The date the holiday starts recurring. Uses the format yyyy-mm-dd.stringrecurrenceStartDate

The date the holiday stops recurring. Uses the format yyyy-mm-dd.

Optional.

stringrecurrenceEndDate

The start time on the date of the holiday. Uses the format

HH:mm:ss.SSSZ. startTime and endTime must be both null

or both not null. If they are both null, indicates the whole day.

stringstartTime

The end time on the date of the holiday. Uses the format

HH:mm:ss.SSSZ. startTime and endTime must be both null

or both not null. If they are both null, indicates the whole day.

stringendTime

The recurrence type of the holiday. Valid values are: RecursDaily,

RecursEveryWeekday, RecursMonthly, RecursMonthlyNth, RecursWeekly,

RecursYearly, RecursYealyNth.

stringrecurrenceType

The interval of weeks, months, or years the holiday recurs.stringrecurrenceInterval

The day of week the holiday recurs. Valid values: Monday, Tuesday,

Wednesday, Thursday, Friday, Saturday, Sunday.

stringrecurrenceDayOfWeek

The day of month the holiday recurs. Valid values: integers 1-31.stringrecurrenceDayOfMonth

Valid values: First, Second, Third, Fourth, Last. Only used for

recurrenceType RecursMonthlyNth and RecursYearlyNth. For example,

stringrecurrenceInstance

if the recurenceInstance value is First, the holiday recurs on the

first Monday of the month every 3 months.

Valid values: January, February, March, April, May, June, July, August,

September, October, November, December.

stringrecurrenceMonthOfYear

The name of the business hours setting that applies to this holiday.stringbusinessHours

Declarative Metadata Sample Definition

The following is an example businesshours.settings metadata file:

<?xml version="1.0" encoding="UTF-8"?>

569

BusinessHoursSettingsMetadata Types

<name>Default</name>

<timeZoneId>America/Los_Angeles</timeZoneId>

</businessHours>

<default>false</default>

<timeZoneId>America/Los_Angeles</timeZoneId>

</businessHours>

<businessHours>Default</businessHours>

<isRecurring>false</isRecurring>

<name>Labor Day</name>

</holidays>

<name>Thanksgiving</name>

<recurrenceMonthOfYear>November</recurrenceMonthOfYear>

<recurrenceType>RecursYearly</recurrenceType>

</holidays>

</BusinessHoursSettings>

570

BusinessHoursSettingsMetadata Types

The following is an example package.xml manifest that references the BusinessHoursSettings definitions:

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>BusinessHours</members>

<name>Settings</name>

</types>

</Package>

CaseSettings

Represents an organization’s case settings, such as the default case owner, which case-related features are enabled, and which email

templates are used for various case activities.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

CaseSettings values are stored in the Case.settings file in the settings directory. The .settings files are different from

other named components because there is only one settings file for each settings component.

Version

CaseSettings is available in API version 27.0 and later.

Fields

DescriptionField TypeField Name

Specifies the email template used for case assignment

notifications. The format must be

folderName/emailTemplateName.

stringcaseAssignNotificationTemplate

Specifies the email template used for case close notifications.

The format must be

folderName/emailTemplateName.

stringcaseCloseNotificationTemplate

Specifies the email template used for case comment

notifications. The format must be

folderName/emailTemplateName.

stringcaseCommentNotificationTemplate

Specifies the email template used for case create

notifications. The format must be

folderName/emailTemplateName.

stringcaseCreateNotificationTemplate

Specifies the settings for feed items in feed-based case page

layouts. This field is available in API version 32.0 and later.

FeedItemSettings[]caseFeedItemSettings

Indicates whether Closed is included in the Case Status

field on case edit pages (true) or not (false).

booleancloseCaseThroughStatusChange

571

CaseSettingsMetadata Types

DescriptionField TypeField Name

Specifies the default owner of a case when assignment rules

fail to locate an owner.

stringdefaultCaseOwner

Specifies whether the default case owner is a user or a queue.stringdefaultCaseOwnerType

Specifies the user listed in the Case History related list for

automated case changes from:

stringdefaultCaseUser

•Assignment rules

•Escalation rules

•On-Demand Email-to-Case

•Cases logged in the Self-Service portal

The organization’s Email-to-Case settings.EmailToCaseSettingsemailToCase

Indicates whether Case Feed is enabled (true) or not

(false).

booleanenableCaseFeed

Indicates whether draft emails are enabled (true) or not

(false). Enabling email drafts requires that Case Feed and

Email-to-Case are also enabled.

booleanenableDraftEmails

Indicates whether early triggers on escalation rules are

enabled (true) or not (false).

booleanenableEarlyEscalationRuleTriggers

Indicates whether default email templates are enabled

(true) or not (false). Default email templates are

available only if draft emails are enabled.

booleanenableNewEmailDefaultTemplate

Indicates whether the Suggested Articles list appears on case

pages.(true) or not (false). Is only valid if

enableSuggestedSolutions=false.

booleanenableSuggestedArticlesApplication

Indicates whether the Suggested Articles list appears on

customer portal pages (true) or not (false). Is only valid

if enableSuggestedSolutions=false.

booleanenableSuggestedArticlesCustomerPortal

Indicates whether the Suggested Articles list appears on

partner portal pages (true) or not (false). Is only valid if

enableSuggestedSolutions=false.

booleanenableSuggestedArticlesPartnerPortal

Indicates whether the View Suggested Solutions or Find

Articles button appears on case detail pages (true) or not

booleanenableSuggestedSolutions

(false). Is only valid if

enableSuggestedArticlesApplication,

enableSuggestedArticlesCustomerPortal,

and

enableSuggestedArticlesPartnerPortal=false.

Indicates whether, when applying assignment rules to

manually created records, to keep the existing record type

booleankeepRecordTypeOnAssignmentRule

572

CaseSettingsMetadata Types

DescriptionField TypeField Name

(true) or to override the existing record type with the

assignee’s default record type (false).

Specifies the Apex class that defines the default email

template for new email messages in Case Feed. This field

stringnewEmailDefaultTemplateClass

appears only when

enableNewEmailDefaultTemplate=true.

Indicates whether contacts who are not members of your

Self-Service portal can be notified when a new comment is

added to a case.(true) or not (false).

booleannotifyContactOnCaseComment

Indicates whether the default case owner is notified when

assigned a new case (true) or not (false).

booleannotifyDefaultCaseOwner

Indicates whether the case owner is notified when a

comment is added to a case (true) or not (false).

booleannotifyOwnerOnCaseComment

Indicates whether the Send Notification Email

checkbox on cases is automatically selected when users

change a case owner to another user (true).

booleannotifyOwnerOnCaseOwnerChange

Indicates whether the Save & Close button on case edit

pages and the Cls link on Cases related lists are hidden

(true) or shown (false).

booleanshowFewerCloseActions

Specifies the email address used when the default case user

is the system user.

stringsystemUserEmail

Indicates whether case comment, case attachment, and case

assignment email notifications are sent from a system

booleanuseSystemEmailAddress

address (true) or whether case notifications appear to be

sent from the user or contact updating the case (false).

Indicates whether the system user is used as the automated

case user (true) or not (false). If false, then you must

specify a value for the defaultCaseUser field.

booleanuseSystemUserAsDefaultCaseUser

The organization’s Web-to-Case settings.WebToCaseSettingswebToCase

EmailToCaseSettings

Represents an organization’s Email-to-Case settings.

573

CaseSettingsMetadata Types

Fields

DescriptionField TypeField Name

Indicates whether Email-to-Case is enabled (true) or not

(false). Note: once Email-to-Case is enabled, it can’t be

disabled.

booleanenableEmailToCase

Indicates whether HTML email is enabled (true) or not

(false).

booleanenableHtmlEmail

Indicates whether On-Demand Email-to-Case is enabled

(true) or not (false).

booleanenableOnDemandEmailToCase

Indicates whether the Thread ID for a case is inserted in the

body of an email (true) or not (false).

booleanenableThreadIDInBody

Indicates whether the Thread ID for a case is inserted in the

subject line of an email (true) or not (false).

booleanenableThreadIDInSubject

Indicates whether the owner of a case receives a notification

when a new email related to the case is received (true) or

not (false).

booleannotifyOwnerOnNewCaseEmail

Specifies what happens to email messages received after an

organization exceeds its daily Email-to-Case limits. Valid values

are:

EmailToCaseOnFailureActionType

(enumeration of type string)

overEmailLimitAction

•Bounce

•Discard

•Requeue

Indicates whether the user signature is inserted after the reply

but before the email thread in an outbound email (true) or

at the end of the email (false).

booleanpreQuoteSignature

The organization’s Email-to-Case routing address settings.EmailToCaseRoutingAddress[]routingAddresses

Specifies what happens to email messages received from

invalid senders. Valid values are:

EmailToCaseOnFailureActionType

(enumeration of type string)

unauthorizedSenderAction

•Bounce

•Discard

EmailToCaseRoutingAddress

Represents an organization’s Email-to-Case routing address.

574

CaseSettingsMetadata Types

Fields

DescriptionField TypeField Name

Specifies the type of Email-to-Case routing address. Valid

values are:

EmailToCaseRoutingAddressType

(enumeration of type string)

addressType

•EmailToCase—A routing address used with

Email-to-Case or On-Demand Email-to-Case.

•Outlook—A routing address used with

Salesforce for Outlook to create cases from Outlook.

Requires that On-Demand Email-to-Case is enabled.

Specifies the email addresses or domains from which

On-Demand Email-to-Case can receive email. Include multiple

entries in a comma-separated list.

stringauthorizedSenders

Specifies the default case origin for cases created through this

routing address.

stringcaseOrigin

Specifies the default owner of cases created through this

routing address. The case owner can be either a user or a

queue. Specify the case owner using a Salesforce username.

stringcaseOwner

Specifying a case owner here in the routing address settings

value of defaultCaseOwner in CaseSettings.

Specifies whether the default case owner is a user or a queue.stringcaseOwnerType

Specifies the default case priority for cases created through

this routing address.

stringcasePriority

Indicates whether a task is automatically assigned to the case

owner when a case is created through an email (true) or

not (false).

booleancreateTask

Specifies the email address used to route email messages that

are submitted as cases.

stringemailAddress

Reserved for future use.stringemailServicesAddress

Reserved for future use.booleanisVerified

Specifies the name of the Email-to-Case routing address.stringroutingName

Indicates whether email routing and envelope information

are saved (true) or not (false).

booleansaveEmailHeaders

Specifies the default status on tasks automatically assigned

to the case owner when email is submitted as a case. Only

applies if createTask is set to true.

stringtaskStatus

575

CaseSettingsMetadata Types

FeedItemSettings

Represents an organization’s feed item settings. Available in API version 32.0 and later.

DescriptionField TypeField Name

Specifies the maximum number of characters displayed for

each feed item.

intcharacterLimit

Indicates whether earlier messages in an email thread are

removed from email feed items(true) or not (false).

booleancollapseThread

Indicates how email feed items are displayed. Valid values are:FeedItemDisplayFormat

(enumeration of type string)

displayFormat

•Default—Blank lines in email feed items are displayed.

•HideBlankLines—Blank lines in email feed items

are not displayed.

The type of feed item to which the settings apply. For

FeedItemSettings, the only valid feedItemType

value is EmailMessageEvent.

FeedItemType (enumeration of

type string)

feedItemType

WebToCaseSettings

Represents an organization’s Web-to-Case settings.

Fields

DescriptionField TypeField Name

Specifies the default case origin for cases created through this web form.

Only applies if enableWebToCase is set to true.

stringcaseOrigin

Specifies the default template used for email responses to cases

submitted through a Self-Service portal. Only applies if

enableWebToCase is set to true.

stringdefaultResponseTemplate

Indicates whether Web-to-Case is enabled (true) or not (false).booleanenableWebToCase

Declarative Metadata Sample Definition

This code sample is an example of a case settings file.

<?xml version="1.0" encoding="UTF-8"?>

unfiled$public/SupportCaseAssignmentNotification

</caseAssignNotificationTemplate>

unfiled$public/SupportCaseCloseNotification

</caseCloseNotificationTemplate>

576

CaseSettingsMetadata Types

unfiled$public/SupportCaseCommentNotification

</caseCommentNotificationTemplate>

unfiled$public/SupportCaseCreateNotification

</caseCreateNotificationTemplate>

<defaultCaseOwner>admin@acme.com</defaultCaseOwner>

<defaultCaseUser>admin@acme.com</defaultCaseUser>

<enableHtmlEmail>false</enableHtmlEmail>

<notifyOwnerOnNewCaseEmail>false</notifyOwnerOnNewCaseEmail>

<overEmailLimitAction>Bounce</overEmailLimitAction>

<addressType>EmailToCase</addressType>

<caseOrigin>Email</caseOrigin>

<casePriority>Medium</casePriority>

<emailAddress>support@acme.com</emailAddress>

<routingName>EmailToCaseRoutingAddress1</routingName>

<taskStatus>Not Started</taskStatus>

</routingAddresses>

<addressType>Outlook</addressType>

<caseOrigin>Email</caseOrigin>

<caseOwner>admin@acme.com</caseOwner>

<routingName>OutlookRoutingAddress1</routingName>

</routingAddresses>

<unauthorizedSenderAction>Discard</unauthorizedSenderAction>

</emailToCase>

<enableSuggestedArticlesPartnerPortal>false</enableSuggestedArticlesPartnerPortal>

<enableSuggestedSolutions>false</enableSuggestedSolutions>

<newEmailDefaultTemplateClass>CaseTemplateController</newEmailDefaultTemplateClass>

577

CaseSettingsMetadata Types

<notifyOwnerOnCaseOwnerChange>false</notifyOwnerOnCaseOwnerChange>

<showFewerCloseActions>false</showFewerCloseActions>

<defaultResponseTemplate>unfiled$public/SupportCaseResponse</defaultResponseTemplate>

</webToCase>

</CaseSettings>

SEE ALSO:

Settings

ChatterAnswersSettings

Represents the metadata used to manage settings for Chatter Answers.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

Chatter Answers settings are stored in a single file named ChatterAnswers.settings in the settings directory. The

.settings files are different from other named components because there is only one settings file for each settings component.

Version

ChatterAnswersSettings is available in API version 27.0 and later.

Fields

DescriptionField TypeField Name

Indicates whether users are notified when a best answer is selected for

a question that they’re following (true) or not (false).

booleanemailFollowersOnBestAnswer

Indicates whether users are notified when other users reply to questions

they’re following (true) or not (false).

booleanemailFollowersOnReply

Indicates whether users are notified when customer support responds

to their questions privately (true) or not (false).

booleanemailOwnerOnPrivateReply

Indicates whether users are notified when other users reply to their

questions (true) or not (false).

booleanemailOwnerOnReply

Indicates whether users can post answers by replying to email

notifications (true) or not (false). This field is available in API version

29.0 and later.

booleanenableAnswerViaEmail

Indicates whether Chatter Answers is enabled in the organization (true)

or not (false).

booleanenableChatterAnswers

578

ChatterAnswersSettingsMetadata Types

DescriptionField TypeField Name

Indicates whether users sign in to your Chatter Answers communities

with their Facebook logins (true) or not (false). To enable this

booleanenableFacebookSSO

feature, you must define and enable a Facebook authentication provider

in your organization’s security controls and enable Auth Providers in

your organization.

Indicates whether users can filter search results by articles or questions

before they post a question to any of your Chatter Answers communities

booleanenableInlinePublisher

(true) or not (false). Also, adds Title and Body fields to

questions for easier text input and scanning. This field is available in API

version 29.0 and later.

Indicates whether reputations display for users as hover text on their

profile pictures (true) or not (false). Reputation is enabled across

booleanenableReputation

all zones. To enable the reputation setting, you must enable Reputation

in your organization.

Indicates whether the rich text editor is enabled for users to format text

and upload images when posting questions (true) or not (false).

To enable rich text editor, you must enable Optimize Question Flow.

booleanenableRichTextEditor

The name of an existing Facebook authentication provider. You must

choose a Facebook authentication provider to implement Facebook

Single Sign On for your Chatter Answers communities.

stringfacebookAuthProvider

Indicates whether Chatter Answers can be added as a tab to your

Customer portal or partner portal (true) or not (false).

booleanshowInPortals

Declarative Metadata Sample Definition

The following is an example chatteranswers.settings metadata file:

<?xml version="1.0" encoding="UTF-8"?>

<facebookAuthProvider>FacebookAuthProvider</facebookAuthProvider>

</ChatterAnswersSettings>

The following is an example package.xml manifest that references the ChatterAnswersSettings definitions:

<?xml version="1.0" encoding="UTF-8"?>

579

ChatterAnswersSettingsMetadata Types

<types>

<members>ChatterAnswers</members>

<name>Settings</name>

</types>

</Package>

SEE ALSO:

Settings

CompanySettings

Represents global settings that affect multiple features in your organization.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

Declarative Metadata File Suffix and Directory Location

CompanySettings values are stored in a single file named Company.settings in the settings directory of the corresponding

package directory. The .settings files are different from other named components because there is only one settings file for each

settings component.

Version

Company Profile Settings are available in API version 27.0 and later.

Fields

DescriptionField TypeField Name

The organization’s fiscal year setting based on year and start

month. Not available if Custom Fiscal Year or Forecasts (Classic)

FiscalYearSettingfiscalYear

is enabled. When changing fiscal year settings, quotas and

adjustments can be purged. For example changing your start

month results in purging this data.

FiscalYearSetting

Represents your organization’s fiscal year setting.

DescriptionField TypeField

This field is used to determine the fiscal year name. Valid values

are endingMonth or startingMonth. For example, if

stringfiscalYearNameBasedOn

your fiscal year starts in April 2012 and ends in March 2013, and

this value is:

•endingMonth, then 2013 is used for the fiscal year name.

580

CompanySettingsMetadata Types

DescriptionField TypeField

•startingMonth, then 2012 is used for the fiscal year

name.

The month on which the fiscal year is based.stringstartMonth

Declarative Metadata Sample Definition — Fiscal Year Setting

A sample XML definition of a fiscal year setting is shown below. Note that this example is supported in API version 27.0 and later.

<?xml version="1.0" encoding="UTF-8"?>

<fiscalYearNameBasedOn>endingMonth</fiscalYearNameBasedOn>

<startMonth>January</startMonth>

</fiscalYear>

</CompanySettings>

SEE ALSO:

Settings

ContractSettings

Represents contract settings. For more information, see “Customize Contracts” in the Salesforce online help.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

There is one contract settings file stored in a file named Contract.settings in the settings directory. The .settings

files are different from other named components because there is only one settings file for each settings component.

Version

ContractSettings is available in API version 27.0 and later.

Fields

DescriptionField TypeField Name

Indicates whether the end date of a contract is automatically calculated

(true) or not (false).

booleanautoCalculateEndDate

Indicates whether account and contract owners are automatically sent

email notifications when a contract expires (true) or not (false).

booleannotifyOwnersOnContractExpiration

581

ContractSettingsMetadata Types

Declarative Metadata Sample Definition

This is a sample contract settings file.

<?xml version="1.0" encoding="UTF-8"?>

<notifyOwnersOnContractExpiration>false</notifyOwnersOnContractExpiration>

</ContractSettings>

SEE ALSO:

Settings

EntitlementSettings

Represents an organization’s entitlement settings.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

EntitlementSettings values are stored in the Entitlements.settings file in the settings directory. The .settings files

are different from other named components because there is only one settings file for each settings component.

Version

EntitlementSettings is available in API version 27.0 and later.

Fields

DescriptionField TypeField Name

Indicates whether entitlements-related lookup filters on

cases return only the assets related to the active

entitlements on the case’s account (true) or not (false).

booleanassetLookupLimitedToActiveEntitlementsOnAccount

Indicates whether entitlements-related lookup filters on

cases return only the assets related to the active

entitlements on the case’s contact (true) or not (false).

booleanassetLookupLimitedToActiveEntitlementsOnContact

Indicates whether entitlements-related lookup filters on

cases return only the assets related to the case’s account

(true) or not (false).

booleanassetLookupLimitedToSameAccount

Indicates whether entitlements-related lookup filters on

cases return only the assets related to the case’s contact

(true) or not (false).

booleanassetLookupLimitedToSameContact

Indicates whether entitlements are enabled (true) or not

(false).

booleanenableEntitlements

582

EntitlementSettingsMetadata Types

DescriptionField TypeField Name

Indicates whether entitlement versioning is enabled

(true) or not (false).

This field is available in API version 28.0 and later.

booleanenableEntitlementVersioning

Indicates whether entitlements-related lookup filters on

cases return only active entitlements (true) or not

(false).

booleanentitlementLookupLimitedToActiveStatus

Indicates whether entitlements-related lookup filters on

cases return only the entitlements related to the case’s

account (true) or not (false).

booleanentitlementLookupLimitedToSameAccount

Indicates whether entitlements-related lookup filters on

cases return only the entitlements related to the case’s

asset (true) or not (false).

booleanentitlementLookupLimitedToSameAsset

Indicates whether entitlements-related lookup filters on

cases return only the entitlements related to the case’s

contact (true) or not (false).

booleanentitlementLookupLimitedToSameContact

Declarative Metadata Sample Definition

This is a sample entitlements settings file.

<?xml version="1.0" encoding="UTF-8"?>

false

</assetLookupLimitedToActiveEntitlementsOnAccount>

false

</assetLookupLimitedToActiveEntitlementsOnContact>

false

</assetLookupLimitedToSameAccount>

false

</assetLookupLimitedToSameContact>

true

</enableEntitlements>

false

</entitlementLookupLimitedToActiveStatus>

false

</entitlementLookupLimitedToSameAccount>

false

</entitlementLookupLimitedToSameAsset>

583

EntitlementSettingsMetadata Types

false

</entitlementLookupLimitedToSameContact>

</EntitlementSettings>

SEE ALSO:

Settings

FileUploadAndDownloadSecuritySettings

Represents the security settings for uploading and downloading files. This type extends the Metadata metadata type and inherits its

fullName field.

File Suffix and Directory Location

FileUploadAndDownloadSecuritySettings components have the suffix .settings and are stored in the settings folder.

Version

FileUploadAndDownloadSecuritySettings components are available in API version 39.0 and later.

Fields

DescriptionField TypeField Name

Represents the metadata used to manage filetype behavior.

This field is available in API version 39.0 and later.

FileTypeDispositionAssignmentBean[]dispositions

Indicates whether to allow HTML uploads as attachments or

document records. This field is available in API version 39.0 and

later.

booleannoHtmlUploadAsAttachment

FileTypeDispositionAssignmentBean

Represents the metadata used to manage filetype behavior.

DescriptionField TypeField Name

One of the following values:FileDownloadBehavior

(enumeration of type string)

behavior

•DOWNLOAD

•EXECUTE

•HYBRID

The following filetypes are a security risk and can not have EXECUTE

behavior:

•EXE

•FLASH

584

FileUploadAndDownloadSecuritySettingsMetadata Types

DescriptionField TypeField Name

•HTML

•RFC822

•SVG

•TXML

•UNKNOWN

•WEBVIEW

•XHTML

•XML

Although more filetypes exist, these are the only ones supported

by FileTypeDispositionAssignmentBean:

FileType (enumeration of type

string)

filetype

•AVI

•EXCEL

•EXCEL_X

•EXE

•FLASH

•HTML

•MOV

•MP3

•MP4

•MPEG

•PDF

•POWER_POINT

•POWER_POINT_X

•RFC822

•SVG

•TXML

•UNKNOWN

•WAV

•WEBVIEW

•WMA

•WMV

•WORD

•WORD_X

•XHTML

•XML

Indicates filetypes that cannot have behavior set to EXECUTE, due

to security risks. This field is read-only.

booleansecurityRiskFileType

585

FileUploadAndDownloadSecuritySettingsMetadata Types

Declarative Metadata Sample Definition

The following is an example of a FileUploadAndDownloadSecuritySettings component.

<behavior>HYBRID</behavior>

<securityRiskFileType>false</securityRiskFileType>

</dispositions>

<behavior>HYBRID</behavior>

<securityRiskFileType>false</securityRiskFileType>

</dispositions>

<behavior>HYBRID</behavior>

<securityRiskFileType>false</securityRiskFileType>

</dispositions>

<behavior>DOWNLOAD</behavior>

</dispositions>

<behavior>DOWNLOAD</behavior>

</dispositions>

<behavior>DOWNLOAD</behavior>

<fileType>WEBVIEW</fileType>

</dispositions>

<behavior>DOWNLOAD</behavior>

</dispositions>

<behavior>HYBRID</behavior>

<securityRiskFileType>false</securityRiskFileType>

</dispositions>

<behavior>HYBRID</behavior>

<securityRiskFileType>false</securityRiskFileType>

</dispositions>

<behavior>HYBRID</behavior>

<securityRiskFileType>false</securityRiskFileType>

</dispositions>

586

FileUploadAndDownloadSecuritySettingsMetadata Types

<behavior>HYBRID</behavior>

<securityRiskFileType>false</securityRiskFileType>

</dispositions>

<behavior>HYBRID</behavior>

<securityRiskFileType>false</securityRiskFileType>

</dispositions>

<behavior>HYBRID</behavior>

<fileType>POWER_POINT</fileType>

<securityRiskFileType>false</securityRiskFileType>

</dispositions>

<behavior>HYBRID</behavior>

<fileType>POWER_POINT_X</fileType>

<securityRiskFileType>false</securityRiskFileType>

</dispositions>

<behavior>DOWNLOAD</behavior>

</dispositions>

<behavior>DOWNLOAD</behavior>

<fileType>FLASH</fileType>

</dispositions>

<behavior>DOWNLOAD</behavior>

</dispositions>

<behavior>DOWNLOAD</behavior>

<fileType>UNKNOWN</fileType>

</dispositions>

<behavior>HYBRID</behavior>

<securityRiskFileType>false</securityRiskFileType>

</dispositions>

<behavior>HYBRID</behavior>

<securityRiskFileType>false</securityRiskFileType>

</dispositions>

<behavior>HYBRID</behavior>

<securityRiskFileType>false</securityRiskFileType>

587

FileUploadAndDownloadSecuritySettingsMetadata Types

</dispositions>

<behavior>DOWNLOAD</behavior>

<fileType>XHTML</fileType>

</dispositions>

<behavior>HYBRID</behavior>

<fileType>EXCEL</fileType>

<securityRiskFileType>false</securityRiskFileType>

</dispositions>

<behavior>HYBRID</behavior>

<fileType>EXCEL_X</fileType>

<securityRiskFileType>false</securityRiskFileType>

</dispositions>

<behavior>DOWNLOAD</behavior>

</dispositions>

<noHtmlUploadAsAttachment>false</noHtmlUploadAsAttachment>

</FileUploadAndDownloadSecuritySettings>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>FileUploadAndDownloadSecurity</members>

<name>Settings</name>

</types>

</Package>

ForecastingSettings

Represents the Collaborative Forecasts settings options. This type extends the Metadata metadata type and inherits its fullName

field.

Note: This information only applies to Collaborative Forecasts.

File Suffix and Directory Location

ForecastingSettings values are stored in a single file named Forecasting.settings in the settings directory of the

corresponding package directory. The .settings files are different from other named components because there is only one settings

file for each settings component.

Version

ForecastingSettings components are available in API version 28 and later. The structure of the ForecastingSettings type changed

significantly in API version 30.0.

588

ForecastingSettingsMetadata Types

Fields

DescriptionField TypeField Name

The currency for displaying forecasts; either the organization's corporate

currency or each forecast owner's personal currency setting. This is the

DisplayCurrency

(enumeration of

type string)

displayCurrency

default currency used in Collaborative Forecasts and selected in setup.

The selection must be one of the currencies enabled for use in the

organization, and only one selection is allowed. The default is

Corporate. The valid values are:

•Corporate

•Personal

Indicates if Collaborative Forecasts is enabled or not. Set to true to

enable Collaborative Forecasts and false to disable the functionality.

booleanenableForecasts

Warning: Disabling Forecasts can result in data loss. Refer to

the online Help before disabling any functionality.

A list of forecast types. For field values, see ForecastingTypeSettings. The

maximum number of forecast types is four.

ForecastingType

Settings[]

forecastingTypeSettings

A list of mappings associating forecast types with forecast rollups.ForecastingCategoryMappings[]forecastingCategoryMappings

ForecastingTypeSettings

The settings for each forecast type. An organization can have up to 4 forecast types active. Omitting a previously enabled forecast type

that has a minimum API version less than or equal to the metadata package version deletes its quota and adjustment data from the

organization.

Warning: Omitting a forecast type field from the XML can deactivate that forecast type: if the forecast type was available in the

release specified by the XML package version, that forecast type is deactivated and its quota and adjustment data are deleted.

DescriptionField TypeField Name

This indicates whether the forecast type specified in the name field is

active.

booleanactive

Note: Setting the active field to false purges all forecasting

data, adjustments, and quotas for the forecast type. When

active is set to true, some values on the Forecasts tab may

not appear immediately. An in-process icon appears to indicate

that the values are being calculated.

This enables or disables the Forecasts adjustments option in Forecasts.AdjustmentsSettingsadjustmentsSettings

The default periods and range selections in Collaborative Forecasts.ForecastRangeSettingsforecastRangeSettings

The name of the forecast type. Each forecast type requires a specific

string.

Valid values include:

stringname

589

ForecastingSettingsMetadata Types

DescriptionField TypeField Name

•OpportunityRevenue : Opportunities - Revenue

•OpportunityQuantity : Opportunities - Quantity

•OpportunitySplitRevenue : Opportunity Revenue Splits -

Revenue

•OpportunityOverlayRevenue : Opportunity Overlay Splits

- Revenue

•OpportunityLineItemRevenue : Product Families -

Revenue

•OpportunityLineItemQuantity : Product Families -

Quantity

•The name of a custom opportunity split type that has been enabled

as a forecast type. Custom split types are based on currency fields,

which can contain revenue amounts only.

A read-only list of the API names and UI labels for all fields on the

Opportunity object.

OpportunityListFieldsLabelMappingsopportunityListFieldsLabelMappings

The fields selected to appear in the opportunity pane of the forecast

page for the forecast type. Opportunity Name is required. You

can select up to 15 fields.

OpportunityListFields

SelectedSettings

opportunityListFields

SelectedSettings

The fields not selected to appear in the opportunity pane of the forecast

page for the forecast type.

OpportunityListFields

UnselectedSettings

opportunityListFields

UnselectedSettings

This enables or disables the quota option in Forecasts.QuotasSettingsquotasSettings

This field appears four times to specify the four forecast rollup categories

used in the organization, for either cumulative forecast rollups, or

individual forecast category rollups.

Valid values for organizations using cumulative forecast rollups:

stringforecastedCategoryApiNames

•openpipeline

•bestcaseforecast

•commitforecast

•closedonly

Valid values for organizations using individual forecast category rollups:

•pipelineonly

•bestcaseonly

•commitonly

•closedonly

Changing from one set of four values to the other changes the

organization setting for Enable Cumulative Forecast Rollups in Setup. If

this field is omitted, the setting is not changed.

590

ForecastingSettingsMetadata Types

DescriptionField TypeField Name

This read-only field indicates whether the forecast type is based on

revenue amounts. The value of isAmount is always the opposite of

the value of isQuantity.

booleanisAmount

This read-only field indicates whether the forecast type can currently be

used in the organization. For example, the revenue splits forecast type

booleanisAvailable

can’t be used in an organization that doesn’t have Opportunity Splits

enabled.

This read-only field indicates whether the forecast type is based on

product quantities. The value of isQuantity is always the opposite

of the value of isAmount.

booleanisQuantity

This read-only field appears four times to specify the four forecast rollup

categories displayed in the Forecasts tab, for either cumulative forecast

stringdisplayedCategoryApiNames

rollups, or individual forecast category rollups. Always use the same 4

values for both displayedCategoryApiNames and

forecastedCategoryApiNames.

Valid values for organizations using cumulative forecast rollups:

•openpipeline

•bestcaseforecast

•commitforecast

•closedonly

Valid values for organizations using individual forecast category rollups:

•pipelineonly

•bestcaseonly

•commitonly

•closedonly

This read-only field appears twice to specify the two forecast rollup

categories that forecast managers can adjust in the organization for

stringmanagerAdjustableCategoryApiNames

either cumulative forecast rollups or individual forecast category rollups.

This field can only be used when the enableAdjustments field

contains a value of true. If both the

managerAdjustableCategoryApiNames and

ownerAdjustableCategoryApiNames fields are being used,

they must contain the same two values. Their values must also be

consistent with the values of the enableAdjustments and

enableOwnerAdjustments fields.

Valid values for organizations using cumulative forecast rollups:

•bestcaseforecast

•commitforecast

Valid values for organizations using individual forecast category rollups:

•bestcaseonly

591

ForecastingSettingsMetadata Types

DescriptionField TypeField Name

•commitonly

This read-only field indicates the UI label for the forecast type.stringmasterLabel

This read-only field appears twice to specify the two forecast rollup

categories that forecast owners can adjust in the organization, for either

stringownerAdjustableCategoryApiNames

cumulative forecast rollups, or individual forecast category rollups. This

field can only be used when the enableOwnerAdjustments field

contains a value of true. If both the

managerAdjustableCategoryApiNames and

ownerAdjustableCategoryApiNames fields are being used,

they must contain the same two values. Their values must also be

consistent with the values of the enableAdjustments and

enableOwnerAdjustments fields.

Valid values for organizations using cumulative forecast rollups:

•bestcaseforecast

•commitforecast

Valid values for organizations using individual forecast category rollups:

•bestcaseonly

•commitonly

AdjustmentsSettings

The adjustment options for Collaborative Forecasts.

DescriptionField TypeField

Set to true to enable Collaborative Forecasts manager

adjustments and false to disable them. All forecast types

must contain the same enableAdjustments value.

booleanenableAdjustments

Warning: Disabling adjustments results in Collaborative

Forecasts adjustment data being purged.

Set to true to enable Collaborative Forecasts owner

adjustments and false to disable them. All forecast types

must contain the same enableAdjustments value.

booleanenableOwnerAdjustments

Warning: Disabling adjustments results in Collaborative

Forecasts adjustment data being purged.

ForecastRangeSettings

The default periods and range selections in Collaborative Forecasts. Users can forecast up to 12 months or eight quarters in the future

or past. If your forecast range includes the current month or quarter, the forecasts page displays the current month or quarter by default.

592

ForecastingSettingsMetadata Types

If not, the first month or quarter of the range is selected. All forecast types must contain the same forecastRangeSettings field

values.

Warning: If you change the time period from monthly to quarterly or quarterly to monthly, or you change the standard fiscal

year, all adjustments and quotas are purged. If you enable custom fiscal years, creating the first custom fiscal year deletes any

quotas and adjustments in the corresponding and subsequent standard fiscal years. These changes trigger a forecast recalculation

that can take significant time, depending on the quantity of your data.

DescriptionField TypeField

Indicates the beginning month or quarter to display by default.intbeginning

Indicates the number of months or quarters to display by default.

The maximum number of months is 12 and quarters is 8.

intdisplaying

Indicates what type of period to use. Valid values are:PeriodTypes (enumeration of

type string)

periodType

•Month

•Quarter

OpportunityListFieldsLabelMappings

A read-only list of the API names and UI labels for all fields on the Opportunity object.

DescriptionField TypeField

The API name of the Opportunity field.stringfield

The UI label of the Opportunity field.stringlabel

OpportunityListFieldsSelectedSettings

The fields selected to appear in the opportunity pane of the forecast page for the forecast type. Opportunity Name is required.

You can select up to 15 fields.

DescriptionField TypeField

Specifies names of fields to display in the opportunity pane.stringfield

OpportunityListFieldsUnselectedSettings

The fields not selected to appear in the opportunity pane of the forecast page for the forecast type.

DescriptionField TypeField

Specifies names of fields not displayed in the opportunity pane.stringfield

QuotasSettings

QuotasSettings indicates if quotas are available in Collaborative Forecasts.

593

ForecastingSettingsMetadata Types

DescriptionField TypeField

Set to true to enable quotas. All forecast types must contain

the same showQuotas field value.

booleanshowQuotas

ForecastingCategoryMappings

The forecasting category mappings for Collaborative Forecasts. This subtype appears eight times within the ForecastingSettings

type. Each occurrence includes fields that specify a type of forecast category rollup, which forecast categories each rollup includes, and

the weight of each forecast category in the rollup. Organizations using either cumulative forecast rollups or individual forecast category

columns must include all eight occurrences of this subtype.

DescriptionField TypeField

This field specifies the API name of the rollup type. The valid

values are:

stringforecastingItemCategoryApiName

•openpipeline

•bestcaseforecast

•commitforecast

•pipelineonly

•bestcaseonly

•commitonly

•closedonly

•omittedonly

This field can occur more than once when specifying more than

one forecast category to include in the rollup type. Each

WeightedSourceCategories[]weightedSourceCategories

occurrence contains two subfields that specify a forecast

category to include in the forecast rollup type and its weight.

Some rollup types include more than one forecast category. This

list shows the forecast categories that are included in each rollup

type.

•Rollup: openpipeline, Forecast categories: pipeline, best

case, commit

•Rollup: bestcaseforecast, Forecast categories: best case,

commit, closed

•Rollup: commitforecast, Forecast categories: commit, closed

•Rollup: pipelineonly, Forecast categories: pipeline

•Rollup: bestcaseonly, Forecast categories: best case

•Rollup: commitonly, Forecast categories: commit

•Rollup: closedonly, Forecast categories: closed

•Rollup: omittedonly, Forecast categories: omitted

594

ForecastingSettingsMetadata Types

WeightedSourceCategories

This field can occur more than once when specifying more than one forecast category to include in the rollup type. Each occurrence

contains two subfields that specify a forecast category to include in the forecast rollup type and its weight. Some rollup types include

more than one forecast category. This table shows the forecast categories that are included in each rollup type.

DescriptionField TypeField

Specifies the API name of a forecast category to include in the

rollup type. The valid values are.

stringsourceCategoryApiName

•pipeline

•best case

•commit

•closed

•omitted

Specifies the weight given to the forecast category when

calculating the forecast for the rollup type. The only supported

value is 1.0.

doubleweight

Declarative Metadata Sample Definition

The following is an example of a ForecastingSettings component that enables the Opportunity-Revenue and Product Family-Quantity

forecast types:

<?xml version="1.0" encoding="UTF-8"?>

</adjustmentsSettings>

<name>OpportunityRevenue</name>

<periodType>Month</periodType>

</forecastRangeSettings>

<field>OPPORTUNITY.NAME</field>

</opportunityListFieldsSelectedSettings>

</quotasSettings>

</forecastingTypeSettings>

<active>false</active>

595

ForecastingSettingsMetadata Types

</adjustmentsSettings>

<name>OpportunityLineItemQuantity</name>

<periodType>Month</periodType>

</forecastRangeSettings>

<field>OPPORTUNITY.NAME</field>

</opportunityListFieldsSelectedSettings>

</quotasSettings>

<displayedCategoryApiNames>pipelineonly</displayedCategoryApiNames>

<displayedCategoryApiNames>bestcaseonly</displayedCategoryApiNames>

<displayedCategoryApiNames>commitonly</displayedCategoryApiNames>

<displayedCategoryApiNames>closedonly</displayedCategoryApiNames>

<forecastedCategoryApiNames>commitonly</forecastedCategoryApiNames>

<forecastedCategoryApiNames>closedonly</forecastedCategoryApiNames>

<forecastedCategoryApiNames>bestcaseonly</forecastedCategoryApiNames>

<forecastedCategoryApiNames>pipelineonly</forecastedCategoryApiNames>

<managerAdjustableCategoryApiNames>commitonly</managerAdjustableCategoryApiNames>

<managerAdjustableCategoryApiNames>bestcaseonly</managerAdjustableCategoryApiNames>

<ownerAdjustableCategoryApiNames>commitonly</ownerAdjustableCategoryApiNames>

<ownerAdjustableCategoryApiNames>bestcaseonly</ownerAdjustableCategoryApiNames>

</forecastingTypeSettings>

<forecastingItemCategoryApiName>commitonly</forecastingItemCategoryApiName>

<sourceCategoryApiName>commit</sourceCategoryApiName>

</weightedSourceCategories>

</forecastingCategoryMappings>

<forecastingItemCategoryApiName>closedonly</forecastingItemCategoryApiName>

<sourceCategoryApiName>closed</sourceCategoryApiName>

</weightedSourceCategories>

</forecastingCategoryMappings>

<forecastingItemCategoryApiName>bestcaseforecast</forecastingItemCategoryApiName>

<sourceCategoryApiName>commit</sourceCategoryApiName>

</weightedSourceCategories>

</weightedSourceCategories>

596

ForecastingSettingsMetadata Types

<sourceCategoryApiName>closed</sourceCategoryApiName>

</weightedSourceCategories>

</forecastingCategoryMappings>

<forecastingItemCategoryApiName>omittedonly</forecastingItemCategoryApiName>

<sourceCategoryApiName>omitted</sourceCategoryApiName>

</weightedSourceCategories>

</forecastingCategoryMappings>

<forecastingItemCategoryApiName>openpipeline</forecastingItemCategoryApiName>

<sourceCategoryApiName>commit</sourceCategoryApiName>

</weightedSourceCategories>

</weightedSourceCategories>

<sourceCategoryApiName>pipeline</sourceCategoryApiName>

</weightedSourceCategories>

</forecastingCategoryMappings>

<forecastingItemCategoryApiName>bestcaseonly</forecastingItemCategoryApiName>

</weightedSourceCategories>

</forecastingCategoryMappings>

<forecastingItemCategoryApiName>commitforecast</forecastingItemCategoryApiName>

<sourceCategoryApiName>closed</sourceCategoryApiName>

</weightedSourceCategories>

<sourceCategoryApiName>commit</sourceCategoryApiName>

</weightedSourceCategories>

</forecastingCategoryMappings>

<forecastingItemCategoryApiName>pipelineonly</forecastingItemCategoryApiName>

<sourceCategoryApiName>pipeline</sourceCategoryApiName>

597

ForecastingSettingsMetadata Types

</weightedSourceCategories>

</forecastingCategoryMappings>

SEE ALSO:

Settings

IdeasSettings

Represents the metadata used to manage settings for Ideas.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

IdeasSettings is stored in one file named Ideas.settings in the settings folder of the corresponding package directory. The

.settings files are different from other named components because there is only one settings file for each settings component.

Version

IdeasSettings is available in API version 27.0 and later.

Ideas

Represents settings for Ideas and Idea Themes.

Fields

DescriptionField TypeField Name

Indicates whether Idea Themes is enabled (true) or not (false).booleanenableIdeaThemes

Indicates whether Ideas is enabled (true) or not (false).booleanenableIdeas

Indicates whether Reputation is enabled (true) or not (false). You

can’t enable IdeasReputation without enabling the Ideas Reputation

booleanenableIdeasReputation

permission in your organization. This field is available in API version 28.0

and later.

Indicates that the Chatter user profile is used for Ideas user profiles. If

enableChatterProfile is true, the ideasProfilePage

booleanenableChatterProfile

value must not be specified. If enableChatterProfile is false,

then specify a ideasProfilePage value, otherwise the Ideas zone

profile is used. This field is available in API version 29.0 and later.

The name of the Visualforce page to use for a custom Ideas user profile,

if enableChatterProfile is false. If

stringideasProfilePage

enableChatterProfile is false, then specify a

ideasProfilePage value, otherwise the Ideas zone profile is used.

This field is available in API version 29.0 and later.

598

IdeasSettingsMetadata Types

DescriptionField TypeField Name

Indicates how quickly old ideas drop in ranking on the Popular Ideas

subtab. The half-life setting determines how the number of days after

doublehalfLife

which old ideas drop in ranking on the Popular Ideas subtab, to make

room for ideas with more recent votes. A shorter half-life moves older

ideas down the page faster than a longer half-life.

Declarative Metadata Sample Definition

The following is an example ideas.settings metadata file:

<?xml version="1.0" encoding="UTF-8"?>

<enableChatterProfile>false</enableChatterProfile>

<ideasProfilePage>name of Visualforce page</ideasProfilePage>

</IdeasSettings>

SEE ALSO:

Settings

KnowledgeSettings

Represents the metadata used to manage settings for Salesforce Knowledge.

This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

KnowledgeSettings values are stored in a single file named Knowledge.settings in the settings directory. The .settings

files are different from other named components because there is only one settings file for each settings component.

Version

KnowledgeSettings is available in API version 27.0 and later.

Fields

DescriptionField TypeField Name

Represents the metadata used to manage settings

for Salesforce Knowledge and Answers.

KnowledgeAnswerSettingsanswers

599

KnowledgeSettingsMetadata Types

DescriptionField TypeField Name

Represents the metadata used to manage settings

for Salesforce Knowledge and Cases.

KnowledgeCaseSettingscases

Required. The default language for Salesforce

Knowledge. Use the abbreviation for the

stringdefaultLanguage

language, for example, en_US for United States

English.

A list of languages enabled for Salesforce

Knowledge.

KnowledgeLanguageSettingslanguages

Indicates whether tracking for case deflection via

Chatter is enabled (true) or not (false).

booleanenableChatterQuestionKBDeflection

Indicates whether users can create and edit

articles on the articles tab (true) or not

(false).

booleanenableCreateEditOnArticlesTab

Indicates whether connecting to external media

is enabled (true) or not (false).

booleanenableExternalMediaContent

Indicates whetherSalesforce Knowledge is

enabled (true) or not (false).

booleanenableKnowledge

Indicates whether article summaries appear in

the Customer Portal (true) or not (false).

booleanshowArticleSummariesCustomerPortal

Indicates whether article summaries appear in

the internal knowledge base (true) or not

(false).

booleanshowArticleSummariesInternalApp

Indicates whether article summaries appear in

the partner portal (true) or not (false).

booleanshowArticleSummariesPartnerPortal

Indicates whether validation status appears on

articles (true) or not (false).

booleanshowValidationStatusField

Represents the metadata used to manage settings

for the case fields used to suggest articles for

cases. Available in API version 37.0 and later.

KnowledgeSuggestedArticlesSettingssuggestedArticles

KnowledgeAnswerSettings

Represents the metadata used to manage settings for Salesforce Knowledge and Answers.

DescriptionField TypeField Name

Specifies the username an article is assigned to from Answers.stringassignTo

The default article type for articles created from Answers. Uses the API

name of the article type.

stringdefaultArticleType

600

KnowledgeSettingsMetadata Types

DescriptionField TypeField Name

Indicates whether users can create articles from Answers (true) or not

(false).

booleanenableArticleCreation

KnowledgeCaseField

Represents the name of the case field used to suggest articles for the case. Available in API version 37.0 and later.

DescriptionField TypeField Name

Specifies the name of the case field used to suggest

articles for the case.

stringname

KnowledgeCaseFieldsSettings

Represents a list of the case fields used to suggest articles for the case. Available in API version 37.0 and later.

DescriptionField TypeField Name

Specifies the names of the case fields used to suggest

articles for the case.

KnowledgeCaseField[]field

KnowledgeWorkOrderField

Represents the name of the work order field used to suggest articles for the work order. Available in API version 39.0 and later.

DescriptionField TypeField Name

Specifies the name of the work order field used to

suggest articles for the work order.

stringname

KnowledgeWorkOrderFieldsSettings

Represents a list of the work order fields used to suggest articles for the work order. Available in API version 39.0 and later.

DescriptionField TypeField Name

Specifies the names of the work order fields used to

suggest articles for the work order.

KnowledgeWorkOrderField[]field

KnowledgeWorkOrderLineItemField

Represents the name of the work order line item field used to suggest articles for the work order line item. Available in API version 39.0

and later.

601

KnowledgeSettingsMetadata Types

DescriptionField TypeField Name

Specifies the name of the work order line item field

used to suggest articles for the work order line item.

stringname

KnowledgeWorkOrderLineItemFieldsSettings

Represents a list of the work order line item fields used to suggest articles for the work order line item. Available in API version 39.0 and

later.

DescriptionField TypeField Name

Specifies the names of the work order line item fields

used to suggest articles for the work order line item.

KnowledgeWorkOrderLineItemField[]field

KnowledgeSuggestedArticlesSettings

Represents the metadata used to manage settings for the articles suggested for cases, work orders, and work order line items.

DescriptionField TypeField Name

Represents a list of the case fields used to suggest

articles for the case.

KnowledgeCaseFieldsSettingscaseFields

Indicates whether case content is used to suggest

articles for cases (true) or not (false).

booleanuseSuggestedArticlesForCase

Represents a list of the work order fields used to

suggest articles for the work order.

KnowledgeWorkOrderFieldsSettingsworkOrderFields

Represents a list of the work order line item fields used

to suggest articles for the work order line item.

KnowledgeWorkOrderLineItemFieldsSettingsworkOrderLineItemFields

KnowledgeCaseSettings

Represents the metadata used to manage settings for Salesforce Knowledge and Cases.

DescriptionField TypeField Name

The profile used to create a PDF of an article from

Cases.

stringarticlePDFCreationProfile

Represents the metadata used to manage settings

for Salesforce Knowledge and Sites.

KnowledgeSitesSettingsarticlePublicSharingSites

Represents the metadata used to manage settings

for Salesforce Knowledge and Communities.

KnowledgeSitesSettingsarticlePublicSharingCommunities

Represents the metadata used to manage settings

for Salesforce Knowledge and Sites with Chatter

Answers.

KnowledgeSitesSettingsarticlePublicSharingSitesChatterAnswers

602

KnowledgeSettingsMetadata Types

DescriptionField TypeField Name

Specifies the username an article is assigned to from

Cases.

stringassignTo

Specifies the Apex class used for customization.stringcustomizationClass

The default article type for articles created from

Cases.

stringdefaultContributionArticleType

Indicates the rich text editor type. Valid values are:KnowledgeCaseEditor

(enumeration of type string)

editor

•simple

•standard

Indicates whether users can create articles from

Cases (true) or not (false). Controls whether

other fields on KnowledgeCaseSettings can be set.

booleanenableArticleCreation

Indicates whether articles can be shared via a public

site (URL) from Cases (true) or not (false).

booleanenableArticlePublicSharingSites

Indicates whether a profile is used to create a PDF

of an article from Cases (true) or not (false).

booleanuseProfileForPDFCreation

KnowledgeSitesSettings

Represents the metadata used to manage settings for Salesforce Knowledge and Sites.

DescriptionField TypeField Name

Specifies the site used for Salesforce Knowledge and Sites.string[]site

KnowledgeLanguageSettings

A list of languages enabled for Salesforce Knowledge. KnowledgeLanguageSettings is available in API version 28.0 and later.

DescriptionField TypeField Name

Represents the metadata used to manage settings for

the languages enabled for Salesforce Knowledge.

KnowledgeLanguagelanguage

KnowledgeLanguage

Represents the metadata used to manage settings for the languages enabled for Salesforce Knowledge. KnowledgeLanguage is available

in API version 28.0 and later.

DescriptionField TypeField Name

Indicates whether the language is enabled (true) or

not (false).

booleanactive

603

KnowledgeSettingsMetadata Types

DescriptionField TypeField Name

The default assignee for articles in the language.stringdefaultAssignee

Indicates the default assignee type. Valid values are:KnowledgeLanguageLookupValueType

(enumeration of type string)

defaultAssigneeType

•user

•queue

The default reviewer for articles in the language.stringdefaultReviewer

Indicates the default reviewer type. Valid values are:KnowledgeLanguageLookupValueType

(enumeration of type string)

defaultReviewerType

•user

•queue

The code for the language name, for example: English

is en. See “What languages does Salesforce support?”

stringname

in the Salesforce online help for a list of supported

languages and their codes.

Declarative Metadata Sample Definition

This is a sample Knowledge settings file.

<?xml version="1.0" encoding="UTF-8"?>

<enableArticleCreation>false</enableArticleCreation>

</answers>

<cases>

<articlePDFCreationProfile>partner portal knowledge

profile</articlePDFCreationProfile>

<site>KnowledgeSite</site>

<site>ChatterAnswersSite</site>

</articlePublicSharingSites>

<site>ChatterAnswersSite</site>

</articlePublicSharingSitesChatterAnswers>

<assignTo>testall@kb.org</assignTo>

<defaultContributionArticleType>Support</defaultContributionArticleType>

<editor>simple</editor>

</cases>

604

KnowledgeSettingsMetadata Types

<field>

<name>Subject</name>

</field>

<field>

<name>SuppliedEmail</name>

</field>

</caseFields>

</suggestedArticles>

</KnowledgeSettings>

SEE ALSO:

Settings

LeadConvertSettings

Represents an organization’s custom field mappings for lead conversion. Custom fields can be mapped from Leads to Accounts, Contacts,

and Opportunities. Options for creating opportunities during lead conversion can also be specified. This type extends the Metadata

metadata type and inherits its fullName field.

Version

LeadConvertSettings is available in API versions 39.0 and later.

Fields

DescriptionField TypeField Name

Indicates whether to include the RecordOwner field in the Convert Lead

dialog box (true) or not (false).

booleanallowOwnerChange

A set of inputObject, mappingFields, and outputObject

entries. Up to three objectMapping types can be declared—one

each for Account, Contact, and Opportunity.

metadata typeobjectMapping

The name of the object type containing the source fields for mapping.

The value will always be Lead.

stringinputObject

A set of inputField and outputField entries.metadata typemappingFields

The name of a custom lead field supplying source data during lead

conversion.

stringinputField

The name of a custom account, contact, or opportunity field that will

receive data from source field named in the accompanying

inputField entry.

stringoutputField

605

LeadConvertSettingsMetadata Types

DescriptionField TypeField Name

The name of the object type receiving data during lead

conversion—Account, Contact, or Opportunity.

stringoutputObject

This optional field determines whether the Opportunity field is visible

or required in the Convert Lead dialog box. Valid values include:

stringopportunityCreationOptions

•VisibleOptional—The Opportunity field is included in the

dialog box but not required. A new opportunity is created if the user

enters an opportunity name. This is the default value.

•VisibleRequired—The Opportunity field is included in the

dialog box and is required. A new opportunity is created based on

the name entered by the user.

•NotVisible—The Opportunity field is not included in the dialog

box. No opportunity is created.

Declarative Metadata Sample Definition

The following is an example of the LeadConvertSettings type:

<?xml version="1.0" encoding="UTF-8"?>

<allowOwnerChange>false</allowOwnerChange>

<inputField>custom_lead_field_1</inputField>

<outputField>custom_account_field_1</outputField>

</mappingFields>

<inputField>custom_lead_field_2</inputField>

<outputField>custom_account_field_2</outputField>

</mappingFields>

<inputField>custom_lead_field_3</inputField>

<outputField>custom_account_field_3</outputField>

</mappingFields>

<outputObject>Account</outputObject>

</objectMapping>

<inputField>custom_lead_field_4</inputField>

<outputField>custom_opportunity_field_1</outputField>

</mappingFields>

<outputObject>Opportunity</outputObject>

</objectMapping>

<opportunityCreationOptions>VisibleOptional</opportunityCreationOptions>

</LeadConvertSettings>

606

LeadConvertSettingsMetadata Types

LiveAgentSettings

Represents an organization’s Live Agent settings, such as whether or not Live Agent is enabled. This type extends the Metadata metadata

type and inherits its fullName field.

File Suffix and Directory Location

LiveAgentSettings values are stored in the LiveAgent.settings file in the settings directory. The .settings files are

different from other named components because there is only one settings file for each settings component.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

Version

LiveAgentSettings is available in API version 28.0 and later.

Fields

DescriptionField TypeField Name

Indicates whether Live Agent is enabled (true) or not

(false).

booleanenableLiveAgent

Declarative Metadata Sample Definition

This is a sample Live Agent settings file.

<?xml version="1.0" encoding="UTF-8"?>

</LiveAgentSettings>

MobileSettings

Represents an organization’s mobile settings. For more information, see “Manage Salesforce Mobile Classic Devices” in the Salesforce

online help.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

Declarative Metadata File Suffix and Directory Location

MobileSettings values are stored in a single file named Mobile.settings in the settings directory. The .settings files

are different from other named components because there is only one settings file for each settings component.

Note: MobileSettings is no longer available in API versions 25.0 and 26.0.

Version

Mobile settings are available in API version 27.0 and later.

607

LiveAgentSettingsMetadata Types

Fields

DescriptionField TypeField

The settings for devices running Chatter

mobile.

ChatterMobileSettingschatterMobile (Deprecated)

The settings for devices running the mobile

dashboards app.

DashboardMobileSettingsdashboardMobile (Deprecated)

The settings for devices running Salesforce

Classic Mobile.

SFDCMobileSettingssalesforceMobile

The settings for devices running Salesforce

Touch.

TouchMobileSettingstouchMobile (Deprecated)

ChatterMobileSettings

These fields are deprecated. Represents your organization’s Chatter Mobile settings.

DescriptionField TypeField

Indicates whether iPad devices are enabled

for Chatter Mobile (true) or not (false).

booleanIPadAuthorized

Indicates whether iPhone devices are

enabled for Chatter Mobile (true) or not

(false).

booleanIPhoneAuthorized

Indicates whether Android devices are

enabled for Chatter Mobile (true) or not

(false).

booleanandroidAuthorized

Indicates whether Blackberry devices are

enabled for Chatter Mobile (true) or not

(false).

booleanblackBerryAuthorized

Indicates whether Chatter Mobile has been

enabled for your organization (true) or

not (false).

booleanenableChatterMobile

Note: Setting this to true enables

you to set all of the other settings. If

you change this setting from true

to false, and also try to change

any of the other ChatterMobile

settings, your deploy will fail with an

error.

Indicates whether Chatter push notifications

have been enabled for your organization

(true) or not (false)

booleanenablePushNotifications

608

MobileSettingsMetadata Types

DescriptionField TypeField

The length of time after which users without

activity are prompted to log out or continue

working. Valid values are:

MobileSessionTimeout (enumeration of type

string)

sessionTimeout

•Never

•OneMinute

•FiveMinutes

•TenMinutes

•ThirtyMinutes

DashboardMobileSettings

These fields are deprecated. Represents your organization’s Mobile Dashboards iPad app settings.

DescriptionField TypeField

Indicates whether Mobile Dashboards iPad

app has been enabled for your organization

(true) or not (false)

booleanenableDashboardIPadApp

SFDCMobileSettings

Represents your organization’s Salesforce Classic Mobile app settings.

DescriptionField TypeField

Permanently link users to their mobile

devices. Set this option to true only if you

booleanenableUserToDeviceLinking

want to prevent your users from switching

devices without administrative intervention..

Indicates whether your organization has the

free version of Salesforce Mobile Classic

enabled (true) or not (false).

Note that the free version of Salesforce

Mobile Classic is available only for orgs that

turned on this option prior to Summer ’16.

booleanenableMobileLite

TouchMobileSettings

These fields are deprecated. Salesforce Touch has been upgraded to the Salesforce1 app.

609

MobileSettingsMetadata Types

DescriptionField TypeField

Indicates whether your organization has the

Salesforce Touch mobile browser app

enabled (true) or not (false).

booleanenableTouchBrowserIPad

Indicates whether your organization has the

Salesforce Touch downloadable app

enabled (true) or not (false)

booleanenableTouchAppIPad

Declarative Metadata Sample Definition

This is a sample mobile.settings metadata file.

<?xml version="1.0" encoding="UTF-8"?>

<sessionTimeout>Never</sessionTimeout>

</chatterMobile>

</dashboardMobile>

<enableUserToDeviceLinking>false</enableUserToDeviceLinking>

<enableMobileLite>false</enableMobileLite>

</salesforceMobile>

<enableTouchBrowserIPad>false</enableTouchBrowserIPad>

</touchMobile>

</MobileSettings>

SEE ALSO:

Settings

NameSettings

Enables or disables middle name and suffix attributes for the following person objects: Contact, Lead, Person Account, and User.

File Suffix and Directory Location

NameSettings values are stored in a single file named Name.settings in the settings folder. The .settings files are

different from other named components because there is only one settings file for each settings component.

610

NameSettingsMetadata Types

Version

NameSettings components are available in API version 31.0 and later.

Fields

DescriptionField TypeField Name

Indicates whether middle names are enabled (true) or disabled

(false) for person objects.

booleanenableMiddleName

Indicates whether suffixes are enabled (true) or disabled (false) for

person objects.

booleanenableNameSuffix

Declarative Metadata Sample Definition

The following is an example of a NameSettings component.

<?xml version="1.0" encoding="UTF-8"?>

<enableNameSuffix>false</enableNameSuffix>

</NameSettings>

The following is an example package.xml manifest that references the NameSettings definitions.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>Settings</name>

</types>

</Package>

OpportunitySettings

Represents organization preferences for features such as automatic opportunity updates and similar-opportunity filters. This type extends

the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

Opportunities values are stored in a single file named Opportunity.settings in the settings directory of the corresponding

package directory. The .settings files are different from other named components because there is only one settings file for each

settings component.

Version

OpportunitySettings is available in API version 28.0 and later.

611

OpportunitySettingsMetadata Types

Fields

DescriptionField TypeField Name

Lets users enable automatic, scheduled updates on opportunities.booleanenableUpdateReminders

Automatically uses scheduled updates for new opportunities.booleanautoActivateNewReminders

Lets users see related or similar existing opportunities.booleanenableFindSimilarOpportunities

Defines parameters for similar opportunities.multipicklistfindSimilarOppFilter

Lets users associate team members with opportunities.booleanenableOpportunityTeam

Prompts users to add related products to an opportunity.booleanpromptToAddProducts

FindSimilarOppFilter

Defines whether to match by entire columns or fields.

DescriptionField TypeField

The columns to compare.stringsimilarOpportunitiesDisplayColumns

The fields to compare.stringsimilarOpportunitiesMatchFields

Declarative Metadata Sample Definition

The following is an example of the package file.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Opportunity</members>

<name>Settings</name>

</types>

</Package>

The package file references the following Opportunity.settings file.

<?xml version="1.0" encoding="UTF-8"?>

<similarOpportunitiesMatchFields>OPPORTUNITY.Account</similarOpportunitiesMatchFields>

<similarOpportunitiesMatchFields>OPPORTUNITY.OpportunityCompetitors</similarOpportunitiesMatchFields>

<similarOpportunitiesMatchFields>CustomField__c</similarOpportunitiesMatchFields>

612

OpportunitySettingsMetadata Types

<similarOpportunitiesDisplayColumns>CustomField__c</similarOpportunitiesDisplayColumns>

</findSimilarOppFilter>

<promptToAddProducts>false</promptToAddProducts>

</OpportunitySettings>

OrderSettings

Represents order settings. This type extends the Metadata metadata type and inherits its fullName field. For more information, see

“Customize Order Settings” in the Salesforce Help.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

There is one OrderSettings component in a file named Order.settings in the settings folder. The .settings files are

different from other named components because there is only one settings file for each settings component.

Version

OrderSettings components are available in API version 30.0 and later.

Fields

DescriptionField TypeField Name

Indicates whether users in the organization can add order products with

quantities of less than zero (true) or not (false).

To enable this preference, enableOrders must be set to true.

booleanenableNegativeQuantity

Indicates whether orders are enabled for the organization (true) or

not (false).

booleanenableOrders

Indicates whether reduction orders are enabled for the organization

(true) or not (false). For more information, see “Reduction Orders”

in the Salesforce Help.

To enable this preference, enableOrders must be set to true.

booleanenableReductionOrders

Declarative Metadata Sample Definition

This is a sample OrderSettings component.

<?xml version="1.0" encoding="UTF-8"?>

<enableReductionOrders>false</enableReductionOrders>

613

OrderSettingsMetadata Types

</OrderSettings>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Order</members>

<name>Settings</name>

</types>

</Package>

OrgPreferenceSettings

Represents the unique org preference settings in a Salesforce org. This type extends the Metadata metadata type and inherits its

fullName field.

File Suffix and Directory Location

OrgPreferenceSettings values are stored in the OrgPreference.settings file in the settings directory. The .settings files

are different from other named components because there is only one settings file for each settings component.

Version

OrgPreferenceSettings components are available in API version 37.0 and later.

Fields

DescriptionField TypeField Name

The preferences associated with the org settings. Possible values are:OrganizationSettingsDetail[]preferences

•ChatterEnabled

•EnhancedEmailEnabled

•EventLogWaveIntegEnabled

•LoginForensicsEnabled

•NotesReservedPref01

•OfflineDraftsEnabled

•PathAssistantsEnabled

•S1DesktopEnabled

•S1EncryptedStoragePref2

•S1OfflinePref

•SendThroughGmailPref

•SocialProfilesEnable

•VoiceEnabled

614

OrgPreferenceSettingsMetadata Types

OrganizationSettingsDetail

DescriptionField TypeField Name

The name of the setting. For example,

“S1EncryptedStoragePref2.”

stringsettingName

Indicates whether the setting is enabled

(true) or not (false).

booleansetttingValue

Declarative Metadata Sample Definition

The following is an example of a OrgPreferenceSettings component.

<?xml version="1.0" encoding="UTF-8"?>

<settingName>EventLogWaveIntegEnabled</settingName>

</preferences>

<settingName>SendThroughGmailPref</settingName>

<settingValue>false</settingValue>

</preferences>

<settingName>LoginForensicsEnabled</settingName>

<settingValue>false</settingValue>

</preferences>

<settingName>EnhancedEmailEnabled</settingName>

</preferences>

<settingName>NotesReservedPref01</settingName>

<settingValue>false</settingValue>

</preferences>

<settingName>S1OfflinePref</settingName>

</preferences>

<settingName>S1EncryptedStoragePref2</settingName>

</preferences>

<settingName>OfflineDraftsEnabled</settingName>

<settingValue>false</settingValue>

</preferences>

<settingName>ChatterEnabled</settingName>

</preferences>

615

OrgPreferenceSettingsMetadata Types

<settingName>SocialProfilesEnable</settingName>

</preferences>

<settingName>PathAssistantsEnabled</settingName>

<settingValue>false</settingValue>

</preferences>

<settingName>S1DesktopEnabled</settingName>

</preferences>

<settingName>VoiceEnabled</settingName>

<settingValue>false</settingValue>

</preferences>

</OrgPreferenceSettings>

PathAssistantSettings

Represents the Path preference setting. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

PathAssistantSettings components have the suffix .settings and are stored in the settings folder.

Version

PathAssistantSettings components are available in API version 34.0 and later.

Fields

DescriptionField TypeField Name

Determines whether the preference is enabled for Path in Opportunity

or not. Available in API version 34.0 only.

booleanpathAssistantForOpportunityEnabled

Determines whether the preference is enabled for Path or not. Available

in API version 35.0 and later.

booleanpathAssistantEnabled

Declarative Metadata Sample Definition

The following is an example of a PathAssistantSettings component.

<?xml version="1.0" encoding="UTF-8"?>

</PathAssistantSettings>

616

PathAssistantSettingsMetadata Types

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>PathAssistant</members>

<name>Settings</name>

</types>

</Package

PersonalJourneySettings

Represents an organization’s Adoption Manager setting, which enables or disables the Adoption Manager tool. This type extends the

Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings on page 557 for

more details.

File Suffix and Directory Location

PersonalJourneySettings values are stored in the PersonalJourney.settings file in the settings directory. The .settings

files are different from other named components because there is only one settings file for each settings component.

Version

PersonalJourneySettings components are available in API version 39.0 and later.

Special Access Rules

Adoption Manager must be enabled in your organization.

Fields

DescriptionField TypeField Name

Enables use of Adoption Manager, a tool that helps drive adoption of

the Salesforce1 mobile app and the Lightning Experience. For more

information, see Salesforce Adoption Manager in the Salesforce help.

booleanenableExactTargetForSalesforceApps

ProductSettings

Represents organization preferences for quantity schedules, revenue schedules, and active flag interaction with prices. This type extends

the Metadata metadata type and inherits its fullName field.

617

PersonalJourneySettingsMetadata Types

File Suffix and Directory Location

ProductSettings values are stored in a single file named Product.settings in the settings directory of the corresponding

package directory. The .settings files are different from other named components because there is only one settings file for each

settings component.

Version

ProductSettings is available in API version 28.0 and later.

Fields

DescriptionField TypeField Name

When changing active flag on a product record, automatically updates

active flag on related prices.

booleanenableCascadeActivateToRelatedPrices

Enables quantity schedules for products.booleanenableQuantitySchedule

Enables revenue schedules for products.booleanenableRevenueSchedule

Declarative Metadata Sample Definition

The following is an example of the package file.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Product</members>

<name>Settings</name>

</types>

</Package>

The package file references the following Product.settings file.

<?xml version="1.0" encoding="UTF-8"?>

<enableQuantitySchedule>false</enableQuantitySchedule>

<enableRevenueSchedule>false</enableRevenueSchedule>

</ProductSettings>

QuoteSettings

Enables or disables Quotes, which show proposed prices for products and services. This type extends the Metadata metadata type and

inherits its fullName field.

618

QuoteSettingsMetadata Types

File Suffix and Directory Location

QuoteSettings values are stored in a single file named Quote.settings in the settings directory of the corresponding package

directory. The .settings files are different from other named components because there is only one settings file for each settings

component.

Version

QuoteSettings is available in API version 28.0 and later.

Fields

DescriptionField TypeField Name

When set to true, users can access Quotes.booleanenableQuote

Declarative Metadata Sample Definition

The following is an example of the package file.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Quote</members>

<name>Settings</name>

</types>

</Package>

The package file references the following Quote.settings file.

<?xml version="1.0" encoding="UTF-8"?>

</QuoteSettings>

SearchSettings

Represents an org's search settings.

This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

File Suffix and Directory Location

SearchSettings values are stored in a single file named Search.settings in the settings folder. The .settings files are

different from other named components because there is only one settings file for each settings component.

619

SearchSettingsMetadata Types

Version

SearchSettings is available in API version 37.0 and later.

Fields

DescriptionField TypeField Name

Indicates if a full-text document search is performed.booleandocumentContentSearchEnabled

Indicates whether the search is optimized for the Japanese,

Chinese, and Korean languages. This setting affects sidebar

booleanoptimizeSearchForCJKEnabled

search and the account search for Find Duplicates on a lead

record in sidebar search and global search. Enable this option

if users are searching mostly in Japanese, Chinese, or Korean,

and if the text in searchable fields is mostly in those languages.

Indicates whether the list of records that are returned from a

user autocomplete lookup and from a blank user lookup is

booleanrecentlyViewedUsersForBlankLookupEnabled

taken from the user’s recently viewed user records. Otherwise

this setting is false if the lookup shows a list of recently

accessed user records from across your org (false). Only

applies to User object blank lookup searches.

Represents a list of search settings for each object.SearchSettingsByObjectsearchSettingsByObject

Indicates if autocomplete is enabled for sidebar search.

Autocomplete is when users start typing search terms and

booleansidebarAutoCompleteEnabled

sidebar search displays a matching list of recently viewed

records.

Indicates if a drop-down list appears in the sidebar search

section. From this list, users can select to search within tags,

within a specific object, or across all objects.

booleansidebarDropDownListEnabled

Indicates if the Limit to Items I Own checkbox appears. The

checkbox allows your users to include only records for which

booleansidebarLimitToItemsIOwnCheckboxEnabled

they are the record owner when entering search queries in

the sidebar.

Indicates if a shortcut is enabled. With the shortcut, users skip

the search results page and go directly to the record’s detail

booleansingleSearchResultShortcutEnabled

page when their search returns only a single item. This setting

doesn't apply to tags, case comments (in advanced search),

and global search.

Indicates if spell check is enabled for Knowledge search.booleanspellCorrectKnowledgeSearchEnabled

SearchSettingsByObject

Includes ObjectSearchSetting field type, which is a list of search settings for each object.

620

SearchSettingsMetadata Types

DescriptionField TypeField Name

Contains a list of search settings for each object.ObjectSearchSettingsearchSettingsByObject

ObjectSearchSetting

A list of search settings for each object.

DescriptionField TypeField Name

Indicates if enhanced lookups is enabled for the object.booleanenhancedLookupEnabled

Indicates if autocomplete is enabled for lookup search. Autocomplete

is when users edit the lookup field inline by choosing an autosuggestion.

booleanlookupAutoCompleteEnabled

The entity name of the object being configured.stringname

The number of search results per page.intresultsPerPageCount

Declarative Metadata Sample Definition

The following is an example of the Search.settings file.

<?xml version="1.0" encoding="UTF-8"?>

<enhancedLookupEnabled>false</enhancedLookupEnabled>

<lookupAutoCompleteEnabled>false</lookupAutoCompleteEnabled>

<name>Account</name>

</searchSettingsByObject>

<enhancedLookupEnabled>false</enhancedLookupEnabled>

<lookupAutoCompleteEnabled>false</lookupAutoCompleteEnabled>

<name>Activity</name>

</searchSettingsByObject>

<enhancedLookupEnabled>false</enhancedLookupEnabled>

<lookupAutoCompleteEnabled>false</lookupAutoCompleteEnabled>

<name>Asset</name>

</searchSettingsByObject>

621

SearchSettingsMetadata Types

</SearchSettings>

Example Package Manifest

The following is an example package manifest used to deploy or retrieve the Account settings metadata for an organization.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Search</members>

<name>Settings</name>

</types>

</Package>

SecuritySettings

Represents an organization’s security settings. Security settings define trusted IP ranges for network access, password and login

requirements, and session expiration and security settings.

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more details.

Declarative Metadata File Suffix and Directory Location

SecuritySettings values are stored in a single file named Security.settings in the settings directory. The .settings

files are different from other named components because there is only one settings file for each settings component.

Note: SecuritySettings is no longer available in API versions 25.0 and 26.0.

Version

Security settings are available in API version 27.0 and later.

Fields

DescriptionField TypeField Name

The trusted IP address ranges from which users can always log

in without requiring computer activation.

NetworkAccessnetworkAccess

The requirements for passwords and logins, and assistance with

retrieving forgotten passwords.

PasswordPoliciespasswordPolicies

The settings for session expiration and security.SessionSettingssessionSettings

622

SecuritySettingsMetadata Types

NetworkAccess

Represents your organization’s trusted IP address ranges for network access.

DescriptionField TypeField

The trusted IP address ranges from which users can always log

in without requiring computer activation.

IpRange[]ipRanges

Note: In order to add an IP range, deploy all existing IP

ranges, as well as the one you want to add. Otherwise,

the existing IP ranges are replaced with the ones you

deploy. To remove all the IP ranges in an organization,

leave the networkAccess field blank

(<networkAccess></networkAccess>).

IpRange

Defines a range of trusted IP addresses for network access.

DescriptionField TypeField

The description of the trusted IP range. Use this field to identify

the range, such as which corporate network corresponds to this

range. This field is available in API version 34.0 and later.

stringdescription

The IP address that defines the high end of a range of trusted

addresses.

stringend

The IP address that defines the low end of a range of trusted

addresses.

stringstart

PasswordPolicies

Represents your organization’s password and login policies.

DescriptionField TypeField

The URL to which users with the “API Only User” permission are

redirected instead of the login page.

stringapiOnlyUserHomePageURL

Required. The requirement for which types of characters must

be used in a user’s password. Valid values are:

Complexity (enumeration of

type string)

complexity

•NoRestriction—allows any password value and is

the least secure option.

•AlphaNumeric—requires at least one alphabetic

character and one number. This value is the default value.

•SpecialCharacters—requires at least one alphabetic

character, one number, and one of the following special

characters: ! # $ % - _ = + < >.

623

SecuritySettingsMetadata Types

DescriptionField TypeField

•UpperLowerCaseNumeric—requires at least one

number, one uppercase letter, and one lowercase letter.

This value is available in API version 31.0 and later.

•UpperLowerCaseNumericSpecialCharacters—requires

at least one number, one uppercase letter, and one

lowercase letter, and one of the following special characters:

! # $ % - _ = + < >. This value is available in API

version 31.0 and later.

Required. The length of time until user passwords expire and

must be changed. Valid values are:

Expiration (enumeration of type

string)

expiration

•Never

•ThirtyDays

•SixtyDays

•NinetyDays. This value is the default value.

•SixMonths

•OneYear

Indicates whether a one-day minimum password lifetime is

required (true) or not (false). This field is available in API

version 31.0 and later.

booleanminimumPasswordLifetime

The URL that users can click to retrieve forgotten passwords.stringpasswordAssistanceURL

The text that appears in the Account Lockout email and at the

bottom of the Confirm Identity screen for users resetting their

passwords.

stringpasswordAssistanceMessage

Required. The number of previous passwords saved for users so

that they must always reset a new, unique password. Valid values

stringhistoryRestriction

are 0 through 24 passwords remembered. The maximum

value of 24 applies to API version 31.0 and later. In earlier

versions, the maximum value is 16. The default value is 3.

Required. The duration of the login lockout. Valid values are:LockoutInterval (enumeration

of type string)

lockoutInterval

•FifteenMinutes. This value is the default value.

•ThirtyMinutes

•SixtyMinutes

•Forever (must be reset by admin)

Required. The number of login failures allowed for a user before

they become locked out. Valid values are:

MaxLoginAttempts

(enumeration of type string)

maxLoginAttempts

•NoLimit

•ThreeAttempts

•FiveAttempts

624

SecuritySettingsMetadata Types

DescriptionField TypeField

•TenAttempts. This value is the default value.

Required. The minimum number of characters required for a

password. Valid values are from 5 to 50. The default value is 8.

This field is available in API version 35.0 and later.

stringminimumPasswordLength

Before API version 35.0, specify minimum password length with

the enumeration minPasswordLength, with valid values

FiveCharacters, EightCharacters (default),

TenCharacters, TwelveCharacters (API version

31.0 and later), and FifteenCharacters ( API version

34.0 and later).

Hides the secret answer associated with a password (true) or

not (false).

booleanobscureSecretAnswer

Note: If your org uses the Microsoft Input Method Editor

(IME) with the input mode set to Hiragana, when you

type ASCII characters, they’re converted in Japanese

characters in normal text fields. However, the IME doesn’t

work properly in fields with obscured text. If your org’s

users cannot properly enter their passwords or other

values after enabling this feature, disable the feature.

Required. The restriction on whether the answer to the password

hint question can contain the password itself. Valid values are:

QuestionRestriction

(enumeration of type string)

questionRestriction

•None

•DoesNotContainPassword. This value is the default

value.

SessionSettings

Represents your organization’s session expiration and security settings.

DescriptionField TypeField

Indicates whether the session timeout warning popup is

disabled (true) or enabled (false).

booleandisableTimeoutWarning

Indicates whether a content security policy is enabled for the

email template. A content security policy helps prevent

booleanenableCSPOnEmail

cross-site scripting attacks by whitelisting sources of images

and other content.

Indicates whether Cross-Site Request Forgery (CSRF) protection

on GET requests on non-setup pages is enabled (true) or

disabled (false).

booleanenableCSRFOnGet

625

SecuritySettingsMetadata Types

DescriptionField TypeField

Indicates whether Cross-Site Request Forgery (CSRF) protection

on POST requests on non-setup pages is enabled (true) or

disabled (false).

booleanenableCSRFOnPost

Indicates whether the user’s browser is allowed to store user

names and auto-fill the User Name field on the login page

(true) or not (false).

booleanenableCacheAndAutocomplete

Indicates whether clickjack protection for non-setup Salesforce

pages is enabled (true) or disabled (false).

booleanenableClickjackNonsetupSFDC

Indicates whether clickjack protection for customer Visualforce

pages with standard headers turned on is enabled (true) or

disabled (false).

booleanenableClickjackNonsetupUser

Indicates whether clickjack protection for customer Visualforce

pages with standard headers turned off is enabled (true) or

disabled (false). Available in API version 34.0 and later.

booleanenableClickjackNonsetupUserHeaderless

Indicates whether clickjack protection for setup pages is enabled

(true) or disabled (false).

booleanenableClickjackSetup

Indicates whether cross-domain session information is

exchanged using a POST request instead of a GET request, such

booleanenablePostForSessions

as when a user is using a Visualforce page. In this context, POST

requests are more secure than GET requests. Available in API

version 31.0 and later.

Indicates whether users can receive a one-time PIN delivered

via SMS (true) or not (false).

booleanenableSMSIdentity

If true, the IP addresses in Login IP Ranges are enforced when

a user accesses Salesforce (on every page request), including

booleanenforceIpRangesEveryRequest

access from a client application. If false, the IP addresses in

affects all user profiles that have login IP restrictions. Available

in API version 34.0 and later.

Indicates that when sessions time out for inactive users, current

sessions become invalid. The browser refreshes and returns to

booleanforceLogoutOnSessionTimeout

the login page. To access the org, the user must log in again.

Enabled (true) or not (false). Available in API version 31.0

and later.

If true, an administrator that is logged in as another user is

required to log in again to their original session, after logging

booleanforceRelogin

out as the secondary user. If false, the administrator is not

required to log in again.

Indicates whether the current UI session for a user, such as a

community user, is associated with a specific domain. This check

booleanlockSessionsToDomain

helps prevent unauthorized use of the session ID in another

626

SecuritySettingsMetadata Types

DescriptionField TypeField

domain. The value is true by default for organizations created

with the Spring ’15 release or later. Available in API version 33.0

and later.

Indicates whether user sessions are locked to the IP address

from which the user logged in (true) or not (false).

booleanlockSessionsToIp

The URL to which users are redirected when they log out of

Salesforce. If no value is specified, the default is

stringlogoutURL

https://login.salesforce.com unless MyDomain

is enabled. If My Domain is enabled, the default is

https://customdomain.my.salesforce.com.

Available in API version 34.0 and later.

The length of time after which users without activity are

prompted to log out or continue working. Valid values are:

SessionTimeout (enumeration

of type string)

sessionTimeout

•FifteenMinutes

•ThirtyMinutes

•SixtyMinutes

•TwoHours

•FourHours

•EightHours

•TwelveHours

Declarative Metadata Sample Definition

The following is a sample security.settings metadata file.

<?xml version="1.0" encoding="UTF-8"?>

</ipRanges>

</networkAccess>

<apiOnlyUserHomePageURL>http://www.altPage.com</apiOnlyUserHomePageURL>

<complexity>SpecialCharacters</complexity>

<expiration>OneYear</expiration>

<passwordAssistanceURL>http://www.acme.com/forgotpassword</passwordAssistanceURL>

<passwordAssistanceMessage>Forgot your password? Reset it

here.</passwordAssistanceMessage>

<lockoutInterval>ThirtyMinutes</lockoutInterval>

<maxLoginAttempts>ThreeAttempts</maxLoginAttempts>

627

SecuritySettingsMetadata Types

</passwordPolicies>

<enableCSRFOnGet>false</enableCSRFOnGet>

<enableCSRFOnPost>false</enableCSRFOnPost>

<enableCacheAndAutocomplete>false</enableCacheAndAutocomplete>

<sessionTimeout>TwelveHours</sessionTimeout>

</sessionSettings>

</SecuritySettings>

SEE ALSO:

Settings

Territory2Settings

Represents the metadata for the default settings for Territory Management 2.0 users to access and modify records associated with sales

territories. The standard record access settings apply to accounts and opportunities. If your Salesforce org uses Private default internal

access for contacts or cases, you can also set access for those records. This type extends the Metadata metadata type and inherits its

fullName field. Available only if Territory Management 2.0 has been enabled for your org.

File Suffix and Directory Location

Territory2Settings components have the suffix settings and are stored in the Settings folder.

Version

Territory2Settings components are available in API version 32.0 and later.

Special Access Rules

The Territory2Model object has a State field in the SOAP API. States include Planning, Active, Archived, and a number of

other states, such as Cloning, that indicate that a process is underway. Users who do not have the “Manage Territories” permission

can access only territories that belong to the model in Active state. The “Manage Territories” permission is required for deploy()

calls for all territory management entities, in addition to the “Modify All Data” permission required by Metadata API. Using retrieve()

without the “Manage Territories” permission will return only entities that belong to a Territory2Model in Active state. We recommend

against retrieving without the “Manage Territories” permission because the call will retrieve only partial data.

628

Territory2SettingsMetadata Types

Fields

DescriptionField TypeField Name

The default level of access users will have to account records in territories:

view and edit accounts assigned to territories or view, edit,

transfer, and delete accounts assigned to territories.

stringdefaultAccountAccessLevel

The default level of access users will have to case records in territories:

view and edit accounts assigned to territories or view, edit,

transfer, and delete accounts assigned to territories.

stringdefaultCaseAccessLevel

The default level of access users will have to contact records in territories:

view and edit accounts assigned to territories or view, edit,

transfer, and delete accounts assigned to territories.

stringdefaultContactAccessLevel

The default level of access users will have to opportunity records in

territories: view and edit accounts assigned to territories or view,

edit, transfer, and delete accounts assigned to territories.

stringdefaultOpportunityAccessLevel

Declarative Metadata Sample Definition

The following example shows the definition of a Territory2Settings component.

<?xml version="1.0" encoding="UTF-8"?>

<defaultAccountAccessLevel>Owner</defaultAccountAccessLevel>

</Territory2Settings>

Usage

Territory Management 2.0 components don’t support packaging or change sets and aren’t supported in CRUD calls.

SharedTo

SharedTo defines the sharing access for a list view or a folder. It can be used to specify the target and source for owner-based sharing

rules. See “Sharing Considerations” and “What Is a Group?” in the Salesforce online help.

Declarative Metadata File Suffix and Directory Location

SharedTo is used with ListView, Folder, and SharingRules.

Version

SharedTo is available in API version 17.0 and later.

629

SharedToMetadata Types

Fields

DescriptionField TypeField

A group containing all customer portal users.

This field is available in API version 24.0 and later.

stringallCustomerPortalUsers

A group containing all internal and nonportal users.

This field is available in API version 24.0 and later.

stringallInternalUsers

A group containing all partner users.

This field is available in API version 24.0 and later.

stringallPartnerUsers

A list of groups with sharing access. Use this field instead of the

groups field.

This field is available in API version 22.0 and later.

string[]group

A list of groups with sharing access.

Use the group field instead for API version 22.0 and later.

string[]groups

A list of users whose direct and indirect subordinates receive

sharing access. This field is available in API version 24.0 and later.

string[]managerSubordinates

A list of users whose direct and indirect managers receive sharing

access. This field is available in API version 24.0 and later.

string[]managers

A list of groups with sharing access containing all users in a

portal role.

This field is available in API version 24.0 and later.

string[]portalRole

A list of groups with sharing access containing all users in a

portal role or those under that role.

This field is available in API version 24.0 and later.

string[]portalRoleandSubordinates

A list of roles with sharing access. Use this field instead of the

roles field.

This field is available in API version 22.0 and later.

string[]role

A list of roles with sharing access. All roles below each of these

roles in the role hierarchy also have sharing access. If portal

string[]roleAndSubordinates

accounts are enabled, then all roles and portal accounts below

each of these roles in the role hierarchy also have sharing access.

Use this field instead of the rolesAndSubordinates field

This field is available in API version 22.0 and later.

630

SharedToMetadata Types

DescriptionField TypeField

A list of roles with sharing access. All roles below each of these

roles in the role hierarchy also have sharing access.

This field is available in API version 22.0 and later.

string[]roleAndSubordinatesInternal

A list of roles with sharing access.

Use the role field instead for API version 22.0 and later.

string[]roles

A list of roles with sharing access. All roles below each of these

roles in the role hierarchy also have sharing access. If portal

string[]rolesAndSubordinates

accounts are enabled, then all roles and portal accounts below

each of these roles in the role hierarchy also have sharing access.

Use the roleAndSubordinates field instead for API

version 22.0 and later.

A list of territories with sharing access.

Use the territory field instead for API version 22.0 and

later.

string[]territories

A list of territories with sharing access. All territories below each

of these territories in the territory hierarchy also have sharing

access.

Use the territoryAndSubordinates field instead for

API version 22.0 and later.

string[]territoriesAndSubordinates

A list of territories with sharing access. Use this field instead of

the territories field.

This field is available in API version 22.0 and later.

string[]territory

A list of territories with sharing access. All territories below each

of these territories in the territory hierarchy also have sharing

string[]territoryAndSubordinates

access. Use this field instead of the

territoriesAndSubordinates field.

This field is available in API version 22.0 and later.

A list of queues with sharing access. Applies only to lead, case,

and CustomObject sharing rules.

This field is available in API version 24.0 and later.

string[]queue

SharingBaseRule

Represents sharing rule settings such as access level and to whom access is granted. This type extends the Metadata metadata type and

inherits its fullName field.

631

SharingBaseRuleMetadata Types

Note: You can’t create a SharingBaseRule component directly. Use the components under SharingRules instead.

Version

SharingBaseRule replaces BaseSharingRule and is available in API version 33.0 and later.

Fields

DescriptionField TypeField

Required. The access level that the sharing rule

grants.

stringaccessLevel

The access level for the account’s children (case,

contact, and opportunity).

AccountSharingRuleSettings[]accountSettings

Describes the sharing rule. Maximum of 1000

characters.

stringdescription

Required. Label for the sharing rule.stringlabel

Required. Specifies who the record should be

shared with.

SharedTosharedTo

AccountSharingRuleSettings

Defines the access level for the case, contact, and opportunity associated with the account.

DescriptionField TypeField

Required. The access level that the user or group

has to cases associated with the account.

Possible values are:

stringcaseAccessLevel

•None

•Read

•Edit

Required. The access level that the user or group

has to contacts associated with the account.

Possible values are:

stringcontactAccessLevel

•None

•Read

•Edit

632

SharingBaseRuleMetadata Types

DescriptionField TypeField

Required. The access level that the user or group

has to opportunities associated with the account.

Possible values are:

stringopportunityAccessLevel

•None

•Read

•Edit

SharingRules

Represents the base container for sharing rules, which can be criteria-based, ownership-based, or territory-based. SharingRules enables

you to share records with a set of users, using rules that specify the access level for the target user group.

This type extends the Metadata metadata type and inherits its fullName field. For more information, see “Sharing Rules” in the

Salesforce online help.

In API version 33.0 and later, retrieving, deleting, or deploying of all sharing rules in an organization is available . Wildcard support is also

available. You can’t retrieve, delete, or deploy manual sharing rules or sharing rules by their type (owner, criteria-based, or territory).

Declarative Metadata File Suffix and Directory Location

In API version 33.0 and later, components are stored in the sharingRules folder and their file name matches the object name with the

suffix .sharingRules. Criteria-based, owner-based, and territory-based sharing rules are all contained in a object.sharingRule

file.

Prior to API version 33.0, SharingRules components are stored in their corresponding object directory and the file name matches the

object name. For example, the accountSharingRules directory contains an Account.sharingRules file for account

sharing rules. SharingRules for custom objects are stored in the customObjectSharingRules directory, which contains files

with the .sharingRules extension such as ObjA__c.sharingRules, where ObjA refers to the developer name of a custom

object type.

Version

SharingRules components are available in API version 24.0 and later, but these components are no longer available in API version 33.0

and later: AccountSharingRules, CampaignSharingRules, CaseSharingRules, ContactSharingRules, LeadSharingRules,

OpportunitySharingRules, AccountTerritorySharingRules, CustomObjectSharingRules, UserSharingRules.

In API version 33.0 and later, use SharingCriteriaRule, SharingOwnerRule and SharingTerritoryRule.

Fields

The following information assumes that you are familiar with implementing sharing rules for standard objects and custom objects. For

more information on these fields, see “Sharing Settings” in the Salesforce online help.

633

SharingRulesMetadata Types

DescriptionField TypeField

An array of criteria-based sharing rules. Available in API

version 33.0 and later.

SharingCriteriaRule[]sharingCriteriaRules

An array of ownership-based sharing rules. Available in

API version 33.0 and later.

SharingOwnerRule[]sharingOwnerRules

An array of territory-based sharing rules. Available in API

version 33.0 and later.

SharingTerritoryRule[]sharingTerritoryRules

SharingCriteriaRule

Defines a criteria-based sharing rule. It extends SharingBaseRule and inherits all its fields. Available in API version 33.0 and later.

DescriptionField TypeField

Advanced filter conditions that are specified for the sharing

rule.

stringbooleanFilter

An array of the boolean criteria (conditions) for the sharing

rule.

FilterItem[]criteriaItems

SharingOwnerRule

Defines a ownership-based sharing rule. It extends SharingBaseRule and inherits all its fields. Available in API version 33.0 and later.

DescriptionField TypeField

Required. Specifies the record owners.SharedTosharedFrom

SharingTerritoryRule

Defines a territory-based sharing rule. It extends SharingOwnerRule and inherits all its fields. Available in API version 33.0 and later.

AccountSharingRules

Represents the sharing rules for accounts. It extends the SharingRules metadata type and inherits its fullName field. Only available

in API version 32.0 and earlier.

DescriptionField TypeField

List that defines user criteria-based rules.AccountCriteriaBasedSharingRule[]criteriaBasedRules

List that defines user membership-based rules.AccountOwnerSharingRule[]ownerRules

634

SharingRulesMetadata Types

CampaignSharingRules

Represents the sharing rules for campaigns. It extends the SharingRules metadata type and inherits its fullName field. Only available

in API version 32.0 and earlier.

DescriptionField TypeField

List that defines user criteria-based rules.CampaignCriteriaBasedSharingRule[]criteriaBasedRules

List that defines user membership-based rules.CampaignOwnerSharingRule[]ownerRules

CaseSharingRules

Represents the sharing rules for cases. It extends the SharingRules metadata type and inherits its fullName field. Only available in

API version 32.0 and earlier.

DescriptionField TypeField

List that defines user criteria-based rules.CaseCriteriaBasedSharingRule[]criteriaBasedRules

List that defines user membership-based rules.CaseOwnerSharingRule[]ownerRules

ContactSharingRules

Represents the sharing rules for contacts. It extends the SharingRules metadata type and inherits its fullName field. Only available

in API version 32.0 and earlier.

DescriptionField TypeField

List that defines user criteria-based rules.ContactCriteriaBasedSharingRule[]criteriaBasedRules

List that defines user membership-based rules.ContactOwnerSharingRule[]ownerRules

LeadSharingRules

Represents the sharing rules for leads. It extends the SharingRules metadata type and inherits its fullName field. Only available in

API version 32.0 and earlier.

DescriptionField TypeField

List that defines user criteria-based rules.LeadCriteriaBasedSharingRule[]criteriaBasedRules

List that defines user membership-based rules.LeadOwnerSharingRule[]ownerRules

OpportunitySharingRules

Represents the sharing rules for opportunities. It extends the SharingRules metadata type and inherits its fullName field. Only available

in API version 32.0 and earlier.

635

SharingRulesMetadata Types

DescriptionField TypeField

List that defines user criteria-based rules.OpportunityCriteriaBasedSharingRule[]criteriaBasedRules

List that defines user membership-based rules.OpportunityOwnerSharingRule[]ownerRules

AccountTerritorySharingRules

Represents the sharing rules for account territories. It extends the SharingRules metadata type and inherits its fullName field. Only

available in API version 32.0 and earlier.

DescriptionField TypeField

List that defines user membership-based rules. The list of

acceptable values for the sharedFrom fields are:

AccountTerritorySharingRule[]rules

•territory

•territoryAndSubordinates

CustomObjectSharingRules

Represents the sharing rules for custom objects. It extends the SharingRules metadata type and inherits its fullName field. Only

available in API version 32.0 and earlier.

DescriptionField TypeField

List that defines user criteria-based rules.CustomObjectCriteriaBasedSharingRule[]criteriaBasedRules

List that defines user membership-based rules.CustomObjectOwnerSharingRule[]ownerRules

UserSharingRules

Represents the sharing rules for users. With user sharing rules, you can share members of a group with members of another group. It

extends the SharingRules metadata type and inherits its fullName field. Only available in API version 32.0 and earlier.

DescriptionField TypeField

List that defines user criteria-based rules.UserCriteriaBasedSharingRule[]criteriaBasedRules

List that defines user membership-based rules.UserMembershipSharingRule[]membershipRules

Declarative Metadata Sample Definition

For retrieving sharing rules, see package.xml sample at Sharing Rules.

The following sample XML definition represents a criteria-based sharing rule in API version 33.0.

<?xml version="1.0" encoding="UTF-8"?>

636

SharingRulesMetadata Types

<fullName>AccountCriteriaShareWithCEO</fullName>

</accountSettings>

<operation>startsWith</operation>

</criteriaItems>

<description>my account criteria rule description</description>

<label>AccountCriteriaShareWithCEO</label>

</sharedTo>

</sharingCriteriaRules>

</SharingRules>

The following sample XML definition represents an ownership-based sharing rule in API version 33.0.

<?xml version="1.0" encoding="UTF-8"?>

<fullName>MyCase</fullName>

<description>my case test owner sharing rule desc</description>

<label>MyCase</label>

</sharedFrom>

</sharedTo>

</sharingOwnerRules>

</SharingRules>

The following sample XML definition represents a territory-based sharing rule in API version 33.0.

<?xml version="1.0" encoding="UTF-8"?>

<fullName>MyAccountTerritoryRule</fullName>

</accountSettings>

<description>MyAccountTerritoryRule desc</description>

<label>MyAccountTerritoryRule</label>

<territory>My_territory</territory>

637

SharingRulesMetadata Types

</sharedFrom>

</sharedTo>

</sharingTerritoryRules>

</SharingRules>

The following is the definition of two account owner-based sharing rules in API version 32.0 and earlier. The file name corresponds to

Account.sharingRules under the accountSharingRules directory. In this definition, ownerRules corresponds to

AccountOwnerSharingRule.

<?xml version="1.0" encoding="UTF-8"?>

</sharedFrom>

</sharedTo>

</ownerRules>

</sharedFrom>

</sharedTo>

</ownerRules>

</AccountSharingRules>

The following is the definition of a user criteria-based sharing rule and a user membership-based sharing rule in API version 32.0 and

earlier. The file name corresponds to User.sharingRules under the userSharingRules directory.

<?xml version="1.0" encoding="UTF-8"?>

<fullName>shareUsers2</fullName>

<group>Asia_Division</group>

</sharedTo>

<field>FirstName</field>

638

SharingRulesMetadata Types

<operation>equals</operation>

</criteriaItems>

<name>shareUsers2</name>

</criteriaBasedRules>

<fullName>shareUsers1</fullName>

<group>South_America_Division</group>

</sharedTo>

<group>Asia_Division</group>

</sharedFrom>

<name>shareUsers1</name>

</membershipRules>

</UserSharingRules>

The following shows a sample package.xml file.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>SharingCriteriaRule</name>

</types>

<types>

<name>SharingOwnerRule</name>

</types>

</Package>

BaseSharingRule

This component is removed as of API version 33.0 and is available in earlier versions only. Use SharingBaseRule instead.

Represents the base container for criteria-based and owner-based sharing rules. This type extends the Metadata metadata type and

inherits its fullName field.

Note: You can’t create a BaseSharingRule component directly. Use the components under the CriteriaBasedSharingRule or

OwnerSharingRule metadata types instead.

Version

BaseSharingRule components are available in API version 24.0 and later.

Fields

For more information on these fields, see “Sharing Settings” in the Salesforce online help.

639

BaseSharingRuleMetadata Types

DescriptionField TypeField

Required. Specifies who the record should be

shared with.

SharedTosharedTo

The unique identifier for API access. The

fullName can contain only underscores and

stringfullName

alphanumeric characters. It must be unique,

begin with a letter, not include spaces, not end

with an underscore, and not contain two

consecutive underscores. This field is inherited

from the Metadata component.

CriteriaBasedSharingRule

This component is removed as of API version 33.0 and is available in earlier versions only. Use SharingRules instead.

Represents a criteria-based sharing rule. CriteriaBasedSharingRule enables you to share records based on specific criteria. It extends the

BaseSharingRule metadata type and inherits its sharedTo field. For more information, see “Criteria-Based Sharing Rules Overview”

in the Salesforce online help.

Note: You can’t create a CrteriaBasedSharingRule component directly. Use the child components instead.

Declarative Metadata File Suffix and Directory Location

CriteriaBasedSharingRule components are stored within the SharingRules component in the criteriaBasedRules field.

Version

CriteriaBasedSharingRule components are available in API version 24.0 and later.

Fields

The following information assumes that you are familiar with implementing sharing rules for standard objects and custom objects. For

more information on these fields, see “Sharing Settings” in the Salesforce online help.

DescriptionField TypeField

List that represents the criteria for the sharing

rule. The possible values are:

FilterItem[]criteriaItems

•field

•operation

•value

AccountCriteriaBasedSharingRule

Represents a criteria-based sharing rule for accounts. It extends the CriteriaBasedSharingRule metadata type and inherits its

criteriaItems field.

640

CriteriaBasedSharingRuleMetadata Types

AccountCriteriaBasedSharingRule is used by the criteriaBasedRules field in AccountSharingRules.

DescriptionField TypeField

Required. A value that represents the level of access that the

user or group has to the account. The possible values are:

ShareAccessLevelNoNone

(enumeration of type string)

accountAccessLevel

•Read

•Edit

•All

Represents the filter logic of the sharing rule.stringbooleanFilter

Required. A value that represents the level of access that the

user or group has to cases associated with the account. The

possible values are:

ShareAccessLevelNoAll

(enumeration of type string)

caseAccessLevel

•None

•Read

•Edit

Required. A value that represents the level of access that the

user or group has to contacts associated with the account. The

possible values are:

ShareAccessLevelNoAll

(enumeration of type string)

contactAccessLevel

•None

•Read

•Edit

Represents the description of the sharing rule. Maximum of 1000

characters.

This field is available in API version 29.0 and later.

stringdescription

Required. Name for the sharing rule. Corresponds to Label in

the user interface.

stringname

Required. A value that represents the level of access that a target

group is granted for any associated opportunity. The possible

values are:

ShareAccessLevelNoAll

(enumeration of type string)

opportunityAccessLevel

•None

•Read

•Edit

CampaignCriteriaBasedSharingRule

Represents a criteria-based sharing rule for campaigns. It extends the CriteriaBasedSharingRule metadata type and inherits its

criteriaItems field.

CampaignCriteriaBasedSharingRule is used by the criteriaBasedRules field in CampaignSharingRules.

641

CriteriaBasedSharingRuleMetadata Types

DescriptionField TypeField

Represents the filter logic of the sharing rule.stringbooleanFilter

Represents the description of the sharing rule. Maximum of 1000

characters.

This field is available in API version 29.0 and later.

stringdescription

Required. A value that represents the level of access that a target

group is granted for a campaign. The possible values are:

ShareAccessLevelNoNone

(enumeration of type string)

campaignAccessLevel

•Read

•Edit

•All

Required. Name for the sharing rule. Corresponds to Label in

the user interface.

stringname

CaseCriteriaBasedSharingRule

Represents a criteria-based sharing rule for cases. It extends the CriteriaBasedSharingRule metadata type and inherits its

criteriaItems field.

CaseCriteriaBasedSharingRule is used by the criteriaBasedRules field in CaseSharingRules.

DescriptionField TypeField

Represents the filter logic of the sharing rule.stringbooleanFilter

Represents the description of the sharing rule. Maximum of 1000

characters.

This field is available in API version 29.0 and later.

stringdescription

Required. A value that represents the level of access being

granted for a case. The possible values are:

ShareAccessLevelReadEdit

(enumeration of type string)

caseAccessLevel

•Read

•Edit

Required. Name for the sharing rule. Corresponds to Label in

the user interface.

stringname

ContactCriteriaBasedSharingRule

Represents a criteria-based sharing rule for contacts. It extends the CriteriaBasedSharingRule metadata type and inherits its

criteriaItems field.

ContactCriteriaBasedSharingRule is used by the criteriaBasedRules field in ContactSharingRules.

642

CriteriaBasedSharingRuleMetadata Types

DescriptionField TypeField

Represents the filter logic of the sharing rule.stringbooleanFilter

Represents the description of the sharing rule. Maximum of 1000

characters.

This field is available in API version 29.0 and later.

stringdescription

Required. A value that represents the level of access being

granted to the target group, role, or user for a contact. The

possible values are:

ShareAccessLevelReadEdit

(enumeration of type string)

contactAccessLevel

•Read

•Edit

Required. Name for the sharing rule. Corresponds to Label in

the user interface.

stringname

LeadCriteriaBasedSharingRule

Represents a criteria-based sharing rule for leads. It extends the CriteriaBasedSharingRule metadata type and inherits its criteriaItems

field.

LeadCriteriaBasedSharingRule is used by the criteriaBasedRules field in LeadSharingRules.

DescriptionField TypeField

Represents the filter logic of the sharing rule.stringbooleanFilter

Represents the description of the sharing rule. Maximum of 1000

characters.

This field is available in API version 29.0 and later.

stringdescription

Required. A value that represents the level of allowed access.

The possible values are:

ShareAccessLevelReadEdit

(enumeration of type string)

leadAccessLevel

•Read

•Edit

Required. Name for the sharing rule. Corresponds to Label in

the user interface.

stringname

OpportunityCriteriaBasedSharingRule

Represents a criteria-based sharing rule for opportunities. It extends the CriteriaBasedSharingRule metadata type and inherits its

criteriaItems field.

OpportunityCriteriaBasedSharingRule is used by the criteriaBasedRules field in OpportunitySharingRules.

643

CriteriaBasedSharingRuleMetadata Types

DescriptionField TypeField

Represents the filter logic of the sharing rule.stringbooleanFilter

Represents the description of the sharing rule. Maximum of 1000

characters.

This field is available in API version 29.0 and later.

stringdescription

Required. A value that represents the level of allowed access.

The possible values are:

ShareAccessLevelReadEdit

(enumeration of type string)

opportunityAccessLevel

•Read

•Edit

Required. Name for the sharing rule. Corresponds to Label in

the user interface.

stringname

CustomObjectCriteriaBasedSharingRule

Represents a criteria-based sharing rule for custom objects. It extends the CriteriaBasedSharingRule metadata type and inherits its

criteriaItems field.

CustomObjectCriteriaBasedSharingRule is used by the criteriaBasedRules field in CustomObjectSharingRules.

DescriptionField TypeField

Required. A value that represents the type of allowed sharing.

The possible values are:

stringaccessLevel

•Read

•Edit

•All

Represents the filter logic of the sharing rule.stringbooleanFilter

Represents the description of the sharing rule. Maximum of 1000

characters.

This field is available in API version 29.0 and later.

stringdescription

Required. Name for the sharing rule. Corresponds to Label in

the user interface.

stringname

UserCriteriaBasedSharingRule

Represents a criteria-based sharing rule for users. It extends the CriteriaBasedSharingRule metadata type and inherits its criteriaItems

field.

UserCriteriaBasedSharingRule is used by the criteriaBasedRules field in UserSharingRules.

644

CriteriaBasedSharingRuleMetadata Types

DescriptionField TypeField

Represents the filter logic of the sharing rule.stringbooleanFilter

Represents the description of the sharing rule. Maximum of 1000

characters.

This field is available in API version 29.0 and later.

stringdescription

Required. Name for the sharing rule. Corresponds to Label in

the user interface.

stringname

Required. A value that represents the type of allowed sharing.

The possible values are:

ShareAccessLevelReadEdit

(enumeration of type string)

userAccessLevel

•Read

•Edit

Declarative Metadata Sample Definition

The following is the definition of two owner-based sharing rules and one criteria-based sharing rule containing two criteria items. The

file name corresponds to the Account.sharingRules file under the accountSharingRules directory.

<?xml version="1.0" encoding="UTF-8"?>

</sharedTo>

</sharedFrom>

</ownerRules>

</sharedTo>

</sharedFrom>

</ownerRules>

<fullName>AccountCriteria</fullName>

645

CriteriaBasedSharingRuleMetadata Types

</sharedTo>

<field>BillingCity</field>

<operation>equals</operation>

<value>San Francisco</value>

</criteriaItems>

<field>MyChkBox__c</field>

<operation>notEqual</operation>

<value>False</value>

</criteriaItems>

<name>AccountCriteria</name>

</criteriaBasedRules>

</AccountSharingRules>

OwnerSharingRule

This component is removed as of API version 33.0 and is available in earlier versions only.

Represents an ownership-based sharing rule. OwnerSharingRule enables you to share records owned by a set of users with another set,

using rules that specify the access level of the target user group. It extends the BaseSharingRule metadata type and inherits its SharedTo

field. For more information, see “Sharing Rules” in the Salesforce online help.

Note: You can’t create a OwnerSharingRule component directly. Use the child components instead.

Declarative Metadata File Suffix and Directory Location

OwnerSharingRules components are stored within the SharingRules component in the ownerRules field.

Version

OwnerSharingRules components are available in API version 24.0 and later.

Fields

The following information assumes that you are familiar with implementing sharing rules for standard objects and custom objects. For

more information on these fields, see “Sharing Settings” in the Salesforce online help.

DescriptionField TypeField

Required. Specifies the record owners.SharedTosharedFrom

Required. Specifies who the record should be

shared with.

SharedTosharedTo

The unique identifier for API access. The

fullName can contain only underscores and

stringfullName

646

OwnerSharingRuleMetadata Types

DescriptionField TypeField

alphanumeric characters. It must be unique,

begin with a letter, not include spaces, not end

with an underscore, and not contain two

consecutive underscores. This field is inherited

from the Metadata component.

AccountOwnerSharingRule

Represents a sharing rule for an account with users other than the owner. It extends the OwnerSharingRule metadata type and inherits

its fullName, sharedFrom, and sharedTo fields.

AccountOwnerSharingRule is used by the ownerRules field in AccountSharingRules.

DescriptionField TypeField

Required. A value that represents the level of access that a group

or role has to the account. The possible values are:

ShareAccessLevelNoNone

(enumeration of type string)

accountAccessLevel

•Read

•Edit

•All

Required. A value that represents the level of access that a group

or role has to cases associated with the account. The possible

values are:

ShareAccessLevelNoAll

(enumeration of type string)

caseAccessLevel

•None

•Read

•Edit

Required. A value that represents the level of access that a group

or role has to contacts associated with the account. The possible

values are:

ShareAccessLevelNoAll

(enumeration of type string)

contactAccessLevel

•None

•Read

•Edit

Represents the description of the sharing rule. Maximum of 1000

characters.

This field is available in API version 29.0 and later.

stringdescription

Required. Name for the sharing rule. Corresponds to Label in

the user interface.

stringname

647

OwnerSharingRuleMetadata Types

DescriptionField TypeField

Required. A value that represents the level of access that a group

or role is granted for any associated opportunity. The possible

values are:

ShareAccessLevelNoAll

(enumeration of type string)

opportunityAccessLevel

•None

•Read

•Edit

CampaignOwnerSharingRule

Represents a sharing rule for a campaign with users other than the owner. It extends the OwnerSharingRule metadata type and inherits

its fullName, sharedFrom, and sharedTo fields.

CampaignOwnerSharingRule is used by the ownerRules field in CampaignSharingRules.

DescriptionField TypeField

A value that represents the level of access that a group or role

is granted for a campaign. The possible values are:

ShareAccessLevelNoNone

(enumeration of type string)

campaignAccessLevel

•Read

•Edit

•All

Represents the description of the sharing rule. Maximum of 1000

characters.

This field is available in API version 29.0 and later.

stringdescription

Name for the sharing rule. Corresponds to Label in the user

interface.

stringname

CaseOwnerSharingRule

Represents a sharing rule for a case with users other than the owner. It extends the OwnerSharingRule metadata type and inherits its

fullName, sharedFrom, and sharedTo fields.

CaseOwnerSharingRule is used by the ownerRules field in CaseSharingRules. All the following fields are required.

DescriptionField TypeField

Required. A value that represents the level of access that a group

or role is granted for a case. The possible values are:

ShareAccessLevelReadEdit

(enumeration of type string)

caseAccessLevel

•Read

•Edit

648

OwnerSharingRuleMetadata Types

DescriptionField TypeField

Represents the description of the sharing rule. Maximum of 1000

characters.

This field is available in API version 29.0 and later.

stringdescription

Required. Name for the sharing rule. Corresponds to Label in

the user interface.

stringname

ContactOwnerSharingRule

Represents a sharing rule for a contact with users other than the owner. It extends the OwnerSharingRule metadata type and inherits

its fullName, sharedFrom, and sharedTo fields.

ContactOwnerSharingRule is used by the ownerRules field in ContactSharingRules.

DescriptionField TypeField

Required. A value that represents the level of access that a group

or role is granted for a contact. The possible values are:

ShareAccessLevelReadEdit

(enumeration of type string)

contactAccessLevel

•Read

•Edit

Represents the description of the sharing rule. Maximum of 1000

characters.

This field is available in API version 29.0 and later.

stringdescription

Required. Name for the sharing rule. Corresponds to Label in

the user interface.

stringname

LeadOwnerSharingRule

Represents a sharing rule for a lead with users other than the owner. It extends the OwnerSharingRule metadata type and inherits its

fullName, sharedFrom, and sharedTo fields.

LeadOwnerSharingRule is used by the ownerRules field in LeadSharingRules.

DescriptionField TypeField

Required. A value that represents the level of access that a group

or role is granted for a lead. The possible values are:

ShareAccessLevelReadEdit

(enumeration of type string)

leadAccessLevel

•Read

•Edit

Represents the description of the sharing rule. Maximum of 1000

characters.

This field is available in API version 29.0 and later.

stringdescription

649

OwnerSharingRuleMetadata Types

DescriptionField TypeField

Required. Required. Name for the sharing rule. Corresponds to

Label in the user interface.

stringname

OpportunityOwnerSharingRule

Represents a sharing rule for an opportunity with users other than the owner. It extends the OwnerSharingRule metadata type and

inherits its fullName, sharedFrom, and sharedTo fields.

OpportunityOwnerSharingRule is used by the ownerRules field in OpportunitySharingRules.

DescriptionField TypeField

Required. Name for the sharing rule. Corresponds to Label in

the user interface.

stringname

Represents the description of the sharing rule. Maximum of 1000

characters.

This field is available in API version 29.0 and later.

stringdescription

Required. A value that represents the level of access that a group

or role is granted for an opportunity. The possible values are:

ShareAccessLevelReadEdit

(enumeration of type string)

opportunityAccessLevel

•Read

•Edit

AccountTerritorySharingRule

Represents a rule for sharing an account within a territory. It extends the OwnerSharingRule metadata type and inherits its fullName,

sharedFrom, and sharedTo fields.

AccountTerritorySharingRule is used by the ownerRules field in AccountTerritorySharingRules.

DescriptionField TypeField

Required. A value that represents the level of access that a

Territory or TerritoryAndSubordinates group is granted for an

account territory. The possible values are:

ShareAccessLevelNoNone

(enumeration of type string)

accountAccessLevel

•Read

•Edit

•All

Required. A value that represents the level of access that a

Territory or TerritoryAndSubordinates group is granted for all

child cases to an account. The possible values are:

ShareAccessLevelNoAll

(enumeration of type string)

caseAccessLevel

•None

•Read

650

OwnerSharingRuleMetadata Types

DescriptionField TypeField

•Edit

Required. A value that represents the level of access that a

Territory or TerritoryAndSubordinates group is granted for all

related contacts on an account. The possible values are:

ShareAccessLevelNoAll

(enumeration of type string)

contactAccessLevel

•None

•Read

•Edit

Represents the description of the sharing rule. Maximum of 1000

characters.

This field is available in API version 29.0 and later.

stringdescription

Required. Name for the sharing rule. Corresponds to Label in

the user interface.

stringname

Required. A value that represents the level of access that a

Territory or TerritoryAndSubordinates group is granted for all

ShareAccessLevelNoAll

(enumeration of type string)

opportunityAccessLevel

opportunities associated with an account. The possible values

are:

•None

•Read

•Edit

CustomObjectOwnerSharingRule

Represents a sharing rule for custom objects. It extends the OwnerSharingRule metadata type and inherits its fullName, sharedFrom,

and sharedTo fields.

CustomObjectOwnerSharingRule is used by the ownerRules field in CustomObjectSharingRules.

DescriptionField TypeField

Required. A value that represents the level of access that a group

or role is granted to a custom object. The possible values are:

stringaccessLevel

•Read

•Edit

•All

Represents the description of the sharing rule. Maximum of 1000

characters.

This field is available in API version 29.0 and later.

stringdescription

Required. Name for the sharing rule. Corresponds to Label in

the user interface.

stringname

651

OwnerSharingRuleMetadata Types

UserMembershipSharingRule

Represents a sharing rule to share members of a group with another group of users. It extends the OwnerSharingRule metadata type

and inherits its fullName, sharedFrom, and sharedTo fields.

UserMembershipSharingRule is used by the ownerRules field in UserSharingRules on page 636.

DescriptionField TypeField

Represents the description of the sharing rule. Maximum of 1000

characters.

This field is available in API version 29.0 and later.

stringdescription

Required. Name for the sharing rule. Corresponds to Label in

the user interface.

stringname

Required. A value that represents the level of access that a group

or role is granted for a user. The possible values are:

ShareAccessLevelReadEdit

(enumeration of type string)

userAccessLevel

•Read

•Edit

SharingSet

Represents a sharing set. A sharing set defines an access mapping that grants portal or community users access to objects that are

associated with their accounts or contacts. This type extends the Metadata metadata type and inherits its fullName field.

For example, you can grant portal or community users access to all cases related to their account record. Similarly, you can grant portal

or community users access to all cases related to a parent account that is identified on the user’s account record. For more information,

see “Sharing Set Overview” in the Salesforce Help.

File Suffix and Directory Location

SharingSet components have the suffix .sharingSet and are stored in the sharingSets folder.

Version

SharingSet components are available in API version 30.0 and later.

Fields

DescriptionField TypeField Name

A list of access mappings on a sharing set.AccessMapping[]accessMappings

The sharing set description. Limit: 255 characters.stringdescription

Required. The unique identifier for API access. Corresponds to Sharing

Set Name on the user interface.

stringname

652

SharingSetMetadata Types

DescriptionField TypeField Name

The profiles of users that are granted access to the target objects. Valid

values are:

string[]profiles

•Authenticated Website

•Customer Community User

•Customer Community Login User

•High Volume Customer Portal User

•Overage Authenticated Website User

•Overage High Volume Customer Portal User

AccessMapping

AccessMapping represents an access mapping in the sharing set, which grants access to a target object by looking up to an account or

contact associated with the user.

You can grant portal users access to a target object, or to both a target object and its associated objects, such as an account and its

contacts and cases.

DescriptionField TypeField Name

The target object access level granted to the portal user. Valid values are:stringaccessLevel

•Read

•Edit

A lookup to the target object, which supports standard or custom fields, or an

Id. For accounts or cases associated with entitlements, use

Entitlement.Account or Entitlement.Case.

stringobjectField

The target object to which the portal user is gaining access, and refers to one

of the following:

stringobject

•Account

•Contact

•Case

•ServiceContract

•User

•Custom Objects (e.g. ObjA__c)

Portal users gain access to all order entitlements and order items under an

account to which they have access.

The user’s lookup to an account, contact, or a standard or custom field derived

from an account or contact. Either the user or the user’s manager can be used

in the lookup. Valid values are:

stringuserField

•Account

•Account.Field

653

SharingSetMetadata Types

DescriptionField TypeField Name

•Contact

•Contact.Field

•Manager.Account

•Manager.Contact

Field refers to a standard or custom field based on an account or contact.

Declarative Metadata Sample Definition

The following is an example of a SharingSet component that grants users access to all contacts whose ReportsTo fields match the

users’ contacts.

<?xml version="1.0" encoding="UTF-8"?>

<objectField>ReportsTo</objectField>

<userField>Contact</userField>

</accessMappings>

<description>User Access Mapping</description>

<profiles>customer community user</profiles>

</SharingSet>

The following is an example of a SharingSet component that grants users access to all cases that are related to an entitlement, which is

associated with the user’s account.

<?xml version="1.0" encoding="UTF-8"?>

<objectField>Entitlement.Account</objectField>

<userField>Account</userField>

</accessMappings>

</SharingSet>

The following is an example of a SharingSet component with a list of access mappings.

<?xml version="1.0" encoding="UTF-8"?>

<description>This is a basic sharing set with several access mappings.</description>

<name>Basic</name>

<profiles>customer community user</profiles>

<userField>Account</userField>

654

SharingSetMetadata Types

</accessMappings>

<objectField>Account</objectField>

<userField>Account</userField>

</accessMappings>

<objectField>Contact</objectField>

<userField>Contact</userField>

</accessMappings>

<objectField>AccountLookup__c</objectField>

<userField>Account</userField>

</accessMappings>

</SharingSet>

The following is an example package.xml that references the previous definition.

<fullName>SharingSetBasic</fullName>

<types>

<members>HVPUAccessible__c.AccountLookup__c</members>

<members>HVPUAccessible__c.ContactLookup__c</members>

<name>CustomField</name>

</types>

<types>

<members>HVPUAccessible__c</members>

<name>CustomObject</name>

</types>

<types>

<members>Basic</members>

<name>SharingSet</name>

<types>

</Package>

SiteDotCom

Represents a site for deployment. It extends the MetadataWithContent type and inherits its fullName and content fields.

Declarative Metadata File Suffix and Directory Location

SiteDotCom components are stored in the siteDotComSites directory of the corresponding package directory. The file name for

the metadata .xml file is [sitename].site-meta.xml. The file name for the site file is [sitename].site

655

SiteDotComMetadata Types

Note: There is a file size limitation when using the Metadata API to deploy a site from sandbox to production. The assets in the

.site file can’t be larger than 40 MB. The site gets created, but the assets show in the new site as broken. To fix the assets, export

the assets from the sandbox environment separately and then import them into your new site.

Version

SiteDotCom components are available in API version 30.0 and later.

Fields

DescriptionField TypeField

The name of the site you are deploying.stringlabel

Required. Identifies whether the site is a

ChatterNetworkPicasso site for Salesforce

(enumeration of type

string)

siteType

Communities sites, or a Siteforce site for

Site.com sites.

Declarative Metadata Sample Definition

Sample XML definitions for SiteDotCom are shown below.

<?xml version="1.0" encoding="UTF-8"?>

<label>testsite</label>

<siteType>Siteforce</siteType>

</SiteDotCom>

<?xml version="1.0" encoding="UTF-8"?>

<label>testCommunity</label>

<siteType>ChatterNetworkPicasso</siteType>

</SiteDotCom>

Skill

Represents the settings for a skill used for field service or to route chats to agents in Live Agent, such as the name of the skill and which

agents the skills are assigned to. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

Skill values are stored in the <developer_name>.skill file in the skills directory.

656

SkillMetadata Types

Version

Skill is available in API version 28.0 and later.

Fields

DescriptionField TypeField Name

Specifies how skills are assigned to Live Agent users. Skills

can be assigned to sets of users or sets of profiles.

SkillAssignmentsassignments

Specifies the description of the skill. This field is available in

API version 38.0 and later.

stringdescription

Specifies the name of the skill.stringlabel

SkillAssignments

Represents which users and user profiles to whom specific skills are assigned.

Fields

DescriptionField TypeField Name

Specifies the profiles that are associated with a specific skill.SkillProfileAssignmentsprofiles

Specifies the users that are associated with a specific skill.SkillUserAssignmentsusers

SkillProfileAssignments

Represents the profiles that are associated with a specific skill.

Fields

DescriptionField TypeField Name

Specifies the custom name of the profile associated with a

specific skill.

stringprofile

SkillUserAssignments

Represents the users that are associated with a specific skill.

657

SkillMetadata Types

Fields

DescriptionField TypeField Name

Specifies the username of the user associated with a specific

skill.

stringuser

Declarative Metadata Sample Definition

This is a sample of a skill file.

<?xml version="1.0" encoding="UTF-8"?>

<label>My Skill 1</label>

<profile>LiveAgentOperator</profile>

<profile>LiveAgentSupervisor</profile>

</profiles>

<users>

</users>

</assignments>

</Skill>

StandardValueSet

Represents the set of values in a standard picklist field. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

StandardValueSet components have the suffix .standardValueSet and are stored in the standardValueSets folder.

Version

StandardValueSet components are available in API version 38.0 and later.

Note: StandardValueSet isn’t available in Tooling API. Picklist elements in Tooling API are represented as in API version 37.0.

Fields

DescriptionField TypeField Name

Required. Indicates whether a global value set is sorted in alphabetical

order. By default, this value is false.

booleansorted

Defines each value in a standard picklist’s value set.StandardValue[]standardValue

658

StandardValueSetMetadata Types

Declarative Metadata Sample Definition

The following example shows a StandardValueSet component that’s defined as the Stage standard picklist on a customized opportunity

object.

<?xml version="1.0" encoding="UTF-8"?>

<fullName>OpportunityStage</fullName>

<fullName>Closed Abandoned</fullName>

</standardValue>

<fullName>Closed Won</fullName>

</standardValue>

<fullName>Closed Lost</fullName>

</standardValue>

</StandardValueSet>

<fullName>Opportunity</fullName>

<fullName>StageName</fullName>

<label>Stage</label>

<type>Picklist</type>

</fields>

<label>ObjectWithValueSet</label>

<pluralLabel>ObjectWithValueSet</pluralLabel>

<sharingModel>ReadWrite</sharingModel>

</CustomObject>

For a list of standard value set names for standard picklists, see StandardValueSet Names and Standard Picklist Fields.

StandardValueSetTranslation

Contains details for a standard picklist translation. It returns a translated standard value set.This type extends the Metadata metadata

type and inherits its fullName field.

File Suffix and Directory Location

StandardValueSetTranslation components have the suffix .standardValueSetTranslation and are stored in the

standardValueSetTranslations folder.

Translations are stored in a file with a format of ValueSetName-lang.standardValueSetTranslation, where

ValueSetName is the global value set’s name, and lang is the translation language.

Version

StandardValueSetTranslation components are available in API version 38.0 and later.

659

StandardValueSetTranslationMetadata Types

Fields

DescriptionField TypeField

A list of values from global value sets to be translated.ValueTranslation[]valueTranslation

Declarative Metadata Sample Definition

The following is an example of a StandardValueSetTranslation component. When a value isn’t translated, its translation becomes a

comment that’s paired with its masterLabel.

<?xml version="1.0" encoding="UTF-8"?>

</valueTranslation>

</valueTranslation>

</valueTranslation>

</StandardValueSetTranslation>

The following is an example package.xml that references the StandardValueSetTranslation definition.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>AccountRating-fr</members>

<name>StandardValueSetTranslation</name>

</types>

</Package>

SEE ALSO:

Translations

StaticResource

Represents a static resource file, often a code library in a ZIP file. This type extends the MetadataWithContent metadata type and inherits

its content and fullName fields.

Static resources allow you to upload content that you can reference in a Visualforce page, including archives (such as .zip and .jar files),

images, style sheets, JavaScript, and other files.

660

StaticResourceMetadata Types

File Suffix and Directory Location

The file suffix is .resource for the template file. The accompanying metadata file is named resource-meta.xml.

Static resource components are stored in the staticresources folder in the corresponding package directory.

Version

Static resources are available in API version 12.0 and later.

Fields

This metadata type contains the following fields:

DescriptionField TypeField Name

Required. Indicates whether the static resource is marked with a public caching

tag so that a third-party delivery client can cache the content. This is a new field

in API version 14.0. The valid values are:

StaticResourceCacheControl

(enumeration of type string)

cacheControl

•Private

•Public

The static resource content. Base 64-encoded binary data. Prior to making an

API call, client applications must encode the binary attachment data as base64.

base64Binarycontent

Upon receiving a response, client applications must decode the base64 data to

binary. This conversion is usually handled for you by a SOAP client. This field is

inherited from the MetadataWithContent component.

Required. The content type of the file, for example text/plain.stringcontentType

The description of the static resource.stringdescription

The static resource name. The name can only contain characters, letters, and the

underscore (_) character, must start with a letter, and cannot end with an

underscore or contain two consecutive underscore characters.

Inherited from the Metadata component, this field is not defined in the WSDL

for this component. It must be specified when creating, updating, or deleting.

See create() to see an example of this field specified for a call.

stringfullName

Declarative Metadata Sample Definition

<?xml version="1.0" encoding="UTF-8"?>

<contentType>text/plain</contentType>

<description>Test Resource</description>

</StaticResource>

661

StaticResourceMetadata Types

SynonymDictionary

Represents a set of synonym groups, which are groups of words or phrases that are treated as equivalent in users’ searches. You can

define synonym groups to optimize search results for acronyms, variations of product names, and other terminology unique to your

organization.

Synonyms are available in Service Cloud features such as Salesforce Knowledge. This type extends the Metadata metadata type and

inherits its fullName field.

File Suffix and Directory Location

SynonymDictionary components have the suffix .synonymDictionary and are stored in the synonymDictionaries folder.

Version

SynonymDictionary components are available in API version 29.0 and later.

Special Access Rules

Synonyms must be enabled in your organization. Only users with the “Manage Synonyms” permission can access this object.

Fields

DescriptionField TypeField Name

The synonym groups defined in this dictionary.SynonymGroupgroups

Indicates whether this component is protected (true) or not (false).

Protected components cannot be linked to or referenced by components

created in the installing organization.

booleanisProtected

Required. Specifies the display name of the synonym dictionary.stringlabel

SynonymGroup

Represents a group of synonymous words or phrases.

DescriptionField TypeField Name

Required. Specifies the languages the synonym group applies to. If synonyms

are specific to a single language, specify only that language. If the synonyms

Languagelanguages

apply to multiple languages, specify multiple languages for one synonym

group.

662

SynonymDictionaryMetadata Types

DescriptionField TypeField Name

Required. A word or phrase synonymous with other terms in the group.

Maximum of 50 characters. Minimum of two terms per group.

Synonym groups are symmetric, which means that if oranges and apples are

defined in a synonym group, a search for oranges will return a match for

apples, and vice versa for a search for apples.

stringterms

Declarative Metadata Sample Definition

The following is an example of a SynonymDictionary component:

<?xml version="1.0" encoding="UTF-8"?>

<terms>Salesforce</terms>

<terms>salesforce.com</terms>

<terms>The Customer Company</terms>

</groups>

<terms>renault</terms>

</groups>

<label>Sample Dictionary</label>

</SynonymDictionary>

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

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>Sample Dictionary</members>

<name>SynonymDictionary</name>

</types>

</Package>

Usage

If you have existing synonym groups defined before API version 29.0, your existing groups are associated with a default dictionary called

_Default.

If you have a set of synonyms that require frequent updates, we recommend assigning the synonym group or groups to a dedicated

dictionary with a small number of groups. Each time you deploy an existing dictionary, all of its synonym groups are overwritten. We

don’t support deploying updates to only a single synonym group within a dictionary.

663

SynonymDictionaryMetadata Types

Territory

Represents a territory in your organization.

Declarative Metadata File Suffix and Directory Location

The file suffix for territory components is .territory and components are stored in the territories directory of the

corresponding package directory.

Version

Territory components are available in API version 24.0 and later.

Fields

This metadata type extends to subtype RoleOrTerritory.

DescriptionField TypeField Name

Specifies whether users in this territory can access accounts that are

assigned to this territory and are otherwise inaccessible. Valid values are:

stringaccountAccessLevel

•Read

•Edit

•All

If your organization’s sharing model for accounts is Public Read/Write,

valid values are only Edit and All.

If no value is set for this field, this field value uses the default access level

that is specified in the Manage Territory page in Setup.

This field is available in API version 31.0 and later.

The unique identifier for API access. The fullName can contain only

underscores and alphanumeric characters. It must be unique, begin with

stringfullName

a letter, not include spaces, not end with an underscore, and not contain

two consecutive underscores. This field is inherited from the Metadata

component. Corresponds to Territory Name in the user interface.

The territory above this territory in the territory hierarchy.stringparentTerritory

Declarative Metadata Sample Definition

The following is the definition of a territory.

<?xml version="1.0" encoding="UTF-8"?>

664

TerritoryMetadata Types

<description>Sample Territory</description>

<mayForecastManagerShare>false</mayForecastManagerShare>

</Territory>

Territory2

Represents the metadata associated with a sales territory in Territory Management 2.0. This type extends the Metadata metadata type

and inherits its fullName field.Available only if Territory Management 2.0 has been enabled for your organization.

File Suffix and Directory Location

Territory2 components have the suffix territory2 and are stored in the territories folder under the folder for the corresponding

Territory2Model.

Version

Territory2 components are available in API version 32.0 and later.

Special Access Rules

The Territory2Model object has a State field in the SOAP API. States include Planning, Active, Archived, and a number of

other states, such as Cloning, that indicate that a process is underway. Users who do not have the “Manage Territories” permission

can access only territories that belong to the model in Active state. The “Manage Territories” permission is required for deploy()

calls for all territory management entities, in addition to the “Modify All Data” permission required by Metadata API. Using retrieve()

without the “Manage Territories” permission will return only entities that belong to a Territory2Model in Active state. We recommend

against retrieving without the “Manage Territories” permission because the call will retrieve only partial data.

Fields

DescriptionField TypeField Name

Specifies whether users in this territory can access accounts that are

assigned to this territory and are otherwise inaccessible. Valid values

are:

stringaccountAccessLevel

•Read

•Edit

•All

If your organization’s sharing model for accounts is Public Read/Write,

valid values are only Edit and All. If no value is set for this field,

this field value uses the default access level that is specified in

Territory2Settings as permitted by the organization’s sharing settings.

665

Territory2Metadata Types

DescriptionField TypeField Name

Specifies whether users in this territory can access cases that are

assigned to this territory and are otherwise inaccessible. Valid values

are:

stringcaseAccessLevel

•None

•Read

•Edit

No value should be specified if your organization’s sharing model for

cases/opportunities is Public Read/Write,If no value is set for this field,

this field value uses the default access level that is specified in

Territory2Settings as permitted by the organization’s sharing settings.

Specifies whether users in this territory can access contacts that are

assigned to this territory and are otherwise inaccessible. Valid values

are:

stringcontactAccessLevel

•None

•Read

•Edit

No value should be specified if your organization’s sharing model for

contacts is Public Read/Write or Controlled By Parent,

Values for custom fields defined on the Territory2 object and used by

this territory. Their metadata is captured separately in CustomObject

on page 233. Note the following:

FieldValuecustomFields

•Territory2 and Territory2Model objects do not handle values for

Text Area (Long), Text Area (Rich), and text-encrypted custom fields.

•Fields are referenced using their API names. Compound field types

like Geolocation will appear as their constituent column fields. For

example, nnn_Latitude__s, nnn_Longitude__s where

“nnn” is the field name and the suffixes are the Geolocation

components.

•Values of required custom fields are enforced during the

deploy() operation.

A description of the territory.stringdescription

Required. The user interface label for the territory.stringname

Specifies whether users in this territory can access opportunities that

are assigned to this territory and are otherwise inaccessible. Valid values

are:

stringopportunityAccessLevel

•None

•Read

•Edit

No value should be specified if your organization’s sharing model for

cases/opportunities is Public Read/Write,If no value is set for this field,

666

Territory2Metadata Types

DescriptionField TypeField Name

this field value uses the default access level that is specified in

Territory2Settings as permitted by the organization’s sharing settings.

The name of the territory’s parent. When you specify the parent territory,

use the developer name. Do not use the “fully qualified” name. Custom

stringparentTerritory

fields with no values are retrieved with values of type: <value

xsi:nil="true"/>. You can also use <value

xsi:nil="true"/> syntax to remove existing values in custom

fields.

Represents an object assignment rule and its association to a territory.

Use the developer name of the rule.

Territory2RuleAssociationruleAssociations

Required. The territory type that the territory belongs to.stringterritory2Type

FieldValue

Represents the values of custom fields on the Territory2 object. Available in API version 32.0 and later.

DescriptionField TypeField Name

Required. The user interface label for the territory.stringname

The value of the field, which can also be null. The field type is specified in

the XML and depends on the field value.

any typevalue

Territory2RuleAssociation

Represents the association of an object assignment rule to a territory. Available in API version 32.0 and later.

DescriptionField TypeField Name

Required. Indicates whether the rule is inherited from a parent territory (true)

or local to the current territory (false).

Rule inheritance flows from the parent territory where the rule is created to

the rule’s descendent territories (if any) in the territory model hierarchy. A local

rule is created within a single territory and affects that territory only.

booleaninherited

Required. The name of a rule associated with the territory. ruleName doesn’t

need to be fully qualified because Metadata API assumes that the rule belongs

to the same model as the territory.

stringruleName

667

Territory2Metadata Types

Declarative Metadata Sample Definition

The following example shows the definition of a Territory2 component.

<?xml version="1.0" encoding="UTF-8"?>

<Territory2 xmlns="http://soap.sforce.com/2006/04/metadata"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<description>United States sales</description>

<parentTerritory>Worldwide_Sales</parentTerritory>

<ruleName>AccRule1</name>

</ruleAssociations>

<ruleName>AccRule2</name>

<inherited>False</inherited>

</ruleAssociations>

<name>Activation_DateTime__c</name>

</customFields>

<name>AutoNumber__c</name>

</customFields>

<name>DeactivationDate__c</name>

</customFields>

<name>External_Id__c</name>

</customFields>

<name>ManagersPhone__c</name>

</customFields>

</Territory2>

The following is a package.xml sample. FY13 and FY14 represent the names of territory models and demonstrate that rules

can have identical developer names within different models. A wildcard character (*) in place of the model name can be used to retrieve

all rules in all models in an organization.

<?xml version="1.0" encoding="UTF-8"?>

<types>

668

Territory2Metadata Types

<name>Territory2Model</name>

</types>

<types>

<members>FY13.Worldwide_Sales</members>

<name>Territory2</name>

</types>

</Package>

Usage

•Triggers defined on Territory2 will not fire during a deploy() operation.

•Territory Management 2.0 components don’t support packaging or change sets and aren’t supported in CRUD calls.

Territory2Model

Represents the metadata associated with a territory model in Territory Management 2.0. This type extends the Metadata metadata type

and inherits its fullName field.Available only if Territory Management 2.0 has been enabled for your Salesforce org.

File Suffix and Directory Location

Territory2Model components have the suffix territory2Model and are stored in the territory2Models folder.

Version

Territory2Model components are available in API version 32.0 and later.

Special Access Rules

The Territory2Model object has a State field in the SOAP API. States include Planning, Active, Archived, and a number of

other states, such as Cloning, that indicate that a process is underway. Users who do not have the “Manage Territories” permission

can access only models in Active state. The “Manage Territories” permission is required for deploy() calls for all territory

management entities, in addition to the “Modify All Data” permission required by Metadata API. Using retrieve() without the

“Manage Territories” permission will return only entities that belong to a Territory2Model in Active state. We recommend against

retrieving without the “Manage Territories” permission because the call will retrieve only partial data.

669

Territory2ModelMetadata Types

Fields

DescriptionField TypeField Name

Custom fields defined on the Territory2Model object and used by this

model. Their metadata is captured separately.

FieldValuecustomFields

•Territory2 and Territory2Model objects do not handle values for Text

Area (Long), Text Area (Rich), and text-encrypted custom fields.

•Fields are referenced using their API names. Compound field types

like Geolocation will appear as their constituent column fields. For

example, nnn_Latitude__s, nnn_Longitude__s where

“nnn” is the field name and the suffixes are the Geolocation

components.

•Values of required custom fields are enforced during the

deploy() operation.

A description for the territory model.stringdescription

Required. The user interface label for the territory model..stringname

Declarative Metadata Sample Definition

The following example shows the definition of a Territory2Model component.

<?xml version="1.0" encoding="UTF-8"?>

<Territory2Model xmlns="http://soap.sforce.com/2006/04/metadata"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<description>Geographic allocation</description>

<name>Activation_DateTime__c</name>

</customFields>

<name>AutoNumber__c</name>

</customFields>

<name>DeactivationDate__c</name>

</customFields>

<name>External_Id__c</name>

</customFields>

</Territory2Model>

670

Territory2ModelMetadata Types

Usage

•The retrieve() call will not return models in these four states: Cloning, Cloning Failed, Deleting, and Deletion

Failed.

•Whenever a model is created, its initial state is Planning. You can only do a deploy() operation for models in Planning

or Active state. The same requirement applies to territories and rules associated with those models. For example, you might have

a model in Planning state on a sandbox org, and a model with the same developer name in Archived state on your production

org. The deploy() operation on production will fail because that model’s state is Archived and that state prevents changes

to the model.

•Because of the state restrictions, if you have territory models in different orgs with identical developer names and you attempt a

deploy() operation, Metadata API will attempt to create new models, but that operation will fail because of the developer name

conflict. For example, you might have a model in Planning state on a sandbox org, and a model with the same developer name

in Archived state on your production org. The deploy() operation on production will fail because that model’s state is

Archived and that state prevents changes to the model.

•If you try to delete a model that has territories, then the delete() call will change the model’s state to Deleting and cascade

delete all territories, rules, and user associations in the model. Deleting may take some time depending on the number of territries

in the model.

•Whenever a model is created, its initial state is Planning. If a model with the same developer name already exists, it will already

have a state, so we do not include the State field in Territory2.

•Territory Management 2.0 components don’t support packaging or change sets and aren’t supported in CRUD calls.

Territory2Rule

Represents the metadata associated with a territory assignment rule associated with an object, such as Account, in Territory Management

2.0. This type extends the Metadata metadata type and inherits its fullName field.Available only if Territory Management 2.0 has

been enabled for your Salesforce org.

File Suffix and Directory Location

Territory2Rule components have the suffix territory2Rule and are stored in the rules folder under the folder for the

corresponding Territory2Model.

Version

Territory2Rule components are available in API version 32.0 and later.

Special Access

The Territory2Model object has a State field in the SOAP API. States include Planning, Active, Archived, and a number of

other states, such as Cloning, that indicate that a process is underway. Users who do not have the “Manage Territories” permission

can access only rules that belong to the model in Active state. The “Manage Territories” permission is required for deploy() calls

for all territory management entities, in addition to the “Modify All Data” permission required by Metadata API. Using retrieve()

without the “Manage Territories” permission will return only entities that belong to a Territory2Model in Active state. We recommend

against retrieving without the “Manage Territories” permission because the call will retrieve only partial data.The SOAP API and the user

interface require that a user attempting to create or edit a rules has field-level security access to the fields referenced in the rule item.

671

Territory2RuleMetadata Types

This restriction is relaxed for Metadata API deploy() operations, as those require “Modify All Data” and “Manage Territories” permissions.

“Modify All Data” is the base permission requirement for all Metadata API operations.

Fields

DescriptionField TypeField Name

Required. Indicates whether the rule is active (true) or inactive

(false). Via the API, active rules run automatically when object records

booleanactive

are created and edited. The exception is when the value of the

IsExcludedFromRealign field on an object record is true,

which prevents record assignment rules from evaluating that record.

An advanced filter condition. For example: (1 AND 2) OR 3.

Numbering must start at 1 and must be contiguous.

stringbooleanFilter

Required. The user interface label for the rule.stringname

Required. The object that the rule is defined for. For API version 32.0, the

only available object is Account.

stringobjectType

The items that define a rule’s the selection criteria, such as Billing

State equals California.

Territory2RuleItem

on page 672

ruleItems

Territory2RuleItem

Represents the association of a rule item to a rule. Available in API version 32.0 and later.

DescriptionField TypeField Name

The standard or custom object field that the rule item operates on.stringfield

The criterion to apply for the rule item. For example: equals or starts

with.

FilterOperation

(enumeration of type

string)

operation

The field value or values to evaluate. For example: if the field is Billing

ZIP/Postal Code, a value might be 94105.

stringvalue

Declarative Metadata Sample Definition

The following example shows the definition of a Territory2RuleItem component.

<?xml version="1.0" encoding="UTF-8"?>

<label>Northern CA</label>

<description>To capture northern CA based accounts</description>

<objectType>Account</objectType>

672

Territory2RuleMetadata Types

<field>BillingZip</field>

<operation>contains</operation>

</ruleItems>

<field>Industry</field>

<operation>equals</operation>

</ruleItems>

<field>someCustomField__c</field>

<operation>greater_than</operation>

</ruleItems>

</Territory2Rule>

The following is a package.xml sample. FY13 and FY14 represent names of territory models and demonstrate that rules can

have identical developer names within different models. A wildcard character (*) in place of the model name can be used to retrieve all

rules in all models in an org.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>Territory2Model</name>

</types>

<types>

<members>FY13.AccRule1</members>

<members>FY14.AccRule1</members>

<name>Territory2Rule</name>

</types>

</Package>

Usage

•A territory rule can have up to 10 rule items.

•The sort order of rule items is implicitly derived from the position of the rule items in the XML

•Rules can’t be run via Metadata API.

•Territory Management 2.0 components don’t support packaging or change sets and aren’t supported in CRUD calls.

Territory2Type

Represents the metadata for a category of territories in Territory Management 2.0. Every Territory2 must have a Territory2Type. This type

extends the Metadata metadata type and inherits its fullName field.Available only if Enterprise Territory Management has been

enabled for your Salesforce org.

673

Territory2TypeMetadata Types

File Suffix and Directory Location

Territory2Type components have the suffix territory2Type and are stored in the territory2Types folder.

Version

Territory2Type components are available in API version 32.0 and later.

Special Access Rules

Users without the “Manage Territories” permission will be able to retrieve all the Territory2Types in the org. “Manage Territories” permission

is required for the deploy() operation, in addition to the “Modify All Data” permission required by the Metadata API.

Fields

DescriptionField TypeField Name

A description of the territory type.stringdescription

Required. The user interface label for the territory type.stringname

Required. Used for Filter-Based Opportunity Territory Assignment

(Pilot in Spring ’15 / Metadata API version 33). Lets you specify a

intpriority

priority for a territory type. For opportunity assignments, the filter

examines all territories assigned to the account that the opportunity

is assigned to. The account-assigned territory whose territory type

priority is highest is then assigned to the opportunity. The

priority field value on each territory type must be unique.

Further, if there are multiple territories with the same territory type

(and therefore the same priority) assigned to the account, no territory

is not assigned to the opportunity.

Declarative Metadata Sample Definition

The following example shows the definition of a Territory2Type component.

<?xml version="1.0" encoding="UTF-8"?>

<description>Geographic allocation</description>

</Territory2Type>

Usage

Territory Management 2.0 components don’t support packaging or change sets and aren’t supported in CRUD calls.

674

Territory2TypeMetadata Types

TransactionSecurityPolicy

Represents a transaction security policy definition. Transaction Security policies give you a way to look through events in your organization

and specify actions to take when certain combinations occur.

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

TransactionSecurityPolicy components have the suffix .transactionSecurityPolicy and are stored in the

transactionSecurityPolicies folder.

Version

TransactionSecurityPolicy components are available in API version 35.0 and later.

Fields

DescriptionField TypeField Name

Required. Describes the action to take when the matching

Transaction Security policy is triggered.

TransactionSecurityActionaction

Required. If true, the policy is enabled and is actively monitoring

its event.

booleanactive

Required. The name of the class that implements the

TxnSecurity.PolicyCondition interface for this policy.

stringapexClass

Optional. A description of the policy.stringdescription

Optional. This unique name prevents conflicts with other policies

that have the same masterLabel. This name can contain only

stringdeveloperName

underscores and alphanumeric characters, and must be unique in

your org. It must begin with a letter, not include spaces, not end

with an underscore, and not contain two consecutive underscores.

Indicates which type of event is being monitored. Valid values are:MonitoredEvents (enumeration

of type string)

eventType

•AccessResource—Notifies you when the selected

resource has been accessed.

•AuditTrail—Reserved for future use.

•DataExport—Notifies you when the selected object type

has been exported using the Data Loader API client.

•Entity—Notifies you on use of an object type such as an

authentication provider or client browser.

•Login—Notifies you when a user logs in.

675

TransactionSecurityPolicyMetadata Types

DescriptionField TypeField Name

Required. The name of the user to notify when the policy is

triggered, if any notifications have been selected. This user must

have the System Administrator profile.

stringexecutionUser

Optional. The master label for this object. This display value is the

internal label that is not translated.

stringmasterLabel

Required. A resource used to narrow down the conditions under

which the policy triggers. For example, with a Login event, you

stringresourceName

can add a resource to specify that only a specific login URL triggers

the policy. The resources available depend on the Event Type

field. Valid resources are grouped below by event type.

•AccessResource—EventTimestamp, SessionLevel, SourceIp

•DataExport—EventTimestamp, SessionLevel, SourceIp

•Entity—AuthorizeUrl, ConsumerKey, ConsumerSecret,

DefaultScopes, DeveloperName, ErrorUrl, FriendlyName,

IconUrl, IdTokenIssuer, LogoutUrl, TokenUrl, UserInfoUrl

•Login—ApiType, ApiVersion, Application, Browser,

ClientVersion, LoginUrl, Platform, Status

TransactionSecurityAction

Describes the action to take when the matching Transaction Security policy is triggered.

DescriptionField TypeField Name

Required. If true, the requested operation is blocked. This action

only applies to Login and AccessResource events.

booleanblock

Required. If true, a current session must be closed before a new

session can be started. This action only applies to Login events.

booleanendSession

Specifies how to notify the ystem administrator when the action

is triggered. There can be none, one, or multiple notifications.

TransactionSecurityNotification[]notifications

Required. If true, two-factor authentication is required for a

higher level of access before the requested operation can continue.

This action only applies to Login and AccessResource events.

booleantwoFactorAuthentication

TransactionSecurityNotification

Describes who to notify and how to notify them when the matching Transaction Security policy is triggered.

DescriptionField TypeField Name

True if an in-app notification is selected.booleaninApp

676

TransactionSecurityPolicyMetadata Types

DescriptionField TypeField Name

True if an email notification is selected.booleansendEmail

The administrator to receive the notification. This user must belong

to the System Administrator profile.

stringuser

Declarative Metadata Sample Definition

The following is an example of a TransactionSecurityPolicy component.

<?xml version="1.0" encoding="UTF-8"?>

<endSession>false</endSession>

<inApp>false</inApp>

<user>admin@your.org</user>

</notifications>

<twoFactorAuthentication>false</twoFactorAuthentication>

</action>

<apexClass>TxnSecurityMdApiPolicy</apexClass>

<eventType>Login</eventType>

<executionUser>admin@your.org</executionUser>

<resourceName>LoginHistory</resourceName>

</TransactionSecurityPolicy>

The following is an example package manifest used to deploy or retrieve the transaction security metadata for an organization.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<members>MySecurityPolicy</members>

<name>TransactionSecurityPolicy</name>

</types>

</Package>

Translations

This metadata type allows you to work with translations for various supported languages. This type extends the Metadata metadata

type and inherits its fullName field. The ability to translate component labels is part of the Translation Workbench. For more information,

see “Enable and Disable the Translation Workbench” in the Salesforce online help.

Language

A two-character language code identifies each language, such as en, or a five-character locale code, such as en_AU.

677

TranslationsMetadata Types

Note: Setting a default locale is different from setting a default language.

Salesforce offers full support for the following languages.

•Chinese (Simplified): zh_CN

•Chinese (Traditional): zh_TW

•Danish: da

•Dutch: nl_NL

•English: en_US

•Finnish: fi

•French: fr

•German: de

•Italian: it

•Japanese: ja

•Korean: ko

•Norwegian: no

•Portuguese (Brazil): pt_BR

•Russian: ru

•Spanish: es

•Spanish (Mexico): es_MX

•Swedish: sv

•Thai: th

End-user languages are useful if you have a multilingual organization or partners who speak languages other than your company’s

default language. For end-user languages, Salesforce provides translated labels for all standard objects and pages, except administrative

pages, Setup, and Help. When you specify an end-user language, labels and Help that aren’t translated appear in English. End-user

languages are intended only for personal use by end users. Don’t use end-user languages as corporate languages. Salesforce doesn’t

provide customer support in end-user languages.

End-user languages include:

•Arabic: ar

•Bulgarian: bg

•Croatian: hr

•Czech: cs

•English (UK): en_GB

•Greek: el

•Hebrew: iw

•Hungarian: hu

•Indonesian: in

•Polish: pl

•Portuguese (Portugal): pt_PT

•Romanian: ro

•Slovak: sk

•Slovenian: sl

678

TranslationsMetadata Types

•Turkish: tr

•Ukrainian: uk

•Vietnamese: vi

Note: Salesforce provides limited support for right-to-left languages—Arabic and Hebrew—for the following features.

•Live Agent

•Cases

•Accounts

These features are not supported in Lightning Experience, the Salesforce1 mobile app, any other mobile app or mobile browser,

or any user interface except Salesforce Classic. There is no guarantee that right-to-left languages function correctly with any other

Salesforce features. There are no plans to expand the list of supported features.

Features that aren’t supported for right-to-left languages include, but are not limited to, the following.

•Report Builder

•Generating quote PDFs

•Customizable forecasting

•Emails

•Salesforce Knowledge

•Feeds

•Communities

The absence of a feature from this list does not imply support. Only Live Agent, Cases, and Accounts are supported with right-to-left

languages.

In situations where Salesforce doesn’t provide default translations, use platform-only languages to localize apps and custom functionality

that you’ve built on the Salesforce App Cloud. You can translate items such as custom labels, custom objects, and field names. You can

also rename most standard objects, labels, and fields. Informative text and non-field label text aren’t translatable.

Platform-only languages are available in all places where you can select a language in the application. However, when you select a

platform-only language, all standard Salesforce labels default to English or, in select cases, to an end-user or fully supported language.

•Albanian: sq

•Arabic (Algeria): ar_DZ

•Arabic (Bahrain): ar_BH

•Arabic (Egypt): ar_EG

•Arabic (Iraq): ar_IQ

•Arabic (Jordan): ar_JO

•Arabic (Kuwait): ar_KW

•Arabic (Lebanon): ar_LB

•Arabic (Libya): ar_LY

•Arabic (Morocco): ar_MA

•Arabic (Oman): ar_OM

•Arabic (Qatar): ar_QA

•Arabic (Saudi Arabia): ar_SA

•Arabic (Sudan): ar_SD

•Arabic (Syria): ar_SY

679

TranslationsMetadata Types

•Arabic (Tunisia): ar_TN

•Arabic (United Arab Emirates): ar_AE

•Arabic (Yemen): ar_YE

•Armenian: hy

•Basque: eu

•Bosnian: bs

•Bengali: bn

•Chinese (Simplified—Singapore): zh_SG

•Chinese (Traditional—Hong Kong): zh_HK

•English (Australia): en_AU

•English (Canada): en_CA

•English (Hong Kong): en_HK

•English (India): en_IN

•English (Ireland): en_IE

•English (Malaysia): en_MY

•English (Philippines): en_PH

•English (Singapore): en_SG

•English (South Africa): en_ZA

•Estonian: et

•French (Belgium): fr_BE

•French (Canada): fr_CA

•French (Luxembourg): fr_LU

•French (Switzerland): fr_CH

•Georgian: ka

•German (Austria): de_AT

•German (Luxembourg): de_LU

•German (Switzerland): de_CH

•Hindi: hi

•Icelandic: is

•Irish: ga

•Italian (Switzerland): it_CH

•Latvian: lv

•Lithuanian: lt

•Luxembourgish: lb

•Macedonian: mk

•Malay: ms

•Maltese: mt

•Romanian (Moldova): ro_MD

•Montenegrin: sh_ME

•Romansh: rm

680

TranslationsMetadata Types

•Serbian (Cyrillic): sr

•Serbian (Latin): sh

•Spanish (Argentina): es_AR

•Spanish (Bolivia): es_BO

•Spanish (Chile): es_CL

•Spanish (Colombia): es_CO

•Spanish (Costa Rica): es_CR

•Spanish (Dominican Republic): es_DO

•Spanish (Ecuador): es_EC

•Spanish (El Salvador): es_SV

•Spanish (Guatemala): es_GT

•Spanish (Honduras): es_HN

•Spanish (Nicaragua): es_NI

•Spanish (Panama): es_PA

•Spanish (Paraguay): es_PY

•Spanish (Peru): es_PE

•Spanish (Puerto Rico): es_PR

•Spanish (United States): es_US

•Spanish (Uruguay): es_UY

•Spanish (Venezuela): es_VE

•Tagalog: tl

•Tamil: ta

•Urdu: ur

•Welsh: cy

Declarative Metadata File Suffix and Directory Location

Translations are stored in a file with a format of localeCode.translation, where localeCode is the locale code of the

translation language. For example, the file name for German translations is de.translation. The supported locale codes are listed

in Language.

Custom object translations are stored in the translations folder in the corresponding package directory.

Version

Translations components are available in API version 14.0 and later.

Fields

DescriptionField TypeField

A list of custom application translations.CustomApplicationTranslation[]customApplications

681

TranslationsMetadata Types

DescriptionField TypeField

A list of custom label translations.CustomLabelTranslation[]customLabels

A list of translations for web links defined in a home page

component.

CustomPageWebLinkTranslation[]customPageWebLinks

A list of custom tab translations.CustomTabTranslation[]customTabs

Required. The language code; for example, de for

German.

Inherited from Metadata, this field is not defined in the

WSDL for this metadata type. It must be specified when

stringfullName

creating, updating, or deleting. See create() to see

an example of this field specified for a call.

A list of global picklist translations. A global picklist’s

value set is inherited by all the custom picklist fields that

are based on it.

This field is available in API version 37.0 only and is

removed from later versions.

GlobalPicklistTranslation[]globalPicklists

A list of global (rather than object-specific) quick actions.GlobalQuickActionTranslation[]quickActions

A list of report type translations.ReportTypeTranslation[]reportTypes

A list of s-control translations.ScontrolTranslation[]scontrols

CustomApplicationTranslation

CustomApplicationTranslation contains details for a custom application translation. For more details, see CustomApplication.

DescriptionField TypeField

Required. The translated custom application name. Maximum

of 765 characters.

stringlabel

Required. The name of the custom application.stringname

CustomLabelTranslation

CustomLabelTranslation contains details for a custom label translation. For more details, see CustomLabels.

DescriptionField TypeField

Required. The translated custom label name. Maximum of 765

characters.

stringlabel

Required. The custom label name.stringname

682

TranslationsMetadata Types

CustomPageWebLinkTranslation

CustomPageWebLinkTranslation contains details for a translation of a web link defined in a home page component. For more details,

see CustomPageWebLink.

DescriptionField TypeField

Required. The translated web link.stringlabel

Required. The name of the web link.stringname

CustomTabTranslation

CustomTabTranslation contains details for a translation of a custom tab. For more details, see CustomTab.

DescriptionField TypeField

Required. The translated custom tab name.stringlabel

Required. The custom tab name.stringname

GlobalPicklistTranslation

Note: GlobalPicklistTranslation is available in API version 37.0 only and is removed from later versions.

GlobalPicklistTranslation contains details for a global picklist translation.

Translations are stored in a file with a format of globalPicklistName__e-lang.objectTranslation, where

globalPicklistName__e is the global picklist name, and lang is the translation language. To reference a global picklist

translation value, use globalPicklistName__e.value1, where value1 is the translated value for the user interface.

Here’s what translations look like for a global picklist.

<?xml version="1.0" encoding="UTF-8"?>

<name>transpicklist</name>

<masterLabel>Three</masterLabel>

<translation>Trois</translation>

</picklistValues>

<translation>Quatre</translation>

</picklistValues>

</globalPicklists>

</Translations>

DescriptionField TypeField

Required. Represents the name of a global picklist to be

translated.

stringname

683

TranslationsMetadata Types

DescriptionField TypeField

A list of picklist values from global picklists to be translated.PicklistValueTranslation[]picklistValues

GlobalQuickActionTranslation

GlobalQuickActionTranslation contains details for the translation of a quick action, globally. For more information, see QuickAction.

DescriptionField TypeField

Required. The translated quick action name, globally.stringlabel

Required. The quick action name.stringname

ReportTypeTranslation

ReportTypeTranslation contains details for a translation of a custom report type. For more details, see ReportType.

DescriptionField TypeField

The translated report type description.stringdescription

The translated report type name.stringlabel

Required. The name of the report type.stringname

A list of report type section translations.ReportTypeSectionTranslation[]sections

ReportTypeSectionTranslation

ReportTypeSectionTranslation contains details for a report type section translation.

DescriptionField TypeField

A list of report type column translations.ReportTypeColumnTranslation[]columns

The translated report type section name.stringlabel

Required. The name of the report type section.stringname

ReportTypeColumnTranslation

ReportTypeColumnTranslation contains details for a report type column translation.

DescriptionField TypeField

Required. The translated report type column name.stringlabel

Required. The report type column name.stringname

684

TranslationsMetadata Types

ScontrolTranslation

Important: Visualforce pages supersede s-controls. Organizations that haven’t previously used s-controls can’t create them.

Existing s-controls are unaffected, and can still be edited.

ScontrolTranslation contains details for a translation of an s-control. For more information, see “About S-Controls” in the Salesforce online

help.

DescriptionField TypeField

Required. The translated s-control name.stringlabel

Required. The name of the s-control.stringname

Declarative Metadata Sample Definition

A sample XML definition of a translations component is shown below.

<?xml version="1.0" encoding="UTF-8"?>

<label>Angebot-Manager</label>

<name>Quote Manager</name>

</customApplications>

<label>Dieses ist ein manuelles Angebot</label>

<name>quoteManual</name>

</customLabels>

</Translations>

Usage

When you use the retrieve() call to get translations in your organization, the files returned in the .translations folder only

include translations for the other metadata types referenced in package.xml. For example, the following package.xml file

contains types elements that match all custom applications, custom labels, Web links defined in home page components, custom

tabs, report types, and s-controls. Translations for all these metadata types are returned because each metadata type is explicitly listed

in package.xml.

<?xml version="1.0" encoding="UTF-8"?>

<types>

<name>CustomApplication</name>

</types>

<types>

<name>CustomLabels</name>

</types>

<types>

<name>CustomPageWebLink</name>

</types>

685

TranslationsMetadata Types

<types>

<name>CustomTab</name>

</types>

<types>

<name>ReportType</name>

</types>

<types>

<name>Scontrol</name>

</types>

<types>

<name>Translations</name>

</types>

</Package>

SEE ALSO:

CustomLabels

UserCriteria

Represents the member criteria to use in community moderation rules. This type extends the Metadata metadata type and inherits its

fullName field..

File Suffix and Directory Location

UserCriteria components have the suffix community_name.user_criteria_developer_name.userCriteria and

are stored in the UserCriteria folder.

Version

UserCriteria components are available in API version 39.0 and later.

Special Access Rules

To view, create, edit, and delete moderation rules, you need the Manage Communities or Create and Set Up Communities permission.

Fields

DescriptionField TypeField Name

If specified, includes only users that were created within a specific time

frame.

intcreationAgeInSeconds

The description of the user criteria.stringdescription

686

UserCriteriaMetadata Types

DescriptionField TypeField Name

If specified, includes only members that have posted or commented in

the community within a specific time frame.

intlastChatterActivityAgeInSeconds

Name of the user criteria.stringmasterLabel

The member type to use in moderation rules. Valid values are:NetworkUserType

(enumeration of

type string)

userTypes

•Internal

•Customer

•Partner

Declarative Metadata Sample Definition

The following is an example of a UserCriteria component.

<?xml version="1.0" encoding="UTF-8"?>

<masterLabel>Customer and Partner Members</masterLabel>

<description>Member criteria matches customer and partner member</description>

<userTypes>Partner</userTypes>

<userTypes>Customer</userTypes>

</UserCriteria>

WaveApplication

Represents the Wave Analytics application. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

WaveApplication components have the suffix .wapp and are stored in the wave folder.

Version

WaveApplication components are available in API version 37.0 and later.

Fields

DescriptionField TypeField Name

The icon that represents the Wave application.stringassetIcon

The description that appears in the user interface.stringdescription

The internal api name of the folder or application.stringfolder

The user interface label name of the folder or application.stringmasterLabel

687

WaveApplicationMetadata Types

DescriptionField TypeField Name

The folder sharing rules.FolderShareshares

The internal (unique) name of the template used to create the

application. This field is blank if the application was not created from a

template.

stringtemplateOrigin

The version assigned to the application template by the template's

creator. This field is blank if the application was not created from a

template.

stringtemplateVersion

Declarative Metadata Sample Definition

The following is an example of a WaveApplication component.

<?xml version="1.0" encoding="UTF-8"?>

<assetIcon>/analytics/wave/web/proto/images/app/icons/11.png</assetIcon>

<description>Application that shows my sales</description>

<masterLabel>Sales Application</masterLabel>

<accessLevel>EditAllContents</accessLevel>

<sharedTo>shareswith@org.ee</sharedTo>

</shares>

</WaveApplication>

WaveDataflow

Represents the WaveDataflow object in the Wave Analytics application. This type extends the MetadataWithContent metadata type and

inherits its content and fullName fields.

File Suffix and Directory Location

WaveDataflow components have the suffix .wdf and are stored in the wave folder.

Version

WaveDataflow components are available in API version 37.0 and later.

Fields

DescriptionField TypeField Name

The dataflow description that appears in the user interface.stringdescription

Required. The dataflow name that appears in the user interface.stringmasterLabel

688

WaveDataflowMetadata Types

Declarative Metadata Sample Definition

The following is an example of a WaveDataflow component.

<?xml version="1.0" encoding="UTF-8"?>

<WaveDataflow xmlns="http://soap.sforce.com/2006/04/metadata"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <content xsi:nil="true"/>

</WaveDataflow>

WaveDashboard

Represents the WaveDashboard object in the Wave Analytics application. This type extends the MetadataWithContent metadata type

and inherits its content and fullName fields.

File Suffix and Directory Location

WaveDashboard components have the suffix .wdash and are stored in the wave folder.

Version

WaveDashboard components are available in API version 37.0 and later.

Fields

DescriptionField TypeField Name

Required. The internal name of the application.stringapplication

The dashboard description that appears in the user interface.stringdescription

Required. The dashboard name that appears in the user interface.stringmasterLabel

Links the dashboard to the template used to create it. Null for assets not

created from a template.

stringtemplateAssetSourceName

Declarative Metadata Sample Definition

The following is an example of a WaveDashboard component.

<?xml version="1.0" encoding="UTF-8"?>

<WaveDashboard xmlns="http://soap.sforce.com/2006/04/metadata"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<masterLabel>Dashboard1</masterLabel>

<description>somedesc</description>

</WaveDashboard>

689

WaveDashboardMetadata Types

WaveDataset

Represents the WaveDataset object in the Wave Analytics application. This type extends the Metadata metadata type and inherits its

fullName field.

File Suffix and Directory Location

WaveDataset components have the suffix .wds and are stored in the wave folder.

Version

WaveDataset components are available in API version 37.0 and later.

Fields

DescriptionField TypeField Name

Required. The internal name of the application.stringapplication

The dataset description that appears in the user interface.stringdescription

Required. The user interface label name of the Dataset.stringmasterLabel

Links the dataset to the template used to create it. Null for assets not

created from a template.

stringtemplateAssetSourceName

Declarative Metadata Sample Definition

The following is an example of a WaveDataset component.

<application>SharedApp</application>

<description>description</description>

<masterLabel>datasetl</masterLabel>

</WaveDataset>

WaveLens

Represents the WaveLens object in the Wave Analytics application. This type extends the MetadataWithContent metadata type and

inherits its content and fullName fields.

File Suffix and Directory Location

WaveLens components have the suffix .wlens and are stored in the wave folder.

690

WaveDatasetMetadata Types

Version

WaveLens components are available in API version 37.0 and later.

Fields

DescriptionField TypeField Name

Required. The internal name of the application.stringapplication

A reference to the dataset used to create this lens.stringdatasets

The dashboard description that appears in the user interface.stringdescription

Required. The user interface label name of the dashboard.stringmasterLabel

Links the lens to the template used to create it. Null for assets not created

from a template.

stringtemplateAssetSourceName

Required. The visualization type to be used for this lens. Valid values are:stringvisualizationType

•calheatmap—Calendar heat map

•comparisontable—Comparison table

•heatmap—Heat map

•hbar—Horizontal bar

•hbarhdot—Horizontal dot plot

•matrix—Matrix

•parallelcoords—Parallel coordinates

•pie—Donut

•pivottable—Pivot table

•scatter—Scatter plot

•stackhbar—Stacked horizontal bar

•stackvbar—Stacked vertical bar

•time—Time line

•valuestable—Values table

•vbar—Vertical bar

•vdot—Vertical dot plot

Declarative Metadata Sample Definition

The following is an example of a WaveLens component.

<?xml version="1.0" encoding="UTF-8"?>

<WaveLens xmlns="http://soap.sforce.com/2006/04/metadata"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

691

WaveLensMetadata Types

<description>lens in shared app</description>

</WaveLens>

WaveTemplateBundle

Represents a Wave Analytics template bundle, which can be used to create Wave apps. A bundle contains a Wave template definition

and all its related resources.This type extends the Metadata metadata type and inherits its fullName field.

Note: We provide this feature to selected customers through a pilot program that requires agreement to specific terms and

conditions. To be nominated to participate in the program, contact Salesforce. Because pilot programs are subject to change, we

can’t guarantee acceptance. This pilot feature isn’t generally available, as referenced in this document or in press releases or public

statements. We can’t guarantee that it will become generally available within any particular time frame or at all. Make your purchase

decisions only on the basis of generally available features. Services provided by the Wave REST API are subject to change. Support

is not provided.

File Suffix and Directory Location

A Wave template bundle is a folder that contains definition files for a template. Unlike other metadata components, a WaveTemplateBundle

component isn’t represented by a single component file, but instead by a collection of JSON and CSV definition files. Each definition file

represents a resource in a template, such as lenses, dashboards, dataflows, and comma-separated values. For example, this directory

structure shows the hierarchy of the folders and files for one Wave Template definition, template1.

waveTemplates

template1

template-info.json

variables.json

ui.json

extFiles

PostalCodes.csv

Wave template bundles must be under a top-level folder that’s named waveTemplates. Each bundle must have its own subfolder

under the waveTemplates folder and be named with the template's fully qualified API name. The bundle folder must contain a

template-info.json file to specify the metadata about the template and the references to other definition files. An entire bundle doesn’t

have a suffix and definition files can have one of the following suffixes.

Component TypeSuffix

JavaScript Object Notation.json

Comma-Separated Values.csv

Version

WaveTemplateBundle components are available in API version 35.0 and later.

692

WaveTemplateBundleMetadata Types

Special Access Rules

Definitions can be created in both managed and unmanaged packages.

Fields

DescriptionField TypeField Name

The icon to use by default for new Wave apps based on this template.

Valid values are 1.png through 20.png.

stringassetIcon

The specification of the template.stringdescription

Required. The label of the template.stringlabel

Required. The type of the template. Valid values are:stringtemplateType

•App

•Dashboard

•Lens

Wavexmd

Represents the WaveXmd object in the Wave Analytics application. This type extends the Metadata metadata type and inherits its

fullName field.

File Suffix and Directory Location

WaveXmd components have the suffix .xmd and are stored in the wave folder.

Version

WaveXmd components are available in API version 39.0 and later.

Fields

DescriptionField TypeField Name

Specifies the dataset associated with this Xmd.stringdataset

The name of the connector source for the dataset.stringdatasetConnector

Specifies the fully qualified name of the dataset version associated with

this Xmd.

stringdatasetFullyQualifiedName

List of dates, with formatting information.WaveXmdDatedates

List of dimensions, with formatting information.WaveXmdDimensiondimensions

693

WavexmdMetadata Types

DescriptionField TypeField Name

List of measures, with formatting information.WaveXmdMeasuremeasures

List of organizations, for multi-organization support.WaveXmdOrganizationorganizations

The origin of the dataset version.stringorigin

WaveXmdDate

WaveXmdDate represents a date in Wave Xmd.

DescriptionField TypeField

Alias of the Date column.stringalias

Whether the date should be displayed in compact form.booleancompact

The day field.stringdateFieldDay

The epoch day field.stringdateFieldEpochDay

The epoch second field.stringdateFieldEpochSecond

The fiscal month field.stringdateFieldFiscalMonth

The fiscal quarter field.stringdateFieldFiscalQuarter

The fiscal week field.stringdateFieldFiscalWeek

The fiscal year field.stringdateFieldFiscalYear

The full year field.stringdateFieldFullYear

The hour field.stringdateFieldHour

The minute field.stringdateFieldMinute

The month field.stringdateFieldMonth

The quarter field.stringdateFieldQuarter

The second field.stringdateFieldSecond

The week field.stringdateFieldWeek

The year field.stringdateFieldYear

The description of the date column.stringdescription

Represents the first day of the week.intfirstDayOfWeek

Offset number of months for the fiscal year in relation to the

calendar year.

intfiscalMonthOffset

Whether the year end is the fiscal year.booleanisYearEndFiscalYear

The label of the date column.stringlabel

694

WavexmdMetadata Types

DescriptionField TypeField

Whether or not the date should be shown in the explorer.booleanshowInExplorer

Whether or not to sort.intsortIndex

WaveXmdDimension

WaveXmdDimension represents a dimension in Wave Xmd.

DescriptionField TypeField

Custom actions linked to this dimension.WaveXmdDimensionCustomActioncustomActions

Indicates whether the dimension has custom actions enabled.booleancustomActionsEnabled

The format used for a date that is a dimension.stringdateFormat

The description of the dimension.stringdescription

The field name of the dimension (used in queries).stringfield

The fully qualified name of the dimension.stringfullyQualifiedName

The image template.stringimageTemplate

Whether this is a derived dimension.booleanisDerived

Indicates whether the dimension is multi-value.booleanisMultiValue

The label for the dimension.stringlabel

The template for formatting a link.stringlinkTemplate

Indicates whether the dimension has link templates enabled.booleanlinkTemplateEnabled

The tooltip to be displayed for links.stringlinkTooltip

The member overrides for a dimension.WaveXmdDimensionMembermembers

The origin of this dimension.stringorigin

Ordered list of dimensions. The list defines the default order in

which to display the dimensions in the user interface.

WaveXmdRecordDisplayLookuprecordDisplayFields

The record ID for this dimension.stringrecordIdField

The record organization ID for this dimension.stringrecordOrganizationIdField

Salesforce actions linked to this dimension.WaveXmdDimensionSalesforceActionsalesforceActions

Indicates whether the dimension has Salesforce actions enabled.booleansalesforceActionsEnabled

Default order in which to show the dimensions in the user

interface.

intshowDetailsDefaultFieldIndex

Indicates whether the dimension is displayed in the explorer.booleanshowInExplorer

695

WavexmdMetadata Types

DescriptionField TypeField

Whether or not to sort.intsortIndex

WaveXmdDimensionCustomAction

WaveXmdDimensionCustomAction represents a custom action in a dimension in Wave Xmd.

DescriptionField TypeField

The name of this custom action.stringcustomActionName

Indicates whether the action is enabled for a specific dimension.booleanenabled

The icon for the action.stringicon

The method for the action.stringmethod

Whether or not to sort.intsortIndex

The target for the action.stringtarget

The tooltip for the action.stringtooltip

The URL for the action.stringurl

WaveXmdDimensionMember

WaveXmdDimensionMember represents a dimension in Wave Xmd.

DescriptionField TypeField

The color for the member.stringcolor

The label for the member.stringlabel

The member value.stringmember

Whether or not to sort.intsortIndex

WaveXmdRecordDisplayLookup

WaveXmdDimensionRecordDisplayLookup represents a record display field in Wave Xmd.

DescriptionField TypeField

The field to display.stringrecordDisplayField

WaveXmdDimensionSalesforceAction

WaveXmdDimensionSalesforceAction represents an action in a dimension in Wave Xmd.

696

WavexmdMetadata Types

DescriptionField TypeField

Indicates whether the action is enabled for a specific dimension.booleanenabled

The name of the action.stringsalesforceActionName

Whether or not to sort.intsortIndex

WaveXmdMeasure

WaveXmdMeasure represents a measure in Wave Xmd.

DescriptionField TypeField

The format used for a date that is a measure.stringdateFormat

The description of the measure.stringdescription

The field name of the measure (used in queries).stringfield

The original (XMD 1.1) format array as a single string.stringformatCustomFormat

The number of digits displayed after the decimal place.intformatDecimalDigits

Indicates whether to display negative numbers with parentheses,

rather than a minus sign.

booleanformatIsNegativeParens

The prefix placed before the field value.stringformatPrefix

The suffix placed after the field value.stringformatSuffix

The unit string for the measure. For example, 'cm'.stringformatUnit

The multiplier for the unit.doubleformatUnitMultiplier

The fully qualified name of the measure.stringfullyQualifiedName

Whether this is a derived measure.booleanisDerived

The label for the measure.stringlabel

The origin of the measure.stringorigin

Default order in which to show the measures in the user

interface.

intshowDetailsDefaultFieldIndex

Indicates whether the measure is displayed in the explorer.booleanshowInExplorer

Whether or not to sort.intsortIndex

WaveXmdOrganization

WaveXmdOrganization represents a Salesforce organization in Wave Xmd.

697

WavexmdMetadata Types

DescriptionField TypeField

The instance URL for the organization.stringinstanceUrl

The label for the organization.stringlabel

The ID of the organization.stringorganizationIdentifier

Whether or not to sort.intsortIndex

Workflow

Represents the metadata associated with a workflow rule. A workflow rule sets workflow actions into motion when its designated

conditions are met. You can configure workflow actions to execute immediately when a record meets the conditions in your workflow

rule, or set time triggers that execute the workflow actions on a specific day. For more information, see “Workflow” in the Salesforce

Help. This type extends the Metadata metadata type and inherits its fullName field. Use this metadata type to create, update, or

delete workflow rule definitions.

When using a manifest file, retrieve all workflow components using the following code:

<types>

<name>Workflow</name>

</types>

Declarative Metadata File Suffix and Directory Location

Workflow files have the suffix .workflow. There is one file per standard or custom object that has workflow. These files are stored in

the workflows directory of the corresponding package.

Version

Workflow rules are available in API version 13.0 and later.

Workflow

This metadata type represents the valid types of workflow rules and actions associated with a standard or custom object.

DescriptionField TypeField Name

An array of all alerts for the object associated with the workflow.WorkflowAlert[]alerts

An array of all field updates for the object associated with the

workflow.

WorkflowFieldUpdate[]fieldUpdates

An array of flow triggers for the object associated with the

workflow. Available in API version 30.0 and later.

The pilot program for flow trigger workflow actions is closed. If

you've already enabled the pilot in your org, you can continue

WorkflowFlowAction[]flowActions

to create and edit flow trigger workflow actions. If you didn't

698

WorkflowMetadata Types

DescriptionField TypeField Name

enable the pilot in your org, use the Flows action in Process

Builder instead.

The developer name used as a unique identifier for API access.

The fullName can contain only underscores and

stringfullName

alphanumeric characters. It must be unique, begin with a letter,

not include spaces, not end with an underscore, and not contain

two consecutive underscores. This field is inherited from the

Metadata component.

An array of Salesforce Knowledge Workflow Publishes associated

with the workflow. Available in API version 27.0 and later.

WorkflowKnowledgePublish[]knowledgePublishes

An array of all of the outbound messages for the object

associated with the workflow.

WorkflowOutboundMessage[]outboundMessages

An array of all the objects associated with the workflow.WorkflowRule[]rules

An array of all the tasks for the object associated with the

workflow.

WorkflowTask[]tasks

WorkflowActionReference

WorkflowActionReference represents one of the workflow actions.

DescriptionField TypeField Name

Required. The name of the workflow action.stringname

Required. Available types of workflow actions:WorkflowActionType

(enumeration of type string)

type

•Alert

•FieldUpdate

•FlowAction—Available in API version 30.0 and later

•OutboundMessage

•Task

The pilot program for flow trigger workflow actions is closed. If

you've already enabled the pilot in your org, you can continue to

create and edit flow trigger workflow actions. If you didn't enable

the pilot in your org, use the Flows action in Process Builder instead.

WorkflowAlert

WorkflowAlert represents an email alert associated with a workflow rule.

699

WorkflowMetadata Types

DescriptionField TypeField Name

Additional email addresses. This field is similar to the CC field

in email clients.

For the email to be sent successfully, set a value for

ccEmails or recipients. You can set values for both

string[]ccEmails

fields. The value of ccEmails can include up to five different

email addresses.

Required. A description of the email alert. Available in API

version 16.0 and later.

stringdescription

Required. The developer name used as a unique identifier for

API access. The fullName can contain only underscores

stringfullName

and alphanumeric characters. It must be unique, begin with

a letter, not include spaces, not end with an underscore, and

not contain two consecutive underscores. This field is inherited

from the Metadata component.

Required. Indicates whether this component is protected

(true) or not (false). Protected components cannot be

booleanprotected

linked to or referenced by components created in the installing

organization.

The recipients for the email.

For the email to be sent successfully, set a value for

ccEmails or recipients. You can set values for both

fields.

WorkflowEmailRecipient[]recipients

The address in the From field for the email alert. This allows

you to use a standard global email address for your

stringsenderAddress

organization (such as support@company.com) instead

of the default From field, which is the email address of the

person who updates the record. You can only specify a value

in this field if the senderType is set to

OrgWideEmailAddress. See “Organization-Wide

Addresses: Let Users Send Email from Salesforce Using a

Common From Address” in the Salesforce Help.

The email used as the sender's From and Reply-To addresses.

The following values are valid:

ActionEmailSenderType

(enumeration of type string)

senderType

•CurrentUser—The email address of the person

updating the record. This is the default setting.

•DefaultWorkflowUser—The email address of the

default workflow user.

•OrgWideEmailAddress—A verified global email

address for your organization, such as

support@company.com.

700

WorkflowMetadata Types

DescriptionField TypeField Name

Required. Named reference to an EmailTemplate. This email

template does not have to exist in the zip file, but it must exist

in Metadata API.

stringtemplate

WorkflowEmailRecipient

WorkflowEmailRecipient represents a recipient for an email alert associated with a workflow rule.

DescriptionField TypeField Name

Name of the field referenced in type. The field named should

be of the type specified in type.

stringfield

The recipients for the email. Depending on the type selected,

this may be required.

stringrecipient

Named reference to an EmailTemplate component. Valid values

are:

ActionEmailRecipientTypes

(enumeration of type string)

type

•accountOwner - The email is sent to the record's

account owner (for example, the Account owner for an

Opportunity).

•accountTeam - Only applicable on the Account object.

The email is sent to everyone on that Account's account

team.

•campaignMemberDerivedOwner - Emails are sent

to lead and contact owners when contacts are added to a

campaign or in response to a campaign.

•contactLookup - The email is sent to a contact whose

value is looked up from a field on the record. For this value,

the field field must reference a Contact.

•creator - The email is sent to the record's creator.

•customerPortalOwner - The email is sent to a

specific self-service portal user. For this value, the recipient

field must reference a User (by username), only self-service

portal users.

•email - The email is sent to an email address whose value

is looked up from a field on the record. For this value, the

field field must reference an email field.

•group - The email is sent to all users in a group. For this

value, the recipient field must reference a group (by group

name).

•opportunityTeam - Only applicable on the

Opportunity object. The email is sent to everyone on that

Opportunity's opportunity team.

•owner - The email is sent to the record's owner.

701

WorkflowMetadata Types

DescriptionField TypeField Name

•partnerUser - The email is sent to a specific partner

user. For this value, the recipient field must reference a User

(by username), only partner users.

•portalRole - Like role, but for portal roles only.

•portalRoleSubordinates - Like

roleSubordinates, but for portal roles only.

•role - The email is sent to all users in a role. For this value,

the recipient field must reference a Role (in the role

hierarchy, by role name).

•roleSubordinates - The email is sent to all users in

a role subordinates. For this value, the recipient field must

reference a Role.

•roleSubordinatesInternal - Like

roleSubordinates, but for internal portal roles only.

•user - The email is sent to a specific user. For this value,

the recipient field must reference a User (by username).

•userLookup - The email is sent to a user whose value

is looked up from a field on the record. For this value, the

field field must reference a user foreign key field.

WorkflowFieldUpdate

WorkflowFieldUpdate represents a workflow field update. Field updates allow you to automatically update a field value to one that you

specify when a workflow rule is triggered.

DescriptionField TypeField Name

The description of the field update. This information is useful to

track the reasoning for initially configuring the field update.

stringdescription

Required. The field (on the object for the workflow) to be updated.stringfield

If the operation field value is Formula, this is set to a formula

used to compute the new field value.

stringformula

Required. The developer name used as a unique identifier for API

access. The fullName can contain only underscores and

stringfullName

alphanumeric characters. It must be unique, begin with a letter,

not include spaces, not end with an underscore, and not contain

two consecutive underscores. This field is inherited from the

Metadata component.

If the operation field value is Literal, this is the literal

value for the field.

stringliteralValue

If the operation field value is lookupValue, this is the

lookup value that is referenced.

stringlookupValue

702

WorkflowMetadata Types

DescriptionField TypeField Name

The type of object that the lookupValue field value is

referencing. The valid values are:

LookupValueType

(enumeration of type string)

lookupValueType

•Queue

•RecordType

•User

Required. A name for the component. Available in version API

16.0 and later.

stringname

Required. Notify the assignee when the field is updated.booleannotifyAssignee

Required. The operation that computes the value with which to

update the field. Valid values are:

FieldUpdateOperation

(enumeration of type string)

operation

•Formula - Indicates the field will be set to a formula. If set,

the formula must be a valid formula.

•Literal - Indicates the field will be set to a literal value. If

set, the literalValue must be a valid literal value for this field.

•LookupValue - Similar to Literal, but for an object

reference, such as a contact, user, account, etc. If set, the

lookupValue element must be set. Only User is supported

in the current API.

•NextValue - Indicates that the field will be set to its next

value; this is only allowed when the field update references a

picklist.

•Null - Indicates the field will be set to null.

•PreviousValue - Indicates that the field will be set to its

previous value; this is only allowed when the field update

references a picklist.

Required. Indicates whether this component is protected (true)

or not (false). Protected components cannot be linked to or

referenced by components created in the installing organization.

booleanprotected

When set to true, if the field update changes the field’s value, all

workflow rules on the associated object are re-evaluated. Any

booleanreevaluateOnChange

workflow rules whose criteria are met as a result of the field value

change will be triggered.

If any of the triggered workflow rules result in another field update

that’s also enabled for workflow rule re-evaluation, a domino effect

occurs, and more workflow rules can be re-evaluated as a result

of the newly-triggered field update. This cascade of workflow rule

re-evaluation and triggering can happen up to five times after the

initial field update that started it.

This is set if the change is detected on a child record. If this is set,

it points to the foreign key reference on the child object (for

stringtargetObject

703

WorkflowMetadata Types

DescriptionField TypeField Name

example, EmailMessage.ParentId) pointing to the parent

(for example, Case). When set, the formula is based on the child

object (for example, EmailMessage). This field is named

sourceField before version 14.0. The field name change is

automatically handled between versions and does not require

any manual editing of existing XML component files.

WorkflowFlowAction

Represents a flow trigger, which is a workflow action that launches a flow. Available in API version 30.0 and later. For more information,

see the following topics in the Salesforce Help.

•Define a Flow Trigger for Workflow (Pilot)

•Flow Trigger Considerations (Pilot)

Note:

•The pilot program for flow trigger workflow actions is closed. If you've already enabled the pilot in your org, you can continue

to create and edit flow trigger workflow actions. If you didn't enable the pilot in your org, use the Flows action in Process

Builder instead.

•Test mode for flow triggers isn’t supported in the Metadata API. If you want a flow trigger to run the latest flow version when

an administrator causes the workflow rule to fire, enable test mode via the user interface after deployment.

DescriptionField TypeField Name

Describes the flow trigger.stringdescription

Required. Unique name of the flow that this workflow action

launches.

stringflow

An array of values to pass into flow variables and sObject variables

when launching the flow.

WorkflowFlowActionParameter[]flowInputs

Required. Name of the flow trigger.stringlabel

Reserved for future use.stringlanguage

Reserved for future use.booleanprotected

WorkflowFlowActionParameter

Represents a value specified in the flow trigger that is passed into a flow variable or sObject variable when launching the flow.

Note: The pilot program for flow trigger workflow actions is closed. If you've already enabled the pilot in your org, you can continue

to create and edit flow trigger workflow actions. If you didn't enable the pilot in your org, use the Flows action in Process Builder

instead.

704

WorkflowMetadata Types

DescriptionField TypeField Name

Required. Unique name of the variable or sObject variable in the flow.

The flow variable must have isInput set to True.

stringname

Required. Value to assign to the flow variable or sObject variable when launching the flow.

Unlike an sObject variable, which represents an entire Salesforce record in the flow, a flow variable

represents a single field. Therefore, the allowed value depends on whether the name identifies a

flow variable or an sObject variable.

stringvalue

For an sObject variable, the value must be a merge field that identifies a record—or a lookup

relationship field that references a record—of the same object type as the sObject variable. For example:

•{!this}—identifies the record that fired the workflow rule.

•{!Contact}—identifies the contact associated with the record that fired the workflow rule.

•{!Asset.Account}—identifies the account associated with the asset that is associated with

the record that fired the workflow rule.

•{!SomeObject__r}—uses a lookup relationship field to identify a custom object record

associated with the record that fired the workflow rule.

For a flow variable, you can enter a merge field or a literal value. Manually enter a literal value when

the variable should have the same value every time the flow is launched, regardless of which record

fired the workflow rule. For example, you can enter true or false for a variable of type Boolean.

For a flow variable, supported merge fields identify a global variable or a field of the same data type

as the flow variable. For example:

•{!Id}—ID of the record that fired the workflow rule.

•{!Account.Owner.Email}—email address of the account owner for the account associated

with the record that fired the workflow rule.

•{!$Organization.Country}—country of the organization.

WorkflowKnowledgePublish

WorkflowKnowledgePublish represents Salesforce Knowledge article publishing actions and information. Available in API version 27.0

and later.

DescriptionField TypeField Name

The article publishing actions available when this rule fires.

Valid values are:

KnowledgeWorkflowAction

(enumeration of type string)

action

•PublishAsNew: Publishes the article as a new

article.

•Publish: Publishes the article as a version of a

previously published article.

A brief article description.stringdescription

Label that represents the article throughout the Salesforce

user interface.

stringlabel

705

WorkflowMetadata Types

DescriptionField TypeField Name

The language of the article.stringlanguage

Required. Indicates whether this component is protected

(true) or not (false). Protected components cannot

booleanprotected

be linked to or referenced by components created in the

installing organization.

WorkflowOutboundMessage

WorkflowOutboundMessage represents an outbound message associated with a workflow rule. Outbound messages are workflow and

approval actions that send the information you specify to an endpoint you designate, such as an external service. An outbound message

sends the data in the specified fields in the form of a SOAP message to the endpoint. For more information, see “Outbound Message

Actions” in the Salesforce Help.

DescriptionField TypeField Name

Required. The API version of the outbound message. This is automatically

set to the current API version when the outbound message is created.

Valid API versions for outbound messages are 8.0 and 18.0 or later.

This API version is used in API calls back to Salesforce using the enterprise

or partner WSDLs. The API Version can only be modified by using

doubleapiVersion

the Metadata API. It can't be modified using the Salesforce user interface.

This field is available in API version 18.0 and later.

Warning: If you change the apiVersion to a version that

doesn't support one of the fields configured for the outbound

message, messages will fail until you update your outbound

message listener to consume the updated WSDL. You can monitor

the status of outbound messages from Setup by entering

Outbound Messages in the Quick Find box, then

selecting Outbound Messages in Salesforce.

Describes the outbound message.stringdescription

Required. The endpoint URL to which the outbound message is sent.stringendpointUrl

The named references to the fields that are to be sent.string[]fields

Required. The developer name used as a unique identifier for API access.

The fullName can contain only underscores and alphanumeric

stringfullName

characters. It must be unique, begin with a letter, not include spaces, not

end with an underscore, and not contain two consecutive underscores.

This field is inherited from the Metadata component.

Required. Set if you want the Salesforce session ID included in the

outbound message. Useful if you intend to make API calls and you do

not want to include a username and password.

booleanincludeSessionId

706

WorkflowMetadata Types

DescriptionField TypeField Name

Required. The named reference to the user under which this message is

sent.

stringintegrationUser

Required. A name for the component. Available in version API 16.0 and

later.

stringname

Required. Indicates whether this component is protected (true) or not

(false). Protected components cannot be linked to or referenced by

components created in the installing organization.

booleanprotected

This field is only available for organizations with dead letter queue

permissions turned on. If set, this outbound message will use the dead

letter queue if normal delivery fails.

booleanuseDeadLetterQueue

WorkflowRule

This metadata type represents a workflow rule. This type extends the Metadata metadata type and inherits its fullName field.

DescriptionField TypeField Name

An array of references for the actions that

should happen when this rule fires.

WorkflowActionReference[]actions

Required. Determines if this rule is active.booleanactive

For advanced criteria filter, the boolean

formula, for example, (1 AND 2) OR

stringbooleanFilter

An array of the boolean criteria (conditions)

under which this rule fires. Note that either

this or formula must be set.

FilterItem[]criteriaItems

The description of the workflow rulestringdescription

The formula condition under which this

rule first (either this or

criteriaItems) must be set

stringformula

The developer name used as a unique

identifier for API access. The fullName

stringfullName

can contain only underscores and

alphanumeric characters. It must be

unique, begin with a letter, not include

spaces, not end with an underscore, and

not contain two consecutive underscores.

This field is inherited from the Metadata

component.

707

WorkflowMetadata Types

DescriptionField TypeField Name

Under what conditions the trigger fires.

Valid values are:

WorkflowTriggerTypes (enumeration of type string)triggerType

•onAllChanges - The workflow rule

is considered on all changes.

•onCreateOnly - The workflow rule

is considered only on create.

•onCreateOrTriggeringUpdate

- The workflow rule is considered on

create and triggering updates.

Represents a set of Workflow actions (Field

Updates, Email Alerts, Outbound Messages,

WorkflowTimeTriggerworkflowTimeTriggers

and Tasks) that should execute before or

after a specified interval of time.

WorkflowTask

This metadata type references an assigned workflow task.

DescriptionField TypeField Name

Specifies the user, role, or team to which the workflow rule

or action is assigned. The field corresponding to the value

stringassignedTo

specified here must be the same as the specified

assignedToType.

Valid string values for this type are:ActionTaskAssignedToTypes

(enumeration of type string)

assignedToType

•accountCreator - When set, the task is assigned

to the record's account's creator.

•accountOwner - When set, the task is assigned to

the record's account's owner (Opportunity).

•accountTeam - Same as WorkflowAlert type

•creator - When set, the task is assigned to the

record's creator.

•opportunityTeam - Same as WorkflowAlert type

•owner - When set, the task is assigned to the record's

owner.

•partnerUser - When set, the assignedTo field

references a User (by username), a partner user.

•portalRole - When set, the assignedTo field

references a Role (by role name), a portal role.

•role - When set, the assignedTo field references

a Role (by role name)

708

WorkflowMetadata Types

DescriptionField TypeField Name

•user - When set, the assignedTo field references

a User (by username)

The description of this workflow task.stringdescription

Required. The offset, in days, from either the trigger date,

or the date specified in the (optional)

offsetFromField. This can be a negative number.

intdueDateOffset

Required. The developer name used as a unique identifier

for API access. The fullName can contain only

stringfullName

underscores and alphanumeric characters. It must be

unique, begin with a letter, not include spaces, not end

with an underscore, and not contain two consecutive

underscores. This field is inherited from the Metadata

component.

Required. Set to send an email notification when the task

is assigned.

booleannotifyAssignee

Optional field reference of the date field from which the

dueDate should be computed.

stringoffsetFromField

Required. The priority to assign the created task.stringpriority

Required. Indicates whether this component is protected

(true) or not (false). Protected components cannot

booleanprotected

be linked to or referenced by components created in the

installing organization.

Required. The status to assign the created task.stringstatus

Required. A subject for the workflow task. It is used if an

email notification is sent when the task is assigned. Available

in API version 16.0 and later.

stringsubject

WorkflowTimeTrigger

Represents a set of Workflow actions (Field Updates, Email Alerts, Outbound Messages, and Tasks) that should execute before or after a

specified interval of time.

DescriptionField TypeField Name

An array of references for the actions that should happen when this

trigger fires.

WorkflowActionReference[]actions

The date type field name that the time-based workflow triggers off

of, i.e. Created Date, Last Modified Date, Rule

stringoffsetFromField

Trigger Date or a custom date field on the object for which

the workflow rule is defined.

709

WorkflowMetadata Types

DescriptionField TypeField Name

The numeric value of the time after/before the workflow triggers.

A negative value represents the time length before the trigger will

stringtimeLength

fire. The timeLength is measured in either hours or days, as

specified by workflowTimeTriggerUnit.

The unit of time before or after which the time-based workflow will

trigger. Valid string values are:

WorkflowTimeUnits

(enumeration of type string)

workflowTimeTriggerUnit

•Hours

•Days

Declarative Metadata Sample Definition

The following is the definition of a workflow rule:

<?xml version="1.0" encoding="UTF-8"?>

<fullName>Another_alert</fullName>

<description>Another alert</description>

<protected>false</protected>

<type>accountOwner</type>

</recipients>

<field>Contact__c</field>

<type>contactLookup</type>

</recipients>

<field>Email__c</field>

<type>email</type>

</recipients>

<template>TestEmail/Email Test</template>

</alerts>

<fullName>Enum_Field_Update</fullName>

<field>EnumField__c</field>

<name>Enum Field Update</name>

<operation>NextValue</operation>

<protected>false</protected>

</fieldUpdates>

<fullName>Enum_Field_Update2</fullName>

<field>EnumField__c</field>

<name>Enum Field Update2</name>

<operation>Literal</operation>

710

WorkflowMetadata Types

<protected>false</protected>

</fieldUpdates>

<fullName>Field_Update</fullName>

<description>TestField update desc</description>

<formula>Name & "Updated"</formula>

<name>Field Update</name>

<notifyAssignee>false</notifyAssignee>

<operation>Formula</operation>

<protected>false</protected>

</fieldUpdates>

<fullName>Lookup_On_Contact</fullName>

<field>RealOwner__c</field>

<lookupValue>admin@acme.com</lookupValue>

<name>Lookup On Contact</name>

<notifyAssignee>false</notifyAssignee>

<operation>LookupValue</operation>

<protected>false</protected>

</fieldUpdates>

<fullName>Another_Outbound_message</fullName>

<description>Another Random outbound.</description>

<fields>Email__c</fields>

<integrationUser>admin@acme.com</integrationUser>

<name>Another Outbound message</name>

<protected>false</protected>

</outboundMessages>

<rules>

<fullName>BooleanFilter</fullName>

<active>false</active>

<field>CustomObjectForWorkflow__c.CreatedById</field>

<operation>notEqual</operation>

</criteriaItems>

<field>CustomObjectForWorkflow__c.CreatedById</field>

<operation>notEqual</operation>

</criteriaItems>

<field>CustomObjectForWorkflow__c.CreatedById</field>

<operation>equals</operation>

</criteriaItems>

<triggerType>onCreateOrTriggeringUpdate</triggerType>

</rules>

<rules>

711

WorkflowMetadata Types

<fullName>Custom Rule1</fullName>

<name>Another_alert</name>

<type>Alert</type>

</actions>

<name>Enum_Field_Update2</name>

<type>FieldUpdate</type>

</actions>

<fullName>Field_Update</name>

<type>FieldUpdate</type>

</actions>

<name>Another_Outbound_message</name>

<type>OutboundMessage</type>

</actions>

<name>Role_task_was_completed</name>

</actions>

<field>CustomObjectForWorkflow__c.Name</field>

<operation>startsWith</operation>

</criteriaItems>

<description>Custom Rule1 desc</description>

<triggerType>onCreateOrTriggeringUpdate</triggerType>

</rules>

<rules>

<fullName>IsChangedFunctionRule</fullName>

<description>IsChangedDesc</description>

<formula>ISCHANGED(Name)</formula>

<triggerType>onAllChanges</triggerType>

</rules>

<tasks>

<fullName>Another_task_was_completed</fullName>

<assignedToType>owner</assignedToType>

<description>Random Comment</description>

<protected>false</protected>

<status>Completed</status>

<subject>Another task was completed</subject>

</tasks>

<tasks>

<fullName>Role_task_was_completed</fullName>

712

WorkflowMetadata Types

<offsetFromField>CustomObjectForWorkflow__c.CreatedDate</offsetFromField>

<protected>false</protected>

<status>Completed</status>

<subject>Role task was completed</subject>

</tasks>

<tasks>

<fullName>User_task_was_completed</fullName>

<assignedTo>admin@acme.com</assignedTo>

<offsetFromField>User.CreatedDate</offsetFromField>

<protected>false</protected>

<status>Completed</status>

<subject>User task was completed</subject>

</tasks>

</Workflow>

713

WorkflowMetadata Types

CHAPTER 11 Headers

Use headers in Metadata API calls to set options for each call.

IN THIS SECTION:

AllOrNoneHeader

Indicates whether to roll back all metadata changes when some of the records in a call result in failures.

CallOptions

Specifies the API client identifier.

DebuggingHeader

Specifies that the deployment result will contain the debug log output, and specifies the level of detail included in the log. The

debug log contains the output of Apex tests that are executed as part of a deployment.

SessionHeader

Specifies the session ID that the login call returns. This session ID is used to authenticate all subsequent Metadata API calls.

AllOrNoneHeader

Indicates whether to roll back all metadata changes when some of the records in a call result in failures.

Version

This header is available in API version 34.0 and later.

Supported Calls

createMetadata(), updateMetadata(), upsertMetadata(), deleteMetadata()

Usage

If this header isn’t used in API version 34.0 and later, by default a call can save a partial set of records (equivalent to

AllOrNoneHeader=false)—the records that are processed successfully are saved and records that have failures aren’t saved.

714

Fields

DescriptionTypeField Name

Set to true to cause all metadata changes to be rolled back if

any records in the call cause failures. Set to false to enable

booleanallOrNone

saving only the records that are processed successfully when other

records in the call cause failures.

Sample Code—Java

Add the AllOrNoneHeader to the metadata connection before you perform a call as follows:

metadataConnection.setAllOrNoneHeader(true);

This next example shows how to use the AllOrNoneHeader when creating two custom objects. Because the second custom object

doesn’t have the required Name field, the create() call can’t create this custom object and rolls back the first custom object. The

output is shown after this code sample.

import com.sforce.soap.metadata.*;

import com.sforce.soap.metadata.Error;

import com.sforce.ws.ConnectionException;

public class CallWithHeader {

MetadataConnection metadataConnection = null;

public static void main(String[] args) throws ConnectionException {

CallWithHeader samples = new CallWithHeader();

samples.createWithHeader();

}

public CallWithHeader() throws ConnectionException {

metadataConnection = MetadataLoginUtil.login();

}

public void createWithHeader() throws ConnectionException {

// Define two custom objects to be inserted.

CustomObject co1 = new CustomObject();

String name1 = "MyCustomObject1";

co1.setFullName(name1 + "__c");

co1.setDeploymentStatus(DeploymentStatus.Deployed);

co1.setDescription("Created by the Metadata API");

co1.setEnableActivities(true);

co1.setLabel(name1 + " Object");

co1.setPluralLabel(co1.getLabel() + "s");

co1.setSharingModel(SharingModel.ReadWrite);

CustomField nf = new CustomField();

nf.setType(FieldType.Text);

nf.setLabel(co1.getFullName() + " Name");

co1.setNameField(nf);

715

AllOrNoneHeaderHeaders

// The second custom object doesn't have a Name field

CustomObject co2 = new CustomObject();

String name2 = "MyCustomObject2";

co2.setFullName(name2 + "__c");

co2.setDeploymentStatus(DeploymentStatus.Deployed);

co2.setDescription("Created by the Metadata API");

co2.setEnableActivities(true);

co2.setLabel(name2 + " Object");

co2.setPluralLabel(co2.getLabel() + "s");

co2.setSharingModel(SharingModel.ReadWrite);

// Setting the allOrNone header to true to cause

// the call to not commit any record if one or more

// records in this call have failures.

metadataConnection.setAllOrNoneHeader(true);

// Now that the header has been set, make the create call.

SaveResult[] results = metadataConnection

.createMetadata(new Metadata[] { co1, co2 });

// Iterate through the call results

for (SaveResult r : results) {

if (r.isSuccess()) {

System.out.println("Created component: " + r.getFullName());

}else {

System.out

.println("Errors were encountered while creating "

+ r.getFullName());

for (Error e : r.getErrors()) {

System.out.println("Error message: " + e.getMessage());

System.out.println("Status code: " + e.getStatusCode());

}

This is the output that the sample returns. The first record is rolled back and the second has a failure.

Errors were encountered while creating MyCustomObject1__c

Error message: Record rolled back because not all records were valid and the request was

using AllOrNone header

Status code: ALL_OR_NONE_OPERATION_ROLLED_BACK

Errors were encountered while creating MyCustomObject2__c

Error message: Must specify a nameField of type Text or AutoNumber

Status code: FIELD_INTEGRITY_EXCEPTION

CallOptions

Specifies the API client identifier.

716

CallOptionsHeaders

Version

This call is available in all API versions.

Supported Calls

All Metadata API calls.

Fields

DescriptionTypeField Name

A value that identifies an API client.stringclient

Sample Code—Java

To change the API client ID, add the CallOptions header to the metadata connection before you perform a call as follows:

metadataConnection.setCallOptions("client ID");

DebuggingHeader

Specifies that the deployment result will contain the debug log output, and specifies the level of detail included in the log. The debug

log contains the output of Apex tests that are executed as part of a deployment.

Version

This header is available in all API versions.

Supported Calls

deploy()

Fields

DescriptionTypeField Name

A list of log categories with their associated log levels.LogInfo[]categories

Deprecated. This field is provided only for backward compatibility.

If you provide values for both debugLevel and categories,

the categories value is used.

LogType (enumeration of type string)debugLevel

The debugLevel field specifies the type of information returned

in the debug log. The values are listed from the least amount of

717

DebuggingHeaderHeaders

DescriptionTypeField Name

information returned to the most information returned. Valid values

include:

•None

•Debugonly

•Db

•Profiling

•Callout

•Detail

LogInfo

Specifies the type and amount of information to be returned in the debug log. The categories field takes a list of these objects.

LogInfo is a mapping of category to level.

DescriptionTypeElement Name

Specify the type of information returned in the debug log. Valid values are:LogCategorycategory

•Db

•Workflow

•Validation

•Callout

•Apex_code

•Apex_profiling

•Visualforce

•System

•All

Specifies the level of detail returned in the debug log.

Valid log levels are (listed from lowest to highest):

LogCategoryLevellevel

•NONE

•ERROR

•WARN

•INFO

•DEBUG

•FINE

•FINER

•FINEST

718

DebuggingHeaderHeaders

Sample Code—Java

Add the DebuggingHeader to the metadata connection before you perform the deploy() call as follows.

LogInfo[] logs = new LogInfo[1];

logs[0] = new LogInfo();

logs[0].setCategory(LogCategory.Apex_code);

logs[0].setLevel(LogCategoryLevel.Fine);

metadataConnection.setDebuggingHeader(logs);

The result of the deploy() call is obtained by calling checkDeployStatus(). After the deployment finishes, and if tests were run, the response

of checkDeployStatus() contains the debug log output in the debugLog field of a DebuggingInfo output header.

SessionHeader

Specifies the session ID that the login call returns. This session ID is used to authenticate all subsequent Metadata API calls.

Version

This header is available in all API versions.

Supported Calls

All Metadata API calls.

Fields

DescriptionTypeField Name

The session ID that the login call returns.stringsessionId

Sample Code—Java

Add the SessionHeader to the metadata connection before you perform a call as follows:

metadataConnection.setSessionHeader("<session_ID>");

719

SessionHeaderHeaders

APPENDICES

APPENDIX A CustomObjectTranslation Language Support: Fully

Supported Languages

Not every language supports all the possible values for the fields in CustomObjectTranslation. Use this appendix to determine which

field values a language supports.

Note: Salesforce offers three levels of language support: fully supported languages, end-user languages, and platform-only

languages. This appendix provides information only for fully supported languages. For more information, see Supported Languages

Chinese (Simplified)

plural

false

caseType

Nominative

possessive

None

startwith

Consonant

plural

false

Chinese (Traditional)

caseType

Nominative

possessive

None

startwith

Consonant

plural

false

720

Danish

caseType

Nominative

article

Zero

Definite

Indefinite

possessive

None

gender

Feminine

Neuter

startwith

Consonant

plural

true

Dutch

CaseType

Nominative

article

Definite

Indefinite

gender

Feminine

Neuter

possessive

None

plural

true

Finnish

caseType

Ablative

Adessive

Allative

Dative

721

CustomObjectTranslation Language Support: Fully Supported

Languages

Elative

Essive

Genitive

Illative

Inessive

Nominative

Partitive

Translative

plural

true

possessive

None

First

Second

startwith

Consonant

French

article

Zero

Definite

Indefinite

gender

Masculine

Feminine

possessive

None

plural

true

startwith

Consonant

Vowel

German

article

Zero

Definite

722

CustomObjectTranslation Language Support: Fully Supported

Languages

Indefinite

caseType

Accusative

Dative

Genitive

Nominative

gender

Masculine

Feminine

Neuter

possessive

None

plural

true

Italian

article

Zero

Indefinite

Definite

CaseType

Nominative

gender

Masculine

Feminine

possessive

None

plural

true

startwith

Consonant

Vowel

Special

Japanese

CaseType

Nominative

723

CustomObjectTranslation Language Support: Fully Supported

Languages

possessive

None

startwith

Consonant

plural

false

Korean

CaseType

Nominative

possessive

None

startwith

Consonant

plural

false

Portuguese (Brazilian)

article

Zero

Definite

Indefinite

article

Zero

Indefinite

Definite

plural

true

Russian

caseType

Accusative

Dative

Genitive

Instrumental

Nominative

Prepositional

724

CustomObjectTranslation Language Support: Fully Supported

Languages

gender

Masculine

Feminine

Neuter

Animate_Masculine

plural

true

false

Spanish

article

Zero

Definite

Indefinite

CaseType

Nominative

gender

Masculine

Feminine

startwith

Consonant

plural

true

Thai

CaseType

Nominative

possessive

None

startwith

Consonant

plural

false

725

CustomObjectTranslation Language Support: Fully Supported

Languages

APPENDIX B CustomObjectTranslation Language Support:

End-User Languages

Not every language supports all the possible values for the fields in CustomObjectTranslation. Use this appendix to determine which

field values a language supports.

Note: Salesforce offers three levels of language support: fully supported languages, end-user languages, and platform-only

languages. This appendix provides information only for end-user languages. For more information, see Supported Languages

Arabic

article

Zero

Definite

CaseType

Nominative

Accusative

gender

Masculine

Feminine

plural

true

possessive

None

First

Second

startwith

Consonant

Bulgarian

article

Zero

Definite

726

CaseType

Nominative

Objective

gender

Masculine

Feminine

Neuter

possessive

None

plural

true

startwith

Consonant

Czech

CaseType

Accusative

Dative

Genitive

Instrumental

Locative

Vocative

Nominative

gender

Masculine

Feminine

Neuter

Animate_Masculine

plural

true

Greek

article

Zero

Definite

Indefinite

727

CustomObjectTranslation Language Support: End-User

Languages

CaseType

Accusative

Genitive

Nominative

Vocative

gender

Masculine

Feminine

Neuter

possessive

None

plural

true

Hebrew

article

Zero

Definite

CaseType

Nominative

gender

Masculine

Feminine

possessive

None

plural

true

Hungarian

article

Zero

Definite

Indefinite

CaseType

Ablative

Accusative

Allative

Causalfinal

728

CustomObjectTranslation Language Support: End-User

Languages

Dative

Delative

Distributive

Elative

Essiveformal

Illative

Inessive

Instrumental

Nominative

Sublative

Terminative

Translative

plural

true

possessive

None

First

Second

startwith

Consonant

Vowel

Indonesian

plural

true

CaseType

Nominative

Possessive

None

startwith

Consonant

Norwegian

article

Zero

Definite

Indefinite

729

CustomObjectTranslation Language Support: End-User

Languages

CaseType

Nominative

gender

Masculine

Feminine

Neuter

possessive

None

plural

true

Polish

CaseType

Nominative

Accusative

Dative

Genitive

Instrumental

Locative

Vocative

gender

Masculine

Feminine

Neuter

Animate_Masculine

plural

true

Romanian

article

Zero

Definite

Indefinite

CaseType

Nominative

Dative

730

CustomObjectTranslation Language Support: End-User

Languages

gender

Masculine

Feminine

Neuter

possessive

None

plural

true

Spanish (Mexico)

article

Zero

Definite

Indefinite

CaseType

Nominative

gender

Masculine

Feminine

possessive

None

plural

true

Turkish

article

Zero

Indefinite

CaseType

Ablative

Accusative

Dative

Genitive

Nominative

possessive

None

First

Second

731

CustomObjectTranslation Language Support: End-User

Languages

startwith

Consonant

plural

true

Ukrainian

CaseType

Accusative

Dative

Genitive

Instrumental

Nominative

Locative

Vocative

gender

Masculine

Feminine

Neuter

Animate_Masculine

plural

true

Vietnamese

CaseType

Nominative

possessive

None

startwith

Consonant

plural

false

732

CustomObjectTranslation Language Support: End-User

Languages

APPENDIX C StandardValueSet Names and Standard Picklist

Fields

In API version 38.0 and later, standard picklists are represented by the StandardValueSet type. In previous versions, standard picklists are

represented by the CustomField type. This table lists the names of standard picklists as standard value sets and their corresponding field

names.

Note: The names of standard value sets and picklist fields are case-sensitive.

Field Name (API version 37.0 and earlier)Standard Value Set Name (API version 38.0 and later)

AccountContactRelation.RolesAccountContactMultiRoles

AccountContactRole.RoleAccountContactRole

Account.OwnershipAccountOwnership

Account.Rating

Lead.Rating

AccountRating

Account.TypeAccountType

Country picklistAddressCountryCode

State picklistAddressStateCode

Asset.StatusAssetStatus

CampaignMember.StatusCampaignMemberStatus

Campaign.StatusCampaignStatus

Campaign.TypeCampaignType

CaseContactRole.RoleCaseContactRole

Case.OriginCaseOrigin

Case.PriorityCasePriority

Case.ReasonCaseReason

Case.StatusCaseStatus

Case.TypeCaseType

OpportunityContactRole.RoleContactRole

733

Field Name (API version 37.0 and earlier)Standard Value Set Name (API version 38.0 and later)

ContractContactRole.RoleContractContactRole

Contract.StatusContractStatus

Entitlement.TypeEntitlementType

Event.SubjectEventSubject

Event.TypeEventType

Period.PeriodLabelFiscalYearPeriodName

FiscalYearSettings.PeriodPrefixFiscalYearPeriodPrefix

Period.QuarterLabelFiscalYearQuarterName

FiscalYearSettings.QuarterPrefixFiscalYearQuarterPrefix

IdeaTheme.Categories1

IdeaCategory1

Idea.CategoriesIdeaMultiCategory

Idea.StatusIdeaStatus

IdeaTheme.StatusIdeaThemeStatus

Account.Industry

Lead.Industry

Industry

Invoice.StatusInvoiceStatus

Account.AccountSource

Lead.LeadSource

LeadSource

Opportunity.Source

Lead.StatusLeadStatus

Opportunity.CompetitorsOpportunityCompetitor

Opportunity.StageNameOpportunityStage

Opportunity.TypeOpportunityType

Order.Status1

OrderStatus1

Order.TypeOrderType

Account.PartnerRolePartnerRole

Product2.FamilyProduct2Family

Question.Origin1

QuestionOrigin1

QuickText.CategoryQuickTextCategory

QuickText.ChannelQuickTextChannel

734

StandardValueSet Names and Standard Picklist Fields

Field Name (API version 37.0 and earlier)Standard Value Set Name (API version 38.0 and later)

Quote.StatusQuoteStatus

OpportunityTeamMember.TeamMemberRole

UserAccountTeamMember.TeamMemberRole

SalesTeamRole

UserTeamMember.TeamMemberRole

AccountTeamMember.TeamMemberRole

Contact.Name

Salutation

Lead.Name

ServiceContract.ApprovalStatusServiceContractApprovalStatus

SocialPost.ClassificationSocialPostClassification

SocialPost.EngagementLevelSocialPostEngagementLevel

SocialPost.ReviewedStatusSocialPostReviewedStatus

Solution.StatusSolutionStatus

Task.PriorityTaskPriority

Task.StatusTaskStatus

Task.SubjectTaskSubject

Task.TypeTaskType

WorkOrderLineItem.StatusWorkOrderLineItemStatus

WorkOrder.PriorityWorkOrderPriority

WorkOrder.StatusWorkOrderStatus

1 You can’t read or update this standard value set or picklist field.

735

StandardValueSet Names and Standard Picklist Fields

GLOSSARY

A |B |C |D |E |F |G |H |I |J |K |L |M |N |O |P |Q |R |S |T |U |V |W |X |Y |Z

Apex

Apex is a strongly typed, object-oriented programming language that allows developers to execute flow and transaction control

statements on the Force.com platform server in conjunction with calls to the Force.com API. Using syntax that looks like Java and

acts like database stored procedures, Apex enables developers to add business logic to most system events, including button clicks,

related record updates, and Visualforce pages. Apex code can be initiated by Web service requests and from triggers on objects.

Apex-Managed Sharing

Enables developers to programmatically manipulate sharing to support their application’s behavior. Apex-managed sharing is only

available for custom objects.

App

Short for “application.” A collection of components such as tabs, reports, dashboards, and Visualforce pages that address a specific

business need. Salesforce provides standard apps such as Sales and Service. You can customize the standard apps to match the way

you work. In addition, you can package an app and upload it to the AppExchange along with related components such as custom

fields, custom tabs, and custom objects. Then, you can make the app available to other Salesforce users from the AppExchange.

AppExchange

The AppExchange is a sharing interface from Salesforce that allows you to browse and share apps and services for the Force.com

platform.

AppExchange Upgrades

Upgrading an app is the process of installing a newer version.

Application Programming Interface (API)

The interface that a computer system, library, or application provides to allow other computer programs to request services from it

and exchange data.

Asynchronous Calls

A call that does not return results immediately because the operation may take a long time. Calls in the Metadata API and Bulk API

are asynchronous.

Boolean Operators

You can use Boolean operators in report filters to specify the logical relationship between two values. For example, the AND operator

between two values yields search results that include both values. Likewise, the OR operator between two values yields search results

that include either value.

Bulk API

The REST-based Bulk API is optimized for processing large sets of data. It allows you to query, insert, update, upsert, or delete a large

number of records asynchronously by submitting a number of batches which are processed in the background by Salesforce. See

also SOAP API.

736

Class, Apex

A template or blueprint from which Apex objects are created. Classes consist of other classes, user-defined methods, variables,

exception types, and static initialization code. In most cases, Apex classes are modeled on their counterparts in Java.

Client App

An app that runs outside the Salesforce user interface and uses only the Force.com API or Bulk API. It typically runs on a desktop or

mobile device. These apps treat the platform as a data source, using the development model of whatever tool and platform for

which they are designed.

Component, Metadata

A component is an instance of a metadata type in the Metadata API. For example, CustomObject is a metadata type for custom

objects, and the MyCustomObject__c component is an instance of a custom object. A component is described in an XML file

and it can be deployed or retrieved using the Metadata API, or tools built on top of it, such as the Force.com IDE or the Force.com

Migration Tool.

Component, Visualforce

Something that can be added to a Visualforce page with a set of tags, for example, <apex:detail>. Visualforce includes a

number of standard components, or you can create your own custom components.

Component Reference, Visualforce

A description of the standard and custom Visualforce components that are available in your organization. You can access the

component library from the development footer of any Visualforce page or the Visualforce Developer's Guide.

Controller, Visualforce

An Apex class that provides a Visualforce page with the data and business logic it needs to run. Visualforce pages can use the standard

controllers that come by default with every standard or custom object, or they can use custom controllers.

Controlling Field

Any standard or custom picklist or checkbox field whose values control the available values in one or more corresponding dependent

fields.

Custom App

See App.

Custom Field

A field that can be added in addition to the standard fields to customize Salesforce for your organization’s needs.

Custom Help

Custom text administrators create to provide users with on-screen information specific to a standard field, custom field, or custom

object.

Custom Links

Custom links are URLs defined by administrators to integrate your Salesforce data with external websites and back-office systems.

Formerly known as Web links.

Custom Object

Custom records that allow you to store information unique to your organization.

Custom S-Control

Note: S-controls have been superseded by Visualforce pages. After March 2010 organizations that have never created

s-controls, as well as new organizations, won't be allowed to create them. Existing s-controls will remain unaffected, and can

still be edited.

Custom Web content for use in custom links. Custom s-controls can contain any type of content that you can display in a browser,

for example a Java applet, an Active-X control, an Excel file, or a custom HTML Web form.

737

Glossary

Database

An organized collection of information. The underlying architecture of the Force.com platform includes a database where your data

is stored.

Database Table

A list of information, presented with rows and columns, about the person, thing, or concept you want to track. See also Object.

Data Manipulation Language (DML)

An Apex method or operation that inserts, updates, or deletes records.

Decimal Places

Parameter for number, currency, and percent custom fields that indicates the total number of digits you can enter to the right of a

decimal point, for example, 4.98 for an entry of 2. Note that the system rounds the decimal numbers you enter, if necessary. For

example, if you enter 4.986 in a field with Decimal Places of 2, the number rounds to 4.99. Salesforce uses the round half-up

rounding algorithm. Half-way values are always rounded up. For example, 1.45 is rounded to 1.5. –1.45 is rounded to –1.5.

Dependent Field

Any custom picklist or multi-select picklist field that displays available values based on the value selected in its corresponding

controlling field.

Developer Edition

A free, fully-functional Salesforce organization designed for developers to extend, integrate, and develop with the Force.com platform.

Developer Edition accounts are available on developer.salesforce.com.

Salesforce Developers

The Salesforce Developers website at developer.salesforce.com provides a full range of resources for platform developers, including

sample code, toolkits, an online developer community, and the ability to obtain limited Force.com platform environments.

Document Library

A place to store documents without attaching them to accounts, contacts, opportunities, or other records.

Email Alert

Email alerts are actions that send emails, using a specified email template, to specified recipients.

Email Template

A form email that communicates a standard message, such as a welcome letter to new employees or an acknowledgement that a

customer service request has been received. Email templates can be personalized with merge fields, and can be written in text,

HTML, or custom format.

Enterprise Edition

A Salesforce edition designed for larger, more complex businesses.

Enterprise WSDL

A strongly-typed WSDL for customers who want to build an integration with their Salesforce organization only, or for partners who

are using tools like Tibco or webMethods to build integrations that require strong typecasting. The downside of the Enterprise WSDL

is that it only works with the schema of a single Salesforce organization because it is bound to all of the unique objects and fields

that exist in that organization's data model.

Entity Relationship Diagram (ERD)

A data modeling tool that helps you organize your data into entities (or objects, as they are called in the Force.com platform) and

define the relationships between them. ERD diagrams for key Salesforce objects are published in the SOAP API Developer's Guide.

738

Glossary

Enumeration Field

An enumeration is the WSDL equivalent of a picklist field. The valid values of the field are restricted to a strict set of possible values,

all having the same data type.

Field

A part of an object that holds a specific piece of information, such as a text or currency value.

Field-Level Security

Settings that determine whether fields are hidden, visible, read only, or editable for users. Available in Professional, Enterprise,

Unlimited, Performance, and Developer Editions.

Filter Condition/Criteria

Condition on particular fields that qualifies items to be included in a list view or report, such as “State equals California.”

Force.com

The Salesforce platform for building applications in the cloud. Force.com combines a powerful user interface, operating system, and

database to allow you to customize and deploy applications in the cloud for your entire enterprise.

Force.com IDE

An Eclipse plug-in that allows developers to manage, author, debug and deploy Force.com applications in the Eclipse development

environment.

Force.com Migration Tool

A toolkit that allows you to write an Apache Ant build script for migrating Force.com components between a local file system and

a Salesforce organization.

Foreign Key

A field whose value is the same as the primary key of another table. You can think of a foreign key as a copy of a primary key from

another table. A relationship is made between two tables by matching the values of the foreign key in one table with the values of

the primary key in another.

Formula Field

A type of custom field. Formula fields automatically calculate their values based on the values of merge fields, expressions, or other

values.

Function

Built-in formulas that you can customize with input parameters. For example, the DATE function creates a date field type from a

given year, month, and day.

Gregorian Year

A calendar based on a 12-month structure used throughout much of the world.

HTTP Debugger

An application that can be used to identify and inspect SOAP requests that are sent from the AJAX Toolkit. They behave as proxy

servers running on your local machine and allow you to inspect and author individual requests.

739

Glossary

See Salesforce Record ID.

Inline S-Control

Note: S-controls have been superseded by Visualforce pages. After March 2010 organizations that have never created

s-controls, as well as new organizations, won't be allowed to create them. Existing s-controls will remain unaffected, and can

still be edited.

An s-control that displays within a record detail page or dashboard, rather than on its own page.

Instance

The cluster of software and hardware represented as a single logical server that hosts an organization's data and runs their applications.

The Force.com platform runs on multiple instances, but data for any single organization is always stored on a single instance.

Integration User

A Salesforce user defined solely for client apps or integrations. Also referred to as the logged-in user in a SOAP API context.

ISO Code

The International Organization for Standardization country code, which represents each country by two letters.

Junction Object

A custom object with two master-detail relationships. Using a custom junction object, you can model a “many-to-many” relationship

between two objects. For example, you may have a custom object called “Bug” that relates to the standard case object such that a

bug could be related to multiple cases and a case could also be related to multiple bugs.

No Glossary items for this entry.

License Management Application (LMA)

A free AppExchange app that allows you to track sales leads and accounts for every user who downloads your managed package

(app) from the AppExchange.

License Management Organization (LMO)

The Salesforce organization that you use to track all the Salesforce users who install your package. A license management organization

must have the License Management Application (LMA) installed. It automatically receives notification every time your package is

installed or uninstalled so that you can easily notify users of upgrades. You can specify any Enterprise, Unlimited, Performance, or

Developer Edition organization as your license management organization. For more information, go to

http://www.salesforce.com/docs/en/lma/index.htm.

List View

A list display of items (for example, accounts or contacts) based on specific criteria. Salesforce provides some predefined views.

740

Glossary

In the Agent console, the list view is the top frame that displays a list view of records based on specific criteria. The list views you

can select to display in the console are the same list views defined on the tabs of other objects. You cannot create a list view within

the console.

Local Project

A .zip file containing a project manifest (package.xml file) and one or more metadata components.

Locale

The country or geographic region in which the user is located. The setting affects the format of date and number fields, for example,

dates in the English (United States) locale display as 06/30/2000 and as 30/06/2000 in the English (United Kingdom) locale.

In Professional, Enterprise, Unlimited, Performance, and Developer Edition organizations, a user’s individual Locale setting overrides

the organization’s Default Locale setting. In Personal and Group Editions, the organization-level locale field is called Locale,

not Default Locale.

Logged-in User

In a SOAP API context, the username used to log into Salesforce. Client applications run with the permissions and sharing of the

logged-in user. Also referred to as an integration user.

Lookup Field

A type of field that contains a linkable value to another record. You can display lookup fields on page layouts where the object has

a lookup or master-detail relationship with another object. For example, cases have a lookup relationship with assets that allows

users to select an asset using a lookup dialog from the case edit page and click the name of the asset from the case detail page.

Managed Package

A collection of application components that is posted as a unit on the AppExchange and associated with a namespace and possibly

a License Management Organization. To support upgrades, a package must be managed. An organization can create a single

managed package that can be downloaded and installed by many different organizations. Managed packages differ from unmanaged

packages by having some locked components, allowing the managed package to be upgraded later. Unmanaged packages do not

include locked components and cannot be upgraded. In addition, managed packages obfuscate certain components (like Apex) on

subscribing organizations to protect the intellectual property of the developer.

Manifest File

The project manifest file (package.xml) lists the XML components to retrieve or deploy when working with the Metadata API,

or clients built on top of the Metadata API, such as the Force.com IDE or the Force.com Migration Tool.

Manual Sharing

Record-level access rules that allow record owners to give read and edit permissions to other users who might not have access to

the record any other way.

Many-to-Many Relationship

A relationship where each side of the relationship can have many children on the other side. Many-to-many relationships are

implemented through the use of junction objects.

Master-Detail Relationship

A relationship between two different types of records that associates the records with each other. For example, accounts have a

master-detail relationship with opportunities. This type of relationship affects record deletion, security, and makes the lookup

relationship field required on the page layout.

Metadata

Information about the structure, appearance, and functionality of an organization and any of its parts. Force.com uses XML to describe

metadata.

741

Glossary

Metadata WSDL

A WSDL for users who want to use the Force.com Metadata API calls.

Multitenancy

An application model where all users and apps share a single, common infrastructure and code base.

Namespace

In a packaging context, a one- to 15-character alphanumeric identifier that distinguishes your package and its contents from packages

of other developers onAppExchange, similar to a domain name. Salesforce automatically prepends your namespace prefix, followed

by two underscores (“__”), to all unique component names in your Salesforce organization.

Native App

An app that is built exclusively with setup (metadata) configuration on Force.com. Native apps do not require any external services

or infrastructure.

Object

An object allows you to store information in your Salesforce organization. The object is the overall definition of the type of information

you are storing. For example, the case object allow you to store information regarding customer inquiries. For each object, your

organization will have multiple records that store the information about specific instances of that type of data. For example, you

might have a case record to store the information about Joe Smith's training inquiry and another case record to store the information

about Mary Johnson's configuration issue.

Object-Level Help

Custom help text that you can provide for any custom object. It displays on custom object record home (overview), detail, and edit

pages, as well as list views and related lists.

Object-Level Security

Settings that allow an administrator to hide whole objects from users so that they don't know that type of data exists. Object-level

security is specified with object permissions.

onClick JavaScript

JavaScript code that executes when a button or link is clicked.

One-to-Many Relationship

A relationship in which a single object is related to many other objects. For example, an account may have one or more related

contacts.

Organization-Wide Defaults

Settings that allow you to specify the baseline level of data access that a user has in your organization. For example, you can set

organization-wide defaults so that any user can see any record of a particular object that is enabled via their object permissions, but

they need extra permissions to edit one.

Outbound Message

An outbound message sends information to a designated endpoint, like an external service. Outbound messages are configured

from Setup. You must configure the external endpoint and create a listener for the messages using the SOAP API.

Overlay

An overlay displays additional information when you hover your mouse over certain user interface elements. Depending on the

overlay, it will close when you move your mouse away, click outside of the overlay, or click a close button.

742

Glossary

Owner

Individual user to which a record (for example, a contact or case) is assigned.

Package

A group of Force.com components and applications that are made available to other organizations through the AppExchange. You

use packages to bundle an app along with any related components so that you can upload them to AppExchange together.

Partner WSDL

A loosely-typed WSDL for customers, partners, and ISVs who want to build an integration or an AppExchange app that can work

across multiple Salesforce organizations. With this WSDL, the developer is responsible for marshaling data in the correct object

representation, which typically involves editing the XML. However, the developer is also freed from being dependent on any particular

data model or Salesforce organization. Contrast this with the Enterprise WSDL, which is strongly typed.

Picklist

Selection list of options available for specific fields in a Salesforce object, for example, the Industry field for accounts. Users can

choose a single value from a list of options rather than make an entry directly in the field. See also Master Picklist.

Picklist (Multi-Select)

Selection list of options available for specific fields in a Salesforce object. Multi-select picklists allow users to choose one or more

values. Users can choose a value by double clicking on it, or choose additional values from a scrolling list by holding down the CTRL

key while clicking a value and using the arrow icon to move them to the selected box.

Picklist Values

Selections displayed in drop-down lists for particular fields. Some values come predefined, and other values can be changed or

defined by an administrator.

Primary Key

A relational database concept. Each table in a relational database has a field in which the data value uniquely identifies the record.

This field is called the primary key. The relationship is made between two tables by matching the values of the foreign key in one

table with the values of the primary key in another.

Production Organization

A Salesforce organization that has live users accessing data.

Professional Edition

A Salesforce edition designed for businesses who need full-featured CRM functionality.

Queue

A holding area for items before they are processed. Salesforce uses queues in a number of different features and technologies.

Query String Parameter

A name-value pair that's included in a URL, typically after a '?' character. For example:

https://yourInstance.salesforce.com/001/e?name=value

743

Glossary

Record

A single instance of a Salesforce object. For example, “John Jones” might be the name of a contact record.

Record Name

A standard field on all Salesforce objects. Whenever a record name is displayed in a Force.com application, the value is represented

as a link to a detail view of the record. A record name can be either free-form text or an autonumber field. Record Name does

not have to be a unique value.

Record Type

A record type is a field available for certain records that can include some or all of the standard and custom picklist values for that

record. You can associate record types with profiles to make only the included picklist values available to users with that profile.

Record-Level Security

A method of controlling data in which you can allow a particular user to view and edit an object, but then restrict the records that

the user is allowed to see.

Recycle Bin

A page that lets you view and restore deleted information. Access the Recycle Bin by using the link in the sidebar.

Related Object

Objects chosen by an administrator to display in the Agent console's mini view when records of a particular type are shown in the

console's detail view. For example, when a case is in the detail view, an administrator can choose to display an associated account,

contact, or asset in the mini view.

Relationship

A connection between two objects, used to create related lists in page layouts and detail levels in reports. Matching values in a

specified field in both objects are used to link related data; for example, if one object stores data about companies and another

object stores data about people, a relationship allows you to find out which people work at the company.

Relationship Query

In a SOQL context, a query that traverses the relationships between objects to identify and return results. Parent-to-child and

child-to-parent syntax differs in SOQL queries.

Report Type

A report type defines the set of records and fields available to a report based on the relationships between a primary object and its

related objects. Reports display only records that meet the criteria defined in the report type. Salesforce provides a set of pre-defined

standard report types; administrators can create custom report types as well.

Role Hierarchy

A record-level security setting that defines different levels of users such that users at higher levels can view and edit information

owned by or shared with users beneath them in the role hierarchy, regardless of the organization-wide sharing model settings.

Roll-Up Summary Field

A field type that automatically provides aggregate values from child records in a master-detail relationship.

SaaS

See Software as a Service (SaaS).

744

Glossary

S-Control

Note: S-controls have been superseded by Visualforce pages. After March 2010 organizations that have never created

s-controls, as well as new organizations, won't be allowed to create them. Existing s-controls will remain unaffected, and can

still be edited.

Custom Web content for use in custom links. Custom s-controls can contain any type of content that you can display in a browser,

for example a Java applet, an Active-X control, an Excel file, or a custom HTML Web form.

Salesforce Record ID

A unique 15- or 18-character alphanumeric string that identifies a single record in Salesforce.

Salesforce SOA (Service-Oriented Architecture)

A powerful capability of Force.com that allows you to make calls to external Web services from within Apex.

Sandbox

A nearly identical copy of a Salesforce production organization for development, testing, and training. The content and size of a

sandbox varies depending on the type of sandbox and the editioin of the production organization associated with the sandbox.

Search Layout

The organization of fields included in search results, in lookup dialogs, and in the key lists on tab home pages.

Session ID

An authentication token that is returned when a user successfully logs in to Salesforce. The Session ID prevents a user from having

to log in again every time he or she wants to perform another action in Salesforce. Different from a record ID or Salesforce ID, which

are terms for the unique ID of a Salesforce record.

Session Timeout

The period of time after login before a user is automatically logged out. Sessions expire automatically after a predetermined length

of inactivity, which can be configured in Salesforce from Setup by clicking Security Controls. The default is 120 minutes (two hours).

The inactivity timer is reset to zero if a user takes an action in the Web interface or makes an API call.

Setup

A menu where administrators can customize and define organization settings and Force.com apps. Depending on your organization’s

user interface settings, Setup may be a link in the user interface header or in the drop-down list under your name.

Sharing

Allowing other users to view or edit information you own. There are different ways to share data:

•Sharing Model—defines the default organization-wide access levels that users have to each other’s information and whether

to use the hierarchies when determining access to data.

•Role Hierarchy—defines different levels of users such that users at higher levels can view and edit information owned by or

shared with users beneath them in the role hierarchy, regardless of the organization-wide sharing model settings.

•Sharing Rules—allow an administrator to specify that all information created by users within a given group or role is automatically

shared to the members of another group or role.

•Manual Sharing—allows individual users to share records with other users or groups.

•Apex-Managed Sharing—enables developers to programmatically manipulate sharing to support their application’s behavior.

See Apex-Managed Sharing.

Sharing Model

Behavior defined by your administrator that determines default access by users to different types of records.

Sharing Rule

Type of default sharing created by administrators. Allows users in a specified group or role to have access to all information created

by users within a given group or role.

745

Glossary

Sites

Force.com Sites enables you to create public websites and applications that are directly integrated with your Salesforce

organization—without requiring users to log in with a username and password.

Snippet

Note: S-controls have been superseded by Visualforce pages. After March 2010 organizations that have never created

s-controls, as well as new organizations, won't be allowed to create them. Existing s-controls will remain unaffected, and can

still be edited.

A type of s-control that is designed to be included in other s-controls. Similar to a helper method that is used by other methods in

a piece of code, a snippet allows you to maintain a single copy of HTML or JavaScript that you can reuse in multiple s-controls.

SOAP (Simple Object Access Protocol)

A protocol that defines a uniform way of passing XML-encoded data.

Software as a Service (SaaS)

A delivery model where a software application is hosted as a service and provided to customers via the Internet. The SaaS vendor

takes responsibility for the daily maintenance, operation, and support of the application and each customer's data. The service

alleviates the need for customers to install, configure, and maintain applications with their own hardware, software, and related IT

resources. Services can be delivered using the SaaS model to any market segment.

SOQL (Salesforce Object Query Language)

A query language that allows you to construct simple but powerful query strings and to specify the criteria that should be used to

select data from the Force.com database.

SOSL (Salesforce Object Search Language)

A query language that allows you to perform text-based searches using the Force.com API.

Standard Object

A built-in object included with the Force.com platform. You can also build custom objects to store information that is unique to

your app.

System Log

Part of the Developer Console, a separate window console that can be used for debugging code snippets. Enter the code you want

to test at the bottom of the window and click Execute. The body of the System Log displays system resource information, such as

how long a line took to execute or how many database calls were made. If the code did not run to completion, the console also

displays debugging information.

Test Method

An Apex class method that verifies whether a particular piece of code is working properly. Test methods take no arguments, commit

no data to the database, and can be executed by the runTests() system method either through the command line or in an

Apex IDE, such as the Force.com IDE.

Translation Workbench

The Translation Workbench lets you specify languages you want to translate, assign translators to languages, create translations for

customizations you’ve made to your Salesforce organization, and override labels and translations from managed packages. Everything

from custom picklist values to custom fields can be translated so your global users can use all of Salesforce in their language.

Trigger

A piece of Apex that executes before or after records of a particular type are inserted, updated, or deleted from the database. Every

trigger runs with a set of context variables that provide access to the records that caused the trigger to fire, and all triggers run in

bulk mode—that is, they process several records at once, rather than just one record at a time.

746

Glossary

Trigger Context Variable

Default variables that provide access to information about the trigger and the records that caused it to fire.

Unit Test

A unit is the smallest testable part of an application, usually a method. A unit test operates on that piece of code to make sure it

works correctly. See also Test Method.

Unlimited Edition

Unlimited Edition is Salesforce’s solution for maximizing your success and extending that success across the entire enterprise through

the Force.com platform.

Unmanaged Package

A package that cannot be upgraded or controlled by its developer.

URL (Uniform Resource Locator)

The global address of a website, document, or other resource on the Internet. For example, http://www.salesforce.com.

URL S-Control

Note: S-controls have been superseded by Visualforce pages. After March 2010 organizations that have never created

s-controls, as well as new organizations, won't be allowed to create them. Existing s-controls will remain unaffected, and can

still be edited.

An s-control that contains an external URL that hosts the HTML that should be rendered on a page. When saved this way, the HTML

is hosted and run by an external website. URL s-controls are also called Web controls.

Validation Rule

A rule that prevents a record from being saved if it does not meet the standards that are specified.

Visualforce

A simple, tag-based markup language that allows developers to easily define custom pages and components for apps built on the

platform. Each tag corresponds to a coarse or fine-grained component, such as a section of a page, a related list, or a field. The

components can either be controlled by the same logic that is used in standard Salesforce pages, or developers can associate their

own logic with a controller written in Apex.

Web Control

See URL S-Control.

Web Links

See Custom Links.

Web Service

A mechanism by which two applications can easily exchange data over the Internet, even if they run on different platforms, are

written in different languages, or are geographically remote from each other.

747

Glossary

WebService Method

An Apex class method or variable that can be used by external systems, like a mash-up with a third-party application. Web service

methods must be defined in a global class.

Web Services API

A Web services application programming interface that provides access to your Salesforce organization's information. See also SOAP

API and Bulk API.

Web Tab

A custom tab that allows your users to use external websites from within the application.

Workflow Action

A workflow action, such as an email alert, field update, outbound message, or task, fires when the conditions of a workflow rule are

met.

Workflow Email Alert

A workflow action that sends an email when a workflow rule is triggered. Unlike workflow tasks, which can only be assigned to

application users, workflow alerts can be sent to any user or contact, as long as they have a valid email address.

Workflow Field Update

A workflow action that changes the value of a particular field on a record when a workflow rule is triggered.

Workflow Outbound Message

A workflow action that sends data to an external Web service, such as another cloud computing application. Outbound messages

are used primarily with composite apps.

Workflow Queue

A list of workflow actions that are scheduled to fire based on workflow rules that have one or more time-dependent workflow actions.

Workflow Rule

A workflow rule sets workflow actions into motion when its designated conditions are met. You can configure workflow actions to

execute immediately when a record meets the conditions in your workflow rule, or set time triggers that execute the workflow

actions on a specific day.

Workflow Task

A workflow action that assigns a task to an application user when a workflow rule is triggered.

WSDL (Web Services Description Language) File

An XML file that describes the format of messages you send and receive from a Web service. Your development environment's SOAP

client uses the Salesforce Enterprise WSDL or Partner WSDL to communicate with Salesforce using the SOAP API.

XML (Extensible Markup Language)

A markup language that enables the sharing and transportation of structured data. All Force.com components that are retrieved or

deployed through the Metadata API are represented by XML definitions.

No Glossary items for this entry.

748

Glossary

Zip File

A data compression and archive format.

A collection of files retrieved or deployed by the Metadata API. See also Local Project.

749

Glossary

INDEX

<new object name> component 686

Account Team Roles 17

AccountSettings components 558

ActionLinkGroupTemplate component 120

ActionOverride component 244

ActivitiesSettings component 559

AddressSettings component 563

AllOrNoneHeader header 714

Analytics 405

AnalyticSnapshot component 124

ApexClass component 136

ApexComponent component 138

ApexPage component 139

ApexTestSuite component 141

ApexTrigger component 142

API support policy 3

AppMenu component 144

ApprovalProcess components 147

ArticleType component

Channel Layout 132

Layout 130, 333

AssignmentRules component 158

AuraDefinitionBundle component 160

AuthProvider object 163

AutoResponseRules component 167

Backward compatibilty 3

BaseSharingRule component 639

BusinessHoursSettings component 567

BusinessProcess component 246

call deprecation 3

CallCenter component 170

CallOptions header 716

Calls

cancelDeploy 43

checkDeployStatus 42

checkRetrieveStatus 56

checkStatus 79

create (asynchronous) 71

createMetadata (synchronous) 59

delete (asynchronous) 73

Calls (continued)

deleteMetadata (synchronous) 68

deploy 33

deployRecentValidation 45

describeMetadata 80

describeValueType 81

listMetadata 84, 86

readMetadata (synchronous) 62

renameMetadata (synchronous) 70

retrieve 50

update (asynchronous) 75

updateMetadata (synchronous) 63

upsertMetadata (synchronous) 66

CampaignInfluenceModel component 172

cancel deploy call 43

CaseSettings components 571

Certificate component 173

Channel Layout (for article types) 132

ChatterAnswersSettings component 578

checkDeployStatus metadata call 42

checkRetrieveStatus metadata call 56

checkStatus metadata call 79

CleanDataService component 174

Community (Zone)component 179

CommunityTemplateDefinition component 182, 196

CommunityThemeDefinition component 186

CompactLayout component 248

CompanySettings component 580

component 222

Components

AccountSettings 558

ActionLinkGroupTempalte 120

ActionOverride 244

ActivitiesSettings 559

Activity Settings 559

AddressSettings 563

AnalyticSnapshot 124

ApexClass 136

ApexComponent 138

ApexPage 139

ApexTestSuite 141

ApexTrigger 142

AppMenu 144

ApprovalProcess 147

Article Type 133

ArticleType 127

750

Components (continued)

AssignmentRules 158

AuraDefinitionBundle 160

AutoResponseRules 167

BaseSharingRule 639

BusinessHoursSettings 567

BusinessProcess 246

CallCenter 170

CampaignInfluenceModel 172

CaseSettings 571

Certificate 173

Channel Layout (for article types) 132

ChatterAnswersSettings 578

CleanDataService 174

Community (Zone) 179

CommunityTemplateDefinition 182, 196

CommunityThemeDefinition 186

CompactLayout 248

CompanySettings 580

ConnectedApp 187

ContractSettings 581

CorsWhitelistOrigin 198

CriteriaBasedSharingRule 640

CspTrustedSite 200

custom metadata type 226

CustomApplication 201

CustomApplicationComponent 220

CustomFeedFilter 222

CustomField 250

CustomLabels 224

CustomMetadata 229

CustomObject 233

CustomObjectTranslation 288

CustomPageWebLink 297

CustomPermission 300

CustomSite 302

CustomTab 308

CustomValue 311

Dashboard 314

DelegateGroup 338

Dependent Picklist (see Picklist) 269

Document 340

DuplicateRule 342

EclairGeoData 347

EmailTemplate 349

EntitlementProcess 353

EntitlementSettings 582

EntitlementTemplate 357

EscalationRules 358

Components (continued)

ExternalDataSource 361

ExternalServiceRegistration 401

FieldSet 261

FileUploadAndDownloadSecuritySettings 584

FlexiPage 365

Flow 373

Folder 403

FolderShare 405

ForecastingSettings 588

GlobalPicklist 407

GlobalPicklistValue 408

GlobalValueSet 411

GlobalValueSetTranslation 413

Group 414

HistoryRetentionPolicy 262

HomePageComponent 415

HomePageLayout 417

IdeasSettings 598

InstalledPackage 418

KeywordList 419

KnowledgeSettings 599

Layout 421

Layout (for article types) 130, 333

LeadConvertSettings 605

Letterhead 441

list of types 106

ListView 263

LiveAgentSettings 607

LiveChatAgentConfig 444

LiveChatButton 448

LiveChatDeployment 451

LiveChatSensitiveDataRule 453

ManagedTopics 455

MatchingRule 457

Metadata 460

MetadataWithContent 461

MilestoneType 461

MobileSettings 607

ModerationRule 462

NamedCredential 466

NamedFilter 266

NameSettings 610

network 467

OpportunitySettings 611

OrderSettings 613

OrgPreferenceSettings 614

OwnerSharingRule 646

PathAssistant 482

751

Index

Components (continued)

PathAssistantSettings 616

PermissionSet 484

PersonalJourneySettings 617

Picklist 269

PlatformCachePartition 491

Portal 493

PostTemplate 495

ProductSettings 617

Profile 496

ProfileActionOverride 509

Queue 511

QuickAction 512

QuoteSettings 618

RecordType 273

RemoteSiteSetting 517

Report 519

ReportType 545

Role 549

RoleOrTerritory 550

SamlSsoConfig 552

Scontrol 555

SearchLayouts 275

SearchSettings 619

SecuritySettings 622

Settings 557

SharedTo 629

SharingBaseRule 631

SharingReason 278

SharingRecalculation 279

SharingRules 633

SharingSet 652

SiteDotCom 655

Skill 656

StandardValueSet 658

StandardValueSetTranslation 659

StaticResource 660

SynonymDictionary 662

Territory 664

Territory2 665

Territory2Model 669

Territory2Rule 671

Territory2Settings 628

Territory2Type 673

TransactionSecurityPolicy 675

Translations 677

unsupported 118

UserCriteria 686

ValidationRule 279

Components (continued)

WaveApplication 687

WaveDashboard 689

WaveDataflow 688

WaveDataset 690

WaveLens 690

WaveTemplateBundle 692

WaveXmd 693

WebLink 281

Workflow 698

Components in deployments 119

ConnectedApp component 187

ContractSettings component 581

CorsWhitelistOrigin component 198

create call (asynchronous) 71

createMetadata call (synchronous) 59

CriteriaBasedSharingRule component 640

CspTrustedSite component 200

Custom metadada type component 226

CustomApplication component 201

CustomApplicationComponent component 220

CustomField component 250

CustomLabels component 224

CustomMetadata component 229

CustomObject

WebLink component 281

CustomObject component 233

CustomObjectTranslation

language support 720, 726

CustomObjectTranslation component 288

CustomPageWebLink component 297

CustomPermission component 300

CustomSite component 302

CustomTab component 308

CustomValue component 311

Dashboard component 314

DebuggingHeader header 717

DelegateGroup component 338

delete call (asynchronous) 73

Delete components 41

deleteMetadata call (synchronous) 68

Dependent Picklist 269

Deploy 15

deploy call

running tests 23–25

Deployment issues 119

deployRecentValidation call 45

752

Index

Deprecated calls 3

describeMetadata call 80

describeValueType call 81

destructiveChanges.xml 41

destructiveChangesPost.xml 41

destructiveChangesPre.xml 41

Developer resources 3

Development platforms 2

Document component 340

DuplicateRule component 342

EclairGeoData component 347

Editions 1

EmailTemplate component 349

EntitlementProcess components 353

EntitlementSettings components 582

EntitlementTemplate component 357

Error handling 32

EscalationRules component 358

Expiration of session ID 32

ExternalDataSource component 361

ExternalServiceRegistration component 401

Field types 285

FieldSet component 261

File-based metadata 15

FileUploadAndDownloadSecuritySettings component 584

FlexiPage component 365

Flow component 373

FlowDefinition 402

Folder component 403

ForecastingSettings component 588

Global picklist 311, 407–408, 411

Global value set 411

global value sets

translation of 413

GlobalPicklist component 407

GlobalPicklistValue component 408

GlobalValueSet component 311, 411

GlobalValueSetTranslation component 413

Group component 414

Headers

AllOrNoneHeader 714

Headers (continued)

CallOptions 716

DebuggingHeader 717

SessionHeader 719

HistoryRetentionPolicy component 262

HomePageComponent component 415

HomePageLayout component 417

IdeasSettings component 598

InstalledPackage component 418

KeywordList component 419

KnowledgeSettings component 599

Layout component 421

Layout component (for article types) 130, 333

LeadConvertSettings components 605

Letterhead component 441

listMetadata call 84

ListMetadataQuery 86

ListView component 263

LiveAgentSettings components 607

LiveChatAgentConfig components 444

LiveChatButton components 448

LiveChatDeployment components 451

LiveChatSensitiveDataRule component 453

ManagedTopics component 455

Manifest file 15, 17

MatchingRule component 457

Metadata calls 1

Metadata component 460

Metadata components 117

Metadata types 106, 117–118

MetadataWithContent component 461

MilestoneType component 461

MobileSettings component 607

ModerationRule component 462

NamedCredential component 466

NamedFilter component 266

NameSettings component 610

Network component 467

753

Index

Object relationship 545

Objects

AuthProvider 163

Opportunity Team Roles 17

OpportunitySettings component 611

OrderSettings component 613

OrgPreferenceSettings component 614

Outer join 545

OwnerSharingRule component 646

Package 480

Package versions 136

package.xml

samples 17

PackageVersion 136

PathAssistant component 482

PathAssistantSettings component 616

PermissionSet component 484

PersonalJourneySettings component 617

Picklist component 269

Picklist value set 407–408

PicklistValue component 408

PlatformCachePartition component 491

Portal component 493

PostTemplate component 495

Prerequisites 4

ProductSettings component 617

Profile component 496

ProfileActionOverride component 509

Queue component 511

Quick start

Generate WSDLs 4

Import WSDLs 5

Java sample 6

Prerequisites 4

QuickAction component 512

QuoteSettings component 618

readMetadata call (synchronous) 62

RecordType component 273

Recycle Bin 340

RemoteSiteSetting component 517

renameMetadata call (synchronous) 70

Report component 519

ReportType component 545

Retrieve 15

retrieve call 50

RetrieveRequest 55

Role component 549

RoleOrTerritory component 550

SamlSsoConfig component 552

Sample code 6

Sandbox 1

Scontrol component 555

SearchLayouts component 275

SearchSettings components 619

SecuritySettings component 622

Session ID expiration 32

SessionHeader header 719

Settings 557

SharedTo component 629

SharingBaseRule component 631

SharingReason component 278

SharingRecalculation component 279

SharingRules 633

SharingSet component 652

SiteDotCom component 655

Skill component 656

Standard Picklist

standard value set names in API version 38.0 and later 733

standard value sets

translation of 659

Standards compliance 2

StandardValueSet

names 733

StandardValueSetTranslation component 659

StaticResource component 660

Support policy 3

Supported calls 117

SynonymDictionary component 662

Territory component 664

Territory2 component 665

Territory2Model component 669

Territory2Rule component 671

Territory2Settings component 628

Territory2Type component 673

TransactionSecurityPolicy component 675

Translations component 677

Types of fields 285

754

Index

Understanding metadata calls and components 1

update call (asynchronous) 75

updateMetadata call (synchronous) 63

upsertMetadata call (synchronous) 66

Usernames 25

ValidationRule component 279

Versions 136

Visualforce component, see ApexComponent 138

Visualforce page, see ApexPage 139

WaveApplication component 687

WaveDashboard component 689

WaveDataflow component 688

WaveDataset component 690

WaveLens component 690

WaveTemplateBundle component 692

WaveXmd component 693

WebLink component 281

Workflow component 698

WSC 5

WSDL integration 4–5

Zip file 15

755

Index

Metadata API Developer Guide

Navigation menu

Versions of this User Manual:

Views

Navigation