Blueprint Developer Manual / Version 2204
Table Of ContentsThis 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
| Name | Type | Description | Example | Default value |
|---|---|---|---|---|
enabled
| Boolean Property | Enable/disable feedback for the channel. If disabled, all other settings are ignored | true, false | false |
commentType
| String Property | Disable 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 Property | Disable 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 Property | Enable reCAPTCHA for Reviews and Ratings. | true, false | false |
commentModerationType
| String Property | Moderation Type for comments. | PRE_MODERATION, POST_MODERATION, NONE
| NONE |
reviewModerationType
| String Property | Moderation Type for reviews. | PRE_MODERATION, POST_MODERATION, NONE
| NONE |
reviewDocumentTypes
| String List Property | Optional 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 Property | Optional 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 Property | Optional 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 Property | Optional 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 Property | Default number of reviews to be displayed initially. If 0, all reviews are displayed. | 3 | 0 |
maxImageFileSize
| Integer Property | Maximum size of uploaded images (in bytes). | 512000 | 512000 |
userImageHeight
| Integer Property | Height of user image in px. | 150 | 150 |
userImageWidth
| Integer Property | Width of user image in px. | 200 | 200 |
userImageThumbnailHeight
| Integer Property | Height of user thumbnail image in px. | 48 | 48 |
userImageThumbnailWidth
| Integer Property | Width of user thumbnail image in px. | 48 | 48 |
userImageCommentThumbnailHeight
| Integer Property | Height of user thumbnail image in px, displayed for a comment. | 48 | 48 |
recaptchaPublicKey
| String Property | ID of your registered reCAPTCHA app | ABCD123... | |
recaptchaPrivateKey
| String Property | Secret authentication key of your registered reCAPTCHA app | ABCD123... | |
filterCategories
| LinkListProperty | Configures 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
