Community Functions community-functions

The type of features expected from a community experience are well known. Community features are available as community functions. Essentially, they are one or more pages pre-wired to implement a community feature which requires more than simply adding a component to a page in author mode. They are the building blocks used to define the structure of a community site template from which community sites are created.

Once a community site is created, content may be added to the resulting pages using the standard AEM authoring mode. Various community functions are available as seen in the community functions console.

Community Functions Console community-functions-console

To reach the community functions console in the author environment:

Pre-built Functions pre-built-functions

Following is a brief description of the functions delivered with AEM Communities. Each function includes one or more AEM pages containing Communities components wired together into a feature that is easily incorporated into a community site template.

A community site template provides the structure for a community site including login, user profiles, notifications, messaging, site menu, search, theming, and branding features.

Title and URL Settings title-and-url-settings

Title and URL are properties common to all community functions.

When a community function is added to a community site template or added when modifying the structure of a community site, the function’s dialog opens so that the Title and URL may be configured.

Configuration Function Details configuration-function-details

For example, using the site created from following the Getting Started tutorial, if

Then, the URL to the page is https://localhost:4503/content/sites/engage/en/page.html

and the menu link for the page appears as:

Activity Stream Function activity-stream-function

The activity stream function is a page with an Activity Streams component with all views selected (all activities, user activities, and following). See also Activity Stream Essentials for developers.

When added to a template, the following dialog opens:

Configuration Function Details configuration-function-details-1

Blog Function blog-function

The blog function is a page with a Blog component configured for tagging, file uploads, following, members to self-edit, voting, and moderation. See also Blog Essentials for developers.

When added to a template, the following dialog opens:

Calendar Function calendar-function

The calendar function is a page with a Calendar component configured to allow tagging. See also Calendar Essentials for developers.

When added to a template, the following dialog opens:

Featured Content Function featured-content-function

The featured content function is a page with a Featured Content component configured to allow comments to be added and deleted.

The ability to feature content may be allowed or disallowed per component (see Blog Function, Calendar Function, Forum Function, Ideation Function, and QnA Function).

When added to a template, the only configuration is for the Title and URL Settings.

File Library Function file-library-function

The file library function is a page with a File Library component configured to allow comments to be added and deleted.

When added to a template, the only configuration is for the Title and URL Settings.

Forum Function forum-function

The forum function is a page with a Forum component configured for tagging, file uploads, following, members to self-edit, voting, and moderation.

When added to a template, the following dialog opens:

Configuration Function Details configuration-function-details-2

Groups Function groups-function

The groups function provides the ability for community members to create sub-communities within the community site in the publish environment.

Depending on settings when the Groups function is included in a community site template, the groups can be public or private and one or more community group templates may be configured to provide a choice of templates when the community group is actually created (such as from the publish environment). A community group template specifies which Communities features are created for the group pages, such as forums and calendars.

When a community group is created, a member group is dynamically created for the new group, to which members can be assigned or join. For more information, see Managing Users and User Groups.

As of Communities feature pack 1, community groups are created in the author environment using the Communities Sites’ Groups console, and may be created in the publish environment when enabled.

When added to a template, the following dialog opens:

Ideation Function ideation-function

The ideation function is a page with one Ideation component.

When added to a template, the following dialog opens, which specifies the default Title and URL names, and default display settings for the template:

Leaderboard Function leaderboard-function

The leaderboard function is a page with one Leaderboard component.

NOTE: The Leaderboard component needs further configuration after a community site is created from a community template which includes the Leaderboard function. Specify the Leaderboard component’s rules, which depend on configuration of scoring and badges for the community site.

When added to a template, the following dialog opens, which specifies the default Title and URL names, and default display settings for the template:

Page Function page-function

The page function adds a blank page to the community site that it is wired into the features of the community site: login, menu, notifications, messaging, theming and branding. Content is added to the page using the standard AEM authoring mode.

When added to a template, the only configuration is for the Title and URL Settings.

QnA Function qna-function

The QnA function is a page with a QnA component configured for tagging, file uploads, following, members to self-edit, voting, and moderation.

When added to a template, the configuration allows restriction to privileged members:

Create Community Function create-community-function

The ability to create a community function is reached by selecting the Create Community Function icon located at the top of the Community Functions console. Multiple functions based on the same AEM Blueprint may be created and then uniquely customized by opening in author edit mode.

Community Function Name community-function-name

On the Community Function Name panel, a name, description and whether the function is enabled or disabled are configured:

AEM Blueprint aem-blueprint

On the AEM Blueprint panel, it is possible to select the blueprint which is the underlying implementation of the community function.

The community function is a mini site that includes one or more pages, pre-wired for inclusion into a community site including login, user profiles, notifications, messaging, site menu, search, theming, and branding features. Once the function is created, it is possible to open the function in author edit mode and customize the page or component settings.

Since the community function is implemented as a live copy of a blueprint, it is possible to rollout changes made to a function which affects all community site pages created from the community site template or community group template that included the function. It is also possible to disassociate a page from its parent blueprint to make page-level modifications.

See also Multi Site Manager.

Thumbnail thumbnail

On the Thumbnail panel, an image may be uploaded to display in the Community Functions console.

Open Community Function open-community-function

Select the Open Community Function icon to enter author edit mode for authoring the page content and modifying the configuration of the feature component(s).

Configuring Components configuring-components

A community function is implemented as a Live Copy of an AEM Blueprint, details of which are documented under Multi Site Manager.

It is possible to not only author page content, but to configure components.

If configuring a component on a page of a created community site, it may be necessary to cancel inheritance to configure the component. Inheritance should be re-established when configuration is completed.

For configuration details, visit Communities Components for authors.

Edit Community Function edit-community-function

Select the Edit Community Function icon to edit the function’s properties using the same panels as creating a community function, including enabling or disabling the function.