Preface

This document describes the functionality provided by the IBM WebSphere Process Server (WPS) plugin.

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

Overview

The WPS plugin is a XL Deploy plugin that adds capability for managing deployments and resources on an existing WebSphere Process Server server. It offers out of the box support for deploying/undeploying applications (EAR files). See the Features section below for details. It can easily be extended to support more deployment options or management of new artifacts/resources on WPS.

Features

  • Deploys and undeploys WPS Enterprise applications (EAR)
  • Start and stop templates
  • Start and stop applications

Requirements

  • XL Deploy requirements
    • XL Deploy: version 4.0.0+
    • IBM WebSphere Process Server: 6.x and 7.x (Unix and Windows)
    • Other XL Deploy Plugins: WAS plugin 4.0.0+

Release notes

WPS plugin 4.0.0

XL Deploy 4.0.0 compatibility.

New features

  • [DEPL-5610] - Add support for deploying Query Tables in WPS

Bug fixes

  • [DEPL-3776] - Compatability with WAS plugin

CI Reference

Configuration Item Overview

Deployables

CI Description
wps.Ear Java EE EAR archive
wps.QueryTableJar Jar containing query table files (qtd)

Deployeds

CI Description
wps.DeployedQueryTableJar Deployed jar containing query table files (qtd)
wps.EarModule Description unavailable
wps.WpsAllwaysUploadedDeployedArtifact Base class for all extensible deployed artifact configuration items

Other Configuration Items

CI Description
wps.DeployedQueryTableJar Deployed jar containing query table files (qtd)
wps.Ear Java EE EAR archive
wps.EarModule Description unavailable
wps.QueryTableJar Jar containing query table files (qtd)
wps.WpsAllwaysUploadedDeployedArtifact Base class for all extensible deployed artifact configuration items

Configuration Item Details

wps.DeployedQueryTableJar

Type Hierarchy wps.WpsAllwaysUploadedDeployedArtifact >> was.ExtensibleDeployedArtifact >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces udm.EmbeddedDeployedContainer, udm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Deployed jar containing query table files (qtd)

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 or
Hidden 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.
 
 
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  = wps/querytable/install-querytables.py
Python script invoked to deploy a Java EE artifact or create a Java EE resource
 
 
createVerb : STRING  = Deploy
The word that is used to prefix a step description for the create operation.
 
 
destroyOrder : INTEGER  = 30
The order in which a destroy step will be executed.
 
 
destroyScript : STRING  = wps/querytable/uninstall-querytables.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.
 
 
discoverOrder : INTEGER  = 50
The order in which a discover step will be executed.
 
 
libraryScripts : LIST_OF_STRING  = [wps/querytable/querytable-lib.py]
List of scripts to appended to the the deployeds runtime script
 
 
modifyOrder : INTEGER  = 70
The order in which a modify step will be executed.
 
 
modifyScript : STRING  = wps/querytable/update-querytables.py
Python script invoked to upgrade a Java EE artifact or modify a Java EE resource
 
 
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
 
 
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.
 
 
rolloutEditionedOrder : INTEGER  = 20
The order in which a rollout step will be executed.
 
 
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  = 50
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  = 50
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  = -1
The order in which a synchronize after create step will be executed.
 
 
syncAfterDestroyOrder : INTEGER  = -1
The order in which a synchronize after destroy step will be executed.
 
 
syncAfterModifyOrder : INTEGER  = -1
The order in which a synchronize after modify step will be executed.
 
 
applyRestartStrategyOnNoop : BOOLEAN  = false
When true, the restart strategy is apply for a NOOP operation
 
 
exposeDeployedApplication : BOOLEAN  = false
flag to indicate whether the deployed application CI is to be injected to the python script execution context.
 
 
noopScript : STRING
Python script invoked for the noop operation.
 
 
rolloutEditionedScript : STRING
Python script invoked to rollout a Java EE artifact.
 
 
startScript : STRING
Python script invoked to start a Java EE artifact or Java EE resource
 
 
stopScript : STRING
Python script invoked to stop a Java EE artifact or Java EE resource

wps.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

Java EE EAR archive

Public Properties
 
 
appEdition : STRING
Edition used by this application. (string)
 
 
applyRestartStrategyOnNoop : STRING
When true, the restart strategy is apply for a NOOP operation (boolean) default(false)
 
 
checksum : STRING
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
 
 
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)
 
 
deleteInstancesAndStopTemplates : STRING
CAUTION: If you specify -force, all instances enterprise application's templates are deleted -- even if they are currently running. (boolean) default(false)
 
 
drainageInterval : STRING
Drainage interval in seconds. (integer) default(30)
 
 
editionDescription : STRING
Edition description used by this application. (string)
 
 
excludeFileNamesRegex : STRING
Regular expression that matches file names that must be excluded from scanning
 
 
groupSize : STRING
Specifies num of members in a cluster. (integer) default(1)
 
 
isEdition : STRING
Edition used by this application. (boolean) default(false)
 
 
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)
 
 
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 user/group 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)
 
 
stopProcessAndTaskTemplates : STRING
Stop process, task instances before undeployment. (boolean) default(true)
 
 
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

wps.EarModule

Type Hierarchy was.EarModule >> was.Module >> was.ExtensibleDeployedArtifact >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> 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
 
 
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.
 
 
appEdition : STRING
Edition used by this application.
 
 
applyRestartStrategyOnNoop : BOOLEAN  = false
When true, the restart strategy is apply for a NOOP operation
 
 
deleteInstancesAndStopTemplates : BOOLEAN  = false
CAUTION: If you specify -force, all instances enterprise application's templates are deleted -- even if they are currently running.
 
 
deployable : CI<udm.Deployable>
The deployable that this deployed is derived from.
 
 
drainageInterval : INTEGER  = 30
Drainage interval in seconds.
 
 
editionDescription : STRING
Edition description used by this application.
 
 
groupSize : INTEGER  = 1
Specifies num of members in a cluster.
 
 
isEdition : BOOLEAN  = false
Edition used by this application.
 
 
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.
 
 
resetStrategy : ENUM [SOFT, HARD]  = SOFT
Indicates type of reset strategy.
 
 
roleMappings : MAP_STRING_STRING
Security role to user/group 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.
 
 
stopProcessAndTaskTemplates : BOOLEAN  = true
Stop process, task instances before undeployment.
 
 
virtualHost : CI<was.VirtualHost>
Virtual host this application should be mapped to
 
 
webServers : SET_OF_CI<was.ManagedWebServer>
Web servers this application should be mapped to
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.
 
 
deleteBpcTemplatesScript : STRING  = wps/application/delete-processes-tasks.py
Delete Bpc Templates Script
 
 
deleteBpcTemplatesScriptOrder : INTEGER  = 9
Delete Bpc Templates Script Order
 
 
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.
 
 
discoverOrder : INTEGER  = 50
The order in which a discover step will be executed.
 
 
discoverScript : STRING  = wps/application/discover-inspect-wps-ear-module.py
Python wsadmin script invoked to inspect a JMS resource.
 
 
libraryScripts : LIST_OF_STRING  = [was/application/discover-app-module-lib.py, was/application/deploy-application-lib.py, wps/application/override-was-plugin-functions.py]
List of scripts to appended to the the deployeds 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.
 
 
stopBpcTemplatesScript : STRING  = wps/application/stop-processes-tasks.py
Stop Bpc Templates Script
 
 
stopBpcTemplatesScriptOrder : INTEGER  = 8
The order in which stop process, task instances step will be executed.
 
 
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
Control task Parameter CI Attributes Description
deleteInstancesAndStopTemplates

language = python, script = wps/application/delete-processes-tasks.py

No description.

startTemplates

language = python, script = wps/application/start-processes-tasks.py

No description.

stopTemplates

language = python, script = wps/application/stop-processes-tasks.py

No description.


wps.QueryTableJar

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

Jar containing query table files (qtd)

Public Properties
 
 
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
 
 
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
 
 
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

wps.WpsAllwaysUploadedDeployedArtifact

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

Base class for all extensible deployed artifact configuration items.

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 or
Hidden 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.
 
 
createEditionedOrder : INTEGER  = 10
The order in which a create step for Editioned application will be executed(was85nd only).
 
 
createOrder : INTEGER  = 60
The order in which a create step will be executed.
 
 
createVerb : STRING  = Create
The word that is used to prefix a step description for the create operation.
 
 
destroyOrder : INTEGER  = 40
The order in which a destroy step will be executed.
 
 
destroyVerb : STRING  = Destroy
The word that is used to prefix a step description for the destroy operation.
 
 
discoverOrder : INTEGER  = 50
The order in which a discover step will be executed.
 
 
modifyOrder : INTEGER  = 60
The order in which a modify step will be executed.
 
 
modifyVerb : STRING  = Modify
The word that 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
 
 
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.
 
 
rolloutEditionedOrder : INTEGER  = 20
The order in which a rollout step will be executed.
 
 
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  = 50
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  = 50
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  = 65
The order in which a synchronize after create step will be executed.
 
 
syncAfterDestroyOrder : INTEGER  = 45
The order in which a synchronize after destroy step will be executed.
 
 
syncAfterModifyOrder : INTEGER  = 65
The order in which a synchronize after modify step will be executed.
 
 
applyRestartStrategyOnNoop : BOOLEAN  = false
When true, the restart strategy is apply for a NOOP operation
 
 
createScript : STRING
Python script invoked to deploy a Java EE artifact or create a Java EE resource
 
 
destroyScript : STRING
Python script invoked to undeploy a Java EE artifact or destroy a Java EE resource
 
 
exposeDeployedApplication : BOOLEAN  = false
flag to indicate whether the deployed application CI is to be injected to the python script execution context.
 
 
libraryScripts : LIST_OF_STRING
List of scripts to appended to the the deployeds runtime script
 
 
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.
 
 
rolloutEditionedScript : STRING
Python script invoked to rollout a Java EE artifact.
 
 
startScript : STRING
Python script invoked to start a Java EE artifact or Java EE resource
 
 
stopScript : STRING
Python script invoked to stop a Java EE artifact or Java EE resource