Configuration - <episerver.common> 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.common>
<sites>
<site>
<cache>
<entity>
<eventCounter>
<framework>
<integration>
<security>
<syndication>
<uri>
</site>
</sites>
</episerver.common>
<site>
<site connectionStringName="string"
siteId="string" >
<cache>
<entity>
<eventCounter>
<framework>
<integration>
<security>
<syndication>
<uri>
</site>
<site> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
connectionStringName |
EPiServerCommon |
The identifying name for the connection string that should be used by EPiServer Common. A connection string with the specified name must exist in connectionStrings.config. |
|
siteId |
Default |
A unique ID for this site instance. This ID is used in the host mappings section in EPiServerFramework.config. |
<cache>
<cache defaultProvider="string >
<providers>
<add name="string"
type="string" />
</providers>
</cache>
<cache> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
defaultProvider |
EPiServerCacheExpirationProvider |
The name of the cache provider that should be used. A provider with the specified name must exist in the <providers> collection. |
<add> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
name |
|
A unique name for this cache provider. |
|
type |
The full classname of the cache cache provider. |
<entity>
<entity>
<providers>
<add name="string"
type="string" />
...
</providers>
<supportedTypes>
<add provider="string"
type="string" />
...
</supportedTypes>
</entity>
<providers>/<add> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
name |
|
A unique name for this entity provider. |
|
type |
The full classname of the entity provider. |
<supportedTypes>/<add> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
provider |
|
The name of the entity provider responsible for this type. |
|
type |
The full classname of the entity class. |
<eventCounter>
<eventCounter active="bool
aggregationInterval="TimeSpan >
<events>
<add action="EventAction"
name="string"
event="string"
groupName="string"
instanceMethod="string"
type="string" />
...
</events>
</eventCounter>
<eventCounter> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
active |
true |
If the event logging should be active. |
|
aggregationInterval |
00:30:00 |
How often aggregation of collected event data should be performed. |
<add> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
action |
|
The type of action the the event represents. Possible values are Add, Update, Remove. |
|
name |
A unique name for this event. | |
|
event |
The name of the event that should be logged. | |
|
groupName |
The name used to group related events by. Events sharing the same groupName value are placed in the same presentation group. |
|
|
instanceMethod |
The name of the method that should be called to get the global instance of the class. Should be used if the class specified in the type attribute has a static instance. |
|
|
type |
The full name of the of the class that publishes the event. |
<framework>
<framework>
<activityLog logLevel="ActivityLogLevel" >
<loggedTypes>
<add type="string" />
...
</loggedTypes>
</activityLog>
<rating maxRating="int" />
<tag>
<archiving interval="TimeSpan"
maxRelatedTags="int" />
<tagCloud cacheExpiration="TimeSpan"
defaultItemCount="int"
maxItemWeight="int"
minItemWeight="int"
noiseLevel="int" />
</tag>
</framework>
<activityLog> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
logLevel |
ActivityLogLevel.Custom |
The level of logging that should be used in the application. The possible levels are: Full, None, Custom.f Custom is the default and allows you to configure specific logged types in the <loggedTypes> collection. |
<add> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
type |
|
The full classname of the class for which logging should be active. |
<rating> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
maxRating |
10 |
Defines the maximum rating value for entities. |
<archiving> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
interval |
23:59:59 |
Defines how often the tags should be archived/aggregated. |
|
maxRelatedTags |
5 |
The maximum number of related tags that will be returned by the GetRelatedTags method. |
<tagCloud> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
cacheExpiration |
23:59:59 |
The absolute TagCloud cache time. |
|
defaultItemCount |
150 |
The default nuber of TagCloudItems that will be retrieved in a TagCloud. |
|
maxItemWeight |
10 |
The maximum weight value that can be assigned to a TagCloudItem. |
|
minItemWeight |
1 |
The minimum weight value that can be assigned to a TagCloudItem. |
|
noiseLevel |
100 |
The cutoff level when a tag with a different initial letter should be taken instead of this tag, even though that would leave this tag's inital letter unrepresented in the cloud. The cutoff condition can be represented as weightOfMostPopularTagInCloud / noiseLevel > weightOfCurrentTag. |
<integration>
<integration>
<rolesToSynchronize>
<add name="string" />
...
</rolesToSynchronize>
<rolesToTransfer>
<add name="string" />
...
</rolesToTransfer>
</integration>
<rolesToSynchronize>/<add> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
name |
|
The name of the role that a user must be a member of in order to be synchronized to the EPiServer.Common database. |
<rolesToTransfer>/<add> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
name |
|
The name of the role that should be copied to the EPiServer.Common database. |
<security>
<security anonymousGroupId="int"
defaultProvider="string" />
<providers>
<add name="string"
type="string" />
...
</providers>
</security>
<security> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
anonymousGroupId |
The ID of the group that should be used to validate anonymous access. |
|
|
defaultProvider |
ClearTextPasswordProvider |
The name of the security provider that should be used. A provider with the specified name must exist in the <providers> collection. |
<add> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
name |
A unique name for this security provider. |
|
|
type |
|
The full classname of the security provider. |
<syndication>
<syndication feedUriProviderName="string"
resourceUriProviderName="string"
viewModeUriProviderName="string" />
<syndication> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
feedUriProviderName |
String.Empty |
The name of the uri provider used to locate the feed (RSS/Atom) of an entity. |
|
resourceUriProviderName |
String.Empty |
The name of the uri provider used to locate the resource (e.g. image file) represented by an entity. |
|
viewModeUriProviderName |
String.Empty |
The name of the uri provider used to locate the view (e.g. web form) for an entity. |
<uri>
<uri defaultProvider="string" >
<providers>
<add baseUri="string"
name="string"
type="string" />
</providers>
</uri>
<uri> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
defaultProvider |
The name of the uri provider that should be used. A provider with the specified name must exist in the <providers> collection. |
<add> Element Attributes
| Name | Default Value | Description |
|---|---|---|
|
baseUri |
The URI that will be used as a base for constructing the full URI to resources handled by the provider. |
|
|
name |
A unique name for this uri provider. |
|
|
type |
The full classname of the uri provider. |
