Historization

Overview

The Historization page maintains how a table is historized into a historized table and how the generated historization package handles changes over time. Use it to assign the historizing package, control SCD behavior, define validity-period logic, maintain filters and scripts, configure special history columns, and tune package loading options.

Function

The top area identifies the historization relationship in Historicize and lets you select or enter the Package that owns the historization. Operational options control statistics updates, VAULT ID usage, insert-only loading, use of existing history, truncation, source persistence, duplicate checks, future-history cleanup, empty-source handling, missing-source behavior, and whether the stored procedure is automatically created or manually maintained.

The Definition tab contains the main column rules. The Columns grid assigns each column to no change tracking, SCD 1 current-value tracking, or SCD 2 full history tracking, and it can define fallback empty values. The calculated-columns grid adds derived columns with statements and data types, while the Variables grid maintains package variables used by the historization package.

The Filters tab separates new-or-changed detection from deleted-row detection. It provides one filter area for the incoming source side and one for the existing historized side in each detection flow.

The Scripts tab stores SQL that runs before and after the historization step. Each script can be viewed as originally entered or as parsed text after AnalyticsCreator resolves macros.

The Procedure, Special columns, and Options tabs control the generated or manually maintained procedure text, the technical history-column names, and package performance behavior. The default buttons restore repository defaults for the related special-column or option value.

Save validates the historizing package, checks required empty values when an empty record is configured, stores the historization settings, regenerates the historization procedure, and refreshes the page. Cancel closes the editor without continuing the current edit.

Access

Open an existing historization from the Historization branch under Packages, from the historization branch under a historization schema, from the Historizations list, or from a diagram historization edge. To create a new historization, use Add historization from a package, table, or diagram context; the Historization Wizard collects the source table, target schema, target table name, package, SCD type, empty-record behavior, and VAULT ID option before opening the Historization page for detailed editing.

How to access

Data warehouse -> Packages -> Historization -> [package] -> [historization] -> Edit historization, or Data warehouse -> [historization schema] -> Historization -> [historization].

Toolbar

ETL -> Historizations, then double-click a row or use New to create a historization.

Diagram

Double-click a historization package edge, or use Add -> Historization from a table context.

Visual element

Historization page and Historization Wizard

Screen overview

ID Property Description
1HistoricizeRead-only relationship label showing the historized table and the source table being edited.
2PackageHistorizing package that owns the definition. A typed package name can create a new historizing package on save.
3Update StatisticsUpdates table statistics as part of the historization package flow.
4Use VAULT ID as PKUses the VAULT ID value as the primary-key basis for the historization.
5Insert only (no PK)Uses insert-only historization when no primary key is available; this also limits close-behavior and calculated-column editing.
6Source is historicisedUses existing history from the source side. It requires a ValidFrom statement before it can remain selected.
7Truncate historized tableClears the historized table when existing source history is used.
8Persist sourcePersists the source side when the historized source is based on a view and persistence is available.
9Check source for duplicatesChecks incoming source data for duplicate business keys before loading history.
10Delete future history if existsAllows the load to remove later-dated history rows when they conflict with the current run.
11Empty sourceControls empty-source behavior: Continue, Stop with error, or Stop without error.
12ValidFrom new keysStatement used to calculate the valid-from date for newly detected keys.
13ValidFrom existing keysStatement used to calculate the valid-from date for keys that already have history.
14ValidToStatement used to calculate the valid-to date for closed history rows.
15Missing sources behaviourControls how missing source rows affect existing history: Close, Do not close, or Add empty record.
16Stored procedure typeChooses between Automatically created and Manually created procedure handling.
17DefinitionTab for column historization rules, calculated columns, and package variables.
18ColumnsGrid that defines how each table column participates in historization.
19Column nameColumn selected for the historization rule.
20SCD TypeColumn behavior: None, SCD1 (Actual only), or SCD2 (Full historicize).
21Empty valueFallback value used when the load must add an empty record for a required column.
22Last value as empty valueUses the previous value as the empty-record fallback for that column.
23Calculated columnsGrid for derived values; the labels remind you to use the incoming and existing-row aliases in expressions.
24StatementExpression used to calculate the derived column value.
25Data TypeData type for the calculated column.
26MaxLengthMaximum character length for the calculated column when relevant.
27NumScaleNumeric scale for the calculated column when relevant.
28NumPrecNumeric precision for the calculated column when relevant.
29VariablesGrid for package variables used by the historization package.
30VariableVariable name available to the generated package.
31TypeVariable data type: String, Integer, or Boolean.
32DescriptionOptional description of the package variable.
33ExpressionOptional expression for the package variable.
34Initial valueInitial value assigned to the package variable.
35FiltersTab for change-detection and delete-detection filters.
36Detect new and changed data - source tableFilter for incoming source rows used to detect new or changed data.
37Detect new and changed data - historized tableFilter for existing historized rows used to detect new or changed data.
38Detect deleted data - source tableFilter for incoming source rows used to detect deleted data.
39Detect deleted data - historized tableFilter for existing historized rows used to detect deleted data.
40ScriptsTab for SQL that runs before or after the historization step.
41PreScriptSQL executed before the historization step.
42PostScriptSQL executed after the historization step.
43Original / ParsedSwitches script display between the entered script and the parsed script after macro resolution.
44ProcedureTab containing the stored-procedure text; it is read-only for automatically created procedures and editable for manually created procedures.
45Special columnsTab for technical history-column names.
46Column to store technical valid from dateColumn that stores the technical valid-from timestamp.
47Column to store technical valid to dateColumn that stores the technical valid-to timestamp.
48Column to store root surrogate keyColumn that stores the root surrogate key for the history chain.
49Column to store previous surrogate keyColumn that stores the previous surrogate key in the history chain.
50Column to store next surrogate keyColumn that stores the next surrogate key in the history chain.
51OptionsTab for package loading and performance settings.
52DefaultBufferMaxRowsMaximum rows allowed in a data-flow buffer before the package uses a new buffer.
53DefaultBufferSizeBuffer size used by the generated package data flow.
54Max insert commit sizeMaximum number of inserted rows committed in one operation.
55Keep nullsPreserves incoming null values instead of applying target defaults.
56Keep identityKeeps identity values from the incoming data when supported.
57Table lockRequests a table lock while rows are inserted into the historized target.
58Check constraintsControls whether target constraints are checked during load.
59Rows per batchBatch size used when writing rows to the historized target.
60Use HASH JOINControls whether generated historization SQL should use hash-join behavior when available.
61defaultRestores the repository default value for the special-column or option row.
62SaveValidates the package and stores the historization rules, filters, scripts, procedure settings, special columns, and options.
63CancelCloses the page without continuing the current edit.

Related topics