Overview of WebSphere Portal configuration service

Overview of WebSphere Portal configuration services

Starting with Version 6 of WebSphere Portal you can no longer set these properties by simply changing the property value in the properties file and restarting WebSphere Portal. The configuration for each service is stored in and accessible through the administrative console.

Table 1. WebSphere Portal services

WebSphere Portal service	Service name in the administrative console	WebSphere Portal properties file
Administrator Unique Names Mapping Service	WP AdminUniqueNamesMappingService	AdminUniqueNamesMappingService.properties
Cache Manager Service	WP CacheManagerService	CacheManagerService.properties
Configuration Service	WP ConfigService	ConfigService.properties
Content Access Service	WP PortletServiceRegistryService - Refer to Content Access Service.	PortletServiceRegistryService.properties - Refer to Content Access Service.
Data Store Service	WP DataStoreService	DataStoreService.properties
Deployment Service	WP DeploymentService	DeploymentService.properties
Loader Service	WP LoaderService	LoaderService.properties
Localizer Service	WP LocalizerService	LocalizerService.properties
Mail Service	WP MailService	MailService.properties
Navigator Service	WP NavigatorService	NavigatorService.properties
Portlet Container Service. This includes Parallel portlet rendering	WP PortletContainerService	PortletContainerService.properties
Pipe Pool Service	WP PipePoolService	PipePoolService.properties
Registry Service	WP RegistryService	RegistryService.properties
State Manager Service	WP StateManagerService	StateManagerService.properties
Portal Security Services
Access Control Data Management Service	WP AccessControlDataManagementService	AccessControlDataManagementService.properties
Authentication Service	WP AuthenticationService	AuthenticationService.properties
Credential Vault Service	WP VaultService	VaultService.properties
External Access Control Service	WP ExternalAccessControlService	ExternalAccessControlService.properties
Auditing Service	WP AuditService	AuditService.properties
Puma and Puma Validation services
Puma service	WP PumaService	PumaService.properties
Puma Validation service	WP ValidationService	ValidationService.properties
Other WebSphere Portal configuration services
Access Control Service	WP AccessControlService	AccessControlService.properties
Access Control WarmUp Service	WP AccessControlWarmUpService	AccessControlWarmUpService.properties
Credential Type Registry Service	WP CredentialTypeRegistryService	CredentialTypeRegistryService.properties
Dynamic UI Manager Factory Service	WP DynamicUIManagerFactoryService	DynamicUIManagerFactoryService.properties
Identification	WP Identification	Identification.properties
PAC Group Management Service	WP PACGroupManagementService	PACGroupManagementService.properties
Plugin Manager Service	WP PluginManagerService	PluginManagerService.properties
Portal Filter Service	WP PortalFilterService	PortalFilterService.properties
PortletFilterService	WP PortletFilterService	PortletFilterService.properties
Site Analyzer Log Service	WP SiteAnalyzerLogService	SiteAnalyzerLogService.properties
Vault Service	WP VaultService	VaultService.properties
Virtual Portal Identification Service	WP VirtualPortalIdentificationService	VirtualPortalIdentificationService.properties
WSRP Web Service Security	WP WSRPWebServiceSecurity	WSRPWebServiceSecurity.properties
Web Content Service	WP WebContentService	WebContentService.properties
Work Manager Service	WP WorkManagerService	WorkManagerService.properties

Deployment Service :--

 The Deployment Service provides services for accessing the configuration parameters required for the portlet deployment.

The portlet deployment component is responsible for the integration of portlets into the portal. It handles the correct deployment of portlet applications and their WAR files into WebSphere Portal and WebSphere Application Server. It uses the WebSphere Application Server management services for the physical deployment and management of war files in the WebSphere Application Server. Management of war files includes installing, removing, redeploying, starting, and stopping portlet applications.

Note: Portlet applications appear in the Enterprise Application list on the administrative console of WebSphere Application Server. However, you should never manage them from outside the portal. Instead, manage them by using the WebSphere Portal administration portlets or the XML configuration interface of the portal. You recognize Web applications which comprise a portlet application by their administrative name, also called the display name. It is shown in the WebSphere Application Server administrative console. You can identify the name of such a portlet application by a portal specific identifier suffix _PA_<id> . This identifier is appended to the name. An example for such a name is World_Clock_PA_3v7zl6w . The name in turn is derived from the name of the WAR file when the portlet application was first installed. This administrative name never changes, even if a different filename is used to update the portlet application.

In the following list of parameters the values given in parentheses are the default values.

was.admin.host = (localhost)

The WebSphere Application Server administrative host name. This parameter is used to adapt to the WebSphere Application Server bootstrap host name, if the default is not applicable.

use.admin.user = (true)

Use this key to select between two user authentication mechanisms for the portal Portlet Deployment Manager to authenticate with the WebSphere Application Server administrative services when portal security is enabled. Specify one of the following two possible values:

true

Use a single preset shared user ID for all portal administrative users who issue WAR deployment requests. This is the default. This is a separate user ID that is common for all users who are allowed to perform install or manage applications tasks. You must register this user ID with WebSphere Application Server Console User Administrator rights.

false

Use the actual user ID by which the administrator issues the WAR deployment request. Every portal user with portlet deployment rights must be added to the WebSphere Application Server Console User list with administrator rights. Alternatively, you can add the complete group of portal administrators to the WebSphere Application Server Console Group administrator rights.

For more information about how to use this property refer to Deploying portlets in a secure environment.

update.portlet.preserves.config.settings = (true | protect)

This parameter controls the update of portlet configuration settings during updates of portlet application WAR files. It determines whether the portlet configuration parameters from the file portlet.xml in a new WAR file should replace the existing ones, or whether the existing parameters should be preserved, and only new ones be added. The default value is protect. This prevents modifications made by an administrative user from being overwritten with default values that the portlet developer put into the portlet.xml in the new WAR file. Specify one of the following possible values:

protect | true

If you set this property to protect, this prevents modifications that an administrative user makes from being overwritten with default values that the portlet developer put into the portlet.xml in the new WAR file. This is the default value. For backward compatibility with previous portal versions, the value true remains also valid and has the same effect.

Note: Existing settings that do not appear in the new portlet.xml are not deleted. To delete existing settings and keep only those defined in the new portlet.xml, specify the value clean.

overwrite | false

If you set this property to overwrite, modifications that an administrative user made are overwritten with default values that the portlet developer put into the portlet.xml in the new WAR file. For backward compatibility with previous portal versions, the value false remains also valid and has the same effect.

Note: Existing settings that do not appear in the new portlet.xml are not deleted. To delete existing settings and keep only those defined in the new portlet.xml, specify the value clean.

clean

If you set this property to clean, existing settings are cleared and deleted, and only the new settings found in the portlet.xml are created.

 Note for portal Version 6.0: If you have portal Version 6.0 without PK28601 installed, this parameter takes only the values true or false. The default is true. In this case existing settings that do not appear in the new portlet.xml are not deleted during updates of portlet application WAR files. For portal Version 6.0, PK28601 enhances this parameter with the additional value options protect, overwrite, and clean as listed above. (Version 6.0.0.1 and later versions include PK28601.)

If you set this property to protect or true, the fields listed in the following table are preserved from modification by an updated portlet.xml file.

Table 2. Fields that are protected from modification

Portal resource	Standard API portlet application	IBM API portlet application
Portlet Application	Default locale	N/A
	Title	Title
	User attributes	Context parameter
Portlet	Name	Name
	Title	Title
	Short title	Short title
	Keywords	Keywords
	Description	Description
	Default locale and description	Default locale
	Preferences	N/A
	Remote cache settings	Cache settings
	Expiration date settings	N/A