Object Metadata

The Object Metadata tool in Crudspace.io provides a comprehensive interface for exploring and understanding the structure of standard and custom objects in Salesforce. This feature helps administrators and developers better understand their Salesforce data model.

Overview

Understanding the structure of Salesforce objects is crucial for effective development, administration, and data management. The Object Metadata tool offers:

• Detailed information about standard and custom objects
• Comprehensive field metadata including data types, picklist values, and relationships
• Visibility into object relationships and dependencies
• Easy exploration of object properties and capabilities

Accessing Object Metadata

To access the Object Metadata tool:

1. Log in to Crudspace.io
2. From the left sidebar, click on "Object Metadata"

Interface Components

Object Navigator

The left sidebar displays a hierarchical list of all available Salesforce objects:

• Standard Objects: Core Salesforce objects (Account, Contact, etc.)
• Custom Objects: Organization-specific custom objects
• Platform Objects: Salesforce platform objects (like AsyncApexJob)

Object Detail Panel

The main panel displays detailed information about the selected object:

• General Information: API name, label, plural label, description
• Object Properties: Searchable, queryable, createable, updateable, deletable
• Fields List: All fields available on the object
• Relationships: Child and parent relationships

Field Detail Panel

When a field is selected, its details are displayed:

• Field Properties: API name, label, type, length, precision, scale
• Access Controls: Permissions required for the field
• Picklist Values: For picklist fields, all available values
• Relationship Details: For relationship fields, target object and relationship behavior

Working with Object Metadata

Browsing Objects

1. Use the Object Navigator to browse through the list of available objects
2. Click on an object name to view its details
3. Use the search box to quickly find specific objects

Exploring Fields

1. Select an object to view its fields
2. Click on a field name to view detailed field metadata
3. Use field filters to narrow down the list of fields

Understanding Relationships

1. Navigate to the "Relationships" tab in the Object Detail Panel
2. View parent relationships (lookup and master-detail)
3. View child relationships (related lists)
4. Click on relationship names to navigate to related objects

Advanced Features

Metadata Search

Use the search functionality to find objects or fields matching specific criteria:

1. Enter a search term in the search box
2. Select whether to search objects, fields, or both
3. Review the search results to find the metadata you need

Metadata Export

Export object and field metadata for documentation or analysis:

1. Select the object you want to export
2. Click the "Export" button
3. Choose your export format (CSV, JSON, or XML)
4. Save the exported file

Use Cases

The Object Metadata tool is valuable for several scenarios:

1. Data Modeling: Understanding existing objects before creating new ones
2. Field Analysis: Reviewing field definitions and dependencies
3. Relationship Mapping: Mapping out object relationships
4. Permission Planning: Understanding field properties before setting permissions
5. Integration Planning: Identifying fields needed for integrations

Best Practices

• Regular Exploration: Periodically review object metadata to stay familiar with your Salesforce schema
• Document Findings: Export and document important metadata discoveries
• Check Relationships: Always check relationship behavior before modifying fields
• Verify Field Types: Review field types and constraints before building dependent functionality
• Consider Dependencies: Be aware of dependencies when planning changes to object structures

Related Documentation

• SObject Permissions
• Field Permissions
• Custom Metadata Editor