IBM WebSphere Process Server Plugin Reference 8.0.x
The IBM WebSphere Process Server (WPS) plugin allows XL Deploy to manage deployments and resources on a WebSphere Process Server.
This document provides information that is specific to this version of the WPS plugin. For general information about the plugin, refer to Introduction to the WebSphere Process Server plugin.
Requirements
- XL Deploy 5.1.0 or later
- XL Deploy WebSphere Application Server (WAS) plugin 5.1.0 or later
- IBM WebSphere Process Server 6.x or 7.x (Unix and Microsoft Windows)
Release notes
WPS plugin 6.0.1
XL Deploy 6.0.0 compatibility.
WPS plugin 6.0.0
XL Deploy 6.0.0 compatibility.
WPS plugin 5.0.0
XL Deploy 5.0.0 compatibility.
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] - Compatibility 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.WpsAlwaysUploadedDeployedArtifact | Description unavailable |
Configuration Item Details
wps.DeployedQueryTableJar
Type Hierarchy | wps.WpsAlwaysUploadedDeployedArtifact >> was.ExtensibleDeployedArtifact >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
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
|
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 be appended to the deployed's 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, provisioners, ordinal, boundConfigurationItems
|
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.
|
||
|
|
syncAfterCreateEditionedOrder: INTEGER = 11
|
The order in which a synchronize after create step for Editioned application will be executed.
|
||
|
|
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
|
When true, the restart strategy is apply for a NOOP operation
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
exposeDeployedApplication: BOOLEAN
|
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.ArchiveArtifact, udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
Java EE EAR archive
Children | ||
---|---|---|
|
|
ejbModules:
SET_OF_CI<was.EmbeddedEjbModuleSpec>
|
Specify EJB modules contained by this enterprise application.
|
||
|
|
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)
|
||
|
|
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)
|
||
|
|
createMBeansForResources: STRING
|
Specifies whether to create MBean files for various resources (such as servlets or JSP files) within an application. (boolean)
|
||
|
|
deleteInstancesAndStopTemplates: STRING
|
CAUTION: If you specify -force, all instances enterprise application's templates are deleted -- even if they are currently running. (boolean) default(false)
|
||
|
|
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)
|
||
|
|
enableWorkaroundForJavaEE4inWAS7: STRING
|
Specify JSP reloading workaround for J2EE4 for Websphere 7. (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
|
||
|
|
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)
|
||
|
|
preScannedPlaceholders: BOOLEAN
|
Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
|
||
|
|
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
|
Whether to scan this artifact to replace 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.
|
||
|
|
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
|
||
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
||
|
|
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.Artifact, was.ConfigurableModule, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
Description unavailable
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.
|
||
|
|
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.
|
||
|
|
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.
|
||
|
|
deleteInstancesAndStopTemplates: BOOLEAN
|
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.
|
||
|
|
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.
|
||
|
|
enableWorkaroundForJavaEE4inWAS7: BOOLEAN
|
Specify JSP reloading workaround for J2EE4 for Websphere 7.
|
||
|
|
groupSize: INTEGER = 1
|
Specifies num of members in a cluster.
|
||
|
|
isEdition: BOOLEAN
|
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
|
||
|
|
preCompileJsps: BOOLEAN
|
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.
|
||
|
|
stopProcessAndTaskTemplates: BOOLEAN = true
|
Stop process, task instances before undeployment.
|
||
|
|
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.
|
||
|
|
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 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, provisioners, ordinal, boundConfigurationItems
|
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.
|
||
|
|
syncAfterCreateEditionedOrder: INTEGER = 11
|
The order in which a synchronize after create step for Editioned application will be executed.
|
||
|
|
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.
|
||
|
|
applyRestartStrategyOnNoop: BOOLEAN
|
When true, the restart strategy is apply for a NOOP operation
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
exposeDeployedApplication: BOOLEAN
|
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.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable |
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
|
||
|
|
fileUri: STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
placeholders: SET_OF_STRING
|
Placeholders detected in this artifact
|
||
|
|
preScannedPlaceholders: BOOLEAN
|
Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
|
||
|
|
scanPlaceholders: BOOLEAN = true
|
Whether to scan this artifact to replace 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
|
||
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
||
|
|
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.WpsAlwaysUploadedDeployedArtifact
Virtual Type | |
---|---|
Type Hierarchy | was.ExtensibleDeployedArtifact >> was.ExtensibleDeployed >> python.PythonManagedDeployed >> udm.BaseDeployed >> udm.BaseConfigurationItem |
Interfaces | udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer |
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
|
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, provisioners, ordinal, boundConfigurationItems
|
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.
|
||
|
|
syncAfterCreateEditionedOrder: INTEGER = 11
|
The order in which a synchronize after create step for Editioned application will be executed.
|
||
|
|
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
|
When true, the restart strategy is apply for a NOOP operation
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
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
|
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 be appended to the deployed's 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
|