Import settings

You can configure TotalAgility to receive documents through Cloud file, POP3, IMAP, SMTP, MS Graph, fax servers, folder, and Exchange Web Services. Each external system has configuration settings that create TotalAgility processes when business documents are received.

See Import sources.

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.

Active import sources or passive import connection settings are supported.

For more information about supported input file formats and output file formats.

See Input and output formats for Message Connector.

Active import sources

The active import sources run as services within TotalAgility to accept messages sent from external systems. You can only configure one import source type 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 before submitting it to a Capture activity.
If the email body is formatted as HTML, after processing the image 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 sources

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

Passive import sources settings include:

Post Office Protocol (POP3)
Internet Message Access Protocol (IMAP)
Exchange Web Services (EWS)
MS Graph
Fax
File
Cloud File

Metadata for all import sources

See the following table for metadata available for all import sources.

Metadata

IMAP/EWS/POP3/SMTP/ MS Graph

External fax server/FoIP

File

Cloud File

Archive folder

This metadata does not apply to the {Process-ID} field.

Path to store the archived messages.

Error information

Error description displayed when the file is not imported.

Error description displayed when the file is partially imported or not imported.

Error description displayed when the file is not imported.

Error level

N/A

The status of an imported file: 0 = imported, 1 = partially imported and 2 = not imported.

N/A

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.

File path

Folder path of the file.

File name

From

Field in an email.

N/A

Field in an EML or MSG file.

The 'Sender' details are used when the 'From' field is not available in the message file.

Field in an email.

Field in an EML or MSG file.

The 'Sender' details are used when the 'From' field is not available in the message file.

Field in an EML or MSG file.

The 'Sender' details are used when the 'From' field is not available in the message file.

Body

Field in an email.

The following table provides information about the output generated with/without message header for different types of email body:

Include message header	Email body	Output format
False	Text	Plain text
False	in-line images	MHT format (MIME format)
False	HTML	HTML format
True	Any	Base64 encoded string

N/A

Field in an EML or MSG file.

The 'Sender' details are used when the 'From' field is not available in the message file.

Bcc

Field in an email.

Field in an EML or MSG file.

The 'Sender' details are used when the 'From' field is not available in the message file.

Field in an EML or MSG file.

The 'Sender' details are used when the 'From' field is not available in the message file.

Field in an email.

Field in an EML or MSG file.

The 'Sender' details are used when the 'From' field is not available in the message file.

Field in an EML or MSG file.

The 'Sender' details are used when the 'From' field is not available in the message file.

From fax number

The fax number from which the fax has been sent.

Message import folder

Folder or the subfolder name from where the messages are polled. For example, if the polled folder is "Inbox" and the subfolder is "sub1", then this field contains "Inbox/sub1".

Import source address

The mailbox name configured in TotalAgility. For example, the final routed email address for SMTP email.

The fax number configured in TotalAgility. For example, the extension number for FoIP.

The watch folder name configured in TotalAgility.

Import source type

FAX

FOLDER

Import source recipients

The comma-delimited list of To and CC recipients.

Original fax number.

The watch folder name configured in TotalAgility.

Input source type

The type of input source. For email, it is POP3, IMAP, SMTP, or EWS.

The type of input source. For fax, it is BISCOM, RightFax or KCS.

The type of input source. For file import, it is folder.

Message attachment list

The file names of the message attachments delimited by ';'.

The file names of the documents delimited by ';'.

KfxMessageRemovedAttachmentList

Includes the list of all the filenames which are skipped from import. The file names are delimited using a semicolon.

You can use this field in the subject field or in the body of a notification email sent for Successfully imported, Not imported, and Partially imported messages.

Supported input source: Email

Supported input source: Folder.

When file types are specified in the Allow importing files or Skip importing files fields, the names of all the files types that are not imported are listed in the "KfxMessageRemovedAttachmentList" message field.

Supported input source: Folder.

Message correlation

The correlation information of the message (for internal use).

Message delivery priority

The priority of the message, such as Low, Normal, High.

Values:

0: Low
1: Normal
2: High

Supported input source: IMAP, POP3, MS Graph, and EWS.

N/A

Message delivery type

The delivery type of the message. Reserved for future use.

Set to static string TO.

The delivery type of the message. Reserved for future use.

Set to static string TO.

The delivery type of the message. Reserved for future use.

Set to static string TO.

The delivery type of the message. Reserved for future use.

Set to static string TO.

Message general file name

The file name of the document. For the fax server, this returns the server's internal file name of the fax message.

Message ID

The unique ID assigned by the Message Connector to a message on arrival.

Message original recipients

Contains a list of the original recipients as specified by the fax originator.

Message originator name

The full name of the message originator. For SMTP/POP3/EWS/IMAP, it is the originator's display name (mime-header/from/mailbox/displayname).

The full name of the message originator. For faxes, this is the TSI.

The full name of the message originator. For SMTP/POP3/EWS, it is the originator's display name (mime-header/from/mailbox/displayname).

Message originator number

The originator email (mime-header/from/mailbox/address) for POP3/SMTP/EWS mail.

The fax number of the originator (caller ID).

The watch folder name configured in TotalAgility including the file name.

Message originator service

FAX

FOLDER

Message owner reference

The mime-header or message ID of emails.

The server-specific message ID.

The mime-header or message ID of EML or MSG files.

Message reception caller ID

The fax number of the sending fax machine.

Message importing error

If the message is rejected by TotalAgility, it contains the error message.

Message reception time created

The time when the message was retrieved by the Message Connector.

For emails, we recommend that you use the Message Reception Time Received field.

Biscom/Right Fax: The start time of fax reception.
KCS: The time when the fax server started receiving the message.

For Biscom and Right Fax, the "Message reception time created" and "Message reception time received" fields return the same value. We recommend that you use the Message Reception Time Received field.

The time when the message was retrieved by the Message Connector.

For the folder, we recommend that you use the Message Reception Time Received field.

The time when the message was retrieved by the Message Connector.

For the folder, we recommend that you use the Message Reception Time Received field.

Message reception time received

The time when the message was retrieved by the Message Connector.

Biscom/Right Fax: The start time of fax reception.
KCS: The time when the fax server finished receiving the message.

The time when the message was retrieved by the Message Connector.

Message recipient name

The full name of the message recipient. For POP3, this is the mailbox display name.

The full name of the message recipient.

The full name of the message recipient in an EML or MSG file.

Message recipient service

The service name of the recipient. For email import, it is "EMAIL".

The service name of the recipient. For fax import, it is "FAX".

The service name of the recipient. For file import, it is "FOLDER".

Message routing number

SMTP: Active email recipient.
POP3/IMAP/EWS: Mailbox username.

The extension or called party number.

The full path of the imported file.

Message response XML

If you use this metadata, you do not need to map any other metadata.

All available metadata of the incoming message.

All available metadata of the incoming document.

All available metadata of the incoming file.

Message suspected duplication

Reserved for future use. Set to static value 0.

Pages

The number of fax pages in the message.

Time created

If you are currently using this field, we recommend that you use the Message Reception Time Created field.

The date and time when the message was retrieved.

The time when the fax server received the message.

Time posted

The date and time information of an incoming message. If the message does not contain date and time information, TotalAgility uses the current date and time.

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 a trigger file).

Subject

The subject of an email.

The subject of an EML or MSG file.

Message MetaData Xml

It holds the metadata of the following fields: ArchiveFolder, Bcc, CC, ErrorInformation, ErrorLevel, FileName, FilePath, ImportSourceAddress, ImportSourceReceipients, ImportSourceType, InputSourceType, MessageAttchmentList, MessageCorrelation, MessageDeliveryPriority, MessageDeliveryType, MessageID, MessageImportingError, MessageOriginatorName, MessageOriginatorNumber, MessageOriginatorService,MessageOwnerReference, MessageReceptionTimeCreated, MessageReceptionTimeRecieved, MessageRecipientName, MessageRecipientService, MessageRoutingNumber, MessageSuspectedDuplication, Subject, To

It holds the metadata of these fields: ArchiveFolder, Bcc, CC, ErrorInformation, ErrorLevel, FileName, FilePath, ImportSourceAddress, ImportSourceReceipients, ImportSourceType, InputSourceType, MessageAttchmentList, MessageCorrelation, MessageDeliveryPriority, MessageDeliveryType, MessageID, MessageImportingError, MessageOriginatorName, MessageOriginatorNumber, MessageOriginatorService,MessageOwnerReference, MessageReceptionTimeCreated, MessageReceptionTimeRecieved, MessageRecipientName, MessageRecipientService, MessageRoutingNumber, MessageSuspectedDuplication, Subject, To

By default, the Date/Time metadata fields always return values in the UTC format. To get metadata field values in local system format, refer to the Kofax TotalAgility Administrator's Guide.

How to: Configure the import connection settings