MediaValet DAM connector
Digital asset management (DAM) Incubator Version 2.0.0 Magnolia 6.3 compatible [1]
The MediaValet DAM connector provides a connector to MediaValet to use assets form this service. It incorporates MediaValet Media browser widget that allows users to select assets to be included in the website.
Installing with Maven
Maven is the easiest way to install the module. Add the following to your bundle:
<dependency>
<groupId>info.magnolia.external.dam</groupId>
<artifactId>mediavalet-dam-connector</artifactId>
<version>2.0.0</version>
</dependency>
<dependency>
<groupId>info.magnolia.external.dam</groupId>
<artifactId>mediavalet-media-widget-integration</artifactId>
<version>2.0.0</version>
</dependency>Configuration
To use this module you need to have exiting account with MediaValet. From your mediaValet account you need below information:
-
clientId -
clientSecret -
subscriptionKeyPrimary -
scope -
domain -
username -
password -
publicUrl
This information should be added to the config.yaml file in the resources folder (or it can be overridden from light-modules). Please check screenshot below:
clientId: MEDIAVALET_CLIENT_ID
clientSecret: MEDIAVALET_CLIENT_SECRET
scope: MEDIAVALET_SCOPE
subscriptionKeyPrimary: MEDIAVALET_SUBSCRIPTION_KEY_PRIMARY
domain: MEDIAVALET_DOMAIN
username: /mediavalet/username
password: /mediavalet/password
publicUrl: MEDIAVALET_PUBLIC_URL
Magnolia will try to register MediaValet webhook when this module starts. Webhook registration on module start should happen only if mediaValet webhook is not registered previously and if you have provided valid publicUrl.
Alternatively magnolia will listen for any change in the module configuration folder (/modules/mediaValet-dam-connector/config) and in the keystore workspace. For any change in these folders magnolia will register new MediaValet webhook.
Webhook registration is done only on author instance. So, only author instance will get notifications from MediaValet for the file updates.
-
update
-
delete actions.
| For each notification that author instance receives, mediaValet JCR cache will be updated and this JCR changes will be propagated (published) to public instance(s). |
| To use the MediaValet Widget, your domain must be approved by MediaValet. Contact them to whitelist your domain. |
Each http request that magnolia author instance receives from mediaValet is checked to make sure that request comes from MediaValet.
This security check is done based on secret token that is received from MediaValet when webhook is registered. This webhook secret is saved in the "mediavalet-media" workspace.
Usage of the mediaValetWidgetField
You can use magnolia field in any dialog:
form:
implementationClass: info.magnolia.ui.javascript.form.FormViewWithChangeListener
properties:
image:
label: MediaValet Image
$type: mediaValetWidgetFieldAfter opening magnolia dialog and clicking on select image button, you should be presented with mediaValet widget select dialog.
