Configuring user settings

In addition to the settings available by default when iManage Drive is installed in user mode, you can customize the following:

  • Customize the options available on the Account Setup page that is used for adding iManage Work accounts.

  • Customize the default value for the Gen authenticate_with_default_browser eral, Notifications, and Sync tabs available under the Access iManage Drive settings images/download/thumbnails/163611161/Settings.png > Preferences option.

  • Customizing the default configuration settings in iManage Drive.

To change the application mode (user mode by default) and customize the account setup options, create the admin_settings.yaml file and place it in the C:/ProgramData/iManage/Drive folder.

The file contains the following sections:

  • additional_ignore_file_patterns: Specify the list of additional file patterns that should not be synced to iManage Work Server. There is no default value for this option.

  • additional_ignore_folder_patterns: Specify the list of additional folder patterns that should not be synced to iManage Work Server. There is no default value for this option.

  • allow_bulk_email_download: By default, emails are not downloaded when users download an entire container in their mapped drive using the Download (always keep on this device) right-click option. Set this option to true to include emails as part of container download. The default value is false.

  • allow_folder_copy_outside_drive: Determines whether users can copy the folders in the iManage Drive local working directory to an external location . The default value is false. Set this option to false if you do not want users to copy folders outside. With this option disabled, an error message is displayed when users perform an external folder copy action informing them that iManage Drive blocked the action because it is disabled in admin settings.

  • checkin_mode_new_version: Determines the file check-in behavior when you modify a file in your local drive, save the changes, and close the file. Changes synced back can be saved as a new version in iManage Work or the existing version can be replaced with the local copy. The default value is true and all changes to a file are saved as a new version in iManage Work. It is recommended to set this value to false to reduce the number of file versions.

  • days_to_allow_document_changelog_copy: When a document is added or modified in the locally in the mapped directory, a reference to the document is added to the document change log. Specify the number of days to allow documents to be copied from Document Change Log. Set this value to 0 to disable the feature to copy documents from the change log. Default value is 1.

  • days_to_keep_document_changelog_entries: Specify the number of days the documents changed locally will be available in the Document Change Log. Default value is 30.

  • delete_documents: Specify the default setting of whether or not to allow document deletion. The default value is true and the Allow Document Deletion option is selected. Navigate to General > Enable/Disable Document Deletion to change the setting.

    NOTE:

    iManage Drive always deletes all versions of a document when it is deleted from the mapped drive.

  • delete_folders: Specify the default setting of whether or not to allow folder deletion. The default value is false and the Allow folder deletion option is not selected. Navigate to General > Enable/Disable folder deletion to change the setting.

    NOTE:

    The Allow folder deletion option is enabled only if the Allow document deletion option is selected.

  • drive_user_root_dir: Specify a different iManage Drive root working directory. The root directory is the parent directory for all iManage Drive users. It is a directory that contains the users' working folders and files for the iManage Drive. The directory value must be on a locally attached device. Defaults to the following for Microsoft Windows:

    • $USERPROFILE\iManageDrive if USERPROFILE environment variable is set.

    • $HOMEDRIVE$HOMEPATH\iManageDrive if USERPROFILE environment is not set and HOMEPATH and HOMEDRIVE environment variables are set.

    • $HOMEPATH\iManageDrive if USERPROFILE and HOMEDRIVE environment variables are not set and HOMEPATH environment variable is set.

  • enable_container_download: The Download (always keep on this device) right-click option is available for all containers in the mapped drive by default. Set the value to false to hide this option if you do not want the container download feature to be available to users.

    NOTE:

    • The Download (always keep on this device) right-click option is available for iManage Work containers only if users connect to iManage Work Server 10.3.1 or later.

    • The Download (always keep on this device) option is also available when users connect to server versions older than 10.3.1 if the Enable Folder Download check box under Preferences was selected option in the previous versions of iManage Drive.

    • The value configured for the enable_container_download option in the admin_settings.yaml file overrides the availability of Download (always keep on this device) option in both the aforementioned instances.

  • enable_recent_my_workspaces_folder: Set this option to true to enable the My Matters and Recent Matters folders in the mapped drive. The default value is false.

  • enable_sync_progress_dialog: Set this option to false if you do not want the iManage Drive panel to pop up when syncing or unlinking a workspace , regardless of the Preferences > Notifications settings. The default value is true.

  • extra_hosts: Specify the URL of the iManage Work account(s) that you want to list for the Enter iManage Work URL field in the iManage Drive quick setup wizard and in the iManage Drive Accounts dialog box.

  • ignore_emails: Enable this option to ensure that no emails are synced to iManage Drive. The default value is false. Emails already synced will not be removed unless you restart iManage Drive and the re-sync the matter. Similarly, enabling this option will not sync emails unless you restart iManage Drive and re-sync the matter.

  • language_options: In iManage Drive user interface, navigate to images/download/thumbnails/163611161/Settings.png > Preferences > General > Language list and specify the supported languages that are available to the users for selection.

  • local_rest_service_port: Specify the port for the iManage Drive local rest API service. The default value is 8010. Set it to 0 to disable the local rest API service.

  • max_items_to_show_in_recent_workspaces: Set the maximum number of items to show in the Recent Matters folder in the mapped drive. The default value is 100.

  • max_items_to_show_in_my_workspaces: Set the maximum number of items to show in the My Matters folder in the mapped drive. The default value is 100.

    NOTE:

    To ensure that the changed settings for max_items_to_show_in_recent_workspaces and max_items_to_show_in_my_workspaces are applied, users may have to manually refresh the folders using the Refresh option that appears when they right-click these folders.


  • maximum_matters_limit: Set the maximum number of workspaces or matters that can be synced. The recommended maximum and default is 20.

  • min_free_space_for_download_mb: Set the minimum amount of free hard disk space that iManage Drive requires before it pauses download activities. The default value is 2048 (MB). If the space configured here is not available, all downloads pause and the application displays a message to free up disk space before the downloads can resume automatically.

  • native_drive_letter: Specify the drive letter you want to map the iManage Drive folder to. If the drive letter is in use, the mapping is not created. The default value is M. You can change it some other letter, such as S, and so on. To disable drive letter mapping, set the value to false.

    NOTE:

    To ensure that the OLE feature works as expected in iManage Drive, you must ensure that all users map the application to the same drive letter.


  • notify_on_files_changed: Specify if notifications are shown in iManage Drive whenever users modify files. The default value is true, that is, the Notifications > Documents changed option is selected.

  • prompt_for_sync_confirmation_reminder: This option controls the time (in minutes) to prompt users for items that they have not yet confirmed for syncing to iManage Work, that is, the interval at which the sync confirmation dialog box keeps reappearing until all changes are either confirmed or restored. The default value is 5.

  • prompt_for_sync_issues_reminder: This option controls the time (in minutes) to prompt users for file sync issues they have not acted upon, that is, the interval at which the sync issues dialog box keeps reappearing until all sync issues are either resolved or taken no action on. The default value is 60.

  • proxy_server_mode: Enables you to set the mode for proxy server. The following values can be set for this option:

    • 0: no proxy

    • 1: auto-detect system proxy (default value)

    • 2: use manual proxy set by user or by administrator.

  • proxy_server_url: Specify the proxy URL that iManage Drive must use when making web/API requests. proxy_type can be http, socks4, or socks5. Possible values/formats:

    • proxy_server_url: <proxy_type>://<server_address>:<server_port>

    • proxy_server_url: <proxy_type>://<username>@<server_address>:<server_port>

    • proxy_server_url: <proxy_type>://<username>: <password>@<server_address>:<server_port>

    NOTE:

    Replace the placeholders in the angular brackets with actual values.

  • refresh_recent_my_matters_frequency_in_seconds: The Recent Matters and My Matters folders will refresh at the interval specified (in seconds). For example, to refresh the content every 10 minutes, set the value to 600. This feature is disabled by default.

    NOTE:

    • If this option is not set and users navigate within the Recent Matters or My Matters folder that has not been refreshed in the past 24 hours, an automatic refresh will occur.

    • Setting this frequency too low may overload the server, especially when a large number of users are connected to it. We recommend that users manually refresh the folders using the Refresh option that appears when they right-click these folders.

  • sync_frequency: Specify the default value of the automated sync frequency in minutes (displayed for the Sync > Document Sync Settings > Sync Frequency option). The default value is 30. Set it to 0 to disable automated syncing. Once the user changes the sync frequency using the application UI, the value set here is ignored.

  • sync_tool_allow_backup_outside_drive: Set this option to true to allow users to use the sync tool to backup data from workspaces outside iManage Drive. Default value is false.

  • trigger_confirmation_change_count: This option determines the number of files/folders that can be deleted, modified, renamed, moved, or created in the iManage Drive local directory before a sync confirmation is requested, that is, the sync confirmation dialog box is displayed to users. The default value is 10.

  • trigger_confirmation_delete_count: This option determines the number of files that can be deleted in the iManage Drive local directory before a sync confirmation is requested, that is, the sync confirmation dialog box is displayed to users. Once this count is reached, no changes will be synced to the server until the user approves them. The value for this option must always be less than or equal to trigger_confirmation_change_count. Confirming a file delete removes all its versions from iManage Work. The default value is 10.

    NOTE:

    To disable sync confirmations, set the trigger_confirmation_change_count and trigger_confirmation_delete_count options to 0. Users can enable these options by changing the values to 1 or a larger number using the Preferences > Notifications > Sync confirmation option. For all other scenarios (except when you set the value to zero and user sets it higher), if the value for the options is different in the UI and the admin_settings file, the effective limit will be the lower of the two values.

  • use_common_token: Ensures that iManage Drive uses the singleton token from iManage Work Agent. The default value is false. Organizations using Azure AD can set this option to true to ensure iManage Drive uses the singleton token for signing users in.

  • user_role: Mode in which iManage Drive is installed. The default value is user.

    NOTE:

    Change the value to admin for troubleshooting and other administrative purposes only. The following UI options are available only in admin mode:

    • The Work Agent Token Settings to use the login token from iManage Work Agent, and Server Authentication Settings options on the iManage Drive Accounts page.

    • Additional options (Show iManage Drive Log, Show iManage Drive Databases, Open iManage Drive Log Folder, Sync Now, Pause Syncing, Diagnostics: Tests, Diagnostics: Performance Stats, and Reset iManage Drive) on the Access iManage Drive Settings menu.

    • Additional tabs (Sync, Proxies, and Advanced) for the Access iManage Drive settingsimages/download/thumbnails/163611161/Settings.png > Preferences option.

  • enable_windows_sidebar: Set this option to true for users to access iManage Drive application from the users' Microsoft Windows Explorer sidebar. The default value is false.

  • search_show_max_results: Use this option to set the maximum number of results iManage Drive can display when performing the search option. The default value is 30 and maximum value is 500.

The following is a sample configuration file:

additional_ignore_file_patterns: 
- *.ext1 
- *.ext2
 
additional_ignore_folder_patterns:
- folder_1
- folder_2
 
allow_bulk_email_download: false
allow_folder_copy_outside_drive: false
checkin_mode_new_version: true
days_to_allow_document_changelog_copy: 3
days_to_keep_document_changelog_entries: 30
delete_documents: true
delete_folders: false
drive_user_root_dir: C:\iManageDriveRootDir
enable_container_download: true
enable_recent_my_workspaces_folder: true
enable_sync_progress_dialog: true
enable_windows_sidebar: false  
search_show_max_results: 30
 
extra_hosts:
- https://cloudimanage.com
- https://<iManage Work Server domain name>
 
ignore_emails: false
 
language_options:
- en
- fr
- es
- de
- pt
- ja
- zh
 
local_rest_service_port: 8010
max_items_to_show_in_my_workspaces: 100
max_items_to_show_in_recent_workspaces: 100
maximum_matters_limit: 20
min_free_space_for_download_mb: 2048
native_drive_letter: M
notify_on_files_changed: true
prompt_for_sync_confirmation_reminder: 5
prompt_for_sync_issues_reminder: 60
proxy_server_mode: 1
proxy_server_url: <proxy_type>://<server_address>:<server_port>
refresh_recent_my_matters_frequency_in_seconds: 600
sync_frequency: 30
sync_tool_allow_backup_outside_drive: false
trigger_confirmation_change_count: 10
trigger_confirmation_delete_count: 10
user_role: user
use_common_token: false


NOTE:

  • Replace the <iManage Work Server domain name> variable with the domain name of the desired iManage Work account.

  • Alignment and indentation of text must remain the same and no extra text must be added to ensure that the file works correctly.

  • Restart iManage Drive, using the shortcut for the application on your desktop, every time you update this file to ensure that the changes are applied.

  • If you want iManage Drive to automatically connect to the server that iManage Agent is connected to, configuring additional servers using the admin_settings.yaml file may not be required.