Oracle Designer Extension Builder

Installation Document Release 1.0

February 2007

This document explains how to install Oracle Designer Extension Builder. It contains the following topics:

Prerequisites Installing Oracle Designer Extension Builder PL/SQL Web Server Configuration

Prerequisites
An Oracle Designer Extension Builder user has to be an Oracle Designer subordinate user. A subordinate user is a repository user who has controlled access to the repository metadata. To install Oracle Designer Extension Builder, you must perform the following prerequisite steps:

Create a Subordinate User Grant Access on Workarea and Containers to Oracle Designer Extension Builder Users

Create a Subordinate User

Any user name you want to use for subordinate users must already have been created as Oracle user names by using a CREATE USER statement in SQL*Plus. Once the user name is created, you can use the Repository Administration Utility to create subordinate users. To create Oracle user names and subordinate user names, perform the following steps:
1.

Start SQL*Plus and connect to the database as a user with SYSDBA privileges using the following command:
sqlplus "sys/<sys_password>@<service_name> AS SYSDBA"

2.

Create an Oracle Database user as follows:

Create user username identified by password; grant connect , resource to username;

3. 4.

In the Repository Administration Utility, open the User Maintenance dialog box. Select Users and click Add (+).

5. 6. 7. 8. 9.

In the Repository User Properties dialog box, select the user you want to add from the Oracle User Name list. Enter other details about this user, for example, their real name. This is an optional step. Select the repository privileges and roles this user must have for using the repository. Click OK to return to the User Maintenance dialog box. Click Reconcile. This is an optional step.
Note:

If you have given users access to the repository using private synonyms, then the new user has the status INSERTED (Reconcile button is enabled) and you must reconcile the grants for the user before they can use the repository. If you have given users access to the repository using public synonyms, then the new user has the status VALID (Reconcile button is disabled) and now has access to the repository using the one set of synonyms defined for all users. Therefore, you do not have to create any synonyms specifically for the user.

10. A message is displayed reminding you to check that all users have the

correct system privileges. Click OK.

Note:

Do not stop the reconcile operation before it is complete, else users will not have the synonyms required to access the repository. If you do not have the repository owner privileges to reconcile grants, then a message displays showing the privileges you require. Click Cancel and contact your Oracle Database Administrator to assign you the privileges.

Grant Access on Workarea and Containers to Oracle Designer Extension Builder Users
Once the subordinate user is created, you need to grant access rights to the subordinate user on one or more selected containers, configurations, or workareas. This is required because the Oracle Designer Extension Builder user (subordinate user) can work only on the Oracle Designer metadata present in those containers to which the user is granted access. An Oracle Designer Extension Builder user needs to be granted select rights on the container that you want the user to work on. This can be done through the Repository Object Navigator. The owner of the container or workarea can grant access to a different user. In addition, a repository owner can also grant access on containers, configurations, or workareas to a subordinate user. To grant access to containers, perform the following steps:

1. 2. 3. 4. 5.

Invoke the Repository Object Navigator and open the workarea on which access must be granted. Right click the workarea and select Grant Access Right from the menu. Select the user from the user list and select the select option. This provides the select access to the user. Click Grant and then OK. Similarly, right click the Application system or folder within the workarea to which you want to give access rights and select Grant Access Right from the menu. Select the user from the user list and select the select option. This provides select access to the user. Check the recurse sub-containers option. Click Grant and then OK. Repeat these steps for all the workarea and containers to which you want to give the user select access.

6. 7. 8. 9.

Installing Oracle Designer Extension Builder

To install Oracle Designer Extension Builder, perform the following steps:
1. 2.

Extract the contents of the Oracle Designer Extension Builder install ZIP file into a temporary folder, for example, c:\temp. On the command prompt, set the current directory to the one where the scripts are stored. For example:
cd c:\temp\deb

3.

Start SQL*Plus as follows:

Oracle_Home\bin\sqlplus

4.

When prompted for the user name, enter the full connect string as follows:
sys/psw@host [as sysdba]

5.

At the SQL prompt, run the following command:

@setup.sql

6.

This script prompts for some input. The following example shows the prompts you may see along with sample input values:
SQL> @setup.sql Enter DEB Schema name : deb Enter DEB Schema password : deb Enter Repository owner user id : repos Enter Repository user password : manager Enter TNS connect string for server : stdes10.world Enter the install files path : c:\temp\deb Enter the file separator : \ Enter the folder on the server machine where you want your logs to exist. This path should be existing on the server machine : c:\temp

The user who installed Oracle Database on the server should have the write permission on the DEB logs folder in which the log files are being generated.
Note:

Installation log files such as install_api.log, install_ddl.log, and install_ui.log are created in the same directory in which the setup.sql file is present. For example: c:\temp\deb Once the input is provided correctly, the DDL and PL/SQL packages are installed on the subordinate user schema.
7.

To check for invalid packages, run the following query:

select object_name, status from all_objects where object_type like 'PACKAGE' and owner like user and status <> 'VALID';

PL/SQL Web Server Configuration

After the Oracle Designer Extension Builder installation, you need to configure a Web server to provide access to the Oracle Designer Extension Builder PL/SQL procedures by using a browser. You need to perform the following tasks:

Copy the Required Files to the Web Server Create Directory Mappings Create a Database Access Descriptor (DAD)

Copy the Required Files to the Web Server

You need to create a gif folder on the Web server and then copy all the files present in the DEBInstallationDirectory\gifs directory to the Web server gif folder. Similarly you need to create a doc folder on the Web server and then copy all the files and folders present in the DEBInstallationDirectory\docs directory to the Web server doc folder. You need to ensure that the user accessing the Web server has read permission to the gif and the doc folder. If the Web server is running on a Unix system, it is recommended that you use a FTP tool to copy files.

Create Directory Mappings

A directory mapping is used by the Web server to map a virtual directory to a physical directory. The computer on which the Web server is running should be able to access the physical directory. Oracle Designer Extension Builder requires the following directory mappings:

Virtual Directory: /deb_images/ and /deb_docs/ Physical Directory: Location of the folders to which you have copied the gif and doc files.

In Oracle Application Server, you need to define the virtual directory mappings in Apache. You need to edit the httpd.conf file available in the ORA_ HOME\Apache\Apache\conf directory. Perform the following steps to define the virtual directory mappings:
1. 2.

Open the httpd.conf file in a text editor. Enter the following code:
Alias /deb_images/ "<DEB gif directory>/" Alias /deb_docs/ "<DEB docs directory>/"

A sample httpd.conf file is shown in the following example:

.. # # Aliases: Add here as many aliases as you need (with no limit). The format is # Alias fakename realname # # Note that if you include a trailing / on fakename then the server will # require it to be present in the URL. So "/icons" isn't aliased in this # example, only "/icons/".. # Alias /icons/ "D:\oraias9i\Apache\Apache\icons/" Alias /jservdocs/ "D:\oraias9i\Apache\Jserv\docs/" # Unix example: Alias /deb_images/ "/u01/app/deb/gif/" # NT example: Alias /deb_images/ "c:\deb\gif/" Alias /deb_images/ "<DEB gif directory>/" Alias /deb_docs/ "<DEB docs directory>/" .. ..

Note:

It is recommended to group all Alias statements in the httpd.conf file together as shown in the example.

3.

Restart the server.

Create a Database Access Descriptor (DAD)

All HTML pages of Oracle Designer Extension Builder are known as dynamic documents. It means that these HTML pages are not stored on the file system but are created at run time by PL/SQL code in your database. To be able to call this code from your browser, the Web server should be able to obtain the following information from the URL you provide in the browser:

The connection string of the user for logging in to the database The name of the stored procedure to be executed

Providing the entire connection string in the URL can be a security issue. Therefore, an intermediate object called a Database Access Descriptor (DAD) is created in the Web server configuration that can translate the URLs which follow a specific formatting convention to a connection string and a stored procedure to execute. Such a URL could look as shown in the following example:
http://<your_server:your_port>/DEBDAD/ODEB.STARTUP

The string /DEBDAD/ is the name of a DAD. From this DAD name, the Web server retrieves the connect string from its configuration, and uses it to connect to a database. The string /ODEB.STARTUP, which usually indicates a filename, is indicating a stored PL/SQL object. The procedure STARTUP in the package ODEB is executed, and its output is sent back to the browser that submitted the URL.
Note:

It is not mandatory to store user name and password in a DAD. When this data is not specified, the Web server displays a login dialog box when you start the application.

Providing Access to the Oracle Designer Extension Builder User

You can provide following two types of access to the Oracle Designer Extension Builder user:

DAD type 1 - Oracle Designer Extension Builder users log in with their own username and password. You need to create one DAD without any Oracle username/password which can then be used for any Oracle Designer Extension Builder user.

DAD type 2 - Oracle Designer Extension Builder users are automatically logged in with a particular Oracle Designer Extension Builder user name. In this case, you need to specify the user name/password of the Oracle Designer Extension Builder user in the DAD. A separate DAD is required for each Oracle Designer Extension Builder user.

You can have both DAD of type 1 and one or more DADs of type 2. Perform the following steps to create a DAD in Oracle Application Server:
1. 2.

Edit the DAD configuration file dads.conf located in the ORACLE_ HOME/Apache/modplsql/conf directory. Add a DAD in the following format:

Database Access Descriptor Name This is the name of the database descriptor. Specify DEB as value. For example:
<Location /DEB>

PlsqlAuthenticationMode PlsqlAuthenticationMode parameter specifies the authentication mode to use for access through this DAD. Specify Basic as value. For example:
PlsqlAuthenticationMode Basic

PlsqlDatabaseConnectString PlsqlDatabaseConnectString parameter specifies the connection to an Oracle Database. For example:
PlsqlDatabaseConnectString myhost.com:1521:iasdb

PlsqlDatabasePassword

PlsqlDatabasePassword parameter specifies the password to use to log in to the database.

PlsqlDatabaseUserName Specifies the user name to use to login to the database. For example:
PlsqlDatabaseUsername scott

PlsqlDefaultPage PlsqlDefaultPage parameter specifies the default procedure to call if none is specified in the URL. Specify ODEB.STARTUP as value. For example:
PlsqlDefaultPage ODEB.STARTUP

PlsqlDocumentTablename PlsqlDocumentTablename parameter specifies the table in the database to which all documents are uploaded. Specify DDK_IMPORT_ FILES as value. For example:
PlsqlDocumentTablename DDK_IMPORT_FILES

3. 4.

Save the file. Restart the server.

Following example shows a sample dads.conf file:

<Location /DEB> PlsqlDatabaseUsername PlsqlDatabasePassword PlsqlDatabaseConnectString PlsqlAuthenticationMode PlsqlDefaultPage PlsqlDocumentTablename </Location> scott tiger orcl Basic ODEB.STARTUP DDK_IMPORT_FILES

You can start the Oracle Designer Extension Builder console by using the following URL:
http://<your_server:your_port>/<DAD name>/ODEB.STARTUP

Figure 1 shows the Oracle Designer Extension Builder console page. Click HELP for Oracle Designer Extension Builder documentation.

Figure 1 Oracle Designer Extension Builder Console

Documentation Accessibility
Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/ Accessibility of Code Examples in Documentation Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace. Accessibility of Links to External Web Sites in Documentation This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites. TTY Access to Oracle Support Services Oracle provides dedicated Text Telephone (TTY) access to Oracle Support Services within the United States of America 24 hours a day, seven days a week. For TTY support, call 800.446.2398.

Oracle Designer Extension Builder, Release 1.0 Copyright 2007, Oracle. All rights reserved. The Programs (which include both the software and documentation) contain proprietary information; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited. The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. This document is not warranted to be error-free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose. If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of the United States Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software--Restricted Rights (June 1987). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065. The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and we disclaim liability for any damages caused by such use of the Programs. Oracle, JD Edwards, PeopleSoft, and Siebel are registered trademarks of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. The Programs may provide links to Web sites and access to content, products, and services from third parties. Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all risks associated with the use of such content. If you choose to purchase any products or services from a third party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warranty obligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third party.

10