Skip to main content

How to use Salesforce data model diagrams to design external integrations

Use schema diagrams to design accurate external integrations.

Updated yesterday

Why use Salesforce data model diagrams to design external integrations?

Integrating Salesforce with external systems—whether Jira, an ERP, or a customer data platform—requires more than knowing which objects to sync. It demands a deep understanding of the schema: how objects relate, which fields are required, and where customizations diverge from standard Salesforce patterns.

Without that clarity, integration designs are risky. You may sync data in the wrong sequence, miss mandatory fields, or fail to see how one object depends on another—causing errors and fragmented records.

Elements.cloud helps you visualize and explore your Salesforce schema in minutes by generating capability-specific data model diagrams. These diagrams let architects confidently plan data mappings, API sequences, and field-level requirements, all grounded in live Org metadata.

When to use this?

Use this guide when:

  • Planning an external integration (e.g. Jira, SAP, NetSuite, HubSpot)

  • Mapping fields and relationships for ETL, middleware, or direct API interactions

  • Troubleshooting failed syncs due to schema mismatches

  • Documenting schema structure for developers or data teams

Prerequisites

Before you start, make sure:

Data Model Generation is currently available in closed beta to the customers who have pre-registered for access.

We are planning GA release in May, subject to feedback from beta customers.

Perform integration design using data model diagrams

Step 1: Understand the integration requirement

Before generating anything, clarify what data you plan to integrate and why. This shapes the scope of the diagram you’ll generate.

Ask:

  • What’s the business capability being supported by this integration?

  • What Salesforce records are involved? Created, read, updated, or deleted?

  • What’s the source or target system, and how will it interact?

Example scenario: You want to sync issue tracking data between Jira and Salesforce. In Jira, the key entities are epics, stories, bugs, and tasks. In Salesforce, these are often tracked via Case, Work Order, Task, but there is possibility of custom and managed objects of which you are unaware of.

Step 2: Generate the schema diagram for your capability

Use Elements’ data model generation to focus the diagram on your integration area.

Prompt example for the Jira–Salesforce use case:

“How do we manage work and customer issues across projects?”

This phrasing helps Elements select relevant objects like Case, Task, WorkOrder, and any custom ticketing structures like Bug__c or Epic__c.

Name the diagram accordingly (e.g. “Jira Integration Schema – April 2025”) and proceed to generate.

Step 3: Interpret object relationships to plan integration logic

Once the diagram is generated, shift into integration design mode. Each relationship line helps you determine:

  • Sequence of API calls or ETL steps

  • Mandatory dependencies that require pre-inserts

  • Which object serves as the parent in data hierarchy

Use the diagram to:

  • Identify lookups and master-detail relationships:

    • E.g., Task → Case, Case → Account

    • This implies Account must exist before Case, which must exist before Task
      ​

  • Discover custom relationships like Bug__c → Epic__c that mirror Jira hierarchy
    ​

  • Hover on fields to view population rate—helps assess if fields are optional or core
    ​

  • Click object cards to open the metadata dictionary, where you can:

    • View all fields and their types

    • Identify required fields

    • See field-level limits (lengths, picklists)

    • Check real usage and data volumes

Example Insight: If Bug__c is a custom object with a required lookup to Epic__c, then during integration:

  • You must ensure Epics are synced before Bugs

  • Bugs without valid Epics will cause insert errors

  • Field mapping must include the Epic__c reference field

Step 4: Document the integration design and next steps

  • Add sticky notes to flag constraints, priorities, or design decisions

  • Raise user stories directly from object cards for mapping or logic tasks

  • Use metadata dictionary views to create field-level mapping specs

  • Share the diagram with integration or developer teams for alignment

Summary

A well-defined integration starts with a well-understood schema. Elements.cloud data model diagrams turn Org complexity into clarity—helping you design safe, efficient, and robust integrations grounded in real metadata.

By starting with the business capability and using the diagram to understand object dependencies, you can map, sequence, and execute integrations with confidence.

Related Articles
Design the Technical Architecture of the Salesforce Solution to Ensure Scalability, Security, and Performance
Documenting Integrations and Relationships Between Salesforce and Other Systems
Salesforce data model generation
Understand Salesforce Data Model for Data Migrations
How to understand your Salesforce data model to build accurate reports and dashboards
Did this answer your question?