02. Metadata Properties Reference

Owned by Former user (Deleted)
Last updated: Jan 18, 2010 by Former user (Deleted)Version comment
1 min read
Unknown macro: {scrollbar}

Out-of-the-Box Properties

The table below shows the properties that are provided with Pentaho Metadata Editor.

Unknown macro: {table-plus}

Id

Description

Category

Values

Name *

This property describes the display name for the business object.

General

Alphanumeric

Description *

A descriptive text entry describing the business object.

General

Alphanumeric

Comments *

Additional comments regarding the business object.

General

Alphanumeric

Security Information

Security rules for granting/restricting access to the business object.

General

Determined by security widget; see Adding Security.

Font

The font properties to apply to this business object.

Formatting

Determined by font dialog

Color of Text

The foreground or text color for the business object.

Formatting

Determined by color dialog

Text Alignment

The text alignment for the business object.

Formatting

( Left | Right | Centered | Justified )

Color of Background

The background color for the business object.

Formatting

Determined by color dialog

Relative Size

This property is normally associated with business tables and is used to calculate join paths. The sum of all table relative sizes in a path are calculated when deciding on a multi-table join, and the multi-table join with the smallest summed value is used for the join path.

Formatting

Numeric

Aggregation Rule

Determines the method of aggregating the data from this business object.

Model Descriptors

( None | Sum | Count | Distinct Count | Minimum | Maximum )

Data Type

Data type for this business object.

Model Descriptors

( Unknown | String | Date | Boolean | Numeric | Binary | Image | URL ) + Length and Precision (Integers)

Field Type

What type or relationship purpose this field serves.

Model Descriptors

( Other | Dimension | Fact | Key | Attribute )

Table Type

Table type is used to automatically determine relationship types with other tables. For instance, if a Fact table is joined with a Dimension table, this is normally an N to 1 relationship

Model Descriptors

( Other | Dimension | Fact )

Formula

This property allows you to create a calculation defining the business object. See Pentaho Metadata Formulas for more information.

Calculation

Alphanumeric

Is the Formula Exact?

Determines whether the formula should be parsed as a Metadata Formula. If false, this field is treated as a database column name .

Calculation

Boolean

Column Width

The width of the column as represented for display.

Miscellaneous

( Pixels | Percent of Page Width | Inches | Centimeters | Points ) + Integer

Hidden For the User?

This hides the object from being displayed in the Business View of the model.

Miscellaneous

Boolean

Mask for Number or Date

The format mask that should be used when the data for this object is displayed. For dates, the format follows the date/time patterns for a Java SimpleDateFormat format mask. For numbers, the pattern should follow the Java DecimalFormat format mask.

Miscellaneous

Alphanumeric

Target Schema

This property defines the database schema to use when querying the business object.

Miscellaneous

Alphanumeric

Target Table

This property defines the physical database table from which the business object is defined.

Miscellaneous

Alphanumeric

* Localized properties.

Custom Properties

You can define any number of custom properties. You must give your property an id and set its type.

The available types are:

  • String
  • Date
  • Numeric Value
  • Color
  • Font
  • Type of Field
  • Type of Aggregation
  • Boolean
  • Field Data Type
  • Localized String
  • Type of Table
  • URL
  • Security
  • Text Alignment
  • Column Width

Required Properties per Business Object


The table below shows required properties for given business objects. Required properties cannot be deleted.

Unknown macro: {table-plus}

Id

PhysicalTable

PhysicalColumn

BusinessCategory

BusinessModel

Name

Description

Security Information

 

 

Table Type

 

 

 

Relative Size

 

 

 

Formula

 

 

 

Field Type

 

 

 

Data Type

 

 

 

Aggregation rule

 

 

 

Is the Formula Exact?

 

 

 

Hidden for the User?

 

 

 

Font

 

 

 

 

Mask for Number or Date

 

 

 

 

Color of Text

 

 

 

 

Color of Background

 

 

 

 
0%

TODO