loading table of contents...

8.3.1. Configuring Elastic Social

This section describes the configuration of the Elastic Social plugin.

Context settings for Elastic Social are defined in the following contexts:

  • Root channel: Application context settings can only be defined in the root channel and can not be overwritten

  • Every Channel: Channel context settings can be defined in every channel and are inherited or can be overwritten by child channels

Root Channel

The following context settings are defined for the root channel and can not be overwritten:

tenant
Type String property
Description The tenant
Example elastic
Default Value
Required true
userModerationType
Type String Property
Description Moderation type for users
Example PRE_MODERATION, POST_MODERATION, NONE
Default Value NONE
Required false

Table 8.4.  Root Channel Context Settings


The context setting tenant is needed to define which tenant is used for a site.

<?xml version="1.0" encoding="UTF-8"?>
<Struct xmlns="http://www.coremedia.com/2008/struct"
        xmlns:xlink="http://www.w3.org/1999/xlink">
  <StructProperty Name="elasticSocial">
    <Struct>
      <StringProperty Name="tenant">
        elastic
      </StringProperty>
      <StringProperty Name="userModerationType">
        POST_MODERATION
      </StringProperty>
    </Struct>
 </StructProperty>
</Struct>

Example 8.7. Root Channel Context Settings


Every Channel

The following context settings can be defined per channel and are inherited or can be overwritten by child channels:

Context Settings for Every Channel
NameTypeDescriptionExampleDefault value
enabledBoolean PropertyEnable/disable feedback for the channel. If disabled, all other settings are ignoredtrue, falsefalse
commentTypeString PropertyDisable commenting generally by settings this property to DISABLED. Enable reading comments by setting this property to READONLY. Enable only registered users to write comments by settings the property to REGISTERED. Enable all users (registered and anonymous) to write comments by settings the property to ANONYMOUS. This property is only available if enabled is true.DISABLED, READONLY, REGISTERED, ANONYMOUSDISABLED
reviewTypeString PropertyDisable reviewing generally by settings this property to DISABLED. Enable reading reviews by setting this property to READONLY. Enable only registered users to write reviews by settings the property to REGISTERED. Enable all users (registered and anonymous) to write reviews by settings the property to ANONYMOUS. This property is only available if enabled is true.DISABLED, READONLY, REGISTERED, ANONYMOUSDISABLED
commentModerationTypeString PropertyModeration Type for comments.PRE_MODERATION, POST_MODERATION, NONENONE
reviewModerationTypeString PropertyModeration Type for reviews.PRE_MODERATION, POST_MODERATION, NONENONE
filterCategoriesLinkListPropertyConfigures filter options for the comment moderation list. You can add navigation and taxonomy documents.  

Table 8.5. Context Settings for Every Channel


<?xml version="1.0" encoding="UTF-8"?>
<Struct xmlns="http://www.coremedia.com/2008/struct"
        xmlns:xlink="http://www.w3.org/1999/xlink">
  <StructProperty Name="elasticSocial">
    <Struct>
      <BooleanProperty Name="enabled">
        true
      </BooleanProperty>
      <StringProperty Name="commentType">
        ANONYMOUS
      </StringProperty>
      <StringProperty Name="reviewType">
        REGISTERED
      </StringProperty>
      <StringProperty Name="commentModerationType">
        PRE_MODERATION
      </StringProperty>
      <StringProperty Name="reviewModerationType">
        PRE_MODERATION
      </StringProperty>
    </Struct>
  </StructProperty>
</Struct>

Example 8.8. Context Settings for Every Channel