Skip Headers

Oracle Workflow Installation Notes for Oracle Database
Release 2.6.3

Part Number B12169-01

Oracle® Workflow

Installation Notes for Oracle Database

Release 2.6.3

May 2004

Part No. B12169-01

Overview

These notes explain how to install or upgrade the version of Oracle Workflow available with Oracle Database 10g.

The Oracle Workflow installation includes the Oracle Workflow server and Oracle Workflow middle tier components, as well as the Oracle Workflow components that reside on a client PC. The Oracle Workflow server and middle tier components are available from the Oracle Workflow Server Release 2.6.3 (Oracle Database 10g) CD for your platform. The Oracle Workflow client components are available from the Oracle Database Client CD for Windows.

Oracle Workflow Server and Middle Tier Hardware and Software Requirements

The Oracle Workflow server and middle tier components require the following hardware and software configurations:

Java-based Workflow Notification Mailer

Oracle Workflow Server and Middle Tier Installation

Perform the following steps to install Oracle Workflow server and middle tier components or to upgrade an existing version of Oracle Workflow to Release 2.6.3.


Caution:

To upgrade to Release 2.6.3, your existing Oracle Workflow Server must be Release 2.6.0 or higher. If you have an earlier version of Oracle Workflow, you must upgrade Oracle Workflow to Release 2.6 before you can upgrade to Release 2.6.3. Note also that because the Oracle Workflow Release 2.6.3 server and middle tier components are installed separately from the Oracle Workflow Server CD, you must both upgrade Oracle Workflow Server in your database and perform a new installation of Oracle Workflow Middle Tier in your middle tier Oracle home to complete the upgrade.



Caution:

Before you upgrade an existing Oracle Workflow server, ensure that there are no users accessing the server. Otherwise, locks in the database will prohibit a successful upgrade.



Note:

In the sample commands shown in this document, any variable input is enclosed in brackets and is italicized. For example:

cd <workflow_top_directory>


Step 1. Set the database initialization parameters.

You must verify the following parameters set in the database initialization parameter file or server parameter file:

For more information, refer to the Oracle Database Administrator's Guide and the Oracle Streams Advanced Queuing User's Guide and Reference 10g.

Step 2. Load DBMS_LDAP package (conditionally required).

If you plan to integrate with Oracle Internet Directory as your directory repository, ensure that the DBMS_LDAP PL/SQL package is loaded in your database. This package contains the functions and procedures that can be used to access data from LDAP servers and is required for LDAP synchronization. To check whether the DBMS_LDAP package is already installed, connect to SQL*Plus and use the following command:

desc DBMS_LDAP

If the DBMS_LDAP package does not already exist, load it manually by running the catldap.sql script located in the <ORACLE_HOME>/rdbms/admin directory. Run this script as the SYS user. For example, use the following command:

sqlplus "SYS/<SYS password> as sysdba" 
@$ORACLE_HOME/rdbms/admin/catldap.sql

Step 3. Install Oracle Workflow Server files using the Oracle Universal Installer.

Run the Oracle Universal Installer from the Oracle Workflow Server CD to copy the Oracle Workflow Server files to your file system.


Note:

Before you begin running the Oracle Universal Installer, you should close other applications you may have running, including Java applications, Oracle-based applications, and any other applications that consume large amounts of memory, hard disk space, or CPU time. However, you should not close any components of the Oracle Database where you want to install Oracle Workflow.


In the Oracle Universal Installer, choose to install into the Oracle home for your Oracle Database 10g, and select Oracle Workflow Server as the component to install.

To complete the installation, follow the instructions displayed in the Oracle Universal Installer screens. If you need additional information about any screen, click Help. When the installation completes, click Exit and click Yes to exit from the Oracle Universal Installer.

Note that the Oracle Universal Installer copies Workflow files to your system. You must also run the Workflow Configuration Assistant to load Oracle Workflow into your database by creating the Oracle Workflow database objects in the database. For instructions on performing the configuration, see Step 4. Run the Workflow Configuration Assistant.


Note:

During the installation process, the US language is loaded. To support access to Oracle Workflow in another language, you must load that language after completing the installation and configuration steps for Oracle Workflow. You can run the Workflow Configuration Assistant manually to load an additional language into your Oracle Workflow Server database.


Step 4. Run the Workflow Configuration Assistant.

Run the Workflow Configuration Assistant from your database Oracle home to load Oracle Workflow into your database. You must run the Workflow Configuration Assistant after you install Oracle Workflow Server components through the Oracle Universal Installer. You can also rerun the Workflow Configuration Assistant later if you need to reconfigure Oracle Workflow or if you want to load additional languages into your Oracle Workflow Server database after Oracle Workflow is installed and configured. The configuration should take approximately 20 to 30 minutes, depending on your system's speed and capacity.


Note:

Before you begin running the Workflow Configuration Assistant, you should close other applications you may have running, including Java applications, Oracle-based applications, and any other applications that consume large amounts of memory, hard disk space, or CPU time. However, you should not close any components of the Oracle Database where you want to load Oracle Workflow.



Note:

When you run the Workflow Configuration Assistant on Windows, several command windows may open and close automatically. You should ignore these windows. You must not manually close any of these command windows, or you will interrupt the configuration process.


  1. Start the Workflow Configuration Assistant, using the following commands:

    On UNIX:

    $ORACLE_HOME/wf/install/wfinstall.csh
    

    On Windows NT:

    %ORACLE_HOME%\wf\install\wfinstall.bat
    

    On Windows NT, you can also run the Workflow Configuration Assistant from the Start Menu. Choose Start > Programs > Oracle - HOME_NAME > Configuration and Migration Tools > Workflow Configuration Assistant.

  2. In the Oracle Workflow Configuration Assistant window, enter the following user information:

  3. To integrate with Oracle Internet Directory (OID) and Oracle Application Server Single Sign-On as your directory repository for Oracle Workflow, select the Enter LDAP Parameters check box and choose Get LDAP Values.


    Note:

    If you are upgrading an existing installation of Oracle Workflow in which you already implemented OID integration, you must re-enter your Lightweight Directory Access Protocol (LDAP) values here to preserve the OID integration during the upgrade.


    Enter the following LDAP server information for the LDAP directory to which you want to connect. After the initial installation, you can update these values if necessary in the Global Workflow Preferences Web page. For more information, see: Setting Up Oracle Workflow, Oracle Workflow Administrator's Guide.

    • Host Name - The host on which your Lightweight Directory Access Protocol (LDAP) directory resides.

    • Port No. - The port on the host. This port must be a non-Secure Sockets Layer (non-SSL) port.

    • User Name - The LDAP user account used to connect to the LDAP server. This user name must have write privileges and is required to bind to the LDAP directory. For example: cn=orcladmin

    • OID Password - Enter the password for the LDAP user account. LDAP password values are masked as asterisks in the display and are stored in encrypted form.

    • Log Base - The LDAP node under which change logs are located. For example: cn=changelog

    • User Base - The LDAP node under which user records can be found. For example: cn=Base, cn=OracleSchemaVersion

    Then choose OK.

    If you enter values for these LDAP options, the Oracle Workflow Configuration Assistant automatically implements Oracle Workflow directory service views that support OID integration for you. Additionally, it installs the appropriate WFA_SEC Workflow security package.


    Note:

    After setting up integration with OID during installation, you must use the WF_LDAP APIs to synchronize your Oracle Workflow directory service with OID. For instructions, see Synchronizing Oracle Workflow Directory Services with Oracle Internet Directory, Setting Up Oracle Workflow, Oracle Workflow Administrator's Guide.


  4. If you do not want to integrate with OID, then leave the Enter LDAP Parameters check box blank.

    In this case directory service views that use Oracle Database users and roles as your directory repository will be automatically implemented for you by default, and the appropriate WFA_SEC Workflow security package is installed. You should modify the default views to add e-mail addresses for these users if you want them to be able to receive e-mail notifications.


    Note:

    When the Oracle Workflow Configuration Assistant implements the directory service views using Oracle Database users and roles as your directory repository, it sets each native Oracle Database user's e-mail address to the user's respective username. As a minimal setup step, you should edit the wfdirouv.sql script to either link your native Oracle users to an existing mail directory store through the WF_ROLES view definition, or, if the usernames and e-mail account names match, then simply add the domain for your organization, such as '@oracle.com', to the usernames in the WF_USERS view definition. Typically, the columns that you change are EMAIL_ADDRESS in WF_USERS and EMAIL_ADDRESS in WF_ROLES. The wfdirouv.sql script is located in the Oracle Workflow sql subdirectory within your ORACLE_HOME. For more information, see Setting Up Oracle Workflow, Oracle Workflow Administrator's Guide.


  5. To enter configuration parameters for the seeded Java-based notification mailer service component, called the Workflow Notification Mailer, select the Enter Mailer Parameters check box and choose Get Mailer Values. Enter values for the following parameters:

    • Inbound Mail Server - The name of the inbound IMAP mail server.

    • IMAP User Name - The user name of the mail account that the notification mailer uses to send and receive e-mail messages.

    • HTML Agent Name - The base URL that identifies the Web agent defined for Oracle Workflow in Oracle HTTP Server. Oracle Workflow uses this URL to display its Web pages. The notification mailer also uses this URL to support e-mail notifications with HTML attachments. The HTML agent should be specified in the following format:

      http://<server.com:portID>/pls/wf
      

      where <server.com:portID> represents the server and TCP/IP port number on which your web listener accepts requests, and wf is the default Database Access Descriptor (DAD) created during the Oracle Workflow middle tier installation.

    • Outbound Host Name - The name of the outbound SMTP mail server.

    • Reply To - The address of the e-mail account that receives incoming messages, to which notification responses should be sent.

    Then choose OK.

    After the initial installation, you can update the notification mailer configuration values if necessary in the Oracle Workflow Manager component of Oracle Enterprise Manager. You can also update the HTML agent value for Oracle Workflow in the Global Workflow Preferences Web page. For more information, see the Oracle Workflow Manager online help and Setting Up Oracle Workflow, Oracle Workflow Administrator's Guide.

  6. To change the tablespace assigned to the Oracle Workflow database account, select the Change Tablespace check box. Then select an existing tablespace from the list of values.

  7. Choose Submit to begin the configuration. You can also choose Quit to exit the Workflow Configuration Assistant without performing the configuration.

  8. When the configuration is complete, a confirmation window appears. Choose OK.

  9. You can check the status of the configuration by reviewing the workflow.log file located in the wf/install subdirectory within your Oracle home.

Step 5. Install Oracle Workflow middle tier components using the Oracle Universal Installer.

Run the Oracle Universal Installer from the Oracle Workflow Server CD to install Oracle Workflow middle tier components.

In the Oracle Universal Installer, choose to install into the middle tier Oracle home where Oracle HTTP Server is installed, and select Oracle Workflow Middle Tier as the component to install.

Enter the following configuration information:

To complete the installation, follow the instructions displayed in the Oracle Universal Installer screens. If you need additional information about any screen, click Help. When the installation completes, click Exit and click Yes to exit from the Oracle Universal Installer.

The Oracle Workflow Middle Tier installation performs the following tasks:

Step 6. Configure Oracle Workflow DAD for Oracle Internet Directory and single sign-on integration (conditionally required).

If you chose to use Oracle Database users and roles as your directory service, skip this step and continue with Step 7. Restart Oracle HTTP Server.

If you chose to integrate with Oracle Internet Directory and Oracle Application Server Single Sign-On by entering LDAP parameters in the Workflow Configuration Assistant, perform the following tasks to configure the Oracle Workflow DAD for Oracle Internet Directory and single sign-on integration.

  1. Update the Database Access Descriptor (DAD) for Oracle Workflow in the Oracle HTTP Server dads.conf file, specifying the following parameters. You can either use Oracle Enterprise Manager to update the DAD or edit the dads.conf file directly. The DAD should be named /pls/your_Workflow_DAD. For example: /pls/wf

    • PlsqlDatabaseUsername - Oracle Workflow schema

    • PlsqlDatabasePassword - Oracle Workflow schema password

    • PlsqlDatabaseConnectString - Database connect string

    • PlsqlDefaultPage - wfa_html.home

    • PlsqlSessionStateManagement - StatelessWithResetPackageState

    • PlsqlAuthenticationMode - Basic

  2. Protect the Oracle Workflow DAD by adding the following entry in your mod_osso configuration file. Replace "your_Workflow_DAD" with the name of your DAD.

    <Location /pls/your_Workflow_DAD>
       require valid-user
       authType Basic
    </Location>
    

    For more information, see: Developing Applications Using mod_osso, Oracle Application Server Single Sign-On Application Developer's Guide.

Step 7. Restart Oracle HTTP Server.

After completing the Oracle Workflow Middle Tier installation and DAD configuration, you must restart Oracle HTTP Server to enable access to the Oracle Workflow DAD.

Step 8. Verify Oracle Workflow Web interface virtual directory mappings (optional).


Note:

In some previous releases, it was necessary to add the virtual directory mappings for Oracle Workflow manually. In Release 2.6.3, however, these virtual directory mappings are set by default. You should verify the default mappings and add or edit them only if necessary.


Oracle Workflow requires a virtual directory mapping called /OA_JAVA/ in your Web listener that points to the Oracle Workflow JAR files on your file system. The JAR files are in a directory called <ORACLE_HOME>/jlib, within your middle tier Oracle home. The Oracle Universal Installer automatically installs the Java code in this directory when you install the Oracle Workflow middle tier components.

Oracle Workflow also requires a virtual directory mapping called /OA_MEDIA/ that points to the Oracle Workflow icon area on your file system. The icon area is <ORACLE_HOME>/wf/java/oracle/apps/fnd/wf/icons/, within your middle tier Oracle home. All icon and gif files that are required by Oracle Workflow's Web interface must be stored in the /OA_MEDIA/ virtual directory.

If you installed Oracle Workflow middle tier components in the same Oracle home as Oracle HTTP Server, the /OA_JAVA/ and /OA_MEDIA/ virtual directory mappings are set by default. You should verify these mappings and add them if necessary.

  1. To add the required virtual directory mappings in Oracle HTTP Server, add aliases for the jlib directory and the Oracle Workflow icon area to the <ORACLE_HOME>/wf/admin/wf.conf file. The path to this configuration file must be included in the <ORACLE_HOME>/Apache/Apache/conf/oracle_apache.conf file which helps define the behavior of Oracle HTTP Server. Add the aliases using the following format:

    On UNIX:

    Alias /OA_JAVA/ "<$ORACLE_HOME>/jlib/"
    Alias /OA_MEDIA/ "<$ORACLE_HOME>/wf/java/oracle/apps/fnd/wf/icons/"
    

    For example:

    ...
    #
    # Aliases: Add here as many aliases as you need (with no limit). 
    # The format is
    # Alias fakename realname
    #
    ...
    Alias /OA_JAVA/ "/oracle/jlib/"
    Alias /OA_MEDIA/ "/oracle/wf/java/oracle/apps/fnd/wf/icons/"
    ...
    

    On Windows NT:

    Alias /OA_JAVA/ "<ORACLE_HOME>\jlib/"
    Alias /OA_MEDIA/ "<ORACLE_HOME>\wf\java\oracle\apps\fnd\wf\icons/"
    

    For example:

    ...
    #
    # Aliases: Add here as many aliases as you need (with no limit). 
    # The format is
    # Alias fakename realname
    #
    ...
    Alias /OA_JAVA/ "C:\oracle\jlib/"
    Alias /OA_MEDIA/ "C:\oracle\wf\java\oracle\apps\fnd\wf\icons/"
    ...
    


    Note:

    Be sure to add a trailing slash to each alias name and physical directory path.


  2. Restart Oracle HTTP Server.

Step 9. Set up Oracle Workflow HTML help.

Oracle Workflow provides access to HTML help from the Help button on each of its Web pages. The HTML help that appears is context-sensitive and provides links to the entire contents of the Oracle Workflow documentation.

When you install Oracle Workflow Middle Tier components, the Oracle Universal Installer copies a zip file containing the HTML help to the Workflow directory in your middle tier Oracle home. The zip file is <ORACLE_HOME>/wf/wfdoc.zip. To set up the HTML help, you must extract the doc directory tree from the zip file and verify that you have a virtual directory mapping called /OA_DOC/ in your Web listener that points to the documentation area on your file system.

The /OA_DOC/ virtual directory mapping is set by default when you install Oracle Workflow into the same Oracle home as Oracle HTTP Server. You should verify this mapping and add it if necessary.

  1. Use an unzip utility to extract the doc directory tree from the zip file within the Workflow directory in your middle tier Oracle home. You need at least 7 Mb of free disk space to extract the zip file.

    The doc directory tree that is created includes the Oracle Workflow documentation area, <ORACLE_HOME>/wf/doc, and the following subdirectories:

  2. (Optional) After extracting the doc directory tree, you can optionally remove the zip file.

  3. (Optional) Verify that you have a virtual directory mapping called /OA_DOC/ in your Web listener that points to the new Oracle Workflow documentation area on your file system and add this mapping if necessary.


    Note:

    In some previous releases, it was necessary to add the virtual directory mappings for Oracle Workflow manually. In Release 2.6.3, however, these virtual directory mappings are set by default. You should verify the default mappings and add or edit them only if necessary.


    • In Oracle HTTP Server, verify that you have an alias for the Oracle Workflow documentation area in the <ORACLE_HOME>/wf/admin/wf.conf file. The path to this configuration file must be included in the <ORACLE_HOME>/Apache/Apache/conf/oracle_apache.conf file which helps define the behavior of Oracle HTTP Server. Add the alias if necessary, using the following format:

      On UNIX:

      Alias /OA_DOC/ "<$ORACLE_HOME>/wf/doc/"
      

      For example:

      ...
      #
      # Aliases: Add here as many aliases as you need (with no limit). 
      # The format is
      # Alias fakename realname
      #
      ...
      Alias /OA_DOC/ "/oracle/wf/doc/"
      ...
      

      On Windows NT:

      Alias /OA_DOC/ "<ORACLE_HOME>\wf\doc/"
      

      For example:

      ...
      #
      # Aliases: Add here as many aliases as you need (with no limit). 
      # The format is
      # Alias fakename realname
      #
      ...
      Alias /OA_DOC/ "C:\oracle\wf\doc/"
      ...
      


      Note:

      Be sure to add a trailing slash to each alias name and physical directory path.


    • After adding the alias, restart Oracle HTTP Server.

  4. After the /OA_DOC/ virtual directory mapping is added to your Web listener, you can access the HTML help from the Help button on any Oracle Workflow Web page. You can also access any HTML help file directly by appending its virtual path to your Web listener base URL.

    The path for the contents page of the Oracle Workflow online help is:

    http://<server_name>[:<portID>]/OA_DOC/<lang>/wf/toc.htm
    

    The path for the contents page of your Oracle Workflow custom help is:

    http://<server_name>[:<portID>]/OA_DOC/<lang>/wfcust/wfcust.htm
    

  5. (Optional) If you want to add custom help, you can replace the placeholder file in the wfcust directory, wfcust.htm, with your own help material. The HTM file that is the main entry point for your custom help must be named wfcust.htm and must contain an anchor named contents. Your custom help will be accessible through the Custom Help link on the contents page of the Oracle Workflow help.

Step 10. Migrate existing user information to Oracle Internet Directory (optional).

If you are upgrading a previous installation of Oracle Workflow, and you are integrating with Oracle Internet Directory for the first time, migrate your existing Workflow user information to Oracle Internet Directory.


Note:

For a new installation of Oracle Workflow, you do not need to perform this step unless you want to access Oracle Workflow with the user names and passwords of the Workflow demonstration users. To enable access as the demonstration users when Oracle Workflow is integrated with OID, you must first migrate the seeded user information for these users to OID.


You must perform a one-time migration of existing Oracle Workflow user information to OID to enable single sign-on and single administration. Ensure that you migrate all the necessary data from WF_LOCAL_USERS as well as any other user tables in which you previously stored user information. After performing the migration, you should maintain your user information only through OID.

OID provides a migration tool called ldifmigrator. To use this tool, you must extract your user information from the database into an intermediate LDAP Data Interchange Format (LDIF) file, with substitution variables wherever necessary. The ldifmigrator tool converts the intermediate entries in the file to actual LDIF entries by replacing the variables based on arguments provided at runtime or information retrieved from the LDAP directory. The LDIF file produced by the ldifmigrator can then be uploaded into OID using OID bulk tools.

For more information about the ldifmigrator, the format required for the intermediate LDIF file, and OID bulk upload tools, see Appendix A: Syntax for LDIF and Command-Line Tools, Oracle Internet Directory Administrator's Guide.

Step 11. Access the Oracle Workflow user interface.

To invoke Oracle Workflow's Web pages, append the appropriate procedure and arguments to the base URL for the Workflow Web agent. After the Oracle Workflow installation and configuration are complete, you can verify your base URL by connecting as a valid user to the Oracle Workflow home page:

http://<host:portID>/pls/wf/wfa_html.home


Note:

The Workflow Web agent must be defined before you can access Oracle Workflow's Web pages. If you did not enter the Workflow Web agent in the Workflow Configuration Assistant, you can load this value manually using a script called wftoken.sql. This script is located in the wf/sql subdirectory within your Oracle home. Connect to the Oracle Workflow database account using SQL*Plus and run the script using the following command:

sqlplus <username>/<pwd> @wftoken WF_WEB_AGENT <web_agent_value>

Replace <web_agent_value> with the Workflow web agent name in the following format:

http://<host:portID>/pls/wf

where <host:portID> represents the host server and TCP/IP port number on which your web listener accepts requests and wf is the default Database Access Descriptor (DAD) created during the Oracle Workflow middle tier installation.



Note:

The icons on the Oracle Workflow Web pages may appear as broken images if the virtual directory mapping to the Oracle Workflow icon area has not been added. See Step 8. Verify Oracle Workflow Web interface virtual directory mappings.


When you install Oracle Workflow and its demonstration workflow processes, you also install a demonstration data model that seeds a set of demonstration users in the directory service. The users are: sysadmin, wfadmin, blewis, cdouglas, kwalker, and spierson. Their passwords are the same as their usernames. You can authenticate your connection to an Oracle Workflow Web page with any of these user names and passwords. Public grants and synonyms were created so that these users have full access to Oracle Workflow's Web-based user interface.

Step 12. Access Oracle Workflow Manager.

The Oracle Workflow server installation also includes the Oracle Workflow Manager component of Oracle Enterprise Manager, which provides administrative and management tools for Oracle Workflow. When you install Oracle Workflow into your Oracle Database home, the Workflow Configuration Assistant configures Oracle Workflow Manager. It creates two new Oracle Application Server Containers for Java 2 Enterprise Edition (OC4J) instances:

To access the Oracle Workflow Manager user interface, perform the following steps.

  1. Start the OC4J_Workflow_Component_Container instance using the following command:

    ${ORACLE_HOME}/jdk/bin/java 
    -Djava.security.properties=${ORACLE_HOME}/oc4j/j2ee/home/config/jazn
    .security.props -jar ${ORACLE_HOME}/oc4j/j2ee/home/oc4j.jar 
    -userThreads -config 
    ${ORACLE_HOME}/oc4j/j2ee/OC4J_Workflow_Component_Container/config/se
    rver.xml &
    

  2. Start the OC4J_Workflow_Management_Container instance using the following command:

    ${ORACLE_HOME}/jdk/bin/java 
    -Djava.security.properties=${ORACLE_HOME}/oc4j/j2ee/home/config/jazn
    .security.props -jar ${ORACLE_HOME}/oc4j/j2ee/home/oc4j.jar  -config 
    ${ORACLE_HOME}/oc4j/j2ee/OC4J_Workflow_Management_Container/config/s
    erver.xml &
    

  3. Navigate to the following URL:

    http://<host_name>:<port_number>/WFMGRWebApp/uix/oam/wfm/wfmLogin
    

    where <host_name> represents the host server where OC4J is installed and <port_number> represents the http port specified in the $ORACLE_HOME/oc4j/j2ee/OC4J_Workflow_Management_Container/config/http-web-site.xml configuration file.

    Log in using your Oracle Workflow database username and password and the connect string for the database where Oracle Workflow is installed. Specify the connect string, including the host name, port number, and database system identifier (SID), in the following format:

    <host_name>:<port_number>:<ORACLE_SID> 
    

You can stop and restart the OC4J instances in which Oracle Workflow Manager is deployed if necessary. To stop an OC4J instance, use the following command:

${ORACLE_HOME}/jdk/bin/java -jar ${ORACLE_HOME}/oc4j/j2ee/home/admin.jar 
ormi://<host_name>:<RMI_port> admin welcome -shutdown

where <host_name> and <RMI_port> represent the host server and remote method invocation (RMI) port for the instance that you want to stop, as listed in the rmi.xml configuration file for the instance.

Step 13. Complete additional setup steps.

After you complete the Oracle Workflow installation process, you must perform some additional steps to set up Oracle Workflow for your site. Some of the setup steps are required; other steps are optional, depending on the Oracle Workflow features you want to implement. Refer to the Setting Up Oracle Workflow chapter in the Oracle Workflow Administrator's Guide for information on how to complete these setup steps for Oracle Workflow.

Additionally, for updates to this document, please refer to OracleMetaLink Document 265554.1, Oracle Workflow 2.6.3 Installation Update.

Changing the Oracle Workflow Directory Service Implementation After Installation

During the installation and configuration of Oracle Workflow, you choose the type of directory service to implement. You can either integrate with Oracle Internet Directory (OID) and Oracle Application Server Single Sign-On, or you can use Oracle Database users and roles as your directory repository for Oracle Workflow. If necessary, you can change your directory service implementation after the initial installation and configuration are complete.

For more information, see Setting Up Oracle Workflow, Oracle Workflow Administrator's Guide.

Converting from Oracle Database Users to Oracle Internet Directory

  1. Ensure that the DBMS_LDAP PL/SQL package is loaded in your database. This package contains the functions and procedures that can be used to access data from LDAP servers and is required for LDAP synchronization. To check whether the DBMS_LDAP package is already installed, connect to SQL*Plus and use the following command:

    desc DBMS_LDAP
    

    If the DBMS_LDAP package does not already exist, load it manually by running the catldap.sql script located in the <ORACLE_HOME>/rdbms/admin directory. Run this script as the SYS user. For example, use the following command:

    sqlplus "SYS/<SYS password> as sysdba" 
    @$ORACLE_HOME/rdbms/admin/catldap.sql
    

  2. Run the <ORACLE_HOME>/wf/sql/wfdircsv.sql script to implement Oracle Workflow directory service views that support OID integration. For example, use the following command:

    sqlplus owf_mgr/<passwd> @$ORACLE_HOME/wf/sql/wfdircsv.sql
    

  3. Load the appropriate version of the WFA_SEC package, which contains Oracle Workflow security functions and procedures. To load this package, log on to SQL*Plus as the Oracle Workflow database user and run the <ORACLE_HOME>/wf/sql/wfsecssb.sql script. For example, use the following command:

    sqlplus owf_mgr/<passwd> @$ORACLE_HOME/wf/sql/wfsecssb.sql
    

  4. Update the Database Access Descriptor (DAD) for Oracle Workflow in the Oracle HTTP Server dads.conf file, specifying the following parameters. You can either use Oracle Enterprise Manager to update the DAD or edit the dads.conf file directly. The DAD should be named /pls/your_Workflow_DAD. For example: /pls/wf

    • PlsqlDatabaseUsername - Oracle Workflow schema

    • PlsqlDatabasePassword - Oracle Workflow schema password

    • PlsqlDatabaseConnectString - Database connect string

    • PlsqlDefaultPage - wfa_html.home

    • PlsqlSessionStateManagement - StatelessWithResetPackageState

    • PlsqlAuthenticationMode - Basic

  5. Protect the Oracle Workflow DAD by adding the following entry in your mod_osso configuration file. Replace "your_Workflow_DAD" with the name of your DAD.

    <Location /pls/your_Workflow_DAD>
       require valid-user
       authType Basic
    </Location>
    

    For more information, see: Developing Applications Using mod_osso, Oracle Application Server Single Sign-On Application Developer's Guide.

    After you update the DAD and the mod_osso configuration file, restart Oracle HTTP Server.

  6. Set the following LDAP preferences in the Global Workflow Preferences page. For details, see: To Set Global User Preferences, Oracle Workflow Administrator's Guide.

    • LDAP Host

    • LDAP Port

    • LDAP User Name

    • LDAP Password

    • LDAP Changelog Base Directory

    • LDAP User Base Directory

  7. Migrate your existing Workflow user information to Oracle Internet Directory. You must perform a one-time migration of existing Oracle Workflow user information to OID to enable single sign-on and single administration. Ensure that you migrate all the necessary data from WF_LOCAL_USERS as well as any other user tables in which you previously stored user information. After performing the migration, you should maintain your user information only through OID.

    OID provides a migration tool called ldifmigrator. To use this tool, you must extract your user information from the database into an intermediate LDAP Data Interchange Format (LDIF) file, with substitution variables wherever necessary. The ldifmigrator tool converts the intermediate entries in the file to actual LDIF entries by replacing the variables based on arguments provided at runtime or information retrieved from the LDAP directory. The LDIF file produced by the ldifmigrator can then be uploaded into OID using OID bulk tools.

    For more information about the ldifmigrator, the format required for the intermediate LDIF file, and OID bulk upload tools, see: Appendix A: Syntax for LDIF and Command-Line Tools, Oracle Internet Directory Administrator's Guide.

  8. Use the WF_LDAP APIs to periodically synchronize your Oracle Workflow directory service with OID. For instructions, see: Synchronizing Oracle Workflow Directory Services with Oracle Internet Directory, Setting Up Oracle Workflow, Oracle Workflow Administrator's Guide.

Converting from Oracle Internet Directory to Oracle Database Users

  1. Stop any database jobs you have scheduled to execute the WF_LDAP APIs to synchronize your Oracle Workflow directory service with OID. For more information, see: Synchronizing Oracle Workflow Directory Services with Oracle Internet Directory, Setting Up Oracle Workflow, Oracle Workflow Administrator's Guide.

  2. Update the Database Access Descriptor (DAD) for Oracle Workflow in the Oracle HTTP Server dads.conf file, specifying the following parameters. You can either use Oracle Enterprise Manager to update the DAD or edit the dads.conf file directly. The DAD should be named /pls/your_Workflow_DAD. For example: /pls/wf

    • PlsqlDatabaseConnectString - Database connect string

    • PlsqlDefaultPage - wfa_html.home

    • PlsqlSessionStateManagement - StatelessWithResetPackageState

    • PlsqlAuthenticationMode - Basic

    Ensure that you do not specify a database user name or password, in order to enable mod_plsql database authentication.

  3. Delete the entry for your Workflow DAD from the mod_osso configuration file.

    After you update the DAD and the mod_osso configuration file, restart Oracle HTTP Server.

  4. Run the <ORACLE_HOME>/wf/sql/wfdirouv.sql script to map the Oracle Workflow directory service views to your Oracle Database users and roles. For example, use the following command:

    sqlplus owf_mgr/<passwd> @$ORACLE_HOME/wf/sql/wfdirouv.sql
    

    The wfdirouv.sql script sets each native Oracle Database user's e-mail address to the user's respective username. As a minimal setup step, you should edit the script to either link your native Oracle Database users to an existing mail directory store through the WF_ROLES view definition or, if the usernames and e-mail account names match, then simply add the domain for your organization, such as '@oracle.com', to the usernames in the WF_USERS view definition. Typically, the columns that you change are EMAIL_ADDRESS in WF_USERS and EMAIL_ADDRESS in WF_ROLES. For more information, see: Setting Up Oracle Workflow, Oracle Workflow Administrator's Guide.

  5. Load the appropriate version of the WFA_SEC package, which contains Oracle Workflow security functions and procedures. To load this package, log on to SQL*Plus as the Oracle Workflow database user and run the <ORACLE_HOME>/wf/sql/wfsecwsb.sql script. For example, use the following command:

    sqlplus owf_mgr/<passwd> @$ORACLE_HOME/wf/sql/wfsecwsb.sql
    

  6. Clear the following LDAP preferences in the Global Workflow Preferences page. For details, see: To Set Global User Preferences, Oracle Workflow Administrator's Guide.

    • LDAP Host

    • LDAP Port

    • LDAP User Name

    • LDAP Password

    • LDAP Changelog Base Directory

    • LDAP User Base Directory

Oracle Workflow Client Hardware and Software Requirements

The Oracle Workflow client components consist of the Oracle Workflow Builder and supporting files, including Oracle Workflow Common Files and Oracle Workflow HTML help. Oracle Workflow Builder is a GUI design tool that allows you to create and edit workflow definitions on a PC running either Microsoft Windows NT, Windows 2000, Windows Server 2003, or Windows XP Professional. A workflow definition can be saved to a flat file or to your Workflow Server database if you have Oracle Net installed on your PC. Oracle Workflow Builder requires the following hardware and software configurations:

Oracle Workflow Client Installation

Perform the following steps to install the Oracle Workflow client components on a PC.

Step 1. Install Oracle Workflow client components using the Oracle Universal Installer.

Run the Oracle Universal Installer from the Oracle Database Client CD for Windows to install Oracle Workflow client components. Note that because the Oracle Workflow client components must be installed on a Windows PC, they are only included on the Oracle Database Client CD for Windows. You must install from this CD to obtain the Oracle Workflow client components, even if your Oracle Workflow Server installation is on another platform. For more information about running the Oracle Universal Installer, see the Oracle Database Client Installation Guide for Windows.

In the Oracle Universal Installer, choose to install into an Oracle Database 10g client Oracle home, and select the Administrator installation type. Oracle Workflow Client is one of the components installed by this installation type.


Note:

When you install the Oracle Workflow Builder, the Oracle Workflow Common Files and the Oracle Workflow HTML help are automatically installed as well.



Note:

In some cases you may see the following error message during the installation: "Error encountered when registering <filename>, please run regsvr32.exe manually to register this file after the installation completes". For example, you may see this error for the wfnvg.ocx file.

If you encounter this error, close the error message and proceed with the installation. After the installation is complete, register the specified file manually by running the following command from a DOS prompt:

regsvr32 <path>\<filename>

Replace <path> with the path to the file and <filename> with the name of the file to register. The wfnvg.ocx file is normally located in the <ORACLE_HOME>\bin directory.


Step 2. Set up the Oracle Workflow HTML help (optional).

When you install Oracle Workflow Builder, the Oracle Universal Installer copies a zip file containing the HTML help to the Workflow directory in your Oracle home. The zip file is <ORACLE_HOME>\wf\wfdoc.zip. Before you can view the HTML help, you must extract the doc directory tree from the zip file to your file system.

  1. Use an unzip utility to extract the doc directory tree from the zip file within the Workflow directory. You need at least 7 Mb of free disk space to extract the zip file.

    The doc directory tree that is created includes the Oracle Workflow documentation area, <ORACLE_HOME>\wf\doc, and the following subdirectories:

  2. After extracting the doc directory tree, you can optionally remove the zip file.

  3. You can now view the HTML help using a Web browser.

    The path for the contents page of the Oracle Workflow online help is:

    \<ORACLE_HOME>\wf\doc\<lang>\wf\toc.htm
    

    The path for the contents page of your Oracle Workflow custom help is:

    \<ORACLE_HOME>\wf\doc\<lang>\wfcust\wfcust.htm
    

    You can also view context-sensitive help for the Oracle Workflow Builder in Winhelp format by choosing Contents from the Help menu within the Oracle Workflow Builder.

  4. If you want to add custom help, you can replace the placeholder file in the wfcust directory, wfcust.htm, with your own help material. The HTM file that is the main entry point for your custom help must be named wfcust.htm and must contain an anchor named contents. Your custom help will be accessible through the Custom Help link on the contents page of the Oracle Workflow online help.

Step 3. Modify fonts in the Oracle Workflow Builder (optional).

If you are installing the Oracle Workflow Builder in another language such as Japanese, you can modify the font used by the windows in the Oracle Workflow Builder to a font that is appropriate for your language. Any change you make applies to all windows within the program.

  1. Choose Font from the View menu to display the Fonts properties page.

  2. Select the font you want to use in the labels for your icons and in the navigator tree. The Sample region shows the appearance of the font you select. For example, when using the Oracle Workflow Builder in Japanese, you might choose the font MS PGothic.

  3. Select the font style: Regular, Bold, Italic, or Bold Italic. Some fonts have a limited selection of font styles.

  4. Select the font size to use. Some fonts have a limited selection of font sizes.

  5. Select the Underline or Strikeout check boxes to apply those effects.

  6. Choose OK when you are finished.

  7. Close and restart the Oracle Workflow Builder. The new font settings should then take effect.

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. 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 additional information, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/

Accessibility of Code Examples in Documentation

JAWS, a Windows screen reader, 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, JAWS 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.

Legal Notices

Copyright © 2004, 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 Corporation, 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.

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.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.



Oracle Logo
Copyright © 2004, Oracle. All rights reserved.