D
Setting Up and Maintaining the AS Portlets

Appendix summary

This appendix describes the post-installation set up tasks for the AS Portlets. It also describes other AS Portlet maintainance tasks. .

List of topics

This appendix contains the following topics:

• Registering the AS Portlet Provider

• Adding Databases to the AS_PORTAL_DATABASE_LIST Table

• Removing Databases from the AS_PORTAL_DATABASE_LIST Table

• Clearing the AS Portlets Cache

• Troubleshooting Potential Problems

Registering the AS Portlet Provider

Verifying that you are ready to perform the registration

After you have completed the installation, you should be ready to register the AS Portlet provider with Oracle Portal. It is a good idea, however, to verify that this is the case before proceeding.

To check that you are ready to register the portlet provider, enter the following URL in your Web browser:

http://apache.server.location/servlet/asportlets

The browser should display a page that informs you that you have successfully reached your portlet provider's test page, which indicates that you are ready to register the provider.

If you receive a message that indicates that access is forbidden, you must add the following line to the zone.properties file:

servlet.asportlets.initArgs=debuglevel=1

Procedure: Registering the portlet provider

Use the following procedure to register the AS Portlet provider:

1. Log in to Oracle Portal

2. Choose the Administer tab

3. Select Add a Portlet Provider

4. In the Implementation Style box, select Web

5. In the URL box, enter the URL for the portlet provider:

    http://apache.server.location/servlet/asportlets
   

6. Choose OK.

The AS Portlet provider will now be available, along with the other providers.

Adding Databases to the AS_PORTAL_DATABASE_LIST Table

Introduction

To make an Express database available to Oracle Portal users, you must add the necessary information about the database to the AS_PORTAL_DATABASE_LIST table.

Using DBA Studio to add databases

Oracle Corporation recommends that you use Oracle Enterprise Manager DBA Studio to add databases to the AS_PORTAL_DATABASE_LIST table. Specify the indicated information in the columns in the AS_PORTAL_DATABASE_LIST table, as follows:

d:/orant/olap/ofaxxx/

Using the AddExpressEntry script to add databases

As an alternative to using DBA Studio, you can use the AddExpressEntry script to populate the AS_PORTAL_DATABASE_LIST table with the necessary information about the Express database. Following the installation, the files for the AddExpressEntry script will be in the PTLxxx/PTLWEB/SQL directory under the Oracle Home where xxx represents the current release of Financial Analyzer. For Windows systems, run the AddExpressEntry.cmd script; for Unix systems, run the AddExpressEntry script.

The syntax and parameters are the same for both the Windows and Unix versions of the script, with the exception of the name of the script itself. Each invocation of the script adds one Express database to the table, so you must run the script once for each database that you want to add.

Syntax for AddExpressEntry

The syntax for the Windows version of the AddExpressEntry script is as follows:

addexpressentry.cmd -s express_server_url 
-sd express_server_desc -db express_db -dbd express_db_desc
-a app_type -os sys_os -sso single_sign_on 
-as as_portlet_user -asp as_portlet_pwd -c connect_string

Note: The syntax for the Unix version is identical, except that the name of the script is addexpressentry instead of addexpressentry.cmd.

Parameters for AddExpressEntry

The parameters for the AddExpressEntry script are as follows:

s express_server_url

express_server_url is the URL that points to the Express Web Agent CGI executable and the Express instance.

-sd express_server_desc

express_server_desc is a text description for the Express Web Agent CGI executable and Express instance pointed to by express_server_url. The description must be a continuous string; you can use underscores to separate words, but you cannot use spaces.

-db express_db

express_db is the name of the Express database. For Financial Analyzer databases, express_db is the path name for the database, not including the name of the file. For example

d:/orant/olap/ofaxxx/

where xxx represents the current release of Financial Analyzer.

-dbd express_db_desc

express_db_desc is a text description for the database. The description must be a continuous string; you can use underscores to separate words, but you cannot use spaces.

-a app_type

app_type indicates the application under which the database was created.

Use OFA to indicate that the database was created under Financial Analyzer

-os sys_os

sys_os indicates the operating system for the database. Specify one of the following values for sys_os:

• WIN -- Indicates that the operating system is Windows

• UNIX -- Indicates that the operating system is Unix

-sso single_sign_on

single_sign_on indicates whether the database is a single sign-on database. Specify one of the following values for single_sign_on:

• YES -- Indicates that the database is a single sign-on database

• NO -- Indicates that the database is not a single sign-on database

-as as_portlet_user

as_portlet_user is the user ID for the schema that contains the AS_PORTAL_DATABASE_LIST table.

-asp as_portlet_pwd

as_portlet_pwd is the password associated with the as_portlet_user user ID.

-c connect_string

connect_string is the name of the entry in the TNS names file that specifies the connection to a remote database. This parameter is required only if the database is a remote database. If the database is a local database, omit this parameter entirely.

AddExpressEntry example

The following example shows how to specify the parameters for the AddExpressEntry script for a local Financial Analyzer single sign-on database named test.db, where the URL for the Express Web Agent CGI executable and Express instance is www.test.com, the operating system is Windows, and the user ID and password for the schema that contains the AS_PORTAL_DATABASE_LIST table are both asportlet:

addexpressentry.cmd -s http://www.test.com 
-sd express_server -db test.db -dbd test_database -a osa 
-os win -sso yes -as asportlet -asp asportlet

Removing Databases from the AS_PORTAL_DATABASE_LIST Table

Introduction

To remove users' access to a database, you must remove the entry that pertains to that database from the AS_PORTAL_DATABASE_LIST table.

Using DBA Studio to remove databases

Oracle Corporation recommends that you use Oracle Enterprise Manager DBA Studio to remove an Express database from the AS_PORTAL_DATABASE_LIST table. In DBA Studio, delete the entry for any database to which you no longer want users to have access.

Using the DeleteExpressEntry script to remove databases

As an alternative to using DBA Studio, you can use the DeleteExpressEntry script to remove a database from the table. Following the installation, the files for the DeleteExpressEntry script will be in the PTLxxx/PTLWEB/SQL directory under the Oracle Home where xxx represents the current release of Financial Analyzer. For Windows systems, run the DeleteExpressEntry.cmd script; for Unix systems, run the DeleteExpressEntry script.

Each invocation of the script removes one Express database from the table, so you must run the script once for each database that you want to remove.

Syntax for DeleteExpressEntry

The syntax for the Windows version of the DeleteExpressEntry script is as follows:

deleteexpressentry.cmd -s express_server_url 
-db express_db -as as_portlet_user -asp as_portlet_pwd 
-c connect_string

Note: The syntax for the Unix version is identical, except that the name of the script is deleteexpressentry instead of deleteexpressentry.cmd.

Parameters for DeleteExpressEntry

The parameters for the DeleteExpressEntry script are as follows:

-s express_server_url

express_server_url is the URL that points to the Express Web Agent CGI executable and the Express instance.

db express_db

express_db is the name of the Express database.

For Financial Analyzer databases, express_db is the path name for the database, not including the name of the file. For example:

d:/orant/olap/ofaxxx/

where xxx represents the current release of Financial Analyzer.

as as_portlet_user

as_portlet_user is the user ID for the schema that contains the AS_PORTAL_DATABASE_LIST table.

-asp as_portlet_pwd

as_portlet_pwd is the password associated with the as_portlet_user user ID.

-c connect_string

connect_string is the name of the entry in the TNS names file that specifies the connection to a remote database. This parameter is required only if the database is a remote database. If the database is a local database, omit this parameter entirely.

DeleteExpressEntry Example

The following example shows how to specify the parameters for the DeleteExpressEntry script for a local Financial Analyzer database named test.db, where the URL for the Express Web Agent CGI executable and Express instance is www.test.com and the user ID and password for the schema that contains the AS_PORTAL_DATABASE_LIST table are both asportlet:

deleteexpressentry.cmd -s http://www.test.com -db test.db 
-as asportlet -asp asportlet

Clearing the AS Portlets Cache

Introduction

If Express data has changed, and you want users to be able to view the new data without having to refresh data themselves, you need to clear the AS portlets cache.

Using DBA Studio to clear the cache

Oracle Corporation recommends that you use Oracle Enterprise Manager DBA Studio to clear the cache by removing entries from the AS_PORTAL_CACHE table. In DBA Studio, delete the entries for any users for whom you want to clear the cache.

Using the ClearCache script to clear the cache

As an alternative to using DBA Studio, you can use the ClearCache script to clear the cache. You can clear the cache for all users at once, or for a single user.

Following the installation, the files for the ClearCache script will be in the PTLxxx/PTLWEB/SQL directory under the Oracle Home where xxx represents the current release of Financial Analyzer. For Windows systems, run the ClearCache.cmd script; for Unix systems, run the ClearCache script. The syntax and parameters are the same for both the Windows and Unix versions of the script, with the exception of the name of the script itself.

Syntax for ClearCache

The syntax for the Windows version of the ClearCache script is as follows:

clearcache.cmd -u user -as as_portlet_user 
-asp as_portlet_pwd -c connect_string

Note: The syntax for the Unix version is identical, except that the name of the script is clearcache instead of clearcache.cmd.

Parameters for ClearCache

The parameters for the ClearCache script are as follows:

-u user

user is the Portal user or users for whom you want to clear the cache. Specify ALL to clear the cache for all users or specify the user ID to clear the cache for a single user.

-as as_portlet_user

as_portlet_user is the user ID for the schema that contains the AS_PORTAL_DATABASE_LIST table.

-asp as_portlet_pwd

as_portlet_pwd is the password associated with the as_portlet_user user ID.

-c connect_string

connect_string is the name of the entry in the TNS names file that specifies the connection to a remote database. This parameter is required only if the database is a remote database. If the database is a local database, omit this parameter entirely.

ClearCache Example

The following example shows how to specify the parameters for the ClearCache script for all AS Portlets users named test.db, where the user ID and password for the schema that contains the AS_PORTAL_DATABASE_LIST table are both asportlet:

deleteexpressentry.cmd -s http://www.test.com -db test.db 
-as asportlet -asp asportlet

Troubleshooting Potential Problems

Version of the xmlparserv2.jar file

You must have a current version of the xmlparserv2.jar file. You probably have an old version of the file if you find an error such as the following in the jserv.log file:

[07/11/2001 15:49:15:812] (ERROR) ajp12: Servlet Error:
java.lang.NoClassDefFoundError: org/xml/sax/XMLReader:
org/xml/sax/XMLReader

You can obtain a new version of the file through http://technet.oracle.com. You must reference this .jar file in your jserv.properties file. Also, be sure that you do not have any references to any other xmlparserv2.jar file.

Loading sequence for the cryptix32.jar file

The cryptix32.jar file must be loaded first. If it is not, you may find an error such as the following in the jserv.log file:

[10/12/2001 16:55:51:836 EST] java.lang.NoSuchMethodError: 
netscape.security.PrivilegeManager: method 
revertPrivilege(Lnetscape/security/Target;)V not found

If this error occurs, move the entry in the jserv.properties file that refers to the cryptix32.jar file so that it is the first file to be loaded.