CMIS c1932200

IBM Content Management Interoperability Services forFileNet Content ManagerVersion 1.0.0

Planning, Installing, and ConfiguringIBM Content ManagementInteroperability Services for FileNetContent 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 number5724-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 Contractwith IBM Corp.

Contents

ibm.com and related resources. . . . . vHow to send your comments . . . . . . . . . vContacting IBM . . . . . . . . . . . . . vi

Planning, installing, and configuring IBMCMIS for FileNet Content Manager . . . 1

IBM CMIS for FileNet Content Managerarchitecture overview . . . . . . . . . 3

Planning for IBM CMIS for FileNetContent Manager . . . . . . . . . . . 5Prerequisites . . . . . . . . . . . . . . 5Planning for WebSphere Application Server . . . . 5Recommended server topology . . . . . . . . 6User authentication and security. . . . . . . . 6

Support for IBM FileNet Content Manager CVLsecurity . . . . . . . . . . . . . . . 6

Language support for IBM CMIS for FileNet ContentManager . . . . . . . . . . . . . . . . 7Installation and configuration worksheets. . . . . 8

Installation and configuration worksheet . . . . 9Silent installation and configuration worksheet . 11Advanced configuration worksheet . . . . . 14

Installing IBM CMIS for FileNet ContentManager . . . . . . . . . . . . . . 19Installing the IBM CMIS for FileNet ContentManager software . . . . . . . . . . . . 19

Running the installation program . . . . . . 20Running a silent installation . . . . . . . . 21

Installing Content Engine Client files for IBM CMISfor FileNet Content Manager . . . . . . . . 22

Configuring IBM CMIS for FileNetContent Manager . . . . . . . . . . 25Configuring the IBM CMIS for FileNet ContentManager web application . . . . . . . . . . 25

Configuring IBM CMIS by running theconfiguration tool . . . . . . . . . . . 25Configuring IBM CMIS by running a silentconfiguration . . . . . . . . . . . . . 27Configuring advanced IBM CMIS for FileNetContent Manager properties . . . . . . . . 30

Configuring single sign-on . . . . . . . . . 35Configuring Lightweight Third PartyAuthentication (LTPA) . . . . . . . . . . 36Configuring Lightweight Directory AccessProtocol (LDAP) . . . . . . . . . . . . 38

Configuring logging . . . . . . . . . . . 39Specifying log level entries . . . . . . . . 40Configuring log location and size . . . . . . 41Logged errors . . . . . . . . . . . . 42

Configuring Content Engine API client logging 42

Deploying IBM CMIS for FileNetContent Manager . . . . . . . . . . 47Deploying the IBM CMIS for FileNet ContentManager application by running the configurationtool . . . . . . . . . . . . . . . . . 47Deploying the IBM CMIS for FileNet ContentManager application by running a silentconfiguration . . . . . . . . . . . . . . 48Deploying the IBM CMIS for FileNet ContentManager application manually . . . . . . . . 50

Modifying the generic JVM arguments inWebSphere Application Server . . . . . . . 50Importing the WS-Security policy set toWebSphere Application Server . . . . . . . 51Manually deploying IBM CMIS for FileNetContent Manager . . . . . . . . . . . 51

IBM CMIS for FileNet Content ManagerDevelopment . . . . . . . . . . . . 53IBM CMIS for FileNet Content Manager index page 53

IBM CMIS for FileNet Content Manager servicecollection URLs . . . . . . . . . . . . 54IBM CMIS for FileNet Content Manager URItemplates . . . . . . . . . . . . . . 54

OASIS CMIS specification . . . . . . . . . 55Useful resources . . . . . . . . . . . . . 55Extensions for IBM CMIS for FileNet ContentManager . . . . . . . . . . . . . . . 56

Class display name extension . . . . . . . 56Hidden properties extension. . . . . . . . 57Choice list symbolic name extension . . . . . 57Choice list display name extension . . . . . 57Domain name extension . . . . . . . . . 57Object store ID extension . . . . . . . . . 58Object store database type extension . . . . . 58Records management extension. . . . . . . 58Text search engine extension. . . . . . . . 58GZIP compression extension. . . . . . . . 59

IBM CMIS for FileNet Content Managerimplementation of the OASIS CMIS specification . . 59

Change token support . . . . . . . . . . 60Links in private working copy support . . . . 60Paging feed support . . . . . . . . . . 61Query support . . . . . . . . . . . . 61Versioning properties on document objectssupport. . . . . . . . . . . . . . . 63

Best practices for developing client applications . . 63

Troubleshooting IBM CMIS for FileNetContent Manager . . . . . . . . . . 65IBM CMIS for FileNet Content Manager log files . . 65

© Copyright IBM Corp. 2010, iii

Collecting data for IBM CMIS for FileNet ContentManager . . . . . . . . . . . . . . . 67Error messages for IBM CMIS for FileNet ContentManager . . . . . . . . . . . . . . . 69

Removing IBM CMIS for FileNetContent Manager . . . . . . . . . . 79Removing IBM CMIS for FileNet Content Managerfrom WebSphere Application Server . . . . . . 80

Accessibility features of IBM CMIS forFileNet Content Manager . . . . . . . 81

Notices . . . . . . . . . . . . . . 83Trademarks . . . . . . . . . . . . . . 86

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 onibm.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 youroperating system. If you do not have the Acrobat Reader installed, you candownload it from the Adobe website at http://www.adobe.com.

See the IBM CMIS for FileNet® Content Manager product publication library pagefor 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 commentsYour feedback helps IBM provide quality information. Send any comments thatyou have about this information or other documentation that IBM SoftwareDevelopment 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 [email protected]. Include the name of

the product, the version number of the product, and the name and publicationnumber of the information (if applicable.) If you are commenting on specifictext, include the location of the text (for example, a title, a table number, or apage number).

Consumability survey

You are invited to tell IBM how to improve the consumability of softwareproducts. If you want to help IBM make this product easier to use, take theConsumability Survey at http://www.ibm.com/software/data/info/consumability-survey/.

© Copyright IBM Corp. 2010, v

http://www.ibm.com/software/data/content-management/filenet-content-manager/support.html



http://publib.boulder.ibm.com/infocenter/p8docs/v5r0m0/

http://www.adobe.com

http://www.ibm.com/support/docview.wss?uid=swg27020097


http://www.ibm.com/software/data/info/consumability-survey/

http://www.ibm.com/software/data/info/consumability-survey/

Contacting IBMTo contact IBM customer service in the United States or Canada, call1-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-4343v In Canada: 1-800-465-9600

For more information about how to contact IBM, see the Contact IBM Web site athttp://www.ibm.com/contact/us/.

vi Planning, Installing, and Configuring IBM CMIS for FileNet Content Manager

http://www.ibm.com/contact/us/

Planning, installing, and configuring IBM CMIS for FileNetContent Manager

IBM Content Management Interoperability Services for FileNet Content Manager(IBM CMIS) enables clients applications that use the OASIS CMIS standard towork with content that is stored on IBM FileNet Content Engine.

Use this information to plan for, install, or configure IBM CMIS for FileNet ContentManager.

To use this information, you should be familiar with one or more of the followingoperating systems:v AIX®

v Linuxv Microsoft Windows

In addition, to install and configure IBM CMIS for FileNet Content Manager, youshould be familiar with:v WebSphere® Application Server or WebSphere Application Server Network

Deploymentv IBM FileNet Content Enginev IBM FileNet Content Managerv 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

“Planning for IBM CMIS forFileNet Content Manager” onpage 5

Verify that you have all theprerequisite productsinstalled and configured.

Analyze your business needsand decide how to structureyour content managementsystem.

Perform before you begin theproduct installation.

“Installing IBM CMIS forFileNet Content Manager” onpage 19

The installation programguides you through the IBMCMIS for FileNet ContentManager installation.

Perform once to install theproduct.

“Configuring IBM CMIS forFileNet Content Manager” onpage 25

The configuration tool guidesyou through the IBM CMISfor FileNet Content Managerconfiguration.

Perform as needed toconfigure the product.

© Copyright IBM Corp. 2010, 1

Table 1. Planning, installation, configuration, and administration tasks (continued)

Task What you can do When to perform

“Deploying IBM CMIS forFileNet Content Manager” onpage 47

The configuration tool guidesyou through deploying IBMCMIS for FileNet ContentManager on WebSphereApplication Server, or youcan manually deploy IBMCMIS for FileNet ContentManager.

Perform as needed to deploychanges to the configurationto WebSphere ApplicationServer.

“IBM CMIS for FileNetContent ManagerDevelopment” on page 53

Use the OASIS CMISspecification and the IBMFileNet P8 extensions tointeract with the OASISCMIS bindings or to developagainst a CMIS client API.

Perform as needed.

“Removing IBM CMIS forFileNet Content Manager” onpage 79

The uninstallation wizardguides you through removingIBM CMIS for FileNetContent Manager from theserver. Then you can removeIBM CMIS for FileNetContent Manager fromWebSphere ApplicationServer.

Perform once to remove theproduct.

“Troubleshooting IBM CMISfor FileNet Content Manager”on page 65

Troubleshoot IBM CMIS forFileNet Content Manager.

Perform as needed.

2 Planning, Installing, and Configuring IBM CMIS for FileNet Content Manager

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 theOASIS CMIS standard to work with content that is stored on IBM FileNet ContentEngine.

The OASIS CMIS standard enables client applications to work with multiplecontent management systems by defining a standard domain model and standardset of services and protocol bindings for Web Services and RESTful AtomPublishing Protocol (AtomPub). IBM CMIS for FileNet Content Manager is theimplementation of the OASIS CMIS standard for IBM FileNet Content Manager.

The following diagram shows how IBM CMIS for FileNet Content Managerconnects to your IBM FileNet P8 system and your client application.

It is recommended that you deploy IBM CMIS for FileNet Content Manager to adedicated application server. In addition, it is recommended that you dedicate aserver in your IBM FileNet P8 system to IBM CMIS for FileNet Content Manager.

IBM CMIS for FileNet Content Manager communicates with Content Engine byusing the Content Engine Client Java API. After you install IBM CMIS for FileNetContent Manager, you must install the Content Engine Client on the machinewhere IBM CMIS for FileNet Content Manager will be deployed and install theContent Engine Client Java API files in the IBM CMIS for FileNet Content Managerinstallation directory.

WebSphereApplication Server

IBM FileNet P8 System

Content Engineserver

IBMFileNetContentEngine

WebSphereApplication Server

IBM CMIS for FileNetContent Manager server

IBM CMIS for FileNetContent Manager

IBM FileNetContent EngineClient Java API

CMIS clientapplication

REST and WebServices Bindings

CMIS-enabledenterprise content

managementsystem


IBM CMIS for FileNet Content Manager and other CMIS-enabled enterprisecontent management systems communicate with client applications by using RESTand Web Services bindings.


Planning for IBM CMIS for FileNet Content Manager

The following topics can help you plan your IBM Content ManagementInteroperability Services for FileNet Content Manager (IBM CMIS) systeminstallation 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

PrerequisitesThe IBM Content Management Interoperability Services for FileNet ContentManager (IBM CMIS) hardware and software requirements document providesdetailed information about the supported versions of each prerequisite application.

A complete and up-to-date list of the hardware and software requirements for IBMCMIS for FileNet Content Manager is available on the IBM support site athttp://www.ibm.com/support/docview.wss?uid=swg27019859.

Planning for WebSphere Application ServerIBM Content Management Interoperability Services for FileNet Content Manager(IBM CMIS) can be deployed to several different WebSphere Application Servertopologies.

Important: Regardless of the WebSphere Application Server topology that youdeploy to, it is strongly recommended that you install IBM CMIS to a dedicatedapplication 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 adedicated application server.

WebSphere Application Server Network Deployment topologies

If you use WebSphere Application Server Network Deployment, you can deployIBM CMIS to the following topologies:

Unmanaged nodes

An unmanaged node is an application server node with its ownadministration facilities. The node is not federated to the deploymentmanager. You can deploy IBM CMIS to a dedicated application servernode.



Managed nodes

A managed node is an application server node that is federated to thedeployment manager. You can deploy IBM CMIS to a dedicated applicationserver node.

Clusters

A cluster is a group of application servers that share the load for anapplication. The deployment manager deploys the application to thecluster members.

Recommended server topologyIBM 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 ofyour system.

A IBM FileNet P8 system generally requires a set of dedicated servers. Thecomponents of an IBM FileNet P8 system are often spread across several servers.For better performance and scalability, it is recommended that you install IBMFileNet Content Engine and any client applications, such as IBM CMIS for FileNetContent Manager, on separate servers.

The following list describes the recommended server configuration for a scenariothat 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 Enginev Server 3: WebSphere Application Server, IBM CMIS for FileNet Content Managerv Server 4: Databasev Server 5: Directory service servers

User authentication and securityIBM Content Management Interoperability Services for FileNet Content Manager(IBM CMIS) uses the same LDAP server and the same LTPA keys that areconfigured for the IBM FileNet Content Engine server.

You must enable single sign-on (SSO) between the application servers that hostIBM FileNet Content Engine and IBM CMIS for FileNet Content Manager.

In addition, you must decide how to implement support for IBM FileNet ContentManager 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 securityBy default, IBM Content Management Interoperability Services for FileNet ContentManager (IBM CMIS) caches controlled vocabulary lists (CVLs) for all users toimprove performance. However, when IBM CMIS for FileNet Content Managercaches the CVLs, the security settings that are configured for the CVLs in yourIBM FileNet Content Manager system are ignored.


If your IBM FileNet Content Manager CVLs are configured to prevent some usersfrom seeing certain CVLs, you can configure IBM CMIS for FileNet ContentManager to honor the CVL security settings.Related reference

“CVL caching (CVL_Cache)” on page 32

Language support for IBM CMIS for FileNet Content ManagerThe installation program, configuration tool, and error messages for IBM ContentManagement 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 theconfiguration tool.

However, IBM CMIS uses locale settings to determine the language in which todisplay the following information:v Error messages in HTTP responsesv IBM CMIS index page, about page, and configuration pagev 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 todetermine 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 CMISapplication 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 todetermine 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-Languageheader of an HTTP request.

3. If the Accept-Language header is not available or does not specify a supportedlanguage, IBM CMIS uses the language of the JVM on the IBM CMISapplication 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:

Planning for IBM CMIS for FileNet Content Manager 7

v If you provide a WS-I18N header and an Accept-Language header and bothheaders specify a supported language, the language that is specified in theWS-I18N header takes precedence.

v If you provide an Accept-Language header with multiple languages, IBM CMISdisplays only the preferred language (the language with the highest qualityvalue, such as q=1).If multiple languages are designated as the preferred language, IBM CMIS usesthe first language from the left with the highest value quality. For example, theheader includes the following code, IBM CMIS would display content in Frenchbecause 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 Language code

Chinese, Simplified zh_CN

Chinese, Traditional zh_TW

English en

French fr

German de

Italian it

Japanese ja

Korean ko

Portuguese, Brazilian pt_BR

Spanish es

In addition, variations of the following languages are partially supported:v Variations of Chinese are displayed in Simplified Chinesev 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 languagesthat are not supported, even if the language is supported by the underlyingrepository.

Installation and configuration worksheetsBefore you install and configure IBM Content Management InteroperabilityServices for FileNet Content Manager (IBM CMIS), you should work with yourContent Engine system administrator and your WebSphere Application Serversystem administrator to collect the information that you must provide wheninstalling and configuring IBM CMIS.

Use the following worksheets to plan your IBM CMIS installation andconfiguration:

“Installation and configuration worksheet” on page 9“Silent installation and configuration worksheet” on page 11“Advanced configuration worksheet” on page 14


Installation and configuration worksheetWork with your Content Engine system administrator and your WebSphereApplication Server system administrator to collect the information that you mustprovide when installing and configuring IBM Content ManagementInteroperability Services for FileNet Content Manager (IBM CMIS).

Installation information

When you install IBM CMIS for FileNet Content Manager, you specify thedirectory in which to install the IBM CMIS software.

After you install the IBM CMIS software, you must install the Content EngineClient API files in the IBM CMIS installation directory.

Table 3. Installation parameters

Parameter Description Value

Installation directory IBM CMIS installation directory.

v On AIX and Linux, the defaultinstallation directory is/opt/IBM/FN_CMIS.

v On Windows, the default installationdirectory is C:\ProgramFiles\IBM\FN_CMIS.

Basic configuration parameters

When you run the configuration tool you specify information about your ContentEngine system and your WebSphere Application Server system.

You also specify basic information about your IBM CMIS system that clientapplications use when sending requests to IBM CMIS for FileNet Content Manager.

Collect the following information about the Content Engine server to which youare connecting.

Table 4. Content Engine parameters


Content Engine URL The URL that applications use to connectto Content Engine.

The URL is case-sensitive and has theformat: 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 theContent Engine system, you must providea user name.

Content Engine password If you want to verify the connection to theContent Engine system, you must providea password.


Collect the following information about how you plan to authenticate to IBM CMISafter it is deployed.

Table 5. Application security parameters


Authentication method forweb services

The authentication method that clientapplications use when sending requests tothe IBM CMIS web services.

Valid values include:

HTTP basic authenticationThis method uses an encodeduser name and password in anHTTP header to authenticate.

WS-Security authenticationThis method uses a WS-SecuritySOAP header to authenticate.

Collect the following information about your WebSphere Application Serversystem.

Table 6. WebSphere Application Server parameters


WebSphere ApplicationServer installation directory

The instance of WebSphere ApplicationServer to which you are deploying IBMCMIS.

v On AIX, the default installationdirectory is /usr/IBM/WebSphere/AppServer.

v On Linux, the default installationdirectory is /opt/IBM/WebSphere/AppServer

v On Windows, the default installationdirectory is C:\ProgramFiles\IBM\WebSphere\AppServer.

Application server profile The WebSphere Application Server profileon which you are deploying IBM CMIS.Important: You must deploy IBM CMIS toan existing profile that has WebSphereApplication Server security enabled.

Administrator user name The WebSphere Application Serveradministrator user name.

Password The WebSphere Application Serveradministrator password.


Table 6. WebSphere Application Server parameters (continued)


Deployment environment The type of WebSphere Application Serverenvironment into which you aredeploying IBM CMIS.


Single application serverUse this option if you plan todeploy IBM CMIS to anapplication server on WebSphereApplication Server or anunmanaged node or managednode on WebSphere ApplicationServer Network Deployment.

Application server clusterUse this option if you plan todeploy IBM CMIS to anapplication server cluster onWebSphere Application ServerNetwork Deployment.

Application server node andserver name

The node and server on which you aredeploying IBM CMIS.Important: You must deploy IBM CMIS toan existing server.

This parameter applies to a Singleapplication server deploymentenvironment only.

Application server clustername

The cluster on which you are deployingIBM CMIS.Important: You must deploy IBM CMIS toan existing cluster.

This parameter applies to an Applicationserver cluster deployment environmentonly.

Application name The name of the IBM CMIS application todisplay in the WebSphere ApplicationServer administrative console.

Optional.

The default name is fncmis.

Silent installation and configuration worksheetWork with your Content Engine system administrator and your WebSphereApplication Server system administrator to collect the information that you mustprovide when silently installing and configuring IBM Content ManagementInteroperability Services for FileNet Content Manager (IBM CMIS).

Installation information

When you install IBM CMIS for FileNet Content Manager, you specify thedirectory in which to install the IBM CMIS software.


After you install the IBM CMIS software, you must install the Content EngineClient API files in the IBM CMIS installation directory.

Table 7. Installation parameters


USER_INSTALL_DIR IBM CMIS installation directory.

v On AIX and Linux, the defaultinstallation directory is/opt/IBM/FN_CMIS.

v On Windows, the default installationdirectory is C:\ProgramFiles\IBM\FN_CMIS.

Basic configuration parameters

To run the silent configuration program, you must specify information about yourContent Engine system and your WebSphere Application Server system in thesilent configuration response file.

You must also specify basic information about your IBM CMIS system that clientapplications use when sending requests to IBM CMIS for FileNet Content Manager.

Collect the following information about the Content Engine server to which youare connecting.

Table 8. Content Engine parameters


USER_CE_URI Content Engine URL.

The URL that applications use to connectto Content Engine.

The URL is case-sensitive and has theformat: 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.

Collect the following information about how you plan to authenticate to IBM CMISafter it is deployed.


Table 9. Application security parameters


USER_WS_AUTH Authentication method for web services.

The authentication method that clientapplications use when sending requests tothe IBM CMIS web services.


0 HTTP basic authentication. Thismethod uses an encoded username and password in an HTTPheader to authenticate.

1 WS-Security authentication. Thismethod uses a WS-Security SOAPheader to authenticate.

Collect the following information about your WebSphere Application Serversystem.

Table 10. WebSphere Application Server parameters


USER_APPSERVER_HOME WebSphere Application Server installationdirectory.

The instance of WebSphere ApplicationServer to which you are deploying IBMCMIS.

v On AIX, the default installationdirectory is /usr/IBM/WebSphere/AppServer.

v On Linux, the default installationdirectory is /opt/IBM/WebSphere/AppServer

v On Windows, the default installationdirectory is C:\ProgramFiles\IBM\WebSphere\AppServer.

USER_APPSERVER_PROFILE_NAME

The WebSphere Application Server profileon which you are deploying IBM CMIS.Important: You must deploy IBM CMIS toan existing profile that has WebSphereApplication Server security enabled.

USER_WASADMIN_ID The WebSphere Application Serveradministrator user name.

USER_WASADMIN_PW The WebSphere Application Serveradministrator password.


Table 10. WebSphere Application Server parameters (continued)


USER_DEPLOY_TYPE The type of WebSphere Application Serverenvironment into which you are deployingIBM CMIS.


appserverUse this option if you plan todeploy IBM CMIS to anapplication server on WebSphereApplication Server or anunmanaged node or managednode on WebSphere ApplicationServer Network Deployment.

cluster Use this option if you plan todeploy IBM CMIS to anapplication server cluster onWebSphere Application ServerNetwork Deployment.

USER_APPSERVER_NAME The name of the server on which you aredeploying IBM CMIS.Important: You must deploy IBM CMIS toan existing server.

This parameter applies to an appserverdeployment environment only.

USER_APPSERVER_NODE The name of the application server nodethat contains the application server onwhich you are deploying IBM CMIS.

This parameter applies to an appserverdeployment environment only.

USER_APPSERVER_CLUSTER_NAME

The cluster on which you are deployingIBM CMIS.Important: You must deploy IBM CMIS toan existing cluster.

This parameter applies to a clusterdeployment environment only.

USER_APP_NAME The name of the IBM CMIS application todisplay in the WebSphere ApplicationServer administrative console.

Optional.

The default name is fncmis.

Advanced configuration worksheetIBM Content Management Interoperability Services for FileNet Content Manager(IBM CMIS) includes advanced configuration parameters that enable you to tuneyour system for optimal performance and scaling. However, you can run IBMCMIS by using the default values that are specified in the advanced configurationproperties file.


Collect information about the advanced parameters that you want to configure foryour IBM CMIS environment.

Tip: It is recommended that you review the topics for each advanced configurationparameter for additional information about the parameters and to determinewhether it makes sense to modify the parameters for your environment.

Table 11. Advanced configuration parameters


cmisURI The URL to which client applications sendrequests.

For most IBM CMIS configurations, youdo not need to specify a value for thisparameter. However, you can specify theURL by which IBM CMIS and clientapplications communicate if you want toforce client applications to access IBMCMIS through a specific URL or if yourproxy server settings cause IBM CMIS toproduce invalid URLs.

The URL must have the formhttp://host_name:port.

CMC_TIME_TO_LIVE The length of time (in milliseconds) thatthe Content Engine metadata is kept in theContent Engine Client Metadata Cache.

The default value is 3600000 milliseconds.

CRC_TIME_TO_LIVE The length of time (in milliseconds) thatobject stores are kept in the client-sideserver cache.


checkout_copycontent Whether to copy the content stream of achecked out document to the contentstream of the private working copy.

The default value is true.


false Do not copy the content stream tothe Private Working Copy.

true Copy the content stream to thePrivate Working Copy.

defaultMaxItems The maximum number of items to returnwhen an HTTP request does not specify avalue for the maxItems parameter.

The default value is 25.


Table 11. Advanced configuration parameters (continued)


CVL_Cache Whether to cache IBM FileNet ContentManager controlled vocabulary lists(CVLs) for all users. If the CVLs arecached, IBM CMIS ignores any CVLsecurity settings.

By default, IBM CMIS caches the CVLs toimprove performance.



false Do not cache the CVLs for allusers. When this value isspecified, IBM CMIS honors thesecurity settings that areconfigured for IBM FileNetContent Manager CLVs.

true Cache the CVLs for all users.When this value is specified, IBMCMIS ignores the security settingsthat are configured for IBMFileNet Content Manager CLVs.

SecureMetadataCache Whether to cache class definition metadatafor all users. If the class definitionmetadata is cached, IBM CMIS displaysthe following properties to all usersregardless of their access control list (ACL)permissions:

v Creator

v DateCreated

By default, IBM CMIS caches the classdefinition metadata to improveperformance.

The default value is false.


false Cache the class definitionmetadata. When this value isspecified, IBM CMIS ignores theACL settings for the Creator andDateCreated properties.

true Do not cache the class definitionmetadata. When this value isspecified, IBM CMIS honors theACL settings for the Creator andDateCreated properties.


Table 11. Advanced configuration parameters (continued)


filterHiddenProperties Whether to return hidden properties toclient applications.



false Do not filter hidden properties.When this value is specified, IBMCMIS returns hidden properties.

true Filter hidden properties. Whenthis value is specified, IBM CMISdoes not return hiddenproperties.

com.ibm.xml.xlxp2.api.util.encoding.DataSourceFactory.bufferLength

The size of the internal buffers that areused to create documents with content onthe repository when using IBM CMIS WebServices.

WebSphere Application Server uses a65536 byte buffer. However, IBM CMIS canoverride this setting.

By default IBM CMIS uses a 2048 bytebuffer. It is recommended that you do notchange the default value becauseincreasing the size of the buffer can causememory consumption issues whenuploading documents larger than 50 MBthrough IBM CMIS Web Services.

If you specify 0 for this parameter, IBMCMIS does not override the default valuethat is set in WebSphere ApplicationServer.

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” onpage 30


Installing IBM CMIS for FileNet Content Manager

You can install IBM Content Management Interoperability Services for FileNetContent Manager (IBM CMIS) on AIX, Linux, or Windows operating systems.

Before you install IBM CMIS, you must install the prerequisite software on theserver 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 andconfiguration worksheets” on page 8.

The high-level installation and configuration sequence for IBM CMIS for FileNetContent 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 ContentManager system and that you are installing IBM CMIS for FileNet ContentManager to the default installation directory.

Table 12. Default installation directory on each supported operating system

Operating system Default directory

AIX /opt/IBM/FN_CMIS

Linux /opt/IBM/FN_CMIS

Windows 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 22Related concepts

“Prerequisites” on page 5Related reference

“Installation and configuration worksheets” on page 8

Installing the IBM CMIS for FileNet Content Manager softwareYou can install the IBM Content Management Interoperability Services for FileNetContent Manager (IBM CMIS) software on the workstation by running theinstallation program or by running a silent installation.




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 programYou can install IBM Content Management Interoperability Services for FileNetContent Manager (IBM CMIS) on the server by running the installation program.



To install IBM CMIS for FileNet Content Manager:1. Start the installation program:

Operating system Installation command

AIX At a command prompt, change to the IBMCMIS for FileNet Content Manager CD or tothe directory where you downloaded theproduct and enter: ./install.sh.

Linux At a command prompt, change to the IBMCMIS for FileNet Content Manager CD or tothe directory where you downloaded theproduct and enter: ./install.sh.

Windows At a command prompt, change to the IBMCMIS for FileNet Content Manager CD or tothe directory where you downloaded theproduct and enter: install.bat.

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.


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” onpage 25“Deploying IBM CMIS for FileNet Content Manager” on page 47Related reference


Running a silent installationYou can install IBM Content Management Interoperability Services for FileNetContent Manager (IBM CMIS) on the server by running a silent installation.



Important: You must save the installation image to the workstation before you runa silent installation so that you can edit the response file.

A silent installation uses a response file that contains the installation parametersthat you specify. When you run a silent installation, the installation program doesnot display any installation windows or messages. Instead, any messages anderrors 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 Response file

AIX fncmis-UNIX_SilentInstall.properties

Linux fncmis-UNIX_SilentInstall.properties

Windows 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 (\) byadding a backslash before each colon or backslash in the installationdirectory file path. For example, C:\Program Files\IBM\FN_CMIS would havethe following format:C\:\\Program Files\\IBM\\FN_CMIS

The response file must contain the following text:LICENSE_ACCEPTED=trueUSER_INSTALL_DIR=installation directory

Installing IBM CMIS for FileNet Content Manager 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 Command

AIX ./install.sh -s

Linux ./install.sh -s

Windows 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” onpage 25“Deploying IBM CMIS for FileNet Content Manager” on page 47Related reference


Installing Content Engine Client files for IBM CMIS for FileNet ContentManager

After you install the IBM Content Management Interoperability Services for FileNetContent Manager (IBM CMIS) software, you must install the Content Engine ClientAPI files in the IBM CMIS installation directory. The Content Engine Client APIfiles enable IBM CMIS for FileNet Content Manager to communicate with the IBMFileNet 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 isinstalled, you must run the Content Engine Client installation program to add theContent Engine Client API files to the IBM CMIS installation directory.

If the Content Engine Client is not installed, you must install the Content EngineClient and add the Content Engine Client API files to the IBM CMIS installationdirectory.

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 ContentEngine Client installation directory.

3. In the Select FileNet P8 Applications window, select IBM CMIS for FileNetContent Manager.


4. In the IBM CMIS for FileNet Content Manager Installation Path window, takeone 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 followingdirectory:

Table 13. Default installation directory on each supported operating system


AIX /opt/IBM/FN_CMIS

Linux /opt/IBM/FN_CMIS

Windows C:\Program Files\IBM\FN_CMIS

To verify that the Content Engine Client files were installed to the IBM CMISinstallation directory, open the CE_API\lib subdirectory of the installation directoryand 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 ContentManager, you can configure IBM CMIS.Related tasks

“Configuring the IBM CMIS for FileNet Content Manager web application” onpage 25Related reference


Installing IBM CMIS for FileNet Content Manager 23

Configuring IBM CMIS for FileNet Content Manager

After you install IBM Content Management Interoperability Services for FileNetContent Manager (IBM CMIS), you must configure the IBM CMIS application andyour 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 applicationBefore you can deploy IBM Content Management Interoperability Services forFileNet Content Manager (IBM CMIS), you must configure and build the IBMCMIS web application.

Before you can configure the web application, you must install the Content EngineClient API files in the IBM CMIS installation directory.


To configure the IBM CMIS web application, complete the tasks that areappropriate 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” onpage 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 toolYou can use the configuration tool to build and deploy the IBM ContentManagement Interoperability Services for FileNet Content Manager (IBM CMIS)web application EAR file. The configuration tool validates the information that youspecify about your IBM FileNet Content Manager system and your WebSphereApplication Server environment before you deploy the IBM CMIS web application.



Tip: The configuration tool retains your configuration and deploymentinformation, except for user IDs and passwords, across sessions. If you need tomodify your configuration, you can rerun the configuration tool without having toenter each configuration option again.


Only the most recent configuration information is retained. To back up a previousconfiguration, you must save a copy of the following files, which are located inprofiles/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) willbe retained in the configuration wizard.

To configure IBM CMIS:1. Start the configuration tool:


AIX At a command prompt, change to the configsubdirectory of the IBM CMIS for FileNetContent Manager installation directory andenter: ./config.sh.

Linux At a command prompt, change to the configsubdirectory of the IBM CMIS for FileNetContent Manager installation directory andenter: ./config.sh.

Windows At a command prompt, change to the configsubdirectory of the IBM CMIS for FileNetContent Manager installation directory andenter: config.bat.

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 namev Passwordv WebSphere Application Server installation directory

3. Specify the authentication method that client applications use when sendingrequests 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 andpassword to authenticate.

v WS-Security Authentication - Select this option if you want clientapplications 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 instanceof WebSphere Application Server. This option is recommended for mostusers.


v Manually deploy IBM CMIS - If you select this option, the configurationtool does not deploy IBM CMIS. You must manually deploy IBM CMIS to asupported instance of WebSphere Application Server. This option isrecommended only for expert WebSphere Application Server users.

6. Specify the instance of WebSphere Application Server to which to deploy IBMCMIS.

Important: You must deploy IBM CMIS to an existing WebSphere ApplicationServer 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, theconfiguration tool uses the installation directory that you specified in theContent 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 IBMCMIS.

e. Specify the cluster or application server to which to deploy IBM CMIS.

Remember: It is recommended that you deploy IBM CMIS to a dedicatedapplication server or application server cluster.

f. Optional: Specify the name to display for the IBM CMIS application inWebSphere Application Server. The default display name for the applicationis FN_CMIS.

7. Verify your WebSphere Application Server deployment information and clickNext.

To validate that IBM CMIS was successfully deployed, start the IBM CMISapplication 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 53Related tasks


Configuring IBM CMIS by running a silent configurationYou can use the silent configuration program to build and deploy the IBM ContentManagement Interoperability Services for FileNet Content Manager (IBM CMIS)web application EAR file.



A silent configuration uses a response file that contains the configuration anddeployment parameters that you specify. When you run a silent configuration, the

Configuring IBM CMIS for FileNet Content Manager 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 thelog directory.

To configure the IBM CMIS for FileNet Content Manager application:1. Open the response file:


AIX config/fncmis-UNIX_SilentConfig.properties

Linux config/fncmis-UNIX_SilentConfig.properties

Windows config\fncmis-WIN_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 domainname. 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 specifythe authentication method that client applications use when sending requests tothe 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 WebApplication 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 EARfile but does not deploy IBM CMIS. You must manually deploy IBM CMIS toa supported instance of WebSphere Application Server.If you specify 1, you do not need to specify values for the parameters in theWeb Application Deployment section of the response file.

5. Specify the information about the WebSphere Application Server environmentto which you want to deploy IBM CMIS.

Important: You must deploy IBM CMIS to an existing WebSphere ApplicationServer 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 (\) byadding a backslash before each colon or backslash in the installationdirectory 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 WebSphereApplication Server profile to which you want to deploy IBM CMIS. Thedefault profile is AppSrv01.

c. Set the USER_WASADMIN_ID parameter to the administrator user namefor the specified application server profile.

d. Set the USER_WASADMIN_PW parameter to the administrator passwordfor the specified application server profile.

e. Set the USER_DEPLOY_TYPE parameter to one of the following values:

appserverSpecify appserver to deploy IBM CMIS to an application server onWebSphere Application Server or to a managed node or anunmanaged node on WebSphere Application Server NetworkDeployment.

clusterSpecify cluster to deploy IBM CMIS to a cluster on WebSphereApplication Server Network Deployment.

f. If you specified USER_DEPLOY_TYPE=appserver, specify values for thefollowing properties.

Remember: It is recommended that you deploy IBM CMIS to a dedicatedapplication 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 todeploy IBM CMIS.

g. If you specified USER_DEPLOY_TYPE=cluster, set theUSER_APPSERVER_CLUSTER parameter to the name of the applicationserver cluster on which to deploy IBM CMIS.

Remember: It is recommended that you deploy IBM CMIS to a dedicatedapplication server cluster.

h. Optional: Set the USER_APP_NAME parameter to specify the name todisplay for the IBM CMIS application in WebSphere Application Server. Thedefault 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:


AIX ./config.sh -s

Linux ./config.sh -s

Windows config.bat -s

To validate that IBM CMIS was successfully deployed, start the IBM CMISapplication on WebSphere Application Server and open the IBM CMIS index page,index.jsp.


Related concepts


“Configuring advanced IBM CMIS for FileNet Content Manager properties”

Configuring advanced IBM CMIS for FileNet Content Managerproperties

The advanced IBM Content Management Interoperability Services for FileNetContent Manager (IBM CMIS) properties are optional configuration settings thatenable you to tune your system for optimal performance and scaling. However,you can run IBM CMIS for FileNet Content Manager by using the default valuesthat are specified in fncmis_advanced.properties.

It is recommended that you complete the “Advanced configuration worksheet” onpage 14 before you configure the advanced IBM CMIS for FileNet ContentManager 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 CMISinstallation directory:

Operating system File location

AIX /profiles/profile1/fncmis_advanced.properties

Linux /profiles/profile1/fncmis_advanced.properties

Windows \profiles\profile1\fncmis_advanced.properties

2. Edit the entries for the advanced parameters that you want to modify for yourIBM 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 CMISapplication 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 page31“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


“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


“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” onpage 50Related 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 Enginemetadata is kept in the Content Engine Client Metadata Cache.

You can use IBM Content Management Interoperability Services for FileNetContent Manager (IBM CMIS) without modifying the default value of theCMC_TIME_TO_LIVE property.

CMC_TIME_TO_LIVE

Specify how long (in milliseconds) the Content Engine metadata is kept in theContent Engine Client Metadata Cache.


When you increase the time to live (TTL), you can improve the performance ofIBM CMIS, but the cache might not contain up-to-date information about thecontent server.

When you decrease the TTL, the cache contains more up-to-date informationabout the content server. However, when you increase the frequency of cacheupdates, 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 inthe client-side server cache.

You can use IBM Content Management Interoperability Services for FileNetContent Manager (IBM CMIS) without modifying the default value of theCRC_TIME_TO_LIVE property.

CRC_TIME_TO_LIVE

Specify how long (in milliseconds) object stores are kept in the client-sideserver cache.


When you increase the time to live (TTL), you can improve the performance ofIBM CMIS, but the cache might not contain up-to-date information about theobject stores on the content server.

When you decrease the TTL, the cache contains more up-to-date informationabout the object stores on the content server. However, when you increase thefrequency of cache updates, you decrease the performance of IBM CMIS.


CVL caching (CVL_Cache)The CVL_Cache property determines whether IBM Content ManagementInteroperability Services for FileNet Content Manager (IBM CMIS) caches IBMFileNet Content Manager controlled vocabulary lists (CVLs) for all users.

By default, IBM CMIS for FileNet Content Manager caches the CVLs to improveperformance. However, if the CVLs are cached, IBM CMIS does not honor thesecurity settings that are configured for CVLs in your IBM FileNet ContentManager system.

You should modify this parameter if you have security settings configured for yourCVLs and you need IBM CMIS to honor those settings.

CVL_Cache

Specify whether to cache CVLs for all users.


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 forIBM FileNet Content Manager CLVs.Default value.

v false

When you specify CVL_Cache=false, IBM CMIS does not cache the CVLs. Inaddition, IBM CMIS honors the security settings that are configured for IBMFileNet 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 ContentManagement Interoperability Services for FileNet Content Manager (IBM CMIS)returns hidden properties to client applications.

You can use IBM Content Management Interoperability Services for FileNetContent Manager (IBM CMIS) without modifying the default value of thefilterHiddenProperties property.

By default, IBM CMIS does not return hidden properties to improve performance.

filterHiddenProperties

Specify whether IBM CMIS returns hidden properties to client applications.



true

When you specify filterHiddenProperties=true, IBM CMIS returnshidden properties in responses.

false

When you specify filterHiddenProperties=false, IBM CMIS does notreturn hidden properties in responses.


Default value.

IBM CMIS URL (cmisURI)The cmisURI property specifies the URL by which client applications can accessIBM Content Management Interoperability Services for FileNet Content Manager(IBM CMIS). For most IBM CMIS systems, you do not need to configure thecmisURL parameter.

It is recommended that you do not specify a value for this parameter unless one ofthe 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 URLhas 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.bufferLengthproperty specifies the size of the internal buffers that are used to create documentswith content on the repository when using IBM Content ManagementInteroperability Services for FileNet Content Manager (IBM CMIS) Web Services.

WebSphere Application Server uses a 65536 byte buffer. However, IBM CMIS isconfigured to override this setting and use a 2048 byte buffer.

It is recommended that you do not change the default value because increasing thesize of the buffer can cause memory consumption issues when uploadingdocuments 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 withcontent 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.


0

If you specify 0 for this parameter, IBM CMIS does not override thedefault value that is set in WebSphere Application Server, and youmight experience memory consumption issues.

Integers greater than 0If you specify an integer greater than 0 for this parameter, IBM CMISoverrides the default value that is set in WebSphere Application Serverwith 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 beable to override the WebSphere Application Server buffer size. To avoid thisproblem, it is recommended that you deploy IBM CMIS to a dedicated applicationserver.


Maximum number of items to return (defaultMaxItems)The defaultMaxItems property determines the maximum number of items toreturn when an HTTP request does not specify a value for the maxItemsparameter.

You can use IBM Content Management Interoperability Services for FileNetContent Manager (IBM CMIS) without modifying the default value of thedefaultMaxItems property.

defaultMaxItems

Specify the maximum number of items to return when an HTTP request doesnot 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 achecked out document is copied to the content stream of the private working copy.

You can use IBM Content Management Interoperability Services for FileNetContent Manager (IBM CMIS) without modifying the default value of thecheckout_copycontent property.

checkout_copycontent

Specify whether to copy the content stream of a checked out document to thecontent stream of the private working copy.



true

When you specify checkout_copycontent=true, IBM CMIS copies thecontent stream of a checked out document to the content stream of theprivate working copy.

Default value.

false

When you specify checkout_copycontent=false, IBM CMIS does notcopy the content stream of a checked out document to the contentstream 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 limitelapses, control is returned to IBM Content Management Interoperability Servicesfor FileNet Content Manager (IBM CMIS).

You can use IBM CMIS without modifying the default value of thequeryTimeLimit property.

queryTimeLimit

Specify the maximum length of time (in seconds) to run a query on therepository (IBM FileNet P8 object store).

The default value is 180 seconds.



0

If you specify queryTimeLimit=0 for this parameter, IBM CMIS uses thedefault query time limit that is configured for the repository.

Integers greater than 0If you specify an integer greater than 0 for this parameter, IBM CMISoverrides the default query time limit that is configured for therepository.

Secure metadata caching (SecureMetadataCache)The SecureMetadataCache property determines whether IBM ContentManagement 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 improveperformance. However, if the class definition metadata is cached, IBM CMISdisplays the following properties to all users regardless of their access control list(ACL) permissions:v Creatorv DateCreated

SecureMetadataCache

Specify whether to secure class metadata or cache class metadata for all users.



true

Do not cache the class definition metadata. When you specifySecureMetaCache=true, IBM CMIS honors the ACL settings for theCreator and DateCreated properties.

false

Cache the class definition metadata. When you specifySecureMetaCache=false, IBM CMIS ignores the ACL settings for theCreator and DateCreated properties.

Default value.

Configuring single sign-onYou must enable single sign-on (SSO) between the application servers that hostIBM FileNet Content Engine and IBM Content Management InteroperabilityServices for FileNet Content Manager

If Content Engine and IBM CMIS for FileNet Content Manager are running on thesame instance of WebSphere Application Server, you do not need to configureLTPA.

If Content Engine and IBM CMIS for FileNet Content Manager are running ondifferent instances of WebSphere Application Server, you must configure LTPA andenable application security for each instance of WebSphere Application Server.Additionally, each instance of WebSphere Application Server must use the samedirectory service for authentication.

To configure SSO, you must complete the following tasks.


“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 serverand the IBM Content Management Interoperability Services for FileNet ContentManager (IBM CMIS) application server must match.

If Content Engine and IBM CMIS for FileNet Content Manager are running on thesame instance of WebSphere Application Server, you do not have to configureLTPA.

Ask your Content Engine administrator whether you are already using LTPA withyour 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 server2. Export the LTPA key from the Content Engine application server3. Import the LTPA key to the IBM CMIS application server

If you are already using LTPA with the Content Engine application server, it isrecommended that you do not generate a new LTPA key from Content Engineapplication server. You must,1. Export the LTPA key from the Content Engine application server2. 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 keyto the Content Engine client applications that use the old LTPA key.

To configure LTPA for IBM CMIS for FileNet Content Manager, you must completethe 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

373. “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 applicationserverIf you are not currently using LTPA with the IBM FileNet Content Engineapplication server, you must generate an LTPA key from the Content Engineapplication server.

If you are already using LTPA with the Content Engine application server, it isrecommended that you do not generate a new LTPA key from Content Engineapplication 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:


a. Click Security → Global security.b. Select LTPA.

3. Enter a password to create the LTPA password. For password restrictions, seethe WebSphere Application Server documentation.

4. Click Generate Keys.5. Click Save, and then click Save changes to the Master Configuration.6. Stop and restart WebSphere Application Server.

Exporting the LTPA key from the Content Engine applicationserverYou must export the LTPA key from the Content Engine application server beforeyou can import the key file to the IBM Content Management InteroperabilityServices 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:


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 keyexpires after 2 hours. Users will not be able to log in to IBM CMIS after beinglogged 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 ContentManager application serverYou must import the LTPA key to the IBM Content Management InteroperabilityServices for FileNet Content Manager (IBM CMIS) application server to enable IBMCMIS 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_name2. On the IBM CMIS server, log in to the WebSphere Application Server

administrative console.3. Open the LTPA settings page:


4. Enter a value for the LTPA timeout that is larger than the default. Forexample, if the timeout value is left at the default value of 120 minutes, theLTPA key expires after 2 hours. Users will not be able to log in to IBM CMISafter being logged in for 2 hours.

5. Save your changes.


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 ManagementInteroperability Services for FileNet Content Manager (IBM CMIS) must use thesame LDAP server as the WebSphere Application Server that hosts Content Engine.

To enable LDAP communication between IBM CMIS for FileNet Content Managerand Content Engine, you must configure the LDAP settings in WebSphereApplication Server.

IBM CMIS supports stand-alone LDAP and LDAP for federated repositories. Thesteps 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 registryand click Configure.

5. Configure the LDAP provider settings to exactly match the correspondingsettings on the Content Engine application server.

Tip: Open the WebSphere Application Server administrative console for theContent Engine server to ensure that the following settings match on bothapplication 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 registrysettings to exactly match the corresponding settings on the Content Engineapplication server.


Tip: Open the WebSphere Application Server administrative console for theContent Engine server to ensure that the following settings match on bothapplication 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 anddoes not support Java 2 security. Enabling Java 2 security causes unexpectedbehavior.

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 connectionsucceeds, click OK to return to the previous page.

Configuring loggingIBM Content Management Interoperability Services for FileNet Content Manageruses the standard Apache Commons Logging API, which can be configured at runtime 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:

ConfigurationBy default, the Configuration tab is active. Any changes that you makeon the Configuration tab are saved to the WebSphere ApplicationServer configuration files, but your changes are not activated until yourestart the server.

RuntimeThis option is recommended. Any changes that you make to thelogging level on the Runtime tab are activated immediately.


Tip: If the Runtime tab is active and you want to make your changespermanent, select Save runtime changes to configuration as well.

5. Enter a log detail level that specifies the components or groups to trace. Youcan enter the log detail level string directly or generate the log detail levelstring 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 entriesOn the Logging and Tracing panel of the WebSphere Application Serveradministrative console, you can manually specify the logging level of any numberof classes or packages. However, you must use the correct syntax when youspecify the logging level manually.

Each entry must have the form package_name.*=logging_level orclass_name=logging_level. Entries are separated with a colon (:).

Tip: It is recommended that you add .* after the names of packages to configurelogging 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 mightneed to configure the "finest" log level, which includes entry/exit logging, fortemporary troubleshooting. The "fine" log level is used for debug-level logging.Log levels "fine" and below are not recommended for anything other thantemporary troubleshooting in a production environment because they are verboseand affect performance.

The IBM Content Management Interoperability Services for FileNet ContentManager application can be divided into the following categories for logging:

IBM CMIS application loggingThe package name for the IBM CMIS application is com.ibm.ecm.

IBM CMIS component loggingThe package name for the IBM CMIS components is com.ibm.ecm.cmis.

Common component loggingThe package name for the common application components iscom.ibm.ecm.integration.

Performance loggingThe class name for the performance component is com.ibm.ecm.cmis.perf.

The following examples show how you can configure common logging levels forIBM 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 includesinformation that can be used to debug general problems, enter:com.ibm.ecm.cmis.*=fine


v To specify finest-level logging for the IBM CMIS components, which logsdetailed 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 traceinformation 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 sizeFrom the WebSphere Application Server administrative console, you can enable ordisable trace logging, change the log file location, size and retention, and modifythe log entry format.

These settings apply to all applications that use Apache Commons Loggingstandard. It is not usually necessary to change these settings when troubleshootingIBM Content Management Interoperability Services for FileNet Content Manager(IBM CMIS).

To ensure that log data is retained properly, you can specify the maximum file sizeand maximum number of historical files. However, be sure to account for the loglevel that is configured and the load that the configuration will place on yoursystem.

By default, the SystemOut.log and the trace.log files are located in theWAS_profile_location/logs/server subdirectory of the WebSphere ApplicationServer installation directory. For example, on a standard AIX installation, the logfiles 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 foryour environment:


RuntimeThis option is recommended. Any changes that you make on theRuntime tab are activated immediately.


4. Click Apply.


http://publib.boulder.ibm.com/infocenter/wasinfo/v7r0/topic/com.ibm.websphere.base.doc/info/aes/ae/rtrb_loglevels.html

5. To configure trace.log, click Diagnostic Trace in the Logging and Tracingpanel. Specify the trace output for your configuration on the appropriate tab foryour environment:


RuntimeThis option is recommended. Any changes that you make on theRuntime tab are activated immediately.


6. Click Apply.

Logged errorsIf you configured logging for IBM Content Management Interoperability Servicesfor FileNet Content Manager (IBM CMIS), all errors are logged in WebSphereApplication 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 followingobject 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 oruse invalid syntax.INVALID_OBJECT_ID_1_A=Ensure that a valid object ID or path is retrieved fromHTTP responses, or the RESTful AtomPub binding service document, or the WebServices binding document.

The OASIS CMIS API specification requires applications to throw exceptions whencertain errors occur. The following code is an example of the information that iswritten to the log file when an exception occurs:MM/DD/YY HH:MM:SS] 00000017 DALP8Exceptio Ecom.ibm.ecm.cmis.dal.p8.DALP8ExceptionHandler handleException nullcom.ibm.ecm.cmis.app.exceptions.InvalidArgumentException:CIL1145: The service cannot be completed because the value that was specifiedfor the following input parameter is not valid.Input parameter: repositoryIdValue: bad-dogExplanation: 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 andreturned. If you use Web Services, server-side stack trace information is logged butnot returned. The client application sees only the client-side stack traceinformation.

Configuring Content Engine API client loggingIBM Content Management Interoperability Services for FileNet Content Manager(IBM CMIS) bundles and performs most content operations through the IBMFileNet Content Engine Java API. You might need to configure Content Engine APIclient logging when you need to troubleshoot performance problems related toContent Engine.


The API layer has its own logging structure, that uses the Apache Log4J standardlibrary. Therefore, the server logs might show stack traces for ContentEngine-related errors that occur under normal operation, no matter what theapplication 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 WebSphereApplication Server directory:

Operating system Default Directory

AIX /usr/IBM/WebSphere/AppServer/profile_name/installedApps/cell_name/fncmis.ear/fncmis.war/WEB-INF/classes

Linux /opt/IBM/WebSphere/AppServer/profile_name/installedApps/cell_name/fncmis.ear/fncmis.war/WEB-INF/classes

Windows C:\Program Files\IBM\WebSphere\AppServer\profiles\profile_name\installedApps\cell_name\fncmis.ear\fncmis.war\WEB-INF\classes

3. Restart the IBM CMIS application in the WebSphere Application Serveradministrative console to distribute the changes to the deployed application.

After you deploy the application, the Content Engine API client logs are created inthe 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############################################################## === FileNetNullAppenderlog4j.appender.FileNetNullAppender=org.apache.log4j.varia.NullAppender

# === FileNetConsoleAppenderlog4j.appender.FileNetConsoleAppender=org.apache.log4j.ConsoleAppenderlog4j.appender.FileNetConsoleAppender.layout=org.apache.log4j.PatternLayoutlog4j.appender.FileNetConsoleAppender.layout.ConversionPattern=%d %5p [%t] - %m\r\n

#=== FileNetErrorAppenderlog4j.appender.FileNetErrorAppender=org.apache.log4j.FileAppenderlog4j.appender.FileNetErrorAppender.File=logs/server1/fncmis_api_error.loglog4j.appender.FileNetErrorAppender.layout=org.apache.log4j.PatternLayoutlog4j.appender.FileNetErrorAppender.layout.ConversionPattern=%d %5p [%t] - %m\r\n

#=== FileNetTraceAppenderlog4j.appender.FileNetTraceAppender=org.apache.log4j.FileAppenderlog4j.appender.FileNetTraceAppender.File=logs/server1/fncmis_api_trace.log# 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.FileNetTraceAppender.layout=com.filenet.apiimpl.util.TraceLayout# Comment out the following lines if using the FileNet TraceLayoutlog4j.appender.FileNetTraceAppender.layout=org.apache.log4j.PatternLayoutlog4j.appender.FileNetTraceAppender.layout.ConversionPattern=%d %5p [%t] - %m\r\n

#=== FileNetErrorRollingAppenderlog4j.appender.FileNetErrorRollingAppender=org.apache.log4j.RollingFileAppenderlog4j.appender.FileNetErrorRollingAppender.File=logs/server1/fncmis_api_error.loglog4j.appender.FileNetErrorRollingAppender.MaxFileSize=100MBlog4j.appender.FileNetErrorRollingAppender.MaxBackupIndex=1log4j.appender.FileNetErrorRollingAppender.layout=org.apache.log4j.PatternLayoutlog4j.appender.FileNetErrorRollingAppender.layout.ConversionPattern=%d %5p [%t] - %m\r\n

#=== FileNetTraceRollingAppenderlog4j.appender.FileNetTraceRollingAppender=org.apache.log4j.RollingFileAppenderlog4j.appender.FileNetTraceRollingAppender.File=logs/server1/fncmis_api_trace.loglog4j.appender.FileNetTraceRollingAppender.MaxFileSize=100MBlog4j.appender.FileNetTraceRollingAppender.MaxBackupIndex=1# This is the layout that the TraceLoggingConfigurationframework 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 TraceLayoutlog4j.appender.FileNetTraceRollingAppender.layout=org.apache.log4j.PatternLayoutlog4j.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 logger’s value overwrites parent logger’s value.# If a logger is not specified, it inherents its value from its parent.# By default, error logging is set to level ERROR.############################################################## Don’t 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 logger’s value overwrites parent logger’s 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.


## 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############################################################## Don’t 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 = debuglog4j.logger.filenet_tracing.api.timer = debug# Remove the comment corresponding to the desired detail levellog4j.logger.filenet_tracing.api.detail.moderate.summary = debug#log4j.logger.filenet_tracing.api.detail.moderate = debug#log4j.logger.filenet_tracing.api.detail = debug


Deploying IBM CMIS for FileNet Content Manager

You can deploy the IBM Content Management Interoperability Services for FileNetContent Manager (IBM CMIS) application manually or by using the configurationtool.

The configuration tool enables you to deploy IBM CMIS as soon as you modify theapplication. In addition, the configuration tool remembers your configuration anddeployment information across sessions.

Alternatively, you can manually deploy the application after you use theconfiguration 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 runningthe configuration tool”“Deploying the IBM CMIS for FileNet Content Manager application by runninga 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 byrunning the configuration tool

When you configure IBM Content Management Interoperability Services forFileNet Content Manager (IBM CMIS), you can use the configuration tool todeploy IBM CMIS to WebSphere Application Server.

To deploy the IBM CMIS application:1. Start the configuration tool:


AIX At a command prompt, change to the configsubdirectory of the IBM CMIS for FileNetContent Manager installation directory andenter: ./config.sh.

Linux At a command prompt, change to the configsubdirectory of the IBM CMIS for FileNetContent Manager installation directory andenter: ./config.sh.

Windows At a command prompt, change to the configsubdirectory of the IBM CMIS for FileNetContent Manager installation directory andenter: config.bat.

2. Configure the IBM CMIS application for your environment and selectAutomatically deploy IBM CMIS.

3. Specify the instance of WebSphere Application Server to which to deploy IBMCMIS.


Important: You must deploy IBM CMIS to an existing WebSphere ApplicationServer 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, theconfiguration tool uses the installation directory that you specified in theContent 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 IBMCMIS.

e. Specify the cluster or application server to which to deploy IBM CMIS.

Remember: It is recommended that you deploy IBM CMIS to a dedicatedapplication server or application server cluster.

f. Optional: Specify the name to display for the IBM CMIS application inWebSphere Application Server. The default display name for the applicationis FN_CMIS.

4. Verify your WebSphere Application Server deployment information and clickNext.


“IBM CMIS for FileNet Content Manager index page” on page 53

Deploying the IBM CMIS for FileNet Content Manager application byrunning a silent configuration

When you configure IBM Content Management Interoperability Services forFileNet Content Manager (IBM CMIS), you can enter information about yourWebSphere Application Server deployment environment in the silent configurationresponse file.

A silent configuration uses a response file that contains the configuration anddeployment parameters that you specify. When you run a silent configuration, theconfiguration program does not display any configuration windows or messages.Instead, any messages and errors are written to the fncmis-config.log file in thelog directory.

To deploy the IBM CMIS for FileNet Content Manager application:1. Open the response file:


AIX config/fncmis-UNIX_SilentConfig.properties

Linux config/fncmis-UNIX_SilentConfig.properties

Windows config\fncmis-WIN_SilentConfig.properties


2. Ensure that the parameters in the Content Engine Connection Informationsection are specified correctly for your environment.

3. Ensure that the USER_WS_AUTH parameter is specified correctly for yourenvironment.

4. Set the USER_MANUAL_DEPLOY parameter to 0.

Remember: If you set the USER_MANUAL_DEPLOY parameter to 1, youmust manually deploy IBM CMIS.

5. Specify the information about the WebSphere Application Server environmentto which you want to deploy IBM CMIS.

Important: You must deploy IBM CMIS to an existing WebSphere ApplicationServer 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 (\) byadding a backslash before each colon or backslash in the installationdirectory 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 WebSphereApplication Server profile to which you want to deploy IBM CMIS. Thedefault profile is AppSrv01.

c. Set the USER_WASADMIN_ID parameter to the administrator user namefor the specified application server profile.

d. Set the USER_WASADMIN_PW parameter to the administrator passwordfor the specified application server profile.

e. Set the USER_DEPLOY_TYPE parameter to one of the following values:

appserverSpecify appserver to deploy IBM CMIS to an application server onWebSphere Application Server or to a managed node or anunmanaged node on WebSphere Application Server NetworkDeployment.

clusterSpecify cluster to deploy IBM CMIS to a cluster on WebSphereApplication Server Network Deployment.

f. If you specified USER_DEPLOY_TYPE=appserver, specify values for thefollowing properties.

Remember: It is recommended that you deploy IBM CMIS to a dedicatedapplication 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 todeploy IBM CMIS.

g. If you specified USER_DEPLOY_TYPE=cluster, set theUSER_APPSERVER_CLUSTER parameter to the name of the applicationserver cluster on which to deploy IBM CMIS.

Deploying IBM CMIS for FileNet Content Manager 49

Remember: It is recommended that you deploy IBM CMIS to a dedicatedapplication server cluster.

h. Optional: Set the USER_APP_NAME parameter to specify the name todisplay for the IBM CMIS application in WebSphere Application Server. Thedefault 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:


AIX ./config.sh -s

Linux ./config.sh -s

Windows config.bat -s



Deploying the IBM CMIS for FileNet Content Manager applicationmanually

After you configure IBM Content Management Interoperability Services for FileNetContent Manager (IBM CMIS), you can manually deploy IBM CMIS to WebSphereApplication 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 513. “Manually deploying IBM CMIS for FileNet Content Manager” on page 51Related tasks


Modifying the generic JVM arguments in WebSphereApplication Server

Before you manually deploy IBM Content Management Interoperability Servicesfor FileNet Content Manager (IBM CMIS), you must modify the generic JVMarguments 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 tocomplete 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.


4. Under Server Infrastructure, click Java and Process Management → Processdefinition.

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 WebSphereApplication Server

If you configured IBM Content Management Interoperability Services for FileNetContent Manager (IBM CMIS) to use WS-Security, you must import theWS-Security policy set to WebSphere Application Server before you manuallydeploy IBM CMIS.

If you use the configuration program to deploy IBM CMIS, you do not need tocomplete this task.

To import the WS-Security policy set to WebSphere Application Server:1. Log in to the WebSphere Application Server administrative console.2. Click Services → Policy sets → Application policy sets.3. Select Import → From Selected Location.4. Select the cmis_auth_policyset.zip file from the config/scripts/policysets

subdirectory of the IBM CMIS installation directory:


AIX /opt/IBM/FN_CMIS/config/scripts/policysets/cmis_auth_policyset.zip

Linux /usr/IBM/FN_CMIS/config/scripts/policysets/cmis_auth_policyset.zip

Windows C:\Program Files\IBM\FN_CMIS\config\scripts\policysets\cmis_auth_policyset.zip

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 ManagerAfter you configure your WebSphere Application Server environment for IBMContent Management Interoperability Services for FileNet Content Manager (IBMCMIS), you can manually deploy IBM CMIS to WebSphere Application Server.

You must modify the generic JVM arguments for the server on which IBM CMISwill be deployed.

In addition, if you configured IBM CMIS to use WS-Security, you must import theWS-Security policy set to WebSphere Application Server.

The IBM CMIS application EAR file, fncmis.ear, is created when you selectManually deploy IBM CMIS in the configuration tool or the silent configurationresponse file.

Deploying IBM CMIS for FileNet Content Manager 51

The IBM CMIS fncmis.ear file is created in the profiles/profile1 subdirectory ofthe IBM CMIS installation directory.

Table 14. Default location of the fncmis.ear file


AIX /opt/IBM/FN_CMIS/profiles/profile1/fncmis.ear

Linux /usr/IBM/FN_CMIS/profiles/profile1/fncmis.ear

Windows C:\Program Files\IBM\FN_CMIS\profiles\profile1\fncmis.ear

To manually deploy IBM CMIS to WebSphere Application Server:1. Log in to the WebSphere Application Server administrative console.2. Click Applications → New Application → New Enterprise Application.3. 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.




IBM CMIS for FileNet Content Manager Development

Content Management Interoperability Services (CMIS) is an open source OASISstandard that enables applications to work with one or more content managementsystems by defining a standard domain model and standard set of services andprotocol bindings for Web Services and RESTful AtomPub.

The CMIS Web Services bindings and RESTful AtomPub bindings are described inthe 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 CMISspecification” on page 59“Best practices for developing client applications” on page 63

IBM CMIS for FileNet Content Manager index pageThe IBM Content Management Interoperability Services for FileNet ContentManager (IBM CMIS) index page contains information about the instance of IBMCMIS that is deployed to your web application server.

Specifically, the index page includes links to the service documents andinformation about the URI templates and service collections that are defined forthe repositories (IBM FileNet P8 object stores) on your Content Engine server.

When IBM CMIS is properly configured and deployed, you can access the indexpage at http://host_name:port/context_root/index.jsp. By default, the contextroot 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 bindingv Develop against a client API

The index page also includes links to the Web Services binding information andthe RESTful Atom Protocol (AtomPub) binding information in the OASIS CMISspecification.

“IBM CMIS for FileNet Content Manager service collection URLs” on page 54“IBM CMIS for FileNet Content Manager URI templates” on page 54


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” onpage 30“Deploying the IBM CMIS for FileNet Content Manager application by running theconfiguration tool” on page 47“Deploying the IBM CMIS for FileNet Content Manager application by running asilent configuration” on page 48“Manually deploying IBM CMIS for FileNet Content Manager” on page 51Related information

Context root for Web modules settings (WebSphere Application Server NetworkDeployment)Context root for Web modules settings (WebSphere Application Server)

IBM CMIS for FileNet Content Manager service collectionURLs

Service collection URLs provide feeds that enable users to browse and navigate theitems in the repository. The OASIS CMIS specification defines several servicecollection URLs.

The OASIS specification defines the following service collection URLs:

Root folder collectionThis URL provides a feed that displays all of the folders and documentsthat are in the root folder.

Query collectionThis URL provides a feed of the objects that satisfy a predefined query.

Checked out collectionThis URL provides a feed of the documents that are in the checked-outstate in the repository.

Unfiled collectionThis URL provides a feed of the documents that are not filed in a folder inthe repository.

Types children collectionThis URL provides a feed of the base object types, specificallycmis:document and cmis:folder.

For a list of the service collection URLs for your IBM CMIS for FileNet ContentManager 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 Manageris fncmis.

For more information, see section 3.7 Service Collections of the OASIS CMISspecification.

IBM CMIS for FileNet Content Manager URI templatesURI templates enable users to insert values in a standardized URI to retrievespecific data, such as a specific folder or document, from the repository. The OASISCMIS specification defines several URI templates.


http://publib.boulder.ibm.com/infocenter/wasinfo/v7r0/topic/com.ibm.websphere.nd.multiplatform.doc/info/ae/ae/uweb_contextroot.html

http://publib.boulder.ibm.com/infocenter/wasinfo/v7r0/topic/com.ibm.websphere.nd.multiplatform.doc/info/ae/ae/uweb_contextroot.html

http://publib.boulder.ibm.com/infocenter/wasinfo/v7r0/topic/com.ibm.websphere.base.doc/info/aes/ae/uweb_contextroot.html

http://docs.oasis-open.org/cmis/CMIS/v1.0/os/cmis-spec-v1.0.html#_Toc243905538

The OASIS specification defines the following URI templates:

Object by ID (objectbyid) templateThis URI template enables users to create a URI that can directly access adocument or folder by specifying the ID of the object.

Object by path (objectbypath) templateThis URI template enables users to create a URI that can directly access adocument or folder by specifying the path of the object.

Query (query) templateThis URI template enables users to create a URI to search for data in therepository by specifying a CMIS Query Statement. The server returns afeed of objects that correspond to the query that is supplied.

Type by ID (typebyid) templateThis URI template enables users to create a URI to retrieve metadata abouta type (IBM FileNet P8 class). The server returns the class descriptioninformation in the CMIS format for a type, which includes all the propertydescriptions that are defined for the specified type.

For a list of the URI templates for your IBM CMIS for FileNet Content Managerapplication, 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 CMISspecification.

OASIS CMIS specificationThe OASIS Content Management Interoperability Services (CMIS) specificationincludes detailed information about the CMIS Web Services bindings and theRESTful AtomPub bindings.

The OASIS CMIS API specification is available in HTML format athttp://docs.oasis-open.org/cmis/CMIS/v1.0/os/cmis-spec-v1.0.html.

Important: The IBM Content Management Interoperability Services for FileNetContent Manager documentation does not include specific guidance for developingwith the OASIS CMIS APIs. However, some of the resources in “Useful resources”provide additional guidance.

Useful resourcesUseful resources that help you get started with OASIS Content ManagementInteroperability Services (CMIS) and CMIS client applications are available online.

The OASIS CMIS Technical Committee maintains a website that includesinformation about various implementations of CMIS at http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=cmis.

IBM maintains a page for Content Management Interoperability Services (CMIS)Information Management software, which includes links to developerWorks® topicsand other useful resources, at http://www.ibm.com/software/data/content-management/cm-interoperablity-services.html.

IBM CMIS for FileNet Content Manager Development 55


http://docs.oasis-open.org/cmis/CMIS/v1.0/os/cmis-spec-v1.0.html

http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=cmis

http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=cmis

http://www.ibm.com/software/data/content-management/cm-interoperablity-services.html

http://www.ibm.com/software/data/content-management/cm-interoperablity-services.html

The Lotus® Quickr® wiki also includes a compilation of resources athttp://www.ibm.com/software/lotus/info/r/ldd/lqwiki.nsf/dx/11122008094143amwebk95.htm.

Extensions for IBM CMIS for FileNet Content ManagerThe OASIS Content Management Interoperability Services (CMIS) specificationenables developers to extend the RESTful AtomPub bindings and Web Servicesbindings that are provided by the specification. IBM Content ManagementInteroperability Services for FileNet Content Manager (IBM CMIS) includes severalextensions that enable client applications to retrieve additional information from anIBM FileNet Content Manager system.

The IBM CMIS extensions are extensions to the XML output from the server andare present on each response from the Content Engine server. The extensions areoptional and do not interfere with client applications that are not designed to usethe 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 areprovided 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 extensionThe class display name (ClassDisplayName) extension enables client applicationsto retrieve the display name of an object class as part of the object type definitionfor 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 isprovided by the extension only if a value is available. If this information is notprovided, it should not cause your application to encounter an error because theinformation is not required by the OASIS CMIS API specification.


http://www.lotus.com/ldd/lqwiki.nsf/dx/11122008094143AMWEBK95.htm

http://www.lotus.com/ldd/lqwiki.nsf/dx/11122008094143AMWEBK95.htm

Response format<p8ext:ClassDisplayName>Class Display Name</p8ext:ClassDisplayName>

Hidden properties extensionThe hidden properties (isHidden) extension enables client applications todetermine the object properties that should not be displayed based on the objectproperties that are marked as hidden in Content Engine.


Response format<p8ext:isHidden>Boolean true or false</p8ext:isHidden>

Choice list symbolic name extensionThe choice list symbolic name (ChoiceListSymbolicName) extension enables clientapplications to retrieve the symbolic name of a choice list (also called a controlledvocabulary list or a CVL) from Content Engine.


Response format<p8ext:ChoiceListSymbolicName>Symbolic Name</p8ext:ChoiceListSymbolicName>

Choice list display name extensionThe choice list display name (ChoiceListDisplayName) extension enables clientapplications to retrieve the display name of a choice list (also called a controlledvocabulary list or a CVL) from Content Engine.


Response format<p8ext:ChoiceListDisplayName>Display Name</p8ext:ChoiceListDisplayName>

Domain name extensionThe domain name (DomainName) extension enables client applications to retrievethe 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 isprovided 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 theinformation is not required by the OASIS CMIS API specification.

Response format<p8ext:DomainName>FileNet P8 Domain Name</p8ext:DomainName>

Object store ID extensionThe object store ID (ObjectStoreID) extension enables client applications to retrievethe object store GUID as part of the repository information.


Response format<p8ext:ObjectStoreID>{GUID}</p8ext:ObjectStoreID>

Object store database type extensionThe object store database type (ObjectStoreDBType) extension enables clientapplications to retrieve the type of database, such as DB2® or Oracle, that therepository runs on as part of the repository information.


Response format<p8ext:ObjectStoreDBType>Database type</p8ext:ObjectStoreDBType>

Records management extensionThe records management (RecordsManagementEnabled) extension enables clientapplications to determine whether the documents in a repository can be declaredas records. This information is provided as part of the repository information.


Response format<p8ext:RecordsManagementEnabled>Boolean true or false</p8ext:RecordsManagementEnabled>

Text search engine extensionThe text search engine (TextSearchEngine) extension enables client applications todetermine whether text search is enabled on the repository. If text search isenabled, this extension identifies which text search engine is installed. Thisinformation is provided as part of the repository information.


Regardless of the text search engine that is installed, your client must use OASISCMIS search syntax.


Response format<p8ext:TextSearchEngine>Integer value for text search engine</p8ext:TextSearchEngine>

The extension returns one of the following values:

0 The repository does not have a text search engine installed.

1 The repository has an IBM Legacy Content Search Engine text searchengine installed.

2 The repository has a IBM Content Search Services text search engineinstalled.

Important: The values that are returned by this extension are documented in theContent Engine API. For definitive information about the text search values, seethe com.filenet.api.constants.CRBSearchType section of the Content Engine API.

GZIP compression extensionThe GZIP compression extension enables client applications to request compressedresponses from IBM Content Management Interoperability Services for FileNetContent Manager (IBM CMIS) to increase performance.

If a client application sends a request that contains an Accept-Encoding header thatspecifies the GZIP file compression, IBM CMIS compresses the response usingGZIP compression.

Request formatAccept-Encoding: gzip

Response formatContent-Encoding: gzip

IBM CMIS for FileNet Content Manager implementation of the OASISCMIS specification

The OASIS Content Management Interoperability Services (CMIS) specificationenables applications to implement the specification in slightly different ways toaccount for the differences between repositories. When you develop a clientapplication that uses CMIS services to interact with a repository, you must beaware of the behaviors and limitations of the implementation.

Tip: To learn about the optional capabilities that a repository supports, see thevalues that are published in the repositoryInfo.capabilities structure.


In addition, you should be aware of the following behaviors and limitations whenyou develop a client application to connect to an IBM FileNet Content Managersystem by using IBM Content Management Interoperability Services for FileNetContent 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 supportIBM Content Management Interoperability Services for FileNet Content Manager(IBM CMIS) supports the cmis:changeToken property for only documents andfolders. IBM CMIS does not support the property for domains, relationships,repositories, or content streams.

OASIS CMIS specification

The OASIS CMIS specification defines the cmis:changeToken property to provideoptimistic 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 CMISspecification.

IBM CMIS implementation

IBM CMIS for FileNet Content Manager supports the cmis:changeToken propertyfor only documents and folders.

The cmis:changeToken property is included in the object metadata for thecmis:document type and the cmis:folder type. The cmis:changeToken propertymaps to the IBM FileNet P8 UpdateSequenceNumber property.

Links in private working copy supportIBM Content Management Interoperability Services for FileNet Content Manager(IBM CMIS) supports up links in private working copies. However, in some casesthe 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 LinkRelations of the OASIS CMIS specification.


IBM CMIS for FileNet Content Manager always includes an up link in privateworking 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.





v If a version series has only one version and that version is the private workingcopy of the document, the up link in the private working copy leads to a feedthat contains the parent folder of the private working copy.

Paging feed supportIBM 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 aredefined in the AtomPub RFC.

For more information, see section 3.1.8 Paging of Feeds of the OASIS CMISspecification.


IBM CMIS for FileNet Content Manager supports the paging of feeds, but has thefollowing behaviors for next and last links:

Last linksLast links are not supported.

Next linksWhen the last page of feed is full (more specifically, when the number ofitems returned equals the value specified for the maxItems argument), IBMCMIS for FileNet Content Manager might provide an unnecessary nextlink.

Query supportIBM Content Management Interoperability Services for FileNet Content Manager(IBM CMIS) supports queries. However there are some restrictions that you shouldbe aware of when developing queries.


The OASIS CMIS specification provides a type-based query service to search forobjects 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 queryspecifications with the following exceptions and limitations.

Character escaping in LIKE strings is not supported

The OASIS CMIS specification requires repositories to support thebackslash (\) as an escape character in query statements. One of therequirements is that in a LIKE string, \% represents % and \_ represents _.

However, IBM CMIS for FileNet Content Manager does not supportquerying on the percent sign (%) or the underscore (_) characters in a LIKEstring because the Content Engine APIs do not support ESCAPE clauses. If




a query includes an escaped percent sign (\%) or an escaped underscore(\_), IBM CMIS for FileNet Content Manager converts the characters to anunderscore, which is a single-character wildcard.

Converting escaped percent signs and escaped underscores to asingle-character wildcard character can result in more search results thanexpected.

For example, you have three documents in your repository nameddocument_1, document_2, and document11. You use the query SELECT * FROMDocument WHERE DocumentTitle LIKE ’document\_%’ to search for alldocuments that have a title that starts with document_. The expected resultis that document_1 and document_2 are returned by the query.

However, when you submit the query, IBM CMIS for FileNet ContentManager converts the query to (SELECT * FROM Document WHEREDocumentTitle LIKE ’document_%’), so that IBM FileNet P8 can parse thequery. This query returns all three documents.

Tip: You can use percent signs and underscores as wildcard characters inqueries that include equality conditions because equality conditions do notrequire 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 querythat 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 ContentManager requires parentheses around the nested <joined table>.

For example, if you submit the following query, IBM FileNet P8 returns aparsing error on the INNER JOIN clause:SELECT d.* FROM cmis:document d INNER JOIN cmis:folder f ONd.cmis:createdBy = f.cmis:createdBy INNER JOIN EntryTemplate e ON

d.cmis:lastModifiedBy = e.cmis:lastModifiedBy WHEREe.cmis:createdBy<>’admin’

To run this query in IBM CMIS for FileNet Content Manager, you must usethe following syntax:SELECT d.* FROM (cmis:document d INNER JOIN cmis:folder f ONd.cmis:createdBy = f.cmis:createdBy) INNER JOIN EntryTemplate e ON


Nested JOIN clauses can appear on only one side of the JOIN keyword

The OASIS CMIS specification defines the following syntax for a querythat 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>


In the OASIS CMIS specification, you can have nested JOIN clauses oneither side of the JOIN keyword. However, IBM CMIS for FileNet ContentManager supports nested JOIN clauses on either the left side or the rightside 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 aparsing error because there is a nested JOIN clause on each side of theJOIN keyword:SELECT d.* FROM (cmis:document d INNER JOIN cmis:folder f ONd.cmis:createdBy = f.cmis:createdBy) INNER JOIN (EntryTemplatee INNER JOIN Email e2 ON e.cmis:createdBy = e2.cmis:createdBy)ON d.cmis:lastModifiedBy = e.cmis:lastModifiedBy WHEREe.cmis:createdBy<>’admin’

To run this query in IBM CMIS for FileNet Content Manager, you mustremove the nested JOIN clause on one side of the JOIN key word. Thefollowing query has a nested JOIN clause on the right side of the JOINkeyword:SELECT d.* FROM EntryTemplate e INNER JOIN (cmis:document dINNER JOIN cmis:folder f ON d.cmis:createdBy = f.cmis:createdBy) ON


Versioning properties on document objects supportIBM 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 documentobjects, which includes the cmis:checkinComment property.

For more information, see section 2.1.9.5 Versioning Properties on DocumentObjects of the OASIS CMIS specification.


If a value is specified for the cmis:checkinComment property, the value is ignoredwhen the document is checked in.

Best practices for developing client applicationsThere are several best practices and recommendations that you should keep inmind when accessing content through IBM Content Management InteroperabilityServices 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 totrue, folders and documents are deleted individually. If a document or foldercannot 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 IDsthat were not deleted to the client application.




If you call the deleteTree service with the continueOnFailure parameter set tofalse, all of the folders and documents are deleted in a single batch, whichimproves performance. However, if a document or folder cannot be deleted, noneof 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 parentfolder contains many documents and folders. If this occurs, you can call thedeleteTree service on a subfolder of the parent folder to reduce the number ofobjects 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 thefollowing suggestions, you can reduce the impact of using the Unfiled servicecollection 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 isrequired to display the documents.This is especially important if you use Web Services to retrieve documentsbecause Web Services does not provide a next link.

v If you want to retrieve a specific set of unfiled documents, use a custom queryto return only the wanted documents.

v If your repository (IBM FileNet P8 object store) contains more than 1,000,000documents, use the Unfiled service collection URL only when the least numberof users are using the system.

Recommendations for working with large objects

If your repository contains large objects, you should implement the followingrecommendations 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 section2.2.4.16 setContentStream of the OASIS CMIS API specification.

v For Web Services, the most efficient method to access large objects is the SOAPMessage Transmission Optimization Mechanism (MTOM) method, which mustbe configured in client application.



Troubleshooting IBM CMIS for FileNet Content Manager

This section includes information that you can use to troubleshoot commonproblems that you might encounter when using IBM Content ManagementInteroperability Services for FileNet Content Manager (IBM CMIS). For example,this section includes information about log files, runtime error messages, andinformation 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 filesIBM Content Management Interoperability Services for FileNet Content Manager(IBM CMIS) generates several log files that you can use to troubleshoot problemsthat 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 ContentManager installation. Use this log file to determine whether IBM CMIS forFileNet Content Manager was successfully installed.

This log file is located in the log subdirectory of the IBM CMIS installationdirectory. However, if the installation program stops before you specify theinstallation directory, the log file is saved to the desktop on Windows orthe home directory of the user who is running the installation on AIX orLinux.

fncmis-install.log

This log file is generated during the IBM CMIS for FileNet ContentManager installation and contains debug-level logging information. If theIBM CMIS installation fails, use this log file to determine where and whythe problem occurred.

This log file is located in the log subdirectory of the IBM CMIS installationdirectory.

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 Managerconfiguration tool and contains debug-level logging information. If youexperience issues in the following situations, use this log file to determinewhere and why the problem occurred:v You cannot establish a test connection to Content Enginev The application EAR file cannot be builtv The application cannot be deployed to WebSphere Application Server



Runtime log files

Depending on how you configure logging for IBM CMIS for FileNet ContentManager, you can find information that can help you resolve problems that occurwhen using IBM CMIS for FileNet Content Manager in several locations:

SystemOut.log

IBM CMIS for FileNet Content Manager uses the Apache CommonsLogging API, which can be configured through the WebSphere ApplicationServer 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 FileNetContent 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 filealso 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 loggingconfiguration in the WebSphere Application Server information center.

For information about configuring the SystemOut.log file for IBM CMIS forFileNet Content Manager, see “Configuring logging” on page 39.

trace.log

IBM CMIS for FileNet Content Manager uses the Apache CommonsLogging API, which can be configured through the WebSphere ApplicationServer 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 SoftwareSupport to pinpoint when and where a failure occurred.


To learn more about the trace.log file, see Tracing and loggingconfiguration in the WebSphere Application Server information center.

For information about configuring the trace.log file for IBM CMIS forFileNet Content Manager, see “Configuring logging” on page 39.

fncmis_api_error.log

IBM CMIS for FileNet Content Manager bundles and performs mostcontent operations through the Apache Commons Logging API.

You can configure client-side logging if you need to troubleshoot problemsrelated to Content Engine.

This log file shows the calls that IBM CMIS for FileNet Content Managermakes to the enable IBM Software Support to pinpoint when and where afailure occurred.


http://publib.boulder.ibm.com/infocenter/wasinfo/v7r0/topic/com.ibm.websphere.base.doc/info/aes/ae/rtrb_enabletrc.html





For information about configuring the fncmis_api_error.log file for IBMCMIS for FileNet Content Manager, see “Configuring Content Engine APIclient logging” on page 42.

fncmis_api_trace.log

IBM CMIS for FileNet Content Manager bundles and performs mostcontent operations through the IBM FileNet Content Engine Java API.

You can configure client-side trace logging if you need to troubleshootproblems related to Content Engine.

This log file shows the calls that IBM CMIS for FileNet Content Managermakes to enable IBM Software Support to pinpoint when and where afailure occurred. This log file includes more detailed information than thefncmis_api_error.log file.


For information about configuring the fncmis_api_trace.log file for IBMCMIS for FileNet Content Manager, see “Configuring Content Engine APIclient 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 ContentManager uninstallation and contains debug-level logging information. Ifyou experience issues when you uninstall IBM CMIS, use this log file todetermine where and why the problem occurred.


Collecting data for IBM CMIS for FileNet Content ManagerIf you cannot determine the cause of a problem, you might need to contact IBMSoftware Support for additional assistance. In such cases, you must collectdiagnostic data before contacting IBM Software Support.

Collecting data before opening a problem management record (PMR) can help youto 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 Serverv IBM FileNet Content Manager

Troubleshooting IBM CMIS for FileNet Content Manager 67

v IBM FileNet Content Engine Client

For more information about the prerequisite software, see “Prerequisites” onpage 5.

2. Recreate the problem with finest-level logging and Content Engine Client APItrace logging enabled.For information about enabling finest-level logging, see “Specifying log levelentries” 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 aproblem report, restore your original logging settings to control the size of yourlog files and to improve performance.

3. Gather the IBM CMIS for FileNet Content Manager log files:v fncmis-install-ia.log

v fncmis-install.log

v fncmis-config.log

v fncmis-uninstall.log (if applicable)v 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 ContentManager log files, see “IBM CMIS for FileNet Content Manager log files” onpage 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 yourIBM CMIS installation page on the IBM CMIS for FileNet Content Managerindex page.

v How is your IBM CMIS for FileNet Content Manager system configured?

Recommendation: Copy the configuration information from the About yourIBM CMIS configuration page on the IBM CMIS for FileNet ContentManager index page, which includes information about your IBM CMISconfiguration, system properties, and environment variables.

v Is the IBM CMIS for FileNet Content Manager installation a fresh installationor did you upgrade from a previous version of IBM CMIS for FileNetContent Manager?

v What is the operating system, including the version number, of the IBMCMIS for FileNet Content Manager server?

v What version of WebSphere Application Server is IBM CMIS for FileNetContent Manager deployed to? (Specify WebSphere Application Server orWebSphere Application Server Network Deployment.)

v Was IBM CMIS for FileNet Content Manager deployed automatically ormanually?


v What type of environment is IBM CMIS for FileNet Content Managerdeployed to? For example is IBM CMIS deployed to a single applicationserver, an unmanaged node, a managed node, or an application servercluster?

v How was IBM CMIS for FileNet Content Manager configured? Did you usethe configuration tool or did you run a silent configuration?

5. Describe the problem. Provide the following information to help IBM SoftwareSupport 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 ManagerIf you receive an error message while using IBM Content ManagementInteroperability Services for FileNet Content Manager (IBM CMIS), the error that isdisplayed in the HTTP response contains the information that you need to resolvethe issue. However, the errors are also provided in the information center for yourreference.

“CIL1100” on page 71“CIL1122” on page 71“CIL1125” on page 71“CIL1129” on page 71“CIL1130” on page 71“CIL1139” on page 71“CIL1140” on page 71“CIL1143” on page 71“CIL1144” on page 71“CIL1145” on page 72“CIL1146” on page 72“CIL1147” on page 72“CIL1148” on page 72“CIL1200” on page 72“CIL1217” on page 72“CIL1218” on page 72“CIL1298” on page 72“CIL1299” on page 72“CIL1300” on page 72“CIL1400” on page 72“CIL1401” on page 73“CIL1402” on page 73“CIL1403” on page 73“CIL1404” on page 73“CIL1405” on page 73“CIL1406” on page 73


“CIL1407” on page 73“CIL1408” on page 73“CIL1412” on page 73“CIL1413” on page 73“CIL1415” on page 73“CIL1416” on page 74“CIL1417” on page 74“CIL1500” on page 74“CIL1502” on page 74“CIL1503” on page 74“CIL1508” on page 74“CIL1510” on page 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” on page 75“CIL1601” on page 75“CIL1602” on page 76“CIL1603” on page 76“CIL1604” on page 76“CIL1605” on page 76“CIL1606” on page 76“CIL1607” on page 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” on page 77“CIL1616” on page 77“CIL1700” on page 77“CIL1701” on page 77“CIL1800” on page 77“CIL1900” on page 77“CIL2000” on page 77“CIL2001” on page 77“CIL2100” on page 77“CIL2102” on page 78


“CIL2103” on page 78“CIL2104” on page 78“CIL2105” on page 78“CIL2106” on page 78“CIL2107” on page 78“CIL2200” on page 78“CIL2300” on page 78

CIL1100 The service cannot be completedbecause one or more of the inputparameters are missing or are not valid.

Explanation: No additional explanation is required.

User response: For more information aboutimplementing the argument, see the OASIS CMIS APIspecification.

CIL1122 The query cannot be completed becausethe query syntax is not correct. Query:{query string} OASIS CMIS exception:{exception message}

Explanation: Either the query contains an invalidcharacter, or the structure of the query is not correct.

User response: Modify the query and try again.

If the problem persists, see the "Query LanguageDefinition" section of the OASIS CMIS API specificationfor more information.

CIL1125 The service cannot be completedbecause the {header name} HTTP headeris 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 APIspecification.

CIL1129 The service cannot be completedbecause the content stream cannot bedecoded. Input length: {content length}Document MIME type: {MIME type}Required encoding: base64

Explanation: The document might be corrupted ortruncated.

User response: Resubmit the request with a properlyencoded content stream. OASIS CMIS requires a base64encoding.

CIL1130 The service cannot be completedbecause the {header name} HTTP requestheader contains an invalid value.

Invalid value: {invalid header value}


User response: For more information about the HTTPrequest header, see the HTTP resources that arementioned in the "Normative References" section of theOASIS CMIS API specification.

CIL1139 The service cannot be completedbecause the following object is not afolder: {object path or object ID}

Explanation: The service can be performed only for afolder.

User response: Specify a path or object ID that pointsto a folder.

For more information about implementing the service,see the OASIS CMIS API specification.

CIL1140 The service cannot be completedbecause the following object is a rootfolder: {object path or object ID}

Explanation: The service returns the parents of afolder. However, the folder that was specified is a rootfolder, which does not have parents.

User response: Specify a path or object ID that pointsto a folder other than a root folder.


CIL1143 The service cannot be completedbecause the following object is not adocument: {object path or object ID}

Explanation: The service can be performed only for adocument.

User response: Specify a path or object ID that pointsto a document.


CIL1144 The service cannot be completedbecause the required input parameter,{parameter name}, was not specified.


CIL1100 • CIL1144


User response: Specify the required input parameter.


CIL1145 The service cannot be completedbecause the value that was specified forthe following input parameter is notvalid. Input parameter: {parameter name}Value: {parameter value}


User response: For information about implementingthe argument, see the OASIS CMIS API specification.

CIL1146 The service cannot be completedbecause the value that was specified forthe following input parameter is notvalid. Input parameter: {parameter name}Value: {parameter value} Valid values: "{listor range of valid values}"


User response: For information about implementingthe 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: The syntax of the URL is incorrect.

User response: Specify a URL with the correct format.

See the RESTful AtomPub binding service documentfor information about the correct format for collectionURLs.

CIL1148 The service cannot be completedbecause the following object ID or pathis not valid: {object path or object ID}

Explanation: The object ID or path might containinvalid characters or use invalid syntax.

User response: Ensure that a valid object ID or path isretrieved from HTTP responses, or the RESTfulAtomPub binding service document, or the WebServices binding document.

CIL1200 The service cannot be completedbecause the object cannot be found.


User response: Verify that the path or ID of the objectis correct or specify a different object.

CIL1217 The query contains an invalid objecttype ID. Object type ID: {object type}

Explanation: Either the specified object type ID doesnot exist or is not a valid argument for the query.

User response: Verify that the object type is spelledcorrectly and is a supported OASIS CMIS object type,such as cmis:document or cmis:folder.

If the problem persists, see the "Query LanguageDefinition" section of the OASIS CMIS specification formore information.

CIL1218 The major version of the documentcannot be retrieved because the versionseries does not contain a major version.

Explanation: This error occurs when the object that isspecified for the getObjectOfLatestVersion argumentdoes not have a major version.

User response: For information on implementing thegetObjectOfLatestVersion argument, see the OASISCMIS API specification.

CIL1298 The service cannot be completedbecause the following object cannot befound: {object path or object ID}



CIL1299 The service cannot be completedbecause the following object cannot befound: Input parameter: {parameter name}Object ID or path: {object path or objectID}



CIL1300 Your request cannot be completedbecause you do not have the appropriatepermissions on the repository.


User response: If you need different permissions,contact your content management server administratorfor assistance.

CIL1400 The service cannot be completedbecause the service method that wasinvoked requires an optional capabilitythat is not supported by the repository.


User response: Use the getRepositoryInfo service to

CIL1145 • CIL1400


see the supported services for a repository.

CIL1401 The content stream cannot be deletedbecause the following error occurred onthe content management server. Contentmanagement server error: {exceptionmessage}


User response: See the content management serverdocumentation for information on resolving the issue.

CIL1402 The document cannot be deletedbecause it is not checked out.


User response: Ensure that the document that youwant to delete is checked out and try again.

CIL1403 The {operator name} operator cannot beused to query the {property name}property.

Explanation: The query supports only equality (=) andIN operators for certain properties.

User response: Rewrite the query to use the equals (=)or IN operator.

Contact your content server system administrator foradditional information about the query restrictions thatapply to your content management system.

CIL1404 The following query cannot be usedbecause the NOT operator cannot beused with a CONTAINS clause. Query:{query string}

Explanation: The NOT operator cannot be used with aCONTAINS clause.

User response: Modify the query to replace "NOTCONTAINS(''query_string1 query_string2'')" with"CONTAINS(''-query_string1 -query_string2'')".


CIL1405 The query cannot be used because it hasa CONTAINS clause and a JOIN clause.

Explanation: A query cannot have both a CONTAINSclause and a JOIN clause.

User response: Modify the query to remove theCONTAINS clause or the JOIN clause.


CIL1406 The {0} property cannot be used in aquery statement, because the property isnot queryable, selectable, or orderable.

Explanation: A property that is not queryable,selectable, or orderable cannot be used in a querystatement.

User response: Modify the query to remove thespecified property.

Use the property definition or contact your contentserver administrator to determine whether a property isqueryable, selectable, or orderable.

CIL1407 The query cannot be used because it hasmore than one CONTAINS clause.

Explanation: A query statement can include only oneCONTAINS clause.

User response: Modify the query to use only oneCONTAINS clause or separate each CONTAINS clauseinto 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 hasa SCORE clause but does not have acorresponding CONTAINS clause.

Explanation: A query statement that includes aSCORE clause must include a correspondingCONTAINS clause.

User response: Modify the query to add a CONTAINSclause 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 becreated.

Explanation: IBM CMIS does not support the specifiedobject type.

User response: No action required.

CIL1413 The object cannot be unfiled from thefolder because it is not a document.

Explanation: Only documents can be unfiled.

User response: Ensure that the object that you want tounfile is a document and try again.

CIL1415 The object cannot be deleted becausethe object is not a folder.

Explanation: The deleteTree service can be used onlyto delete folders.

User response: For more information on the deleteTree

CIL1401 • CIL1415


service, see the OASIS CMIS API specification.

CIL1416 The {operation name} HTTP operation isnot supported on this collection orresource.


User response: For more information about thespecified HTTP operation, see the OASIS CMIS APIspecification.

CIL1417 The service cannot be completedbecause the {object type} object type isnot supported.

Explanation: IBM CMIS does not support the specifiedobject type.

User response: No action is required.

CIL1500 The service cannot be completed.

Explanation: This error can occur for the followingreasons:

v An error in the IBM CMIS application

v An error on the repository

User response: See the HTTP response or theWebSphere Application Server SystemOut.log file formore information and to review the stack trace for theexception.

By default, the SystemOut.log file is in theWAS_profile_location/logs/server/logs subdirectoryof the WebSphere Application Server installationdirectory.

CIL1502 The value, {value}, that was specified forthe {property name} property in theconfiguration file is not valid.

Explanation: See the "Installation and configurationchecklist" in the information center for informationabout the valid values and formats for each property.

User response: Take one of the following actions toresolve the issue:

v If the property is a basic configuration property, runthe configuration program again to rebuild anddeploy the web application EAR file.

v If the property is an advanced configurationproperty, modify the fncmis_advanced.propertiesfile and run the configuration program again torebuild and deploy the web application EAR file.

CIL1503 The syntax of the following entry is notvalid. Configuration file entry: {propertyname}/{value}

Explanation: The syntax property/value is not correct.The correct syntax is property=value.

See the "Installation and configuration checklist" in theinformation center for information about the validvalues and formats for each property.

User response: Take one of the following actions toresolve the issue:

v If the property is a basic configuration property, runthe configuration program again to rebuild anddeploy the web application EAR file.

v If the property is an advanced configurationproperty, modify the fncmis_advanced.propertiesfile and run the configuration program again torebuild and deploy the web application EAR file.

CIL1508 The query cannot be run becausefull-text search is not configured for therepository.

Explanation: To run the query, full-text search must beconfigured on the repository.

User response: Contact your content server systemadministrator to determine whether full-text search isconfigured for the repository.

CIL1510 The service cannot be completedbecause the operation requires anobject, and {path or ID} is not an object.

Explanation: The operation can be performed only foran object.

User response: For more information aboutimplementing the service, see the OASIS CMIS APIspecification.

CIL1511 The service cannot be completedbecause no repositories were found.

Explanation: This error can occur for the followingreasons:

v No repositories are defined on the contentmanagement server.

v IBM CMIS cannot connect to the contentmanagement server because of a networkconnectivity problem.

v The content management server connectioninformation in the IBM CMIS configuration is notcorrect.

v The WebSphere Application Server securityinformation in the IBM CMIS configuration is notcorrect.

v An LTPA key expired.

v An LDAP server is not running or cannot be reachedbecause of a network connectivity problem.

User response: See the WebSphere Application ServerSystemOut.log file for more information.

By default, the SystemOut.log file is in theWAS_profile_location/logs/server/logs subdirectory

CIL1416 • CIL1511


of the WebSphere Application Server installationdirectory.

CIL1513 The query cannot be run because thefollowing error occurred. Query: {querystring} Content server exception:{exception message}

Explanation: An error occurred on the content serverwhen running the query.

User response: See the WebSphere Application ServerSystemOut.log file for more information and to reviewthe stack trace for the exception.


CIL1514 The required property, {property name}, isnot defined in the cmis.propertiesconfiguration file.


User response: Run the configuration program againto specify the missing property and to rebuild anddeploy the web application EAR file.

CIL1515 The SOAP header is missing the localeelement, which is a required element.

Explanation: According to the W3C Web ServicesInternationalization (WS-I18N) standard, theinternational element in a SOAP header must haveexactly one locale element, and the locale element mustbe the first item in the children property of theinternational element.

User response: Add the locale element to theinternational 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 becausethe {object path or object ID} object cannotbe deleted. Content management servererror: {error message}

Explanation: The folder cannot be deleted if the foldercontains an object that cannot be deleted.

User response: Delete the objects in the folderindividually.

You can use an OASIS CMIS service, such asgetChildren or query, to determine the objects that arestill in the folder.

See the content management server documentation forinformation about resolving the error that occurred on

the content management server.

CIL1517 The service cannot be completedbecause the XML input cannot bedeserialized.

Explanation: Either no input was provided or theinput is not a well-formed XML document.

User response: Provide a valid CMIS Atom entry.

For more information about Atom entries, see theOASIS CMIS API specification.

CIL1519 The configuration file, {file name}, cannotbe loaded from the web application.

Explanation: The configuration file might becorrupted or might have been moved or deleted.

User response: Run the configuration program againto rebuild and deploy the web application EAR file.

CIL1524 The folder cannot be deleted becausethe deleteTree service timed out.


User response: To prevent the request from timingout, take one of the following actions:

v Delete smaller folders. For example delete anysubfolders before deleting the parent folder.

v Resubmit the delete request with thecontinueOnFailure property set to true.

CIL1525 The service cannot be completedbecause an error occurred in IBM CMIS.IBM CMIS error: {additional errorinformation}

Explanation: No additional information is available.

User response: Contact IBM Software Support. Beforecalling, ensure that you collect the information that islisted in "Collecting data for IBM CMIS" in theinformation center.

CIL1600 The service cannot be completedbecause a constraint was violated.


User response: For more information aboutimplementing the service, see the OASIS CMIS APIspecification.

CIL1601 The service cannot be completedbecause a value that was specified for aproperty violated a constraint.

Explanation: The value that was specified for aproperty is outside the permitted range or the valueexceeds the maximum length allowed.

CIL1513 • CIL1601


User response: Use the property definition of theobject type to get the valid range and maximum length.

CIL1602 The document cannot be checked outbecause the object ID was not specified.


User response: For more information about theversioning service, see the OASIS CMIS APIspecification.

CIL1603 The object cannot be deleted because itis not a document.



For more information about the versioning service, seethe OASIS CMIS API specification.

CIL1604 The document cannot be createdbecause the {versioning state} versioningstate is not a valid state for the{document type} document type.

Explanation: The specified document type requiresversioning.

User response: Specify a valid versioning parameter.

Contact your content management systemadministrator for information about the versioningrequirements on the repository.

CIL1605 Versioning is disabled for the {documentclass} document class when theversioning state is set to "{versioningstate}".

Explanation: Versioning is disabled for the specifieddocument type.

User response: Specify a valid versioning parameter.


CIL1606 The {document path or document ID}document cannot be checked outbecause versioning is disabled.

Explanation: When versioning is disabled for thedocument type, documents cannot be checked out.



CIL1607 The folder cannot be deleted because itis not empty.

Explanation: The delete operation cannot beperformed for a folder that is not empty.

User response: For more information about deletingfolders, see the OASIS CMIS API specification.

CIL1609 The list of parents cannot be returnedfor the {object path or object ID} objectbecause the object is not a fileableobject.

Explanation: The getObjectParents method returns theparent folders of a fileable object. If an object is notfileable, the getObjectParents method is not valid.

User response: For more information about thegetObjectParents method, see the OASIS CMIS APIspecification.

CIL1610 The document cannot be createdbecause one or more required propertiesare missing.


User response: Specify a value for each requiredproperty and try to create the document again.

Use the document type definition to determine whichproperties are required.

CIL1611 A property cannot be set or modifiedbecause it is read-only.


User response: Use the property definition todetermine which properties can be modified and whichproperties are read-only.

CIL1612 The object cannot be updated becausethe {property name} property is read-only.


User response: Use the property definition todetermine which properties can be modified and whichproperties are read-only.

CIL1613 The service cannot be completedbecause the document does not containa content stream.

Explanation: The service can be completed only fordocuments that contain content streams.

User response: For more information about contentstreams, see the OASIS CMIS API specification.

CIL1602 • CIL1613


CIL1614 The content stream cannot be retrievedbecause the streamId {stream ID} is notvalid.

Explanation: The value that was specified for thestreamId is outside the range of valid streamIds on thecontent server.

User response: Specify the streamId of an existingcontent stream.

For more information about streamIds, see the OASISCMIS API specification.

CIL1615 The service cannot be completedbecause one or more specifiedproperties do not exist for the specifiedobject type.


User response: Use the object type definition todetermine the properties that are available for theobject type.

CIL1616 The service cannot be completedbecause the {property name} property doesnot exist for the specified object type.


User response: Use the object type definition todetermine the properties that are available for theobject type.

CIL1700 The query cannot be completed becausethe filter contains an invalid character.

Explanation: The following characters are not valid:space " ", backslash "\", double backslash "\\", period.".", left parenthesis "(", right parenthesis ")", andapostrophe "'".

User response: Modify the filter to remove the invalidcharacter.

CIL1701 The query cannot be completed becausethe filter contains the following invalidcharacter: {character}.

Explanation: The following characters are not valid:space " ", backslash "\", double backslash "\\", period.".", left parenthesis "(", right parenthesis ")", andapostrophe "'".

User response: Modify the filter to remove the invalidcharacter.

CIL1800 The service cannot be completedbecause the document type that wasspecified does not support contentstreams.


User response: Use the object type definition todetermine whether a document type supports contentstreams.

CIL1900 The service cannot be completedbecause of a storage problem on therepository.

Explanation: There is an issue on the repository thatprevents objects from being created or updated.

User response: See the WebSphere Application ServerSystemOut.log file for more information about the errorthat occurred on the repository.


CIL2000 The contents of the document cannot beupdated because a content streamalready exists and the overwriteFlagparameter is set to false.

Explanation: When the overwriteFlag parameter is setto false, the content cannot be changed.

User response: For more information about updatingthe contents of a document, see the OASIS CMIS APIspecification.

CIL2001 The contents of the following documentcannot be updated because a contentstream already exists and theoverwriteFlag parameter is set to false:{document path or document ID}

Explanation: When the overwriteFlag parameter is setto false, the content cannot be changed.

User response: For more information about updatingthe contents of a document, see the OASIS CMIS APIspecification.

CIL2100 The service cannot be completedbecause the document is not the currentversion.

Explanation: The service can be completed only forthe current version of a document.

User response: Specify the current version of thedocument and try again.

CIL1614 • CIL2100


CIL2102 The document cannot be checked inbecause it is not currently checked out.


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 becauseit is not currently checked out.


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 outbecause it is already checked out.


User response: If the document is checked out byanother user, you must wait until the user checks thedocument in.

CIL2105 The {document path or document ID}document cannot be checked outbecause it is not the current version.



CIL2106 The service cannot be completedbecause the {document path or documentID} document is not the current version.

Explanation: The service can be completed only forthe current version of a document.


CIL2107 The object cannot be moved because itis not the current version.

Explanation: Only the current version of the objectcan be moved from one folder into another.

User response: Specify the current version of theobject and try again.

CIL2200 The object cannot be updated becausethe object is no longer the currentversion.

Explanation: A newer version of the object exists onthe repository.

User response: Specify the current version of theobject and try again.

CIL2300 The object cannot be updated or createdbecause another object with the samename already exists.

Explanation: The object type requires that each objecthave a unique name.

User response: Specify a different name for the object.

Use the object type definition to determine theuniqueness requirements for the object type.

CIL2102 • CIL2300


Removing IBM CMIS for FileNet Content Manager

You can use the uninstallation program or the silent uninstallation command toremove IBM Content Management Interoperability Services for FileNet ContentManager (IBM CMIS) from the workstation where the software is installed.

Important: When you uninstall IBM CMIS, the deployed application is notremoved from WebSphere Application Server. You must manually remove theapplication from WebSphere Application Server.

To uninstall IBM CMIS:

Run the uninstallation program:


AIX At a command prompt, change to theuninstall directory of the IBM CMISinstallation directory and enter one of thefollowing 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 theuninstall directory of the IBM CMISinstallation directory and enter one of thefollowing 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 theuninstall directory of the IBM CMISinstallation directory and enter one of thefollowing commands:

v To use the uninstallation program, enteruninstall.bat

v To use the silent uninstallation command,enter uninstall.bat -s

If you ran the uninstallation program to remove IBM CMIS, complete the followingtasks 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 thefollowing tasks to complete the uninstallation:


1. See the fncmis-uninstall.log file in the log subdirectory of the IBM CMISinstallation directory, to ensure that IBM CMIS was successfully removed fromthe workstation.

2. Manually remove any files that were not removed by the uninstallationprogram.

3. Manually remove the deployed IBM CMIS application from WebSphereApplication Server.“Removing IBM CMIS for FileNet Content Manager from WebSphereApplication Server”

Removing IBM CMIS for FileNet Content Manager from WebSphereApplication Server

When you remove the IBM Content Management Interoperability Services forFileNet Content Manager (IBM CMIS) software from the workstation, the deployedapplication is not removed from WebSphere Application Server. You mustmanually 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.


Accessibility features of IBM CMIS for FileNet ContentManager

IBM Content Management Interoperability Services for FileNet Content Manager(IBM CMIS) includes features that make it more accessible to people withdisabilities.

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 anaccessible information center. The HTML format enables you to viewdocumentation according to the display preferences that are set in your webbrowser. The HTML format also supports the use of screen readers and otherassistive technologies.

The documentation is also available in PDF format.


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 inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBMIntellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan Ltd.1623-14, Shimotsuruma, Yamato-shiKanagawa 242-8502 Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law:INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express orimplied warranties in certain transactions, therefore, this statement may not applyto you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.


IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM CorporationJ46A/G4555 Bailey AvenueSan Jose, CA 95141-1003U.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 materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurements may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

All statements regarding IBM's future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, whichillustrate programming techniques on various operating platforms. You may copy,modify, and distribute these sample programs in any form without payment toIBM, for the purposes of developing, using, marketing or distributing applicationprograms conforming to the application programming interface for the operatingplatform for which the sample programs are written. These examples have notbeen thoroughly tested under all conditions. IBM, therefore, cannot guarantee orimply reliability, serviceability, or function of these programs.


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 themin the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). Thefull Policy may be found at the OASIS website.This document and translations of it may be copied and furnished to others, andderivative works that comment on or otherwise explain it or assist in itsimplementation may be prepared, copied, published, and distributed, in wholeor in part, without restriction of any kind, provided that the above copyrightnotice and this section are included on all such copies and derivative works.However, this document itself may not be modified in any way, including byremoving the copyright notice or references to OASIS, except as needed for thepurpose of developing any document or deliverable produced by an OASISTechnical Committee (in which case the rules applicable to copyrights, as setforth in the OASIS IPR Policy, must be followed) or as required to translate itinto languages other than English.The limited permissions granted above are perpetual and will not be revoked byOASIS 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 OFTHE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIPRIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY ORFITNESS FOR A PARTICULAR PURPOSE.OASIS requests that any OASIS Party or any other party that believes it haspatent claims that would necessarily be infringed by implementations of thisOASIS Committee Specification or OASIS Standard, to notify OASIS TCAdministrator and provide an indication of its willingness to grant patentlicenses to such patent claims in a manner consistent with the IPR Mode of theOASIS Technical Committee that produced this specification.OASIS invites any party to contact the OASIS TC Administrator if it is aware ofa claim of ownership of any patent claims that would necessarily be infringedby implementations of this specification by a patent holder that is not willing toprovide a license to such patent claims in a manner consistent with the IPRMode of the OASIS Technical Committee that produced this specification. OASISmay include such claims on its website, but disclaims any obligation to do so.OASIS takes no position regarding the validity or scope of any intellectualproperty or other rights that might be claimed to pertain to the implementationor use of the technology described in this document or the extent to which anylicense under such rights might or might not be available; neither does itrepresent that it has made any effort to identify any such rights. Information onOASIS' procedures with respect to rights in any document or deliverableproduced by an OASIS Technical Committee can be found on the OASISwebsite. Copies of claims of rights made available for publication and anyassurances of licenses to be made available, or the result of an attempt made toobtain a general license or permission for the use of such proprietary rights byimplementers or users of this OASIS Committee Specification or OASISStandard, can be obtained from the OASIS TC Administrator. OASIS makes norepresentation that any information or list of intellectual property rights will atany time be complete, or that any claims in such list are, in fact, EssentialClaims.The names "OASIS", “CMIS” are trademarks of OASIS, the owner and developerof this specification, and should be used only to refer to the organization and itsofficial outputs. OASIS welcomes reference to, and implementation and use of,

Notices 85

specifications, while reserving the right to enforce its marks against misleadinguses. Please see http://www.oasis-open.org/who/trademark.php for aboveguidance.“Trademarks”

Trademarks

The following terms are trademarks of the International Business MachinesCorporation 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 registeredtrademarks or trademarks of Adobe Systems Incorporated in the United States,and/or other countries.

Microsoft, Windows, and Windows NT are trademarks of Microsoft Corporation inthe United States, other countries, or both.

Java and all Java-based trademarks and logos are trademarks or registeredtrademarks of Oracle and/or its affiliates.

Linux is a registered trademark of Linus Torvalds in the United States, othercountries, or both.

Other company, product, and service names may be trademarks or service marksof others.


http://www.ibm.com/legal/copytrade.shtml

http://www.ibm.com/legal/copytrade.shtml

Index

Aaccessibility features 81API

OASIS CMIS specification 55architecture overview 3

CChoiceListDisplayName

See extensionsChoiceListSymbolicName

See extensionsClassDisplayName

See extensionsCMIS

LTPA, configuring 36SSO

LTPA, configuring 36SSO, configuring 35

CMIS APIsdeveloping with 53

best practices 63CMIS client APIs

resources 55collecting data

IBM CMIS 67collecting troubleshooting data 67configuration

advanced properties 30buffer length 33checkout_copycontent 34CMC_TIME_TO_LIVE 31cmisURI 33CRC_TIME_TO_LIVE 31CVL_Cache 32defaultMaxItems 34filterHiddenProperties 32queryTimeLimit 34SecureMetadataCache 35

configuration tool 25IBM CMIS 25

advanced properties 30buffer length 33checkout_copycontent 34CMC_TIME_TO_LIVE 31cmisURI 33configuration tool 25CRC_TIME_TO_LIVE 31CVL_Cache 32defaultMaxItems 34filterHiddenProperties 32queryTimeLimit 34SecureMetadataCache 35web application 25

logging 39log location 41log size 41

planning for 8advanced configuration 15interactive configuration 9

configuration (continued)planning for (continued)

silent configuration 11silent configuration 27web application, creating 25worksheets 8

advanced configuration 15interactive configuration 9silent configuration 11

configuration tooldeployment 47

controlled vocabulary listssecurity, support for 7

CVLssecurity, support for 7

Ddeploying 47deployment

configuration tool 47IBM CMIS 47IBM CMIS application 47

manual deployment 50silent configuration 48

manual deployment 50, 51generic JVM arguments 50policy sets 51

silent configuration 48DomainName

See extensions

Eerror messages 69extensions 56

choice list display name 57choice list symbolic name 57ChoiceListDisplayName 57ChoiceListSymbolicName 57class display name 56ClassDisplayName 56domain name 57DomainName 57GZIP compression 59hidden properties 57isHidden 57object store database type 58object store ID 58ObjectStoreDBType 58ObjectStoreID 58records management extension 58RecordsManagementEnabled 58text search engine 59TextSearchEngine 59

Ggeneric JVM arguments

manual deployment 50

GZIP compressionSee extensions

Hhardware requirements

IBM CMIS 5

IIBM CMIS 1, 8, 9, 11

accessibility features 81architecture overview 3behaviors 59error messages 69extensions 56

choice list display name 57choice list symbolic name 57ChoiceListDisplayName 57ChoiceListSymbolicName 57class display name 56ClassDisplayName 56domain name 57DomainName 57GZIP compression 59hidden properties 57isHidden 57object store database type 58object store ID 58ObjectStoreDBType 58ObjectStoreID 58records management extension 58RecordsManagementEnabled 58text search engine 59TextSearchEngine 59

index page 53service collection URLs 54URI templates 55

language support 7limitations 59

cmis:changeToken property 60cmis:checkinComment

property 63paging of feeds 61private working copy links 60queries 61

log files 65planning for 5prerequisites 5removing 79

deployed application 80service documents 53

service collection URLs 54URI templates 55

troubleshooting 65uninstalling 79

IBM CMIS implementations 59cmis:changeToken property 60cmis:checkinComment property 63paging of feeds 61


IBM CMIS implementations (continued)private working copy links 60queries 61

IBM CMIS, configuring 25advanced properties 30

buffer length 33checkout_copycontent 34CMC_TIME_TO_LIVE 31cmisURI 33CRC_TIME_TO_LIVE 31CVL_Cache 32defaultMaxItems 34filterHiddenProperties 32queryTimeLimit 34SecureMetadataCache 35

configuration tool 25log location 41log size 41logging 39silent configuration 27web application 25

IBM CMIS, installing 19Content Engine Client files 22installation program 20silent installation 21software 19

index page 53service collection URLs 54URI templates 55

installationContent Engine Client files 22IBM CMIS 19IBM CMIS installation program 20IBM CMIS software 19IBM CMISsilent installation 21planning for 8

interactive installation 9silent installation 11

worksheets 8interactive installation 9silent installation 11

interactive configurationplanning for 9worksheets 9

interactive installationplanning for 9worksheets 9

isHiddenSee extensions

Llanguages

IBM CMIS 7LDAP

configuring 38limitations

cmis:changeToken property 60cmis:checkinComment property 63paging of feeds 61private working copy links 60queries 61

log files 65log4j.properties 43

sample 43logging

configuring 39

logging (continued)Content Engine API client

logging 43log location 41log size 41

Log4J 43logged errors 42WebSphere Application Server logging

levels 40LTPA

configuring 36key, exporting 37key, generating 36key, importing 37

LTPA keyexporting 37generating 36importing 37

Mmanual deployment 51

OOASIS CMIS

resources 55OASIS CMIS APIs

developing with 53best practices 63

OASIS CMIS specification 55object types

controlled vocabulary listssecurity, support for 7

CVLssecurity, support for 7

ObjectStoreDBTypeSee extensions

ObjectStoreIDSee extensions

Pplanning for 8, 9, 11policy sets

manual deployment 51WS-Security 51

prerequisitesIBM CMIS 5

RRecordsManagementEnabled

See extensionsremoving

deployed application 80resources

CMIS client APIs 55OASIS CMIS 55

Ssamples

log4j.properties 43

securityplanning for 6

server configuration 6server topology 6service documents 53

service collection URLs 54URI templates 55

silent configurationdeployment 48planning for 11worksheets 11

silent installationplanning for 11worksheets 11

Single sign-on (SSO)configuring 35

software requirementsIBM CMIS 5

supported languagesIBM CMIS 7

TTextSearchEngine

See extensionstroubleshooting

collecting dataIBM CMIS 67

error messages 69IBM CMIS 65

error messages 69log files 65

log files 65

Uuninstallation 79user authentication

planning for 6

Wweb application, creating 25

configuration tool 25WebSphere Application Server

planning for 5WebSphere Application Server Network

Deploymentplanning for 5

worksheetsadvanced configuration 15configuration 8installation 8interactive configuration 9interactive installation 9silent configuration 11silent installation 11


��

Program Number: 5724-R81

SC19-3220-00

CMIS c1932200

Documents

Transcript of CMIS c1932200