2 Installation and Configuration

This chapter describes how to install and configure the SMTP adapter. It contains the following topics:

• Installing the SMTP Adapter

• Installing Multiple SMTP Adapters in the Same Oracle Home

• Configuring the SMTP Adapter

• Uninstalling the SMTP Adapter

Installing the SMTP Adapter

The SMTP adapter must be installed in an existing Oracle home Middle Tier for OracleAS Integration InterConnect 10g Release 2 (10.1.2).

This section contains the following topics:

• Preinstallation Tasks

• Installation Tasks

• Postinstallation Tasks

Preinstallation Tasks

Refer to the following guides before installing the SMTP adapter:

• Oracle Application Server Installation Guide for information about Oracle Universal Installer startup.

• Oracle Application Server Integration InterConnect Installation Guide for information on software, hardware, and system requirements for OracleAS Integration InterConnect.

  
  

  Note: OracleAS Integration InterConnect Hub is installable through the OracleAS Integration InterConnect Hub installation type. You must install the OracleAS Integration InterConnect Hub before proceeding with the SMTP adapter installation.

  
  

Installation Tasks

To install the SMTP adapter:

1. In the Available Product Components page of the OracleAS Integration InterConnect installation, select OracleAS Integration InterConnect Adapter for SMTP 10.1.2.0.2, and click Next.

2. The Set Oracle Wallet Password page is displayed. Enter and confirm the password on the page, which will be used to manage OracleAS Integration InterConnect. Click Next.

   • Go to step 3 if installing the SMTP adapter in an OracleAS Middle Tier Oracle home that does not have an InterConnect component already installed. Ensure that the OracleAS Integration InterConnect hub has been installed.

   • Go to step 4 if installing the SMTP adapter in an OracleAS Middle Tier Oracle home that has an existing InterConnect component. Ensure that it is a home directory to an OracleAS Integration InterConnect component.

3. The Specify Hub Database Connection page is displayed. Enter information in the following fields:

   • Host Name: The host name of the computer where the hub database is installed.

   • Port Number: The TNS listener port for the hub database.

   • Database SID: The System Identifier (SID) for the hub database.

   • Password: The password for the hub database user.

4. Click Next. The Specify SMTP Adapter Name page is displayed.

5. Enter the application to be defined. Blank spaces are not permitted. The default value is mySMTPApp.

   
   

   Note: You can change the application name in iStudio after installation. In such case, you need to specify the password corresponding to new application name in the Oracle Wallet. For more informtion, refer to the following sections in Appendix A, "Frequently Asked Questions": AppendixA, "The SMTP adapter is not starting. What could be the reason?" AppendixA, "How do I secure my passwords?"

   
   

6. Click Next. The Specify SMTP Adapter Usage page is displayed.

7. Select one of the options and go to the step specified.

   If You Select...	Then Click Next and Go to Step...
   Configure for both sending and receiving messages	8
   Configure for sending messages ONLY	8
   Configure for receiving messages ONLY	10

   
   
   
   

   Note: You can change the values for these selections later by editing the parameter settings in the adapter.ini file.

   
   

8. Enter the following information in the Configure Sending Endpoint Information page:

   • Email Address: The e-mail address of the outgoing SMTP server to which OracleAS Integration InterConnect sends messages. Enter the e-mail address as follows:

     username@hostname
     
     

   • Outgoing Mail Server: The hostname of the outgoing SMTP server to which OracleAS Integration InterConnect sends messages

9. Click Next. The installation page that is displayed next is based on the selection made in Step 7:

   If You Selected...	Then Go to Step...
   Configure for both sending and receiving messages	10
   Configure for sending messages ONLY	12

   
   

10. Enter the following information in the Configure Receiving Endpoint Information page:

    • Username: The user name account of the IMAP server from which the OracleAS Integration InterConnect receives messages.

    • Password: The password for the user name account.

    • Incoming Mail Server: The hostname of the IMAP server from which OracleAS Integration InterConnect receives messages.This information is required for polling the user name account and sending information back to OracleAS Integration InterConnect.

      
      

      Caution: For testing purposes, do not specify a personal e-mail account as the receiving endpoint. During run time, the SMTP adapter connects to the IMAP server and removes messages in the folder specified by the receiving endpoint. Oracle recommends that you create a dedicated e-mail account for testing and deploying this adapter.

      
      

11. Click Next. The Summary page is displayed.

12. Select Install to install the SMTP adapter. The following table lists the platform and the directory in which the SMTP adapter will be installed.

    Platform	Directory
    Windows	ORACLE_HOME\intergration\interconnect\adapters\Application
    UNIX	ORACLE_HOME/integration/interconnect/adapters/Application

    
    

    Application is the value specified in Step 5.

13. Click Exit on the Installation page to exit the SMTP adapter installation.

Postinstallation Tasks

The installation process creates the adapter.ini file that consists of configuration parameters read by the SMTP adapter at startup. The configuration parameter settings are suitable for most SMTP application environments. To customize the adapter.ini file parameter settings for the SMTP application, refer to the following sections:

• Customizing the Payload Type

• Customizing the Sending Endpoints

• Customizing the Receiving Endpoints

Customizing the Payload Type

Payload data is the data sent between applications. To change the payload type from the default of XML to D3L, edit the parameters in the adapter.ini file.

To customize the payload data type:

1. Set the ota.type parameter to the payload type D3L. For example:

   ota.type=D3L
   
   

2. Copy the D3L XML files associated with the SMTP application to the directory in which the adapter.ini file is located.

3. Set the ota.d3ls parameter to specify the D3L files associated with the SMTP application. For example:

   ota.d3ls=person1.xml,person2.xml
   
   

   
   

   See Also: ota.type and ota.d3ls parameter descriptions in Table 2-9 for additional information

   
   

Customizing the Sending Endpoints

To customize the sending endpoints (destinations) for messages, edit the following parameters in the adapter.ini file.

1. Set the smtp.sender.content_type parameter to the message content type to use. For example:

   smtp.sender.content_type=plain/text
   
   

2. Set the smtp.sender.character_set parameter to the message character set to use. For example:

   smtp.sender.character_set=iso-2022-jp
   
   

   
   

   See Also: Table 2-9, "SMTP Adapter-Specific Parameters"

   
   

Customizing the Receiving Endpoints

To customize the receiving IMAP endpoints for messages, edit the following parameters in the adapter.ini file.

1. Set the smtp.receiver.exception_folder parameter to the folder name that can store files. For example:

   smtp.receiver.exception_folder=error_messages
   
   

   This parameter is not automatically set to a default value during installation. The IMAP administrator must create this folder. Leave this setting blank if you do not want to save these files.

2. Set the smtp.receiver.polling_interval parameter to the time interval in milliseconds to poll the IMAP server for messages. This parameter automatically defaults to a value of 10000 during installation. For example:

   smtp.receiver.polling_interval=20000
   
   

3. Set the smtp.receiver.max_msgs_retrieved parameter to the maximum number of messages to retrieve in a polling session. This parameter automatically defaults to a value of 10 during installation. For example:

   smtp.receiver.max_msgs_retrieved=30
   
   

   
   

   See Also: Table 2-9, "SMTP Adapter-Specific Parameters"

   
   

Installing Multiple SMTP Adapters in the Same Oracle Home

To install multiple instances of the SMTP adapter in same Oracle home, use the copyAdapter script located in the ORACLE_HOME/integration/interconnect/bin directory.

Usage: copyAdapter app1 app2

For example, you have one instance of SMTP adapter with name mySMTPApp installed on a computer. To install another instance of the SMTP adapter with name mySMTPApp1 in the same Oracle home, use the following command:

copyAdapter mySMTPApp mySMTPApp1

The copyAdapter script is copied to the following bin directory only during Hub installation:

• UNIX: ORACLE_HOME/integration/interconnect/bin

• Windows: ORACLE_HOME\integration\interconnect\bin

If you need to use this script to create multiple adapters on a spoke computer, then copy the script to the bin directory on the spoke computer, and edit the script to reflect the new Oracle home.

After running the copyAdapter script, If you want to manage or monitor the newly installed adapter through Oracle Enterprise Manager 10g Application Server Control Console, then you need to modify the opmn.xml file by adding information about the new instance. For example, you have created a new instance of the SMTP adapter mySMTPApp1 by using the copyAdapter script. To manage the mySMTPApp1 adapter through Enterprise Manager, perform the following:

1. Navigate to the MiddleTier\bin directory and run the following command to stop the Enterprise Manager:

   emctl stop iasconsole
   
   

2. Next, specify the information about this new instance in the opmn.xml file located in the ORACLEMIDDLETIER_HOME/opmn/conf directory as follows:

   <process-type id="mySMTPApp1" module-id="adapter" working-dir="$ORACLE_
   HOME/integration/interconnect/adapters/mySMTPApp1" status="enabled">
          <start timeout="600" retry="2"/>
          <stop timeout="120"/>
          <port id="icadapter_dmsport_range" range="15701-15800"/>
          <process-set id="mySMTPApp1" restart-on-death="true" numprocs="1">
               <module-data>
                   <category id="start-parameters">
                       <data id="java-parameters" value="-Xms8M"/>
                       <data id="class-name"
                        value="oracle.oai.agent.service.AgentService"/>
                   </category>
                   <category id="stop-parameters">
                       <data id="java-parameters" value="-mx64m"/>
                       <data id="class-name"
                        value="oracle.oai.agent.proxy.ShutdownAgent"/>
                       <data id="application-parameters"
                        value="persistence/Agent.ior"/>
                   </category>
               </module-data>
          </process-set>
   </process-type>
   
   

   The opmn.xml file would appear like this:

   <process-type id="mySMTPApp" module-id="adapter" working-dir="$ORACLE
   _HOME/integration/interconnect/adapters/mySMTPApp" status="enabled">
          <start timeout="600" retry="2"/>
          <stop timeout="120"/>
          <port id="icadapter_dmsport_range" range="15701-15800"/>
          <process-set id="mySMTPApp" restart-on-death="true" numprocs="1">
               <module-data>
                   <category id="start-parameters">
                       <data id="java-parameters" value="-Xms8M"/>
                       <data id="class-name"
                        value="oracle.oai.agent.service.AgentService"/>
                   </category>
                   <category id="stop-parameters">
                       <data id="java-parameters" value="-mx64m"/>
                       <data id="class-name"
                value="oracle.oai.agent.proxy.ShutdownAgent"/>
                <data id="application-parameters"
                 value="persistence/Agent.ior"/>
            </category>
        </module-data>
     </process-set>
   </process-type>
               
   <process-type id="mySMTPApp1" module-id="adapter" working-dir="$ORACLE
   _HOME/integration/interconnect/adapters/mySMTPApp1" status="enabled">
          <start timeout="600" retry="2"/>
          <stop timeout="120"/>
          <port id="icadapter_dmsport_range" range="15701-15800"/>
          <process-set id="mySMTPApp1" restart-on-death="true" numprocs="1">
           <module-data>
             <category id="start-parameters">
                 <data id="java-parameters" value="-Xms8M"/>
                 <data id="class-name"
                  value="oracle.oai.agent.service.AgentService"/>
             </category>
             <category id="stop-parameters">
                  <data id="java-parameters" value="-mx64m"/>
                  <data id="class-name"
                   value="oracle.oai.agent.proxy.ShutdownAgent"/>
                  <data id="application-parameters"
                   value="persistence/Agent.ior"/>
             </category>
           </module-data>
          </process-set>
   </process-type>
   
   

3. Save the opmn.xml file.

4. Navigate to the MiddleTier\opmn\bin directory and run the following command to reload the OPMN:

   opmnctl reload
   
   

5. You can start the mySMTPApp1 adapter by using the following command

   opmnctl startproc ias-component="InterConnect" process-type="mySMTPApp1"
   
   

6. Navigate to the MiddleTier\bin directory and run the following command to start the Enterprise Manager:

   emctl start iasconsole
   
   

7. Login to the Oracle Enterprise Manager 10g Application Server Control Console to view and manage the newly installed or copied adapter. For information about how to use Oracle Enterprise Manager 10g Application Server Control Console , refer to the Oracle Application Server Integration InterConnect User's Guide

Note: While installing multiple adapters in the same computer, the copyadapter script does not create entries for the new adapter's password in the Oracle Wallet. You need to manually create a password for this new adapter using the Oracle Wallet Manager. To store the password in Oracle Wallet, use the following format: ApplicationName/password The number of entries is dependent on the type of adapter. For example, Database Adapter needs two entries whereas AQ Adapter needs only one entry. For more information about how to manage your passwords in Oracle Wallet, refer to AppendixA, "How do I secure my passwords?"in Appendix A, "Frequently Asked Questions"

Configuring the SMTP Adapter

After installing the SMTP adapter, you can configure it according to your requirements. The following tables describe the location and details of the configuration files.

Table 2-1 describes the location where the adapter is installed.

Table 2-1 SMTP Adapter Directory

Platform	Directory
UNIX	ORACLE_HOME/integration/interconnect/adapters/Application
Windows	ORACLE_HOME\integration\interconnect\adapters\Application

Table 2-2 describes the various executable files of the SMTP adapter.

Table 2-2 SMTP Executable Files

File	Description
start.bat (Windows)	Does not use parameters; starts the adapter.
start (UNIX)	Does not use parameters; starts the adapter.
stop.bat (Windows)	Does not use parameters; stops the adapter.
stop (UNIX)	Does not use parameters; stops the adapter.

See Also: "SMTP Adapter Error Codes" for a list of error codes

Table 2-3 describes the SMTP adapter configuration files.

Table 2-3 SMTP Configuration Files

File	Description
adapter.ini (Windows)	Consists of all initialization parameters the adapter reads at startup.
adapter.ini (UNIX)	Consists of all initialization parameters the adapter reads at startup.

See Also: Appendix B, "Example of the adapter.ini File"

Table 2-4 describes the directories used by the SMTP adapter.

Table 2-4 SMTP Directories

Directory	Description
logs	The adapter activity is logged in subdirectories of the logs directory. Each new run of the adapter creates a subdirectory for the log.xml log file.
persistence	The messages are made available in this directory. Do not edit this directory or its files.

Ini File Settings

The following .ini files are used to configure the SMTP adapter:

• hub.ini Files

• adapter.ini Files

hub.ini Files

The SMTP adapter connects to the hub database using parameters in the hub.ini file located in the hub directory. Table 2-5 gives a description and an example for each parameter.

Table 2-5 hub.ini Parameters

Parameter	Description	Example
hub_host	The name of the computer hosting the hub database. There is no default value. The value is set during installation.	hub_host=mpscottpc
hub_instance	The SID of the hub database. There is no default value. The value is set during installation.	hub_instance=orcl
hub_port	The TNS listener port number for the hub database instance. There is no default value. The value is set during installation.	hub_port=1521
hub_username	The name of the hub database schema (or user name). The default value is ichub.	hub_username=ichub
repository_name	The name of the repository that communicates with the adapter. The default value is InterConnectRepository.	repository_name=InterConnectRepository

Oracle Real Application Clusters hub.ini Parameters

When a hub is installed on an Oracle Real Application Clusters database, the parameters listed in Table 2-6 represent information about additional nodes used for connection and configuration. These parameters are in addition to the default parameters for the primary node. In Table 2-6, x represents the node number which can range from 2 to the total number of nodes in a cluster. For example, if the cluster setup contains 4 nodes, then x can be a value between 2 and 4.

Table 2-6 Oracle Real Application Clusters Hub.ini Parameters

Parameter	Description	Example
hub_hostx	The host where the Real Application Clusters database is installed.	hub_host2=dscott13
hub_instancex	The instance on the respective node.	hub_instance2=orcl2
hub_num_nodes	The number of nodes in a cluster.	hub_num_nodes=4
hub_portx	The port where the TNS listener is listening.	hub_port2=1521

adapter.ini Files

The agent component of the SMTP adapter reads the adapter.ini file at runtime to access SMTP adapter parameter configuration information. Table 2-7 gives a description and an example for each parameter.

Table 2-7 adapter.ini Parameters

Parameter	Description	Example
agent_admin_port	Specifies the port through which the adapter can be accessed through firewalls. Possible value: Any valid port number Default value: None	agent_admin_port=1059
agent_delete_file_cache_at_startup	Specifies whether to delete the cached metadata during startup. If any agent caching method is enabled, then metadata from the repository is cached locally on the file system. Set the parameter to true to delete all cached metadata on startup. Possible values: true or false Default value: false Note: After changing metadata or DVM tables for the adapter in iStudio, you must delete the cache to guarantee access to new metadata or table information.	agent_delete_file_cache_at_startup=false
agent_dvm_table_caching	Specifies the Domain Value Mapping (DVM) table caching algorithm. Possible values: startup: Cache all DVM tables at startup. This may take a while if there are a lot of tables in the repository. demand: Cache tables as they are used none: No caching. This slows down performance Default value: demand	agent_dvm_table_caching=demand
agent_log_level	Specifies the amount of logging necessary. Possible values: 0=errors only 1=status and errors 2=trace, status, and errors Default value: 1	agent_log_level=2
agent_lookup_table_caching	Specifies the lookup table caching algorithm. Possible values: startup: Cache all lookup tables at startup. This may take a while if there are a lot of tables in the repository demand: Cache tables as they are used none: No caching. This slows down performance Default value: demand.	agent_lookup_table_caching=demand
agent_max_ao_cache_size	Specifies the maximum number of application object metadata to cache. Possible value: An integer greater than or equal to 1 Default value: 200	agent_max_ao_cache_size=200
agent_max_co_cache_size	Specifies the maximum number of common object metadata to cache. Possible value: An integer greater than or equal to 1 Default value: 100	agent_max_co_cache_size=100
agent_max_dvm_table_cache_size	Specifies the maximum number of DVM tables to cache. Possible value: An integer greater than or equal to 1 Default value: 200	agent_max_dvm_table_cache_size=200
agent_max_lookup_table_cache_size	Specifies the maximum number of lookup tables to cache. Possible value: An integer greater than or equal to 1 Default value: 200	agent_max_lookup_table_cache_size=200
agent_max_message_metadata_cache_size	Specifies the maximum number of message metadata (publish/subscribe and invoke/implement) to cache. Possible value: An integer greater than or equal to 1 Default value: 200	agent_max_message_metadata_cache_size=200
agent_max_queue_size	Specifies the maximum size to which internal OracleAS Integration InterConnect message queues can grow. Possible value: Any integer greater than or equal to 1 Default value: 1000	agent_max_queue_size=1000
agent_message_selector	Specifies conditions for message selection when the adapter registers its subscription with the hub. Possible value: A valid Oracle Advanced Queue message selector string (such as '%,aqapp,%') Default value: None	agent_message_selector=%,aqapp,%
agent_metadata_caching	Specifies the metadata caching algorithm. Possible values: startup: Cache everything at startup. This may take time if there are a lot of tables in the repository demand: Cache metadata as it is used none: No caching. This slows down performance Default value: demand	agent_metadata_caching=demand
agent_persistence_cleanup_interval	Specifies how often to run the persistence cleaner thread in milliseconds. Possible value: Any integer greater than or equal to 30000 milliseconds Default value: 60000	agent_persistence_cleanup_interval=60000
agent_persistence_queue_size	Specifies the maximum size of internal OracleAS Integration InterConnect persistence queues. Possible value: Any integer greater than or equal to 1 Default value: 1000	agent_persistence_queue_size=1000
agent_persistence_retry_interval	Specifies how often the persistence thread retries when it fails to send an OracleAS Integration InterConnect message. Possible value: Any integer greater than or equal to 5000 milliseconds Default value: 60000	agent_persistence_retry_interval=60000
agent_pipeline_from_hub	Specifies whether to activate the pipeline for messages from the hub to the bridge. If you set the pipeline to false, then the file persistence is not used in that direction. Possible value: true, false Default value: false	agent_pipeline_from_hub=false
agent_pipeline_to_hub	Specifies whether to activate the pipeline for messages from the bridge to the hub. If you set the pipeline to false, then the file persistence is not used in that direction. Possible value: true, false Default value: false	agent_pipeline_to_hub=false
agent_reply_message_selector	Specifies the application instance to which the reply must be sent. This parameter is used only if multiple adapter instances exist for the given application and given partition. Possible value: A string built using the application name (parameter:application) concatenated with the instance number (parameter:instance_number). Default value: None	If application=smtpapp, instance_number=2, then agent_reply_message_selector=receipient_list like '%,smtpapp2,%'
agent_reply_subscriber_name	Specifies the subscriber name used when multiple adapter instances are used for the given application and given partition. This parameter is optional if only one instance is running. Possible value: The application name (parameter:application) concatenated with the instance number (parameter:instance_number) Default value: None	If application=smtpapp and instance_number=2, then agent_reply_subscriber_name=smtpapp2
agent_subscriber_name	Specifies the subscriber name used when this adapter registers its subscription. Possible value: A valid Oracle Advanced Queue subscriber name. Default value: None	agent_subscriber_name=smtpapp
agent_throughput_measurement_enabled	Specifies if the throughput measurement is enabled. Set this parameter to true to activate all throughput measurements. Default value: true	agent_throughput_measurement_enabled=true
agent_tracking_enabled	Specifies if message tracking is enabled. Set this parameter to false to turn off all tracking of messages. Set this parameter to true to track messages with tracking fields set in iStudio. Default value: true.	agent_tracking_enabled=true
agent_use_custom_hub_dtd	Specifies whether to use a custom DTD for the common view message when handing it to the hub. By default, adapters use a specific OracleAS Integration InterConnect DTD for all messages sent to the hub. Set this parameter to true to have the adapter use the DTD imported for the message of the common view instead of the OracleAS Integration InterConnect DTD. Default value: None	agent_use_custom_hub_dtd=false
application	Specifies the name of the application to which this adapter connects. This must match with the name specified in iStudio while creating metadata. Possible value: Any alphanumeric string Default value: None	application=smtpapp
encoding	Specifies the character encoding for published messages. The adapter uses this parameter to generate encoding information for the encoding tag of transformed OracleAS Integration InterConnect messages. OracleAS Integration InterConnect represents messages internally as XML documents. Possible value: A valid character encoding Default value: UTF-8 When there is no existing encoding in the subscribed message, this parameter will be used to explicitly specify the encoding of the published message.This parameter will be ignored when the encoding already exists in the subscribed message.	encoding=Shift_JIS
external_dtd_base_url	Specify the base URL for loading external enitites and DTDs. This specifies to the XML parser to resolve the external entities in the instance document using the given URL.Possible value: A URLDefault value: The URL of the current user directory	external_dtd_base_url=file://C:\InterConnect10_1_2\adapters\AQApp\
instance_number	Specifies the instance number to which this adapter corresponds. Specify a value only if you want to have multiple adapter instances for the given application with the given partition. Possible value: Any integer greater than or equal to 1 Default value: None	instance_number=1
nls_country	Specifies the ISO country code. The codes are defined by ISO-3166. Possible value: A valid code. A full list of the codes is available at http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html Default value: US Note: This parameter specifies date format. It is applicable only for the date format.	nls_country=US
nls_date_format	Specifies the format for date fields expressed as string. Possible value: Any valid date format pattern as shown in Table 2-8 for the definitions of the format characters. Default value: EEE MMM dd HHmmss zzz yyyy	Date format pattern dd/MMM/yyyy can represent 01/01/2003. nls_date_format=dd-MMM-yy Multiple date formats can be specified as num_nls_formats=2 nls_date_format1=dd-MMM-yy nls_date_format2=dd/MMM/yy
nls_language	Specifies the ISO language code. The codes are defined by ISO-639. Possible value: A valid code. A full list of these codes is available at http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt Default value: en Note: This parameter specifies date format. It is applicable only for the date format.	nls_language=en
partition	Specifies the partition this adapter handles as specified in iStudio. Possible value: Any alphanumeric string Default value: None	partition=germany
service_class	Specifies the entry class for the Windows service. Possible value: oracle/oai/agent/service/AgentService Default value: None	service_class=oracle/oai/agent/service/AgentService
service_classpath	Specifies the class path used by the adapter JVM. If a custom adapter is developed and, the adapter is to pick up any additional jar files, then add the jar files to the existing set of jar files. Possible value: A valid PATH setting Default value: None This parameter is only for Microsoft Windows.	service_classpath=D:\oracle\oraic\integration\interconnect\lib\oai.jar; D:\oracle\oraic\jdbc\classes12.zip
service_jdk_dll	Specifies the Dynamic Link Library (DLL) that the adapter JVM should use. Possible value: A valid jvm.dll Default value: jvm.dll This parameter is only for Microsoft Windows.	service_jdk_dll=jvm.dll
service_jdk_version	Specifies the JDK version that the adapter Java VM should use. Possible value: A valid JDK version number Default value: 1.4 This parameter is only for Microsoft Windows.	service_jdk_version=1.4
service_max_heap_size	Specifies the maximum heap size for the adapter JVM. Possible value: A valid JVM heap size Default value: 536870912 This parameter is only for Microsoft Windows.	service_max_heap_size=536870912
service_max_java_stack_size	Specifies the maximum size to which the JVM stack can grow. Possible value: A valid JVM maximum stack size Default value: Default value for the JVM This parameter is only for Microsoft Windows.	service_max_java_stack_size=409600
service_max_native_stack_size	Specifies the maximum size to which the JVM native stack can grow. Possible value: The valid JVM maximum native stack size Default value: Default value for the JVM This parameter is only for Microsoft Windows.	service_max_native_size=131072
service_min_heap_size	Specifies the minimum heap size for the adapter JVM. Possible value: The valid JVM heap size Default value: 536870912 This parameter is only for Microsoft Windows.	service_min_heap_size=536870912
service_num_vm_args	Specifies the number of service_vm_argnumber parameters specified in JVM. Possible value: The number of service_vm_argnumber parameters Default value: None This parameter is only for Microsoft Windows.	service_num_vm_args=1
service_path	Specifies the environment variable PATH. The PATH variable before starting the Java Virtual Machine (JVM). Typically, list all directories that contain necessary DLLs. Possible value: The valid PATH environment variable setting Default value: None This parameter is only for Microsoft Windows.	service_path=%JREHOME%\bin;D:\oracle\oraic\bin
service_vm_argnumber	Specifies any additional arguments to the JVM. For example, to retrieve line numbers in any of the stack traces, set service_vm_arg1=java.compiler=NONE. If a list of arguments exists, then use multiple parameters as shown in the example, by incrementing the last digit by 1. Possible value: A valid JVM arguments. Default value: None. This parameter is only for Microsoft Windows.	service_vm_arg1=java.compiler= NONE service_vm_arg2=oai.adapter=.aq

Table 2-8 shows the reserved characters used to specify the value of the nls_date_format parameter. Use these characters to define date formats.

Table 2-8 Reserved Characters for the nls_date_format Parameter

Letter	Description	Example
G	Era designator	AD
y	Year	1996 or 96
M	Month in year	July or Jul or 07
w	Week in year	27
W	Week in month	2
D	Day in year	189
d	Day in month	10
F	Day of week in month	Number 2
E	Day in week	Tuesday or Tue
a	a.m./p.m. marker	P.M.
H	Hour in day (0-23)	0
k	Hour in day (1-24)	24
K	Hour in a.m./p.m. (0-11)	0
h	Hour in a.m./p.m. (1-12)	12
m	Minute in hour	30
s	Second in minute	55
S	Millisecond	978

SMTP Adapter-Specific Parameters

Table 2-9 lists the parameters specific to the SMTP adapter.

Table 2-9 SMTP Adapter-Specific Parameters

Parameter	Description	Example
bridge_class	Specifies the entry class for the SMTP adapter.A value must be specified and cannot be modified later. Possible value: oracle.oai.agent.adapter.technology.TechBridge. Default value: None	bridge_class=oracle.oai.agent. adapter.technology. TechBridge
ota.d3ls	Specifies the list of data definition description language (D3L) XML files used by the bridge. Each business event handled by the bridge must have its own D3L XML file. When a new D3L XML file is imported in iStudio for use by an application using the SMTP adapter, the parameter must be updated and the SMTP adapter restarted. Default value: None	ota.d3ls=person.xml, person1.xml
ota.receive.endpoint	Specifies the receiving endpoint URL for the SMTP adapter. The URL is written as follows: imap://username@imapHostName Default value: None	ota.receive.endpoint=imap://joe@server10
ota.send.endpoint	Defines the sending endpoint URL for the SMTP adapter. The URL is written as follows: mailto:username@hostname Default value: None	ota.send.endpoint=mailto:[e-mail]
ota.time_format	Specifies the format in which you want to define the timestamp. The format options are identical to java.text.SimpleDateFormat. If you don't want to define the smtp_sender_customizer_class parameter, but still want to define the subject line generation, then use this parameter. Default value: None	ota.time_format=yyyyMMddHHmmss
ota.time_format_couuntry_code	Specifies the country code. If ota.time_format is null, then the other two will be ignored and the timestamp will be in milliseconds. If ota.time_format is not null and if either this parameter or the ota.time_format_language_code parameter is null, then the default value for both the parameters is used, ignoring the values given. Possible value: A valid ISO country code as mentioned in java.util.Locale Default value: None	ota.time_format_couuntry_code=FR
ota.time_format_language_code	Specifies the language code. If ota.time_format is null, then this parameter will be ignored and timestamp will be in milliseconds. If ota.time_format is not null and if either this parameter or ota.time_format_couuntry_code parameter is null, then default value for both the parameters is used, ignoring the values given. Possible value: A valid ISO language code as mentioned in java.util.Locale. Default value: None.	ota.time_format_language_code=fr
ota.type	Specifies the type of payload this adapter handles. Each business event handled by the bridge must have its own D3L XML file. Whenever a new D3L XML file is imported in iStudio for use by an application using the SMTP adapter, the parameter must be updated and the SMTP adapter restarted Possible value: XML or D3L. Default value: XML.	ota.type=XML
smtp.receiver.customizer_class	Specifies the class name for customization. Used by the SMTP receiver. Default value: oracle.oai.aget.adapter.technology.DefaultReceiverCustomizer	smtp.receiver.customizer_class=MySMTPSenderCustomizer
smtp.receiver.exception_folder	Specifies a mail folder in which to put e-mails that cannot be processed successfully. This mail folder must be created by the IMAP server administrator. Possible value: A valid mail folder name Default value: None	smtp.receiver.exception_folder=error
smtp.receiver.max_msgs_retrieved	Specifies the maximum number of messages to be retrieved in each polling session. Possible value: An integer greater than 0 Default value: 30	smtp.receiver.max_msgs_retrieved=10
smtp.receiver.password	Specifies the user password for the IMAP server. This password can also be encrypted by running the encrypt tool and renaming this parameter to encrypted_smtp.receiver.password. Possible value: A valid password string. Default value: None. Note: All passwords are stored in Oracle Wallet. Refer to AppendixA, "How do I secure my passwords?" in Appendix A, "Frequently Asked Questions" for more details on how to modify and retrieve the password using Oracle Wallet.	smtp.receiver.password= smtpuser
smtp.receiver.polling_interval	Specifies the time interval during which to poll the IMAP server (in milliseconds). Possible value: An integer greater than 0 Default value: 60000 (60 seconds)	smtp.receiver.polling_interval=10000
smtp.receiver.protocol	Specifies the e-mail protocol to use. For this release, the only possible value is imap. Default value: None	smtp.receiver.protocol= imap
smtp.sender.character_set	Specifies the character encoding for the message. Default value: None	smtp.sender.character_set=iso-2022-jp
smtp.sender.content_type	Specifies the content type of e-mail messages (RFC 822 header field). Default value: None	smtp.sender.content_type=plain/text
smtp.sender.customizer_class	Specifies the class name for customization. Used by the SMTP sender. Default value: oracle.oai.agent.adapter.technology.SMTPDefaultSenderCustomizer	smtp.sender.customizer_class=MySMTPSenderCustomizer
smtp.sender.smtp_host	Specifies the SMTP host to use in sending messages. Default value: None.	smtp.sender.smtp_host=smtp1.foo.com
smtp.sender.subject_rule	Specifies the rule for generating subject. Used by the SMTP sender. Default value: %APP%%PART%_%TIME%	smtp.sender.subject_rule=Message_from_%APP%_%EVENT%_%TIME%

Uninstalling the SMTP Adapter

To uninstall the SMTP adapter, perform the following:

1. Navigate to the MiddleTier\opmn\bin directory.

2. Run the following command to check the adapter status.

   opmnctl status
   
   

3. If the SMTP adapter instance that you want to remove is running, stop it by using the the following command:

   opmnctl stopproc ias-component="InterConnect" process-type="SMTPApp"
   
   

   where SMTPApp is the name of the SMTP adapter instance.

4. Navigate to the MiddleTier\bin directory and run the following command to stop the Enterprise Manager:

   emctl stop iasconsole
   
   

5. Carefully, remove the adapter process-type entry from the opmn.xml file located in the MiddleTier\opmn\conf directory. For example, to remove an SMTP adapter instance mySMTPApp1, delete the following information specific to the adapter instance:

   <process-type id="SMTPApp1" module-id="adapter" working-dir="$ORACLE_HOME/integration/interconnect/adapters/SMTPApp1" status="enabled">
          <start timeout="600" retry="2"/>
          <stop timeout="120"/>
          <port id="icadapter_dmsport_range" range="15701-15800"/>
          <process-set id="mySMTPApp1" restart-on-death="true" numprocs="1">
               <module-data>
                   <category id="start-parameters">
                       <data id="java-parameters" value="-Xms8M"/>
                       <data id="class-name"
                        value="oracle.oai.agent.service.AgentService"/>
                   </category>
                   <category id="stop-parameters">
                       <data id="java-parameters" value="-mx64m"/>
                       <data id="class-name"
                        value="oracle.oai.agent.proxy.ShutdownAgent"/>
                       <data id="application-parameters"
                        value="persistence/Agent.ior"/>
                   </category>
               </module-data>
          </process-set>
   </process-type>
   
   

6. Save the opmn.xml file.

7. Navigate to the MiddleTier\opmn\bin directory and run the following command to reload the OPMN:

   opmnctl reload
   
   

8. Navigate to the ORACLE_HOME\integration\interconnect\adapters directory and delete the folder that was created for the removed adapter instance.

9. Navigate to the MiddleTier\bin directory and run the following command to start the Enterprise Manager:

   emctl start iasconsole