ExMeX Plugin - Data Vault
The ExMeX Plugin - Data Vault is a PowerDesigner Extension for designing a Data Vault data model which helps the data modeler to easy and fast incorporate all types of Data Vault tables in a physical PowerDesigner data model (PDM) as well as provides the stereotypes for all Load Process Steps (LPS) generated by the Framework.
Main features are
- Drag & Drop Data Vault objects to your physical diagram
- Names for hub/link or sat are set via input window
- Pre- and postfix conventions automatically added.
- Surrogate Key is generated according to naming conventions with prefix or postfix
- Standard columns are created with domain or data type according to naming conventions
- PK and AK are generated according to naming conventions with prefix or postfix
- Names for references are set depending on hub/link or sat names
- FK is generated according to naming conventions with prefix or postfix
- Easily switch between Data Vault types by changing table stereotype
- For non Data Vault objects mandatory columns are created with domain or data type according to naming conventions
The names of the objects in the data model are configured in the plug-in, NOT the code for database objects (DDL for table, view, PK, FK, etc.)! The derivation of the code from the name is a setting in the corresponding physical data model (.pdm) and is not part or task of the plugin!
(Photo by Carlos Irineu da Costa on Unsplash)
How to install the plugin: PD Data Vault?
For the procedure to update the plugin please see the section below.
Download the most recent extension of TEDAMOH ExMeX Data Vault - Orig.xem (in our download section) and unzip it within your ExMeX Core root directory into: ./library/resource/extension
Copy and rename the plugin file to a suitable name in the file explorer. Proposals from us are:
- TEDAMOH ExMeX Plugin - Data Vault - With Hash-SK.xem or
- TEDAMOH ExMeX Plugin - Data Vault - With Sequence-SK.xem or
- to any other name you prefer.
You can attach the plugin to your data model by directly drag & drop the extension from your file system into your PowerDesigner data model. It is then attached with a shortcut symbol:
Extension in the PD Object Browser
To rename the plugin in your Power Designer object browser open the extension (double click) and rename it on the General Tab:
How to rename an extension
How to configure the plugin: PD Data Vault?
To configure the extension to your naming standards and rules, follow this steps for table or reference configuration.
The names of the objects in the data model are configured in the plug-in, NOT the code for database objects (DDL for table, view, PK, FK, etc.)! The derivation of the code from the name is a setting in the corresponding physical data model (.pdm) and is not part or task of the plugin!
- Double click on the Extension in your PowerDesigner object browser to open the properties.
- Then click on the plus sign of Profile on the left.
- Then click on the plus sign of Table.
- Then click on the plus sign of Event Handlers.
- Go to Initialize.
- Go to the Event Handler Script tab
In this tab you will see the configuration for naming standards and rules. You should only change the variable values inside the block that starts with:
'# DO YOUR CONFIGURATION HERE '### Important for all parameters: '# '# For each parameter with the classword ending *Name set the desired name '# of the object. '# '# The Code of the object will be transformed automatically from the Name '# with the rules you configured in your PowerDesigner settings. '### '### Parameter for Data Vault table name convention '# '# If you do not have a pre- or postfix, then use "" (empty string) '# '# For example LinkPrefixName = "" '#
You can change here every string in red letters – each string has to begin with a " and end with a ".
Configure extension properties - Save your configuration with the save button in the upper right corner of the window – you can also use Save As to not overwrite the default extension properties.
- Close the Window with OK.
- Double click on the Extension in your PowerDesigner object browser to open the properties.
- Then click on the plus sign of Profile on the left.
- Then click on the plus sign of Reference.
- Then click on the plus sign of Event Handlers.
- Go to Initialize.
- Go to the Event Handler Script tab
In this tab you will see the configuration for foreign key naming standards and rules. You should only change the variable values inside the block that starts with:
'#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++*/ '# DO YOUR CONFIGURATION HERE '### Naming rule for references '# '# A reference is always drawn and read FROM CHILD - TO PARENT '# Sat FK Name : (PrefixName)<ChildTableName>(PostfixName) '# Link FK Name: (PrefixName)<ChildTableName>(Connector)<ParentTableName>(PostfixName) '# Constraint : (PrefixConstraint)<ReferenceCode>(PostfixConstraint) '# '# Advice: Use parent/child role for hierarchical link or same-as-link '### '### Important for all parameters: '# '# For each parameter with the classword ending *Name set the desired name '# of the object. '# '# The Code of the object will be transformed automatically from the Name '# with the rules you configured in your PowerDesigner settings. '### '### Parameter for Reference name convention '# '# If you do not have a pre- or postfix or connector, then use "" (empty string) '# For example ForeignKeyPrefixName = "" ForeignKeyPrefixName = "FK " ForeignKeyPostfixName = "" ForeignKeyLinkConnectorName = " 2 " ForeignKeyPrefixConstraint = "FK" ForeignKeyPostfixConstraint = "" '# '### '#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++*/
You can change here every string in red letters – each string has to begin with a " and end with a ".
- Save your configuration with the save button in the upper right corner of the window – you can also use Save As to not overwrite the default extension properties.
- Close the Window with OK.
How to use the plugin: PD Data Vault?
In your PowerDesigner Toolbox (default on the right of the PowerDesigner window) a new section with the Tedamoh Extension will appear. You can use the new toolbox section to design your Data Vault data model by clicking on one of the icons and then click one time in the physical model diagram.
A popup with an input field will appear which asks how the table should be named.
The Pre- and Postfixe will be attached by the extension itself; you only have to enter the specific object name. For example, enter Supplier for a new Hub, then the prefix HUB_ (which was configured in the previous section) will be applied and the table will be named HUB_Supplier.
You can also change the stereotype of a Data Vault object, the extension will automatically add or delete columns which are specific for this Data Vault stereotype.
How to update an already installed plugin: PD Data Vault?
Caution: Before you merge the plugins, remember to make a backup of your configuration on Event Handler Script tab!
Download the most recent plugin of TEDAMOH ExMeX Data Vault - Orig.xem (in our download section) and unzip it within your ExMeX Core root directory into:: ./library/resource/extension
Open the plugin (aka PowerDesigner extension) which is attached to your data model (double click on the plugin) and click on the button Import Items to import any changes from TEDAMOH ExMeX Data Vault - Orig.xem:
Import Items from original extension
Select original extension
Merge original extension
We recommend to restart PowerDesigner after updating the plugin!
Always compare your current plugin configuration on Event Handler Script tab with the most recent version of TEDAMOH ExMeX Data Vault Configuration - Orig.vb (in our download section). There may be new variables added.
ExMeX Plugin - Metadata Export
How to install the plugin: Metadata Export?
Download the most recent extension of TEDAMOH ExMeX Plugin - Metadata Export (in our download section) and unzip it within your ExMeX Core root directory into: ./library/resource/extension
You can attach the plugin to your data model by directly drag & drop the extension from your file system into your PowerDesigner data model. It is then attached with a shortcut symbol:
Extension in the PD Object Browser
That's all and the plugin is ready to use.
How to enable export of Annotation and Description metadata?
Valid as of ExMeX Plugin - Metadata Export release 1.8.0
Purpose
If the metadata for the ExMeX Framework Core is generated, no additional information of the PowerDesigner attributes Annotation and Description are generated since release 1.8.0 of this plugin. Main purpose is to reduce generation time and to save space in the database. Nevertheless it is still possible to enable export of Annotation and Description metadata.
Motivation
The export of Annotation and Description metadata is used if more metadata should be stored in the metadata database. By default Annotation and Description metadata export is not enabled.
Considerations and consequences
If the export of Annotation and Description metadata is enabled, the generated metadata files are larger. This leads to longer runtimes for both the generation and the installation of the metadata.
Sample
To enable the export of Annotation and Description metadata in the ExMeX Plugin - Metadata Export, a variable ExMeX-AnnoDesc must be created in the General Options of the PowerDesigner.
Valid values are:
| Value | Description |
| false | Export of metadata for Annotation and Description is off |
| true | Export of metadata for Annotation and Description is on |
To review and edit variables, select menu Click in the row of an existing variable in order to edit its value. To create a new variable, click the Add a Row tool and specify a name and value.
