BEA Logo BEA WLCS Release 3.5

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

 

   WLCS Documentation   |   Creating Portals and Portlets   |   Previous Topic   |   Next Topic   |   Contents   |   Index

Portal Management Database Schema

 

This topic documents the database schema for the WebLogic Personalization Server Portal Management package. This topic includes the following sections:

 


The Entity-Relation Diagram

Figure 7-1 shows the logical Entity-Relation diagram for the WebLogic Commerce Server Portal and Portlet tables in the Commerce database. See the subsequent sections in this chapter for information about the data type syntax.

Figure 7-1 Entity-Relation Diagram for the Portal and Portlet Tables


 
 

Figure 7-2 lists the tables used for the example portal.

Note: These tables are listed in the database schema chapter for the WebLogic Personalization Server.

Figure 7-2 Tables Used for the Example Portal


 

 


List of Tables Comprising the Portal Management Package

Portal Management tables:

The WLCS_CATEGORIES Database Table

The WLCS_COLUMN_INFORMATION Database Table

The WLCS_PORTAL_DEFINITION Database Table

The WLCS_PORTLET_DEFINITION Database Table

The WLCS_PORTAL_HIERARCHY Database Table

The WLCS_PORTAL_GROUP_HIERARCHY Database Table

The WLCS_GROUP_PERSONALIZATION Database Table

The WLCS_PORTAL_PERSONALIZATION Database Table

The WLCS_USER_PERSONALIZATION Database Table

The Tables Used for the Sample Portal:

The WLCS_BOOKMARKS Database Table

The WLCS_CATEGORIES Database Table

The WLCS_COLUMN_INFORMATION Database Table

The WLCS_GROUP_PERSONALIZATION Database Table

The WLCS_IS_ALIVE Database Table

The WLCS_LDAP_CONFIG Database Table

The WLCS_SEQUENCER Database Table

The WLCS_TODO Database Table

The WLCS_UIDS Database Table

The WLCS_UNIFIED_PROFILE_TYPE Database Table

The WLCS_USER_GROUP_CACHE Database Table

The WLCS_USER_PERSONALIZATION Database Table

The WLCS_UUP_EXAMPLE Database Table

 


The Portal Management Data Dictionary

In this section, the Portal and Portlet schema tables are arranged alphabetically as a data dictionary.

Note: Even though the following documentation references "foreign keys" to various tables, these constraints do not currently exist in this release of WebLogic Personalization Server. However, they will be (available in future releases) in place in future versions of WebLogic Personalization Server and we want you to be aware of these relationships now.

The WLCS_BOOKMARKS Database Table

Table 7-1 describes the WLCS_BOOKMARKS table. This table is used by the Example portal and is not used except for demonstration purposes. It contains information used in the Bookmark portlet.

The Primary Key is comprised of NAME and OWNER.

Table 7-1 WLCS_BOOKMARKS Table Metadata

Column Name

Data Type

Description and Recommendations

NAME

VARCHAR(150)

The name of the bookmark.

OWNER

VARCHAR(150)

The owner of the bookmark.

URL

VARCHAR(50)

The URL of the bookmark.


 
 

The WLCS_CATEGORIES Database Table

Table 7-2 describes the WLCS_CATEGORIES table. This table is used to store category information for the portal portion of the WebLogic Personalization Server application.

Note: The CATEGORY feature has not been implemented at this time and, therefore, this table is not being used/populated.

The Primary Key is NID.

Table 7-2 WLCS_CATEGORIES

Column Name

Data Type

Description and Recommendations

NID

NUMBER(15)

Category identifier.

PORTAL_NID

NUMBER(15)

The Portal identifier. This column is a foreign key to the NID column of the WLCS_PORTAL_DEFINITION table.

NAME

VARCHAR(100)

The name for the category.

ICON_URL

VARCHAR(100)

The URL pointing to the icon associated with the category. This may be null.

CATEGORY_ORDER

NUMBER(5)

The sequence number identifying the order of display.


 
 

The WLCS_COLUMN_INFORMATION Database Table

Table 7-3 describes the WLCS_COLUMN_INFORMATION table. This table is used to store column definition information for each portal and category.

The Primary Key is comprised of PORTAL_NID, CATEGORY_NID and COLUMN_ORDER.


 

Table 7-3 WLCS_COLUMN_INFORMATION

Column Name

Data Type

Description and Recommendations

PORTAL_NID

NUMBER(15)

The Portal identifier. This column is a foreign key to the NID column of the WLCS_PORTAL_DEFINITION table.

CATEGORY_NID

NUMBER(15)

The Category identifier.

COLUMN_ORDER

NUMBER(5)

A sequence number identifying the display sequence for this column. Starting at the left-most part of the screen the COLUMN_ORDER would be 1.

COLUMN_WIDTH

NUMBER(5)

The value entered here is a percentage of the screen width. An example would be 30. This represents how wide this particular portal column is to be (30% of the screen).


 

The WLCS_IS_ALIVE Database Table

Table 7-4 describes the WLCS_IS_ALIVE table. This table is used by the JDBC connection pools to insure the connection to the database is still alive.

There is no Primary Key


 
 
 

Table 7-4 WLCS_IS_ALIVE Table Metadata

Column Name

Data Type

Description and Recommendations

NAME

VARCHAR(100)

Used by the JDBC connection pools to insure the connection to the database is still alive.


 
 

The WLCS_LDAP_CONFIG Database Table

Table 7-5 describes the WLCS_LDAP_CONFIG table. This table holds configuration information for LDAP functionality within the User Management module.

There is no Primary Key.

Table 7-5 WLCS_LDAP_CONFIG Table Metadata

Column Name

Data Type

Description and Recommendations

LDAP_PROPERTY

VARCHAR(100)

The property name.

LDAP_VALUE

VARCHAR(254)

The property value.


 

The WLCS_PORTAL_DEFINITION Database Table

Table 7-6 describes the WLCS_PORTAL_DEFINITION table.

The Primary Key is NID.

Table 7-6 WLCS_PORTAL_DEFINITION

Column Name

Data Type

Description and Recommendations

NID

NUMBER(15)

The identifier for the portal definition.

NAME

VARCHAR(500)

The name of the portal definition. Any combination of numbers and letters will be accepted in this field.

HEADER_URL

VARCHAR(500)

Enter a URL to display as the portal header. It can be a JSP or HTML fragment.

CONTENT_URL

VARCHAR(500)

Enter a URL relative to your portal working directory.

FOOTER_URL

VARCHAR(500)

Enter a URL to display as the portal footer. It can be a JSP or HTML fragment.

CONTENT_COLUMN_COUNT

NUMBER(5)

Specifies the number of content columns. Valid values at this time would be 1, 2, or 3.

SUSPENDED

NUMBER(5)

Set this flag to suspend the portal application and replace the portal home page with an "under maintenance" screen until service resumes.

SUSPENDED_URL

VARCHAR(500)

When the SUSPENDED flag is set, this URL will point to the JSP page to be displayed while the application is in suspend mode.


 

The WLCS_PORTAL_GROUP_HIERARCHY Database Table

Table 7-7 describes the WLCS_PORTAL_GROUP_HIERARCHY table. This table maintains records showing which groups are associated with each portal.

The Primary Key is comprised of PORTAL_NID and GROUP_NID.

Table 7-7 WLCS_PORTAL_GROUP_HIERARCHY

Column Name

Data Type

Description and Recommendations

PORTAL_NID

NUMBER(15)

The portal identifier. This column is a foreign key to the NID column of the WLCS_PORTAL_DEFINITION table.

GROUP_NID

NUMBER(15)

The group identifier. This column is a foreign key to the ENTITY_ID column of the WLCS_ENTITY_ID table.


 

The WLCS_GROUP_PERSONALIZATION Database Table

Table 7-8 describes the WLCS_GROUP_PERSONALIZATION table. Portals can be associated to groups and this table helps establish those relationships and maintain specific information for the group.

The Primary Key is comprised of PORTAL_NID, CATEGORY_NID, PORTLET_NID and GROUP_NID.

Table 7-8 WLCS_GROUP_PERSONALIZATION

Column Name

Data Type

Description and Recommendations

PORTAL_NID

NUMBER(15)

The portal identifier. This column is a foreign key to the NID column of the WLCS_PORTAL_DEFINITION table.

CATEGORY_NID

NUMBER(15)

The category identifier. This column is a foreign key to the NID column of the WLCS_CATEGORIES table.

PORTLET_NID

NUMBER(15)

The portlet identifier. This column is a foreign key to the NID column of the WLCS_PORTLET_DEFINITION table.

GROUP_NID

NUMBER(15)

The group identifier. This column is a foreign key to the ENTITY_ID column of the WLCS_ENTITY_ID table.

AVAILABLE

NUMBER(5)

A switch to identify whether or not this portlet is available.

MANDATORY

NUMBER(5)

This flag, when set, overrides the VISIBLE flag and requires the portlet be displayed.

EDITABLE

NUMBER(5)

This flag determines whether a user is allowed to edit any content.

MOVEABLE

NUMBER(5)

This column is not being used.

MINIMIZEABLE

NUMBER(5)

This flag determines whether or not the user will be allowed to minimize the portlet.

MAXIMIZEABLE

NUMBER(5)

This flag determines whether or not the user will be allowed to maximize the portlet.

FLOATABLE

NUMBER(5)

This flag determines whether the portlet can open up in its own browser window.

VISIBLE

NUMBER(5)

This flag determines whether or not the portlet is visible.

X

NUMBER(5)

The X coordinate determines the placement of the portlet on the screen. This is zero based and refers to the column placement (0=column 1, 1=column 2 and so on).

Y

NUMBER(5)

The Y coordinate determines placement of the portlet on the screen. Like the X coordinate, it is zero based. The Y coordinate refers to the row placement (0=row 1, 1=row 2 and so on).

MINIMIZED

NUMBER(5)

This flag determines whether or not the portlet should be displayed in a minimized format when initially displayed.


 

The WLCS_PORTAL_HIERARCHY Database Table

Table 7-9 describes the WLCS_PORTAL_HIERARCHY table. This table contains records showing which portlets are associated with each portal.

The Primary Key is comprised of PORTAL_NID and PORTLET_NID.

Table 7-9 WLCS_PORTAL_HIERARCHY

Column Name

Data Type

Description and Recommendations

PORTAL_NID

NUMBER(15)

The portal identifier. This column is a foreign key to the NID column of the WLCS_PORTAL_DEFINITION table.

PORTLET_NID

NUMBER(15)

The portlet identifier. This column is a foreign key to the NID column of the WLCS_PORTLET_DEFINITION table.


 

The WLCS_PORTAL_PERSONALIZATION Database Table

Table 7-10 describes the WLCS_PORTAL_PERSONALIZATION table. This table maintains information pertinent to each personalized portal definition.

The Primary Key is comprised of PORTAL_NID, CATEGORY_NID and PORTLET_NID.

Table 7-10 WLCS_PORTAL_PERSONALIZATION

Column Name

Data Type

Description and Recommendations

PORTAL_NID

NUMBER(15)

The portal identifier. This column is a foreign key to the NID column of the WLCS_PORTAL_DEFINITION table.

CATEGORY_NID

NUMBER(15)

The category identifier. This column is a foreign key to the NID column of the WLCS_CATEGORIES table.

PORTLET_NID

NUMBER(15)

The portlet identifier. This column is a foreign key to the NID column of the WLCS_PORTLET_DEFINITION table.

AVAILABLE

NUMBER(5)

This flag, when set, overrides the VISIBLE flag and requires the portlet be displayed. 0 equates to false and 1 equates to true.

MANDATORY

NUMBER(5)

This flag, when set, overrides the VISIBLE flag and requires the portlet be displayed.

EDITABLE

NUMBER(5)

This flag determines whether a user is allowed to edit the content of the portal. 0 equates to false and 1 equates to true.

MOVEABLE

NUMBER(5)

This column is not being used. 0 equates to false and 1 equates to true.

MINIMIZEABLE

NUMBER(5)

This flag determines whether or not the user will be allowed to minimize the portlet. 0 equates to false and 1 equates to true.

MAXIMIZEABLE

NUMBER(5)

This flag determines whether or not the user will be allowed to maximize the portlet. 0 equates to false and 1 equates to true.

FLOATABLE

NUMBER(5)

This flag determines whether the portlet can open up in its own browser window. 0 equates to false and 1 equates to true.

VISIBLE

NUMBER(5)

This flag determines whether or not the portlet is visible. 0 equates to false and 1 equates to true.

X

NUMBER(5)

The X coordinate determines the placement of the portlet on the screen. This is zero based and refers to the column placement (0=column 1, 1=column 2 and so on).

Y

NUMBER(5)

The Y coordinate determines placement of the portlet on the screen. Like the X coordinate, it is zero based. The Y coordinate refers to the row placement (0=row 1, 1=row 2 and so on).

MINIMIZED

NUMBER(5)

This flag determines whether or not the portlet should be displayed in a minimized format when displayed initially. 0 equates to false and 1 equates to true.


 

The WLCS_PORTLET_DEFINITION Database Table

Table 7-11 describes the WLCS_PORTLET_DEFINITION table. This table maintains information pertinent to each portlet definition.

The Primary Key is comprised of NID.

Table 7-11 WLCS_PORTLET_DEFINITION

Column Name

Data Type

Description and Recommendations

NID

NUMBER(15)

The portlet identifier.

NAME

VARCHAR(500)

The name of your portlet. Any combination of numbers and letters will be accepted in this field.

HEADER_URL

VARCHAR(500)

Enter a URL to display as the portlet header. It can be a JSP or HTML fragment.

FOOTER_URL

VARCHAR(500)

Enter a URL to display as the portlet footer. It can be a JSP or HTML fragment.

CONTENT_URL

VARCHAR(500)

Enter a URL relative to your portal working directory.

BANNER_URL

VARCHAR(500)

Enter a URL to display as the portlet banner under the portlet titlebar. It can be a JSP or HTML fragment.

ALTERNATE_HEADER_URL

VARCHAR(500)

Enter a URL to display as a Web page header when the portlet is floated or maximized. If this is null, the portal framework uses a default called alternateheader.jsp.

ALTERNATE_FOOTER_URL

VARCHAR(500)

Enter a URL to display as a Web page footer when the portlet is floated or maximized. If this is null, the portal framework uses a default called alternatefooter.jsp.

TITLEBAR_URL

VARCHAR(500)

Enter a URL to display as the portlet titlebar. It can be a JSP or HTML fragment.

EDIT_URL

VARCHAR(500)

If the EDITABLE flag has been set then a URL will be stored here that enables the user to edit the portlet content.

HELP_URL

VARCHAR(500)

If the HELP flag has been set then a URL must be specified that opens a help topic related to the portlet.

ICON_URL

VARCHAR(500)

A URL to display an icon (GIF) on the left side of the portlet titl bar. This image should be 27 pixels wide by 20 pixels high with 2 pixels of transparency on the right.

HELP

NUMBER(5)

This flag determines whether users can access a help screen in the portlet. If set, a Help icon displays in the portlet titlebar.

MAXIMIZED_URL

VARCHAR(500)

A URL for the content area of the maximized page. The default URL is your portlet content area URL.

MANDATORY

NUMBER(5)

This flag, when set, overrides the VISIBLE flag and requires the portlet be displayed. 0 equates to false and 1 equates to true.

EDITABLE

NUMBER(5)

This flag determines whether a user is allowed to edit the content of a portlet. 0 equates to false and 1 equates to true.

MOVEABLE

NUMBER(5)

This column is not being used. 0 equates to false and 1 equates to true.

LOGIN_REQUIRED

NUMBER(5)

This flag determines whether or not security is required for access to the portlet. 0 equates to false and 1 equates to true.

MINIMIZEABLE

NUMBER(5)

This flag determines whether or not the user will be allowed to minimize the portlet. 0 equates to false and 1 equates to true.

MAXIMIZEABLE

NUMBER(5)

This flag determines whether or not the user will be allowed to maximize the portlet. 0 equates to false and 1 equates to true.

FLOATABLE

NUMBER(5)

This flag determines whether the portlet can open up in its own browser window. 0 equates to false and 1 equates to true.

VISIBLE

NUMBER(5)

This flag determines whether or not the portlet is visible. 0 equates to false and 1 equates to true.

X

NUMBER(5)

The X coordinate determines the placement of the portlet on the screen. This is zero based and refers to the column placement (0=column 1, 1=column 2 and so on).

Y

NUMBER(5)

The Y coordinate determines placement of the portlet on the screen. Like the X coordinate, it is zero based. The Y coordinate refers to the row placement (0=row 1, 1=row 2 and so on).

MINIMIZED

NUMBER(5)

This flag determines whether or not the portlet should be displayed in a minimized format when displayed initially. 0 equates to false and 1 equates to true.


 

The WLCS_SEQUENCER Database Table

Table 7-12 describes the WLCS_SEQUENCER table. The WLCS_SEQUENCER table is used to maintain all of the sequence identifiers (for example, property_meta_data_id_sequence, and so on) used in the application.

There is no Primary Key.

Table 7-12 WLCS_SEQUENCER Table Metadata

Column Name

Data Type

Description and Recommendations

SEQUENCE_NAME

VARCHAR(50)

A unique name used to identify the sequence.

CURRENT_VALUE

NUMBER(15)

The current value of the sequence.

IS_LOCKED

NUMBER(1)

This flag identifies whether or not the particular SEQUENCE_ID has been locked for update. This column is being used as a generic locking mechanism that can be used for multiple database environments.


 

The WLCS_TODO Database Table

Table 7-13 describes the WLCS_TODO table. This table is used by the Example portal and is not used except for demonstration purposes. It contains information used in the To Do portlet.

The Primary Key is ITEM and OWNER.

Table 7-13 WLCS_TODO Table Metadata

Column Name

Data Type

Description and Recommendations

ITEM

VARCHAR(50)

The activity to be accomplished.

OWNER

VARCHAR(150)

The individual who owns, or is responsible, for this activity.

DONE

NUMBER(5)

The status identifying whether this item has been completed.

PRIORITY

NUMBER(5)

The priority of the activity.


 

The WLCS_UIDS Database Table

Table 7-14 describes the WLCS_UIDS table. This table stores sequence information in a generic database independent format.

The Primary Key is SID.

Table 7-14 WLCS_UIDS Table Metadata

Column Name

Data Type

Description and Recommendations

SID

VARCHAR(100)

The name of the sequence.

NEXT_SEQUENCE

NUMBER(15)

The next value available for use with the sequence.


 

The WLCS_UNIFIED_PROFILE_TYPE Database Table

Table 7-15 describes the WLCS_UNIFIED_PROFILE_TYPE table. This table allows registration of classes which extend the ProvidedUser class.

There is no Primary Key.

Table 7-15 WLCS_UNIFIED_PROFILE_TYPE Table Metadata

Column Name

Data Type

Description and Recommendations

TYPE_NAME

VARCHAR(100)

Any unique name used for easy lookup.

CLASS_NAME

VARCHAR(100)

The name of the remote interface class.

HOME

VARCHAR(100)

The name of the home class.

PK

VARCHAR(100)

The name of the primary key class.

JNDI_NAME

VARCHAR(100)

The name to look up in the JNDI tree.

SUCCESSOR

VARCHAR(100)

This column allows you to define another class should the TYPE_NAME not exist. This column is a foreign key to TYPE_NAME of the WLCS_UNIFIED_PROFILE_TYPE table.


 

The WLCS_USER_GROUP_CACHE Database Table

Table 7-16 describes the WLCS_USER_GROUP_CACHE table. In the event of a deep group hierarchy, this table will flatten the group hierarchy and enables quick group membership searches.

Note: The startup process GroupCache is disabled by default. This table will only be used if enabled.

The Primary Key is comprised of both USER_NAME and GROUP_NAME.

Table 7-16 WLCS_USER_GROUP_CACHE Table Metadata

Column Name

Data Type

Description and Recommendations

USER_NAME

VARCHAR(100)

FK—foreign key to WLCS_USER.IDENTIFIER.

GROUP_NAME

VARCHAR(100)

FK—foreign key to WLCS_GROUP.IDENTIFIER.


 

The WLCS_USER_PERSONALIZATION Database Table

Table 7-17 describes the WLCS_USER_PERSONALIZATION table.This table contains personalized portal information for the user.

The Primary Key is comprised of PORTAL_NID, CATEGORY_NID, GROUP_NID, USER_NID and PORTLET_NID.

Table 7-17 WLCS_USER_PERSONALIZATION

Column Name

Data Type

Description and Recommendations

PORTAL_NID

NUMBER(15)

The portal identifier. This column is a foreign key to the NID column of the WLCS_PORTAL_DEFINITION table.

CATEGORY_NID

NUMBER(15)

The category identifier. This column is a foreign key to the NID column of the WLCS_CATEGORIES table.

GROUP_NID

NUMBER(15)

The group identifier. This column is a foreign key to the ENTITY_ID column of the WLCS_ENTITY_ID table.

USER_NID

NUMBER(15)

The user identifier. This column is a foreign key to the ENTITY_ID column of the WLCS_ENTITY_ID table.

PORTLET_NID

NUMBER(15)

The portlet identifier. This column is a foreign key to the NID column of the WLCS_PORTLET table.

VISIBLE

NUMBER(5)

This flag determines whether or not the portlet is visible. 0 equates to false and 1 equates to true.

X

NUMBER(5)

The X coordinate determines the placement of the portlet on the screen. This is zero based and refers to the column placement (0=column 1, 1=column 2 and so on).

Y

NUMBER(5)

The Y coordinate determines placement of the portlet on the screen. Like the X coordinate, it is zero based. The Y coordinate refers to the row placement (0=row 1, 1=row 2 and so on).

MINIMIZED

NUMBER(5)

This flag determines whether or not the portlet should be displayed in a minimized format when displayed initially. 0 equates to false and 1 equates to true.


 

The WLCS_UUP_EXAMPLE Database Table

Table 7-18 describes the WLCS_UUP_EXAMPLE table. This is an example of how to use the Unified Profile Types.

There is no Primary Key.

Table 7-18 WLCS_UUP_EXAMPLE Table Metadata

Column Name

Data Type

Description and Recommendations

NAME

VARCHAR(100)

A username.

POINTS

NUMBER(15)

A point accumulator based on various actions taken by the user.


 

 


The SQL Scripts Used to Create the Database

The database schemas for the WebLogic Personalization Server, WebLogic Commerce Server and BEA's Campaign Manager for WebLogic are all created by executing the create_all script for the target database environment.

Cloudscape

For Cloudscape, execute one of the following:

Oracle

For Oracle, from the command line, move to the following directory:

WL_COMMERCE_HOME/db/oracle/8.1.6

After logging into SQL*PLus, simply execute the create_all.sql script (e.g., @create_all).

Script Name

Description

create_campaign.sql

Creates the Campaign Manager specific database objects (e.g., tables, indexes and constraints).

create_common.sql

Creates the database objects which are common to WLPS and WLCS.

create_mail_ad.sql

Creates all the database objects used by the mail messaging component.

create_wlcs.sql

Creates all the database objects for WLCS (including Catalog and Order Management).

create_wlps.sql

Creates all the database object for WLPS.

drop_campaign.sql

Drops all database objects associated with Campaign Manager.

drop_common.sql

Drops the database objects which are common between WLPS and WLCS.

drop_mail_ad.sql

Drops the database objects used by the mail messaging component.

drop_wlcs.sql

Drops the database objects associated with WLCS.

drop_wlps.sql

Drops the database objects associated with WLPS.

insert_common.sql

Inserts core data into the common tables between WLPS and WLCS.

insert_wlcs.sql

Inserts core data into some of the WLCS tables.

insert_wlcs_sample_catalog.sql

Inserts sample data into the product catalog.

insert_wlcs_sample_customer.sql

Inserts sample customer information into WLCS tables.

insert_wlcs_sample_data.sql

Inserts sample data into various WLCS tables.

insert_wlps.sql

Inserts core data into WLPS tables.

insert_wlps_sample_data.sql

Inserts sample data into various WLPS tables.

install_report.sql

This script is used to summarize the database installation. Information such as the number of tables, indexes, etc., is displayed.

statistics.sql

This script is used in computing statistics on various database objects (e.g., tables and indexes) in an Oracle environment.


 

 


Defined Constraints

There are no constraints associated with this part of the schema.

 

back to top previous page next page