Salesforce ERD Generator 🌐📊

Welcome to the Salesforce ERD Generator! 🚀 This Visual Studio Code extension empowers you to create stunning Entity Relationship Diagrams (ERDs) for your Salesforce objects with ease. Visualize your data model, explore relationships, and export results as SVG or CSV—all from within VS Code! 🎨💾

Demo

Features ✨

• Generate ERDs: Create beautiful ERD diagrams for Salesforce objects using the Salesforce CLI and mohanc plugin. 🖼️
• Interactive UI: Add objects, view diagrams, and explore data in a sleek Webview interface. 🖥️
• Data Table: View object metadata in a sortable, searchable table. 📋
• Export Options: Download ERDs as SVG and data as CSV for easy sharing. 📥
• Fallback Support: Generates basic ERDs even if the mohanc plugin fails. 🔄
• Progress Feedback: Real-time status updates and progress bar for a smooth experience. ⏳

Installation 🛠️

1. Install Salesforce CLI:

   • Download and install the Salesforce CLI: Salesforce CLI Installation.
   • Verify installation:

     sf --version
     

2. Install mohanc Plugin (optional, for enhanced ERD generation):

   • Install the mohanc plugin:

     sf plugins install sfdx-mohanc-plugins
     

   • Verify:

     sf plugins --core
     

3. Install the Extension:

   • Open VS Code.
   • Go to the Extensions view (Ctrl+Shift+X or Cmd+Shift+X).
   • Search for Salesforce ERD Generator and click Install. 📦

4. Set Up Your Salesforce Org:

   • Ensure you have a Salesforce org alias or username configured:

     sf org list
     

Usage 🚀

1. Open the Extension:

   • Launch VS Code and open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P).
   • Run the command: Salesforce ERD: Generate Diagram. 🎯

2. Enter Details:

   • Username/Alias: Input your Salesforce username or org alias (e.g., mchinnappan@salesforce.com.platform6).
   • Objects: Add Salesforce objects (e.g., Account, Contact, Product2) using the input field and Add button. ➕
   • Remove objects by clicking the × on their pills. ❌

3. Generate ERD:

   • Click Generate ERD to create the diagram and data table. 🖌️
   • View the ERD in the ERD Diagram tab or metadata in the Data Table tab. 📈

4. Interact with Results:

   • ERD Diagram: Download the diagram as an SVG file. 💾
   • Data Table: Search, sort, and export data as CSV. 🔍📄
   • Switch between tabs to explore your data model. 🔄

5. Debugging:

   • Check status messages for progress or errors. ⚠️
   • Open the Webview’s Developer Tools (Ctrl+Shift+P > Developer: Toggle Developer Tools) for detailed logs. 🛠️

Example 🌟

1. Enter ea10 as the username.
2. Add objects: Account, Contact.
3. Click Generate ERD.
4. View the ERD diagram and table, then download the SVG or CSV.

Troubleshooting 🐞

• Salesforce CLI Not Found:

  • Ensure the CLI is installed and accessible:

    sf --version
    

  • Verify the path in your system environment variables.

• mohanc Plugin Issues:

  • Confirm plugin installation:

    sf plugins --core
    

  • Test the plugin:

    sf mohanc md describe -s Account -e /tmp/erd-test.svg -u your-org-alias
    

• No Diagram Generated:

  • Verify your org alias/username and object names.
  • Check the Output panel in VS Code for errors.
  • Ensure network access to your Salesforce org.

License 📜

This project is licensed under the MIT License. See the LICENSE file for details.

Happy ERD diagramming! 🎉