WebSphere Adapter for JDBC

Business object schema and its application-specific information

The business object schema is built out of database components that you select. Each component translates into a top-level business object.

For those business objects that are based on tables, views, stored procedures, and synonyms/nicknames, the enterprise service discovery wizard generates the name of the business object in the form of PrefixSchemaNameObjectName, where
  • Prefix is the value as specified in the connection property named Prefix. Prefix is not required, and if not specified, no prefix will be added to the business object name.
  • SchemaName is the name of the schema to which the object belongs.
  • ObjectName is the name of the table, view, stored procedure, or synonym/nickname.
Globalized characters are supported in the business object name.
For query business objects, the enterprise service discovery wizard generates the same of the business object in the form of PrefixQueryBOName, where
  • Prefix is the value as specified in the connection property named Prefix. Prefix is not required, and if not specified, no prefix will be added to the business object name.
  • QueryBOName is the value as specified in the configuration property named QueryBOName.
Globalized characters are supported in the business object name.

For the business objects that are based on table or view, the enterprise service discovery wizard sets the TableName application-specific information attribute to a value in the form of schemaname.tablename. It sets the business object level application-specific information as listed in the table "Business object application-specific information (ASI) for table or view business objects." The operations you select will be set in the business object. The attributes of the business object are created based on the columns.

Table 1. Business object application-specific information (ASI) for business objects based on tables or views
Business object ASI Set by enterprise service discovery wizard Additional information
TableName Yes Set to the actual name of the object
StatusColumnName Yes You specify during object selection
StatusValue Yes You specify during object selection

For the business objects that are based on stored procedures, the enterprise service discovery wizard sets the business object level application-specific information SPName to a value in the form of schemaname.spname. It sets the business object level application-specific information as listed in the table "Business object application-specific information (ASI) for business objects based on stored procedures." The attributes of the business object are created based on the stored procedure input/output parameters. If the stored procedure has one returned value, a corresponding business object attribute is created. If the returned value or any of the input/output parameters are complex data types, the wizard creates child business objects for them.

Enterprise service discovery can support nested structs and arrays. If these child business objects are generated from returned ResultSets, their names are in the form of PrefixSchemaNameSPNameRetRS#. For example, if one stored procedure returns two result sets, enterprise service discovery creates two child business objects for them. Their names will be PrefixSchemaNameSPNameRetRS1 and PrefixSchemaNameSPNameRetRS2.

When the child business objects are generated from input/output parameters with a complex data type of ResultSet, Struct, or Array, these child business object names are in the form of PrefixSchemaNameSPNameParameterName. For those child business objects that correspond to nested structs and arrays, their business object names are in the form of PrefixSchemaNameSPNameParameterNameColumnName.

Table 2. Business object application-specific information (ASI) for business objects based on stored procedures
Business object ASI Set by enterprise service discovery wizard Additional information
SPName Yes Set to the actual name of the stored procedure
ResultSet Yes Set to true if the stored procedure returns one or more ResultSets, otherwise it is set to false.
MaxNumofRetRS Yes The maximum number of returned result sets that are handled by the adapter runtime.
ReturnValue Yes Set to a business object attribute name if the stored procedure has a return value. If the returned value is of simple data type, the attribute is also of simple data type. If the returned value is a ResultSet, this attribute points to a child business object.

For query business objects, one business object level application-specific information named SelectStatement is added. Its value is the complete select statement.

Table 3. Business object application-specific information (ASI) for query business objects
Business object ASI Set by enterprise service discovery wizard Additional information
SelectStatement Yes You specify during object selection

The enterprise service discovery wizard also generates business graphs for all business objects, because all are top-level. The name of the business graph will be the business object name followed by "BG." For example, a business object with the name JDBCSchema1Customer, would have a the business graph named JDBCSchema1CustomerBG. The operations set in the business object are also set in the business graph.

When enterprise service discovery generates a stored procedure business object, it creates a child business object if necessary, such as for ResultSet, Struct, and Array. Creating parent-child relationships between table business objects is done manually using the Business Object Editor.

Enterprise service discovery handles business objects based on synonym/nicknames like objects based on tables and views, even when a synonym is of a stored procedure.


Terms of use |

Last updated: Tue 12 Dec 2006 03:32:38

(c) Copyright IBM Corporation 2005, 2006.
This information center is powered by Eclipse technology (http://www.eclipse.org)