Skip Headers
Oracle® Warehouse Builder OMB*Plus Command Reference
11g Release 2 (11.2)

Part Number E14406-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
Mobi · ePub

OMBRETRIEVE TIME_DIMENSION

Purpose

This command retrieve metadata from the time dimension.

Prerequisites

Should be in Oracle Module context.

Syntax

retrieveTimeDimensionCommand =  OMBRETRIEVE TIME_DIMENSION 
          "TimeDimensionName" ( GET ( PROPERTIES "propertyKeyList" | FISCAL 
          PROPERTIES "propertyKeyList" | DIMENSION_ATTRIBUTES | LEVELS | 
          HIERARCHIES | DIMENSION_ROLES | YEARS | START_YEAR | 
          IMPLEMENTATION_STRATEGY | MAPPING | IMPLEMENTED_OBJECTS ) | 
          "dimensionAttributeDetailClause" | "levelDetailClause" | 
          "hierarchyDetailClause" | "roleDetailClause" )
     TimeDimensionName =  "QUOTED_STRING"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     dimensionAttributeDetailClause =  "dimensionAttributeLocator" GET 
          PROPERTIES "propertyKeyList"
     levelDetailClause =  "levelLocator" ( GET ( PROPERTIES "propertyKeyList" | 
          LEVEL_ATTRIBUTES | IMPLEMENTED_OBJECT ) | "levelAttributeDetailClause"
           )
     hierarchyDetailClause =  "hierarchyLocator" GET ( PROPERTIES 
          "propertyKeyList" | ( REF | REFERENCE ) LEVELS )
     roleDetailClause =  "roleLocator" ( GET ( PROPERTIES "propertyKeyList" ) )
     propertyKey =  "UNQUOTED_STRING"
     dimensionAttributeLocator =  DIMENSION_ATTRIBUTE "dimensionAttributeName"
     levelLocator =  LEVEL "levelName"
     levelAttributeDetailClause =  "levelAttributeLocator" GET ( PROPERTIES 
          "propertyKeyList" | IMPLEMENTED COLUMN )
     hierarchyLocator =  HIERARCHY "hierarchyName"
     roleLocator =  ROLE "roleName"
     dimensionAttributeName =  "QUOTED_STRING"
     levelName =  "QUOTED_STRING"
     levelAttributeLocator =  LEVEL_ATTRIBUTE "levelAttributeName"
     hierarchyName =  "QUOTED_STRING"
     roleName =  "QUOTED_STRING"
     levelAttributeName =  "QUOTED_STRING"

Parameters

retrieveTimeDimensionCommand

This clause retrieves informtion about TIME_DIMENSION, PROPERTIES, FISCAL, DIMENSION_ATTRIBUTES, LEVELS, HIERARCHIES, DIMENSION_ROLES, YEARS, START_YEAR, IMPLEMENTATION_STRATEGY, MAPPING, IMPLEMENTED_OBJECTS.

TimeDimensionName

The name of the time dimension.

propertyKeyList

A list of time dimension properties.

dimensionAttributeDetailClause

This clause gets property details of dimension attribute.

levelDetailClause

This clause gets property details of a level.

hierarchyDetailClause

This clause gets property details of a hierarchy.

roleDetailClause

This clause gets property details of a role.

propertyKey

Property Key in a UNQUOTED_STRING.

propertyKey

Basic properties for TIME DIMENSION, TIME DIMENSION MAP, DIMENSION_ATTRIBUTE, LEVEL, LEVEL_ATTRIBUTE and HIERARCHY: 

Basic properties for TIME DIMENSION :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Time Dimension 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Time Dimension 

Name: STORAGE
Type: STRING
Valid Values: 'RELATIONAL', 'AW' 
Default: 'RELATIONAL' 
The storage of a dimension can be AW or relational 

Name: AW_NAME
Type: STRING(32)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Set the analytical workspace name where the dimension is implemented 

Name: AW_DIMENSION_NAME
Type: STRING(32)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Set the Analytical Workspace dimension physical object name 


Basic properties for TIME MAP :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Time Dimension Map

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Time Dimension Map

Basic properties for DIMENSION_ATTRIBUTE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Dimension_Attribute 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string

dimensionAttributeLocator

Dimension Attribute Locator.

levelLocator

This clause gets the level.

levelAttributeDetailClause

This clause gets property details of a level attribute.

hierarchyLocator

This clause gets the hierarchy.

roleLocator

This clause finds a Time Dimension role.

dimensionAttributeName

Dimension Attribute Name in QUOTED_STRING.

levelName

The level name in QUOTED_STRING.

levelAttributeLocator

This clause gets the level Attribute.

hierarchyName

The name of a hierarchy.

roleName

A role name.

levelAttributeName

The level attribute name in QUOTED_STRING.

DIMENSION Object

Table 21-11 DIMENSION Object

Property Type Choices Min Max Default Description

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true

DEPLOYMENT_OPTIONS

STRING

DEPLOY_ALL, DEPLOY_DATA_OBJECTS_ONLY, DEPLOY_TO_CATALOG_ONLY

none

none

DEPLOY_DATA_OBJECTS_ONLY

Warehouse Builder generates a set of scripts for Dimension, they are DDL Scripts for Relational Dimensional or Scripts for ROLAP or or Scripts for AW.

ENABLE_MV_REFRESH

BOOLEAN

true, false

none

none

false

Enable MV Refresh

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

MVCONSTRAINTS

STRING

, ENFORCED, TRUSTED

none

none

TRUSTED

MV Constraints

NEXTDATE

STRING

none

none

none

empty string

Refresh Next Date

REFRESH

STRING

, COMPLETE, FAST, FORCE

none

none

FORCE

Refresh Mode

REFRESH_ON

STRING

, DEMAND, ONDATE

none

none

DEMAND

Refresh On

STARTWITH

STRING

none

none

none

empty string

Refresh Start Date

VIEW_NAME

STRING(30)

none

none

none

empty string

Name of the view that is generated to hide the control rows on the dimension implementation table of a star schema. If this field is left blank, the view name will default to '<Name of Dimension>_v'

VISIBLE

BOOLEAN

true, false

none

none

true

The Dimension is visible to OLAP end user if value is set = true.


HIERARCHY Object

Table 21-12 HIERARCHY Object

Property Type Choices Min Max Default Description

HIERLOADLEVEL

STRING

none

none

none

empty string