New article
Recently updated
AutoDiscovery patterns for File System folders
Who is this article for?Users responsible for setting up filing Locations.
Shared config access is required.
This article contains information about all the elements you need to be familiar with when setting up Auto Discovery for File System folders.
1. Files
| Name | Description |
|---|---|
| MailManager.Autodiscovery.exe | Used to test the configurations. Located in: ...\Mail Manager\Program Files\x64. |
| AutoDiscoveryFileSystem.txt | Contains the configuration patterns. Sample file located in: …\Mail Manager\Program Files\Sample\Mail Manager Config. |
| Generated collections files | Created after running MailManager.Autodiscovery.exe. Used for checking and using with the Collections.txt as an alternative to using auto discovery. Files created in: %Temp%\Mail Manager\AutoDiscovery\FileSystem\Collections. |
2. Configuration patterns
You can use a combination of any of the following elements when editing AutoDiscoveryFileSystem.txt.
2.1. Hierarchy components
| Component | Description |
|---|---|
|
Consolidation |
Groups multiple directories into a single collection. Must be named, but doesn't need to include [C]. Must be the first hierarchy in the configuration and followed by Directory. |
|
Directory |
Starting folder path e.g. UNC or Drive and must end with a backslash, e.g.: J:\ Must be followed by Folder. Directory must not be the Collection level. |
|
Folder |
Must be after Directory. |
2.2. Hierarchy separators
| Separator | Description |
|---|---|
| / |
Separates the different hierarchy levels. |
| | | Separates components (e.g. Name). Hierarchy component must be the first thing in each level. |
2.3. Identifiers
| Name | Tag | Description |
|---|---|---|
| Collection | [C] | Specifies the Mail Manager Collection name. Must be before [D]. |
| Description | [D] | Specifies the Mail Manager Description name. Must be after [C] or Consolidation. Additional description [D] levels can be applied. Will be appended to the right of the previous description |
| Target | [T] | Option - Filing Location folder is always the last level. |
2.4. Additional tags
| Name | Tag | Description |
|---|---|---|
| Partial | [P] | Can be applied to Named levels only. Performs a partial name match. For example, "Cont" will discover "Contoso", "Conteso", "osoCont", "o Cont os". By default, if the level is missing a [P] tag, it will discover structures looking for a full match. Levels after the description cannot be Partial. |
| Case Insensitive | [CI] | Can be applied to Named levels only. Performs case insensitive matching. Work both for Partial and Full name match. For example, "CoNtOsO" will discover "Contoso", "contoso", "CONTOSO". |
| Description Prefix | [DP] | Name of the discovered level appended to the left of the description [D] level |
| Unloaded | [U] |
Must be combined with [C]. First time the Collection is added to the client database, it will include the unloaded flag, i.e. the collection light bulb is greyed out in the Location tool. |
| Search Only | [SO] |
Must be combined with [C]. Locations associated with the Collection will have a "Usage" of Search. |
| Ignore | [I] |
Ignore all folders that match the full specified string. Case sensitive by default. |
| Ignore Partial | [P] | [I] | Ignore all folders that contain the specified string in any part of the name. Case sensitive by default. For example, "Folder | [P] | [I] | sys" will discover every folder that does not contain "sys". "sysAdmin", "Testsys", "AsysB" will not be discovered. |
| Ignore Prefix | [IP] | Ignore all folders that start with the specified string. For example, "Folder | [IP] | [CI] | .a" will discover every folder that does not start with ".a" or ".A". |
| Ignore Suffix | [IS] | Ignores all folders that end with the specified string. For example, "Folder | [IS] | [CI] | old" will discover every folder that does not end with "old". |
2.5. Example
Below pattern would create a Collection called "Suppliers".
Directory|\\global.company.com\london\Jobs\ / Folder|Suppliers|[C] / Folder|[D] / Folder|Emails|[T]
The pattern above could also be written as the following using the consolidation component if the 'Suppliers' Collection name was already taken:
Consolidation|SuppliersCollection|[C] / Directory|\\global.company.com\london\Jobs\ / Folder|Suppliers / Folder|[D] / Folder|Emails|[T]
Modifying more than one Collection at the same time?
You can configure multiple elements by separating them with a new line.
Be careful that the same Collection name, followed by the tag [C], is not specified in multiple lines or setups. Collections with the same name will be overwritten by the last one in the list.
Specifying the name of a level of an Auto Discovery path means auto discovery will specifically look for this name. If a part of the setup is not named then Auto Discovery will treat this as a wildcard and search all folders at that level