Implementing the Tridion Connector for Aprimo DAM requires a JSON configuration file, which defines your specific integration of Tridion with Aprimo DAM.
This topic describes the configuration properties that are needed specifically for the Connector for Aprimo DAM . For full details on the standard connector configuration format, refer to the related topics.
- url
-
The URL to the REST API endpoint of the assigned Aprimo DAM instance.
-
The URL is usually in the following format:
https://COMPANY.dam.aprimo.com
- userName
-
The API username defined in Aprimo DAM instance.
clientId
-
API username to be used to authenticate over OAuth.
accessToken
-
Access token to be used to authenticate over OAuth.
-
The Connector will generate a Base64-encoded bearer token based on the access token and the username.
pageSize
-
Default page size when doing search and list operations.
-
This property is optional. When no value is specified, the default page size is 100.
- browsingMode
-
Configures how the connector will build up the navigation tree.
-
Allowed values are:
classification
-
Base navigation on classifications (tags), which is the default method.
collection
-
Base navigation on collections.
- classificationMode
-
Determines which records of classification the connector should show.
-
This option takes effect only when the browsingMode is set to "classification".
-
Allowed values are:
direct
-
Show only directly classified records.
child
-
Show records of child classifications, which is the default option.
- canUpdateEntities
-
Indicates whether or not the metadata for the Aprimo DAM file can be updated.
-
Allowed values are:
true
-
File metadata can be updated.
-
This is the default value.
false
-
File metadata cannot be updated.
- fileResolutionStrategy
-
Indicates which version of an asset should be used when resolving linked files.
-
Allowed values are:
latest
-
Always use the latest version of the asset regardless of the version indicated in the link.
linked
-
Always use the linked version even if not the latest.
-
This is the default value.
- inUseClassificationId
-
Defines the Aprimo DAM classification ID to set when Tridion has marked an asset as being in use, such as when used in links and on Pages.
-
-
Note: If the ID is incorrect, various things in Tridion user interface will not work properly, such as links to Aprimo DAM assets.
- masterFileRenditionName
-
Controls which rendition of the master file to use as CDN URL at publish time.
-
When publishing, if a master rendition name is not found, the connector will not set a CDN URL and will fall back and publish a binary file instead of a URL.
-
You can validate the configuration by clicking on the public link in the ECL properties popup window.
-
This property applies only if the Akamai CDN feature has been enabled for Aprimo DAM.
-
- searchFields
-
A list of strings that defines which fields to use when performing a search.
-
In addition to configuring the fields in this property, you must also add these fields to the search index in Aprimo DAM.
-
"searchFields": [
"Title",
"Description",
"Keywords"
]
-
Note: As of version 1.7 of the Connector for Aprimo DAM , search no longer (by default) includes the LatestVersionOfMasterfile.FileName field. If you want to include this field in search, be sure to add it to the searchFields list of fields and to the search index.
- showFilesInSearch
-
Configures search to show results for Aprimo DAM as files rather than as records (which appear as folders and contain the files).
-
true
-
Show search results as
AprimoFiles items (files).
false
-
Show search results as
AprimoRecord items (folders).
-
This is the default value when the property is not specified.
- ExpectedFilesPerRecord
-
When showing search results as files instead of as records (ShowFilesInSearch is set to
true), this property sets the number of files that the connector can expect (on average) to be in each record/folder. This value is used together with the pageSize value to calculate how many records the system should include on a single page of search results and still keep the page size close to the configured pageSize.
- Example: The pageSize is set to 100 and you also set ExpectedFilesPerRecord to 5. On a single page of search results, the connector will show all files contained within 20 records (100 divided by 5). Of course, the actual number or files in those 10 records cannot be predicted.
- Default: The default value is 1, which is essentially the same as having no property at all. With a pageSize equal to 100, the system would show all files from 100 records. If each record had 5 files, this would result in a page size of 500 files. Since large numbers of files can have a significant impact on performance, we recommend setting this property carefully.
- globalRecordsFilter
-
Configures a global filter that will be applied to all Aprimo DAM Records.
-
You can use this optional property to filter out certain types of Records based on various field values
-
For more information on filtering and searching for records, see the following Aprimo DAM documentation: Using Search Expressions and Searching for Records
- additionalFilesFilter
-
Configures a filter that is applied to additional Aprimo DAM files (other than the masters), such as images that have been cropped or videos that have been trimmed.
-
You can use this optional property to either include or exclude these additional files.
-
-
not included
-
When the property is not included in the configuration file, the connector applies the filter to additional files. The metadata of each additional file is checked and the file is included only if one of the following fields are present with the indicated value:
ïsCroppedImage = "1"
isTrimmedVideo = "1"
-
This is the default value.
<EMPTY STRING>
-
When the property is included in the configuration file and is defined as an empty string, the connector applies no filtering and includes all additional files regardless of their metadata values.
-
Define the property with an empty value, as follows:
"additionalFilesFilter": ""
-
Note: The property is currently limited to being defined with an empty string. In a future release, we anticipate adding support for other values, such as query expressions that can be used for custom filtering.
- maxBinarySize
-
The maximum size of binary content for Aprimo DAM files, in bytes, that will be returned from the
IDownloadBinaryCapability.DownloadBinary method.
-
If a file is larger than the configured value,
DownloadBinary will return no data.
-
Examples:
"maxBinarySize": 52428800 — Binaries up to and including 50 MB will be downloaded, but files larger than 50 MB will not be downloaded.
"maxBinarySize": 0 — No binaries will be downloaded for any Aprimo DAM files.
-
This property is optional. When no value is specified, the result is the same as if it is defined as "0" and no binaries will be downloaded.
- metadataFieldMapping
-
A section that defines the mapping of custom metadata fields to standard fields.
-
The current release of the Connector for Aprimo DAM supports mapping with the nested parameters:
-
-
recordTitleField
-
The Aprimo DAM field that you want to map to the
Title field in Tridion Sites. The default mapped field is DisplayTitle.
-
recordDescriptionField
-
The Aprimo DAM field that you want to map to the
Description field in Tridion Sites. Optional; define as needed.
-
tagsField
-
The Aprimo DAM field that you want to map to the
Tags field in Tridion Sites. Optional; define as needed.
- localeMapping
-
A section that defines the mapping of Tridion Sites publication IDs to Aprimo DAM locales. If no mapping is defined for a certain publication ID, the default locale is used.
-
The configuration consists of a list of the following nested parameters:
-
-
publicationIds
-
A list of publication IDs
-
locale
- Aprimo DAM locale identifier
-
enableCaching
-
Indicates whether or not to use cashing for Aprimo DAM Classification folders.
-
true
-
Enables caching of Aprimo DAM Classification folders. When a Tridion user browses Classification folders in the Tridion user interface, the folders will be cached so that no more API calls are made the next time they are expanded or refreshed.
false
-
Disables caching for Aprimo DAM Classification folders.
-
This is the default value when the property is not specified.
- cacheExpiration
-
When enableCaching is set to
true, this property configures an expiration for caching.
-
Define the expiration time in minutes.
-
This property is optional. When no value is specified, the default expiration is 30 minutes.
The following sample code illustrates the configuration file of a Connector for Aprimo DAM :
{
"configuration": {
"AprimoDAMConnector": {
"namespaces": {
"aprimo": {}
},
"configuration": {
"url": "https://partner1.dam.aprimo.com",
"userName": "user1",
"clientId": "6IDA9IDZ-1111",
"accessToken": "bb022b2777c34a9aae7fe3a1510ca8cc",
"pageSize": 50,
"browsingMode": "classification",
"classificationMode": "direct",
"inUseClassificationId": "0c288aaf-0894-44c6-933f-aad4010e2e0d",
"canUpdateEntities": false,
"fileResolutionStrategy": "latest",
"searchFields": [
"DisplayTitle",
"DisplayDescription",
"DescriptionLocalized",
"Keywords"
],
"showFilesInSearch": true,
"ExpectedFilesPerRecord": 10,
"metadataFieldMapping": {
"recordTitleField": "DisplayTitle",
"recordDescriptionField": "DescriptionLocalized",
"tagsField": "Keywords"
},
"localeMapping": [
{
"publicationIds": [ "6", "7" ],
"locale": "18ca1f440c214eedaeccb98f0ae65a81"
},
{
"publicationIds": [ "4" ],
"locale": "c2bd4f9bbb954bcb80c31e924c9c26dc"
}
]
}
}
},
"sitesCm": {
"isEnabled": true,
"AprimoDAMConnector": {
"namespaces": {
"aprimo": {
"displayName": "Aprimo",
"stubFolders": ["tcm:2-71-2"]
}
}
}
},
"staging": {
"isEnabled": true
}
}