Contents

Title and Copyright Information

Preface

Audience

Documentation Accessibility

Related Documents

Conventions

Part I MDS XML Schema Elements

1 About the Oracle BI Server MDS XML API

1.1 About the Oracle BI Server MDS XML API

1.2 Generating MDS XML

1.2.1 Generating MDS XML from an Existing RPD Using the Administration Tool

1.2.2 Generating MDS XML from an Existing RPD Using a Command-Line Utility

1.3 Generic MDS XML Elements and Attributes

1.3.1 About MDS XML Object Identifiers

1.4 Example: Analysis of an MDS XML Logical Table Element

1.5 Topics of Interest in Other Guides

1.6 System Requirements and Certification

2 MDS XML Logical Elements

2.1 MDS XML Elements: Logical Column

2.2 MDS XML Elements: Business Model

2.3 MDS XML Elements: Logical Complex Join

2.4 MDS XML Elements: Logical Level

2.5 MDS XML Elements: Dimension

2.6 MDS XML Elements: Logical Table

2.7 MDS XML Elements: Logical Foreign Key

2.8 MDS XML Elements: Logical Key

2.9 MDS XML Elements: Logical Table Source

2.9.1 Column Mapping

2.10 MDS XML Elements: Logical Source Folder

2.11 MDS XML Elements: Measure Definition

2.12 MDS XML Elements: Aggregation Rule

2.13 MDS XML Elements: Override Aggregation Rule

2.14 MDS XML Elements: Logical Display Folder

3 MDS XML Physical Elements

3.1 MDS XML Elements: Database

3.2 MDS XML Elements: Physical Catalog

3.3 MDS XML Elements: Physical Schema

3.4 MDS XML Elements: Physical Display Folder

3.5 MDS XML Elements: Physical Table

3.6 MDS XML Elements: Physical Column

3.7 MDS XML Elements: Connection Pool

3.8 MDS XML Elements: Physical Key

3.9 MDS XML Elements: Physical Foreign Key

3.10 MDS XML Elements: Complex Join

3.11 MDS XML Elements: Cube Table

3.12 MDS XML Elements: Physical Dimension

3.13 MDS XML Elements: Physical Hierarchy

3.14 MDS XML Elements: Physical Level

3.15 MDS XML Elements: Cube Column

3.16 MDS XML Elements: Analytic Workspace

3.17 MDS XML Elements: AW Cube

3.18 MDS XML Elements: AW Dimension

3.19 MDS XML Elements: AW Hierarchy

3.20 MDS XML Elements: AW Level

3.21 MDS XML Elements: AW Column

4 MDS XML Presentation Elements

4.1 MDS XML Elements: Presentation Catalog

4.2 MDS XML Elements: Presentation Table

4.3 MDS XML Elements: Presentation Column

4.4 MDS XML Elements: Presentation Hierarchy

4.5 MDS XML Elements: Presentation Level

5 MDS XML Marketing, Security, and Other Elements

5.1 MDS XML Marketing Elements

5.1.1 MDS XML Elements: Catalog Link

5.1.2 MDS XML Elements: Target Level

5.1.3 MDS XML Elements: List Catalog

5.1.4 MDS XML Elements: Qualified List Item

5.1.5 MDS XML Elements: Qualifying Key

5.1.6 MDS XML Elements: Sampling Table

5.1.7 MDS XML Elements: Seg Catalog

5.2 MDS XML Security Elements

5.2.1 MDS XML Elements: Variable

5.2.2 MDS XML Elements: LDAP Server

5.2.3 MDS XML Elements: Init Block

5.2.4 MDS XML Elements: Custom Authenticator

5.2.5 MDS XML Elements: Privilege Package

5.2.6 MDS XML Elements: Object Privilege

5.2.7 MDS XML Elements: Query Privilege

5.2.8 MDS XML Elements: User

5.2.9 MDS XML Elements: Group

5.2.10 MDS XML Elements: DB Sign-On

5.3 Other MDS XML Elements

5.3.1 MDS XML Elements: Project

5.3.2 MDS XML Elements: Query Object

Part II XML Schema Elements

6 About the Oracle BI Server XML API

6.1 About the Oracle BI Server XML API

6.1.1 About Using the Oracle BI Server XML API to Merge and Append Objects

6.2 Generating and Executing XML

6.2.1 Generating XML from an Existing RPD

6.2.2 Executing XML in Offline Mode

6.2.3 Executing XML Against the Oracle BI Server

6.3 Using the Oracle BI Server XML API

6.3.1 Maintaining Versions of the Metadata

6.3.2 Migrating Metadata from Another System

6.3.3 Applying a Metadata Patch Against a Running Oracle BI Server

6.3.4 Manipulating Metadata Programmatically

6.3.4.1 Example of Programmatically Creating a Repository Object Using XML

6.3.5 Moving from Test to Production Environments

6.3.6 Using XSL to Transform XML Files

6.4 Generic XML Elements and Attributes

6.4.1 About Object Identifiers

6.4.2 About Naming Requirements for Repository Objects

7 XML Logical Elements

7.1 XML Elements: Logical Column

7.2 XML Elements: Business Model

7.3 XML Elements: Logical Complex Join

7.4 XML Elements: Logical Level

7.5 XML Elements: Dimension

7.6 XML Elements: Logical Table

7.7 XML Elements: Logical Foreign Key

7.8 XML Elements: Logical Key

7.9 XML Elements: Logical Table Source

7.9.1 Column Mapping

7.10 XML Elements: Logical Source Folder

7.11 XML Elements: Measure Definition

7.12 XML Elements: Aggregation Rule

7.13 XML Elements: Override Aggregation Rule

7.14 XML Elements: Logical Display Folder

8 XML Physical Elements

8.1 XML Elements: Database

8.2 XML Elements: Physical Catalog

8.3 XML Elements: Physical Schema

8.4 XML Elements: Physical Display Folder

8.5 XML Elements: Physical Table

8.6 XML Elements: Physical Column

8.7 XML Elements: Connection Pool

8.8 XML Elements: Physical Key

8.9 XML Elements: Physical Foreign Key

8.10 XML Elements: Complex Join

8.11 XML Elements: Cube Table

8.12 XML Elements: Physical Dimension

8.13 XML Elements: Physical Hierarchy

8.14 XML Elements: Physical Level

8.15 XML Elements: Cube Column

8.16 XML Elements: Analytic Workspace

8.17 XML Elements: AW Cube

8.18 XML Elements: AW Dimension

8.19 XML Elements: AW Hierarchy

8.20 XML Elements: AW Level

8.21 XML Elements: AW Column

9 XML Presentation Elements

9.1 XML Elements: Presentation Catalog

9.2 XML Elements: Presentation Schema

9.3 XML Elements: Presentation Table

9.4 XML Elements: Presentation Column

9.5 XML Elements: Presentation Hierarchy

9.6 XML Elements: Presentation Level

10 XML Marketing, Security, and Other Elements

10.1 XML Marketing Elements

10.1.1 XML Elements: Catalog Link

10.1.2 XML Elements: Target Level

10.1.3 XML Elements: List Catalog

10.1.4 XML Elements: Qualified List Item

10.1.5 XML Elements: Qualifying Key

10.1.6 XML Elements: Sampling Table

10.1.7 XML Elements: Seg Catalog

10.2 XML Security Elements

10.2.1 XML Elements: Variable

10.2.2 XML Elements: LDAP Server

10.2.3 XML Elements: Init Block

10.2.4 XML Elements: Custom Authenticator

10.2.5 XML Elements: Privilege Package

10.2.6 XML Elements: Object Privilege

10.2.7 XML Elements: Query Privilege

10.2.8 XML Elements: User

10.2.9 XML Elements: Group

10.2.10 XML Elements: DB Sign-On

10.2.11 XML Elements: FMW Security

10.3 Other XML Elements

10.3.1 XML Elements: Project

10.3.2 XML Elements: Query Object

Glossary

Index

Oracle® Fusion Middleware

XML Schema Reference for Oracle Business Intelligence Enterprise Edition

11g Release 1 (11.1.1)

E23950-01

December 2011

Describes how to use the Oracle BI Server MDS XML API and the legacy Oracle BI Server XML API, and provides reference information for each MDS and XML schema element.

Oracle Fusion Middleware XML Schema Reference for Oracle Business Intelligence Enterprise Edition, 11g Release 1 (11.1.1)

E23950-01

Copyright © 2011, Oracle and/or its affiliates. All rights reserved.

Primary Authors:  Marla Azriel, Mike Meditzky

Contributors: Oracle Business Intelligence development, product management, and quality assurance teams

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Preface

The Oracle Business Intelligence Foundation Suite is a complete, open, and integrated solution for all enterprise business intelligence needs, including reporting, ad hoc queries, OLAP, dashboards, scorecards, and what-if analysis. The Oracle Business Intelligence Foundation Suite includes Oracle Business Intelligence Enterprise Edition.

Oracle Business Intelligence Enterprise Edition (Oracle BI EE) is a comprehensive set of enterprise business intelligence tools and infrastructure, including a scalable and efficient query and analysis server, an ad-hoc query and analysis tool, interactive dashboards, proactive intelligence and alerts, and an enterprise reporting engine.

The components of Oracle BI EE share a common service-oriented architecture, data access services, analytic and calculation infrastructure, metadata management services, semantic business model, security model and user preferences, and administration tools. Oracle BI EE provides scalability and performance with data-source specific optimized request generation, optimized data access, advanced calculation, intelligent caching services, and clustering.

This guide contains usage and reference information about both the Oracle BI Server MDS XML API and the legacy Oracle BI Server XML API.

Audience

This document is intended for metadata repository developers who use MDS XML or Oracle BI Server XML in their repository development processes, or for system administrators who use the Oracle BI Server XML API to programmatically interact with the Oracle BI repository.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Related Documents

For more information, see the following documents in the Oracle Business Intelligence Enterprise Edition 11g Release 1 (11.1.1) documentation set:

The Oracle Business Intelligence chapter in Oracle Fusion Middleware Release Notes for your platform

Oracle Fusion Middleware Metadata Repository Builder's Guide for Oracle Business Intelligence Enterprise Edition

Oracle Fusion Middleware Installation Guide for Oracle Business Intelligence

Oracle Fusion Middleware Installation and Administration Guide for Oracle Exalytics In-Memory Machine

Oracle Fusion Middleware Upgrade Guide for Oracle Business Intelligence

Oracle Fusion Middleware System Administrator's Guide for Oracle Business Intelligence Enterprise Edition

Oracle Fusion Middleware Enterprise Deployment Guide for Oracle Business Intelligence

Oracle Fusion Middleware Security Guide for Oracle Business Intelligence Enterprise Edition

Oracle Fusion Middleware Integrator's Guide for Oracle Business Intelligence Enterprise Edition

Oracle Fusion Middleware User's Guide for Oracle Business Intelligence Enterprise Edition

Oracle Fusion Middleware Developer's Guide for Oracle Business Intelligence Enterprise Edition

Oracle Fusion Middleware Scheduling Jobs Guide for Oracle Business Intelligence Enterprise Edition

Conventions

The following text conventions are used in this document:

Convention
Meaning

boldface

Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.

italic

Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

monospace

Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

Part I

MDS XML Schema Elements

Part I provides usage and reference information for the Oracle BI Server MDS XML API.

Part I contains the following chapters:

Chapter 1, "About the Oracle BI Server MDS XML API"

Chapter 2, "MDS XML Logical Elements"

Chapter 3, "MDS XML Physical Elements"

Chapter 4, "MDS XML Presentation Elements"

Chapter 5, "MDS XML Marketing, Security, and Other Elements"

1 About the Oracle BI Server MDS XML API

MDS XML is an XML format that is compatible with Oracle Metadata Services, and is a supported format for the Oracle BI repository. Oracle Business Intelligence provides the ability to save Oracle BI repository metadata as a set of XML documents in MDS XML format.

Using this feature, you can integrate with third-party source control management (SCM) systems for Oracle BI repository development. For more details, see "Using a Source Control Management System for Repository Development" in Oracle Fusion Middleware Metadata Repository Builder's Guide for Oracle Business Intelligence Enterprise Edition.

Note:

MDS XML format is different from the XML format generated by the Oracle BI Server XML API, where the metadata for an Oracle BI repository is generated in a single XML file. For more information about the Oracle BI Server XML API, see Chapter 6, "About the Oracle BI Server XML API."

This chapter contains the following topics:

Section 1.1, "About the Oracle BI Server MDS XML API"

Section 1.2, "Generating MDS XML"

Section 1.3, "Generic MDS XML Elements and Attributes"

Section 1.4, "Example: Analysis of an MDS XML Logical Table Element"

Section 1.5, "Topics of Interest in Other Guides"

Section 1.6, "System Requirements and Certification"

1.1 About the Oracle BI Server MDS XML API

The contents and structure of the Oracle BI Server MDS XML repository files are defined through the following schema element files:

xudml_mds_admin.xsd and xudml_mds.xsd

These files contain the basic MDS XML grammar for the repository elements.

xudml_mds_core.xsd

This file contains the detailed MDS XML grammar for the repository elements and attributes and the relationships between the elements.

You can find these files at:

ORACLE_HOME/bifoundation/server/bin

You can view these files to see the relationships between MDS XML metadata objects, but you must not modify these files.

1.2 Generating MDS XML

You can generate MDS XML from an existing repository file either from within the Administration Tool or by using a command-line utility.

This section contains the following topics:

Section 1.2.1, "Generating MDS XML from an Existing RPD Using the Administration Tool"

Section 1.2.2, "Generating MDS XML from an Existing RPD Using a Command-Line Utility"

1.2.1 Generating MDS XML from an Existing RPD Using the Administration Tool

Perform these steps to generate MDS XML from an existing repository file using the Administration Tool:

Open your existing repository file (RPD) in the Administration Tool in offline mode.

Select File, then select Save As, then select MDS XML Documents.

Select a root location for your MDS XML repository files, and then click OK.

The output files are generated in directories under the following path:

root_location/oracle/bi/server/base.

The number of generated directories depends on the complexity of your repository.

For example, with C:\SampleApp_MDS selected as your root location, the output directory structure could be as shown in Figure 1-1.

Figure 1-1 Example of Directories Containing MDS XML Elements

1.2.2 Generating MDS XML from an Existing RPD Using a Command-Line Utility

Oracle Business Intelligence provides the biserverxmlgen command-line utility to generate MDS XML output from a repository file.

Before running biserverxmlgen, you must first run bi-init to launch a command prompt or shell window that is initialized to your Oracle instance. This utility is called bi-init.sh on Linux and UNIX systems, bi-init.bat on client installations of the Administration Tool, and bi-init.cmd for all other Windows installation types.

For example, on Windows:

In Windows Explorer, go to the location appropriate for your install type:

Client installations:

ORACLE_HOME/bifoundation/server/bin

All other installations:

ORACLE_INSTANCE/bifoundation/OracleBIApplication/coreapplication/setup

Double-click bi-init.cmd (or bi-init.bat for client installations) to display a command prompt that is initialized to your Oracle instance.

At the command prompt, type biserverxmlgen with the desired options. You can also run biserverxmlgen with no arguments or parameters to see usage information.

To use biserverxmlgen to generate MDS XML output from an existing repository file, execute the following at the command prompt:

biserverxmlgen -M -R repository_pathname [-P password] -D output_directory [-8] [-N] [-Q|-S]

Where:

-M indicates that you want MDS XML output.

repository_pathname is the name and location of the repository file from which you want to generate MDS XML.

password is the repository password.

The password argument is optional. If you do not provide a password argument, you are prompted to enter a password when you run the command. To minimize the risk of security breaches, Oracle recommends that you do not provide a password argument either on the command line or in scripts. Note that the password argument is supported for backward compatibility only, and will be removed in a future release.

output_directory is the name and location of the directory under which you want to generate your MDS XML output.

Specify -8 to use UTF-8 encoding in the generated XML file. If you do not specify -8, the generated XML file uses ANSI ISO-8859-1 encoding by default.

Specify -N to generate output without upgrade ids (uids). These are the internal identifiers of objects. Use this if you want to create a new repository without the old upgrade ids.

You can use one of the two options -Q and -S to control the generation of security objects:

Use -Q to generate output without security objects

Use -S to generate output for only security objects

If you use both -Q and -S on the same call of biserverxmlgen, the second option on the call command takes precedence, and the first is ignored.

1.3 Generic MDS XML Elements and Attributes

This section describes generic elements and attributes that are common, like Description, name, and mdsid. In the Oracle BI Server MDS XML schema (.xsd file), these elements and attributes are defined under the object_t element.

The only common element is the Description element. This element can hold a text string describing a particular object. For example:

<Description>

2 MDS XML Logical Elements

Logical elements are typically those elements that are exposed in the Business Model and Mapping layer, or in other words, the elements that appear in the center pane of the Administration Tool.

This chapter contains the following topics:

Section 2.1, "MDS XML Elements: Logical Column"

Section 2.2, "MDS XML Elements: Business Model"

Section 2.3, "MDS XML Elements: Logical Complex Join"

Section 2.4, "MDS XML Elements: Logical Level"

Section 2.5, "MDS XML Elements: Dimension"

Section 2.6, "MDS XML Elements: Logical Table"

Section 2.7, "MDS XML Elements: Logical Foreign Key"

Section 2.8, "MDS XML Elements: Logical Key"

Section 2.9, "MDS XML Elements: Logical Table Source"

Section 2.10, "MDS XML Elements: Logical Source Folder"

Section 2.11, "MDS XML Elements: Measure Definition"

Section 2.12, "MDS XML Elements: Aggregation Rule"

Section 2.13, "MDS XML Elements: Override Aggregation Rule"

Section 2.14, "MDS XML Elements: Logical Display Folder"

2.1 MDS XML Elements: Logical Column

The logical column element corresponds to the logical column object in the Business Model and Mapping layer.

The logical column element is not a top-level element - it appears as a child element of the logical table element.

The logical column tag includes the following attributes:

Table 2-1 Logical Column Tag Attributes

Attribute Name
Description

isDerived

When set to true, indicates that the logical column is based on a user-defined expression (for example, another logical column, a constant value, or a variable).

IsWriteable

When set to true, indicates that write back has been enabled for this column. This feature is typically used with ADF Business Component data sources. This option is called Writeable in the Administration Tool.

customSortOrderRef

If the sort order for this logical column is based on a different logical column, this attribute references that logical column.

descriptorIDRef

When multilingual columns are based on a lookup function, it is common to specify the non-translated lookup key column as the descriptor ID column of the translated column. This attribute references the descriptor ID column.

The logical column tag includes the following child elements:

Table 2-2 Logical Column Child Elements

Element Name
Description

Expr

Contains the expression from which the logical column should be derived. This element is only used when the isDerived attribute is set to true.

Syntax

<LogicalColumn …
     isDerived=""
     isWriteable="
     customSortOrderRef=""
     descriptorIDRef="">
   <Description />
   <Expr>...</Expr>
</LogicalColumn>

Example

<LogicalColumn mdsid="m8030eac4-07d6-0000-714b-e31d00000000"
   name="Days Closed Category"
   isDerived="true"
   isWriteable="false">
   <Description>

3 MDS XML Physical Elements

Physical elements are typically those elements that are exposed in the Physical layer, or in other words, the elements that appear in the right-hand pane of the Administration Tool.

This chapter contains the following topics:

Section 3.1, "MDS XML Elements: Database"

Section 3.2, "MDS XML Elements: Physical Catalog"

Section 3.3, "MDS XML Elements: Physical Schema"

Section 3.4, "MDS XML Elements: Physical Display Folder"

Section 3.5, "MDS XML Elements: Physical Table"

Section 3.6, "MDS XML Elements: Physical Column"

Section 3.7, "MDS XML Elements: Connection Pool"

Section 3.8, "MDS XML Elements: Physical Key"

Section 3.9, "MDS XML Elements: Physical Foreign Key"

Section 3.10, "MDS XML Elements: Complex Join"

Section 3.11, "MDS XML Elements: Cube Table"

Section 3.12, "MDS XML Elements: Physical Dimension"

Section 3.13, "MDS XML Elements: Physical Hierarchy"

Section 3.14, "MDS XML Elements: Physical Level"

Section 3.15, "MDS XML Elements: Cube Column"

Section 3.16, "MDS XML Elements: Analytic Workspace"

Section 3.17, "MDS XML Elements: AW Cube"

Section 3.18, "MDS XML Elements: AW Dimension"

Section 3.19, "MDS XML Elements: AW Hierarchy"

Section 3.20, "MDS XML Elements: AW Level"

Section 3.21, "MDS XML Elements: AW Column"

3.1 MDS XML Elements: Database

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

The database tag includes the following attributes:

Table 3-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.

containerRef

References the container for this database.

persistConnPoolRef

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 database tag includes the following child elements:

Table 3-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).

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.

RefConnectionPools

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 VOs.

Syntax

<Database …
     type=""
     dbFlag=""
     containerRef=""
     persistConnectionPoolRef="">
   <Description />
   <Features>
     <Feature name="" value=""/>
     <Feature name="" value=""/>
     ...
   </Features>
   <RefConnectionPools>
     <RefConnectionPool connectionPoolRef="" …/>
     <RefConnectionPool connectionPoolRef="" …/>
   </RefConnectionPools>
   <RefDisplayFolders>
     <RefPhysicalDisplayFolder physicalDisplayFolderRef="" …/>
     <RefPhysicalDisplayFolder physicalDisplayFolderRef="" …/>
   </RefDisplayFolders>
   <Properties>
     <PropertyGroup>
       category=""
       <Property>
          <Name …/>
          <Value …/>
       </Property>
     </Property Group>
   </Properties>
</Database>

Example

<Database mdsid="m80c882ea-0bcf-0000-714b-e31d00000000"
   name="Loyalty Input Data Source"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://www.oracle.com/obis/repository"
   type="ODBC200">
   <Feature name="LEFT_OUTER_JOIN_SUPPORTED" value="true" />
   <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="true" />
   <Feature name="COUNT_DISTINCT_SUPPORTED" value="true" />
...
   <Feature name="SORT_ORDER_LOCALE" value="english-usa" />
   <Feature name="COMMENT_START" />
   <Feature name="COMMENT_END" />
   <RefConnectionPools>
     <RefConnectionPool refId="m80c882ea-0bcf-0000-714b-e31d00000000-m80c882ec-
        0bd5-0000-714b-e31d00000000"
       connectionPoolRef="/oracle/bi/server/base/ConnectionPool/Loyalty Input
        Connection Pool_80c882ec-0bd5-0000-714b-e31d00000000.xml#m80c882ec-0bd5-
        0000-714b-e31d00000000" />
   </RefConnectionPools>
</Database>

3.2 MDS 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 attributes:

Table 3-3 Physical Catalog Tag Attributes

Attribute Name
Description

containerRef

References the database for this physical catalog.

dynamicNameRef

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

Syntax

<PhysicalCatalog …
   containerRef=""
   dynamicNameRef="">
   <Description />
</PhysicalCatalog>

Example

<PhysicalCatalog mdsid="m00238422-0bd1-0000-714b-e31d00000000"
   name="Catalog"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://www.oracle.com/obis/repository"
   containerRef="/oracle/bi/server/base/Database/Forecasting Oracle Data Warehouse
    _00238415-0bcf-0000-714b-e31d00000000.xml#m00238415-0bcf-0000-714b-
    e31d00000000">
</PhysicalCatalog>

3.3 MDS 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 attributes:

Table 3-4 Physical Catalog Tag Attributes

Attribute Name
Description

containerRef

References the database for this physical schema.

dynamicNameRef

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

Syntax

<Schema …>
   containerRef=""
   dynamicNameRef="">
   <Description />
</Schema>

Example

<Schema mdsid="m80d02084-0bd3-0000-714b-e31d00000000"
   name="RTDUSER"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://www.oracle.com/obis/repository"
   containerRef="/oracle/bi/server/base/Database/RTD Reporting Database_80d02083-
    0bcf-0000-714b-e31d00000000.xml#m80d02083-0bcf-0000-714b-e31d00000000">
</Schema>

3.4 MDS 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 attributes:

Table 3-5 Physical Display Folder Tag Attributes

Attribute Name
Description

databaseRef

References the database for this physical display folder.

The physical display folder tag includes the following child elements:

Table 3-6 Physical Display Folder Child Elements

Element Name
Description

RefTables

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

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

Syntax

<PhysicalDispFolder … >
   databaseRef=""
   <Description />
   <RefTables>
     <RefPhysicalTable tableRef="" …/>
     <RefPhysicalTable tableRef="" …/>
   </RefTables>
</Schema>

Example

<PhysicalDisplayFolder mdsid="me40757e1-0bf1-1000-b290-0ae593200000"
   name="Opaque Views"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://www.oracle.com/obis/repository"
   databaseRef="/oracle/bi/server/base/Database/SQLDB_Northwind_e4070ae5-0bf1-
    1000-b290-0ae593200000.xml#me4070ae5-0bf1-1000-b290-0ae593200000">
   <RefTables>
     <RefPhysicalTable refId="me40757e1-0bf1-1000-b290-0ae593200000-me4072f9e-
        0bf1-1000-b290-0ae593200000"
       tableRef="/oracle/bi/server/base/PhysicalTable/Employees_Country_e4072f9e-
        0bf1-1000-b290-0ae593200000.xml#me4072f9e-0bf1-1000-b290-0ae593200000" />
     <RefPhysicalTable refId="me40757e1-0bf1-1000-b290-0ae593200000-me4072fc7-
        0bf1-1000-b290-0ae593200000"
       tableRef="/oracle/bi/server/base/PhysicalTable/Population_e4072fc7-0bf1-
        1000-b290-0ae593200000.xml#me4072fc7-0bf1-1000-b290-0ae593200000" />
     <RefPhysicalTable refId="me40757e1-0bf1-1000-b290-0ae593200000-me4072fcc-
        0bf1-1000-b290-0ae593200000"
       tableRef="/oracle/bi/server/base/PhysicalTable/Quarter_e4072fcc-0bf1-1000-
        b290-0ae593200000.xml#me4072fcc-0bf1-1000-b290-0ae593200000" />
     <RefPhysicalTable refId="me40757e1-0bf1-1000-b290-0ae593200000-me4072fa0-
        0bf1-1000-b290-0ae593200000"
       tableRef="/oracle/bi/server/base/PhysicalTable/Year_e4072fa0-0bf1-1000-
        b290-0ae593200000.xml#me4072fa0-0bf1-1000-b290-0ae593200000" />
   </RefTables>
</PhysicalDisplayFolder>

3.5 MDS 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 3-7 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.

containerRef

References the database, schema, or physical catalog for this physical table.

aggrConnPoolRef

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

sourceTableRef

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

variableRef

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

memberKeyRef

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.

parentKeyRef

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.

distanceColumnRef

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.

leafColumnRef

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 physical table tag includes the following child elements:

Table 3-8 Physical Table Child Elements

Element Name
Description

DBMapItem

Stores the value of database-specific strings. The <DBMapItem> element contains a <name> attribute and a <Value> sub-element.

PhysicalColumn

Specifies the physical column that belongs to this physical table. For details, see Section 3.6, "MDS XML Elements: Physical Column."

PhysicalKey

References the physical columns in this physical table that make up the physical key.

Each physical column is referenced in a sub-element called RefColumns. For details, see Section 3.8, "MDS XML Elements: Physical Key."

PhysicalForeignKey

References the physical key in an external physical table and the physical columns in this physical table that together make up the physical foreign key.

Each physical column is referenced in a sub-element called RefColumns.

For details, see Section 3.9, "MDS XML Elements: Physical Foreign Key.".

Syntax

The syntax here includes summary child element entries for the physical column, physical key, and physical foreign key elements. The full syntax for each child element appears in the appropriate section listed in the following table:

Table 3-9 References to Child Elements of Physical Table Element

Child Element Entry
Section Containing Child Element Syntax

PhysicalColumn

MDS XML Elements: Physical Column

PhysicalKey

MDS XML Elements: Physical Key

PhysicalForeignKey

MDS XML Elements: Physical Foreign Key

<PhysicalTable …
     type=""
     isCacheable=""
     cacheExpiry=""
     isCacheEventTable=""
     isOverrideCacheProp=""
     pollFreq=""
     x=""
     y=""
     rowCount=""
     lastUpdated=""
     uri=""
     xslPath=""
     maxConn=""
     xmlRefreshInterval=""
     scriptPath=""
     hints=""
     isExtGatewayInProcess=""
     extGatewayDelimiter=""
     isSysGen=""
     isDDLAggr=""
     containerRef=""
     aggrConnPoolRef=""
     sourceTableRef=""
     variableRef=""
     memberKeyRef=""
     parentKeyRef=""
     distanceColumnRef=""
     leafColumnRef="">
   <Description />
   <DBMapItem name="">
      <Value …/>
   </DBMapItem>
   <PhysicalColumn />
   <PhysicalKey />
   <PhysicalForeignKey />
</PhysicalTable>

Example

<PhysicalTable mdsid="m00226232-0bb9-0000-714b-e31d00000000"
   name="CONTACTS_PRODUCTS_NOT_ORDERED"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://www.oracle.com/obis/repository"
   type="select"
   x="625"
   y="376"
   maxConn="0"
   containerRef="/oracle/bi/server/base/Schema/dbo_00238426-0bd3-0000-714b-
    e31d00000000.xml#m00238426-0bd3-0000-714b-e31d00000000">
   <DBMapItem name="SQLServer70">
     <Value>

4 MDS XML Presentation Elements

Presentation elements are typically those elements that are exposed in the Presentation layer, or in other words, the elements that appear in the left-hand pane of the Administration Tool.

This chapter contains the following topics:

Section 4.1, "MDS XML Elements: Presentation Catalog"

Section 4.2, "MDS XML Elements: Presentation Table"

Section 4.3, "MDS XML Elements: Presentation Column"

Section 4.4, "MDS XML Elements: Presentation Hierarchy"

Section 4.5, "MDS XML Elements: Presentation Level"

4.1 MDS XML Elements: Presentation Catalog

The presentation catalog element corresponds to the subject area object in the Presentation layer.

The presentation catalog tag includes the following attributes:

Table 4-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.

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.

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.

containerRef

References the container for this presentation catalog.

subjectAreaRef

References the business model for this subject area.

defaultFactColRef

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 presentation catalog tag includes the following child elements:

Table 4-2 Presentation Catalog Child Elements

Element Name
Description

Alias

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 has an attribute called name.

RefTables

References the presentation tables that belong to this subject area.

Each presentation table is contained in a sub-element called RefPresentationTable.

Syntax

<PresentationCatalog …
     isExportKeys=""
     isAutoAggr=""
     hasDispName=""
     dispName=""
     hasDispDescription=""
     dispDescription""
     containerRef=""
     subjectAreaRef=""
     defaultFactColumnRef="">
   <Description />
   <Alias name=""/>
   <RefTables>
     <RefPresentationTable presentationTableRef="" …/>
     <RefPresentationTable presentationTableRef="" …/>
   </RefTables>
</PresentationCatalog>

Example

<PresentationCatalog mdsid="m80d0301d-0fa4-0000-714b-e31d00000000"
   name="Inventory Org Real Time"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://www.oracle.com/obis/repository"
   hasDispName="false"
   hasDispDescription="false"
   subjectAreaRef="/oracle/bi/server/base/BusinessModel/Core_0021f84a-07d0-0000-
    714b-e31d00000000.xml#m0021f84a-07d0-0000-714b-e31d00000000"
   defaultFactColumnRef="/oracle/bi/server/base/LogicalTable/Fact _u0150 InvOrg _u
    0150 Dummy Fact for dimension browsing_80d55585-07f3-0000-714b-e31d00000000.
    xml#m80d5558b-07d6-0000-714b-e31d00000000">
   <Description>

5 MDS XML Marketing, Security, and Other Elements

This chapter describes the MDS XML API elements for Oracle Marketing Segmentation objects, security objects, and miscellaneous objects that do not fall in other categories.

This chapter contains the following topics:

Section 5.1, "MDS XML Marketing Elements"

Section 5.2, "MDS XML Security Elements"

Section 5.3, "Other MDS XML Elements"

5.1 MDS XML Marketing Elements

Marketing elements are typically those elements that are related to features for the Oracle Marketing Segmentation product. For information about features and options related to Oracle Marketing Segmentation, see the administrator documentation for the Oracle Marketing Segmentation application.

Marketing elements include:

Section 5.1.1, "MDS XML Elements: Catalog Link"

Section 5.1.2, "MDS XML Elements: Target Level"

Section 5.1.3, "MDS XML Elements: List Catalog"

Section 5.1.4, "MDS XML Elements: Qualified List Item"

Section 5.1.5, "MDS XML Elements: Qualifying Key"

Section 5.1.6, "MDS XML Elements: Sampling Table"

Section 5.1.7, "MDS XML Elements: Seg Catalog"

5.1.1 MDS XML Elements: Catalog Link

The catalog link element corresponds to the conforming dimension link object in the Marketing metadata. A conforming dimension links a fact that contains target-level IDs to a fact that does not contain target-level IDs by navigating along a dimension that is shared by both fact tables.

The catalog link tag includes the following attributes:

Table 5-1 Catalog Link Tag Attributes

Attribute Name
Description

inColumnRef

References the presentation column that represents the primary key of the subject area from which the dimension link originates.

outColumnRef

References the presentation column that represents the primary key of the subject area to which the dimension link points.

Syntax

<CatalogLink …
     inColumnRef=""
     outColumnRef="">
   <Description />
</CatalogLink>

Example

<CatalogLink mdsid="m8033142f-0fac-0000-714b-e31d00000000"
   name="Customer Profile->Opportunity Contact"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://www.oracle.com/obis/repository"
   inColumnRef="/oracle/bi/server/base/PresentationTable/_u0150 Contact Profile_80
    2b468d-0fa8-0000-714b-e31d00000000.xml#m80312fa3-0faa-0000-714b-e31d00000000"
   outColumnRef="/oracle/bi/server/base/PresentationTable/_u0150 Contact Profile_
    80330ba0-0fa8-0000-714b-e31d00000000.xml#m80330b9e-0faa-0000-714b-e31d00000000
    ">
   <Description>

Part II

XML Schema Elements

Part II provides usage and reference information for the Oracle BI Server XML API.

Part II contains the following chapters:

Chapter 6, "About the Oracle BI Server XML API"

Chapter 7, "XML Logical Elements"

Chapter 8, "XML Physical Elements"

Chapter 9, "XML Presentation Elements"

Chapter 10, "XML Marketing, Security, and Other Elements"

6 About the Oracle BI Server XML API

Oracle Business Intelligence provides utilities to create a generic, XML-based representation of the Oracle BI repository metadata, using the Oracle BI Server XML API. This XML file version of the repository can be used to programmatically modify the metadata. The Oracle BI Server XML API can be used for metadata migration, programmatic metadata generation and manipulation, metadata patching, and other functions.

Note that Oracle BI Server XML API objects correspond to metadata repository objects in an RPD file. These objects are not the same as Oracle BI Presentation Catalog XML objects.

This chapter contains the following topics:

Section 6.1, "About the Oracle BI Server XML API"

Section 6.2, "Generating and Executing XML"

Section 6.3, "Using the Oracle BI Server XML API"

Section 6.4, "Generic XML Elements and Attributes"

6.1 About the Oracle BI Server XML API

The Oracle BI Server XML schema document (xudml1.xsd) contains the grammar for the structure of XML repository files. You can find this file at:

ORACLE_HOME/bifoundation/server/bin

Note that this is not the file that enables the generation of MDS XML output. For information about generating MDS XML output, see Chapter 1, "About the Oracle BI Server MDS XML API."

You can view this file to see relationships between XML metadata objects, but you must not modify this file. Doing so can lead to errors and crashes in the biserverxmlexec utility.

The structure of the repository is primarily a flat list of objects, in the format:

<?xml version="1.0" encoding="iso-8859-1"?>
<Repository xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DECLARE>
    <ObjectType {attributes}>
      Contents…
    </ObjectType>
    <ObjectType {attributes}>
      Contents…
    </ObjectType>
    …
  </DECLARE>
</Repository>

Most of the modeling relationships, including the hierarchical ones, are formed using name references between objects, not by the hierarchical structure of the XML.

Note that the metadata objects in the XML file must appear in a particular order. You can view the set order in the XML schema document under the objectList_t element.

6.1.1 About Using the Oracle BI Server XML API to Merge and Append Objects

Do not use the Oracle BI Server XML API to attempt a full repository merge. The merge feature in the Administration Tool handles an extremely complex set of object comparisons and decisions, and it is not possible to account for and resolve these conflicts using the XML utilities. Because of this, using the XML API to perform a full merge is not supported. Attempting to do so might result in a corrupted repository.

However, you can use the XML API to append objects from one repository to another repository, using the -B option with biserverxmlexec to specify a base repository path name. This approach works when you have two completely separate repositories with no shared objects between the two, including no shared variables or application roles. For example, if you have separate repositories for the Credit and Manufacturing departments, you can take objects from the Credit XML metadata and append them to the Manufacturing XML metadata, and then convert to a single RPD that contains both working models. Using this method, you are essentially adding one repository to another.

Before attempting to perform an append operation, you should create a script to ensure that there are no common objects. Even when your repositories are separate, they might contain the same names for common objects, such as a current_date variable.

It is also a good idea to equalize the upgrade IDs to ensure that there are no accidental clashes. Equalizing objects causes objects in two repositories that have the same name but different upgrade ids to be treated as the same object. See "Equalizing Objects" in Oracle Fusion Middleware Metadata Repository Builder's Guide for Oracle Business Intelligence Enterprise Edition for more information.

6.2 Generating and Executing XML

Oracle Business Intelligence provides the following command-line tools to generate and execute XML:

biserverxmlgen generates XML from an existing RPD

biserverxmlexec lets you execute the XML in offline mode to create or modify a repository file

biserverxmlcli executes the XML against the Oracle BI Server

Before running the XML utilities, you must first run bi-init to launch a command prompt or shell window that is initialized to your Oracle instance. This utility is called bi-init.sh on Linux and UNIX systems, bi-init.bat on client installations of the Administration Tool, and bi-init.cmd for all other Windows installation types.

For example, on Windows:

In Windows Explorer, go to the location appropriate for your install type:

Client installations:

ORACLE_HOME/bifoundation/server/bin

All other installations:

ORACLE_INSTANCE/bifoundation/OracleBIApplication/coreapplication/setup

Double-click bi-init.cmd (or bi-init.bat for client installations) to display a command prompt that is initialized to your Oracle instance.

At the command prompt, type biserverxmlgen, biserverxmlexec, or biserverxmlcli with the desired options. You can also run the utilities with no arguments or parameters to see usage information.

Note that when you execute XML to update an existing repository with new content, objects are replaced in their entirety. For example, to change the name attribute of a PresentationTable object from name="Facts Revenue" to name="Facts Financial," you must submit the entire PresentationTable object to biserverxmlexec or biserverxmlcli.

In addition, make sure that the qualified name, UID, and ID are correct when replacing existing objects. The Oracle BI Server assumes that a different ID is a different object.

This section contains the following topics:

Section 6.2.1, "Generating XML from an Existing RPD"

Section 6.2.2, "Executing XML in Offline Mode"

Section 6.2.3, "Executing XML Against the Oracle BI Server"

6.2.1 Generating XML from an Existing RPD

Use biserverxmlgen to generate an XML file from an existing repository file (RPD). To use this utility, execute the following at the command prompt:

biserverxmlgen -R repository_pathname [-P password] -O output_file_pathname [-8] [-N] [-Q|-S]

Where:

repository_pathname is the name and location of the repository file from which you want to generate XML

password is the repository password.

The password argument is optional. If you do not provide a password argument, you are prompted to enter a password when you run the command. To minimize the risk of security breaches, Oracle recommends that you do not provide a password argument either on the command line or in scripts. Note that the password argument is supported for backward compatibility only, and will be removed in a future release.

output_file_pathname is the name and location of the XML output file you want to generate. It is recommended that you provide an output filename with an .xml extension.

Specify -8 to use UTF-8 encoding in the generated XML file. If you do not specify -8, the generated XML file uses ANSI ISO-8859-1 encoding by default.

Specify -N to generate output without upgrade ids (uids). These are the internal identifiers of objects. Use this if you want to create a new repository without the old upgrade ids.

You can use one of the two options -Q and -S to control the generation of security objects:

Use -Q to generate output without security objects

Use -S to generate output for only security objects

If you use both -Q and -S on the same call of biserverxmlgen, the second option on the call command takes precedence, and the first is ignored.

6.2.2 Executing XML in Offline Mode

Use biserverxmlexec to execute XML in offline mode. This utility can generate an entire repository file (RPD) from an XML repository file, or it can modify an existing repository file by applying the changes specified in the XML file. The input XML is validated against the Oracle BI Server XML schema. Any objects that exist in both the RPD and the XML file are overwritten by the corresponding object definitions in the XML file. Note that the same object cannot be defined twice in the XML file.

A qualified name (qualifiedName) or upgrade id (uid) must be specified for each object. When the utility resolves and identifies objects, uids have the highest priority, followed by qualifiedNames. See Section 6.4, "Generic XML Elements and Attributes" for more information about identifier attributes.

To use this utility, execute the following at the command prompt:

biserverxmlexec -I input_file_pathname [-B base_repository_pathname] [-P password]
-O output_repository_pathname

Where:

input_file_pathname is the name and location of the XML input file you want to execute

base_repository_pathname is the existing repository file you want to modify using the XML input file (optional). Do not specify this argument if you want to generate a new repository file from the XML input file.

password is the repository password. If you specified a base repository, enter the repository password for the base repository. If you did not specify a base repository, enter the password you want to use for the new repository.

The password argument is optional. If you do not provide a password argument, you are prompted to enter a password when you run the command. To minimize the risk of security breaches, Oracle recommends that you do not provide a password argument either on the command line or in scripts. Note that the password argument is supported for backward compatibility only, and will be removed in a future release.

output_repository_pathname is the name and location of the RPD output file you want to generate

Examples

The following example creates a new repository called rp1:

biserverxmlexec -I testxudml.txt -O rp1.rpd
Give password: my_rpd_password

The following example modifies rp1 and writes to rp2:

biserverxmlexec -I testxudml.txt -B rp1.rpd -O rp2.rpd
Give password: my_rpd_password

6.2.3 Executing XML Against the Oracle BI Server

Use biserverxmlcli to execute XML against the Oracle BI Server. This utility is very similar to biserverxmlexec, but is instead used to modify an online repository. An online repository is a running Oracle BI Server instance that has loaded an existing repository into its navigation space.

To use this utility, execute the following at the command prompt:

biserverxmlcli -U user_name [-P user_password] [-R repository_password]
-D data_source_name [-w ssl_pass_phrase |-y] -I XML_file_pathname

Where:

user_name is a valid user name. This user must have the manage repository permission (oracle.bi.server.manageRepositories).

user_password is the corresponding user password.

The user password argument is optional. If you do not provide a user password argument, you are prompted to enter a user password when you run the command. To minimize the risk of security breaches, Oracle recommends that you do not provide password arguments either on the command line or in scripts. Note that the user password argument is supported for backward compatibility only, and will be removed in a future release.

repository_password is the repository password for the online repository.

The repository password argument is optional. If you do not provide a repository password argument, you are prompted to enter a repository password when you run the command. To minimize the risk of security breaches, Oracle recommends that you do not provide password arguments either on the command line or in scripts. Note that the repository password argument is supported for backward compatibility only, and will be removed in a future release.

data_source_name is the Oracle BI Server ODBC data source name (DSN) to which you want to connect

ssl_pass_phrase is the SSL passphrase for the Oracle BI Server, if the ODBC connection has been configured to use SSL

-y is the SSL passphrase to the private key file

xml_file_pathname is the name and location of the XML input file you want to execute

6.3 Using the Oracle BI Server XML API

This section provides information about different use cases for the Oracle BI Server XML API feature. This section contains the following topics:

Section 6.3.1, "Maintaining Versions of the Metadata"

Section 6.3.2, "Migrating Metadata from Another System"

Section 6.3.3, "Applying a Metadata Patch Against a Running Oracle BI Server"

Section 6.3.4, "Manipulating Metadata Programmatically"

Section 6.3.5, "Moving from Test to Production Environments"

6.3.1 Maintaining Versions of the Metadata

The Oracle BI Server XML API provides an efficient way of keeping versions of an RPD. Rather than storing entire RPD files for each version, you can generate XML patch files using the Create Patch feature in the Compare dialog in the Administration Tool. The patch file contains only the delta of the changes between the current and original versions. Using patch files to store changes eliminates the need to store redundant data in entire repository files and saves disk space. Note that you always need to retain a copy of the original repository file to maintain versions using this method.

You can apply a patch to the original file using the patch merge feature in the Administration Tool, using the patchrpd utility, or by running biserverxmlexec with the -B option.

For example, if you have repository versions A0, A1, and A2, and you have an XML patch file called A2-0delta.xml that contains the changes between the latest and original versions, you can run the following command:

biserverxmlexec -I A2-0delta.xml -B A0.rpd -O A2reproduced.rpd
Give password: my_password

Alternatively, if you stored changes between A0 and A1, and then A1 and A2, you can run two commands to apply the latest changes on the original file:

biserverxmlexec -I A1-0delta.xml -B A0.rpd -O A1reproduced.rpd
Give password: my_password

biserverxmlexec -I A2-1delta.xml -B A1reproduced.rpd -O A2reproduced.rpd
Give password: my_password

Make sure to specify different names for the -B and -O arguments to avoid overwriting the original repository file.

See Oracle Fusion Middleware Metadata Repository Builder's Guide for Oracle Business Intelligence Enterprise Edition for more information about patch merges.

6.3.2 Migrating Metadata from Another System

If you have another business intelligence or reporting system and want to migrate the metadata to Oracle Business Intelligence, you can write an adapter to transform the third-party metadata to the Oracle Business Intelligence generic XML format. The XML schema file (xudml1.xsd) provides a way to understand the structure of the Oracle Business Intelligence metadata. After you have a compatible XML metadata file, you can use the biserverxmlexec utility to create a corresponding RPD file.

6.3.3 Applying a Metadata Patch Against a Running Oracle BI Server

If you use the Administration Tool to make changes to your repository in offline mode, you can use the XML patch feature to apply the changes to an online repository, without needing to restart the server or apply the changes manually.

To do this, open the new version of the repository in the Administration Tool, compare it with the running version, and create an XML patch file using the Create Patch feature. You can then apply the patch against the running Oracle BI Server to load the changes, using the biserverxmlcli utility. For example:

biserverxmlcli -U my_user -D my_server_dsn -I my_xml_file_pathname
Give user password: my_password
Give repository password: my_repos_password

6.3.4 Manipulating Metadata Programmatically

You can use the Oracle BI Server XML API to develop custom applications to modify Oracle BI repository metadata. To do this, you can generate XML from your RPD file using the biserverxmlgen utility, and then parse the XML using a generic XML parser. Because the Oracle BI XML utilities are command-line utilities, they can be invoked from batch files, scripts, or as processes from within the code. You can modify the XML programmatically, and then use the biserverxmlexec utility to generate a new RPD that includes the changes.

For example, the Cloning Application Framework (CAF) uses the Oracle BI Server XML API to replicate content developed for one application so that it can be used by another application. The goal of the CAF application is to reuse content across applications so that it does not need to be developed twice.

CAF users can map Presentation layer objects and logical dimension hierarchies from one RPD to the corresponding names in the other RPD. The CAF application generates XML for the first RPD using the biserverxmlgen utility, then scans the XML to determine the Presentation layer object dependencies in the Business Model and Mapping layer and Physical layer. It then creates the necessary Presentation and Business Model and Mapping layer objects (such as columns, subject areas, and expressions), identical to objects in the first RPD but with the appropriate mapped names. When the corresponding XML is ready, it generates the cloned RPD using the biserverxmlexec utility.

6.3.4.1 Example of Programmatically Creating a Repository Object Using XML

This example shows how to add a presentation column called "Billed Qty" to the "Facts Revenue" presentation table of the "Sample Small" subject area. The logical column in the business model on which it is based already exists, and has the name "Sample Small"."F0 Rev Base Measures"."2-01 Billed Qty (Sum All)".

Figure 6-1 illustrates the goal of the example.

Figure 6-1 Logical Column Exists in Repository with No Corresponding Presentation Column

To add the presentation column programmatically, two metadata changes are needed:

A <PresentationColumn> object must be created for the new "Billed Qty" presentation column. It must reference the "2-01 Bill Qty (Sum All)" logical column to which it maps, and the Facts Revenue presentation table to which it belongs.

The <PresentationTable name="Facts Revenue"> object must be updated to reference the new "Billed Qty" presentation column object.

Figure 6-2 shows a view of what the new presentation column looks like in the Administration Tool after it is created.

Figure 6-2 Administration Tool Equivalent for New Presentation Column

To update the metadata, first create an XML file called Change.rpdx. This file will contain the metadata changes needed, in XML format. Add the following code:

<?xml version="1.0" encoding="iso-8859-1"?>
<Repository xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DECLARE>
    <PresentationColumn name="Billed Qty" parentName="&quot;Sample Small&quot;..
    &quot;Facts Revenue&quot;" parentId="4008:2143"
    parentUid="80cab573-07d0-0000-714b-e31d00000000"
    hasDispName="false"
    overrideLogicalName="true">
      <Description>

7 XML Logical Elements

Logical elements are typically those elements that are exposed in the Business Model and Mapping layer, or in other words, the elements that appear in the center pane of the Administration Tool.

This chapter contains the following topics:

Section 7.1, "XML Elements: Logical Column"

Section 7.2, "XML Elements: Business Model"

Section 7.3, "XML Elements: Logical Complex Join"

Section 7.4, "XML Elements: Logical Level"

Section 7.5, "XML Elements: Dimension"

Section 7.6, "XML Elements: Logical Table"

Section 7.7, "XML Elements: Logical Foreign Key"

Section 7.8, "XML Elements: Logical Key"

Section 7.9, "XML Elements: Logical Table Source"

Section 7.10, "XML Elements: Logical Source Folder"

Section 7.11, "XML Elements: Measure Definition"

Section 7.12, "XML Elements: Aggregation Rule"

Section 7.13, "XML Elements: Override Aggregation Rule"

Section 7.14, "XML Elements: Logical Display Folder"

7.1 XML Elements: Logical Column

The logical column element corresponds to the logical column object in the Business Model and Mapping layer.

The logical column tag includes the following attributes:

Table 7-1 Logical Column Tag Attributes

Attribute Name
Description

isDerived

When set to true, indicates that the logical column is based on a user-defined expression (for example, another logical column, a constant value, or a variable).

IsWriteable

When set to true, indicates that write back has been enabled for this column. This feature is typically used with ADF Business Component data sources. This option is called Writeable in the Administration Tool.

The logical column tag includes the following child elements:

Table 7-2 Logical Column Child Elements

Element Name
Description

Expr

Contains the expression from which the logical column should be derived. This element is only used when the isDerived attribute is set to true.

CustomSortOrder

If the sort order for this logical column is based on a different logical column, this element references that logical column.

The logical column upon which the sort order is based is contained in a sub-element called RefLogicalColumn.

DescriptorID

When multilingual columns are based on a lookup function, it is common to specify the non-translated lookup key column as the descriptor ID column of the translated column. This element references the descriptor ID column.

The descriptor ID logical column is contained in a sub-element called RefLogicalColumn.

Levels

For dimension columns, shows the level to which this column has been assigned. For level-based measures, shows the level at which the column has been explicitly fixed.

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

Syntax

<LogicalColumn …
     isDerived=""
     isWriteable="">
   <Description />
   <Expr>...</Expr>
   <CustomSortOrder>
     <RefLogicalColumn …/>
   </CustomSortOrder>
   <DescriptorID>
     <RefLogicalColumn …/>
   </DescriptorID>
   <Levels>
     <RefLogicalLevel …/>
   </Levels>
</LogicalColumn>

Example

<LogicalColumn name="Person ID"
     parentName="&quot;8 - Fusion Order Demo (OLTP)&quot;.&quot;
      D01 Customers&quot;"
     parentId="2035:61791" parentUid="80cbbddc-07f3-0000-714b-e31d00000000"
     id="2006:61814" uid="80cbbe7b-07d6-0000-714b-e31d00000000"
     isWriteable="false">
   <Levels>
     <RefLogicalLevel id="2025:63664"
      uid="80cbc70a-07e9-0000-714b-e31d00000000"
      qualifiedName="&quot;8 - Fusion Order Demo (OLTP)&quot;
       .&quot;H01 Customers&quot;.&quot;Customer ID&quot;"/>
   </Levels>
</LogicalColumn>

7.2 XML Elements: Business Model

The business model element corresponds to the business model object in the Business Model and Mapping layer.

The business model tag includes the following attributes:

Table 7-3 Subject Area Tag Attributes

Attribute Name
Description

isClassicStar

If set to true, indicates that the business model follows a star schema. Star schemas have one-to-many relationships between the logical dimension tables and the logical fact table.

isAvailable

If set to true, indicates that the corresponding subject area is available for queries.

The business model tag includes the following child elements:

Table 7-4 Subject Area Child Elements

Element Name
Description

Tables

References the logical tables that belong to this business model.

Each logical table is contained in a sub-element called RefLogicalTable.

DisplayFolders

References the display folders that belong to this business model.

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

Syntax

<BusinessModel …
     isClassicStar=""
     isAvailable="">
   <Description />
   <Tables>
     <RefLogicalTable …/>
     <RefLogicalTable …/>
   </Tables>
   <DisplayFolders>
     <RefLogicalDisplayFolder …/>
     <RefLogicalDisplayFolder …/>
   </DisplayFolders>
</BusinessModel>

Example

<BusinessModel name="9 - Usage Tracking"
     id="2000:22314" uid="802b289f-07d0-0000-714b-e31d00000000"
     isClassicStar="false" isAvailable="true">
</BusinessModel>

7.3 XML Elements: Logical Complex Join

The logical complex join element corresponds to the logical join object in the Business Model and Mapping Layer.

The logical complex join tag includes the following attributes:

Table 7-5 Logical Complex Join Tag Attributes

Attribute Name
Description

type

The type of join. Valid values are Inner, LeftOuter, RightOuter, FullOuter, and FullOuterStitch.

The logical complex join tag includes the following child elements:

Table 7-6 Logical Complex Join Child Elements

Element Name
Description

Roles

Roles define how a logical table or a logical level contributes to the join.

Each role is contained in a sub-element called Role. The role sub-element has two attributes:

multiplicity indicates the multiplicity of the table or level in the join. Valid values are ([0-9])* TO ([0-9])*, ZERO TO ONE, ZERO TO MANY, ONE TO ONE, ONE TO MANY, and UNKNOWN.

isAggregate indicates whether the table or level is an aggregate.

Each Role sub-element can contain two additional sub-elements: RefLogicalTable, which references the logical tables in the join, and RefLogicalLevel, which references the logical levels in the join.

See the syntax for the logical complex join element to see the complete hierarchy for the roles child element.

DrivingTable

If a driving table has been specified for the key, this element references that logical table.

The driving table is contained in a sub-element called RefLogicalTable.

Syntax

<LogicalComplexJoin …
     type="">
   <Description />
   <Roles>
     <Role multiplicity="" isAggregate="">
       <RefLogicalTable …/>
       <RefLogicalLevel …/>
     </Role>
   </Roles>
   <DrivingTable>
     <RefLogicalTable …/>
   </DrivingTable>
</LogicalComplexJoin>

Example

<LogicalComplexJoin name="Relationship_2004:617171273059824"
     id="2004:61717" uid="80cbbf09-07d4-0000-714b-e31d00000000"
     type="Inner">
   <Roles>
     <Role multiplicity="n..n" isAggregate="false">
       <RefLogicalTable id="2035:61664"
        uid="80cbbdd9-07f3-0000-714b-e31d00000000"
        qualifiedName="&quot;8 - Fusion Order Demo (OLTP)&quot;.&quot;
         F1 Order Facts&quot;"/>
     </Role>
     <Role multiplicity="0..1" isAggregate="false">
       <RefLogicalTable id="2035:61573"
        uid="80cbbdd5-07f3-0000-714b-e31d00000000"
        qualifiedName="&quot;8 - Fusion Order Demo (OLTP)&quot;.&quot;
         D11 Discounts and Coupons&quot;"/>
     </Role>
   </Roles>
</LogicalComplexJoin>

7.4 XML Elements: Logical Level

The logical level element corresponds to the logical level object contained in the dimensions in the Business Model and Mapping layer.

The logical level tag includes the following attributes:

Table 7-7 Logical Level Tag Attributes

Attribute Name
Description

isUniqueSourceKey

If set to true, indicates that this level is associated with the logical column or columns that comprise the logical key of the dimension table (or in other words, that this level is the lowest level of the dimension).

isGTA

If set to true, indicates that this level is the Grand Total level, which is a special level representing the grand total for a dimension. Each dimension can have just one Grand Total level. A grand total level does not contain dimensional attributes and does not have a level key.

Note: GTA stands for Grand Total Alias.

isFDUC

If set to true, indicates that the logical level rolls up to its parent. This option is called Supports rollup to higher level of aggregation in the Administration Tool.

Note: FDUC stands for FullDrillUpCoverage.

levelConst

The star schema level constant.

memberCount

The number of elements that exist at this logical level.

The logical level tag includes the following child elements:

Table 7-8 Logical Level Child Elements

Element Name
Description

ChildLevels

References the child levels that have been defined for this logical level.

Each child level is contained in a sub-element called RefLogicalLevel.

PreferredDrillDown

If a drill path has been defined that is outside the normal drill path defined by the dimension level hierarchy, this element references the level to which users should drill.

The preferred drill level is contained in a sub-element called RefLogicalLevel.

ParentKey

References the parent key for this level (for dimensions with parent-child hierarchies only).

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

Syntax

<LogicalLevel …
     isUniqueSourceKey=""
     isGTA=""
     isFDUC=""
     levelConst=""
     memberCount="">
   <Description />
   <ChildLevels>
     <RefLogicalLevel …/>
     <RefLogicalLevel …/>
   </ChildLevels>
   <PreferredDrillDown>
     <RefLogicalLevel …/>
   </PreferredDrillDown>
   <ParentKey>
     <RefLogicalLevel …/>
   </ParentKey>
</LogicalLevel>

Example

<LogicalLevel name="City"
     parentName="&quot;8 - Fusion Order Demo (OLTP)&quot;.&quot;
      H02 Cust Primary Addresses&quot;"
     parentId="2019:63679" parentUid="80cbc715-07e3-0000-714b-e31d00000000"
     id="2025:63890" uid="80cbc796-07e9-0000-714b-e31d00000000"
     isGTA="false" isFDUC="true" memberCount="1" levelConst="&apos;City&apos;">
   <ChildLevels>
     <RefLogicalLevel id="2025:63894"
      uid="80cbc798-07e9-0000-714b-e31d00000000"
      qualifiedName="&quot;8 - Fusion Order Demo (OLTP)&quot;.&quot;
       H02 Cust Primary Addresses&quot;.&quot;Cust Address&quot;"/>
   </ChildLevels>
</LogicalLevel>

7.5 XML Elements: Dimension

The dimension element corresponds to the dimension object in the Business Model and Mapping layer.

The dimension tag includes the following attributes:

Table 7-9 Dimension Tag Attributes

Attribute Name
Description

isTimeDim

If set to true, indicates that this 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.

isValueBased

If set to true, indicates that this object is a dimension with parent-child hierarchies. A parent-child hierarchy is a hierarchy of members that all have the same type. In a parent-child hierarchy, the inter-member relationships are parent-child relationships between dimension members.

The dimension tag includes the following child elements:

Table 7-10 Dimension Child Elements

Element Name
Description

RootLevels

References the root level or levels of this dimension. Root levels are levels in the hierarchy that do not have any levels above them. In the Administration Tool, root levels appear directly below the dimension icon.

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

DefaultRootLevel

References the default root level of this dimension. When there are many root levels in a dimension, the default root level is the one that is used for drilldown.

The default root level is contained in a sub-element called RefLogicalLevel.

Syntax

<Dimension …
     isTimeDim=""
     isRagged=""
     isSkipped=""
     isValueBased="">
   <Description />
   <RootLevels>
     <RefLogicalLevel …/>
     <RefLogicalLevel …/>
   </RootLevels>
   <DefaultRootLevel>
     <RefLogicalLevel …/>
   </DefaultRootLevel>
</Dimension>

Example

<Dimension name="H0 Time"
     parentName="&quot;3 - Sample Federated&quot;"
     parentId="2000:53458" parentUid="80cb9462-07d0-0000-714b-e31d00000000"
     id="2019:53459" uid="80cb9463-07e3-0000-714b-e31d00000000"
     isTimeDim="true" isValueBased="false" isRagged="false" isSkipped="false">
   <RootLevels>
     <RefLogicalLevel id="2025:53882"
      uid="80cb960a-07e9-0000-714b-e31d00000000"
      qualifiedName="&quot;3 - Sample Federated&quot;.&quot;H0 Time&quot;.&quot;
       Total Time&quot;"/>
   </RootLevels>
   <DefaultRootLevel>
     <RefLogicalLevel id="2025:53882"
      uid="80cb960a-07e9-0000-714b-e31d00000000"
      qualifiedName="&quot;3 - Sample Federated&quot;.&quot;H0 Time&quot;.&quot;
       Total Time&quot;"/>
   </DefaultRootLevel>
</Dimension>

7.6 XML Elements: Logical Table

The logical table element corresponds to the logical table object in the Business Model and Mapping layer.

The logical table tag includes the following attributes:

Table 7-11 Logical Table Tag Attributes

Attribute Name
Description

isBridgeTable

In previous releases, this attribute was used to indicate whether the logical table is a bridge table. This attribute exists only for backward compatibility with previous releases.

isLookupTable

If set to true, indicates that this logical table is a lookup table.

Lookup tables are typically used to store fields that contain translations in several languages. Queries that require multilingual data join the base table and lookup table to obtain the translated values for each row in the base table.

x

The x coordinate of the table when it is shown in the business model diagrams.

y

The y coordinate of the table when it is shown in the business model diagrams.

The logical table tag includes the following child elements:

Table 7-12 Logical Table Child Elements

Element Name
Description

LevelColumn

References the column that is used in the level that corresponds to this logical table.

Each level column is contained in a sub-element called RefLogicalColumn.

Columns

References the logical columns that belong to this logical table.

Each logical column is contained in a sub-element called RefLogicalColumn.

TableSources

References the logical table sources for this logical table.

Each logical table source is contained in a sub-element called RefLogicalTableSource.

Syntax

<LogicalTable …
     isBridgeTable=""
     isLookupTable=""
     x=""
     y="">
   <Description />
   <LevelColumn>
     <RefLogicalColumn …/>
   </LevelColumn>
   <Columns>
     <RefLogicalColumn …/>
     <RefLogicalColumn …/>
   </Columns>
   <TableSources>
     <RefLogicalTableSource …/>
     <RefLogicalTableSource …/>
   </TableSources>
</LogicalTable>

Example

<LogicalTable name="F2 Coupon Usages"
     parentName="&quot;8 - Fusion Order Demo (OLTP)&quot;"
     parentId="2000:61417" parentUid="80cbbdd2-07d0-0000-714b-e31d00000000"
     id="2035:61501" uid="80cbbde8-07f3-0000-714b-e31d00000000"
     x="133" y="378">
   <Columns>
     <RefLogicalColumn id="2006:61504"
      uid="80cbbefc-07d6-0000-714b-e31d00000000"
      qualifiedName="&quot;8 - Fusion Order Demo (OLTP)&quot;.&quot;
       F2 Coupon Usages&quot;.&quot;Applied Date&quot;"/>
     <RefLogicalColumn id="2006:61507"
      uid="80cbbeff-07d6-0000-714b-e31d00000000"
      qualifiedName="&quot;8 - Fusion Order Demo (OLTP)&quot;.&quot;
       F2 Coupon Usages&quot;.&quot;# of Customers&quot;"/>
     <RefLogicalColumn id="2006:61508"
      uid="80cbbf00-07d6-0000-714b-e31d00000000"
      qualifiedName="&quot;8 - Fusion Order Demo (OLTP)&quot;.&quot;
       F2 Coupon Usages&quot;.&quot;# of Coupons and Discounts&quot;"/>
     <RefLogicalColumn id="2006:61512"
      uid="80cbbf04-07d6-0000-714b-e31d00000000"
      qualifiedName="&quot;8 - Fusion Order Demo (OLTP)&quot;.&quot;
       F2 Coupon Usages&quot;.&quot;Order ID&quot;"/>
   </Columns>
   <TableSources>
     <RefLogicalTableSource id="2037:61503"
      uid="80cbc055-07f5-0000-714b-e31d00000000"
      qualifiedName="&quot;8 - Fusion Order Demo (OLTP)&quot;.&quot;
       F2 Coupon Usages&quot;.&quot;COUPON_USAGES&quot;"/>
   </TableSources>
</LogicalTable>

7.7 XML Elements: Logical Foreign Key

The logical foreign key element corresponds to the logical foreign key object in the Business Model and Mapping layer.

The logical foreign key tag includes the following attributes:

Table 7-13 Logical Foreign Key Tag Attributes

Attribute Name
Description

type

The type of join. Valid values are Inner, LeftOuter, RightOuter, FullOuter, and FullOuterStitch.

The logical foreign key tag includes the following child elements:

Table 7-14 Logical Foreign Key Child Elements

Element Name
Description

Columns

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

Each logical column is contained in a sub-element called RefLogicalColumn.

CounterPartKey

References the foreign key columns for this foreign key.

Each logical column is contained in a sub-element called RefLogicalKey.

DrivingTable

If a driving table has been specified for this logical foreign key, this element references that logical table.

The driving table is contained in a sub-element called RefLogicalTable.

Syntax

<LogicalForeignKey …
     type="">
   <Description />
   <Columns>
     <RefLogicalColumn …/>
     <RefLogicalColumn …/>
   </Columns>
   <CounterPartKey>
     <RefLogicalKey …/>
   </CounterPartKey>
   <DrivingTable>
     <RefLogicalTable …/>
   </DrivingTable>
</LogicalForeignKey>

Example

<LogicalForeignKey name="Measures_FKey"
     parentName="&quot;9 - Usage Tracking&quot;.&quot;Measures&quot;"
     parentId="2035:22319" parentUid="802b28a4-07f3-0000-714b-e31d00000000"
     id="2033:22559" uid="802b29a5-07f1-0000-714b-e31d00000000"
     type="Inner">
   <Columns>
     <RefLogicalColumn id="2006:22349"
      uid="802b28b2-07d6-0000-714b-e31d00000000"
      qualifiedName="&quot;9 - Usage Tracking&quot;.&quot;Measures&quot;.&quot;
       QueryText&quot;"/>
   </Columns>
   <CounterPartKey>
     <RefLogicalKey id="2008:22412"
      uid="802b29a0-07d8-0000-714b-e31d00000000"
      qualifiedName="&quot;9 - Usage Tracking&quot;.&quot;Topic&quot;.&quot;
       Topic_Key&quot;"/>
   </CounterPartKey>
</LogicalForeignKey>

7.8 XML Elements: Logical Key

The logical key element corresponds to the logical key object in the Business Model and Mapping layer.

The logical key tag includes the following attributes:

Table 7-15 Logical Key Tag Attributes

Attribute Name
Description

isPrimary

If set to true, indicates that this key is the logical primary key for the table.

isForDrillDown

If set to true, indicates that this key is the key that is displayed when a user clicks to drill down.

isChronKey

If set to true, indicates that this key is a chronological key for a time dimension.

The logical key tag includes the following child elements:

Table 7-16 Logical Key Child Elements

Element Name
Description

Columns

References the logical column that defines the key of the logical table.

The logical column is contained in a sub-element called RefLogicalColumn.

Syntax

<LogicalKey …
     isPrimary=""
     isForDrillDown=""
     isChronKey="">
   <Description />
   <Columns>
     <RefLogicalColumn …/>
   </Columns>
</LogicalKey>

Example

<LogicalKey name="CUSTOMER_ID"
     parentName="&quot;8 - Fusion Order Demo (OLTP)&quot;.&quot;
      F2 Coupon Usages&quot;"
     parentId="2035:61501" parentUid="80cbbde8-07f3-0000-714b-e31d00000000"
     id="2008:61513" uid="80cbbf39-07d8-0000-714b-e31d00000000"
     isPrimary="true">
   <Columns>
     <RefLogicalColumn id="2006:61512"
      uid="80cbbf04-07d6-0000-714b-e31d00000000"
      qualifiedName="&quot;8 - Fusion Order Demo (OLTP)&quot;.&quot;
       F2 Coupon Usages&quot;.&quot;Order ID&quot;"/>
   </Columns>
</LogicalKey>

7.9 XML Elements: Logical Table Source

The logical table source element corresponds to the logical table source object in the Business Model and Mapping layer. See also the column mapping element, described in Section 7.9.1, "Column Mapping."

The logical table source tag includes the following attributes:

Table 7-17 Logical Table Source Attributes

Attribute Name
Description

isDistinct

This attribute is used if the values for the logical table source are unique. In the Administration Tool, this option is called Select distinct values in the Content tab of the Logical Table Source dialog.

isDimOnly

This attribute is not used.

isSysGen

If set to true, indicates that an internal utility such as the Aggregate Persistence Wizard has generated this logical table source.

canCombine

If set to true, indicates that this logical table source can be combined with other logical table sources to provide a full set of results. In the Administration Tool, this option is called This source should be combined with other sources at this level in the Content tab of the Logical Table Source dialog.

isActive

If set to true, indicates that this logical table source is active. In the Administration Tool, this attribute corresponds with the Disabled option in the General tab of the Logical Table Source dialog.

allowUnmappedTable

Determines if the logical table source can have physical tables which are not mapped to logical columns.

This can occur with a snowflake of physical tables A->B->C, where a logical table maps to columns in A and C, but B needs to be included in the logical table source because it is in the join path between A and C.

priorityGroup

Indicates the priority group number of this logical table source. Logical table source priority group numbers are assigned to indicate which logical table source should be used for queries for which there is more than one logical table source that can satisfy the requested set of columns.

The logical table source tag includes the following child elements:

Table 7-18 Logical Table Source Child Elements

Element Name
Description

Link

References the set of physical tables to which the logical table source is mapped. These links are references to the physical joins that already exist. In the Administration Tool, this element corresponds with the Map to these tables section in the General tab of the Logical Table Source dialog.

Each link child element contains two sub-elements, StartNode and Joins:

The StartNode sub-element references the physical table identified by this link. It can contain the RefCubeTable, RefPhysicalTable, RefAWDimension, or RefAWCube sub-element, depending on your data source type.

The Joins sub-element defines the joins for this link. It contains different sub-elements, depending on the type of join. For example:

RefCubeTable, RefPhysicalTable, RefAWCube, or RefAWDimension

RefPhysicalForeignKey or RefComplexJoin

DrivingTable, which contains a sub-element RefPhysicalTable

The Joins sub-element has two attributes: type (Inner, LeftOuter, RightOuter, FullOuter, or FullOuterStitch) and cardinality (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).

See the syntax for the logical table source element to see the complete hierarchy for the link child element.

WhereClause

If a WHERE clause filter has been defined, contains the WHERE clause expression that limits the number of rows the source uses in the resultant table. The expression is contained in a sub-element called Expr.

In the Administration Tool, this option is called Use this "WHERE clause" filter to limit rows returned (exclude the "WHERE") in the Content tab of the Logical Table Source dialog.

GroupBy

Contains the expression that defines whether the aggregation is grouped by logical level or by column. The expression is contained in a sub-element called Expr.

In the Administration Tool, this option is called Aggregation content, group by in the Content tab of the Logical Table Source dialog.

FragmentContent

Contains the expression that defines how the source is fragmented. The expression is contained in a sub-element called Expr.

This child element is used in conjunction with the canCombine attribute. In the Administration Tool, this option is called Fragmentation content in the Content tab of the Logical Table Source dialog.

ClosureTable

References the parent-child table, if any.

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

Syntax

<LogicalTableSource …
     isDistinct=""
     isSysGen=""
     canCombine=""
     isActive=""
     priorityGroup="">
   <Description />
   <Link>
     <StartNode>
       <RefPhysicalTable …/>
     </StartNode>
     <Joins>
       <Join type="" cardinality="">
         <RefPhysicalTable …/>
         <RefPhysicalTable …/>
         <RefPhysicalForeignKey …/>
       </Join>
     </Joins>
   </Link>
   <WhereClause>
     <Expr>...</Expr>
   </WhereClause>
   <GroupBy>
     <Expr />
   </GroupBy>
   <FragmentContent>
     <Expr />
   </FragmentContent>
   <ClosureTable>
     <RefPhysicalTable …/>
   </ClosureTable>
</LogicalTableSource>

Example

<LogicalTableSource name="LTS3 Channels (Bridged to Revenue)"
     parentName="&quot;1 - Sample App&quot;.&quot;D4 Offices and Channels
      (M:M Joins)&quot;"
     parentId="2035:11648" parentUid="80cab595-07f3-0000-714b-e31d00000000"
     id="2037:12357" uid="80cab7d5-07f5-0000-714b-e31d00000000"
     isActive="true">
   <Link>
     <StartNode>
       <RefPhysicalTable id="3001:42412"
        uid="80cb6825-0bb9-0000-714b-e31d00000000"
        qualifiedName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;
         Catalog&quot;.&quot;BISAMPLE&quot;.&quot;D30 Offices&quot;"/>
     </StartNode>
     <Joins>
       <Join type="Inner" cardinality=" ONE TO MANY">
         <RefPhysicalTable id="3001:42412"
          uid="80cb6825-0bb9-0000-714b-e31d00000000"
          qualifiedName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog
           &quot;.&quot;BISAMPLE&quot;.&quot;D30 Offices&quot;"/>
         <RefPhysicalTable id="3001:42416"
          uid="80cb6829-0bb9-0000-714b-e31d00000000"
          qualifiedName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog
           &quot;.&quot;BISAMPLE&quot;.&quot;D43 Chnls Offs Bridge (Rev)&quot;"/>
         <RefPhysicalForeignKey id="3006:43167"
          uid="80cb6b18-0bbe-0000-714b-e31d00000000"
          qualifiedName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog
           &quot;.&quot;BISAMPLE&quot;.&quot;D43 Chnls Offs Bridge (Rev)&quot;
           .&quot;D43 Chnls Offcs Bridge (Revenue)_FKey&quot;"/>
       </Join>
     </Joins>
   </Link>
   <Link>
     <StartNode>
       <RefPhysicalTable id="3001:42414"
        uid="80cb6827-0bb9-0000-714b-e31d00000000"
        qualifiedName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog
         &quot;.&quot;BISAMPLE&quot;.&quot;D41 Channels (Revenue)&quot;"/>
     </StartNode>
     <Joins>
       <Join type="Inner" cardinality=" ONE TO MANY">
         <RefPhysicalTable id="3001:42414"
          uid="80cb6827-0bb9-0000-714b-e31d00000000"
          qualifiedName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog
           &quot;.&quot;BISAMPLE&quot;.&quot;D41 Channels (Revenue)&quot;"/>         <RefPhysicalTable id="3001:42416"
          uid="80cb6829-0bb9-0000-714b-e31d00000000"
          qualifiedName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog
           &quot;.&quot;BISAMPLE&quot;.&quot;D43 Chnls Offs Bridge (Rev)&quot;"/>         <RefPhysicalForeignKey id="3006:43166"
          uid="80cb6b17-0bbe-0000-714b-e31d00000000"
          qualifiedName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog
           &quot;.&quot;BISAMPLE&quot;.&quot;D43 Chnls Offs Bridge (Rev)&quot;
           .&quot;D53 Teams Membership Bridge (Revenue Facts)_FKey#1&quot;"/>
       </Join>
     </Joins>
   </Link>
   <Link>
     <StartNode>
       <RefPhysicalTable id="3001:42416"
        uid="80cb6829-0bb9-0000-714b-e31d00000000"
        qualifiedName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog
         &quot;.&quot;BISAMPLE&quot;.&quot;D43 Chnls Offs Bridge (Rev)&quot;"/>
     </StartNode>
     <Joins>
       <Join type="Inner" cardinality="MANY TO ONE">
         <RefPhysicalTable id="3001:42416"
          uid="80cb6829-0bb9-0000-714b-e31d00000000"
          qualifiedName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog
           &quot;.&quot;BISAMPLE&quot;.&quot;D43 Chnls Offs Bridge (Rev)&quot;"/>         <RefPhysicalTable id="3001:42414"
          uid="80cb6827-0bb9-0000-714b-e31d00000000"
          qualifiedName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog
           &quot;.&quot;BISAMPLE&quot;.&quot;D41 Channels (Revenue)&quot;"/>         <RefPhysicalForeignKey id="3006:43166"
          uid="80cb6b17-0bbe-0000-714b-e31d00000000"
          qualifiedName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog
           &quot;.&quot;BISAMPLE&quot;.&quot;D43 Chnls Offs Bridge (Rev)&quot;
           .&quot;D53 Teams Membership Bridge (Revenue Facts)_FKey#1&quot;"/>
       </Join>
       <Join type="Inner" cardinality="MANY TO ONE">
         <RefPhysicalTable id="3001:42416"
          uid="80cb6829-0bb9-0000-714b-e31d00000000"
          qualifiedName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog
           &quot;.&quot;BISAMPLE&quot;.&quot;D43 Chnls Offs Bridge (Rev)&quot;"/>
         <RefPhysicalTable id="3001:42412"
          uid="80cb6825-0bb9-0000-714b-e31d00000000"
          qualifiedName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog
          &quot;.&quot;BISAMPLE&quot;.&quot;D30 Offices&quot;"/>
         <RefPhysicalForeignKey id="3006:43167"
          uid="80cb6b18-0bbe-0000-714b-e31d00000000"
          qualifiedName="&quot;01 - Sample App Data (ORCL)&quot;.&quot;Catalog
           &quot;.&quot;BISAMPLE&quot;.&quot;D43 Chnls Offs Bridge (Rev)&quot;
           .&quot;D43 Chnls Offcs Bridge (Revenue)_FKey&quot;"/>
       </Join>
     </Joins>
   </Link>
   <WhereClause>
      <Expr></Expr>
   </WhereClause>
   <GroupBy>
      <Expr>

8 XML Physical Elements

Physical elements are typically those elements that are exposed in the Physical layer, or in other words, the elements that appear in the right-hand pane of the Administration Tool.

This chapter contains the following topics:

Section 8.1, "XML Elements: Database"

Section 8.2, "XML Elements: Physical Catalog"

Section 8.3, "XML Elements: Physical Schema"

Section 8.4, "XML Elements: Physical Display Folder"

Section 8.5, "XML Elements: Physical Table"

Section 8.6, "XML Elements: Physical Column"

Section 8.7, "XML Elements: Connection Pool"

Section 8.8, "XML Elements: Physical Key"

Section 8.9, "XML Elements: Physical Foreign Key"

Section 8.10, "XML Elements: Complex Join"

Section 8.11, "XML Elements: Cube Table"

Section 8.12, "XML Elements: Physical Dimension"

Section 8.13, "XML Elements: Physical Hierarchy"

Section 8.14, "XML Elements: Physical Level"

Section 8.15, "XML Elements: Cube Column"

Section 8.16, "XML Elements: Analytic Workspace"

Section 8.17, "XML Elements: AW Cube"

Section 8.18, "XML Elements: AW Dimension"

Section 8.19, "XML Elements: AW Hierarchy"

Section 8.20, "XML Elements: AW Level"

Section 8.21, "XML Elements: AW Column"

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 VOs.

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

<PhysicalDispFolder …>
   <Description />
   <Tables>
     <RefPhysicalTable …/>
   </Tables>
</Schema>

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

This child element is reserved for a future release.

XSDSchema

This child element is reserved for a future release.

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>
</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>

9 XML Presentation Elements

Presentation elements are typically those elements that are exposed in the Presentation layer, or in other words, the elements that appear in the left-hand pane of the Administration Tool.

This chapter contains the following topics:

Section 9.1, "XML Elements: Presentation Catalog"

Section 9.2, "XML Elements: Presentation Schema"

Section 9.3, "XML Elements: Presentation Table"

Section 9.4, "XML Elements: Presentation Column"

Section 9.5, "XML Elements: Presentation Hierarchy"

Section 9.6, "XML Elements: Presentation Level"

9.1 XML Elements: Presentation Catalog

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.

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 RefLogicalColumn.

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 Alias, with one attribute called name.

Tables

References the presentation tables that belong to this subject area.

Each presentation table is contained in a sub-element called RefPresentationTable.

Syntax

<PresentationCatalog …
     isExportKeys=""
     isAutoAggr=""
     hasDispName=""
     dispName=""
     hasDispDescription=""
     dispDescription"">
   <Description />
   <RefBusinessModel …/>
   <DefaultFactCol>
     <RefLogicalColumn …/>
   </DefaultFactCol>
   <Aliases …/>
   <Tables>
     <RefPresentationTable …/>
   </Tables>
</PresentationCatalog>

Example

<PresentationCatalog name="C - Sample Headcount"
     id="4004:20154" uid="80cad5f1-0fa4-0000-714b-e31d00000000"
     hasDispName="false" hasDispDescription="false">
   <Description>

10 XML Marketing, Security, and Other Elements

This chapter describes the XML API elements for Oracle Marketing Segmentation objects, security objects, and miscellaneous objects that do not fall in other categories.

This chapter contains the following topics:

Section 10.1, "XML Marketing Elements"

Section 10.2, "XML Security Elements"

Section 10.3, "Other XML Elements"

10.1 XML Marketing Elements

Marketing elements are typically those elements that are related to features for the Oracle Marketing Segmentation product. For information about features and options related to Oracle Marketing Segmentation, see the administrator documentation for the Oracle Marketing Segmentation application.

Marketing elements include:

Section 10.1.1, "XML Elements: Catalog Link"

Section 10.1.2, "XML Elements: Target Level"

Section 10.1.3, "XML Elements: List Catalog"

Section 10.1.4, "XML Elements: Qualified List Item"

Section 10.1.5, "XML Elements: Qualifying Key"

Section 10.1.6, "XML Elements: Sampling Table"

Section 10.1.7, "XML Elements: Seg Catalog"

10.1.1 XML Elements: Catalog Link

The catalog link element corresponds to the conforming dimension link object in the Marketing metadata. A conforming dimension links a fact that contains target-level IDs to a fact that does not contain target-level IDs by navigating along a dimension that is shared by both fact tables.

The catalog link tag includes the following child elements:

Table 10-1 Catalog Link Child Elements

Element Name
Description

From

References the presentation column that represents the primary key of the subject area from which the dimension link originates.

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

To

References the presentation column that represents the primary key of the subject area to which the dimension link points.

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

The catalog link tag does not include any attributes.

Syntax

<CatalogLink …>
   <Description />
   <From>
     <RefPresentationColumn …/>
   </From>
   <To>
     <RefPresentationColumn …/>
   </To>
</CatalogLink>

Example

<CatalogLink name="Customer Profile-&gt;Campaign Contacts"
     id="4012:280960" uid="8032f5a3-0fac-0000-714b-e31d00000000">
   <Description>

Glossary

This glossary defines terms for Oracle Business Intelligence Enterprise Edition. See also the Oracle Fusion Middleware Master Glossary for additional terms and definitions.

action

Provides functionality to navigate to related content or to invoke operations, functions or processes in external systems. You can include actions in analyses, dashboard pages, agents, scorecard objectives, scorecard initiatives, and KPIs.

See also action link.

Action Framework

The Action Framework is a component of the Oracle BI EE architecture and includes a J2EE application called the Action Execution Service (AES) and actions-specific JavaScript functionality deployed as part of Oracle BI EE. The action framework also includes client-side functionality for creating actions and invoking certain action types directly from the browser.

action link

A link to an action that you have embedded in an analysis, dashboard page, scorecard objective, scorecard initiative, or KPI that, when clicked, runs an associated action.

See also action.

ADF Business Intelligence Component

Provides the developer the ability to include Oracle BI Presentation Catalog objects in ADF Applications. This component uses a SOAP connection to access the catalog.

Administration Server

Part of the WebLogic server domain and runs the processes that manage Oracle Business Intelligence components. The Administration Server includes the Oracle WebLogic Server Administration Console, Oracle Fusion Middleware Control, and JMX MBeans. For a Simple Install type, the Administration Server also includes Java components for Oracle Business Intelligence such as Oracle BI Publisher and Oracle Real-Time Decisions.

See also Fusion Middleware Control, Java components and Managed Server.

Administration Tool

See Oracle BI Administration Tool.

agent

Enables you to automate your business processes. You can use agents to provide event-driven alerting, scheduled content publishing, and conditional event-driven action execution.

Agents can dynamically detect information-based problems and opportunities, determine the appropriate individuals to notify, and deliver information to them through a wide range of devices (e-mail, phones, and so on).

aggregate persistence

A feature that automates the creation and loading of aggregate tables and their corresponding Oracle Business Intelligence metadata mappings to enable aggregate navigation.

aggregate table

A table that stores precomputed results from measures that have been aggregated over a set of dimensional attributes. Each aggregate table column contains data at a given set of levels. For example, a monthly sales table might contain a precomputed sum of the revenue for each product in each store during each month. Using aggregate tables optimizes performance.

aggregation rule

In an Oracle BI repository, a rule applied to a logical column or physical cube column that specifies a particular aggregation function to be applied to the column data, such as SUM.

In Presentation Services, users can see the rules that have been applied in the repository. Users can also change the default aggregation rules for measure columns.

alias table

A physical table that references a different physical table as its source. You can use alias tables to set up multiple tables, each with different keys, names, or joins, when a single physical table must serve in different roles. Because alias table names are included in physical SQL queries, you can also use alias tables to provide meaningful table names, making the SQL statements easier to read.

analysis

A query that a user creates on the Criteria tab in Presentation Services. An analysis can optionally contain one or more filters or selection steps to restrict the results.

See also filter and selection step.

analysis criteria

Consists of the columns, filters, and selection steps that you specify for an analysis.

See also analysis.

analysis prompt

A prompt that is added to an analysis. When the user selects a prompt value, that value then determines the content that displays in the analysis that contains the prompt, only.

See dashboard prompt and prompt.

attribute

The details of a dimension in an Oracle BI repository. Attributes usually appear as columns of a dimension table.

attribute column

In Presentation Services, a column that holds a flat list of values that are also known as members. No hierarchical relationship exists between these members, as is the case for members of a hierarchical column. Examples include ProductID or City.

See hierarchical column.

BI Composer

BI Composer is a simple-to-use wizard that enables you to quickly and easily create, edit, or view analyses without the complexities of the Analysis editor.

BI domain

Contains configurable system components (the coreapplication) and Java components (the WebLogic server domain), and includes the Web-based management tools and applications that use resources.

A BI domain can be a set of middleware homes spread across one or more physical servers.

See also BI instance.

BI instance

Refers to the system components (coreapplication) of a BI domain

See also BI domain.

BI object

A piece of business intelligence content that is created with Presentation Services and saved to the Oracle BI Presentation Catalog. Examples of BI objects include analyses, dashboards, dashboard pages, scorecards, and KPIs.

BI Search

A search tool that resides outside of Presentation Services. BI Search is available from the Home Page after the administrator adds a link to the BI Search URL. BI Search provides a mechanism for searching for objects in the Oracle BI Presentation Catalog that is similar to a full-text search engine.

bookmark link

Captures the path to a dashboard page and all aspects of the page state.

See prompted link.

bridge table

A table that enables you to resolve many-to-many relationships between two other tables.

briefing book

See Oracle BI Briefing Books.

business model

An object in the Oracle BI repository that contains the business model definitions and the mappings from logical to physical tables. Business models are always dimensional, unlike objects in the Physical layer, which reflect the organization of the data sources. Each business model contains logical tables, columns, and joins.

Business Model and Mapping layer

A layer of the Oracle BI repository that defines the business, or logical, model of the data and specifies the mapping between the business model and the Physical layer schemas. This layer can contain one or more business models.

The Business Model and Mapping layer determines the analytic behavior that is seen by users, and defines the superset of objects available to users. It also hides the complexity of the source data models.

business owner

The person responsible for managing and improving the business value and performance of a KPI or scorecard object, such as an objective, cause & effect map, and so on.

catalog

See Oracle BI Presentation Catalog.

cause & effect map

A component of a scorecard that lets you illustrate the cause and effect relationships of an objective or KPI.

See also Oracle Scorecard and Strategy Management.

chronological key

A column in a time dimension that identifies the chronological order of the members within a dimension level. The key must be unique at its level.

Cluster Controller

A process that serves as the first point of contact for new requests from Presentation Services and other clients. The Cluster Controller determines which Oracle BI Server in the cluster to direct the request to based on Oracle BI Server availability and load. It monitors the operation of servers in the cluster, including the Oracle BI Scheduler instances. The Cluster Controller is deployed in active-passive configuration.

column

In an Oracle BI repository, columns can be physical columns, logical columns, or presentation columns.

In Presentation Services, indicates the pieces of data that an analysis returns. Together with filters and selection steps, columns determine what analyses contain. Columns also have names that indicate the types of information that they contain, such as Account and Contact.

See also analysis, attribute column, hierarchical column, and measure column.

column filter

See filter.

column prompt

A type of filter that enables you to build specific value prompts on a data column to either exist alone on the dashboard or analysis or to expand or refine existing dashboard and analysis filters.

See also prompt.

complex join

A join in the Physical layer of an Oracle BI repository that uses an expression other than equals.

condition

Objects that return a single Boolean value based on the evaluation of an analysis or of a key performance indicator (KPI). You use conditions to determine whether agents deliver their content and execute their actions, whether actions links are displayed in dashboard pages, or whether sections and their content are displayed in dashboard pages.

See also action, action link, agent and key performance indicator (KPI).

connection pool

An object in the Physical layer of an Oracle BI repository that contains the connection information for a data source.

See also Physical layer.

content designer

The user who creates business intelligence objects such as analyses, dashboards, and scorecards.

contextual event action

A predelivered action that uses the Action Framework to pass content from the business intelligence object to another region on an ADF page.

See also action, Action Framework, and action link.

criteria

See analysis criteria.

cube

An OLAP (online analytical processing) data structure that lets data be analyzed more quickly and with greater flexibility than structures in relational databases. Cubes are made up of measures and organized by dimensions. Cubes in multidimensional data sources roughly correspond to star schemas in relational database models.

currency prompt

A prompt that enables the user to change the currency type that displays in the currency columns on an analysis or dashboard.

See also prompt.

custom view

A component of a scorecard that lets you show a customized view of your business and strategy data.

See also Oracle Scorecard and Strategy Management.

dashboard

An object that provides personalized views of corporate and external information. A dashboard consists of one or more pages. Pages can display anything that you can access or open with a Web browser, such as results of analyses, images, alerts from agents, and so on.

dashboard prompt

A prompt that is added to the dashboard. When the user selects a prompt value, that value then determines the content that displays in all analyses that are included on the dashboard.

See analysis prompt and prompt.

Dashboard URL

Used for incorporating or referencing the content of a specific dashboard in external portals or applications. It has several forms and optional arguments that you can use to control its behavior.

data source name (DSN)

A data structure that contains the information about a specific database, typically used by an ODBC driver to connect to the database. The DSN contains information such as the name, directory, and driver of the database.

Connection pool objects in the Physical layer of the Oracle BI repository contain DSN information for individual data sources.

database hint

Instructions placed within a SQL statement that tell the database query optimizer the most efficient way to execute the statement. Hints override the optimizer's execution plan, so you can use hints to improve performance by forcing the optimizer to use a more efficient plan. Hints are supported only for Oracle Database data sources.

dimension

A hierarchical organization of logical columns (attributes). One or more logical dimension tables might be associated with at most one dimension.

A dimension might contain one or more (unnamed) hierarchies. There are two types of logical dimensions: dimensions with level-based hierarchies (structure hierarchies), and dimensions with parent-child hierarchies (value hierarchies).

A particular type of level-based dimension, called a time dimension, provides special functionality for modeling time series data.

See also hierarchy.

dimension table

A logical table that contains columns used by a particular dimension. A dimension table cannot be a fact table.

See also fact table.

driving table

A mechanism used to optimize the manner in which the Oracle BI Server processes multi-database joins when one table is very small (the driving table) and the other table is very large.

DSN

See data source name (DSN).

event polling table

Event polling tables (also called event tables) provide information to the Oracle BI Server about which physical tables have been updated. They are used to keep the query cache up-to-date. The Oracle BI Server cache system polls the event table, extracts the physical table information from the rows, and purges stale cache entries that reference those physical tables.

Essbase

A multidimensional database management system available from Oracle that provides a multidimensional database platform upon which to build business intelligence applications. Also referred to as Oracle's Hyperion Essbase.

fact table

In an Oracle BI repository, a logical table in the Business Model and Mapping layer that contains measures and has complex join relationships with dimension tables.

See also dimension table.

filter

Criteria that are applied to attribute and measure columns to limit the results that are displayed when an analysis is run. For measure columns, filters are applied before the query is aggregated and affect the query and thus the resulting values.

See also prompt and selection step.

foreign key

A column or a set of columns in one table that references the primary key columns in another table.

fragmentation content

The portion, or fragment, of the set of data specified in a logical table source when the logical table source does not contain the entire set of data at a given level. Fragmentation content is defined by the logical columns that are entered in the Fragmentation content box in the Content tab of the Logical Table Source dialog box.

Fusion Middleware Control

Provides Web-based management tools that enable you to monitor and configure Fusion Middleware components.

global header

An object in the user interface for Oracle BI Presentation Services that contains links and options that enable the user to quickly begin a task or locate a specific object within the Oracle BI Presentation Catalog. The global header always displays in the Presentation Services user interface, thus enabling users to quickly access links and search the catalog without having to navigate to the Home Page or Catalog page.

Go URL

Used to incorporate specific business intelligence results into external portals or applications. The Go URL is used when you add a result to your favorites or add a link to a request to a dashboard or external Web site. It has several forms and optional arguments that you can use to control its behavior.

hierarchical column

In Presentation Services, a column that holds data values that are organized using both named levels and parent-child relationships. This column is displayed using a tree-like structure. Individual members are shown in an outline manner, with lower-level members rolling into higher-level members. For example, a specific day belongs to a particular month, which in turn is within a particular year. Examples include Time or Geography.

See also attribute column.

hierarchy

In an Oracle BI repository, a system of levels in a logical dimension that are related to each other by one-to-many relationships. All hierarchies must have a common leaf level and a common root (all) level.

Hierarchies are not modeled as separate objects in the metadata. Instead, they are an implicit part of dimension objects.

See also dimension, logical level, and presentation hierarchy.

hierarchy level

In Presentation Services, an object within a hierarchical column that either rolls up or is rolled up from other levels. Corresponds to a presentation level in an Oracle BI repository.

See also presentation level.

home page

Provides an intuitive, task-based entry way into the functionality of Presentation Services. The Home page is divided into sections that enable you to quickly begin specific tasks, locate an object, or access technical documentation.

image prompt

A prompt that provides an image with different areas mapped to specific values. The user clicks an image area to select the prompt value that populates the analysis or dashboard.

See also prompt.

initialization block

Used to initialize dynamic repository variables, system session variables, and nonsystem session variables. An initialization block contains the SQL statements that are executed to initialize or refresh the variables that are associated with that block.

initiative

Used in a scorecard, an initiative is a time-specific task or project that is necessary to achieve objectives. As such, you can use initiatives that support objectives as milestones as they reflect progress toward strategy targets.

See also objective and Oracle Scorecard and Strategy Management.

Java components

Fusion Middleware Control components that are deployed as one or more Java EE applications (and a set of resources) and are managed by Node Manager.

See also Node Manager.

key performance indicator (KPI)

A measurement that defines and tracks specific business goals and strategic objectives. KPIs often times roll up into larger organizational strategies that require monitoring, improvement, and evaluation. KPIs have measurable values that usually vary with time, have targets to determine a score and performance status, include dimensions to allow for more precise analysis, and can be compared over time for trending purposes and to identify performance patterns.

See also Oracle Scorecard and Strategy Management.

KPI watchlist

A method of distributing KPIs to end users. A watchlist is a collection of KPIs that are built by adding the KPIs that are stored in the Oracle BI Presentation Catalog. After a KPI watchlist is built and saved, it is stored as a catalog object and can be added to dashboards and scorecards.

See also key performance indicator (KPI).

level

See hierarchy level.

logical display folder

Folders used to organize objects in the Business Model and Mapping layer of an Oracle BI repository. They have no metadata meaning.

logical join

Joins that express relationships between logical tables. Logical joins are conceptual, rather than physical, joins. In other words, they do not join to particular keys or columns. A single logical join can correspond to many possible physical joins.

logical layer

See Business Model and Mapping layer.

logical level

In an Oracle BI repository, a component of a level-based hierarchy that either rolls up or is rolled up from other levels.

Parent-child hierarchies have implicit, inter-member levels between ancestors and descendants that are not exposed as logical level objects in the metadata. Although parent-child hierarchies also contain logical level objects, these levels are system generated and exist to enable aggregation across all members only.

See also dimension and hierarchy.

Logical SQL

The SQL statements that are understood by the Oracle BI Server. The Oracle BI Server Logical SQL includes standard SQL, plus special functions (SQL extensions) like AGO, TODATE, EVALUATE, and others.

Clients like Presentation Services send Logical SQL to the Oracle BI Server when a user makes a request. In addition, Logical SQL is used in the Business Model and Mapping layer to enable heterogeneous database access and portability. The Oracle BI Server transforms Logical SQL into physical SQL that can be understood by source databases.

logical table

A table object in the Business Model and Mapping layer of an Oracle BI repository. A single logical table can map to one or more physical tables. Logical tables can be either fact tables or dimension tables.

See also dimension table and fact table.

logical table source

Objects in the Business Model and Mapping layer of an Oracle BI repository that define the mappings from a single logical table to one or more physical tables. The physical to logical mapping can also be used to specify transformations that occur between the Physical layer and the Business Model and Mapping layer, and to enable aggregate navigation and fragmentation.

Managed Server

An individual J2EE application container (JMX MBean container). It provides local management functions on individual hosts for Java components and system components contained within the local middleware home, and refers to the Administration Server for all of its configuration and deployment information.

See also Administration Server and Fusion Middleware Control.

MDS

Oracle Metadata Services. A core technology of the Application Development Framework. MDS provides a unified architecture for defining and using metadata in an extensible and customizable manner.

See also MDS XML.

MDS XML

An XML format that is compatible with Oracle Metadata Services. MDS XML is a supported format for the Oracle BI repository. It enables integration with third-party source control management systems for offline repository development.

MDS XML format is different from the XML format generated by the Oracle BI Server XML API.

See also MDS, Oracle BI repository, and Oracle BI Server XML API.

measure column

A column that can change for each record and can be added up or aggregated. Typical measures are sales dollars and quantity ordered. Measures are calculated from data sources at query time.

Measure columns are displayed in the Oracle BI repository, usually in fact tables, or in Presentation Services.

metadata

Data about data. Metadata objects include the descriptions of schemas (such as tables, columns, data types, primary keys, foreign keys, and so on) and logical constructs (like fact tables, dimensions, and logical table source mappings).

The Oracle BI repository is made up of the metadata used by the Oracle BI Server to process queries.

metadata dictionary

A static set of XML documents that describe metadata objects, such as a column, including its properties and relationships with other metadata objects. A metadata dictionary can help users obtain more information about metrics or attributes for repository objects.

mission statement

A statement in a scorecard that specifies the key business goals and priorities that are required to achieve your vision.

See also Oracle Scorecard and Strategy Management and vision statement.

multi-database join

A join between two tables in an Oracle BI repository, where each table resides in a different database.

Node Manager

A daemon process that provides remote server start, stop, and restart capabilities when Java processes become unresponsive or terminate unexpectedly.

See also Java components.

OCI

See Oracle Call Interface (OCI).

ODBC

See Open Database Connectivity (ODBC).

object properties

Information about an object and attributes that the owner can assign to an object. Examples of properties include name, description, date stamps, read-only access, and do not index flag.

See also permissions.

objective

A required or desired outcome in a scorecard that forms your corporate strategy.

See also initiative and Oracle Scorecard and Strategy Management.

offline mode

In the Oracle BI Administration Tool, a mode where a repository builder can edit a repository that is not loaded into the Oracle BI Server.

online mode

In the Oracle BI Administration Tool, a mode where a repository builder can edit a repository while it is available for query operations. Online mode also allows user session monitoring for users connected to the subject areas in the repository.

opaque view

A Physical layer table that consists of a SELECT statement. In the Oracle BI repository, opaque views appear as view tables in the physical databases, but the view does not actually exist.

Open Database Connectivity (ODBC)

A standard interface used to access data in both relational and nonrelational databases. Database applications can use ODBC to access data stored in different types of database management systems, even if each database uses a different data storage format and programming interface.

OPMN

See Oracle Process Manager and Notification Server (OPMN).

Oracle BI Administration Tool

A Windows application that is used to create and edit Oracle BI repositories. The Administration Tool provides a graphical representation of the three parts of a repository: the Physical layer, the Business Model and Mapping layer, and the Presentation layer.

Oracle BI Briefing Books

A collection of static or updatable snapshots of dashboard pages, individual analyses, and BI Publisher reports. You can download briefing books in PDF or MHTML format for printing and viewing. You also can update, schedule, and deliver briefing books using agents.

Oracle BI JavaHost

A service that gives Presentation Services the ability to use functionality that is provided in Java libraries to support components such as graphs. The services are provided based on a request-response model.

Oracle BI Logical SQL View Object

Provides the developer the ability to create a Logical SQL statement to access the Oracle BI Server and fetch business intelligence data and bind it to native ADF components for inclusion on an ADF page. This view object uses a BI JDBC connection to the Oracle BI Server.

Oracle BI Presentation Catalog

Stores business intelligence objects, such as analyses and dashboards, and provides an interface where users create, access, and manage objects, and perform specific object-based tasks (for example, export, print, and edit). The catalog is organized into folders that are either shared or personal.

Oracle BI Presentation Services

Provides the framework and interface for the presentation of business intelligence data to Web clients. It maintains a Presentation Catalog service on the file system for the customization of this presentation framework. It is a standalone process and communicates with the Oracle BI Server using ODBC over TCP/IP. It consists of components that are known as Answers, Delivers, and Interactive Dashboards.

See also ODBC; Oracle BI Server; Oracle BI Presentation Catalog; Oracle BI Presentation Services server.

Oracle BI Presentation Services server

The Oracle BI Web server that exchanges information and data with the Oracle BI Server.

Oracle BI Publisher

A J2EE application that provides enterprise-wide publishing services in Oracle Business Intelligence. It generates highly formatted, pixel-perfect reports.

See also report.

Oracle BI Publisher report

See report.

Oracle BI repository

The set of Oracle Business Intelligence metadata that defines logical schemas, physical schemas, physical-to-logical mappings, aggregate table navigation, and other constructs. Oracle BI repositories can be in binary (RPD) format, in which repository metadata is contained in a single file with an extension of .rpd, or in a set of MDS XML documents. MDS XML format repositories are used for offline development only and cannot be loaded into the Oracle BI Server. Oracle BI repositories in both formats can be edited using the Oracle BI Administration Tool.

See also metadata and Oracle BI Administration Tool.

Oracle BI Scheduler

An extensible scheduling application for scheduling results to be delivered to users at specified times. It is the engine behind the Oracle BI Delivers feature.

See also results.

Oracle BI Server

A standalone process that maintains the logical data model that it provides to Presentation Services and other clients through ODBC. Metadata is maintained for the data model in a local proprietary file called the repository file. The Oracle BI Server processes user requests and queries underlying data sources.

Oracle BI Server XML API

Provides utilities to create a generic, XML-based representation of the Oracle BI repository metadata. You can use this XML file version of the repository to programmatically modify the metadata. The Oracle BI Server XML API objects correspond to metadata repository objects in an RPD file. These objects differ from XML objects in the Oracle BI Presentation Catalog.

The XML generated by the Oracle BI Server XML API is different from the MDS XML format used for Oracle BI repositories integrated with third-party source control management systems.

See also MDS XML.

Oracle Business Intelligence Mobile

Oracle Business Intelligence Mobile allows you to view Oracle BI EE content on supported mobile devices such as the Apple iPhone and Apple iPad.

Using Oracle Business Intelligence Mobile, you can view and analyze BI content such as analyses and dashboards, BI Publisher content, scorecard content, and content delivered by agents.

Oracle Business Intelligence Web Services

See Oracle Business Intelligence Session-Based Web Services and Oracle Business Intelligence Web Services for SOA.

Oracle Business Intelligence Session-Based Web Services

An API that implements SOAP. These Web services are designed for programmatic use, where a developer uses one Web service to invoke many different business intelligence objects. These Web services provide functionality on a wide range of Presentation Services operations. These Web services enable the developer to extract results from Oracle BI Presentation Services and deliver them to external applications, perform Presentation Services management functions, and execute Oracle Business Intelligence alerts (known as Intelligent Agents).

See also Oracle Business Intelligence Web Services for SOA.

Oracle Business Intelligence Web Services for SOA

Contains three Web services, ExecuteAgent, ExecuteAnalysis, and ExecuteCondition, which are hosted by the bimiddleware J2EE application. These web services are designed to enable developers to use third-party Web services clients (for example, Oracle SOA Suite) to browse for and include business intelligence objects in service oriented architecture components.

See also Oracle Business Intelligence Session-Based Web Services.

Oracle Call Interface (OCI)

A connection interface that the Oracle BI Server can use to connect to Oracle Database data sources. You should always use OCI when importing metadata from or connecting to an Oracle Database.

Oracle OLAP

Oracle Database has an OLAP Option that provides an embedded, full-featured online analytical processing server.

Oracle Business Intelligence supports Oracle OLAP as a data source. When you import metadata from an Oracle OLAP source, the Oracle OLAP objects appear in the Physical layer of the Administration Tool. Oracle OLAP objects include Analytic Workspaces, which are containers for storing related cubes.

Oracle Process Manager and Notification Server (OPMN)

A process management tool that manages all system components (server processes), and supports both local and distributed process management, automatic process recycling and the communication of process state (up, down, starting, stopping). OPMN detects process unavailability and automatically restarts processes).

See also system components.

Oracle Scorecard and Strategy Management

A performance management tool that lets you describe and communicate your business strategy. You can drive and assess your corporate strategy and performance from the top of your organization down, or from the bottom up.

Oracle Technology Network (OTN)

A repository of technical information about Oracle's products where you can search for articles, participate in discussions, ask the user community technical questions, and search for and download Oracle products and documentation.

parent-child hierarchy

A hierarchy of members that all have the same type. All the dimension members of a parent-child hierarchy occur in a single data source. In a parent-child hierarchy, the inter-member relationships are parent-child relationships between dimension members.

See also dimension.

parent-child relationship table

A table with values that explicitly define the inter-member relationships in a parent-child hierarchy. Also called a closure table.

pass-through calculation

A calculation that is not computed by the Oracle BI Server but instead is passed to another data source. Enables advanced users to leverage data source features and functions without the need to modify the Oracle BI repository.

permissions

Specify which users can access an object, and limit how users can interact with an object. Examples of permissions include write, delete, and change permissions.

See object properties.

perspective

A category in your organization with which to associate initiatives, objectives, and KPIs in a scorecard. A perspective can represent a key stakeholder (such as a customer, employee, or shareholder/financial) or a key competency area (such as time, cost, or quality).

See also initiative, key performance indicator (KPI), objective, and Oracle Scorecard and Strategy Management.

physical catalog

An object in the Physical layer of an Oracle BI repository that groups different schemas. A catalog contains all the schemas (metadata) for a database object.

physical display folder

Folders that organize objects in the Physical layer of an Oracle BI repository. They have no metadata meaning.

physical join

Joins between tables in the Physical layer of an Oracle BI repository.

Physical layer

A layer of the Oracle BI repository that contains objects that represent physical data constructs from back-end data sources. The Physical layer defines the objects and relationships available for writing physical queries. This layer encapsulates source dependencies to enable portability and federation.

physical schema

An object in the Physical layer of an Oracle BI repository that represents a schema from a back-end database.

physical table

An object in the Physical layer of an Oracle BI repository, usually corresponding to a table that exists in a physical database.

See also Physical layer.

presentation hierarchy

An object in the Presentation layer of an Oracle BI repository that provides an explicit way to expose the multidimensional model in Presentation Services and other clients. Presentation hierarchies expose analytic functionality such as member selection, custom member groups, and asymmetric queries. Users can create hierarchy-based queries using presentation hierarchies.

In Presentation Services, presentation hierarchies are displayed as hierarchical columns.

See also hierarchical column and presentation level.

Presentation layer

Provides a way to present customized, secure, role-based views of a business model to users. It adds a level of abstraction over the Business Model and Mapping layer in the Oracle BI repository. The Presentation layer provides the view of the data seen by users who build analyses in Presentation Services and other client tools and applications.

See also Business Model and Mapping layer.

presentation level

In the Oracle BI repository, a component of a presentation hierarchy that either rolls up or is rolled up from other levels. Presentation levels are displayed as levels within hierarchical columns in Presentation Services.

See also hierarchy level and presentation hierarchy.

Presentation Services

See Oracle BI Presentation Services.

Presentation Services server

See Oracle BI Presentation Services server.

presentation table

An object in the Presentation layer of an Oracle BI repository that is used to organize columns into categories that make sense to the user community. A presentation table can contain columns from one or more logical tables. The names and object properties of the presentation tables are independent of the logical table properties.

primary key

A column (or set of columns) where each value is unique and identifies a single row of a table.

process instance

A unique process on an individual workstation that is associated with a BI instance.

See also BI instance.

prompt

A type of filter that enables the content designer to build and specify data values or the end user to choose specific data values to provide a result sets for an individual analysis or multiple analyses included on a dashboard or dashboard page. A prompt expands or refines existing dashboard and analysis filters.

The types of prompts are column prompts, currency prompts, image prompts, and variable prompts.

See also column prompt, currency prompt, filter, image prompt, and variable prompt.

prompted link

Captures the path to a dashboard page and a simplified presentation of the dashboard prompt.

See bookmark link.

query

Contains the underlying SQL statements that are issued to the Oracle BI Server. You do not have to know a query language to use Oracle Business Intelligence.

query cache

A facility to store query results for use by other queries.

ragged hierarchy

See unbalanced hierarchy.

report

The response returned to the user from the execution of a query created using Oracle BI Publisher. Reports can be formatted, presented on a dashboard page, saved in the Oracle BI Presentation Catalog, and shared with other users.

See also analysis.

repository

See Oracle BI repository.

repository variable

See variable.

results

The output returned from the Oracle BI Server for an analysis.

See also analysis.

scorecard

See Oracle Scorecard and Strategy Management.

selection step

A choice of values that is applied after the query is aggregated that affects only the members displayed, not the resulting aggregate values. Along with filters, selection steps restrict the results for an analysis.

See also analysis and filter.

session variable

See variable.

skip-level hierarchy

A hierarchy where some members do not have a value for a particular ancestor level. For example, in the United States, the city of Washington in the District of Columbia does not belong to a state. The expectation is that users can still navigate from the country level (United States) to Washington and below without the need for a state.

See also hierarchy.

snowflake schema

A dimensional schema where one or more of the dimensions are partially or completely normalized.

SQL

See structured query language (SQL).

star schema

A relational schema that allows dimensional analysis of historical information. Star schemas have one-to-many relationships between the logical dimension tables and the logical fact table. Each star consists of a single fact table joined to a set of denormalized dimension tables.

strategy map

A component of a scorecard that shows how the objectives that have been defined for a scorecard and the KPIs that measure their progress are aligned by perspectives. It also shows cause and effect relationships.

See also Oracle Scorecard and Strategy Management.

strategy tree

A component of a scorecard that shows an objective and its supporting child objectives and KPIs hierarchically in a tree diagram.

See also Oracle Scorecard and Strategy Management.

structured query language (SQL)

A standard programming language for querying and modifying data. Oracle Business Intelligence supports standard SQL-92 with several value-added proprietary extensions.

See also Logical SQL.

subject area

In an Oracle BI repository, an object in the Presentation layer that organizes and presents data about a business model. It is the highest-level object in the Presentation layer and represents the view of the data that users see in Presentation Services. Oracle BI repository subject areas contain presentation tables, presentation columns, and presentation hierarchies.

In Presentation Services, subject areas contain folders, measure columns, attribute columns, hierarchical columns, and levels.

system components

Server processes (not Java applications) that are managed by the Oracle Process Manager and Notification server (OPMN).

See also Oracle Process Manager and Notification Server (OPMN).

transformation

Work that is performed on data when moving from a database to another location (sometimes another database). Some transformations are typically performed on data when it is moved from a transaction system to a data warehouse system.

unbalanced hierarchy

A hierarchy where the leaves do not have the same depth. For example, an organization might choose to have data for the current month at the day level, data for the previous at the month level, and data for the previous five years at the quarter level.

See also hierarchy.

value hierarchy

See parent-child hierarchy.

variable

Objects in an Oracle BI repository that are used to streamline administrative tasks and dynamically modify metadata content to adjust to a changing data environment.

Variables are of the following types:

Repository variables have a single value at any point in time. There are two types of repository variables: static and dynamic.

Session variables are created and assigned a value when each user logs on. There are two types of session variables: system and nonsystem.

variable prompt

Enables the user to select a value specified in the variable prompt to display on the dashboard. A variable prompt is not dependent upon column data, but enables you to manipulate, for example add or multiply, the column data on an analysis.

See also prompt.

virtual physical table

A physical table that is made from a stored procedure or a SELECT statement. Creating virtual tables can provide the Oracle BI Server and the underlying databases with the proper metadata to perform some advanced query requests.

vision statement

A short statement in a scorecard that describes what your organization wants to become sometime in the future. For example, it might be to become the most successful business in the South America Polypropylene Market.

See also mission statement and Oracle Scorecard and Strategy Management.

WebLogic server domain

Contains Java components that are configured to participate in the servicing of SOAP, HTTP, and other forms of requests.

WebLogic Scripting Tool (WLST)

A command-line scripting interface that enables you to configure, manage, and persist changes to WebLogic Server instances and domains and to monitor and manage server run-time events.

XML API

See Oracle BI Server XML API.

Index

A  B  C  D  G  H  I  J  L  M  N  O  P  Q  S  T  U  V  W  X 

A

Administration Tool, using for repository development, 1.5

aggregation rule element

in MDS XML schema, 2.12

in XML schema, 7.12

APIs

Oracle BI Server XML API, 6.1

appending objects, using Oracle BI Server XML API, 6.1.1

application roles

managing, 1.5

B

bi-init, 1.2.2, 1.2.2, 6.2, 6.2

biserverxmlcli command-line tool, using, 6.2.3

biserverxmlexec command-line tool, using, 6.2.2

biserverxmlgen command-line tool

for generating MDS XML, 1.2.2

for generating XML, 6.2.1

business model element

in MDS XML schema, 2.2

in XML schema, 7.2

C

catalog link element

in MDS XML schema, 5.1.1

in XML schema, 10.1.1

certification information, 1.6

column mapping element

in MDS XML schema, 2.9.1

in XML schema, 7.9.1

command-line tools

biserverxmlcli, 6.2.3

biserverxmlexec, 6.2.2

biserverxmlgen, 1.2.2, 6.2.1

complex join element

in MDS XML schema, 3.10

in XML schema, 8.10

connection pool element

in MDS XML schema, 3.7

in XML schema, 8.7

connection pool settings, updating using Oracle BI Server XML API, 6.3.5

cube column element

in MDS XML schema, 3.15

in XML schema, 8.15

cube table element

in MDS XML schema, 3.11

in XML schema, 8.11

custom authenticator element

in MDS XML schema, 5.2.4

in XML schema, 10.2.4

D

data sources

supported by Oracle Business Intelligence, 1.6

database element

in MDS XML schema, 3.1

in XML schema, 8.1

databases, supported, 1.6

DB sign-on element

in MDS XML schema, 5.2.10

in XML schema, 10.2.10

dimension element

in MDS XML schema, 2.5

in XML schema, 7.5

DSNs, setting up for the Oracle BI Server, 1.5

G

generic elements and attributes, for Oracle BI Server XML API, 1.3, 6.4

group element

in MDS XML schema, 5.2.9

in XML schema, 10.2.9

groups, managing, 1.5

H

hardware requirements, 1.6

I

id, about, 6.4.1

init block element

in MDS XML schema, 5.2.3

in XML schema, 10.2.3

installation types, supported, 1.6

J

JDKs, supported, 1.6

L

LDAP server element

in MDS XML schema, 5.2.2

in XML schema, 10.2.2

list catalog element

in MDS XML schema, 5.1.3

in XML schema, 10.1.3

logging, managing, 1.5

logical column element

in MDS XML schema, 2.1

in XML schema, 7.1

logical complex join element

in MDS XML schema, 2.3

in XML schema, 7.3

logical display folder element

in MDS XML schema, 2.14

in XML schema, 7.14

logical elements, for Oracle BI Server MDS XML API, 2

logical elements, for Oracle BI Server XML API, 7

logical foreign key element

in MDS XML schema, 2.7

in XML schema, 7.7

logical key element

in MDS XML schema, 2.8

in XML schema, 7.8

logical level element

in MDS XML schema, 2.4

in XML schema, 7.4

logical source folder element

in MDS XML schema, 2.10

in XML schema, 7.10

logical table element

in MDS XML schema, 2.6

in XML schema, 7.6

logical table source element

in MDS XML schema, 2.9

in XML schema, 7.9

M

marketing elements elements, for Oracle BI Server MDS XML API, 5.1

marketing elements elements, for Oracle BI Server XML API, 10.1

MDS XML APIs

Oracle BI Server MDS XML API, 1.1

MDS XML schema

aggregation rule element, 2.12

business model element, 2.2

catalog link element, 5.1.1

column mapping element, 2.9.1

complex join element, 3.10

connection pool element, 3.7

cube column element, 3.15

cube table element, 3.11

custom authenticator element, 5.2.4

database element, 3.1

DB sign-on element, 5.2.10

dimension element, 2.5

group element, 5.2.9

init block element, 5.2.3

LDAP server element, 5.2.2

list catalog element, 5.1.3

logical column element, 2.1

logical complex join element, 2.3

logical display folder element, 2.14

logical foreign key element, 2.7

logical key element, 2.8

logical level element, 2.4

logical source folder element, 2.10

logical table element, 2.6

logical table source element, 2.9

measure definition element, 2.11

object privilege element, 5.2.6

override aggregation rule element, 2.13

physical catalog element, 3.2

physical column element, 3.6

physical dimension element, 3.12

physical display folder element, 3.4

physical foreign key element, 3.9

physical hierarchy element, 3.13

physical key element, 3.8

physical level element, 3.14

physical schema element, 3.3

physical table element, 3.5

presentation catalog element, 4.1

presentation column element, 4.3

presentation hierarchy element, 4.4

presentation level element, 4.5

presentation table element, 4.2

privilege package element, 5.2.5

project element, 5.3.1

qualified list item element, 5.1.4

qualifying key element, 5.1.5

query object element, 5.3.2

query privilege element, 5.2.7

sampling table element, 5.1.6

seg catalog element, 5.1.7

target level element, 5.1.2

user element, 5.2.8

variable element, 5.2.1

MDS XML, generating and executing with Oracle BI Server MDS XML API, 1.2

mdsid, about, 1.3.1

measure definition element

in MDS XML schema, 2.11

in XML schema, 7.11

memory requirements, 1.6

migrating from test to production environments, 6.3.5

migrating metadata, with Oracle BI Server XML API, 6.3.2

minimum disk space requirements, 1.6

N

naming restrictions for repository objects, 6.4.2

NQSConfig.INI

using, 1.5

O

object identifiers, for Oracle BI Server MDS XML API, 1.3.1

object identifiers, for Oracle BI Server XML API, 6.4.1

object privilege element

in MDS XML schema, 5.2.6

in XML schema, 10.2.6

ODBC DSN

for the Oracle BI Server, 1.5

operating systems, supported, 1.6

Oracle BI repository

maintaining versions with Oracle BI Server XML API, 6.3.1

programmatically updating connection pool settings, 6.3.5

programmatically updating using Oracle BI Server XML API, 6.3.4

Oracle BI repository, designing and building, 1.5

Oracle BI Server

ODBC DSN configuration, 1.5

starting and stopping, 1.5

Oracle BI Server MDS XML API

about, 1.1

about object identifiers, 1.3.1

command-line tool, 1.2.2

Oracle BI Server MDS XML API elements

logical elements, 2

marketing elements, 5.1

other elements, 5.3

physical elements, 3

presentation elements, 4

security elements, 5.2

Oracle BI Server Web services, using, 1.5

Oracle BI Server XML API

about, 6.1

about object identifiers, 6.4.1

applying patches to online repositories, 6.3.3

command-line tools, 6.2

maintaining RPD versions with, 6.3.1

programmatically updating repositories, 6.3.4

using to append objects, 6.1.1

using to migrate metadata, 6.3.2

using to migrate to production environments, 6.3.5

using XSL with, 6.3.6

Oracle BI Server XML API elements

generic elements and attributes, 1.3, 6.4

logical elements, 7

marketing elements, 10.1

other elements, 10.3

physical elements, 8

presentation elements, 9

security elements, 10.2

Oracle Business Intelligence

logging, 1.5

starting and stopping, 1.5

Oracle WebLogic Server, managing, 1.5

other elements, for Oracle BI Server MDS XML API, 5.3

other elements, for Oracle BI Server XML API, 10.3

override aggregation rule element

in MDS XML schema, 2.13

in XML schema, 7.13

P

patches, applying to online repositories using Oracle BI Server XML API, 6.3.3

physical catalog element

in MDS XML schema, 3.2

in XML schema, 8.2

physical column element

in MDS XML schema, 3.6

in XML schema, 8.6

physical dimension element

in MDS XML schema, 3.12

in XML schema, 8.12

physical display folder element

in MDS XML schema, 3.4

in XML schema, 8.4

physical elements, for Oracle BI Server MDS XML API, 3

physical elements, for Oracle BI Server XML API, 8

physical foreign key element

in MDS XML schema, 3.9

in XML schema, 8.9

physical hierarchy element

in MDS XML schema, 3.13

in XML schema, 8.13

physical key element

in MDS XML schema, 3.8

in XML schema, 8.8

physical level element

in MDS XML schema, 3.14

in XML schema, 8.14

physical schema element

in MDS XML schema, 3.3

in XML schema, 8.3

physical table element

in MDS XML schema, 3.5

in XML schema, 8.5

platforms, supported, 1.6

presentation catalog element

in MDS XML schema, 4.1

in XML schema, 9.1

presentation column element

in MDS XML schema, 4.3

in XML schema, 9.4

presentation elements, for Oracle BI Server MDS XML API, 4

presentation elements, for Oracle BI Server XML API, 9

presentation hierarchy element

in MDS XML schema, 4.4

in XML schema, 9.5

presentation level element

in MDS XML schema, 4.5

in XML schema, 9.6

presentation table element

in MDS XML schema, 4.2

in XML schema, 9.3

privilege package element

in MDS XML schema, 5.2.5

in XML schema, 10.2.5

processes, starting and stopping, 1.5

production environments, moving to, 1.5

project element

in MDS XML schema, 5.3.1

in XML schema, 10.3.1

Q

qualified list item element

in MDS XML schema, 5.1.4

in XML schema, 10.1.4

qualifiedName, about, 6.4.1

qualifying key element

in MDS XML schema, 5.1.5

in XML schema, 10.1.5

query object element

in MDS XML schema, 5.3.2

in XML schema, 10.3.2

query privilege element

in MDS XML schema, 5.2.7

in XML schema, 10.2.7

S

sampling table element

in MDS XML schema, 5.1.6

in XML schema, 10.1.6

schema document, for Oracle BI Server XML API, 6.1

security

managing, 1.5

security elements, for Oracle BI Server MDS XML API, 5.2

security elements, for Oracle BI Server XML API, 10.2

seg catalog element

in MDS XML schema, 5.1.7

in XML schema, 10.1.7

software requirements, 1.6

source control management, using for repository development, 1.5

starting Oracle Business Intelligence processes, 1.5

stopping Oracle Business Intelligence processes, 1.5

system requirements, 1.6

T

target level element

in MDS XML schema, 5.1.2

in XML schema, 10.1.2

test to production, 1.5

third-party products, supported, 1.6

U

uid, about, 6.4.1

user element

in MDS XML schema, 5.2.8

in XML schema, 10.2.8

users, managing, 1.5

V

variable element

in MDS XML schema, 5.2.1

in XML schema, 10.2.1

W

Web services, for Oracle BI Server, 1.5

X

XML API

See Oracle BI Server XML API

XML schema

aggregation rule element, 7.12

business model element, 7.2

catalog link element, 10.1.1

column mapping element, 7.9.1

common elements and attributes, 1.3, 6.4

complex join element, 8.10

connection pool element, 8.7

cube column element, 8.15

cube table element, 8.11

custom authenticator element, 10.2.4

database element, 8.1

DB sign-on element, 10.2.10

dimension element, 7.5

group element, 10.2.9

init block element, 10.2.3

LDAP server element, 10.2.2

list catalog element, 10.1.3

logical column element, 7.1

logical complex join element, 7.3

logical display folder element, 7.14

logical foreign key element, 7.7

logical key element, 7.8

logical level element, 7.4

logical source folder element, 7.10

logical table element, 7.6

logical table source element, 7.9

measure definition element, 7.11

object privilege element, 10.2.6

override aggregation rule element, 7.13

physical catalog element, 8.2

physical column element, 8.6

physical dimension element, 8.12

physical display folder element, 8.4

physical foreign key element, 8.9

physical hierarchy element, 8.13

physical key element, 8.8

physical level element, 8.14

physical schema element, 8.3

physical table element, 8.5

presentation catalog element, 9.1

presentation column element, 9.4

presentation hierarchy element, 9.5

presentation level element, 9.6

presentation table element, 9.3

privilege package element, 10.2.5

project element, 10.3.1

qualified list item element, 10.1.4

qualifying key element, 10.1.5

query object element, 10.3.2

query privilege element, 10.2.7

sampling table element, 10.1.6

seg catalog element, 10.1.7

target level element, 10.1.2

user element, 10.2.8

variable element, 10.2.1

XML, generating and executing with Oracle BI Server XML API, 6.2

XSL, using with Oracle BI Server XML API, 6.3.6

xudml_mds_admin.xsd file, 1.1

xudml_mds_core.xsd file, 1.1

xudml1.xsd file, 6.1

Shows the updated repository in the Administration Tool, with details for the new Billed Qty object shown in the Presentation Column dialog.

Shows the Presentation Column dialog in the Administration Tool for the Billed Qty object.

Shows the Administration Tool main window with a logical column called 2-01 Billed Qty (Sum All). The image highlights the fact that there is no corresponding presentation column.

Shows a directory listing for C:\SampleApp_MDS\oracle\bi\server\base.

Under the Name column, the folder names for the sub-directories are:

Database

BusinessModel

ComplexJoin

ConnectionPool

CubeTable

InitBlock

PhysicalCatalog

PhysicalDimension

PhysicalHierarchy

PhysicalTable

Schema

Variable

Dimension

LogicalLevel

LogicalTable

LogicalSourceFolder

LogicalTableSource

AggrRule

LogicalComplexJoin

MeasureDefn

PresentationCatalog

Group

ObjectPrivilege

PresentationHierarchy

PresentationLevel

PresentationTable

PrivilegePackage

Project

QualifiedListItem

QualifyingKey

QueryPrivilege

SegCatalog

TargetLevel

User

The left-hand side shows a directory hierarchy, starting with the folder oracle.

The folder bi is indented under oracle.

The folder server is indented under bi.

The folder base is indented under server.

Under the folder base, an indented column of sub-directory names appears, with the following folder names:

AggrRule

Business Model (this value is highlighted as white text on a blue background)

ComplexJoin

ConnectionPool

CubeTable

Database

Dimension

Group

InitBlock

LogicalComplexJoin

LogicalLevel

LogicalSourceFolder

LogicalTable (this value is highlighted as white text on a blue background)

LogicalTableSource (this value is highlighted as white text on a blue background)

MeasureDefn

ObjectPrivilege

PhysicalCatalog

PhysicalDimension

PhysicalHierarchy

PhysicalTable

The right-hand side contains three lists of file names, each of which correspond to and show individual file names for one of the highlighted sub-directory names on the left-hand side.

In each file name list, one of the file names is highlighted with a red surrounding box.

From each highlighted sub-directory name on the left-hand side, a red connector line joins the sub-directory name to the red-boxed file name in the corresponding file name list on the right-hand side, as follows:

The BusinessModel sub-directory connects to the file Fusion Order Demo_80cbbdd2-07d0-0000-714b-e31d00000000.xml

The LogicalTable sub-directory connects to the file F2 Coupon Usages_80cbbde8-07f3-0000-714b-e31d00000000.xml

The LogicalTableSource sub-directory connects to the file COUPON_USAGES_80cbc055-07f5-0000-714b-e31d00000000.xml

Shows the Compare repositories dialog, with the two modified connection pool objects shown.

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2010, Oracle and/or its affiliates. All rights reserved.

License Restrictions Warranty/Consequential Damages Disclaimer

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

Warranty Disclaimer

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

Restricted Rights Notice

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

Hazardous Applications Notice

This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.

Trademark Notice

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Third-Party Content, Products, and Services Disclaimer

This software and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.