Integrating with an E-mail Server | ||
---|---|---|
Previous | Next | |
Integrating with Oracle Secure Enterprise Search | Integration Using External Attribute Types |
iKnowBase E-mail Reader is a stand-alone component that enables you to automatically load mails from a mailbox into the iKnowBase Content Store. It has the following key features:
Use the E-mail integration component in iKnowBase Development Studio to configure e-mail accounts used by the iKnowBase E-mail Reader. For more information on configuring an e-mail account, see the iKnowBase Development Reference.
The iKnowBase E-mail Reader program performs the following tasks, once for each active account during execution:
There can be multiple body parts of a single e-mail. This happens because of the e-mail programs that send multiple versions of the body of an e-mail. One version can be a rich HTML-message and the other can be a simple text-message.
To select the body part that you want to use, use the following rules:
The E-mail integration accounts can be configured with a message handler (e-mail reader procedure) that is a customizable PL/SQL procedure. You can use the message handler for automatically loading of e-mails from the iKnowBase E-mail Reader tables into the iKnowBase Content Store. Loading e-mails into the iKnowBase Content Store can be useful for various reasons and the actual document structure required varies widely.
When the iKnowBase E-mail Reader program runs, it populates the iKnowBase E-mail Reader tables with e-mail information. After populating these tables, the program activates the message handler, passing the account_id of the account as the only parameter.
The message handler will typically traverse the iKnowBase E-mail Reader tables, using the iKnowBase Service API to create the required iKnowBase documents and objects.
iKnowBase comes with a default message handler TEST_INSERT_MAIL, useful for testing and simple setups. This message handler has the following features:
The iKnowBase E-mail Reader guarantees once-and-only-once semantics of message delivery and processing, given that the message handler is built according to certain principles, see the last bullet point of this section.
The E-mail Reader program is distributed as a java .jar-archive, which can be run using the following command:
java �jar iKnowBase-<version>-EmailReader.jar
where version is the actual version of iKnowBase Content Services.
The E-mail Reader program accepts the following parameters.
Parameter | Description |
---|---|
-url
<url>
|
JDBC-url to database |
-username
<user>
|
Database username, for iKnowBase user/schema |
-password
<pwd>
|
Database password, for iKnowBase user/schema |
-interval
<secs>
|
This is the interval between runs. The program runs repeatedly with an interval of the specified number of seconds. If this parameter is missing, the program runs only once. The first run occurs immediately. |
-properties
<file>
|
Refers to a property file with parameters. In some operating systems where the command line parameters can be seen, this parameter is useful in hiding the username or password from other logged on users. |
-log4j
<file>
|
Refers to a custom log4j.properties-file. E-mail Reader program uses a default setup, unless specified. |
In general, the recommended setup is to use a property file, and enter all the parameters in that file. The syntax of the file has multiple lines, where each line contains a parameter name, an equals sign, and a value. Lines beginning with a hash sign are comments:
# Database connection
url=url
username=user
password=pws
# 3600 seconds = one hour
interval=3600
The iKnowBase E-mail Reader relies on log4j from the Apache logging project for logging. You can configure the log using a custom log4j properties file.
If you do not configure the log, the program uses a default configuration which logs detailed messages to standard out, and warning messages to the ERROR_TAB table in the iKnowBase database. The actual setup for this logging can be seen in the file log4j.properties which is distributed along with the iKnowBase E-mail Reader program.
To customize the logging, create your own log4j properties file with the parameters that you want and then start the iKnowBase E-mail Reader program with the extra
-log4j <filename>
command line argument.
For information on log4j configuration, see http://logging.apache.org/log4j/1.2/index.html.
Note: If you want to log to the Windows event log, you need to install the DLL available through the log4j project.
Previous | Top | Next |
Integrating with Oracle Secure Enterprise Search | Integration Using External Attribute Types |