Welcome > Integration module > Import settings

Import settings

You can configure TotalAgility to receive documents through POP3, IMAP and Exchange Web Services. Each external system has configuration settings that create TotalAgility processes when messages with attached business documents are received.

Note Email import settings are only available for TotalAgility on-premise; Email import settings are not available in an Azure environment.

Active import sources or passive import connection settings are supported.

Active import sources

The active import sources run as services within TotalAgility to accept messages sent from external systems. Only one import source type can be configured for each import connection. Active import sources include:

  • Simple Mail Transfer Protocol (SMTP)

  • Fax Over Internet Protocol (FoIP)

When you configure the import connector for email, you can create a document directly using the email body. The mime type of the resulting document is determined by the email format (text, RTF, HTML):

  • If the email body is formatted as text, you can perform classification or extraction on that document. After performing image processing on the document, you can view the document in any of the Capture Client activities.

  • If the email body is formatted as RTF, provide customization to convert the RTF document to a supported format prior to submitting to a capture activity.

  • If the email body is formatted as HTML, after performing image processing on the document, you can perform classification or extraction on the document or view the document in any of the Capture Client activities.

Passive import connections

Passive import connections are polled by TotalAgility to retrieve messages. One or more import connections can be configured with a Message Connector. Each import connection contains settings for the Message Connector and one or more import sources.

Passive import connection settings include:

  • Post Office Protocol (POP3)

  • Internet Message Access Protocol (IMAP)

  • Exchange Web Services (EWS)

  • Fax

  • File

You can configure the import source settings on the TotalAgility Integration Server in the same way as you would do in TotalAgility on-premise.

When the event is raised on the Integration Server, the action is executed on Azure.

See the following table for metadata available for IMAP, EWS, POP3 and SMTP import sources.

Metadata Description

From, To, CC, Body and Subject

Components of an email import.

Import Source Type

The type of import source.

Import Source Address

The mail box name configured in Kofax TotalAgility. For example, the final routed email address for SMTP email, and extension number for FOIP.

Import Source Recipients

The comma delimited list of To and CC recipients.

XML DATA

The root XML document that is, the complete XML document that has been recognized as an XML type (usually the first XML document in the email or the first XML document in the folder or the XML document that has been used as trigger file).

Note When you import an XML file which is generated using the Kofax XML format, Message Connector automatically maps the values of the imported XML fields to the TotalAgility fields.

Time Posted

The date and time information fetched from an incoming message. If the message does not contain date and time information, Kofax TotalAgility will use the current date and time.

Time Created

The date and time when the message was retrieved.

Error Level

The status of an imported file: imported, partially imported or not imported.

Error Info

The description of the error.

MessageID

The unique ID assigned to a message on message arrival.

See the following table for metadata available for External Fax Server and FOIP import sources.

Metadata Description

Fax Extension

The fax extension to which the fax has been originally sent.

Fax User

The fax user to which the fax has been originally sent.

From Fax Number

The fax number from which the fax has been sent.

Import Source Type

The type of import source.

Import Source Address

The mail box name configured in Kofax TotalAgility. For example, the final routed email address for SMTP email, and extension number for FOIP.

Import Source Recipients

The comma delimited list of To and CC recipients.

Time Created

The time when the fax server received the message.

Error Level

The status of an imported file: imported, partially imported or not imported.

Error Info

The description of the error.

Pages

The number of fax pages in the message.

MessageID

The unique ID assigned to a message on message arrival.

See the following table for metadata available for the FILE import source.

Metadata Description

File Name

Name of the file without location path.

File Path

Path of the file including the file name.

Import Source Type

The type of import source.

Import Source Address

The mail box name configured in Kofax TotalAgility. For example, the final routed email address for SMTP email, and extension number for FOIP.

Import Source Recipients

The comma delimited list of To and CC recipients

XML DATA

The root XML document, that is, the complete XML document that has been recognized as an XML type (usually the first XML document in the email or the first XML document in the folder or the XML document that has been used as trigger file).

Error Level

The status of an imported file: imported, partially imported or not imported.

Error Info

The description of the error.

MessageID

The unique ID assigned to a message on message arrival.

This section describes the following: