Connector Pack and Special Feature changelog

This release brings the Google Analytics 4 connector to our Analytics Connector Pack. (ANALYTICS-381)

With Google Universal Analytics (UA) going away, we are moving our UA connector into Maintenance Mode until the end of the year. Following this period, in accordance with our Deprecation Policy, we will proceed to deprecate and retire the UA connector.

Improvements

Bug fixes

To keep the UI uncluttered, widget icons are now hidden until the user mouses over the chart.

A drag and drop handle icon has been added to widgets in the Analytics app and a more obvious frame is displayed so users can better visualize where they are moving the widget.

ANALYTICS-331, ANALYTICS-351, ANALYTICS-352

Bug fixes

This release delivers a new user-friendly UI to empower editors and marketeers in creating and editing their own dashboards and widgets.

In Analytics module 1.1, only technical users who were able to work with YAML files could build charts and dashboards.

Now users can create a dashboard and add widgets featuring commonly used metrics in just a few clicks. A preview of the widget being created is displayed as soon as metrics are selected. Once added to the dashboard, widgets can be dragged and dropped around, or expanded for better viewing.

See the Analytics app for how to create dashboards and add widgets.

Default metrics and dimensions are provided for each third-party analytics tool so that end users can start creating popular widgets as soon as the data supplier is configured.

Users with in-depth knowledge of their analytics data can access all the metrics and dimensions available from their data supplier when adding widgets by clicking the Add metrics button.

Developers can change the default metrics and dimensions available in the Analytics app through decoration in the data supplier definitions.

A dashboard can contain widgets displaying data from different data suppliers.

You can create widgets from different sources of analytics data, such as Adobe Analytics, file-based data, Google Analytics, Matomo, and display them all in a single dashboard.

Previously, dashboard filters were cleared when you changed the dashboard layout, added a widget or dragged and dropped a widget.

Now filters persist until you reload the dashboard, select another dashboard, add a dashboard or delete a dashboard.

To provide more visual information about the data in the widgets, dynamic tooltips are now displayed by default when mousing over charts. The green tooltip is the label for the Y axis.

A JSONPath evaluator is provided to help you test and evaluate your JSONPath.

Dashboards are available to all users. Instead of deleting them, you can hide them by setting the enable property to false if required.

Analytics module 1.2 supports the display of dashboards created using the previous version of this module. Dashboards created in version 1.1 can be viewed, but not edited. Users are notified of this limitation in the UI.

We recommend you use the new Analytics app to re-create your 1.1 dashboards and widgets from scratch. However, we provide an example of how to migrate in How to migrate Analytics module 1.1 dashboards to 1.2 if you prefer to reconfigure your charts and dashboards.

A new timeline chart type is provided by the magnolia-analytics-amcharts-samples module. See the amCharts timeline chart demo.

Previously, dataSuppliers and chartDefinitions were configured in the dashboard yaml definitions and would sometimes need to be duplicated.

Now, Magnolia provides registries for the dataSupplier and chartDefinition configuration.

Data suppliers are defined once under this directory: /<module name>/dataSuppliers/<dataSupplierRegistryFile.yaml>.

The chartDefinition configuration in the dashboard definition yaml file can be included from the chart definitions provided by the magnolia-analytics-ui submodule:

For example:

Make sure the chart definitions are known to a registry and are listed under charts in the Definitions app.

You can format dates and decimals that appear in your dashboard widgets under: analytics/config.yaml

This release comes with an amCharts^ update from 4.5.3 to 4.9.17.

The AnalyticsDataSupplierCache used in 1.1 has been replaced by the Addon-commons cache module in 1.2.

If you customized your cache configuration in 1.1, update the new cache configuration under /analytics/decorations/addon-commons-cache/config.yaml.

See the Analytics Connector Pack 1.2 changelog for all the changes.

A new ecommerceLinkField field (extends Link field) has been introduced.

Here are the default configurations for the different e-commerce components provided:

ECOMMERCE-461

New EcommerceChooserValidator classes have been added to ensure the connection, category and product selected are valid when adding e-commerce content to a page.

(ECOMMERCE-472)

When you test a connection, the result message is now displayed for longer to make it easier to read.

(ECOMMERCE-465)

A user-friendly product chooser makes finding and selecting categories and products faster and simpler for end users.

Each column provides a filter at the top.

The chooser dialog can also be configured to enable or disable certain columns.

You can find component definitions and template files configured under /ecommerce-templating/templates/components.

The components introduced in v1.3 are suffixed with -v3.

Those with no suffix are provided for backwards compatibility with E-commerce v1.2.x.

You can still view and edit the 1.2.x version components but we recommend you recreate your e-commerce pages using the new component definitions to benefit from the new product chooser dialog and other improvements.

The sample components Category list and Product list have been aligned with the other e-commerce page components and now provide chooser dialogs for selecting the e-commerce content to be displayed.

The chooser dialogs only store the connectionId property, which consists of {definitionName}/{connectionName} in JCR instead of the previously stored properties definition and connection.

The related template files category-list.ftl and product-list.ftl were adapted accordingly.

To ensure backward compatibility with the previous template files, an ecommerce-freemarker renderer was introduced and configured for the renderType property in the component configuration yaml files:

The ecommerce-freemarker renderer parses the definition and connection names from the connectionId property and wraps the component content with the definition and connection properties with the parsed values.

(ECOMMERCE-389, ECOMMERCE-389)

A new locale parameter used for product/category names or descriptions can be set in the commercetools configuration.

See the parameter description in the tab for commercetools.

ECOMMERCE-389

See the 1.2.5 changelog for all the changes.

This release delivers a new connector for SAP Commerce Cloud (formerly Hybris).

The connector includes a new User endpoint for SAP:

See the User REST endpoint page.

This release provides a V2 of two endpoints:

The ecommerce-rest-role has been updated to allow the v2 endpoints.

See the V2 endpoint pages.

This release also improves the sample template provided in the Pages app. Magnolia provides a dialog to select the connection, category and product instead of requiring you to manually enter the connection name, definition name and a product ID. If you only have one connection configured, you choose the category and product directly.

List of changes:

See the 1.2.2 changelog for all the changes.

Bynder provides different image derivatives (referred to as image variations in Magnolia) such as large, medium, small. This functionality is now integrated into Magnolia and can be used via the DAM templating function (damfn).

For example, to retrieve the small Bynder derivative:

To see which image variations are available for a given Bynder asset, look in the asset details view:

See Using Bynder image derivatives for more information.

For more information about Bynder derivatives, see Derivatives (Create Smaller Versions of Assets) in the Bynder documentation.

EXTDAM-305, EXTDAM-307

We have improved S3 caching of bucket regions in Magnolia to fix an issue causing performance problems when using the delivery endpoint for Cloud customers.

EXTDAM-318

When selecting external assets, you can now use a filter at the top of the Name column for both Bynder and S3 to reduce the number of assets displayed.

Note that in the case of S3, you must open the bucket of your choice before filtering within it. Filtering at the root level does not produce results.

EXTDAM-295, EXTDAM-294

When creating an S3 bucket in the Assets app, the list of regions available are ordered alphabetically and unavailable regions are no longer displayed.

EXTDAM-292, EXTDAM-311

Previously the DAM Connector Pack provided a sample Text and External Image component in the Travel demo to help get users started using external assets in pages.

This sample component has now been removed. We recommend you use the standard MTK Text and Image component instead.

EXTDAM-145

To avoid S3 asset link references breaking, it is no longer possible to rename S3 assets in Magnolia.

The Asset name field is now disabled in the asset details view.

EXTDAM-315

From External DAM 1.0.7 (DAM module 3.0.8), you can configure a single asset provider for link fields to limit your users to selecting assets from only one asset provider.

Previously, you had to use the aggregated damLinkField and users had to choose from all the enabled asset providers.

EXTDAM-268

By default, the Bynder and AWS S3 subapps are disabled and do not appear in the Magnolia Magnolia Assets app.

You must enable the subapp for your external solution <dam-connector>/decorations/dam.

EXTDAM-253

As an alternative to using the static Magnolia Password manager app to store your AWS S3 credentials, you can now use the AWS default credential provider chain.

AWSFNDN-25

To protect the URLs of private Bynder assets rendered in Magnolia, you must use the proxy service provided.

When using the proxy, if you want to make a Bynder asset public, for example an image asset used in the Pages app, you must publish the image as well as the page in Magnolia.

You can enable or disable the proxy service using the proxyMode parameter.

See EXTDAM-160.

You can now publish S3 assets via the Magnolia UI. By default, all S3 assets are private.

If you want to use S3 assets on a public page, you must publish them to make them public.

See EXTDAM-63.

When you upload assets via Magnolia to S3, they are set to private by default. If you want to keep the preview functionality available, you must use presigned urls.

See EXTDAM-157.

Your location in the S3 folder hierarchy is now displayed in the bottom left-hand corner of the asset browser.

See EXTDAM-190.

When you have two or more users trying to browse assets in S3 the sessions can overlap each other. Users may enter the app in a folder opened by another user in another session instead of the top level folder.

See EXTDAM-210.

The Bynder SDK version has been reverted from 2.2.4 to 2.2.1.

This resolves the issue discovered in version External DAM 1.0.3 that blocks users from uploading assets to Bynder via Magnolia.

See EXTDAM-189.

You can now configure pagination to improve response times.

See EXTDAM-169.

You can now publish Bynder assets via the Magnolia UI.

By default, all Bynder assets are private. If you want to use Bynder assets on a public page, you must publish them to make them public.

See EXTDAM-62.

Magnolia has improved how large numbers (thousands) of assets in a given S3 folder are rendered.

Magnolia has a specialized method that counts the total number of assets in your S3 system instead of creating the corresponding internal objects. Since S3 only allows batches of 1000 assets to be retrieved in a given call, we iterate as many API calls as necessary to retrieve the assets stored in S3.

For example, Magnolia must make 100 API calls to retrieve 100 000 assets. Depending on your internet bandwidth, cache and other factors, this could take around 1 minute to complete. For better response times, we recommend that you store a maximum of 10 000 assets per S3 bucket.

See EXTDAM-170 and EXTDAM-138.

You can configure the maximum time Magnolia Periscope spends searching for S3 assets to be displayed in the Magnolia interface using a new parameter called maxSearchTimeInMilis under dam-s3/config.yaml.

By default, the maximum search time is 10 seconds (maxSearchTimeInMilis: 10000).

See EXTDAM-184.

If you upload an asset that does not have a suffix, Magnolia now infers the mime type from the binary.

To avoid extra API calls to S3, we recommend you include the suffix whenever possible.

See EXTDAM-126.

See EXTDAM-167.

Updated for Magnolia 6.0 compatibility.

Initial release of the Extensions version of the module.