Metadata Excel Format - Export
Bridge Requirements
This bridge:requires Internet access to https://repo.maven.apache.org/maven2/ and/or other tool sites to download drivers into <TDC_HOME>/data/download/MIMB/.
requires the tool to be installed to access its SDK.
Bridge Specifications
Vendor | Meta Integration Technology, Inc. |
Tool Name | Metadata Excel Format |
Tool Version | Excel 2003 to 2010 |
Tool Web Site | Model Bridge (MIMB) Guide |
Supported Methodology | [Metadata Management] Multi-Model, ETL (Source and Target Data Stores, Transformation Lineage, Expression Parsing, Expression Conversion) via Excel 2007 (XLSX) File |
SPECIFICATIONS
Tool: Meta Integration Technology, Inc. / Metadata Excel Format version Excel 2003 to 2010 via Excel 2007 (XLSX) File
See MIMB Known Limitations
Productivity tools, such as spreadsheet editing tools, are commonly used to capture, document or publish physical, logical and business metadata throughout the industry. A tool like Microsoft Office Excel is an especially common choice as it is nearly always available. It is understood by and familiar to business users, offers simple copy and paste compatibility with other Office applications, and conveniences such as spelling correction. Microsoft Excel import and export capabilities are provided to leverage these advantages.
1. All metadata output spreadsheets are generated in the Standard format, as this is the only format directly supported. To accommodate export to a locally defined spreadsheet layout, the format generated by the export bridge is not hard coded, but rather defined by 'Blank' spreadsheets specifying how each spreadsheet cell relates to the neutral repository metamodel. This flexibility is available only as a specific customized export bridge which may be provided through consulting services.
2. While both import (reading from spreadsheet) and export (writing to spreadsheet) capabilities are offered, they are not designed to support round-trip re-engineering. For example, one may forward engineer the mapping requirements into a DI/ETL tool for design, but the purpose of exporting from that DI/ETL tool back to Excel is to provide a mapping lineage summary independent of all internal multiple complex transformations and not to re-engineer the design and re-import.
3. Data Design and Architecture tool models may support round-trip type editing within Excel, to take advantage of the spell-checking, column and row based copy and paste, and other conveniences inherent to a spreadsheet environment. In this case, one should export to a spreadsheet, make the edits and then re-import into the original design tool, leveraging the compare and merge facilities provided with that tool.
4. New source or target data stores may be exported to an existing spreadsheet. However, no merge or update features are offered at this time. Also, when importing an Excel spreadsheet into a DI/ETL tool, the receiving tool is responsible for integrating/merging the models and mappings within its existing versions.
5. Specific assumptions and limitations are provided for each pre-defined format in the appropriate ${MODEL_BRIDGE_HOME}\conf\MIRModelBridgeTemplate\MIRMicrosoftExcel\*-Blank.xlsx file
6.Using a spreadsheet to manage metadata may have limitations in some cases. There are no actual limits for any information represented as rows in the spreadsheet. For example, there are no limits in the number of entities/tables per model, or the number of attributes/columns per entity/table. However, there are some limitations for any information represented as columns for usability reasons. For example, the nesting of packages within a model, the number of PK/FK/AK keys a given attribute/column can be involved in, or more importantly the number of custom UDP allocated to an entity/table, attribute/column, or data type.
SUPPORT
Provide a troubleshooting package with:
- the debug log (can be set in the UI or in conf/conf.properties with MIR_LOG_LEVEL=6)
- the metadata backup if available (can be set in the Miscellaneous parameter with -backup option, although this common option is not implemented on all bridges for technical reasons).
This export bridge allows one to generate metadata expressed in Microsoft Office Excel spreadsheets, which may contain anything from simple data models to complex mappings (where various Excel sheets are used to define the source data models, target data model, and the mapping between them). The generated spreadsheet will be provided in XLSX format. The 'File' parameter should contain the name of this spreadsheet, referred to as the 'metadata output spreadsheet.'
The spreadsheets generated are Office 2007 XLSX files. To read this kind of file into Office 2003 or Office XP, download and install the 'Compatibility Pack' from Microsoft.
This metadata output spreadsheet will be provided in a specific format referred to as the 'Standard' format. As an example of this format and how is populated, there is a Standard-Blank.xlsx file with a complete set of the possible worksheets and column headers with definitions describing the contents and their meaning. By default, this file is in the directory at ${MODEL_BRIDGE_HOME}\conf\MIRModelBridgeTemplate\MIRMicrosoftExcel\.
Also provided is an Excel 'Add-In' based 'ribbon' or menu to help navigate and manage spreadsheets which are designed using the standard format. These functions include:
- Inserting new worksheets in the 'Standard' format
- Show and hide functions to control which columns are displayed
- Annotation, formatting and validation of entries on a worksheet
In order to activate these options in Microsoft Office Excel, one must install the add-in provided with the software. Such add-ins are provided for Microsoft Office Excel 2007 and 2003. Instructions for installation are provided in the exported spreadsheet in the comment section for the 'how to use' cell on all worksheets of type 'Models'.
Bridge Parameters
Parameter Name | Description | Type | Values | Default | Scope | ||
File | Exports a model into an Excel spreadsheet as text. The \"File\" parameter is the file name of this spreadsheet. It must have an XLSX extension. | FILE | *.xlsx | Mandatory | |||
Include business name and description | Include the business name and business description of objects when exporting to a spreadsheet. They become the Name and the Description. 'True' Export them to the spreadsheet 'False' Do not export them to the spreadsheet |
BOOLEAN |
|
True | |||
Miscellaneous | INTRODUCTION Specify miscellaneous options starting with a dash and optionally followed by parameters, e.g. -connection.cast MyDatabase1="MICROSOFT SQL SERVER" Some options can be used multiple times if applicable, e.g. -connection.rename NewConnection1=OldConnection1 -connection.rename NewConnection2=OldConnection2; As the list of options can become a long string, it is possible to load it from a file which must be located in ${MODEL_BRIDGE_HOME}\data\MIMB\parameters and have the extension .txt. In such case, all options must be defined within that file as the only value of this parameter, e.g. ETL/Miscellaneous.txt JAVA ENVIRONMENT OPTIONS -java.memory <Java Memory's maximum size> (previously -m) 1G by default on 64bits JRE or as set in conf/conf.properties, e.g. -java.memory 8G -java.memory 8000M -java.parameters <Java Runtime Environment command line options> (previously -j) This option must be the last one in the Miscellaneous parameter as all the text after -java.parameters is passed "as is" to the JRE, e.g. -java.parameters -Dname=value -Xms1G The following option must be set when a proxy is used to access internet (this is critical to access https://repo.maven.apache.org/maven2/ and exceptionally a few other tool sites) in order to download the necessary third-party software libraries. Note: The majority of proxies are concerned with encrypting (HTTPS) the outside (of the company) traffic and trust the inside traffic that can access proxy over HTTP. In this case, an HTTPS request reaches the proxy over HTTP where the proxy HTTPS-encrypts it. -java.parameters -java.parameters -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=3128 -Dhttp.proxyUser=user -Dhttp.proxyPassword=pass |
STRING |
Bridge Mapping
Meta Integration Repository (MIR) Metamodel (based on the OMG CWM standard) |
"Metadata Excel Format" Metamodel MicrosoftExcel |
Mapping Comments |
Attribute | Attributes, SourceAttributes or TargetAttributes | |
Comment | Attribute Comment | |
Description | Attribute Description | |
InitialValue | Attribute Initial Value | |
Name | Attribute Name | |
Optional | Is Attribute Optional | Is Attribute Required |
PhysicalName | Attribute Physical name | |
Position | Attribute Position | |
Class | Classes, SourceClasses or TargetClasses | |
Comment | Class Comment | |
Description | Class Description | |
Name | Class Name | |
PhysicalName | Class Physical name | |
ClassifierMap | Computed based on feature maps | |
DataAttribute | Computed based on feature maps | |
DataSet | Computed based on Transformation | |
DatabaseSchema | Schemas, SourceSchemas or TargetSchemas | Created based on the "System Type" |
Comment | Schema Comment | |
Description | Schema Description | |
Name | Schema Name | |
PhysicalName | Schema Physical name | |
DerivedType | Create using "Data Type Inherited From" or calculated using template data. | |
Comment | Data Type Comment | |
Description | Data Type Description | |
InitialValue | Data Type Initial Value | |
Length | Data Type Length | |
LowerBound | Data Type Min Value | |
Name | Data Type Name | |
PhysicalName | Data Type Physical Name | |
Scale | Data Type Scale | |
UpperBound | Data Type Max Value | |
UserDefined | Calculated based on the datatype usage | |
DesignPackage | DataPackages, SourceDataPackages or TargetDataPackages | |
Comment | Package Comment | |
Description | Package Description | |
Name | Package Name | |
PhysicalName | Package Physical name | |
FeatureMap | FeatureMaps | Computed based on source and target attribute references. |
Description | Feature Map Description | |
Name | Feature Map Name | |
Operation | Feature Map Operation | |
FileDirectory | Schemas, SourceSchemas or TargetSchemas | Created based on the "System Type" |
Comment | Schema Comment | |
Description | Schema Description | |
Name | Schema Name | |
PhysicalName | Schema Physical name | |
PropertyType | Defined in the template | |
DataType | Defined in the template | |
InitialValue | Defined in the template | |
Name | Defined in the template | |
Name | Defined in the template | |
Value | Defined in the template | |
StoreModel | Models | |
Author | Model Creation Time | |
Comment | Model Comment | |
CreationTime | Model Creation Time | |
Description | Model Description | |
ModificationTime | Model Creation Time | |
Modifier | Model Creation Time | |
Name | Model Name | |
PhysicalName | Model Physical name | |
SystemType | System Type | |
SystemTypeOld | System Type | |
TypeValue | DataTypes, SourceDataTypes or TargetDataTypes | |
Description | Data Type Enumerated Value Description | |
Name | Data Type Enumerated Value |