You can use a configuration file to customize some of the options in the IBM® Content Navigator for Microsoft Office interface. However, most of the options in the configuration
file can also be set at the desktop-level in the IBM Content Navigator administration tool.
Before you begin
Important: For an alternative method to customize the label and custom commands by using
desktop settings in the administration tool, see
Configuring desktops for Microsoft Office. The desktop
settings take precedence over configuration file settings. However, if no desktop settings are
specified, the configuration file settings are applied. If you configure the desktop settings, skip
this task.
It is highly advisable that you use the desktop settings rather than the configuration
file. Changes to the desktop settings are automatically picked up by IBM Content Navigator for Microsoft Office clients. Conversely, if you update the configuration file, you
must redistribute the configuration file to each IBM Content Navigator for Microsoft Office
client in your environment.
Procedure
To customize the IBM Content Navigator for Microsoft Office interface:
-
Install IBM Content Navigator for Microsoft Office.
-
Open the configuration.ini file in
a text editor.
The
configuration.ini file
is in the
IBM Content Navigator for Microsoft Office application
data directory:
- If you installed IBM Content Navigator for Microsoft Office for all users, the default
directory is C:\ProgramData\IBM\Content Navigator for Microsoft
Office.
- If you installed IBM Content Navigator for Microsoft Office for
the current user, the default directory is C:\Users\user_account\AppData\Roaming\IBM\Content
Navigator for Microsoft Office, where the user_account directory
is the current user.
-
If you plan to use a central configuration.ini file, specify values for
the following parameters:
| Option |
Description |
| BaseURL |
Required. Specify the URL by which you want users to access IBM Content Navigator from Microsoft Office. Do not include the
?desktop=desktop_name parameter in the URL.
The parameter
must have the format:
BaseURL=public_Content_Navigator_URL
|
| Desktop |
Optional. Specify the ID of the IBM Content Navigator desktop that
you want users to access from Microsoft Office.
If you do not specify a desktop ID, users are
directed to the default desktop.
The parameter must have the
format: Desktop=desktop_ID
|
| BaseURLReadOnly |
Optional. Specify whether you want the URL to IBM Content Navigator to be read-only.
By default, the BaseURLReadOnly parameter is set to
false.
|
| DesktopReadOnly |
Optional. Specify whether you want the IBM Content Navigator
desktop ID to be read-only.
By default, the DesktopReadOnly parameter is
set to false.
|
| AutoConnectMode |
Optional. Specify whether you want to enable IBM Content Navigator for Microsoft Office
to automatically connect to IBM Content Navigator.
The parameter must have the
format: AutoConnectMode=1 | 2
Valid
values include:
- 1
- For Kerberos single sign-on (SSO) deployments only. When users start Microsoft
Office, IBM Content Navigator for Microsoft Office automatically connects to IBM Content Navigator.
For example, if you set the AutoConnectMode to
1 in a Kerberos SSO deployment, when users start Microsoft Word, IBM Content Navigator for Microsoft Office starts the connection to IBM Content Navigator automatically. This setting enables users to automatically access IBM Content Navigator from Microsoft Word.
- 2
- This setting behaves differently depending on how users access their documents:
- If a user opens a Microsoft Office document from the IBM Content Navigator web client, Microsoft
Office opens and IBM Content Navigator for Microsoft Office starts the connection to IBM Content Navigator automatically.
- If a user opens a Microsoft Office document on their local file system and the document is
stored on the repository, IBM Content Navigator for Microsoft Office starts the connection to
IBM Content Navigator automatically.
If you configured a Kerberos SSO deployment, or if users are already logged in to IBM Content Navigator for Microsoft Office, users are not prompted to authenticate. Otherwise, users must
provide credentials in IBM Content Navigator for Microsoft Office before the connection to
IBM Content Navigator is completed.
|
| UseCMNameAttributeOnAddDoc |
Optional. IBM Content Manager
users only.
By default, when a user adds a document to the repository, and
the document was not saved on their local file system, the file is added to the repository according
to a generic name that is based on the item type.
- A Microsoft Word document is added with the file name Document1.doc.
- A Microsoft Excel spreadsheet is added with the file name Book1.xslx.
- A Microsoft PowerPoint presentation is added with the file name
Presentation1.ppt.
The UseCMNameAttributeOnAddDoc parameter enables
IBM Content Navigator for Microsoft Office to populate the name property according to the
Microsoft Office file naming convention. For example, if a user saves a Microsoft PowerPoint
document, Microsoft Office automatically uses the text from the title slide as the file
name.
Important: In the IBM Content Manager
repository, you must enable the Represents item option. The option must be
enabled on a property in the class that is used for the document. Otherwise, the document is added
to the repository with a generic name.
By default, the
UseCMNameAttributeOnAddDoc parameter is set to
false.
Valid vales include:
- true
- When users add an unsaved document to the repository, IBM Content Navigator for Microsoft Office populates the name property according to the Microsoft Office
file naming convention.
- false
- When users add an unsaved document to the repository, IBM Content Navigator for Microsoft Office populates the name property according to a generic name for the
item type.
|
| ProxyURL |
Optional.
Specify
the URL of the proxy server by which you want users to access IBM Content Navigator from Microsoft Office.
Restriction: You can
specify only a proxy server that does not require authentication.
The parameter must have
the format:
ProxyURL=hostname:port
|
| UseSSO |
Set to true to enable SAML SSO. This action is not necessary for Kerberos SSO.
|
| DocumentPath |
Use this setting to control the path that is used when opening documents. By default,
IBM Content Navigator for Microsoft Office uses the same path that is used by Microsoft office,
typically the My documents folder. Modify this setting to use a different path, other than the
Microsoft Office default. Set the value to a specific path, or use pre-defined tokens for certain
Windows paths:
%HOME% for the home dir (ex. c:\users\administrator)
%MYDOCUMENTS% for my documents (c:\users\administrator\documents)
%[Env var]% a specified environment variable (ex: %APPDATA%)
You can also append or
add a prefix to values as shown in the following example:
DocumentPath=C:\Temp
DocumentPath=%HOME%
DocumentPath=%MYDOCUMENTS%
DocumentPath=%HOME%\Extra Path\%USERNAME%
DocumentPath=C:\Temp\%USERNAME%
|
-
Specify any optional parameters for your environment.
Remember: It is recommended that you configure these parameters from the IBM Content Navigator administration tool rather than in the
configuration.ini file. By default, these parameters are not included in the
configuration.ini file for IBM Content Navigator, Version 2.0.3 or higher.
-
To change the label that is displayed for IBM Content Navigator for Microsoft Office, you can change the
value of the IBMECMTabLabel parameter:
IBMECMTabLabel=Custom toolbar label
-
To add a custom action to IBM Content Navigator for Microsoft Office, modify the following
entries in the configuration.ini file:
- To specify the label of the custom action, enter a value for the
CustomCommand1Name parameter and remove the number sign (#) from the beginning
of the
line:
CustomCommand1Name=Command label
- To specify the URL target of the custom action, enter a value for the
CustomCommand1URL parameter and remove the number sign (#) from the beginning
of the
line:
CustomCommand1URL=Target URL
- To specify the icon of the custom action, enter the fully qualified path of an icon file, such
as a local file, for the CustomCommand1Icon parameter. Remove the number sign
(#) from the beginning of the
line:
CustomCommand1Icon=Fully qualified location of the icon file
You can create up to four custom actions. To create more custom actions, copy the custom action
parameters and increment the number in the parameter. For example, to create a second custom action,
enter the following information in the
configuration.ini file:
CustomCommand2Name=Command label
CustomCommand2URL=Target URL
CustomCommand2Icon=Fully qualified location of the icon file
What to do next
To customize the
IBM Content Navigator for Microsoft Office clients
in your environment, take one of the following actions:
- Add the configuration.ini file to a shared
directory or mapped network directory and then specify the location
of the configuration file when you run a silent installation. For
more information, see Installing IBM Content Navigator for Microsoft Office silently.
- Update the configuration.ini file on each
client. To update the configuration.ini file,
take one of the following actions:
- Silently push the updated file to the client.
- Create a batch executable file that updates the file on the client
and instruct your users to download the executable file from a URL.
- Instruct your users to download the updated file and replace the
existing file on their client.