The cookieDomain is used when a fragment request is created. All accessible cookies are copied and added to this request using the specified cookie domain. This way it is ensured that the CAE session cookie is detected by the CAE and fragments can be rendered depending on the logged on user. The cookieDomain can contain multiple cookieDomains separated by comma.

A fragment request promotes cookies from the commerce request to the CAE. However, this policy is overruled by other features (for example, the newPreviewSession URL parameter). In the unconditionalCookieNames property you can specify cookies that are always to be passed with the fragment request. The value must be a comma separated list of cookie names.

The optional parameter is used to identify the HCL Commerce system that is requesting a fragment from a CAE. It may be used to serve different sites for each commerce system that is connected to a single CMS. The strategy for resolving this parameter is implemented in the class LiveContextSiteResolver. The method findSiteFor(@NonNull FragmentParameters fragmentParameters) checks if the environment parameters has been passed as request matrix parameter. If set (for example:site:Aurora), a lookup is made if a site with a matching name and locale exists. If no site is found with the given name, the default lookup strategy, implemented in findSiteFor(@NonNull String storeId, @NonNull Locale locale) is used.

The liveCaeHost identifies the Live CAE, to be precise, the Varnish, Apache or any other proxy in front of the Live CAE. Each request made by the fragment connector will be prefixed with the urlPrefix.

The previewCaeHost identifies the Preview CAE, to be precise, the Varnish, Apache or any other proxy in front of the Preview CAE. Each request made by the fragment connector will be prefixed with the urlPrefix. The previewCaeHost is only required if you want a single HCL Commerce instance being able to access the preview CAE in case of HCL Commerce system preview and the live CAE in all other cases. Additionally, the preview mode can be invoked through an HTTP header. If you have a dedicated commerce instance for staging and separate production commerce system, you do not need to set this property. If this parameter is not set, the parameter liveCaeHost will be used instead.

This prefix identifies the web application, the servlet context and the fragment handler to handle fragment requests. The default request mapping of all the handlers within CoreMedia Blueprint that are able to handle fragment requests start with service/fragment.

Configures the template lookup path that is used when rendering CoreMedia Widget includes. Default is /Widgets-CoreMedia/com.coremedia.commerce.store.widgets.CoreMediaContentWidget/impl/templates/

Every fragment request needs to contain the tuple (storeId, locale) because it is needed to map a request to the correct site. Using defaultLocale you can set a default that is used for every request that does not contain a custom locale. You will see how it is used later, when you see the IncludeTag in action.

Every fragment request can be enriched with shop context specific data. It will be most likely user session related info, that is available in the HCL Commerce and can be provided to the backend CAE via a ContextProvider implementation. See Section 6.3, “Extending the Shop Context” for details.

The fragment connector will return error messages that occur in the CAE while rendering a fragment if the isDevelopment parameter is set to true. For production environments you should set this option to false. Errors are logged than but do not appear on the commerce page so that the end user will not recognize the errors.

Turn this flag to true if you want to disable the fragment connector. Disabled means that the fragment connector always delivers an empty fragment. This property is not mandatory. If this property is not set, the default is false.

The connection timeout in milliseconds used by the fragment connector; that is the time to establish a connection. A value of "0" means "infinite". Default is "10000".

The socket read timeout in milliseconds used by the fragment connector; that is the time to wait for a response after a connection has successfully been established. A value of "0" means "infinite". Default is "30000".

Maximum number of connections used by the fragment connector. Default is 200.

An optional access token that is sent along with all HTTP requests towards the CoreMedia preview CAE. Can be used by the CAE to authorize the access.

An optional access token that is sent along with all HTTP requests towards the CoreMedia live CAE. Can be used by the CAE to authorize the access.

If set to true the connector tries to prefetch fragments for the current commerce page.

Comma separated list of parameter names. If set, these parameters will be copied from the shop request to the CAE fragment request. All other parameter will be ignored. If set, this list has precedence over com.coremedia.fragmentConnector.parameterExcludeList.

Comma separated list of parameter names. If set, all parameters but the configured ones will be copied from the shop request to the CAE fragment request. The property com.coremedia.fragmentConnector.parameterIncludeList has precedence.