Administration Guide
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:
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:
You can use the Metadata Browser to access metadata in the following ways:
You can use the Metadata Browser to introspect both data service metadata and function metadata.
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
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:
Figure 8-1 Data Service Metadata
Provides general configuration information about the data service, including the following:
|
|
Displays a table of read functions. The table also lists the parameter names, if any, and return type (schema file name) for each function. |
|
Displays the content of the schema associated with the return type of the data service. |
|
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. |
|
Lists any user-defined properties assigned to the data service. |
|
Provides a visual representation of the lineage between the currently selected data service. Relationships can be displayed in one of the two possible directions: |
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:
Data service dependencies associated with navigation functions are shown based on the following rules:
Once visual rendering appears, several options become available:
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.
There are two types of data services:
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
You can browse metadata associated with a function.
Figure 8-5 illustrates the function metadata displayed.
Table 8-3 describes the function metadata available.
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:
Figure 8-6 OrderView Data Service and Its Dependents
Once visual rendering appears, several options become available:
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 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
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.
Search algorithms that include wildcards are based on standards governing regular expression syntax. For detailed information on regular expression syntax see one of the following currently available Web sites:
Alternatively, any other standardized regular expression reference can be consulted.
The following topics are covered in this section:
You can search for data services based on the data service name, description, function name, or return type.
The basic search screen appears, as illustrated in Figure 8-8.
Figure 8-8 Basic Metadata Browser Search Facility
You can choose to search based on the data service name, description, function name, and return type.
The search results appear in the Contents pane. For more information about the search results, see Exploring Metadata Search Results on page 8-16.
For more information about generating reports, see Generating Reports on page 8-18.
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.
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:
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.
The advanced search pane appears, as illustrated in Figure 8-9.
Figure 8-9 Metadata Browser Advanced Search
Table 8-4 describes the criteria you can specify using the advanced search facility.
The search results appear in the Contents pane. For more information about the search results, see Exploring Metadata Search Results on page 8-16.
For more information about generating reports, see Generating Reports on page 8-18.
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.
Either physical or logical. For more information about data service types, see Introspecting Data Service Metadata on page 8-7. |
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.
The basic search screen appears. The advanced search tool is available as a link below the basic search interface.
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
Table 8-6 describes the options you can select to defined the information included in the generated report.