Metadata Retriever

TurboKit's Metadata Retriever provides a powerful interface for downloading and exploring Salesforce metadata, making it easier to understand your org's configuration and prepare for deployments.

Overview

Salesforce metadata represents the structure and configuration of your org, including objects, fields, page layouts, workflows, and more. The Metadata Retriever in TurboKit makes it easy to download and explore this metadata, providing valuable insights for development, documentation, and deployment planning.

Key Features

• Metadata Type Selection: Choose from a comprehensive list of metadata types
• Selective Download: Download specific metadata components or entire types
• Structured Output: View metadata in a structured, hierarchical format
• Export Options: Save metadata as XML or JSON files
• Metadata Comparison: Compare metadata across different orgs or environments
• Search Functionality: Search within metadata to find specific components
• Batch Processing: Download multiple metadata types at once

Using Metadata Retriever

Downloading Metadata

1. Open TurboKit and select "Metadata Retriever"
2. Select the metadata types you want to download
3. Choose specific components within each type (optional)
4. Click "Download" to retrieve the metadata
5. View the metadata in the structured viewer
6. Export the metadata to your local machine if needed

Supported Metadata Types

The Metadata Retriever supports a wide range of Salesforce metadata types, including:

• Objects: Standard and custom objects, including fields, relationships, and validation rules
• Profiles and Permission Sets: Security settings for users
• Page Layouts: Layout configurations for record pages
• Apex Classes and Triggers: Custom code in your org
• Visualforce Pages and Components: Custom UI elements
• Workflows and Process Builders: Automation configurations
• Reports and Dashboards: Reporting configurations
• Custom Metadata Types: Configuration data stored as metadata
• And many more: The tool supports all metadata types available through the Salesforce Metadata API

Exploring Metadata

Once downloaded, you can explore the metadata in the structured viewer:

• Navigate through the hierarchical structure to view specific components
• Expand and collapse sections to focus on areas of interest
• Search within the metadata to find specific elements
• View the raw XML or JSON representation of the metadata

Exporting Metadata

The Metadata Retriever allows you to export the downloaded metadata:

• Export as XML files (the native Salesforce metadata format)
• Export as JSON files (for easier parsing and analysis)
• Save to your local machine for further processing or version control

Best Practices

• Be selective about which metadata types you download to improve performance
• Use the search functionality to find specific components within large metadata sets
• Export metadata regularly for backup and version control purposes
• Compare metadata across environments to identify differences before deployments
• Use the structured viewer to understand relationships between metadata components
• Consider metadata dependencies when planning deployments

Integration with Other Features

The Metadata Retriever integrates with other TurboKit features:

• Use with REST API Explorer to understand the API calls for metadata operations
• Combine with Profile Reader to analyze security settings in the metadata
• Use alongside Field Creator to understand existing field configurations before creating new fields