Warehouse Builder - SDK Main Page

Oracle Warehouse Builder 10g

Software Development Kit

The Oracle Warehouse Builder Software Development Kit (SDK) is a robust framework to extend the capabilities of Warehouse Builder. On this page, you will find technical information and sample code to help add functionality to the already extensive design, ETL and runtime capabilities of Warehouse Builder. With more than twenty different APIs covering the entire product you will be able to extent the product allowing you to solve these specific requirements for your project in a timely and scalable manner.

Metadata Access
and Exchange
Metadata Extensibility Data Quality Runtime Management Web Services Gateways

Metadata Access and Exchange

Metadata plays a pivotal role in any Warehouse Builder project and a lot of time and effort is spent on creating and managing metadata. While Warehouse Builder comes with a set of pre-built reports, there is more information available in the repository and the metadata access APIs allow you to customize your metadata reporting for both the design and runtime repository.

If your solution incorporates third party tools for querying or designing, these exchange APIs allow you to load metadata from Warehouse Builder into any third party tool and load data from any design tool into Warehouse Builder.

Within Metadata Access and Exchange Warehouse Builder delivers the following set of APIs:

The public SQL views on the repository schema for Warehouse Builder allow any user or partner a read-only query mechanism to the Warehouse Builder metadata (Documentation link). This API is exceptionally suited to create custom queries or reporting solutions on the Warehouse Builder metadata.

Virtually all actions available to the user in the graphical user interface are available in a scripting language allowing any customer or partner to write scripts to create and manipulate metadata.

Back to Top

Metadata Extensibility

In some cases it is important to add metadata to the Warehouse Builder repository that is not natively available within the product. The extensibility APIs allow you to create custom objects and/or attributes within the repository. Once you have created or registered these new objects Warehouse Builder will allow you to report on them as if these were internal Warehouse Builder objects.

This in turn allows you to complete your lineage information or register impact on objects not defined in Warehouse Builder.

To enable customers and partners to link in their own security, Warehouse Builder provides the possibility to extend the security rules in the repository.

The metadata extensibility APIs are:

User defined properties provide the first step in extending the repository. Using user defined properties allows you to add additional metadata to any of the repository objects. Interesting capabilities include adding a URL to an object for more documentation.

Back to Top

Data Quality

Much has been said about Data Quality in the past. Warehouse Builder is one of the few ETL tools in the market that allow any data quality vendor to implement a solution underneath the Warehouse Builder ETL tool.

This data quality API allows customers to choose or retain their data quality vendor of choice while utilizing the power of Warehouse Builder and the Oracle Database. Data Quality vendors can use this API to promote their products as a partner of Oracle.

The Data Quality API is a way to link data libraries into the Warehouse Operators:

Data Quality Integration

This Java API allows a partner to link postal data sets into the Warehouse Builder Name & Address operator. When linked the operator will perform data cleansing based on the linked libraries. The data quality APIs are already used by some of our data quality partners.

To download the validation kit and documentation to start your validation click here. This file provides you with:

  • The requirements for your solution to be validated
  • The API (service provider interface) documentation
  • Approriate Java Classes for the provider interface
  • Test metadata (OWB Mappings) for release 10.2
  • Test data set (both US and World)

To use these APIs it is required that you are an official Oracle Partner and registered with the Oracle Partner Network. Before you can claim validation status it is required to run a press release through Oracle Partner Network.

Back to Top

Runtime Management

The runtime management is handled out of the box by the Runtime Audit Browser. As the runtime engine is covered with Public Views customers and partners can create their own reporting environment on these SQL views. Using these SQL views the users can create their own exceptions reporting and their own statistics all on a supported set of queries.

Another part of the runtime platform is the modularity with which the platform is built. The code generators and the scheduling and process flow code are extensible and can allow the customer or partner to plug in their own adapters.

This API essentially allows anyone to create a complete warehouse management system based on out-of-the-box components.

The APIs available on the runtime platform allow customers and partners to create their own utilities to monitor their ETL process and the data warehouse:

The public SQL views on the repository schema for Warehouse Builder allow any user or partner a read-only query mechanism to the Warehouse Builder metadata (Documentation link). This API is exceptionally suited to create custom queries or reporting solutions on the Warehouse Builder metadata.

On the runtime side of things scripting is very useful to automate tasks, like for example moving from Development to Production or to automate deployment of a solution.

Back to Top

Web Services

Within Warehouse Builder you can publish a mapping or a process flow as a web service. Once you have published a mapping or process flow as a web service you can call the functionality within these components from any application.

This in turn allows you to utilize the data integration and cleansing capabilities of Warehouse Builder outside of the realm of traditional data warehouse projects. For example it will be possible to embed the name and address cleansing capabilities from mappings into a customer registration web site.

For this API you will need a combination of Oracle JDeveloper and Oracle Warehouse Builder.

The web services API is a java based implementation allowing you to publish both on the internet and intranet.

Learn how you can publish mappings and process flows as web services using Warehouse Builder. The description of this API covers all steps required to publish your transformations as web services.

Back to Top

Gateways

One of the key requirements in ETL is to get access to various data sources. In some cases this can be achieved by gateways.

In the Warehouse Builder case, a gateway will translate the catalog and queries between a legacy system and Oracle. This way Warehouse Builder can read metadata from non-Oracle systems, and then use regular mappings (SQL and PL/SQL) to read data from the legacy system into Oracle just as if it was Oracle to Oracle data movement.

This SDK section allows you to self-certify your gateway solution with Oracle Warehouse Builder. By doing so customers can utilize your gateway in combination with a Warehouse Builder implementation.

If you have a gateway solution to non-Oracle platforms then take a look at the following self certification:

This section will provide you with:

  • The Validation Requirements for your gateway solution
  • The source data and metadata to document your test case
  • Scripts to deliver the test results to Oracle
  • Links to the Oracle Partner Network for the required press release

To use these APIs it is required that you are an official Oracle Partner and registered with the Oracle Partner Network. Before you can claim validation status it is required to run a press release through Oracle Partner Network.

Back to Top

E-mail this page
Printer View Printer View
Oracle Is The Information Company About Oracle | Oracle RSS Feeds | Careers | Contact Us | Site Maps | Legal Notices | Terms of Use | Privacy