Oracle® Application Server Integration InterConnect Adapter for SMTP Installation and User's Guide
10g Release 2 (10.1.2) Part No. B14075-01 |
|
![]() Previous |
![]() Next |
This chapter describes how to install and configure the SMTP adapter. It contains the following topics:
The SMTP adapter must be installed in an existing Oracle home Middle Tier for OracleAS InterConnect 10g Release 2 (10.1.2).
This section contains the following topics:
Consult 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 mounting CD-ROMs, software, hardware, and system requirements for OracleAS 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. |
To install the SMTP adapter:
In the Available Product Components page of the OracleAS Integration InterConnect installation, select SMTP adapter, and click Next.
The Set Oracle Wallet Password screen is displayed. Enter and confirm the password on the screen, which will be used to administer OracleAS Integration InterConnect installation. 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.
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.
Click Next. The Specify SMTP Adapter Name page is displayed.
Enter the application to be defined. Blank spaces are not permitted. The default value is mySMTPApp
.
Click Next. The Specify SMTP Adapter Usage screen is displayed.
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 theadapter.ini file.
|
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
Click Next. The installation screen that appears is based on the selection made in Step 7:
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.
Click Next. The Summary page is displayed.
Select Install to install the SMTP adapter. The adapter is installed in the following directory:
Platform | Directory |
---|---|
Windows | ORACLE_HOME \intergration\interconnect\adapters\ Application
|
UNIX | ORACLE_HOME /integration/interconnect/adapters/ Application
|
Application
is the value specified in Step 5.
Click Exit on the Installation page to exit the SMTP adapter installation.
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:
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:
Set the ota.type
parameter to the payload type D3L
. For example:
ota.type=D3L
Copy the D3L XML files associated with the SMTP application to the directory in which the adapter.ini
file is located.
Set the ota.d3ls
parameter to specify the D3L files associated with the SMTP application. For example:
ota.d3ls=person1.xml,person2.xml
To customize the behavior of the sending endpoints (destinations) for messages, edit the following parameters in the adapter.ini
file.
Set the smtp.sender.content_type
parameter to the message content type to use. For example:
smtp.sender.content_type=plain/text
Set the smtp.sender.character_set
parameter to the message character set to use. For example:
smtp.sender.character_set=iso-2022-jp
To customize the behavior of the receiving IMAP endpoints for messages, edit the following parameters in the adapter.ini
file.
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.
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
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
After an SMTP adapter installation, you can configure it for your needs. 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
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. |
Table 2-4 describes the directories used by the SMTP adapter.
Table 2-4 SMTP Directories
The following are the .ini
files used to configure the SMTP adapter:
The SMTP adapter connects to the hub database using parameters in the hub.ini
file located in the hub
directory. Table 2-5 lists the parameter names, descriptions for each parameter, and examples.
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. The number is between 2 and the number of nodes. 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
|
The agent component of the SMTP adapter reads the adapter.ini
file at runtime to access SMTP adapter parameter configuration information. Table 2-7 lists the parameter names, descriptions for each parameter, and examples..
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: Default Value: 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:
Default Value: |
agent_dvm_table_caching=demand
|
agent_log_level | Specifies the amount of logging necessary.
Possible values:
Default Value: 1. |
agent_log_level=2
|
agent_lookup_table_caching | Specifies the lookup table caching algorithm.
Possible values:
Default Value: |
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 Default Value: |
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 Default Value: |
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 Default Value: |
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 Default Value: |
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 Default Value: |
agent_max_message_metadata_cache_size=200
|
agent_max_queue_size | Specifies the maximum size internal OracleAS Integration InterConnect message queues can grow.
Possible Value: Any integer greater than or equal to Default Value: |
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 (like Default Value: None. |
agent_message_selector=%,aqapp ,%
|
agent_metadata_caching | Specifies the metadata caching algorithm.
Possible values:
Default Value: |
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 Default Value: |
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 Default Value: |
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 Default Value: |
agent_persistence_retry_interval=60000
|
agent_pipeline_from_hub | Specifies whether to turn on 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: Default Value: |
agent_pipeline_from_hub=false
|
agent_pipeline_to_hub | Specifies whether to turn on 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: Default Value: |
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 turn on all throughput measurements.
Default Value: |
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: |
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 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: 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 URL.Default 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 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 Default Value: Note: This parameter specifies date format. It is applicable for the date format only. |
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: |
Date format pattern dd/MMM/yyyy can represent 01/01/2003.
Multiple date formats can be specified as
|
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 Default Value: Note: This parameter specifies date format. It is applicable for the date format only. |
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: 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 Default Value: None. This parameter is for Microsoft Windows only. |
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 Default Value: This parameter is for Microsoft Windows only. |
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 for Microsoft Windows only. |
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: This parameter is for Microsoft Windows only. |
service_max_heap_size=536870912
|
service_max_java_stack_size | Specifies the maximum size that the JVM stack can grow.
Possible Value: A valid JVM maximum stack size. Default Value: Default value for the JVM. This parameter is for Microsoft Windows only. |
service_max_java_stack_size=409600
|
service_max_native_stack_size | Specifies the maximum size 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 for Microsoft Windows only. |
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: This parameter is for Microsoft Windows only. |
service_min_heap_size=536870912
|
service_num_vm_args | Specifies the number of service_vm_arg number parameters specified in JVM.
Possible Value: The number of Default Value: None. This parameter is for Microsoft Windows only. |
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 Default Value: None. This parameter is for Microsoft Windows only. |
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 for Microsoft Windows only. |
service_vm_arg1=java.compiler= NONE
|
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: 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:
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:
Default Value: None. |
ota.send.endpoint=mailto:joe.one@test.com
|
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 Possible Value: A valid ISO country code as mentioned in Default Value: None. |
ota.time_format_couuntry_code=FR
|
ota.time_format_language_code | Specifies the language code.
If Possible Value: A valid ISO language code as mentioned in 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: Default Value: |
ota.type=XML
|
smtp.receiver.customizer_class | Specifies the class name for customization. Used by the SMTP receiver.
Default Value: |
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 Default Value: |
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 "How do I secure my passwords?" 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 Default Value: |
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: |
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: |
smtp.sender.subject_rule=Message_from_%APP%_%EVENT%_%TIME%
|