Configuration Editor
BimlFlex Configurations define exactly how data is intended to be processed, through which steps in the architecture, and by using what technology.
The Configuration Editor is used to manage standard Columns and how, when and where these are added to Objects. These standard columns can be configured to drive the behavior of the output that BimlFlex generates.
Configurations can be used to support requirements for file locations, naming conventions, data conventions and standard system columns.
The defaults for the configurations that are set as part of the BimlFlex installation are the Varigence recommended values. There is no need to change or configure unless there is a requirement to change specific behaviors. Align these settings with the organization's best practices and environmental requirements.
Tip
Details on all default BimlFlex configurations can be found in the Configuration Reference Documentation.
Overview
Configurations can be found under Administration in the BimlFlex Applicationmenu.
Note
Detailed descriptions of all Configuration Editor fields and options are available in the Reference Documentation.
Action Buttons
The action buttons modify the Configuration that is active in the editor.
Icon | Action | Description |
---|---|---|
Save | This will save any changes displayed in the Configurations editor. The Save button is only enabled if there are changes in the editor. | |
Discard | Discard any unsaved changes and revert to last saved form. |
Configuration Editor Overview
The Configuration Editor is used to manage all Configurations. The fields in the editor are defined in this table along with the validation rules.
Configuration Application Properties
The definition of each configuration can be seen as a Global Configuration, and will apply to specific Objects based on their configuration. The configuration properties below control where each configuration applies. Exactly how the configuration applies depends on the selected Configuration Attribute Type for each individual application property.
Field |
Description |
---|---|
Landing Attribute | Determines if the configuration is applied to objects in a Landing connection. |
Staging Attribute | Determines if the configuration is applied to objects in a Staging connection. |
Persistent Staging Attribute | Determines if the configuration is applied to objects in a Persistent Staging connection. |
Hub Attribute | Determines if the configuration is applied to objects that have the Hub object type. |
Satellite Attribute | Determines if the configuration is applied to objects that have the Satellite object type. |
Link Attribute | Determines if the configuration is applied to objects that have the Link object type. |
Dim Attribute | Determines if the configuration is applied to objects that have the Dimension object type. If any Dimension objects in the project have Type 2 columns, Dim Attribute must be set to Derived . |
Fact Attribute | Determines if the configuration is applied to objects that have the Fact object type. |
Configuration Attribute Types
Configuration Attribute Types are the allowed values to configure the attribution of a Configuration to a specific area of the data solution architecture. This is defined using the Configuration Editor and governs the location in the data logistics process for which the Configuration is applied.
Each configuration property will allow a list of values to be selected, which impacts how the configuration is applied to the in-scope objects.
Attribute Type | Code | Description |
---|---|---|
Ignore | IGN | Set the Configuration Attribute to Ignore to make sure the configuration does not apply to the assigned area. |
Derived | DER | Derive the configuration using the value specified in the appropriate Expression column. Which expression column will be used depends on the Integration Template used. |
Source | SRC | Use the value as is available from the source object. This column needs to exist in the source and have the same name as specified by the Configuration Value column for the configuration in the source object. |
Default | DEF | Apply the value specified in the Configuration Default field of the Configuration as a default value / constraint for the Objects the configuration has been defined for. Note that this only applies to SQL Server, Managed Instances and Azure SQL because these database technologies support having default constraints with expression (example: GETDATE()). |
Target | TGT | Defined by the Target. |
Hash | HSH | Apply hashing logic when loading the value. |
Configuration Overrides
Configuration Overrides are used to override how configurations values are applied for selected areas of the design. For example, to implement a configuration for all columns except for the ones in a specific project. Overrides allow highly granular control of exceptions that need to be implemented in the solution.
All overrides that apply to the selected configuration are listed in the Overrides section of the editor.
Adding a Configuration Override
To add a Configuration Override, click + Add
on the Overrides tab. This will open the Configuration Override Editor.
The Configuration Override Editor allows the override to apply at various levels of abstraction, for example at Column level, Object level, Project level or even for the entire Connection or Customer. This is specified by the Attribute Type
. Depending on the selected type different options will be shown to specify the exact item the override needs to apply for.
Note
The Configuration Override Editor will apply to the selected configuration.
The example below shows an override that applies to a specific Column, and overrides the Configuration Default
that otherwise would apply based on the global configurations.
The fields that are visible in the editor depend on the selected Attribute Type
, but the following fields will always be shown:
Field Name | Description |
---|---|
Attribute Type | Defines the scope to which the override is applied. Depending of the selection option more detailed fields will shown as relevant for the selected scope. |
Overridden Configuration | Defines the Configuration that will be overridden. |
Attribute Value | The value with which the Configuration will be replaced for the selected scope. |
Description | Allows to add a meaningful description explaining the purpose of the override. |
Depending on the selected Attribute Type, the following options will be made available for more granular control of the scope. All fields will be mandatory for the selected scope option.
Attribute Type | Options | More Information |
---|---|---|
Column | Adds Connection, Object and Column fields. | Column Editor |
Object | Adds Connection and Object fields. | Object Editor |
Project | Add the Project selector field. | Project Editor |
Connection | Add the Connection selector field. | Connection Editor |
Customer | Does not add any fields, the override will apply to all content in the active Customer. | Customer Overview |
Batch | Add the Batch selector field. | Batch Editor |
When saving the override, BimlFlex will assign a unique name for the override. This will be a combination of the Configuration Key and the property to which the override applies.
Editing or Archiving a Configuration Override
Using the Configuration Override Editor
In the Configuration Editor, the overrides that apply to the selected configuration are listed in the Overrides section.
To edit or remove the override, select the designated override and click on the Edit
button. This will open the Configuration Override Editor where editing and archiving is possible.
Compared to adding a new override there are additional options when editing an existing override. The options are as follows:
Icon | Action | Description |
---|---|---|
Save | This will persist changed made to the override. | |
Discard | Pending changes to the override will be discarded. | |
Archive | Archive will remove the override from the active metadata repository, and move it to the metadata archive. | |
Duplicate | Allows to make a copy of the selected override. A new dialog will be shown to provide a new unique name for the new override and modify its details. |
Using the Attribute Editor
Configuration Overrides are managed as Attributes in BimlFlex. The Attributes Documentation provides information on Attributes and how to manage them.
This means that all overrides that are created will also be visible in the Attribute Editor , and it is possible to edit and/or remove them here as well.
From the Configuration Override Editor it is possible to directly navigate to the corresponding Attribute by clicking on the attribute link in the overrides section. This will open the Attribute Editor and show the details of the selected override displayed as an Attribute.