Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrate text box

Table of contents

Table of Contents

Description

The Blueriq CMIS Client component makes it possible to connect to Document Management Systems that implement the CMIS (Content Management Interoperability Services) standard like Alfresco Document Management System and IBM FileNet.

UI Text Box
type
Info

The CMIS Spec 1.1 is supported. For the binding type only atompub is supported.

...

Requirements

N/A

Installation

Unzip the CMIS-Plugin-x.y.z.zip and add the extracted jar to the classpath of your application. Also place the *.properties files in your blueriq config location. 

The plugins can be found in the installation package:

  • Java - runtime\Java\Webapp\Plugins
  • .NET - runtime\.Net\Webapp\

When the plugins are installed and configured in the right way, they will be shown in the runtime dashboard in the "Installed plugins" overview.

Configuration

UI Expand
titleJava

Go to the directory Blueriq\Runtime\aquima.home and configure the right properties as they are made in the DMS.

Below you will find an example how to configure:

cmis.user=xxx

cmis.password=xxx

cmis.servicesUrl=http://aq-acc:9080/alfresco/cmisatom

cmis.repositoryId=14f2517f-fb35-4d86-821e-2d0b37929f72

cmis.objectTypeId=D:br:documentOne

cmis.bindingType=atompub

# Set this property only if you want to override the default BASIC (cmis.user, cmis.password) authentication with a custom authentication mechanism

cmis.authProvider.class=com.somecompany.plugin.cmis.impl.SomeCustomAuthenticationProvider

# The following setting lets you choose if you want to treat path and filename combinations as unique. For systems such as FileNet, when setting this to false, then it is possible to create two files with different Ids on the same path and filename combination. The default setting is true.

cmis.uniquePathFilename=[true|false]

Add the artifact with groupId com.blueriq and artifactId blueriq-component-cmis-client as a dependency to your Blueriq runtime POM file.

In order to use this component, the 

Include Page
_ProfileCMIS
_ProfileCMIS
profile must be active. More information on how to configure the application using Spring Profiles can be found here : Application configuration with Spring Profiles

Configuration

The following properties in the

Include Page
_PropertiesCMIS
_PropertiesCMIS
are used to configure the cmis component:

<cmis user="xxx"           password="xxx"           serviceUrl="http://aq-acc:9080/alfresco/cmisatom"           repositoryId="2f074dcf-fb38-4536-801b-910ecc547e59"           objectTypeId="D:br:documentOne"           bindingType="atompub" />
Code Block
languagexml
titleCMIS configuration
# the user to connect to CMIS
blueriq.cmis.user=
# the password to connect to CMIS
blueriq.cmis.password=
# the URL of the CMIS service
blueriq.cmis.services-url=
blueriq.cmis.repository-id=
blueriq.cmis.object-type-id=
blueriq.cmis.binding-type=atompub


# JWT authentication provider
blueriq.cmis.authProviderClassName=com.blueriq.component.cmis.client.impl.jwt.JwtAuthenticationProvider


# JWT authentication provider properties
## URL pointing to key store containing RSA private/public keys for JWT signing
blueriq.cmis.authProviderConfiguration.jwt.ks.fileUrl=file:///D:/some_dir/jwt/keystore.jks
## key store password
blueriq.cmis.authProviderConfiguration.jwt.ks.password=
## alias of key that Blueriq should use for JWT signing
blueriq.cmis.authProviderConfiguration.jwt.ks.blueriqKeyAlias=
## password for key that Blueriq should use for JWT signing
blueriq.cmis.authProviderConfiguration.jwt.ks.blueriqKeyPassword=
## standard 'issuer' claim to put in Json Web token
blueriq.cmis.authProviderConfiguration.jwt.claims.iss=
## standard 'audience' claim to put in Json Web token
blueriq.cmis.authProviderConfiguration.jwt.claims.aud=
## standard 'subject' claim to put in Json Web token
blueriq.cmis.authProviderConfiguration.jwt.claims.sub=
## custom claim to put in Json Web token
blueriq.cmis.authProviderConfiguration.jwt.claims.idp=
## JWT claim name to put the Blueriq user id in
blueriq.cmis.authProviderConfiguration.jwt.blueriqUser.id.claimName=
## JWT claim name to put the CMIS connector id in
blueriq.cmis.authProviderConfiguration.jwt.cmisConnector.id.claimName=
UI Expand
title.NET

Open the Web.config file and place the following line between the configSections tags. 

Code Block
languagexml
titleCMIS configuration section
<section name="cmis" type="Aquima.Plugin.Cmis.Config.CmisConfigurationSectionHandler"/>

Hereafter add the following lines between the configuration tags with the correct property values.

 

Code Block
languagexml
titleCMIS connection configuration

Usage

In how to setup a CMIS connection an example is worked out for using this component.

Troubleshooting

N/A

See also

Service call type: AQ_CMIS_DocumentManagerAQ_Web_FileUpload

How to setup a CMIS connection