Configuration - <episerver.community> Section
|
Product version: |
EPiServer Community 4.0 / Relate 2 R2 |
|---|---|
|
Document version: |
1.0 |
|
Document last saved: |
Section Hierarchy - Table of Contents
This is a pseudocode description of the element structure of the episerver.community section. Each element name is also a link leading to the detailed information for that element
<episerver.community>
<sites>
<site>
<administration>
<blog>
<chat>
<contact>
<documentArchive>
<expert>
<forum>
<imageGallery>
<newsFeed>
<nml>
<onlineStatus>
<openId>
<search>
<videoGallery>
<webmail>
</site>
...
</sites>
</episerver.community>
<site>
<site licenseFilePath="string"
siteId="string" >
<administration>
<blog>
<chat>
<contact>
<documentArchive>
<expert>
<forum>
<imageGallery>
<newsFeed>
<nml>
<onlineStatus>
<openId>
<search>
<videoGallery>
<webmail>
</site>
<site> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
licenceFilePath |
The path to the license file used by this site instance. The default license path used if this attribute is not specified is "EPiServerCommunityLicense.config". |
|
|
siteId |
Default |
A unique ID for this site instance. This ID is used in the host mappings section in EPiServerFramework.config. |
<administration>
<administration enableShellSearchProviderSecurityCheck="bool">
<administrableTypes>
<add addUrl="string"
type="string"
updateUrl="string"
windowHeight="int"
windowWidth=int" />
...
</administrableTypes>
</administration>
<administration> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
enableShellSearchProviderSecurityCheck |
true |
Determine if the current user's access rights should be used to filter search results. |
<add> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
addUrl |
~/ |
URL to where objects of this type can be added. The URL will be used in a String.Format operation where {0} will be replaced by the obect's ID. Example: "EditUser.aspx&userId={0}" |
|
type |
Type |
The full name of the type that should be administrable. |
|
updateUrl |
~/ |
URLs to where objects of this type can be updated. The URL will be used in a String.Format operation where {0} will be replaced by the obect's ID. Example: "EditUser.aspx&userId={0}" |
|
windowHeight |
600 |
The default height of the admin window. |
|
windowWidth |
800 |
The default width of the admin window. |
<blog>
<blog entryIDPattern="string"
sendPingbacks="bool"
sendWeblogUpdates="bool"
syndicationInterval="TimeSpan" />
<blog> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
entryIDPattern |
entryID=([^\\=&]+) |
The regular expression used to extract the entry id from the entry uri query string. |
|
sendPingbacks |
true |
Defines if pingbacks should be sent when a new blog entry is added. |
|
sendWeblogUpdates |
true |
Defines if weblog updates should be sent when a new blog entry is added. |
|
syndicationInterval |
00:10:00 |
How often external blogs should be syndicated... |
<chat>
<chat webServiceUrl="string" />
<chat> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
webServiceUrl |
http://localhost |
The URL of the chat web service. |
<contact>
<contact reverseAdd="bool"
reverseRemove="bool" />
<contact> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
reverseAdd |
true |
Defines if add operations should automatically create two-way friendships. |
|
reverseRemove |
true |
Defines if add operations should automatically create two-way ending of friendships. |
<documentArchive>
<documentArchive physicalPath="string"
virtualPath="string" />
<documentArchive> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
physcalPath |
? |
The physical path where to store the documents. |
|
virtualPath |
? |
The virtual path where to get the documents. |
<expert>
<expert assignmentRecommendedMaxDays="int"
autoPublish="bool"
questionRelationSymmetric="bool" />
<expert> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
assignmentRecommendedMaxDays |
14 |
The recommended number of days until an expert should have answered a question. If this time span is exceeded a warning will be displayed. |
|
autoPublish |
true |
If answers should be automatically published after submission. |
|
questionRelationSymmetric |
true |
If relations between questions should be kept symmetric when changes occur. |
<forum>
<forum minNumberOfTopicRepliesToBeHot="int"
timeBackForHotTopics="TimeSpan />
<forum> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
minNumberOfTopicRepliesToBeHot |
10 |
The number of replies the topic should have had during the above mentioned period of time to be considered “hot”. |
|
timeBackForHotTopics |
10:00:00 |
How far back in time we should look to determine if a topic is considered “hot” – meaning it has a lot of attention. |
<imageGallery>
<imageGallery imageAbsoluteFilePath="string"
imgExtension="string"
imgMaxHeight="int"
imgMaxWidth="int"
imgQuality="int"
maxUserImageQuota="int"
saveOriginal="bool"
thumbnailVirtualFilePath="string" >
<thumbnailBackgroundColor b="int"
g="int"
r="int" />
<watermark format="string"
horizontalAlign="HorizontalAlign"
imageAbsoluteFilePath="string"
verticalAlign="VerticalAlign" >
<canvas b="int"
bottom="int"
g="int"
left="int"
r="int"
right="int"
top="int" />
</watermark>
</imageGallery>
<imageGallery> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
imageAbsoluteFilePath |
? |
The physical path to the directory where images should be stored. |
|
imgExtension |
.png |
The image extension and format to use for images. Available extensions are: .jpg,.gif, .png and .tif. |
|
imgMaxHeight |
1 |
The maximum height images should be saved in. |
|
imgMaxWidth |
1 |
The maximum width images should be saved in. |
|
imgQuality |
100 |
The image quality that shold be used when creating image thumbnails. |
|
maxUserImageQuota |
0 |
The maximum number of images allowed to be stored per user. |
|
saveOriginal |
Defines if the original image add to a gallery should be saved for archiving. |
|
|
thumbnailVirtualFilePath |
? |
The virtual path to the thumbnail directory. Thumbnails will be created here from the images in the previously entered directory. |
<thumbnailBackgroundColor> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
b |
0 |
The blue component value of the background color. |
|
g |
0 |
The green component value of the background color. |
| r |
0 |
The red component value of the background color. |
<watermark> Element Attributes
| Name | Default Value | Description |
|---|---|---|
| format |
|
The display format of the watermark image. Can be Exact or Proportional. Proportional tags will be scaled in proportion to thumbnails. |
|
horizontalAlign |
HorizontalAlign.Left |
The horizontal alignment of the watermark image. Can be Left or Right. |
|
imageAbsoluteFilePath |
The physical path to the watermark image file. |
|
|
verticalAlign |
VerticalAlign.Top |
The vertial alignment of the watermark image. Can be Top or Bottom. |
<canvas> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
b |
0 |
The blue component of the canvas color. -1 for transparent. |
|
bottom |
0 |
The bottom canvas in pixels. |
|
g |
0 |
The green component of the canvas color. -1 for transparent. |
|
left |
0 |
The left canvas in pixels. |
|
r |
0 |
The red component of the canvas color. -1 for transparent. |
|
right |
0 |
The right canvas in pixels. |
|
top |
0 |
The top canvas in pixels. |
<newsFeed>
<newsFeed aggregationInterval="TimeSpan"
aggregationSpan="TimeSpan" />
<newsFeed> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
aggregationInterval |
00:10:00 |
Defines how often we should attempt to aggregate user’s minifeeds into newsfeeds visible to their friends. |
|
aggregationSpan |
1.00:00:00 |
Defines the time span within which stories are to be aggregated. |
<nml>
<nml>
<allowedPatterns>
<add name="string"
pattern="string"
tagAttribute="string" />
</allowedPatterns>
<allowedValues>
<add name="string"
value="string"
tagAttribute="string" />
</allowedValues>
<attributes>
<add attributeName="string"
defaultValue="string"
name="string"
tag="string"
template="string" />
</attributes>
<categories>
<add name="string" />
</categories>
<tags>
<add category="string"
name="string"
postTemplate="string"
preTemplate="string"
trigger="string" />
</tags>
</nml>
<allowedPatterns>/<add> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
name |
x |
Idenitfies this allowedPattern definition element. |
|
pattern |
x |
The regex used to define allowed attribute values. |
|
tagAttribute |
x |
The attribute from the attributes colletion to which this allowedPattern definition belongs. |
<allowedValues>/<add> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
name |
x |
Idenitfies this allowedValue definition element. |
|
value |
x |
The string representing an allowed attribute value. |
|
tagAttribute |
x |
The attribute from the attributes colletion to which this or allowedValue definition belongs. |
<attributes>/<add> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
attributeName |
x |
Used as the key when inserting the attribute value in the a tag's PreTemplate or PostTemplate text. In the template texts “{keyname}” is replaced with the attribute value with that name. |
|
defaultValue |
x |
The default value of the NML attribute. |
|
name |
x |
Idenitfies this attribute definition element. |
|
tag |
x |
The tag from the tag colletion to which this attribute belongs. |
|
template |
x |
Defines the template text for the attribute in the output. |
<categories>/<add> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
name |
x |
The <categories> collection contains on or more category definitions. Any tags defined are under one of these categories. This means that different categories can have completely different tags defined, or different implementations of the same tag.When rendering NML, the category to use can be specified, otherwise the category named “general” is used. |
<tags>/<add> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
category |
x |
The category from the category collection to which this tag belongs. |
|
name |
x |
Idenitfies this tag definition element. |
|
postTemplate |
x |
The text that will be inserted after the text that the tag encloses. If you have “[b]foo[/b]”, this is the template for the text that should be added after “foo” in the output. |
|
preTemplate |
x |
Exactly like postTemplate except that the value of this attribute will be before the text. |
|
trigger |
x |
Identifies this tag in markup. For example if you want to be able to use “[b]foo[/b]”, the value to the trigger attribute would be “b”. |
<onlineStatus>
<onlineStatus loginTimeOut="TimeSpan"
timeOutCheckInterval="TimeSpan" />
<onlineStatus> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
loginTimeOut |
00:00:00 |
The time in minutes for a user to be inactive before he is regarded as offline. |
|
timeOutCheckInterval |
00:00:00 |
The timespan the module should check for timed out users. |
<openId>
<openId confirmPage="string"
identityUrlPattern="string" />
<openId> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
confirmPage |
~/EPiServerCommunity/OpenIDConfirm.aspx |
The address to the page used by the OpenID provider to handle non-immediate authentication requests. |
|
identityUrlPattern |
/EPiServerCommunity/Public/OpenID/User.aspx/{0} |
The base string for a regexp used to extract the user ID from the identity URL. The value will be used in a String.Format operation where {0} is replaced with "(\d+)". The (\d+) regexp matches one or more digits. |
<search>
<search active="bool"
defaultNamedIndex="string"
defaultNamedIndexingService="string"
defaultUriProvider="string"
threadSleepBetweenBulkAddBatchesInMilliSeconds="int">
<supportedTypes>
<add type="string" />
</supportedTypes>
</search>
<search> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
active |
Defines if EPiServer Community should create search index data for entites. |
|
|
defaultNamedIndex |
The index that EPiServer Community entities should be added to. If specified, the value must correspond to registered index in the configured indexing service. |
|
|
defaultNamedIndexingService |
The indexing service that should be used to store entity search index data. If specified, the value must correspond to registered indexing service in the <episerver.search> section. |
|
|
defaultUriProvider |
The name of the URI provider that should be used for generating search index data. If specified, the value must correspond to a registered URI provider in the <episerver.common> section. |
|
|
threadSleepBetweenBulkAddBatchesInMilliSeconds |
Delay between batches when bulk adding entity search index data. |
<supportedTypes>/<add> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
type |
Type |
The type of the entity which should be indexed. |
<videoGallery>
<videoGallery pollingIntervalSeconds="int" >
<cdnProvider accessKey="string"
contentHostUrl="string"
secretAccessKey="string
type="string"
uploadUrl="string"
webServiceUrl=string" />
</videoGallery>
<videoGallery> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
pollingIntervalSeconds |
60 |
The interval which the CDN should be polled for changes. Returned result may be that a video has been uploaded or a video has been successfully converted into a web friendly format. |
<cdnProvider> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
accessKey |
|
This is the customer’s account ID provided to them by EPiServer when they sign up with the Video Gallery service. |
|
contentHostUrl |
http://localhost |
Base URI to where to where video files are hosted. |
|
secretAccessKey |
|
This is the secret key that is given to the customer by EPiServer. The secret key is used to create a signature used as authentication when communicating with the CDN. |
|
type |
The full classname of the CDN Provider. |
|
|
uploadUrl |
http://localhost |
The URL used to upload videos to the CDN. |
|
webServiceUrl |
http://localhost |
The URL pointing to the CDN’s webservice. |
<webmail>
<webmail defaultPasswordProviderType="string"
diskCachePath="string" />
<webmail> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
defaultPasswordProviderType |
EPiServer.Common.Security.CleartextPasswordProvider, EPiServer.Common.Security.Internal |
The type of the password provider that should be used for handing mail account passwords. |
|
diskCachePath |
? |
The path where the webmail cache files should be placed. Please note that the specified folder must have appropriate permissions set. Note: This directory is emptied on startup |
