CMIS c1932200

IBM Content Management Interoperability Services for FileNet Content Manager
Version 1.0.0
Planning, Installing, and Configuring IBM Content Management Interoperability Services for FileNet Content Manager
SC19-3220-00
IBM Content Management Interoperability Services for FileNet Content Manager

Version 1.0.0
Planning, Installing, and Configuring IBM Content Management Interoperability Services for FileNet Content Manager
SC19-3220-00
Note Before using this information and the product it supports, read the information in Notices on page 83.
Edition notices This edition applies to version 5, release 0, modification 0 of IBM FileNet Content Manager (product number 5724-R81) and to all subsequent releases and modifications until otherwise indicated in new editions. Copyright IBM Corporation 2010, . US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
Contents
ibm.com and related resources. . . . . v
How to send your comments . . . . . . . . . v Contacting IBM . . . . . . . . . . . . . vi Configuring Content Engine API client logging 42
Deploying IBM CMIS for FileNet Content Manager . . . . . . . . . . 47

Deploying the IBM CMIS for FileNet Content Manager application by running the configuration tool . . . . . . . . . . . . . . . . Deploying the IBM CMIS for FileNet Content Manager application by running a silent configuration . . . . . . . . . . . . . Deploying the IBM CMIS for FileNet Content Manager application manually . . . . . . . Modifying the generic JVM arguments in WebSphere Application Server . . . . . . Importing the WS-Security policy set to WebSphere Application Server . . . . . . Manually deploying IBM CMIS for FileNet Content Manager . . . . . . . . . . . 47
Planning, installing, and configuring IBM CMIS for FileNet Content Manager . . . 1 IBM CMIS for FileNet Content Manager architecture overview . . . . . . . . . 3 Planning for IBM CMIS for FileNet Content Manager . . . . . . . . . . . 5
Prerequisites . . . . . . . . . . . . . . 5 Planning for WebSphere Application Server . . . . 5 Recommended server topology . . . . . . . . 6 User authentication and security. . . . . . . . 6 Support for IBM FileNet Content Manager CVL security . . . . . . . . . . . . . . . 6 Language support for IBM CMIS for FileNet Content Manager . . . . . . . . . . . . . . . . 7 Installation and configuration worksheets. . . . . 8 Installation and configuration worksheet . . . . 9 Silent installation and configuration worksheet . 11 Advanced configuration worksheet . . . . . 14
. 48 . 50 . 50 . 51 . 51
IBM CMIS for FileNet Content Manager Development . . . . . . . . . . . . 53

IBM CMIS for FileNet Content Manager index page IBM CMIS for FileNet Content Manager service collection URLs . . . . . . . . . . . . IBM CMIS for FileNet Content Manager URI templates . . . . . . . . . . . . . . OASIS CMIS specification . . . . . . . . . Useful resources . . . . . . . . . . . . . Extensions for IBM CMIS for FileNet Content Manager . . . . . . . . . . . . . . . Class display name extension . . . . . . . Hidden properties extension . . . . . . . . Choice list symbolic name extension . . . . . Choice list display name extension . . . . . Domain name extension . . . . . . . . . Object store ID extension . . . . . . . . . Object store database type extension . . . . . Records management extension. . . . . . . Text search engine extension. . . . . . . . GZIP compression extension. . . . . . . . IBM CMIS for FileNet Content Manager implementation of the OASIS CMIS specification . . Change token support . . . . . . . . . . Links in private working copy support . . . . Paging feed support . . . . . . . . . . Query support . . . . . . . . . . . . Versioning properties on document objects support. . . . . . . . . . . . . . . Best practices for developing client applications . . 53 54 54 55 55 56 56 57 57 57 57 58 58 58 58 59 59 60 60 61 61 63 63
Installing IBM CMIS for FileNet Content Manager . . . . . . . . . . . . . . 19

Installing the IBM CMIS for FileNet Content Manager software . . . . . . . . . Running the installation program . . . Running a silent installation . . . . . Installing Content Engine Client files for IBM for FileNet Content Manager . . . . . . . . . . . . . . CMIS . . . 19 20 21 22
Configuring IBM CMIS for FileNet Content Manager . . . . . . . . . . 25

Configuring the IBM CMIS for FileNet Content Manager web application . . . . . . . . Configuring IBM CMIS by running the configuration tool . . . . . . . . . Configuring IBM CMIS by running a silent configuration . . . . . . . . . . . Configuring advanced IBM CMIS for FileNet Content Manager properties . . . . . . Configuring single sign-on . . . . . . . Configuring Lightweight Third Party Authentication (LTPA) . . . . . . . . Configuring Lightweight Directory Access Protocol (LDAP) . . . . . . . . . . Configuring logging . . . . . . . . . Specifying log level entries . . . . . . Configuring log location and size . . . . Logged errors . . . . . . . . . .
Copyright IBM Corp. 2010,
. . . . . . . . . . .
. 25 . 25 . 27 . 30 . 35 . 36 . . . . . 38 39 40 41 42
Troubleshooting IBM CMIS for FileNet Content Manager . . . . . . . . . . 65

IBM CMIS for FileNet Content Manager log files . . 65
iii
Collecting data for IBM CMIS for FileNet Content Manager . . . . . . . . . . . . . . . 67 Error messages for IBM CMIS for FileNet Content Manager . . . . . . . . . . . . . . . 69
Accessibility features of IBM CMIS for FileNet Content Manager . . . . . . . 81 Notices . . . . . . . . . . . . . . 83

Trademarks . . . . . . . . . . . . . . 86
Removing IBM CMIS for FileNet Content Manager . . . . . . . . . . 79

Removing IBM CMIS for FileNet Content Manager from WebSphere Application Server . . . . . . 80
Index . . . . . . . . . . . . . . . 87
iv
Planning, Installing, and Configuring IBM CMIS for FileNet Content Manager
ibm.com and related resources

Product support and documentation are available from ibm.com.
Support and assistance

Product support is available from the IBM Support Portal at http:// www.ibm.com/software/data/content-management/filenet-content-manager/ support.html.
Information center
You can view the product documentation in an Eclipse-based information center on ibm.com at http://publib.boulder.ibm.com/infocenter/p8docs/v5r0m0/.
PDF publications
You can view the PDF files online by using the Adobe Acrobat Reader for your operating system. If you do not have the Acrobat Reader installed, you can download it from the Adobe website at http://www.adobe.com. See the IBM CMIS for FileNet Content Manager product publication library page for links to the PDF publications at http://www.ibm.com/support/ docview.wss?uid=swg27020097 How to send your comments Contacting IBM on page vi
How to send your comments

Your feedback helps IBM provide quality information. Send any comments that you have about this information or other documentation that IBM Software Development ships with its products. You can use the following methods to provide comments: v Click the Feedback link at the bottom of any topic in the information center. v Send your comments by email to comments@us.ibm.com. Include the name of the product, the version number of the product, and the name and publication number of the information (if applicable.) If you are commenting on specific text, include the location of the text (for example, a title, a table number, or a page number).
Consumability survey
You are invited to tell IBM how to improve the consumability of software products. If you want to help IBM make this product easier to use, take the Consumability Survey at http://www.ibm.com/software/data/info/ consumability-survey/.
Contacting IBM
To contact IBM customer service in the United States or Canada, call 1-800-IBM-SERV (1-800-426-7378). To learn about available service options, call one of the following numbers: v In the United States: 1-888-426-4343 v In Canada: 1-800-465-9600 For more information about how to contact IBM, see the Contact IBM Web site at http://www.ibm.com/contact/us/.
vi
Planning, installing, and configuring IBM CMIS for FileNet Content Manager
IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) enables clients applications that use the OASIS CMIS standard to work with content that is stored on IBM FileNet Content Engine. Use this information to plan for, install, or configure IBM CMIS for FileNet Content Manager. To use this information, you should be familiar with one or more of the following operating systems: v AIX v Linux v Microsoft Windows In addition, to install and configure IBM CMIS for FileNet Content Manager, you should be familiar with: v WebSphere Application Server or WebSphere Application Server Network Deployment v IBM FileNet Content Engine v IBM FileNet Content Manager v System operation and network administration The following table summarizes and links to the high-level tasks for planning, installing, and configuring IBM CMIS for FileNet Content Manager.
Table 1. Planning, installation, configuration, and administration tasks Task What you can do When to perform Perform before you begin the product installation.
Planning for IBM CMIS for Verify that you have all the FileNet Content Manager on prerequisite products page 5 installed and configured. Analyze your business needs and decide how to structure your content management system. The installation program Installing IBM CMIS for FileNet Content Manager on guides you through the IBM page 19 CMIS for FileNet Content Manager installation.
Perform once to install the product.
Configuring IBM CMIS for The configuration tool guides Perform as needed to configure the product. FileNet Content Manager on you through the IBM CMIS page 25 for FileNet Content Manager configuration.
Table 1. Planning, installation, configuration, and administration tasks (continued) Task What you can do When to perform Perform as needed to deploy changes to the configuration to WebSphere Application Server.
Deploying IBM CMIS for The configuration tool guides FileNet Content Manager on you through deploying IBM page 47 CMIS for FileNet Content Manager on WebSphere Application Server, or you can manually deploy IBM CMIS for FileNet Content Manager. IBM CMIS for FileNet Content Manager Development on page 53 Use the OASIS CMIS specification and the IBM FileNet P8 extensions to interact with the OASIS CMIS bindings or to develop against a CMIS client API.
Perform as needed.
Perform once to remove the The uninstallation wizard Removing IBM CMIS for FileNet Content Manager on guides you through removing product. page 79 IBM CMIS for FileNet Content Manager from the server. Then you can remove IBM CMIS for FileNet Content Manager from WebSphere Application Server. Troubleshooting IBM CMIS Troubleshoot IBM CMIS for for FileNet Content Manager FileNet Content Manager. on page 65 Perform as needed.
IBM CMIS for FileNet Content Manager architecture overview

IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) is a web application that enables client applications that use the OASIS CMIS standard to work with content that is stored on IBM FileNet Content Engine. 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 FileNet Content Manager is the implementation of the OASIS CMIS standard for IBM FileNet Content Manager. The following diagram shows how IBM CMIS for FileNet Content Manager connects to your IBM FileNet P8 system and your client application.
IBM FileNet P8 System Content Engine server WebSphere Application Server IBM CMIS for FileNet Content Manager server WebSphere Application Server IBM CMIS for FileNet Content Manager IBM FileNet Content Engine Client Java API REST and Web Services Bindings CMIS client application
IBM FileNet Content Engine
CMIS-enabled enterprise content management system

It is recommended that you deploy IBM CMIS for FileNet Content Manager to a dedicated application server. In addition, it is recommended that you dedicate a server in your IBM FileNet P8 system to IBM CMIS for FileNet Content Manager. IBM CMIS for FileNet Content Manager communicates with Content Engine by using the Content Engine Client Java API. After you install IBM CMIS for FileNet Content Manager, you must install the Content Engine Client on the machine where IBM CMIS for FileNet Content Manager will be deployed and install the Content Engine Client Java API files in the IBM CMIS for FileNet Content Manager installation directory.
IBM CMIS for FileNet Content Manager and other CMIS-enabled enterprise content management systems communicate with client applications by using REST and Web Services bindings.
Planning for IBM CMIS for FileNet Content Manager

The following topics can help you plan your IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) system installation and configuration. Prerequisites Planning for WebSphere Application Server Recommended server topology on page 6 User authentication and security on page 6 Language support for IBM CMIS for FileNet Content Manager on page 7 Installation and configuration worksheets on page 8
Prerequisites
The IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) hardware and software requirements document provides detailed information about the supported versions of each prerequisite application. A complete and up-to-date list of the hardware and software requirements for IBM CMIS for FileNet Content Manager is available on the IBM support site at http://www.ibm.com/support/docview.wss?uid=swg27019859.
Planning for WebSphere Application Server

IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) can be deployed to several different WebSphere Application Server topologies. Important: Regardless of the WebSphere Application Server topology that you deploy to, it is strongly recommended that you install IBM CMIS to a dedicated application server or application server cluster for the following reasons: v 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. v When more than one application is installed in an application server, the scalability of each application decreases.
WebSphere Application Server topologies

If you use WebSphere Application Server, you can deploy IBM CMIS to a dedicated application server.
WebSphere Application Server Network Deployment topologies

If you use WebSphere Application Server Network Deployment, you can deploy IBM CMIS to the following topologies: 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.
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. 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.
Recommended server topology

IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) is an optional component of an IBM FileNet Content Manager system. The server configuration that you use can affect the performance and scalability of your system. A IBM FileNet P8 system generally requires a set of dedicated servers. The components of an IBM FileNet P8 system are often spread across several servers. For better performance and scalability, it is recommended that you install IBM FileNet Content Engine and any client applications, such as IBM CMIS for FileNet Content Manager, on separate servers. The following list describes the recommended server configuration for a scenario that does not include a high-availability system: v Server 1: Content Search Engine, which is required for full-text search. v Server 2: WebSphere Application Server, Content Engine v Server 3: WebSphere Application Server, IBM CMIS for FileNet Content Manager v Server 4: Database v Server 5: Directory service servers
User authentication and security

IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) uses the same LDAP server and the same LTPA keys that are configured for the IBM FileNet Content Engine server. You must enable single sign-on (SSO) between the application servers that host IBM FileNet Content Engine and IBM CMIS for FileNet Content Manager. In addition, you must decide how to implement support for IBM FileNet Content Manager CVL security in your IBM CMIS for FileNet Content Manager application. Support for IBM FileNet Content Manager CVL security
Support for IBM FileNet Content Manager CVL security

By default, IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) caches controlled vocabulary lists (CVLs) for all users to improve performance. However, when IBM CMIS for FileNet Content Manager caches the CVLs, the security settings that are configured for the CVLs in your IBM FileNet Content Manager system are ignored.
If your IBM FileNet Content Manager CVLs are configured to prevent some users from seeing certain CVLs, you can configure IBM CMIS for FileNet Content Manager to honor the CVL security settings. Related reference CVL caching (CVL_Cache) on page 32
Language support for IBM CMIS for FileNet Content Manager

The installation program, configuration tool, and error messages for IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) are provided in several languages. You can specify the language that is displayed in the installation program and the configuration tool. However, IBM CMIS uses locale settings to determine the language in which to display the following information: v Error messages in HTTP responses v IBM CMIS index page, about page, and configuration page v IBM FileNet P8 metadata, such as type definition and property definition display names and descriptions If you use REST services, IBM CMIS 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 sets 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 sets 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:
v 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. v 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, 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:
fr;q=1, en-US;q=1, de;q=.9
IBM CMIS for FileNet Content Manager is available in the following languages:
Table 2. Supported IBM CMIS for FileNet Content Manager languages and language codes Language Chinese, Simplified Chinese, Traditional English French German Italian Japanese Korean Portuguese, Brazilian Spanish Language code zh_CN zh_TW en fr de it ja ko pt_BR es
In addition, variations of the following languages are partially supported: v Variations of Chinese are displayed in Simplified Chinese v Variations of Portuguese are displayed in Brazilian Portuguese Important: IBM CMIS returns the response (such as messages and display names) in supported languages only. IBM CMIS does not return responses in languages that are not supported, even if the language is supported by the underlying repository.
Installation and configuration worksheets

Before you install and configure IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS), you should work with your Content Engine system administrator and your WebSphere Application Server system administrator to collect the information that you must provide when installing and configuring IBM CMIS. Use the following worksheets to plan your IBM CMIS installation and configuration: Installation and configuration worksheet on page 9 Silent installation and configuration worksheet on page 11 Advanced configuration worksheet on page 14
Installation and configuration worksheet

Work with your Content Engine system administrator and your WebSphere Application Server system administrator to collect the information that you must provide when installing and configuring IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS).
Installation information
When you install IBM CMIS for FileNet Content Manager, you specify the directory in which to install the IBM CMIS software. After you install the IBM CMIS software, you must install the Content Engine Client API files in the IBM CMIS installation directory.
Table 3. Installation parameters Parameter Installation directory Description IBM CMIS installation directory. v On AIX and Linux, the default installation directory is /opt/IBM/FN_CMIS. v On Windows, the default installation directory is C:\Program Files\IBM\FN_CMIS. Value
Basic configuration parameters

When you run the configuration tool you specify information about your Content Engine system and your WebSphere Application Server system. You also specify basic information about your IBM CMIS system that client applications use when sending requests to IBM CMIS for FileNet Content Manager. Collect the following information about the Content Engine server to which you are connecting.
Table 4. Content Engine parameters Parameter Content Engine URL Description The URL that applications use to connect to Content Engine. The URL is case-sensitive and has the format: iiop://host_name:2809/FileNet/ Engine. FileNet P8 domain name Optional. If you do not provide a domain name, IBM CMIS connects to the default domain. Content Engine user name If you want to verify the connection to the Content Engine system, you must provide a user name. If you want to verify the connection to the Content Engine system, you must provide a password. Value
Content Engine password
Collect the following information about how you plan to authenticate to IBM CMIS after it is deployed.
Table 5. Application security parameters Parameter Authentication method for web services Description The authentication method that client applications use when sending requests to the IBM CMIS web services. Valid values include: HTTP basic authentication This method uses an encoded user name and password in an HTTP header to authenticate. WS-Security authentication This method uses a WS-Security SOAP header to authenticate. Value
Collect the following information about your WebSphere Application Server system.
Table 6. WebSphere Application Server parameters Parameter Description Value
WebSphere Application The instance of WebSphere Application Server installation directory Server to which you are deploying IBM CMIS. v On AIX, the default installation directory is /usr/IBM/WebSphere/ AppServer. v On Linux, the default installation directory is /opt/IBM/WebSphere/ AppServer v On Windows, the default installation directory is C:\Program Files\IBM\WebSphere\AppServer. Application server profile The WebSphere Application Server profile on which you are deploying IBM CMIS. Important: You must deploy IBM CMIS to an existing profile that has WebSphere Application Server security enabled. The WebSphere Application Server administrator user name. The WebSphere Application Server administrator password.
Administrator user name Password
10
Table 6. WebSphere Application Server parameters (continued) Parameter Deployment environment Description The type of WebSphere Application Server environment into which you are deploying IBM CMIS. Valid values include: Single application server Use this option if you plan to deploy IBM CMIS to an application server on WebSphere Application Server or an unmanaged node or managed node on WebSphere Application Server Network Deployment. Application server cluster Use this option if you plan to deploy IBM CMIS to an application server cluster on WebSphere Application Server Network Deployment. Application server node and The node and server on which you are server name deploying IBM CMIS. Important: You must deploy IBM CMIS to an existing server. This parameter applies to a Single application server deployment environment only. Application server cluster name The cluster on which you are deploying IBM CMIS. Important: You must deploy IBM CMIS to an existing cluster. This parameter applies to an Application server cluster deployment environment only. Application name The name of the IBM CMIS application to display in the WebSphere Application Server administrative console. Optional. The default name is fncmis. Value
Silent installation and configuration worksheet

Work with your Content Engine system administrator and your WebSphere Application Server system administrator to collect the information that you must provide when silently installing and configuring IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS).
Installation information
When you install IBM CMIS for FileNet Content Manager, you specify the directory in which to install the IBM CMIS software.
11
After you install the IBM CMIS software, you must install the Content Engine Client API files in the IBM CMIS installation directory.
Table 7. Installation parameters Parameter USER_INSTALL_DIR Description IBM CMIS installation directory. v On AIX and Linux, the default installation directory is /opt/IBM/FN_CMIS. v On Windows, the default installation directory is C:\Program Files\IBM\FN_CMIS. Value
Basic configuration parameters

To run the silent configuration program, you must specify information about your Content Engine system and your WebSphere Application Server system in the silent configuration response file. You must also specify basic information about your IBM CMIS system that client applications use when sending requests to IBM CMIS for FileNet Content Manager. Collect the following information about the Content Engine server to which you are connecting.
Table 8. Content Engine parameters Parameter USER_CE_URI Description Content Engine URL. The URL that applications use to connect to Content Engine. The URL is case-sensitive and has the format: iiop://host_name:2809/FileNet/ Engine. USER_P8_DOMAIN FileNet P8 domain name. Optional. If you do not provide a domain name, IBM CMIS connects to the default domain. Value
Collect the following information about how you plan to authenticate to IBM CMIS after it is deployed.
12
Table 9. Application security parameters Parameter USER_WS_AUTH Description Authentication method for web services. The authentication method that client applications use when sending requests to the IBM CMIS web services. Valid values include: 0 HTTP basic authentication. This method uses an encoded user name and password in an HTTP header to authenticate. WS-Security authentication. This method uses a WS-Security SOAP header to authenticate. Value
Collect the following information about your WebSphere Application Server system.
Table 10. WebSphere Application Server parameters Parameter Description Value
USER_APPSERVER_HOME WebSphere Application Server installation directory. The instance of WebSphere Application Server to which you are deploying IBM CMIS. v On AIX, the default installation directory is /usr/IBM/WebSphere/ AppServer. v On Linux, the default installation directory is /opt/IBM/WebSphere/ AppServer v On Windows, the default installation directory is C:\Program Files\IBM\WebSphere\AppServer. USER_APPSERVER _PROFILE_NAME The WebSphere Application Server profile on which you are deploying IBM CMIS. Important: You must deploy IBM CMIS to an existing profile that has WebSphere Application Server security enabled. The WebSphere Application Server administrator user name. The WebSphere Application Server administrator password.
USER_WASADMIN_ID USER_WASADMIN_PW
13
Table 10. WebSphere Application Server parameters (continued) Parameter USER_DEPLOY_TYPE Description The type of WebSphere Application Server environment into which you are deploying IBM CMIS. Valid values include: appserver Use this option if you plan to deploy IBM CMIS to an application server on WebSphere Application Server or an unmanaged node or managed node on WebSphere Application Server Network Deployment. cluster Use this option if you plan to deploy IBM CMIS to an application server cluster on WebSphere Application Server Network Deployment. USER_APPSERVER_NAME The name of the server on which you are deploying IBM CMIS. Important: You must deploy IBM CMIS to an existing server. This parameter applies to an appserver deployment environment only. USER_APPSERVER_NODE The name of the application server node that contains the application server on which you are deploying IBM CMIS. This parameter applies to an appserver deployment environment only. USER_APPSERVER_ CLUSTER_NAME The cluster on which you are deploying IBM CMIS. Important: You must deploy IBM CMIS to an existing cluster. This parameter applies to a cluster deployment environment only. USER_APP_NAME The name of the IBM CMIS application to display in the WebSphere Application Server administrative console. Optional. The default name is fncmis. Value
Advanced configuration worksheet

IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) includes advanced configuration parameters that enable you to tune your system for optimal performance and scaling. However, you can run IBM CMIS by using the default values that are specified in the advanced configuration properties file.
14
Collect information about the advanced parameters that you want to configure for your IBM CMIS environment. Tip: It is recommended that you review the topics for each advanced configuration parameter for additional information about the parameters and to determine whether it makes sense to modify the parameters for your environment.
Table 11. Advanced configuration parameters Parameter cmisURI Description The URL to which client applications send requests. For most IBM CMIS configurations, you do not need to specify a value for this parameter. However, you can specify the URL by which IBM CMIS and client applications communicate if you want to force client applications to access IBM CMIS through a specific URL or if your proxy server settings cause IBM CMIS to produce invalid URLs. The URL must have the form http://host_name:port. CMC_TIME_TO_LIVE The length of time (in milliseconds) that the Content Engine metadata is kept in the Content Engine Client Metadata Cache. The default value is 3600000 milliseconds. CRC_TIME_TO_LIVE The length of time (in milliseconds) that object stores are kept in the client-side server cache. The default value is 3600000 milliseconds. checkout_copycontent Whether to copy the content stream of a checked out document to the content stream of the private working copy. The default value is true. Valid values include: false true defaultMaxItems Do not copy the content stream to the Private Working Copy. Copy the content stream to the Private Working Copy. Value
The maximum number of items to return when an HTTP request does not specify a value for the maxItems parameter. The default value is 25.
15
Table 11. Advanced configuration parameters (continued) Parameter CVL_Cache Description Whether to cache IBM FileNet Content Manager controlled vocabulary lists (CVLs) for all users. If the CVLs are cached, IBM CMIS ignores any CVL security settings. By default, IBM CMIS caches the CVLs to improve performance. The default value is true. Valid values include: false Do not cache the CVLs for all users. When this value is specified, IBM CMIS honors the security settings that are configured for IBM FileNet Content Manager CLVs. Cache the CVLs for all users. When this value is specified, IBM CMIS ignores the security settings that are configured for IBM FileNet Content Manager CLVs. Value
true
SecureMetadataCache
Whether to cache class definition metadata for all users. If the class definition metadata is cached, IBM CMIS displays the following properties to all users regardless of their access control list (ACL) permissions: v Creator v DateCreated By default, IBM CMIS caches the class definition metadata to improve performance. The default value is false. Valid values include: false Cache the class definition metadata. When this value is specified, IBM CMIS ignores the ACL settings for the Creator and DateCreated properties. Do not cache the class definition metadata. When this value is specified, IBM CMIS honors the ACL settings for the Creator and DateCreated properties.
true
16
Table 11. Advanced configuration parameters (continued) Parameter filterHiddenProperties Description Whether to return hidden properties to client applications. The default value is true. Valid values include: false Do not filter hidden properties. When this value is specified, IBM CMIS returns hidden properties. Filter hidden properties. When this value is specified, IBM CMIS does not return hidden properties. Value
true
com.ibm.xml.xlxp2.api. util.encoding.DataSource Factory.bufferLength
The size of the internal buffers that are used to create documents with content on the repository when using IBM CMIS Web Services. WebSphere Application Server uses a 65536 byte buffer. However, IBM CMIS can override this setting. By default IBM CMIS uses a 2048 byte buffer. It is recommended that you do not change the default value because increasing the size of the buffer can cause memory consumption issues when uploading documents larger than 50 MB through IBM CMIS Web Services. If you specify 0 for this parameter, IBM CMIS does not override the default value that is set in WebSphere Application Server.
queryTimeLimit
The maximum length of time (in seconds) to run a query on the repository. The default value is 180 seconds.
Related tasks Configuring advanced IBM CMIS for FileNet Content Manager properties on page 30
17
18
Installing IBM CMIS for FileNet Content Manager

You can install IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) on AIX, Linux, or Windows operating systems. Before you install IBM CMIS, you must install the prerequisite software on the server where you plan to host IBM CMIS. For more information, see the Prerequisites on page 5 topic. In addition, it is recommended that you complete the Installation and configuration worksheets on page 8. The high-level installation and configuration sequence for IBM CMIS for FileNet Content Manager is: 1. Install the IBM CMIS for FileNet Content Manager software. 2. Install the Content Engine Client files for IBM CMIS for FileNet Content Manager. 3. Configure IBM CMIS for FileNet Content Manager. 4. Deploy IBM CMIS for FileNet Content Manager. The installation instructions assume that you have a working IBM FileNet Content Manager system and that you are installing IBM CMIS for FileNet Content Manager to the default installation directory.
Table 12. Default installation directory on each supported operating system Operating system AIX Linux Windows Default directory /opt/IBM/FN_CMIS /opt/IBM/FN_CMIS C:\Program Files\IBM\FN_CMIS
To install IBM CMIS for FileNet Content Manager, complete the following tasks. 1. Installing the IBM CMIS for FileNet Content Manager software 2. Installing Content Engine Client files for IBM CMIS for FileNet Content Manager on page 22 Related concepts Prerequisites on page 5 Related reference Installation and configuration worksheets on page 8
Installing the IBM CMIS for FileNet Content Manager software

You can install the IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) software on the workstation by running the installation program or by running a silent installation. Before you install IBM CMIS, you must install the prerequisite software on the server where you plan to host IBM CMIS. For more information, see the Prerequisites on page 5 topic.
19
In addition, it is recommended that you complete the Installation and configuration worksheets on page 8. To install the IBM CMIS software, complete one of the following tasks. Running the installation program Running a silent installation on page 21
Running the installation program

You can install IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) on the server by running the installation program. Before you install IBM CMIS, you must install the prerequisite software on the server where you plan to host IBM CMIS. For more information, see the Prerequisites on page 5 topic. In addition, it is recommended that you complete the Installation and configuration worksheets on page 8. To install IBM CMIS for FileNet Content Manager: 1. Start the installation program:
Operating system AIX Installation command At a command prompt, change to the IBM CMIS for FileNet Content Manager CD or to the directory where you downloaded the product and enter: ./install.sh. At a command prompt, change to the IBM CMIS for FileNet Content Manager CD or to the directory where you downloaded the product and enter: ./install.sh. At a command prompt, change to the IBM CMIS for FileNet Content Manager CD or to the directory where you downloaded the product and enter: install.bat.
Linux
Windows
2. Read and accept the software license terms. 3. Specify the installation directory. 4. Verify the installation location and click Install. After you install IBM CMIS for FileNet Content Manager, you must: 1. Install the Content Engine Client API files in the IBM CMIS for FileNet Content Manager installation directory. 2. Configure IBM CMIS for FileNet Content Manager. 3. Deploy IBM CMIS for FileNet Content Manager to WebSphere Application Server.
20
Related tasks Installing Content Engine Client files for IBM CMIS for FileNet Content Manager on page 22 Configuring the IBM CMIS for FileNet Content Manager web application on page 25 Deploying IBM CMIS for FileNet Content Manager on page 47 Related reference Installation and configuration worksheets on page 8
Running a silent installation

You can install IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) on the server by running a silent installation. Before you install IBM CMIS, you must install the prerequisite software on the server where you plan to host IBM CMIS. For more information, see the Prerequisites on page 5 topic. In addition, it is recommended that you complete the Installation and configuration worksheets on page 8. Important: You must save the installation image to the workstation before you run a silent installation so that you can edit the response file. A silent installation uses a response file that contains the installation parameters that you specify. When you run a silent installation, the installation program does not display any installation windows or messages. Instead, any messages and errors are written to the following log files in the log directory: v fncmis-install.log v fncmis-install-ia.log To install IBM CMIS for FileNet Content Manager: 1. Open the response file:
Operating system AIX Linux Windows Response file fncmis-UNIX_SilentInstall.properties fncmis-UNIX_SilentInstall.properties fncmis-WIN_SilentInstall.properties
2. Edit the following values in the response file: a. Set the LICENSE_ACCEPTED parameter to true. b. Set the USER_INSTALL_DIR to the directory where you want to install IBM CMIS for FileNet Content Manager. Important: On Windows, you must escape colons (:) and backslashes (\) by adding a backslash before each colon or backslash in the installation directory file path. For example, C:\Program Files\IBM\FN_CMIS would have the following format:
C\:\\Program Files\\IBM\\FN_CMIS
The response file must contain the following text:

LICENSE_ACCEPTED=true USER_INSTALL_DIR=installation directory
21
3. Save your changes to the response file. 4. At a command prompt, change to the directory that contains the installation program and run the following command:
Operating system AIX Linux Windows Command ./install.sh -s ./install.sh -s install.bat -s
After you install IBM CMIS for FileNet Content Manager, you must: 1. Install the Content Engine Client API files in the IBM CMIS for FileNet Content Manager installation directory. 2. Configure IBM CMIS for FileNet Content Manager. 3. Deploy IBM CMIS for FileNet Content Manager to WebSphere Application Server. Related tasks Installing Content Engine Client files for IBM CMIS for FileNet Content Manager Configuring the IBM CMIS for FileNet Content Manager web application on page 25 Deploying IBM CMIS for FileNet Content Manager on page 47 Related reference Installation and configuration worksheets on page 8
Installing Content Engine Client files for IBM CMIS for FileNet Content Manager
After you install the IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) software, you must install the Content Engine Client API files in the IBM CMIS installation directory. The Content Engine Client API files enable IBM CMIS for FileNet Content Manager to communicate with the IBM FileNet Content Manager server. Important: You must complete this task before you can configure IBM CMIS. If the Content Engine Client is already installed on the server where IBM CMIS is installed, you must run the Content Engine Client installation program to add the Content Engine Client API files to the IBM CMIS installation directory. If the Content Engine Client is not installed, you must install the Content Engine Client and add the Content Engine Client API files to the IBM CMIS installation directory. To add the Content Engine Client API files to the IBM CMIS installation directory: 1. Run the Content Engine Client installation program. 2. If the Content Engine Client is not installed on the server, specify the directory in which to install the Content Engine Client. Important: Do not specify the IBM CMIS installation directory as the Content Engine Client installation directory. 3. In the Select FileNet P8 Applications window, select IBM CMIS for FileNet Content Manager.
22
4. In the IBM CMIS for FileNet Content Manager Installation Path window, take one of the following actions: v If IBM CMIS is already installed on the server, verify that the installation program detected the IBM CMIS installation directory. v If IBM CMIS is not installed on the server, specify the directory where you will install IBM CMIS. By default, IBM CMIS is installed in the following directory:
Table 13. Default installation directory on each supported operating system Operating system AIX Linux Windows Default directory /opt/IBM/FN_CMIS /opt/IBM/FN_CMIS C:\Program Files\IBM\FN_CMIS
To verify that the Content Engine Client files were installed to the IBM CMIS installation directory, open the CE_API\lib subdirectory of the installation directory and verify that the directory contains the following files: v Jace.jar v log4j.jar After you install the Content Engine Client files for IBM CMIS for FileNet Content Manager, you can configure IBM CMIS. Related tasks Configuring the IBM CMIS for FileNet Content Manager web application on page 25 Related reference Installation and configuration worksheets on page 8
23
24
Configuring IBM CMIS for FileNet Content Manager

After you install IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS), you must configure the IBM CMIS application and your web application server. To configure IBM CMIS, complete the following tasks. Configuring the IBM CMIS for FileNet Content Manager web application Configuring single sign-on on page 35 Configuring logging on page 39
Configuring the IBM CMIS for FileNet Content Manager web application
Before you can deploy IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS), you must configure and build the IBM CMIS web application. Before you can configure the web application, you must install the Content Engine Client API files in the IBM CMIS installation directory. In addition, it is recommended that you complete the Installation and configuration worksheets on page 8. To configure the IBM CMIS web application, complete the tasks that are appropriate for your environment: Configuring IBM CMIS by running the configuration tool Configuring IBM CMIS by running a silent configuration on page 27 Configuring advanced IBM CMIS for FileNet Content Manager properties on page 30 Related tasks Installing Content Engine Client files for IBM CMIS for FileNet Content Manager on page 22
Configuring IBM CMIS by running the configuration tool

You can use the configuration tool to build and deploy the IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) web application EAR file. The configuration tool validates the information that you specify about your IBM FileNet Content Manager system and your WebSphere Application Server environment before you deploy the IBM CMIS web application. Before you can configure the web application, you must install the Content Engine Client API files in the IBM CMIS installation directory. In addition, it is recommended that you complete the Installation and configuration worksheets on page 8. Tip: The configuration tool retains your configuration and deployment information, except for user IDs and passwords, across sessions. If you need to modify your configuration, you can rerun the configuration tool without having to enter each configuration option again.
25
Only the most recent configuration information is retained. To back up a previous configuration, you must save a copy of the following files, which are located in profiles/profile1 subdirectory of the IBM CMIS installation directory: v configure-fncmis.properties v fncmis.properties After you Configure and Deploy, if any change has to be done to the configuration, the configuration wizard can be re-run. All values (except IDs and passwords) will be retained in the configuration wizard. To configure IBM CMIS: 1. Start the configuration tool:
Operating system AIX Installation command At a command prompt, change to the config subdirectory of the IBM CMIS for FileNet Content Manager installation directory and enter: ./config.sh. At a command prompt, change to the config subdirectory of the IBM CMIS for FileNet Content Manager installation directory and enter: ./config.sh. At a command prompt, change to the config subdirectory of the IBM CMIS for FileNet Content Manager installation directory and enter: config.bat.
Linux
Windows
2. Specify the information to connect to the Content Engine server: a. Specify the Content Engine URL. The URL is case-sensitive and has the format iiop:host_name:2809/FileNet/Engine. b. Specify the FileNet P8 domain name. If you do not specify a domain, IBM CMIS uses the default domain. c. Optional: Test the connection to the Content Engine server to ensure that you entered the Content Engine URL and FileNet P8 domain name correctly. To test the connection, you must provide the following information: v Content Engine user name v Password v WebSphere Application Server installation directory 3. Specify the authentication method that client applications use when sending requests to the IBM CMIS web services: v HTTP Basic Authentication - Select this option if you want client applications to use an HTTP header that contains an encoded user name and password to authenticate. v WS-Security Authentication - Select this option if you want client applications to use a WS-Security SOAP header to authenticate. 4. Verify your IBM CMIS configuration information. 5. Specify how you are deploying IBM CMIS: v Automatically deploy IBM CMIS - If you select this option, the configuration tool automatically deploys IBM CMIS to the selected instance of WebSphere Application Server. This option is recommended for most users.
26
v Manually deploy IBM CMIS - If you select this option, the configuration tool does not deploy IBM CMIS. You must manually deploy IBM CMIS to a supported instance of WebSphere Application Server. This option is recommended only for expert WebSphere Application Server users. 6. Specify the instance of WebSphere Application Server to which to deploy IBM CMIS. Important: You must deploy IBM CMIS to an existing WebSphere Application Server profile that has WebSphere Application Server security enabled. a. If prompted, specify the WebSphere Application Server installation directory. If you tested the connection to the Content Engine server, the configuration tool uses the installation directory that you specified in the Content Engine Connection Information window. b. Specify the application server profile to which to deploy IBM CMIS. c. Specify the administrator user name and password for the selected application server profile. d. If the application server profile contains application servers and application server clusters, specify the type of server to which you plan to deploy IBM CMIS. e. Specify the cluster or application server to which to deploy IBM CMIS. Remember: It is recommended that you deploy IBM CMIS to a dedicated application server or application server cluster. f. Optional: Specify the name to display for the IBM CMIS application in WebSphere Application Server. The default display name for the application is FN_CMIS. 7. Verify your WebSphere Application Server deployment information and click Next. To validate that IBM CMIS was successfully deployed, start the IBM CMIS application on WebSphere Application Server and open the IBM CMIS index page, index.jsp. Related concepts IBM CMIS for FileNet Content Manager index page on page 53 Related tasks Configuring advanced IBM CMIS for FileNet Content Manager properties on page 30
Configuring IBM CMIS by running a silent configuration

You can use the silent configuration program to build and deploy the IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) web application EAR file. Before you can configure the web application, you must install the Content Engine Client API files in the IBM CMIS installation directory. In addition, it is recommended that you complete the Installation and configuration worksheets on page 8. A silent configuration uses a response file that contains the configuration and deployment parameters that you specify. When you run a silent configuration, the
27
configuration program does not display any configuration windows or messages. Instead, any messages and errors are written to the fncmis-config.log file in the log directory. To configure the IBM CMIS for FileNet Content Manager application: 1. Open the response file:
Operating system AIX Linux Windows Response file config/fncmisUNIX_SilentConfig.properties config/fncmisUNIX_SilentConfig.properties config\fncmisWIN_SilentConfig.properties
2. Specify the information to connect to the Content Engine server: a. Set the USER_CE_URI parameter to the URL of the Content Engine server. The URL is case-sensitive and has the format iiop://host_name:2809/ FileNet/Engine. b. Set the USER_P8_DOMAIN parameter to the IBM FileNet P8 domain name. If you do not specify a domain, IBM CMIS uses the default domain. 3. Set the USER_WS_AUTH parameter to one of the following values to specify the authentication method that client applications use when sending requests to the IBM CMIS web services: v 0 - Specify 0 to use HTTP Basic Authentication, an encoded user name and password in an HTTP header, to authenticate. v 1 - Specify 1 to use WS-Security Authentication, a WS-Security SOAP header, to authenticate. 4. Set the USER_MANUAL_DEPLOY parameter to one of the following values to specify how you want to deploy IBM CMIS: v 0 - Specify 0 to deploy IBM CMIS to the instance of WebSphere Application Server that you specify in the response file. If you specify 0, you must specify values for the parameters in the Web Application Deployment section of the response file. v 1 - Specify 1 to manually deploy IBM CMIS. If you specify 1, the configuration program generates the application EAR file but does not deploy IBM CMIS. You must manually deploy IBM CMIS to a supported instance of WebSphere Application Server. If you specify 1, you do not need to specify values for the parameters in the Web Application Deployment section of the response file. 5. Specify the information about the WebSphere Application Server environment to which you want to deploy IBM CMIS. Important: You must deploy IBM CMIS to an existing WebSphere Application Server profile that has WebSphere Application Server security enabled. a. Set the USER_APPSERVER_HOME parameter to the instance of WebSphere Application Server to which you want to deploy IBM CMIS. Important: On Windows, you must escape colons (:) and backslashes (\) by adding a backslash before each colon or backslash in the installation directory file path. For example, C:\Program Files\IBM\WebSphere\ AppServer would have the following format:
28
C\:\\Program Files\\IBM\\WebSphere\\AppServer
b. Set the USER_APPSERVER_PROFILE_NAME parameter to the WebSphere Application Server profile to which you want to deploy IBM CMIS. The default profile is AppSrv01. c. Set the USER_WASADMIN_ID parameter to the administrator user name for the specified application server profile. d. Set the USER_WASADMIN_PW parameter to the administrator password for the specified application server profile. e. Set the USER_DEPLOY_TYPE parameter to one of the following values: appserver Specify appserver to deploy IBM CMIS to an application server on WebSphere Application Server or to a managed node or an unmanaged node on WebSphere Application Server Network Deployment. cluster Specify cluster to deploy IBM CMIS to a cluster on WebSphere Application Server Network Deployment. f. If you specified USER_DEPLOY_TYPE=appserver, specify values for the following properties. Remember: It is recommended that you deploy IBM CMIS to a dedicated application server. 1) Set the USER_APPSERVER_NAME parameter to the name of the application server on which to deploy IBM CMIS. 2) Set the USER_APPSERVER_NODE parameter to the name of the application server node that contains the application server on which to deploy IBM CMIS. g. If you specified USER_DEPLOY_TYPE=cluster, set the USER_APPSERVER_CLUSTER parameter to the name of the application server cluster on which to deploy IBM CMIS. Remember: It is recommended that you deploy IBM CMIS to a dedicated application server cluster. h. Optional: Set the USER_APP_NAME parameter to specify the name to display for the IBM CMIS application in WebSphere Application Server. The default display name for the application is FN_CMIS. 6. Save your changes to the response file. 7. At a command prompt, change to the config subdirectory of the IBM CMIS installation directory and run the following command:
Operating system AIX Linux Windows Command ./config.sh -s ./config.sh -s config.bat -s
To validate that IBM CMIS was successfully deployed, start the IBM CMIS application on WebSphere Application Server and open the IBM CMIS index page, index.jsp.
29
Related concepts IBM CMIS for FileNet Content Manager index page on page 53 Related tasks Configuring advanced IBM CMIS for FileNet Content Manager properties
Configuring advanced IBM CMIS for FileNet Content Manager properties

The advanced IBM Content Management Interoperability Services for FileNet Content Manager (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 FileNet Content Manager by using the default values that are specified in fncmis_advanced.properties. It is recommended that you complete the Advanced configuration worksheet on page 14 before you configure the advanced IBM CMIS for FileNet Content Manager properties. To configure the advanced properties: 1. Open the fncmis_advanced.properties file in a text editor. The fncmis_advanced.properties file is in the following directory of the IBM CMIS installation directory:
Operating system AIX Linux Windows File location /profiles/profile1/ fncmis_advanced.properties /profiles/profile1/ fncmis_advanced.properties \profiles\profile1\ fncmis_advanced.properties
2. Edit the entries for the advanced parameters that you want to modify for your IBM CMIS for FileNet Content Manager system. 3. Save your changes. 4. Run the configuration tool or a silent configuration to rebuild and deploy the web application EAR file. 5. If you selected to manually deploy the application, deploy your changes to WebSphere Application Server. To validate that IBM CMIS was successfully deployed, start the IBM CMIS application on WebSphere Application Server and open the IBM CMIS index page, index.jsp. Content Engine metadata cache time to live (CMC_TIME_TO_LIVE) on page 31 Client server cache time to live (CRC_TIME_TO_LIVE) on page 31 CVL caching (CVL_Cache) on page 32 Filter hidden properties (filterHiddenProperties) on page 32 IBM CMIS URL (cmisURI) on page 33 Internal buffer size (com.ibm.xml.xlxp2.api.util.encoding.DataSourceFactory. bufferLength) on page 33 Maximum number of items to return (defaultMaxItems) on page 34
30
Private working copy content stream (checkout_copycontent) on page 34 Query time limit (queryTimeLimit) on page 34 Secure metadata caching (SecureMetadataCache) on page 35 Related concepts IBM CMIS for FileNet Content Manager index page on page 53 Related tasks Configuring IBM CMIS by running the configuration tool on page 25 Configuring IBM CMIS by running a silent configuration on page 27 Deploying the IBM CMIS for FileNet Content Manager application manually on page 50 Related reference Advanced configuration worksheet on page 14
Content Engine metadata cache time to live (CMC_TIME_TO_LIVE)

The CMC_TIME_TO_LIVE property specifies how long the Content Engine metadata is kept in the Content Engine Client Metadata Cache. You can use IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) without modifying the default value of the CMC_TIME_TO_LIVE property. CMC_TIME_TO_LIVE Specify how long (in milliseconds) the Content Engine metadata is kept in the Content Engine Client Metadata Cache. The default value is 3600000 milliseconds. When you increase the time to live (TTL), you can improve the performance of IBM CMIS, but the cache might not contain up-to-date information about the content server. When you decrease the TTL, the cache contains more up-to-date information about the content server. However, when you increase the frequency of cache updates, you decrease the performance of IBM CMIS.
Client server cache time to live (CRC_TIME_TO_LIVE)

The CRC_TIME_TO_LIVE property specifies how long object stores are kept in the client-side server cache. You can use IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) without modifying the default value of the CRC_TIME_TO_LIVE property. CRC_TIME_TO_LIVE Specify how long (in milliseconds) object stores are kept in the client-side server cache. The default value is 3600000 milliseconds. When you increase the time to live (TTL), you can improve the performance of IBM CMIS, but the cache might not contain up-to-date information about the object stores on the content server. When you decrease the TTL, the cache contains more up-to-date information about the object stores on the content server. However, when you increase the frequency of cache updates, you decrease the performance of IBM CMIS.
31
CVL caching (CVL_Cache)

The CVL_Cache property determines whether IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) caches IBM FileNet Content Manager controlled vocabulary lists (CVLs) for all users. By default, IBM CMIS for FileNet Content Manager caches the CVLs to improve performance. However, if the CVLs are cached, IBM CMIS does not honor the security settings that are configured for CVLs in your IBM FileNet Content Manager system. You should modify this parameter if you have security settings configured for your CVLs and you need IBM CMIS to honor those settings. CVL_Cache Specify whether to cache CVLs for all users. The default value is true. Valid values: v true When you specify CVL_Cache=true, IBM CMIS caches the CVLs for all users. In addition, IBM CMIS ignores the security settings that are configured for IBM FileNet Content Manager CLVs. Default value. v false When you specify CVL_Cache=false, IBM CMIS does not cache the CVLs. In addition, IBM CMIS honors the security settings that are configured for IBM FileNet Content Manager CLVs. Related concepts Support for IBM FileNet Content Manager CVL security on page 6
Filter hidden properties (filterHiddenProperties)

The filterHiddenProperties property determines whether IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) returns hidden properties to client applications. You can use IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) without modifying the default value of the filterHiddenProperties property. By default, IBM CMIS does not return hidden properties to improve performance. filterHiddenProperties Specify whether IBM CMIS returns hidden properties to client applications. The default value is false. Valid values include: true When you specify filterHiddenProperties=true, IBM CMIS returns hidden properties in responses. false When you specify filterHiddenProperties=false, IBM CMIS does not return hidden properties in responses.
32
Default value.
IBM CMIS URL (cmisURI)

The cmisURI property specifies the URL by which client applications can access IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). For most IBM CMIS systems, you do not need to configure the cmisURL parameter. It is recommended that you do not specify a value for this parameter unless one of the following situations applies to your environment: v You want to force client applications to access IBM CMIS through a specific URL. v Your proxy server settings cause IBM CMIS to produce invalid URLs. cmisURL Specify the URL by which client application can access IBM CMIS. The URL has the form http://host_name:port.
Internal buffer size (com.ibm.xml.xlxp2.api.util.encoding.DataSourceFactory. bufferLength)

The com.ibm.xml.xlxp2.api.util.encoding.DataSourceFactory.bufferLength property specifies the size of the internal buffers that are used to create documents with content on the repository when using IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) Web Services. WebSphere Application Server uses a 65536 byte buffer. However, IBM CMIS is configured to override this setting and use a 2048 byte buffer. It is recommended that you do not change the default value because increasing the size of the buffer can cause memory consumption issues when uploading documents larger than 50 MB through IBM CMIS Web Services. com.ibm.xml.xlxp2.api.util.encoding.DataSourceFactory.bufferLength Specifies the size of the internal buffers that are used to create documents with content on the repository when using IBM CMIS Web Services. The default value is 2048 bytes. If you do not specify a value for this property, IBM CMIS uses the default size of 2048 bytes. Valid values include: 0 If you specify 0 for this parameter, IBM CMIS does not override the default value that is set in WebSphere Application Server, and you might experience memory consumption issues. Integers greater than 0 If you specify an integer greater than 0 for this parameter, IBM CMIS overrides the default value that is set in WebSphere Application Server with the value that you specify. If IBM CMIS is deployed on the same application server as another application, and the other application is initialized before IBM CMIS, IBM CMIS might not be able to override the WebSphere Application Server buffer size. To avoid this problem, it is recommended that you deploy IBM CMIS to a dedicated application server.
33
Maximum number of items to return (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. You can use IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) without modifying the default value of the defaultMaxItems property. defaultMaxItems Specify the maximum number of items to return when an HTTP request does not specify a value for the maxItems parameter. The default value is 25 items.
Private working copy content stream (checkout_copycontent)

The checkout_copycontent property determines whether the content stream of a checked out document is copied to the content stream of the private working copy. You can use IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) without modifying the default value of the checkout_copycontent property. checkout_copycontent Specify whether to copy the content stream of a checked out document to the content stream of the private working copy. The default value is true. Valid values include: true When you specify checkout_copycontent=true, IBM CMIS copies the content stream of a checked out document to the content stream of the private working copy. Default value. false When you specify checkout_copycontent=false, IBM CMIS does not copy the content stream of a checked out document to the content stream of the private working copy.
Query time limit (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 Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). You can use IBM CMIS without modifying the default value of the queryTimeLimit property. queryTimeLimit Specify the maximum length of time (in seconds) to run a query on the repository (IBM FileNet P8 object store). The default value is 180 seconds. Valid values include:
34
0 If you specify queryTimeLimit=0 for this parameter, IBM CMIS uses the default query time limit that is configured for the repository. Integers greater than 0 If you specify an integer greater than 0 for this parameter, IBM CMIS overrides the default query time limit that is configured for the repository.
Secure metadata caching (SecureMetadataCache)

The SecureMetadataCache property determines whether IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) caches class definition metadata for all users. By default, IBM CMIS caches the class definition metadata to improve performance. However, if the class definition metadata is cached, IBM CMIS displays the following properties to all users regardless of their access control list (ACL) permissions: v Creator v DateCreated SecureMetadataCache Specify whether to secure class metadata or cache class metadata for all users. The default value is false. Valid values include: true Do not cache the class definition metadata. When you specify SecureMetaCache=true, IBM CMIS honors the ACL settings for the Creator and DateCreated properties. false Cache the class definition metadata. When you specify SecureMetaCache=false, IBM CMIS ignores the ACL settings for the Creator and DateCreated properties. Default value.
Configuring single sign-on

You must enable single sign-on (SSO) between the application servers that host IBM FileNet Content Engine and IBM Content Management Interoperability Services for FileNet Content Manager If Content Engine and IBM CMIS for FileNet Content Manager are running on the same instance of WebSphere Application Server, you do not need to configure LTPA. If Content Engine and IBM CMIS for FileNet Content Manager are running on different instances of WebSphere Application Server, you must configure LTPA and enable application security for each instance of WebSphere Application Server. Additionally, each instance of WebSphere Application Server must use the same directory service for authentication. To configure SSO, you must complete the following tasks.
35
Configuring Lightweight Third Party Authentication (LTPA) Configuring Lightweight Directory Access Protocol (LDAP) on page 38
Configuring Lightweight Third Party Authentication (LTPA)

The LTPA security settings on the IBM FileNet Content Engine application server and the IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) application server must match. If Content Engine and IBM CMIS for FileNet Content Manager are running on the same instance of WebSphere Application Server, you do not have to configure LTPA. Ask your Content Engine administrator whether you are already using LTPA with your Content Engine application server. If you are not currently using LTPA with the Content Engine application server, you must: 1. Generate an LTPA key from the Content Engine application server 2. Export the LTPA key from the Content Engine application server 3. Import the LTPA key to the IBM CMIS application server If you are already using LTPA with the Content Engine application server, it is recommended that you do not generate a new LTPA key from Content Engine application server. You must, 1. Export the LTPA key from the Content Engine application server 2. Import the LTPA key to the IBM CMIS for FileNet Content Manager application server Remember: If you generate a new LTPA key, you must import the new LTPA key to the Content Engine client applications that use the old LTPA key. To configure LTPA for IBM CMIS for FileNet Content Manager, you must complete the following tasks. 1. Generating the LTPA key from the Content Engine application server 2. Exporting the LTPA key from the Content Engine application server on page 37 3. Importing the LTPA key to the IBM CMIS for FileNet Content Manager application server on page 37
Generating the LTPA key from the Content Engine application server
If you are not currently using LTPA with the IBM FileNet Content Engine application server, you must generate an LTPA key from the Content Engine application server. If you are already using LTPA with the Content Engine application server, it is recommended that you do not generate a new LTPA key from Content Engine application server. To generate the LTPA key from the Content Engine application server: 1. Log in to the WebSphere Application Server administrative console on which Content Engine is installed. 2. Open the LTPA settings page:
36
3. 4. 5. 6.
a. Click Security Global security. b. Select LTPA. Enter a password to create the LTPA password. For password restrictions, see the WebSphere Application Server documentation. Click Generate Keys. Click Save, and then click Save changes to the Master Configuration. Stop and restart WebSphere Application Server.
Exporting the LTPA key from the Content Engine application server
You must export the LTPA key from the Content Engine application server before you can import the key file to the IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) application server. To export the LTPA key from the Content Engine application server: 1. Log in to the WebSphere Application Server administrative console on which Content Engine is installed. 2. Open the LTPA settings page: a. Click Security Global security. b. Select LTPA. 3. Enter a value for the LTPA timeout that is larger than the default. For example, if the timeout value is left at the default value of 120 minutes, the LTPA key expires after 2 hours. Users will not be able to log in to IBM CMIS after being logged in for 2 hours. 4. Save your changes. 5. In the Cross-cell single sign-on field, type the LTPA password. 6. Enter the fully qualified path for the Key File Name. For example, /opt/LTPA/ltpa_key_name. 7. Click Export keys. Verify that a message like the following message is displayed:
The keys were successfully exported to the file ltpa_key_name.
Importing the LTPA key to the IBM CMIS for FileNet Content Manager application server
You must import the LTPA key to the IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) application server to enable IBM CMIS to authenticate to the IBM FileNet Content Engine application server. To import the LTPA key to the IBM CMIS application server: 1. Copy the key file from the Content Engine server to a directory on the IBM CMIS server. For example: /opt/LTPA/ltpa_key_name 2. On the IBM CMIS server, log in to the WebSphere Application Server administrative console. 3. Open the LTPA settings page: a. Click Security Global security. b. Select LTPA. 4. Enter a value for the LTPA timeout that is larger than the default. For example, if the timeout value is left at the default value of 120 minutes, the LTPA key expires after 2 hours. Users will not be able to log in to IBM CMIS after being logged in for 2 hours. 5. Save your changes.
37
6. In the Cross-cell single sign-on field, type the LTPA password. 7. In the Key File Name field, specify the fully qualified path for the key file that you imported. For example, /opt/LTPA/ltpa_key_name. 8. Click Import keys. Verify that a message like the following message is displayed:
The keys were successfully imported to the file ltpa_key_name.
9. Click Save, and then click Save changes to the Master Configuration. 10. Stop and restart WebSphere Application Server.
Configuring Lightweight Directory Access Protocol (LDAP)

The WebSphere Application Server that hosts IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) must use the same LDAP server as the WebSphere Application Server that hosts Content Engine. To enable LDAP communication between IBM CMIS for FileNet Content Manager and Content Engine, you must configure the LDAP settings in WebSphere Application Server. IBM CMIS supports stand-alone LDAP and LDAP for federated repositories. The steps in this task assume that you use stand-alone LDAP. To configure stand-alone LDAP: 1. On the IBM CMIS server, log in to the WebSphere Application Server administrative console. 2. Click Security Global security. 3. Disable the following Security settings: v Clear the Enable Administrative Security flag. v Clear the Enable application security flag. v Clear the Java 2 security flag. 4. From the Available realm definitions list, select Standalone LDAP registry and click Configure. 5. Configure the LDAP provider settings to exactly match the corresponding settings on the Content Engine application server. Tip: Open the WebSphere Application Server administrative console for the Content Engine server to ensure that the following settings match on both application servers. v Primary administrative user name v Automatically generated server identity v Type of LDAP server v Host v Port v Base distinguished name (DN) v Bind distinguished name (DN) v Bind password 6. Click Apply. 7. Under Additional Properties, click Advanced Lightweight Directory Access Protocol (LDAP) user registry settings. Configure the LDAP user registry settings to exactly match the corresponding settings on the Content Engine application server.
38
Tip: Open the WebSphere Application Server administrative console for the Content Engine server to ensure that the following settings match on both application servers. v User filter v Group Filter v User ID map v Group member ID map v Certificate map mode v Certificate filter 8. Click OK 9. Save your changes. 10. From the Available realm definitions list, ensure that Standalone LDAP registry is selected and click Set as current. 11. Set the following Security flags: v Select the Enable Administrative Security flag. v Select the Enable application security flag. v Clear the Java 2 security flag. Important: The IBM FileNet P8 Platform uses LDAP-based security and does not support Java 2 security. Enabling Java 2 security causes unexpected behavior. 12. Click Save, and then click Save changes to the Master Configuration. 13. Stop and restart WebSphere Application Server. 14. On the Standalone LDAP registry page, test the connection to the LDAP server. If the test fails, correct the error before proceeding. If the connection succeeds, click OK to return to the previous page.
Configuring logging
IBM Content Management Interoperability Services for FileNet Content Manager uses the standard Apache Commons Logging API, which can be configured at run time through the WebSphere Application Server administrative console. To configure logging for IBM CMIS: 1. Log in to the WebSphere Application Server administrative console and expand Troubleshooting. 2. Click Logs and trace, and then click the name of the server where IBM CMIS is installed. 3. In the Logging and Tracing panel, click Change Log Detail Levels. 4. Select the appropriate tab: 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 to the logging level on the Runtime tab are activated immediately.
39
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 Specifying log level entries Configuring log location and size on page 41 Logged errors on page 42 Configuring Content Engine API client logging on page 42
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. Each entry must have the form package_name.*=logging_level or class_name=logging_level. Entries are separated with a colon (:). 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: IBM CMIS application logging The package name for the IBM CMIS application is com.ibm.ecm. IBM CMIS component logging The package name for the IBM CMIS components is com.ibm.ecm.cmis. Common component logging The package name for the common application components is com.ibm.ecm.integration. Performance logging The class name for the performance component is com.ibm.ecm.cmis.perf. The following examples show how you can configure common logging levels for IBM CMIS: v To specify info-level logging for the IBM CMIS application, which includes errors, warning, and important informational messages, enter:
com.ibm.ecm.*=info
v 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
40
v 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
v 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
Related information WebSphere log levels
Configuring log location and size

From the WebSphere Application Server administrative console, you can enable or disable trace logging, change the log file location, size and retention, and modify the log entry format. These settings apply to all applications that use Apache Commons Logging standard. It is not usually necessary to change these settings when troubleshooting IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). 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. To configure logging for IBM CMIS: 1. Log in to the WebSphere Application Server administrative console and expand Troubleshooting. 2. Click Logs and trace, and then click the name of the server where IBM CMIS is installed. 3. To configure SystemOut.log, click JVM logs in the Logging and Tracing panel. Specify the logging 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. 4. Click Apply.
41
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 configured logging for IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS), all errors are logged in WebSphere Application Server and returned in a response. The following code is an example of the message format:
INVALID_OBJECT_ID_1=CIL1148: The service cannot be completed because the following object ID or path is not valid: {object ID or object path} INVALID_OBJECT_ID_1_E=The object ID or path might contain invalid characters or use invalid syntax. INVALID_OBJECT_ID_1_A=Ensure that a valid object ID or path is retrieved from HTTP responses, or the RESTful AtomPub binding service document, or the Web 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:
MM/DD/YY HH:MM:SS] 00000017 DALP8Exceptio E com.ibm.ecm.cmis.dal.p8.DALP8ExceptionHandler handleException null com.ibm.ecm.cmis.app.exceptions.InvalidArgumentException: CIL1145: The service cannot be completed because the value that was specified for the following input parameter is not valid. Input parameter: repositoryId Value: bad-dog Explanation: No additional explanation is required. Action: For information about implementing the argument, see the OASIS CMIS API specification. Stack trace...
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 Content Engine API client logging

IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) bundles and performs most content operations through the IBM FileNet Content Engine Java API. You might need to configure Content Engine API client logging when you need to troubleshoot performance problems related to Content Engine.
42
The API layer has its own logging structure, that uses the Apache Log4J standard library. Therefore, the server logs might show stack traces for Content Engine-related errors that occur under normal operation, no matter what the application log settings are. To configure Content Engine API client logging for IBM CMIS: 1. Create a log4j.properties file. 2. Insert the log4j.properties file into the classes directory of the deployed application. By default, the classes directory is located in the following WebSphere Application Server directory:
Operating system AIX Default Directory /usr/IBM/WebSphere/AppServer/ profile_name/installedApps/cell_name/ fncmis.ear/fncmis.war/WEB-INF/classes /opt/IBM/WebSphere/AppServer/ profile_name/installedApps/cell_name/ fncmis.ear/fncmis.war/WEB-INF/classes C:\Program Files\IBM\WebSphere\ AppServer\profiles\profile_name\ installedApps\cell_name\fncmis.ear\ fncmis.war\WEB-INF\classes
Linux
Windows
3. Restart the IBM CMIS application in the WebSphere Application Server administrative console to distribute the changes to the deployed application. After you deploy the application, the Content Engine API client logs are created in the directory that was specified in the log4j.properties file. The following code is a sample log4j.properties file.
############################################################# # Root logger ############################################################# log4j.rootLogger=off, FileNetNull Appender ############################################################# # Appenders ############################################################# # === FileNetNullAppender log4j.appender.FileNetNullAppender=org.apache.log4j.varia.NullAppender # === FileNetConsoleAppender log4j.appender.FileNetConsoleAppender=org.apache.log4j.ConsoleAppender log4j.appender.FileNetConsoleAppender.layout=org.apache.log4j.PatternLayout log4j.appender.FileNetConsoleAppender.layout.ConversionPattern= %d %5p [%t] - %m\r\n #=== FileNetErrorAppender log4j.appender.FileNetErrorAppender=org.apache.log4j.FileAppender log4j.appender.FileNetErrorAppender.File=logs/server1/fncmis_api_error.log log4j.appender.FileNetErrorAppender.layout=org.apache.log4j.PatternLayout log4j.appender.FileNetErrorAppender.layout.ConversionPattern= %d %5p [%t] - %m\r\n #=== FileNetTraceAppender log4j.appender.FileNetTraceAppender=org.apache.log4j.FileAppender log4j.appender.FileNetTraceAppender.File=logs/server1/fncmis_api_trace.log # This is the layout that the TraceLoggingConfiguration
43
framework on the server uses. # To use this layout , jace.jar must be present in the classpath. #log4j.appender.FileNetTraceAppender.layout=com.filenet.apiimpl.util.TraceLayout # Comment out the following lines if using the FileNet TraceLayout log4j.appender.FileNetTraceAppender.layout=org.apache.log4j.PatternLayout log4j.appender.FileNetTraceAppender.layout.ConversionPattern= %d %5p [%t] - %m\r\n #=== FileNetErrorRollingAppender log4j.appender.FileNetErrorRollingAppender=org.apache.log4j.RollingFileAppender log4j.appender.FileNetErrorRollingAppender.File=logs/server1/fncmis_api_error.log log4j.appender.FileNetErrorRollingAppender.MaxFileSize=100MB log4j.appender.FileNetErrorRollingAppender.MaxBackupIndex=1 log4j.appender.FileNetErrorRollingAppender.layout=org.apache.log4j.PatternLayout log4j.appender.FileNetErrorRollingAppender.layout.ConversionPattern= %d %5p [%t] - %m\r\n #=== FileNetTraceRollingAppender log4j.appender.FileNetTraceRollingAppender=org.apache.log4j.RollingFileAppender log4j.appender.FileNetTraceRollingAppender.File=logs/server1/fncmis_api_trace.log log4j.appender.FileNetTraceRollingAppender.MaxFileSize=100MB log4j.appender.FileNetTraceRollingAppender.MaxBackupIndex=1 # This is the layout that the TraceLoggingConfiguration framework on the server uses. # To use this layout, jace.jar must be present in the classpath. #log4j.appender.FileNetTraceRollingAppender.layout=com.filenet.apiimpl.util.TraceLayout # Comment out the following lines if using the FileNet TraceLayout log4j.appender.FileNetTraceRollingAppender.layout=org.apache.log4j.PatternLayout log4j.appender.FileNetTraceRollingAppender.layout.ConversionPattern= %d %5p [%t] - %m\r\n ############################################################# # Error Loggers: # # Set log level to either one of off/fatal/error/warn/info. # Child loggers value overwrites parent loggers value. # If a logger is not specified, it inherents its value from its parent. # By default, error logging is set to level ERROR. ############################################################# # Dont comment out the following line since it has appenders. log4j.logger.filenet_error = error, FileNetConsoleAppender, FileNetErrorRollingAppender, FileNetTraceRollingAppender #=== SubSystem: api # Uncomment to set error logging level to WARN. #log4j.logger.filenet_error.api = warn ############################################################ # Trace loggers: # # Setting log level to "off" will turn off trace logging. # Setting log level to "debug" will turn on trace logging. # # Child loggers value overwrites parent loggers value. # If a logger is not specified, it inherents its value from its parent. # By default, trace logging is off. # # The general message trace logging has a hierarchy # of three detail levels represented with # hierarchical logger names: # ...detail.moderate.summary -- Enables a summary level of tracing # ...detail.moderate -- Enables a moderate level of tracing # ...detail -- Enables the most detailed level of tracing # # Uncomment corresponding lines to turn tracing on. To enable trace logging # for all subsystems and all flags, set the level of the filenet_tracing # logger to debug.
44
# # Here are the trace flags used for each sub system. # For message tracing, enable the line # corresponding to the desired detail level. # log4j.logger.filenet_tracing.<SubSystem>.timer = debug # log4j.logger.filenet_tracing.<SubSystem>.detail.moderate.summary = debug # log4j.logger.filenet_tracing.<SubSystem>.detail.moderate = debug # log4j.logger.filenet_tracing.<SubSystem>.detail = debug # # For example: # log4j.logger.filenet_tracing.api.detail.moderate = debug ############################################################# # Dont comment out the following line since it includes an appender. log4j.logger.filenet_tracing = off, FileNetTraceRollingAppender #=== SubSystem: api # Uncomment one or more lines to enable tracing. log4j.logger.filenet_tracing.api = debug log4j.logger.filenet_tracing.api.timer = debug # Remove the comment corresponding to the desired detail level log4j.logger.filenet_tracing.api.detail.moderate.summary = debug #log4j.logger.filenet_tracing.api.detail.moderate = debug #log4j.logger.filenet_tracing.api.detail = debug
45
46
Deploying IBM CMIS for FileNet Content Manager

You can deploy the IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) application manually or by using the configuration tool. The configuration tool enables you to deploy IBM CMIS as soon as you modify the application. In addition, the configuration tool remembers your configuration and deployment information across sessions. Alternatively, you can manually deploy the application after you use the configuration tool or run a silent configuration to build the EAR file. To deploy IBM CMIS, complete one of the following tasks. Deploying the IBM CMIS for FileNet Content Manager application by running the configuration tool Deploying the IBM CMIS for FileNet Content Manager application by running a silent configuration on page 48 Deploying the IBM CMIS for FileNet Content Manager application manually on page 50
Deploying the IBM CMIS for FileNet Content Manager application by running the configuration tool
When you configure IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS), you can use the configuration tool to deploy IBM CMIS to WebSphere Application Server. To deploy the IBM CMIS application: 1. Start the configuration tool:
Operating system AIX Installation command At a command prompt, change to the config subdirectory of the IBM CMIS for FileNet Content Manager installation directory and enter: ./config.sh. At a command prompt, change to the config subdirectory of the IBM CMIS for FileNet Content Manager installation directory and enter: ./config.sh. At a command prompt, change to the config subdirectory of the IBM CMIS for FileNet Content Manager installation directory and enter: config.bat.
Linux
Windows
2. Configure the IBM CMIS application for your environment and select Automatically deploy IBM CMIS. 3. Specify the instance of WebSphere Application Server to which to deploy IBM CMIS.
47
Important: You must deploy IBM CMIS to an existing WebSphere Application Server profile that has WebSphere Application Server security enabled. a. If prompted, specify the WebSphere Application Server installation directory. If you tested the connection to the Content Engine server, the configuration tool uses the installation directory that you specified in the Content Engine Connection Information window. b. Specify the application server profile to which to deploy IBM CMIS. c. Specify the administrator user name and password for the selected application server profile. d. If the application server profile contains application servers and application server clusters, specify the type of server to which you plan to deploy IBM CMIS. e. Specify the cluster or application server to which to deploy IBM CMIS. Remember: It is recommended that you deploy IBM CMIS to a dedicated application server or application server cluster. f. Optional: Specify the name to display for the IBM CMIS application in WebSphere Application Server. The default display name for the application is FN_CMIS. 4. Verify your WebSphere Application Server deployment information and click Next. To validate that IBM CMIS was successfully deployed, start the IBM CMIS application on WebSphere Application Server and open the IBM CMIS index page, index.jsp. Related concepts IBM CMIS for FileNet Content Manager index page on page 53
Deploying the IBM CMIS for FileNet Content Manager application by running a silent configuration
When you configure IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS), you can enter information about your WebSphere Application Server deployment environment in the silent configuration response file. A silent configuration uses a response file that contains the configuration and deployment parameters that you specify. When you run a silent configuration, the configuration program does not display any configuration windows or messages. Instead, any messages and errors are written to the fncmis-config.log file in the log directory. To deploy the IBM CMIS for FileNet Content Manager application: 1. Open the response file:
Operating system AIX Linux Windows Response file config/fncmisUNIX_SilentConfig.properties config/fncmisUNIX_SilentConfig.properties config\fncmisWIN_SilentConfig.properties
48
2. Ensure that the parameters in the Content Engine Connection Information section are specified correctly for your environment. 3. Ensure that the USER_WS_AUTH parameter is specified correctly for your environment. 4. Set the USER_MANUAL_DEPLOY parameter to 0. Remember: If you set the USER_MANUAL_DEPLOY parameter to 1, you must manually deploy IBM CMIS. 5. Specify the information about the WebSphere Application Server environment to which you want to deploy IBM CMIS. Important: You must deploy IBM CMIS to an existing WebSphere Application Server profile that has WebSphere Application Server security enabled. a. Set the USER_APPSERVER_HOME parameter to the instance of WebSphere Application Server to which you want to deploy IBM CMIS. Important: On Windows, you must escape colons (:) and backslashes (\) by adding a backslash before each colon or backslash in the installation directory file path. For example, C:\Program Files\IBM\WebSphere\ AppServer would have the following format:
C\:\\Program Files\\IBM\\WebSphere\\AppServer
b. Set the USER_APPSERVER_PROFILE_NAME parameter to the WebSphere Application Server profile to which you want to deploy IBM CMIS. The default profile is AppSrv01. c. Set the USER_WASADMIN_ID parameter to the administrator user name for the specified application server profile. d. Set the USER_WASADMIN_PW parameter to the administrator password for the specified application server profile. e. Set the USER_DEPLOY_TYPE parameter to one of the following values: appserver Specify appserver to deploy IBM CMIS to an application server on WebSphere Application Server or to a managed node or an unmanaged node on WebSphere Application Server Network Deployment. cluster Specify cluster to deploy IBM CMIS to a cluster on WebSphere Application Server Network Deployment. f. If you specified USER_DEPLOY_TYPE=appserver, specify values for the following properties. Remember: It is recommended that you deploy IBM CMIS to a dedicated application server. 1) Set the USER_APPSERVER_NAME parameter to the name of the application server on which to deploy IBM CMIS. 2) Set the USER_APPSERVER_NODE parameter to the name of the application server node that contains the application server on which to deploy IBM CMIS. g. If you specified USER_DEPLOY_TYPE=cluster, set the USER_APPSERVER_CLUSTER parameter to the name of the application server cluster on which to deploy IBM CMIS.
49
Remember: It is recommended that you deploy IBM CMIS to a dedicated application server cluster. h. Optional: Set the USER_APP_NAME parameter to specify the name to display for the IBM CMIS application in WebSphere Application Server. The default display name for the application is FN_CMIS. 6. Save your changes to the response file. 7. At a command prompt, change to the config subdirectory of the IBM CMIS installation directory and run the following command:
Operating system AIX Linux Windows Command ./config.sh -s ./config.sh -s config.bat -s
To validate that IBM CMIS was successfully deployed, start the IBM CMIS application on WebSphere Application Server and open the IBM CMIS index page, index.jsp. Related concepts IBM CMIS for FileNet Content Manager index page on page 53
Deploying the IBM CMIS for FileNet Content Manager application manually
After you configure IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS), you can manually deploy IBM CMIS to WebSphere Application Server. To manually deploy IBM CMIS, complete the following tasks. 1. Modifying the generic JVM arguments in WebSphere Application Server 2. Importing the WS-Security policy set to WebSphere Application Server on page 51 3. Manually deploying IBM CMIS for FileNet Content Manager on page 51 Related tasks Configuring advanced IBM CMIS for FileNet Content Manager properties on page 30
Modifying the generic JVM arguments in WebSphere Application Server

Before you manually deploy IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS), you must modify the generic JVM arguments for the server to which you want to deploy IBM CMIS. If you use the configuration program to deploy IBM CMIS, you do not need to complete this task. To modify the generic JVM arguments on the server: 1. Log in to the WebSphere Application Server administrative console. 2. Click Servers Server Types WebSphere application servers. 3. Click the name of the server where you want to deploy IBM CMIS, such as server1.
50
4. Under Server Infrastructure, click Java and Process Management Process definition. 5. Under Additional Properties, click Java Virtual Machine. 6. In the Generic JVM arguments field, append -Djaxws.payload.highFidelity=true. 7. Click OK and save your changes to the master configuration.
Importing the WS-Security policy set to WebSphere Application Server

If you configured IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) to use WS-Security, you must import the WS-Security policy set to WebSphere Application Server before you manually deploy IBM CMIS. If you use the configuration program to deploy IBM CMIS, you do not need to complete this task. To import the WS-Security policy set to WebSphere Application Server: 1. 2. 3. 4. Log in to the WebSphere Application Server administrative console. Click Services Policy sets Application policy sets. Select Import From Selected Location. Select the cmis_auth_policyset.zip file from the config/scripts/policysets subdirectory of the IBM CMIS installation directory:
Default directory /opt/IBM/FN_CMIS/config/scripts/ policysets/cmis_auth_policyset.zip /usr/IBM/FN_CMIS/config/scripts/ policysets/cmis_auth_policyset.zip C:\Program Files\IBM\FN_CMIS\config\ scripts\policysets\ cmis_auth_policyset.zip
Operating system AIX Linux Windows
Important: Do not change the name of the policy set. 5. Click OK and save your changes to the master configuration.
Manually deploying IBM CMIS for FileNet Content Manager

After you configure your WebSphere Application Server environment for IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS), you can manually deploy IBM CMIS to WebSphere Application Server. You must modify the generic JVM arguments for the server on which IBM CMIS will be deployed. In addition, if you configured IBM CMIS to use WS-Security, you must import the WS-Security policy set to WebSphere Application Server. The IBM CMIS application EAR file, fncmis.ear, is created when you select Manually deploy IBM CMIS in the configuration tool or the silent configuration response file.
51
The IBM CMIS fncmis.ear file is created in the profiles/profile1 subdirectory of the IBM CMIS installation directory.
Table 14. Default location of the fncmis.ear file Operating system AIX Linux Windows Default directory /opt/IBM/FN_CMIS/profiles/profile1/ fncmis.ear /usr/IBM/FN_CMIS/profiles/profile1/ fncmis.ear C:\Program Files\IBM\FN_CMIS\profiles\ profile1\fncmis.ear
To 1. 2. 3.
manually deploy IBM CMIS to WebSphere Application Server: Log in to the WebSphere Application Server administrative console. Click Applications New Application New Enterprise Application. In the Path to the new application window, select Local file system.
4. Select the fncmis.ear file from the profiles/profile1 subdirectory of the IBM CMIS installation directory and click Next. 5. In the How do you want to install the application window, select Fast Path and click Next. 6. Accept the default values for the remaining parameters. 7. In the Summary window, click Finish. 8. Save your changes to the master configuration. 9. After the application is deployed, start the application. To validate that IBM CMIS was successfully deployed, start the IBM CMIS application on WebSphere Application Server and open the IBM CMIS index page, index.jsp. Related concepts IBM CMIS for FileNet Content Manager index page on page 53
52
IBM CMIS for FileNet Content Manager 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. IBM CMIS for FileNet Content Manager index page OASIS CMIS specification on page 55 Useful resources on page 55 Extensions for IBM CMIS for FileNet Content Manager on page 56 IBM CMIS for FileNet Content Manager implementation of the OASIS CMIS specification on page 59 Best practices for developing client applications on page 63
IBM CMIS for FileNet Content Manager index page

The IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) index page contains information about the instance of IBM CMIS that is deployed to your web application server. 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 FileNet P8 object stores) on your Content Engine 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 FileNet Content Manager is fncmis. You can use the information about the index page to: v Interact directly with the OASIS CMIS Web Services binding or RESTful AtomPub binding v 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. IBM CMIS for FileNet Content Manager service collection URLs on page 54 IBM CMIS for FileNet Content Manager URI templates on page 54
53
Related tasks Configuring IBM CMIS by running the configuration tool on page 25 Configuring IBM CMIS by running a silent configuration on page 27 Configuring advanced IBM CMIS for FileNet Content Manager properties on page 30 Deploying the IBM CMIS for FileNet Content Manager application by running the configuration tool on page 47 Deploying the IBM CMIS for FileNet Content Manager application by running a silent configuration on page 48 Manually deploying IBM CMIS for FileNet Content Manager on page 51 Related information Context root for Web modules settings (WebSphere Application Server Network Deployment) Context root for Web modules settings (WebSphere Application Server)
IBM CMIS for FileNet Content Manager service collection URLs

Service collection URLs provide feeds that enable users to browse and navigate the items in the repository. The OASIS CMIS specification defines several service collection URLs. The OASIS specification defines the following service collection URLs: Root folder collection This URL provides a feed that displays all of the folders and documents that are in the root folder. Query collection This URL provides a feed of the objects that satisfy a predefined query. Checked out collection This URL provides a feed of the documents that are in the checked-out state in the repository. Unfiled collection This URL provides a feed of the documents that are not filed in a folder in the repository. Types children collection This URL provides a feed of the base object types, specifically cmis:document and cmis:folder. For a list of the service collection URLs for your IBM CMIS for FileNet Content Manager application, see the index page at http://host_name:port/context_root/ index.jsp. By default, the context root of IBM CMIS for FileNet Content Manager is fncmis. For more information, see section 3.7 Service Collections of the OASIS CMIS specification.
IBM CMIS for FileNet Content Manager 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.
54
The OASIS specification defines the following URI templates: Object by ID (objectbyid) template This URI template enables users to create a URI that can directly access a document or folder by specifying the ID of the object. Object by path (objectbypath) template This URI template enables users to create a URI that can directly access a document or folder by specifying the path of the object. Query (query) template This URI template enables users to create a URI to search for data in the repository by specifying a CMIS Query Statement. The server returns a feed of objects that correspond to the query that is supplied. Type by ID (typebyid) template This URI template enables users to create a URI to retrieve metadata about a type (IBM FileNet P8 class). The server returns the class description information in the CMIS format for a type, which includes all the property descriptions that are defined for the specified type. For a list of the URI templates for your IBM CMIS for FileNet Content Manager application, see the index page at http://host_name:port/context_root/index.jsp. By default, the context root of IBM CMIS for FileNet Content Manager is fncmis. For more information, see section 3.6.1 URI Templates of the OASIS CMIS specification.
OASIS CMIS specification

The OASIS Content Management Interoperability Services (CMIS) specification includes detailed information about the CMIS Web Services bindings and the RESTful AtomPub bindings. The OASIS CMIS API specification is available in HTML format at http://docs.oasis-open.org/cmis/CMIS/v1.0/os/cmis-spec-v1.0.html. Important: The IBM Content Management Interoperability Services for FileNet Content Manager 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.oasisopen.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/contentmanagement/cm-interoperablity-services.html.
55
The Lotus Quickr wiki also includes a compilation of resources at http://www.ibm.com/software/lotus/info/r/ldd/lqwiki.nsf/dx/ 11122008094143amwebk95.htm.
Extensions for IBM CMIS for FileNet Content Manager

The OASIS Content Management Interoperability Services (CMIS) specification enables developers to extend the RESTful AtomPub bindings and Web Services bindings that are provided by the specification. IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) includes several extensions that enable client applications to retrieve additional information from an IBM FileNet Content Manager system. The IBM CMIS extensions are extensions to the XML output from the server and are present on each response from the Content Engine server. The extensions are optional and do not interfere with client applications that are not designed to use the extensions. Important: If you design your client application to use the IBM CMIS extensions, it is recommended that you design the application to use the values that are provided by the extensions only if values are available. In addition, if you design your client application to use the IBM CMIS extensions, you should keep the following restrictions in mind: v The extensions are for an IBM FileNet Content Manager repository only. v If your client application is designed to require values for these extensions, your client application will not work with another CMIS-enabled repository. IBM CMIS for FileNet Content Manager includes the following extensions: Class display name extension Hidden properties extension on page 57 Choice list symbolic name extension on page 57 Choice list display name extension on page 57 Domain name extension on page 57 Object store ID extension on page 58 Object store database type extension on page 58 Records management extension on page 58 Text search engine extension on page 58 GZIP compression extension on page 59
Class display name extension

The class display name (ClassDisplayName) extension enables client applications to retrieve the display name of an object class as part of the object type definition for a collection of objects, such as documents and folders. Remember: If you design your client application to use this IBM CMIS extension, it is recommended that you design the application to use the value that is provided by the extension only if a value is available. If this information is not provided, it should not cause your application to encounter an error because the information is not required by the OASIS CMIS API specification.
56
Response format
<p8ext:ClassDisplayName>Class Display Name</p8ext:ClassDisplayName>
Hidden properties extension

The hidden properties (isHidden) extension enables client applications to determine the object properties that should not be displayed based on the object properties that are marked as hidden in Content Engine. Remember: If you design your client application to use this IBM CMIS extension, it is recommended that you design the application to use the value that is provided by the extension only if a value is available. If this information is not provided, it should not cause your application to encounter an error because the information is not required by the OASIS CMIS API specification.
Response format
<p8ext:isHidden>Boolean true or false</p8ext:isHidden>
Choice list symbolic name extension

The choice list symbolic name (ChoiceListSymbolicName) extension enables client applications to retrieve the symbolic name of a choice list (also called a controlled vocabulary list or a CVL) from Content Engine. Remember: If you design your client application to use this IBM CMIS extension, it is recommended that you design the application to use the value that is provided by the extension only if a value is available. If this information is not provided, it should not cause your application to encounter an error because the information is not required by the OASIS CMIS API specification.
Response format
<p8ext:ChoiceListSymbolicName>Symbolic Name</p8ext:ChoiceListSymbolicName>
Choice list display name extension

The choice list display name (ChoiceListDisplayName) extension enables client applications to retrieve the display name of a choice list (also called a controlled vocabulary list or a CVL) from Content Engine. Remember: If you design your client application to use this IBM CMIS extension, it is recommended that you design the application to use the value that is provided by the extension only if a value is available. If this information is not provided, it should not cause your application to encounter an error because the information is not required by the OASIS CMIS API specification.
Response format
<p8ext:ChoiceListDisplayName>Display Name</p8ext:ChoiceListDisplayName>
Domain name extension

The domain name (DomainName) extension enables client applications to retrieve the IBM FileNet P8 domain name as part of the repository information. Remember: If you design your client application to use this IBM CMIS extension, it is recommended that you design the application to use the value that is provided by the extension only if a value is available. If this information is not
57
provided, it should not cause your application to encounter an error because the information is not required by the OASIS CMIS API specification.
Response format
<p8ext:DomainName>FileNet P8 Domain Name</p8ext:DomainName>
Object store ID extension

The object store ID (ObjectStoreID) extension enables client applications to retrieve the object store GUID as part of the repository information. Remember: If you design your client application to use this IBM CMIS extension, it is recommended that you design the application to use the value that is provided by the extension only if a value is available. If this information is not provided, it should not cause your application to encounter an error because the information is not required by the OASIS CMIS API specification.
Response format
<p8ext:ObjectStoreID>{GUID}</p8ext:ObjectStoreID>
Object store database type extension

The object store database type (ObjectStoreDBType) extension enables client applications to retrieve the type of database, such as DB2 or Oracle, that the repository runs on as part of the repository information. Remember: If you design your client application to use this IBM CMIS extension, it is recommended that you design the application to use the value that is provided by the extension only if a value is available. If this information is not provided, it should not cause your application to encounter an error because the information is not required by the OASIS CMIS API specification.
Response format
<p8ext:ObjectStoreDBType>Database type</p8ext:ObjectStoreDBType>
Records management extension

The records management (RecordsManagementEnabled) extension enables client applications to determine whether the documents in a repository can be declared as records. This information is provided as part of the repository information. Remember: If you design your client application to use this IBM CMIS extension, it is recommended that you design the application to use the value that is provided by the extension only if a value is available. If this information is not provided, it should not cause your application to encounter an error because the information is not required by the OASIS CMIS API specification.
Response format
<p8ext:RecordsManagementEnabled>Boolean true or false</p8ext:RecordsManagementEnabled>
Text search engine extension

The text search engine (TextSearchEngine) extension enables client applications to determine whether text search is enabled on the repository. If text search is enabled, this extension identifies which text search engine is installed. This information is provided as part of the repository information.
58
Regardless of the text search engine that is installed, your client must use OASIS CMIS search syntax. Remember: If you design your client application to use this IBM CMIS extension, it is recommended that you design the application to use the value that is provided by the extension only if a value is available. If this information is not provided, it should not cause your application to encounter an error because the information is not required by the OASIS CMIS API specification.
Response format
<p8ext:TextSearchEngine>Integer value for text search engine</p8ext:TextSearchEngine>
The extension returns one of the following values: 0 1 2 The repository does not have a text search engine installed. The repository has an IBM Legacy Content Search Engine text search engine installed. The repository has a IBM Content Search Services text search engine installed.
Important: The values that are returned by this extension are documented in the Content Engine API. For definitive information about the text search values, see the com.filenet.api.constants.CRBSearchType section of the Content Engine API.
GZIP compression extension

The GZIP compression extension enables client applications to request compressed responses from IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) to increase performance. If a client application sends a request that contains an Accept-Encoding header that specifies the GZIP file compression, IBM CMIS compresses the response using GZIP compression.
Request format
Accept-Encoding: gzip
Response format
Content-Encoding: gzip
IBM CMIS for FileNet Content Manager implementation of the OASIS CMIS specification
The OASIS Content Management Interoperability Services (CMIS) specification enables applications to implement the specification in slightly different ways to account for the differences between repositories. When you develop a client application that uses CMIS services to interact with a repository, you must be aware of the behaviors and limitations of the implementation. Tip: To learn about the optional capabilities that a repository supports, see the values that are published in the repositoryInfo.capabilities structure.
59
In addition, you should be aware of the following behaviors and limitations when you develop a client application to connect to an IBM FileNet Content Manager system by using IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). Change token support Links in private working copy support Paging feed support on page 61 Query support on page 61 Versioning properties on document objects support on page 63
Change token support

IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) supports the cmis:changeToken property for only documents and folders. IBM CMIS does not support the property for domains, relationships, repositories, or content streams.

The OASIS CMIS specification defines the cmis:changeToken property to provide optimistic locking to prevent client applications from updating out-of-date objects. For more information, see section 2.2.1.3 Change Tokens of the OASIS CMIS specification.
IBM CMIS implementation

IBM CMIS for FileNet Content Manager supports the cmis:changeToken property for only documents and folders. The cmis:changeToken property is included in the object metadata for the cmis:document type and the cmis:folder type. The cmis:changeToken property maps to the IBM FileNet P8 UpdateSequenceNumber property.
Links in private working copy support

IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) supports up links in private working copies. However, in some cases the up link leads to an empty feed.

The OASIS CMIS specification uses up links that are defined in the AtomPub RFC. For more information, see section 3.4.3.2 Hierarchy Navigation Internet Draft Link Relations of the OASIS CMIS specification.

IBM CMIS for FileNet Content Manager always includes an up link in private working copies, but in some cases the up link leads to an empty feed: v If a version series includes a version other than the private working copy of the document, the up link in the private working copy leads to an empty feed.
60
v If a version series has only one version and that version is the private working copy of the document, the up link in the private working copy leads to a feed that contains the parent folder of the private working copy.
Paging feed support

IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) supports the paging of feeds. However, last links are not supported, and next links sometimes return a page that contains no results.

The OASIS CMIS specification uses first, next, previous, and last links that are defined in the AtomPub RFC. For more information, see section 3.1.8 Paging of Feeds of the OASIS CMIS specification.

IBM CMIS for FileNet Content Manager supports the paging of feeds, but has the following behaviors for next and last links: Last links Last links are not supported. Next links When the last page of feed is full (more specifically, when the number of items returned equals the value specified for the maxItems argument), IBM CMIS for FileNet Content Manager might provide an unnecessary next link.
Query support
IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) supports queries. However there are some restrictions that you should be aware of when developing queries.

The OASIS CMIS specification provides a type-based query service to search for objects on the repository. For more information, see section 2.1.10 Query of the OASIS CMIS specification.

IBM CMIS for FileNet Content Manager supports the OASIS CMIS query specifications with the following exceptions and limitations. Character escaping in LIKE strings is not supported The OASIS CMIS specification requires repositories to support the backslash (\) as an escape character in query statements. One of the requirements is that in a LIKE string, \% represents % and \_ represents _. However, IBM CMIS for FileNet Content Manager does not support querying on the percent sign (%) or the underscore (_) characters in a LIKE string because the Content Engine APIs do not support ESCAPE clauses. If
61
a query includes an escaped percent sign (\%) or an escaped underscore (\_), IBM CMIS for FileNet Content Manager converts the characters to an underscore, which is a single-character wildcard. Converting escaped percent signs and escaped underscores to a single-character wildcard character can result in more search results than expected. For example, you have three documents in your repository named document_1, document_2, and document11. You use the query SELECT * FROM Document WHERE DocumentTitle LIKE document\_% to search for all documents that have a title that starts with document_. The expected result is that document_1 and document_2 are returned by the query. However, when you submit the query, IBM CMIS for FileNet Content Manager converts the query to (SELECT * FROM Document WHERE DocumentTitle LIKE document_%), so that IBM FileNet P8 can parse the query. This query returns all three documents. Tip: You can use percent signs and underscores as wildcard characters in queries that include equality conditions because equality conditions do not require escape characters. For example, you can use the query SELECT * FROM Document WHERE DocumentTitle = document_1 OR DocumentTitle = document_2 to return document_1 and document_2. Parentheses are required for nested JOIN clauses The OASIS CMIS specification defines the following syntax for a query that contains nested JOIN clauses:
<joined table> ::= "(" <joined table> ")" | <table reference> [ <join type> ] JOIN <table reference> <join specification>
In the OASIS CMIS specification, the parentheses around the nested <joined table> are optional. However, IBM CMIS for FileNet Content Manager requires parentheses around the nested <joined table>. For example, if you submit the following query, IBM FileNet P8 returns a parsing error on the INNER JOIN clause:
SELECT d.* FROM cmis:document d INNER JOIN cmis:folder f ON d.cmis:createdBy = f.cmis:createdBy INNER JOIN EntryTemplate e ON d.cmis:lastModifiedBy = e.cmis:lastModifiedBy WHERE e.cmis:createdBy<>admin
To run this query in IBM CMIS for FileNet Content Manager, you must use the following syntax:
SELECT d.* FROM (cmis:document d INNER JOIN cmis:folder f ON d.cmis:createdBy = f.cmis:createdBy) INNER JOIN EntryTemplate e ON d.cmis:lastModifiedBy = e.cmis:lastModifiedBy WHERE e.cmis:createdBy<>admin
Nested JOIN clauses can appear on only one side of the JOIN keyword The OASIS CMIS specification defines the following syntax for a query that contains nested JOIN clauses on both sides of the JOIN keyword:
<table reference> ::= <table name> [ [ AS ] <correlation name> ] | <joined table> <joined table> ::= "(" <joined table> ")" | <table reference> [ <join type> ] JOIN <table reference> <join specification>
62
In the OASIS CMIS specification, you can have nested JOIN clauses on either side of the JOIN keyword. However, IBM CMIS for FileNet Content Manager supports nested JOIN clauses on either the left side or the right side of the JOIN keyword, but not on both sides of the JOIN keyword. For example, if you submit the following query, IBM FileNet P8 returns a parsing error because there is a nested JOIN clause on each side of the JOIN keyword:
SELECT d.* FROM (cmis:document d INNER JOIN cmis:folder f ON d.cmis:createdBy = f.cmis:createdBy) INNER JOIN (EntryTemplate e INNER JOIN Email e2 ON e.cmis:createdBy = e2.cmis:createdBy) ON d.cmis:lastModifiedBy = e.cmis:lastModifiedBy WHERE e.cmis:createdBy<>admin
To run this query in IBM CMIS for FileNet Content Manager, you must remove the nested JOIN clause on one side of the JOIN key word. The following query has a nested JOIN clause on the right side of the JOIN keyword:
SELECT d.* FROM EntryTemplate e INNER JOIN (cmis:document d INNER JOIN cmis:folder f ON d.cmis:createdBy = f.cmis:createdBy) ON d.cmis:lastModifiedBy = e.cmis:lastModifiedBy WHERE e.cmis:createdBy<>admin
Versioning properties on document objects support

IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) does not honor the cmis:checkinComment property.

The OASIS CMIS specification defines a set of versioning properties for document objects, which includes the cmis:checkinComment property. For more information, see section 2.1.9.5 Versioning Properties on Document Objects of the OASIS CMIS specification.

If a value is specified for the cmis:checkinComment property, the value is ignored when the document is checked in.
Best practices for developing client applications

There are several best practices and recommendations that you should keep in mind when accessing content through IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS).
Recommendations for using the deleteTree service

The deleteTree service deletes a folder and all of its subfolders and documents. If you call the deleteTree service with the continueOnFailure parameter set to true, folders and documents are deleted individually. If a document or folder cannot be deleted, the service moves to the next document or folder in the list. When the service completes, it returns a list of the document IDs and folder IDs that were not deleted to the client application.
63
If you call the deleteTree service with the continueOnFailure parameter set to false, all of the folders and documents are deleted in a single batch, which improves performance. However, if a document or folder cannot be deleted, none of the contents of the folder are deleted and an error is returned to the client. When continueOnFailure is set to false, the service can time out if the parent folder contains many documents and folders. If this occurs, you can call the deleteTree service on a subfolder of the parent folder to reduce the number of objects that are deleted at one time and to avoid a timeout.
Recommendations for getting unfiled documents

When you retrieve unfiled documents by using the Unfiled service collection URL, the service can consume system resources in a large system. If you implement the following suggestions, you can reduce the impact of using the Unfiled service collection URL: v In REST feeds, use next links to page through results rather than requesting the next page with a skip count. v If you want to retrieve a large number of unfiled documents, specify a larger value for the maxItems parameter to reduce the amount of paging that is required to display the documents. This is especially important if you use Web Services to retrieve documents because Web Services does not provide a next link. v If you want to retrieve a specific set of unfiled documents, use a custom query to return only the wanted documents. v If your repository (IBM FileNet P8 object store) contains more than 1,000,000 documents, use the Unfiled service collection URL only when the least number of users are using the system.
Recommendations for working with large objects

If your repository contains large objects, you should implement the following recommendations to reduce memory consumption: v For REST Services, the most efficient method to access large objects is the setContentStream method. The setContentStream method is defined in section 2.2.4.16 setContentStream of the OASIS CMIS API specification. v For Web Services, the most efficient method to access large objects is the SOAP Message Transmission Optimization Mechanism (MTOM) method, which must be configured in client application.
64
Troubleshooting IBM CMIS for FileNet Content Manager

This section includes information that you can use to troubleshoot common problems that you might encounter when using IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS). For example, this section includes information about log files, runtime error messages, and information that you must collect before calling IBM Software Support. IBM CMIS for FileNet Content Manager log files Collecting data for IBM CMIS for FileNet Content Manager on page 67 Error messages for IBM CMIS for FileNet Content Manager on page 69
IBM CMIS for FileNet Content Manager log files

IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) generates several log files that you can use to troubleshoot problems that occur when you install, configure, or use IBM CMIS.
Installation log files

IBM CMIS for FileNet Content Manager generates two installation log files: fncmis-install-ia.log This log file is generated during the IBM CMIS for FileNet Content Manager installation. Use this log file to determine whether IBM CMIS for FileNet Content Manager was successfully installed. This log file is located in the log subdirectory of the IBM CMIS installation directory. However, if the installation program stops before you specify the installation directory, the log file is saved to the desktop on Windows or the home directory of the user who is running the installation on AIX or Linux. fncmis-install.log This log file is generated during the IBM CMIS for FileNet Content Manager installation and contains debug-level logging information. If the IBM CMIS installation fails, use this log file to determine where and why the problem occurred. This log file is located in the log subdirectory of the IBM CMIS installation directory.
Configuration log files

IBM CMIS for FileNet Content Manager generates one configuration log file: fncmis-config.log This log file is generated by the IBM CMIS for FileNet Content Manager configuration tool and contains debug-level logging information. If you experience issues in the following situations, use this log file to determine where and why the problem occurred: v You cannot establish a test connection to Content Engine v The application EAR file cannot be built v The application cannot be deployed to WebSphere Application Server
65
This log file is located in the log subdirectory of the IBM CMIS installation directory.
Runtime log files

Depending on how you configure logging for IBM CMIS for FileNet Content Manager, you can find information that can help you resolve problems that occur when using IBM CMIS for FileNet Content Manager in several locations: SystemOut.log IBM CMIS for FileNet Content Manager 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 this log file and to the trace.log file. Use this log file to review messages that occur when IBM CMIS for FileNet Content Manager is running. This log file contains informational messages, warning messages, and error messages. If IBM CMIS for FileNet Content Manager throws an exception, this log file also includes stack trace. By default, this log file is in the WAS_profile_location/logs/server/ subdirectory of the WebSphere Application Server installation directory. 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 FileNet Content Manager, see Configuring logging on page 39. trace.log IBM CMIS for FileNet Content Manager uses the Apache Commons Logging API, which can be configured through the WebSphere Application Server administrative console. If you configure finest-level logging or higher (up to fatal-level logging), information is written to this log file. This log file is used by IBM Software Support to pinpoint when and where a failure occurred. By default, this log file is in the WAS_profile_location/logs/server/ subdirectory of the WebSphere Application Server installation directory. To learn more about the trace.log file, see Tracing and logging configuration in the WebSphere Application Server information center. For information about configuring the trace.log file for IBM CMIS for FileNet Content Manager, see Configuring logging on page 39. fncmis_api_error.log IBM CMIS for FileNet Content Manager bundles and performs most content operations through the Apache Commons Logging API. You can configure client-side logging if you need to troubleshoot problems related to Content Engine. This log file shows the calls that IBM CMIS for FileNet Content Manager makes to the enable IBM Software Support to pinpoint when and where a failure occurred.
66
By default, this log file is in the WAS_profile_location/logs/server/ subdirectory of the WebSphere Application Server installation directory. For information about configuring the fncmis_api_error.log file for IBM CMIS for FileNet Content Manager, see Configuring Content Engine API client logging on page 42. fncmis_api_trace.log IBM CMIS for FileNet Content Manager bundles and performs most content operations through the IBM FileNet Content Engine Java API. You can configure client-side trace logging if you need to troubleshoot problems related to Content Engine. This log file shows the calls that IBM CMIS for FileNet Content Manager makes to enable IBM Software Support to pinpoint when and where a failure occurred. This log file includes more detailed information than the fncmis_api_error.log file. By default, this log file is in the WAS_profile_location/logs/server/ subdirectory of the WebSphere Application Server installation directory. For information about configuring the fncmis_api_trace.log file for IBM CMIS for FileNet Content Manager, see Configuring Content Engine API client logging on page 42.
Uninstallation log files

IBM CMIS for FileNet Content Manager generates one uninstallation log file: fncmis-uninstall.log This log file is generated during the IBM CMIS for FileNet Content Manager uninstallation and contains debug-level logging information. If you experience issues when you uninstall IBM CMIS, use this log file to determine where and why the problem occurred. This log file is located in the log subdirectory of the IBM CMIS installation directory.
Collecting data for IBM CMIS for FileNet Content Manager

If you cannot determine the cause of a problem, you might need to contact IBM Software Support for additional assistance. In such cases, you must collect diagnostic data before contacting IBM Software Support. Collecting data before opening a problem management record (PMR) can help you to answer the following questions: v Do the symptoms match any known problems? If so, has a fix or workaround been published? v Can the problem be identified and resolved without a code fix? v When does the problem occur? Complete the following steps before contacting IBM Software Support: 1. Ensure that you have the appropriate versions of the following prerequisite software installed: v IBM WebSphere Application Server v IBM FileNet Content Manager
67
v IBM FileNet Content Engine Client For more information about the prerequisite software, see Prerequisites on page 5. 2. Recreate the problem with finest-level logging and Content Engine Client API trace logging enabled. For information about enabling finest-level logging, see Specifying log level entries on page 40. For information about enabling Content Engine Client API trace logging, see Configuring Content Engine API client logging on page 42. 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. 3. Gather the IBM CMIS for FileNet Content Manager log files: v v v v v fncmis-install-ia.log fncmis-install.log fncmis-config.log fncmis-uninstall.log (if applicable) fncmis_api_error.log
v fncmis_api_trace.log v SystemOut.log v trace.log For information about the location of the IBM CMIS for FileNet Content Manager log files, see IBM CMIS for FileNet Content Manager log files on page 65. 4. Gather the following information about your environment: v What version of IBM CMIS for FileNet Content Manager is installed? Recommendation: Copy the installation information from the About your IBM CMIS installation page on the IBM CMIS for FileNet Content Manager index page. v How is your IBM CMIS for FileNet Content Manager system configured? Recommendation: Copy the configuration information from the About your IBM CMIS configuration page on the IBM CMIS for FileNet Content Manager index page, which includes information about your IBM CMIS configuration, system properties, and environment variables. v Is the IBM CMIS for FileNet Content Manager installation a fresh installation or did you upgrade from a previous version of IBM CMIS for FileNet Content Manager? v What is the operating system, including the version number, of the IBM CMIS for FileNet Content Manager server? v What version of WebSphere Application Server is IBM CMIS for FileNet Content Manager deployed to? (Specify WebSphere Application Server or WebSphere Application Server Network Deployment.) v Was IBM CMIS for FileNet Content Manager deployed automatically or manually?
68
v What type of environment is IBM CMIS for FileNet Content Manager deployed to? For example is IBM CMIS deployed to a single application server, an unmanaged node, a managed node, or an application server cluster? v How was IBM CMIS for FileNet Content Manager configured? Did you use the configuration tool or did you run a silent configuration? 5. Describe the problem. Provide the following information to help IBM Software Support understand the problem that you are encountering: v What are you trying to do when the problem occurs? v Can the problem be reproduced? If so, how? Provide specific steps to reproduce the problem. v How many users are affected by this problem? v What is the business impact of this problem? v Is there a workaround for this problem?
Error messages for IBM CMIS for FileNet Content Manager

If you receive an error message while using IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS), the error that is displayed in the HTTP response contains the information that you need to resolve the issue. However, the errors are also provided in the information center for your reference. CIL1100 on page 71 CIL1122 on page 71 CIL1125 on page 71 CIL1129 on page 71 CIL1130 on page 71 CIL1139 CIL1140 CIL1143 CIL1144 CIL1145 CIL1146 CIL1147 on on on on on on on page page page page page page page 71 71 71 71 72 72 72
CIL1148 on page 72 CIL1200 on page 72 CIL1217 on page 72 CIL1218 on page 72 CIL1298 on page 72 CIL1299 CIL1300 CIL1400 CIL1401 on on on on page page page page 72 72 72 73
CIL1402 on page 73 CIL1403 on page 73 CIL1404 on page 73 CIL1405 on page 73 CIL1406 on page 73
69
CIL1407 CIL1408 CIL1412 CIL1413 CIL1415 CIL1416 CIL1417 CIL1500 CIL1502 CIL1503 CIL1508 CIL1510
on on on on on on on on on on on on
page page page page page page page page page page page page
73 73 73 73 73 74 74 74 74 74 74 74
CIL1511 on page 74 CIL1513 on page 75 CIL1514 on page 75 CIL1515 on page 75 CIL1516 on page 75 CIL1517 on page 75 CIL1519 on page 75 CIL1524 on page 75 CIL1525 on page 75 CIL1600 CIL1601 CIL1602 CIL1603 CIL1604 CIL1605 CIL1606 CIL1607 on on on on on on on on page page page page page page page page 75 75 76 76 76 76 76 76
CIL1609 on page 76 CIL1610 on page 76 CIL1611 on page 76 CIL1612 on page 76 CIL1613 on page 76 CIL1614 on page 77 CIL1615 CIL1616 CIL1700 CIL1701 CIL1800 CIL1900 CIL2000 on on on on on on on page page page page page page page 77 77 77 77 77 77 77
CIL2001 on page 77 CIL2100 on page 77 CIL2102 on page 78
70
CIL1100 CIL1144
CIL2103 CIL2104 CIL2105 CIL2106 CIL2107 on on on on on page page page page page 78 78 78 78 78
CIL2200 on page 78 CIL2300 on page 78

CIL1100 The service cannot be completed because one or more of the input parameters are missing or are not valid. Invalid value: {invalid header value} Explanation: No additional explanation is required. User response: For more information about the HTTP request header, see the HTTP resources that are mentioned in the "Normative References" section of the OASIS CMIS API specification. CIL1139 CIL1122 The query cannot be completed because the query syntax is not correct. Query: {query string} OASIS CMIS exception: {exception message} The service cannot be completed because the following object is not a folder: {object path or object ID}
Explanation: No additional explanation is required. User response: For more information about implementing the argument, see the OASIS CMIS API specification.
Explanation: The service can be performed only for a folder. User response: Specify a path or object ID that points to a folder. For more information about implementing the service, see the OASIS CMIS API specification. CIL1140 The service cannot be completed because the following object is a root folder: {object path or object ID}
Explanation: Either the query contains an invalid character, or the structure of the query is not correct. User response: Modify the query and try again. If the problem persists, see the "Query Language Definition" section of the OASIS CMIS API specification for more information. CIL1125 The service cannot be completed because the {header name} HTTP header is missing.
Explanation: The specified header is required. User response: Provide the required HTTP header. For more information about required HTTP headers, see the HTTP resources that are mentioned in the "Normative References" section of the OASIS CMIS API specification. CIL1129 The service cannot be completed because the content stream cannot be decoded. Input length: {content length} Document MIME type: {MIME type} Required encoding: base64
Explanation: The service returns the parents of a folder. However, the folder that was specified is a root folder, which does not have parents. User response: Specify a path or object ID that points to a folder other than a root folder. For more information about implementing the service, see the OASIS CMIS API specification. CIL1143 The service cannot be completed because the following object is not a document: {object path or object ID}
Explanation: The service can be performed only for a document. User response: Specify a path or object ID that points to a document. For more information about implementing the service, see the OASIS CMIS API specification. CIL1144 The service cannot be completed because the required input parameter, {parameter name}, was not specified.
Explanation: The document might be corrupted or truncated. User response: Resubmit the request with a properly encoded content stream. OASIS CMIS requires a base64 encoding. CIL1130 The service cannot be completed because the {header name} HTTP request header contains an invalid value.
Explanation: No additional explanation is required.

71
CIL1145 CIL1400
User response: Specify the required input parameter. For more information about implementing the service, see the OASIS CMIS API specification. CIL1145 The service cannot be completed because the value that was specified for the following input parameter is not valid. Input parameter: {parameter name} Value: {parameter value} CIL1217 The query contains an invalid object type ID. Object type ID: {object type}
Explanation: Either the specified object type ID does not exist or is not a valid argument for the query. User response: Verify that the object type is spelled correctly and is a supported OASIS CMIS object type, such as cmis:document or cmis:folder. If the problem persists, see the "Query Language Definition" section of the OASIS CMIS specification for more information. CIL1218 The major version of the document cannot be retrieved because the version series does not contain a major version.
Explanation: No additional explanation is required. User response: For information about implementing the argument, see the OASIS CMIS API specification. CIL1146 The service cannot be completed because the value that was specified for the following input parameter is not valid. Input parameter: {parameter name} Value: {parameter value} Valid values: "{list or range of valid values}"
Explanation: This error occurs when the object that is specified for the getObjectOfLatestVersion argument does not have a major version. User response: For information on implementing the getObjectOfLatestVersion argument, see the OASIS CMIS API specification. CIL1298 The service cannot be completed because the following object cannot be found: {object path or object ID}
Explanation: No additional explanation is required. User response: For information about implementing the argument, see the OASIS CMIS API specification. CIL1147 The URL of the request is not valid. URL: {URL} Invalid portion of the URL: {invalid syntax}
Explanation: No additional explanation is required. User response: Verify that the path or ID of the object is correct or specify a different object. CIL1299 The service cannot be completed because the following object cannot be found: Input parameter: {parameter name} Object ID or path: {object path or object ID}
Explanation: The syntax of the URL is incorrect. User response: Specify a URL with the correct format. See the RESTful AtomPub binding service document for information about the correct format for collection URLs. CIL1148 The service cannot be completed because the following object ID or path is not valid: {object path or object ID}
Explanation: No additional explanation is required. User response: Verify that the path or ID of the object is correct or specify a different object. CIL1300 Your request cannot be completed because you do not have the appropriate permissions on the repository.
Explanation: The object ID or path might contain invalid characters or use invalid syntax. User response: Ensure that a valid object ID or path is retrieved from HTTP responses, or the RESTful AtomPub binding service document, or the Web Services binding document. CIL1200 The service cannot be completed because the object cannot be found.
Explanation: No additional explanation is required. User response: If you need different permissions, contact your content management server administrator for assistance. CIL1400 The service cannot be completed because the service method that was invoked requires an optional capability that is not supported by the repository.
Explanation: No additional explanation is required. User response: Verify that the path or ID of the object is correct or specify a different object.
Explanation: No additional explanation is required. User response: Use the getRepositoryInfo service to
72
CIL1401 CIL1415
see the supported services for a repository. CIL1401 The content stream cannot be deleted because the following error occurred on the content management server. Content management server error: {exception message} CIL1406 The {0} property cannot be used in a query statement, because the property is not queryable, selectable, or orderable.
Explanation: A property that is not queryable, selectable, or orderable cannot be used in a query statement. User response: Modify the query to remove the specified property. Use the property definition or contact your content server administrator to determine whether a property is queryable, selectable, or orderable. CIL1407 The query cannot be used because it has more than one CONTAINS clause.
Explanation: No additional explanation is required. User response: See the content management server documentation for information on resolving the issue. CIL1402 The document cannot be deleted because it is not checked out.
Explanation: No additional explanation is required. User response: Ensure that the document that you want to delete is checked out and try again. CIL1403 The {operator name} operator cannot be used to query the {property name} property.
Explanation: A query statement can include only one CONTAINS clause. User response: Modify the query to use only one CONTAINS clause or separate each CONTAINS clause into a separate query. To learn more, see the "Query Language Definition" section of the OASIS CMIS specification. CIL1408 The query cannot be used because it has a SCORE clause but does not have a corresponding CONTAINS clause.
Explanation: The query supports only equality (=) and IN operators for certain properties. User response: Rewrite the query to use the equals (=) or IN operator. Contact your content server system administrator for additional information about the query restrictions that apply to your content management system. CIL1404 The following query cannot be used because the NOT operator cannot be used with a CONTAINS clause. Query: {query string}
Explanation: A query statement that includes a SCORE clause must include a corresponding CONTAINS clause. User response: Modify the query to add a CONTAINS clause or remove the SCORE clause. To learn more, see the "Query Language Definition" section of the OASIS CMIS specification. CIL1412 The object of type {object type} cannot be created.
Explanation: The NOT operator cannot be used with a CONTAINS clause. User response: Modify the query to replace "NOT CONTAINS(''query_string1 query_string2'')" with "CONTAINS(''-query_string1 -query_string2'')". Contact your content server system administrator for additional information about the query restrictions that apply to your content management system. CIL1405 The query cannot be used because it has a CONTAINS clause and a JOIN clause.
Explanation: IBM CMIS does not support the specified object type. User response: No action required. CIL1413 The object cannot be unfiled from the folder because it is not a document.
Explanation: Only documents can be unfiled. User response: Ensure that the object that you want to unfile is a document and try again. CIL1415 The object cannot be deleted because the object is not a folder.
Explanation: A query cannot have both a CONTAINS clause and a JOIN clause. User response: Modify the query to remove the CONTAINS clause or the JOIN clause. Contact your content server system administrator for additional information about the query restrictions that apply to your content management system.
Explanation: The deleteTree service can be used only to delete folders. User response: For more information on the deleteTree
73
CIL1416 CIL1511
service, see the OASIS CMIS API specification. CIL1416 The {operation name} HTTP operation is not supported on this collection or resource. See the "Installation and configuration checklist" in the information center for information about the valid values and formats for each property. User response: Take one of the following actions to resolve the issue: v If the property is a basic configuration property, run the configuration program again to rebuild and deploy the web application EAR file. v If the property is an advanced configuration property, modify the fncmis_advanced.properties file and run the configuration program again to rebuild and deploy the web application EAR file. CIL1508 The query cannot be run because full-text search is not configured for the repository.
Explanation: No additional explanation is required. User response: For more information about the specified HTTP operation, see the OASIS CMIS API specification. CIL1417 The service cannot be completed because the {object type} object type is not supported.
Explanation: IBM CMIS does not support the specified object type. User response: No action is required. CIL1500 The service cannot be completed.
Explanation: To run the query, full-text search must be configured on the repository. User response: Contact your content server system administrator to determine whether full-text search is configured for the repository. CIL1510 The service cannot be completed because the operation requires an object, and {path or ID} is not an object.
Explanation: This error can occur for the following reasons: v An error in the IBM CMIS application v An error on the repository User response: See the HTTP response or the WebSphere Application Server SystemOut.log file for more information and to review the stack trace for the exception. By default, the SystemOut.log file is in the WAS_profile_location/logs/server/logs subdirectory of the WebSphere Application Server installation directory. CIL1502 The value, {value}, that was specified for the {property name} property in the configuration file is not valid.
Explanation: The operation can be performed only for an object. User response: For more information about implementing the service, see the OASIS CMIS API specification. CIL1511 The service cannot be completed because no repositories were found.
Explanation: This error can occur for the following reasons: v No repositories are defined on the content management server. v IBM CMIS cannot connect to the content management server because of a network connectivity problem. v The content management server connection information in the IBM CMIS configuration is not correct. v The WebSphere Application Server security information in the IBM CMIS configuration is not correct. v An LTPA key expired. v An LDAP server is not running or cannot be reached because of a network connectivity problem. User response: See the WebSphere Application Server SystemOut.log file for more information. By default, the SystemOut.log file is in the WAS_profile_location/logs/server/logs subdirectory
Explanation: See the "Installation and configuration checklist" in the information center for information about the valid values and formats for each property. User response: Take one of the following actions to resolve the issue: v If the property is a basic configuration property, run the configuration program again to rebuild and deploy the web application EAR file. v If the property is an advanced configuration property, modify the fncmis_advanced.properties file and run the configuration program again to rebuild and deploy the web application EAR file. CIL1503 The syntax of the following entry is not valid. Configuration file entry: {property name}/{value}
Explanation: The syntax property/value is not correct. The correct syntax is property=value.
74
CIL1513 CIL1601
of the WebSphere Application Server installation directory. CIL1513 The query cannot be run because the following error occurred. Query: {query string} Content server exception: {exception message} the content management server. CIL1517 The service cannot be completed because the XML input cannot be deserialized.
Explanation: Either no input was provided or the input is not a well-formed XML document. User response: Provide a valid CMIS Atom entry. For more information about Atom entries, see the OASIS CMIS API specification. CIL1519 The configuration file, {file name}, cannot be loaded from the web application.
Explanation: An error occurred on the content server when running the query. User response: See the WebSphere Application Server SystemOut.log file for more information and to review the stack trace for the exception. By default, the SystemOut.log file is in the WAS_profile_location/logs/server/logs subdirectory of the WebSphere Application Server installation directory. CIL1514 The required property, {property name}, is not defined in the cmis.properties configuration file.
Explanation: The configuration file might be corrupted or might have been moved or deleted. User response: Run the configuration program again to rebuild and deploy the web application EAR file. CIL1524 The folder cannot be deleted because the deleteTree service timed out.
Explanation: No additional explanation is required. User response: Run the configuration program again to specify the missing property and to rebuild and deploy the web application EAR file. CIL1515 The SOAP header is missing the locale element, which is a required element.
Explanation: No additional explanation is required. User response: To prevent the request from timing out, take one of the following actions: v Delete smaller folders. For example delete any subfolders before deleting the parent folder. v Resubmit the delete request with the continueOnFailure property set to true. CIL1525 The service cannot be completed because an error occurred in IBM CMIS. IBM CMIS error: {additional error information}
Explanation: According to the W3C Web Services Internationalization (WS-I18N) standard, the international element in a SOAP header must have exactly one locale element, and the locale element must be the first item in the children property of the international element. User response: Add the locale element to the international element in the SOAP header. For information on how to format the SOAP header, see the W3C standard Web Services Internationalization (WS-I18N). CIL1516 The folder cannot be deleted because the {object path or object ID} object cannot be deleted. Content management server error: {error message}
Explanation: No additional information is available. User response: Contact IBM Software Support. Before calling, ensure that you collect the information that is listed in "Collecting data for IBM CMIS" in the information center. CIL1600 The service cannot be completed because a constraint was violated.
Explanation: No additional explanation is required. User response: For more information about implementing the service, see the OASIS CMIS API specification. CIL1601 The service cannot be completed because a value that was specified for a property violated a constraint.
Explanation: The folder cannot be deleted if the folder contains an object that cannot be deleted. User response: Delete the objects in the folder individually. You can use an OASIS CMIS service, such as getChildren or query, to determine the objects that are still in the folder. See the content management server documentation for information about resolving the error that occurred on
Explanation: The value that was specified for a property is outside the permitted range or the value exceeds the maximum length allowed.
75
CIL1602 CIL1613
User response: Use the property definition of the object type to get the valid range and maximum length. CIL1602 The document cannot be checked out because the object ID was not specified. CIL1607 The folder cannot be deleted because it is not empty.
Explanation: The delete operation cannot be performed for a folder that is not empty. User response: For more information about deleting folders, see the OASIS CMIS API specification. CIL1609 The list of parents cannot be returned for the {object path or object ID} object because the object is not a fileable object.
Explanation: No additional explanation is required. User response: For more information about the versioning service, see the OASIS CMIS API specification. CIL1603 The object cannot be deleted because it is not a document.
Explanation: No additional explanation is required. User response: No action is required. For more information about the versioning service, see the OASIS CMIS API specification. CIL1604 The document cannot be created because the {versioning state} versioning state is not a valid state for the {document type} document type.
Explanation: The getObjectParents method returns the parent folders of a fileable object. If an object is not fileable, the getObjectParents method is not valid. User response: For more information about the getObjectParents method, see the OASIS CMIS API specification. CIL1610 The document cannot be created because one or more required properties are missing.
Explanation: The specified document type requires versioning. User response: Specify a valid versioning parameter. Contact your content management system administrator for information about the versioning requirements on the repository. CIL1605 Versioning is disabled for the {document class} document class when the versioning state is set to "{versioning state}".
Explanation: No additional explanation is required. User response: Specify a value for each required property and try to create the document again. Use the document type definition to determine which properties are required. CIL1611 A property cannot be set or modified because it is read-only.
Explanation: No additional explanation is required. User response: Use the property definition to determine which properties can be modified and which properties are read-only. CIL1612 The object cannot be updated because the {property name} property is read-only.
Explanation: Versioning is disabled for the specified document type. User response: Specify a valid versioning parameter. Contact your content management system administrator for information about the versioning requirements on the repository. CIL1606 The {document path or document ID} document cannot be checked out because versioning is disabled.
Explanation: No additional explanation is required. User response: Use the property definition to determine which properties can be modified and which properties are read-only. CIL1613 The service cannot be completed because the document does not contain a content stream.
Explanation: When versioning is disabled for the document type, documents cannot be checked out. User response: No action is required. Contact your content management system administrator for information about the versioning requirements on the repository.
Explanation: The service can be completed only for documents that contain content streams. User response: For more information about content streams, see the OASIS CMIS API specification.
76
CIL1614 CIL2100
CIL1614 The content stream cannot be retrieved because the streamId {stream ID} is not valid. CIL1800 The service cannot be completed because the document type that was specified does not support content streams.
Explanation: The value that was specified for the streamId is outside the range of valid streamIds on the content server. User response: Specify the streamId of an existing content stream. For more information about streamIds, see the OASIS CMIS API specification. CIL1615 The service cannot be completed because one or more specified properties do not exist for the specified object type.
Explanation: No additional explanation is required. User response: Use the object type definition to determine whether a document type supports content streams. CIL1900 The service cannot be completed because of a storage problem on the repository.
Explanation: There is an issue on the repository that prevents objects from being created or updated. User response: See the WebSphere Application Server SystemOut.log file for more information about the error that occurred on the repository. By default, the SystemOut.log file is in the WAS_profile_location/logs/server/logs subdirectory of the WebSphere Application Server installation directory. CIL2000 The contents of the document cannot be updated because a content stream already exists and the overwriteFlag parameter is set to false.
Explanation: No additional explanation is required. User response: Use the object type definition to determine the properties that are available for the object type. CIL1616 The service cannot be completed because the {property name} property does not exist for the specified object type.
Explanation: No additional explanation is required. User response: Use the object type definition to determine the properties that are available for the object type. CIL1700 The query cannot be completed because the filter contains an invalid character.
Explanation: When the overwriteFlag parameter is set to false, the content cannot be changed. User response: For more information about updating the contents of a document, see the OASIS CMIS API specification. CIL2001 The contents of the following document cannot be updated because a content stream already exists and the overwriteFlag parameter is set to false: {document path or document ID}
Explanation: The following characters are not valid: space " ", backslash "\", double backslash "\\", period. ".", left parenthesis "(", right parenthesis ")", and apostrophe "'". User response: Modify the filter to remove the invalid character. CIL1701 The query cannot be completed because the filter contains the following invalid character: {character}.
Explanation: When the overwriteFlag parameter is set to false, the content cannot be changed. User response: For more information about updating the contents of a document, see the OASIS CMIS API specification. CIL2100 The service cannot be completed because the document is not the current version.
Explanation: The following characters are not valid: space " ", backslash "\", double backslash "\\", period. ".", left parenthesis "(", right parenthesis ")", and apostrophe "'". User response: Modify the filter to remove the invalid character.
Explanation: The service can be completed only for the current version of a document. User response: Specify the current version of the document and try again.
77
CIL2102 CIL2300
CIL2102 The document cannot be checked in because it is not currently checked out. CIL2300 The object cannot be updated or created because another object with the same name already exists.
Explanation: No additional explanation is required. User response: If you want to modify the document, check out the document and try again. CIL2103 The {document path or document ID} document cannot be checked in because it is not currently checked out.
Explanation: The object type requires that each object have a unique name. User response: Specify a different name for the object. Use the object type definition to determine the uniqueness requirements for the object type.
Explanation: No additional explanation is required. User response: If you want to modify the document, check out the document and try again. CIL2104 The {document path or document ID} document cannot be checked out because it is already checked out.
Explanation: No additional explanation is required. User response: If the document is checked out by another user, you must wait until the user checks the document in. CIL2105 The {document path or document ID} document cannot be checked out because it is not the current version.
Explanation: No additional explanation is required. User response: Specify the current version of the document and try again. CIL2106 The service cannot be completed because the {document path or document ID} document is not the current version.
Explanation: The service can be completed only for the current version of a document. User response: Specify the current version of the document and try again. CIL2107 The object cannot be moved because it is not the current version.
Explanation: Only the current version of the object can be moved from one folder into another. User response: Specify the current version of the object and try again. CIL2200 The object cannot be updated because the object is no longer the current version.
Explanation: A newer version of the object exists on the repository. User response: Specify the current version of the object and try again.
78
Removing IBM CMIS for FileNet Content Manager

You can use the uninstallation program or the silent uninstallation command to remove IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) from the workstation where the software is installed. Important: When you uninstall IBM CMIS, the deployed application is not removed from WebSphere Application Server. You must manually remove the application from WebSphere Application Server. To uninstall IBM CMIS: Run the uninstallation program:
Operating system AIX Command At a command prompt, change to the uninstall directory of the IBM CMIS installation directory and enter one of the following commands: v To use the uninstallation program, enter ./uninstall.sh v To use the silent uninstallation command, enter ./uninstall.sh -s Linux At a command prompt, change to the uninstall directory of the IBM CMIS installation directory and enter one of the following commands: v To use the uninstallation program, enter ./uninstall.sh v To use the silent uninstallation command, enter ./uninstall.sh -s Windows At a command prompt, change to the uninstall directory of the IBM CMIS installation directory and enter one of the following commands: v To use the uninstallation program, enter uninstall.bat v To use the silent uninstallation command, enter uninstall.bat -s
If you ran the uninstallation program to remove IBM CMIS, complete the following tasks to complete the uninstallation: 1. Manually remove any files that were not removed by the uninstallation program. 2. Manually remove the deployed IBM CMIS application from WebSphere Application Server. If you used the silent uninstallation command to remove IBM CMIS, complete the following tasks to complete the uninstallation:
79
1. See the fncmis-uninstall.log file in the log subdirectory of the IBM CMIS installation directory, to ensure that IBM CMIS was successfully removed from the workstation. 2. Manually remove any files that were not removed by the uninstallation program. 3. Manually remove the deployed IBM CMIS application from WebSphere Application Server. Removing IBM CMIS for FileNet Content Manager from WebSphere Application Server
Removing IBM CMIS for FileNet Content Manager from WebSphere Application Server
When you remove the IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) software from the workstation, the deployed application is not removed from WebSphere Application Server. You must manually remove the application from WebSphere Application Server. To remove IBM CMIS from WebSphere Application Server: 1. Log in to the WebSphere Application Server administrative console. 2. If you configured IBM CMIS to use WS-Security, remove the WS-Security policy set from WebSphere Application Server: a. Click Services Policy sets Application policy sets. b. Select the WS-Security policy set, cmis_auth_policyset. c. Click Delete. d. Save your changes to the master configuration. 3. Uninstall the application: a. Click Applications Application Types WebSphere enterprise applications. b. Select the IBM CMIS application. By default, the application is named fncmis. c. Click Uninstall. d. On the Uninstall application panel, click OK. e. Save your changes to the master configuration.
80
Accessibility features of IBM CMIS for FileNet Content Manager

IBM Content Management Interoperability Services for FileNet Content Manager (IBM CMIS) includes features that make it more accessible to people with disabilities.
Silent installation and configuration

For an accessible version of the IBM CMIS installation and configuration programs, you must use the silent installation and silent configuration features.
Product documentation
The documentation for IBM CMIS is available in HTML format within an accessible information center. The HTML format enables you to view documentation according to the display preferences that are set in your web browser. The HTML format also supports the use of screen readers and other assistive technologies. The documentation is also available in PDF format.
81
82
Notices
This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan Ltd. 1623-14, Shimotsuruma, Yamato-shi Kanagawa 242-8502 Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.
83
IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation J46A/G4 555 Bailey Avenue San Jose, CA 95141-1003 U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurements may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products. All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs.
84
Portions of this product are: v Copyright OASIS 2009, 2010. All Rights Reserved. All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website. This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English. The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns. This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so. OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims. The names "OASIS", CMIS are trademarks of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of,
Notices
85
specifications, while reserving the right to enforce its marks against misleading uses. Please see http://www.oasis-open.org/who/trademark.php for above guidance. Trademarks
Trademarks
The following terms are trademarks of the International Business Machines Corporation in the United States, other countries, or both: http://www.ibm.com/ legal/copytrade.shtml Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, and/or other countries. Microsoft, Windows, and Windows NT are trademarks of Microsoft Corporation in the United States, other countries, or both. Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both. Other company, product, and service names may be trademarks or service marks of others.
86
Index A
accessibility features 81 API OASIS CMIS specification architecture overview 3 55 configuration (continued) planning for (continued) silent configuration 11 silent configuration 27 web application, creating 25 worksheets 8 advanced configuration 15 interactive configuration 9 silent configuration 11 configuration tool deployment 47 controlled vocabulary lists security, support for 7 CVLs security, support for 7 GZIP compression See extensions
H
hardware requirements IBM CMIS 5
C
ChoiceListDisplayName See extensions ChoiceListSymbolicName See extensions ClassDisplayName See extensions CMIS LTPA, configuring 36 SSO LTPA, configuring 36 SSO, configuring 35 CMIS APIs developing with 53 best practices 63 CMIS client APIs resources 55 collecting data IBM CMIS 67 collecting troubleshooting data 67 configuration advanced properties 30 buffer length 33 checkout_copycontent 34 CMC_TIME_TO_LIVE 31 cmisURI 33 CRC_TIME_TO_LIVE 31 CVL_Cache 32 defaultMaxItems 34 filterHiddenProperties 32 queryTimeLimit 34 SecureMetadataCache 35 configuration tool 25 IBM CMIS 25 advanced properties 30 buffer length 33 checkout_copycontent 34 CMC_TIME_TO_LIVE 31 cmisURI 33 configuration tool 25 CRC_TIME_TO_LIVE 31 CVL_Cache 32 defaultMaxItems 34 filterHiddenProperties 32 queryTimeLimit 34 SecureMetadataCache 35 web application 25 logging 39 log location 41 log size 41 planning for 8 advanced configuration 15 interactive configuration 9 Copyright IBM Corp. 2010,
I
IBM CMIS 1, 8, 9, 11 accessibility features 81 architecture overview 3 behaviors 59 error messages 69 extensions 56 choice list display name 57 choice list symbolic name 57 ChoiceListDisplayName 57 ChoiceListSymbolicName 57 class display name 56 ClassDisplayName 56 domain name 57 DomainName 57 GZIP compression 59 hidden properties 57 isHidden 57 object store database type 58 object store ID 58 ObjectStoreDBType 58 ObjectStoreID 58 records management extension 58 RecordsManagementEnabled 58 text search engine 59 TextSearchEngine 59 index page 53 service collection URLs 54 URI templates 55 language support 7 limitations 59 cmis:changeToken property 60 cmis:checkinComment property 63 paging of feeds 61 private working copy links 60 queries 61 log files 65 planning for 5 prerequisites 5 removing 79 deployed application 80 service documents 53 service collection URLs 54 URI templates 55 troubleshooting 65 uninstalling 79 IBM CMIS implementations 59 cmis:changeToken property 60 cmis:checkinComment property 63 paging of feeds 61
D
deploying 47 deployment configuration tool 47 IBM CMIS 47 IBM CMIS application 47 manual deployment 50 silent configuration 48 manual deployment 50, 51 generic JVM arguments 50 policy sets 51 silent configuration 48 DomainName See extensions
E
error messages 69 extensions 56 choice list display name 57 choice list symbolic name 57 ChoiceListDisplayName 57 ChoiceListSymbolicName 57 class display name 56 ClassDisplayName 56 domain name 57 DomainName 57 GZIP compression 59 hidden properties 57 isHidden 57 object store database type 58 object store ID 58 ObjectStoreDBType 58 ObjectStoreID 58 records management extension 58 RecordsManagementEnabled 58 text search engine 59 TextSearchEngine 59
G
generic JVM arguments manual deployment 50
87
IBM CMIS implementations (continued) private working copy links 60 queries 61 IBM CMIS, configuring 25 advanced properties 30 buffer length 33 checkout_copycontent 34 CMC_TIME_TO_LIVE 31 cmisURI 33 CRC_TIME_TO_LIVE 31 CVL_Cache 32 defaultMaxItems 34 filterHiddenProperties 32 queryTimeLimit 34 SecureMetadataCache 35 configuration tool 25 log location 41 log size 41 logging 39 silent configuration 27 web application 25 IBM CMIS, installing 19 Content Engine Client files 22 installation program 20 silent installation 21 software 19 index page 53 service collection URLs 54 URI templates 55 installation Content Engine Client files 22 IBM CMIS 19 IBM CMIS installation program 20 IBM CMIS software 19 IBM CMISsilent installation 21 planning for 8 interactive installation 9 silent installation 11 worksheets 8 interactive installation 9 silent installation 11 interactive configuration planning for 9 worksheets 9 interactive installation planning for 9 worksheets 9 isHidden See extensions
logging (continued) Content Engine API client logging 43 log location 41 log size 41 Log4J 43 logged errors 42 WebSphere Application Server logging levels 40 LTPA configuring 36 key, exporting 37 key, generating 36 key, importing 37 LTPA key exporting 37 generating 36 importing 37
M
manual deployment 51
security planning for 6 server configuration 6 server topology 6 service documents 53 service collection URLs URI templates 55 silent configuration deployment 48 planning for 11 worksheets 11 silent installation planning for 11 worksheets 11 Single sign-on (SSO) configuring 35 software requirements IBM CMIS 5 supported languages IBM CMIS 7
54
T
TextSearchEngine See extensions troubleshooting collecting data IBM CMIS 67 error messages 69 IBM CMIS 65 error messages 69 log files 65 log files 65
O
OASIS CMIS resources 55 OASIS CMIS APIs developing with 53 best practices 63 OASIS CMIS specification 55 object types controlled vocabulary lists security, support for 7 CVLs security, support for 7 ObjectStoreDBType See extensions ObjectStoreID See extensions
U
uninstallation 79 user authentication planning for 6
P
planning for 8, 9, 11 policy sets manual deployment WS-Security 51 prerequisites IBM CMIS 5 51
W
web application, creating 25 configuration tool 25 WebSphere Application Server planning for 5 WebSphere Application Server Network Deployment planning for 5 worksheets advanced configuration 15 configuration 8 installation 8 interactive configuration 9 interactive installation 9 silent configuration 11 silent installation 11
L
languages IBM CMIS 7 LDAP configuring 38 limitations cmis:changeToken property 60 cmis:checkinComment property 63 paging of feeds 61 private working copy links 60 queries 61 log files 65 log4j.properties 43 sample 43 logging configuring 39
R
RecordsManagementEnabled See extensions removing deployed application 80 resources CMIS client APIs 55 OASIS CMIS 55
S
samples log4j.properties 43
88
Program Number: 5724-R81
SC19-3220-00

CMIS c1932200

Загружено:

Сведения о документе

Исходное описание:

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

CMIS c1932200

Загружено:

Авторское право:

Доступные форматы

IBM Content Management Interoperability Services for FileNet Content Manager

IBM Content Management Interoperability Services for FileNet Content Manager

Deploying IBM CMIS for FileNet Content Manager . . . . . . . . . . 47

IBM CMIS for FileNet Content Manager Development . . . . . . . . . . . . 53

Installing IBM CMIS for FileNet Content Manager . . . . . . . . . . . . . . 19

Configuring IBM CMIS for FileNet Content Manager . . . . . . . . . . 25

Troubleshooting IBM CMIS for FileNet Content Manager . . . . . . . . . . 65

Accessibility features of IBM CMIS for FileNet Content Manager . . . . . . . 81 Notices . . . . . . . . . . . . . . 83

Removing IBM CMIS for FileNet Content Manager . . . . . . . . . . 79

ibm.com and related resources

Support and assistance

How to send your comments

Copyright IBM Corp. 2010,

Perform once to install the product.

Copyright IBM Corp. 2010,

IBM CMIS for FileNet Content Manager architecture overview

IBM FileNet Content Engine

CMIS-enabled enterprise content management system

Planning for IBM CMIS for FileNet Content Manager

Planning for WebSphere Application Server

WebSphere Application Server topologies

WebSphere Application Server Network Deployment topologies

Recommended server topology

User authentication and security

Support for IBM FileNet Content Manager CVL security

Language support for IBM CMIS for FileNet Content Manager

Planning for IBM CMIS for FileNet Content Manager

Installation and configuration worksheets

Installation and configuration worksheet

Basic configuration parameters

Content Engine password

Planning for IBM CMIS for FileNet Content Manager

Administrator user name Password

Silent installation and configuration worksheet

Planning for IBM CMIS for FileNet Content Manager

Basic configuration parameters

Planning for IBM CMIS for FileNet Content Manager

Advanced configuration worksheet

Planning for IBM CMIS for FileNet Content Manager

com.ibm.xml.xlxp2.api. util.encoding.DataSource Factory.bufferLength

Planning for IBM CMIS for FileNet Content Manager

Installing IBM CMIS for FileNet Content Manager

Installing the IBM CMIS for FileNet Content Manager software

Copyright IBM Corp. 2010,

Running the installation program

Running a silent installation

The response file must contain the following text:

Installing IBM CMIS for FileNet Content Manager

Configuring IBM CMIS for FileNet Content Manager

Configuring IBM CMIS by running the configuration tool

Configuring IBM CMIS by running a silent configuration

Configuring IBM CMIS for FileNet Content Manager

Configuring IBM CMIS for FileNet Content Manager

Configuring advanced IBM CMIS for FileNet Content Manager properties

Content Engine metadata cache time to live (CMC_TIME_TO_LIVE)

Client server cache time to live (CRC_TIME_TO_LIVE)

CVL caching (CVL_Cache)

Filter hidden properties (filterHiddenProperties)

IBM CMIS URL (cmisURI)

Internal buffer size (com.ibm.xml.xlxp2.api.util.encoding.DataSourceFactory. bufferLength)

Maximum number of items to return (defaultMaxItems)

Private working copy content stream (checkout_copycontent)

Query time limit (queryTimeLimit)