Skip to content

Effectivity Satellite

Ulf Mattern edited this page Feb 26, 2025 · 1 revision

This node creates an effectivity satellite version 0. It should be applied 'on top' of the staging layer, and is either connected to a Hub or a Link.

The purpose of an effectivity satellite is to capture whether an object or relationship disappears in the source system. Technically, one effectivity satellite always tracks the appearances of one hashkey, either a hub hashkey for business objects, or a link hashkey for relationships. If the hub or link is loaded by multiple sources, create one effectivity satellite for each source.

Disclaimer

This effectivity satellite is designed to identify and track deletions and appearances of hashkeys inside source objects. It only works if the source data delivery always includes a full load of the data. It does not work, if the data delivery only includes deltas.

Features:

  • Can handle multiple updates per batch, without losing intermediate changes. Therefore initial loading is supported. Effectivity is properly calculated for each batch.
  • Using a dynamic high-water-mark to optimize loading performance of multiple loads.

Version 1 Satellite

There is no specific Effectivity Satellite v1 macro. To calculate load end dates of effectivity data, the Standard Satellite v1 should be used.


User Configuration

In the "Config" section on the right hand-side, expand section "Data Vault" to modify the following configurations for the node:

Config Name Config Type Explanation
Tracked Hashkey columnSelector Select the hashkey which should be used for tracking effectivity.
Disable High-Water-Mark? Boolean By default, a HWM is applied in the loading script. This reduces the selected source data to only rows, where the load date is newer than the maximum load date inside the existing Satellite.
Source Data is Single Batch Boolean Performance boost for single source loads. Set this to FALSE only if source contains multiple batches. Model will get slower if set to FALSE, even if source only holds one batch.

System Columns

Sys Column Name Default Value Explanation
IS_ACTIVE --- Determines whether a hashkey appeared or disappeared in the load. Is of type boolean.

Example 1

Description

In this example we got a stage named 'STG_CUSTOMER_WIKI'.

Create the node:

Eff Sat Node

  • Select the 'STG_CUSTOMER_WIKI' and create the node 'EFF_SATV0_STG_CUSTOMER_WIKI' with the node type 'Datavault by Scalefree: Effectivity Satellite V0'
  • Rename the satellite using your naming conventions. In this case rename it to 'CUSTOMER_WIKI_ES'

Eff Sat Node open

  • Open the node and delete all unnecessary columns, so that you only keep the Hashkey, LoadDate Timestamp, Record Source and the system column is_active.
  • In the Config section on the right there is a tab called 'Data Vault'
  • Expand this and you get a column selector list 'Tracked Hashkey'
    • Select the to be tracked hashkey and bring it to the right side.
  • Create and run the node

Clone this wiki locally