Skip navigation.
Downloads | Product Documentation | Support

Data Services Developer's Guide

# Obtaining Enterprise Metadata

A first step in creating data services for the BEA Aqualogic Data Services Platform (DSP) is to obtain metadata from physical data needed by your application.

This chapter describes this process, including the following topics:

- Creating Data Source Metadata
- Obtaining Metadata From Relational Sources

- Importing Relational Table and View Metadata
- Importing Stored Procedure-Based Metadata
- Using SQL to Import Metadata

- Importing Web Services Metadata
- Importing Java Function Metadata
- Importing Delimited File Metadata
- Importing XML File Metadata
- Updating Data Source Metadata

# Creating Data Source Metadata

Metadata is simply information about the structure of a data source. For example, a list of the tables and columns in a relational database is metadata. A list of operations in a Web service is metadata.

In DSP, a physical data service is based almost entirely on the introspection of physical data sources.

Figure 3-1 Data Services Available to the RTL Sample Application

Table 3-2 list the types of sources from which DSP can create metadata.

Table 3-2 Data Sources Available for Creating Data Service Metadata

Data Source Type | Access
--- | ---
Relational (including tables, views, stored procedures, and SQL) | JDBC
Web services (WSDL files) | URI, UDDI, WSDL
Delimited (CSV files) | File-based data, such as spreadsheets.
Java functions (`.java`) | Programmatic
XML (XML files) | File- or data stream-based XML

When information about physical data is developed using the Metadata Import Wizard two things happen:

- A physical data service (extension `.ds`) is created in your DSP-based project.
- A companion schema of the same name (`extension``.xsd`), is created. This schema describes quite exactly the XML type of the data service. Such schemas are placed in a directory named schemas which is a sub-directory of your newly created data service.

Figure 3-3 DSP Application Pane Displaying a Data Service and Its Schema Directory

You can import metadata on the data sources needed by your application using the DSP Metadata Import wizard. This wizard introspects available data sources and identifies data objects that can be rendered as data services and functions. Once created, physical data services become the building-blocks for queries and logical data services.

Data source metadata can be imported as Data Services Platform functions or procedures. For example, the following source resulted from importing a Web service operation:

>     (::pragma function <f:function xmlns:f="urn:annotations.ld.bea.com" kind="read" nativeName="getCustomerOrderByOrderID" nativeLevel1Container="ElecDBTest" nativeLevel2Container="ElecDBTestSoap" style="docu	ment"/>::)

>     declare function f1:getCustomerOrderByOrderID($x1 as element(t1:getCustomerOrderByOrderID)) as schema-element(t1:getCustomerOrderByOrderIDResponse) external;

Notice that the imported Web service is described as a "read" function in the pragma. "External" refers to the fact that the schema is in a separate file. You can find a detailed description of source code annotations in "Understanding Data Services Platform Annotations" in the XQuery Reference Guide.

For some data sources such as Web services imported metadata represents functions which typically return void (in other words, these functions perform operations rather than returning data). Such routines are classified as side-effecting functions or, more formally, as DSP procedures. You also have the option of marking routines imported from certain data sources as procedures. (See Identifying DSP Procedures.)

The following source resulted from importing Web service metadata that includes an operation that has been identified as a side-effecting procedure:

>     (::pragma function <f:function xmlns:f="urn:annotations.ld.bea.com" kind="hasSideEffects" nativeName="setCustomerOrder" style="document"/>::)

>     declare function f1:setCustomerOrder($x1 as element(t3:setCustomerOrder)) as schema-element(t3:setCustomerOrderResponse) external;

In the above pragma the function is identified as "hasSideEffects".

Note: DSP procedures are only associated with physical data services and can only be created through the metadata import process. So, for example, attempting to add procedures to a logical data service through Source View will result in an error condition.

## Identifying DSP Procedures

When you import source metadata for Web services, relational stored procedures, or Java functions you have an opportunity to identify the metadata that represents side-effecting routines. A typical example is a Web service that creates a new customer record. From the point of view of the data service such routines are procedures.

Procedures are not standalone; they always are part of a data service from the same data source.

When importing data from such sources the Metadata Import wizard automatically categorizes routines that return void as procedures. The reason for this is simply: if a routine does not return data it cannot inter-operate with other data service functions.

There are, however, routines that both return data and have side-effects; it is these routines which you need to identify as procedures during the metadata import process. Identification of such procedures provides the application developer with two key benefits:

- Creating a procedure during metadata input makes that the routine more easily available to the application programmer through the DSP invokeProcedure() API.
- If you import a routine that has side effects simply as a data service or as an executable function in an XML Function Library, invoking that routine through XQuery may have unexpected results, including the possibility that the routine will not be invoked at all. (The reason for this is that XQuery is a declarative language. You define your goals and the query engine determines how to achieve those goals. If a function is not intrinsic to achieving the overall goal of the query then its execution may be skipped even though it is specified as part of the overall query.)

Table 3-4 lists common DSP operations, identifying which operations are available or unavailable for data service procedures.

Table 3-4 Data Services Platform Scope of Procedures

Artifact | Procedures Available | Procedures Unavailable
--- | --- | ---
Data Services Platform IDE | Metadata import operations Function execution from Test View DSP Control query function palette | DSP Palette XQuery Editor function list Query Plan Viewer function list For use in ad hoc queries For use in logical data services
Data Services Platform Console | Function security settings Left tree access | Cache operations
Data Services Platform APIs | invokeProcedure() Strongly typed API DSP control | invoke() API (only for use with functions) prepareExpression() for running ad hoc queries

Procedures greatly simplify the process of updating non-relational back-end data sources by providing an invokeProcedure( ) API. This API encapsulates the operational logic necessary to invoke relational stored procedures, Web services, or Java functions. In such cases update logic can be built into a back-end data source routine which, in turn, updates the data.

For information on updating non-relational sources and other special cases see "Enabling SDO Data Source Updates" in the Client Application Developer's Guide.

For an example showing how you can identify side-effecting procedures during the metadata import process see Importing Web Services Metadata.

# Obtaining Metadata From Relational Sources

You can obtain metadata on any relational data source available to the BEA WebLogic Platform. For details see the BEA Platform document entitled How Do I Connect a Database Control to a Database Such as SQL Server or Oracle.

Four types of metadata can be obtained from a relational data source:

- Table-based
- View-based
- Stored procedure-based
- SQL-based
- Functions

Note: When using an XA transaction driver you need to mark your data source's connection pool to allow LocalTransaction in order for single database reads and updates to succeed.

For additional information in XA transaction adaptor settings see "Developing Adaptors" in BEA WebLogic Integration documentation: http://e-docs.bea.com/wli/docs81/devadapt/dbmssamp.html

## Importing Relational Table and View Metadata

To create metadata on relational tables and views follow these steps:

1. Select the project in which you want to create your metadata. For example, if you have a project called myLDProject right-click on the project name and select Import Source Metadata... from the pop-up menu. Click Next.
2. From the available data sources in the Import Wizard select Relational (see Figure 3-5).

Figure 3-5 Selecting a Relational Source from the Import Metadata Wizard

3. Either select a data source from available sources or make a new data source available to the WLS.

Figure 3-6 Import Data Source Metadata Selection Dialog Box

### Data Object Selection Options

For information on creating a new data source see Creating a New Data Source.

If you choose to select from an existing data source, several options are available (Figure 3-6).

#### Select All Database Objects

If you choose to select all, a table will appear containing all the tables, views, and stored procedures in your data source organized by catalog and schema.

#### Filter Data Source Objects

Sometimes you know exactly the objects in your data source that you want to turn into data services. Or your data source may be so large that a filter is needed. Or you may be looking for objects with specific naming characteristics (such as %audit2003%, a string which would retrieve all objects containing the enclosed string).

In such cases you can identify the exact parts of your relational source that you want to become data service candidates using standard JDBC wildcards. An underscore (_) creates a wildcard for an individual character. A percentage sign (%) indicates a wildcard for a string. Entries are case-sensitive.

For example, you could search for all tables starting with CUST with the entry: CUST%. Or, if you had a relational schema called ELECTRONICS, you could enter that term in the Schema field and retrieve all the tables, views, and stored procedure that are a part of that schema.

Another example:

>      CUST%, PAY%

entered in the Tables/Views field retrieves all tables and views starting with either CUST or PAY.

Note: If no items are entered for a particular field, all matching items are retrieved. For example, if no filtering entry is made for the Procedure field, all stored procedures in the data object will be retrieved.

For relational tables and views you should choose either the Select all option or Selected data source objects.

You can also use wildcards to support importing metadata on internal stored procedures. For example, entering the following string as a stored procedure filter:

>     %TRIM%

retrieves metadata on the system stored procedure:

>     STANDARD.TRIM

In such a situation you would also want to make a nonsense entry in the Table/View field to avoid retrieving all tables and views in the database.

For details on stored procedures see Importing Stored Procedure-Based Metadata.

#### SQL statement

Allows you to enter an SQL statement that is used as the basis for creating a data service. See Using SQL to Import Metadata for details.

### Creating a New Data Source

Most often you will work with existing data sources. However, if you choose New... the WLS DataSource Viewer appears (Figure 3-7). Using the DataSource Viewer you can create new data pools and sources.

Figure 3-7 BEA WebLogic Data Source Viewer

For details on using the DataSource Viewer see Configuring a Data Source in WebLogic Workshop documentation.

### Selecting an Existing Data Source

Only data sources that have set up through the BEA WebLogic Administration Console are available to a Data Services Platform application or project. In order for the BEA WebLogic Server used by DSP to access a particular relational data source you need to set up a JDBC connection pool and a JDBC data source.

- For details on setting up a JDBC connection pool see:

>     http://e-docs.bea.com/wls/docs81/ConsoleHelp/domain_jdbcconnectionpool_config_general.html

- For details on setting up a JDBC data source see:

>     http://e-docs.bea.com/wls/docs81/ConsoleHelp/domain_jdbcdatasource_config.html

Figure 3-8 Selecting a Data Source

Once you have selected a data source, you need to choose how you want to develop your metadata — by selecting all objects in the database, by filtering database objects, or by entering a SQL statement. (see Figure 3-6).

### Creating Table- and View-Based Metadata

Once you have selected a data source and any optional filters, a list of available database objects appears.

Figure 3-9 Identifying Database Objects to be Used as Data Services

Using standard dialog commands you can add one or several tables to the list of selected data objects. To deselect a table, select that table in the right-hand column and click Remove.

A Search field is also available. This is useful for data sources which have many objects. Enter a search string, then click Search repeatedly to move through your list.

1. Once you have selected one or several data sources, click Next to verify the location of the to-be-created data services and the names of your new data services.

The imported data summary screen:

- Lists selected objects by name. You can mouse over the XML type to see the complete path (Figure 3-10).
- Lists the location of the generated data service in the current application.
- Identifies any name conflicts. Name conflicts occur when there is an data service of the same name present in the target directory. Any name conflicts are highlighted in red.

  You can edit the file name to clarify the name or to avoid conflicts. Simply click on the name of the file and make any editing changes.

Alternatively, choose Remove All to return to the initial, nothing-is-selected state.

2. There are several situations where you will need to change the name of your data service:

- There already is a data service of the same name in your application.
- You are trying to create multiple data services with the same name.

In such cases the name(s) of the data service(s) having name conflicts appear in red. Simply change to a unique name using the built-in line editor.

Figure 3-10 Relational Source Import Data Summary Screen

3. Click Finish. A data service will be created for each object selected. The file extension of the created data services will always be `.ds`.

#### Database-specific Considerations

Database vendors variously support database catalogs and schemas. Table 3-11 describes this support for several major vendors.

Table 3-11 Vendor Support for Catalog and Schema Objects

Vendor | Catalog | Schema
--- | --- | ---
Oracle | Does not support catalogs. When specifying database objects, the catalog field should be left blank. | Typically the name of an Oracle user ID.
DB2 | If specifying database objects, the catalog field should be left blank. | Schema name corresponds to the catalog owner of the database, such as `db2admin`.
Sybase | Catalog name is the database name. | Schema name corresponds to the database owner.
Microsoft SQL Server | Catalog name is the database name. | Schema name corresponds to the catalog owner, such as `dbo`. The schema name must match the catalog or database owner for the database to which you are connected.
Informix | Does not support catalogs. If specifying database objects, the catalog field should be left blank. | Not needed.
PointBase | Pointbase database systems do not support catalogs. If specifying database objects, the catalog field should be left blank. | Schema name corresponds to a database name.

#### XML Name Conversion Considerations

When a source name is encountered that does not fit within XML naming conventions, default generated names are converted according to rules described by the SQLX standard. Generally speaking, an invalid XML name character is replaced by its hexadecimal escape sequence (having the form `_xUUUU_`).

For additional details see section 9.1 of the W3C draft version of this standard:

>     http://www.sqlx.org/SQL-XML-documents/5WD-14-XML-2003-12.pdf

Once you have created your data services you are ready to start constructing logical views on your physical data. See Designing Data Services. and Modeling Data Services.

## Importing Stored Procedure-Based Metadata

Enterprise databases utilize stored procedures to improve query performance, manage and schedule data operations, enhance security, and so forth. You can import metadata based on stored procedures. Each stored procedure becomes a data service.

Note: Refer to your database documentation for details on managing stored procedures.

Stored procedures are essentially database objects that logically group a set of SQL and native database programming language statements together to perform a specific task.

Table 3-12 defines some commonly used terms as they apply to this discussion of stored procedures.

Table 3-12 Terms Commonly Used When Discussing Stored Procedures

Term | Usage
--- | ---
Function | A function is identical to a procedure except a function always return one or more values to the caller and a procedure never returns a value. The value can be a simple type, a row type, or a complex user defined type.
Package | A package is a group of related procedures and functions, together with the cursors and variables they use, stored together in a database for continued use as a unit. Similar to standalone procedures and functions, packaged procedures and functions can be called explicitly by applications or users.
Stored Procedure | A sequence of programming commands written in an extended SQL (such as PL/SQL or T-SQL), Java or XQuery, stored in the database where it is to be used to maximize performance and enhance security. The application can call a procedure to fetch or manipulate database records, rather than using code outside the database to get the same results. Stored procedures do not return values.
DSP Procedure | Typically a routine which performs work but does not return data. An example would be a routine callable from a data service which writes information to a log file.
Rowset | The set of rows returned by a procedure or query.
Result set | JDBC term for rowset.
Parameter mode | Procedures can have three modes: IN, OUT, and INOUT. There roughly correspond to "write", "read", and "read/write".

### Importing Stored Procedures Using the Metadata Import Wizard

Imported stored procedure metadata is quite similar to imported metadata for relational tables and views. The initial three steps for importing stored procedures are the same as importing any relational metadata (described under Importing Relational Table and View Metadata).

Note: If a stored procedure has only one return value and the value is either simple type or a RowSet which is mapping to an existing schema, no schema file created.

You can select any combination of database tables, views, and stored procedures. If you select one or several stored procedures, the Metadata Import wizard will guide you through the additional steps required to turn a stored procedure into a data service. These steps are:

1. Select one or several stored procedures. A data service can represent only one stored procedure. In other words, if you have five stored procedures, you will create five data services.

Figure 3-13 Selecting Stored Procedure Database Objects to Import

2. After you have added the database objects that you want to become data services.
3. From the selected procedures (Figure 3-14) configure each stored procedure. If your stored procedure has an OUT parameter requiring a complex element, you may need to provide a schema.

Figure 3-14 Configuring a Stored Procedure in Pre-editing Mode

Data objects in the stored procedure that cannot be identified by the Metadata Import wizard will appear in red, without a datatype. In such cases you need to enter Edit mode (click the Edit button) to identify the data type.

Your goal in correcting an "<unknown>" condition associated with a stored procedure (Figure 3-14) is to bring the metadata obtained by the import wizard into conformance with the actual metadata of the stored procedure. In some cases this will be by correcting the location of the return type. In others you will need to adjust the type associated with an element of the procedure or add elements that were not found during the initial introspection of the stored procedure.

Figure 3-15 Stored Procedure in Editing Mode (with Callouts)

4. Edit your procedure as appropriate using the following steps:

1. Select a stored procedure from the complete list of stored procedures that you want to turn into data services.
2. Edit the stored procedure parameters including setting mode (in, out, inout), type, and for out parameters, schema location.
3. Verify and, if necessary, add, remove, or change the order of parameters.
4. Verify and, if necessary, add, remove, or change any editable rowset.
5. Supply a return type (either simple or complex through identifying a schema location) in cases the Metadata Import wizard was unable to determine the type.
6. Accept or cancel your changes.

You need to complete information for each selected stored procedure before you can move to the next step. In particular, any stored procedures shown in red must be addressed.

Details for each section of the stored procedure import dialog box appear below.

#### Procedure Profile

Each element in a stored procedure is associated with a type. If the item is a simple type, you can simply choose from the pop-up list of types.

Figure 3-16 Changing the Type of an Element in a Stored Procedure

If the type is complex, you may need to supply an appropriate schema. Click on the schema location button and either enter a schema path name or browse to a schema. The schema must reside in your application.

After selecting a schema, both the path to the schema file and the URI appear. For example:

>     http://temp.openuri.org/schemas/Customer.xsd}CUSTOMER

#### Procedure Parameters

The Metadata Import wizard, working through JDBC, also identifies any stored procedure parameters. This includes the name, mode (input [in], output [out], or bidirectional [inout]) and data type. The out mode supports the inclusion of a schema.

Complex type is only supported under three conditions:

- as the output parameter
- as the return type
- as a rowset

All parameters are editable, including the name.

Note: If you make an incorrect choice you can use the Previous, then Next button to return the dialog to its initial state.

#### Rowsets

Not all databases support rowsets. In addition, JDBC does not report information related to defined rowsets. In order to create data services from stored procedures that use rowset information, supply the correct ordinal (matching number) and a schema. If the schema has multiple global elements, you can select the one you want from the Type column. Otherwise the type will be the first global element in your schema file.

The order of rowset information is significant; it must match the order in your data source. Use the Move Up / Move Down commands to adjust the ordinal number assigned to the rowset.

Complete the importation of your procedures by reviewing and accepting items in the Summary screen (see step 4. in Importing Relational Table and View Metadata for details).

Note: XML types in data services generated from stored procedures do not display native types. However, you can view the native type in the Source View pragma (see Working with XQuery Source).

Handling Stored Procedure Rowsets

A rowset type is a complex type. The name of the rowset type can be:

- The parameter name (in case of a input/output or output only parameter)
- An assigned name such as RETURN_VALUE (if return value)
- The referenced element name (result rowsets) in a user-specified schema

The rowset type contains a sequence of a repeatable elements (for example called CUSTOMER) with the fields of the rowset.

Note: All rowset-type definitions must conform to this structure.

In some cases the Metadata Import wizard can automatically detect the structure of a rowset and create an element structure. However, if the structure is unknown, you will need to provide it through the wizard.

1. Mark Appropriate Imported Stored Procedure Metadata as DSP Procedures

#### Identifying Stored Procedures as DSP Procedures

It is often convenient to leverage independent routines as part of managing enterprise information through a data service. An obvious example would be to leverage standalone update or security functions through data services. Such functions have noXML type; in fact they typically return nothing (or void). Instead the data service knows that they have side-effects and are associated as procedures with a data service of the same data source.

Stored procedures are very often side-effecting from the perspective of the data service, since they perform internal operations on data. In such cases all you need to do is identify the stored procedures as a DSP procedure during the metadata import process.

After you have identified the stored procedures that you want to add to your data service or XML file library (XFL), you also have an opportunity to identify which of these should be identified as DSP procedures.

Figure 3-17 Identifying Stored Procedures Having Side Effects

Note: DSP procedures based around atomic (simple) types are collected in an identified XML function library (XFL) file. Other procedures need to be associated with a data service that is local to your DSP-enabled project.

#### Internal Stored Procedure Support

You can import metadata for an internal stored procedures. See Filter Data Source Objects for details.

#### Stored Procedure Version Support

Only the most recent version of a stored procedure can be imported into DSP. For this reason you cannot identify a version number when importing a stored procedure through the Metadata Import wizard. Similarly, adding a version number to DSP source will result in a query exception.

### Stored Procedure Support for Commonly Used Databases

Each database vendor approaches stored procedures differently. XQuery support limitations are, in general, due to JDBC driver limitations.

#### General Restriction

DSP does not support rowset as an input parameter.

#### Oracle Stored Procedure Support

Table 3-18 summarizes DSP support for Oracle database procedures.

Table 3-18 Support for Oracle Store Procedures

Term | Usage
--- | ---
Procedure types | Procedures Functions Packages
Parameter modes | Input only Output only Input/Output None
Parameter data types | Any Oracle PL/SQL data type except those listed below: ROWID UROWID Note: When defining function signatures, note that the Oracle %TYPE and %ROWTYPE types must be translated to XQuery types that match the true types underlying the stored procedure's %TYPE and %ROWTYPE declarations. %TYPE declarations map to simple types; %ROWTYPE declarations map to rowset types. For a list of database types supported by DSP see Relational Data Types-to-Metadata Conversion.
Data returned from a function | Oracle supports returning PL/SQL data types such as NUMBER, VARCHAR, %TYPE, and %ROWTYPE as parameters.
Comments | The following identifies limitations associated with importing Oracle database procedure metadata. The Metadata Import wizard can only detect the data structure for cursors that have a binding PL/SQL record. For a dynamic cursor you need to manually specify the cursor schema. Data from a PL/SQL record structure cannot be retrieved due to Oracle JDBC driver limitations. The Oracle JDBC driver supports rowset output parameters only if they are defined as reference cursors in a package. The Oracle JDBC driver does not support NATURALN and POSITIVEN as output only parameters.

#### Sybase Stored Procedure Support

Table 3-19 summarizes DSP support for Sybase SQL Server database procedures.

Table 3-19 Support for Sybase Stored Procedures

Term | Usage
--- | ---
Procedure types | Procedures Grouped procedures Functions Functions are categorized as a scalar or inline table-valued and multi-statement table-valued function. Inline table-valued and multi-statement table-valued functions return rowsets.
Parameter modes | Input only Output only
Parameter data types | For the complete list of database types supported by DSP see Relational Data Types-to-Metadata Conversion.
Data returned from a function | Sybase functions supports returning a single value or a table. Procedures return data in the following ways: As output parameters, which can return either data (such as an integer or character value) or a cursor variable (cursors are rowsets that can be retrieved one row at a time). As return codes, which are always an integer value. As a rowset for each SELECT statement contained in the stored procedure or any other stored procedures called by that stored procedure. As a global cursor that can be referenced outside the stored procedure supports, returning single value or multiple values.
Comments | The following identifies limitations associated with importing Sybase database procedure metadata: The Sybase JDBC driver does not support input/output or output only parameters that are rowsets (including cursor variables). The Jconnect driver and some versions of the BEA Sybase driver cannot detect the parameter mode of the procedure. In this case, the return mode will be UNKNOWN, preventing importation of the metadata. To proceed, you need to set the correct mode in order to proceed. Only data types generally supported by DSP metadata import can be imported as part of stored procedures.

#### IBM DB2 Stored Procedure Support

Table 3-20 summarizes DSP support for IBM DB2 database procedures.

Table 3-20 Support for IBM Store Procedures

Term | Usage
--- | ---
Procedure types | Procedures Functions Packages Each function is also categorized as a scalar, column, row, or table function. Here are additional details on function categorization: A scalar function is one that returns a single-valued answer each time it is called. A column function is one which conceptually is passed a set of like values (a column) and returns a single-valued answer (AVG( )). A row function is a function that returns one row of values. A table function is function that returns a table to the SQL statement that referenced it.
Parameter modes | Input only Output only Input/output
Parameter data types | For the complete list of database types supported by DSP see Relational Data Types-to-Metadata Conversion.
Data returned from a function | DB2 supports returning a single value, a row of values, or a table.
Comments | The following identifies limitations associated with importing DB2 database procedure metadata: Column type functions are not supported. Rowsets as output parameters are not supported. The DB2 JDBC driver supports float, double, and decimal input only and output only parameters. Float, double, and decimal data types are not supported as input/output parameters. Only data types generally supported by DSP metadata import can be imported as part of stored procedures.

#### Informix Stored Procedure Support

Table 3-21 summarizes DSP support for Informix database stored procedures.

Table 3-21 Support for Informix Stored Procedures

Term | Usage
--- | ---
Procedure types | Procedures Functions A function may return more than one value.
Parameter modes | Input only Output only Input/output
Parameter data types | For the complete list of database types supported by DSP see Relational Data Types-to-Metadata Conversion.
Data returned from a function | Informix supports returning single value, multiple values, and rowsets.
Comments | Informix treats return value(s) from functions or procedures as a rowset. For this reason a rowset needs to be defined for the return value(s). The following limitations have been identified: Informix Native Driver Limitations All parameter names are missing; instead in the Metadata Import wizard parameters are assigned the same system-generated name: `RETURN VALUE` All return values are reported as parameters with mode `return` instead of mode `result`. This leads to a problem since only the first parameter should be in mode `return`. This also causes a runtime failure. The workaround is to get the value(s) using resultset. BEA WebLogic Driver Limitations Input parameter names and return values are reported as `result` mode. Since there is no name declared for those return values insider the procedure, their corresponding parameters have no name either. The problem is that this does not model "result" parameters as a group; thus result parameters are likely to repeat as multiple rows. (Unlike the Oracle cursor which has the cursor itself as an outer parameter, there is no holder for Informix result parameters.) Recommendations Due to the limitations described above, the following approach is suggested for importing Informix stored procedure metadata: 1. Use the BEA WebLogic driver wherever possible. 2. Define a schema that matches the return value structure (using the same approach as external schemas for other databases). 3. In the Metadata Import wizard's stored procedure section, remove all the parameters in the Result section using Edit mode. Add a result parameter and associate it with the schema defined in step 2. (If you are using the Informix native driver assign a proper name for the input parameters.) 4. Manually edit the parameter's section of the generated data service file.

#### Microsoft SQL Server Stored Procedure Support

Table 3-22 summarizes DSP support for Microsoft SQL Server database procedures.

Table 3-22 DSP Support for Microsoft SQL Server Stored Procedures

Term | Usage
--- | ---
Procedure types | SQL Server supports procedures, grouped procedures, and functions. Each function is also categorized as a scalar or inline table-valued and multi-statement table-valued function. Inline table-valued and multi-statement table-valued functions return rowsets.
Parameter modes | SQL Server supports input only and output only parameters.
Parameter data types | SQL Server procedures/functions support any SQL Server data type as a parameter.
Data returned from a function | SQL Server functions supports returning a single value or a table. Data can be returned in the following ways: As output parameters, which can return either data (such as an integer or character value) or a cursor variable (cursors are rowsets that can be retrieved one row at a time). As return codes, which are always an integer value. As a rowset for each SELECT statement contained in the stored procedure or any other stored procedures called by that stored procedure.
Comments | The following identifies limitations associated with importing SQL Server procedure metadata. Result sets returned from SQL server (as well as those returned from Sybase) are not detected automatically. Instead you will need to manually add parameters as a result. The Microsoft SQL Server JDBC driver does not support rowset input/output or output only parameters (including cursor variables). Only data types generally supported by DSP metadata import can be imported as part of stored procedures.

## Using SQL to Import Metadata

One of the relational import metadata options (see Figure 3-6) is to use an SQL statement to customize introspection of a data source. If you select this option the SQL Statement dialog appears.

Figure 3-23 SQL Statement Dialog Box

You can type or paste your SELECT statement into the statement box (Figure 3-23), indicating parameters with a "?" question-mark symbol. Using one of the DSP data samples, the following SELECT statement can be used:

>     SELECT * FROM RTLCUSTOMER.CUSTOMER WHERE CUSTOMER_ID = ?

RTLCUSTOMER is a schema in the data source, CUSTOMER is, in this case, a table.

For the parameter field, you would need to select a data type. In this case, CHAR or VARCHAR.

The next step is to assign a data service name.

When you run your query under Test View, you will need to supply the parameter in order for the query to run successfully.

Once you have entered your SQL statement and any required parameters click Next to change or verify the name and location of your new data service.

Figure 3-24 Relational SQL Statement Imported Data Summary Screen

The imported data summary screen identifies a proposed name for your new data service.

The final steps are no different than you used to create a data service from a table or view.

### Relational Data Types-to-Metadata Conversion

The following table shows how data types provided by various relational databases are converted into XQuery data types. Types are listed in alphabetical order.

Table 3-25 Relational Data Types and Their XQuery Counterparts

Datatype Name | XQuery Equivalent | Oracle | IBM DB2 | Sybase | Informix | Microsoft SQL Server | Pointbase
--- | --- | --- | --- | --- | --- | --- | ---
`ARRAY` | `not supported` | #### x | ####  | ####  | ####  | ####  | ####
`BFILE` | `not supported` | #### x | ####  | ####  | ####  | ####  | ####
`BIGINT` | `xs:long` | ####  | #### x | ####  | ####  | #### x | #### x
`BINARY` | `xs:hexBinary` | ####  | ####  | #### x | ####  | #### x | ####
`BIT` | `xs:boolean` | ####  | ####  | #### x | ####  | #### x | ####
`BLOB` | `xs:hexBinary` | #### x | #### x | ####  | #### x | ####  | #### x
`BOOLEAN` | `xs:Boolean` | ####  | ####  | ####  | #### x | ####  | #### x
`BYTE` | `xs:hexBinary` | ####  | ####  | ####  | #### x | ####  | ####
`CHAR` | `xs:string` | #### x | #### x | #### x | #### x | #### x | #### x
`CHAR() FOR BIT DATA` | `xs:hexBinary` | ####  | #### x | ####  | ####  | ####  | ####
`CLOB` | `xs:string` | #### x | #### x | ####  | #### x | ####  | #### x
`DATE` | `xs:date` | ####  | #### x | ####  | ####  | ####  | #### x
`DATE` | `xs:datetime` | #### x | ####  | ####  | ####  | ####  | ####
`DATETIME` | `xs:datetime` | ####  | ####  | #### x | #### x | #### x | ####
`DECIMAL{n, s} s>0` | `xs:decimal` | ####  | #### x | #### x | #### x | #### x | #### x
`DECIMAL{n}` | `xs:integer` | ####  | #### x | #### x | #### x | #### x | #### x
`DOUBLE` | `xs:double` | ####  | #### x | ####  | ####  | ####  | ####
`DOUBLE PRECISION` | `xs:double` | ####  | ####  | #### x | ####  | ####  | #### x
`FLOAT` | `xs:double` | #### x | #### x | #### x | #### x | #### x | #### x
`IMAGE` | `xs:hexBinary` | ####  | ####  | #### x | ####  | #### x | ####
`INT` | `xs:int` | ####  | ####  | #### x | ####  | #### x | ####
`INT8` | `xs:long` | ####  | ####  | ####  | #### x | ####  | ####
`INTEGER` | `xs:int` | ####  | #### x | ####  | #### x | ####  | #### x
`INTERVAL` | `not supported` | ####  | ####  | ####  | #### x | ####  | ####
`INTERVALDS` | `xdt:dayTimeduration` | #### x | ####  | ####  | ####  | ####  | ####
`INTERVALYM` | `xdt:yearMonthduration` | #### x | ####  | ####  | ####  | ####  | ####
`LONG` | `xs:string` | #### x | ####  | ####  | ####  | ####  | ####
`LONG RAW` | `xs:hexBinary` | #### x | ####  | ####  | ####  | ####  | ####
`LONG VARCHAR` | `xs:string` | ####  | #### x | ####  | ####  | ####  | ####
`LONG VARCHAR FOR BIT DATA` | `xs:hexBinary` | ####  | #### x | ####  | ####  | ####  | ####
`LVARCHAR` | `xs:string` | ####  | ####  | ####  | #### x | ####  | ####
`MONEY` | `xs:decimal` | ####  | ####  | #### x | #### x | #### x | ####
`MSLABEL` | `not supported` | #### x | ####  | ####  | ####  | ####  | ####
`NCHAR` | `xs:string` | #### x | ####  | #### x | #### x | #### x | ####
`NTEXT` | `xs:string` | ####  | ####  | ####  | ####  | #### x | ####
`NUMBER` | `xs:double` | #### x | ####  | ####  | ####  | ####  | ####
`NUMBER{n, s} s<0` | `xs:integer` | #### x | ####  | ####  | ####  | ####  | ####
`NUMBER{n, s} s>0` | `xs:decimal` | #### x | ####  | ####  | ####  | ####  | ####
`NUMBER{n}` | `xs:integer` | #### x | ####  | ####  | ####  | ####  | ####
`NUMERIC{n, s} s>0` | `xs:decimal` | ####  | #### x | #### x | ####  | #### x | #### x
`NUMERIC{n}` | `xs:decimal` | ####  | #### x | #### x | ####  | #### x | #### x
`NVARCHAR` | `xs:string` | ####  | ####  | #### x | #### x | #### x | ####
`NVARCHAR2` | `xs:string` | #### x | ####  | ####  | ####  | ####  | ####
`RAW` | `xs:hexBinary` | #### x | ####  | ####  | ####  | ####  | ####
`REAL` | `xs:float` | ####  | #### x | #### x | ####  | #### x | #### x
`REF` | `not supported` | #### x | ####  | ####  | ####  | ####  | ####
`ROWID` | `xs:string` | #### x | ####  | ####  | ####  | ####  | ####
`SERIAL` | `not supported` | ####  | ####  | ####  | #### x | ####  | ####
`SERIAL8` | `not supported` | ####  | ####  | ####  | #### x | ####  | ####
`SMALLDATETIME` | `xs:datetime` | ####  | ####  | #### x | ####  | #### x | ####
`SMALLFLOAT` | `xs:float` | ####  | ####  | ####  | #### x | ####  | ####
`SMALLINT` | `xs:short` | ####  | #### x | #### x | #### x | #### x | #### x
`SMALLMONEY` | `xs:decimal` | ####  | ####  | #### x | ####  | #### x | ####
`SQL_VARIANT` | `xs:string` | ####  | ####  | ####  | ####  | #### x | ####
`STRUCT` | `not supported` | #### x | ####  | ####  | ####  | ####  | ####
`SYSNAME` | `xs:string` | ####  | ####  | #### x | ####  | #### x | ####
`TEXT` | `xs:string` | ####  | ####  | #### x | #### x | #### x | ####
`TIME` | `xs:time` | ####  | #### x | ####  | ####  | ####  | #### x
`TIMESTAMP` | `xs:datetime` | #### x | #### x | ####  | ####  | ####  | #### x
`TIMESTAMP` | `xs:hexBinary` | ####  | ####  | ####  | ####  | #### x | ####
`TIMESTAMP WITH LOCAL TIME ZONE` | `xs:datetime` | #### x | ####  | ####  | ####  | ####  | ####
`TIMESTAMP WITH TIME ZONE` | `xs:datetime` | #### x | ####  | ####  | ####  | ####  | ####
`TINYINT` | `xs:short` | ####  | ####  | #### x | ####  | #### x | ####
`UNIQUEIDENTIFIER` | `xs:hexbinary` | ####  | ####  | ####  | ####  | #### x | ####
`UROWID` | `xs:string` | #### x | ####  | ####  | ####  | ####  | ####
`VARBINARY` | `xs:hexBinary` | ####  | ####  | #### x | ####  | #### x | ####
`VARCHAR` | `xs:string` | ####  | #### x | #### x | #### x | #### x | #### x
`VARCHAR() FOR BIT DATA` | `xs:hexBinary` | ####  | #### x | ####  | ####  | ####  | ####
`VARCHAR2` | `xs:string` | #### x | ####  | ####  | ####  | ####  | ####

# Importing Web Services Metadata

A Web service is a self-contained, platform-independent unit of business logic that is accessible through application adaptors, as well as standards-based Internet protocols such as HTTP or SOAP.

Web services greatly facilitate application-to-application communication. As such they are increasingly central to enterprise data resources. A familiar example of an externalized Web service is a frequent-update weather portlet or stock quotes portlet that can easily be integrated into a Web application. Similarly, a Web service can be effectively used to track a drop shipment order from a seller to a manufacturer.

Note: Multi-dimensional arrays in RPC mode are not supported.

Creating a data service based on a Web service definition (schema) is similar to importing relational data source metadata (see Importing Relational Table and View Metadata).

Here are the Web service-specific steps involved:

1. Select the DSP-based project in which you want to create your Web service metadata. For example, if you have a project called DataServices right-click on the project name and select Import Metadata... from the pop-up menu.
2. From the available data sources in the Metadata Import wizard select Web service and click Next.
3. There are three ways to access a Web service:

- From a Web service description language (WSDL) file that is in your current DSP project.
- From a URI which is a WSDL accessible via a URL (HTTP).
- From a Universal Description, Discovery, and Integration service (UDDI).

Figure 3-26 Locating a Web Service

Note: For the purpose of showing how to import Web service metadata a WSDL file from the RTLApp sample is used for the remaining steps. If you are following these instructions enter the following into the URI field to access the WSDL included with RTLApp:

http://localhost:7001/ElecWS/controls/ElecDBTestContract.wsdl

1. From the selected Web service choose the operations that you want to turn into data services or XFL functions.
2. Identify which, if any, Web service-based data services should be marked as having side-effects.

Note: Imported operations returning void are automatically imported as DSP procedures. You can identify other operations as procedures using the Select Side Effect Procedures dialog (Figure 3-27).

It is often convenient to leverage side-effecting operations as part of managing enterprise information through a data service. An obvious example would be to manage standalone update or security functions through data services. The data service registers that such operations have side-effects.

Procedures are not standalone; they always are part of a data service from the same data source.

Web services are side-effecting from the perspective of the data service even when they do return data. In such cases, you need to associate the Web service operation with a data service during the metadata import process.

Figure 3-27 Marking Imported Operations DSP Procedures

Procedures must be associated with a data service that is local to a DSP-enabled project.

Figure 3-28 Identifying Web Service Operations to be Used as Data Services

Using standard dialog editing commands you can select one or several operations to be added to the list of selected Web service operations. To deselect an operation, click on it, then click Remove. Or choose Remove All to return to the initial state.

1. Click Next to verify the location of the to-be-created data services and their names.

Figure 3-29 Web Services Imported Data Summary Screen

The summary screen shown in Figure 3-29:

- Lists the Web service operations you have selected.
- Lists the target name for the generated data services.
- Identifies in red any data service name conflicts.

Even if there are no name conflicts you may want to change a data service name for clarity. Simply click on the name of the data service and enter the new name.

- Provides an option for adding the function to an existing data service based on the same WSLD. This option is only enabled if such a data service exists in your project. If there are several data services based on the same WSDL, a dropdown menu allows you to choose the data service for your function.

Note: Web Service functions identified as side-effecting procedures must be associated with a data service based on the same WSDL.

Note: When importing a Web service operation that itself has one or more dependent (or referenced) schemas, the Metadata Import wizard creates second-level schemas according to internal naming conventions. If several operations reference the same secondary schemas, the generated name for the secondary schema may change if you re-import or synchronize with the Web service.

1. Click Finish. A data service will be created for each selected operation.

## Testing Metadata Import With an Internet Web Service URI

If you are interested in trying the Metadata Import wizard with an internet Web service URI, the following page (available as of this writing) provides sample URIs:

>     http://www.strikeiron.com/BrowseMarketplace.aspx?c=14&m=1

Simply select a topic and navigate to a page showing the sample WSDL address such as:

>     http://ws.strikeiron.com/SwanandMokashi/StockQuotes?WSDL

Copy the string into the Web service URI field and click Next to select the operations want to turn into sample data services or procedures.

Another external Web service that can be used to test metadata import can be located at:

>     http://www.whitemesa.net/wsdl/std/echoheadersvc.wsdl

# Importing Java Function Metadata

You can create metadata based on custom Java functions. When you use the Metadata Import wizard to introspect a `.class` file, metadata is created around both complex and simple types. Complex types become data services while simple Java routines are converted into XQueries and placed in an XQuery function library (XFL). In Source View (see Working with XQuery Source) a pragma is created that defines the function signature and relevant schema type for complex types such as Java classes and elements.

In the RTLApp DataServices/Demo directory there is a sample that can be used to illustrate Java function metadata import.

## Supported Java Function Types

Your Java file can contains two types of functions:

Types of Java Functions | Use in Data Services Platform
--- | ---
Functions processing primitive types or arrays of primitive types | Grouped into an XQuery Function Library file, callable by any data service in the same application.
Functions processing complex types or arrays of complex types | Grouped into a data services, using XMLBean Java-to-XML technology.

Before you can create metadata on a custom Java function you must create a Java class containing both schema and function information. A detailed example is described in Creating XMLBean Support for Java Functions.

## Adding Java Function Metadata Using Import Wizard

Importing Java function metadata is similar to importing relational data source metadata (see Importing Relational Table and View Metadata). Here are the Java function-specific steps involved:

1. Select the DSP-based project in which you want to create your Java function metadata. (In the DataServices project of the RTLApp there is a special Demo folder containing XML, CSV, and Java data and schema samples.)
2. Build your project to validate its contents. A build will create a `.class` file from your `.java` function and place it in your application's library.
3. Right-click on the Java folder and select Import Source Metadata from the pop-up menu.
4. From the available data sources in the Metadata Import wizard select Java Function (see Figure 3-30). Click Next.

Figure 3-30 Selecting a Java Function as the Data Source

5. Your Java `.class` file must be in your BEA WebLogic application. You can browse to your file or enter a fully-qualified path name starting from the root directory of your DSP-based project.

Figure 3-31 Specifying a Java Class File for Metadata Import

6. Select Java functions for import.

Figure 3-32 Selecting Java Functions to Become Either Data Services or XFL Functions

7. Java functions with the following input and output types are supported for import:

- Simply types
- XMLBean types
- Java arrays of simple types
- Java arrays of XMLBean types

1. Identify which, if any, Java function-based data services should be identified as having side-effects.

It is often convenient to leverage independent routines as part of managing enterprise information through a data service. An obvious example would be to leverage standalone update or security functions through data services. Such functions have noXML type; in fact they typically return nothing (or void). Instead the data service knows that the routine has side-effects, but those effects are not transparent to the service. DSP procedures can also be thought of as side-effecting functions.

Java functions are "side-effecting" from the perspective of the data service when they perform internal operations on data.

After you have identified the Java functions that you want to add to your project, you can also identify which, if any, of these should be treated as DSP procedures (Figure 3-33). In the case of main(), the Metadata Import wizard detects that it returns void so it is already marked as a procedure.

Figure 3-33 Marking Java Functions as DSP Procedures

Functions based around atomic (simple) types are collected in an identified XML function library (XFL) file.

Note: Side-effecting procedures must to be associated with a data service that is from the same data source. In this case, the source is your Java file. In other words, in order to specify a Java function as a procedure, a function in the same file that returns a complex element must either be created at the same time or already exist in your project.

1. Click Next to verify the name and location of your new data service(s).

Figure 3-34 Java Function Imported Data Summary Screen

You can edit the proposed data service name either for clarity or to avoid conflicts with other existing or planned data services. All functions returning complex data types will be in the same data service. Click on the proposed data service name to change it.

Procedures must be associated with a data service that draws data from the same data source (Java file). In the sample shown in Figure 3-34, the only available data service is PRODUCTS (or whatever name you choose).

If there are existing XFL files in your project you have the option of adding atomic functions to that library or creating a new library for them. All the Java file atomic functions are located in the same library.

2. Click Finish.

## Creating XMLBean Support for Java Functions

Before you can import Java function metadata, you need to create a `.class` file that contains XMLBean classes based on global elements and compiled versions of your Java functions. To do this, you first create XMLBean classes based on a schema of your data. There are several ways to accomplish this. In the example in this section you create a WebLogic Workshop project of type Schema.

Generally speaking, the process involves:

- Creating a WebLogic Workshop project of type Schema. Schema projects (and applications) generate XMLBeans from schema files.
- Importing a schema (`.xsd` file) representing the shape of the global elements invoked by your function.
- Importing your custom Java function into your DSP-based project or Java project.
- Building your application to create a Java `.class` file, if under a DSP-based project, or you can add the JAR file from a Java project to the Library folder of your application.
- Creating metadata for your data service based on the `.class` file.
- Use the resulting data service or functions in your application.

#### Creating a Metadata-enriched Java Class: An Example

In the following example there are a number of custom functions in a `.java` file called `FuncData.java`. In the RTLApp this file can be found at:

>     ld:DataServices/Demo/Java/FuncData.java

Some functions in this file return primitive data types, while others return a complex element. The complex element representing the data to be introspected is in a schema file called `FuncData.xsd`.

File | Purpose
--- | ---
`FuncData.java` | Contains Java functions to be converted into data service query functions. Also contains as small data sample.
`FuncData.xsd` | Contains a schema for the complex element identified in `FuncData.java`

The schema file can be found at:

>     ld:DataServices/Demo/Java/schema/FuncData.xsd

To simplify the example a small data set is included in the `.java` file as a string.

The following steps will create a data service from the Java functions in `FuncData.java`:

1. Create a new DSP-based application called CustomFunctions.
2. Create a new project of type Schema in your application; name it Schemas.
3. Right-click on the newly created Schemas project and select the Import... option.
4. Browse to the RTLApp and select `FuncData.xsd` for import.

Importing a schema file into a schema project automatically starts the project build process.

When successful, XMLBean classes are created for each function in your Java file and placed in a JAR file called `JavaFunctSchema.jar`

The JAR file is located in the Libraries section of your application.

5. Build your project.
6. In your DSP-based project (customFunctionsDataServices) create a folder called JavaFuncMetadata.
7. Right-click on the newly created JavaFuncMetadata folder and select the Import... option.
8. Browse to the `ld:DataServices/Demo/Java` folder in the RTLApp and select `FuncData.java` for import. Click Import.
9. Build your project.

The JAR file named for your DSP-based project is updated to include a`.class` file named `FuncData.class`; It is this file that can be introspected by the Metadata Import wizard. The file is located in a folder named JavaFuncMetadata in the Library section of your application.

Figure 3-35 Class File Generated Java Function XML Beans

10. Now you are ready to create metadata from your Java function. These steps are described in Adding Java Function Metadata Using Import Wizard.

## Inspecting the Java Source

The `.java` file used in this example contains both functions and data. More typically, your routine will access data through a data import function.

The first function in Listing 3-1 simply retrieves the first element in an array of PRODUCTS. The second returns the entire array.

Listing 3-1 JavaFunc.java getFirstPRODUCT( ) and getAllPRODUCTS( ) Functions

>     public class JavaFunc {

>      ...

>     	public static noNamespace.PRODUCTSDocument.PRODUCTS getFirstProduct(){
>     		noNamespace.PRODUCTSDocument.PRODUCTS products = null;
>     		try{
>     			noNamespace.DbDocument dbDoc = noNamespace.DbDocument.Factory.parse(testCustomer);
>                 products = dbDoc.getDb().getPRODUCTSArray(1);
>                 //return products;
>     		}catch(Exception e){
>     			e.printStackTrace();
>     		}
>     		return products;
>     	}

>     	public static noNamespace.PRODUCTSDocument.PRODUCTS[] getAllProducts(){
>     		noNamespace.PRODUCTSDocument.PRODUCTS[] products = null;
>     		try{
>     			noNamespace.DbDocument dbDoc = noNamespace.DbDocument.Factory.parse(testCustomer);
>                 products = dbDoc.getDb().getPRODUCTSArray();
>                 //return products;
>     		}catch(Exception e){
>     			e.printStackTrace();
>     		}
>     		return products;
>     	}
>     }

The schema used to create XMLBeans is shown in Listing 3-2. It simply models the structure of the complex element; it could have been obtained by first introspecting the data directly.

Listing 3-2 B-PTest.xsd Model Complex Element Parsed by Java Function

>     <xs:schema elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
>       <xs:element name="db">
>         <xs:complexType>
>           <xs:sequence>
>             <xs:element ref="PRODUCTS" maxOccurs="unbounded"/>
>           </xs:sequence>
>         </xs:complexType>
>       </xs:element>
>       <xs:element name="AVERAGE_SERVICE_COST" type="xs:decimal"/>
>       <xs:element name="LIST_PRICE" type="xs:decimal"/>
>       <xs:element name="MANUFACTURER" type="xs:string"/>
>       <xs:element name="PRODUCTS">
>         <xs:complexType>
>           <xs:sequence>
>             <xs:element ref="PRODUCT_NAME"/>
>             <xs:element ref="MANUFACTURER"/>
>             <xs:element ref="LIST_PRICE"/>
>             <xs:element ref="PRODUCT_DESCRIPTION"/>
>             <xs:element ref="AVERAGE_SERVICE_COST"/>
>           </xs:sequence>
>         </xs:complexType>
>       </xs:element>
>       <xs:element name="PRODUCT_DESCRIPTION" type="xs:string"/>
>       <xs:element name="PRODUCT_NAME" type="xs:string"/>
>     </xs:schema>

Java functions require that an element returned (as specified in the return signature) come from a valid XML document. A valid XML document has a single root element with zero or more children, and its content matches the schema referred.

Listing 3-3 Approach When Data is Retrieved Through a Document

>     	public static noNamespace.PRODUCTSDocument.PRODUCTS getNextProduct(){

>           // create the dbDocument (the root)
>          noNamespace.DbDocument dbDoc = noNamespace.DbDocument.Factory.newInstance();
>          // the db element from it
>          noNamespace.DbDocument.Db db = dbDoc.addNewDb();
>          // get the PRODUCTS element
>          PRODUCTS product = db.addNewPRODUCTS();
>          //.. create the children
>          product.setPRODUCTNAME("productName");
>          product.setMANUFACTURER("Manufacturer");
>          product.setLISTPRICE(BigDecimal.valueOf((long)12.22));
>          product.setPRODUCTDESCRIPTION("Product Description");
>          product.setAVERAGESERVICECOST(BigDecimal.valueOf((long)122.22));

>          // .. update children of db
>          db.setPRODUCTSArray(0,product);

>          // .. update the document with db
>          dbDoc.setDb(db);

>          //.. now dbDoc is a valid document with db and is children.
>          // we are interested in PRODUCTS which is a child of db.
>          // Hence always create a valid document before processing the
>     			children.
>     		// Just creating the child element and returning it, is not
>     		// enough, since it does not mean the document is valid.
>     		// The child needs to come from a valid document, which is created
>     		// for the global element only.

>             return  dbDoc.getDb().getPRODUCTSArray(0);

>     	}

## How Metadata for Java Functions Is Created

In DSP, user-defined functions are typically Java classes. The following are supported:

- Java primitive types and single-dimension arrays.
- Global elements, global complex types, and global arrays through XMLBean classes

In order to support this functionality, the Metadata Import wizard supports marshalling and unmarshalling so that token iterators in Java are converted to XML and vice-versa.

Functions you create should be defined as static Java functions. The Java method name when used in an XQuery will be the XQuery function name qualified with a namespace.

Table 3-36 shows the casting algorithms for simple Java types, schema types and XQuery types.

Table 3-36 Simple Java Types and XQuery Counterparts

Java Simple or Defined Type | Schema Type
--- | ---
boolean | xs:boolean
byte | xs:byte
char | xs:char
double | xs:double
float | xs:float
int | xs:int
long | xs:long
short | xs:short
string | xd:string
java.lang.Date | xs:datetime
java.lang.Boolean | xs:boolean
java.math.BigInteger | xs:integer
java.math.BigDecimal | xs:decimal
java.lang.Byte | xs.byte
java.lang.Char | xs:char
java.lang.Double | xs:double
java.lang.Float | xs:float
java.lang.Integer | xs:integer
java.lang.Long | xs:long
java.lang.Short | xs:short
java.sql.Date | xs:date
java.sql.Time | xs:time
java.sql.Timestamp | `xs:datetime`
java.util.Calendar | xs:datetime

Java functions can also consume variables of XMLBean type that are generated by processing a schema via XMLBeans. The classes generated by XMLBeans can be referred in a Java function as parameters or return types.

The elements or types referred to in the schema should be global elements because these are the only types in XMLBeans that have static parse methods defined.

The next section provides additional code samples that illustrate how Java functions are used by the Metadata Import wizard to create data services.

### Technical Details, with Additional Example Code

In order to create data services or members of an XQuery function library, you would first start with a Java function.

#### Processing a Function Returning an Array of Java Primitives

As an example, the Java function getListGivenMixed( ) can be defined as:

>     public static float[] getListGivenMixed(float[] fpList, int size) {
>     int listLen = ((fpList.length > size) ? size : fpList.length);
>     float fpListop = new float[listLen];
>     for (int i =0; i < listLen; i++)
>     fpListop[i]=fpList[i];
>     return fpListop;
>     }

After the function is processed through the wizard the following metadata information is created:

>     xquery version "1.0" encoding "WINDOWS-1252";

>     (::pragma xfl <x:xfl xmlns:x="urn:annotations.ld.bea.com">
>     <creationDate>2005-06-01T14:25:50</creationDate>
>     <javaFunction class="DocTest"/>
>     </x:xfl>::)

>     declare namespace f1 = "lib:testdoc/library";

>        (::pragma function <f:function xmlns:f="urn:annotations.ld.bea.com" nativeName="getListGivenMixed">
>        <params>
>           <param nativeType="[F"/>
>           <param nativeType="int"/>
>        </params>
>        </f:function>::)

>        declare function f1:getListGivenMixed($x1 as xsd:float*, $x2 as xsd:int) as xsd:float* external;

Here is the corresponding XQuery for executing the above function:

>     declare namespace f1 = "ld:javaFunc/float";
>     let $y := (2.0, 4.0, 6.0, 8.0, 10.0)
>     let $x := f1:getListGivenMixed($y, 2)
>     return $x

#### Processing complex types represented via XMLBeans

Consider that you have a schema called Customer (`customer.xsd`), as shown below:

>     <?xml version="1.0" encoding="UTF-8" ?>
>     <xs:schema targetNamespace="ld:xml/cust:/BEA_BB10000" xmlns:xs="http://www.w3.org/2001/XMLSchema">
>     <xs:element name="CUSTOMER">
>     <xs:complexType>
>     <xs:sequence>
>     <xs:element name="FIRST_NAME" type="xs:string" minOccurs="1"/>
>     <xs:element name="LAST_NAME" type="xs:string" minOccurs="1"/>
>     </xs:sequence>
>     </xs:complexType>
>     </xs:element>
>     </xs:schema>

If you want to generate a list conforming to the CUSTOMER element you could process the schema via XMLBeans and obtain `xml.cust.beaBB10000.CUSTOMERDocument.CUSTOMER`. Now you can use the CUSTOMER element as shown:

>     public static xml.cust.beaBB10000.CUSTOMERDocument.CUSTOMER[]
>     getCustomerListGivenCustomerList(
>     		xml.cust.beaBB10000.CUSTOMERDocument.CUSTOMER[] ipListOfCust)
>     throws XmlException {
>     xml.cust.beaBB10000.CUSTOMERDocument.CUSTOMER [] mylocalver =
>     		ipListOfCust;
>     return mylocalver;
>     }

Then the metadata information produced by the wizard will be:

>     (::pragma function <f:function xmlns:f="urn:annotations.ld.bea.com" kind="datasource" access="public">
>     <params>
>     <param nativeType="[Lxml.cust.beaBB10000.CUSTOMERDocument$CUSTOMER;"/>
>     </params>
>     </f:function>::)

>     declare function f1:getCustomerListGivenCustomerList($x1 as element(t1:CUSTOMER)*) as element(t1:CUSTOMER)* external;

The corresponding XQuery for executing the above function is:

>     declare namespace f1 = "ld:javaFunc/CUSTOMER";

>     let $z := (

>     validate(<n:CUSTOMER xmlns:n="ld:xml/cust:/BEA_BB10000"><FIRST_NAME>John2</FIRST_NAME><LAST_NAME>Smith2</LAST_NAME>

>     </n:CUSTOMER>),

>     validate(<n:CUSTOMER xmlns:n="ld:xml/cust:/BEA_BB10000"><FIRST_NAME>John2</FIRST_NAME><LAST_NAME>Smith2</LAST_NAME>

>     </n:CUSTOMER>),

>     validate(<n:CUSTOMER xmlns:n="ld:xml/cust:/BEA_BB10000"><FIRST_NAME>John2</FIRST_NAME><LAST_NAME>Smith2</LAST_NAME>

>     </n:CUSTOMER>),

>     validate(<n:CUSTOMER xmlns:n="ld:xml/cust:/BEA_BB10000"><FIRST_NAME>John2</FIRST_NAME><LAST_NAME>Smith2</LAST_NAME>

>     </n:CUSTOMER>))

>     for $zz in $z
>     return
>      						f1:getCustomerListGivenCustomerList($z)

#### Restrictions on Java Functions

The following restrictions apply to Java functions:

- Function overloading is based on the number of arguments; not on the types of the parameter.
- Array support is restricted to single-dimension arrays only.
- In functions returning complex types the return element needs to be extracted from a valid XML document.

# Importing Delimited File Metadata

Spreadsheets offer a highly adaptable means of storing and manipulating information, especially information which needs to be changed quickly. You can easily turn such spreadsheet data in a data services.

Spreadsheet documents are often referred to as CSV files, standing for comma-separated values. Although CSV is not a typical native format for spreadsheets, the capability to save spreadsheets as CSV files is nearly universal.

Although the separator field is often a comma, the Metadata Import wizard supports any ASCII character as a separator, as well as fixed-length fields.

Note: Delimited files in a single server must share the same encoding format. This encoding can be specified through the system property ld.csv.encoding and set through the JVM command-line directly or via a script such as `startWebLogic.cmd` (Windows) or `startWebLogic.sh` (UNIX).

Here is the format for this command:

>     -Dld.csv.encoding=<encoding format>

If no format is specified through ld.csv.encoding, then the format specified in the file.encoding system property is used.

In the RTLApp DataServices/Demo directory there is a sample that can be used to illustrate delimited file metadata import.

## Providing a Document Name, a Schema Name, or Both

There are several approaches to developing metadata around delimited information, depending on your needs and the nature of the source.

- Provide a delimited document name only. If you supply the Metadata Import wizard with the name of a valid CSV file, the wizard will automatically create a schema based on the columns in the document. All the columns will be of type string, although you can later modify the generated schema with more accurate type information.

Note: The generated schema takes the name of the source file.

- Providing a schema name only. This option is typically used when the source file is dynamic; for example, when data is streamed.
- Providing both a schema and a document name. Providing a schema gives you the ability to more accurately type information in the columns of a delimited document.

## Using the Metadata Import Wizard on Delimited Files

Importing XML file information is similar to importing a relational data source metadata (see Importing Relational Table and View Metadata). Here are the steps that are involved:

1. Select the project in which you want to create your delimited file metadata. For example, if you have a project called myProject right-click on the project name and select Import Source Metadata from the pop-up menu.
2. From the available data sources in the Metadata Import wizard select Delimited Source as the data type (see Figure 3-37).

Figure 3-37 Selecting a Delimited Source from the Import Metadata Wizard

3. You can supply either a schema name, a source file name, or both. Through the wizard you can browse to a file located in your project. You can also import data from any CSV file on your system using an absolute path prepended with the following:

>     file:///

For example, on Windows systems you can access an XML file such as Orders.xml from the root C: directory using the following URI:

>     file:///<c:/home>/Orders.csv

On a UNIX system, you would access such a file with the URI:

>     file:///<home>/Orders.csv

4. Select additional import options:

- Header. Indicates whether the delimited file contains header data. Header data is located in the first row of the spreadsheet. If you check this option, the first row will not be treated as data.
- Delimited or Fixed Width. Data in your file is either separated by a specific character (such as a comma) or is of a fixed width (such as 10 spaces). If the data is delimited, you also need to provide the delimited character. By default the character is a comma (`,`).

Figure 3-38 Specifying Import Delimited Metadata Characteristics

5. Once you have selected a document and, optionally, a schema, click Next to verify the location and unique location/name of your new data service.

Figure 3-39 Delimited Document Imported Data Summary Screen

You can edit the data service name either to clarify the name or to avoid conflicts with other existing or planned data services. Any name conflicts are displayed in red. To change the name, double click on the name of the data service to activate the line editor.

6. Click Finish. A data service (`.ds` file) will be created with your schema as its XML type.

Note: When importing CSV-type data there are several things to keep in mind:

- The number of delimiters in each row must match the number of header columns in your source minus one (# of columns-1). If subsequent rows contain more than the maximum number of delimiters (fields), subsequent use of the data service will not be successful.
- If the delimited file has rows with a variable number of delimiters (fields), you can supply a schema that contains optional elements for the trailing set of extra elements.
- Not all characters are not equal. Some may need special escape sequences before spreadsheet data can be accessed at run-time.

# Importing XML File Metadata

XML files are a convenient means of handling hierarchical data. XML files and associated schemas are easily turned into data services.

Importing XML file information is similar to importing a relational data source metadata (see Importing Relational Table and View Metadata).

The Metadata Import wizard allows you to browse for an XML file anywhere in your application. You can also import data from any XML file on your system using an absolute path prepended with the following:

>     file:///

For example, on Windows systems you can access an XML file such as Orders.xml from the root C: directory using the following URI:

>     file:///c:/Orders.xml

On a UNIX system, you would access such a file with the URI:

>     file:///home/Orders.xml

## XML File Import Sample

In the RTLApp DataServices/Demo directory there is a sample that can be used to illustrate XML file metadata import.

Here are the steps involved:

1. Select your DSP-based project in which you want to create your XML file metadata. For example, if you have a project called myProject, right-click on the project name and select Import Metadata... from the pop-up menu.
2. From the available data sources in the Metadata Import wizard select XML Source.

Figure 3-40 Selecting an XML File from the Import Metadata Wizard

3. In order to access XML data you must first identify a schema; the schema must be located in your application.

Figure 3-41 Specify an XML File Schema for XML Metadata Import

4. Optionally specify an XML file. If the XML file exists in your DSP-based project you can simply browse to it. More likely your document is available as a URI, in which case you want to leave the XML file field empty and supply a URI at runtime.
5. Once you have selected a schema and optional document name, click Next to verify that the name of your new data service is unique to your application.

Figure 3-42 XML File Imported Data Summary Screen

You can edit the data service name either to clarify the name or to avoid conflicts with other existing or planned data services. Conflicts are shown in red. Simply click on the name of the data service to change its name. Then click Next.

6. Next select a global element in your schema (Figure 3-43). Click Ok.

Figure 3-43 A Selecting a Global Element When Importing XML Metadata

7. Complete the importation of your procedures by reviewing and accepting items in the Summary screen (see step 4. in Importing Relational Table and View Metadata for details).

## Testing the Metadata Import Wizard with an XML Data Source

When you create metadata for an XML data source but do not supply a data source name, you will need to identify the URI of your data source as a parameter when you execute the data service's read function (various methods of accessing data service functions are described in detail in the Client Application Developer's Guide).

The identification takes the form of:

>     <uri>/path/filename.xml

where uri is representative of a path or path alias, path represents the directory and filename.xml represents the filename. The `.xml` extension is needed.

You can access files using an absolute path prepended with the following:

>     file:///

For example, on Windows systems you can access an XML file such as Orders.xml from the root C: directory using the following URI:

>     file:///c:/Orders.xml

On a UNIX system, you would access such a file with the URI:

>     file:///home/Orders.xml

Figure 3-44 shows how the XML source file is referenced.

Figure 3-44 Specifying an XML Source URI in Test View

# Updating Data Source Metadata

When you first create a physical data service its underlying metadata is, by definition, consistent with its data source. Over time, however, your metadata may become "out of sync" for several reasons:

- The structure of underlying data sources may have changed, in which case it is important to be able to identify those changes so that you can determine when and if you need to update your metadata.
- You have modified schemas or added relationships to your data service.

You can use the Update Source Metadata right-click menu option to identify differences between your source metadata files and the structure of the source data including:

- Object added
- Object deleted
- Object modified
- Source Unavailable

In the case of Source Unavailable, the issue likely relates to connectivity or permissions. In the case of the other types of reports, you can determine when and if to update data source metadata to conform with the underlying data sources.

If there are no differences between your metadata and the underlying source, the Update Source Metadata wizard will report up-to-date for each data service tested.

## Considerations When Updating Source Metadata

Source metadata should be updated with care since the operation can have both direct and indirect consequences. For example, if you have added a relationship between two physical data services, updating your source metadata can potentially remove the relationship from both data services. If the relationship appears in a model diagram, the relationship line will appear in red, indicating that the relationship is no longer described by the respective data services.

In many cases the Update Source Metadata Wizard can automatically merge user changes with the updated metadata. See Using the Update Source Metadata Wizard, for details.

### Direct and Indirect Effects

Direct effects apply to physical data services. Indirect effects occur to logical data services, since such services are themselves ultimately based — at least in part — on physical data service. For example, if you have created a new relationship between a physical and a logical data service, updating the physical data service can invalidate the relationship. In the case of the physical data service, there will be no relationship reference. The logical data service will retain the code describing the relationship but it will be invalid if the opposite relationship notations is no longer be present.

Thus updating source metadata should be done carefully. Several safeguards are in place to protect your development effort while preserving your ability to keep your metadata up-to-date. See Archival of Source Metadata for information of how your current metadata is preserved as part of the source update.

## Using the Update Source Metadata Wizard

The Update Source Metadata wizard allows you to update your source metadata.

Note: Before attempting to update source metadata you should make sure that your build project has no errors.

Figure 3-45 Updating Source Metadata for Several Data Services

You can verify that your data structure is up-to-date by performing a metadata update on one or multiple physical data services in your DSP-based project. For example, in Figure 3-45 all the physical data services in the project will be updated.

After you select your target(s), the wizard identifies the metadata that will be verified and any differences between your metadata and the underlying source.

You can select/deselect any data service or XFL file listed in the dialog using the checkbox to the left of the name (Figure 3-46).

Figure 3-46 Data Services Metadata to be Updated

### Metadata Update Analysis

Next, an analysis is performed on your metadata by the wizard. The following types of synchronization mismatches are identified:

- Structural differences between the data source and the metadata. These will be resolved in favor of the data source and includes generated schema (data services XML type) based on the physical source.
- Differences that will be overwritten in favor of the values coming from the data source.
- Additions and modifications to the physical data service that will automatically be merged back into the updated metadata. This includes data service functions.

A update preview screen report (Figure 3-47) is prepared describing these differences both generally and for field-level data.

Figure 3-47 Metadata Update Plan for RTLApp's DataServices Project

The Metadata Update Preview screen identifies:

- Metadata changes to be applied. These changes are necessary in order for the physical data service to remain a valid representation of a underlying physical data source.
- User changes dropped. These are changes which cannot be merged into the updated metadata.
- User changes carried forward. These are changes will can be merged into the update metadata.

Icons differentiate elements as to be added, removed, or changed. Table 3-48 describes the update source metadata message types and color legends.

Table 3-48 Source Metadata Update Targets and Color Legend

Category | Color | Description
--- | --- | ---
Data source field added | Green | A data source field has been added since the last metadata update.
Data service schema (XML type) modified | Black | A change has been made in a schema that was derived from a data source.
Data source field deleted | Red | A field used by your metadata is no longer appearing in source.
Field modified | Blue | A field in your metadata does not exactly match the data source field.
Function modified | Blue | A function in your metadata does not exactly match the data source function.

### Synchronization Mismatches

Under some circumstances the Update Source Metadata wizard flags data service artifacts as changed locally when, in fact, no change was made.

For example, in the case of importing a Web service operation, a schema that is dependent (or referenced) by another schema will be assigned an internally-generated filename. If a second imported Web service operation in your project references the same dependent schema, upon synchronization the wizard may note that the name of the imported secondary schema file has changed. Simply proceed with synchronization; the old second-level schema will automatically be removed.

## Archival of Source Metadata

When you update source metadata two files are created and placed in a special directory in your application:

- A copy of the update report in the form:

>     ld:/updateMetadataHistory/metadatadiff<timestamp>.xml

- The XQuery source data services and other artifacts that were overwritten by the update operation are saved in the form of:

>     ld:/updateMetadataHistory/sourceBackUp<timestamp>.zip

An update metadata source operations assigns the same timestamp to both generated files.

Figure 3-49 UpdateMetadataHistory Directory Sample Content

Working with a particular update operations report and source, you can often quickly restore relationships and other changes that were made to your metadata while being assured that your metadata is up-to-date.