Configuring the Edit Service client for IBM Content Navigator
If you use IBM® Content Navigator with IBM FileNet® P8 and IBM Content Manager repositories, you can install the Edit Service client on users' workstations. Then, users can easily add files or edit files in the local apps that are installed on their computers.
Before you begin
The IBM Content Navigator web client communicates with the Edit Service
client through localhost.ibm.net
, a global domain name server that points to
127.0.0.1
.
- Configure your own DNS server with to point
localhost.ibm.net
to127.0.0.1
. - Configure the hosts file on each client workstation to include the following entry,
127.0.0.1 localhost.ibm.net
The Edit Service client stores temporary files and data files in the %TEMP%\IBM Content Navigator Edit\ and %APPDATA%\IBM Content Navigator Edit\ directory. Ensure that the user has write access to the files.
About this task
By default, the Edit Service client includes support for Microsoft Office documents. However, you can configure the Edit Service client to support other document types, such as PDF or HTML files.
When you use the Edit Service client on Mac OS and Windows, SAML SSO and Kerberos and SPNEGO SSO are supported.
- Creating and adding new documents to the repository.
When the Edit Service client is enabled, a user can click New and select the type of file that they want to create. The file is added to the repository, checked out, and opened in the appropriate application on the user's workstation. Also, when the user saves their changes, the changes are checked into the repository.
- Saving changes that are made in native desktop applications to the repository.
When the Edit Service client is enabled and a user clicks
, the file is checked out and opened in the appropriate application on their workstation. Also, when the user saves their changes, the changes are saved or checked into the repository.
Note:
- Open the repository configuration in the IBM Content Navigator administration tool.
- Click the Edit Integration tab.
- In the Class and Role Settings section, select the classes that are used with Edit Service client for IBM Content Manager.
- In the Class and Role Settings section, specify the groups or roles who can use the Edit Service client templates and the draft items.
- Save your changes to the repository configuration.
Procedure
To integrate IBM Content Navigator with user desktop applications:
Disabling automatic validation of IBM Content Navigator server SSL certificate for the Edit Service client
About this task
- Windows: In the default installation directory, C:\Program Files (x86)\IBM\IBM Content Navigator Edit\EditClient\, open the IBM Content Navigator Edit.exe.config file and change the SSL parameter from True to False.
- Mac: In the default directory, /Users/%username%/Library/Application Support/IBM Content Navigator Edit, open the IBMContentNavigatorConfiguration.plist file and change the Validate SSL Certificate parameter from True to False.
Configuring the Edit Service client for an SSO environment
About this task
- Option 1
- Click the Edit Service client application icon, and then select Use Single Sign-On from the menu.
- Option 2
- (Windows Edit Service client only) Modify the IBM Content Navigator
Edit.exe.config file and change the isSSO parameter from
False to True. The default path is:
C:\Program Files (x86)\IBM\IBM Content Navigator Edit\EditClient\. Restart the
Windows Edit Service client.Note:
- If you choose option 2, then Use Single Sign-On is disabled in the menu. When the isSSO parameter is changed from True to False, Use Single Sign-On is enabled and active.
- These options apply only to special cases that need to do the authentication for the Edit
Service client in IBM Content Navigator. The following items are special cases.
- A custom Identity Provider (IdP) server is used, which applies a token exchange mechanism during authentication.
- When the Edit Service client is started after the user already authenticated IBM Content Navigator from the browser. In this situation, the user needs to refresh the browser page to allow the web to send the authentication token to the Edit client again. If the user does not refresh the browser, the Edit client resorts to the previous method of authentication and opens an authentication window.
- A custom certificate is used and the password for the custom certificate is stored in the IBM Content Navigator database. In this case, the Edit client needs to retrieve the custom certificate password from the IBM Content Navigator database upon launch. This retrieval process requires authentication.
- A user has unsaved document changes to the local workstation that results from a lost network connection or from other reasons. The network becomes online and tries to upload the unsaved changes.
Customizing the Edit client URL
About this task
You can configure an Edit client custom URL in the administration desktop by enabling the Edit Service custom URL, and then entering the same hostname with your custom SSL certificate. Following are the detailed steps.
- The first approach. Save the custom certificate password in the Content
Navigator database.
- When you enable the Edit Service custom URL in the administration desktop, enter the custom certificate password into Custom Certificate Password.
- Copy the certificate to the Edit client's installation directory: ...\IBM Content Navigator Edit\EditClient\.
- Open and modify the IBM Content Navigator Edit.exe.config file, which is in the installation directory: ...\IBM Content Navigator Edit\EditClient\. Change the certificate name to the name of your custom certificate. Update ServerURL and UserID with your IBM Content Navigator server URL and user ID.
- Restart the Edit client.
- The second approach. Enable the custom certificate password through Edit client plug-in.
- Retrieve the EditCustomURLPlugin source code from Windows Edit Client build file and open it with Visual Studio IDE. Change the variable CertPassword value to the certificate's password in the file CustomURLPlugin.cs. Recompile the project EditCustomURLPlugin to generate the DLL file with Visual Studio IDE.
- Copy the EditCustomURLPlugin.dll file to the Edit client's installation directory: ....\IBM Content Navigator Edit\EditClient\Plugins\.
- Copy the certificate to the Edit client's installation directory: ...\IBM Content Navigator Edit\EditClient\.
- Open and modify the IBM Content Navigator Edit.exe.config file, which is under the installation directory: ...\IBM Content Navigator Edit\EditClient\. Change the certificate name to the name of your custom certificate. Update the DefaultCustomURLPlugin value if you have a different plug-in name.
- Restart the Edit client.
- Retrieve the EditCustomURLPlugin source code from the Mac Edit Client build file. Open the code with Xcode IDE, and then change the variable certPassword value to the certificate's password in the CustomURLPlugin.m file. Clean and build the project CustomURLPlugin to generate the plug-in file with Xcode IDE.
- Copy the CustomURLPlugin.plugin file to the Mac Edit client's configuration directory: /Users/%username%/Library/Application Support/IBM Content Navigator Edit/Plugins/.
- Copy the custom certificate to the Edit client's configuration directory: /Users/%username%/Library/Application Support/IBM Content Navigator Edit/.
- Open and modify the IBMContentNavigatorConfiguration.plist file, which is under the configuration directory: /Users/%username%/Library/Application Support/IBM Content Navigator Edit/. Change the CertificateName value to the name of your custom certificate. Update the DefaultCustomURLPlugin value if you have a different plug-in name.
- Restart the Edit client.
Configuring the Edit Service client to list Content Navigator hosts that can access the Edit client
About this task
To configure your Edit Client with the Content Navigator host list, complete the following steps.
- Edit the IBM Content Navigator Edit.exe.config configuration file and add
the CORSSites property with the list of hosts that are allowed to access the
Edit Service client. The value can be *, which allows all hosts. You can list
several hosts that are separated by commas and no spaces. Examples:
- To allow all Content Navigator hosts, enter
<setting name="CORSSites" serializeAs="String"> <value>*</value></setting>
- To allow a limited set of Content Navigator hosts, enter
<setting name="CORSSites" serializeAs="String"> <value>http://icnserver1:port,https://icnserver1:port,https://icnserver2:port</value></setting>
Note: If you have a host that is defined as http(s)://icnserver:port/navigator, set the URL as http(s)://icnserver:port.
- To allow all Content Navigator hosts, enter
- Restart the Edit Service client. Click IBM Content Navigator Edit.exe.
- From one of the allowed Content Navigator hosts, edit a document. Go to .
In the Response Headers, the Access Control Allow Origin: displays the Content Navigator host URL that you are using for your document edits. If the Access Control Allow Origin: displays an *, then any Content Navigator host URL is allowed to edit documents. If an * is not displayed or if the host is not listed in the CORSSite property, the edit request is rejected by the Edit Service client, and an error message is posted.