The SXA site definition fields
Version:
In SXA, site definitions are done at the item level. This means that you do not have to restart a website after each change in the Sitecore.config file. You can create new sites with SXA without restarting your Sitecore instance.
You can change the site definition fields in sitecore/content/
The following table lists the SXA site definition fields, their Sitecore equivalent (if any), and a description:
| Field | Sitecore equivalent | Description |
|---|---|---|
| Site Name | name | The name of the site. When you choose a name for the website, you must avoid using characters that are invalid for the website cookies. Therefore, do not use control characters, spaces (" "), semicolons, or commas in your website names. Do not use separators, for example, hyphens (“-”), with these reserved words: ancestor, and, child, descendant, div, false, following, mod, or, parent, preceding, self, true, xor. |
| Valid for environment | Defines the environment that the site is resolved for. Allowed values are empty string, *, or an environment name without blank spaces. You must define the environment name that this field refers to in your config file. | |
| Target Hostname | targetHostName | Specifies the host name used while generating links and sitemaps. |
| Host Name | hostName | Defines the host name that the site resolves to. |
| Virtual Folder | virtualFolder | Use this field to resolve sites with the same host name but located in a different virtual folder. |
| Start Item | startItem | Defines the path to the root item of the site. |
| Database | database | Defines the database containing the items that Sitecore uses for rendering the site for visitors. |
| Domain | domain | Defines the Sitecore security domain of the site. |
| Link Provider name | Defines the link provider. With SXA, you can select a different link provider for different sites. This can be useful when you have multiple sites that all have different link requirements. | |
| Linkable Site | Select to make a site linkable. | |
| Other Properties | Place for additional attributes for SXA sites that you would normally have in your site definitions config file. Sitecore or Sitecore modules might require other properties that were not explicitly specified in the Site Grouping node. You can configure these properties in the Other Properties field by specifying the key/value pair. These properties are then sent verbatim to Sitecore site provider. For example, SXA does not have a port property that lets you specify which port your site is exposed under. Another example: in an older version of SXA to enable language fallback for a site, you could add enableItemLanguageFallback and enableFieldLanguageFallback and set them to true. | |
| Language | language | The default content language for the site. |
| Language Embedding | languageEmbedding | Select to show the language in the URL. |
| Enable item language fallback | enableItemLanguageFallback | Select to enable item-level language fallback. For more information on enabling item-level language fallback, see Enable and set up language fallback, and scroll to the section about item-level fallback. Item-level language fallback is deselected by default. |
| Enable field language fallback | enableFieldLanguageFallback | Select to enable field-level language fallback. For more information on enabling field-level language fallback, see Enable and set up language fallback, and scroll to the section about field-level language fallback. Field-level language fallback is deselected by default. |
| Allow Debug | allowDebug | Controls whether presentation components collect profile and trace information, affecting whether the debugger renders information about those controls, and whether to show tracing and profiling commands in the debugging ribbon. |
| Cache Html | cacheHtml | Select to enable caching for your site. |
| Enable Preview | enablePreview | Select to enable preview on the site. |
| Enable Web Edit | enableWebEdit | Select to enable WebEdit mode for the site. |
| Enable Debugger | enableDebugger | Enable or disable debugging features, including tracing, profiling, and rendering information, and the debugging ribbon. |
| Disable Client Data | disableClientData | Select to disable storage required for CMS user interfaces for the site. |
| Disable Browser Caching | disableBrowserCaching | Set to Yes to disable browser caching for the site. Set to Default to have the value of the DisableBrowserCaching setting in the |
| Login Page | loginpage | Use this field to assign a custom SXA login page. |
| Require Login | requireLogin | Select to require users to log in to enter the site. |
| Html Cache Size (in MB) | htmlCacheSize | The maximum size of the html cache. |
| Registry Cache Size (in MB) | registry | The registry cache size for the site. |
| View State Cache Size (in MB) | CacheViewState | The view state cache size for the site. |
| Xsl Cache Size (in MB) | xsl | The xsl renderings cache size for the site. |
| Filtered Items Cache Size (in MB) | filteredItemsCacheSize | The size of the cache used to store filtered items according to the filterItems attribute. |
| Indexes | Enter your index specifications for the site. Always start with the database followed by a slash. You can then specify the language or use an asterisk (*) to include all languages. | |
| Scheme | scheme | The scheme that indicates the protocol type: http or https. |
| Port | port | The port number of the incoming URL. |
| Dictionary domain | dictionaryDomain | The default dictionary domain to use. |
| No publishable URL | noPublishableUrl | The URL of the page that handles errors if no publishable item or version of an item can be found. |
| No license URL | noLicenseUrl | The URL to redirect to if a license is missing. |
| No access URL | noAccessUrl | The URL to redirect to if access to an item is denied. |
| Link item not found | linkItemNotFoundUrl | The URL to redirect to if the linked item is not found. |
| URL Layout not found | layoutNotFoundUrl | The URL to redirect to if an item's layout is not found. |
| URL Item not found | itemNotFoundUrl | The URL to redirect to if an item is not found. |
| URL Error page URL | errorPageUrl | The URL to redirect to if a generic error occurs. |
If you have suggestions for improving this article, let us know!