AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.
AEM Communities license
Optional licenses for:
For the AEM platform
Install latest AEM 6.4 Updates
If not using the default ports (4502, 4503), then configure replication agents
If supporting globalization, setup automated translation
(sample setup is provided for development)
For the Communities capability
If deploying a publish farm, identify the primary publisher
Setup a default email service
Identify the choice for shared UGC storage (SRP)
If MongoDB SRP (MSRP)
If relational database SRP (DSRP)
If Adobe SRP (ASRP)
If JCR SRP (JSRP)
Not a shared UGC store:
Default is JSRP
For the enablement feature
AEM 6.4 Communities GA includes Communities package. To know about updates to AEM 6.4 Communities, refer AEM 6.4 Release Notes.
Starting in AEM 6.3, updates to Communities are delivered as part of AEM Cumulative Fix Packs and Service Packs.
For the latest updates to AEM 6.4, be sure to check Adobe Experience Manager 6.4 Cumulative Fix Packs and Service Packs.
As on AEM 6.4 and beyond, AEM Communities features and hotfixes are part of AEM Communities cumulative fix packs and service packs. There are, therefore, no separate feature packs.
Two Communities features use a MySQL database:
The MySQL connector must be obtained and installed separately.
The necessary steps are:
Download the ZIP archive from https://dev.mysql.com/downloads/connector/j/
Extract mysql-connector-java-<version>-bin.jar (bundle) from the archive
Use the web console to install and start the bundle:
If installing on an existing deployment after JDBC has been configured, then rebind JDBC to the new connector by resaving the JDBC configuration from the web console:
Day Commons JDBC Connections Poolconfiguration
Repeat steps 3 and 4 on all author and publish instances
Further information on installing bundles is found on the Web Console page.
Shareable Content Object Reference Model (SCORM) is a collection of standards and specifications for e-learning. SCORM also defines how content may be packaged into a transferable ZIP file.
The AEM Communities SCORM engine is required for the enablement feature. Scorm packages supported on AEM Communities 6.4 version are:
cq -social- scorm -package, version 1.2.11. This SCORM package is supported by all AEM 6.4 Communities versions.
cq -social- scorm -package, version 2.2.2 includes SCORM 2017.1 engine. This SCORM package is supported AEM 6.4.2.x Communities onwards.
For a new installation of SCORM engine, the package containing SCORM 2017.1 (which is cq -social- scorm -package, version 2.2.2) should be used. So that you are able to play learning resources supported by SCORM 2017.
/libs/social/config/scorm/database_scormengine_data.sqlfrom cq instance and execute it in mysql server to create an upgraded scormEngineDB schema.
/content/communities/scorm/RecordResultsin Excluded Paths property in CSRF filter from
Existing SCORM installations can be upgraded to cq-social-scorm-package, version 2.2.2 (which uses SCORM 2017.1), if the authored course content requires SCORM 2017.1.
Upgrading to SCORM 2017.1 package requires migration of the existing database (as explained further).
Take a back up of ScormEngineDB schema.
Install the cq-social-scorm-package, version 2.2.2.
Download the package from
/libs/social/config/scorm/ScormEngine.zip and extract the same.
Go to Installer folder of the extracted directory.
SystemDatabaseConnectionString with your
scorm db connection url in file EngineInstall.xml.
Run mysql schema upgrade tool in Installer folder with the command:
java -Dlogback.configurationFile=logback.xml -cp "lib/*" RusticiSoftware.ScormContentPlayer.Logic.Upgrade.ConsoleApp EngineInstall.xml
engine_upgrade.log file for any kind of error and schema upgrade status.
/content/communities/scorm/RecordResults in Excluded Paths property in CSRF filter from
https://<hostname>:<port>/system/console/configMgr on publishers.
As installed, all enablement activity is verbosely logged to the system console.
If desired, the log level can be set to WARN for the
For working with logs, see Working with Audit Records and Log Files.
For the SRP collection (MSRP or DSRP) to support advanced multilingual search (MLS), new Solr plug-ins are required in addition to a custom schema and Solr configuration. All required items are packaged into a downloadable zip file.
The advanced MLS download (also known as ‘phasetwo’) is available from the Adobe repository:
To obtain the Advanced MLS package, see AEM Advanced MLS in the deploy section of the documentation.
For details and installation information, visit Solr Configuration for SRP.
Packages Visible in Adobe AEM Cloud
The links to packages on this page require no running instance of AEM as they are to package share on
adobeaemcloud.com. While the packages are viewable, the
Installbutton is for installing the packages into an Adobe hosted site. If intending to install on a local AEM instance, selecting
Installwill result in an error.
How to Install on Local AEM Instance
To install the packages visible in
adobeaemcloud.com on a local AEM instance, the package must first be downloaded to a local disk:
On the local AEM instance, use package manager (for example http://localhost:4502/crx/packmgr/), to upload to the local AEM’s package repository.
Alternatively, accessing the package using package share from the local AEM instance (for example, http://localhost:4502/crx/packageshare/), the
Downloadbutton will download to the local AEM instance’s package repository.
Once in the local AEM instance’s package repository, use package manager to install the package.
For more information, visit How to Work With Packages.
In AEM Communities, a common store is used to store user generated content (UGC) and is often referred to as the storage resource provider (SRP). The recommended deployment centers on choosing an SRP option for the common store.
The common store supports moderation of, and analytics on, UGC in the publish environment while eliminating the need for replication of UGC.
Community Content Store: discusses the SRP storage options for AEM communities
Recommended Topologies: discusses the topology to use depending on use case and SRP choice
When upgrading to the AEM 6.4 platform from previous versions of AEM, it is important to read Upgrading to AEM 6.4.
In addition to upgrading the platform, read Upgrading to AEM Communities 6.4 to learn about Communities changes.
When the deployment chosen is a publish farm, then one AEM publish instance must be identified as the
primary publisher for activities which should not occur on all instances, such as features that rely on notifications or Adobe Analytics.
By default, the
AEM Communities Publisher Configuration OSGi configuration is configured with the
Primary Publisher checkbox checked, such that all publish instances in a publish farm would self-identify as the primary.
Therefore, it is necessary to edit the configuration on all secondary publish instances to uncheck the
Primary Publisher checkbox.
For all other (secondary) publish instances in a publish farm:
Sign in with administrator privileges
Access the web console
AEM Communities Publisher Configuration
Select the edit icon
Uncheck the Primary Publisher box
Replication is used for site content created in the publish environment, such as community groups, as well as managing members and member groups from the author environment using the tunnel service.
For the primary publisher, ensure the Replication Agent Config correctly identifies the publish server and authorized user. The default authorized user,
admin, already has the appropriate permissions (is a member of
In order for some other user to have the appropriate permissions, they must be added as a member to the
administrators user group (also a member of
There are two replication agents in the author environment that need the transport configuration to be correctly configured.
Access the Replication console on author
Follow the same procecure for both agents:
Default Agent (publish)
Reverse Replication Agent (publish reverse)
4503, edit the URI to specify the correct port
admin, edit the User and Password to specify a member of the
The following images show the results of changing the port from 4503 to 6103 by:
When using the author environment to create sites, modify site properties or manage community members, it is necessary to access members (users) registered in the publish environment, not users registered on author.
The tunnel service provides this access using the replication agent on author.
To enable the tunnel service:
Sign in with administrative privileges
If publisher is not localhost:4503 or transport user is not
Access the Web Console
AEM Communities Publish Tunnel Service
Select the edit icon
Check the enable box
There are two features of AEM Communities that require all AEM server instances to use the same encryption keys. These are Analytics and ASRP.
As of AEM 6.3, the key material is stored in the file system and no longer in the repository.
In order to copy the key material from author to all other instances, it is necessary to:
Access the AEM instance, typically an author instance, that contains the key material to copy
com.adobe.granite.crypto.file bundle in the local file system
bundle.infofile will identify the bundle
Navigate into the data folder
Copy the hmac and primary node files
For each target AEM instance
Navigate into the data folder
Paste the 2 files previously copied
It is necessary to refresh the Granite Crypto bundle if the target AEM instance is currently running
If another security feature has already been configured that is based on the crypto keys, then replicating the crypto keys could damage the configuration. For assistance, contact customer care.
Having the key material stored in the repository, as was the case for AEM 6.2 and earlier, can be preserved by specifying the following system property on first startup of each AEM instance (which creates the initial repository):
It is important to verify that the replication agent on author is correctly configured.
With the key material stored in the repository, the manner for replicating the crypto key from author to other instances is as follows:
Using CRXDE Lite:
browse to https://<server>:<port>/crx/de
On each publish instance, access the Web Console
Adobe Granite Crypto Support bundle (com.adobe.granite.crypto)
After a moment, a Success dialog should appear:
Operation completed successfully.
If using the Apache HTTP server, ensure that you use the correct server name for all relevant entries.
In particular, be careful to use the correct server name, not
localhost, in the
<IfModule alias_module> # XAMPP does not have a favicon; this prevents any 404 errors which may arise. Redirect 404 /favicon.ico <Location /favicon.ico> ErrorDocument 404 "No favicon" </Location> # Return from "Sign Out" generates response header directing you to "/", generating a 404 error # The RedirectMatch resolves it correctly when modified for the target Community Site: RedirectMatch ^/$ https://[server name]/content/sites/engage/en.html ... </IfModule>
If using a Dispatcher, see:
Visit Administering Communities Sites to learn about creating a community site, configuring community site templates, moderating community content, managing members, and configuring messaging.
Visit Developing Communities to learn about the social component framework (SCF) and customizing Communities components and features.
Visit Authoring Communities Components to learn how to author with and configure Communities components.