IBM CMIS For Content Manager OnDemand For Dummies
IBM CMIS For Content Manager OnDemand For Dummies
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 2
Filing ................................................................................................................................................................................. 53
Versioning ........................................................................................................................................................................ 53
CMIS Folder ...................................................................................................................................................................... 54
Paging ............................................................................................................................................................................... 54
Full text search ................................................................................................................................................................. 54
Query limitations .............................................................................................................................................................. 54
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 3
IBM Content Navigator, Version 2.0.2 Fix Pack 1 includes support for IBM Content Management Interoperability Services for
Content Manager OnDemand (IBM CMIS).
The OASIS CMIS standard enables client applications to work with multiple content management systems by defining a
standard domain model and standard set of services and protocol bindings for Web Services and RESTful Atom Publishing
Protocol (AtomPub). IBM CMIS for Content Manager OnDemand is the implementation of the OASIS CMIS standard for IBM
Content Manager OnDemand.
IBM CMIS for Content Manager OnDemand provides a read-only subset of CMIS functions. With it users can:
The following diagram shows how IBM CMIS for Content Manager OnDemand connects to your IBM Content Manager
OnDemand and your client application.
IBM CMIS for Content Manager OnDemand communicates with IBM Content Manager OnDemand by using the Content
Manager OnDemand Web Enablement Kit (ODWEK) Java API. You must install ODWEK on the machine where IBM CMIS for
Content Manager OnDemand will be deployed.
IBM CMIS for Content Manager OnDemand and other CMIS-enabled enterprise content management systems
communicate with client applications by using REST and Web Services bindings.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 4
Planning for IBM CMIS for Content Manager OnDemand
Use the information in this section to plan your IBM CMIS for Content Manager OnDemand.
Review these topics before you install and configure IBM CMIS for Content Manager OnDemand so that you are aware of
any restrictions or limitations that apply to your environment.
A complete and up-to-date list of the hardware and software requirements for IBM Content Navigator is available on the
IBM support site at http://www.ibm.com/support/docview.wss?uid=swg27036292.
Tip: Before you install or configure IBM CMIS for Content Manager OnDemand, it is recommended that you:
• Read the relevant topics for your environment in the planning section to ensure that you are aware of any
restrictions or limitations that might apply to your environment.
• If you plan to install IBM Content Navigator and IBM CMIS for Content Manager OnDemand, review Getting IBM
Content Navigator up and running to get an overview of the end-to-end installation and configuration process.
• A supported content management server and any required components for that server
• A supported web application server where you can deploy IBM CMIS for Content Manager OnDemand
• IBM Content Manager OnDemand Web Enablement Kit (ODWEK) on the web application server
If you plan to install IBM Content Navigator and IBM CMIS for Content Manager OnDemand, ensure that your system
includes the necessary prerequisites for IBM Content Navigator. For more information, see Prerequisites for installing IBM
Content Navigator.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 5
Planning for your application server
IBM CMIS for Content Manager OnDemand can be deployed to several different application server types and topologies.
Regardless of the application server topology that you deploy to, you should install IBM CMIS for Content Manager
OnDemand to a dedicated application server or application server cluster because of the effect on JVM arguments and
scalability. When IBM CMIS is installed to an application server, the JVM arguments on the server are modified, which can
affect other applications on that server. Also, when more than one application is installed in an application server, the
scalability of each application decreases.
In addition, it is recommended that you dedicate a server in your IBM Content Manager OnDemand to IBM CMIS for
Content Manager OnDemand.
Restriction: IBM WebSphere Application Server administrative security is required for IBM Content Navigator. Therefore,
you cannot deploy IBM CMIS for Content Manager OnDemand and IBM Content Navigator in the same instance WebSphere
Application Server.
IBM CMIS for Content Manager OnDemand supports the following topologies on WebSphere Application Server:
• If you use WebSphere Application Server, you can deploy IBM CMIS to a dedicated application server.
• If you use WebSphere Application Server Network Deployment, you can deploy IBM CMIS to the following
topologies:
o Unmanaged nodes
An unmanaged node is an application server node with its own administration facilities. The node is not
federated to the deployment manager. You can deploy IBM CMIS to a dedicated application server node.
o Managed nodes
A managed node is an application server node that is federated to the deployment manager. You can
deploy IBM CMIS to a dedicated application server node.
o Clusters
A cluster is a group of application servers that share the load for an application. The deployment manager
deploys the application to the cluster members.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 6
Recommended server topology
An IBM CMIS for Content Manager OnDemand environment includes several components that will generally be installed on
separate systems.
Content Manager OnDemand generally requires its own system, and is often spread across several systems. For best
performance and availability, it is strongly recommended that you install Content Manager OnDemand and any client
applications, such as IBM CMIS for Content Manager OnDemand, on separate servers. If your client application requires its
own application server instance, you should install on a separate system.
You should install IBM CMIS for Content Manager OnDemand to a dedicated application server or application server cluster
for the following reasons:
• When IBM CMIS for Content Manager OnDemand is installed to an application server, the JVM arguments on the
server are modified, which can affect other applications on that server.
• When more than one application is installed in an application server, the scalability of each application decreases.
• When each application is installed in in a dedicated application server, it is easier for IBM Software Support to
identify the cause of a problem.
The recommended server configuration for a non-HA (highly available) environment is:
When IBM CMIS for Content Manager OnDemand is deployed on WebSphere Application Server, administrative security
must be disabled. Because IBM CMIS for Content Manager OnDemand does not support web application authentication,
IBM CMIS for Content Manager OnDemand supports only HTTP Basic authentication for both RESTful and Web Services
bindings.
With HTTP Basic authentication, user credentials (for example, a user name and password) are encoded as a message
header in HTTP requests.
You can specify the language that is displayed in the installation program and the Configuration and Deployment Tool.
However, IBM CMIS for Content Manager OnDemand uses locale settings to determine the language in which to display the
following information:
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 7
• Error messages in HTTP responses
• IBM CMIS for Content Manager OnDemand index page, about page, and configuration page
• IBM Content Manager OnDemand metadata, such as type definition and property definition display names and
descriptions
If you use REST services, IBM CMIS for Content Manager OnDemand uses the following rules of precedence to determine
the locale:
1. IBM CMIS uses the language that is specified in the Accept-Language header of the HTTP request.
2. If the Accept-Language header is not available or does not specify a supported language, IBM CMIS uses the
language of the JVM on the IBM CMIS application server.
Tip: By default, WebSphere Application Server and Oracle WebLogic Server set the JVM to English.
3. If the language of the JVM is not available, IBM CMIS displays content in English.
If you use Web Services, IBM CMIS uses the following rules of precedence to determine the locale:
1. IBM CMIS uses the language that is specified in the locale element of the i18n:international element of the WS-
I18N header.
2. If the WS-I18N header is not available or does not specify a supported language, IBM CMIS uses the language that
is specified in the Accept-Language header of an HTTP request.
3. If the Accept-Language header is not available or does not specify a supported language, IBM CMIS uses the
language of the JVM on the IBM CMIS application server.
Tip: By default, WebSphere Application Server and Oracle WebLogic Server set the JVM to English.
4. If the language of the JVM is not available, IBM CMIS displays content in English.
Important: If you use headers to specify the language in which to display content, you must understand the following
restrictions and behaviors:
• If you provide a WS-I18N header and an Accept-Language header and both headers specify a supported language,
the language that is specified in the WS-I18N header takes precedence.
• If you provide an Accept-Language header with multiple languages, IBM CMIS displays only the preferred language
(the language with the highest quality value, such as q=1).
If multiple languages are designated as the preferred language, IBM CMIS uses the first language from the left with the
highest value quality. For example, if the header includes the following code, IBM CMIS would display content in French
because French is the first entry from the left with the highest quality value:
IBM CMIS for Content Manager OnDemand runtime error messages are available in the following languages:
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 8
Language Language code
English en
Finnish fi
French fr
German de
Greek el
Hebrew he
Hungarian hu
Italian it
Japanese ja
Korean ko
Norwegian no
Polish pl
Portuguese pt
Portuguese, Brazilian pt_BR
Spanish es
Swedish sv
Thai th
Turkish tr
Restriction: The following worksheets are specific to an IBM CMIS for Content Manager OnDemand configuration. If you
plan to configure IBM Content Navigator, use the information in Installation and configuration worksheets to determine the
appropriate worksheets for your environment.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 9
Worksheet for configuring IBM CMIS for Content Manager OnDemand
If you want to enable client applications that use the OASIS Content Management Interoperability Services standard to
work with content that is stored on an IBM Content Manager OnDemand repository, work with your Content Manager
OnDemand administrator to gather the information that you need to configure the IBM CMIS for Content Manager
OnDemand web application. The IBM Content Navigator Configuration and Deployment Tool requires that you enter values
prepared in advance. The worksheet is a useful place to put these values.
Print this worksheet and enter values as you prepare your installation.
Use this worksheet when you complete the following configuration and deployment task in the IBM Content Navigator
Configuration and Deployment Tool:
Table 1. Parameters required to connect to your IBM Content Manager OnDemand environment
Worksheets for deploying the web application on your web application server
Work with your application server administrator to gather the information that you need to configure and deploy IBM CMIS
for Content Manager OnDemand to your web application server environment. Enter the information about your
environment in the appropriate worksheet:
• Worksheet for deploying the web application on WebSphere Application Server
• Worksheet for deploying the web application on Oracle WebLogic Server
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 10
Installing IBM CMIS for Content Manager OnDemand
IBM CMIS for Content Manager OnDemand is installed as part of IBM Content Navigator.
To install IBM CMIS for Content Manager OnDemand, follow the instructions in Installing the IBM Content Navigator
software.
Remember: If you plan to install IBM Content Navigator and IBM CMIS for Content Manager OnDemand, ensure that you
complete all of the appropriate prerequisite tasks in Installing IBM Content Navigator.
The IBM Content Navigator Configuration and Deployment Tool enables you to deploy:
• An IBM Content Navigator web application that can connect to your IBM Content Manager, IBM Content Manager
OnDemand, IBM FileNet Content Manager, and OASIS CMIS repositories.
• An IBM CMIS for Enterprise Content Management application that can connect to an IBM Content Manager, IBM
Content Manager OnDemand, or IBM FileNet Content Manager repository.
• A web application that includes both IBM Content Navigator and IBM CMIS for FileNet Content Manager. However,
it is not recommended that you deploy an application that includes both types of connections.
The configuration tasks that you must complete depend on whether you plan to deploy an IBM Content Navigator web
application or an IBM CMIS for Enterprise Content Management application. For more information, see Configuring the IBM
Content Navigator web application.
To configure an IBM CMIS for Content Manager OnDemand application, you must complete the appropriate tasks for your
web application server environment in the IBM Content Navigator Configuration and Deployment Tool:
• Configuring and deploying IBM CMIS for Content Manager OnDemand on WebSphere Application Server
• Configuring and deploying IBM CMIS for Content Manager OnDemand on Oracle WebLogic Server
• Configuring and deploying IBM CMIS for Content Manager OnDemand by using the command-line interface
Configuring and deploying IBM CMIS for Content Manager OnDemand on WebSphere
Application Server
To configure an IBM CMIS for Content Manager OnDemand application on WebSphere Application server, you must
complete the following tasks:
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 11
Creating a configuration profile
In order to create the IBMCMIS for Content Manager OnDemand web application, you must use the IBM Content Navigator
Configuration and Deployment Tool. You can create multiple web applications from a single installation of IBM Content
Navigator.
• Ensure that the web application server where you want to deploy IBM CMIS for Content Manager OnDemand is
running.
• Collect information about your web application server. Refer to the appropriate worksheet for your web
application server:
o Worksheet for connecting to IBM WebSphere Application Server
o Worksheet for connecting to Oracle WebLogic Server
• If you want to save the passwords that you enter in the IBM Content Navigator Configuration and Deployment Tool
as encrypted passwords in the XML configuration files, click Preferences > Basic Settings and select the Save all
passwords to file when saving a task or profile check box before you create a configuration profile. If you do not
select this check box, your passwords are not saved and you must enter your passwords in clear text when you run
the task.
• The type of web application server that you plan to deploy IBM Content Navigator to
• The types of repositories that you plan to use the deployed web application to connect to
The configuration tasks that you must complete depend on the web application server and the types of repositories that
you want to connect to from the IBM Content Navigator web client.
Tip: If the IBM Content Navigator Configuration and Deployment Tool is separated from your web application server by a
wide area network (WAN), there might be a delay when populating information about your web application server in the
tool. You can minimize this delay by running the tool on the same local area network (LAN) as the web application server.
Procedure
To create a configuration profile:
1. Open the IBM Content Navigator Configuration and Deployment Tool. The Configuration and Deployment Tool is in
the configure subdirectory of the IBM Content Navigator installation directory, by default:
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 12
Linux for System z /opt/IBM/ECMClient/configure/configmgr
Windows C:\Program Files
(x86)\IBM\ECMClient\configure\configmgr.exe
2. If you want to enable the IBM Content Navigator Configuration and Deployment Tool to save passwords, click
Window > Preferences > Basic Settings and select Save all passwords to file when saving a task or profile. Click
OK. When you select this option, your passwords are encrypted.
Important: The encryption method that is used in the IBM Content Navigator Configuration and Deployment Tool
might not comply with Federal Information Processing Standards (FIPS) 140.
To comply with FIPS 140, set the operating system-level access permissions on the XML configuration files that are
generated by the tool to allow only the administrator who is configuring and deploying IBM Content Navigator to
read or write to the file.
4. Specify a name and location for your configuration and click Next. The name that you specify is the name of the
configuration profile. When you need to reuse or update your configuration, you can select this profile from the
list of profiles on your IBM Content Navigator server.
5. Select either WebSphere Application Server or Oracle WebLogic Server and click Next. The web application server
that you select determines the types of repositories that you can connect to and the types of IBM CMIS for ECM
services that you can configure:
o If you select WebSphere Application Server, you can configure the following repository connections and
IBM CMIS for ECM web applications:
o If you select Oracle WebLogic Server, you can configure the following repository connections and IBM
CMIS for ECM services:
6. Complete the task to connect to your web application server by using the values that you entered in the worksheet
for your environment:
Tip: You can use the Test Connection button to ensure that you entered the information about your web
application server correctly.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 13
7. Click Next to connect to your web application server.
Restriction: When you specify the types of applications that you want to configure, keep the following restrictions
in mind:
o It is recommended that you do not configure a web application that includes both IBM Content Navigator
repository connections and IBM CMIS for ECM services.
o It is recommended that you do not configure a web application that includes more than one type of IBM
CMIS for ECM service.
9. Click Next.
This option is recommended for most IBM Content Manager Enterprise Edition and IBM Content Manager
OnDemand users. This option is also recommended for IBM FileNet P8 users who are deploying IBM
Content Navigator to a new application server that does not have any existing IBM FileNet P8
configurations and who plan to use IBM FileNet P8 workflows.
You must gather information about your system and review the documentation for configuring and
deploying IBM Content Navigator before you select this option.
11. Click Next to proceed to the next configuration task or click Close to save your profile until you are ready to
complete the configuration tasks.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 14
Configuring IBM CMIS for Content Manager OnDemand
If you want to enable client applications that use the OASIS CMIS standard to work with content that is stored on an IBM
Content Manager OnDemand repository, you must enable your IBM CMIS for Content Manager OnDemand web application
to communicate with the repository.
Procedure
To configure IBM CMIS for Content Manager OnDemand:
1. Open the following task in your configuration profile: Configure IBM CMIS for IBM Content Manager OnDemand.
2. Complete the task to configure the web application by using the values that you entered in the Worksheet for
configuring IBM CMIS for Content Manager OnDemand.
If you are manually running the tasks in the IBM Content Navigator Configuration and Deployment Tool, you can
take one of the following actions:
o Click Run Task to run the task now. This option is recommended because it makes it easier to
troubleshoot and resolve problems if they occur.
o Wait until all of the tasks are complete and then click Run All Tasks to run all of the tasks that are
required to configure and deploy the web application.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 15
Configuring and deploying IBM CMIS for Content Manager OnDemand on Oracle
WebLogic Server
To configure an IBM CMIS for Content Manager OnDemand application on WebSphere Application server, you must
complete the following tasks:
• Ensure that the web application server where you want to deploy IBM CMIS for Content Manager OnDemand is
running.
• Collect information about your web application server. Refer to the appropriate worksheet for your web
application server:
• If you want to save the passwords that you enter in the IBM Content Navigator Configuration and Deployment Tool
as encrypted passwords in the XML configuration files, click Preferences > Basic Settings and select the Save all
passwords to file when saving a task or profile check box before you create a configuration profile. If you do not
select this check box, your passwords are not saved and you must enter your passwords in clear text when you run
the task.
• The type of web application server that you plan to deploy IBM Content Navigator to
• The types of repositories that you plan to use the deployed web application to connect to
The configuration tasks that you must complete depend on the web application server and the types of repositories that
you want to connect to from the IBM Content Navigator web client.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 16
Tip: If the IBM Content Navigator Configuration and Deployment Tool is separated from your web application server by a
wide area network (WAN), there might be a delay when populating information about your web application server in the
tool. You can minimize this delay by running the tool on the same local area network (LAN) as the web application server.
Procedure
To create a configuration profile:
12. Open the IBM Content Navigator Configuration and Deployment Tool. The Configuration and Deployment Tool is in
the configure subdirectory of the IBM Content Navigator installation directory, by default:
13. If you want to enable the IBM Content Navigator Configuration and Deployment Tool to save passwords, click
Window > Preferences > Basic Settings and select Save all passwords to file when saving a task or profile. Click
OK. When you select this option, your passwords are encrypted.
Important: The encryption method that is used in the IBM Content Navigator Configuration and Deployment Tool
might not comply with Federal Information Processing Standards (FIPS) 140.
To comply with FIPS 140, set the operating system-level access permissions on the XML configuration files that are
generated by the tool to allow only the administrator who is configuring and deploying IBM Content Navigator to
read or write to the file.
15. Specify a name and location for your configuration and click Next. The name that you specify is the name of the
configuration profile. When you need to reuse or update your configuration, you can select this profile from the
list of profiles on your IBM Content Navigator server.
16. Select either WebSphere Application Server or Oracle WebLogic Server and click Next. The web application server
that you select determines the types of repositories that you can connect to and the types of IBM CMIS for ECM
services that you can configure:
o If you select WebSphere Application Server, you can configure the following repository connections and
IBM CMIS for ECM web applications:
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 17
o If you select Oracle WebLogic Server, you can configure the following repository connections and IBM
CMIS for ECM services:
17. Complete the task to connect to your web application server by using the values that you entered in the worksheet
for your environment:
Tip: You can use the Test Connection button to ensure that you entered the information about your web
application server correctly.
Restriction: When you specify the types of applications that you want to configure, keep the following restrictions
in mind:
o It is recommended that you do not configure a web application that includes both IBM Content Navigator
repository connections and IBM CMIS for ECM services.
o It is recommended that you do not configure a web application that includes more than one type of IBM
CMIS for ECM service.
This option is recommended for most IBM Content Manager Enterprise Edition and IBM Content Manager
OnDemand users. This option is also recommended for IBM FileNet P8 users who are deploying IBM
Content Navigator to a new application server that does not have any existing IBM FileNet P8
configurations and who plan to use IBM FileNet P8 workflows.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 18
o Click Advanced to manually run the configuration tasks.
Important: If you select this option, you cannot use the wizard to update or redeploy the profile.
You must gather information about your system and review the documentation for configuring and
deploying IBM Content Navigator before you select this option.
22. Click Next to proceed to the next configuration task or click Close to save your profile until you are ready to
complete the configuration tasks.
Procedure
To configure IBM CMIS for Content Manager:
4. Open the following task in your configuration profile: Configure IBM CMIS for IBM Content Manager OnDemand.
5. Complete the task to configure the web application by using the values that you entered in the Worksheet for
configuring IBM CMIS for Content Manager OnDemand.
If you are manually running the tasks in the IBM Content Navigator Configuration and Deployment Tool, you can
take one of the following actions:
o Click Run Task to run the task now. This option is recommended because it makes it easier to
troubleshoot and resolve problems if they occur.
o Wait until all of the tasks are complete and then click Run All Tasks to run all of the tasks that are
required to configure and deploy the web application.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 19
Building the web application
You must use the IBM Content Navigator Configuration and Deployment Tool to build the EAR file that contains your IBM
CMIS for Enterprise Content Management web application. For more information, see Building the web application.
Configuring and deploying IBM CMIS for Content Manager OnDemand by using the
command-line interface
You can configure and deploy an IBM CMIS for Content Manager OnDemand application by using the command-line version
of the IBM Content Navigator Configuration and Deployment Tool.
For information about deploying applications other than IBM CMIS for Content Manager OnDemand, see Configuring and
deploying web applications by using the command-line interface.
Remember: It is recommended that you configure and deploy type of IBM CMIS repository service in a web application.
It is recommended that most users use the graphical user interface version of the IBM Content Navigator Configuration and
Deployment Tool, which enables you to test the values that you enter before you run tasks.
The scripts for the command-line version of the IBM Content Navigator Configuration and Deployment Tool are in
the configure directory of the IBM Content Navigator installation directory.
To configure and deploy IBM CMIS for Content Manager OnDemand by using the command-line interface, you must
generate and edit the configuration XML files, run the configuration tasks, and then deploy the web application to your web
application server.
Important: If you plan to deploy multiple instances of IBM CMIS on the same web application server, you must:
• Generate, edit, and run a complete set of configuration files for each instance.
You can either generate all of the configuration XML files before you edit and run the files, or you can generate,
edit, run, and verify the files one at a time.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 20
• Store the configuration files for each instance in a separate profile directory.
The name that you specify for the profile is also used as the name for the directory where the configuration files
are stored. The profile name must be a valid directory name for your operating system. By default, the profiles are
stored in the configure/profiles directory of the IBM Content Navigator installation directory.
To configure and deploy an IBM CMIS for Content Manager OnDemand web application by using the command-line
interface, you must edit and run the tasks that apply to your environment. For more information about the tasks that the
generateConfig creates, see IBM Content Navigator Configuration and Deployment Tool command-line reference.
Procedure
To configure and deploy IBM CMIS for Content Manager OnDemand by using the command-line interface:
1. From the command prompt, change to the IBM Content Navigator configure subdirectory.
2. Generate the configuration XML files for an IBM CMIS web application by running the generateConfig command.
The parameters that you specify depend on the types of IBM CMIS web application that you are configuring:
The following parameters are specific to IBM CMIS for Content Manager:
• db
Important: You must specify the –db parameter even if you configure an IBM CMIS for Content Manager
OnDemand web application to prevent an error when you run the generateConfig command. If you are
not configuring an IBM CMIS for Content Manager web application, enter placeholder for the –db
parameter.
The following parameters are specific to IBM CMIS for FileNet Content Manager:
• ldap_Repository
• ldap
The generateConfig command creates the configuration XML files in the profile directory that you specify in the -
profile argument. The configuration XML files contain the properties that you must specify for each configuration
task.
Tip: To see the status of the command through a pager, append | more to the end of the command.
To generate all of the XML files for an IBM CMIS web application, enter:
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 21
For example, to generate the configuration XML files for an IBM CMIS for Content Manager OnDemand web
application that you plan to deploy on WebSphere Application Server, enter:
3. If you want to save your passwords, run the storePasswords command for each task that requires a password.
Important: Your passwords are encrypted before they are saved to the configuration XML files. However, the
encryption method might not comply with Federal Information Processing Standards (FIPS) 140. To comply with
FIPS 140, ensure that the operating system access permissions on the XML configuration files for each task are set
to allow only the administrator who edits and runs the tasks to read or write to the files.
If you do not save your passwords, you must manually enter any required passwords into the XML configuration
files before you run any of these tasks.
4. Edit the configuration XML files to provide values for your environment. The XML files are in the profile directory
that you specified when you ran the generateConfig command.
Tip: You can use the IBM Content Navigator installation and configuration worksheets to determine the
appropriate values for your environment.
5. Start the application server where you plan to deploy the IBM CMIS web application.
6. From the command prompt, change to the IBM Content Navigator configure subdirectory, where the
configmgr_cl file is located.
Tip: If you need to run the configuration XML files for a profile that was created or edited in the graphical user
interface version of the IBM Content Navigator Configuration and Deployment Tool, verify that the XML files
contain values for the required passwords before you run the files.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 22
• To run all of the configuration files at the same time, enter:
Tip: If you run all of the tasks at the same time, ensure that all of the tasks are complete before you run
the execute command.
Tip: If you run the tasks individually, it is recommended that you run the tasks in the order that they are
listed in IBM Content Navigator Configuration and Deployment Tool command-line reference. When you
run the tasks in this order, it ensures that any prerequisite configuration is completed when you run each
task.
Tip: To view the descriptions and valid values for each parameter from the command prompt, enter the following
command:
generateConfig command
Use the generateConfig command to generate the configuration XML files that you need to deploy and instance of IBM
Content Navigator or IBM CMIS in your environment.
The syntax of the generateConfig command depends on the type of web application server on which you plan to deploy the
web application. Refer to the following table to determine which parameters apply to your web application and web
application server.
To deploy IBM Content Navigator, enter the command with the following syntax:
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 23
Table 2. Parameters used in the generateConfig command
Specify the type of web application server on which you will deploy your web
application.
Valid values:
weblogic
Specify this value to deploy IBM Content Navigator on Oracle WebLogic
Server.
websphere
Specify this value to deploy IBM Content Navigator on WebSphere
Application Server.
-configure_CM Required for WebSphere Application Server users only.
This parameter does not apply if you plan to deploy IBM Content Navigator on
Oracle WebLogic Server.
Specify whether or not you want to configure IBM Content Navigator to connect
to IBM Content Manager repositories.
Valid values:
yes
Specify this value to configure IBM Content Navigator to connect to IBM
Content Manager repositories.
no
Specify this value if you do not want to connect to IBM Content Manager
repositories.
If you do not want to configure an IBM CMIS web application, specify no for the
following parameters:
• -configure_CMIS_CM
• -configure_CMIS_FileNetP8
-configure_CMIS_CM Required for WebSphere Application Server users only.
This parameter does not apply if you plan to deploy your web application on
Oracle WebLogic Server.
Specify whether or not you want to configure an IBM CMIS for Content Manager
web application.
Valid values:
yes
Specify this value to configure an IBM CMIS for Content Manager web
application.
no
Specify this value if you do not want to configure an IBM CMIS for
Content Manager web application.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 24
Parameter name Description
If you do not want to configure an IBM Content Navigator web application, specify
no for the following parameters:
• -configure_CM
• -configure_CMOD
• -configure_FileNetP8
-configure_CMOD Required.
Specify whether or not you want to configure IBM Content Navigator to connect
to IBM Content Manager OnDemand repositories.
Valid values:
yes
Specify this value to configure IBM Content Navigator to connect to IBM
Content Manager OnDemand repositories.
no
Specify this value if you do not want to connect to IBM Content Manager
OnDemand repositories.
If you do not want to configure an IBM CMIS web application, specify no for the
following parameters:
• -configure_CMIS_CM
• -configure_CMIS_FileNetP8
-configure_FileNetP8 Required.
Specify whether or not you want to configure IBM Content Navigator to connect
to IBM FileNet Content Manager repositories.
Valid values:
yes
Specify this value to configure IBM Content Navigator to connect to IBM
FileNet Content Manager repositories.
no
Specify this value if you do not want to connect to IBM FileNet Content
Manager repositories.
If you do not want to configure an IBM CMIS web application, specify no for the
following parameters:
• -configure_CMIS_CM
• -configure_CMIS_FileNetP8
-configure_CMIS_FileNetP8 Required.
Specify whether or not you want to configure an IBM CMIS for FileNet Content
Manager web application.
Valid values:
yes
Specify this value to configure an IBM CMIS for FileNet Content Manager
web application.
no
Specify this value if you do not want to configure an IBM CMIS for FileNet
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 25
Parameter name Description
Content Manager web application.
If you do not want to configure an IBM Content Navigator web application, specify
no for the following parameters:
• -configure_CM
• -configure_CMOD
• -configure_FileNetP8
-db Required for IBM Content Navigator and IBM CMIS for Content Manager users
only.
Important: You must specify the –db parameter even if you configure an IBM
CMIS for Content Manager OnDemand or IBM CMIS for FileNet Content Manager
web application to prevent an error when you run the generateConfig command.
If you are not configuring an IBM Content Navigator or IBM CMIS for Content
Manager web application, enter placeholder for the –db parameter.
IBM Content Navigator users: Specify the type of database on which you plan to
store your IBM Content Navigator configuration data.
IBM CMIS for Content Manager users: Specify the type of database that your IBM
Content Manager library server uses.
Valid values:
db2
Specify this value if you plan to store your configuration data on a DB2
database.
db2zos
Specify this value if you plan to store your configuration data on a DB2
for z/OS database.
db2pshadr
Specify this value if you plan to store your configuration data on a DB2
pureScale or high availability disaster recovery (HADR) database.
Specify the type of environment in which IBM Content Navigator will be deployed.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 26
Parameter name Description
Valid values:
cluster
Specify this value to deploy IBM Content Navigator on a highly available
server cluster.
netdeploy
Specify this value to deploy IBM Content Navigator to a WebSphere
Application Server Network Deployment environment without a cluster.
standard
Specify this value to deploy IBM Content Navigator to a stand-alone
server.
-icn_sso Required for IBM Content Navigator users only.
Specify where the initial authentication for IBM Content Navigator occurs.
Valid values:
none
Specify this value if you want to authenticate users against the repository
that is configured as the default repository for a desktop.
cca
IBM FileNet P8 users only.
Specify this value if you want to authenticate users against the web
application server where IBM Content Navigator is deployed before they
can access the IBM Content Navigator web application.
This option only applies if you have one of the following environments
configured:
• CA SiteMinder
• SPNEGO/Kerberos
• Tivoli Access Manager for e-business
fba
WebSphere Application Server users only.
Select this option to control access to IBM Content Navigator if you use a
login form to gather and send user credentials to your web application
server.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 27
Parameter name Description
Specify the directory service (LDAP) provider of your Content Engine or Content
Platform Engine LDAP server.
Valid values:
activedirectory
Specify this value if your LDAP server is an Active Directory server.
adam
Specify this value if your LDAP server is an ADAM or AD LDS server.
ca
Specify this value if your LDAP server is a CA Directory server.
edirectory
Specify this value if your LDAP server is an eDirectory server.
oid
Specify this value if your LDAP server is an Oracle Internet Directory
server.
oracledirectorySE
Specify this value if your LDAP server is an Oracle Directory Server
Enterprise Edition server.
tivoli
Specify this value if your LDAP server is a Tivoli Directory Server server.
-ldap_Repository Required for IBM FileNet P8 users only.
Valid values:
federated
Specify this value if your LDAP server is a federated repository.
stand-alone
Specify this value if your LDAP server is a stand-alone LDAP registry.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 28
Tasks generated by the generateConfig command
Based on the parameters that you specify when you run the generateConfig command, the command-line interface
generates the tasks that you need to configure and deploy the web application in your environment. The following table
describes the tasks that the generateConfig command creates.
This task enables the IBM Content Navigator Configuration and Deployment Tool to
communicate with the web application server where you plan to deploy your web
application.
downloadcejarstask Required for IBM FileNet P8 and IBM CMIS for FileNet Content Manager users only.
This task is required only if the version of the Content Engine connector files that are
installed with IBM Content Navigator do not match the version of the files on your
Content Engine or Content Platform Engine server.
Prerequisites: Ensure that you are running a supported version of Content Engine or
Content Platform Engine before you run this task.
This task downloads the correct version of the client connector files from the Content
Engine or Content Platform Engine server.
configureodwek Required for IBM Content Manager OnDemand users only.
Prerequisites: Install IBM Content Manager OnDemand Web Enablement Kit on the
IBM Content Navigator server before you run this task.
This task enables the web client to connect to IBM Content Manager OnDemand
repositories and tells the web client where to find the Content Manager OnDemand
Web Enablement Kit.
configurepe Required for IBM FileNet P8 users only.
This task is required only if you want to use IBM FileNet P8 workflows in IBM Content
Navigator.
• Ensure that you are running a supported version of Process Engine or Content
Platform Engine.
• Ensure that the version of the Process Engine or Content Platform Engine
client connector files on the IBM Content Navigator server match the version
of Process Engine or Content Platform Engine that you are running.
• Create an isolated region or identify an existing isolated region that you want
to use for IBM Content Navigator.
This task registers the IBM Content Navigator application in Process Engine and creates
the IBM Content Navigator step processor in the isolated region.
configurecmisp8 Required for IBM CMIS for FileNet Content Manager users only.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 29
Task Name Description
This task enables the IBM CMIS for FileNet Content Manager web application to
communicate with your IBM FileNet P8 repository.
Prerequisites: Copy the JDBC drivers for your database to the IBM Content Navigator
server before you run this task.
This task adds your database JDBC driver to your web application server
environment variables so that IBM Content Navigator can access its
configuration database table.
This task enables the web client to connect to IBM Content Manager repositories by
enabling IBM Content Navigator to communicate with your IBM Content Manager
library server.
Restriction: You can configure IBM Content Navigator to connect to IBM Content
Manager only if you deploy IBM Content Navigator on WebSphere Application Server.
configurecmiscmtask Required for IBM CMIS for Content Manager users only.
This task enables the IBM CMIS for Content Manager web application to communicate
with your IBM Content Manager library server.
Restriction: You can configure IBM CMIS for Content Manager only if you deploy the
web application on WebSphere Application Server.
configurecmisodtask Required for IBM CMIS for Content Manager OnDemand users only.
This task enables the IBM CMIS for Content Manager OnDemand web application to
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 30
Task Name Description
communicate with your IBM Content Manager OnDemand repository.
Prerequisites: You must have an existing database and a database ID before you run
this task.
Prerequisites: If you have an existing data source that uses the same name as the data
source that you plan to use when you run this task, you must use your application
server administration tools to manually remove the data source before you run this
task. If you do not remove the existing data source, you cannot run the task
successfully.
This task creates a data source connection that enables the web client to connect to
the IBM Content Navigator database.
configureldap Required for IBM FileNet P8 and IBM CMIS for FileNet Content Manager users only.
If you have an LDAP configuration on the web application server where you are
deploying IBM Content Navigator or IBM CMIS for FileNet Content Manager and the
LDAP configuration matches the settings on your Content Engine or Content Platform
Engine LDAP repository, you do not need to run this task.
This task configures your web application server to use the Content Engine or Content
Platform Engine LDAP repository.
Important: The values that you enter must match the values that are set on your
Content Engine or Content Platform Engine server.
The IBM Content Navigator Configuration and Deployment Tool does not include every
option that you can set when configuring your LDAP server connection. Work with your
LDAP server administrator to determine if there are any settings that you must
configure that are not included in the IBM Content Navigator Configuration and
Deployment Tool. If your LDAP server connection includes additional settings, you
must manually update your LDAP server connection on your web application server
after you run this task. You can open the administrative console for the web
application server for Content Engine or Content Platform Engine to ensure that your
LDAP configurations match.
importltpakey Required for IBM FileNet P8 and IBM CMIS for FileNet Content Manager users on
WebSphere Application Server only.
If you plan to deploy IBM Content Navigator or IBM CMIS for FileNet Content Manager
in the same cell as Content Engine or Content Platform Engine on WebSphere
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 31
Task Name Description
Application Server, you do not need to run this task.
Prerequisites: You must export the LTPA key file from the Content Engine or Content
Platform Engine server and save it to the IBM Content Navigator server before you run
this task.
This task imports your Content Engine or Content Platform Engine LTPA key to the web
application server to enable IBM Content Navigator or IBM CMIS for FileNet Content
Manager to authenticate to the Content Engine or Content Platform Engine server.
configureloginmodules Required for IBM Content Navigator on WebSphere Application Server users only.
This task is required regardless of the types of repositories that you plan to connect to
from IBM Content Navigator.
IBM Content Navigator uses Java Authentication and Authorization Service (JAAS) to
authenticate users’ login credentials. This task configures your web application server
to use JAAS authentication.
configurecmisauthenticationtask Required for IBM CMIS on WebSphere Application Server users only.
This task enables you to specify the authentication method that client applications use
when sending requests to your IBM CMIS web application.
configureicntask Required for all IBM Content Navigator users.
This task collects the information that the IBM Content Navigator Configuration and
Deployment Tool uses when it creates the IBM Content Navigator web application,
such as the name of the application.
rebuildear Required for all users.
Prerequisites: If you are running the tasks individually, you must run all of the other
tasks to configure IBM Content Navigator for your environment before you run this
task.
This task builds the application EAR file that you deploy to your web application server.
deployapplication Optional.
Prerequisites: You must complete the other web application configuration tasks before
you deploy the web application. If any of the configuration tasks fail, the deployed web
application will not work properly.
You must deploy the web application to your web application server. You can use the
IBM Content Navigator Configuration and Deployment Tool to deploy the web
application, or you can deploy the EAR file manually.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 32
Completing post-configuration tasks
After you deploy IBM CMIS for Content Manager OnDemand to your web application server, you must complete several
tasks before you can use the deployed web application.
http://odcmis_server:port_number/odcmis
Refer to the appropriate worksheet for your environment to determine the port that you specified when you
configured and deployed the web application:
2. Verify that your IBM Content Manager OnDemand repositories are listed at the bottom of the page.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 33
Configuring IBM CMIS for Content Manager OnDemand advanced properties
The advanced IBM Content Management Interoperability Services for Content Manager OnDemand (IBM CMIS) properties
are optional configuration settings that enable you to tune your system for optimal performance and scaling. However, you
can run IBM CMIS for Content Manager OnDemand by using the default values that are specified in
odcmis.properties.
For more information about the advanced properties, see the Advanced configuration properties reference.
You must perform this task on each application server node if IBM CMIS for Content
Manager OnDemand is deployed in an application server cluster.
1. Stop the application server on where IBM CMIS for Content Manager OnDemand web application is running.
2. Open the odcmis.properties file in a text editor. The odcmis.properties file is in the installed
applications folder of the application server. For example, for WebSphere Application Server on Windows, the file
might be in the following directory: C:\Program Files
(x86)\ibm\WebSphere\AppServer\profiles\AppSrv01\installedApps\serverNode01Cel
l\navigator.ear\odcmis.war\WEB-INF\classes
3. Edit the entries for the advanced parameters that you want to modify for your IBM CMIS for Content Manager
OnDemand system.
Remember: You do not need to configure these settings to use IBM CMIS for Content Manager OnDemand. However, if you
want to tune your system for optimal performance and scaling, you can configure any properties that are appropriate for
your environment.
Important: To use this setting, you must have the AFP2PDF conversion
utility installed on the IBM CMIS for Content Manager OnDemand server,
and you must specify values for the following advanced configuration
parameters:
• afp2PdfInstallDir
• convertAfpToPdf
• tempDir
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 34
afp2PdfInstallDir If you want to convert AFP documents to PDF documents, you must
specify a value for this parameter.
Important: To use this setting, you must have the AFP2PDF conversion
utility installed on the IBM CMIS for Content Manager OnDemand server,
and you must specify values for the following advanced configuration
parameters:
• afp2PdfConfigFile
• convertAfpToPdf
• tempDir
appendFileExtToName The appendFileExtToName property specifies whether the file extension
for a known file type is appended to the document name before it is
displayed in client applications.
The default value is 2048 bytes. If you do not specify a value for this
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 35
property, IBM CMIS uses the default size of 2048 bytes.
• false
When you specify convertAfpToPDF=false, AFP
documents are not converted to PDF documents. Users must
have a viewer that can display AFP documents.
Important: To use this setting, you must have the AFP2PDF conversion
utility installed on the IBM CMIS for Content Manager OnDemand server,
and you must specify values for the following advanced configuration
parameters:
• afp2PdfInstallDir
• afp2PdfConfigFile
• tempDir
convertLinedataToAscii The convertLinedataToAscii property specifies whether line data
documents should be converted to ASCII documents before they are
displayed in client applications.
• false
When you specify convertLinedataToAscii =false,
line data documents are not converted to ASCII documents.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 36
Users must have a viewer that can display line data documents.
Important: To use this setting, you must specify a value for the tempDir
advanced configuration parameter.
defaultMaxItems The defaultMaxItems property determines the maximum number of
items to return when an HTTP request does not specify a value for the
maxItems parameter.
If you change the default value, you must specify an integer greater than
0.
queryTimeLimit The queryTimeLimit property specifies the maximum length of time (in
seconds) to run a query on the repository. If the query is not complete
after the time limit elapses, control is returned to IBM CMIS for Content
Manager OnDemand
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 37
RepositoryName.nameProperty=OD_property_name
If you specify a value for a repository, you must add an entry to the
specified repository.
• NONE
Enter NONE to indicate that no custom criteria should be used
and that the search should be run with the default criteria that
are provided by IBM Content Manager OnDemand for that
repository. Z
If you specify a value for a repository, you must add an entry to the
specified repository.
If you do not specify a value for this property, IBM CMIS for Content
Manager takes the following actions in the order that they are listed:
1. IBM CMIS for Content Manager OnDemand creates a search for
a property that supports an operator that can accept a wildcard.
The property is used to run a search that attempts to retrieve all
documents.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 38
property as the document name in client applications.
• false
When you specify
RepositoryName.useViewTitle=false, IBM CMIS
does not display that property as the document name in client
applications. This setting overrides the viewTitle=yes
setting in the repository.
If you specify a value for a repository, you must add an entry to the
specified repository.
However, you must specify a value for the property if you configure one
or both of the following properties:
• convertAfpToPdf
• convertLineDataToAscii
You must specify the fully qualified path of an existing directory on the
web application server where IBM CMIS and ODWEK are installed.
traceDir The traceDir property specifies the fully qualified path of the directory
where you want to store the ODWEK trace file, arswww.trace.
However, you must specify a value for the property if you configure
traceLevel property.
You must specify the fully qualified path of an existing directory on the
web application server where IBM CMIS and ODWEK are installed.
traceLevel The traceLevel property specifies the level of logging information that is
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 39
written to the ODWEK trace file, arswww.trace.
• 1
Error message logging
• 2
Error and warning message logging
• 3
Error, warning, and informational message logging
• 4
All messages are captured, including function trace
If you specify a value for this property, it is recommended that you also
specify a value for the traceDir property.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 40
Troubleshooting IBM CMIS for Content Manager OnDemand
This section includes information that you can use to troubleshoot common problems that you might encounter when using
IBM CMIS for Content Manager OnDemand. For example, this section includes information about log files, runtime error
messages, and information that you must collect before calling IBM Software Support.
For more information on how to find these log files, see IBM Content Navigator log files.
arswww.log
IBM CMIS for FileNet Content Manager bundles and performs most content operations through the IBM ODWEK Java API.
You can configure client-side trace logging if you need to troubleshoot problems related to Content Manager OnDemand.
By default, the ODWEK logging is not enabled. For information about configuring the arswww.log file for IBM CMIS for
Content Manager OnDemand, see Configuring ODWEK API logging.
There are two types of runtime logging for IBM CMIS for Content Manager OnDemand:
IBM CMIS for Content Manager OnDemand bundles and performs most content operations through the IBM
ODWEK Java API.
You can configure client-side trace logging if you need to troubleshoot problems related to Content Manager
OnDemand. By default, the ODWEK logging is not enabled. For information about configuring the arswww.log
file for IBM CMIS for Content Manager OnDemand, see Configuring logging for IBM Content Manager OnDemand
Web Enablement Kit (ODWEK).
On WebSphere Application Server, IBM CMIS for Content Manager OnDemand uses the Apache Commons
Logging API, which can be configured through the WebSphere Application Server administrative console.
If you configure detail-level logging or higher (up to fatal-level logging) information is written to the
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 41
SystemOut.log file and to the trace.log file.
Use the SystemOut.log file to review messages that occur when IBM CMIS for Content Manager
OnDemand is running. This log file contains informational messages, warning messages, and error
messages. If IBM CMIS for Content Manager OnDemand throws an exception, the SystemOut.log file
also includes stack trace.
To learn more about the SystemOut.log file, see Tracing and logging configuration in the WebSphere
Application Server information center.
For information about configuring the SystemOut.log file for IBM CMIS for Content Manager
OnDemand, see Configuring logging for IBM CMIS for Content Manager OnDemand on WebSphere
Application Server.
On Oracle WebLogic Server, IBM CMIS for Content Manager OnDemand uses the Apache Commons
Logging API, which can be configured through the IBM Content Navigator log4j.properties file on
the IBM CMIS web application server.
For information about configuring the Navigator log4j.properties file, see Configuring logging for
IBM CMIS for Content Manager OnDemand on Oracle WebLogic Server
Configuring logging for IBM Content Manager OnDemand Web Enablement Kit
(ODWEK)
IBM CMIS for Content Manager OnDemand bundles and performs most content operations through the IBM ODWEK Java
API. You might need to configure ODWEK logging when you need to troubleshoot performance problems related to IBM
Content Manager OnDemand.
Important: You must manually clean the trace file periodically. The trace file is not circular, and requires sufficient file
space.
ODWEK tracing is intended to assist in problem determination. As with any form of tracing, there is a decline in the
performance when you enable ODWEK tracing. It is recommended that you avoid setting the trace level to the highest level
unless instructed otherwise by IBM Software Support. For more information about the trace levels, see the traceLevel
description in Advanced configuration properties reference.
A lower trace level, such as traceLevel=1, is ideal for monitoring an IBM CMIS for Content Manager OnDemand
application that is in a steady state. In this state, the logging configuration creates minimal overhead and alters you only if
error conditions occur.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 42
Tip: In ODWEK V8.5.0.0 and later, the trace file is written in binary. To convert the trace file from its binary format, use the
ARSTFMT command, which is in the bin directory on your IBM Content Manager OnDemand server. For example, on AIX,
you might run the following command to convert the binary file to a text file:
2. Open the odcmis.properties file in a text editor. The odcmis.properties file is in the installed
applications folder of the application server. . For example, for WebSphere Application Server on Windows, the file
might be in the following directory: C:\Program Files
(x86)\ibm\WebSphere\AppServer\profiles\AppSrv01\installedApps\serverNode01Cel
l\navigator.ear\odcmis.war\WEB-INF\classes
Configuring logging for IBM CMIS for Content Manager OnDemand on WebSphere
Application Server
IBM CMIS for Content Manager OnDemand uses the standard Apache Commons Logging API, which can be configured at
run time through the WebSphere Application Server administrative console.
• Runtime
This option is recommended. Any changes that you make to the logging level on the Runtime tab are
activated immediately.
Tip: If the Runtime tab is active and you want to make your changes permanent, select Save runtime
changes to configuration as well.
5. Enter a log detail level that specifies the components or groups to trace. You can enter the log detail level string
directly or generate the log detail level string by using the graphical trace interface.
6. Click Apply.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 43
Specifying log level entries
On the Logging and Tracing panel of the WebSphere Application Server administrative console, you can manually specify
the logging level of any number of classes or packages. However, you must use the correct syntax when you specify the
logging level manually.
Tip: It is recommended that you add .* after the names of packages to configure logging for all of the subpackages of the
specified packages.
The minimum recommended log level for a production environment is "info", which includes errors and important
informational messages. However, you might need to configure the "finest" log level, which includes entry/exit logging, for
temporary troubleshooting. The "fine" log level is used for debug-level logging. Log levels "fine" and below are not
recommended for anything other than temporary troubleshooting in a production environment because they are verbose
and affect performance.
The IBM Content Management Interoperability Services for FileNet® Content Manager application can be divided into the
following categories for logging:
The following examples show how you can configure common logging levels for IBM CMIS:
• To specify info-level logging for the IBM CMIS application, which includes errors, warning, and important
informational messages, enter:
com.ibm.ecm.*=info
• To specify fine-level logging for IBM CMIS components, which includes information that can be used to debug
general problems, enter:
com.ibm.ecm.cmis.*=fine
• To specify finest-level logging for the IBM CMIS components, which logs detailed trace information and method
entry and exit information, enter:
com.ibm.ecm.cmis.*=finest
• To specify finest-level logging for performance, which logs detailed trace information and all the detail that is
required to debug performance problems, enter:
com.ibm.ecm.cmis.perf=finest
These settings apply to all applications that use Apache Commons Logging standard. It is not usually necessary to change
these settings when troubleshooting IBM CMIS for Content Manager OnDemand.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 44
To ensure that log data is retained properly, you can specify the maximum file size and maximum number of historical files.
However, be sure to account for the log level that is configured and the load that the configuration will place on your
system.
By default, the SystemOut.log and the trace.log files are located in the
WAS_profile_location/logs/server subdirectory of the WebSphere Application Server installation directory.
For example, on a standard AIX installation, the log files would be in the
/opt/IBM/WebSphere/AppServer/profiles/AppSrv01/logs/server1/ directory.
• Runtime
This option is recommended. Any changes that you make on the Runtime tab are activated immediately.
Tip: If the Runtime tab is active and you want to make your changes permanent, select Save runtime
changes to configuration as well.
4. Click Apply.
5. To configure trace.log, click Diagnostic Trace in the Logging and Tracing panel. Specify the trace output for
your configuration on the appropriate tab for your environment:
• Configuration
By default, the Configuration tab is active. Any changes that you make on the Configuration tab are saved
to the WebSphere Application Server configuration files, but your changes are not activated until you
restart the server.
• Runtime
This option is recommended. Any changes that you make on the Runtime tab are activated immediately.
Tip: If the Runtime tab is active and you want to make your changes permanent, select Save runtime
changes to configuration as well.
6. Click Apply.
Logged errors
If you configure logging for IBM CMIS for Content Manager OnDemand, all errors are logged in WebSphere Application
Server and returned in a response.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 45
Services binding document.
The OASIS CMIS API specification requires applications to throw exceptions when certain errors occur. The following code is
an example of the information that is written to the log file when an exception occurs:
If you use REST services, server-side stack trace information is logged and returned. If you use Web Services, server-side
stack trace information is logged but not returned. The client application sees only the client-side stack trace information.
Configuring logging for IBM CMIS for Content Manager OnDemand on Oracle
WebLogic Server
To troubleshoot an IBM CMIS web application on Oracle WebLogic Server, you must manually change the logging level of
the log4j.properties file on the IBM CMIS web application server.
Important: Do not set debug logging unless instructed to do so to by IBM Software Support. If you do set debug level
logging, reset the logging level after you resolve the problem. When you reset the logging level, you must redeploy the
application.
The logging levels in log4j.properties file are, from the simplest to the most detailed, FATAL, ERROR,
WARN, INFO, DEBUG and TRACE.
For example, to set debug logging in the log4j.properties file, change the first line of the
log4j.properties file from:
log4j.category.com.ibm.ecm=ERROR, ibmcmisAppender
to
log4j.category.com.ibm.ecm=DEBUG, ibmcmisAppender
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 46
Configuring logging after the IBM CMIS web application is deployed
To manually change the logging level of an existing deployment:
1. Log in to the server where IBM Content Navigator is installed.
2. Open the /configure/files/config/weblogic/webapp/WEB-INF/classes/ subdirectory of the
IBM Content Navigator installation directory.
3. Edit the log4j.properties file in a text editor.
The logging levels in log4j.properties file are, from the simplest to the most detailed, FATAL, ERROR,
WARN, INFO, DEBUG and TRACE.
For example, to set debug logging in the log4j.properties file, change the first line of the
log4j.properties file from:
log4j.category.com.ibm.ecm=ERROR, ibmcmisAppender
to
log4j.category.com.ibm.ecm=DEBUG, ibmcmisAppender
Collecting data before opening a problem management record (PMR) can help you to answer the following questions:
• Do the symptoms match any known problems? If so, has a fix or workaround been published?
• Can the problem be identified and resolved without a code fix?
• When does the problem occur?
For more information about the prerequisite software, see Prerequisites for installing IBM Content Navigator.
2. Recreate the problem with finest-level logging and ODWEK API trace logging enabled.
Important: After you gather all the information that is needed to open a problem report, restore your original
logging settings to control the size of your log files and to improve performance.
• For information about enabling finest-level logging, see:
o Configuring logging for IBM CMIS for Content Manager OnDemand on WebSphere Application
Server
o Configuring logging for IBM CMIS for Content Manager OnDemand on Oracle WebLogic Server
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 47
• For information about enabling ODWEK API trace logging, see Configuring ODWEK API logging.
3. Gather the IBM CMIS for Content Manager OnDemand log files:
• arswww.log
• Web application server log files:
o WebSphere Application Server users: SystemOut.log and trace.log
o Oracle WebLogic Server users: log4j.properties
For information about the location of the IBM CMIS for Content Manager OnDemand log files, see IBM CMIS for
Content Manager OnDemand log files
Recommendation: Copy the installation information from the About your IBM CMIS installation page on
the IBM CMIS for Content Manager OnDemand index page.
• How is your IBM CMIS for Content Manager OnDemand system configured?
Recommendation: Copy the configuration information from the About your IBM CMIS configuration
page on the IBM CMIS for Content Manager OnDemand index page, which includes information about
your IBM CMIS configuration, system properties, and environment variables.
• Is the IBM CMIS for Content Manager OnDemand installation a fresh installation or did you upgrade from
a previous version of IBM CMIS for Content Manager OnDemand?
• What is the operating system, including the version number, of the IBM CMIS for Content Manager
OnDemand server?
• What version of WebSphere Application Server or Oracle WebLogic Server is IBM CMIS for Content
Manager OnDemand deployed to? (For WebSphere Application Server, specify WebSphere Application
Server or WebSphere Application Server Network Deployment.)
• Was IBM CMIS for Content Manager OnDemand deployed automatically or manually?
• What type of environment is IBM CMIS for Content Manager OnDemand deployed to? For example is IBM
CMIS deployed to a single application server, an unmanaged node, a managed node, or an application
server cluster?
• How was IBM CMIS for Content Manager OnDemand configured? Did you use the IBM Content Navigator
Configuration and Deployment Tool or did you run a silent configuration by using the command-line
interface?
5. Describe the problem. Provide the following information to help IBM Software Support understand the problem
that you are encountering:
• What are you trying to do when the problem occurs?
• Can the problem be reproduced? If so, how? Provide specific steps to reproduce the problem.
• How many users are affected by this problem?
• What is the business impact of this problem?
• Is there a workaround for this problem?
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 48
If you cannot find the error message in the other IBM CMIS documentation and you need additional assistance, contact IBM
Software Support.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 49
IBM CMIS for Content Manager OnDemand Development
Content Management Interoperability Services (CMIS) is an open source OASIS standard that enables applications to work
with one or more content management systems by defining a standard domain model and standard set of services and
protocol bindings for Web Services and RESTful AtomPub.
The CMIS Web Services bindings and RESTful AtomPub bindings are described in the OASIS CMIS specification.
Specifically, the index page includes links to the service documents and information about the URI templates and service
collections that are defined for the repositories (IBM Content Manager OnDemand Folders) on your OnDemand server.
When IBM CMIS is properly configured and deployed, you can access the index page at
http://host_name:port/context_root/index.jsp. By default, the context root of IBM CMIS for Content
Manager OnDemand is odcmis.
You can use the information about the index page to:
• Interact directly with the OASIS CMIS Web Services binding or RESTful AtomPub binding
• Develop against a client API
The index page also includes links to the Web Services binding information and the RESTful Atom Protocol (AtomPub)
binding information in the OASIS CMIS specification.
• Query collection
This URL provides a feed of the objects that satisfy a predefined query.
• Unfiled collection
This URL provides a feed of the documents that are not filed in a folder in the repository.
For a list of the service collection URLs for your IBM CMIS for Content Manager OnDemand application, see the index page
at http://host_name:port/context_root/index.jsp. By default, the context root of IBM CMIS for Content
Manager is odcmis.
For more information, see section 3.7 Service Collections of the OASIS CMIS specification.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 50
IBM CMIS for Content Manager OnDemand URI templates
URI templates enable users to insert values in a standardized URI to retrieve specific data, such as a specific folder or
document, from the repository. The OASIS CMIS specification defines several URI templates.
For a list of the URI templates for your IBM CMIS for Content Manager OnDemand application, see the index page at
http://host_name:port/context_root/index.jsp. By default, the context root of IBM CMIS for Content
Manager OnDemand is odcmis.
For more information, see section 3.6.1 URI Templates of the OASIS CMIS specification.
Important: The IBM CMIS for Content Manager OnDemand documentation does not include specific guidance for
developing with the OASIS CMIS APIs. However, some of the resources in Useful resources provide additional guidance.
Useful resources
Useful resources that help you get started with OASIS Content Management Interoperability Services (CMIS) and CMIS
client applications are available online.
The OASIS CMIS Technical Committee maintains a website that includes information about various implementations of
CMIS at http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=cmis.
IBM maintains a page for Content Management Interoperability Services (CMIS) Information Management software, which
includes links to developerWorks topics and other useful resources, at http://www.ibm.com/software/data/content-
management/cm-interoperablity-services.html.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 51
IBM CMIS for Content Manager OnDemand implementation of the OASIS CMIS
specification
This release of IBM CMIS for Content Manager OnDemand is the implementation of the CMIS v1.0 with errata specification,
available here: https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=cmis. The implementation is based on
IBM Content Manager OnDemand Web Enablement Kit (ODWEK) Java API.
IBM CMIS for Content Manager includes a limited set of read-only functions from the CMIS specification. IBM CMIS for
Content Manager OnDemand does not support create, update, or delete operations.
One deployed instance of IBM CMIS for Content Manager OnDemand can be configured to work with only one IBM Content
Manager OnDemand server.
The following sections include important information about the implementation of the CMIS specification in IBM CMIS for
Content Manager OnDemand.
CMIS Repository
An IBM Content Manager OnDemand folder is the mechanism through which users search for documents that have
common properties (IBM Content Manager OnDemand fields). An IBM Content Manager OnDemand folder is not a
container for filing documents.
A CMIS repository is mapped to a single IBM Content Manager OnDemand folder. This is because searches in IBM Content
Manager OnDemand are performed on folders and are limited to a single folder. Therefore, an IBM Content Manager
OnDemand folder fulfills the OASIS CMIS query specification requirement which stipulates that queries are scoped to a
single repository.
The allowable actions that client applications can perform on the root folder are limited because IBM Content Manager
OnDemand does not have the concept of a root folder. In addition, the root folder does not contain any child documents or
folders.
Document retrieval
Because IBM Content Manager OnDemand does not support OASIS CMIS folders, you must use one of the following
methods to retrieve documents:
• By using the document ID
• By running a query
• By using the unfiled service collection
Unfiled documents
The getUnfiled operation returns all of the documents in the IBM Content Manager OnDemand repository. This is because
IBM Content Manager OnDemand documents are not filed in folders.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 52
Relationships
Relationships are not implemented in this version of the IBM CMIS for Content Manager OnDemand.
Because IBM Content Manager OnDemand does not have hierarchical folders, only the cmis:document and cmis:folder
base types are available. The CMISType.getSubTypes method always returns an empty list.
IBM Content Manager OnDemand does not have folders. Therefore, IBM CMIS for Content Manager OnDemand
implements the minimum CMISTypeFolder requirements of the OASIS CMIS specification.
Because of the limited CMISTypeFolder implementation, the following properties return a value of false:
• cmis:creatable
• cmis:fileable
• cmis:queryable
CMIS documents
An IBM Content Manager OnDemand document contains metadata and non-formatted data.
The allowable actions that client applications can perform on a document are limited because IBM CMIS for Content
Manager OnDemand provides a read-only subset of CMIS functions. If a client application invokes a method to delete or
update a document, IBM CMIS for Content Manager OnDemand throws a notSupported exception.
Content stream
The non-formatted data from an IBM Content Manager OnDemand document is retrieved in a byte array from the first
content stream in the CMIS document.
In IBM Content Manager OnDemand, documents that are large objects have data in multiple segments. However, in IBM
CMIS for Content Manager OnDemand, all of the segments are put into the first content stream. The segments cannot be
mapped to individual content streams because segments have pages and there is no mechanism to retrieve individual
pages in a segment.
Filing
IBM Content Manager OnDemand does not have folders. Therefore, the cmis:fileable property returns a value of false.
Versioning
IBM Content Manager OnDemand does not support document versions, so the cmis:versionable attribute will always return
false. The getAllVersions operation will always return a single version. The checkout and checkin methods will throw
notSupported exceptions or return empty lists if the method cannot throw this exception.
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 53
CMIS Folder
IBM Content Manager OnDemand does not have folders (OASIS CMIS folders that are used for filing documents). Therefore,
IBM CMIS for Content Manager OnDemand implements the minimum folder requirements of the OASIS CMIS specification.
Paging
The IBM CMIS for Content Manager OnDemand implementation for paging a list of query results is not efficient. Therefore,
it is recommended that you use queries that do not return a large number of results. If a query contains a large number of
results, the performance of the IBM CMIS for Content Manager OnDemand server can be impacted.
Query limitations
IBM Content Manager does not support all of the query operations that are supported by OASIS CMIS. IBM CMIS for
Content Manager OnDemand throws an exception if a client application submits a request for one of the following query
operations:
Planning, installing, and configuring IBM CMIS for Content Manager OnDemand 54