Interwoven Connector

You are reading the CRX 2.3 version of Interwoven Connector.

Caution

This page may be out of date for versions after CQ 5.5. It has not been tested.

The CRX Connector for Interwoven TeamSite belongs to Day's CRX connector family. CRX is Day's Content Repository Extreme (CRX), which fully implements the Content Repository API for Java Technology (JCR). The Interwoven TeamSite connector implements a portion of the JCR interface, enabling applications to read, search and observe changes in the Interwoven TeamSite repository using the JCR API.

Making your TeamSite repository JCR compliant consists of the following steps: 

  • Installing and configuring the CRX repository used as framework for the Interwoven TeamSite connector.
  • Installing the Interwoven TeamSite connector.
  • Configuring the Interwoven TeamSite connector.

Features

The CRX Connector for Interwoven TeamSite includes the following functionality: 

  • Read from the Interwoven TeamSite repository via the Interwoven OpenAPI.
  • Execute queries on the TeamSite repository.
  • Apply Access Control Lists (ACLs) from TeamSite to content extracted from TeamSite.
  • Observe user and content changes that occur in the TeamSite repository.

Supported Platforms

The connector runs on the following operation systems: 

  • Windows Server 2000, 2003.
  • Red Hat Enterprise Linux Advanced Server 3 and 4.
  • Solaris 9 and 10.

The connector supports Interwoven TeamSite version 6.5.

About the Interwoven TeamSite Connector

The Interwoven TeamSite connector extracts content from a Interwoven TeamSite repository and submits it to a JCR based application or a JCR adapter. The architecture is as follows:


You can use the connector the following purposes: 

  1. Read information about users, groups, group memberships, and content (including access control lists) stored in the TeamSite repository.
  2. Search content stored in the TeamSite repository.
  3. Repository Full scan: Extracts the entire content and all users, groups and group memberships, so that an external application can process this information.
  4. Incremental updates: Registered applications receive a notification when content, user and permission are updated. You can configure the notification frequency.

Reading from the TeamSite Repository

The connector maps TeamSite files and folders to the JCR file and folder node types. The connector accesses the TeamSite repository through the Interwoven OpenAPI interface.

Executing Queries on the TeamSite Repository

The connector supports queries on the TeamSite repository. It converts TeamSite query results into JCR query results.
For example, the following query
//element(*,nt:file)
        

returns all files in the TeamSite repository. 

The Interwoven connector supports a partial mapping of the JCR query model to the Interwoven XML query feature. The currently supported query functions are: 

  • Exact property matches: =
  • Relative property matches: < > <= >= !=
  • Full text matches: jcr:contains(), using the Interwoven CONTAINS syntax.
  • Node type matches: element(*, ...)
  • Boolean predicates: or, and, not.

Apply Access Control Lists (ACL) from TeamSite to Content Extracted from TeamSite

All TeamSite ACLs are read from the TeamSite repository and converted into JCR permissions accessible through the JCR API.

Repository Full Scan

Depending on the data volumes, full scan time requirements and the available hardware infrastructure, the connector can run in one or more instances. The latter configuration enables full scan partitioning based on configurable views on the TeamSite repository.

Incremental Updates (Content, Users, Permissions)

Content Updates

The connector periodically checks for content updates in the TeamSite repository (modified, created or deleted files and folders). You can configure the frequency of these checks. The connector converts the updates into JCR events, which you can use to trigger an incremental content update in registered applications.

User and Permission Updates

The connector periodically checks for user and permission updates in the TeamSite repository (users, groups and group memberships). You can configure the frequency of these checks. The connector converts the updates into JCR events, which you can use to trigger an incremental content update in registered applications.

Node Type Mapping

The Interwoven content model consists of a versionable file system 

hierarchy with a few organizational levels (projects, workareas, and so on) at the top. This content model is mapped by the Interwoven connector to subtypes of the JCR nt:hierarchyNode node type. 

The current mapping is: 

  • IWFSServiceRoot -> nt:folder
  • IWStorePathNamedObject -> nt:folder
  • IWBranch -> nt:folder
  • IWFile -> nt:hierarchyNode
  • IWDir -> nt:folder
  • IWSimpleFile -> nt:file (containing an nt:resource as jcr:content)
  • IWSymLink -> iw:symlink
  • IWHole -> iw:hole
  • IWArea -> nt:folder
  • IWDynamicArea -> nt:folder
  • IWWorkArea -> nt:folder
  • IWStaging -> nt:folder
  • IWSnapshot -> nt:folder
  • IWEdition -> nt:folder

Installation

Requirements

The connector requires the following: 

  • Java Runtime Environment 1.4.2 or later
  • Day Content Repository Extreme 1.2 (CRX 1.2) or later
  • Interwoven OpenAPI 6.5 jar file (openapi_client.jar)
  • Interwoven TeamSite connector 1.2

Setting Up CRX

Installing CRX

Install CRX 1.2 following the instructions in the CRX Installation Guide.

Unpacking the CRX Web Archive

To install the connector, you need to unpack the CRX Web archive, so you can access its contents individually. Proceed as follows: 

  1. Go to the /server/webapps directory.
  2. Rename the archive file crx.war to crx_ori.war.
  3. Create a new folder named crx.war.
  4. Extract the archive crx_ori.war to the folder crx.war.

Installing the Interwoven TeamSite Connector

The crx2interwoven connector comes as an archive file that contains all the necessary installation files.
Before you can install the files, unpack the archive file into a temporary folder, as follows:

Adding the Library files

The connector requires two library files: 

  • crx2interwoven-1.2.jar, which you find in the connector’s /lib folder.
  • openapi_client.jar, which you find in the Interwoven TeamSite installation folder. The file may contain a version number, such as openapi_client-6.5.0.jar.

Add these files to the folder /server/webapps/crx.war/WEB-INF/lib of your CRX installation folder.

Note

Note: To install the files in the crx.war folder, you need to unpack the compressed crx.war archive file into a folder named “crx.war”. See above for step-by-step instructions.

Adding the Connector Configuration File

The connector stores its settings in the file interwoven.properties. The connector folder contains a sample file, which you can adapt to your needs (see below). To add the sample file, copy it to the folder /server/etc in your CRX installation folder.

Adding the Workspace Files

The connector stores the data from Interwoven in a separate workspace, which is named crx.interwoven. To add that workspace to CRX, proceed as follows:
1. Copy the folder crx.interwoven from the folder etc of the connector to the folder server/crx/workspaces of the CRX installation folder.

Adding the Log-In Module and Configuration File

The connector uses the same JAAS (Java Authentication and ) authentication infrastructure as Interwoven TeamSite. For this, you have to add the InterwovenLoginModule and its configuration file as follows:
  1. Copy the file interwoven_login.conf from the connector folder to the folder server/etc of your CRX installation folder.
  2. Open the Communiqué manager. Double-click the CRX installation you want to use with the connector. The Configure Instance window opens.
  3. In the VM Options field, add the option “Djava.security.auth.login.config=etc/interwoven_login.conf” in front of the -jar option. Make sure to start with a dash and separate the entry with a space from the one before and after.

Note

Note: If you start CRX with a batch file, add the option to the start command in the batch file.

Configuration

This section tells you how to configure the connector to your needs. If you have followed the instructions so far, all the configuration files are in place, and you can edit them using a standard text editor.

Interwoven TeamSite Connector

To edit the connector configuration, edit the file interwoven.properties in the folder server/etc of the CRX installation folder. The file looks as follows:
# Example interwoven.properties file
# Locations of the Interwoven OpenAPI services
com.day.crx.interwoven.service.access=//locahost/IWAccessService
com.day.crx.interwoven.service.filesys=//locahost/IWFileSysService
com.day.crx.interwoven.service.search=//locahost/IWSearchService
# Interwoven user account information
com.day.crx.interwoven.username=guest
com.day.crx.interwoven.password=secret
com.day.crx.interwoven.role=author
# The Interwoven path to be mounted as /iw:content
com.day.crx.interwoven.root=//localhost/default/main
# The depth of the mounted content tree (-1 is unlimited)
com.day.crx.interwoven.depth=-1
# Observation listener interval (seconds)
com.day.crx.interwoven.interval=300
# JNDI naming provider that contains the CRX repository
java.naming.provider.url=http://jcr.day.com
java.naming.factory.initial=com.day.util.jndi.provider.MemoryInitialContextFactory
# JNDI name of the CRX repository
com.day.crx.repository=crx
# Name of the Interwoven workspace within the repository
com.day.crx.workspace=crx.interwoven
        
Make sure that the settings in this file correspond to your Interwoven TeamSite connection. The parameters are as follows:

Interwoven OpenAPI Service Location

  • com.day.crx.interwoven.service.access:
    The URL that points to the RMI access point for the Interwoven OpenAPI access service.
  • com.day.crx.interwoven.service.filesys:
    The URL that points to the RMI access point for the Interwoven OpenAPI file system service.
  • com.day.crx.interwoven.service.search:
    The URL that points to the RMI access point for the Interwoven OpenAPI search service.

Interwoven User Account

  • com.day.crx.interwoven.username:
    The user name of the user account that the connector uses.
  • com.day.crx.interwoven.password:
    The password of the user account that the connector uses.
  • com.day.crx.interwoven.role:
    The role of the user account that the connector uses.

Others

  • com.day.crx.interwoven.root:
    The Interwoven content path that is mounted as /iw:content.
  • com.day.crx.interwoven.depth: The depth of the tree that the connector maps to the CRX repository. Use -1 to map the entire tree.
  • com.day.crx.interwoven.interval: The amount of seconds between checks for content updates.

Internal

The following settings are internal. Do not modify them. 

  • java.naming.provider.url
  • java.naming.factory.initial
  • com.day.crx.repository
  • com.day.crx.workspace

Workspace Configuration

If you have followed the instructions, you have created a workspace folder, which contains a default configuration file for the workspace crx.interwoven. Usually, you do not have to modify this file.

JAAS Configuration

To configure the Java Authentication and Authorization service (JAAS), edit the file interwoven_login.conf in the folder server/etc of the CRX installation folder.
com.day.crx {
    com.day.crx.security.CRXLoginModule sufficient;
    com.day.crx.interwoven.security.InterwovenLoginModule required
        principal_provider.class="com.day.crx.interwoven.security.InterwovenPrincipalProvider"
        principal_provider.name="interwoven"
        configurationPath="interwoven.properties";
};
        

Usually, you do not have to edit the settings in this file, except for the following parameter: 

  • sync_interval: The interval in seconds in which the connector checks for updates on the Interwoven TeamSite repository. The default is 3600, so the connector checks once every hour.

Copyright, Licenses, Disclaimers

This section lists all licenses, copyright notices and disclaimers which must be explicitly stated in connection with the CRX Connector for Interwoven TeamSite.

CRX Connector for Interwoven TeamSite

The CRX Connector for Interwoven TeamSite is covered by the following license. This includes the following libraries included with the product:

  • crx2interwoven-1.2.jar
CRX Content Repository Extreme (r) Connector for Interwoven TeamSite ("the 
Software"). By installing the Software you agree to the following terms and 
conditions.

This Software is protected by copyright law and international treaties. This
Software is licensed (not sold), and its use is subject to a separate license
agreement between you and Day or Day's authorized resellers. By installing the
Software you confirm to be an authorized user of the software in accordance
with such license agreement. The unauthorized use, copying or distribution of
this Software may result in severe criminal or civil penalties, and will be
prosecuted to the maximum extent allowed by law.

Remote Verification. You acknowledge and agree that the Software may contain
verification and reporting functionality that allows the remote reporting of
your usage of the Software for the purpose of verifying your compliance with
these terms and conditions. If remote verification reveals that you are using
the Software in violation of these terms and conditions, you agree to cease
such unauthorized use and to pay Day's reasonable expenses and a penalty fee
associated with such remote verification and your unauthorized use.

DAY, the DAY logo, Communique, ContentBus and CRX Content Repository Extreme
are registered trademarks and service marks, or are trademarks and service
marks, of Day Management AG, Switzerland, in various countries around the world.

All other product names and company logos mentioned in the information,
documents or other items provided or available herein may be the trademarks of
their respective owners.