Feature Pack 6 or later

Configuration properties for content management system integration

Configure WebSphere Commerce to enable the features and behavior that is available when WebSphere Commerce is integrated with a content management system. For instance, IBM Web Content Manager. Configure the appropriate properties to set the values for your environment and store. The properties that you must set depend on how your environment is set up and the content management system that you are integrating with WebSphere Commerce.

The configuration values for the properties must be configured for each store that is to use the integration. There is no support for determining the store path value of the configuration properties. If your site has multiple stores or multiple asset stores and extended site stores, then the configuration values must be set for each store.

The following tables identify the available configuration properties for integrating WebSphere Commerce with a content management system. As an example, the following tables identify the required properties for integrating with IBM Web Content Manager and provides an example of the value to set for the properties.

Content Management System punch-out integration properties.
Configuration property Required for IBM Web Content Manager integration Description
wc.cmsPunchOut.cmsHost No The host name (including scheme, hostname, and port) of the content management system application that allows a business user to select and edit content URLs. This configuration value affects only the behavior of Management Center.

For the integration with IBM Web Content Manager, set the value for the property to be the WebSphere Portal hostname with the port and scheme set. 'http://your_WebSphere_Portal_hostname:port_number'
wc.cmsPunchOut.cmsPath No The URI of the content management system relative to the host that is specified by the wc.cmsPunchOut.cmsHost property. This configuration value affects the behavior of Management Center.
wc.cmsPunchOut.cmsEditPath Yes The URI of the content management system application that allows a business user to edit the content found at a selected content URL. This configuration value affects the behavior of Management Center. If this value is not specified, then the value of the property wc.cmsPunchOut.cmsPath is used to determine the URI.

For the integration with IBM Web Content Manager, set the value for the property to be '/wps/myportal?uri=wcs:edit'
wc.cmsPunchOut.cmsSelectPath Yes The URI of the content management system application that allows a business user to select a content URL. This configuration value affects the behavior of Management Center. If this value is not specified, then the value of the property wc.cmsPunchOut.cmsPath is used to determine the URI.

For the integration with IBM Web Content Manager, set the value for the property to be '/wps/myportal?uri=wcs:link'
wc.cmsPunchOut.enabled Yes Enables the integration. This configuration value affects only the behavior of Management Center.
true
The integration is enabled.
false
The integration is disabled

For the integration with IBM Web Content Manager, set the value for the property to be 'true'

Configuration properties for retrieving content.
Configuration property Required for IBM Web Content Manager integration Description
wc.getContent.characterEncoding No The character encoding of the content. The default value is 'UTF-8'. This configuration value affects the behavior of the wcst:getContent tag.
wc.getContent.cmsHost No The host name (including the scheme, host name, and port) of the location of production environment content. This value (along with the path) is used to replace the prefix token that is found in embedded URLs within content. This configuration value affects the behavior of the wcst:getContent tag.
wc.getContent.cmsPath No The path to the production environment location of content. This value (along with the host) is used to replace the prefix token that is found in embedded URLs within content. This configuration value affects the behavior of the wcst:getContent tag.
wc.getContent.cmsPreviewHost Yes The host name (including the scheme, host name, and port) of the location of preview content. This value (along with the path) is used to replace the prefix token that is found in embedded URLs within content. This configuration value affects the behavior of the wcst:getContent tag.

For the integration with IBM Web Content Manager, set the value for the property to be the WebSphere Portal host name. 'https://WebSphere_Portal_hostname'
wc.getContent.cmsPreviewPath Yes The path to the preview location of content. This value (along with the path) is used to replace the prefix token that is found in embedded URLs within content. This configuration value affects the behavior of the wcst:getContent tag.

For the integration with IBM Web Content Manager, set the value for the property to be '/wps/wcm/myconnect/'
wc.getContent.cmsPreviewToken Yes A prefix token that is replaced by a configurable URL prefix when the token is found in embedded URLs within preview content. The replacement URL prefix is determined by appending a configurable content path to a configurable content host. If this value is not specified, the value of the property wc.getContent.cmsToken is used. This configuration value affects the behavior of the wcst:getContent tag.

For the integration with IBM Web Content Manager, set the value for the property to be '/wps/wcm/myconnect/'
wc.getContent.cmsToken No A prefix token that is replaced by a configurable URL prefix when the token is found in embedded URLs within production environment content. The replacement URL prefix is determined by appending a configurable content path to a configurable content host. If this value is not specified, then embedded URLs are not modified. This configuration value affects the behavior of the wcst:getContent tag.
wc.getContent.connectTimeout Optional The number of milliseconds allowed to pass before a connection times out. This value is used when production environment content is retrieved from the external application. The default value is '3000'. This configuration value affects the behavior of the wcst:getContent tag.
wc.getContent.ltpaTokenDomain No The domain for the LTPA token. If the host name of the content URL matches this domain, then the LTPA token is sent with the request. If this value is not specified, then the LTPA token is sent to all domains. This configuration value affects the behavior of the wcst:getContent tag.
wc.getContent.ltpaTokenSecure No The secure connection setting for sending the LTPA token. This configuration value affects the behavior of the wcst:getContent tag. This configuration value is only used if the value of wc.getContent.sendLTPAToken is set to 'true'.
true
The LTPA token is sent to the content URL only when the URL is a secure connection
false
The LTPA token is sent for both secure and unsecure connections. The default value.
wc.getContent.previewConnectTimeout Optional The number of milliseconds allowed to pass before a connection times out. This value is used when preview content is retrieved from the external application. If this value is not specified, then the value of the property wc.getContent.connectTimeout is used. This configuration value affects the behavior of the wcst:getContent tag.
wc.getContent.previewLTPATokenDomain Yes The domain for the preview LTPA token. If the host name of the preview content URL matches this domain, then the LTPA token is sent with the request. If this value is not specified, then the value of the property wc.getContent.ltpaTokenDomain is used. This configuration value affects the behavior of the wcst:getContent tag.

For the integration with IBM Web Content Manager, set the value for the property to be the domain that is shared between your WebSphere Commerce staging server and your WebSphere Portal Server. 'your_domain_name.com'
wc.getContent.previewLTPATokenSecure Optional The secure connection setting for sending the preview LTPA token. This configuration value affects the behavior of the wcst:getContent tag in preview mode. This configuration value is only used if the value of wc.getContent.sendPreviewLTPAToken is set to 'true'.
true
The preview LTPA token is sent to the preview content URL only when the connection is secure.
false
The preview LTPA token is sent for both secure and unsecure connections.
unspecified
If the value is not specified, the value of the property wc.getContent.ltpaTokenSecure is used.
wc.getContent.previewReadTimeout Optional The number of milliseconds allowed to pass before a read times out. This value is used when preview content is retrieved. If this value is not specified, then the value of the property wc.getContent.readTimeout is used. This configuration value affects the behavior of the wcst:getContent tag.
wc.getContent.readTimeout Optional wc.getContent.readTimeout The number of milliseconds allowed to pass before a read times out. This value is used when production environment content is retrieved from the external application. The default value is '3000'. This configuration value affects the behavior of the wcst:getContent tag.
wc.getContent.sendLTPAToken No Indicates that the LTPA token of a user is sent when content is retrieved by using the wcst:getContent tag. This configuration value affects the behavior of the wcst:getContent tag.
true
The LTPA token is sent when content is being retrieved.
false
The LTPA token is not sent. The default value.
wc.getContent.sendPreviewLTPAToken Yes Indicates that the user's LTPA token is sent when preview content is retrieved by using the wcst:getContent tag. This configuration value affects the behavior of the wcst:getContent tag.
true
The LTPA token is sent when preview content is being retrieved.
false
The LTPA token is not sent.
unspecified
If the value is not specified, then the value of the property wc.getContent.sendLTPAToken is used.

For the integration with IBM Web Content Manager, set the value for the property to be 'true'
wc.getContent.useRelativeURLs No Indicates that relative URLs are used to replace the embedded content URLs that are found in production environment content that is retrieved with the wcst:getContent tag. This configuration value affects the behavior of the wcst:getContent tag.
true
Embedded content URLs are relative to the same host name as the pages that include the URLs.
false
Embedded content URLs are not relative.
This option can be overridden by setting the includeHostName attribute of the wcst:getContent tag to be 'true'.

Configuration properties for resolving content URLs.
Configuration property Required for IBM Web Content Manager integration Description
wc.resolveContentURL.cmsHost Yes The host name (including scheme, host name, and port) of the content URLs from the content management system. This host name must be configured in all stores. This configuration value affects the behavior of the wcst:resolveContentURL tag.

For the integration with IBM Web Content Manager, set the value for the property to be the host name of the WebSphere Commerce web server. 'http://your_WebSphere_Commerce_hostname.com'
wc.resolveContentURL.cmsInternalHost Optional The host name (including scheme, host name, and port) of managed content URLs that are to be used when the application server requests content through the wcst:getContent tag. If this value is not specified for the store, then the value that is specified for the property wc.resolveContentURL.cmsHost is used. This configuration value affects the behavior of the wcst:resolveContentURL tag.
wc.resolveContentURL.cmsInternalPreviewHost Optional The host name (including scheme, host name, and port) that is used in preview when the application server requests content through the wcst:getContent tag. If this value is not specified, then the system looks for a value by first checking the property wc.resolveContentURL.cmsPreviewHost, then the property wc.resolveContentURL.cmsInternalHost. Finally the system looks for the value of the property wc.resolveContentURL.cmsHost. This configuration value affects the behavior of the wcst:resolveContentURL tag.
wc.resolveContentURL.cmsPath Yes The path to the production environment location for content. This value is optional and can be omitted if the content URLs are relative to the content host. This configuration value affects the behavior of the wcst:resolveContentURL tag.

For the integration with IBM Web Content Manager, set the value for the property to be the context root of the pre-rendered content that is copied to the WebSphere Commerce web server. '/wcsstore/your_WebSphere_Commerce_store'
wc.resolveContentURL.cmsPreviewPath Yes The path to the store preview location for content. If this value is not specified, then the value of the property wc.resolveContentURL.cmsPath is used. This configuration value affects the behavior of the wcst:resolveContentURL tag.

For the integration with IBM Web Content Manager, set the value for the property to be '/spw/myportal?uri=wcs:render&link='
wc.resolveContentURL.cmsPreviewHost Yes The host name (including scheme, host name, and port) that is to be used to resolve content URLs when a user is in store preview. If this value is not specified, then the value that is specified for the property wc.resolveContentURL.cmsHost is used. This configuration value affects the behavior of the wcst:resolveContentURL tag.

For the integration with IBM Web Content Manager, set the value for the property to be your WebSphere Portal host. 'https://your_WebSphere_Portal_hostname'
wc.resolveContentURL.contentRenderType No The value of the renderType parameter, which indicates that the content is an HTML fragment that is to be embedded within a page. If the value is not specified, the default value is 'CONTENT'. The configuration value affects the behavior of the wcst:resolveContentURL tag.
wc.resolveContentURL.encode No Indicates that the content URL value is to be URL encoded before the URL value is appended to the configured path. This configuration value affects the behavior of the wcst:resolveContentURL tag.
true
Content URLs are URL encoded.
false
Content URLs are not encoded. The default value.
wc.resolveContentURL.encodeForPreview Yes Indicates that preview URLs are to be resolved by URL encoding the content URL before the URL is appended to the configured path. This configuration value affects the behavior of the wcst:resolveContentURL tag.
true
Preview content URLs are to be URL encoded.
false
Preview content URLs are not encoded.
unspecified
If this value is not specified, then the value of the property wc.resolveContentURL.encode is used.

For the integration with IBM Web Content Manager, set the value for the property to be 'true'
wc.resolveContentURL.getLinkURL Yes Indicates that URLs, which have a render type of LINK are to be retrieved from the resolved content URL. This configuration value affects the behavior of the wcst:resolveContentURL tag.
true
Indicates that link URLs are to be retrieved from the content URL.
false
The resolved URL is treated as the link URL. This is the default.

For the integration with IBM Web Content Manager, set the value for the property to be 'true'
wc.resolveContentURL.getPreviewLinkURL Yes Indicates that preview URLs, which have a render type of LINK are to be retrieved from the resolved content URL. This configuration value affects the behavior of the wcst:resolveContentURL tag.
true
Indicates that preview link URLs are to be retrieved from the content URL.
false
The resolved URL is treated as the preview link URL.
unspecified
If this value is not specified, then the value of the property wc.resolveContentURL.getLinkURL is used.

For the integration with IBM Web Content Manager, set the value for the property to be 'false'
wc.resolveContentURL.getPreviewResourceURL Yes Indicates that preview URLs, which have a render type of RESOURCE are to be retrieved from the resolved content URL. The configuration value affects the behavior of the wcst:resolveContentURL tag.
true
Indicate that preview resource URLs are to be retrieved from the content URL.
false
The resolved URL is treated as the preview resource URL.
unspecified
If this value is not specified, then the value of the property wc.resolveContentURL.getResourceURL is used.

For the integration with IBM Web Content Manager, set the value for the property to be 'false'
wc.resolveContentURL.getResourceURL Yes Indicates that URLs, which have a render type of RESOURCE are to be retrieved from the resolved content URL. The configuration value affects the behavior of the wcst:resolveContentURL tag.
true
Indicate that resource URLs are to be retrieved from the content URL.
false
The resolved URL is treated as the preview resource URL.
unspecified
If this value is not specified, then the resolved URL is treated as the resource URL.

For the integration with IBM Web Content Manager, set the value for the property to be 'true'
wc.resolveContentURL.linkRenderType No The value of the renderType parameter, which indicates that the content URL is to be rendered as a link by using the HTML anchor (A) tag. If a value is not specified, the default value is 'LINK'. The configuration value affects the behavior of the wcst:resolveContentURL tag.
wc.resolveContentURL.mimeTypeParameter No The name of a parameter in the URL that indicates the MIME type. If this value is not specified, then the default value of 'mimeType' is used. This configuration value affects the behavior of the wcst:resolveContentURL tag.
wc.resolveContentURL.renderTypeParameter No The name of a parameter in the URL that indicates how the content is to be rendered. If this value is not specified, then the default value of 'renderType' is used. The configuration value affects the behavior of the wcst:resolveContentURL tag.
wc.resolveContentURL.resourceRenderType No The value of the renderType parameter, which indicates that the content URL is an image or other resource and should be rendered in HTML according to the 'mimeType' value. If a value is not specified, the default value is 'RESOURCE'. The configuration value affects the behavior of the wcst:resolveContentURL tag.
wc.resolveContentURL.useRelativeURLs Yes Indicates that production environment content is hosted on the same host location as the page that includes the URL. The configuration value affects the behavior of the wcst:resolveContentURL tag.
true
Resolved URLs do not include the host name unless they are being resolved for email content, for preview, or for use by the getContent tag.
false
Resolved URLs do include the host name. The default value.

For the integration with IBM Web Content Manager, set the value for the property to be 'true'