Database.com Metadata API Developer's Guide - Salesforce.com

More documents

Recommendations

Info

Deploying and Retrieving MetadataMaintaining User ReferencesMaintaining User ReferencesUser fields are preserved during a metadata deployment.When a component in your deployment refers to a specific user, such as a recipient of a workflow email notification or adashboard running user, then Database.com attempts to locate a matching user in the destination organization by comparingusernames during the deployment.For example, when you copy data to a test database, the fields containing usernames from the production organization arealtered to include the test database name. In a test database named test, the username user@acme.com becomesuser@acme.com.test. When you deploy the metadata in the test database to another organization, the test in the usernameis ignored.For user references in deployments, Database.com performs the following sequence:1. Database.com compares usernames in the source environment to the destination environment and adapts the organizationdomain name.2. If two or more usernames match, Database.com lists the matching names and requests one of the users in the sourceenvironment be renamed.3. If a username in the source environment doesn’t exist in the destination environment, Database.com displays an error, andthe deployment stops until the usernames are removed or resolved to users in the destination environment.20
Chapter 4CRUD-Based Metadata DevelopmentUse the CRUD-based metadata calls to create, update, or delete setup and configuration components for your organizationor application. These configuration components include custom objects, custom fields, and other configuration metadata. Themetadata calls mimic the behavior in the Database.com user interface for creating, updating, or deleting components. Whateverrules 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 Database.com, from Setup, clickDevelop > 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 theSOAP API. Retrieve the metadataServerUrl from the LoginResult returned by your SOAP API login() call. Formore information about the SOAP API, see the SOAP API Developer's Guide.• Metadata calls are either asynchronous or synchronous. For the asynchronous calls, the results are not returned in a singlecall. The API core calls are synchronous; the results are returned in one call.• There are three asynchronous metadata calls with the same name as the corresponding core SOAP API synchronous calls,but with different signatures: create(), update(), and delete(). There is also a special utility call, checkStatus(),which you use to poll for the completion of the asynchronous call.The following development workflow is common for asynchronous CRUD-based metadata calls:1. The logged-in user issues a metadata call, specifying all required fields to be created or updated.2. Database.com returns an AsyncResult object, which is updated with status information for each component as the operationmoves from a queue to completed or error state.3. The logged-in user checks the status values in AsyncResult to determine when all the create or update operations arecompleted.Note: Metadata API also supports retrieve() and deploy() calls for retrieving and deploying metadatacomponents. For more information, see Deploying and Retrieving Metadata.Java Sample Code for CRUD-Based DevelopmentThis section walks through a sample Java client application that uses CRUD—based calls. This sample application performsthe following main tasks:1. Uses the MetadataLoginUtil.java class to create a Metadata connection. For more information, see Step 3: WalkThrough the Java Sample Code.2. Calls create() to create a new custom object.Database.com returns an AsyncResult object for each component you tried to create. The AsyncResult object is updatedwith 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.21
Page 1: Version 30.0: Spring ’14Database.
Page 4 and 5: Table of ContentsrenameMetadata()..
Page 7 and 8: GETTING STARTEDChapter 1Understandi
Page 9 and 10: Understanding Metadata APIDevelopme
Page 11 and 12: Chapter 2Quick StartThe easiest way
Page 13 and 14: Quick StartStep 3: Walk Through the
Page 15: Quick StartStep 3: Walk Through the
Page 18 and 19: Quick StartStep 3: Walk Through the
Page 20 and 21: USING METADATA APIChapter 3Deployin
Page 22 and 23: Deploying and Retrieving MetadataSa
Page 24 and 25: Deploying and Retrieving MetadataSa
Page 28 and 29: CRUD-Based Metadata DevelopmentNote
Page 30 and 31: Chapter 5Error HandlingMetadata API
Page 32 and 33: File-Based Callsdeploy()2. If the c
Page 34 and 35: File-Based Callsdeploy()NamerunAllT
Page 36 and 37: File-Based Callsdeploy()if (!deploy
Page 38 and 39: File-Based CallscancelDeploy()1. Is
Page 40 and 41: File-Based Callsretrieve()}}// and
Page 42 and 43: File-Based Callsretrieve()private v
Page 44 and 45: File-Based Callsretrieve()}} catch
Page 46 and 47: File-Based CallscheckRetrieveStatus
Page 48 and 49: Chapter 7CRUD-Based CallsUse the fo
Page 50 and 51: CRUD-Based Callsupdate()1. Determin
Page 52 and 53: CRUD-Based CallscreateMetadata()}//
Page 54 and 55: CRUD-Based CallsreadMetadata()nf.se
Page 56 and 57: CRUD-Based CallsupdateMetadata()upd
Page 58 and 59: CRUD-Based CallsdeleteMetadata()Ver
Page 60 and 61: CRUD-Based CallsrenameMetadata()}if
Page 62 and 63: Utility CallsdescribeMetadata()desc
Page 64 and 65: Utility CallsListMetadataQueryRespo
Page 66 and 67: Result ObjectsAsyncResultNameTypeDe
Page 68 and 69: Result ObjectsDeployResultNamedonei
Page 70 and 71: Result ObjectsDeployResultNamestate
Page 72 and 73: Result ObjectsDeployResultRunTestsR
Page 74 and 75: Result ObjectsDescribeMetadataResul
Page 76 and 77:
Result ObjectsRetrieveResultEach Re
Page 78 and 79:
Result ObjectsErrorErrorRepresents
Page 80 and 81:
Metadata TypesMetadata TypeMetadata
Page 82 and 83:
Metadata TypesUnsupported Metadata
Page 84 and 85:
Metadata TypesApexTriggerApexTrigge
Page 86 and 87:
Metadata TypesAppMenuField NameFiel
Page 88 and 89:
Metadata TypesCallCenterVersionCall
Page 90 and 91:
Metadata TypesCustomObjectVersionCu
Page 92 and 93:
Metadata TypesCustomObjectField Nam
Page 94 and 95:
Metadata TypesCustomFieldField Name
Page 96 and 97:
Metadata TypesCustomFieldField Name
Page 98 and 99:
Metadata TypesCustomFieldssnThe fir
Page 100 and 101:
Metadata TypesNamedFilter....See Al
Page 102 and 103:
Metadata TypesPicklist (Including D
Page 104 and 105:
Page 106 and 107:
Page 108 and 109:
Metadata TypesSharingRecalculationr
Page 110 and 111:
Metadata TypesWeblinkDeclarative Me
Page 112 and 113:
Metadata TypesWeblinkField Nameopen
Page 114 and 115:
Metadata TypesMetadata Field TypesF
Page 116 and 117:
Metadata TypesExternalDataSourceFie
Page 118 and 119:
Metadata TypesInstalledPackageInsta
Page 120 and 121:
Metadata TypesLayoutField Namerelat
Page 122 and 123:
Metadata TypesLayoutField Nameunitw
Page 124 and 125:
Metadata TypesLayoutField Namelayou
Page 126 and 127:
Metadata TypesLayoutField Namerelat
Page 128 and 129:
EditOwnerIdEditCurrencyIsoCodeTwoCo
Page 130 and 131:
Metadata TypesMetadatafeedItemTypeC
Page 132 and 133:
Metadata TypesPermissionSetNamename
Page 134 and 135:
Metadata TypesPermissionSetFieldedi
Page 136 and 137:
Metadata TypesProfileCustomTabJob_R
Page 138 and 139:
Metadata TypesProfileField Nameapex
Page 140 and 141:
Metadata TypesProfileField Nameallo
Page 142 and 143:
Metadata TypesProfile}// Employees
Page 144 and 145:
Metadata TypesQueueFieldsThis metad
Page 146 and 147:
Metadata TypesQuickActionField Name
Page 148 and 149:
Metadata TypesRemoteSiteSettingDecl
Page 150 and 151:
Metadata TypesSamlSsoConfigFieldsFi
Page 152 and 153:
Metadata TypesSettingsField Namesam
Page 154 and 155:
Metadata TypesActivitiesSettingsFil
Page 156 and 157:
Metadata TypesActivitiesSettingsFie
Page 158 and 159:
Metadata TypesBusinessHoursSettings
Page 160 and 161:
Metadata TypesBusinessHoursSettings
Page 163 and 164:
Metadata TypesMobileSettingsFielden
Page 165 and 166:
Metadata TypesSecuritySettingsField
Page 167 and 168:
Metadata TypesSecuritySettingsField
Page 169 and 170:
Metadata TypesSharingRulesFieldsFie
Page 171 and 172:
Metadata TypesBaseSharingRuleequals
Page 173 and 174:
Metadata TypesCriteriaBasedSharingR
Page 175 and 176:
Metadata TypesSiteDotComFieldField
Page 177 and 178:
Metadata TypesWorkflowDeclarative M
Page 179 and 180:
Metadata TypesWorkflowField Nametar
Page 181 and 182:
Metadata TypesWorkflowField Namecri
Page 183 and 184:
Metadata TypesWorkflowadmin@acme.co
Page 185 and 186:
GlossaryA |B |C |D |E |F |G |H |I |
Page 187 and 188:
GlossaryEEnterprise WSDLA strongly-
Page 189 and 190:
GlossaryMany-to-Many RelationshipA
Page 191 and 192:
GlossaryRelationship QueryIn a SOQL
Page 193 and 194:
GlossaryVValidation RuleWA rule tha
Page 195 and 196:
IndexIndexAAccount Team Roles 16Acc
Page 197:
IndexWSC 6WSDL integration 5-6ZZip
show all

Database.com Metadata API Developer's Guide - Salesforce.com

Create successful ePaper yourself

Delete template?

Save as template?