Oracle Application Server InterConnect Adapter for SMTP Installation and User's Guide 10g (9.0.4) Part Number B10414-01 |
|
This chapter describes Simple Mail Transfer Protocol (SMTP) adapter installation and configuration.
This chapter contains these topics:
This section contains these topics:
The SMTP adapter must be installed in one of the following Oracle homes:
Consult the following guides before proceeding with SMTP adapter installation:
To install the SMTP adapter:
Consider the following scenarios:
The hub database information, such as the SID, host, port, and username/password from the Hub installation, is needed for step 2.
Note:
mySMTPApp
.
adapter.ini
file.
If You Select... | Then Click Next and Go to Step... |
---|---|
Configure for both sending and receiving messages |
|
Configure for sending messages ONLY |
|
Configure for receiving messages ONLY |
username@hostname
The installation screen that appears next is based on the selection you made in Step 5:
If You Selected... | Then Go to Step... |
---|---|
Configure for both sending and receiving messages |
|
Configure for sending messages ONLY |
When finished, the Summary screen appears.
Platform | Directory |
---|---|
Windows |
|
UNIX |
|
You have defined the value of Application
in Step 3.
SMTP adapter installation creates an adapter.ini
file that consists of configuration parameters read by the SMTP adapter at startup. These configuration parameter settings are appropriate for most SMTP application environments. You can customize some adapter.ini
file parameter settings for the SMTP application after installation. See the following sections:
Payload data is the data sent between applications. If you want to change the payload datatype from the default of XML to the data definition description language (D3L), edit the following parameters in the adapter.ini
file.
To customize the payload datatype:
ota.type
parameter to the payload type D3L
. For example:
ota.type
=D3L
adapter.ini
file is located.
ota.d3ls
parameter to specify the D3L files associated with the SMTP application. For example:
ota.d3ls=person1.xml,person2.xml
If you want to customize the behavior of the sending endpoints (destinations) for messages, edit the following parameters in the adapter.ini
file. These parameters are not automatically set to default values during installation.
To customize the sending endpoint:
smtp.sender.content_type
parameter to the message content type to use. For example:
smtp.sender.content_type
=plain/text
smtp.sender.character_set
parameter to the message character set to use. For example:
smtp.sender.character_se
t=iso-2022-jp
If you want to customize the behavior of the receiving IMAP endpoints for messages, edit the following parameters in the adapter.ini
file.
To customize the receiving endpoint:
smtp.receiver.exception_folder
to the folder name in which to place files that have not been processed successfully. 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.
smtp.receiver.polling_interval
parameter to the time interval in milliseconds during which 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
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
Table 2-2, Table 2-3, and Table 2-4 describe SMTP executable files, configuration files, and directories. These files and directories are accessible from the directory shown in Table 2-1.
Platform | Directory |
---|---|
UNIX |
|
Windows |
|
See Also:
"SMTP Adapter Error Codes" for a list of error codes |
File | Description |
---|---|
|
Contains one error code per line |
|
Consists of all the initialization parameters that the adapter reads at startup |
The SMTP adapter connects to the hub database using parameters from the hub.ini
file located in the hub directory. Table 2-5 lists the parameter name, description, the possible and default values, and example for each parameter
When a hub is installed on a Real Application Cluster (RAC) database, parameters listed in Table 2-6 represent information on additional nodes used for connection and configuration. These parameters are added on top of the default parameters which represent the primary node. In Table 2-6, x
represent the node number, which varies between 2 and the number of nodes. For example, if the RAC setup contains 4 nodes, x
can take a value between 2 and 4.
This section contains these topics:
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 name, a description for each parameter, the possible and default values, and an example.
Parameter | Description | Example |
---|---|---|
|
Specifies the name of the application to which this adapter connects. This must match with the name specified in iStudio during creation of metadata. Use any alphanumeric string. There is no default value. |
|
|
Specifies the partition this adapter handles as defined in iStudio. Any alphanumeric string is a possible value. There is no default value. |
|
|
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 values are any integer greater than or equal to |
|
|
Specifies the amount of logging necessary. Possible values are:
The default value is |
|
|
Specifies the subscriber name used when this adapter registers its subscription. The possible value is a valid Oracle Advanced Queue subscriber name. There is no default value. |
|
|
Specifies conditions for message selection when registering its subscription with the hub. The possible value is a valid Oracle Advanced Queue message selector string. There is no default value. |
|
|
Specifies the subscriber name used when multiple adapter instances for the given application with the given partition are used. This parameter is optional if only one instance is running. The possible value is the application name ( |
If |
|
Used only if multiple adapter instances exist for the given application with the given partition. The possible value is a string built using the concatenated application name ( |
If |
|
Specifies if message tracking is enabled. Set this parameter to |
|
|
Specifies if throughput measurement is enabled. Set this parameter to |
|
|
Specifies whether to use a custom document type definition (DTD) for the common view message when handing it to the hub (the repository in which metadata is stored). By default, adapters use an OracleAS InterConnect-specific DTD for all messages sent to the hub, as other OracleAS InterConnect adapters retrieve the messages from the hub and know how to interpret them.
Set this parameter to |
|
|
Specifies the metadata caching algorithm. Possible values are:
The default value is |
|
|
Specifies the domain value mapping (DVM) table caching algorithm. Possible values are:
The default value is |
|
|
Specifies the lookup table caching algorithm. Possible values are:
The default value is |
|
|
With any of the agent caching methods enabled, metadata from the repository is cached locally on the file system. Set this parameter to Note: After changing metadata or DVM tables for this adapter in iStudio, you must delete the cache to guarantee access to the new metadata or table information. |
|
|
Specifies the maximum number of application objects' metadata to cache. Possible values are any integer greater than or equal to |
|
|
Specifies the maximum number of common objects' metadata to cache. Possible values are any integer greater than or equal to |
|
|
Specifies the maximum number of messages' metadata (publish/subscribe and invoke/implement) to cache. Possible values are any integer greater than or equal to |
|
|
Specifies the maximum number of DVM tables to cache. Possible values are any integer greater than or equal to |
|
|
Specifies the maximum number of lookup tables to cache. Possible values are any integer greater than or equal to |
|
|
Specifies the maximum size to which internal OracleAS InterConnect message queues can grow. Possible values are any integer greater than or equal to |
|
|
Specifies the maximum size to which internal OracleAS InterConnect persistence queues can grow. Possible values are any integer greater than or equal to |
|
|
Specifies how often to run the persistence cleaner thread (in milliseconds). Possible values are any integer greater than or equal to |
|
|
Specifies how often the persistence thread retries when it fails to send an OracleAS InterConnect message. Possible values are any integer greater than or equal to |
|
|
Specifies how to turn on or off the pipeline for messages from the Bridge towards the hub. If you set the pipeline to |
|
|
Specifies how to turn on or off the pipeline for messages from the hub towards the Bridge. If you set the pipeline to |
|
|
Windows only. Specifies the value to which to set the environment variable |
|
|
Specifies the class path used by the adapter Java VM. If a custom adapter is developed and, as a result, the adapter is to pick up any additional jars, add the jars to the existing set of jars being picked up. Possible values are the valid class path. There is no default value. |
|
|
Specifies the entry class for the Windows service. A possible value is |
|
|
Windows only. Specifies the maximum size to which the Java VM's stack can grow. Possible values are the valid Java VM maximum native stack size. The default value is the default for the Java VM. |
|
|
Windows only. Specifies the maximum size to which the Java VM's native stack can grow. Possible values are the valid Java VM maximum native stack size. The default value is the default for the Java VM. |
|
|
Windows only. Specifies the minimum heap size for the adapter Java VM. Possible values are the valid Java VM heap sizes. The default value is the default Java VM heap size. |
|
|
Windows only. Specifies the maximum heap size for the adapter Java VM. Possible values are any valid Java VM heap sizes. The default value is |
|
|
Windows only. Specifies the number of |
|
|
Windows only. Specifies any additional arguments to the Java VM. For example, to get line numbers in any of the stack traces, set |
|
|
The CORBA port number on which the adapter CORBA service listens. Generally, this port is allocated dynamically. However, it can be configured to enable access across firewall. |
|
|
Character encoding for published messages. The adapter uses this parameter to generate encoding information in encoding tag of transformed OracleAS InterConnect message. OracleAS InterConnect represents messages internally as an XML document. The default encoding of the XML document is |
|
|
Format for date fields expressed as string. The default date format is |
Date format pattern
Multiple date formats can be specified as
|
|
This parameter is a valid ISO Country Code. These upper-case and two-letter codes are defined by ISO-3166. You can find a full list of these codes at a Web site, such as,
The default Country code is Note: This parameter specifies date format. It is applicable for the date format only. |
|
|
This parameter is a valid ISO Language Code. These lower-case and two-letter codes are defined by ISO-639. You can find a full list of these codes at a Web site, such as,
The default language code is Note: This parameter specifies date format. It is applicable for the date format only. |
|
Table 2-8 shows the reserved characters used to specify the value of the nls_date_format
parameter. Using these characters, you can construct a pattern to define date formats.
Table 2-9 lists the parameters specific to the SMTP adapter.
Parameter | Description | Example |
---|---|---|
|
Specifies the entry class for the SMTP adapter. A value must be specified and cannot be modified later. There is no default value. A possible value is |
|
|
Specifies the receiving endpoint URL for the SMTP adapter. There is no default value. The URL is of the form:
|
|
|
Specifies the list of data definition description language (D3L) XML files used by this bridge. 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. There is no default value. |
|
|
Specifies the message type the SMTP adapter handles for both incoming and outgoing messages. The options are |
|
|
Specifies the sending endpoint URL for the SMTP adapter. There is no default value. The URL is of the form:
|
|
|
Specifies the SMTP host to use in sending messages. |
|
|
Specifies the content type of e-mail messages (RFC 822 header field). |
|
|
Specifies the character encoding for the message. |
|
|
Specifies the rule for generating subject. Used by the SMTP sender. The default value is: |
|
|
Specifies the class name for customization. Used by the SMTP sender. The default value is: |
|
|
User password for the IMAP server. The possible value is a valid password. There is no default value. This password can also be encrypted by running the encrypt tool and renaming this parameter to See Also: "How do I make the adapter.ini file password parameter secure?" for instructions on encrypting the user password |
|
|
Specifies the e-mail protocol to use. For this release, the only possible value is |
|
|
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 values are a valid mail folder name. There is no default value. |
|
|
Specifies the time interval during which to poll the IMAP server (in milliseconds). Possible values are any integers greater than |
|
|
Specifies the maximum number of messages to be retrieved in each polling session. Possible values are any integers greater than |
|
|
Specifies the class name for customization. Used by the SMTP receiver. The default value is: |
|
|
![]() Copyright © 2002, 2003 Oracle Corporation. All Rights Reserved. |
|