This section provides you with information and instructions to help you use the Pentaho Metadata Editor, a tool that allows you to build metadata models and domains. There is also an exercise included that walks you through creating a metadata model using a small sample database.
There is sample data available if you want to test Metadata Editor before importing your own data. This sample data is inside of the Pentaho download. This process will be covered later in this section.
Audience: To use the Pentaho Metadata Editor, you must have database administrator (DBA) skills, such as knowing how to import tables, create relationships between tables, assign aggregations, add categories, and assign security as well as an extensive knowledge of your databases. You must also know what type of data interests your business users, in order to determine whether a column should be a measure or a dimension, for example. These skills will allow you to map a business user model (logical model) to a complex relational database, which can then lets your users create Pentaho reports without a DBA's assistance.
A Conceptual Overview of the Pentaho Metadata Editor
A Pentaho Metadata Model maps the physical structure of your database into a logical business model.
Get Started with the Pentaho Metadata Editor
Follow the instructions to see the example metadata model that is deployed with the Pentaho Server.
The Pentaho Metadata Editor and the Pentaho Server must be running before you can begin.
- In the main window of the Metadata Editor, go to File > Import from XMI File.
- Navigate to your installation of the Pentaho Server (for example, C:\Program Files\pentaho\server\pentaho-server\pentaho-solutions\, if you used the installer). There can be several root pentaho-solution folders and each of them may contain one metadata model repository.
- Open the steel-wheels folder and click [MyBusinessModel].xmi where [myBusinessModel] is any name you have given the model. The .xmi is the repository for Pentaho-related metadata and business views.
- Type Sample Data in the Save Model dialog box.
If you see the message, "This model already exists...," click Yes to continue.
This step processes the file and displays the structure of the repository (connections and business models) on the navigation pane on the left.
- Log into the User Console, and click New Report.
Notice that the business models (Human Resources, Inventory, and Orders) are displayed.
Create a Domain
A metadata domain is a Pentaho term that represents all of the business objects created, stored and used in the metadata layer. A domain may consist of one or more connections, one or more models, security information, business tables, business views, categories, columns and concepts. You can create and save multiple metadata domains using the Metadata Editor.
Apply Metadata Properties and Concepts
The Pentaho metadata paradigm uses the term concept to mean a collection of metadata properties that can be applied to a given business object (business table or column, for example).
Import and Export Domains
When you save a domain, the domain is stored in a metadata repository. The Pentaho Server does not use the metadata repository, instead it accesses an XML file exported from the Pentaho Metadata Editor. Exporting your domain is a good way to ensure safe backups of your domains.
Import a Domain
In the Pentaho Metadata Editor, go to File > Import From XMI File.Note: You may be prompted to save the currently active model if you have any unsaved changes pending. When you import a new domain, that domain becomes the active domain in the Pentaho Metadata Editor.
- In the file browser, navigate to your domain file, select it, and click OK.
- In the Save Model dialog box, type a name for the domain.
Important: If you enter the name of an existing domain, that domain is overwritten by the import.
Export a Domain
- In the Metadata Editor, go to File > Export to XMI File.
Note: You may be prompted to save the currently active model if you have any unsaved changes pending.
- Type a file name and select a location to save your file.
Important: The default extension for a Metadata domain XML file is .xmi.
- Click Save. Once you have entered a name for your export file, the domain is exported to that file. You can inspect the export file using a text editor if you are curious about the underlying XML code.
The following topics help to extend your knowledge of Metadata Editor beyond basic setup and use:
- Metadata Security
To restrict access to certain portions of a metadata model that you are using as a data source, you can edit the model with Metadata Editor and add restrictions.
- Add Security to Metadata Business Objects
Set security information properties to communicate with the Pentaho Server to retrieve a list of users, roles and access control lists (ACLs).
- Add Row Level Security to a Pentaho Metadata Model
Use row level security to control the results that are returned in a query-based on a user's security level.
- Manage International Locales
Add multiple locale entries for any text or string-based metadata property.
- Domain Backup and Recovery
Revert to the last known state of your domain using backup and recovery.
- Metadata Properties Reference
Review lists of out-of-the-box properties, custom properties, and required properties per business object.
- Pentaho Metadata Formulas
Use formulas to define, constrain, and secure metadata.
See our list of common problems and resolutions.