Installing the IntelligenceBank Assets Connector for Adobe Experience Manager

Modified on Wed, 8 Oct at 5:48 PM

Deploying to AEM 6.5 (on-prem or AMS)

AEM 6.5 installation is performed via Package Manager. The following packages should be installed:

aem-connector.all-2.X.X.zip - main package, contains connector code and cofiguration
aem-connector.ui.content65-2.X.X.zip - system user and permissions (required only for AEM 6.5.x installations)

Latest versions of this content packages can be found in a public Bitbucket repository: https://bitbucket.org/IB-IntelligenceBank/intelligencebank-connector-for-adobe-experience-manager-public/src/master/

If an older 1.X IntelligenceBank Connector was previously installed, it should be uninstalled/removed before installing the 2.X release (both content and OSGi bundle).

Deploying to AEM Cloud

The recommended process is to have the released Connector package available in a Public/Password-protected Maven repository. IntelligenceBank uses a public Bitbucket repository: https://bitbucket.org/IB-IntelligenceBank/intelligencebank-connector-for-adobe-experience-manager-public/src/master/.

In order to deploy the Connector to your AEM as a Cloud Service instance, the following modifications should be applied to your pom.xml file:

Define IntelligenceBank Maven repository:

 <repositories>
        //...
        <repository>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
            <id>central</id>
            <name>default-maven-virtual</name>
            <url>https://bitbucket.org/IB-IntelligenceBank/intelligencebank-connector-for-adobe-experience-manager-public/raw/master/releases</url>
        </repository>
        <repository>
            <snapshots/>
            <id>snapshots</id>
            <name>default-maven-virtual</name>
            <url>https://bitbucket.org/IB-IntelligenceBank/intelligencebank-connector-for-adobe-experience-manager-public/raw/master/releases</url>
        </repository>
    </repositories>

Specify IntelligenceBank Connector dependency:

 <dependencies>
          // ...
          <dependency>
            <groupId>com.intelligencebank.aem</groupId>
            <artifactId>aem-connector.all</artifactId>
            <version>2.X.Y</version>
            <type>zip</type>
        </dependency>
    </dependencies>

Configure filevault-package-maven-plugin to embed aem-connector.all into the deployment package ,e.g.:

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.jackrabbit</groupId>
                <artifactId>filevault-package-maven-plugin</artifactId>
                <extensions>true</extensions>
                <configuration>
                    // ...
                    <embeddeds>
                        // ...
                        <embedded>
                            <groupId>com.intelligencebank.aem</groupId>
                            <artifactId>aem-connector.all</artifactId>
                            <type>content-package</type>
                            <target>/apps/<...>/install</target>
                        </embedded>
                    </embeddeds>
                </configuration>
            </plugin>
        </plugins>
      // ....
    </build>

Once the above configuration is performed, a regular CloudManager deployment will fetch the Connector dependency from IntelligenceBank Artifactory and embed it into your deployment package.

Connector Configuration

Click here for configuration instructions.

Connector Logging

The Connector includes the following logger configuration:

{
  "org.apache.sling.commons.log.pattern": "{0,date,yyyy-MM-dd HH:mm:ss.SSS} *{4}* [{2}] {3} {5}",
  "org.apache.sling.commons.log.names": [
    "com.intelligencebank.aem",
    "org.apache.http.wire"
  ],
  "org.apache.sling.commons.log.level": "info",
  "org.apache.sling.commons.log.file": "logs/intelligencebank.log",
  "org.apache.sling.commons.log.additiv": "true"
}

For monitoring, it is possible to either read from logs/intelligencebank.log file, or to create a dedicated logger configuration for com.intelligencebank.aem.

Logging conventions to note: WARN log messages indicate a recoverable error while ERROR indicate a failure.

Release Notes

Version 2.1.10 (26 June 2024)

Removed deprecated service user mapping format.

Version 2.1.9 (8 December 2023)

Implements throttling for handling 429 Too Many Requests response as part of new API rate limits.

Version 2.1.8 (7 June 2023)

Fix for loop scenario when multiple assets in scope have the same filename.
Fix for OakState0001: Unresolved conflicts" error.
Fix for extension missing on download.
- This issue was introduced as a side effect of the fix for "Filename may contain forbidden characters, e.g. asterisk, and should be sanitized before attempting to create an asset" released in version 2.1.4. Unfortunately, there is no automatic fix for already synced assets, so impacted assets need to be removed, and synced again for the extension to be saved correctly again.

Version 2.1.7 (16 May 2023)

Fix to handle unsupported characters (e.g. /) when creating dynamic Destination Folders based on a metadata field.

Version 2.1.6 (14 May 2023)

Fix to tracking of Folder sync call so that the Adobe Experience Manager Connector is correctly identified as the source in Usage Reporting.
AEM Cloud may run Author servers in a clustered mode, which can be causing excessive requests when every node tries to perform the sync. This fix ensures only 1 node (the leader) will triggers the update.

Version 2.1.5 (26 March 2023)

Address some of the warnings that may now be appearing during CI/CD pipeline quality check. Note that the outstanding warnings cannot be removed or suppressed any longer. Here is an explanation for the outstanding ones:
- The product interface com.day.cq.dam.api.Rendition annotated with @ProviderType should not be implemented by custom code. Detected in com.intelligencebank.aem.resource.VirtualAssetRendition contained in /apps/intelligencebank/application/install/aem-connector.core-2.1.4.jar.
  
  The product interface com.day.cq.dam.api.Asset annotated with @ProviderType should not be implemented by custom code. Detected in com.intelligencebank.aem.resource.IntelligenceBankAsset contained in /apps/intelligencebank/application/install/aem-connector.core-2.1.4.jar.
  
  These warnings indicate that the Connector is building on top of AEM APIs which are not guaranteed to be backward-compatible in future AEM releases. This results in a risk that we would need to adjust the connector to make it compatible with future AEM releases. This is expected. Since 2019, there has been no breaking changes released in said interfaces, so we estimate this risk as low.
- PackageOverlaps
  
  These warnings seem to be false-positives as we do not observe any overlaps in the codebase.
- /apps/intelligencebank/classic-config/servicepage-template is a Static Template under /apps. The use of Editable Templates is recommended.
  
  Since the template in question is a Connector configuration page, it does not make sense to use editable templates in that circumstance.

The deployment pipeline in Adobe Cloud Manager can be updated to ignore said warnings by selecting "Important Metrics Failures Behavior -> Continue immediately".

Version 2.1.4 (6 October 2022)

Remove the mandatory validation on the "value" field in wrapped conditions, since there are scenarios where value is not needed for the query
Update re-login logic: react only to 401 status, verify the login status by presence of apiUrlV3 and sid fields, remove unused APIv2 fields
Filename may contain forbidden characters, e.g. asterisk, so should be sanitized before attempting to create an asset
Allow sync http client to follow the redirects, because downloadFile API is responding with 302 redirect to S3 location now
Add error handling to avoid uncaught exceptions during the page rendering

Version 2.1.2 (7 August 2021)

[Asset Sync Mode] Conditional Destination Folders support
[Asset Sync Mode] Dynamic Destination Folders support
[Asset Sync Mode] Automatic assignment / unassignment of IB Metadata Schema
[Sites Mode] Add “Store assets locally” configuration option
[Sites Mode] Add opacity to items which are not public
General Stability improvements

Version 2.1.1

Custom Form Fields metadata mapping support

Version 2.0.3

Support for AEM Sites Connector mode in AEM as a Cloud Service
Support for AEM 6.5

Version 2.0.1

Support AEM Cloud version 2020.11+

Version 2.0 (30 April 2021)

Beta Version of the Adobe Assets Cloud Sync Connector Mode option, which supports:
- Adobe Assets Cloud Sync as a new Connector mode
- Single user credentials for authenticating to the IntelligenceBank platform instance
- Selection of a single destination folder for all synced assets in AEM Assets
- Search query scope parameters including:
  - Folder source(s)
  - Extensions
  - Search Keywords
  - Advanced Filtering Conditions
- Metadata mapping options including:
  - Automatic IntelligenceBank Scheme with IntelligenceBank standard and custom filter fields.
  - Custom Mapping of IntelligenceBank standard and custom filter fields to select AEM Assets metadata fields / properties.