Skip Headers

Oracle Email Administrator's Guide
Release 9.0.3

Part Number B10033-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Feedback

Go to previous page
Previous
Go to next page
Next
View PDF

2
Getting Started

This chapter discusses the administration tools and explains how to configure, start up, shut down, and reinitialize the Oracle Email system.

This chapter contains the following topics:

Pre-Configuration Checklist

This section describes pre-configuration procedures that must be done prior to confuguring Oracle Email.

This section contains the following topics:

Verifying the Java and OracleText Options on the Mail Store Database

To verify that the Java and Oracle Text Options were installed and configured on the mail store database, run the following sql query as sysdba:

SQL> select comp_id, version, status from dba_registry;

Verifying and Starting the Oracle9iAS Infrastructure and Application Servers

Verify that the infrastructure and application servers are running:

ps -ef | grep http

To start the infrastructure and application servers:

% opmnctl startall

Registering the Database with Oracle Internet Directory

An Oracle9i database is required to install the mail store. Before a database can be configured as a mail store, it must be registered with the Oracle Internet Directory infrastructure. If the database is not already registered with the Oracle Internet Directory, it can be registered using the Oracle database configuration assistant . Once the database is registered with Oracle Internet Directory, at a later point any changes to the connect identifier can be made using Oracle Net Manager.

To register the mail store database with the Oracle Internet Directory infrastructure, the following procedures must be performed using the Oracle Net Configuration Assistant (NETCA) and the Database Configuration Assistant (DBCA):

Running Oracle Net Configuration Assistant (NETCA)

Perform the following steps to run Oracle Net Configuration Assistant (NETCA):

  1. Start Oracle Net Configuration Assistant (NETCA):
    $ORACLE_HOME/bin/netca
    
    
  2. Select Directory Service Usage Configuration
  3. Click Next.
  4. Select Select the directory server you want to use. The directory server must already be configured for Oracle usage.
  5. Click Next.
  6. Select Oracle Internet Directory as the directory server you want to
  7. use and choose Next.
  8. Enter connect information about the Oracle Internet Directory infrastructure.
  9. Click Next.
  10. Select the root OracleContext (cn=OracleContext) as the default
  11. Oracle Context in the directory and finish the netca configuration.

Running Oracle Database Configuration Assistant (DBCA)

Perform the following steps to run the Oracle Database Configuration Assistant (DBCA):

  1. Start Oracle Database Configuration Assistant (DBCA) to register the mail store database with Oracle Internet Directory infrastructure.
    $ORACLE_HOME/bin/dbca
    
    
  2. Select Configure database.
  3. Click Next.
  4. Select the mail store database instances.
  5. Click Next.
  6. In the Directory Services screen, Select the Yes, register the database.
  7. Enter a user DN and password to connect to the Oracle Internet Directory infrastructure. For example, acmeadmin.
  8. Complete the Oracle Database Configuration Assistant (DBCA) configuration.

Setting the Database init.ora Parameters on the Mail Store Database

Set the database init.ora parameters on the mail store database to the following values:

processes=150 or higher
open_cursors=300 or higher
dml_locks=200 or higher
shared_pool_size=32000000 or higher
java_pool_size=40000000 or higher

Creating Mail Store Tablespaces and Schema

The Oracle Email configuration wizard creates tablespaces and schema for mail store. If you want to customize tablespace storage parameters or data files, you can create them before running configuration wizard.

For the name of mail store tablespaces and their default storage parameters refer to the $ORACLE_HOME/oes/install/sql/tblspc.sql script.

There is a table space named ESTERSTORE that is reserved for tertiary storage of old messages. To enable tertiary storage, pre-create tablespace ESTERSTORE on a different disk prior to installation. After which, create an instance of the housekeeping server with the TertiaryStore parameter enabled, and parameter Tertiary Store Age Threshold to the desired age value in terms of number of days (the default is 30). The housekeeping server instance automatically moves messages periodically.

Note::

If you pre-create tablespaces, the Oracle Email configuration wizard log shows some errors indicating tablespace creation failed. These errors can be ignored.


See Also:

Chapter 4, "Servers and Processes", for more information on tertiary storage and how to configure server proceses

Configuring Oracle Email

This section describes how to configure the Oracle Email mail store, and middle tier servers.

This section contains the following topics:

Configuring the Oracle Email Mail Store

Configuring the mail store database does the following:

To configure the Oracle Email mail store, perform the following steps on the middle tier server:

  1. Run the umconfig.sh script located on the application server:
    • For UNIX, enter the following command:
      $ORACLE_HOME/oes/bin/umconfig.sh
      
      
    • For Windows, enter the following command:
      %ORACLE_HOME%\oes\bin\umconfig.bat
      
      
      

    The Unified Messaging Configuration screen appears.

  2. Select Mail Store Database Configuration.
  3. Click Next. The Mail Store Database Configuration screen is displayed.
  4. Enter the following information in the corresponding fields:
    Table 2-1
    Field Description

    Database Hostname

    The name of the machine on which the database is located

    SID

    The system identifier of the mail store

    Port Number

    The port number on which the listener is listening

    System Password

    The system password for the host database

    CTXSYS Password

    The password for the OracleText account


    Note: :

    To use OracleText with the Oracle9i database, the ctxsys account must be unlocked. Installation of OracleText requires the ctxsys account to be present.


  5. Click Next. The ES_Mail password screen is displayed.

  6. Enter the ES_MAIL password and confirm it. If an ES_MAIL password is not entered, the default is es.


    Note: :

    The mail store schema is owned by the ES_MAIL database user.


  7. Click Next. The UMADMIN password screen is displayed.


    Note: :

    UMADMIN is an administrator account created in the Oracle Internet Directory server during the application server installation of Oracle Email. It account owns specific Oracle Email entries in the directory. After installation, administrators should log in to the administration tool using the UMADMIN account and create an initial Oracle Email user. Thereafter, they can delegate system and domain administration responsibilities to other users.


  8. Enter the UMADMIN password and confirm it. If a password is not entered, the default value welcome is stored in Oracle Internet Directory and the database as the UMADMIN password.
  9. Click Next. The Create Unified Messaging Domain screen is displayed.
  10. Enter the domain name. This domain name is used for users' e-mail addresses.
  11. Click Next. The Configuration Tools screen is displayed and the mail store configuration begins.

    Once the mail store configuration is complete, the End of Installation screen is displayed.

    Log files for umconfig.sh are located in the following directory:

    • Unix:
      $ORACLE_HOME/oes/log/
      
      
      
      
    • Windows:

      %ORACLE_HOME\oes\log\


      Note:

      When adding subsequent mail stores through the umconfig.sh script, the following error is reported in $ORACLE_HOME/oes/log/createmailstore.log file:

      javax.naming.NameNotFoundException: [LDAP: error code 32 - No Such Object]; remaining name

      This error message can be ignored.


    Manually Configuring the Oracle Email Mail Store


    Note:

    The manual steps described below are an alternative to running the mailstore.sh script through the user interface.


    Enter the following command to manually run the Oracle Email mail store configuration scripts with parameters:

    • On Unix:
      cd $ORACLE_HOME/oes/bin
      install_mailstore.sh <connect_str> true <system_passwd>
      <ctxsys_passwd> <SID> <host_name> <port_number> UM_SYSTEM <ORACLE_HOME>
      <es_mail_passwd> <umadmin_passwd> <oid_flag> <domain_name>
      
      
    • On Windows:
      cd %ORACLE_HOME%\oes\bin
      install_mailstore.sh <connect_str> true <system_passwd>
      <ctxsys_passwd> <SID> <host_name> <port_number> UM_SYSTEM <ORACLE_HOME>
      <es_mail_passwd> <umadmin_passwd> <oid_flag> <domain_name>
      
      

    Where:

    Table 2-2
    Parameter Description

    connect_str

    The mail store database connect string.

    System Password

    The system password for the host database

    CTXSYS Password

    The password for the OracleText account

    SID

    The mail store database SID.

    host_name

    The mail store database host name.

    port_number

    The mail store database port number (default 1521).

    es_mail_passwd

    The password for the ES_MAIL database user. If an ES_MAIL password is not entered, the default is es.

    umadmin_passwd

    UMADMIN is an administrator account created in the Oracle Internet Directory server during the application server installation of Oracle Email. It account owns specific Oracle Email entries in the directory. After installation, administrators should log in to the administration tool using the UMADMIN account and create an initial Oracle Email user. Thereafter, they can delegate system and domain administration responsibilities to other users.

    If a password is not entered, the default value welcome is stored in Oracle Internet Directory and the database as the UMADMIN password.

    oid_flag

    f Oracle Email entries have been created in Oracle Internet Directory, the value is 1. Otherwise, it is 0.

    To determine if the Oracle Internet Directory infrastructure is configured for Oracle Email, run the following commands from the middle tier ORACLE_HOME.

    rm $ORACLE_HOME/oes/log/exists.txt
    java -classpath
    $ORACLE_HOME/jlib/esinstall.jar:$ORACLE_
    HOME/jlib/repository.jar:$ORACLE_
    HOME/jlib/esldap.jar:$ORACLE_
    HOME/jlib/jndi.jar:$ORACLE_
    HOME/jlib/ldap.jar:$ORACLE_
    HOME/jlib/providerutil.jar 
    oracle.mail.install.ESDSInstallQuery $ORACLE_HOME 
    um_system.
    

    After running this query, check if the $ORACLE_HOME/oes/log/exists.txt file exists. If it exists, the value of oid_flag should be 1, otherwise, the value is 0.

    • On Windows:
      del %ORACLE_HOME%\oes\log\exists.txt
      java -classpath
      %ORACLE_HOME%\jlib\esinstall.jar;%ORACLE_
      HOME%\jlib\repository.jar;%ORACLE_
      HOME%\jlib\esldap.jar;%ORACLE_
      HOME%\jlib\jndi.jar;%ORACLE_
      HOME%\jlib\ldap.jar;%ORACLE_
      HOME%\jlib\providerutil.jar
      oracle.mail.install.ESDSInstallQuery %ORACLE_HOME% 
      um_system.
      

    After running this query, check if the %ORACLE_HOME%\oes\log\exists.txt file exists. If the file exists, the oid_flag value should be 1, otherwise, it is 0

    domain_name

    The local domain name. For example, acme.com.


    Note::

    The default INSTALLATION_NAME is UM_SYSTEM.


    Installing the umbackend.tar File


    Note:

    If the mail store database was not installed from Oracle Collaboration Suite, the umbackend.tar file must be downloaded from the Oracle Technology Network website.


    Perform the following steps to install the umbackend.tar file:

    1. Copy the umbackend.tar file from $ORACLE_HOME/oes directory on the application server to the $ORACLE_HOME on the mail store database. If the mail store is located on another system, the umbackend.tar file for the database platform must be transferred from the application server to the mail store database as the database owner.
    2. Untar the umbackend.tar file:
      tar xvf umbackend.tar
      
      
    3. Run the following commands to run the installer:
      cd backend/Disk1
      ./runInstaller
      
      
    4. Follow the screen prompts to complete the Oracle Email backend installation.

    Installing the install_infra.sql File

    Administrators must run <mailstore_database_oracle_home/
    oes/install/sql/install_infra.sql
    on the mailstore database machine after installing the umbackend.tar file.

    Configuring the Oracle Email Middle Tier

    Configuring the middle tier does the following:

    • Configures middle tier with Oracle Internet Directory
    • Configures middle tier with mailstore
    • Creates Oracle Email server instances

    To configure the Oracle Email middle tier servers, perform the following steps:

    1. Run the umconfig.sh script located on the application server:
      • For UNIX, enter the following command:
        $ORACLE_HOME/oes/bin/umconfig.sh
        
        
      • For Windows, enter the following command:
        %ORACLE_HOME%\oes\bin\umconfig.bat
        
        

      The Unified Messaging Configuration screen is displayed.

    2. Select Middle Tier Configuration.
    3. Click Next. The Middle Tier Configuration screen is displayed.

    4. Enter the mail store global database name. This is the name of the middle tier mail store database.


      Note:

      If the UMADMIN password and the domain name were specified during the mail store configuration, the next screen that displays is the Configuration Tool screen. Otherwise, you must specify the UMADMIN password and the domain name.


    5. Click Next. The UMADMIN password screen is displayed.


      Note: :

      UMADMIN is an administrator account created in the Oracle Internet Directory server during the application server installation of Oracle Email. It account owns specific Oracle Email entries in the directory. After installation, administrators should log in to the administration tool using the UMADMIN account and create an initial Oracle Email user. Thereafter, they can delegate system and domain administration responsibilities to other users.


    6. Enter the UMADMIN password and confirm it. If a password is not entered, the default value welcome is stored in Oracle Internet Directory and the database as the UMADMIN password.
    7. Click Next. The Create Unified Messaging Domain screen is displayed
    8. Enter the the domain name to be created. This domain is used for users' e-mail addresses.
    9. Click Next. The Configuration Tools screen is displayed and the middle tier configuration begins.

    Once the middle tier configuration is complete, the End of Installation screen is displayed.

    Log files for umconfig.sh and umconfig.bat are located in the following directories:

    • Unix:
      $ORACLE_HOME/oes/log/
      
    • Windows:
      %ORACLE_HOME%\oes\log\ 
      

    Manually Configuring the Oracle Email Middle Tier


    Note:

    The manual steps described below are an alternative to running the middletier.sh script through the user interface.


    Use the following command to run the Oracle Email Middle Tier configuration scripts with parameters:

    • On Unix:
      cd $ORACLE_HOME/oes/bin
      install_middletier.sh true true UM_SYSTEM <ORACLE_HOME>
      <umadmin_passwd> <oid_flag> <global_db_name> <domain_name>
      
      
    • On Windows:
      cd $ORACLE_HOME/oes/bin
      install_middletier.sh true true UM_SYSTEM <ORACLE_HOME>
      <umadmin_passwd> <oid_flag> <global_db_name> <domain_name>
      
      

    Where:

    Table 2-3
    Parameter Description

    umadmin_passwd

    UMADMIN is an administrator account created in the Oracle Internet Directory server during the application server installation of Oracle Email. It account owns specific Oracle Email entries in the directory. After installation, administrators should log in to the administration tool using the UMADMIN account and create an initial Oracle Email user. Thereafter, they can delegate system and domain administration responsibilities to other users.

    If a password is not entered, the default value welcome is stored in Oracle Internet Directory and the database as the UMADMIN password.

    oid_flag

    f Oracle Email entries have been created in Oracle Internet Directory, the value is 1. Otherwise, it is 0.

    To determine if the Oracle Internet Directory infrastructure is configured for Oracle Email, run the following commands from the middle tier ORACLE_HOME.

    rm $ORACLE_HOME/oes/log/exists.txt
    java -classpath
    $ORACLE_HOME/jlib/esinstall.jar:$ORACLE_
    HOME/jlib/repository.jar:$ORACLE_
    HOME/jlib/esldap.jar:$ORACLE_
    HOME/jlib/jndi.jar:$ORACLE_
    HOME/jlib/ldap.jar:$ORACLE_
    HOME/jlib/providerutil.jar 
    oracle.mail.install.ESDSInstallQuery $ORACLE_HOME 
    um_system.
    

    After running this query, check if the $ORACLE_HOME/oes/log/exists.txt file exists. If it exists, the value of oid_flag should be 1, otherwise, the value is 0.

    • On Windows:
      del %ORACLE_HOME%\oes\log\exists.txt
      java -classpath
      %ORACLE_HOME%\jlib\esinstall.jar;%ORACLE_
      HOME%\jlib\repository.jar;%ORACLE_
      HOME%\jlib\esldap.jar;%ORACLE_
      HOME%\jlib\jndi.jar;%ORACLE_
      HOME%\jlib\ldap.jar;%ORACLE_
      HOME%\jlib\providerutil.jar
      oracle.mail.install.ESDSInstallQuery %ORACLE_HOME% 
      um_system.
      

    After running this query, check if the %ORACLE_HOME%\oes\log\exists.txt file exists. If the file exists, the oid_flag value should be 1, otherwise, it is 0

    global_db_name

    The database global name. For example, acmedb.foo.acme.com

    domain_name

    The local domain name. For example, acme.com.

    Using the Administration Tools

    This section describes the different administration tools used to administer the Oracle Email system.

    This section contains the following topics:

    Oracle Enterprise Manager

    See Also::

    Oracle9i Application Server Administrator's Guide for more information about Oracle Enterprise Manager

    Oracle Enterprise Manager is a Web-based tool that enables administrators to perform some of the management tasks for the Oracle9i database and Oracle9i Application Server. The Oracle Enterprise Manager can be used to administer Oracle Email service processes. Through Oracle Enterprise Manager, administrators can perform the following tasks on Oracle Email system:

    • Startup
    • Shutdown
    • Reinitialize
    • Modify default parameters

    To perform administration tasks for Oracle Email through Oracle Enterprise Manager, administrators must navigate to the following URL:

    http://<machine name>:1810
    

    Thin Client

    See Also::

    Chapter 3, "Administration and Provisioning" for more information on domain and user provisioning

    Using the Oracle Email Thin Client, administrators can perform domain and user provisioning tasks. Through the Oracle Email Thin Client, administrators can do the following:

    • Create and modify domain settings for users and distribution lists
    • Create, delete, modify, and view e-mail, fax users, voice mail users, and distribution lists
    • Add and delete members to and from distribution lists
    • View all the distribution lists a specific user is on
    • Create, delete, modify, and view server-side filters
    • Create, delete, and modify lists

    To perform administration tasks for Oracle Email through the Thin Client, administrators must navigate to the following URL:

    http://<machine name>:<port>/um/traffic_cop
    

    Starting Up, Shutting Down, and Reinitializing Oracle Email

    This section explains how to start, stop, and reinitialize the Oracle Email system.

    This section contains the following topics:

    Verifying and Starting the Listener for the Mail Store

    The Oracle Net Listener must be running on the mail store database so that the system can establish database connections from the Oracle Email system and clients.

    To verify that the listener is running, enter the following:

    • On Unix:
      % lsnrctl status listener_es
      
      
      
    • On Windows:

      From command prompt, enter the following command:

      lsnrctl status listener_es
      
      

    If the computer returns a message that contains the line no listener, then the listener must be started.

    To start the listener, enter the following:

    • On Unix:
      % lsnrctl start listener_es
      
      
      
    • On Windows:

      From command prompt, enter the following command:

      lsnrctl start listener_es
      
      

      From the Services Console:

      1. Select Start->Settings->Control Panel->Services.
      2. Select listener_es.
      3. Click Start.

    Verifying and Starting the Listener for the Middle Tier

    To verify that the listener is running, enter the following:

    • On Unix:
      % lsnrctl status listener_es
      
      
      
    • On Windows:

      From command prompt, enter the following command:

      lsnrctl status listener_es
      
      
      

    If the computer returns a message that contains the line no listener, then the listener needs to be started.

    To start the listener, perform the following steps:

    • On Windows:

      From command prompt, enter the following command:

      lsnrctl start listener_es
      
      
    • On Unix:
      1. Configure the listener with protocol addresses and other configuration parameters, using Oracle Net Configuration Assistant or Oracle Net Manager.

        See Also: :

        Chapter 12, "Configuring and Administering the Listener," of the Oracle9i Net Services Administrator's Guide

      2. Log in as superuser (root) and set file ownership and access permissions for the listener executable (tnslsnr) and its dependent shared libraries so that these files can be modified only by the superuser. The tnslsnr is located in the $ORACLE_HOME/bin directory.
      3. Verify that the permissions of the individual directories found in the path names to these files, starting with the root directory, are modified in the same way.
      4. Start the listener as root.
      5. At the operating system prompt, enter tnslsnr with optional command line arguments.
        tnslsnr [listener_name] [-user user] [-group group]
        
        
        

        where:

        Table 2-4
        Name Description

        listener_name

        Specifies the name of the listener, as listener_es. If omitted, the default name LISTENER is used.

        -user user

        Specifies the user whose privileges the listener uses when superuser (root) privileges are not needed. After performing the privileged operations, the listener gives up root privileges irreversibly.

        listener_name

        Specifies the name of the listener, as listener_es. If omitted, the default name LISTENER is used.

    Starting the Oracle Email System

    Starting an Oracle Email service starts all the processes comprising that service type, such as IMAP4 and SMTP.

    Using Oracle Enterprise Manager, perform the following procedure to start an Oracle Email system:

    1. Navigate to the Oracle9i Application Server home page
    2. Select Oracle Email.
    3. Click Start.

    Stopping the Oracle Email System

    Stopping an Oracle Email system sends a request to the operating system to shut down all of the Oracle Email processes. One reason an administrator would want to stop the Oracle Email system is to perform maintenance on the system, such as upgrading the server hardware or software. It is not possible for the processes to be running while certain kinds of upgrades are performed.

    Using Oracle Enterprise Manager, perform the following procedure to stop an Oracle Email system:

    1. Navigate to the Oracle9i Application Server home page.
    2. Select Oracle Email.
    3. Click Stop.

    Reinitializing the Oracle Email System

    Reinitializing an Oracle Email process informs the operating system to reload its operational settings from the Oracle Internet Directory server. The process does not stop running, which means that users continue to receive uninterrupted service. Whenever a Oracle Email process parameter is modified, it must be reinitialized to make the changes take effect.

    Using Oracle Enterprise Manager, perform the following procedure to reinitialize an Oracle Email process:

    1. Navigate to the Oracle9i Application Server home page
    2. Select Oracle Email.
    3. Click Reinitialize.

    Creating a Public User

    After configuring Oracle Email, administrators must create a public user account through delegated administration service (DAS). This public user corresponds with the initial user that will be created through the Thin Client administration tool.

    See Also:

    Oracle Internet Directory Administrator's Guide for more information on using DAS

    Once the public user has been created, administrators can navigate to http://<machine name>:<port number>/um/admin/UMAdminLogin.uix, to create the initial domain and user.

    See Also:

    Chapter 3, "Administration and Provisioning" for more information on creating the initial domain and user.