DocumentationAEM 6.4Communities Guide

Community Site Essentials community-site-essentials

Last update: Wed May 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User
CAUTION
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.

Custom Site Template custom-site-template

A custom site template may be specified separately for each language copy of a community site.

To do so,

  • Create a custom template
  • Overlay the default site template path
  • Add the custom template to the overlay path
  • Specify the custom template by adding a page-template property to the configuration node

Default template:

/libs/social/console/components/hbs/sitepage/sitepage.hbs

Custom template in overlay path:

/apps/social/console/components/hbs/sitepage/<template-name>.hbs

Property: page-template
Type: String
Value: <template-name> (no extension)

Configuration node:

/content/<community site path>/<lang>/configuration

For example: /content/sites/engage/en/configuration

NOTE
All nodes in the overlaid path need only be of type Folder.
CAUTION
If the custom template is given the name sitepage.hbs, then all community sites will be customized.

Custom Site Template Example custom-site-template-example

As an example, vertical-sitepage.hbs is a site template that results in the placement of menu links vertically down the left side of the page, instead of horizontally below the banner.

Get File
Place the custom site template in the overlay folder:

/apps/social/console/components/hbs/sitepage/vertical-sitepage.hbs

Identify the custom template by adding a page-template property to the configuration node:

/content/sites/sample/en/configuration

chlimage_1-80

Be sure to Save All and replicate custom code to all AEM instances (custom code is not included when the community site content is published from the console).

The recommended practice for replicating custom code is to create a package and deploy it on all instances.

Exporting a Community Site exporting-a-community-site

Once a community site is created, it is possible to export the site as an AEM package stored in package manager and available for download and upload.

This is available from the Communities Sites console.

Note that UGC and custom code is not included in the community site package.

To export UGC, use the AEM Communities UGC Migration Tool, an open source migration tool available on GitHub.

Deleting a Community Site deleting-a-community-site

As of AEM Communities 6.3 Service Pack 1, Delete Site icon appears on hovering over the community site from Communities > Sites console. During development, if it is desired to delete a community site and start fresh, you can use this functionality. Deleting a community site, removes the following items associated with that site:

Community Unique Site ID community-unique-site-id

To identify the unique site ID associated with the community site, using CRXDE:

  • Navigate to the language root of the site, such as /content/sites/*<site name>*/en/rep:policy

  • Find the allow<#> node with a rep:principalName in this format rep:principalName = *community-enable-nrh9h-members*

  • The site ID is the 3rd component of rep:principalName
    For example, if rep:principalName = community-enable-nrh9h-members

    • site name = enable
    • site ID = nrh9h
    • unique site ID = enable-nrh9h

User Generated Content user-generated-content

Obtain the communities-srp-tools project from Github:

This contains a servlet to delete all UGC from any SRP.

All UGC may be removed or for a specific site, for example:

  • path=/content/usergenerated/asi/mongo/content/sites/engage

This only removes user generated content (entered on publish) and not authored content (entered on author). Therefore, shadow nodes are not affected.

Community User Groups community-user-groups

On all author and publish instances, from the security console, locate and remove the user groups that are:

For example, community-engage-x0e11-members.

Enablement Assets enablement-assets

From the main console:

  • Select Assets
  • Enter Select mode
  • Select folder named with the unique site Id
  • Select Delete (may need to select from More…)

Database Records database-records

There is no tool for selectively deleting database entries for one specific enablement community site.

When all community sites are being deleted, then drop the enablementdb and scormenginedb using MySQL Workbench.

recommendation-more-help
5d37d7b0-a330-461b-814d-068612705ff6