This chapter provides Oracle BI Server XML API reference information for presentation elements. Presentation elements typically correspond to objects in the Presentation layer of the Oracle BI repository, or in other words, the objects that appear in the left-hand pane of the Oracle BI Administration Tool.
This chapter contains the following topics:
The presentation catalog element corresponds to the subject area object in the Presentation layer.
The presentation catalog tag includes the following attributes:
Table 9-1 Presentation Catalog Tag Attributes
| Attribute Name | Description |
|---|---|
|
isExportKeys |
If set to true, indicates that logical keys for this subject area are exposed to other applications. |
|
hasDispName |
Indicates whether this subject area has a custom display name. |
|
dispName |
The value of the custom display name, if one exists for this subject area. |
|
hasDispDescription |
Indicates whether this subject area has a custom description. |
|
dispDescription |
The value of the custom description, if one exists for this subject area. |
|
isAutoAggr |
If set to true, indicates that auto aggregation is enabled. Auto aggregation is the process by which the Oracle BI Server infers the GROUP BY from the attributes projected in the query. Typically, auto aggregation is always enabled for queries against the Presentation layer. |
The presentation catalog tag includes the following child elements:
Table 9-2 Presentation Catalog Child Elements
| Element Name | Description |
|---|---|
|
RefBusinessModel |
References the business model for this subject area. |
|
DefaultFactCol |
References the implicit fact column for this subject area, if one has been set. This column is used to specify a default join path between dimension tables when there are several possible alternatives or contexts. The implicit fact column is contained in a sub-element called |
|
Aliases |
Lists any aliases that have been defined for this subject area. Aliases are created when presentation objects are renamed to ensure that any references to the old names still work in logical SQL queries. Each alias is contained in a sub-element called |
|
Tables |
References the presentation tables that belong to this subject area. Each presentation table is contained in a sub-element called |
|
VisibilityFilter |
Contains the expression specified to control the visibility of this object in Answers and BI Composer. This element corresponds to the Hide object if field in the Administration Tool. The expression is contained in a sub-element called |
<PresentationCatalog …
isExportKeys=""
isAutoAggr=""
hasDispName=""
dispName=""
hasDispDescription=""
dispDescription"">
<Description />
<RefBusinessModel …/>
<DefaultFactCol>
<RefLogicalColumn …/>
</DefaultFactCol>
<Aliases …/>
<Tables>
<RefPresentationTable …/>
</Tables>
<VisibilityFilter>
<Expr …/>
</VisibilityFilter>
</PresentationCatalog>
<PresentationCatalog name="C - Sample Headcount"
id="4004:20154" uid="80cad5f1-0fa4-0000-714b-e31d00000000"
hasDispName="false" hasDispDescription="false">
<Description>
<![CDATA[Sample Subject Area for Headcount analysis. ]]>
</Description>
<RefBusinessModel id="2000:11614"
uid="80cab573-07d0-0000-714b-e31d00000000"
qualifiedName=""1 - Sample App""/>
<DefaultFactCol>
<RefLogicalColumn id="2006:11713"
uid="80cab5d6-07d6-0000-714b-e31d00000000"
qualifiedName=""1 - Sample App"."
F0 Revenue Base Measures"."1- Revenue""/>
</DefaultFactCol>
<Tables>
<RefPresentationTable id="4008:22157"
uid="80caddc2-0fa8-0000-714b-e31d00000000"
qualifiedName=""C - Sample Headcount".."Time""/>
<RefPresentationTable id="4008:32117"
uid="80cb3805-0fa8-0000-714b-e31d00000000"
qualifiedName=""C - Sample Headcount".."Offices""/>
<RefPresentationTable id="4008:20169"
uid="80cad600-0fa8-0000-714b-e31d00000000"
qualifiedName=""C - Sample Headcount".."Base Facts""/>
<RefPresentationTable id="4008:20170"
uid="80cad601-0fa8-0000-714b-e31d00000000"
qualifiedName=""C - Sample Headcount".."
Calculated Facts""/>
<RefPresentationTable id="4008:20171"
uid="80cad602-0fa8-0000-714b-e31d00000000"
qualifiedName=""C - Sample Headcount".."
Simple Calculations""/>
<RefPresentationTable id="4008:22145"
uid="80caddb6-0fa8-0000-714b-e31d00000000"
qualifiedName=""C - Sample Headcount".."
Time Span Variations""/>
</Tables>
</PresentationCatalog>
The presentation schema element is not used.
The presentation table element corresponds to the presentation table object in the Presentation layer.
The presentation table tag includes the following attributes:
Table 9-3 Presentation Table Tag Attributes
| Attribute Name | Description |
|---|---|
|
hasDispName |
Indicates whether this presentation table has a custom display name. |
|
dispName |
The value of the custom display name, if one exists for this presentation table. |
|
hasDispDescription |
Indicates whether this presentation table has a custom description. |
|
dispDescription |
The value of the custom description, if one exists for this presentation table. |
The presentation table tag includes the following child elements:
Table 9-4 Presentation Table Child Elements
| Element Name | Description |
|---|---|
|
Aliases |
Lists any aliases that have been defined for this presentation table. Aliases are created when presentation objects are renamed to ensure that any references to the old names still work in logical SQL queries. Each alias is contained in a sub-element called |
|
Columns |
References the presentation columns that belong to this presentation table. Each presentation column is contained in a sub-element called |
|
VisibilityFilter |
Contains the expression specified to control the visibility of this object in Answers and BI Composer. This element corresponds to the Hide object if field in the Administration Tool. The expression is contained in a sub-element called |
|
ContentFolders |
References any child presentation tables that have been designated for this presentation table. Child presentation tables appear as nested folders in Answers and BI Composer. Note that the folders only appear to be nested - they are not actually nested in terms of drill-down, and the qualified names of the objects remain the same. Each child presentation table is contained in a sub-element called |
<PresentationTable …
hasDispName=""
dispName=""
hasDispDescription=""
dispDescription="">
<Description />
<Aliases>
<Alias name=""/>
<Alias name=""/>
</Aliases>
<Columns>
<RefPresentationColumn …/>
</Columns>
<VisibilityFilter>
<Expr …/>
</VisibilityFilter>
<ContentFolders>
<RefPresentationTable …/>
</ContentFolders>
</PresentationTable>
<PresentationTable name="Offices"
parentName=""A - Sample Sales"."""
parentId="4004:12383" parentUid="80cab7ef-0fa4-0000-714b-e31d00000000"
id="4008:12457" uid="80cab839-0fa8-0000-714b-e31d00000000"
dispName="VALUEOF(NQ_SESSION.CN_A_-_Sample_Sales_Offices)"
hasDispName="true" hasDispDescription="false">
<Description>
<![CDATA[Offices dimension attribute objects]]>
</Description>
<Columns>
<RefPresentationColumn id="4010:31845"
uid="80cb368a-0faa-0000-714b-e31d00000000"
qualifiedName=""A - Sample Sales".."Offices"
."D1 Office""/>
<RefPresentationColumn id="4010:31847"
uid="80cb368b-0faa-0000-714b-e31d00000000"
qualifiedName=""A - Sample Sales".."Offices"
."D2 Department""/>
<RefPresentationColumn id="4010:31849"
uid="80cb368c-0faa-0000-714b-e31d00000000"
qualifiedName=""A - Sample Sales".."Offices"
."D3 Organization""/>
<RefPresentationColumn id="4010:31851"
uid="80cb368d-0faa-0000-714b-e31d00000000"
qualifiedName=""A - Sample Sales".."Offices"
."D4 Company""/>
</Columns>
</PresentationTable>
The presentation column element corresponds to the presentation column object in the Presentation layer.
The presentation column tag includes the following attributes:
Table 9-5 Presentation Column Tag Attributes
| Attribute Name | Description |
|---|---|
|
overrideLogicalName |
Indicates whether the presentation column has been configured to always use the logical column name. This option corresponds to Use Logical Column Name in the Administration Tool. A |
|
hasDispName |
Indicates whether this presentation column has a custom display name. |
|
dispName |
The value of the custom display name, if one exists for this presentation column. |
|
hasDispDescription |
Indicates whether this presentation column has a custom description. |
|
dispDescription |
The value of the custom description, if one exists for this presentation column. |
The presentation column tag includes the following child elements:
Table 9-6 Presentation Column Child Elements
| Attribute Name | Description |
|---|---|
|
RefLogicalColumn |
References the logical column upon which this presentation column is based. |
|
Aliases |
Lists any aliases that have been defined for this presentation column. Aliases are created when presentation objects are renamed to ensure that any references to the old names still work in logical SQL queries. Each alias is contained in a sub-element called |
|
VisibilityFilter |
Contains the expression specified to control the visibility of this object in Answers and BI Composer. This element corresponds to the Hide object if field in the Administration Tool. The expression is contained in a sub-element called |
<PresentationColumn …
overideLogicalName=""
hasDispName=""
dispName=""
hasDispDescription=""
dispDescription="">
<Description />
<RefLogicalColumn …/>
<Aliases>
<Alias name=""/>
<Alias name=""/>
</Aliases>
<VisibilityFilter>
<Expr …/>
</VisibilityFilter>
</PresentationColumn>
<PresentationColumn name="T01 Per Name Week (Rel Only)"
parentName=""F - Sample Essb Federated".."Time""
parentId="4008:54644" parentUid="80cb981c-0fa8-0000-714b-e31d00000000"
id="4010:54646" uid="80cb981e-0faa-0000-714b-e31d00000000"
hasDispName="false" hasDispDescription="false" overrideLogicalName="false">
<Description>
<![CDATA[Help : Period Name Week. Stores the week information
in the format YYYY Week Number. Eg :- 2006 Week 40]]>
</Description>
<RefLogicalColumn id="2006:53537"
uid="80cb94b1-07d6-0000-714b-e31d00000000"
qualifiedName=""3 - Sample Federated"."D0 Time"
."T01 Per Name Week (Rel Only)""/>
<Aliases>
<Alias name="T01 Per Name Week"/>
</Aliases>
</PresentationColumn>
The presentation hierarchy element corresponds to the presentation hierarchy object in the Presentation layer.
The presentation hierarchy tag includes the following attributes:
Table 9-7 Presentation Hierarchy Tag Attributes
| Attribute Name | Description |
|---|---|
|
hasDispName |
Indicates whether this presentation hierarchy has a custom display name. |
|
dispName |
The value of the custom display name, if one exists for this presentation hierarchy. |
|
hasDispDescription |
Indicates whether this presentation hierarchy has a custom description. |
|
dispDescription |
The value of the custom description, if one exists for this presentation hierarchy. |
The presentation hierarchy tag includes the following child elements:
Table 9-8 Presentation Hierarchy Child Elements
| Element Name | Description |
|---|---|
|
Levels |
References the presentation levels for this presentation hierarchy. Each presentation level is contained in a sub-element called RefPresentationLevel. |
|
Aliases |
Lists any aliases that have been defined for this presentation hierarchy. Aliases are created when presentation objects are renamed to ensure that any references to the old names still work in logical SQL queries. Each alias is contained in a sub-element called |
|
DisplayColumns |
For parent-child hierarchies only. This element references the columns designated to be used for display for this parent-child hierarchy. Each display column is contained in a sub-element called |
|
Dimension |
References the logical dimension upon which this presentation hierarchy is based. The dimension is contained in a sub-element called |
|
VisibilityFilter |
Contains the expression specified to control the visibility of this object in Answers and BI Composer. This element corresponds to the Hide object if field in the Administration Tool. The expression is contained in a sub-element called |
<PresentationHierarchy …
hasDisplayName=""
displayName=""
hasDispDescription=""
dispDescription="">
<Description />
<Levels>
<RefPresentationLevel …/>
</Levels>
<Aliases>
<Alias name=""/>
<Alias name=""/>
</Aliases>
<DisplayColumns>
<RefPresentationColumn …/>
</DisplayColumns>
<Dimension>
<RefDimension …/>
</Dimension>
<VisibilityFilter>
<Expr …/>
</VisibilityFilter>
</PresentationHierarchy>
<PresentationHierarchy name="Discounts and Coupons"
parentName=""Fusion Order Demo".."Discounts and Coupons""
parentId="4008:69443" parentUid="80cbdded-0fa8-0000-714b-e31d00000000"
id="4028:69466" uid="80cbde04-0fbc-0000-714b-e31d00000000"
hasDispName="false" hasDispDescription="false">
<Levels>
<RefPresentationLevel id="4030:69479"
uid="80cbde11-0fbe-0000-714b-e31d00000000"
qualifiedName=""Fusion Order Demo".."Discounts and Coupons
"."Discounts and Coupons"."Total""/>
<RefPresentationLevel id="4030:69480"
uid="80cbde12-0fbe-0000-714b-e31d00000000"
qualifiedName=""Fusion Order Demo".."Discounts and Coupons
"."Discounts and Coupons"."Discounts Detail""/>
</Levels>
<Aliases>
<Alias name="H11 Discounts and Coupons"/>
</Aliases>
<Dimension>
<RefDimension id="2019:63982"
uid="80cbc7c7-07e3-0000-714b-e31d00000000"
qualifiedName=""Fusion Order Demo (OLTP)"."
H11 Discounts and Coupons""/>
</Dimension>
</PresentationHierarchy>
The presentation level element corresponds to the presentation level object in the Presentation layer.
The presentation level tag includes the following attributes:
Table 9-9 Presentation Level Tag Attributes
| Attribute Name | Description |
|---|---|
|
hasDispName |
Indicates whether this presentation level has a custom display name. |
|
dispName |
The value of the custom display name, if one exists for this presentation level. |
|
hasDispDescription |
Indicates whether this presentation level has a custom description. |
|
dispDescription |
The value of the custom description, if one exists for this presentation level. |
The presentation level tag includes the following child elements:
Table 9-10 Presentation Level Child Elements
| Element Name | Description |
|---|---|
|
RefLogicalLevel |
References the logical level upon which this presentation level is based. |
|
DrillTo |
References the levels for cross-dimension drill-down operations, as in the case of a Region dimension with a City level that can have a "drill to" level Year in the Time dimension. |
|
DisplayColumns |
References the columns that have been designated to be used for display for this presentation level (on drill-down). Each column is contained in a sub-element called |
|
Aliases |
Lists any aliases that have been defined for this presentation level. Aliases are created when presentation objects are renamed to ensure that any references to the old names still work in logical SQL queries. Each alias is contained in a sub-element called |
|
VisibilityFilter |
This child element is not used. |
<PresentationLevel …
hasDisplayName=""
displayName=""
hasDispDescription=""
dispDescription="">
<Description />
<RefLogicalLevel …/>
<DrillTo>
<RefPresentationLevel …/>
<RefPresentationLevel …/>
</DrillTo>
<DisplayColumns>
<RefPresentationColumn …/>
<RefPresentationColumn …/>
</DisplayColumns>
<Aliases>
<Alias name=""/>
<Alias name=""/>
</Aliases>
</PresentationLevel>
<PresentationLevel name="Ship to Region"
parentName=""A - Sample Sales".."Orders"
."Ship To Region Hier""
parentId="4028:32353" parentUid="80cb38ef-0fbc-0000-714b-e31d00000000"
id="4030:32356" uid="80cb38f3-0fbe-0000-714b-e31d00000000"
dispName="VALUEOF(NQ_SESSION.CN_Orders_Ship_To_Region_Hier_Ship_to_Region)"
hasDispName="true" hasDispDescription="false">
<RefLogicalLevel id="2025:32260"
uid="80cb38a5-07e9-0000-714b-e31d00000000"
qualifiedName=""1 - Sample App"."H9 Orders"
."Ship To Region""/>
<DisplayColumns>
<RefPresentationColumn id="4010:32350"
uid="80cb38ec-0faa-0000-714b-e31d00000000"
qualifiedName=""A - Sample Sales".."Ship To Regions"
."R50 Region""/>
</DisplayColumns>
<Aliases>
<Alias name="Bill to Region"/>
</Aliases>
</PresentationLevel>