Each Stage table column has a set of associated properties. The definition of each property is defined below:
If the Column name or Data type is changed for a column, then the metadata will differ from the table as recorded in the database.
Use the Validate > Validate Table Create Status menu option to compare the metadata to the table in the database.
A context menu option Alter Table is available when you right-click the table name after the validation has been completed. This option alters the database table to match the metadata definition.
If a database table's definition is changed in the metadata, then the table needs to be altered in the database. Use the Validate > Validate Table Create Status menu to compare metadata definitions to physical database tables. The option also provides the ability to alter the database table, through a pop-up menu option from the validated table name.
A sample Properties screen is as follows:
The two special update keys enable you to update the column and step either forward or backward to the next column's properties. ALT-Left Arrow and ALT-Right Arrow can also be used instead of the two special update keys.
General
| Options | Description |
|---|---|
| Table Name | Database-compliant name of the table that contains the column. [Read-only]. |
| Column Name | Database-compliant name of the column. Typically column-naming standards exclude the use of spaces etc. A good practice is to only use alphanumerics and the underscore character. Changing this field alters the table's definition. The case conversion button on the right converts the text between different cases: UPPER CASE, Capitalized Case, and lower case. The mode cycles to the next case in the sequence of each conversion. |
| Business Display Name | Name that the business uses refers to the column, which is included in the RED-generated documentation and can be used in the end user layer of other tools. [Does NOT affect the physical database table]. As such it is a free-form entry and any characters are valid. The case conversion button on the right converts the text between different cases: UPPER CASE, Capitalized Case, and lower case. The mode cycles to the next case in the sequence of each conversion. |
| Column Description | This field contains the description for the column. It may be a description from a business user's point of view. This field might additionally contain information on where and how the column was acquired. For example, if the column is sourced from multiple tables or is a composite or derived column then this definition would normally describe the process used to populate the column. This field is used in the documentation and is available via the view ws_admin_v_dim_col . This field is also stored as a comment against the column in the database. |
Physical Definition
| Options | Description |
|---|---|
| Column Order | Numeric value that controls the relative order of columns in the database create statement. The lowest-numbered column will appear first in the table. Although this affects the physical table definition no action will be taken unless the table is re-created in the database. The columns can be re-numbered based on the existing order by choosing the Respace Order Number pop-up menu option when positioned over any column in the table. This action will number the columns in increments of 10 starting at 10. In addition to a simple change of the order field, the column order can be changed by first displaying the columns in the middle pane and then using drag and drop to move the columns around. This drag-and-drop process will automatically renumber the columns as required. |
| Data Type | Database-compliant data type that must be valid for the target database. For SQL Server, common types are integer, numeric, varchar() and datetime. See the database documentation for a description of the data types available. Changing this field alters the table's definition. |
| Null Values Allowed | Determines whether the table column can hold NULL values or whether a value is always mandatory. |
| Default Value | Initial value that is assigned to the column when a row is inserted into the table but no value is specified for the column. |
| Format | Optional format mask that can be used in end user tools. [Does NOT affect the physical database table]. As such it is a free form entry and any characters are valid. Typically format masks are only used on numeric fields. Example: #,###0.00. It is not worth the effort of populating this field unless it can be utilized by the end user tools in use. |
Meta Definition
| Options | Description | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Numeric | Indicates whether the table column holds numeric values. This is normally only relevant for Fact tables. It does not affect the physical table definition but rather provides input to the view ws_admin_v_dim_col which can be used to assist in the population of an end user tool's end user layer. The use of this field is not relevant unless it can be utilized by the end-user tools. | ||||||||||||||||||||||||||||||||
| Additive | Indicates whether the table column holds values that are additive. This implies that the column can be summed when performing data grouping in a query. This is normally only relevant for fact tables. It does not affect the physical table definition, but rather provides input to the view ws_admin_v_dim_col which can be used to assist in the population of an end user tool's end user layer. The use of this field is not relevant unless it can be utilized by the end user tools. | ||||||||||||||||||||||||||||||||
| Attribute | Indicates whether the table column holds values that are descriptive, and/or are used for grouping/summing. An attribute is defined as a non-factual column. For example, we may have an order number, or a invoice number stored in the Fact table. These columns are considered attributes, rather than facts. This check-box is therefore normally only relevant for fact tables. This check-box does not affect the physical table definition but rather provides input to the view ws_admin_v_dim_col which can be used to assist in the population of an end user tools end user layer. The use of this field is not relevant unless it can be utilized by the end-user tools. | ||||||||||||||||||||||||||||||||
| Business Key | Indicates whether the column is part of the BUSINESS key, which is defined during the update procedure build. [Normally maintained automatically]. Multiple columns can form the primary business key. | ||||||||||||||||||||||||||||||||
| Key Type | Key type that is assigned and used when generating the table's update procedure and indexes. [Normally maintained automatically]. It can be altered here, but this should only be done if the consequences are fully understood and tested. The supported values are:
| ||||||||||||||||||||||||||||||||
| Hash Key Sources | This field is only displayed for Hash key types. Displays the hash source columns that are used to generate the selected Hub, Link, or Change hash key. | ||||||||||||||||||||||||||||||||
| Hash Key Source For | This field is only displayed for Hash key types. Displays the hash key columns that use the displayed hash key sources. | ||||||||||||||||||||||||||||||||
| Multi-Active Key Type | The value is only 'Natural' or 'Sequence' based on the Multi-Active key type. | ||||||||||||||||||||||||||||||||
| Multi-Active Key Source(s) | Lists the key column for Multi-Active Natural Key or the sort columns for Multi-Active Sequence Key. |
Source Details
| Options | Description |
|---|---|
| Source Table | Identifies the source table where the column's data comes from. This source table is normally a Load table or a Dimension table within the data warehouse. If the column was sourced from multiple tables, then the normal practice is to record one of the tables in this field and a comment listing all of the other tables in the Source strategy field. This field is used when generating a procedure to update the Stage table. It is also used in the trackback diagrams and the documentation. |
| Source Column | Identifies the source column where the column's data comes from. Such a column is normally a load table column, which in turn may have been a transformation or the combination of multiple columns. This may also be a dimensional key where a dimension is being joined. |
| Source Data Type | Identifies the source column's data type. [Read-only]. |
| Transformation | Refer to Stage Table Column Transformations for details. [Read-only]. |
| Join | Indicates whether the table column is used in a table join. [Normally maintained automatically but can be optionally changed to override the default join logic used in the generated update procedure]. The Source table and Source column fields will provide the Dimension table's side of the join. The options for this field are False, True, Manual, and Pre-Join. Setting this field to Manual, changes the way the Dimension table is looked up during the Stage table update procedure build. It enables you to join the dimension manually in the Source Join wizard (used to build the 'Where' clause). The usual dialog for matching the dimension business key to a column or columns in the Stage table is not displayed, if this option is enabled. Setting this field to Pre Join activates the Pre Join Source Table field and enables you to select a table from the drop-down list. |
| Pre Join Source Table | Indicates the table from which the pre-joined column was sourced. When the Join option is set to False, this field becomes inactive. When the Join option is set to True or Manual, this field is set to the current table name. When the Join option is set to Pre Join, then you can select the required table from the drop-down list. |