IBM WebSphere Portal Plugin Manual

Preface

This document describes the functionality provided by the IBM WebSphere Portal (WP) plugin.

Refer to Deployit Reference Manual for background information on Deployit and deployment concepts.

Overview

The WP plugin is a Deployit plugin that extends the capabilities of the WAS plugin for managing deployments and resources on an existing WebSphere Portal server. It offers out of the box support for deploying/undeploying portlets, themes & skins and WP configuration, datasources. See the Features section below for details. It can easily be extended to support more deployment options or management of new artifacts/resources on WP.

Features

Deploys and undeploys Portal artifacts:
- Portlets packaged in Enterprise applications archives(EAR) and Web applications archives(WAR).
- Themes and Skins packaged in Web applications archives(WAR).
- XML access scripts including support for placeholders.
- Creates and removes Portal configurations:
  - Theme, mail and application policies.
  - XML Access based configuration items.
- Import of personalisation rules.
Full support for managing unmanaged, managed and clustered portal installations including virtual portals.
Discovers unmanaged portal installations.

Requirements

Deployit requirements
- Deployit: version 3.9+
- IBM WebSphere Portal: 6.1, 7.0 and 8.0 (Unix and Windows)
- Other Deployit Plugins: WAS plugin

Usage in Deployment Packages

The plugin works with the standard deployment package of DAR format. Please see the Packaging Manual for more details about the DAR format and the ways to compose one.

CI Reference

Configuration Item Overview

Deployables

CI	Description
wp.DeployableXmlAccessConfigurationItem	Description unavailable
wp.DeployableXmlAccessScript	Set of XML access scripts to configure WebSphere Portal
wp.Ear	JSR Portal EAR archive
wp.PersonalizationRuleSpec	Description unavailable (deployable)
wp.PolicySpec	Description unavailable
wp.ThemesAndSkinsWar	Description unavailable
wp.War	JSR Portal WAR archive

Deployeds

CI	Description
wp.DeployedXmlAccessConfigurationItem	Resource deployed using XML Access
wp.DeployedXmlAccessScript	Deployed XML Access script
wp.EarModule	EAR with values configured for a deployment
wp.PersonalizationRule	Description unavailable
wp.Policy	Description unavailable
wp.ThemesAndSkinsWarModule	Define WAR for themes and skins
wp.WarModule	WAR with values configured for a deployment

Containers

CI	Description
wp.Cluster	A WebSphere Portal cluster managed by a deployment manager
wp.UnmanagedServer	A standalone WebSphere Portal server NOT managed by any deployment manager
wp.VirtualPortal	A virtual portal that runs on top of WebSphere Portal server

Other Configuration Items

CI	Description
wp.AbstractAclMapping	Base definition for ACL mappings
wp.AclMapping	ACL mapping of a portlet
wp.AclMappingSpec	ACL mapping specification of a portlet
wp.BaseAclMapping	Define ACL mapping for users and groups
wp.BaseAclMappingSpec	Description unavailable
wp.BasePortlet	Portlet description
wp.BaseVirtualUserAndGroupsAclMapping	Define ACL mapping for virtual users and groups
wp.ClonedPortlet	Clone of a portlet
wp.ClonedPortletSpec	Clone specification of a portlet
wp.Cluster	A WebSphere Portal cluster managed by a deployment manager
wp.DeployableXmlAccessConfigurationItem	Description unavailable
wp.DeployableXmlAccessScript	Set of XML access scripts to configure WebSphere Portal
wp.DeployedXmlAccessConfigurationItem	Resource deployed using XML Access
wp.DeployedXmlAccessScript	Deployed XML Access script
wp.Ear	JSR Portal EAR archive
wp.EarModule	EAR with values configured for a deployment
wp.InBetween-BasePortletSpec	Base portlet definition for WebSphere Portal
wp.InBetween-PortletSpec	JSR Portlet for WebSphere Portal
wp.PersonalizationRule	Description unavailable
wp.PersonalizationRuleSpec	Description unavailable (deployable)
wp.Policy	Description unavailable
wp.PolicySpec	Description unavailable
wp.Portlet	Deployed portlet to WebSphere Portal runtime
wp.PortletSpec	JSR Portlet for WebSphere Portal
wp.Skin	Defines a skin
wp.SkinSpec	Specification of a skin
wp.Theme	Defines a theme
wp.ThemeSpec	Specification of a theme
wp.ThemesAndSkinsWar	Description unavailable
wp.ThemesAndSkinsWarModule	Define WAR for themes and skins
wp.UnmanagedServer	A standalone WebSphere Portal server NOT managed by any deployment manager
wp.VirtualPortal	A virtual portal that runs on top of WebSphere Portal server
wp.VirtualUserAndGroupsAclMapping	Virtual user and groups ACL mapping of a portlet
wp.VirtualUserAndGroupsAclMappingSpec	Virtual user and groups ACL mapping specification of a portlet
wp.War	JSR Portal WAR archive
wp.WarModule	WAR with values configured for a deployment

Configuration Item Details

wp.AbstractAclMapping

Virtual Type
Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Base definition for ACL mappings

		Parent
		container : CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public Properties
		deployable : CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.

wp.AclMapping

Type Hierarchy	wp.BaseAclMapping >> wp.AbstractAclMapping >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

ACL mapping of a portlet

		Parent
		container : CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public Properties
		securityLevel : ENUM [NONE, USER, PRIVILEGED_USER, CONTRIBUTOR, EDITOR, MANAGER, DELEGATOR, SECURITY_ADMINISTRATOR, ADMINISTRATOR]
		Set the security level for this mapping.
		deployable : CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		groups : SET_OF_STRING
		Define set of groups for this mapping
		users : SET_OF_STRING
		Define set of users for this mapping

wp.AclMappingSpec

Type Hierarchy	wp.BaseAclMappingSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.ConfigurationItem, udm.EmbeddedDeployable

ACL mapping specification of a portlet

		Public Properties
		groups : SET_OF_STRING
		Define set of groups for this mapping (set_of_string)
		securityLevel : STRING
		Set the security level for this mapping. (enum) values(NONE, USER, PRIVILEGED_USER, CONTRIBUTOR, EDITOR, MANAGER, DELEGATOR, SECURITY_ADMINISTRATOR, ADMINISTRATOR)
		users : SET_OF_STRING
		Define set of users for this mapping (set_of_string)

wp.BaseAclMapping

Type Hierarchy	wp.AbstractAclMapping >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Define ACL mapping for users and groups

		Parent
		container : CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public Properties
		securityLevel : ENUM [NONE, USER, PRIVILEGED_USER, CONTRIBUTOR, EDITOR, MANAGER, DELEGATOR, SECURITY_ADMINISTRATOR, ADMINISTRATOR]
		Set the security level for this mapping.
		deployable : CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		groups : SET_OF_STRING
		Define set of groups for this mapping
		users : SET_OF_STRING
		Define set of users for this mapping

wp.BaseAclMappingSpec

Virtual Type
Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable, udm.ConfigurationItem

Description unavailable

wp.BasePortlet

Virtual Type
Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Portlet description

		Parent
		container : CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Children
		aclMapping : SET_OF_CI<wp.AbstractAclMapping >
		The ACL mappings to define the access rights to this resource.

		Public Properties
		defaultLocale : STRING
		Define the default locale for this portlet.
		deployable : CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		localizedDescriptions : MAP_STRING_STRING
		Localized descriptions. Key is language format according to XML specification.
		localizedKeywords : MAP_STRING_STRING
		Localized keywords. Key is language format according to XML specification.
		localizedTitles : MAP_STRING_STRING
		Localized portlet titles. Key is language format according to XML specification.
		preferences : MAP_STRING_STRING
		Preferences
		uniqueName : STRING
		Unique name

wp.BaseVirtualUserAndGroupsAclMapping

Type Hierarchy	wp.AbstractAclMapping >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Define ACL mapping for virtual users and groups

		Parent
		container : CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public Properties
		securityLevelForAllAuthenticatedPortalUsers : ENUM [NONE, USER, PRIVILEGED_USER, CONTRIBUTOR, EDITOR, MANAGER, DELEGATOR, SECURITY_ADMINISTRATOR, ADMINISTRATOR]
		Set the security level for all authenticated portal users.
		securityLevelForAllPortalUserGroups : ENUM [NONE, USER, PRIVILEGED_USER, CONTRIBUTOR, EDITOR, MANAGER, DELEGATOR, SECURITY_ADMINISTRATOR, ADMINISTRATOR]
		Set the security level for all portal users groups.
		securityLevelForAnonymousPortalUser : ENUM [NONE, USER, PRIVILEGED_USER, CONTRIBUTOR, EDITOR, MANAGER, DELEGATOR, SECURITY_ADMINISTRATOR, ADMINISTRATOR]
		Set the security level for anonymous portal users.
		deployable : CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.

wp.ClonedPortlet

Type Hierarchy	wp.BasePortlet >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Clone of a portlet

		Parent
		container : CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Children
		aclMapping : SET_OF_CI<wp.AbstractAclMapping >
		The ACL mappings to define the access rights to this resource.

		Public Properties
		defaultLocale : STRING
		Define the default locale for this portlet.
		deployable : CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		localizedDescriptions : MAP_STRING_STRING
		Localized descriptions. Key is language format according to XML specification.
		localizedKeywords : MAP_STRING_STRING
		Localized keywords. Key is language format according to XML specification.
		localizedTitles : MAP_STRING_STRING
		Localized portlet titles. Key is language format according to XML specification.
		preferences : MAP_STRING_STRING
		Preferences
		uniqueName : STRING
		Unique name

wp.ClonedPortletSpec

Type Hierarchy	wp.InBetween-BasePortletSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.ConfigurationItem, udm.EmbeddedDeployable

Clone specification of a portlet

		Children
		aclMapping : SET_OF_CI<wp.BaseAclMappingSpec >
		List of ACL mappings of this portlet.

		Public Properties
		defaultLocale : STRING
		Define the default locale for this portlet. (string)
		localizedDescriptions : MAP_STRING_STRING
		Localized descriptions. Key is language format according to XML specification. (map_string_string)
		localizedKeywords : MAP_STRING_STRING
		Localized keywords. Key is language format according to XML specification. (map_string_string)
		localizedTitles : MAP_STRING_STRING
		Localized portlet titles. Key is language format according to XML specification. (map_string_string)
		preferences : MAP_STRING_STRING
		Preferences (map_string_string)
		uniqueName : STRING
		Unique name (string)

wp.Cluster

Type Hierarchy	was.Cluster >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces	was.WasAppContainer, udm.Taggable, was.HealthPolicyMembershipContainer, wp.WpRuntimeContainer, wp.WpContainer, python.PythonManagedContainer, was.WasContainer, udm.ConfigurationItem, udm.Container, overthere.HostContainer

A WebSphere Portal cluster managed by a deployment manager

		Parent
		cell : CI<was.DeploymentManager>
		Deployment manager that manages this this cluster

		Public Properties
		checkStartedInterval : INTEGER = 10
		Number of seconds to sleep inbetween the checking of cluster started.
		checkStoppedInterval : INTEGER = 10
		Number of seconds to sleep inbetween the checking of cluster stopped.
		containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
		Restart strategy used when deploying. Valid values are: NONE,STOP_START,RESTART. For example, if STOP_START strategy is used container will be stopped before deployment and started after the deployment. If RESTART strategy is used deployment will be executed, then container will be restarted using restart script - if there is no restart script defined deployment will be executed than container will be stopped and immediately started. Please note that it's probably better to use property containerRestartStrategy defined on was.Module and it's subtypes.
		wpAdminPassword : STRING
		Password of the administrative user.
		wpAdminUsername : STRING
		Username of the administrative user.
		wpConfigUrl : STRING
		The URL of the WebSphere Portal configuration API.
		wpHome : STRING
		Location of WebSphere Portal on the primary node.
		wpPrimaryNodeHost : CI<overthere.Host>
		The host definition of the primary node.
		wpVersion : ENUM [WP_61, WP_70]
		The version of WebSphere Portal.
		enableRippleStart : BOOLEAN

		failOnPartialApplicationStart : BOOLEAN = true
		Specify if the deployment should fail when application fails to start on all servers in the cluster.
		serverType : ENUM [PROXY_SERVER, APPLICATION_SERVER, ONDEMAND_ROUTER] = APPLICATION_SERVER
		Server type. Possible values are: PROXY_SERVER, APPLICATION_SERVER, ONDEMAND_ROUTER. Default value: APPLICATION_SERVER. Available since: WAS_70
		servers : SET_OF_CI<was.ManagedServer>
		Servers that are part of this cluster
		tags : SET_OF_STRING
		If set, only deployables with the same tag will be automatically mapped to this container.

		Hidden Properties
		restartOrder : INTEGER = 80
		Restart Order
		startOrder : INTEGER = 80
		Start Order
		startScript : STRING = was/container/start-cluster.py
		Start Script
		stopOrder : INTEGER = 20
		Stop Order
		stopScript : STRING = was/container/stop-cluster.py
		Stop Script

Control task	Parameter CI	Attributes	Description
create	was.Cluster_create	language = python, script = was/container/create-cluster.py, delegate = pythonControlTask	Creates application server cluster if it doesn't exist. It will use already associated servers as cluster members. Task will use weight property of the associated servers to assign cluster member weight.
start		language = python, script = was/container/start-cluster.py	Start cluster.
stop		language = python, script = was/container/stop-cluster.py	Stop cluster.

wp.DeployableXmlAccessConfigurationItem

Virtual Type
Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Taggable, udm.Deployable, udm.ConfigurationItem

Description unavailable

		Public Properties
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

wp.DeployableXmlAccessScript

Type Hierarchy	udm.BaseDeployableFolderArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FolderArtifact

Set of XML access scripts to configure WebSphere Portal

		Public Properties
		createScript : STRING = install.xml
		XML Access Script used to install. Also used during update if no update script is specified.
		checksum : STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		destroyScript : STRING = uninstall.xml
		XML Access Script used to uninstall. Also used during update if no update script is specified.
		excludeFileNamesRegex : STRING
		Regular expression that matches file names that must be excluded from scanning
		fileUri : STRING
		The URI pointing to the (remote) location of the file this artifact represents
		modifyScript : STRING
		XML Access Script used to update from a previous version.
		placeholders : SET_OF_STRING
		Placeholders detected in this artifact
		scanPlaceholders : BOOLEAN = true
		Whether to scan this artifact for placeholders when it is imported
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

		Hidden Properties
		createOrder : INTEGER = 50
		Order of creation
		destroyOrder : INTEGER = 50
		Order of destruction
		modifyOrder : INTEGER = 50
		Order of modification
		textFileNamesRegex : STRING = .+\.(cfg \| conf \| config \| ini \| properties \| props \| txt \| asp \| aspx \| htm \| html \| jsf \| jsp \| xht \| xhtml \| sql \| xml \| xsd \| xsl \| xslt)
		Regular expression that matches file names of text files
		delimiters : STRING = {{ }}
		The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
		fileEncodings : MAP_STRING_STRING = {.+\.properties=ISO-8859-1}
		A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

wp.DeployedXmlAccessConfigurationItem

Virtual Type
Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Deployed, udm.ConfigurationItem

Resource deployed using XML Access

		Parent
		container : CI<udm.Container>
		The container on which this deployed runs.

		Public Properties
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden Properties
		createOrder : INTEGER = 50
		Create Order
		createScript : STRING
		Create Script
		destroyOrder : INTEGER = 50
		Destroy Order
		destroyScript : STRING
		Destroy Script
		modifyOrder : INTEGER = 50
		Modify Order
		modifyScript : STRING
		Modify Script

Control task	Parameter CI	Attributes	Description
reinstall			Reinstall

wp.DeployedXmlAccessScript

Type Hierarchy	udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Deployed XML Access script

		Parent
		container : CI<udm.Container>
		The container on which this deployed runs.

		Public Properties
		createScript : STRING
		XML Access Script used to install. Also used during update if no update script is specified.
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.
		destroyScript : STRING
		XML Access Script used to uninstall. Also used during update if no update script is specified.
		modifyScript : STRING
		XML Access Script used to update from a previous version.
		placeholders : MAP_STRING_STRING
		A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>

		Hidden Properties
		createOrder : INTEGER = 79
		Order of creation
		destroyOrder : INTEGER = 21
		Order of destruction
		modifyOrder : INTEGER = 21
		Order of modification

Control task	Parameter CI	Attributes	Description
reinstall			Reinstall the XML Access script

wp.Ear

Type Hierarchy	was.Ear >> jee.Ear >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

JSR Portal EAR archive

		Children
		ejbModules : SET_OF_CI<was.EmbeddedEjbModuleSpec>
		Specify EJB modules contained by this enterprise application.
		portlets : SET_OF_CI<wp.PortletSpec >
		List of portlets to register.
		sessionManagers : SET_OF_CI<was.SessionManagerSpec>
		Specify the session manager options for the application and modules.
		webModules : SET_OF_CI<was.EmbeddedWebModuleSpec>
		Specify Web modules contained by this enterprise application.

		Public Properties
		additionalInstallFlags : SET_OF_STRING
		The additional install flags to be passed to AdminApp.install (set_of_string)
		allowDispatchRemoteInclude : STRING
		Specifies whether an application can dispatch includes to resources across web modules in different Java(TM) virtual machines in a managed node environment through the standard request dispatcher mechanism. (boolean)
		allowServiceRemoteInclude : STRING
		Specifies whether an application can service an include request from an application. (boolean)
		appEdition : STRING
		Edition used by this application. (string)
		applyRestartStrategyOnNoop : STRING
		When true, the restart strategy is apply for a NOOP operation (boolean) default(false)
		asyncRequestDispatchType : STRING
		Enables asynchronous dispatching and specifies how to aggregate the content. (enum) values(DISABLED, SERVER_SIDE, CLIENT_SIDE) default(DISABLED)
		autoScanForPortlets : BOOLEAN = false
		When enabled the archive will be scanned for portlets and all portlets will be added regardless of the registered portlets.
		checksum : STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		classloaderMode : STRING
		Specifies whether classes are loaded using the parent class loader before the application class loader. (enum) values(PARENT_FIRST, PARENT_LAST)
		containerRestartStrategy : STRING
		The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container. (enum) values(NONE, STOP_START, RESTART) default(NONE)
		createMBeansForResources : STRING
		Specifies whether to create MBean files for various resources (such as servlets or JSP files) within an application. (boolean)
		disableJspRuntimeCompilation : STRING
		Specify to disable JSP runtime compilation. Values: 'Yes', 'No'(default). (string) default(No)
		drainageInterval : STRING
		Drainage interval in seconds. (integer) default(30)
		editionDescription : STRING
		Edition description used by this application. (string)
		enableDistribution : STRING
		Specifies whether the application is distributed automatically to other nodes on the cell. The default is for automatic distribution. (boolean) default(true)
		enableJspClassReloading : STRING
		Specify JSP reloading for Web modules. (boolean) default(true)
		excludeFileNamesRegex : STRING
		Regular expression that matches file names that must be excluded from scanning
		fileUri : STRING
		The URI pointing to the (remote) location of the file this artifact represents
		groupSize : STRING
		Specifies num of members in a cluster. (integer) default(1)
		isEdition : STRING
		Edition used by this application. (boolean) default(false)
		jdkSourceLevel : STRING
		Specify JDK source level. (string) default(15)
		jsfImplementation : STRING
		If set, specifies the name of the JSF implementation to use. Otherwise uses the platform default. Only supported on WAS 7.0 and up. Warning: On WAS8.0 and higher, setting this property will update the JSF implementation on all installed applications (for more info see IBM PM88239). (string)
		jspClassPath : STRING
		Specify JSP precompiler classpath. (string) default(jspcp)
		jspReloadInterval : STRING
		The JSP reload interval in seconds. Only applicable if 'enableJspClassReloading' is set. (integer) default(10)
		moduleDestination : STRING
		Specifies the full path name of the enterprise application binary file. The path name can be an absolute path or can contain a path map variable such as APP_INSTALL_ROOT. (string)
		placeholders : SET_OF_STRING
		Placeholders detected in this artifact
		preCompileJsps : STRING
		Specify whether to precompile JavaServer Pages (JSP) files as a part of installation. The default is not to precompile JSP files. (boolean) default(false)
		reloadEnabled : STRING
		Specifies whether to override the class reloading options that are defined for all web and EJB modules in this application. (boolean)
		reloadInterval : STRING
		Specifies the number of seconds between each scan of the file system for updated application files. Set this interval to 0 to disable class reloading for all web and EJB modules in the application. (integer)
		resetStrategy : STRING
		Indicates type of reset strategy. (enum) values(SOFT, HARD) default(SOFT)
		restartStrategy : STRING
		The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start. (enum) values(NONE, STOP, START, STOP_START) default(STOP_START)
		roleMappings : MAP_STRING_STRING
		Security role to group mapping. Mapping is possible to either a dedicated group or to one of WebSphere predefined groups: AllAuthenticatedInTrustedRealms, AllAuthenticated, Everyone. (map_string_string)
		roleUserMappings : MAP_STRING_STRING
		Security role to user mapping (map_string_string)
		rolloutStrategy : STRING
		Indicates type of rollout strategy. (enum) values(ATOMIC, GROUPED) default(GROUPED)
		runAsRoleMappings : MAP_STRING_STRING
		Security role to user, password mapping. Given a role 'myRole' mapped to a user called 'myUser' and a password of 'myPassword'. You will have to enter 2 keys, namely 'myRole_user' and 'myRole_password'. (map_string_string)
		scanPlaceholders : BOOLEAN = false
		Whether to scan this artifact for placeholders when it is imported
		sharedLibraryNames : LIST_OF_STRING
		Shared libraries used by this application. (list_of_string)
		startingWeight : STRING
		Specifies the order in which modules are started when the server starts. The module with the lowest starting weight is started first. (integer) default(1)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		useFullPackageNames : STRING
		Specify to use full package names in JSPs. Values: 'Yes'(default), 'No'. (string) default(Yes)
		useMetadataFromBinaries : STRING
		Specifies whether the application server uses the bindings, extensions, and deployment descriptors located with the application deployment document, the deployment.xml file (default), or those located in the .ear file of the application. (boolean)
		virtualHostName : STRING
		Virtual host this application should be mapped to. (string)
		warClassLoaderPolicy : STRING
		Specifies whether there is one class loader for all WAR files in the application or a separate class loader for each WAR file in the application. (enum) values(SINGLE, MULTIPLE)
		warClassloaderMode : STRING
		WAR-level class loader mode. (enum) values(PARENT_FIRST, PARENT_LAST)
		webServerNames : SET_OF_STRING
		Specify the Web servers as targets that serve as routers for requests to this application. (set_of_string)

		Hidden Properties
		textFileNamesRegex : STRING = .+\.(cfg \| conf \| config \| ini \| properties \| props \| txt \| asp \| aspx \| htm \| html \| jsf \| jsp \| xht \| xhtml \| sql \| xml \| xsd \| xsl \| xslt)
		Regular expression that matches file names of text files
		delimiters : STRING = {{ }}
		The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
		fileEncodings : MAP_STRING_STRING = {.+\.properties=ISO-8859-1}
		A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

wp.EarModule

Type Hierarchy	was.EarModule >> was.Module >> was.ExtensibleDeployedArtifact >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, was.ConfigurableModule, udm.ConfigurationItem, udm.DerivedArtifact

EAR with values configured for a deployment.

		Parent
		container : CI<udm.Container>
		The container on which this deployed runs.

		Children
		ejbModules : SET_OF_CI<was.EmbeddedEjbModule>
		Specify EJB modules contained by this enterprise application.
		portlets : SET_OF_CI<wp.Portlet >
		List of portlets to register.
		sessionManagers : SET_OF_CI<was.SessionManager>
		Specify the session manager options for the application and modules.
		webModules : SET_OF_CI<was.EmbeddedWebModule>
		Specify Web modules contained by this enterprise application.

		Public Properties
		containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
		The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
		restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
		The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
		additionalInstallFlags : SET_OF_STRING = [-usedefaultbindings]
		The additional install flags to be passed to AdminApp.install
		allowDispatchRemoteInclude : BOOLEAN
		Specifies whether an application can dispatch includes to resources across web modules in different Java(TM) virtual machines in a managed node environment through the standard request dispatcher mechanism.
		allowServiceRemoteInclude : BOOLEAN
		Specifies whether an application can service an include request from an application.
		appEdition : STRING
		Edition used by this application.
		applyRestartStrategyOnNoop : BOOLEAN = false
		When true, the restart strategy is apply for a NOOP operation
		asyncRequestDispatchType : ENUM [DISABLED, SERVER_SIDE, CLIENT_SIDE] = DISABLED
		Enables asynchronous dispatching and specifies how to aggregate the content.
		autoScanForPortlets : BOOLEAN = false
		When enabled the archive will be scanned for portlets and all portlets will be added regardless of the registered portlets.
		classloaderMode : ENUM [PARENT_FIRST, PARENT_LAST]
		Specifies whether classes are loaded using the parent class loader before the application class loader.
		createMBeansForResources : BOOLEAN
		Specifies whether to create MBean files for various resources (such as servlets or JSP files) within an application.
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.
		disableJspRuntimeCompilation : STRING = No
		Specify to disable JSP runtime compilation. Values: 'Yes', 'No'(default).
		drainageInterval : INTEGER = 30
		Drainage interval in seconds.
		editionDescription : STRING
		Edition description used by this application.
		enableDistribution : BOOLEAN = true
		Specifies whether the application is distributed automatically to other nodes on the cell. The default is for automatic distribution.
		enableJspClassReloading : BOOLEAN = true
		Specify JSP reloading for Web modules.
		groupSize : INTEGER = 1
		Specifies num of members in a cluster.
		isEdition : BOOLEAN = false
		Edition used by this application.
		jdkSourceLevel : STRING = 15
		Specify JDK source level.
		jsfImplementation : STRING
		If set, specifies the name of the JSF implementation to use. Otherwise uses the platform default. Only supported on WAS 7.0 and up. Warning: On WAS8.0 and higher, setting this property will update the JSF implementation on all installed applications (for more info see IBM PM88239).
		jspClassPath : STRING = jspcp
		Specify JSP precompiler classpath.
		jspReloadInterval : INTEGER = 10
		The JSP reload interval in seconds. Only applicable if 'enableJspClassReloading' is set.
		moduleDestination : STRING
		Specifies the full path name of the enterprise application binary file. The path name can be an absolute path or can contain a path map variable such as APP_INSTALL_ROOT.
		placeholders : MAP_STRING_STRING
		A Map containing all the placeholders mapped to their values. Special values are or
		preCompileJsps : BOOLEAN = false
		Specify whether to precompile JavaServer Pages (JSP) files as a part of installation. The default is not to precompile JSP files.
		reloadEnabled : BOOLEAN
		Specifies whether to override the class reloading options that are defined for all web and EJB modules in this application.
		reloadInterval : INTEGER
		Specifies the number of seconds between each scan of the file system for updated application files. Set this interval to 0 to disable class reloading for all web and EJB modules in the application.
		resetStrategy : ENUM [SOFT, HARD] = SOFT
		Indicates type of reset strategy.
		roleMappings : MAP_STRING_STRING
		Security role to group mapping. Mapping is possible to either a dedicated group or to one of WebSphere predefined groups: AllAuthenticatedInTrustedRealms, AllAuthenticated, Everyone.
		roleUserMappings : MAP_STRING_STRING
		Security role to user mapping
		rolloutStrategy : ENUM [ATOMIC, GROUPED] = GROUPED
		Indicates type of rollout strategy.
		runAsRoleMappings : MAP_STRING_STRING
		Security role to user, password mapping. Given a role 'myRole' mapped to a user called 'myUser' and a password of 'myPassword'. You will have to enter 2 keys, namely 'myRole_user' and 'myRole_password'.
		sharedLibraries : SET_OF_CI<was.SharedLibrary>
		Shared libraries used by this application. (DEPRECATED. Prefer using: sharedLibraryNames)
		sharedLibraryNames : LIST_OF_STRING
		Shared libraries used by this application.
		startingWeight : INTEGER = 1
		Specifies the order in which modules are started when the server starts. The module with the lowest starting weight is started first.
		useFullPackageNames : STRING = Yes
		Specify to use full package names in JSPs. Values: 'Yes'(default), 'No'.
		useMetadataFromBinaries : BOOLEAN
		Specifies whether the application server uses the bindings, extensions, and deployment descriptors located with the application deployment document, the deployment.xml file (default), or those located in the .ear file of the application.
		virtualHost : CI<was.VirtualHost>
		Virtual host this application should be mapped to. (DEPRECATED. Prefer using: virtualHostName)
		virtualHostName : STRING
		Virtual host this application should be mapped to.
		warClassLoaderPolicy : ENUM [SINGLE, MULTIPLE]
		Specifies whether there is one class loader for all WAR files in the application or a separate class loader for each WAR file in the application.
		warClassloaderMode : ENUM [PARENT_FIRST, PARENT_LAST]
		WAR-level class loader mode.
		webServerNames : SET_OF_STRING
		Specify the Web servers as targets that serve as routers for requests to this application.
		webServers : SET_OF_CI<was.ManagedWebServer>
		Specify the Web servers as targets that serve as routers for requests to this application. (DEPRECATED. Prefer using: webServerNames)

		Hidden Properties
		createEditionedOrder : INTEGER = 10
		The order in which a create step for Editioned application will be executed(was85nd only).
		createOrder : INTEGER = 70
		The order in which a create step will be executed.
		createScript : STRING = was/application/deploy-application.py
		Python wsadmin script invoked to create a Java EE artifact.
		createVerb : STRING = Deploy
		The word is used to prefix a step description for the create operation.
		createXmlAccessOrder : INTEGER = 77
		Create Xml Access Order
		createXmlAccessScript : STRING = wp/portletRegister.xml
		Create Xml Access Script
		destroyOrder : INTEGER = 30
		The order in which a destroy step will be executed.
		destroyScript : STRING = was/application/undeploy-application.py
		Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
		destroyVerb : STRING = Undeploy
		The word that is used to prefix a step description for the destroy operation.
		destroyXmlAccessOrder : INTEGER = 20
		Destroy Xml Access Order
		destroyXmlAccessScript : STRING = wp/portletUnregister.xml
		Destroy Xml Access Script
		detectInstallRootOrder : INTEGER = 75
		Detect Install Root Order
		detectInstallRootScript : STRING = wp/jython/get-war-install-location.py
		Detect Install Root Script
		discoverOrder : INTEGER = 50
		The order in which a discover step will be executed.
		discoverScript : STRING = was/application/discover-inspect-ear-module.py
		Discover Script
		libraryScripts : LIST_OF_STRING = [was/application/discover-app-module-lib.py, was/application/deploy-application-lib.py]
		List of scripts to be appended to the deployed's runtime script
		modifyOrder : INTEGER = 70
		The order in which a modify step will be executed.
		modifyVerb : STRING = Update
		The word is used to prefix a step description for the modify operation.
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Noop
		Noop Verb
		retryAttemptsForAppReadyCheck : INTEGER = 6
		Number of retry attempts to check if an application has been distributed before attempting the application start.
		rolloutEditionedOrder : INTEGER = 20
		The order in which a rollout step will be executed.
		rolloutEditionedScript : STRING = was/application/rollout-edition.py
		Python wsadmin script invoked to perform rollout.
		rolloutEditionedVerb : STRING = Rollout
		The word that is used to prefix a step description for the rollout operation.
		standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
		Standard properties that are not exposed to any python wsadmin script.
		startOrder : INTEGER = 90
		The order in which a start step will be executed.
		startVerb : STRING = Start
		The word that is used to prefix a step description for the start operation.
		stopOrder : INTEGER = 10
		The order in which a stop step will be executed.
		stopVerb : STRING = Stop
		The word that is used to prefix a step description for the stop operation.
		syncAfterCreateOrder : INTEGER = 75
		The order in which a synchronize after create step will be executed.
		syncAfterDestroyOrder : INTEGER = 35
		The order in which a synchronize after destroy step will be executed.
		syncAfterModifyOrder : INTEGER = 75
		The order in which a synchronize after modify step will be executed.
		exposeDeployedApplication : BOOLEAN = false
		Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
		installLocation : STRING
		Install Location
		modifyScript : STRING
		Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
		noopScript : STRING
		Python script invoked for the noop operation.
		startScript : STRING = was/application/start-application.py
		Python wsadmin script invoked to start running a Java EE artifact.
		stopScript : STRING = was/application/stop-application.py
		Python script invoked to stop a Java EE artifact or Java EE resource

wp.InBetween-BasePortletSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable, udm.ConfigurationItem

Base portlet definition for WebSphere Portal

		Children
		aclMapping : SET_OF_CI<wp.BaseAclMappingSpec >
		List of ACL mappings of this portlet.

wp.InBetween-PortletSpec

Type Hierarchy	wp.InBetween-BasePortletSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.ConfigurationItem, udm.EmbeddedDeployable

JSR Portlet for WebSphere Portal

		Children
		aclMapping : SET_OF_CI<wp.BaseAclMappingSpec >
		List of ACL mappings of this portlet.
		clones : SET_OF_CI<wp.ClonedPortletSpec >
		List of clones of this portlet.

wp.PersonalizationRule

Type Hierarchy	generic.ExecutedScriptWithDerivedArtifact >> generic.ExecutedScript >> generic.AbstractDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Description unavailable

		Parent
		container : CI<udm.Container>
		The container on which this deployed runs.

		Public Properties
		path : STRING
		Target path for Personalization rule
		deleteChildren : BOOLEAN = false
		Delete children of rule in target environment?
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.
		placeholders : MAP_STRING_STRING
		A key/value pair mapping of placeholders in the deployed artifact to their values. Special values are and
		repository : STRING
		Target repository for Personalization rule. The default repository is used when no target repository is specified.
		workspace : STRING
		Target workspace for Personalization rule. The default workspace is used when no target workspace is specified.

		Hidden Properties
		createOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the create step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		createOrder : INTEGER = 50
		The order of the step in the step list for the create operation.
		createScript : STRING = wp/shell/InstallPersonalizationRule
		Classpath to the script that is uploaded and executed on the generic container for the create operation.
		createVerb : STRING = Create
		Create Verb
		destroyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the destroy step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		destroyOrder : INTEGER = 40
		The order of the step in the step list for the destroy operation.
		destroyVerb : STRING = Destroy
		Destroy Verb
		modifyOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the modify step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		modifyOrder : INTEGER = 50
		The order of the step in the step list for the modify operation.
		modifyVerb : STRING = Modify
		Modify Verb
		noopOptions : SET_OF_STRING = [uploadArtifactData, uploadClasspathResources, uploadTemplateClasspathResources]
		Options for the noop step (1 or more of: none,uploadArtifactData,uploadClasspathResources,uploadTemplateClasspathResources).
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Modify
		Noop Verb
		classpathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the script.
		destroyScript : STRING
		Classpath to the script that is uploaded and executed on the generic container for the destroy operation.
		inspectClasspathResources : SET_OF_STRING
		Additional classpath resources that should be uploaded to the working directory before executing the inspect script.
		inspectScript : STRING
		Classpath to the script used to inspect the generic container.
		inspectTemplateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the inspect script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.
		modifyScript : STRING
		Classpath to the script that is uploaded and executed on the generic container for the modify operation.
		noopScript : STRING
		Classpath to the script that is uploaded and executed on the generic container for the noop operation.
		remoteWorkingDirectoryPath : STRING
		Name of working directory on target host. Default is to create a temporary directory which is deleted when connection is closed.
		restartRequired : BOOLEAN = false
		The generic container requires a restart for the action performed by this deployed.
		restartRequiredForNoop : BOOLEAN = false
		The generic container requires a restart for the NOOP action performed by this deployed.
		retainRemoteWorkingDirectory : BOOLEAN = false
		Retain the specified working directory on target host after completion.
		templateClasspathResources : SET_OF_STRING
		Additional template classpath resources that should be uploaded to the working directory before executing the script.The template is first rendered and the rendered content copied to a file, with the same name as the template, in the working directory.

wp.PersonalizationRuleSpec

Type Hierarchy	udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

Description unavailable (deployable)

		Public Properties
		checksum : STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		deleteChildren : STRING
		Delete children of rule in target environment? (boolean) default(false)
		excludeFileNamesRegex : STRING
		Regular expression that matches file names that must be excluded from scanning
		fileUri : STRING
		The URI pointing to the (remote) location of the file this artifact represents
		path : STRING
		Target path for Personalization rule (string)
		placeholders : SET_OF_STRING
		Placeholders detected in this artifact
		repository : STRING
		Target repository for Personalization rule. The default repository is used when no target repository is specified. (string)
		scanPlaceholders : BOOLEAN = true
		Whether to scan this artifact for placeholders when it is imported
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		workspace : STRING
		Target workspace for Personalization rule. The default workspace is used when no target workspace is specified. (string)

		Hidden Properties
		textFileNamesRegex : STRING = .+\.(cfg \| conf \| config \| ini \| properties \| props \| txt \| asp \| aspx \| htm \| html \| jsf \| jsp \| xht \| xhtml \| sql \| xml \| xsd \| xsl \| xslt)
		Regular expression that matches file names of text files
		delimiters : STRING = {{ }}
		The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
		fileEncodings : MAP_STRING_STRING = {.+\.properties=ISO-8859-1}
		A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

wp.Policy

Type Hierarchy	udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Description unavailable

		Parent
		container : CI<udm.Container>
		The container on which this deployed runs.

		Public Properties
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.
		placeholders : MAP_STRING_STRING
		A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
		policyLabel : STRING
		Policy label

		Hidden Properties
		registerScript : STRING = wp/policyInstall.xml
		Register Script
		registerScriptOrder : INTEGER = 77
		Register Script Order
		unregisterScript : STRING = wp/policyUninstall.xml
		Unregister Script
		unregisterScriptOrder : INTEGER = 20
		Unregister Script Order
		policyName : STRING
		Policy Name

wp.PolicySpec

Type Hierarchy	udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

Description unavailable

		Public Properties
		policyType : ENUM [COMPOSITE_APPLICATION, MAIL, THEME]
		Type
		checksum : STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		excludeFileNamesRegex : STRING
		Regular expression that matches file names that must be excluded from scanning
		fileUri : STRING
		The URI pointing to the (remote) location of the file this artifact represents
		placeholders : SET_OF_STRING
		Placeholders detected in this artifact
		policyLabel : STRING
		Policy label
		scanPlaceholders : BOOLEAN = true
		Whether to scan this artifact for placeholders when it is imported
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

		Hidden Properties
		textFileNamesRegex : STRING = .+\.(cfg \| conf \| config \| ini \| properties \| props \| txt \| asp \| aspx \| htm \| html \| jsf \| jsp \| xht \| xhtml \| sql \| xml \| xsd \| xsl \| xslt)
		Regular expression that matches file names of text files
		delimiters : STRING = {{ }}
		The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
		fileEncodings : MAP_STRING_STRING = {.+\.properties=ISO-8859-1}
		A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

wp.Portlet

Type Hierarchy	wp.BasePortlet >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Deployed portlet to WebSphere Portal runtime.

		Parent
		container : CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Children
		aclMapping : SET_OF_CI<wp.AbstractAclMapping >
		The ACL mappings to define the access rights to this resource.
		clones : SET_OF_CI<wp.ClonedPortlet >
		List of clones of this portlet.

		Public Properties
		portletName : STRING
		Portlet Name
		defaultLocale : STRING
		Define the default locale for this portlet.
		deployable : CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		localizedDescriptions : MAP_STRING_STRING
		Localized descriptions. Key is language format according to XML specification.
		localizedKeywords : MAP_STRING_STRING
		Localized keywords. Key is language format according to XML specification.
		localizedTitles : MAP_STRING_STRING
		Localized portlet titles. Key is language format according to XML specification.
		preferences : MAP_STRING_STRING
		Preferences
		uniqueName : STRING
		Unique name

wp.PortletSpec

Type Hierarchy	wp.InBetween-PortletSpec >> wp.InBetween-BasePortletSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable, udm.ConfigurationItem

JSR Portlet for WebSphere Portal

		Children
		aclMapping : SET_OF_CI<wp.BaseAclMappingSpec >
		List of ACL mappings of this portlet.
		clones : SET_OF_CI<wp.ClonedPortletSpec >
		List of clones of this portlet.

		Public Properties
		defaultLocale : STRING
		Define the default locale for this portlet. (string)
		localizedDescriptions : MAP_STRING_STRING
		Localized descriptions. Key is language format according to XML specification. (map_string_string)
		localizedKeywords : MAP_STRING_STRING
		Localized keywords. Key is language format according to XML specification. (map_string_string)
		localizedTitles : MAP_STRING_STRING
		Localized portlet titles. Key is language format according to XML specification. (map_string_string)
		portletName : STRING
		Portlet Name (string)
		preferences : MAP_STRING_STRING
		Preferences (map_string_string)
		uniqueName : STRING
		Unique name (string)

wp.Skin

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Defines a skin

		Parent
		container : CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public Properties
		directoryName : STRING
		Directory Name
		markup : STRING
		Markup
		skinName : STRING
		Skin Name
		deployable : CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		objectId : STRING
		Object Id
		uniqueName : STRING
		Unique Name

wp.SkinSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable, udm.ConfigurationItem

Specification of a skin.

		Public Properties
		directoryName : STRING
		Directory Name (string)
		markup : STRING
		Markup (string)
		objectId : STRING
		Object Id (string)
		skinName : STRING
		Skin Name (string)
		uniqueName : STRING
		Unique Name (string)

wp.Theme

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Defines a theme

		Parent
		container : CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public Properties
		allowedSkins : SET_OF_STRING
		Set of allowed skins
		defaultSkin : STRING
		Unique name of the default skin
		directoryName : STRING
		Directory Name
		markup : STRING
		Markup
		themeName : STRING
		Theme Name
		deployable : CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		objectId : STRING
		Object Id
		uniqueName : STRING
		Unique Name

wp.ThemeSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable, udm.ConfigurationItem

Specification of a theme.

		Public Properties
		allowedSkins : SET_OF_STRING
		Set of allowed skins (set_of_string)
		defaultSkin : STRING
		Unique name of the default skin (string)
		directoryName : STRING
		Directory Name (string)
		markup : STRING
		Markup (string)
		objectId : STRING
		Object Id (string)
		themeName : STRING
		Theme Name (string)
		uniqueName : STRING
		Unique Name (string)

wp.ThemesAndSkinsWar

Type Hierarchy	was.War >> jee.War >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

Description unavailable

		Children
		sessionManagers : SET_OF_CI<was.SessionManagerSpec>
		Specify the session manager options for the application and modules.
		skins : SET_OF_CI<wp.SkinSpec >
		List of skins embedded in the archive.
		themes : SET_OF_CI<wp.ThemeSpec >
		List of themes embedded in the archive.
		webModules : SET_OF_CI<was.EmbeddedWebModuleSpec>
		Specify Web modules contained by this enterprise application.

		Public Properties
		additionalInstallFlags : SET_OF_STRING
		The additional install flags to be passed to AdminApp.install (set_of_string)
		allowDispatchRemoteInclude : STRING
		Specifies whether an application can dispatch includes to resources across web modules in different Java(TM) virtual machines in a managed node environment through the standard request dispatcher mechanism. (boolean)
		allowServiceRemoteInclude : STRING
		Specifies whether an application can service an include request from an application. (boolean)
		appEdition : STRING
		Edition used by this application. (string)
		applyRestartStrategyOnNoop : STRING
		When true, the restart strategy is apply for a NOOP operation (boolean) default(false)
		asyncRequestDispatchType : STRING
		Enables asynchronous dispatching and specifies how to aggregate the content. (enum) values(DISABLED, SERVER_SIDE, CLIENT_SIDE) default(DISABLED)
		checksum : STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		classloaderMode : STRING
		Specifies whether classes are loaded using the parent class loader before the application class loader. (enum) values(PARENT_FIRST, PARENT_LAST)
		containerRestartStrategy : STRING
		The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container. (enum) values(NONE, STOP_START, RESTART) default(NONE)
		contextRoot : STRING
		Specifies the context root of the Web application (WAR). (string)
		createMBeansForResources : STRING
		Specifies whether to create MBean files for various resources (such as servlets or JSP files) within an application. (boolean)
		disableJspRuntimeCompilation : STRING
		Specify to disable JSP runtime compilation. Values: 'Yes', 'No'(default). (string) default(No)
		drainageInterval : STRING
		Drainage interval in seconds. (integer) default(30)
		editionDescription : STRING
		Edition description used by this application. (string)
		enableDistribution : STRING
		Specifies whether the application is distributed automatically to other nodes on the cell. The default is for automatic distribution. (boolean) default(true)
		enableJspClassReloading : STRING
		Specify JSP reloading for Web modules. (boolean) default(true)
		excludeFileNamesRegex : STRING
		Regular expression that matches file names that must be excluded from scanning
		fileUri : STRING
		The URI pointing to the (remote) location of the file this artifact represents
		groupSize : STRING
		Specifies num of members in a cluster. (integer) default(1)
		isEdition : STRING
		Edition used by this application. (boolean) default(false)
		jdkSourceLevel : STRING
		Specify JDK source level. (string) default(15)
		jsfImplementation : STRING
		If set, specifies the name of the JSF implementation to use. Otherwise uses the platform default. Only supported on WAS 7.0 and up. Warning: On WAS8.0 and higher, setting this property will update the JSF implementation on all installed applications (for more info see IBM PM88239). (string)
		jspClassPath : STRING
		Specify JSP precompiler classpath. (string) default(jspcp)
		jspReloadInterval : STRING
		The JSP reload interval in seconds. Only applicable if 'enableJspClassReloading' is set. (integer) default(10)
		moduleDestination : STRING
		Specifies the full path name of the enterprise application binary file. The path name can be an absolute path or can contain a path map variable such as APP_INSTALL_ROOT. (string)
		placeholders : SET_OF_STRING
		Placeholders detected in this artifact
		preCompileJsps : STRING
		Specify whether to precompile JavaServer Pages (JSP) files as a part of installation. The default is not to precompile JSP files. (boolean) default(false)
		reloadEnabled : STRING
		Specifies whether to override the class reloading options that are defined for all web and EJB modules in this application. (boolean)
		reloadInterval : STRING
		Specifies the number of seconds between each scan of the file system for updated application files. Set this interval to 0 to disable class reloading for all web and EJB modules in the application. (integer)
		resetStrategy : STRING
		Indicates type of reset strategy. (enum) values(SOFT, HARD) default(SOFT)
		restartStrategy : STRING
		The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start. (enum) values(NONE, STOP, START, STOP_START) default(STOP_START)
		roleMappings : MAP_STRING_STRING
		Security role to group mapping. Mapping is possible to either a dedicated group or to one of WebSphere predefined groups: AllAuthenticatedInTrustedRealms, AllAuthenticated, Everyone. (map_string_string)
		roleUserMappings : MAP_STRING_STRING
		Security role to user mapping (map_string_string)
		rolloutStrategy : STRING
		Indicates type of rollout strategy. (enum) values(ATOMIC, GROUPED) default(GROUPED)
		scanPlaceholders : BOOLEAN = false
		Whether to scan this artifact for placeholders when it is imported
		sharedLibraryNames : LIST_OF_STRING
		Shared libraries used by this application. (list_of_string)
		startingWeight : STRING
		Specifies the order in which modules are started when the server starts. The module with the lowest starting weight is started first. (integer) default(1)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		useFullPackageNames : STRING
		Specify to use full package names in JSPs. Values: 'Yes'(default), 'No'. (string) default(Yes)
		useMetadataFromBinaries : STRING
		Specifies whether the application server uses the bindings, extensions, and deployment descriptors located with the application deployment document, the deployment.xml file (default), or those located in the .ear file of the application. (boolean)
		virtualHostName : STRING
		Specify the virtual host where you want to install the Web modules that are contained in your application. You can install Web modules on the same virtual host or disperse them among several hosts. (string)
		warClassLoaderPolicy : STRING
		Specifies whether there is one class loader for all WAR files in the application or a separate class loader for each WAR file in the application. (enum) values(SINGLE, MULTIPLE)
		warClassloaderMode : STRING
		WAR-level class loader mode. (enum) values(PARENT_FIRST, PARENT_LAST)
		webServerNames : SET_OF_STRING
		Specify the Web servers as targets that serve as routers for requests to this application. (set_of_string)

		Hidden Properties
		textFileNamesRegex : STRING = .+\.(cfg \| conf \| config \| ini \| properties \| props \| txt \| asp \| aspx \| htm \| html \| jsf \| jsp \| xht \| xhtml \| sql \| xml \| xsd \| xsl \| xslt)
		Regular expression that matches file names of text files
		delimiters : STRING = {{ }}
		The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
		fileEncodings : MAP_STRING_STRING = {.+\.properties=ISO-8859-1}
		A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

wp.ThemesAndSkinsWarModule

Type Hierarchy	was.WarModule >> was.Module >> was.ExtensibleDeployedArtifact >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, was.ConfigurableModule, udm.ConfigurationItem, udm.DerivedArtifact

Define WAR for themes and skins

		Parent
		container : CI<udm.Container>
		The container on which this deployed runs.

		Children
		sessionManagers : SET_OF_CI<was.SessionManager>
		Specify the session manager options for the application and modules.
		skins : SET_OF_CI<wp.Skin >
		List of skins embedded in the archive.
		themes : SET_OF_CI<wp.Theme >
		List of themes embedded in the archive.
		webModules : SET_OF_CI<was.EmbeddedWebModule>
		Specify Web modules contained by this enterprise application.

		Public Properties
		containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
		The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
		contextRoot : STRING
		Specifies the context root of the Web application (WAR).
		restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
		The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
		additionalInstallFlags : SET_OF_STRING = [-usedefaultbindings]
		The additional install flags to be passed to AdminApp.install
		allowDispatchRemoteInclude : BOOLEAN
		Specifies whether an application can dispatch includes to resources across web modules in different Java(TM) virtual machines in a managed node environment through the standard request dispatcher mechanism.
		allowServiceRemoteInclude : BOOLEAN
		Specifies whether an application can service an include request from an application.
		appEdition : STRING
		Edition used by this application.
		applyRestartStrategyOnNoop : BOOLEAN = false
		When true, the restart strategy is apply for a NOOP operation
		asyncRequestDispatchType : ENUM [DISABLED, SERVER_SIDE, CLIENT_SIDE] = DISABLED
		Enables asynchronous dispatching and specifies how to aggregate the content.
		classloaderMode : ENUM [PARENT_FIRST, PARENT_LAST]
		Specifies whether classes are loaded using the parent class loader before the application class loader.
		createMBeansForResources : BOOLEAN
		Specifies whether to create MBean files for various resources (such as servlets or JSP files) within an application.
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.
		disableJspRuntimeCompilation : STRING = No
		Specify to disable JSP runtime compilation. Values: 'Yes', 'No'(default).
		drainageInterval : INTEGER = 30
		Drainage interval in seconds.
		editionDescription : STRING
		Edition description used by this application.
		enableDistribution : BOOLEAN = true
		Specifies whether the application is distributed automatically to other nodes on the cell. The default is for automatic distribution.
		enableJspClassReloading : BOOLEAN = true
		Specify JSP reloading for Web modules.
		groupSize : INTEGER = 1
		Specifies num of members in a cluster.
		isEdition : BOOLEAN = false
		Edition used by this application.
		jdkSourceLevel : STRING = 15
		Specify JDK source level.
		jsfImplementation : STRING
		If set, specifies the name of the JSF implementation to use. Otherwise uses the platform default. Only supported on WAS 7.0 and up. Warning: On WAS8.0 and higher, setting this property will update the JSF implementation on all installed applications (for more info see IBM PM88239).
		jspClassPath : STRING = jspcp
		Specify JSP precompiler classpath.
		jspReloadInterval : INTEGER = 10
		The JSP reload interval in seconds. Only applicable if 'enableJspClassReloading' is set.
		moduleDestination : STRING
		Specifies the full path name of the enterprise application binary file. The path name can be an absolute path or can contain a path map variable such as APP_INSTALL_ROOT.
		placeholders : MAP_STRING_STRING
		A Map containing all the placeholders mapped to their values. Special values are or
		preCompileJsps : BOOLEAN = false
		Specify whether to precompile JavaServer Pages (JSP) files as a part of installation. The default is not to precompile JSP files.
		reloadEnabled : BOOLEAN
		Specifies whether to override the class reloading options that are defined for all web and EJB modules in this application.
		reloadInterval : INTEGER
		Specifies the number of seconds between each scan of the file system for updated application files. Set this interval to 0 to disable class reloading for all web and EJB modules in the application.
		resetStrategy : ENUM [SOFT, HARD] = SOFT
		Indicates type of reset strategy.
		roleMappings : MAP_STRING_STRING
		Security role to group mapping. Mapping is possible to either a dedicated group or to one of WebSphere predefined groups: AllAuthenticatedInTrustedRealms, AllAuthenticated, Everyone.
		roleUserMappings : MAP_STRING_STRING
		Security role to user mapping
		rolloutStrategy : ENUM [ATOMIC, GROUPED] = GROUPED
		Indicates type of rollout strategy.
		sharedLibraries : SET_OF_CI<was.SharedLibrary>
		Shared libraries used by this application. (DEPRECATED. Prefer using: sharedLibraryNames)
		sharedLibraryNames : LIST_OF_STRING
		Shared libraries used by this application.
		startingWeight : INTEGER = 1
		Specifies the order in which modules are started when the server starts. The module with the lowest starting weight is started first.
		useFullPackageNames : STRING = Yes
		Specify to use full package names in JSPs. Values: 'Yes'(default), 'No'.
		useMetadataFromBinaries : BOOLEAN
		Specifies whether the application server uses the bindings, extensions, and deployment descriptors located with the application deployment document, the deployment.xml file (default), or those located in the .ear file of the application.
		virtualHost : CI<was.VirtualHost>
		Specify the virtual host where you want to install the Web modules that are contained in your application. You can install Web modules on the same virtual host or disperse them among several hosts. (DEPRECATED. Prefer using: virtualHostName)
		virtualHostName : STRING
		Specify the virtual host where you want to install the Web modules that are contained in your application. You can install Web modules on the same virtual host or disperse them among several hosts.
		warClassLoaderPolicy : ENUM [SINGLE, MULTIPLE]
		Specifies whether there is one class loader for all WAR files in the application or a separate class loader for each WAR file in the application.
		warClassloaderMode : ENUM [PARENT_FIRST, PARENT_LAST]
		WAR-level class loader mode.
		webServerNames : SET_OF_STRING
		Specify the Web servers as targets that serve as routers for requests to this application.
		webServers : SET_OF_CI<was.ManagedWebServer>
		Specify the Web servers as targets that serve as routers for requests to this application. (DEPRECATED. Prefer using: webServerNames)

		Hidden Properties
		createEditionedOrder : INTEGER = 10
		The order in which a create step for Editioned application will be executed(was85nd only).
		createOrder : INTEGER = 70
		The order in which a create step will be executed.
		createScript : STRING = was/application/deploy-application.py
		Python wsadmin script invoked to create a Java EE artifact.
		createVerb : STRING = Deploy
		The word is used to prefix a step description for the create operation.
		createXmlAccessOrder : INTEGER = 77
		Create Xml Access Order
		createXmlAccessScript : STRING = wp/themesAndSkinsRegister.xml
		Create Xml Access Script
		destroyOrder : INTEGER = 30
		The order in which a destroy step will be executed.
		destroyScript : STRING = was/application/undeploy-application.py
		Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
		destroyVerb : STRING = Undeploy
		The word that is used to prefix a step description for the destroy operation.
		destroyXmlAccessOrder : INTEGER = 20
		Destroy Xml Access Order
		destroyXmlAccessScript : STRING = wp/themesAndSkinsUnregister.xml
		Destroy Xml Access Script
		discoverOrder : INTEGER = 50
		The order in which a discover step will be executed.
		discoverScript : STRING = was/application/discover-inspect-war-module.py
		Discover Script
		libraryScripts : LIST_OF_STRING = [was/application/discover-app-module-lib.py, was/application/deploy-application-lib.py]
		List of scripts to be appended to the deployed's runtime script
		modifyOrder : INTEGER = 70
		The order in which a modify step will be executed.
		modifyVerb : STRING = Update
		The word is used to prefix a step description for the modify operation.
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Noop
		Noop Verb
		retryAttemptsForAppReadyCheck : INTEGER = 6
		Number of retry attempts to check if an application has been distributed before attempting the application start.
		rolloutEditionedOrder : INTEGER = 20
		The order in which a rollout step will be executed.
		rolloutEditionedScript : STRING = was/application/rollout-edition.py
		Python wsadmin script invoked to perform rollout.
		rolloutEditionedVerb : STRING = Rollout
		The word that is used to prefix a step description for the rollout operation.
		standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
		Standard properties that are not exposed to any python wsadmin script.
		startOrder : INTEGER = 90
		The order in which a start step will be executed.
		startVerb : STRING = Start
		The word that is used to prefix a step description for the start operation.
		stopOrder : INTEGER = 10
		The order in which a stop step will be executed.
		stopVerb : STRING = Stop
		The word that is used to prefix a step description for the stop operation.
		syncAfterCreateOrder : INTEGER = 75
		The order in which a synchronize after create step will be executed.
		syncAfterDestroyOrder : INTEGER = 35
		The order in which a synchronize after destroy step will be executed.
		syncAfterModifyOrder : INTEGER = 75
		The order in which a synchronize after modify step will be executed.
		exposeDeployedApplication : BOOLEAN = false
		Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
		modifyScript : STRING
		Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
		noopScript : STRING
		Python script invoked for the noop operation.
		startScript : STRING = was/application/start-application.py
		Python wsadmin script invoked to start running a Java EE artifact.
		stopScript : STRING = was/application/stop-application.py
		Python script invoked to stop a Java EE artifact or Java EE resource

wp.UnmanagedServer

Type Hierarchy	was.UnmanagedServer >> was.BaseCell >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces	wp.WpRuntimeContainer, was.Server, python.PythonManagedContainer, udm.ConfigurationItem, was.Node, udm.Container, overthere.HostContainer, udm.Taggable, was.WasAppContainer, python.PythonManagingContainer, was.HealthPolicyMembershipContainer, wp.WpContainer, was.WasContainer, was.Cell

A standalone WebSphere Portal server NOT managed by any deployment manager

		Parent
		host : CI<overthere.Host>
		Host on which the WAS server runs

		Children
		webServers : SET_OF_CI<was.ManagedWebServer>
		WebSphere web servers in the node

		Public Properties
		cellName : STRING
		Name of the WebSphere cell, e.g. MyCell, WASCell, Cell01
		nodeName : STRING
		Name of the WebSphere node
		port : INTEGER
		TCP port which is used to login to the WebSphere Administration, defaults to 8880 for SA, 8879 for ND. Value of '0' has special meaning: it'used to suppress passing '-port' argument to wsadmin.
		version : ENUM [WAS_61, WAS_70, WAS_80, WAS_85]
		Version of WebSphere Application Server.
		wasHome : STRING
		Path to the WebSphere profile or deployment manager profile, where bin/wsadmin can be found. For example, /opt/ws/6.1/appserver/profiles/AppSrv01
		wpAdminPassword : STRING
		Password of the administrative user.
		wpAdminUsername : STRING
		Username of the administrative user.
		wpConfigUrl : STRING
		The URL of the WebSphere Portal configuration API.
		wpHome : STRING
		Location of WebSphere Portal..
		wpVersion : ENUM [WP_61, WP_70]
		The version of WebSphere Portal.
		hostname : STRING
		Hostname to which wsadmin should attempt to connect.
		password : STRING
		Password which is used to login to the WebSphere Administration.
		serverType : ENUM [PROXY_SERVER, APPLICATION_SERVER, ONDEMAND_ROUTER]
		Server type. Possible values are: PROXY_SERVER, APPLICATION_SERVER, ONDEMAND_ROUTER
		tags : SET_OF_STRING
		If set, only deployables with the same tag will be automatically mapped to this container.
		unmanagedWebServers : LIST_OF_CI<was.UnmanagedWebServer>
		List of unmanaged web servers.
		updateGlobalPlugin : BOOLEAN
		If set, the global web server plugin configuration will be updated. The plugin configuration will be propagated to all unmanaged web servers.
		username : STRING
		Username which is used to login to the WebSphere Administration.

		Hidden Properties
		deployedsToDiscover : SET_OF_STRING = [was.VirtualHost, was.SharedLibrary]
		Deployeds To Discover
		inspectScript : STRING = was/container/discover-inspect-topology.py
		Inspect script for Cell
		propagateGlobalPluginOrder : INTEGER = 82
		Propagate Global Plugin Order
		updateGlobalPluginOrder : INTEGER = 81
		Update Global Plugin Order
		updateGlobalPluginScript : STRING = was/container/generate-global-plugin.py
		Update Global Plugin Script
		libraryScripts : LIST_OF_STRING = [was/container/discover-inspect-topology-lib.py, was/container/container-lib.py]
		List of scripts to appended to runtime script
		runWithDaemon : BOOLEAN = true
		Set to true to execute commands with the Python daemon

wp.VirtualPortal

Type Hierarchy	udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces	udm.Taggable, wp.WpContainer, udm.ConfigurationItem, udm.Container

A virtual portal that runs on top of WebSphere Portal server.

		Parent
		container : CI<wp.WpRuntimeContainer>
		Containing Portal Server

		Public Properties
		wpVirtualPortalName : STRING
		Name of virtual portal
		tags : SET_OF_STRING
		If set, only deployables with the same tag will be automatically mapped to this container.

wp.VirtualUserAndGroupsAclMapping

Type Hierarchy	wp.BaseVirtualUserAndGroupsAclMapping >> wp.AbstractAclMapping >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.ConfigurationItem, udm.EmbeddedDeployed

Virtual user and groups ACL mapping of a portlet

		Parent
		container : CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public Properties
		securityLevelForAllAuthenticatedPortalUsers : ENUM [NONE, USER, PRIVILEGED_USER, CONTRIBUTOR, EDITOR, MANAGER, DELEGATOR, SECURITY_ADMINISTRATOR, ADMINISTRATOR]
		Set the security level for all authenticated portal users.
		securityLevelForAllPortalUserGroups : ENUM [NONE, USER, PRIVILEGED_USER, CONTRIBUTOR, EDITOR, MANAGER, DELEGATOR, SECURITY_ADMINISTRATOR, ADMINISTRATOR]
		Set the security level for all portal users groups.
		securityLevelForAnonymousPortalUser : ENUM [NONE, USER, PRIVILEGED_USER, CONTRIBUTOR, EDITOR, MANAGER, DELEGATOR, SECURITY_ADMINISTRATOR, ADMINISTRATOR]
		Set the security level for anonymous portal users.
		deployable : CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.

wp.VirtualUserAndGroupsAclMappingSpec

Type Hierarchy	wp.BaseAclMappingSpec >> udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.ConfigurationItem, udm.EmbeddedDeployable

Virtual user and groups ACL mapping specification of a portlet

		Public Properties
		securityLevelForAllAuthenticatedPortalUsers : STRING
		Set the security level for all authenticated portal users. (enum) values(NONE, USER, PRIVILEGED_USER, CONTRIBUTOR, EDITOR, MANAGER, DELEGATOR, SECURITY_ADMINISTRATOR, ADMINISTRATOR)
		securityLevelForAllPortalUserGroups : STRING
		Set the security level for all portal users groups. (enum) values(NONE, USER, PRIVILEGED_USER, CONTRIBUTOR, EDITOR, MANAGER, DELEGATOR, SECURITY_ADMINISTRATOR, ADMINISTRATOR)
		securityLevelForAnonymousPortalUser : STRING
		Set the security level for anonymous portal users. (enum) values(NONE, USER, PRIVILEGED_USER, CONTRIBUTOR, EDITOR, MANAGER, DELEGATOR, SECURITY_ADMINISTRATOR, ADMINISTRATOR)

wp.War

Type Hierarchy	was.War >> jee.War >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

JSR Portal WAR archive

		Children
		portlets : SET_OF_CI<wp.PortletSpec >
		List of portlets to register.
		sessionManagers : SET_OF_CI<was.SessionManagerSpec>
		Specify the session manager options for the application and modules.
		webModules : SET_OF_CI<was.EmbeddedWebModuleSpec>
		Specify Web modules contained by this enterprise application.

		Public Properties
		additionalInstallFlags : SET_OF_STRING
		The additional install flags to be passed to AdminApp.install (set_of_string)
		allowDispatchRemoteInclude : STRING
		Specifies whether an application can dispatch includes to resources across web modules in different Java(TM) virtual machines in a managed node environment through the standard request dispatcher mechanism. (boolean)
		allowServiceRemoteInclude : STRING
		Specifies whether an application can service an include request from an application. (boolean)
		appEdition : STRING
		Edition used by this application. (string)
		applyRestartStrategyOnNoop : STRING
		When true, the restart strategy is apply for a NOOP operation (boolean) default(false)
		asyncRequestDispatchType : STRING
		Enables asynchronous dispatching and specifies how to aggregate the content. (enum) values(DISABLED, SERVER_SIDE, CLIENT_SIDE) default(DISABLED)
		autoScanForPortlets : BOOLEAN = false
		When enabled the archive will be scanned for portlets and all portlets will be added regardless of the registered portlets.
		checksum : STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		classloaderMode : STRING
		Specifies whether classes are loaded using the parent class loader before the application class loader. (enum) values(PARENT_FIRST, PARENT_LAST)
		containerRestartStrategy : STRING
		The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container. (enum) values(NONE, STOP_START, RESTART) default(NONE)
		contextRoot : STRING
		Specifies the context root of the Web application (WAR). (string)
		createMBeansForResources : STRING
		Specifies whether to create MBean files for various resources (such as servlets or JSP files) within an application. (boolean)
		disableJspRuntimeCompilation : STRING
		Specify to disable JSP runtime compilation. Values: 'Yes', 'No'(default). (string) default(No)
		drainageInterval : STRING
		Drainage interval in seconds. (integer) default(30)
		editionDescription : STRING
		Edition description used by this application. (string)
		enableDistribution : STRING
		Specifies whether the application is distributed automatically to other nodes on the cell. The default is for automatic distribution. (boolean) default(true)
		enableJspClassReloading : STRING
		Specify JSP reloading for Web modules. (boolean) default(true)
		excludeFileNamesRegex : STRING
		Regular expression that matches file names that must be excluded from scanning
		fileUri : STRING
		The URI pointing to the (remote) location of the file this artifact represents
		groupSize : STRING
		Specifies num of members in a cluster. (integer) default(1)
		isEdition : STRING
		Edition used by this application. (boolean) default(false)
		jdkSourceLevel : STRING
		Specify JDK source level. (string) default(15)
		jsfImplementation : STRING
		If set, specifies the name of the JSF implementation to use. Otherwise uses the platform default. Only supported on WAS 7.0 and up. Warning: On WAS8.0 and higher, setting this property will update the JSF implementation on all installed applications (for more info see IBM PM88239). (string)
		jspClassPath : STRING
		Specify JSP precompiler classpath. (string) default(jspcp)
		jspReloadInterval : STRING
		The JSP reload interval in seconds. Only applicable if 'enableJspClassReloading' is set. (integer) default(10)
		moduleDestination : STRING
		Specifies the full path name of the enterprise application binary file. The path name can be an absolute path or can contain a path map variable such as APP_INSTALL_ROOT. (string)
		placeholders : SET_OF_STRING
		Placeholders detected in this artifact
		preCompileJsps : STRING
		Specify whether to precompile JavaServer Pages (JSP) files as a part of installation. The default is not to precompile JSP files. (boolean) default(false)
		reloadEnabled : STRING
		Specifies whether to override the class reloading options that are defined for all web and EJB modules in this application. (boolean)
		reloadInterval : STRING
		Specifies the number of seconds between each scan of the file system for updated application files. Set this interval to 0 to disable class reloading for all web and EJB modules in the application. (integer)
		resetStrategy : STRING
		Indicates type of reset strategy. (enum) values(SOFT, HARD) default(SOFT)
		restartStrategy : STRING
		The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start. (enum) values(NONE, STOP, START, STOP_START) default(STOP_START)
		roleMappings : MAP_STRING_STRING
		Security role to group mapping. Mapping is possible to either a dedicated group or to one of WebSphere predefined groups: AllAuthenticatedInTrustedRealms, AllAuthenticated, Everyone. (map_string_string)
		roleUserMappings : MAP_STRING_STRING
		Security role to user mapping (map_string_string)
		rolloutStrategy : STRING
		Indicates type of rollout strategy. (enum) values(ATOMIC, GROUPED) default(GROUPED)
		scanPlaceholders : BOOLEAN = false
		Whether to scan this artifact for placeholders when it is imported
		sharedLibraryNames : LIST_OF_STRING
		Shared libraries used by this application. (list_of_string)
		startingWeight : STRING
		Specifies the order in which modules are started when the server starts. The module with the lowest starting weight is started first. (integer) default(1)
		tags : SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		useFullPackageNames : STRING
		Specify to use full package names in JSPs. Values: 'Yes'(default), 'No'. (string) default(Yes)
		useMetadataFromBinaries : STRING
		Specifies whether the application server uses the bindings, extensions, and deployment descriptors located with the application deployment document, the deployment.xml file (default), or those located in the .ear file of the application. (boolean)
		virtualHostName : STRING
		Specify the virtual host where you want to install the Web modules that are contained in your application. You can install Web modules on the same virtual host or disperse them among several hosts. (string)
		warClassLoaderPolicy : STRING
		Specifies whether there is one class loader for all WAR files in the application or a separate class loader for each WAR file in the application. (enum) values(SINGLE, MULTIPLE)
		warClassloaderMode : STRING
		WAR-level class loader mode. (enum) values(PARENT_FIRST, PARENT_LAST)
		webServerNames : SET_OF_STRING
		Specify the Web servers as targets that serve as routers for requests to this application. (set_of_string)

		Hidden Properties
		textFileNamesRegex : STRING = .+\.(cfg \| conf \| config \| ini \| properties \| props \| txt \| asp \| aspx \| htm \| html \| jsf \| jsp \| xht \| xhtml \| sql \| xml \| xsd \| xsl \| xslt)
		Regular expression that matches file names of text files
		delimiters : STRING = {{ }}
		The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter
		fileEncodings : MAP_STRING_STRING = {.+\.properties=ISO-8859-1}
		A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings

wp.WarModule

Type Hierarchy	was.WarModule >> was.Module >> was.ExtensibleDeployedArtifact >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, was.ConfigurableModule, udm.ConfigurationItem, udm.DerivedArtifact

WAR with values configured for a deployment.

		Parent
		container : CI<udm.Container>
		The container on which this deployed runs.

		Children
		portlets : SET_OF_CI<wp.Portlet >
		List of portlets to register.
		sessionManagers : SET_OF_CI<was.SessionManager>
		Specify the session manager options for the application and modules.
		webModules : SET_OF_CI<was.EmbeddedWebModule>
		Specify Web modules contained by this enterprise application.

		Public Properties
		containerRestartStrategy : ENUM [NONE, STOP_START, RESTART] = NONE
		The restart strategy for the container affected by the deployed. STOP_START : stop container, undeploy, deploy, start container. RESTART : undeploy, deploy, restart container.
		contextRoot : STRING
		Specifies the context root of the Web application (WAR).
		restartStrategy : ENUM [NONE, STOP, START, STOP_START] = STOP_START
		The restart strategy for the deployed. STOP_START : stop, undeploy, deploy, start. STOP: stop, undeploy, deploy. START: undeploy, deploy, start.
		additionalInstallFlags : SET_OF_STRING = [-usedefaultbindings]
		The additional install flags to be passed to AdminApp.install
		allowDispatchRemoteInclude : BOOLEAN
		Specifies whether an application can dispatch includes to resources across web modules in different Java(TM) virtual machines in a managed node environment through the standard request dispatcher mechanism.
		allowServiceRemoteInclude : BOOLEAN
		Specifies whether an application can service an include request from an application.
		appEdition : STRING
		Edition used by this application.
		applyRestartStrategyOnNoop : BOOLEAN = false
		When true, the restart strategy is apply for a NOOP operation
		asyncRequestDispatchType : ENUM [DISABLED, SERVER_SIDE, CLIENT_SIDE] = DISABLED
		Enables asynchronous dispatching and specifies how to aggregate the content.
		autoScanForPortlets : BOOLEAN = false
		When enabled the archive will be scanned for portlets and all portlets will be added regardless of the registered portlets.
		classloaderMode : ENUM [PARENT_FIRST, PARENT_LAST]
		Specifies whether classes are loaded using the parent class loader before the application class loader.
		createMBeansForResources : BOOLEAN
		Specifies whether to create MBean files for various resources (such as servlets or JSP files) within an application.
		deployable : CI<udm.Deployable>
		The deployable that this deployed is derived from.
		disableJspRuntimeCompilation : STRING = No
		Specify to disable JSP runtime compilation. Values: 'Yes', 'No'(default).
		drainageInterval : INTEGER = 30
		Drainage interval in seconds.
		editionDescription : STRING
		Edition description used by this application.
		enableDistribution : BOOLEAN = true
		Specifies whether the application is distributed automatically to other nodes on the cell. The default is for automatic distribution.
		enableJspClassReloading : BOOLEAN = true
		Specify JSP reloading for Web modules.
		groupSize : INTEGER = 1
		Specifies num of members in a cluster.
		isEdition : BOOLEAN = false
		Edition used by this application.
		jdkSourceLevel : STRING = 15
		Specify JDK source level.
		jsfImplementation : STRING
		If set, specifies the name of the JSF implementation to use. Otherwise uses the platform default. Only supported on WAS 7.0 and up. Warning: On WAS8.0 and higher, setting this property will update the JSF implementation on all installed applications (for more info see IBM PM88239).
		jspClassPath : STRING = jspcp
		Specify JSP precompiler classpath.
		jspReloadInterval : INTEGER = 10
		The JSP reload interval in seconds. Only applicable if 'enableJspClassReloading' is set.
		moduleDestination : STRING
		Specifies the full path name of the enterprise application binary file. The path name can be an absolute path or can contain a path map variable such as APP_INSTALL_ROOT.
		placeholders : MAP_STRING_STRING
		A Map containing all the placeholders mapped to their values. Special values are or
		preCompileJsps : BOOLEAN = false
		Specify whether to precompile JavaServer Pages (JSP) files as a part of installation. The default is not to precompile JSP files.
		reloadEnabled : BOOLEAN
		Specifies whether to override the class reloading options that are defined for all web and EJB modules in this application.
		reloadInterval : INTEGER
		Specifies the number of seconds between each scan of the file system for updated application files. Set this interval to 0 to disable class reloading for all web and EJB modules in the application.
		resetStrategy : ENUM [SOFT, HARD] = SOFT
		Indicates type of reset strategy.
		roleMappings : MAP_STRING_STRING
		Security role to group mapping. Mapping is possible to either a dedicated group or to one of WebSphere predefined groups: AllAuthenticatedInTrustedRealms, AllAuthenticated, Everyone.
		roleUserMappings : MAP_STRING_STRING
		Security role to user mapping
		rolloutStrategy : ENUM [ATOMIC, GROUPED] = GROUPED
		Indicates type of rollout strategy.
		sharedLibraries : SET_OF_CI<was.SharedLibrary>
		Shared libraries used by this application. (DEPRECATED. Prefer using: sharedLibraryNames)
		sharedLibraryNames : LIST_OF_STRING
		Shared libraries used by this application.
		startingWeight : INTEGER = 1
		Specifies the order in which modules are started when the server starts. The module with the lowest starting weight is started first.
		useFullPackageNames : STRING = Yes
		Specify to use full package names in JSPs. Values: 'Yes'(default), 'No'.
		useMetadataFromBinaries : BOOLEAN
		Specifies whether the application server uses the bindings, extensions, and deployment descriptors located with the application deployment document, the deployment.xml file (default), or those located in the .ear file of the application.
		virtualHost : CI<was.VirtualHost>
		Specify the virtual host where you want to install the Web modules that are contained in your application. You can install Web modules on the same virtual host or disperse them among several hosts. (DEPRECATED. Prefer using: virtualHostName)
		virtualHostName : STRING
		Specify the virtual host where you want to install the Web modules that are contained in your application. You can install Web modules on the same virtual host or disperse them among several hosts.
		warClassLoaderPolicy : ENUM [SINGLE, MULTIPLE]
		Specifies whether there is one class loader for all WAR files in the application or a separate class loader for each WAR file in the application.
		warClassloaderMode : ENUM [PARENT_FIRST, PARENT_LAST]
		WAR-level class loader mode.
		webServerNames : SET_OF_STRING
		Specify the Web servers as targets that serve as routers for requests to this application.
		webServers : SET_OF_CI<was.ManagedWebServer>
		Specify the Web servers as targets that serve as routers for requests to this application. (DEPRECATED. Prefer using: webServerNames)

		Hidden Properties
		createEditionedOrder : INTEGER = 10
		The order in which a create step for Editioned application will be executed(was85nd only).
		createOrder : INTEGER = 70
		The order in which a create step will be executed.
		createScript : STRING = was/application/deploy-application.py
		Python wsadmin script invoked to create a Java EE artifact.
		createVerb : STRING = Deploy
		The word is used to prefix a step description for the create operation.
		createXmlAccessOrder : INTEGER = 77
		Create Xml Access Order
		createXmlAccessScript : STRING = wp/portletRegister.xml
		Create Xml Access Script
		destroyOrder : INTEGER = 30
		The order in which a destroy step will be executed.
		destroyScript : STRING = was/application/undeploy-application.py
		Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
		destroyVerb : STRING = Undeploy
		The word that is used to prefix a step description for the destroy operation.
		destroyXmlAccessOrder : INTEGER = 20
		Destroy Xml Access Order
		destroyXmlAccessScript : STRING = wp/portletUnregister.xml
		Destroy Xml Access Script
		detectInstallRootOrder : INTEGER = 75
		Detect Install Root Order
		detectInstallRootScript : STRING = wp/jython/get-war-install-location.py
		Detect Install Root Script
		discoverOrder : INTEGER = 50
		The order in which a discover step will be executed.
		discoverScript : STRING = was/application/discover-inspect-war-module.py
		Discover Script
		libraryScripts : LIST_OF_STRING = [was/application/discover-app-module-lib.py, was/application/deploy-application-lib.py]
		List of scripts to be appended to the deployed's runtime script
		modifyOrder : INTEGER = 70
		The order in which a modify step will be executed.
		modifyVerb : STRING = Update
		The word is used to prefix a step description for the modify operation.
		noopOrder : INTEGER = 50
		The order of the step in the step list for the noop operation.
		noopVerb : STRING = Noop
		Noop Verb
		retryAttemptsForAppReadyCheck : INTEGER = 6
		Number of retry attempts to check if an application has been distributed before attempting the application start.
		rolloutEditionedOrder : INTEGER = 20
		The order in which a rollout step will be executed.
		rolloutEditionedScript : STRING = was/application/rollout-edition.py
		Python wsadmin script invoked to perform rollout.
		rolloutEditionedVerb : STRING = Rollout
		The word that is used to prefix a step description for the rollout operation.
		standardPropertiesNotToExpose : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, noopOrder, noopScript, noopVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, discoverScript, inspectScript, discoverOrder, libraryScripts, retryAttemptsForAppReadyCheck, restartStrategy, containerRestartStrategy,applyRestartStrategyOnNoop
		Standard properties that are not exposed to any python wsadmin script.
		startOrder : INTEGER = 90
		The order in which a start step will be executed.
		startVerb : STRING = Start
		The word that is used to prefix a step description for the start operation.
		stopOrder : INTEGER = 10
		The order in which a stop step will be executed.
		stopVerb : STRING = Stop
		The word that is used to prefix a step description for the stop operation.
		syncAfterCreateOrder : INTEGER = 75
		The order in which a synchronize after create step will be executed.
		syncAfterDestroyOrder : INTEGER = 35
		The order in which a synchronize after destroy step will be executed.
		syncAfterModifyOrder : INTEGER = 75
		The order in which a synchronize after modify step will be executed.
		exposeDeployedApplication : BOOLEAN = false
		Flag to indicate whether the deployed application CI is to be injected to the Python script execution context.
		installLocation : STRING
		Install Location
		modifyScript : STRING
		Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
		noopScript : STRING
		Python script invoked for the noop operation.
		startScript : STRING = was/application/start-application.py
		Python wsadmin script invoked to start running a Java EE artifact.
		stopScript : STRING = was/application/stop-application.py
		Python script invoked to stop a Java EE artifact or Java EE resource