Parameters & Macros

Parameters

AnalyticsCreator provides various parameters that can be modified to customize its functionality. To access the parameter settings page, navigate to Help → Parameters in the toolbar.
Once the parameter settings page is open, use the Search Criteria field to locate specific parameters.

image (39)

Below is a list of parameters available for modification in AnalyticsCreator:

Parameter Description Initial value
ALLOW_SNOWFLAKE_TABULAR_OLAP Allow DIM-DIM relations in tabular OLAP cubes 0
AUTOCREATED_REFERENCES_USE_FRIENDLY_NAME Use friendly names instead of table names in description of autocreated references: 0- no, 1 - yes 0
CSV_EMPTY_STRING_LENGTH Length of empty string fields 50
CSV_MIN_STRING_LENGTH Minimum length of string fields 50
CSV_SCAN_ROWS Count of rows scanned to get the field properties 500
DATAVAULT2_CREATE_HUBS DataVault2 create hubs: 0 - no, 1 - yes 1
DEFAULT_CALENDAR_MACRO Name of default calendar macro NULL
DEPLOYMENT_DO_NOT_DROP_OBJECT_TYPES Comma-separated list of object types (see description of SQLPACKAGE.EXE)

Aggregates, ApplicationRoles, Assemblies, AsymmetricKeys, BrokerPriorities, Certificates, Contracts, DatabaseRoles, DatabaseTriggers, ExtendedProperties, FullTextCatalogs,

FullTextStoplists, MessageTypes, PartitionFunctions,

PartitionSchemes, Permissions, Queues, RemoteServiceBindings, RoleMembership, Rules, SearchPropertyLists, Sequences, Services,

Signatures, SymmetricKeys, Synonyms, UserDefinedDataTypes, UserDefinedTableTypes, ClrUserDefinedTypes, Users, XmlSchemaCollections, Audits, Credentials, CryptographicProviders,

DatabaseAuditSpecifications, Endpoints, ErrorMessages, EventNotifications, EventSessions, LinkedServerLogins, LinkedServers, Logins, Routes, ServerAuditSpecifications, ServerRoleMembership, ServerRoles, ServerTriggers

DESCRIPTION_PATTERN_CALENDAR_ID Autogenerated description of HIST_ID (SATZ_ID) field in calendar dimension. You can use {TableName}, {TableID} and {CR} placeholders Calendar ID
DESCRIPTION_PATTERN_DATEFROM Autogenerated description of DATEFROM (DAT_VON_HIST) field. You can use {TableName}, {FriendlyName}, {TableID} and {CR} placeholders {TableName}: Start of validity period
DESCRIPTION_PATTERN_DATETO Autogenerated description of DATETO (DAT_BIS_HIST) field. You can use {TableName}, {FriendlyName}, {TableID} and {CR} placeholders {TableName}: End of validity period
DESCRIPTION_PATTERN_HIST_ID Autogenerated description of HIST_ID (SATZ_ID) field. You can use {TableName}, {FriendlyName}, {TableID} and {CR} placeholders {TableName}: Surrogate key
DESCRIPTION_PATTERN_SNAPSHOT_ID Autogenerated description of HIST_ID (SATZ_ID) field in snapshot dimension . You can use {TableName}, {TableID} and {CR} placeholders Snapshot ID
DIAGRAM_NAME_PATTERN Object name in diagram. You can use {Name}, {Friendly name}, {FullFriendlyName}, {ID} and {CR} placeholders {FullFriendlyName}
DWH_CREATE_REFERENCES Create disabled references between tables in data warehouse 0
DWHWIZARD_CALENDAR DWH Wizard. 1 - Create, 0 - Do not create 1
DWHWIZARD_CALENDAR_FROM DWH Wizard. Calendar start date 19800101
DWHWIZARD_CALENDAR_TO DWH Wizard. Calendar start date 20201231
DWHWIZARD_CALENDAR_TRANSNAME DWH Wizard. Calendar dimension name DIM_Calendar
DWHWIZARD_DIMNAME DWH Wizard. Template for generated dimensions DIM_{SRC_NAME}
DWHWIZARD_DWHTYPE DWH Wizard. 1 - Classic, 2 - DataVault 1.0, 3 - DataVault 2.0, 4 - Mixed 1
DWHWIZARD_FACT DWH Wizard. 1 - N:1 direct related, 2 - All direct related, 3 - N:1 direct and indirect related, 4 - all direct and indirect related 3
DWHWIZARD_FACT_CALENDAR DWH Wizard. 1 - use Calendar in facts, 0 - do not use Calendar in facts 1
DWHWIZARD_FACTNAME DWH Wizard. Template for generated facts FACT_{SRC_NAME}
DWHWIZARD_HISTPACKAGENAME DWH Wizard. Template for generated hist package names HIST_{CONNECTOR_NAME}{NR}
DWHWIZARD_HUB_PACKAGENAME DWH Wizard. Template for generated HUB packages HIST_{CONNECTOR_NAME}_HUB{NR}
DWHWIZARD_HUB_TABLENAME DWH Wizard. Template for generated HUB tables {SRC_NAME}_HUB
DWHWIZARD_HUB_TRANSNAME DWH Wizard. Template for generated HUB transformations {SRC_NAME}_HUB
DWHWIZARD_IMPPACKAGENAME DWH Wizard. Template for generated import package names IMP_{CONNECTOR_NAME}{NR}
DWHWIZARD_LINK_PACKAGENAME DWH Wizard. Template for generated LINK packages HIST_{CONNECTOR_NAME}_LINK{NR}
DWHWIZARD_LINK_TABLENAME DWH Wizard. Template for generated LINK tables {SRC_NAME}_LINK
DWHWIZARD_LINK_TRANSNAME DWH Wizard. Template for generated LINK transformations {SRC_NAME}_LINK
DWHWIZARD_SAT_PACKAGENAME DWH Wizard. Template for generated SAT packages HIST_{CONNECTOR_NAME}_SAT{NR}
DWHWIZARD_SAT_TABLENAME DWH Wizard. Template for generated SAT tables {SRC_NAME}_SAT
DWHWIZARD_SAT_TRANSNAME DWH Wizard. Template for generated SAT transformations {SRC_NAME}_SAT
DWHWIZARD_TABLENAME DWH Wizard. Template for generated table names {SRC_NAME}
DWHWIZARD_TABLESPERPACKAGE DWH Wizard. Tables per package 10
FORCE_DESCRIPTION_INHERITANCE Force inheritance of table and column description: 0 - no, 1 - yes 0
FORCE_FRIENDLYNAMES_INHERITANCE Force inheritance of table and column friendly names: 0 - no, 1 - yes 0
FRIENDLYNAME_PATTERN_CALENDAR_ID Autogenerated friendly name of HIST_ID (SATZ_ID) field in calendar dimension. You can use {TableName}, {TableID} and {CR} placeholders Calendar
FRIENDLYNAME_PATTERN_DATEFROM Autogenerated friendly name of DATEFROM (DAT_VON_HIST) field. You can use {TableName}, {FriendlyName}, {TableID} and {CR} placeholders {FriendlyName}_ValidFrom
FRIENDLYNAME_PATTERN_DATETO Autogenerated friendly name of DATETO (DAT_BIS_HIST) field. You can use {TableName}, {FriendlyName}, {TableID} and {CR} placeholders {FriendlyName}_ValidTo
FRIENDLYNAME_PATTERN_DUPLICATED_COLUMNS Autogenerated replacement of duplicated friendly names. You can use {FriendlyName}, {ColumnName}, {ColumnID} and {NR} (consecutive number) placeholders {FriendlyName}_{ColumnName}
FRIENDLYNAME_PATTERN_DUPLICATED_TABLES Autogenerated replacement of duplicated friendly names. You can use {FriendlyName}, {TableName}, {TableID} and {NR} (consecutive number) placeholders {FriendlyName}_{TableName}
FRIENDLYNAME_PATTERN_HIST_ID Autogenerated friendly name of HIST_ID (SATZ_ID) field. You can use {TableName}, {FriendlyName}, {TableID} and {CR} placeholders {FriendlyName}
FRIENDLYNAME_PATTERN_SNAPSHOT_ID Autogenerated friendly name of HIST_ID (SATZ_ID) field in snapshot dimension . You can use {TableName}, {TableID} and {CR} placeholders Snapshot
HIST_DEFAULT_TYPE 1- SSIS Package, 2 - Stored Procedure 1
HIST_DEFAULT_USE_VAULTID 0 - don't use VAULT_HUB_ID as primary key. 1 - use VAULT_HUB_ID as primary key 1
HIST_DO_NOT_CLOSE Default value of "Missing record behaviour" parameter for new historizations. 0 - close, 1 - don't close 0
LAYER1_NAME Source layer name Source layer
LAYER2_NAME Staging layer name Staging layer
LAYER3_NAME Persisted staging layer name Persisted staging layer
LAYER4_NAME Transformation layer name Transformation layer
LAYER5_NAME Data warehouse layer name Data warehouse layer
LAYER6_NAME Data mart layer name Data mart layer
OLEDBPROVIDER_SQLSERVER OLEDB provider for SQL Server SQLNCLI11
REF_TABLES_RECURSION_DEPTH Max recursion depth due the detection of referenced tables in transformation wizard 5
SAP_DELTAQ_AUTOSYNC 0-Disable, 1- Enable 1
SAP_DELTAQ_TRANSFERMODE I-IDoc, T- tRFC T
SAP_DESCRIPTION_LANGUAGE SAP language to get table and field descriptions E
SAP_MAX_RECORD_COUNT Max count of records returned by SAP 1000
SAP_THEOBALD_VERSION 0 - match the SQL Server version, number (2008, 2012 etc) 2012
SAP_USETABLECOMPRESSION Load SAP using compression 1
SHOW_HUB_DEPS Show vault HUB dependencies 0
SOURCE_REFERENCE_DESCRIPTION_PATTERN Autogenerated source reference description. You can use {SourceSchema1}, {SourceName1}, {SourceID1}, {FriendlyName1}, {SourceSchema2}, {SourceName2}, {SourceID2} and {FriendlyName2} placeholders FK_{SourceName1}_{SourceName2}
SOURCE_REFERENCE_ONECOL_DESCRIPTION_PATTERN Autogenerated one-column source reference description. You can use {SourceSchema1}, {SourceName1}, {SourceID1}, {FriendlyName1}, {SourceSchema2}, {SourceName2}, {SourceID2}, {FriendlyName2}, {ColumnName}, {ColumnID} and {ColumnFriendlyName} placeholders RC_{SourceName1}_{SourceName2}_{ColumnName}
SOURCE_REFRESH_DEL_MISSING_IMP_COLS Source refresh - delete missing import columns: 0 - no, 1 - yes 0
SOURCE_REFRESH_DEL_MISSING_SOURCES Source refresh - delete missing sources: 0 - no, 1 - yes 0
SOURCE_REFRESH_REFRESH_IMP_COLS Source refresh - refresh import columns: 0 - no, 1 - yes 0
SOURCE_REFRESH_REFRESH_IMP_DESC Source refresh - refresh import descriptions: 0 - no, 1 - yes 0
SOURCE_REFRESH_REFRESH_PK Source refresh - refresh primary keys in import tables: 0 - no, 1 - yes 0
SOURCE_REFRESH_REFRESH_SRC_DESC Source refresh - refresh source descriptions: 0 - no, 1 - yes 0
SSIS_REPLACE_DECIMAL_SEPARATOR 0 - do not replace, 1 - replace point by comma, 2 - replace comma by point 1
SYNC_TIMEOUT Timeout for DWH synchronization, seconds 600
TABLE_COMPRESSION_TYPE Default table compression type: 1-NONE, 2-PAGE, 3-RAW 1
TABLE_REFERENCE_DESCRIPTION_PATTERN Autogenerated table reference description. You can use {TableSchema1}, {TableName1}, {TableID1}, {FriendlyName1}, {TableSchema2}, {TableName2}, {TableID2} and {FriendlyName2} placeholders FK_{TableName1}_{TableName2}
TABLE_REFERENCE_ONECOL_DESCRIPTION_PATTERN Autogenerated one-column table reference description. You can use {TableSchema1}, {TableName1}, {TableID1}, {FriendlyName1}, {TableSchema2}, {TableName2}, {TableID2}, {FriendlyName2}, {ColumnName}, {ColumnID} and {ColumnFriendlyName} placeholders RC_{TableName1}_{TableName2}_{ColumnName}
THUMBNAIL_DIAGRAM_DOCK 0 - No dock, 1 - Left top corner, 2 - Right top corner, 3 - Left down corner, 4 - Right down corner 4
THUMBNAIL_DIAGRAM_HEIGHT Height (points) 300
THUMBNAIL_DIAGRAM_LEFT Left (points) 0
THUMBNAIL_DIAGRAM_MARGIN Margin (points). 30
THUMBNAIL_DIAGRAM_SHOW 0 - do not show, 1 - show 1
THUMBNAIL_DIAGRAM_TOP Top (points) 0
THUMBNAIL_DIAGRAM_WIDTH Width (points) 300
TRANS_DEFAULT_USE_VAULT_RELATIONS 0 - use business relations rather than VAULT relations. 1 - use VAULT relations rather than business relations 1
TRANS_FRIENDLY_NAMES_AS_COLUMN_NAMES Use friendly names as column names in transformations: 0 - no, 1 - yes 1
TRANSFORMATIONS_CREATEVIEWS Create VIEW when saving transformation: 2-yes, 1-compile only, 0-no 0

Scripts

Scripts are a set of SQL commands that will be executed under specific conditions. There are four types of scripts:

  1. Pre-Deployment Script: This script is executed prior to DWH synchronization and before deployment.
  2. Post-Deployment Script: This script is executed after DWH synchronization and before deployment.
  3. Pre-Workflow Script: This script is executed in the workflow package before starting all other packages.
  4. Post-Workflow Script: This script is executed in the workflow package after all other packages have finished.

Deployment Script Control

The deployment script can be disabled during synchronization or deployment by using the "Do Not Deploy" and "Do Not Synchronize" flags.

Below is a typical script definition:

Pre-deployment script

Pre and Post-Deployment Scripts for Stored Procedures

Pre and Post-deployment scripts can be used to create stored procedures for use in transformations. In this case, the script should be executed only during Data Warehouse (DWH) synchronization.

Including the CREATE PROCEDURE script during deployment is unnecessary, as the procedure definition is already included in the deployment package.

Macros

A macro is a powerful tool used to simplify transformation definitions in AnalyticsCreator. Every macro has the following components:

  • Name: The name of the macro.
  • Language: The programming language used in the macro.
  • Definition Statement: The logic or functionality defined within the macro.
  • Referenced Table (optional): Used for auto-referencing in transformations.

Currently, two languages are supported: T-SQL and SSIS.

  • T-SQL Macros: Used in transformations, calculated fields, and database objects.
  • SSIS Macros: Used in SSIS statements for import constraints or field logic.

Macro Example

A typical macro definition:

Date2ID Macro

Macro Statement and Parameters

Every macro uses positional parameters like :1, :2, etc. To call a macro, prefix it with @ and supply parameters in parentheses. For example:

@Date2ID(T1.BUDAT)

This will be parsed into:

CONVERT(bigint, ISNULL(DATEDIFF(DD, '20000101', CONVERT(date, T1.BUDAT)) + 1, 0))

Macro Parameters and NULL Replacement

If fewer parameters are passed than defined, the remaining placeholders will be replaced by NULL.

@Date2ID()

Results in:

CONVERT(bigint, ISNULL(DATEDIFF(DD, '20000101', CONVERT(date, NULL)) + 1, 0))

Referenced Table Parameter

The Referenced Table parameter allows automatic creation of a reference between a field and the referenced table, based on the macro logic.

Macro Usage in Transformations

Macros are commonly used in transformation column definitions. For example:

Macro in use

This will be parsed in the transformation VIEW as:


[FK_ModifiedDate] = CASE
    WHEN T1.ModifiedDate < '19800101' THEN 0 
    WHEN T1.ModifiedDate > '20401231' THEN CONVERT(bigint, DATEDIFF(DD, '19800101',  '20401231') + 1)
    ELSE CONVERT(bigint, ISNULL(DATEDIFF(DD, '19800101', CONVERT(date, T1.ModifiedDate)) + 1, 0))

Macro Updates

If a macro definition is changed, all dependent transformations and calculated fields will be recalculated automatically to reflect the change.