After installation of the NuGet package, a new "digizuite<digizuite>" element has been added to your web.config's "configuration" element. It has been added as the last child element of "configuration".
Here is an example of how it can look:
Main Digizuite Element
The digizuite element has some attributes and some child elements. Each of these are described below.
digizuite:
...
baseGuid
entryPoint
autowarmup
redirectvideostream
cache:
folderName
tempFolderName
mediaManager:
url
The mediaManager element only has one attribute: "url".
This URL should point to a Digizuite Media Manager or simply be left with no value.
If a Media Manager URL is specified, DFE can provide links to assets in said Media Manager. This may be desirable, as there are some features in MM, which DFE deosn't support, or aren't as mature. This may be editing more complex meta data types like Tree or Master/Slave item references.
If the "url" attribute is left blank, then no such link will appear.
connection:
This is a very crucial element, as it tells DFE how to communicate with your DAM Center.
baseUrl
The base URL of your DAM Center, e.g. "https://dam-dfe.digizuite.com".
user
The DAM Center user, which is responsible for creating, retrieving, updating, and deleting DAM Center assets and related data in DFE.
secret
An MD5 hash of the user's password.
versionId
| Type | Name | Required | Default | Description |
|---|---|---|---|---|
| string | baseGuid | No | (a hardcoded guid) | A guid that is used as the 'foundation' to generate all the assets Conten Guid. Usually you won't have to change this. |
| string | name | No | "" | The name with which the integration identifies itself - for example when sending editor notifications |
| bool | redirectvideostream | No | false | Default behavior is to have Episerver act as a video proxy for video assets. If this is set to true, Episerver will instead redirect the video streams to the DAM directly. |
| bool | autowarmup | No | false | Controls if the asset cache be automatically warmed up after site has initialized. Will slow down intialization, but speed up subsequent access. |
| bool | disablenotifications | No | false | If set to true, will supress editor notifications from the integration. |
| bool | autoattach | No | true | Controls if the Digizuite Content Provider should automatically attach after initialization to an entry point automatically created. If this is false, you will need to manually configure the content provider. |
| string | autoattachname | No | "Digizuite" | The name of the entry point automatically created in Auto Attach mode. |
| bool | disableresilientassets | No | false | By default image assets are stored locally for resilience when used on published content. This can however slow down the publish process. If resilience is not required you can disable it here. |
Child element: connection
The connection is the most important child element. This is where the main connection setting pointing to the DAM is specified. Typically you will replace this with connections settings you have gotten from your own DAM Center.
| Type | Name | Required | Default | Description |
|---|---|---|---|---|
| string | baseUrl | Yes | Base url to the DAM Center | |
| string | user | Yes | Sync user that the integration can use in the DAM Center | |
| string | secret | Yes | The hashed secret that the integrations sync user should use. | |
| string | versionId | Yes | A DAM Center can have many different products: Media Manager, DAM for Sitecore, Adobe Connector, Office Connector, etc. Each of these can have many versions. These versions facilitate having different configuration, searches, and other things, which can change the experience for the end user. These various versions are defined by their versionId. If the original version has versionId "/1/", then its first child will have "/1/0/". The versionId is an SQL data type called hierarchy ID. It is a tree structure. A use case may be that you want to experiment with some configuration, so you create a new version of DFE in the DAM Center. Then you can alter the versionId attribute on your EPi Server site to "/1/0/", and do your tests, while your public DFE integration still use the "/1/" versionId. |
...
roleMappings:
Each of the child "add" elements have 2 attributes:
DigizuiteRole
A comma separated list of DAM Center user groups to map to EPi Server roles.
EpiserverRoles
A comma separated list of the EPi Server roles, which should be applied to the Digizuite user groups.
fallbackIconMappings
Each of the child "add" elements have 2 attributes:
documentType
extensions
...
| bool | readOnly | No | false | Indicates if the integration should act as if it is in read only mode. |
Child element: cache
The cache element controls the caching - both binary on-disk caching as well as some of the in-memory asset meta-data caching.
| Type | Name | Required | Default | Description |
|---|---|---|---|---|
| string | folderName | Yes | "Digizuite" | The folder name below App_Data where the main binary cache is located. |
| string | tempFolderName | Yes | "DigizuiteTemp" | The folder name below App_Data where the temporary upload cache is located. |
| string | missingImage | No | "" | The site relative url to an image to use for a "No-image" image in cases where a requested image cannot be served. |
| string | timeout | No | "1:00" | Default cache time out setting. |
Child element: media
The media element defines the default media formats (DAM Center ID's) to retrieve if nothing else is specified. Usually the default settings will be sufficient.
| Type | Name | Required | Default | Description |
|---|---|---|---|---|
| string | defaultVideoFormat | Yes | Default Video format ID | |
| string | defaultImageFormat | Yes | Default Image format ID | |
| string | defaultDestination | Yes | Default destination ID (on the DAM Center) |
Child element: mediaManager
If you have a Media Manager (version 5 or later) configured on your DAM Center, the integration to Episerver supports showing deep links to assets there. In order to do that, you must set the base url to the Media Manager.
| Type | Name | Required | Default | Description |
|---|---|---|---|---|
| string | url | No | "" | If not set, it will not show deep links to the Media Manager. If set, it will try to build deep links in the UI for Media Manager for the individual assets. |
Child element: roleMappings
Since access rights can be set on individual assets in the DAM Center, you can use the list of roleMappings to map DAM Center roles to Episerver roles in order to ensure proper permissions for various editor groups. The default configuration of these elements should be sufficient in most cases.
| Type | Name | Required | Default | Description |
|---|---|---|---|---|
| string | DigizuiteRole | Yes | n/a | The name of the role in Digizuite to map. |
| string | EpiserverRoles | Yes | n/a | A comma separated list of Episerver roles that be given similar permissions to the Digizuite Role. |
Child element: fallbackIconMappings
The fallbackIconMappings list is in order to ensure that for assets where a proper thumbnail cannot be shown, we can map the various file extensions to a fitting icon. Typically the default should be sufficient.
Each element in this list has the settings below:
| Type | Name | Required | Default | Description |
|---|---|---|---|---|
| string | documentType | Yes | n/a | The icon for the document type - for instance "video" for a video icon. |
| string | extensions | Yes | n/a | A comma separated list of file extensions to map for the above document type. |