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 General, Notifications, and Sync tabs available under the Access iManage Drive settings  > 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:

• account_settings_rename_url: When set to true, the Rename URL option is enabled in the iManage Drive Accounts window. When users select this option, the Rename URL dropdown menu is displayed. Users can select the rename URL from this dropdown. After selecting the URL, a warning is displayed. Selecting Yes will complete the renaming of the URL and iManage Drive automatically restarts and asks the user to authenticate with the renamed URL. The Rename URL dropdown displays all the URLs mentioned in the work_server_urls admin setting. The default value is false. 

• admin_setting_controlled_values: Specifies the list of admin settings that cannot be changed in iManage Preferences tab. The following values can be controlled:
  • checkin_mode_new_version
  • delete_documents
  • delete_folders
  • hdpi_enabled
  • local_rest_service_token
  • get_main_dialog_size
  • main_dialog_size_without_icons
  • notify_new_workspace_synced
  • notify_new_workspace_synced_popup
  • notify_on_files_changed
  • notify_on_emails_changed
  • notify_workspace_removed
  • notify_workspace_removed_popup
  • notify_of_long_paths
  • prompt_for_authentication_dialog
  • proxy_server_mode
  • proxy_server_url
  • style_layout
  • ui_layout
  • webdav_port
  • zoom_layout
• additional_ignore_file_patterns: Specify the list of additional file patterns that shouldn't be synced to iManage Work Server. There's no default value for this option.
• additional_ignore_folder_patterns: Specify the list of additional folder patterns that shouldn't be synced to iManage Work Server. There's no default value for this option.
• allow_bulk_email_download: By default, emails aren't downloaded when users download an entire container in their mapped drive by using the Download (always keep on this device) right-click option. Set this option to true to include emails for 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. When the value is false, users can't copy folders outside. With this option turned off, an error message is displayed when users perform an external folder copy action informing them that iManage Drive blocked the action because it is turned off in admin settings.

• bulk_import_folder_limit: Specifies the number of folders users can import in bulk. The default value is 1000.

• bulk_import_file_limit: Specifies the number of files users can import in bulk. The default value is 20,000.

• bulk_import_total_size_limit: Specifies the size of the file users can import in bulk. The default value is 0.

• bulk_import_workspace_folder_limit: Specifies the number of folders users can import to a workspace. The default value is 10,000.
  For the bulk_import_total_size_limit and bulk_import_workspace_total_size_limit admin settings, you must specify the size type following number with either:

  • 'b' (bytes),

  • 'k' (kilobytes),

  • 'm' (megabytes), or

  • 'g' (gigabytes)

• bulk_import_workspace_file_limit: Specifies the number of files users can import to a workspace. The default value is 100,000.

• bulk_import_workspace_total_size_limit: Specifies the size of the file users can import to a workspace. The default value is 0.

• 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. We recommend setting this value to false to reduce the number of file versions.
• checkout_mode: Checks out the document when opened or saved. Possible values are on_save and on_open. The default value is on_save. 
• days_to_keep_document_changelog_entries: Specify the number of days for which the documents changed locally will be available in the Document Change Log. Default value is 30.
• days_to_allow_document_changelog_copy: When a document is added or modified in the iManage Drive working 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 turn off the feature to copy documents from the change log. From iManage Drive 10.9.0 onwards, the default value is 7.

• delete_documents: Specify the default setting of whether to allow document deletion. The default value is true and the Allow Document Deletion option is selected. Browse 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 to allow folder deletion. The default value is false and the Allow folder deletion option isn't 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.

• delete_all_document_references: Change this setting to true to delete the document reference from all folders, it's available in. By default, this option is set to false, which means that if a document is available in multiple locations in iManage Work, it is only deleted from the folder..

• 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 iManage Drive. The directory value must be on a locally attached device. Defaults to the following for Microsoft Windows:

  • $USERPROFILE\iManageDrive if the USERPROFILE environment variable is set. 
  • $HOMEDRIVE$HOMEPATH\iManageDrive if the USERPROFILE environment isn't set and the HOMEPATH and HOMEDRIVE environment variables are set.
  • $HOMEPATH\iManageDrive if the USERPROFILE and the HOMEDRIVE environment variables aren't set and the 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 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 make 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 don't 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.
  
• enable_preview: Set this option to false to turn off the enable preview feature. The default value is true. 
• enable_windows_sidebar: Use this option to allow users to access iManage Drive applications from Microsoft Windows Explorer sidebar. The default value is true.

• enable_windows_ssl_context_adapter: Use this option to load certificates from a Microsoft Windows machine. The default value is true. 

  NOTE:

  This option is available from iManage Drive 10.8.0 or later. 

  
  

• extended_hydration_file_types_list: Allows the files to be available in iManage Drive for an extended time (24 hours). By default, the following file types are added to the admin setting: .aac, .aiff, .avi, .f4v, .flac, .flv, .html5, .m4a .mkv, .mov, .mp3, .mp4, .mp4a, .mpeg-2, .ogg, .sef, .wav, .webm, .wmv.

• frequency_to_reclaim_unused_encrypted_files: Time in minutes in which iManage Drive collects unused encrypted files stored locally. The default value is 1440 minutes (24 hours).

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

• language_options: In iManage Drive user interface, browse to > 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. This port is the port that applications will use to communicate with the iManage Drive. For example, Microsoft Windows Explorer communicates with iManage Drive to determine which overlay icons to show for files and folders. When set to 0, a dynamic port will be chosen. If the port is already ‌in use, we recommend that you use a different port. Example, local_rest_service_port: 8025. You can verify if a port is already in use, For more information, refer to the Verifying if a port is in use section.
  If you are enabling web extensions, the value provided in this configuration should match the imanage drive api port value in iManage Control Center. 
  
• log_encryption_type: Configure this setting to enable iManage Drive to tag and encrypt all the sensitive information in the log files. The default value is false and possible values are false, tag, or realtime. 
  • false: Disables tagging. 
  • tag: Specifies that sensitive strings should be wrapped with the tag <E>.</E>. When a diagnostic snapshot is generated, you can specify that the strings wrapped with tags should be converted to encrypted hashes.
  • realtime: Specifies that the sensitive strings should be converted to an encrypted hash.    

• log_file_backup_count: Specify the number of backup copies of log files. The default value is 9. 

• log_file_max_size: Specify the number of backup copies of log files and the maximum size of a log file before it is backed up. The default value is 10m, where m is megabytes. You must specify the size type following the number with either:

  • 'b' (bytes),

  • 'k' (kilobytes),

  • 'm' (megabytes), or

  • 'g' (gigabytes).

• 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: Sets 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 isn't available, all downloads pause and the application displays a message to free up disk space before the downloads can resume automatically. 

• maximum_folder_per_workspace: Specifies the number of folders that a workspace can contain for syncing. When users try to sync a workspace that contains more folders than the value specified, iManage Drive displays a notification in the Notification tab and doesn't sync the workspace. The default value is 10000.

• max_file_size: Specifies the file size that users can upload to the server. The default value is 4GB. Setting the value to 0 allows users to upload files without any limitations. You must specify the size type following the number with either:

  • 'b' (bytes),

  • 'k' (kilobytes),

  • 'm' (megabytes), or

  • 'g' (gigabytes).

• 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 isn't created. The default value is M. You can change it to 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.
• notify_new_workspace_synced: Specify whether users get a notification when iManage Drive starts syncing and finishes syncing a new workspace. 
• notify_new_workspace_synced_popup: Specify whether iManage Drive will popup displaying sync progress when a new workspace is synced.

• notify_on_emails_changed: Specify if notifications are displayed in iManage Drive whenever users modify emails.

• notify_workspace_removed_popup: Specify when iManage Drive will popup displaying unsync progress when a workspace is unsynced.

• notify_workspace_removed: Specify if notifications are displayed when a workspace is unsynced and when iManage Drive finishes unsyncing.

• notify_of_long_paths: Specify whether a notification is displayed when a long path file is updated.

• 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 haven't acted upon, that is, the interval at which the sync issues dialog box keeps reappearing until all sync issues are either resolved or acted 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 be refreshed at the interval specified (in seconds). For example, to refresh the content every 10 minutes, set the value to 600. This feature is turned off by default.

  NOTE:

  • If this option isn't set and users navigate within the Recent Matters or My Matters folder that hasn't 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.

• rename_work_server_urls: Set this configuration to enable users to connect to cloudimanage.com after a successful migration. When this setting is configured, iManage Drive will detect the change and then rename the iManage Work Server specified in from_work_server_url to the iManage Work Server specified in to_work_server_url. After successfully renaming the server, Manage Drive will ask the user to authenticate to the new iManage Work Server. When iManage Drive syncs it'll refresh any preexisting workspaces from the new iManage Work Server. With this change, users will get to view all their synced workspaces that were available before migrating to to cloudimanage.com. This configuration setting has two parts: 

  • from_work_server_url which represents the original server,

  • to_work_server_url which represents the new server.

    NOTE:

    • When using this setting, administrators should make sure:
      • That migration is complete. 
      • The old iManage Work Server is shut down.
      •  Usernames, library names, workspace IDs, document IDs, and folder IDs are the same on the new iManage Work Server. 
      • Users have the same access rights to libraries, workspaces, documents, and folders on the new iManage Work Server as the original server. 
      • The new iManage Work Server URL is listed in either the work_server_urls or extra_hosts configuration.  You can use either work_server_urls or extra_hosts, but not both. If work_server_urls is specified, then extra_hosts is ignored.
      •  iManage Drive versions is 10.9.0 or higher. 
    • The rename_work_server_urls should only be configured if there was a migration from the iManage Work Server specified in from_work_server_url to the iManage Work Server specified in to_work_server_url. 
    • There must only be a leading dash (-) for the from_work_server_url option. The to_work_server_url option shouldn't have a leading dash. There's one space indentation between the dash and the from_work_server_url option. The to_work_server_url option should have a two-space indentation and should align with the from_work_server_url option.

• 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 the maximum value is 500. 

• 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. When the user changes the sync frequency using the application UI, the value set here's ignored.
• sync_issues_show_in_front_timer: Set the timer in seconds, minutes, hours, or days to specify the window of time in which you'd like iManage Drive to have the Show Sync issues dialog box displayed to your users, once a sync conflict has been detected. The purpose of this is to periodically show the Show Sync issues dialog box in front of all the open windows. The default value is 1h. The letter following the value defines the time in seconds, minutes, hours, or days. For example:
  • One second is defined as 1s
  • One minute is defined as 1m
  • One hour is defined as 1h
  • One day is defined as 1d
• show_long_paths: Displays and hides Show Long Paths in Show sync issues. If set to true, the Show Long Paths button is displayed only if long paths are disabled in Microsoft Windows. Possible values are true, false, or force. The default value is true.
• time_before_alerting_sync_issues: Set a time interval after which a dialog box is displayed to the users indicating that iManage Drive isn't synced and there are items that require attention in the iManage Drive Outbox. The default value is 1d and this option can be turned off by setting the value to 0. The letter following the value defines the time in seconds, minutes, hours, or days. For example:
  • One second is defined as 1s
  • One minute is defined as 1m
  • One hour is defined as 1h
  • One day is defined as 1d
• 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. When this count is reached, no changes are 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 deletion removes all versions from iManage Work. The default value is 10.

  NOTE:

  To turn off sync confirmations, set the trigger_confirmation_change_count and trigger_confirmation_delete_count options to 0. Users can turn on 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 the 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.

• trigger_confirmation_folder_change_count: This option determines the number of 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.

• time_before_validating_checked_out_files: In some cases, like where users have unsynced a workspace or removed iManage Drive databases, it's possible that certain files are left locked, although they aren't opened by any user. In such cases, when time_before_validating_checked_out_files is set, for example to 1d, iManage Drive checks for files that are locked for 24 hours, and if they aren't opened by any user, it unlocks these files. The default value is 1d, which is a shorthand for "1 day". Users can use the following letters as duration formats: "s" which denotes "second(s)", "m" which denotes "minute(s)", and "d" which denotes "day(s)". 

• 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:

  • 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) in the Access iManage Drive Settings menu.
  • Additional tabs (Sync, Proxies, and Advanced) for the Access iManage Drive settings > Preferences option.
• web_extension_token: Use this setting to configure the token to be used with the web extension. If you:
  • don't set the value, the default token when configuring the web extension will be used which allows the web extensions to work.
  • set the value, make sure the token value matches the value specified in the imanage drive api token field in iManage Control Center. Make sure that the value is a randomly generated Universally Unique IdentifiersUUID). We recommend this as it's the most secure option. 
  • set the value to ignore, the token is turned off. Although the web extensions should work without any issues, we don't recommend that you set the value to ignore as this is the least secure option. 
• work_server_urls: Specify the URL of the iManage Work account(s) that you want to list in the Enter iManage Work URL field in the iManage Drive quick setup wizard and in the iManage Drive Accounts dialog box. In the earlier versions of iManage Drive, this admin setting was extra_hosts. Although the extra_hosts admin setting still works, we recommend that you use work_server_urls because we'll be deprecating the extra_hosts admin setting in a future release.

The following is a sample configuration file: