Skip navigation.
Downloads | Product Documentation | Support

Administration Guide

# Viewing Metadata

The Data Services Metadata Browser, a component of the AquaLogic Data Services Platform Console, enables you to view information on data services, their functions, and their dependencies in the currently active WebLogic Server.

This chapter describes how to use the Metadata Browser, and includes the following sections:

- Introducing the Metadata Browser
- Using the Metadata Browser
- Searching Metadata

# Introducing the Metadata Browser

The Metadata Browser enables you to view metadata related to a DSP (Data Services Platform) deployment. The information includes the data services that are deployed, their functions and return types, dependencies between data services, and more. Essentially, metadata documents the data model represented by the Data Services Platform deployment.

The Metadata Browser is particularly useful for:

- Data Services Platform administrators needing to gauge effects of changes to underlying data sources.
- Developers of Data Services Platform client applications wanting to determine what data services are available and their calling conventions.

You can use the Metadata Browser to access metadata in the following ways:

- Browse metadata by data service. You can display metadata associated with a specific data service. For more information, see Metadata Browser Interface for Data Services on page 8-3.
- Browse metadata associated with data service functions. You can display function metadata. For more information, see Metadata Browser Interface for Data Service Functions on page 8-9.
- Search for metadata in an application or project. You can perform basic or advanced searches on metadata in an application or in a project folder. For more information, see Searching Metadata on page 8-13.

# Using the Metadata Browser

You can use the Metadata Browser to introspect both data service metadata and function metadata.

## Metadata Browser Requirements for Data Lineage Graph

The Table 8-1 outlines the browser requirements to ensure visibility of the data lineage graph. If your system does not meet the requirements stated in the table, revert to the tabular view of the Metadata Browser.

The Adobe® SVG Viewer plugin required for Internet Explorer and Netscape can be downloaded from:

http://www.adobe.com/svg/viewer/install/main.html

Table 8-1 Browser Support Information for Viewing Data Lineage Graph

Browser (Version) | SVG Viewer Information | Additional Information
--- | --- | ---
Internet Explorer (6.0 and above) | Can auto-detect SVG viewer. If SVG viewer is not installed, a message is displayed with the URL to download the viewer. Install the viewer and the data lineage graph will be visible instantly. | On Windows platform only.
Netscape (8.0) | Can auto-detect SVG viewer. If SVG viewer is not installed, a message is displayed with the URL to download the viewer. Install the viewer and the data lineage graph will be visible instantly. | On Windows platform only. You need to add the URL to the list of trusted sites to view the data lineage graph. Perform the following steps: Click the Open Site Controls icon on the browser tab when you log in to the Administration Console. In the pop-up dialog box, select the I trust this site radio button. Click Done to save your preference. This will enable you to view the data lineage graph.
Mozilla Firefox (1.5) | Has native SVG viewer support. | On Windows and Linux platforms. The data lineage graph is visible without the zoom in or zoom out operations. However, you can scroll up and down using the scroll bar.

## Metadata Browser Interface for Data Services

You can browse data service metadata including general information about a specific data service, its data lineage, its read functions and return types, relationships, dependencies, and more using the Metadata tab in the DSP Console.

To browse data service metadata:

1. Select a data service in the Navigation pane. The Admin/Metadata screen appears (Figure 8-1). The Metadata tab in the console displays general information about the metadata associated with the data service.

Figure 8-1 Data Service Metadata

2. Click the corresponding tab to display general information, data service read functions, return type, relationships, properties, and data service lineage information. Table 8-2 describes the metadata information accessible through the tabs.

Table 8-2 Metadata Information

Tab | Description
--- | ---
General | Provides general configuration information about the data service, including the following: Name. The name of the data service. Description. A user-supplied description. Owner. The owner of the service. Creation Date. The date when the data service was created. Last Modified Date. The date on which the data service was last changed. Return Type. The type returned by the data service. Data Service Type. Either physical or logical. For more information about data service types, see Introspecting Data Service Metadata on page 8-7. Data Source Type. The type of the data source.
Read Functions | Displays a table of read functions. The table also lists the parameter names, if any, and return type (schema file name) for each function.
Return Type | Displays the content of the schema associated with the return type of the data service.
Relationships | Displays a table of related read functions. The table also lists the parameter names, if any, and return type (schema file name) for each function.
Properties | Lists any user-defined properties assigned to the data service.
Lineage | Provides a visual representation of the lineage between the currently selected data service. Relationships can be displayed in one of the two possible directions: Dependencies Where used Each entry includes name and path information.

#### Data Service Lineages

Data service lineages can be viewed in graphical or tabular format. The graphical view is ideal for getting a visual understanding of the lineage associated with a particular data service.

To start with, select a data service from the Navigation pane.

There are two ways to view a data service lineage:

- Where used view. The currently selected data service and the data services which make use of it appear. This is the downstream view.
- Dependency view. The currently selected data service and the data services it is dependent upon appear. This is the upstream view.

Data service dependencies associated with navigation functions are shown based on the following rules:

- If a data service contains a read function which calls a navigation function, the data service containing the navigation function appears as a dependency.
- If the data service contains a navigation function that calls a read function (such as the constructor function in the related data service), that relationship is insufficient for the data service to be identified as a dependent.

The reason for this is that navigation functions are often created automatically during the import metadata process. For details see "Obtaining Enterprise Metadata," in the Data Services Developer's Guide.

Figure 8-2 OrderView Data Service and Its Dependents

Once visual rendering appears, several options become available:

- Panning (Alt + Click, then drag). Allows you to move through the lineage representation in any direction.
- Zoom out (Ctrl + Shift + Click). Allows you to zoom out, providing information on data services that are further removed from your current selection.
- Zoom in (Ctrl + Click). Allows you to zoom in on a set of data services.
- Expanding/Contracting. You can use the +/- sign adjacent to the object to expand or collapse that node.

You can navigate to a new data service simply by double-clicking on it in the lineage diagram.

Note: Panning and Zoom operations work only with the Adobe SVG Viewer.

### Introspecting Data Service Metadata

There are two types of data services:

- Physical data services. These represent a single data source, typically a relational database table, stored procedure, or a web service.
- Logical data services. These can be composed from multiple data sources and represent a view of data which typically is not available from any single data source.

The metadata that is available through the Metadata Browser varies depending on whether a data service is physical or logical. Logical data sources always have dependencies while the physical data services always have dependents.

Figure 8-3 illustrates a tabular view of dependencies and where used information of a logical data service.

Figure 8-3 Logical Data Service Dependencies and Where Used

As you would expect of a logical data service, the return type displays the schema of the data from multiple data sources, according to the design of the data service, as illustrated in Figure 8-4.

Figure 8-4 Return Type for a Logical Data Service

## Metadata Browser Interface for Data Service Functions

You can browse metadata associated with a function.

To display function metadata:

1. Select a function in the Navigation pane.

The console displays the General metadata associated with the function.

2. Click the corresponding tab to display general information, function dependencies, where used information, properties, and the return type.

Figure 8-5 illustrates the function metadata displayed.

Figure 8-5 Function Metadata

Table 8-3 describes the function metadata available.

Table 8-3 Function Metadata

Function Metadata | Description
--- | ---
General | General metadata information for the function, including the following: Function name. The name of the function. data service. The containing data service. Description. A user-supplied description of the function. Return Type. The type returned by the function.
Lineage | Provides a visual representation of the relationships between the currently selected data service read, navigation, or private function. Lineage can be displayed in one of the two possible directions: Dependencies Where used Each entry includes name, path, and type information.
Properties | Displays any user-defined properties associated with the function.
Return Type | Displays details about the return type of the function.

#### Data Service Function Lineages

Data service function lineages can be viewed in graphical or tabular format. The graphical view is ideal for getting a visual understanding of the lineage associated with a particular function. The view includes all functions that directly or indirectly call your selected function, or are called by your selected function.

To start with, select a data service from the Navigation pane. Click on the data service and then select from the list of available read or relationship functions.

There are two ways to view a data service function lineage:

- Dependency view. The currently selected data service function and any functions that it calls (said another way, it depends upon).
- Where used view. The currently selected data service function and any functions that make use of it (said another way, depend on it).

Figure 8-6 OrderView Data Service and Its Dependents

Once visual rendering appears, several options become available:

- Panning (Alt + Click, then drag). Allows you to move through the lineage representation in any direction.
- Zoom out (Ctrl + Shift + Click). Allows you to zoom out, providing information on data services that are further removed from your current selection.
- Zoom in (Ctrl + Click). Allows you to zoom in on a set of data services.
- Expanding/Contracting. You can use the +/- sign adjacent to the object to expand or collapse that node.

You can navigate between functions simply by double-clicking on the particular function of interest that appears in your graph. Lineage for both read and relationships functions can be traced.

### Cyclic Dependency

Cyclic dependency can be observed in a graphical view of both data service lineages and data service function lineages. If a data service is used more than once, each instance of the data service in the graphical view is indicated in a dark blue color. Similarly, if a data service function is used more than once, each instance of the data service function in the graphical view is indicated in a dark blue color. Cyclic redundancy is applicable only when the duplicating nodes are part of the same branch.

Figure 8-7 shows the cyclic dependency of a data service. The text `<<Recursive` is specific to a data service and is displayed only in the case of a data service dependency.

Figure 8-7 Illustrating Cyclic Dependency of Data Services in a Graphic View

# Searching Metadata

The Metadata Browser provides both a basic and an advanced search facility. You can use the search capabilities to locate data services based on metadata associated with the services. You can then generate a report using the results from either of the search modes.

This section describes the following:

- Performing a Basic Metadata Search on page 8-13
- Performing an Advanced Metadata Search on page 8-14
- Exploring Metadata Search Results on page 8-16
- Generating Reports on page 8-18

## Performing a Basic Metadata Search

You can search for data services based on the data service name, description, function name, or return type.

To perform a basic search:

1. Right-click on an application or project node in the Navigation pane, and choose Search in the context-sensitive menu.

The basic search screen appears, as illustrated in Figure 8-8.

Figure 8-8 Basic Metadata Browser Search Facility

2. Choose the search criteria in the drop-down list.

You can choose to search based on the data service name, description, function name, and return type.

3. Enter the search item in the text box, and click Search.

The search results appear in the Contents pane. For more information about the search results, see Exploring Metadata Search Results on page 8-16.

4. Click Create Report in the Content pane to generate a report from the search results.

For more information about generating reports, see Generating Reports on page 8-18.

5. Click Return to Explorer to exit the search facility and return to the main interface.

Clicking Advanced Search enables you to specify additional criteria when performing a search. For more information, see Performing an Advanced Metadata Search on page 8-14.

## Performing an Advanced Metadata Search

You can use the advanced search facility to narrow your search criteria in cases when a basic search produces a large number of results. Using the advanced search option, you can specify criteria such as creation date, last modified data, owner, comments, and user-defined properties.

To perform an advanced search:

1. Right-click on a Data Services Platform application or project node in the Navigation pane, and choose Search in the context-sensitive menu.

The basic search screen appears. The advanced search tool is available as a link below the basic search interface. For more information about the DSP Console user interface, see Introducing the Data Services Platform Console on page 4-1.

2. Click Advanced Search.

The advanced search pane appears, as illustrated in Figure 8-9.

Figure 8-9 Metadata Browser Advanced Search

3. Enter the search criteria, as appropriate, and click Search.

Table 8-4 describes the criteria you can specify using the advanced search facility.

Table 8-4 Advanced Search Criteria

Search Criteria | Description
--- | ---
Data Service Name | The name of the data service.
Data Service Description | The user-supplied description of the data service.
Function Name | The name of the function appearing as part of the data service.
Return Type | The return type of the data service.
Creation Date | The date the data service was created. You can select a relational operator when specifying the date from among the following: = (On this date). Matches the date specified. < (Earlier than). Matches dates earlier than the specified date. <= (On this date or earlier). Matches the specified date or earlier dates. >= (On this date or later). Matches the specified date or later dates. > (Later than). Matches dates later than the specified date.
Last Modified Date | The date the data service was last modified. You can select a relational operator when specifying the date.
Owner | The owner of the data service.
Comment | The comment associated with the data service.
Name | The name of a user-defined property.
Value | The value associated with a user-defined property.

The search results appear in the Contents pane. For more information about the search results, see Exploring Metadata Search Results on page 8-16.

4. Click Create Report in the Content pane to generate a report from the search results.

For more information about generating reports, see Generating Reports on page 8-18.

5. Click Return to Explorer to exit the search facility and return to the main interface.

## Exploring Metadata Search Results

The Metadata Browser displays basic and advanced search results in the Contents pane. The information displayed is the same for both types of searches. Figure 8-10 illustrates the search results page.

Figure 8-10 Metadata Search Results

Table 8-5 describes the information displayed as search results.

Table 8-5 Search Results Information

Search Result | Description
--- | ---
Name | The name of the data service.
Path | The path identifying the data service.
Type | Either physical or logical. For more information about data service types, see Introspecting Data Service Metadata on page 8-7.

## Generating Reports

You can generate an HTML report based on the results of a basic or advanced search. In preparing the report, you specify the information to include such as read functions, return type, relationships, and more.

To generate a report:

1. Right-click on a Data Services Platform application or project node in the Navigation pane, and choose Search in the context-sensitive menu.

The basic search screen appears. The advanced search tool is available as a link below the basic search interface.

2. Specify the criteria for either a basic or advanced search, and click Search.

The search results appear in the Contents pane.

3. Click Create Report in the Content pane to generate a report from the search results.

The Generate Report page appears, as illustrated in Figure 8-11, enabling you to specify the information to include in the generated report.

Figure 8-11 Generating Reports

4. Select the information you want to include in the report, and click Generate Report.

The generated report appears in the Contents pane. Alternative, you can click Clear to reset the Generate Report page, or click Back to Result to return to the search results.

5. Click Return to Explorer to exit the search facility and return to the main interface.

Table 8-6 describes the options you can select to defined the information included in the generated report.

Table 8-6 Report Information

Information | Description
--- | ---
Read Function | Includes read functions in the report. You can choose to include standard or summary information for each function.
Return Type | Includes the return type of the data service in the report.
Relationships | Includes related data services in the report.
Properties | Includes user-defined properties associated with the data service as part of the report.
Dependencies | Includes the data services on which the resulting data service depends. The data services listed in this table contribute content to the current function's return value.
Where Used | Includes the data services where the resulting data service is used.