Oracle Warehouse Builder

Software Development Kit



The Oracle Warehouse Builder Software Development Kit (SDK) is the collection of the frameworks and resources available to extend the capabilities of Warehouse Builder. On this page, you will find technical information, documentation, sample code and other developer-focused resources for the available extensibility mechanisms.



Platforms, Custom Metadata Importers, and Application Adapters

OWB 11gR2 adds support for custom platforms and custom metadata import using SQL queries or Java. OWB 10gR2 and greater support custom metadata import through application adapters that simplify access to the database of an ERP application for use as a source or a target. or targets in DW or data quality applications.

Documentation and samples that describe the use of these facilities are provided below.

The OWB 11gR2 capabilities are described in this paper.

Platform assistants for working with platform definitions and sample platform and application adapters are 

The capabilities of application connectors, the Custom Metadata Interface (CMI) syntax used to define them, and a working example are all provided in this whitepaper.

Back to Top  

ODI Knowledge Modules/Code Templates

Warehouse Builder 11gR2 features a code template system that incorporates a subset of Oracle Data Integrator (ODI) knowledge module (KM) technology, specifically supporting Load KMs (Load CTs), Integration KMs (Integration CTs), Journaling KMs (Journaling CTs, for Change Data Capture), and Check KMs (Control Code Templates). You can develop new ODI knowledge modules or OWB code templates to support new data integration techniques and support for new platforms.

Because the code template technology is based closely on ODI knowledge modules, the reference information for ODI KMs also applies to OWB.

A guide to developing knowledge modules. While the development work is performed in OWB's Code Template editor, the paradigm is essentially the same and the information here is generally applicable.

Knowledge Module
Reference Guide

An API reference for knowledge modules. A subset of the supported APIs is available when writing code templates. For details on the supported and unsupported functions, see the Warehouse Builder 11gR2 documentation.

Tools Reference Guide  Oracle Data Integrator Tools (also called Oracle Data Integrator Commands) are commands provided for performing specific tasks at run-time. These tasks may be as simple as waiting for a certain time or producing a sound, or as sophisticated as executing ANT Scripts or reading emails from a server. A subset of these tools is supported in OWB 11gR2. For details on the supported and unsupported tools, see the Warehouse Builder 11gR2 documentation.
Substitution Methods
Reference Guide
 This manual provides a reference of the Oracle Data Integrator substitution methods available when writing code templates. For details on the supported and unsupported substitution methods, see the Warehouse Builder 11gR2 documentation.
Jython Quick Reference  Jython is used in building code templates. As a convenience, a quick reference for the language is provided here.

Back to Top

 

Metadata Access and Exchange

Warehouse Builder's metadata repository provides extensive design-time and runtime information about all the objects in your project. While Warehouse Builder comes with a set of pre-built reports, there is more information available in the repository. 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.

The public SQL views on the OWB repository provide a read-only query mechanism to the Warehouse Builder metadata. Use these views to create custom queries or reporting solutions on the Warehouse Builder metadata.

See the product documentation for your release for more details

Scripting Language

Virtually all actions available to the user in the graphical user interface are available in the TCL-based OMB*Plus scripting language, allowing any customer or partner to write scripts to create and manipulate metadata. Some OWB features, such as platform definitions in OWB 11gR2, require the use of OMB*Plus.

Back to Top

Metadata Extensibility: User-Defined Objects and Properties

You can extend the OWB repository to model custom objects and attributes that are not natively defined in the product. Once you have created or registered these new objects, you can:

  • Report on them as if these were internal Warehouse Builder objects
  • Use them in data lineage and impact analysis

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

Repository Extensibility Cookbook  The Repository Extensibility Cookbook walks you through creating user-defined objects and properties and icons.
11gR2 UDO/UDP Documentation  User defined objects (UDOs) and properties (UDPs) let you model objects not created within OWB, add additional properties to OWB objects, and associate icons with UDOs for use in the OWB user interface. The OWB 11gR2 documentation covers these topics in depth.
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.

The APIs available that expose the OWB 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.

Scripting Language

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

Name and Address Cleansing Server Integration

Warehouse Builder provides a Java API for name and address cleansing vendors to expose their functionality in OWB mappings.

This Java API allows a partner to link name and address cleansing solutions with OWB, where they are exposed for use in cleansing mappings through the Name and Address operator. 

 

 

Name and Address Library Developer Kit

This file provides you with:

  • 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)
  • The requirements for your solution to be validated

To download the developer kit and documentation click here.

To use these APIs it is required that you are an official Oracle Partner and registered with the Oracle Partner Network. Contact OWB product management when you are ready for the validation process.

Back to Top

Gateway Certification with Warehouse Builder

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.

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

Web Services

NOTE: The functionality described in this section has been superseded in OWB 11gR2 by the built-in support for publishing Web services. For details see the OWB 11gR2 documentation.

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.

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