BEA Logo BEA WebLogic Portal Release 4.0

  BEA Home  |  Events  |  Solutions  |  Partners  |  Products  |  Services  |  Download  |  Developer Center  |  WebSUPPORT

 

   WebLogic Portal Documentation   |   Product Catalog Management   |   Previous Topic   |   Next Topic   |   Contents   |   Index

The Product Catalog Database Schema

 

This topic documents the database schema for the Commerce services Product Catalog. This topic includes the following sections:

 


The Entity-Relation Diagram

Figure 2-1 shows the logical Entity-Relation diagram for the Commerce services core Product Catalog tables in the Commerce database. See the subsequent sections in this topic for information about the data type syntax.

Figure 2-1 Entity-Relation Diagram for the Core Product Catalog Tables


 
 
 
 

 


The Catalog Schema Is Based on Dublin Core Standard

The metadata for items in Commerce services Product Catalog are based on the Dublin Core Metadata Open Standard. This standard offers a number of advantages for a Web-based catalog:

For more information about the Dublin Core Metadata Open Standard, please see http://purl.org/dc.

 


List of Tables Comprising the Product Catalog

The Commerce services Product Catalog is comprised of the following tables. In this list, the tables are sorted by functionality:

 


The Product Catalog Data Dictionary

In this section, the Commerce services schema tables are arranged alphabetically as a data dictionary.

The CATALOG_ENTITY Database Table

Table 2-1 describes the metadata for the Commerce services CATALOG_ENTITY table in the Commerce database. This table stores unique identification numbers for configurable entities.

The Primary Key is ENTITY_ID.

Table 2-1 CATALOG_ENTITY Table Metadata

Column Name

Data Type

Null Value

Description and Recommendations

ENTITY_ID

NUMBER(15)

NOT NULL

PK—a unique, system-generated number used as a record identifier.

ENTITY_NAME

VARCHAR(200)

NOT NULL

The name of the entity.

ENTITY_TYPE

VARCHAR(100)

NOT NULL

The type of entity (e.g., User, Group, etc.)

CREATION_DATE

DATE

NOT NULL

The time and date the record was created.

MODIFIED_DATE

DATE

NOT NULL

The time and date the record was last modified.


 

The CATALOG_PROPERTY_KEY Database Table

Table 2-2 describes the metadata for the Commerce services CATALOG_PROPERTY_KEY table in the Commerce database. This table stores unique identification numbers for scoped property names that are associated with configurable entities.

The Primary Key is PROPERTY_KEY_ID.

Table 2-2 CATALOG_PROPERTY_KEY Table Metadata

Column Name

Data Type

Null Value

Description and Recommendations

PROPERTY_KEY_ID

NUMBER(15)

NOT NULL

PK—a unique, system-generated number used as a record identifier.

PROPERTY_NAME

VARCHAR(100)

NOT NULL

The name of the property (formerly PROPERTY_NAME from the WLCS_PROP_ID table).

CREATION_DATE

DATE

NOT NULL

The time and date the record was created.

MODIFIED_DATE

DATE

NOT NULL

The time and date the record was last modified.

PROPERTY_SET_NAME

VARCHAR(100)

NULL

The name of the property set (formerly the SCOPE_NAME from WLCS_PROP_ID).

PROPERTY_SET_TYPE

VARCHAR(100)

NULL

The type of property set (for example, USER)


 

The CATALOG_PROPERTY_VALUE Database Table

Table 2-3 describes the metadata for the Commerce services CATALOG_PROPERTY_VALUE table in the Commerce database. This table stores Boolean, timestamp, float, integer, text, and user-defined (object) property values that are associated with configurable entities.

See Defined Constraints for information about the constraint defined for this table.

The Primary Key is PROPERTY_VALUE_ID.

Table 2-3 CATALOG_PROPERTY_VALUE Table Metadata

Column Name

Data Type

Null Value

Description and Recommendations

PROPERTY_VALUE_ID

NUMBER(15)

NOT NULL

PK—a unique, system-generated number used as a record identifier.

PROPERTY_KEY_ID

NUMBER(15)

NOT NULL

A system-generated value and foreign key to the PROPERTY_KEY column.

ENTITY_ID

NUMBER(15)

NOT NULL

A system-generated value and foreign key to the ENTITY column.

PROPERTY_TYPE

NUMBER(1)

NOT NULL

Valid entries are:

0=Boolean, 1=Integer, 2=Float, 3=Text, 4=Date and Time, 5=User-Defined (BLOB)

CREATION_DATE

DATE

NOT NULL

The time and date the record was created.

MODIFIED_DATE

DATE

NOT NULL

The time and date the record was last modified.

BOOLEAN_VALUE

NUMBER(1)

NULL

The value for each boolean property identifier.

DATETIME_VALUE

DATE

NULL

The value for each date and time property identifier.

DOUBLE_VALUE

NUMBER

NULL

The value associated with each float property identifier.

LONG_VALUE

NUMBER(20)

NULL

The value associated with the integer property.

TEXT_VALUE

VARCHAR(254)

NULL

The value associated with the text property.

BLOB_VALUE

BLOB

NULL

The value associated with the user-defined property.


 

The WLCS_CATEGORY Database Table

Table 2-4 describes the metadata for the Commerce services WLCS_CATEGORY table. This table is used to store categories in the Commerce database. The descriptions shown in the table reflect the "recommended best practice" for the use of that field by the Dublin Core standard.

See Defined Constraints for information about the constraint defined for this table.

The Primary Key is CATEGORY_ID.


 
 

Table 2-4 WLCS_CATEGORY Table Metadata

Column Name

Data Type

Null Value

Description and Recommendations

CATEGORY_ID

VARCHAR(20)

NOT NULL

A unique identifier for a category; the primary key for this table. This field cannot be NULL. All other fields in the WLCS_CATEGORY table can be NULL.

PARENT_ID

VARCHAR(20)

NULL

The value of the CATEGORY_ID of the parent category in the hierarchy of categories that comprise your product catalog. If this is a top-level user-defined category, the PARENT_ID will be com.beasys.ROOT.

NAME

VARCHAR(50)

NULL

The name of the category in the product catalog.

SOURCE

VARCHAR(30)

NULL

A reference to a category from which the present category is derived.

LANG

VARCHAR(30)

NULL

A language of the intellectual content of the category. The recommended best practice for the values of the language element is defined by RFC 1766, which includes a two-letter Language Code (taken from the ISO 639 standard), such as: en for English; fr for French, or de for German. The language code can, optionally, be followed by a two-letter Country Code (taken from the ISO 3166 standard [ISO3166]). For example, en-uk for English used in the United Kingdom.

RELATION

VARCHAR(30)

NULL

A reference to a related category.

COVERAGE

VARCHAR(30)

NULL

The extent or scope of the content of the category.

RIGHTS

VARCHAR(30)

NULL

Information about rights held in and over the category.

CREATOR

VARCHAR(50)

NULL

An entity primarily responsible for making the content of the category.

PUBLISHER

VARCHAR(50)

NULL

An entity responsible for making the category available.

CONTRIBUTOR

VARCHAR(50)

NULL

An entity responsible for making contributions to the content of the category.

CREATION_DATE

DATE

NULL

A date associated with an event in the life cycle of the category. Recommended best practice for encoding the date value is defined in a profile of ISO 8601 and follows the YYYY-MM-DD format.

MODIFIED_DATE

DATE

NULL

A date associated with an event in the life cycle of the category, such as an update or insert by the DBLoader program that is provided with the Commerce services. The recommended best practice for encoding the date value is defined in a profile of ISO 8601 and follows the YYYY-MM-DD format.

SMALL_IMG_TYPE

NUMBER(3)

NULL

A type field of your own design that relates to the graphic. For example, you can implement your own numbering scheme, such as:

0 = display a low resolution graphic for users with low bandwidth.

1 = display a high resolution graphic for users with high bandwidth.

SMALL_IMG_LANG

VARCHAR(30)

NULL

The language of the thumbnail image for the category. For related information, see the description of the LANG column.

SMALL_IMG_NAME

VARCHAR(50)

NULL

The name of the thumbnail image for the category.

SMALL_IMG_URL

VARCHAR(254)

NULL

The URL of the thumbnail image for the category.

SMALL_IMG_ALT_TEXT

VARCHAR(254)

NULL

The alternate text to display when the user has their cursor over the thumbnail image for the category, or if they have disabled the display of graphics in their browser settings.

LARGE_IMG_TYPE

NUMBER(3)

NULL

A type field of your own design that relates to the graphic. For example, you can implement your own numbering scheme, such as:

0 = display a low resolution graphic for users with low bandwidth.

1 = display a high resolution graphic for users with high bandwidth.

LARGE_IMG_LANG

VARCHAR(30)

NULL

The language of the full-size image for the category. For related information, see the description of the LANG column.

LARGE_IMG_NAME

VARCHAR(50)

NULL

The name of the full-size image for the category.

LARGE_IMG_URL

VARCHAR(254)

NULL

The URL of the full-size image for the category.

LARGE_IMG_ALT_TEXT

VARCHAR(254)

NULL

The alternate text to display when the user has their cursor over the full-size image for the category, or if they have disabled the display of graphics in their browser settings.

DISPLAY_JSP_URL

VARCHAR(254)

NULL

The URL to the JSP used to display the category. For example:

/commerce/catalog/includes/
category.jsp

SHORT_DESC

VARCHAR(50)

NULL

A short description of the content of the category.

LONG_DESC

VARCHAR(254)

NULL

A long description of the content of the category.


 

The WLCS_PRODUCT Database Table

Table 2-5 describes the metadata for the Commerce services WLCS_PRODUCT table. This table is used to store item records in the Commerce database. The descriptions shown in the table reflect the "recommended best practice" for the use of that field by the Dublin Core standard.

The Primary Key is SKU.


 

Table 2-5 WLCS_PRODUCT Table Metadata

Column Name

Data Type

Null Value

Description and Recommendations

SKU

VARCHAR(40)

NOT NULL

A unique identifier (the "Stock Keeping Unit," or SKU) for a product item. This field is the table's primary key and cannot be NULL. All other fields in the WLCS_PRODUCT table can be NULL.

IN_STOCK

VARCHAR(1)

NULL

A flag to indicate whether the product item is in stock. 0 equates to false, 1 equates to true.

VISIBLE

VARCHAR(1)

NULL

Indicates whether the item should be displayed to the user. Enter 1 if visible or 0 if not visible. If not specified in the database, the default is 1. See Controlling the Visibility of Items in the Product Catalog for important information about this field.

TAX_CODE

VARCHAR(10)

NULL

The code used by the TAXWARE system to identify the specific tax category to which this item belongs.

SHIPPING_CODE

VARCHAR(10)

NULL

The code used by the shipping company for this item.

NAME

VARCHAR(100)

NULL

A name given to the product item.

SOURCE

VARCHAR(30)

NULL

A reference to another product item from which the present item is derived.

LANG

VARCHAR(30)

NULL

A language of the intellectual content of the category. The recommended best practice for the values of the language element is defined by RFC 1766, which includes a two-letter Language Code (taken from the ISO 639 standard), such as: en for English; fr for French, or de for German. The language code can, optionally, be followed by a two-letter Country Code (taken from the ISO 3166 standard [ISO3166]). For example, en-uk for English used in the United Kingdom.

RELATION

VARCHAR(30)

NULL

A reference to a related product item.

COVERAGE

VARCHAR(30)

NULL

The extent or scope of the content of the product item.

RIGHTS

VARCHAR(30)

NULL

Information about rights held in and over the item.

FORMAT

VARCHAR(30)

NULL

The physical or digital manifestation of the item.

TYPE

VARCHAR(30)

NULL

The nature or genre of the content of the item.

MSRP_CURRENCY

VARCHAR(30)

NULL

The currency type of the manufacturer's recommended price.

MSRP_AMOUNT

NUMBER(16,4)

NULL

The manufacturer's recommended price.

PRICE_CURRENCY

VARCHAR(30)

NULL

The currency type of our catalog price for this item.

PRICE_AMOUNT

NUMBER(16,4)

NULL

Our current price for this item in the catalog.

ESTIMATE_SHIP_TIME

VARCHAR(100)

NULL

Inventory: number of days/weeks before the item can be shipped.

SPECIAL_NOTES

VARCHAR(100)

NULL

Inventory related message to display with the item.

CREATOR

VARCHAR(50)

NULL

An entity primarily responsible for making the content of the product item.

PUBLISHER

VARCHAR(50)

NULL

An entity responsible for making the product item available.

CONTRIBUTOR

VARCHAR(50)

NULL

An entity responsible for making contributions to the content of the product item.

CREATION_DATE

DATE

NULL

A date associated with an event in the life cycle of the product item. Recommended best practice for encoding the date value is defined in a profile of ISO 8601 and follows the YYYY-MM-DD format.

MODIFIED_DATE

DATE

NULL

A date associated with an event in the life cycle of the item, such as an update or insert by the DBLoader program that is provided with the Commerce services. The recommended best practice for encoding the date value is defined in a profile of ISO 8601 and follows the YYYY-MM-DD format.

SMALL_IMG_TYPE

NUMBER(3)

NULL

A type field of your own design that relates to the graphic. For example, you can implement your own numbering scheme, such as:

0 = display a low resolution graphic for users with low bandwidth.

1 = display a high resolution graphic for users with high bandwidth.

SMALL_IMG_LANG

VARCHAR(30)

NULL

The language of the thumbnail image for the item. For related information, see the description of the LANG column.

SMALL_IMG_NAME

VARCHAR(50)

NULL

The name of the thumbnail image for the item.

SMALL_IMG_URL

VARCHAR(254)

NULL

The URL of the thumbnail image for the category.

SMALL_IMG_ALT_TEXT

VARCHAR(254)

NULL

The alternate text to display when the user has their cursor over the thumbnail image for the item, or if they have disabled the display of graphics in their browser settings.

LARGE_IMG_TYPE

NUMBER(3)

NULL

A type field of your own design that relates to the graphic. For example, you can implement your own numbering scheme, such as:

0 = display a low resolution graphic for users with low bandwidth.

1 = display a high resolution graphic for users with high bandwidth.

LARGE_IMG_LANG

VARCHAR(30)

NULL

The language of the full-size image for the item. For related information, see the description of the LANG column.

LARGE_IMG_NAME

VARCHAR(50)

NULL

The name of the full-size image for the item.

LARGE_IMG_URL

VARCHAR(254)

NULL

The URL of the full-size image for the item.

LARGE_IMG_ALT_TEXT

VARCHAR(254)

NULL

The alternate text to display when the user has their cursor over the full-size image of the item, or if they have disabled the display of graphics in their browser settings.

SUM_DISPLAY_JSP_URL

VARCHAR(254)

NULL

The URL to the JSP used to display the item in summary form. For example:

/commerce/catalog/includes/
itemsummary.jsp

DET_DISPLAY_JSP_URL

VARCHAR(254)

NULL

The URL to the JSP used to display the item in detailed form. For example:

/commerce/catalog/includes/
itemdetails.jsp

SHORT_DESC

VARCHAR(254)

NULL

A short description of the content of the product item.

LONG_DESC

VARCHAR(2000)

NULL

A long description of the content of the product item.


 
 

The WLCS_PRODUCT_CATEGORY Database Table

Table 2-6 describes the metadata for the Commerce services WLCS_PRODUCT_CATEGORY table in the Commerce database. This table is used to join categories and items.

See Defined Constraints for information about the constraint defined for this table.

The Primary Keys are SKU and CATEGORY_ID.

Table 2-6 WLCS_PRODUCT_CATEGORY Table Metadata

Column Name

Data Type

Null Value

Description and Recommendations

SKU

VARCHAR(40)

NOT NULL

A unique identifier (the "Stock Keeping Unit," or SKU) for an item.

CATEGORY_ID

VARCHAR(20)

NOT NULL

A unique identifier for a category.


 

The WLCS_PRODUCT_KEYWORD Database Table

Table 2-7describes the metadata for the Commerce services WLCS_PRODUCT_KEYWORD table in the Commerce database. This table stores the keywords that you associate with each product item. The keywords enable rapid retrieval of item records via the search functions on the Web site's pages or Administration pages.

See Defined Constraints for information about the constraint defined for this table.

The Primary Keys are KEYWORD and SKU.

Table 2-7 WLCS_PRODUCT_KEYWORD Table Metadata

Column Name

Data Type

Null Value

Description and Recommendations

KEYWORD

VARCHAR(30)

NOT NULL

Contains a keyword that you associate with the product item assigned to the unique SKU.

Recommendation—for a given item, select a value from a controlled vocabulary or formal classification scheme implemented in your company.

SKU

VARCHAR(40)

NOT NULL

A unique identifier (the "Stock Keeping Unit," or SKU) for an item.


 

 


The SQL Scripts Used to Create the Database

The database schemas for WebLogic Portal and WebLogic Personalization Server are all created by executing the create_all script for the target database environment.

Scripts

Regardless of your database, execute one of the following to generate the necessary database objects for the modules desired ( WebLogic Portal, WebLogic Personalization Server, Commerce services, Campaign services and Sample Portal):

Note: In this documentation,PORTAL_HOME is used to designate the directory where the product is installed.

Each of the databases supported have the same number of scripts in each of their subdirectories. The scripts are listed and described in Table 2-8 below.

Table 2-8 The Scripts Supporting the Databases

Script Name

Description

create_all.bat

Windows script used to connect to the database and create the necessary database objects for the modules desired (e.g., WebLogic Portal, WebLogic Personalization Server, Commerce services, Campaign services and Sample Portal)

create_all.sh

Unix script used to connect to the database and create the necessary database objects for the modules desired (e.g., WebLogic Portal, WebLogic Personalization Server, Commerce services, Campaign services and Sample Portal)

campaign_create_fkeys.sql

SQL script used to create all foreign keys associated with the Campaign services.

campaign_create_indexes.sql

SQL script used to create all indexes associated with the Campaign services.

campaign_create_tables.sql

SQL script used to create all tables associated with the Campaign services.

campaign_create_triggers.sql

SQL script used to create all database triggers associated with the Campaign services.

campaign_create_views.sql

SQL script used to create all views associated with the Campaign services.

campaign_drop_constraints.sql

SQL script used to drop all constraints (other than foreign keys) associated with the Campaign services.

campaign_drop_fkeys.sql

SQL script used to drop all foreign key constraints associated with the Campaign services.

campaign_drop_indexes.sql

SQL script used to drop all indexes associated with the Campaign services.

campaign_drop_tables.sql

SQL script used to drop all tables associated with the Campaign services.

campaign_drop_views.sql

SQL script used to drop all views associated with the Campaign services.

p13n_create_fkeys.sql

SQL script used to create all foreign keys associated with the WebLogic Personalization Server.

p13n_create_indexes.sql

SQL script used to create all indexes associated with the WebLogic Personalization Server.

p13n_create_tables.sql

SQL script used to create all tables associated with the WebLogic Personalization Server.

p13n_create_triggers.sql

SQL script used to create all database triggers associated with the WebLogic Personalization Server.

p13n_create_views.sql

SQL script used to create all views associated with the WebLogic Personalization Server.

p13n_drop_constraints.sql

SQL script used to drop all constraints (other than foreign keys) associated with the WebLogic Personalization Server.

p13n_drop_fkeys.sql

SQL script used to drop all foreign key constraints associated with the WebLogic Personalization Server.

p13n_drop_indexes.sql

SQL script used to drop all indexes associated with the WebLogic Personalization Server.

p13n_drop_tables.sql

SQL script used to drop all tables associated with the WebLogic Personalization Server.

p13n_drop_views.sql

SQL script used to drop all views associated with the WebLogic Personalization Server.

portal_create_fkeys.sql

SQL script used to create all foreign keys associated with the WebLogic Portal.

portal_create_indexes.sql

SQL script used to create all indexes associated with the WebLogic Portal.

portal_create_tables.sql

SQL script used to create all tables associated with the WebLogic Portal.

portal_create_triggers.sql

SQL script used to create all database triggers associated with the WebLogic Portal.

portal_create_views.sql

SQL script used to create all views associated with the WebLogic Portal.

portal_drop_constraints.sql

SQL script used to drop all constraints (other than foreign keys) associated with the WebLogic Portal.

portal_drop_fkeys.sql

SQL script used to drop all foreign key constraints associated with the WebLogic Portal.

portal_drop_indexes.sql

SQL script used to drop all indexes associated with the WebLogic Portal.

portal_drop_tables.sql

SQL script used to drop all tables associated with the WebLogic Portal.

portal_drop_views.sql

SQL script used to drop all views associated with the WebLogic Portal.

sample_portal_create_fkeys.sql

SQL script used to create all foreign keys associated with the Sample Portal.

sample_portal_create_indexes.sql

SQL script used to create all indexes associated with the Sample Portal.

sample_portal_create_tables.sql

SQL script used to create all tables associated with the Sample Portal.

sample_portal_create_triggers.sql

SQL script used to create all database triggers associated with the Sample Portal.

sample_portal_create_views.sql

SQL script used to create all views associated with the Sample Portal.

sample_portal_drop_constraints.sql

SQL script used to drop all constraints (other than foreign keys) associated with the Sample Portal.

sample_portal_drop_fkeys.sql

SQL script used to drop all foreign key constraints associated with the Sample Portal.

sample_portal_drop_indexes.sql

SQL script used to drop all indexes associated with the Sample Portal.

sample_portal_drop_tables.sql

SQL script used to drop all tables associated with the Sample Portal.

sample_portal_drop_views.sql

SQL script used to drop all views associated with the Sample Portal.

wlcs_create_fkeys.sql

SQL script used to create all foreign keys associated with the Commerce services.

wlcs_create_indexes.sql

SQL script used to create all indexes associated with the Commerce services.

wlcs_create_tables.sql

SQL script used to create all tables associated with the Commerce services.

wlcs_create_triggers.sql

SQL script used to create all database triggers associated with the Commerce services.

wlcs_create_views.sql

SQL script used to create all views associated with the Commerce services.

wlcs_drop_constraints.sql

SQL script used to drop all constraints (other than foreign keys) associated with the Commerce services.

wlcs_drop_fkeys.sql

SQL script used to drop all foreign key constraints associated with the Commerce services.

wlcs_drop_indexes.sql

SQL script used to drop all indexes associated with the Commerce services.

wlcs_drop_tables.sql

SQL script used to drop all tables associated with the Commerce services.

wlcs_drop_views.sql

SQL script used to drop all views associated with the Commerce services.


 

 


Defined Constraints

Various constraints are defined and used in the Product Catalog database schema. These constraints can be found in the following scripts:

wlcs_create_fkeys.sql—contains the Foreign Keys

wlcs_create_tables.sql—contains the Check Constraints

Table 2-9 Constraints Defined on Product Catalog Database Tables

Table Name

Constraints

CATALOG_PROPERTY_VALUE

Column—ENTITY_ID
Constraint—FK1_CAT_PROP_V
Constraint Type—FOREIGN KEY
Ensures that each CATALOG_PROPERTY_VALUE references an existing CATALOG_ENTITY via the ENTITY_ID column.

Column—PROPERTY_KEY_ID
Constraint—FK2_CAT_PROP_V
Constraint Type—FOREIGN KEY
Ensures that each CATALOG_PROPERTY_VALUE references an existing CATALOG_PROPERTY_KEY via the PROPERTY_KEY_ID column.

Column—BOOLEAN_VALUE
Constraint—CC1_CAT_PROP_V
Constraint Type—CHECK
Ensures the value of the BOOLEAN_VALUE column is either 0 (false) or 1 (true).

WLCS_CATEGORY

Column—CATEGORY_ID
Constraint—FK1_CATEGORY
Constraint Type—FOREIGN KEY
Ensures that each PARENT_ID references an existing WLCS_CATEGORY via the CATEGORY_ID column.

WLCS_PRODUCT_CATEGORY

Column— CATEGORY_ID
Constraint— FK1_PRODUCT_CAT
Constraint Type—FOREIGN KEY
Ensures that each CATEGORY_ID references an existing WLCS_CATEGORY via the CATEGORY_ID column.

Column—SKU
Constraint—FK2_PRODUCT_CAT
Constraint Type—FOREIGN KEY
Ensures that each SKU references an existing WLCS_PRODUCT via the SKU column.

WLCS_PRODUCT_KEYWORD

Column—SKU
Constraint—FK1_PRODUCT_KEY
Constraint Type—FOREIGN KEY
Ensures that each SKU references an existing WLCS_PRODUCT via the SKU column.


 

 

back to top previous page next page