Recipes by Category

App Distribution (2) Bundle logic, interface and services for distribution. App Logic (37) The Apex programming language, workflow and formulas for logic. Collaboration (6) The Salesforce Chatter collaboration platform. Database (29) Data persistence, reporting and analytics. Integration (33) Web Service APIs and toolkits for integration. Security (9) Platform, application and data security. Tools (4) Force.com tooling User Interface (36) Visualforce MVC and metadata-drive user interfaces. Web Sites (12) Public web sites and apps with optional user registration and login.
Beta Feedback
Cookbook Home » Using SoqlXplorer to Examine Your Data Model

Using SoqlXplorer to Examine Your Data Model

Post by Developer Force  (2010-07-16)

Status: Certified
Level: novice

Problem

You want to browse through the fields, attributes, and relationships of every object in your Salesforce.com organization, and you're on the Mac OS X platform.

Solution

For Mac users, SoqlXplorer provides metadata exploration, a SOQL query tester, and a graphical schema view for examining object relationships (a piece of functionality that's only available on the Mac OS X platform!). Download SoqlXplorer from Simon Fell's PocketSOAP website at www.pocketsoap.com/osx/soqlx. After the download automatically extracts itself, drag the SoqlXplorer icon to your Applications folder to complete the installation.

After installing SoqlXplorer, open the application and log in by entering your standard Salesforce.com username and password and specifying the server to which you want to connect. Choose www.salesforce.com to connect to the normal production servers, or test.salesforce.com to connect to a sandbox organization.

After you click Login, SoqlXplorer issues a describeGlobal() call to the API to populate the interactive list of objects in the right sidebar.

You can expand any object to explore its fields and relationships. To view attributes for an object, toggle the Details button to On in the bottom right corner of the window. If you select an object field, the Details popup shows properties for the field instead.

Viewing Object Attributes in SoqlXplorer
Two views are available in the main window: SOQL and Schema.
  • Use SOQL view to open a SOQL query editor where you can construct and execute SOQL queries. The queries you write use syntax-highlighting to improve legibility, and you can double-click an object's name to automatically build a query that selects all available fields. You can also double-click any result data to copy and paste it elsewhere.
  • Use Schema view to open an interactive entity relationship diagram (ERD) of the objects in your organization. Select any object in the right sidebar to view that object's parent relationships (in blue) and child relationships (in orange). You can expand the fields of any object by clicking the + toggle button in the upper right corner of any object, and you can double-click an object to move it to the center of the view.
Schema View in SoqlXplorer
Simon Fell frequently adds new functionality to SoqlXplorer. To automatically check for updates, click SoqlXplorer | Preferences and select Check for updates at startup.

Share

Recipe Activity - Please Log in to write a comment

Be the first to comment.

X

Vote to Verify a Recipe

Verifying a recipe is a way to give feedback to others and broaden your own understanding of the capabilities on Force.com. When you verify a recipe, please make sure the code runs, and the functionality solves the articulated problem as expected.

Please make sure:
  • All the necessary pieces are mentioned
  • You have tested the recipe in practice
  • Have sent any suggestions for improvements to the author

Please Log in to verify a recipe

You have voted to verify this recipe.