Preface

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

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

Overview

The WPS plugin is a Deployit 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

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

CI Reference

Configuration Item Overview

Deployable Configuration Items

CIDescription
wps.EarJava EE EAR archive

Deployed Configuration Items

CIDescription
wps.EarModuleDescription unavailable

Virtual Deployed Configuration Items

CIDescription
wps.BaseEarModuleWebsphere Process Server Ear Module

Configuration Item Details

wps.BaseEarModule

Hierarchywas.ExtensibleDeployedArtifact >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfacesudm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Websphere Process Server Ear Module

Public Properties
container  : CI<udm.Container>

The container on which this deployed runs.

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

stopProcessAndTaskTemplates : BOOLEAN = true

Stop process, task instances before undeployment.

Hidden Properties
createOrder  : INTEGER = 60

The order in which a create step will be executed.

createVerb  : STRING = Create

The word is used to prefix a step description for the create operation.

deleteBpcTemplatesScriptOrder  : INTEGER = 9

The order in which the delete and stop process, task instances step will be executed.

destroyOrder  : INTEGER = 40

The order in which a destroy step will be executed.

destroyVerb  : STRING = Destroy

The word is used to prefix a step description for the destroy operation.

inspectVerb  : STRING = Inspect

The word is used to prefix a step description for the inspect operation.

modifyOrder  : INTEGER = 60

The order in which a modify step will be executed.

modifyVerb  : STRING = Modify

The word is used to prefix a step description for the modify operation.

standardPropertiesNotToExpose  : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, inspectScript, inspectVerb, libraryScripts

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 is used to prefix a step description for the start operation.

stopBpcTemplatesScriptOrder  : INTEGER = 9

The order in which stop process, task instances step will be executed.

stopOrder  : INTEGER = 50

The order in which a synchronize after modify stop will be executed.

stopVerb  : STRING = Stop

The word 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.

createScript : STRING

Python script invoked to deploy a Java EE artifact or create a Java EE resource

deleteBpcTemplatesScript : STRING

Python script invoked to delete and stop process, task instances

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.

inspectScript : STRING

Python script invoked to inspect a Java EE artifact or Java EE resource

modifyScript : STRING

Python script invoked to upgrade a Java EE artifact or modify a Java EE resource

startScript : STRING

Python script invoked to start a Java EE artifact or Java EE resource

stopBpcTemplatesScript : STRING

Python script invoked to stop process, task instances

stopScript : STRING

Python script invoked to stop a Java EE artifact or Java EE resource


wps.Ear

Hierarchyjee.Ear >> udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfacesudm.Taggable, udm.Deployable, udm.SourceArtifact, udm.ArchiveArtifact, udm.Artifact, udm.DeployableArtifact, udm.ConfigurationItem, udm.FileArtifact

Java EE EAR archive

Public Properties
excludeFileNamesRegex : STRING

Regular expression that matches file names that must be excluded from scanning

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)

roleMappings : MAP_STRING_STRING

Security role to user/group mapping (map_string_string)

scanPlaceholders : BOOLEAN = true

Scan Placeholders

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)

stopProcessAndTaskTemplates : STRING

Stop process, task instances before undeployment. (boolean)

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


wps.EarModule

Hierarchywps.BaseEarModule >> was.ExtensibleDeployedArtifact >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfacesudm.Artifact, udm.Deployed, udm.ConfigurationItem, udm.DerivedArtifact

Description unavailable

Public Properties
container  : CI<udm.Container>

The container on which this deployed runs.

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

preCompileJsps : BOOLEAN = false

Specify whether to precompile JavaServer Pages (JSP) files as a part of installation. The default is not to precompile JSP files.

roleMappings : MAP_STRING_STRING

Security role to user/group mapping

sharedLibraries : SET_OF_CI<was.SharedLibrary>

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

The order in which the delete and stop process, task instances step will be executed.

deleteInstancesAndStopTemplatesPythonScript  : STRING = wps/application/delete-processes-tasks.py

Delete Instances And Stop Templates Python Script

destroyOrder  : INTEGER = 30

The order in which a destroy step will be executed.

destroyScript  : STRING = was/application/undeploy-application.py

Python wsadmin script invoked to destroy a Java EE artifact.

destroyVerb  : STRING = Undeploy

The word is used to prefix a step description for the destroy operation.

inspectVerb  : STRING = Inspect

The word is used to prefix a step description for the inspect operation.

modifyOrder  : INTEGER = 70

The order in which a modify step will be executed.

modifyVerb  : STRING = Upgrade

The word is used to prefix a step description for the modify operation.

standardPropertiesNotToExpose  : STRING = id, type, properties, deployable, container, createOrder, createScript, createVerb, syncAfterCreateOrder, modifyOrder, modifyScript, modifyVerb, syncAfterModifyOrder, destroyOrder, destroyScript, securityPermissions, inheritPermissions, exposeDeployedApplication, destroyVerb, syncAfterDestroyOrder, startOrder, startScript, startVerb, stopOrder, stopScript, stopVerb, inspectScript, inspectVerb, libraryScripts

Standard properties that are not exposed to any python wsadmin script.

startApplicationPythonScript  : STRING = was/application/start-application.py

Start Application Python Script

startOrder  : INTEGER = 90

The order in which a start step will be executed.

startScript  : STRING = was/application/start-application.py

Python wsadmin script invoked to start running a Java EE artifact

startTemplatesPythonScript  : STRING = wps/application/start-processes-tasks.py

Start Templates Python Script

startVerb  : STRING = Start

The word is used to prefix a step description for the start operation.

stopApplicationPythonScript  : STRING = was/application/stop-application.py

Stop Application Python Script

stopBpcTemplatesScript  : STRING = wps/application/stop-processes-tasks.py

Stop Bpc Templates Script

stopBpcTemplatesScriptOrder  : INTEGER = 9

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.

stopScript  : STRING = was/application/stop-application.py

Python wsadmin script invoked to stop running a Java EE artifact.

stopTemplatesPythonScript  : STRING = wps/application/stop-processes-tasks.py

Stop Templates Python Script

stopVerb  : STRING = Stop

The word 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

Sync After Destroy Order

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.

inspectScript : STRING

Python script invoked to inspect a Java EE artifact or Java EE resource

modifyScript : STRING

Python script invoked to upgrade a Java EE artifact or modify a Java EE resource

Control Tasks
deleteInstancesAndStopTemplates

No description.

startApplication

No description.

startTemplates

No description.

stopApplication

No description.

stopTemplates

No description.