|Oracle® Fusion Middleware XML Schema Reference for Oracle Business Intelligence Enterprise Edition
11g Release 1 (11.1.1)
Part Number E23950-01
|PDF · Mobi · ePub|
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.
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:
The contents and structure of the Oracle BI Server MDS XML repository files are defined through the following schema element files:
These files contain the basic MDS XML grammar for the repository elements.
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:
You can view these files to see the relationships between MDS XML metadata objects, but you must not modify these files.
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:
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:
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
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:
All other installations:
At the command prompt, type biserverxmlgen with the desired options. You can also run biserverxmlgen with no arguments or parameters to see usage information.
biserverxmlgen -M -R repository_pathname [-P password] -D output_directory [-8] [-N] [-Q|-S]
-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.
-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.
-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
-S to control the generation of security objects:
-Q to generate output without security objects
-S to generate output for only security objects
If you use both
-S on the same call of biserverxmlgen, the second option on the call command takes precedence, and the first is ignored.
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
The only common element is the Description element. This element can hold a text string describing a particular object. For example:
<Description> <![CDATA[ Generated by Time Series Wizard ]]> </Description>
There are nine common attributes defined under the
object_t element. Table 1-1 lists these attributes.
Table 1-1 Common MDS XML Attributes in object_t
The name of the object.
Not used for MDS XML.
mdsid is a universally unique identifier, 37-characters long.
The index number for the icon of the object in the Administration Tool.
If set to
If set to
If set to
If set to
If set to
In addition to the common attributes defined in
object_t, an additional common attribute is defined in
ref_t. This attribute is used when one object references another object or set of objects. For example, business model objects reference the logical display folders contained in that business model, using the sub-element
All referenced sub-elements have the same common attribute refId shown in Table 1-2.
Table 1-2 Common MDS XML Attribute in ref_t
Consists of the mdsid of the referencing object and the mdsid of the referenced object, separated by "-".
Oracle BI Server MDS XML metadata objects have a single unique identifier:
This section illustrates the use of MDS XML identifiers and reference attributes for a Logical Table called F2 Coupon Usages.
The logical table F2 Coupon Usages has the following properties:
It contains four logical columns, including the column ORDER_ID
It has a logical key CUSTOMER_ID, that consists of the single logical column ORDER_ID
It is contained within the business model Fusion Order Demo
It has one logical table source COUPON_USAGES
The MDS XML elements to illustrate this example occur in three separate MDS XML files: a file that describes the logical table elements and two files that describe the associated business model and logical table source elements.
The focus of this example is the logical table file, especially the references in the file to related elements and attributes. The only details shown of the business model and logical table source files are those that illustrate relationships with the logical table.
As an overview, the following figure shows these three files highlighted within the general directory structure created when MDS XML is generated from an Oracle BI repository.
Figure 1-2 MDS XML Example Element Files
The contents of the main Logical Table file
F2 Coupon Usages_80cbbde8-07f3-0000-714b-e31d00000000.xml
appear in this section, with the mdsid of the logical table highlighted (the italicized line numbers have been inserted for easy element tag identification in the subsequent sections of this topic).
1 <?xml version="1.0" encoding="UTF-8" ?> 2 <LogicalTable mdsid="m80cbbde8-07f3-0000-714b-e31d00000000" 3 name="F2 Coupon Usages" 4 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 5 xmlns="http://www.oracle.com/obis/repository" 6 x="133" y="378" 7 subjectAreaRef="/oracle/bi/server/base/BusinessModel 8 /Fusion Order Demo_80cbbdd2-07d0-0000-714b-e31d00000000.xml# 9 m80cbbdd2-07d0-0000-714b-e31d00000000"> 10 <LogicalColumn mdsid="m80cbbefc-07d6-0000-714b-e31d00000000" 11 name="Applied Date" isWriteable="false"> 12 </LogicalColumn> 13 <LogicalColumn mdsid="m80cbbeff-07d6-0000-714b-e31d00000000" 14 name="# of Customers" isWriteable="false"> 15 </LogicalColumn> 16 <LogicalColumn mdsid="m80cbbf00-07d6-0000-714b-e31d00000000" 17 name="# of Coupons and Discounts" isWriteable="false"> 18 </LogicalColumn> 19 <LogicalColumn mdsid="m80cbbf04-07d6-0000-714b-e31d00000000" 20 name="Order ID" isWriteable="false"> 21 </LogicalColumn> 22 <LogicalKey mdsid="m80cbbf39-07d8-0000-714b-e31d00000000" 23 name="CUSTOMER_ID" isPrimary="true"> 24 <RefColumns> 25 <RefLogicalColumn 26 refId="m80cbbf39-07d8-0000-714b-e31d00000000- 27 m80cbbf04-07d6-0000-714b-e31d00000000" 28 logicalColumnRef="/oracle/bi/server/base/LogicalTable 29 /F2 Coupon Usages_80cbbde8-07f3-0000-714b-e31d00000000.xml# 30 m80cbbf04-07d6-0000-714b-e31d00000000" /> 31 </RefColumns> 32 </LogicalKey> 33 <RefTableSources> 34 <RefLogicalTableSource 35 refId="m80cbbde8-07f3-0000-714b-e31d00000000- 36 m80cbc055-07f5-0000-714b-e31d00000000" 37 logicalTableSourceRef= 38 "/oracle/bi/server/base/LogicalTableSource 39 /COUPON_USAGES_80cbc055-07f5-0000-714b-e31d00000000.xml# 40 m80cbc055-07f5-0000-714b-e31d00000000" /> 41 </RefTableSources> 42 </LogicalTable>
Reference from Logical Table to Business Model
subjectAreaRef attribute (lines 7 to 9) points to the file and mdsid that describe the related business model:
7 subjectAreaRef="/oracle/bi/server/base/BusinessModel 8 /Fusion Order Demo_80cbbdd2-07d0-0000-714b-e31d00000000.xml# 9 m80cbbdd2-07d0-0000-714b-e31d00000000">
Note that the file name includes most of the business model mdsid.
The Business Model file (full contents not shown here) contains the
BusinessModel tag, which includes the Business Model mdsid attribute:
<BusinessModel mdsid="m80cbbdd2-07d0-0000-714b-e31d00000000" name="Fusion Order Demo" .....
Reference from Logical Key to Logical Column (in current Logical Table)
The logical key tag (lines 22 to 32) contains the mdsid of the logical key.
22 <LogicalKey mdsid="m80cbbf39-07d8-0000-714b-e31d00000000" 23 name="CUSTOMER_ID" ...
In general, a logical key can consist of several logical columns. In this case, the logical key, CUSTOMER_ID, consists of one logical column, Order ID.
The logical column of the logical key CUSTOMER_ID is referenced in the
RefColumns tag (lines 24 to 31), and specifically the
24 <RefColumns> 25 <RefLogicalColumn 26 refId="m80cbbf39-07d8-0000-714b-e31d00000000- 27 m80cbbf04-07d6-0000-714b-e31d00000000" 28 logicalColumnRef="/oracle/bi/server/base/LogicalTable 29 /F2 Coupon Usages_80cbbde8-07f3-0000-714b-e31d00000000.xml# 30 m80cbbf04-07d6-0000-714b-e31d00000000" /> 31 </RefColumns>
logicalColumnRef (lines 28 to 30) points to the current Logical Table file (lines 28 to 29) and the mdsid that describe the logical column within the logical table that makes up the logical key (line 30).
The logical column mdsid (line 30) references the mdsid of the
LogicalColumn tag (lines 19 to 21), that appears just before the
LogicalKey tag in the current Logical Table file:
19 <LogicalColumn mdsid="m80cbbf04-07d6-0000-714b-e31d00000000" 20 name="Order ID" ...
refId value of the
RefLogicalColumn sub-element of the logical table (lines 26 to 27):
26 refId="m80cbbf39-07d8-0000-714b-e31d00000000- 27 m80cbbf04-07d6-0000-714b-e31d00000000"
consists of the mdsid of the logical key itself (line 22 of the logical table file, shown in bold at the beginning of this topic) and the mdsid of the logical column to which it refers (line 19 of the logical table file, shown in bold in the main body of this topic), separated by "-".
Reference from Logical Table to Logical Table Source
In general, a logical table can refer to several logical table sources. In this case, the logical table F2 Coupon Usages refers to the single logical table source COUPON_USAGES.
RefTableSources tag (lines 33 to 41) is a child element of the
LogicalTable tag. The explicit reference to the logical table source appears within the
33 <RefTableSources> 34 <RefLogicalTableSource 35 refId="m80cbbde8-07f3-0000-714b-e31d00000000- 36 m80cbc055-07f5-0000-714b-e31d00000000" 37 logicalTableSourceRef= 38 "/oracle/bi/server/base/LogicalTableSource 39 /COUPON_USAGES_80cbc055-07f5-0000-714b-e31d00000000.xml# 40 m80cbc055-07f5-0000-714b-e31d00000000" /> 41 </RefTableSources>
logicalTableSourceRef (lines 37 to 40) points to the file and the mdsid that describe the logical table source (note that the file name includes most of the logical table source mdsid).
The Logical Table Source file (full contents not shown here) contains the
LogicalTableSource tag, which includes the mdsid of the logical table source:
<LogicalTableSource mdsid="m80cbc055-07f5-0000-714b-e31d00000000" name="COUPON_USAGES" ...
refId value of the
RefLogicalTableSource sub-element of the logical table (lines 35 to 36):
35 refId="m80cbbde8-07f3-0000-714b-e31d00000000- 36 m80cbc055-07f5-0000-714b-e31d00000000"
consists of the mdsid of the logical table itself (shown in bold in line 2 of the logical table file listing, at the beginning of Section 1.4, "Example: Analysis of an MDS XML Logical Table Element") and the mdsid of the logical table source (shown in bold in the body of this topic), separated by "-".
Some topics that may be of interest to XML schema reference users are covered in other guides. Table 1-3 lists these topics, and indicates where to go for more information.
Table 1-3 Topics Covered in Other Guides
|Topic||Where to Go for More Information|
Refer to the system requirements and certification documentation for information about hardware and software requirements, platforms, databases, and other information. Both of these documents are available on Oracle Technology Network (OTN).