Data Vault

Using the working canvas

The working canvas can be used to display existing parts of the model or also extend the model. When having parts of the model opened, you can see the following objects being present. By double-clicking onto a Hub, it is possible to load everything related to that element, enabling you to browse through the existing model.

../_images/usingWorkingCanvas.png
  1. Hub
    ../_images/hub.png

    By default, hubs are represented as larger blue squares, with the display name written onto it.

  2. Link
    ../_images/link.png

    The link connecting two hubs are represented according to their type as line, arrow, or double-arrow. Multiple links are displayed in a bent manner.

  3. Satellite
    ../_images/satellite.png

    By default, satellites are smaller circles, represented with the color of the source system. They are connected to the hub with a line, carrying the functional suffix name of the satellite.

  4. Subject Area
    ../_images/subjectArea.png

    Subject Areas are used to group parts of the model. They are represented as colored clouds around the objects.

  5. Same As
    ../_images/sameAs.png

    To allow the modelling of same as links, the creation of “Alias Hubs” is possible. In this example, the Hub “Product Alias” is an alias of hub “Product” and thereby is bound to its parent by a doubled line. Technically, the declared loads for both hubs will be fed into the same object.

Extending the model

The existing model can easily be extended by using the provided creation dialogues. These dialogues can be reached in the Data Vault module through the right-click-context menu on the canvas or the menu in the top right.

When working with the right click-context-menu and building on top of an existing object (such as a hub, a link, …) , you can right click onto the existing object on the canvas. When invoking the dialogue this way, some information on the base tab can automatically be prefilled by the Datavault Builder.

Adding a Hub

Steps

The add hub dialogue can be used in different ways:

Create the logical model:

A new hub is created, without having a load from a source defined.

  1. Invoke the create hub dialogue,

  2. only fill out the base tab and

  3. complete the combined dialogue on the first tab.

Create a new hub with a load:

A new hub is created, with directly assigning a hub load for a staging table.

  1. Invoke the create hub dialogue,

  2. fill out all tabs and

  3. complete the combined dialogue on the last tab.

Add another load to an existing hub:

Another load from a staging table is assigned to an existing hub.

  1. Invoke the create hub dialogue by right-clicking onto the existing hub and selecting add hub load.

  2. The Datavault Builder will fill out the information on the base tab and directly take you to the source tab.

  3. Complete the combined dialogue on the last tab.

Create an alias hub:

A hub is created, which technically refers to the parent hub to allow same-as-linking.

  1. Invoke the create hub dialogue and

  2. decleare the parent hub in the Make This Hub An Alias For-field.

  3. The dialogue can be completed either on the first or last tab.

Base

../_images/base.png
  1. Hub Name
    Declaration of the displayed name of the hub. Editable.
    When clicking, a list of existing hub names will appear to avoid declaration of the same name.
  2. Hub ID
    Declaration of the technical ID represented on the database for the hub. Not editable.
    Is automatically derived from the entred hub name, but can be manually adjusted.
  3. Make This Hub An Alias For

    Declare the hub to be an alias for an existing hub. This allows the creation of same-as-links. Not editable.

  4. Subject Area

    Grouping the hub into a specific part of the model. Editable.

  5. Comment

    Custom notes about the hub. Will appear in the documentation. Editable.

  6. Add Hub Without Load

    Completes the creation for logical modelling without declaring a load for the hub.

Source

../_images/source.png
  1. Source System

    Selection of a Source System to load from.

  2. Staging Table

    Selection of a Staging Table to load from.

  3. Available Columns

    Available columns in the staging table. Can be filtered, sorted as well as previewed with the Data Preview.

  4. Business Key

    Declaration of the business key. Can be made up of a single columns or as a composite key. Use the buttons in the middle or drag an drop to add columns from the available columns.

  5. Check Uniqueness
    ../_images/checkUniqueness.png

    The Uniqueness check allows you to validate your composed business key against the data currently loaded into your staging area. Click onto the icon, to start the validation. Once complete, it will either successfully turn green (and directly enable Keys are Unique on the next tab), or turn red (and disable Keys are Unique).

    In the second case of duplicates, a data preview window will open up, directly supplying you with the identified duplicates and their count.

    ../_images/checkUniquenes_dataPreview.png

    Also, by clicking onto the plus-icon, you can retrieve a number of duplicates, helping you determine the root of the problem.

    ../_images/checkUniquenes_dataPreview2.png

Key Settings

../_images/keySettings.png
  1. Keys are Unique
    Definition, that the declared business key is the main identifier for the object and is on the same granularity as in the staging table. This activates a check on load, which will throw an error when violating the uniqueness constraint.
    Disable this option when modeling a denormalized source into the datavault or declaring a “foreign-key”-like business key for link-creation. More details in Adding a Link.
  2. Business Key Prefix
    Allows to set a prefix ahead of the declared business key.
    This is needed, when feeding a hub from multiple systems with overlapping keys, which do not mean the same. (For instance: System A Customer 12 != System B Customer 12).
  3. Datavault Category

    Specification to which part of the datavault category (Persistent Staging Area / Raw Vault / Business Vault) the load belongs to.

Adding a Satellite

The creation of a satellite requires an existing hub.

Steps

The add satellite dialogue can be used in two different ways:

Create the logical model:

A new satellite is created, without having a load from a source defined.

  1. Invoke the create satellite dialogue,

  2. only fill out the base tab and

  3. complete the combined dialogue on the first tab.

Create a new satellite with a load:

A new satellite is created, with directly assigning a hub load for a staging table.

  1. Invoke the create satellite dialogue,

  2. fill out all tabs and

  3. complete the combined dialogue on the last tab.

Base

../_images/base1.png
  1. Hub Name

    Name of the hub the satellite belongs to. When clicking into the field, a dropdown list with the existing hubs will appear.

  2. Functional Suffix Name

    Displayed name of the satellite. Editable.

  3. Functional Suffix ID
    Technical ID of the satellite. Not Editable.
    Is automatically derived from the functional suffix name, but can manually be adjusted.
    When more then one satellite exists, a functional suffix id is required.
  4. Subjcet Area
    Grouping the hub into a specific part of the model. Editable.
    If the chosen hub has an assigned subject area, the area will be automatically preselected.
  5. Comment

    Custom notes about the satellite. Will appear in the documentation. Editable.

  6. Create Satellite Without Load

    Completes the creation for logical modelling without declaring a load for the satellite.

Satellite Columns

../_images/satelliteColumns.png
  1. Hub Load

    Selection of an existing hub load from the parent hub.

  2. Available Columns

    Present columns in the staging table of the chosen hub load.

  3. Selected Columns

    Chosen columns to add as attributes to the satellite.

Conversions

../_images/conversions.png
  1. Columns

    Selected columns from the tab satellite columns.

  2. Type Converter
    Allows to add column-based type conversion on the way into the data vault.
    When declaring a type conversion, the original field will be added to the satellite, too, carrying the naming-extension _raw.
  3. Target Name

    Column-based renaming. Will only affect the displayed name.

  4. Comment

    Custom notes about the column. Will appear in the documentation.

Metadata slider

To open up the metadata slider, you can click onto any element previously loaded onto the working canvas. The slider will then appear from the bottom of the screen.
The Metadata-Sliders are made up similarly. Therefore, we will discuss the details based on the metadata of a hub.

Editable properties can be changed using pen.

../_images/metadataSlider.png
  1. Base
    In the base part, the specified data from the base-tab in the creation dialogue is listed.
    When having multiple users working on the same model, the change can only be saved if it has not been modified in the meantime. Otherwise the property has to be reloaded first.
  2. Load

    Lists all loads for the object. (A satellite will only have one load). Only the Datavault Category can be changed. To correct a business key, delete the load and create the correct load again.

  3. Object Actions
    ../_images/objectActions.png
    • Magnifying glass: Open the Data Viewer to see the historized data in the object.

    • Database minus: Open the dialogue to delete loaded data from the hub.

    • Trash bin: Delete the hub. This action requires to delete all loads, data and related objects first.

  4. Load Actions
    ../_images/loadActions.png
    • Circled arrow: Initiate a specific data vault load. Color/Hovering for status details. While loading, a stop symbol will appear to cancel the running load.

    • Trash bin: Remove the specific data vault load.

Style Settings

../_images/styleSettings.png
  1. Canvas Styles

    The following properties can be changed:

    • Color: In case of the satellite, the color will only affect prototyped satellites without a load.

    • Size

    • Font-Size

  2. General

    The visual grouping into subject areas on the canvas can be turned on or off.

Working with bookmarks

Bookmarks can significantly accelerate working speed with the core model by directly accessing most often used parts. Also, bookmarks can be directly shared with all other uses, so you can show what you are modelling currently to a coworker.

Creating a bookmark
  1. Load and arrange the parts of the objects on the working canvas in a favourable way.

  2. Right-Click onto the canvas to open up the context menu and select Add Bookmark.

  3. Give the bookmark a name and save it.

To load a stored view
  1. Click onto Menu and navigate to Bookmarks.

  2. Select a stored bookmark from the list.

Note

Be aware, that loading a bookmark will reinitialize the canvas and clean all existing objects.

Delete Bookmarks
  1. Click onto Menu and navigate to Bookmarks.

  2. Select “Manage Bookmarks…” from the list.

  3. A window listing all bookmarks will appear.

  4. Remove any unwanted bookmark and confirm to leave the dialogue.