8 XML Physical Elements

This chapter provides Oracle BI Server XML API reference information for physical elements. Physical elements typically correspond to objects in the Physical layer of the Oracle BI repository, or in other words, the objects that appear in the right-hand pane of the Oracle BI Administration Tool.

This chapter contains the following topics:

8.1 XML Elements: Database

The database element corresponds to the database object in the Physical layer.

The database tag includes the following attributes:

Table 8-1 Database Tag Attributes

Attribute Name Description

type

The type of data source, such as XMLDirect or ODBC20.

dbFlag

Stores the value of the following options:

  • CRM metadata tables: For legacy Siebel Systems sources only. When selected, the Administration Tool import utility looks for the table definition in Oracle's Siebel CRM-specific tables.

  • Virtual Private Database: Identifies the physical database source as a virtual private database (VPD). When a VPD is used, returned data results are contingent on the user's authorization credentials. This option is used with the Security Sensitive option for session variables.

  • Allow populate queries by default: When selected, allows all users to execute POPULATE SQL. If you want most, but not all, users to be able to execute POPULATE SQL, select this option and then limit queries for specific users or groups.

  • Allow direct database requests by default: When selected, allows all users to execute physical queries. The Oracle BI Server will send unprocessed, user-entered, physical SQL directly to an underlying database. If you want most, but not all, users to be able to execute physical queries, select this option and then limit queries for specific users or groups.

The database tag includes the following child elements:

Table 8-2 Database Child Elements

Element Name Description

Features

Lists the SQL features for this database. Each feature is contained in a sub-element called Feature. This sub-element has two attributes:

  • name indicates the name of the feature, such as LEFT_OUTER_JOIN_SUPPORTED.

  • value indicates whether this feature is supported by the database, or provides the actual value of the feature (such as "0" for MAX_COLUMNS_IN_SELECT).

PersistConnPool

References the connection pool that is used as the persist connection pool, if one has been assigned. A persist connection pool is a database property that is used for specific types of queries (typically used to support Marketing queries).

The persist connection pool is contained in a sub-element called RefConnectionPool.

DisplayFolders

References any physical display folders that contain objects in this database. Physical display folders can be used to organize tables in a database. For example, all alias tables can be stored in a display folder called Alias, in addition to being present in the database.

Each display folder is contained in a sub-element called RefPhysicalDisplayFolder.

ConnectionPools

References the connection pools for this database object.

Each connection pool is contained in a sub-element called RefConnectionPool.

Properties

Custom database properties for Oracle ADF Business Component data sources that are passed to the Administration Tool from Oracle ADF BI view objects.

Syntax

<Database …
     type=""
     dbFlag="">
   <Description />
   <Features>
     <Feature name="" value=""/>
     <Feature name="" value=""/>
     ...
   </Features>
   <PersistConnPool>
     <RefConnectionPool …/>
   </PersistConnPool>
   <DisplayFolders>
     <RefPhysicalDisplayFolder …/>
     <RefPhysicalDisplayFolder …/>
   </DisplayFolders>
   <ConnectionPools>
     <RefConnectionPool …/>
   </ConnectionPools>
   <Properties>
     <PropertyGroup>
       category=""
       <Property>
          <Name …/>
          <Value …/>
       </Property>
     </Property Group>
   </Properties>
</Database>

Example

<Database name="Paint" id="3023:205" uid="80ca62be-0bcf-0000-714b-e31d00000000"
     type="XMLDirect">
   <Features>
     <Feature name="LEFT_OUTER_JOIN_SUPPORTED" value="false" /> 
     <Feature name="RIGHT_OUTER_JOIN_SUPPORTED" value="false" /> 
     <Feature name="FULL_OUTER_JOIN_SUPPORTED" value="false" /> 
     <Feature name="NESTED_OUTER_JOIN_SUPPORTED" value="false" /> 
     <Feature name="UNION_SUPPORTED" value="false" /> 
     <Feature name="UNION_ALL_SUPPORTED" value="false" /> 
     <Feature name="COUNT_SUPPORTED" value="false" /> 
     <Feature name="COUNT_DISTINCT_SUPPORTED" value="false" /> 
...
     <Feature name="SORT_ORDER_LOCALE" value="english-usa" /> 
     <Feature name="COMMENT_START" /> 
     <Feature name="COMMENT_END" /> 
   </Features>
</Database>

8.2 XML Elements: Physical Catalog

The physical catalog element corresponds to the physical catalog object in the Physical layer.

The physical catalog tag includes the following child elements:

Table 8-3 Physical Catalog Child Elements

Element Name Description

DynamicName

If a session variable is being used to specify the name of this physical catalog, this element references that session variable.

The session variable is contained in a sub-element called RefVariable.

The physical catalog element does not include any attributes.

Syntax

<PhysicalCatalog …>
   <Description />
   <DynamicName>
     <RefVariable …/>
   </DynamicName>
</PhysicalCatalog>

Example

<PhysicalCatalog name="Catalog" 
     parentName="&quot;01 - Sample App Data (ORCL)&quot;"
     parentId="3023:85" parentUid="80ca62c4-0bcf-0000-714b-e31d00000000"
     id="3025:42377" uid="80cb6802-0bd1-0000-714b-e31d00000000">
</PhysicalCatalog>

8.3 XML Elements: Physical Schema

The physical schema element corresponds to the physical schema object in the Physical layer.

The physical schema tag includes the following child elements:

Table 8-4 Physical Schema Child Elements

Element Name Description

DynamicName

If a session variable is being used to specify the name of this physical schema, this element references that session variable.

The session variable is contained in a sub-element called RefVariable.

InputMessageTemplate

This child element is reserved for a future release.

The physical schema element does not include any attributes.

Syntax

<Schema …>
   <Description />
   <DynamicName>
     <RefVariable …/>
   </DynamicName>
</Schema>

Example

<Schema name="BISAMPLE"
     parentName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog&quot;"
     parentId="3025:42377" parentUid="80cb6802-0bd1-0000-714b-e31d00000000"
     id="3027:42378" uid="80cb6803-0bd3-0000-714b-e31d00000000">
</Schema>

8.4 XML Elements: Physical Display Folder

The physical display folder element corresponds to the physical display folder object in the Physical layer.

The physical display folder tag includes the following child elements:

Table 8-5 Physical Display Folder Child Elements

Element Name Description

Tables

References the physical tables that belong to this physical display folder.

Each physical table is contained in a sub-element called RefPhysicalTable.

The physical display folder element does not include any attributes.

Syntax

<PhysicalDisplayFolder …>
   <Description />
   <Tables>
     <RefPhysicalTable …/>
   </Tables>
</PhysicalDisplayFolder>

Example

<PhysicalDisplayFolder name="Assets" 
     parentName="&quot;Sample Data&quot;"
     parentId="3023:85" parentUid="80ca62c4-0bcf-0000-714b-e31d00000000"
     id="3037:44085" uid="96c2c481-0c00-1000-835d-0a9702490000">
   <Tables>
     <RefPhysicalTable id="3001:129"
      uid="80ca6538-0bb9-0000-714b-e31d00000000" 
      qualifiedName="&quot;Sample Data&quot;...&quot;D20 Offices&quot;"/>
   </Tables>
</PhysicalDisplayFolder>

8.5 XML Elements: Physical Table

The physical table element corresponds to the physical table object in the Physical layer.

The physical table tag includes the following attributes:

Table 8-6 Physical Table Tag Attributes

Attribute Name Description

type

The type of physical table. Options are as follows:

  • select indicates that this physical table object is a SELECT statement.

  • sp indicates that this physical table is a stored procedure.

  • alias indicates that this physical table is an alias table. An alias table (alias) is a physical table that references a different physical table as its source.

  • none indicates that this physical table is a regular physical table.

isCacheable

If set to true, indicates that this table is included in the Oracle BI Server query cache.

CacheExpiry

How long table entries should persist in the query cache. A value of 0 indicates that cache entries do not expire.

isCacheEventTable

If set to true, indicates that this table has been registered as an Oracle BI Server event polling table.

isOverrideCacheProp

For alias tables only. If set to true, indicates that the alias table has its own cache properties that override the cache properties of the source table.

pollFreq

The polling frequency, in seconds. Only applies if this table is an Oracle BI Server event polling table. The default value is 3600 seconds.

x

The x coordinate of the table when it is shown in the physical diagram.

y

The y coordinate of the table when it is shown in the physical diagram.

rowCount

The latest number of rows retrieved for this physical table.

lastUpdated

The time at which row counts were last updated for this physical table.

uri

For XML data sources only. The resource identifier for the XML data source.

xslPath

For XML data sources only. An XSLT file contains formatting rules written according to the XSLT standard. It defines how an XML file may be transformed.

maxConn

For XML data sources only. The maximum number of connections allowed to the same URL from different users.

xmlRefreshInterval

For XML data sources only. The time interval after which the XML data source is queried again directly, rather than using results in cache.

scriptPath

For XML data sources only. The extended gateway script path.

hints

For Oracle Databases only. Lists any database hints, such as index hints or leading hints, that were specified for this physical table.

isExtGatewayInProcess

For XML data sources only. Indicates that this physical table is the extended gateway part of the process.

extGatewayDelimiter

For XML data sources only. The row delimiter used in the metadata import process, typically the second level element in the XML document.

isSysGen

If set to true, indicates that an internal utility has generated this physical table.

isDDLAggr

Indicates whether this physical table is an aggregate table.

isDeployedView

For relational databases only. If set to true, indicates that this physical table is a deployed (opaque) view. An opaque view is a Physical layer table that consists of a SELECT statement.

The physical table tag includes the following child elements:

Table 8-7 Physical Table Child Elements

Element Name Description

SourceTable

For alias tables only. References the physical table that is being used as the source for this alias table.

The physical table is contained in a sub-element called RefPhysicalTable.

DBMap

Stores the value of database-specific strings. The <DBMap> element contains an <Item> tag, which in turn contains a <Value> tag, as follows:

<Item name="">
   <Value />
</Item>

AggrConnPool

If this physical table is an aggregate table, this element references the connection pool used for the aggregate.

The connection pool is contained in a sub-element called RefConnectionPool.

RefVariable

If a session variable is being used to specify the name of this physical table, this element references that session variable.

MemberKey

Applies to parent-child relationship tables that support parent-child hierarchies on relational sources. The name of the column that uniquely identifies members of the parent-child relationship table.

The member key is contained in a sub-element called RefPhysicalColumn.

ParentKey

The name of the column that contains the key of the parent or ancestor member. Applies to parent-child relationship tables that support parent-child hierarchies on relational sources.

The parent key is contained in a sub-element called RefPhysicalColumn.

DistanceColumn

The name of the column that records the number of levels between the member and the ancestor. Applies to parent-child relationship tables that support parent-child hierarchies on relational sources.

The distance column is contained in a sub-element called RefPhysicalColumn.

LeafColumn

The name of the column that indicates whether the member has no child members (1 if the member is a leaf and has no children, 0 if the member is not a leaf and has children). Applies to parent-child relationship tables that support parent-child hierarchies on relational sources.

The leaf column is contained in a sub-element called RefPhysicalColumn.

XSLT

For Oracle web service data sources. XSLT stores the XSLT transformation to flatten the web service response into a tabular result set.

XSDSchema

For Oracle web service data sources. XSDSchema stores the XML schema describing the structure of the web service response.

Properties

Contains one or more Property sub-elements, each of which has attributes <name> and <value>. These attributes specify a name-value pair of properties for data source metadata. Used for ADF sources, to store information related to the ADF application, such as information on flex Vos, override data types, join definitions, and data filters.

Syntax

<PhysicalTable …
     type=""
     isCacheable=""
     cacheExpiry=""
     isCacheEventTable=""
     isOverrideCacheProp=""
     pollFreq=""
     x=""
     y=""
     rowCount=""
     lastUpdated=""
     uri=""
     xslPath=""
     maxConn=""
     xmlRefreshInterval=""
     scriptPath=""
     hints=""
     isExtGatewayInProcess=""
     extGatewayDelimiter=""
     isSysGen=""
     isDDLAggr=""
     isDeployedView="">
   <Description />
   <SourceTable>
     <RefPhysicalTable …/>
   </SourceTable>
   <DBMap>
     <Item name="">
       <Value …/>
     </Item>
   </DBMap>
   <AggrConnPool>
     <RefConnectionPool …/>
   </AggrConnPool>
   <RefVariable …/>
   <MemberKey>
     <RefPhysicalColumn …/>
   </MemberKey>
   <ParentKey>
     <RefPhysicalColumn …/>
   </ParentKey>
   <DistanceColumn>
     <RefPhysicalColumn …/>
   </DistanceColumn>
   <LeafColumn>
     <RefPhysicalColumn …/>
   </LeafColumn>
   <XSLT />
   <XSDSchema />
   <Properties>
     <Property name="" value=""/>
     <Property name="" value=""/>
   </Properties>
</PhysicalTable>

Example

<PhysicalTable name="SAMP_LOOKUPS_D"
     parentName="&quot;01 - Sample App Data (ORCL)&quot;
      .&quot;Catalog&quot;.&quot;BISAMPLE&quot;"
     parentId="3027:42378" parentUid="80cb6803-0bd3-0000-714b-e31d00000000"
     id="3001:42390" uid="80cb680f-0bb9-0000-714b-e31d00000000" 
     type="none"
     isCacheable="false"
     x="270" y="1551"
     rowCount="0.0"
     uri="VALUEOF(BI_EE_HOME)/sample/SampleAppFiles/Data/SAMP_LOOKUPS_D.xml"
     maxConn="0">
   <Description>
     <![CDATA[ Lookups dimension table : Stores lookup information for various
      dimension attributes in different languages]]> 
   </Description>
   <XSLT /> 
   <XSDSchema /> 
</PhysicalTable>

8.6 XML Elements: Physical Column

The physical column element corresponds to the physical column object in the Physical layer.

The physical column tag includes the following attributes:

Table 8-8 Physical Column Tag Attributes

Attribute Name Description

extName

  • The external name for the physical column. This attribute is required if the same name (such as STATE) is used in multiple hierarchies.

  • This attribute is optional for XML documents. For XML, the extName attribute stores the fully qualified name of a column.

dataType

The data type of the physical column, such as VARCHAR. This option is called Type in the Physical Column dialog in the Administration Tool.

nullable

If set to true, indicates that null values are allowed for the column. This allows null values to be returned to the user, which is expected with certain functions and with outer joins.

precision

The precision of the data type of the column.

scale

The scale of the data type of the column.

rowCount

The latest number of rows retrieved for this physical column.

lastUpdated

The time at which row counts were last updated for this physical column.

valueType

Applies to Siebel OM data sources only. Indicates the cardinality of the value of the column. Valid values include:

  • One to One (Default/Unknown/Single-valued)

  • Many to One (Picklist)

  • One to Many (Multi-valued)

  • Many to Many (Multi-valued)

mappedColumn

Applies to Siebel OM data sources only. The name of the mapped column. Corresponds to the field of the same name for the multi-valued group (MVG) business component.

MVLinkName

Applies to Siebel OM data sources only. The name of the link used in the Siebel business component.

specialType

Valid values are LUD or None. LUD stands for "Last Update Date."

This attribute is currently used only for ADF data sources. It is used to indicate that the column should be checked when performing ETL operations.

The physical column tag includes the following child elements:

Table 8-9 Physical Column Child Elements

Element Name Description

DynamicName

If a session variable is being used to specify the name of this physical column, this element references that session variable.

The session variable is contained in a sub-element called RefVariable.

SourceColumn

For physical columns in an alias table only. References the physical column that is being used as the source for this column.

The physical column is contained in a sub-element called RefPhysicalColumn.

PicklistColumns

A list of physical columns to which the picklist is mapped.

Each physical column is contained in a sub-element called RefPhysicalColumn.

Properties

Contains one or more Property sub-elements, each of which has attributes <name> and <value>. These attributes specify a name-value pair of properties for data source metadata.

Syntax

<PhysicalColumn …
     extName=""
     dataType=""
     length=""
     nullable=""
     precision=""
     scale=""
     rowCount=""
     lastUpdated=""
     valueType=""
     mappedColumn=""
     MVLinkName=""
     specialType="">
   <Description />
   <DynamicName>
     <RefVariable …/>
   </DynamicName>
   <SourceColumn>
     <RefPhysicalColumn …/>
   </SourceColumn>
   <PicklistColumns>
     <RefPhysicalColumn …/>
   </PicklistColumns>
   <Properties>
     <Property name="" value=""/>
     <Property name="" value=""/>
   </Properties>
</PhysicalColumn>

Example

<PhysicalColumn name="Prod_Dsc"
     parentName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog&quot;
     .&quot;BISAMPLE&quot;.&quot;SAMP_PRODUCTS_D&quot;"
     parentId="3001:42392" parentUid="80cb6811-0bb9-0000-714b-e31d00000000"
     id="3003:42538" uid="80cb68a3-0bbb-0000-714b-e31d00000000"
     dataType="VARCHAR"
     precision="25"
     rowCount="0.0"
     specialType="none">
   <Description>
     <![CDATA[Product Description: Stores the product description information 
      as text]]>
   </Description>
</PhysicalColumn>

8.7 XML Elements: Connection Pool

The connection pool element corresponds to the connection pool object in the Physical layer.

The connection pool tag includes the following attributes:

Table 8-10 Connection Pool Tag Attributes

Attribute Name Description

bulkInsertBufferSize

Used for limiting the number of bytes each time data is inserted in a database table. The value is given in kilobytes (KB).

transactionBoundary

Controls the batch size for an insert in a database table.

unicodeDB

This attribute is typically set to true when working with columns of an explicit Unicode data type, such as NCHAR, in an Unicode database.

tempTablePrefix

The first two characters in a temporary table name. The default value is TT.

tempTableOwner

Table owner name used to qualify a temporary table name in a SQL statement, for example to create the table owner.tablename.

tempTableDatabase

Database where the temporary table will be created. This property applies only to IBM OS/390, because IBM OS/390 requires the database name qualifier to be part of the CREATE TABLE statement.

tempTableSpace

Tablespace where the temporary table will be created. This property applies only to IBM OS/390, because IBM OS/390 requires the tablespace name qualifier to be part of the CREATE TABLE statement.

user

The user name for the data source.

password

The password for the data source. Note that passwords are encrypted.

timeout

The amount of time that a connection to the data source will remain open after a request completes. During this time, new requests use this connection rather than open a new one (up to the number specified for the maximum connections). The time is reset after each completed connection request.

If you set the timeout to 0 (the default), connection pooling is disabled. In other words, each connection to the data source terminates immediately when the request completes. Any new connections either use another connection pool or open a new connection.

maxConnDiff

The maximum number of total connections allowed to this connection pool across all users.

dataSource

The data source name that is configured to access the database to which you want to connect. The data source name must contain valid logon information for the data source.

reqQualifedTableName

If set to true, indicates that this database requires fully qualified table names. The fully qualified names are based on the physical object names in the repository.

isSharedLogin

If set to true, all users whose queries use the connection pool will access the underlying database using the same user name and password.

isConcurrentQueriesInConnection

An option that enables a single database connection to remain open for the specified time for use by future query requests. If you do not select this option, each query sent to the database opens a new connection.

In the Administration Tool, this option corresponds to a value of "selected" for Enable connection pooling in the General tab of the Connection Pool dialog.

isCloseAfterEveryRequest

If set to true, indicates that the connection pool gets closed after every query.

In the Administration Tool, this option corresponds to a value of "not selected" for Enable connection pooling in the General tab of the Connection Pool dialog.

isAsyncExecution

An option that indicates that the data source supports asynchronous queries.

executeOnCmd

A command that is to be executed by the Oracle BI Server each time a connection is made to the database. The command may be any command accepted by the database.

xslPath

For XML data sources only. An XSLT file contains formatting rules written according to the XSLT standard. It defines how an XML file may be transformed. Specifying the XSLT file in the connection pool applies it to all the XML physical tables in the connection pool. Used when outputType is set to XML.

maxConn

The maximum number of total connections allowed to this connection pool for a given user.

xmlRefreshInterval

For XML data sources only. The time interval after which the XML data source is queried again directly, rather than using results in cache.

scriptPath

The connection method Search script. This option is used for XML Server data sources.

outputType

For XML data sources only. The query output format (delimited, xml, or fixed).

In the Administration Tool, this option is called Query output format in the XML tab of the Connection Pool dialog.

If this option is not set, the query output format is assumed to be a custom format, and the value for convertScriptPath is used.

gwDelim

The delimiting characters for the query output format. Used when outputType is set to delimited.

xpath

An XPath expression is a simple XSLT transformation rule that fits into one line. Used when outputType is set to xml.

convertScriptPath

Used when outputType is not set. The path to the .exe file to be used to convert the query output to a custom output format (such as HTML).

ignoreFirstLine

If set to true, indicates that the first line of the output file is ignored.

xmlHeaderPath

The path to the header file, if any, used as a query input supplement. Used for XML Server data sources.

trailerPath

The path to the trailer file, if any, used as a query input supplement. Used for XML Server data sources.

supportParams

Indicates whether the data source supports parameters. If set to false, and the database features table supports parameters, special code executes that enables the Oracle BI Server to push filters (or calculations) with parameters to the database.

isolationLevel

For ODBC and DB2 gateways. Sets the transaction isolation level on each connection to the back-end database. The isolation level setting controls the default transaction locking behavior for all statements issued by a connection. Options are as follows:

  • default uses the default transaction locking behavior of the data source.

  • readCommitted specifies that shared locks are held while the data is read to avoid dirty reads.

  • readUncommitted implements dirty read (isolation level 0 locking). When this option is set, it is possible to read uncommitted or dirty data, change values in the data, and have rows appear or disappear in the data set before the end of the transaction.

  • repeatableRead places locks on all data that is used in a query, preventing other users from updating the data.

  • serializable places a range lock on the data set, preventing other users from updating or inserting rows into the data set until the transaction is complete.

xmlaInfo

The vendor-specific information used to connect to the multidimensional data source.

xmlaCatalog

The list of catalogs available. The cube tables correspond to the catalog you use in the connection pool.

xmlaUseSession

If set to true, causes queries go through a common session.

multiThreaded

If set to true, indicates that the connection pool supports multi-threading, or in other words, that one connection pool can support multiple queries. If this option is set to false, each query is tied to a single database connection.

type

The call interface type.

appServerName

The name of the ADF application server.

appServerPort

The port number of the ADF application server.

appID

The ADF application ID.

appEJBBean

The name of the ADF application Enterprise Java Bean.

javaHostServiceName

The name of the JavaHost service. The JavaHost is used as a connector between the Oracle BI Server and data sources that use Java, such as ADF.

isSiebelJDBSecuredisaw

For Siebel OM data sources only. Indicates whether the connection between the Oracle BI Server and the Siebel data source is encrypted.

csfKey

This attribute is not currently used.

isAW

This attribute is not currently used.

useCert

This attribute stands for "Use Certificate." It is used for ADF data sources and indicates whether to use a certificate when securing the connection.

wsServer

Specifies the Oracle database web service host name.

wsWSDL

Specifies the WSDL URL to describe the Oracle database web service.

The connection pool tag includes the following child elements:

Table 8-11 Connection Pool Child Elements

Element Name Description

AfterQueryString

Contains a connection script that is executed after the query is run.

BeforeQueryString

Contains a connection script that is executed before the query is run.

PostConnectString

Contains SQL queries executed after the connection is closed.

PreDisconnectString

Contains SQL queries executed before the connection is established.

RelationalConnPool

This child element is not used.

RelationalDataFolder

This child element is not used.

SQLBypassDB

For Oracle ADF data sources only. References the SQL Bypass database, if one has been specified.

The SQL Bypass feature directly queries the database so that aggregations and other transformations are pushed down where possible, reducing the amount of data streamed and worked on in Oracle Business Intelligence.

The database object is contained in a sub-element called RefDatabase.

Syntax

<ConnectionPool …
     bulkInsertBufferSize=""
     transactionBoundary=""
     unicodeDB=""
     tempTablePrefix=""
     tempTableOwner=""
     tempTableDatabase=""
     tempTableSpace=""
     user=""
     password=""
     timeout=""
     maxConnDiff=""
     dataSource=""
     reqQualifedTableName=""
     isSharedLogin=""
     isConcurrentQueriesInConnection=""
     isCloseAfterEveryRequest=""
     isAsyncExecution=""
     executeOnCmd=""
     xslPath=""
     maxConn=""
     xmlRefreshInterval=""
     scriptPath=""
     outputType=""
     gwDelim=""
     xpath=""
     convertScriptPath=""
     ignoreFirstLine=""
     xmlHeaderPath=""
     trailerPath=""
     supportParams=""
     isolationLevel=""
     xmlaInfo=""
     xmlaCatalog=""
     xmlaUseSession=""
     multiThreaded=""
     type=""
     appServerName=""
     appServerPort=""
     appID=""
     appEJBBean=""
     javaHostServiceName=""
     isSiebelJDBSecured=""
     useCert="">
   <Description /> 
   <AfterQueryString flag="">
     <Value …/>
   </AfterQueryString>
   <BeforeQueryString flag="">
     <Value …/>
   </BeforeQueryString>
   <PostConnectString flag="">
     <Value …/>
   </PostConnectString>
   <PreDisconnectString flag="">
     <Value …/>
   </PreDisconnectString>
   <SQLBypassDB>
     <RefDatabase …/>
   </SQLBypassDB>
</ConnectionPool>

Example

<ConnectionPool name="SampleApp XML Connection"
     parentName="&quot;02 - Sample App Xml Data&quot;"
     parentId="3023:760" parentUid="80ca62c4-0bcf-0000-714b-e31d00000000"
     id="3029:762" uid="80ca62c5-0bd5-0000-714b-e31d00000000"
     password="D7EDED84BC624A917F5B462A4DCA05CDCE256EEEEEDC97D5AC4D07C3A079829F"
     timeout="300"
     maxConnDiff="10"
     maxConn="10"
     dataSource="VALUEOF(BI_EE_HOME)/sample/sample_app/xml_data"
     type="Default"
     reqQualifedTableName="false"
     isSharedLogin="false"
     isConcurrentQueriesInConnection="false"
     isCloseAfterEveryRequest="true"
     xmlRefreshInterval="4294967295"
     outputType="xml"
     bulkInsertBufferSize="0"
     transactionBoundary="0"
     xmlaUseSession="false"
     multiThreaded="false"
     supportParams="false"
     isSiebelJDBSecured="false">
</ConnectionPool>

8.8 XML Elements: Physical Key

The physical key element corresponds to the physical key object in the Physical layer.

The physical key tag includes the following child elements:

Table 8-12 Physical Key Child Elements

Element Name Description

Columns

References the column that defines this physical key.

The column is contained in a sub-element, either RefPhysicalColumn or RefCubeColumn.

The physical key element does not include any attributes.

Syntax

<PhysicalKey …>
   <Description />
   <Columns>
     <RefPhysicalColumn …/>
     <RefCubeColumn …/>
   </Columns>
</PhysicalKey>

Example

<PhysicalKey name="09 Segment_Key" 
     parentName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog&quot;
      .&quot;BISAMPLE&quot;.&quot;D61 Customer Segments&quot;" 
     parentId="3001:42429" parentUid="80cb6836-0bb9-0000-714b-e31d00000000"
     id="3008:43143" uid="80cb6b00-0bc0-0000-714b-e31d00000000">
   <Columns>
      <RefPhysicalColumn id="3003:42857"
       uid="80cb69e2-0bbb-0000-714b-e31d00000000" 
       qualifiedName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog&quot;
        .&quot;BISAMPLE&quot;.&quot;D61 Customer Segments&quot;
        .&quot;Segment_Key&quot;"/>
   </Columns>
</PhysicalKey>

8.9 XML Elements: Physical Foreign Key

The physical foreign key element corresponds to the physical foreign key object in the Physical layer.

The physical foreign key tag includes the following attributes:

Table 8-13 Physical Foreign Key Tag Attributes

Attribute Name Description

hints

For Oracle Databases only. Lists any database hints, such as index hints or leading hints, that were specified for this physical foreign key.

The physical foreign key tag includes the following child elements:

Table 8-14 Physical Foreign Key Child Elements

Element Name Description

Columns

References the physical columns in the table that the foreign key references.

Each physical column is contained in a sub-element called either RefPhysicalColumn or RefCubeColumn.

CounterPartKey

References the corresponding primary key.

Each primary key is contained in a sub-element called RefPhysicalKey.

Syntax

<PhysicalForeignKey …
     hints="">
   <Description />
   <Columns>
     <RefPhysicalColumn …/>
     <RefCubeColumn …/>
   </Columns>
   <CounterPartKey>
     <RefPhysicalKey …/>
   </CounterPartKey>
</PhysicalForeignKey>

Example

<PhysicalForeignKey name="ORDER_ID" 
     parentName="&quot;08 - Fusion Order Demo (OLTP)&quot;..&quot;FOD&quot;
      .&quot;ORDER_ITEMS&quot;"
     parentId="3001:60530" parentUid="80cbb70c-0bb9-0000-714b-e31d00000000"
     id="3006:60849" uid="80cbb908-0bbe-0000-714b-e31d00000000">
   <Columns>
     <RefPhysicalColumn id="3003:60537"
      uid="80cbb80c-0bbb-0000-714b-e31d00000000" 
      qualifiedName="&quot;08 - Fusion Order Demo (OLTP)&quot;..&quot;FOD&quot;
       .&quot;ORDER_ITEMS&quot;.&quot;ORDER_ID&quot;"/>
   </Columns>
   <CounterPartKey>
     <RefPhysicalKey id="3008:62858"
      uid="80cbc41c-0bc0-0000-714b-e31d00000000
      qualifiedName="&quot;08 - Fusion Order Demo (OLTP)&quot;..&quot;FOD&quot;
       .&quot;ORDERS (Attributes)&quot;.&quot;ORDERS (Attributes)_Key&quot;"/>
   </CounterPartKey>
</PhysicalForeignKey>

8.10 XML Elements: Complex Join

The complex join element corresponds to the complex join object in the Physical layer.

The complex join tag includes the following attributes:

Table 8-15 Complex Join Tag Attributes

Attribute Name Description

hints

For Oracle Databases only. Lists any database hints, such as index hints or leading hints, that were specified for this complex join.

cardinality

Indicates the cardinality of the join. Valid values are: ONE TO ONE, ZERO OR ONE TO ONE, ONE TO ZERO OR ONE, ZERO OR ONE TO ZERO OR ONE, ONE TO MANY, ZERO OR ONE TO MANY, ZERO OR ONE TO MANY, MANY TO ONE, MANY TO ZERO OR ONE, or MANY TO MANY.

extName

The external name for the join.

The complex join tag includes the following child elements:

Table 8-16 Complex Join Child Elements

Element Name Description

Tables

References the physical tables in the join. Each physical table is contained in a sub-element called RefPhysicalTable, RefCubeTable, RefAWCube, or RefAWDimension.

Expr

Contains the expression that defines the relationship between the two tables.

ExternalExpr

Contains the external expression used for ADF Business Component data sources.

Syntax

<ComplexJoin …
     hints=""
     cardinality=""
     extName="">
   <Description />
   <Tables>
     <RefPhysicalTable …/>
     <RefPhysicalTable …/>
   </Tables>
   <Expr> … </Expr>
   <ExternalExpr> … </ExternalExpr>
</ComplexJoin>

Example

<ComplexJoin name="D04 Time Rolling Mth_F90 Facts Rolling Time Mth"
     id="3012:43263" uid="80cb6b78-0bc4-0000-714b-e31d00000000">
   <Tables>
     <RefPhysicalTable id="3001:42446"
      uid="80cb6847-0bb9-0000-714b-e31d00000000"
      qualifiedName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog&quot;
       .&quot;BISAMPLE&quot;.&quot;F90 Facts Rolling Time Mth&quot;"/>
     <RefPhysicalTable id="3001:42407"
      uid="80cb6820-0bb9-0000-714b-e31d00000000" 
      qualifiedName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog&quot;
       .&quot;BISAMPLE&quot;.&quot;D04 Time Rolling Mth&quot;"/>
   </Tables>
   <Expr>
     <![CDATA["01 - Sample App Data (ORCL)"."Catalog"."BISAMPLE"."D04 Time Rolling
       Mth"."Mth_Key" >= "01 - Sample App Data (ORCL)"."Catalog"."BISAMPLE".
      "F90 Facts Rolling Time Mth"."Mth_Key"]]>
   </Expr>
</ComplexJoin>

8.11 XML Elements: Cube Table

The cube table element corresponds to the physical cube table object in the Physical layer.

The cube table tag includes the following attributes:

Table 8-17 Cube Table Tag Attributes

Attribute Name Description

extName

The external name for the data source.

type

The type of physical cube table. Options are as follows:

  • select indicates that this physical table object is a SELECT statement.

  • sp indicates that this physical cube table is a stored procedure.

  • alias indicates that this physical cube table is an alias table to a logical table source.

  • none indicates that this physical cube table is a regular physical cube table.

isCacheable

If set to true, indicates that this table is included in the Oracle BI Server query cache.

CacheExpiry

How long table entries should persist in the query cache. A value of 0 indicates that cache entries do not expire.

isCacheEventTable

If set to true, indicates that this table has been registered as an Oracle BI Server event polling table.

pollFreq

The polling frequency, in seconds. Only applies if this table is an Oracle BI Server event polling table. The default value is 3600 seconds.

x

The x coordinate of the table when it is shown in the physical diagram.

y

The y coordinate of the table when it is shown in the physical diagram.

rowCount

The latest number of rows retrieved for this physical cube table.

lastUpdated

The time at which row counts were last updated for this physical cube table.

scriptPath

For XML data sources only. The extended gateway script path.

isSysGen

If set to true, indicates that an internal utility has generated this physical cube table.

isOverrideCacheProp

For alias tables only. If set to true, indicates that the alias table has its own cache properties that override the cache properties of the source table.

hints

This attribute is not used.

isDDLAggr

Indicates whether this cube table is an aggregate table.

memberReference

For Essbase data sources only. Indicates the cube property (for example, Member Name).

An Essbase cube can have multiple aliases, and the value of memberReference is one of the alias names. The query engine will generate a query against the alias set for memberReference.

dateFormat

For Essbase only. Defines the format of date member, for example, 'yyyy-MM-dd.' The value is automatically set during import.

isMemberAliasUnique

This is used for query performance. If you know that all the member names in your data source are unique, you can set it to true by selecting the option Use unqualified member name for better performance.

The cube table tag includes the following child elements:

Table 8-18 Cube Table Child Elements

Element Name Description

Aliases

For Essbase data sources only. For any alias tables for this Essbase cube, lists the alias to use (such as default, LongNames, French, and so on).

AliasTableVar

For Essbase data sources only. Each AliasTableVar represents an Essbase alias table. The AliasTableVar child element contains a sub-element called RefVariable.

DBMap

This child element is not used.

CubeVars

For SAP/BW data sources only. Cube variables are used as a means of parameterizing queries.

Each cube variable is contained in a sub-element called CubeVar. This sub-element has the following attributes:

  • name: Name of the cube variable.

  • caption: A description (label or caption) associated with the cube variable, mainly used for display purposes.

  • type: The type of cube variable (SAP_VAR_TYPE_MEMBER, SAP_VAR_TYPE_HIERARCHY, or SAP_VAR_TYPE_NUMERIC).

  • selectionType: The selection type of the cube variable, for cube variables of type SAP_VAR_TYPE_MEMBER (SAP_VAR_SEL_TYPE_VALUE, SAP_SEL_TYPE_INTERVAL, or SAP_VAR_SEL_TYPE_COMPLEX).

  • entryType: Indicates whether replacing variables is optional or mandatory. Values include SAP_VAR_INPUT_TYPE_OPTIONAL, SAP_VAR_INPUT_TYPE_MANDATORY, or SAP_VAR_INPUT_TYPE_MANDATORY_NOT_INITIAL.

  • refDimension: The reference dimension. This column contains a DIMENSION_UNIQUE_NAME for the parameter type SAP_VAR_TYPE_HIERARCHY.

  • refHierarchy: The reference hierarchy. This column contains a HIERARCHY_UNIQUE_NAME for the variable type SAP_VAR_TYPE_MEMBER.

  • defaultLow: Contains a default value for the variable, or is zero.

  • defaultHigh: Contains a default value for the variable, or is zero. This property is only important for variables with the selection type SAP_VAR_SEL_TYPE_INTERVAL and SAP_VAR_SEL_TYPE_SELECTION.

  • overrideLow: The default value for the cube variable (used if defaultLow is zero).

  • overrideHigh: The default value for the cube variable (used if defaultHigh is zero).

CalcScripts

This child element is not used.

AnonymousCalcBlock

This child element is not used.

Syntax

<CubeTable …
     extName=""
     type=""
     isCacheable=""
     cacheExpiry=""
     isCacheEventTable=""
     pollFreq=""
     x=""
     y=""
     rowCount=""
     lastUpdated=""
     scriptPath=""
     isSysGen=""
     isOverrideCacheProp=""
     isDDLAggr=""
     memberReference=""
     dateFormat=""
     isMemberAliasUnique="">
   <Description />
   <Aliases>
   </Aliases>
   <AliasTableVar>
     <RefVariable …/>
     <RefVariable …/>
   </AliasTableVar>
   <CubeVars>
     <CubeVar …/>
     <CubeVar …/>
   </CubeVars>
</CubeTable>

Example

<CubeTable name="Budget" parentName="&quot;FoodMart&quot;..&quot;&quot;"
     parentId="3025:55574" parentUid="80cb9c54-0bd1-0000-714b-e31d00000000"
     id="3039:55589" uid="80cb9c63-0bdf-0000-714b-e31d00000000"
     type="none" extName="Budget"
     isCacheable="false" x="170" y="50"
     memberReference="Default"
     dateFormat="MM-DD-YYYY" isMemberAliasUnique="true">
</CubeTable>

8.12 XML Elements: Physical Dimension

The physical dimension element corresponds to the physical dimension object in the Physical layer.

The physical dimension tag includes the following attributes:

Table 8-19 Physical Dimension Tag Attributes

Attribute Name Description

defaultMember

The default member for this physical dimension.

The physical dimension tag includes the following child elements:

Table 8-20 Physical Dimension Child Elements

Element Name Description

Hierarchies

References the hierarchies that belong to this physical dimension.Each hierarchy is contained in a sub-element called RefPhysicalHierarchy.

UserAttributes

References the dimension properties for this physical dimension.

Each dimension property is contained in a sub-element called RefCubeColumn.

AlternateHierarchyNames

For Essbase physical dimension objects, lists the names of any alternate hierarchies that belong to this dimension.

Each hierarchy name is listed in a sub-element called Name.

Syntax

<PhysicalDimension …
     defaultMember="">
   <Description />
   <Hierarchies>
     <RefPhysicalHierarchy …/>
   </Hierarchies>
   <UserAttributes>
     <RefCubeColumn …/>
   </UserAttributes>
   <AlternateHierarchyNames>
     <Name …/>
   </AlternateHierarchyNames>
</PhysicalDimension>

Example

<PhysicalDimension name="Months" 
     parentName="&quot;03 - Essbase Sample E1&quot;.&quot;BISAMPLE
      &quot;..&quot;Sample&quot;"
     parentId="3039:55589" parentUid="80cb9c63-0bdf-0000-714b-e31d00000000"
     id="3064:55587" uid="80cb9c61-0bf8-0000-714b-e31d00000000">
   <Hierarchies>
     <RefPhysicalHierarchy id="3041:55581"
      uid="80cb9c5b-0be1-0000-714b-e31d00000000"
      qualifiedName="&quot;03 - Essbase Sample E1&quot;.&quot;BISAMPLE
       &quot;..&quot;Sample&quot;.&quot;Months&quot;"/>
   </Hierarchies>
   <UserAttributes>
     <RefCubeColumn id="3043:55696"
      uid="80cb9cce-0be3-0000-714b-e31d00000000" 
      qualifiedName="&quot;03 - Essbase Sample E1&quot;.&quot;BISAMPLE
       &quot;..&quot;Sample&quot;.&quot;Months Leaf Indicator&quot;"/>
     <RefCubeColumn id="3043:55697"
      uid="80cb9ccf-0be3-0000-714b-e31d00000000"
      qualifiedName="&quot;03 - Essbase Sample E1&quot;.&quot;BISAMPLE
       &quot;..&quot;Sample&quot;.&quot;Months Root Indicator&quot;"/>
   </UserAttributes>
   <AlternateHierarchyNames>
     <Name>
       <![CDATA[Calendar]]>
     </Name>
     <Name>
       <![CDATA[Fiscal]]>
     </Name>
   </AlternateHierarchyNames>
</PhysicalDimension>

8.13 XML Elements: Physical Hierarchy

The physical hierarchy element corresponds to the physical hierarchy object in the Physical layer.

The physical hierarchy tag includes the following attributes:

Table 8-21 Physical Hierarchy Tag Attributes

Attribute Name Description

memberType

Values are Unknown, Regular, All, Formula, Measure. Default value is Unknown.

extName

The external name for the physical hierarchy.

type

The type of physical hierarchy. Options include FULLY BALANCED, UNBALANCED, RAGGED BALANCED, and NETWORK.

This option corresponds to the Hierarchy Type option in the Physical Hierarchy dialog in the Administration Tool.

dimType

The dimension type (for example, Measure Dimension) for the dimension to which this hierarchy belongs.

rowCount

The latest number of rows retrieved for this physical hierarchy.

isTimeDim

If set to true, indicates that this physical dimension is a time dimension.

dimUniqueName

The name of the dimension to which this hierarchy belongs.

isMemberAliasUnique

Indicates whether member names (including aliases) are unique in a given hierarchy so that the Oracle BI Server can take advantage of specific MDX syntax to optimize performance.

This option corresponds to the Use unqualified member name for better performance option in the Physical Hierarchy dialog in the Administration Tool.

The physical hierarchy tag includes the following child elements:

Table 8-22 Physical Hierarchy Child Elements

Element Name Description

Columns

For parent-child (value) hierarchies. References the set of cube columns that belong to this physical hierarchy.

Each cube column is contained in a sub-element called RefCubeColumn.

MemberKey

For parent-child (value) hierarchies. References the cube column that is the member key for this hierarchy.

The member key column is contained in a sub-element called RefCubeColumn.

ParentKey

For parent-child (value) hierarchies. References the cube column that is the parent key for this hierarchy.

The parent key column is contained in a sub-element called RefCubeColumn.

Levels

For level-based hierarchies. References the set of physical levels that belong to this physical hierarchy.

Each level is contained in a sub-element called RefPhysicalLevel.

Syntax

<PhysicalHierarchy …
     memberType=""
     extName=""
     type=""
     dimType=""
     rowCount=""
     isTimeDim=""
     dimUniqueName=""
     isMemberAliasUnique="">
   <Description />
   <Columns>
     <RefCubeColumn …/>
   </Columns>
   <MemberKey>
     <RefCubeColumn …/>
   </MemberKey>
   <ParentKey>
     <RefCubeColumn …/>
   </ParentKey>
   <Levels>
     <RefPhysicalLevel …/>
   </Levels>
</PhysicalHierarchy>

Example

<PhysicalHierarchy name="Employees" 
     parentName="&quot;04 - Essbase Sample E2 (Default Import)&quot;
      .&quot;BISAMPLE&quot;..&quot;Sample&quot;"
     parentId="3039:73265" parentUid="80cbf73c-0bdf-0000-714b-e31d00000000"
     id="3041:73255" uid="80cbf732-0be1-0000-714b-e31d00000000"
     memberType="all"
     extName="Employees"
     type="VALUE" dimType="Other" dimUniqueName="Employees"
     isMemberAliasUnique="true">
   <Columns>
     <RefCubeColumn id="3043:73365"
      uid="80cbf7a0-0be3-0000-714b-e31d00000000"
      qualifiedName="&quot;04 - Essbase Sample E2 (Default Import)&quot;.&quot;
       BISAMPLE&quot;..&quot;Sample&quot;.&quot;Employee Name&quot;"/>
     <RefCubeColumn id="3043:73367" 
      uid="80cbf7a2-0be3-0000-714b-e31d00000000"
      qualifiedName="&quot;04 - Essbase Sample E2 (Default Import)&quot;.&quot;
       BISAMPLE&quot;..&quot;Sample&quot;.&quot;Employee Name - Memnor&quot;"/>
... 
   </Columns>
   <MemberKey>
     <RefCubeColumn id="3043:73365" 
      uid="80cbf7a0-0be3-0000-714b-e31d00000000" 
      qualifiedName="&quot;04 - Essbase Sample E2 (Default Import)&quot;.&quot;
       BISAMPLE&quot;..&quot;Sample&quot;.&quot;Employee Name&quot;"/>
   </MemberKey>
   <ParentKey>
     <RefCubeColumn id="3043:74681" 
      uid="80cbfaa4-0be3-0000-714b-e31d00000000" 
      qualifiedName="&quot;04 - Essbase Sample E2 (Default Import)&quot;.&quot;
       BISAMPLE&quot;..&quot;Sample&quot;.&quot;Employees Parent Key&quot;"/>
   </ParentKey>
   <Levels>
     <RefPhysicalLevel id="3045:73449"
      uid="80cbf7f4-0be5-0000-714b-e31d00000000" 
      qualifiedName="&quot;04 - Essbase Sample E2 (Default Import)&quot;.&quot;
       BISAMPLE&quot;..&quot;Sample&quot;.&quot;Employees&quot;.&quot;
       All Employees&quot;"/>
     <RefPhysicalLevel id="3045:73450"
      uid="80cbf7f5-0be5-0000-714b-e31d00000000" 
      qualifiedName="&quot;04 - Essbase Sample E2 (Default Import)&quot;.&quot;
       BISAMPLE&quot;..&quot;Sample&quot;.&quot;Employees&quot;.&quot;
       Employee L1&quot;"/>
...
   </Levels>
</PhysicalHierarchy>

8.14 XML Elements: Physical Level

The physical level element corresponds to the hierarchical levels for a physical cube table object in the Physical layer.

The physical level tag includes the following attributes:

Table 8-23 Physical Level Tag Attributes

Attribute Name Description

levelNum

Identifies the order of this physical level in the hierarchy.

extName

Fully qualified name for the level.

rowCount

The latest number of rows retrieved for this physical level.

The physical level tag includes the following child elements:

Table 8-24 Physical Level Child Elements

Element Name Description

LevelKey

References the key column for this physical level.

The key column is contained in a sub-element called RefCubeColumn.

Syntax

<PhysicalLevel …
     levelNumber=""
     extName=""
     rowCount="">
   <Description />
   <LevelKey>
     <RefCubeColumn …/>
   </LevelKey>
</PhysicalLevel>

Example

<PhysicalLevel name="Brands" 
     parentName="&quot;03 - Essbase Sample E1&quot;.&quot;BISAMPLE
      &quot;..&quot;Sample&quot;.&quot;Products&quot;"
     parentId="3041:55576" parentUid="80cb9c56-0be1-0000-714b-e31d00000000"
     id="3045:55742" uid="80cb9cfc-0be5-0000-714b-e31d00000000"
     levelNum="1" extName="Brands">
   <LevelKey>
     <RefCubeColumn id="3043:55604" 
      uid="80cb9c72-0be3-0000-714b-e31d00000000"
      qualifiedName="&quot;03 - Essbase Sample E1&quot;.&quot;BISAMPLE
       &quot;..&quot;Sample&quot;.&quot;Brands&quot;"/>
   </LevelKey>
</PhysicalLevel>

8.15 XML Elements: Cube Column

The cube column element corresponds to the cube column of a physical cube object in the Physical layer.

The cube column tag includes the following attributes:

Table 8-25 Cube Column Tag Attributes

Attribute Name Description

extName

  • The external name for the cube column. This attribute is required if the same name (such as STATE) is used in multiple hierarchies.

aggrType

The type of aggregation on the column, if any.

dataType

The data type of the cube column, such as VARCHAR.

nullable

If set to true, indicates that null values are allowed for the column. This allows null values to be returned to the user, which is expected with certain functions and with outer joins.

precision

The precision of the data type of the cube column.

scale

The scale of the data type of the column.

rowCount

The latest number of rows retrieved for this cube column.

lastUpdated

The time at which row counts were last updated for this cube column.

dimPropType

For Essbase dimensional columns only. Indicates the property type of the cube column. Valid values are:

  • uda: User Defined Attribute (UDA) type.

  • memnor: Memnor type, used for outline sorts in the logical layer. Imported at the lowest level of each dimension. Called Outline Sort in the Administration Tool.

  • attribute: Attribute type, for attribute dimensions.

  • other: The type is different than those listed, or unknown.

  • none: The column does not have a property type. Note that this type is mapped to Member Alias in the Administration Tool.

  • ancestorRef: References the ancestor of a dimension.

  • memberKey: The column is a member key.

  • levelNumber: The column is the lowest member of the hierarchy. Called Leaf in the Administration Tool.

  • genNumber: The column is the root member of the hierarchy. Called Root in the Administration Tool.

  • parentRef: References the parent of a dimension.

The cube column tag includes the following child elements:

Table 8-26 Cube Column Child Elements

Element Name Description

AttributeHierarchy

References the physical hierarchy to which this cube column belongs.

The hierarchy is contained in a sub-element called RefPhysicalHierarchy.

PhysicalLevel

References the physical level to which this cube column belongs.

The level is contained in a sub-element called RefPhysicalLevel.

Syntax

<CubeColumn …
     extName=""
     aggrType=""
     dataType=""
     nullable=""
     precision=""
     scale=""
     rowCount=""
     lastUpdated=""
     dimPropType="">
   <Description />
   <AttributeHierarchy>
     <RefPhysicalHierarchy …/>
   </AttributeHierarchy>
   <PhysicalLevel>
     <RefPhysicalLevel …/>
   </PhysicalLevel>
</CubeColumn>

Example

<CubeColumn name="Month Names" 
     parentName="&quot;03 - Essbase Sample E1&quot;.&quot;BISAMPLE&quot;
      ..&quot;Sample&quot;"
     parentId="3039:55589" parentUid="80cb9c63-0bdf-0000-714b-e31d00000000"
     id="3043:55660" uid="80cb9caa-0be3-0000-714b-e31d00000000" 
     extName="Month Names" dataType="VARCHAR" precision="128" 
     nullable="true" dimPropType="none">
   <PhysicalLevel>     <RefPhysicalLevel id="3045:55757" 
      uid="80cb9d0b-0be5-0000-714b-e31d00000000"
      qualifiedName="&quot;03 - Essbase Sample E1&quot;.&quot;BISAMPLE&quot;
       ..&quot;Sample&quot;.&quot;Month of Year&quot;.&quot;Month Names&quot;"/>
   </PhysicalLevel>
</CubeColumn>

8.16 XML Elements: Analytic Workspace

The Analytic Workspace element corresponds to the Oracle OLAP Analytic Workspace (AW) object in the Physical layer.

The Analytic Workspace tag includes the following attributes:

Table 8-27 Analytic Workspace Tag Attributes

Attribute Name Description

version

The version of the Analytic Workspace.

The Analytic Workspace tag includes the following child elements:

Table 8-28 Analytic Workspace Child Elements

Element Name Description

DynamicName

If a session variable is being used to specify the name of this Analytic Workspace, this element references that session variable.

The session variable is contained in a sub-element called RefVariable.

Syntax

<AnalyticWorkspace …
     version="">
   <Description />
   <DynamicName>
     <RefVariable …/>
   </DynamicName>
</AnalyticWorkspace>

Example

<AnalyticWorkspace name="GLOBAL"
     parentName="&quot;Demo AW&quot;.&quot;GLOBAL&quot;"
     parentId="3025:8" parentUid="000000ad-0bd1-0000-714b-e31d00000000"
     id="3049:9" uid="000000ae-0be9-0000-714b-e31d00000000"
     version="10">
</AnalyticWorkspace>

8.17 XML Elements: AW Cube

The AW cube element corresponds to the Oracle OLAP cube object in the Physical layer.

The AW cube tag includes the following attributes:

Table 8-29 AW Cube Tag Attributes

Attribute Name Description

extName

The physical name that is used when referencing the cube in physical SQL queries.

isCacheable

If set to true, indicates that this table is included in the Oracle BI Server query cache.

CacheExpiry

How long table entries should persist in the query cache. A value of 0 indicates that cache entries do not expire.

isCacheEventTable

If set to true, indicates that this table has been registered as an Oracle BI Server event polling table.

pollFreq

The polling frequency, in seconds. Only applies if this table is an Oracle BI Server event polling table. The default value is 3600 seconds.

x

The x coordinate of the table when it is shown in the physical diagram.

y

The y coordinate of the table when it is shown in the physical diagram.

rowCount

The latest number of rows retrieved for this Oracle OLAP cube.

lastUpdated

The time at which row counts were last updated for this Oracle OLAP cube.

hints

For Oracle Databases only. Lists any database hints, such as index hints or leading hints, that were specified for this physical table.

isExtGatewayInProcess

For XML data sources only. Indicates that this physical table is the extended gateway part of the process.

isOverrideCacheProperties

For alias tables only. If set to true, indicates that the alias table has its own cache properties that override the cache properties of the source table.

isDDLAggr

Indicates whether this Oracle OLAP cube is an aggregate table.

isPartitioned

If set to true, indicates that the cube is partitioned by one or more dimensions.

isSysGen

If set to true, indicates that an internal utility has generated this Oracle OLAP cube.

densityStatus

For Oracle OLAP 10g cubes only. Indicates whether the cube is dense or sparse. If neither dense nor sparse is specified, the Oracle BI Server assumes the data is sparse.

Valid values are dense, sparse, and unknown.

materializationStatus

For Oracle OLAP 10g cubes only. Indicates whether the cube is fully materialized.

Valid values are fully, not fully, and unknown.

The AW cube tag includes the following child elements:

Table 8-30 AW Cube Child Elements

Element Name Description

Columns

References the Oracle OLAP columns that belong to this Oracle OLAP cube.

Each Oracle OLAP column is contained in a sub-element called RefAWColumn.

AggrConnPool

If this Oracle OLAP cube is an aggregate table, this element references the connection pool used for the aggregate.

The connection pool is contained in a sub-element called RefConnectionPool.

CompositeInfo

References dimensions for the cube.

Contains the sub-element called Composite, which has one attribute called name and a sub-element called Dimension. Each dimension is contained in the Dimension sub-element.

Syntax

<AWCube …
     extName=""
     isCacheable=""
     cacheExpiry=""
     isCacheEventTable=""
     pollFreq=""
     x=""
     y=""
     rowCount=""
     lastUpdated=""
     hints=""
     isExtGatewayInProcess=""
     isOverrideCacheProp=""
     isDDLAggr=""
     isSysGen=""
     isPartitioned=""
     densityStatus""
     materializationStatus="">
   <Description />
   <Columns>
     <RefAWColumn …/>
   </Columns>
   <AggrConnPool>
     <RefConnectionPool …/>
   </AggrConnPool>
   <CompositeInfo>
      <Composite name="">
        <Dimension …/>
     </Composite>
   </CompositeInfo>
</AWCube>

Example

<AWCube name="Units Cube" 
     parentName="&quot;Demo AW&quot;.&quot;GLOBAL&quot;.&quot;GLOBAL&quot;"
     parentId="3049:9" parentUid="000000ae-0be9-0000-714b-e31d00000000"
     id="3054:10" uid="000000af-0bee-0000-714b-e31d00000000"
     extName="Units Cube">
   <Columns>
     <RefAWColumn id="3060:11"
      uid="000000b5-0bf4-0000-714b-e31d00000000" 
      qualifiedName="&quot;Demo AW&quot;.&quot;GLOBAL&quot;
       .&quot;GLOBAL&quot;.&quot;Units Cube&quot;.&quot;Units&quot;"/>
     <RefAWColumn id="3060:12"
      uid="000000b6-0bf4-0000-714b-e31d00000000"
      qualifiedName="&quot;Demo AW&quot;.&quot;GLOBAL&quot;
       .&quot;GLOBAL&quot;.&quot;Units Cube&quot;.&quot;Sales&quot;"/>
...
   <Columns>
   <CompositeInfo>
     <Composite name="UNITS_CUBE_COMPOSITE">
      <Dimension><![CDATA[CUSTOMER]]></Dimension>
      <Dimension><![CDATA[PRODUCT]]></Dimension>
      <Dimension><![CDATA[CHANNEL]]></Dimension>
     </Composite>
   </CompositeInfo>
</AWCube>

8.18 XML Elements: AW Dimension

The AW dimension element corresponds to the Oracle OLAP dimension object in the Physical layer.

The AW dimension tag includes the following attributes:

Table 8-31 AW Dimension Tag Attributes

Attribute Name Description

type

The dimension type.

isCacheable

If set to true, indicates that this dimension is included in the Oracle BI Server query cache.

CacheExpiry

If set to true, indicates that this dimension is included in the Oracle BI Server query cache.

isCacheEventTable

How long table entries should persist in the query cache. A value of 0 indicates that cache entries do not expire.

isOverrideCacheProp

For alias tables only. If set to true, indicates that the alias table has its own cache properties that override the cache properties of the source table.

pollFreq

If set to true, indicates that this table has been registered as an Oracle BI Server event polling table.

x

The polling frequency, in seconds. Only applies if this table is an Oracle BI Server event polling table. The default value is 3600 seconds.

y

The x coordinate of the table when it is shown in the physical diagram.

rowCount

The y coordinate of the table when it is shown in the physical diagram.

lastUpdated

The time at which row counts were last updated for this Oracle OLAP dimension.

hints

This attribute is not used.

isSysGen

If set to true, indicates that an internal utility has generated this Oracle OLAP dimension.

isDDLAggr

Indicates whether this Oracle OLAP dimension is an aggregate table.

isTimeDim

If set to true, indicates that this Oracle OLAP dimension is a time dimension.

isRagged

If set to true, indicates that this dimension hierarchy is unbalanced. An unbalanced hierarchy is one that contains levels that are not at the same depth.

isSkipped

If set to true, indicates that this dimension hierarchy is a skip-level hierarchy. A skip-level hierarchy is one in which there are members that do not have a value for a particular parent level.

extName

The physical name that is used when referencing the dimension in physical SQL queries.

The AW dimension tag includes the following child elements:

Table 8-32 AW Dimension Child Elements

Element Name Description

AggrConnPool

If this AW dimension is an aggregate table, this element references the connection pool used for the aggregate.

The connection pool is contained in a sub-element called RefConnectionPool.

AWObjects

References the Oracle OLAP objects, such a list of hierarchies, associated with this dimension.

Each object is contained in a sub-element called AWObject. This sub-element includes the following attributes:

  • name

  • type

  • dataType

  • nullable

  • precision

  • scale

Syntax

<AWDimension …
     type=""
     isCacheable=""
     cacheExpiry=""
     isCacheEventTable=""
     isOverrideCacheProp=""
     pollFreq=""
     x=""
     y=""
     rowCount=""
     lastUpdated=""
     isSysGen=""
     isDDLAggr=""
     isTimeDim=""
     extName="">
   <Description />
   <AggrConnPool>
     <RefConnectionPool …/>
   </AggrConnPool>
   <AWObjects>
     <AWObject name="" type="" dataType="" …/>
     <AWObject name="" type="" dataType="" …/>
   </AWObjects>
</AWDimension>

Example

<AWDimension name="Customer"
     parentName="&quot;Demo AW&quot;.&quot;GLOBAL&quot;.&quot;GLOBAL&quot;" 
     parentId="3049:9" parentUid="000000ae-0be9-0000-714b-e31d00000000"
     id="3052:91" uid="000000b3-0bec-0000-714b-e31d00000000"
     type="none" extName="CUSTOMER">
   <AWObjects>
     <AWObject type="HIER_LIST" name="CUSTOMER_HIERLIST" dataType="VARCHAR"
      precision="100"/>
     <AWObject type="LEVEL_LIST" name="CUSTOMER_LEVELLIST" dataType="VARCHAR"
      precision="100"/>
     <AWObject type="IN_HIER" name="CUSTOMER_INHIER" dataType="VARCHAR"
      precision="100"/>
     <AWObject type="PARENT_REL" name="CUSTOMER_PARENTREL" dataType="VARCHAR"
      precision="100"/>
     <AWObject type="LEVEL_REL" name="CUSTOMER_LEVELREL" dataType="VARCHAR"
      precision="100"/>
     <AWObject type="FAMILY_REL" name="CUSTOMER_FAMILYREL" dataType="VARCHAR"
      precision="100"/>
   </AWObjects>
</AWDimension>

8.19 XML Elements: AW Hierarchy

The AW hierarchy element corresponds to the Oracle OLAP hierarchy object in the Physical layer.

The AW hierarchy tag includes the following attributes:

Table 8-33 AW Hierarchy Tag Attributes

Attribute Name Description

type

The type of Oracle OLAP hierarchy (value or level).

isDefault

If set to true, indicates that this is the default hierarchy for the Oracle OLAP dimension.

extName

The physical name that is used when referencing the hierarchy in physical SQL queries.

dataType

The data type of the Oracle OLAP hierarchy, such as VARCHAR.

nullable

If set to true, indicates that null values are allowed for the Oracle OLAP hierarchy. This allows null values to be returned to the user, which is expected with certain functions and with outer joins.

precision

The precision of the data type of the Oracle OLAP hierarchy.

scale

The scale of the data type of the Oracle OLAP hierarchy.

The AW hierarchy tag includes the following child elements:

Table 8-34 AW Hierarchy Child Elements

Attribute Name Description

Levels

For level-based hierarchies only. References the level or levels for this Oracle OLAP hierarchy.

Each level is contained in a sub-element called RefAWLevel.

Columns

For value-based hierarchies only. References the column or columns for this Oracle OLAP hierarchy.

Each column is contained in a sub-element called RefAWColumn.

MemberKey

References the member key (for parent-child hierarchies).

The member key is contained in a sub-element called RefAWColumn.

Syntax

<AWHierarchy …
     type=""
     isDefault=""
     extName=""
     dataType=""
     nullable=""
     precision=""
     scale="">
   <Description />
   <Levels>
     <RefAWLevel ../>
   </Levels>
   <Columns>
     <RefAWColumn …/>
   </Columns>
   <MemberKey>
     <RefAWColumn …/>
   </MemberKey>
</AWHierarchy>

Example

<AWHierarchy name="Primary" 
     parentName="&quot;Demo AW&quot;.&quot;GLOBAL&quot;.&quot;GLOBAL&quot;.&quot;
      Channel&quot;"
     parentId="3052:84" parentUid="000000b2-0bec-0000-714b-e31d00000000"
     id="3056:138" uid="0000012f-0bf0-0000-714b-e31d00000000"
     isDefault="true" extName="PRIMARY" dataType="UNKNOWN">
   <Levels>
     <RefAWLevel id="3058:150"
      uid="0000013b-0bf2-0000-714b-e31d00000000"
      qualifiedName="&quot;Demo AW&quot;.&quot;GLOBAL&quot;.&quot;GLOBAL&quot;
       .&quot;Channel&quot;.&quot;Primary&quot;.&quot;Total Channel&quot;"/>
     <RefAWLevel id="3058:151"
      uid="0000013c-0bf2-0000-714b-e31d00000000"
      qualifiedName="&quot;Demo AW&quot;.&quot;GLOBAL&quot;.&quot;GLOBAL&quot;
       .&quot;Channel&quot;.&quot;Primary&quot;.&quot;Channel&quot;"/>
   </Levels>
</AWHierarchy>

8.20 XML Elements: AW Level

The AW level element corresponds to the Oracle OLAP level object in the Physical layer.

The AW level tag includes the following attributes:

Table 8-35 AW Level Tag Attributes

Attribute Name Description

extName

The physical name that is used when referencing the level in physical SQL queries.

dataType

The data type of the Oracle OLAP level, such as VARCHAR.

nullable

If set to true, indicates that null values are allowed for the Oracle OLAP level. This allows null values to be returned to the user, which is expected with certain functions and with outer joins.

precision

The precision of the data type of the Oracle OLAP level.

scale

The scale of the data type of the Oracle OLAP level.

The AW level tag includes the following child elements:

Table 8-36 AW Level Child Elements

Element Name Description

Columns

References the column or columns for this Oracle OLAP level.

Each column is contained in a sub-element called RefAWColumn.

LevelKey

References the key column for this Oracle OLAP level.

The key column is contained in a sub-element called RefAWColumn.

Syntax

<AWLevel …
     extName=""
     dataType=""
     nullable=""
     precision=""
     scale="">
   <Description />
   <Columns>
     <RefAWColumn …/>
   </Columns>
   <LevelKey>
     <RefAWColumn …/>
   </LevelKey>
</AWLevel>

Example

<AWLevel name="All Years"
     parentName="&quot;Demo AW&quot;.&quot;GLOBAL&quot;.&quot;GLOBAL&quot;
      .&quot;Time&quot;.&quot;Calendar Year&quot;"
     parentId="3056:136" parentUid="0000012d-0bf0-0000-714b-e31d00000000"
     id="3058:142" uid="00000133-0bf2-0000-714b-e31d00000000"
     extName="ALL_YEARS" dataType="UNKNOWN">
   <Columns>
     <RefAWColumn id="3060:49" 
      uid="000000d9-0bf4-0000-714b-e31d00000000"
      qualifiedName="&quot;Demo AW&quot;.&quot;GLOBAL&quot;.&quot;GLOBAL&quot;
       .&quot;Time&quot;.&quot;CALENDAR_YEAR - All Years - Long Description
       &quot;"/>
     <RefAWColumn id="3060:50" 
      uid="000000da-0bf4-0000-714b-e31d00000000"
      qualifiedName="&quot;Demo AW&quot;.&quot;GLOBAL&quot;.&quot;GLOBAL&quot;
       .&quot;Time&quot;.&quot;Calendar Year - All Years&quot;"/>
   </Columns>
   <LevelKey>
     <RefAWColumn id="3060:50" 
      uid="000000da-0bf4-0000-714b-e31d00000000"
      qualifiedName="&quot;Demo AW&quot;.&quot;GLOBAL&quot;.&quot;GLOBAL&quot;
       .&quot;Time&quot;.&quot;Calendar Year - All Years&quot;"/>
   </LevelKey>
</AWLevel>

8.21 XML Elements: AW Column

The AW column element corresponds to the AW column object in the Physical layer.

The AW column tag includes the following attributes:

Table 8-37 AW Column Tag Attributes

Attribute Name Description

extName

The physical name that is used when referencing the column in physical SQL queries.

isParentKey

Indicates whether this Oracle OLAP column is a parent key for a level.

dataType

The data type of the Oracle OLAP column, such as VARCHAR.

scale

The scale of the data type of the Oracle OLAP column.

nullable

If set to true, indicates that null values are allowed for the Oracle OLAP column. This allows null values to be returned to the user, which is expected with certain functions and with outer joins.

precision

The precision of the data type of the Oracle OLAP column.

The AW column tag does not include any child elements.

Syntax

<AWColumn …
     extName=""
     isParentKey=""
     dataType=""
     nullable=""
     precision=""
     scale="">
   <Description />
</AWColumn>

Example

<AWColumn name="Sales"
     parentName="&quot;Demo AW&quot;.&quot;GLOBAL&quot;.&quot;GLOBAL&quot;
      .&quot;Units Cube&quot;"
     parentId="3054:10" parentUid="000000af-0bee-0000-714b-e31d00000000"
     id="3060:12" uid="000000b6-0bf4-0000-714b-e31d00000000" 
     extName="UNITS_CUBE_SALES" dataType="DOUBLE" nullable="true">
</AWColumn>