imWorkOptions.xml

You can edit the imWorkOptions.xml file to customize the user experience of the iManage Work integration with Microsoft Word, Excel, PowerPoint, Visio, and MS Project. For example, you can customize the iManage Work dialog boxes, the footer format of iManage Work files created using Microsoft Word, iManage Work file caption format, and so on.

You can use the following keys and options for customization:

Option

Description

General Options

iwAdditionalHelpLanguages

Specifies other languages for which help is available, other than the base set of languages.

Default value: Empty

Example:
<key name="iwAdditionalHelpLanguages" value="zh"/>

iwFilePickerLocale

Specifies the country-region code to be used when displaying File Selection and File Save dialog boxes.

NOTE:

The value must be a valid Microsoft language or country-region code. If no value is specified, the configured UI language for Windows is applied.

Default value: Empty

Example:

<key name="iwFilePickerLocale" value="ES"/>

IntegratedProcesses

Specifies other third-party applications that should be treated as integrated applications.

Example:

<key name="IntegratedProcesses" value="NuancePDF"/>

iManage.Import.DocClass

Specifies the default document class when saving files to iManage Work as a new document.

NOTE:

  • This option is applicable only for saving new documents not for new versions.

  • The default doc class and default email class are no longer read from the default classes configured for the server. These two values will be read only from the imWorkOptions.xml file.

  • If the iManage.Import.DocClass and iManage.Import.EmailClass options are missing in the file, "DOC" is used as the default document class and "E-MAIL" is used as the default email class.

Default value: DOC

Example:

<key name="iManage.Import.DocClass" value="DOC"/>

If the default document class is left blank, that is, the value string is empty, a blank Class field in the iManage Save dialog box and users are prompted to enter a document class when saving documents.

iManage.Import.EmailClass

Specifies the default email class when saving emails to iManage Work as a new document or new version.

Default value: Email

Example:

<key name="iManage.Import.EmailClass" value="E-Mail"/>

FileSave

Used to map the Microsoft Office's File->Save (idMso) command to a predefined iManage Work command ID, for example, "iManage.WorkSiteSavenSync". By mapping to the "iManage.WorkSiteSavenSync" command, you can save edits to iManage Work when the File->Save operation is performed.

Default value: Empty

NOTE:

This setting is intended for Citrix users.

Example:

<key name="FileSave" value="iManage.WorkSiteSavenSync"/>

ValidateCheckoutLocation

Used to validate the checked out file's location against the logged in user's current machine.

Default value: Y

If this value is set as N, only the file's checkout path is validated during check-in.

NOTE:

For users using a multi-user environment like Citrix, the value should be set to N.

Example:

<key name="ValidateCheckoutLocation" value="Y"/>

iwOnlyKeepLatestVersionatLocal

Ensures that only one version of the file is kept in the "Recent" directory. By default, whenever you save the document as a new version, the previous version of the document will be deleted from your local directory. Valid values: "Y" or "N"; "true" or "false".

Default value: Y

Example:

<key name="iwOnlyKeepLatestVersionatLocal" value="Y"/>

footer

Includes the following keys:

  • iwFooterFormat: Specifies the format of the document footer. It uses the members of the WSProfileAttributeID enumeration, with "{" and "}" around them.

  • AutoInsert: Specifies whether you want to automatically insert the iManage document profile information into the footer. The auto insert operation is triggered when a new version or a new copy of the document is saved to iManage Work.

Default value: As specified in the example

Example:

<ws_option name="footer" applyToAll="true">
<key name="iwFooterFormat" value="#{imProfileDocNum}v{imProfileVersion}<{imProfileDatabase}> - {imProfileDescription}" />
<key name="AutoInsert" value="N" />
</ws_option>

To ensure that the footer is inserted automatically a document is saved to iManage Work, set the value of the AutoInsert key to Y. If the automatic insertion of footers feature is enabled, the iManage footer replaces any existing custom footer in documents.

NOTE:

  • The iwFooterFormat key has been moved from the common section to the footer section. Uncomment the footer section to enable the settings included in it.

  • An advanced footer integration can be achieved by writing your own custom Microsoft Office plugin, for example, to allow merging of the iManage footer with your existing custom footers. For more information refer to the Plugins for iManage Work Desktop for Windows section in iManage Work Desktop for Windows SDK Guide 10.1.1.

  • For the list of the members of the WSProfileAttributeID enumeration that is used in the iwFooterFormat key and the other keys mentioned in the following text, see Appendix C - WSProfileAttributeID enumerators.

iwFileCaptionFormat

Specifies the document caption format in the Microsoft Office applications: Word, Excel, and PowerPoint. The value can be combined with other text or characters. It uses the members of the WSProfileAttributeID enumeration, with "{" and "}" around them.

Default value: #{imProfileDocNum}v{imProfileVersion}<{imProfileDatabase}> - {imProfileDescription}

Example:

<key name="iwFileCaptionFormat" value="#{imProfileDocNum}v{imProfileVersion}<{imProfileDatabase}> - {imProfileDescription}" />

iwFileNameSizeFormat

Formats the file name and size information when sending emails using the MailTemplate.oft file. It uses the members of the WSProfileAttributeID enumeration, with "{" and "}" around them.

Default value: {imProfileDescription}.{imProfileExtension} ({imProfileSize})

Example:

<key name="iwFileNameSizeFormat" value="{imProfileDescription}.{imProfileExtension} ({imProfileSize})" />

iwAttachmentFileNameFormat

Formats the file name information when sending it as an email attachment.

Default value: {imProfileDescription}({imProfileDocNum}.{imProfileVersion}.{imProfileExtension})

Example:

<key name="iwAttachmentFileNameFormat" value="{imProfileDescription}({imProfileDatabase}.{imProfileDocNum}.{imProfileVersion}.{imProfileExtension})" />

iwPurgeRecentAgeThreshold

Whenever you open a file from iManage Work using the iManage Work Desktop for Windows application, a copy of the file is downloaded to the %AppData%\Roaming\iManage\Work\Recent folder. Unless deleted manually, the files remained in the folder. To prevent files from accumulating and unnecessarily increasing hard disk space usage and to prevent the risk of accidentally deleting files that were taken offline, the Purge feature automatically removes files that are older than a configurable number of days from the Recent folder.

Default value: As specified in the example

Minimum value: 1

<key name="iwPurgeRecentAgeThreshold" value ="30"/>

NOTE:

  • System or hidden files, such as, .ini, .prf, and .cmt are not purged.

  • iManage files that are checked out, modified offline, or newly created offline are excluded.

  • Purged files are moved to the local recycle bin instead of being permanently deleted.

iwAllowIWLCallsFromSpecifiedBrowsers

This option can be used to control which web browsers are allowed to make direct iwl:// calls. Microsoft Edge is enabled by default. This is for the integration between the browser and the iManage Work Desktop for Windows to function. Other browsers do not require this support and hence are disabled by default. Disabling this functionality when not required is advised for security reasons.

This is a comma delimited list of browser names. Possible names are: edge, firefox, chrome, i explore, and opera.

Default value: edge

Example:

<key name="iwAllowIWLCallsFromSpecifiedBrowsers" value ="edge"/>

iwLegacyFilePostConvertionAction


This option saves the Microsoft Office documents converted from legacy formats to the latest file formats to the iManage Work Server and replaces the legacy document with the latest format automatically.

This option is enabled by default and can be disabled by setting the value to -1.

Default value:0

Example:

<key name="iwLegacyFilePostConvertionAction" value ="0"/>

NOTE:

If this option is disabled, the converted file format will not be uploaded to the server and the changes will exist only locally. If the file is not saved to the server, the file in the Recent directory can get corrupted even if the same user tries to download the file again.


backstageView

This option is available only when CacheObjects is set to "Y" and enhances the performance on loading the items shown on the backstage when performing file open and save action. It also loads the recent documents and folders in a background tasks once the server is connected.

“AutoUpdateView” option is disabled by default and users can manually refresh the backstage view. If this option is enabled, every time a file is opened (checked-out) or closed (checked-in or unlocked), the backstage view should be updated with the latest changes.

Example:

<ws_option name="backstageView"> <key name="CacheObjects" value="Y"/>
<key name="AutoUpdateView" value="N"/>
</ws_option>

webdownload

Includes the following keys:

  • WebDownloadFileFormat: The file downloaded locally will have its name in the following format: {imProfileDescription}.{imProfileExtension}.

  • WebDownloadVersionFormat: When multiple versions of the same document are downloaded, their name will be formatted as {imProfileDescription}(v{imProfileVersion}).{imProfileExtension}, by default.

  • WebDownloadPath: Specify a folder where the iManage files will be downloaded to. By default, the location will be the current user's Downloads directory. User can also specify a windows directory which may or may not exist locally. For example, <key name="WebDownloadPath" value = @"C:\iMAN" />. If the value is blank, that is, value = "", user will be prompted to choose a folder.

  • WebDownloadAlwaysLatest: This option's default value is "N". If this value is set as "Y", user will not be prompted to select the latest version, and the latest version will be downloaded automatically

Example:

<ws_option name="webdownload">
<key name="WebDownloadFileFormat" value="{imProfileDescription}.{imProfileExtension}"/> <key name="WebDownloadVersionFormat" value="{imProfileDescription}(v{imProfileVersion}).{imProfileExtension}"/> <key name="WebDownloadPath" value="" /> <key name="WebDownloadAlwaysLatest" value="N"/> </ws_option>

Microsoft Office Backstage view keys

In the Backstage view, the document details string is displayed using the two keys as follows:

"iwBackstageFileFormatSection1" + " " + "iwBackstageFileFormatSection2"

iwBackstageFileFormatSection1

Used for displaying the first part of the document details string in the Backstage view. It uses the members of the WSProfileAttributeID enumeration, with "{" and "}" around them.

Default value: {imProfileDescription}.{imProfileExtension}

Example:

<key name="iwBackstageFileFormatSection1" value="{imProfileDescription}.{imProfileExtension}"/>

images/download/attachments/78848905/Part1-Screen_Shot.png

iwBackstageFileFormatSection2

Used for displaying the second part of the document details string in the Backstage view. It uses the members of the WSProfileAttributeID enumeration, with "{" and "}" around them.

Default value: | v{imProfileVersion} | #{imProfileDocNum} | {imProfileAuthor} | {imProfileEditDate} | {imProfileSize}

Example:

<key name="iwBackstageFileFormatSection2" value="| v{imProfileVersion} | #{imProfileDocNum} | {imProfileAuthor} | {imProfileEditDate} | {imProfileSize}"/>

images/download/attachments/78848905/Part2-Screen_Shot.png

iwFileShortcutFormat

Used for displaying the shortcut of files under My Favorites in the Backstage view; the default value will be the description only. It uses the members of the WSProfileAttributeID enumeration, with "{" and "}" around them.

Default value: {imProfileDescription}

Example:

<key name="iwFileShortcutFormat" value="{imProfileDescription}"/>

iwFileShortcutDescriptionFormat

Used for displaying a shortcut document's target information. The same string can also be found in iwAddinExtensionRes.dll. It uses the members of the WSProfileAttributeID enumeration, with "{" and "}" around them.

Default value: Shortcut to document {imProfileDocNum} in library {imProfileDatabase}

Example:

<key name="iwFileShortcutDescriptionFormat" value="Shortcut to document {imProfileDocNum} in library {imProfileDatabase}"/>

images/download/attachments/78848905/Screen_Shot_2017-11-28_at_4.44.30_PM.png

iwUseFileName4NewVersion

Sets the new document version's description field based on the local file name, instead of using the description of the existing version.

Valid values: "Y" or "N"; "true" or "false"

Default value: N

Example:

<key name="iwUseFileName4NewVersion" value ="N"/>

iManage Work Agent options

workagent

Helps in monitoring the progress of background tasks, for example, printing, check-in, checkout, and so on.

Includes the following keys:

  • CountThreshold keys: Automatically cleans up old notifications from iManage Work Agent when the specified number is reached.

  • AgeThreshold options: Automatically cleans up old notifications from iManage Work Agent after the specified number of days.

  • NonIntegratedProcesses: Includes a comma-separated list of non-integrated applications that cannot lock the file while editing.

  • RestrictOriginsToRegisteredServers: When enabled, iwl calls through localhost are accepted from the URLs for the user's registered servers. Default is "N" (no restriction).

  • AllowedOrigins: A comma-separated whitelist of additional origins (server URLs) allowed to invoke IWLs through localhost. When not configured, there are no restrictions.

  • HideAgentAutoUpdateMenu: When enabled, Auto Updates-related menu options in the Work Agent are not visible to your end-users.

    NOTE:

    • The HideAgentAutoUpdateMenu registry setting in the HKEY_CURRENT_USER\Software\iManage\Work\10.0\Client hive is overwritten by this configuration.

    • The changed setting applies 1 minute after the Work Agent is restarted or 30 minutes after the option is changed in the configuration file.

Example:

<ws_option name="workagent" applyToAll="true">
<key name="NotificationCountThreshold" value="50"/>
<key name="NotificationAgeThreshold" value="7"/>
<key name="AttentionCountThreshold" value="50"/>
<key name="AttentionAgeThreshold" value="7"/>
<key name="NonIntegratedProcesses" value="notepad"/>
<key name="RestrictOriginsToRegisteredServers" value="N"/>
<key name="AllowedOrigins" value=""/>
<key name="HideAgentAutoUpdateMenu" value="N"/>
</ws_option>

Notifications for checked-out files

iwCheckoutOverdueAgeThreshold

iManage Work Desktop for Windows reminds users that they have documents checked out that they need to check in. By default, users see iManage Agent notifications if documents are left checked out for more than six hours.

Specify the number of hours after which the user is reminded if documents remain checked out.

Default value: 6

Example:

<key name="iwCheckoutOverdueAgeThreshold" value="6"/>

NOTE: Ensure that the value is not 0. This setting can be enabled or disabled using the following key: <key name="iwUseCheckoutOverdueReminder" value="Y"/>

iwUseCheckoutOverdueReminder

Enable or disable the reminder that warns the user about the documents that remain checked out.

Valid values: "Y" or "N"

Default value: Y

Example:

<key name="iwUseCheckoutOverdueReminder" value="Y"/>

iwDocCloseReminderTimeOfDay

Specify the time of the day when the user is reminded to close the checked out documents. For example, if the user generally leaves office at 6.30 pm, change the default time to 18:30.

Valid values: hour:minute (24-hour format)

Default value: 16.30

Example:

<key name="iwDocCloseReminderTimeOfDay" value="16:30"/>

iwDocCloseReminderSnoozeDuration

Specify the duration in minutes after which the close documents reminder reappears if the user closes it.

Value range: 5-30

Default value: 10

Example:

<key name="iwDocCloseReminderSnoozeDuration" value="10"/>

iwDocCloseReminderMaxSnoozeNum

Specify the number of times the close documents reminder appears before being dismissed for the day.

Value range: 1-10

Default value: 3

Example:

<key name="iwDocCloseReminderMaxSnoozeNum" value="3"/>

iwUseDocCloseReminder

Enable or disable the reminder that warns the user to close the document that remain checked out after the specified time of the day.

Valid values: "Y" or "N"

Default value: N

Example:

<key name="iwUseDocCloseReminder" value="N"/>

Additional options

DefaultOpen

Includes a list of actions available in the iManage Work Open dialog box. You can modify them using the following keys. You can set the values of these keys to any desired string. For example, the iwAttemptOpen key can be set to "Open My Document".

Default value: As specified in the example.

Example:

<ws_option name="DefaultOpen" applyToAll="false" >
<key name="iwAttemptOpen" value="Open" />
<key name="iwAttemptOpenReadOnly" value="Open Read-Only" />
<key name="iwAttemptOpenasCopy" value="Open as Copy" />
<key name="iwAttemptOpeninProtected" value="Open in Protected View" />
</ws_option>

Default options:

images/download/thumbnails/78848905/Screen_Shot_2017-11-28_at_4.48.30_PM.png

After setting the iwAttemptOpen key to "Open My Document":

images/download/thumbnails/78848905/Screen_Shot_2017-11-28_at_4.55.01_PM.png

documentLinkCommands

The following keys provide the default options in the iManage Work Browse dialog box to insert the selected document as a hyperlink (IWL link). The first option inserts the link to the latest version of the selected document, and the second option inserts
the link to the current version of the document. You can set the values of these keys to any desired string. For example, the "iwAttemptInsertLink2Latest" key can be set to "My Latest Document".

Default value: As specified in the example

Example:

<ws_option name="documentLinkCommands" applyToAll="false" >
<key name="iwAttemptInsertLink2Latest" value="Latest" />
<key name="iwAttemptInsertLink2ThisVersion" value="This Version" />
</ws_option>

audit

Determines whether or not to enable and log the audit history events related to the Print operation.

Default value: As specified in the example

Example:

<ws_option name ="audit">
<key name="EnableAuditWordPrint" value="Y"/>
<key name="EnableAuditExcelPrint" value="Y"/>
<key name="EnableAuditPowerPointPrint" value="Y"/>
<key name="EnableAuditProjectPrint" value="Y"/>
<key name="AuditWordPrintPages" value="IWEnumAuditPrintPageType.All"/>
<key name="AuditExcelPrintPages" value="IWEnumAuditPrintPageType.None"/>
<key name="AuditPowerPointPrintPages" value="IWEnumPrintType.None"/>
</ws_option>

integration

Define the options used by iManage Work Desktop for Windows for the integration with Microsoft Office.

OpenFilders: OpenFilters are used to retrieve the files by the specific types.

NOTE:

If the value of WordDocumentOpenFilter, ExcelDocumentOpenFilter, PowerPointDocumentOpenFilter, VisioDocumentOpenFilter or ProjectDocumentOpenFilter enabled, make sure the string — for example, All Word Documents, would work for your current UI specific language.

PassiveMode: iManage Work Desktop for Windows supports passive integration mode with Microsoft Office. If PassiveMode setting is "Y", upon creating a new document, iManage Work Desktop for Windows will not try to take over the build-in operations unless it is an iManage file. Ribbon buttons do not need to be remapped in this mode and the functionality of the Open and Save operations remain unchanged.

Default value: N

IntegratedProcesses: iManage Work Windows for Desktop has a hard-coded list of integrated applications like Microsoft Offce and Adobe and this option extends the list. Integrated processes are expected to check-in documents on their own when the document is closed. The value is the process names separated by comma.

Default value: empty string

InsertiManageField: If this setting is "Y", when focus is in the iManage file's header or footer, user can select a predefined profile field to be inserted into the document.

NOTE:

This is no longer needed in Work Desktop for Windows 10.2.5 or later. The feature is enabled by specifying an iwFirmID.

Default value: N

ReopeniManDriveFile: This switch enables compatibility with iManage Drive. When enabled and a document is opened from iManage Drive, actions in the iManage ribbon in Microsoft Office, such as Save as New Version are enabled.

Default value: N

Example:

<ws_option name="integration"> <key name="PassiveMode" value="N"/> <key name="InsertiManageField" value="N"/>
<key name="ReopeniManDriveFile" value="N" /> </ws_option>

iwReEnabledAddinOption

Determines the automatic re-enabling behavior for the disabled iManage add-ins for Microsoft Outlook, Word, PowerPoint, Excel, Visio, and MS Project when you launch the applications the next time.

Example:

Valid values:

0: Add-ins are automatically enabled and an iManage Work Agent notification is displayed the next time the user launches the applications.

1: Add-ins not enabled automatically and users can manually enable them as desired.

2: iManage Work Agent prompts the user to enable the add-in the next time the user launches an integrated application. If the user selects Yes, the Agent displays a notification that the add-in is enabled.

Default value: 0

Example:

<key name="iwReEnabledAddinOption" value ="0"/>

adobeconversion

Enables users to choose the Adobe convertor for saving documents as PDFs to iManage Work using the iManage > Save as PDF option in integrated Microsoft Office applications.

Valid values: "Y" or "N"

Default value: N

Example:

<ws_option name="adobeconversion" applyToAll="true">
<key name="Enabled" value="N"/>
</ws_option>

shellexecute

Enables you to reduce security vulnerability by blacklisting certain file types to prevent users from opening or printing these files using iManage Work Desktop for Windows or the iManage Work web client.

NOTE:

Certain file types are already hardcoded in the application to block them from using the ShellExecute function in Windows for example, executables and JavaScript files. As a result, users cannot open or print these type of files.

Valid values: File extensions in the lowercase separated by commas. For example, if you do not want rich text format and text files to be printed, change the value to "txt, rtf".

Default value: Empty

Example:

<ws_option name="shellexecute">
<key name="blacklist" value=""/>
</ws_option>

coauthoring

For more information, refer to the Customizing the User Experience in Office Applications section in iManage Work Co-Authoring Guide 10.2.

excel

Keys under this option can be used to resolve a currency format issue in Microsoft Excel. By default, the keys are not enabled.

NOTE:

This workaround causes the WorkbookBeforeSave and WorkbookAfterSave events to trigger twice when you try to save the workbook using the Microsoft Excel object model.

<ws_option name="excel">
<key name="EnableEventsWhenEmbedded" value="N"/>
<key name="EnableResaveWithLocale" value="N" />
</ws_option>

Inserting document information fields (in the footer area of Microsoft Word)

iwFirmID

The value for this key is a unique identifier for that company (usually the firm ID). When enabled, it allows iManage profile fields to be manually inserted in the footer of a Microsoft Word document. The inserted fields are linked to the value specified.

NOTE:

  • The value enables a field drop-down with the header and footer ribbon.

  • It applies only to footer in the Microsoft Word document.

  • Document properties can be inserted without replacing the existing information. For more information refer to the Inserting document information fields section in the iManage Work Desktop for Windows User Guide.

  • The property fields inserted are bound to the document metadata as it is specified in your own document management system (DMS). If your document is imported into a DMS belonging to another firm or company, your document metadata will remain in the document, and is not replaced by the document metadata of the new firm or company's DMS to which it is imported.

Valid values: English language characters. This has a character limit of 15.

<key name="iwFirmID" value=""/>

List of default fields available to add to the footer in Microsoft Word when the feature is enabled are specified below. The field names are specified in the value enclosed by curly braces.

These are available under <ws_option name="iManFields">.

  • <key name="iManage.Field.Database" value="{imProfileDatabase}"/>

  • <key name="iManage.Field.DocNum" value="{imProfileDocNum}"/>

  • <key name="iManage.Field.Version" value="{imProfileVersion}" />

  • <key name="iManage.Field.Description" value="{imProfileDescription}"/>

  • <key name="iManage.Field.Author" value="{imProfileAuthor}"/>

  • <key name="iManage.Field.Operator" value="{imProfileOperator}"/>

  • <key name="iManage.Field.Custom1" value="{imProfileCustom1}"/>

  • <key name="iManage.Field.Custom1Description" value="{imProfileCustom1Description}"/>

  • <key name="iManage.Field.Custom2" value="{imProfileCustom2}"/>

  • <key name="iManage.Field.Custom2Description" value="{imProfileCustom2Description}"/>

  • <key name="iManage.Field.EditDate" value="{imProfileEditDate}"/>

You can add fields by adding the value to a key in the same syntax.

For example, to add the imProfileDatabase field, enter imProfileDatabase as the value with the appropriate key name, under <ws_option name="iManFields">.

<key name="iManage.Profile.Database" value="{imProfileDatabase}"/>

See Appendix C - WSProfileAttributeID Enumerators for a complete list of fields.

Deprecated option

The InsertiManageField option that was introduced in iManage Work Desktop for Windows 10.2.4 for inserting custom fields in the footer in Microsoft Word documents is deprecated. This feature can now be enabled just by entering a firm name or ID using the iwFirmID option.