Dev GuideAPI ReferenceUser Guide
HomeDev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunityDoc feedbackLog In
GitHubNuGetDev CommunityDoc feedback

The [Configure CMS](🔗) topic describes the syntax used in the description of the configuration elements.


## \<module\>

### \<module\> element attributes
NameDefault valueDescription
`helpFile` URL to the help file for this module. {culture}, {major}, {minor}, {build}, {revision} are replaced.
`productName` A product name for display. If this is not specified, the module name is used.
`clientResourceRelativePath` The client module resource relative path is combined with the resource base path and is used for paths to client resources specifically. If not defined the resource base path is used as-is. One use for this is versioning the client resources in a module.
`type` The type specifies which class to instantiate for this module instance. If this is not set, ShellModule is used.
`loadFromBin`trueWhether to load all assemblies from the bin folder of the module. Otherwise, only assemblies listed under the assemblies element are loaded.
`routeBasePath`
Optional base path for routes to the module. 
`viewFolder`
Optional name of folder containing views for the module. If not given, the expectation is that the views are in a folder named as _\<moduleName\>.Views_.
`authorizationPolicy`"DefaultShellModulePolicy"Specifies which policy that should be applied to the module. If not specified then a default policy that require any of roles **WebEditors**, **WebAdmins**, **CmsAdmins**, or **Administrators**.
`moduleJsonSerializerType`JsonSerializerType.ResolveSpecifies which JSON serializer the module should use. JsonSerializerType enum has the following values:

  - **Resolve **– If the shell module contains any Newtonsoft JSON converter that is registered in DI container, Newtonsoft is used as serializer. Otherwise, the .Net Core built-in one is used.
- **Newtonsoft **– A Newtonsoft serializer is used.
- **Net **– The .Net Core built-in serializer is used.
- **None **– None-specific serializer is registered for the module. Useful for example if the module registers a custom serializer (such as Newtonsoft or the built-in serializer with custom settings) through code.
`preferredUiJsonSerializerType`JsonSerializerType.ResolveSpecifies which JSON serializer the CMS UI should use. This can be configured if the module is part of CMS UI serialization, for example, through custom types. JsonSerializerType enum has the following values:

- **Resolve **– If the shell module contains any Newtonsoft JSON converter that is registered in DI container, Newtonsoft is used as serializer. Otherwise, the .Net Core built-in one is used.
- **Newtonsoft **– A Newtonsoft serializer is used.
- **Net **– The .Net Core built-in serializer is used.
- **None **– None-specific serializer is registered for the module. Useful for example if the module registers a custom serializer (such as Newtonsoft or the built-in serializer with custom settings) through code.
## \<assemblies\>
This list of assemblies specifies which assemblies belong to this shell module.

### \<add\> element attributes
NameDefault valueDescription
`assembly` **_Required_**. The name of an assembly that should be loaded and associated with the module.
## \<routes\>

### \<route\> element attributes
NameDefault valueDescription
`url`{moduleArea}/{controller}/{action}/{id}The URL pattern for the route. See the [Route.Url](🔗) property for details on how these values are used by the ASP.NET routing system. URL parameters are enclosed in braces ({}).
`clientSideOnly`falseDetermines whether this route only affects the client routing model.
`type` Fully-qualified name of class to instantiate for routing instead of [Route](🔗). The class must inherit [RouteBase](🔗).
`controllerPrefix` A prefix applied to all controllers routed to this route. This makes it possible to “scope” controllers so they do not conflict with application controllers.
### \<defaults\>/\<add\> element Attributes
These values specify the default values used when URL parameters (see the url attribute on the route element) are not defined in the request. See the [Route.Defaults](🔗) property for details on how the ASP.NET routing system uses these values.
NameDefault valueDescription
`key` **_Required_** – Parameter name
`value` **_Required_** – Default value for this parameter
## \<clientResources\>
This section contains definitions of client resources that should be associated with the module.

### \<add\> element attributes
This is client resource definition.
NameDefault valueDescription
`name` **_Required_** – The name of the client resource. This is used as the key when loading resources. Several resources can share the same name if they should be grouped.
`path` **_Required_** – The virtual path to the resource on this site or well-formed URL to external resource. If the virtual path is relative or partial, it is automatically resolved based on client resource base and relative paths of the module.
`resourceType` **_Required_** – Specifies the type of the resource, must be either **Script** or **Style**.
`sortIndex`0Use the sort index to specify dependencies between resources with the same name.
`isMinified`falseIndicates whether the content of this client resource is already minified.
#### \<dependencies\>/\<add\> element attribute
The list of names of client resources that this resource depends on.
NameDefault valueDescription
`name` **_Required_** – The name of the client resource that this resource depends on.
## \<dojo\>
This section contains configuration for paths and aliases used by Dojo.

### \<paths\>/\<add\> element attributes
NameDefault valueDescription
`name` **_Required_** – Dojo module identifier fragment. (For example: _epi/cms_)
`path`Scripts/[Name]Path to the module root.
### \<aliases\>/\<add\> element attributes
Aliases allow module paths to be remapped at run time.
NameDefault valueDescription
`from` **_Required_** – Module path under Dojo 1.7 (for example, _epi/cms/contentediting/editors/SelectionEditor_).
`to` **_Required_** – Module path under Dojo 1.8 (for example, _epi-cms/contentediting/editors/SelectionEditor_).
## \<clientModule\>
This section contains client-side configuration options.

### \<clientModule\> element attributes
NameDefault valueDescription
`initializer` The (JavaScript) class which has the initializer for starting the module on the client. This should inherit from the base class epi/\_Module.
#### Example of client-side initializer class

### \<moduleDependencies\>/\<add\> element attributes
Defines shell modules that this module has a dependency on on the client side.
NameDefault valueDescription
`dependency` Name of shell module that this (client-side) module depends on.
`type`RequireType of dependency. The options are:
- `Require`  – This indicates that the named module needs to be started before this module.
- `RunAfter`  – This module starts automatically after the named module has started.
You can combine the options.
### \<requiredResources\>/\<add\> element attributes
This section defines which client resources should be loaded on the client.
NameDefault valueDescription
`name` The name of the client resource that is required and should be loaded. This refers to the name attribute in `clientResources`.
## Application default module
In addition to the ordinary shell modules, there is also a module configured for the application root. This module serves two main purposes: resolving paths to the application root when no matching module is found in the module system, and enabling the application to provide functionality that would otherwise require a separate module implementation.
This default module is always added to the module system as an empty module. To configure it, place a _module.config_ file in the application root. This _module.config_ is treated like any other module configuration with the exception that the client resource base path is defaulted to _~/ClientResources_, unless configured otherwise.
## Example module manifest file