close

Filter

loading table of contents...

Blueprint Developer Manual / Version 2110

Table Of Contents

6.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
recaptchaForRegistrationRequired
Type Boolean property
Description Enable/disable captcha for user registration
Example true, false
Default Value false
Required false

Table 6.2. 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>
      <BooleanProperty Name="recaptchaForRegistrationRequired">
        true
      </BooleanProperty>
    </Struct>
 </StructProperty>
</Struct>

Example 6.7. Root Channel Context Settings


<?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 6.8. 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
enabled Boolean PropertyEnable/disable feedback for the channel. If disabled, all other settings are ignoredtrue, falsefalse
commentType String 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, ANONYMOUS DISABLED
reviewType String 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, ANONYMOUS DISABLED
recaptchaForReviewRequired Boolean PropertyEnable reCAPTCHA for Reviews and Ratings.true, falsefalse
commentModerationType String PropertyModeration Type for comments.PRE_MODERATION, POST_MODERATION, NONE NONE
reviewModerationType String PropertyModeration Type for reviews.PRE_MODERATION, POST_MODERATION, NONE NONE
reviewDocumentTypes String List PropertyOptional whitelist of technical document type identifiers for reviews. Do not set this configuration if reviews should be available for all subtypes of CMTeasable CMArticle, CMTeasable, etc. 
commentDocumentTypes String List PropertyOptional whitelist of technical document type identifiers for comments. Do not set this configuration if comments should be available for all subtypes of CMTeasable CMArticle, CMTeasable, etc. 
likeDocumentTypes String List PropertyOptional whitelist of technical document type identifiers for likes. Do not set this configuration if likes should be available for all subtypes of CMTeasable CMArticle, CMTeasable, etc. 
ratingDocumentTypes String List PropertyOptional whitelist of technical document type identifiers for ratings. Do not set this configuration if ratings should be available for all subtypes of CMTeasable CMArticle, CMTeasable, etc. 
defaultNumberOfReviews Integer PropertyDefault number of reviews to be displayed initially. If 0, all reviews are displayed.30
maxImageFileSize Integer PropertyMaximum size of uploaded images (in bytes).512000512000
userImageHeight Integer PropertyHeight of user image in px.150150
userImageWidth Integer PropertyWidth of user image in px.200200
userImageThumbnailHeight Integer PropertyHeight of user thumbnail image in px.4848
userImageThumbnailWidth Integer PropertyWidth of user thumbnail image in px.4848
userImageCommentThumbnailHeight Integer PropertyHeight of user thumbnail image in px, displayed for a comment.4848
recaptchaPublicKey String PropertyID of your registered reCAPTCHA appABCD123... 
recaptchaPrivateKey String PropertySecret authentication key of your registered reCAPTCHA appABCD123... 
filterCategories LinkListPropertyConfigures filter options for the comment moderation list. You can add navigation and taxonomy documents.  

Table 6.3. 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 6.9. Context Settings for Every Channel


Search Results

Table Of Contents
warning

Your Internet Explorer is no longer supported.

Please use Mozilla Firefox, Google Chrome, or Microsoft Edge.