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

Chapter 2Quick StartThe easiest way to access the functionality in Metadata API is to use the Force.com IDE or Force.com Migration Tool. Thesetools are built on top of Metadata API and use the standard Eclipse and Ant tools respectively to simplify the task of workingwith Metadata API. Built on the Eclipse platform, the Force.com IDE provides a comfortable environment for programmersfamiliar with integrated development environments, allowing you to code, compile, test, and deploy all from within the IDEitself. The Force.com Migration Tool is ideal if you want to use a script or a command-line utility for moving metadata betweena local directory and a Database.com organization. For more information about the Force.com IDE or Force.com MigrationTool, see developer.force.com.However, the underlying calls of Metadata API have been exposed for you to use directly, if you prefer to build your ownclient applications. This quick start gives you all the information you need to start writing applications that directly use MetadataAPI to manage customizations for your organization. It shows you how to get started with File-Based Development. For anexample of CRUD-Based Development, see Java Sample Code for CRUD-Based Development.PrerequisitesMake sure you complete these prerequisites before you start using Metadata API.• Create a development environment.It is strongly recommended that you use a test database for development.• Identify a user that has the “API Enabled” and “Modify All Data” permissions. These permissions are required to accessMetadata API calls.• Install a SOAP client. Metadata API works with current SOAP development environments, including, but not limitedto, 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 DevelopmentKit 6). To run the samples, first download the latest force-wsc JAR file and its dependencies (dependencies are listed onthe 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 certaindevelopment 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 OrganizationTo access Metadata API calls, you need a Web Service Description Language (WSDL) file. The WSDL file defines the Webservice that is available to you. Your development platform uses this WSDL to generate stub code to access the Web serviceit defines. You can either obtain the WSDL file from your organization’s Database.com administrator, or you can generate ityourself if you have access to the WSDL download page in the Database.com user interface. For more information aboutWSDL, see http://www.w3.org/TR/wsdl.5