Configure the import connection settings

Configure an import connection to receive documents through Cloud file, POP3, IMAP, SMTP, MS Graph, fax servers, folders, and Exchange Web Services.

The following table illustrates the difference between the local connector and shared connector for various TotalAgility environments. For information about Storage mode and Direct mode, refer to the Kofax TotalAgility Administrator's Guide.

Environment	Core Worker - Message Connector	Local connector		Shared connector	Additional information
Environment	Core Worker - Message Connector	Storage mode	Direct mode	Direct mode	Additional information
On-premise	One-One	Supported	Supported	Not Supported
	One-Many	Supported	Supported	Not Supported
	Many-One	Not Supported	Supported	Not Supported
	Many-Many	Supported ^*	Supported	Not Supported	^* Additionally, configure the value of ImportConnectorName field in Agility.Server.Core.WorkerService.exe.config to ensure that each Message Connector is used only by one Core Worker
Tenant (On-premise multi-tenant or Azure)	One-One	Not Supported	Not Supported	Supported	The local connector shown in a tenant is Integration Server configuration.
	One-Many	Not Supported	Not Supported	Supported
	Many-One	Not Supported	Not Supported	Supported
	Many-Many	Not Supported	Not Supported	Supported
Integration server (On-premise multi-tenant or Azure)	One-One	Supported	Supported	Not Supported

The following table illustrates how different features are applicable and operate in Storage or Direct mode.

Feature/module/condition	Storage mode	Direct mode	Additional information
Document normalization during the import	Yes	No	For direct mode, use Document conversion activity in the workflow.
Document archiving	Yes	No	For direct mode, use activity in the workflow.
Within a pool, multiple Message Connectors balance the load and operate as a fault-tolerant system.	No	Yes
Messages are stored in the Message Connector storage and removed from the source before import to TotalAgility	Yes	No
History of received messages	Yes	No
Download and rerun messages for troubleshooting	Yes	No
When the message is rejected by TotalAgility	The message is kept in the Message Connector as an in bound failure with an optional email to the operator.	For IMAP, EWS, MSGraph, and File, the message is renamed/moved on the source system so that it cannot be imported. For the Fax server, the import is retried with a delay of one hour until the message is manually removed from the source system.
When import to TotalAgility fails	TotalAgility retries import after the configured period. The import is rejected if the committed retries are reached.	TotalAgility retries import with a delay of one hour until the message is manually removed from the source system.
Performance and scalability	The preferred mode for importing large files/messages.	The preferred mode for multi-tenant and fault-tolerant installations.

Message reject behavior in Direct mode:

IMAP: The message is moved to the "Rejected" folder.
EWS / MS Graph: If the "KfxRejected" folder exists, the message is moved to this folder. Otherwise, the import is retried with a delay of one hour until the message is manually removed from the source system.
File: The searched file is permanently locked with the ".?????+99999.locked" suffix.

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, perform classification or extraction on the document, and use the Document conversion activity to normalize the documents, and then use any of the Capture Client activities, such as the image processing activity.
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 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.

Navigate to Integration > Import settings.

The Import settings page appears.
Click New.

The New import connection dialog box is displayed.
Enter a Name for the import connection.
Optional. Enter a Description for the import connection.
By default, the import connection is Active.
This step only applies if you are using TotalAgility in an on-premise multi-tenant environment and you have configured Message Connector pools in Tenant Management System. For other TotalAgility environments, continue with the next step. On the Connection Type list, select either option:

If no Message Connector pools are defined in the Tenant Management System, the "Connection Type" field is not displayed, and you can only use local connectors.
- Local connectors: Select this and continue with the next step for further configuration.
- Shared connectors: See Configure import settings for shared connectors for further configuration.

Select either option for Connection mode.

Storage

In this mode, exactly one Message Connector must be active for an import connection.

Messages are polled and stored in the Message Connector storage. This is the default mode.

If required, Enable SMTP server. See Configure the SMTP settings.

If required, Enable FoIP server. See Configure the FoIP settings.

Direct

Multiple Message Connectors can be used for importing the messages.

The imported messages are not stored in the Message Connector storage but directly sent to the TotalAgility.

For a Direct mode, the "Enable SMTP server" and "Enable FoIP server" fields are not available.

When using local connectors for polling, you need to add the available Message Connectors. To add a new Message Connector, on the Message Connectors list, click .

On the Message Connectors list, click .

The Add Message Connector dialog box is displayed.

Configure the following properties.

Field

Description

Name

Enter a unique name for the Message Connector.

Active

By default, the Message Connector is active.

Message Connector URL

Enter the URL of the Message Connector.

If the "Allow all" system setting is not enabled, you can only enter the Message connector URL that is whitelisted; otherwise, a message appears stating the connection is denied because the URL connection string is not whitelisted. See Whitelist a web service URL or a database connection string.

Credential storage

To log in, select one of the following for Credential storage.

Local (Default)

Process password: Specify the same value which you have specified in the Message Connector Configuration.

The password for process user controls the import of documents in Message Connector and display of "Passive Inputs" in Message Connector Monitor.

If you configure "View password" in Message Connector Configuration, you will be prompted to enter this password at the time of opening the Message Connector Monitor window.

Administrator password: Specify the same value which you have specified in the Message Connector Configuration. The password for admin user restricts the remote configuration of Message Connector without appropriate authentication.

This field is not displayed if you are adding a Message Connector for polling messages in Direct mode.

External

Enter the secret name for the process password and administrator password stored in the configured external storage.

To confirm whether the specified Message Connector URL is correct and active, click Test connection. If the connection fails, an error message appears. Fix the issue.
Click Save.
Repeat steps a to d to add all the required Message Connectors.

To edit an existing Message Connector, select the required Message Connector from the list and click . Update the fields as required and click Save.
To delete a Message Connector, select the required Message Connector from the list and click . On confirmation, delete the Message Connector.

To add an import source, perform the following steps:
1. Click  for Import sources.
2. On the Type list, select an import source and configure the settings in the New import source dialog box.
  - The FoIP, SMTP and POP3 import sources are not available for the Direct mode.
  - The credential storage option is not available for FoIP and SMTP import sources.
  - In Direct mode, the "Notification settings", "Document normalization" and "Document archiving" tabs are not available when configuring an import source.
  Available import sources are
  - POP3 (Default)
  - IMAP
  - MS Graph
  - EWS
  - External fax server
  - FoIP
  - SMTP
  - FILE
3. Save the import source.
  
  The import source name appears under the Import sources table in the New import connection dialog box.
To test whether the specified Message Connector URL is correct and active, click Test connection. This will test the connection with all the Message Connectors in the Message Connectors list.
Click Save.

The import connection appears on the Import settings page.
You can include these import sources and import connections to packages for exporting. For more information, see Import a package.

Configure import settings for shared connectors

When using the shared connectors, the connection mode is always direct.

On the Shared Message Connector pool list, select the required Message Connector pool.
To add an import source, click  for Import sources.
1. On the Type list, select an import source and configure the settings in the New import source dialog box.
  Available import sources are
  - IMAP
  - MS Graph
  - EWS (Default)
  - External fax server
  - FILE
  The "Notification settings", "Document normalization" and "Document archiving" tabs are not available when configuring import sources.
2. Save the import source.
  
  Before saving, ensure that the import source connection is successful.
  
  The import source name appears under the Import sources table in the New import connection dialog box.
To test whether the specified Message Connector pool is correct and active, click Test connection. This will test the connection with all the Message Connectors in the Message Connectors list.

The validation of the Shared Message Connector Pool connection is successful if at least one of the active Message Connector connections in the pool is up and running. An error is thrown only if all the Message Connectors in the pool are down.
Click Save.

The import connection appears on the Import settings page. You can include these import sources and import connections to packages for exporting. For more information, see Import a package.