Graph Editor

The Graph Editor is a submodule of the Build module in beVault. It provides a visual workspace for creating, exploring, and managing a data model based on the Data Vault methodology.

To keep the graph readable and responsive, beVault now displays a graph selection screen before opening the editor. From this screen, users can choose which entities to display.

Choose a graph type

When the Graph Editor opens, the Choose graph type dialog is displayed. Select the graph type that best matches the purpose of your analysis or modelling task.

Source system graph

The Source system graph displays entities mapped to one or more selected source systems.

Select one or more source systems from the list and click Open graph. Entities mapped to the selected source systems are displayed in the graph.

You can select multiple source systems. This makes it possible to compare entities and relationships across different source systems.

Entity relationship graph

The Entity relationship graph displays the entities related to a selected starting entity.

Select the following options:

1. Starting entity: Select the entity from which the graph should start.

2. Relationship depth: Select how far the graph should expand from the starting entity.

A depth of 1 displays directly related entities. Higher values include entities that are further away from the starting entity.

Click Open graph to display the relationship graph.

Blank graph

The Blank graph opens an empty canvas. Use this option when you want to design a new part of the data model or create draft entities without loading an existing graph.

You can create hubs and links directly on the canvas.

All entities

The All entities option displays every entity in the model.

Large graphs may affect performance and can be more difficult to read. Use this option only when you need a complete overview of the model.

Entity states

Each hub, link, and satellite has a state in the graph:

• Draft: The node has been created in the graph to help design the model, but the entity has not yet been created. Draft entities are not available outside the Graph Editor and are not deployed.

• Created: The entity has been created and is available in other submodules. It will be deployed with the next release of the data model.

• Mapped: The entity is used and has been mapped to at least one source in the Source module.

Graph controls

The toolbar at the top of the graph provides controls for filtering and managing the graph.

The available graph also includes standard navigation controls for zooming and navigating large diagrams.

Node positions

Node positions are recalculated each time a graph is opened. The position of a node cannot be saved for future graph openings.

To recalculate the layout manually, click Relayout.

You can move several nodes at the same time:

1. Hold the Shift key.

2. Click and drag over the graph to create a selection box.

3. Release the mouse button.

4. Drag the selected nodes to their new position.

Explore and manage an entity

Click an entity to display its contextual action bar. The available actions depend on the entity’s state and type.

For a created entity, the contextual action bar provides the following options:

Information panel of an entity

Click an entity to display its available actions and descriptive information.

The information panel includes the following details, depending on the entity type:

• Business name

• Technical name

• Table name

• Number of attached satellites

• Number of created mappings

• Business key length for hubs

• Link type for links

• Satellite type for satellites

• Technical description

• Business description

The panel also provides actions for managing or exploring the entity:

• Show neighbours

• Open entity tab

• Update entity, for hubs and links

• Delete entity

The entity information panel and its available actions are based on the entity type and state.

Draft entities

Draft entities provide a different set of actions:

• Create: Opens the creation form for the draft hub or link.

• Update: Opens the form to edit the draft entity.

• Delete: Deletes the draft entity.

Click anywhere else on the graph to close the contextual action bar.

To open an entity’s dynamic tab quickly, hold the Ctrl key and click the entity in the graph.

Create an entity

You can create a new hub or link directly from the graph canvas.

1. Right-click an empty area of the canvas.

2. Select the type of entity to create.

3. A new draft node is added to the graph.

4. Click the draft node and select Create.

5. Complete the creation form.

6. Click Save.

The entity is created and is no longer in the draft state.

Create a hub

To create a hub:

1. Right-click an empty area of the canvas.

2. Select Create hub.

3. Click the draft hub and select Create.

4. Complete the hub information.

5. Click Save.

The hub creation form includes the following fields:

1. Hub’s Business Name (mandatory): The name of the hub. Human-readable name that describes the business concept represented. It is pre-filled with the name of the draft node but the users can edit it

2. Hub’s Business Name (mandatory): The technical name of the hub. Unique, system-oriented identifier used in the database, code, and technical integrations

3. Business Key Length (mandatory): In beVault, the business keys are always of type varchar (or equivalent depending on the database it is deployed on). This is the length of the column in the database

4. Technical Description: A description for the technical users

5. Business Description: a description for the business users

6. Business key case: Choose whether the business key is case sensitive or not (the colour blue defines the chosen option)

7. Save: this button saves the entity and closes the modal

Create a link

You can create a link in two ways:

• Create a draft link from an empty area of the canvas.

• Connect two hubs by dragging a new connection between them.

Create a link from the canvas

1. Right-click an empty area of the canvas.

2. Select Create link.

3. Click the draft link and select Create.

4. Complete the link creation form.

5. Click Save.

The hubs referenced by the link must already exist. A link cannot be created if one of its required hubs is still in the draft state.

Create a link by connecting hubs

To create a link by connecting hubs:

1. Select a connection port on a hub.

2. Drag the connection to another compatible hub.

3. Release the mouse button.

4. Complete the link creation form.

The two connected hubs are automatically added as hub references for the new link.

Connect entities

You can create or configure relationships by dragging a connection from one entity to a compatible node.

The result depends on the connected entities:

• Hub to link: Adds the hub as a reference of the link.

• Hub to hub: Creates a link and adds both hubs as references.

• Incompatible connection: The connection cannot be created.

The link creation form is displayed when additional information is required.

Link creation form

The link creation form consists of two sections.

The link creation consists of a two-step modal with descriptive information about the link and its dependencies.

1. “Basic Information”

   

   1. Link’s Business Name (mandatory): The name of the link. Human-readable name that describes the relationship represented. It is pre-filled with the name of the draft node but the users can edit it

   2. Technical Name (mandatory): The technical name of the link. Unique, system-oriented identifier used in the database, code, and technical integrations

   3. Link Type (mandatory): The type of the link

      1. Relationship: This type of link describes a basic relationships between two (or more) hubs. (e.g. the manufacturer of a car)

      2. Same as: This type of link is mostly used to map two business keys of a same hub that represent the same business object.

      3. Transactional (Non-historized): This type of link represent a relationship that will never change over time. Most of the time, it has a timestamp dependent child. (e.g. an accounting line)

      4. Hierarchy: This type of link, as its name suggests, represent a hierarchy on the same hub. (e.g. A manager - employee relationship with only one hub “employee”)

2. “Add References”

   

   
   

   1. The hub references are pre-filled with the attached hubs when using the “Edge mode” feature

   2. The users can add a new reference by filling in its name and selecting a hub

   3. The users can remove a hub reference by clicking on the “-” button in the list of hub references

   4. The users can add some dependent children by filling in its name and type

      1. Additional information (lenght, scale and precision, …) may be required depending on the type selected

   5. The users can remove a dependent child by clicking on the “-” button

Keyboard shortcuts

Recommended workflow

For the best performance and clearest results:

1. Open the Graph Editor.

2. Select the graph type that matches your task.

3. Use a source system graph when analysing source mappings.

4. Use an entity relationship graph when exploring dependencies around a specific entity.

5. Use a blank graph when designing a new model area.

6. Use Show neighbours to extend the current view when required.

7. Use Relayout after adding or moving several entities.

8. Avoid the All entities option for very large models unless a complete overview is necessary.