AEM CMS Plugin Post-Installation Tasks

Summary

After installing the AEM CMS plugin, complete the tasks that apply to your environment: flush the listed dispatcher files if your authoring instance uses a dispatcher, verify the repository paths for your plugin version, and optionally configure OSGI settings. Dispatcher flushing requires an AEM Admin with dispatcher access and expert knowledge. Skip tasks that do not apply to your environment.

Instructions

Please review the post installation tasks in this article and complete the actions as they apply to your environment. Not all of the steps are required necessarily depending on your environment setup and needs. For example, if you don’t use a dispatcher module with your environment, you can skip that step and move onto the next. 

Flush files in the dispatcher module

If you are using the dispatcher module for your authoring instance, please make sure that you flush the following files under the dispatcher module after installation. If you don’t have a dispatcher module, then this may not apply.

No minification activated

• /libs/cq/gui/components/authoring/editors/clientlibs/sites/page.css
• /libs/cq/gui/components/authoring/editors/clientlibs/sites/page.js

Minification activated

• /libs/cq/gui/components/authoring/editors/clientlibs/sites/page.min.css
• /libs/cq/gui/components/authoring/editors/clientlibs/sites/page.min.js

NOTE: Flushing these files needs to be done by an Admin in AEM with dispatcher access and expert knowledge of how to flush files in the dispatcher. These files will only exist in the dispatcher to be flushed and may not be found in the regular directories.

Verify plugin paths exist in the repository

Verify that the paths shown in the filter of “siteimprove-aem-plugin-package” exist in the repository. If they do not exist, verify your customizations do not override these paths.

Plugin Paths (for plugins before version 3.0.13): 

Plugin Paths (for plugins version 3.0.13 and after): 

OSGI Plugin Configuration

Optionally, under OSGI Configuration (/system/console/configMgr), you can configure settings under “Siteimprove :: AEM Plugin :: Siteimprove Service configuration.”

Additional HTTP headers

Custom HTTP headers to be added to every server-side call to the Siteimprove servers.

Connect timeout and Socket timeout

There are default timeouts set up in these fields that should work with the standard plugin and Prepublish setups. These may need to be adjusted if API customizations with the Prepublish (Content Check) run into timeout issues. Note that the times are in milliseconds.

Disable New UI Version

By default, the “New Plugin Experience” is set up with plugin versions 3.0.0 and after. You can select this option and save changes to revert to the “Old Plugin Experience.” Both versions currently exist while features are being built out and plugins migrate to the New Plugin Experience.

You can read more about each experience with the articles corresponding to each version here:

You may decide to revert to the Old Plugin Experience to retain access to features that are still being built out, or if you run into issues with the new experience that do not exist with the old experience.