Web Content Manager configuration services
Configuration services for IBM® Web Content Manager contain settings for the general operation of the web content system, including settings for messaging, pre-rendering, and searching.
Configuration service (WCM WCMConfigService)
The Web Content Manager configuration service defines common configuration settings for Web Content Manager.
- api.use.dn
- This property specifies whether calls to the Web Content Manager API accept or
return the common name (cn) or distinguished name (dn) for user lookups.
A value of true indicates that the distinguished
name is used.
Default value: false
- defaultLibrary
- The name of the default library used for rendering and the API.
This is used if the URL or context does not contain a library.
Default value: Web Content
- default.SiteArea
- The name of the default site area to use if the URL does not contain
a site area.
Default value: SiteArea
- connect.businesslogic.module
- A list of the modules that are run as part of Web Content Manager on the portal.
Some modules are run as part of the content server itself, while others
are only accessed through a URL command. The following modules can
be defined:
- web: Core module for processing requests for web content. This module is required, so do not remove this module from the list.
- default: Core module for processing requests for web content. This module is required, so do not remove this module from the list.
- ajpe: Core module for processing requests for web content. This module is required, so do not remove this module from the list.
- custom: Core module used to enable custom workflow actions. This module is required, so do not remove this module from the list.
- syndication: Core module for managing syndication. This must be enabled on both the syndicator and subscriber servers.
- itemdispatcher: Core module used by syndication to send the requested item to a subscriber. This must be enabled on a syndicator server.
- synd: Core module for syndication. This must be enabled on a syndicator server.
- subs: Core module for subscribing to a syndicator. This must be enabled on a subscriber server.
- mail: Core module used for sending email from the email workflow action.
- plutouploadfile: Core module used by the authoring portlet to transfer files from the user's computer to the web content system.
- plutodownloadfile: Core module used by the authoring portlet to transfer files from the web content system to the user's computer.
- refreshallitems: Module to touch all items in a specified library. This will force all items to be saved. This module is accessed through a URL command.
- unlocklibrary: Module to unlock a specified library. This module is accessed through a URL command.
- ajpecatselect: Module used to update the profile information for the user making the request. This module is accessed through a URL command.
- memberfixer: Module to identify or change member IDs between environments with different LDAP topologies. This module is accessed through a URL command.
- workflowenablement: Module to enable workflow on content types that do not currently have workflow enabled. This module is accessed through a URL command.
- clearversions: Module to clear the version history of an item. This module is accessed through a URL command.
- clearhistory: Module to clear the history of an item. This module is accessed through a URL command.
Default value: web, mail, default, ajpe, ajpecatselect, memberfixer, workflowenablement, itemdispatcher, plutouploadfile, plutodownloadfile, synd, subs, syndication, refreshallitems, unlocklibrary, custom, data, clearversions, clearhistory
- connect.moduleconfig.syndication.inittasks
- Indicates whether automatic syndication is enabled. This property
should be set the same on both the syndicator and the subscriber.
If set to "false" , automatic syndication is not enabled. If set
to "true", automatic syndication is enabled.
Default value: true
- cmpnt.htmlEncodeDefault
- Indicates whether HTML encoding occurs for text in components.
Default value: true
- active.content.filtering.enable
- Indicates whether active content filtering is enabled or disabled.
Default value: true
- nestedGroupLookup.disabled
- The accessControlDataManagement.enableNestedGroups setting
does not apply to Web Content Manager.
Web Content Manager continues
to request a user's full hierarchical group membership and therefore
prevents environments using Web Content Manager from completely
disabling nested groups. This setting will control whether Web Content Manager will perform a
nested group lookup with a value of true indicating to disable nested
group lookups and a value of false indicating to perform nested group
lookups.
Default value: false
- recentitems.size
- Specifies the maximum number of recent items to store, up to a
maximum value of 100.
Default value: 10
- versioningStrategy.Default
- Specifies the default versioning behavior. Possible values include always, never,
or manual.
Default value: always
- versioningStrategy.AuthoringTemplate
- Specifies the versioning behavior used for authoring templates.
Possible values include always, never,
or manual.
Default value: always
- versioningStrategy.Component
- Specifies the versioning behavior used for components. Possible
values include always, never, or manual.
Default value: always
- versioningStrategy.Content
- Specifies the versioning behavior used for content items. Possible
values include always, never, or manual.
Default value: always
- versioningStrategy.PortalPage
- Use this property to specify the versioning behavior that you want to use for managed portal pages. Valid values include always, never, or manual.
- versioningStrategy.PresentationTemplate
- Specifies the versioning behavior used for presentation templates.
Possible values include always, never,
or manual.
Default value: always
- versioningStrategy.SiteArea
- Specifies the versioning behavior used for sites. Possible values
include always, never, or manual.
Default value: always
- versioningStrategy.Taxonomy
- Specifies the versioning behavior used for taxonomy items. Possible
values include always, never, or manual.
Default value: always
- versioningStrategy.Workflow
- Specifies the versioning behavior used for workflow items. Possible
values include always, never, or manual.
Default value: always
- resource.maxUploadSize
- Specifies the maximum size in megabytes (MB) of individual files
uploaded in file, image, rich text, and HTML components.
Default value: 16
- resourceserver.maxCacheObjectSize
- Specifies the maximum size in kilobytes (KB) of resources to be
cached by the resource server module.
Default value: 300
- resourceserver.cacheExpiryDate
- Specifies the expiry date of resources cached by the resource
server module.
Default value: REL 1M
- user.cache.enable
- Indicates whether the cache holds user object in the web content
system.
Default value: false
- admin.delete.error.percent.threshold
- The error percent threshold for a given type when deleting a library.
This value is specified as an integer from 0 to 100.
If the threshold level is reached for any type, the library deletion
task is stopped. Note: If the threshold is set to 100, the task ignores the error rate. If the threshold is set to an unsupported value, such as a value less than 0 or greater than 100, the threshold is set to the default value of 40 percent.
Default value: 40
- deployment.subscriberOnly
- Indicates whether this instance of Web Content Manager will only be subscribed
to by other servers and will never itself syndicate content to other
servers. If this property is set to true, all item
gatherers are deleted and the item changed task is not added to the
scheduler. This improves performance and is recommended for production
machines that are subscribe-only servers.
Default value: false
- deployment.itemChangedTaskDelay
- Specifies the number of seconds to use as the syndication interval,
with a minimum of 0 seconds and a maximum of 65536 seconds.
A value of 0 will prevent syndication from occurring.
The shorter the interval, the sooner an update can be sent, but because
frequent syndication can affect performance on servers with large
amounts of content, a longer interval might be required.
Default value: 30
- wcm.transaction.timeout
- Web Content Manager uses a
default transaction timeout of 120 seconds even when the value is
changed in the server. This setting was added in CF09.
Default value: 120
Messaging service (WCM MessagingService)
These settings are used when enabling the Java messaging services for web content.
- topic.publishing.enabled
- This must be set to true to enable message generation and delivery.
Default value: false
- items.topic.publishing.enabled
- Indicates whether item topics are published. This must be set
to true to enable messages for item state changes.
Default value: true
- syndication.topic.publishing.enabled
- Indicates whether syndication topics are published. This must
be set to true to enable messages for the status of syndication.
Default value: true
- prerender.topic.publishing.enabled
- Indicates whether pre-render topics are published. This must be
set to true to enable messages for the status of pre-rendering.
Default value: true
- items.topic.name
- The JNDI name of the JMS topic for status changes.
Format for item state changes: jms/IWKTopics/Items
Format for syndication state changes: jms/IWKTopics/Syndication
Format for pre-rendering state changes: jms/IWKTopics/PreRender
Default value: None
- topic.connection.secure
Set to true to enable secure topic connections. You must also set username and password.
Default value: false
- topic.connection.secure.username
Username for secure topic connections.
- topic.connection.secure.password
A clear text or encoded password for secure topic connections. The password can be encoded using the PropFilePasswordEncoder task.
Prerendering service (WCM PrerenderService)
- prerender.extended.support.enabled
- Indicates whether prererendering supports JSP and PZN requests.
Default value: false
- prerender.authenticator.classname
- Indicates the authenticator used to make a connection to the default
login URL for the portal, when an external security manager is not
installed.
Default value: com.aptrix.cacher.authentication.WCMDefaultPrerenderAutthenticator
- prerender.authenticator.credentials.classname
- The credentials used by the authenticator specified by the prerender.authenticator.classname property.
Default value: com.aptrix.cacher.authentication.DefaultPrerenderPropertiesCredentials
- prerender.default.authenticator.credentials.username
- Indicates the user name used by the DefaultPrerenderPropertiesCredentials
authenticator. If you are using a custom credential provider, this
property is not required.
Default value: portal_admin_id
- prerender.default.authenticator.credentials.password
- Indicates the password used by the DefaultPrerenderPropertiesCredentials
authenticator. If you are using a custom credential provider, this
property is not required. The password can be encoded using the PropFilePasswordEncoder
utility provided with WebSphere Application
Server.
Default value: portal_admin_password
- prerender.default.isSecure
- Indicates whether the server URLs should be formatted with secure
HTTP (https://...) or unsecured HTTP (http://...).
Default value: false
- prerender.default.hostName
- The host name of the server performing prerendering. The value
is typically represented as a WebSphere Application
Server variable (for
example, ${WCM_HOST}).
Default value: ${WCM_HOST}
- prerender.default.hostPort
- The port number for server performing prerendering. The value
is typically represented as a WebSphere Application
Server variable (for
example, ${WCM_PORT}).
Default value: ${WCM_PORT}
- prerender.default.portalContext
- The context root for the Web Content Manager web application
(for example, /wps/wcm). The value is typically represented
as a WebSphere Application
Server variable
(for example, ${WCM_WPS_CONTEXT_ROOT}).
Default value: ${WCM_WPS_CONTEXT_ROOT}
- prerender.default.portal.servlet.authenticatedContext
- The authenticated context root for the portal (for example, /myportal).
The value is typically represented as a WebSphere Application
Server variable (for
example, ${WCM_WPS_CONTEXT_ROOT}/${WCM_WPS_PERSONALIZED_HOME}).
Default value: ${WCM_WPS_CONTEXT_ROOT}/${WCM_WPS_PERSONALIZED_HOME}
- prerender.default.portal.servlet.unauthenticatedContext
- The unauthenticated context root for the portal (for example, /portal).
The value is typically represented as a WebSphere Application
Server variable (for
example, ${WCM_WPS_CONTEXT_ROOT}/${WCM_WPS_DEFAULT_HOME}).
Default value: ${WCM_WPS_CONTEXT_ROOT}/${WCM_WPS_DEFAULT_HOME}
- prerender.default.wcm.servlet.authenticatedContext
- The default secured path to the Web Content Manager servlet.
Default value: ${WCM_CONTEXT_ROOT}/myconnect
- prerender.default.wcm.servlet.unauthenticatedContext
- The default unsecured path to the Web Content Manager servlet.
Default value: ${WCM_CONTEXT_ROOT}/connect
Search service (WCM SearchService)
- SearchService.DateFormatString
- Indicates the date format to use when entering dates in search
forms and for displaying search results. Enter a supported Java date
format string. If this property is not set, then the default format
is MMM dd yyyy HH:mm:ss z.
Default value: None
- SearchService.RecrawlInterval
- Indicates the interval in hours between crawling of new web content
search sources.
Default value: 4
- SearchService.BrokenLinksExpirationAge
- Indicates the expiration age in days for broken links in new web
content search sources.
Default value: 1
- SearchService.MetaFields
- Specifies additional elements to crawl when searching for metadata.
The format for this property is elementName,key1.
To specify more than one metadata field maps, use the following format: elementName1,key1;elementName2,key2;elementName3,key3.
For example: metaText,meta.
- elementName is the name of element you want to search for metadata. Any valid element with that name in a searchable site area or content item will be crawled.
- key is the "key" that is specified in an element tag used as part of a search element design. In the previous example, the key of meta has been used. To render the content of the metaText element in a search element design, you would use the following tag: <Element context="autoFill" type="content" key="meta"/>.
Note:- Only text elements and short text elements can be searched.
- Only site areas that have been configured to be searchable will be crawled.
Default value: None
- SearchService.SearchSeed.ExcludeFileAttachments
- Indicates whether resource component attachments are included
in the search results. If this property is set to false,
the files stored in file resource elements in content items can also
be searched. Files stored in file resource elements in a site area
can also be searched as long as a default content item has been selected.
Default value: false
- SearchService.SearchSeed.ExcludeExtensions
- This property is available starting with IBM WebSphere Portal Version 8.0.0.1 CF 10. Use it to exclude individual file extensions for file attachments instead of excluding all by using the SearchService.SearchSeed.ExcludeFileAttachments property. To do so, set SearchService.SearchSeed.excludeExtensions to a value with a comma-separated list of file extensions that you want to exclude. Example: SearchService.SearchSeed.excludeExtensions=avi,mpeg,zip
- SearchService.DefaultResultPageSize
- Specifies the default number of items displayed per page for new
web content search components.
Default value: 10
- SearchService.Siapi.IIOP_URL
- The IIOP URL created for the default search service.
Default value: None
- SearchService.Siapi.EJB
- The EJB name for the JNDI associated with the default search service.
Default value: None
- SearchService.Siapi.SOAP_URL
- The SOAP URL created for the default search service.
Default value: None
- SearchService.Siapi.PSE.Type
- The type of search service used for the default search service.
Default value: None
- SearchService.DefaultCollectionName
- The default web content search collection created during installation.
Default value: WebContentCollection
- SearchService.DefaultSeedPageSize
- Specifies the number of items displayed per page for the Web Content Manager search seed servlet.
Default value: 200
Personalization service (WCM PersonalizationService)
- rulesEngine.user.nestedGroupLookup
- The accessControlDataManagement.enableNestedGroups setting
does not apply to Personalization.
Personalization continues
to request a users full hierarchical group membership and therefore
prevents environments using Personalization from completely
disabling nested groups. This setting will control whether Personalization performs a nested
group lookup with a value of true indicating to perform nested group
lookups and a value of false indicating to disable nested group lookups.
Default value: true