Help & Documentation

Learn how to use StructureGram

Promoting Versions to Diagrams

Promoting a version creates a brand new diagram based on a saved version's configuration. This is perfect for creating permanent variants or preserving important configurations beyond the 15-version limit.

What is "Promote to Diagram"?

Promote to Diagram:

  • Creates a new, independent diagram from a version
  • Copies all settings, layout, and scope from the version
  • The new diagram starts with a fresh version history (no versions)
  • The original diagram and version are unchanged
  • You're navigated to the new diagram immediately

Think of it as "save as" for diagrams - you get a complete copy to work with independently.

How to Promote a Version

  1. Open your diagram (Ownership View or Family Tree)
  2. Click the Versions button in the toolbar
  3. Find the version you want to promote
  4. Click the star icon next to the version name
  5. Enter a name for the new diagram
  6. Optionally add a description
  7. Click "Create Diagram"
  8. You're navigated to the newly created diagram

Naming Your New Diagram

The promote dialog pre-fills with the version name, but you should customize it:

Pre-filled: "Q4 2024 structure"
Better names:

  • "Smith Family Trust - Q4 2024 Archive"
  • "Jones Co. - Pre-Merger Configuration"
  • "Final Presentation - Board Meeting"

You can also add a description to provide context:

  • "Archived configuration before the 2024 restructure"
  • "Layout optimized for executive presentations"
  • "Historical ownership prior to merger with ABC Corp"

What Gets Copied?

The new diagram includes:

Complete State

  • All node positions and sizes
  • Link routing and vertices
  • Link label positions
  • Viewport zoom and pan
  • Legend position and visibility

Settings

  • Hidden entities
  • Custom colors and styling
  • Layout engine and routing algorithm
  • Snapshot date or date range
  • Filter group/scope configuration

Scope Snapshot

  • The exact entity list from the version
  • Immutable reference to those entities
  • Same scope template (if applicable)

What's NOT Copied

  • ❌ Version history (new diagram has no versions yet)
  • ❌ The original diagram's metadata
  • ❌ Any changes made after the version was saved

When to Promote

Permanent Preservation

Scenario: You've hit the 15-version limit but want to keep an important configuration

Solution: Promote that version to a diagram, then it exists permanently as its own diagram

Example:

Original diagram: "Smith Family Trust"
- 15 versions total
- Version "2020 original structure" will be deleted soon
- Promote to: "Smith Family Trust - 2020 Archive"
- Now both diagrams exist independently

Create Variants

Scenario: You want to maintain multiple versions of similar diagrams

Solution: Promote a version to create a branching point

Example:

Original: "ABC Company Structure"
- Version "Option A - Conservative"
- Version "Option B - Aggressive"
- Promote both to separate diagrams
- Now you have 3 diagrams: Original, Option A, Option B

Scenario Planning

Scenario: You're exploring "what-if" scenarios

Solution: Save versions for each scenario, promote the ones you want to preserve

Example:

1. Current structure diagram
2. Save version "Scenario 1: Acquire Competitor"
3. Modify diagram for Scenario 2
4. Save version "Scenario 2: Joint Venture"
5. Promote both scenarios to permanent diagrams
6. Present all three diagrams to stakeholders

Historical Archives

Scenario: You need to maintain historical records

Solution: Promote year-end or milestone versions to separate diagrams

Example:

Working diagram: "Jones Holdings"
Each year:
- Save version "2023-12-31 year end"
- Promote to "Jones Holdings - 2023 Archive"
- Continue working on current structure
- Historical diagrams remain frozen

Presentation Variants

Scenario: You need different presentations for different audiences

Solution: Create and promote versions optimized for each audience

Example:

Detailed working diagram
- Version "Board Presentation"
- Version "Executive Summary" 
- Version "Technical Analysis"
- Promote each to standalone diagrams
- Use appropriate diagram for each meeting

After Promotion

Once promoted:

  1. A new diagram is created in your diagram list
  2. You're automatically navigated to the new diagram
  3. The new diagram has no versions yet (fresh history)
  4. The original diagram and all its versions remain unchanged
  5. Both diagrams are completely independent

Promoted Diagrams are Independent

Important: Once promoted, the two diagrams have no connection:

  • Changes to the original don't affect the promoted copy
  • Changes to the promoted copy don't affect the original
  • They maintain separate version histories
  • They may have different scopes if entities are added/removed
  • Deleting one doesn't affect the other

Scope Behavior

The promoted diagram inherits the version's scope configuration:

  • Entity list: Exactly the entities from the version
  • Snapshot date: Same date/range as the version
  • Filter group: References the same entity filter (if shared scope)

Scope Immutability Note:
With StructureGram's diagram-owned scope system, promoted diagrams receive a cloned scope that's independent from the original. This means:

  • The promoted diagram has its own entity list
  • Modifying the promoted diagram's scope doesn't affect the original
  • Historical accuracy is preserved

Limitations

Version Limit Doesn't Apply

Unlike versions (max 15 per diagram), promoted diagrams are full diagrams:

  • No limit on how many diagrams you create
  • Each has its own 15-version allowance
  • They exist permanently until explicitly deleted

No "Demote" Back to Version

Once promoted to a diagram:

  • You cannot convert it back to a version
  • To restore to the original diagram, you'd need to duplicate or recreate
  • This is by design - diagrams and versions are different types

Scope May Drift

If the version referenced entities that are later deleted:

  • The promoted diagram may show fewer entities than expected
  • Relationships to missing entities won't appear
  • This is expected for archived historical diagrams

Promote vs. Duplicate

Promote Version:

  • Source: An immutable saved version
  • Creates: New diagram with version's exact state
  • Use: When you want a specific historical configuration

Duplicate Diagram:

  • Source: Current working copy
  • Creates: New diagram with current state
  • Use: When you want to copy the diagram's current state

Both create independent diagrams, but promote works from a version while duplicate works from the current working copy.

Common Workflows

Annual Archives

1. December 31: Save version "2024 Year End"
2. Promote to "Company Structure - 2024 Archive"
3. Continue working on diagram for 2025
4. Repeat each year
5. Maintain complete historical record

Presentation Library

1. Create detailed working diagram
2. Save version "Detailed"
3. Simplify, save version "Summary" 
4. Simplify more, save version "Executive"
5. Promote each to standalone diagrams
6. Use appropriate diagram for each audience

Scenario Comparison

1. Model current state
2. Save version "Current"
3. Model Scenario A, save version
4. Restore "Current", model Scenario B, save version
5. Promote all scenarios to diagrams
6. Present side-by-side comparison

Troubleshooting

"The promoted diagram looks different"

  • Entities referenced in the version may have been deleted
  • Check entity count metadata before promoting
  • The version captured state at save time, not current database state

"Can I undo a promotion?"

  • No, but you can delete the promoted diagram
  • The original diagram and version are unaffected
  • Promote is permanent - the new diagram exists

"The promoted diagram is missing relationships"

  • Relationships to deleted entities won't appear
  • This is expected for historical archives
  • The version captured what existed at save time

"Can I merge changes back to original?"

  • No automatic merge capability
  • You'd need to manually recreate changes
  • Promoted diagrams are independent by design

"Where do promoted diagrams appear?"

  • In your main diagram list
  • Same location as any diagram
  • Filtered by the same group/organization
  • Search for the name you gave it

Best Practices

  1. Name clearly: Include context like dates, purpose, or scenario in the name
  2. Add descriptions: Use the description field to explain why this version was preserved
  3. Don't over-promote: Only promote versions you need permanently
  4. Use for archives: Great for end-of-period historical records
  5. Scenario planning: Perfect for exploring "what-if" options
  6. Cleanup periodically: Delete promoted diagrams you no longer need

Next Steps