MS Graph

Configure the properties of MS Graph import source and click Save.

The properties of MS Graph import source are grouped under the following headings:

General

Field Description
Type Protocol for the import source. Select MS graph.
Display name Name for the import source.
Active By default, the import source is active.
Poll cycle in seconds The time interval after which the import connector checks for new documents on the mail server. (Default: 5)
Tenant ID Enter the directory/tenant ID. This ID is generated when you create a tenant in the Microsoft Azure portal.
Client ID Enter the client/application ID. This ID is generated when registering the application in the Microsoft Azure portal.
Client secret Enter the secret string which you generated in the Certificate and secrets section of your application in the Microsoft Azure portal. TotalAgility uses this string to prove its identity when requesting a token.

Note
  • The Tenant ID, Client ID and Client secret fields only apply to Resource Owner Password Credentials (ROPC) grant type and are not displayed if you choose to use the OAuth server.

  • If Default client type is set to YES for your application in Microsoft Azure Active Directory, then do not specify the Client secret. Else, specify the Client secret.

Shared mailbox Enter the name of the shared mailbox to poll the messages from a shared mailbox. Enter the shared mailbox in format: SharedMailbox@domain.com.
Poll mailbox The Inbox folder is polled by default. Enter the name of the email folder to poll the messages from a different folder.
Poll sub folder Select this to poll messages from sub folders of the specified mailbox folder.

Note MS Graph does not support polling of public folders on an Exchange Server. To poll public folders on an Exchange Server, use EWS.

Keep message on server Select this to store processed messages on the mail server.
Processed folder name The folder name to store processed messages. This folder must exist at the same level as the polled inbox folder.

This option is only available if Keep message on server is selected.

Mode Configure whether one inbox can be polled by multiple message connectors simultaneously. Available modes are:

  • Multiple instance: Allow multiple connections to a single mailbox, without risking duplicate imports.

  • Single instance(Default): Poll this mailbox with only one message connector. If you use single instance and run multiple connections in parallel, it might cause TotalAgility to import a message multiple times.

User name and Password The username and password for the MS graph mailbox. Enter the user name in format: user@domain.com.

For OAuth authorization, enter the mailbox name in the User name field. The Password field is disabled for OAuth authorization.

Use OAuth Server Select this to use OAuth authorization.
Note
  • When you select Use OAuth Server, the Password field is not displayed.

  • Make sure that the selected OAuth server uses the Secret in post body type of authentication method. See Secret in post body.

OAuth server Select the OAuth server for authorization the list. For information about OAuth servers, see OAuth 2.0 servers.
Test mailbox Verifies the connection between the import connector and mailbox.
Error Handling
Message connector service timeout Timeout value for message processing. This value sets the timeout when calling the Message Connector service. (Default: 1200 seconds (20 minutes). This value is suitable for processing most messages.)

To avoid timeout for messages with longer processing time, increase the timeout value. Maximum allowed value is 86400 seconds (24 hours.)

Advanced

Field Description
Normalize images and create pages Normalizes the incoming image files to TIFF and create pages. (Default: Clear)

Note
  • To normalize images and create pages for the images in Import (old behavior), the Normalize images and create pages option is enabled on upgrading TotalAgility from version 7.5.0 or lower. We recommend that you do not select this option for new process maps.

    For new process maps, keep this option clear (default). Use the Document conversion activity to normalize the images and then create pages for the images. You can also address issues such as scaling and orientation in the Document conversion activity and then use any Capture activities in your process map.

  • The Document conversion activity runs on the transformation server (scalable and optimized for heavy loads) that can manage the tasks of converting, splitting images and creating pages efficiently.

Create document from body Creates a document from the email body, classifies and extract information from it. (Default: Clear)
Import content Imports the required sections of the email and their occurrence. Select one of the following options:
  • Attachments

  • Attachments first and body

  • Body first and attachments (Default)

  • None

  • Only body

Body with message header Import the body with metadata in its header instead of plain body. Following options are available:

  • Exclude message header (Default)

  • Include message header of email

  • Include message header of email and embedded email(s): Additionally, select the Body option for the Handle body of nested emails as field in Document conversion tab of Message Connector Configuration.

Include complete message as EML file Imports an EML file same as the original email including attachments. (Default: Clear)
Include complete message as MSG file Imports an MSG file same as the original email including attachments.
Skip import for extensions Enter a list of all the file types which you do not want to convert. Delimit each file type with a semicolon. For example, to skip the conversion of PNG and TEXT files, enter .png;.txt.
Skip import for files of size (bytes) less than Enter a valid file size. TotalAgility skips the conversion of files with file size less than specified in this field. (Default is 0, which means this field is ignored.
Extract PDF portfolio content Allows the extraction of documents from PDF portfolio files. (Default: Clear)
Extract referenced MSG/EML files

Allows the import of the nested emails and EML/MSG files along with their attachments.

By default, TotalAgility allows the import of the main email and all types of attached emails in EML/MSG format. This is also applicable to the EML and MSG files which are referenced in the XML files.

This option is selected when upgrading TotalAgility from a lower version.

Note In case of an XML import, enabling the Extract referenced MSG/EML option when Import content is set to Only body is not a valid scenario.

Document normalization

Field Description
Normalize non-PDF eDocuments to PDF/A

Normalizes non-PDF eDocuments (MS Office documents) to PDF/A. (Default: Clear)

Configure the following

Field Description
Skip PDF/A preparation for extensions Skips the conversion of specified file types to PDF/A format. Enter the list of file types separated with semicolon. For example, to skip the conversion of PNG and TEXT files, enter .png;.txt.
Skip PDF/A preparation for files of size (bytes) less than Skips the conversion of files to PDF/A with size less than specified here. (Default: 0, which means this field is ignored.)
Concatenate multiple PDF files Concatenates the PDF files selected at the time of importing. (Default: Clear)
Output PDF format Output format for normalized PDF files:
  • PDF

  • PDF/A-1a

  • PDF/A-1b(Default)

  • PDF/A-2a

  • PDF/A-2b

  • PDF/A-2u

  • PDF/A-3a

  • PDF/A-3b

  • PDF/A-3u

Note
  • If the input PDF file format is not compatible to be converted to the required output format, the actual output format may be downgraded. For example, if the input file version is PDF 1.5 and if the "Output PDF format" field is set to PDF/A-1a, PDF/A-2a or PDF/A-3a, the output PDF document is PDF/A-1b,PDF/A-2u or PDF/A-3u respectively.

  • For a complete list of supported input file formats and respective output PDF formats, refer to the Kofax TotalAgility Administrator's Guide.

Embed original source file

Embeds the source files in the normalized PDF file. This option is only available when Output PDF format is set to PDF/A-3a, PDF/A-3b or PDF/A-3u.

Note If the input source file is of XML type, it is not embedded in the normalized PDF file.

Normalize incoming PDF documents to PDF/A

Converts the PDF documents to the ISO-standardized PDF/A format, specialized for digital preservation of electronic documents. Configure the following. (Default: Clear).

Field Description
Output PDF format

Output format for normalized PDF files:

  • PDF

  • PDF/A-1a

  • PDF/A-1b(Default)

  • PDF/A-2a

  • PDF/A-2b

  • PDF/A-2u

  • PDF/A-3a

  • PDF/A-3b

  • PDF/A-3u

Note
  • If the input PDF file format is not compatible to be converted to the required output format, the actual output format may be downgraded. For example, if the input file version is PDF 1.5 and if the "Output PDF format" field is set to PDF/A-1a, PDF/A-2a or PDF/A-3a, the output PDF document is PDF/A-1b,PDF/A-2u or PDF/A-3u respectively.

  • For a complete list of supported input file formats and respective output PDF formats, refer to the Kofax TotalAgility Administrator's Guide.

Embed original source file

Embeds the source files in the normalized PDF file. This option is only available when Output PDF format is set to PDF/A-3a, PDF/A-3b or PDF/A-3u.

Note If the input source file is of XML type, it is not embedded in the normalized PDF file.

Flatten XFA forms to PDF documents using Adobe Experience Manager

Allows conversion of XFA forms to PDF documents. (Default: Clear)

Ensure the following:

  • Install the Adobe Experience Manager output service and ensure that the web service interface is available.
  • Configure the Adobe Experience Manager credentials in the Kofax Message Connector configuration.

Note If support for Adobe LiveCycle is available, you can also use Adobe LiveCycle for conversion of XFA Forms.
Import exception page for failed preparation

Import the unprocessed document if there is any exception during the normalization process of a document. (default: Clear).

A document with error information is generated and the original document is appended to this document.

VRS processing

Field Description
Scan/VRS profile

Name of the Scan/VRS profile.

Extract text from PDF

To extract the text from PDF, on the Extract text from PDF list, select one of the following options:

  • All text(Default): Extracts both visible and invisible text.
  • Automatic: Extracts only visible text. If results are empty, then extracts by including invisible text in the results.
  • Ignore all text layer: Extracts PDF through OCR. PDF text layer is ignored.
  • Visible text only: Extracts only visible texts.
Word separation characters

The characters required as word separators. Default characters are: /, :, (, ), - and #.

When processing the PDF text, strings of text containing these characters are treated as separate words. For example, 1234/56 is treated as three separate words, 1234, /, and 56.

Apply scan/VRS profile to eDocuments Applies the selected Scan/VRS profile to the documents. (Default: Clear)

XML processing

Field Description
Kofax XML import mode

Select one of the following XML import mode options:

  • Do not map XML fields to TotalAgility fields: The XML file fields are not mapped to the TotalAgility fields.

  • Map XML fields to TotalAgility fields and reject on mismatch:

    TotalAgility imports the XML file and maps the TotalAgility fields to XML file fields. If there is any difference in the fields specified in the XML file, TotalAgility rejects the XML file.

  • Map XML fields to TotalAgility fields and allow fields mismatch:

    TotalAgility imports the XML file and maps the TotalAgility fields to XML file fields. If there is any difference in the fields specified in the XML file, TotalAgility will still import the file and display the errors in the Message Connector.

Kofax XML page tag processing level Select one of the following options:
  • Document: Imports a Kofax XML containing reference to a multi-page TIFF file.

  • Page(default): Imports Kofax XML containing reference to a single page TIFF file.

Create document from XML content

Creates a document from the XML content (default: Clear).

Additionally, on the Process list, select the process which contains the Document conversion activity with required XML rendering configuration. By default, you can only map the XML content to the XML process variable.

Note You must select this option to use the XML rendering feature in the document conversion activity.

Notification settings

Send notification emails to the configured email addresses when the document import process is partially successful or failed.

Field Description
Reject notification recipient list

The email addresses to which you want to send the notifications. Delimit each email addresses with a semicolon.

Send email to originator

Sends notification to the originator. (Default: Clear)

Include complete email message as attachment

Attaches the original message (in EML format) to the notification mail. (Default: Clear)

Remove email attachments When Include complete email message as attachment is selected, by default, the original email is attached to the notification email. To include the original email without attachments to the notification mail, select Remove email attachments. Default: Clear

Note When Remove email attachments is selected and if the original email does not contains body, an empty email is generated.

Message from

The email address of the sender.

Send a test notification email

Verifies whether the recipient list have received the emails by sending a test mail.

Document archiving

Field Description
Successfully imported
Format

One or more file formats for saving the successfully imported documents. Supported formats are:

  • File: Archives the message body in a text file and all attachments in separate files.

  • EML: Archives the message body and the attachments as a single EML file.

  • XML: Archive the message metadata in an XML file (custom Kofax format).

Archive folder

Path of a local folder (such as, C:\Archive) or a network folder to store the successfully imported documents.

Test archive folder

Tests whether the archive the folder is configured correctly.

Subfolder and file prefix

The name of the subfolder and prefix for the archived files. You can also add predefined Fields as subfolder name and filename prefix. The value of these variables is populated at the time of saving the archived files. If you do not add the \ character in the field, all the fields are appended to the archived file names. For example, if you add {OK}\{Process-ID}, the files are stored in OK folder with process ID appended to the filename.

Partially imported
Format One or more file formats for saving the partially imported documents. Supported formats are:
  • File: Archives the message body in a text file and all attachments in separate files.

  • EML: Archives the message body and the attachments as a single EML file.

  • XML: Archive the message metadata in an XML file (custom Kofax format).

Archive folder

Path of a local folder (such as, C:\Archive) or a network folder to store the partially imported documents.

Test archive folder Tests whether the archive the folder is configured correctly.
Subfolder and file prefix

The name of the subfolder and prefix for the archived files. You can also add predefined Fields as subfolder name and filename prefix. The value of these variables is populated at the time of saving the archived files. If you do not add the \ character in the field, all the fields are appended to the archived file names. For example, if you add {PARTIAL}\{Process-ID}, the files are stored in PARTIAL folder with process ID appended to the filename.

Rejected/Failed
Format One or more file formats for saving the rejected/failed imported documents. Supported formats are:
  • File: Archives the message body in a text file and all attachments in separate files.

  • EML: Archives the message body and the attachments as a single EML file.

  • XML: Archive the message metadata in an XML file (custom Kofax format).

Archive folder

Path of a local folder (such as, C:\Archive) or a network folder to store the failed/rejected documents.

Test archive folder Tests whether the archive the folder is configured correctly.
Subfolder and file prefix

The name of the subfolder and prefix for the archived files. You can also add predefined Fields as subfolder name and filename prefix. The value of these variables is populated at the time of saving the archived files. If you do not add the \ character in the field, all the fields are appended to the archived file names. For example, if you add {REJECTED}\{Process-ID}, the files are stored in REJECTED folder with process ID appended to the filename.

Associated actions

On the Job type list, select one of the following job types to associate an action with the MS Graph server so that a job can be created at runtime.

Create new job(Default)

  1. On the Select a Process list, select a process or case.

    If the selected process or case map has any initialization variables, the parameters appear under Initialization variables.

  2. To map the parameters to the initialization variables, on the Mapping list of the initialization variable, select a dynamic value or click and enter a static value.

Create new case

  1. On the Case list, select a case map.

    If the selected case map has any initialization variables, the parameters appear under Initialization variables.

  2. Select an Expression type:

    • Regular: Enter an expression to extract the case reference from a subject in the Case ref field.

    • XSL: Enter an XML expression to extract the case reference from the XML data in the Case ref field.

    • None (default): Automatically uses the job ID as the case reference.

  3. Map the parameters to the initialization variables, using a dynamic or static value.

Create job in case

  1. On the Process list, select a process, case or case fragment.

    If the selected process, case or case fragment has any initialization variables, the parameters appear under Initialization variables.

  2. Select an Expression type:

    • Regular(default): Enter an expression to extract the case reference from a subject in the Case ref field.

    • XSL: Enter an XML expression to extract the case reference from the XML data in the Case ref field.

  3. Map the parameters to the initialization variables, using a dynamic or static value.