../E14406-01.epub /> ../E14406-01.mobi />

OMBRETRIEVE CATALOG_FOLDER

Purpose

Retrieve details of a Catalog Folder.

Prerequisites

Should be in the context of an OBIEE Business Definition Module or use the full path.

Syntax

retrieveCatalogFolderCommand =  OMBRETRIEVE CATALOG_FOLDER "QUOTED_STRING" 
          "retrieveCatalogFolderClause"
     retrieveCatalogFolderClause =  GET ( "getPropertiesClause" | 
          "getReferenceIconSetClause" | "getCFSCOClause" )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getCFSCOClause =  LOGICAL_TABLES | DRILL_PATHS
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveCatalogFolderCommand

To retrieve a catalog folder.

QUOTED_STRING

name of the catalog folder.

retrieveCatalogFolderClause

Retrieves the contents of the catalog folder.

getPropertiesClause

Retrieves the properties of the object.

getPropertiesClause

Basic properties for CATALOG_FOLDER: 

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

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

getReferenceIconSetClause

Get specified Icon Set.

getCFSCOClause

Retrieves the logical table/drill path shortcuts from the catalog folder.

propertyNameList

This is the list of property names.

CATALOG_FOLDER Object

Table 17-6 CATALOG_FOLDER 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