eXo Platform 3.5

## Chapter 2. Configuration

This chapter presents you all the information related to configuration of CMIS via the following topics:

- CMIS Configuration

- Required nodetypes and namespaces in JCR

- Authenticator and organization service configuration

- CMIS search and index

## CMIS Configuration

To expose WCM drives to the CMIS repositories, you must make a special extension of CmisRegistry.

To make a typical component org.exoplatform.ecms.xcmis.sp.jcr.exo.DriveCmisRegistry, do as follows:

    <component>

       <type>org.exoplatform.ecms.xcmis.sp.jcr.exo.DriveCmisRegistry</type>

       <init-params>

          <!-- Disabled by default. Uncomment if you need query support in CMIS. -->

             <!-- value-param>

                <name>indexDir</name>

                <value>${gatein.jcr.index.data.dir}/cmis-index${container.name.suffix}</value>

             </value-param-->

          <value-param>

             <name>exo.cmis.renditions.persistent</name>

             <value>true</value>

          </value-param>

          <values-param>

             <name>renditionProviders</name>

             <description>Redition providers classes.</description>

             <!-- <value>org.xcmis.renditions.impl.PDFDocumentRenditionProvider</value> -->

             <value>org.xcmis.renditions.impl.ImageRenditionProvider</value>

          </values-param>

       </init-params>

    </component>

Where configuration parameters include:

- indexDir: the directory where the lucene index will be placed. It is disabled by default.

- exo.cmis.renditions.persistent: indicates if a rendition of the document (thumbnails) should be persisted in the JCR. The allowed value are true or false.

- renditionProviders: a set of FQN of classes which can be used as Rendition Providers. Classes which implement the org.xcmis.spi.RenditionProvider interface used to preview the CMIS objects (thumbnails).

### Note

In most cases, it is not required to change anything in the xCIMIS configuration. In case of any change of the indexer storage location, do not comment the indexDir value parameter and point it to the actual location.

## Required nodetypes and namespaces in JCR

The following configuration is mandatory for JCR to work correctly:

    <external-component-plugins>

       <target-component>org.exoplatform.services.jcr.RepositoryService</target-component>

       <component-plugin>

          <name>add.namespaces</name>

          <set-method>addPlugin</set-method>

          <type>org.exoplatform.services.jcr.impl.AddNamespacesPlugin</type>

          <init-params>

             <properties-param>

                <name>namespaces</name>

                <property name="cmis" value="http://www.exoplatform.com/jcr/cmis/1.0"/>

                <property name="xcmis" value="http://www.exoplatform.com/jcr/xcmis/1.0"/>

             </properties-param>

          </init-params>

       </component-plugin>

       <component-plugin>

          <name>add.nodeType</name>

          <set-method>addPlugin</set-method>

          <type>org.exoplatform.services.jcr.impl.AddNodeTypePlugin</type>

          <init-params>

            <values-param>

                <name>autoCreatedInNewRepository</name>

                <description>Node types configuration file</description>

                <value>jar:/conf/cmis-nodetypes-config.xml</value>

             </values-param>

          </init-params>

       </component-plugin>

    </external-component-plugins>

## Authenticator and organization service configuration

An authenticator is responsible for creating Identity Security Service Authenticator.

The eXo CMIS service is based on:

- The authentication mechanism provided by the eXo organization service.

- The JAAS configuration of eXo Platform. For example:

    gatein-domain {
      org.exoplatform.web.security.PortalLoginModule required;
      org.exoplatform.services.security.jaas.SharedStateLoginModule required;
      org.exoplatform.services.security.j2ee.TomcatLoginModule required;
    };

## CMIS search and index

The CMIS standard defines a query language based on a subset of the SQL-92 grammar (ISO/IEC 9075: 1992 -- Database Language SQL), with a few extensions to enhance its filtering capability for the CMIS data model, such as existential quantification for multi-valued property, full-text search, and folder membership.

### Warning

CMIS search is disabled by default in eXo CMIS. Uncomment the indexDir parameter if you need the query support in CMIS. To discover the search capability, check the capabilityQuery property (see the table below).

### CMIS Relational View

The relational view of a CMIS repository consists of a collection of virtual tables that are defined on the top of the CMIS data model. A virtual table exists for every queryable object type (content type if you prefer) in the repository. Each row in these virtual tables corresponds to an instance of the corresponding object type (or one of its subtypes). A column exists for every property that the object type has.

### Query Capabilities

Capability | Value
--- | ---
capabilityQuery | `bothcombined` (if indexDir is configured, otherwise `none`)
capabilityJoin | `none`
capabilityPWCSearchable | `false`
capabilityAllVersionsSearchable | `false`

### Configuration

To be able to provide full-text search capabilities, xCMIS uses its own index. The following is the configuration parameter:

Parameter | Default | Description
--- | --- | ---
indexDir | none | The location of the index directory. This parameter is mandatory for the default implementation.

This parameter is passed through the XML configuration.

For example, to set up the index directory:

    <component>

       <type>org.exoplatform.ecms.xcmis.sp.DriveCmisRegistry</type>

       <init-params>

             <!-- Disabled by default. Uncomment if you need query support in CMIS. -->

             <!-- value-param>

                <name>indexDir</name>

                <value>${gatein.jcr.index.data.dir}/cmis-index${container.name.suffix}</value>

             </value-param-->

             ..............

       </init-params>

    </component>

### Index atomicity and durability

- Write-ahead logging

To be able to provide index consistency and recovery in case of unexpected crashes or damages, XCMIS uses write-ahead logging (WAL) technique. Write-ahead logging is a standard approach to transaction logging. Briefly, WAL's center concept is changes of data files (indexes) must be written only after those changes have been logged, that is, when the change log records have been flushed to permanent storage. If you follow this procedure, you do not need to flush data pages to disk on every transaction commit, because it is known in the event of a crash, and the index can be recovered by using the log: any changes that have not been applied to the data pages can be redone from the log records. (This is roll-forward recovery, also known as REDO.)

A major benefit of using WAL is a significantly reduced number of disk writes, because only the log file needs to be flushed to disk at the time of transaction commit, rather than every data file changed by the transaction.

- Recover uncommitted transaction

When you start Indexer, it will check uncommitted transaction logs. If at least one log exists, recovering process will be started. Indexer will read all logs and extract added, updated and removed UUIDs into a set. Then, indexer walks through this set and checks objects against UUID. If the object exists, the indexer will put it into the added document list. In other cases, UUID will be added to the removed documents list. After that, depending on the list of added and removed documents, changes will be applied to the index.

- Initial index population

When you run the indexer to check the number of documents in the index. If there are no documents in the index or the previous re-indexation was not successful, then re-indexation of all content will be started. The first step is cleaning old index data. Uncommitted transaction logs and old persistent data are removed. These data are useless, because re-indexation of all content will be started. Then indexer walks throw all objects and makes lucene document for each one. Then batches with less than 100 elements will be saved to the index. After re-indexation, all logs (WAL) will be removed, all data mentioned on these change logs are already indexed.

### Note

If the administrator gets an exception with the message "Can't remove reindex flag.", it means that the index restoring was finished but file-flag was not removed (see index directory, file named as "reindexProcessing"). You can manually remove this file-flag, and avoid a new reindex of repository on the JCR start.

Copyright © 2009-2012. All rights reserved. eXo Platform SAS