OMBCREATE DRILL_PATH

Purpose

Creates a Drill path to enable drilling to detail.

Prerequisites

Should be in the context of a Business Definition Module.

Syntax

createDrillPathCommand =  OMBCREATE DRILL_PATH "QUOTED_STRING" [ SET 
          "setPropertiesClause" ] [ SET "setReferenceIconSetClause" ] { 
          "DrillLevelClause" } { "DrillLevelLinkClause" }
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     DrillLevelClause =  ADD [ ROOT ] DRILL_LEVEL "QUOTED_STRING" [ DEFAULT_ROOT
           ] [ SET "setPropertiesClause" ] { "setDrillItemClause" } { 
          "addDrillLevelKey" }
     DrillLevelLinkClause =  ADD DRILL_LEVEL_LINK PARENT DRILL_LEVEL 
          "QUOTED_STRING" CHILD DRILL_LEVEL "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setDrillItemClause =  SET ( REF | REFERENCE ) ITEM "QUOTED_STRING" OF ( ( 
          ITEM_FOLDER "QUOTED_STRING" "itemJoinUsages" ) | ( LOGICAL_TABLE 
          "QUOTED_STRING" ) )
     addDrillLevelKey =  ADD DRILL_LEVEL_KEY "QUOTED_STRING" [ SET 
          "setPropertiesClause" ] { "setDrillItemKeyClause" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )
     itemJoinUsages =  { USING JOIN "QUOTED_STRING" OF ITEM_FOLDER 
          "QUOTED_STRING" }
     setDrillItemKeyClause =  SET ( REF | REFERENCE ) ITEM "QUOTED_STRING" OF 
          LOGICAL_TABLE "QUOTED_STRING"

Parameters

createDrillPathCommand

This command creates a drill path.

QUOTED_STRING

Specify the name of the drill path to be created.

setPropertiesClause

Used to set properties (core, logical, physical, user-defined) for drill paths. Valid properties are shown below:

getPropertiesClause

Basic properties for DRILL_PATH:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the drill path

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

Name: TIMEDIMENSION
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the drill path represents a time dimension. Oracle Business Intelligence Modules (OBIEE) only

Basic properties for DRILL_LEVEL:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the drill level

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

Name: DEFAULT_ROOT_LEVEL
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the level is a default root. Oracle Business Intelligence Modules (OBIEE) only

Name: GRAND_TOTAL_LEVEL
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the level is a grand total level. Oracle Business Intelligence Modules (OBIEE) only

Name: SUPPORTS_ROLLUP
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the level supports rollup to a higher level of aggregation. Oracle Business Intelligence Modules (OBIEE) only

Basic properties for DRILL_LEVEL_KEY (Oracle Business Intelligence (OBIEE):

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the drill level key

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

Name: PRIMARYKEY
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the level key is the primary key for the drill level. Oracle Business Intelligence Modules (OBIEE) only

Name: CHRONOLOGICALKEY
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the level key is the chronological key for a time dimension. Oracle Business Intelligence Modules (OBIEE) only

Name: USE_FOR_DRILLDOWN
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the level key is used for drill down. Oracle Business Intelligence Modules (OBIEE) only

setReferenceIconSetClause

Set specified Icon Set.

DrillLevelClause

This clause adds a drill level to a drill path.

DRILL_LEVEL

A level in a drill path.

DrillLevelLinkClause

This clause adds a link bewteen a parent and child level.

propertyNameList

This is the list of property names.

propertyValueList

This is the list of property values.

setDrillItemClause

This clause adds a reference to an item for the level.

addDrillLevelKey

This clause adds a level key to the level.

propertyValue

This is a property value.

itemJoinUsages

The specific joins to be used.

setDrillItemKeyClause

Associates an item with a drill level key.

DRILL_PATH Object

Table 7-4 DRILL_PATH 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 objects marked as Deployable = true