Page tree
Skip to end of metadata
Go to start of metadata
Celum DAM Connector provides a connector to  Celum  to use assets form this service. It provides an app to browse and add/remove images, and a dialog to use this images/videos into your website.

Installation

Maven is the easiest way to install the module. Add the following dependency to your bundle:

<dependency>
  <groupId>info.magnolia.external.dam</groupId>
  <artifactId>celum-dam-connector</artifactId>
  <version>${version}</version>
</dependency>
<!-- the following dependency will be needed in your webapp pom since the api-remote-with-dependencies does not include 
     org.springframework.util.assert needed by the api --!>
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-core</artifactId>
    <version>5.3.7</version>
</dependency>

To be able to use CELUM remote api (api-remote-3.5.0-jar-with-dependencies.jar), it has to be available in your maven (i.e. company Nexus) repository or you will have to install it manually into your local repository.

mvn install:install-file -Dfile=<path-to-file>/api-remote-3.5.0-jar-with-dependencies.jar -DgroupId=com.celum -DartifactId=api-remote -Dversion=3.5.0-jar-with-dependencies -Dpackaging=jar

Versions

1.0Magnolia 6.2.8

Usage

You will need an account to connect to CELUM, that account is created in CELUM Configuration Management Application (CMA).


Depending on your needs, you might want to add access to the API user to some asset types, that will be done on CELUM app server in the administration feature. 

Configuration

rootNodeId

mandatory

Provides the root node id for the tree view.

connectionString

mandatory

Defines the connection string to CELUM remote API. i.e. 

http://host/api

clientId

mandatory

Remote clientId. Can be a path from the passwords app. i.e. /celum-credentials/clientId

clientSecret

mandatory

Client secret. Can be a path from the passwords app. i.e. /celum-credentials/clientSecret

serverSecret

mandatory

Server secret. Can be a path from the passwords app. i.e. /celum-credentials/serverSecret

credentialsPath

optional

Is the Passwords app path where we want to listen for credentials changes.

Default: /celum-credentials/

defaultLocale

optional

Locale to be used by default when getting Celum node names, defaults to "en".

propertyMap:

  title: somepropame

  description: somepropame

  copyright: somepropname

  subject: somepropname

  caption: smepropname

  language: somepropname

  comment: somepropname

optional

Is a map of properties that maps the properties in the Magnolia asset object to properties in the fileProperties of the Celum remote asset. There are some extra properties provided by fileProperties in Celum asset that are automatically available to be used in dialogs, no need to declare them here.

In order to use the Passwords app to store the credentials for the remote connection to Celum, you need to create the folder with the items and set the paths in the config.yaml or the JCR configuration of the Celum connector module.

Sample of config.yaml


rootNodeId: 1111
connectionString: http://localhost:8765/api
clientId: /celum-credentials/clientId
clientSecret: /celum-credentials/clientSecret
serverSecret: /celum-credentials/serverSecret

propertyMap:
  title: title
  copyright: autor
  description: pages
  subject: subject
  caption: caption
  language: sprache
  comment: comment


Deactivate Netty logs


Add the following lines to the log configuration file in your log properties file:
log4j2.xml


<!-- External libraries -->
<!-- Netty -->
<Logger name="io.netty" level="INFO"/>


Warnings

  • This module is at INCUBATOR level.

Changelog

  • Version 1.0 - Initial release of the extensions version of the module.
    • Put links to relevant tickets to help others