1 Oracle SOA Suite Custom WLST Commands
This chapter describes WSLT commands for Oracle SOA Suite. These commands enable you to use WLST to configure SOA composite applications.
Note:
To use these commands, you must invoke WLST from SOA_HOME/common/bin.
WLST provides both offline and online modes. Offline commands can be used without connecting to the Administration Server. When you first invoke WLST, you are in offline mode. You need to connect to the Administration server, using the connect command, before you can use the online mode commands.
This chapter includes the following sections:
-
SOA Composite Application HTTP Client-Based Export and Import Commands
-
SOA Composite Application MBean-Based Export and Import Commands
-
SOA Composite Application Offline Deployment Management Commands
For additional details about deployment, configuration plans, and test suites, see Developing SOA Applications with Oracle SOA Suite.
1.1 Overview of WSLT Command Categories
WLST commands are divided into the categories shown in Table 1-1.
Table 1-1 Oracle SOA Suite Command Categories
| Command category | Description |
|---|---|
|
Deploy and undeploy SOA composite applications. |
|
|
Start, stop, activate, retire, assign a default revision version, and list deployed SOA composite applications. |
|
|
Attach, extract, generate, and validate configuration plans for SOA composite applications. |
|
|
Validate human workflow tasks. |
|
|
Compile SOA composite applications. |
|
|
Package SOA composite applications into archive files to deploy. |
|
|
Test SOA composite applications prior to deployment in a production environment. |
|
|
SOA Composite Application HTTP Client-Based Export and Import Commands |
Export and import SOA composite applications based on the HTTP client. |
|
SOA Composite Application MBean-Based Export and Import Commands |
Export and import SOA composite applications on the server-based composite store MBean ( |
|
Logically group different revisions of your SOA composite applications into separate partitions. |
|
|
SOA Composite Application Offline Deployment Management Commands |
Manage offline deployments of SOA composite applications and shared data. |
1.2 Deployment Commands
Use the deployment commands, listed in Table 1-2, to deploy and undeploy SOA composite applications.
Table 1-2 Deployment Commands for WLST Configuration
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Deploy a SOA composite application. |
Offline |
|
|
Undeploy a SOA composite application. |
Offline |
1.2.1 sca_deployComposite
Command Category: Deployment Commands
Use with WLST: Offline
1.2.1.1 Description
Deploys a SOA composite application to the Oracle WebLogic Server. This command does not package the artifact files of the application for deployment. See SOA Composite Application Packaging Commands for instructions on packaging a SOA composite application.
1.2.1.2 Syntax
sca_deployComposite(serverURL, sarLocation, [overwrite], [user], [password], [forceDefault], [configplan], [partition] [keepInstancesOnRedeploy])
| Argument | Definition |
|---|---|
|
|
URL of the server that hosts the SOA Infrastructure application (for example, |
|
|
Absolute path to one the following:
|
|
|
Optional. Indicates whether to overwrite an existing SOA composite application.
|
|
|
Optional. User name to access the composite deployer servlet when basic authentication is configured. |
|
|
Optional. Password to access the composite deployer servlet when basic authentication is configured. |
|
|
Optional. Indicates whether to set the new composite as the default.
|
|
|
Optional. Absolute path of a configuration plan to be applied to a specified SAR file or to all SAR files included in the ZIP file. |
|
|
Optional. The name of the partition in which to deploy the SOA composite application. The default value is |
|
|
Optional. Specifies whether to keep the instances on redeploy. The default value is false. This argument is used when BPM is installed. |
Note:
Human workflow artifacts such as task mapped attributes (previously known as flex field mappings) and rules (such as vacation rules) are defined based on the namespace of the task definition. Therefore, the following issues are true when the same SOA composite application with a human workflow task is deployed into multiple partitions:
-
For the same task definition type, mapped attributes defined in one partition are visible in another partition.
-
Rules defined on a task definition in one partition can apply to the same definition in another partition.
1.2.1.3 Examples
The following example deploys the HelloWorld application.
wls:/mydomain/ServerConfig> sca_deployComposite("http://myhost10:7001", "/tmp/sca_HelloWorld_rev1.0.jar")
The following example deploys the HelloWorld application as the default version.
wls:/mydomain/ServerConfig> sca_deployComposite("http://myhost10:7001", "/tmp/sca_HelloWorld_rev1.0.jar", true)
The following example deploys the HelloWorld application with a required user name when basic authentication is configured. You are then prompted to provide the password for this user name.
wls:/mydomain/ServerConfig> sca_deployComposite("http://myhost10:7001", "/tmp/sca_HelloWorld_rev1.0.jar", user="weblogic") Password:
The following example deploys the HelloWorld application and applies the configuration plan named deployplan.xml.
wls:/mydomain/ServerConfig> sca_deployComposite("http://myhost10:7001", "/tmp/sca_HelloWorld_rev1.0.jar", forceDefault=false, configplan="/tmp/deployplan.xml")
The following example deploys the HelloWorld ZIP file, which can include multiple SARs, MARs, or both.
wls:/mydomain/ServerConfig> sca_deployComposite("http://myhost:7001", "/tmp/HelloWorld.zip")
The following example deploys the HelloWorld application to the myPartition partition.
wls:/mydomain/ServerConfig> sca_deployComposite("http://stadp10:7001", "/tmp/sca_HelloWorld_rev1.0.jar", partition="myPartition")
1.2.2 sca_undeployComposite
Command Category: Deployment Commands
Use with WLST: Offline
1.2.2.2 Syntax
sca_undeployComposite(serverURL, compositeName, revision, [user], [password], [partition])
| Argument | Definition |
|---|---|
|
|
URL of the server that hosts the SOA Infrastructure application (for example, |
|
|
Name of the SOA composite application. |
|
|
Revision ID of the SOA composite application. |
|
|
Optional. User name to access the composite deployer servlet when basic authentication is configured. |
|
|
Optional. Password to access the composite deployer servlet when basic authentication is configured. |
|
|
Optional. The name of the partition in which the SOA composite application is located. The default value is |
1.2.2.3 Examples
The following example undeploys the HelloWorld application.
wls:/mydomain/ServerConfig> sca_undeployComposite("http://myhost10:7001", "HelloWorld", "1.0")
The following example undeploys the HelloWorld application with a required user name when basic authentication is configured. You are then prompted to provide the password for this user name.
wls:/mydomain/ServerConfig> sca_undeployComposite("http://myhost10:7001", "HelloWorld", "1.0", user="weblogic") Password:
The following example undeploys the HelloWorld application in the myPartition partition.
wls:/mydomain/ServerConfig> sca_undeployComposite("http://stadp10:7001", "HelloWorld", "1.0", partition='myPartition')
1.3 WLST MDS Commands
Use the WLST MDS Commands to import and export metadata.
Table 1-3 WLST MDS Commands for Import and Export
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Import metadata |
Offline |
|
|
Export metadata |
Offline |
1.3.1 importMetadata
The application metadata can be transferred from one server location (testing) to another server location (production) by exporting and importing the metadata. Metadata can be imported using this command.
Syntax
importMetadata( application, server, fromLocation, docs, [restrictCustTo], [excludeAllCust], [excludeBaseDocs], [excludeExtendedMetadata], [cancelOnException], [applicationVersion])| Argument | Definition |
|---|---|
|
Application name for which the metadata has to be imported |
|
The target server on which this application is deployed |
|
Source directory from where documents will be selected for transfer. fromLocation can be used as temporary file system location for transferring metadata from one server to another |
|
List of comma separated fully qualified document name(s) and/or document name patterns (* and ** patterns) |
|
A list of Customization Layer names used to restrict the import operation to import customization documents that match the specified customization layers. This option will be ignored if excludeAllCust option is also specified |
|
Specifies whether or not to import all customization documents.This option overrides the restrictCustTo |
|
Specifies whether or not to import base documents |
|
Specifies whether or not to import the Extended Metadata documents |
|
Whether or not to abort the import operation when an exception is encountered. On abort, the delete is rolled back if supported by the target store |
|
The application version in case multiple versions of the same application are deployed |
Example
wls:/weblogic/serverConfig>importMetadata(application='sampleApp',
server='srg',
fromLocation='/tmp/myrepos',
docs='/**')1.3.2 exportMetadata
The application metadata can be transferred from one server location (testing) to another server location (production) by exporting and importing the metadata. Metadata can be exported using this command.
Syntax
exportMetadata(application, server, toLocation, docs, [restrictCustTo], [excludeAllCust], [excludeBaseDocs], [excludeExtendedMetadata], [fromLabel], [toLabel], [applicationVersion])| Argument | Definition |
|---|---|
|
Application name for which the metadata has to be exported |
|
The target server on which this application is deployed |
|
Target directory to which documents selected from source partition will be transferred. toLocation can be used as temporary file system for transferring metadata from one server to another |
|
List of comma separated fully qualified document name(s) and/or document name patterns (* and ** patterns) |
|
A list of Customization Layer names used to restrict the export operation to export customization documents that match the specified customization layers. This option will be ignored if excludeAllCust option is also specified |
|
Specifies whether or not to export all customization documents.This option overrides the restrictCustTo |
|
Specifies whether or not to export base documents |
|
Specifies whether or not to export the Extended Metadata documents |
|
If specified, transfers the documents from the source partition that is associated with this label |
|
If specified, will work with fromLabel variable to transfers the delta between fromLabel to toLabel from the source partition |
|
he application version in case multiple versions of the same application are deployed |
Examples
wls:/weblogic/serverConfig>exportMetadata(application='sampleApp',
server='srg',
toLocation='/tmp/myrepos',
docs='/**')wls:/weblogic/serverConfig>exportMetadata(application='sampleApp',
server='srg',
docs='/a.xml,/b.xml',
fromLabel='Oct2008'
)1.4 SOA Composite Application Management Commands
Use the management commands, listed in Table 1-4, to start, stop, activate, retire, assign a default revision version, and list deployed SOA composite applications.
Table 1-4 SOA Composite Application Management Commands for WLST Configuration
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Start a previously stopped SOA composite application. |
Offline |
|
|
Stop a SOA composite application. |
Offline |
|
|
Activate a previously retired SOA composite application. |
Offline |
|
|
Retire a SOA composite application. |
Offline |
|
|
Assign the default revision version to a SOA composite application. |
Offline |
|
|
List the deployed SOA composite applications. |
Offline |
1.4.1 sca_startComposite
Command Category: Application Management Commands
Use with WLST: Offline
1.4.1.2 Syntax
sca_startComposite(host, port, user, password, compositeName, revision, [label], [partition])
| Argument | Definition |
|---|---|
|
|
Hostname of the Oracle WebLogic Server (for example, |
|
|
Port of the Oracle WebLogic Server (for example, |
|
|
User name for connecting to the running server to get MBean information (for example, |
|
|
Password for the user name. |
|
|
Name of the SOA composite application. |
|
|
Revision of the SOA composite application. |
|
|
Optional. Label of the SOA composite application. The label identifies the metadata service (MDS) artifacts associated with the application. If the label is not specified, the system finds the latest one. |
|
|
Optional. The name of the partition in which the SOA composite application is located. The default value is |
1.4.1.3 Example
The following example starts revision 1.0 of the HelloWorld application.
wls:/mydomain/ServerConfig> sca_startComposite("myhost", "7001", "weblogic", "welcome1", "HelloWorld", "1.0")
The following example starts revision 1.0 of the HelloWorld application in the partition myPartition.
wls:/mydomain/ServerConfig> sca_startComposite("stadp10", "7001", "weblogic", "weblogic", "HelloWorld", "1.0", partition="myPartition")
1.4.2 sca_stopComposite
Command Category: Application Management Commands
Use with WLST: Offline
1.4.2.2 Syntax
sca_stopComposite(host, port, user, password, compositeName, revision, [label], [partition])
| Argument | Definition |
|---|---|
|
|
Hostname of the Oracle WebLogic Server (for example, |
|
|
Port of the Oracle WebLogic Server (for example, |
|
|
User name for connecting to the running server to get MBean information (for example, |
|
|
Password for the user name. |
|
|
Name of the SOA composite application. |
|
|
Revision of the SOA composite application. |
|
|
Optional. Label of the SOA composite application. The label identifies the MDS artifacts associated with the application. If the label is not specified, the system finds the latest one. |
|
|
Optional. The name of the partition in which the SOA composite application is located. The default value is |
1.4.2.3 Example
The following example stops revision 1.0 of the HelloWorld application.
wls:/mydomain/ServerConfig> sca_stopComposite("myhost", "7001", "weblogic", "welcome1", "HelloWorld", "1.0")
The following example stops revision 1.0 of the HelloWorld application in the partition myPartition.
wls:/mydomain/ServerConfig> sca_stopComposite("stadp10", "7001", "weblogic", "weblogic", "HelloWorld", "1.0", partition="myPartition")
1.4.3 sca_activateComposite
Command Category: Application Management Commands
Use with WLST: Offline
1.4.3.1 Description
Activates a retired SOA composite application. You can then create new instances.
1.4.3.2 Syntax
sca_activateComposite(host, port, user, password, compositeName, revision, [label], [partition])
| Argument | Definition |
|---|---|
|
|
Hostname of the Oracle WebLogic Server (for example, |
|
|
Port of the Oracle WebLogic Server (for example, |
|
|
User name for connecting to the running server to get MBean information (for example, |
|
|
Password for the user name. |
|
|
Name of the SOA composite application. |
|
|
Revision of the SOA composite application. |
|
|
Optional. Label of the SOA composite application. The label identifies the MDS artifacts associated with the application. If the label is not specified, the system finds the latest one. |
|
|
Optional. The name of the partition in which the SOA composite application is located. The default value is |
1.4.3.3 Example
The following example activates revision 1.0 of the HelloWorld application.
wls:/mydomain/ServerConfig> sca_activateComposite("myhost", "7001", "weblogic", "welcome1", "HelloWorld", "1.0")
The following example activates revision 1.0 of the HelloWorld application in the partition myPartition.
wls:/mydomain/ServerConfig> sca_activateComposite("stadp10", "7001", "weblogic", "weblogic", "HelloWorld", "1.0", partition="myPartition")
1.4.4 sca_retireComposite
Command Category: Application Management Commands
Use with WLST: Offline
1.4.4.1 Description
Retires a SOA composite application. If the process life cycle is retired, you cannot create a new instance. Existing instances are allowed to complete normally.
1.4.4.2 Syntax
sca_retireComposite(host, port, user, password, compositeName, revision, [label], [partition])
| Argument | Definition |
|---|---|
|
|
Hostname of the Oracle WebLogic Server (for example, |
|
|
Port of the Oracle WebLogic Server (for example, |
|
|
User name for connecting to the running server to get MBean information (for example, |
|
|
Password for the user name. |
|
|
Name of the SOA composite application. |
|
|
Revision of the SOA composite application. |
|
|
Optional. Label of the SOA composite application. The label identifies the MDS artifacts associated with the application. If the label is not specified, the system finds the latest one. |
|
|
Optional. The name of the partition in which the SOA composite application is located. The default value is |
1.4.4.3 Example
The following example retires revision 1.0 of the HelloWorld application.
wls:/mydomain/ServerConfig> sca_retireComposite("myhost", "7001", "weblogic", "welcome1", "HelloWorld", "1.0")
The following example retires revision 1.0 of the HelloWorld application in the partition myPartition.
wls:/mydomain/ServerConfig> sca_retireComposite("stadp10", "7001", "weblogic", "weblogic", "HelloWorld", "1.0", partition="myPartition")
1.4.5 sca_assignDefaultComposite
Command Category: Application Management Commands
Use with WLST: Offline
1.4.5.1 Description
Sets a SOA composite application revision as the default version. This revision is instantiated when a new request comes in.
1.4.5.2 Syntax
sca_assignDefaultComposite(host, port, user, password, compositeName, revision, [partition])
| Argument | Definition |
|---|---|
|
|
Hostname of the Oracle WebLogic Server (for example, |
|
|
Port of the Oracle WebLogic Server (for example, |
|
|
User name for connecting to the running server to get MBean information (for example, |
|
|
Password for the user name. |
|
|
Name of the SOA composite application. |
|
|
Revision of the SOA composite application. |
|
|
Optional. The name of the partition in which the SOA composite application is located. The default value is |
1.4.5.3 Example
The following example sets revision 1.0 of the HelloWorld application as the default version.
wls:/mydomain/ServerConfig> sca_assignDefaultComposite("myhost", "7001", "weblogic", "welcome1", "HelloWorld", "1.0")
The following example sets revision 1.0 of the HelloWorld application located in the partition myPartition as the default version.
wls:/mydomain/ServerConfig> sca_assignDefaultComposite("stadp10", "7001", "weblogic", "weblogic", "HelloWorld", "1.0", partition="myPartition")
1.4.6 sca_listDeployedComposites
Command Category: Application Management Commands
Use with WLST: Offline
1.4.6.2 Syntax
sca_listDeployedComposites(host, port, user, password)
| Argument | Definition |
|---|---|
|
|
Hostname of the Oracle WebLogic Server (for example, |
|
|
Port of the Oracle WebLogic Server (for example, |
|
|
User name for connecting to the running server to get MBean information (for example, |
|
|
Password for the user name. |
1.5 Configuration Plan Management Commands
Use the configuration plan management commands, listed in Table 1-5, to attach, extract, generate, and validate configuration plans for SOA composite applications.
Table 1-5 Configuration Plan Management Commands for WLST Configuration
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Attach the configuration plan file to the SOA composite application JAR file. |
Offline |
|
|
Extract a configuration plan packaged with the JAR file for editing. |
Offline |
|
|
Generate a configuration plan for editing. |
Offline |
|
|
Validate the configuration plan. |
Offline |
1.5.1 sca_attachPlan
Command Category: Configuration Plan Management Commands
Use with WLST: Offline
1.5.1.1 Description
Attaches the configuration plan file to the SOA composite application file. If a plan already exists in the file, it is not overwritten by default.
1.5.1.2 Syntax
sca_attachPlan(sar, configPlan, [overwrite], [verbose])
| Argument | Definition |
|---|---|
|
|
Absolute path of the SAR file. |
|
|
Absolute path of the configuration plan file. |
|
|
Optional. Indicates whether to overwrite an existing configuration plan in the SAR file.
|
|
|
Optional. Indicates whether to print more information about the configuration plan attachment.
|
1.5.1.3 Examples
The following example attaches the configplan.xml configuration plan file to the HelloWorld application.
wls:/mydomain/ServerConfig> sca_attachPlan("/tmp/sca_HelloWorld_rev1.0.jar", "/tmp/configplan.xml")
The following example overwrites the existing configuration plan with configplan.xml file in the HelloWorld application.
wls:/mydomain/ServerConfig> sca_attachPlan("/tmp/sca_HelloWorld_rev1.0.jar", "/tmp/configplan.xml", overwrite=true)
1.5.2 sca_extractPlan
Command Category: Configuration Plan Management Commands
Use with WLST: Offline
1.5.2.1 Description
Extracts a configuration plan packaged with the SOA composite application file for editing. This is an optional step. If no plan exists, this is the same as creating a new file with sca_generatePlan.
1.5.2.2 Syntax
sca_extractPlan(sar, configPlan, [overwrite], [verbose])
| Argument | Definition |
|---|---|
|
|
Absolute path of a SAR file. |
|
|
Absolute path of a configuration plan file to which to be extracted. |
|
|
Optional. Indicates whether to overwrite the configuration file specified by
|
|
|
Optional. Indicates whether to print more information about configuration plan extraction.
|
1.5.2.3 Example
The following example extracts the configplan.xml file for editing from the HelloWorld application.
wls:/mydomain/ServerConfig> sca_extractPlan("/tmp/sca_HelloWorld_rev1.0.jar", "/tmp/configplan.xml")
The following example extracts the configplan.xml file for editing from the HelloWorld application. This command also overwrites the existing plan.
wls:/mydomain/ServerConfig> sca_extractPlan("/tmp/sca_HelloWorld_rev1.0.jar", "/tmp/configplan.xml", overwrite=true)
1.5.3 sca_generatePlan
Command Category: Configuration Plan Management Commands
Use with WLST: Offline
1.5.3.2 Syntax
sca_generatePlan(configPlan, sar, composite, [overwrite], [verbose])
| Argument | Definition |
|---|---|
|
|
Absolute path of the configuration plan file to be generated. Either |
|
|
Absolute path of the SAR file. Either |
|
|
Absolute path of the |
|
|
Optional. Indicates whether to overwrite an existing configuration plan file:
|
|
|
Indicates whether to print more information about plan generation:
|
1.5.3.3 Examples
The following example generates the myplan.xml configuration plan file for the HelloWorld application.
wls:/mydomain/ServerConfig> sca_generatePlan("/tmp/myplan.xml", sar="/tmp/sca_HelloWorld_rev1.0.jar")
The following example generates the myplan2.xml configuration plan file for the HelloWorld application. The myplan2.xml file overwrites the existing plan.
wls:/mydomain/ServerConfig> sca_generatePlan("/tmp/myplan2.xml", composite="/tmp/HelloWorld_rev1.0/composite.xml", overwrite=true)
1.5.4 sca_validatePlan
Command Category: Configuration Plan Management Commands
Use with WLST: Offline
1.5.4.1 Description
Validates the configuration plan. This command identifies all search and replacement changes to be made during deployment. Use this option for debugging only.
1.5.4.2 Syntax
sca_validatePlan(reportFile, configPlan, [sar], [composite], [overwrite], [verbose])
| Argument | Definition |
|---|---|
|
|
Absolute path of the report file to be generated. Validation results are written to this file. |
|
|
Absolute path of the configuration plan file. |
|
|
Optional. The absolute path of the SAR file. |
|
|
Optional. The absolute path of the |
|
|
Optional. Indicates whether to overwrite an existing configuration plan file:
|
|
|
Optional. Indicates whether to print more information about configuration plan validation.
|
1.5.4.3 Examples
The following example validates the configplan.xml configuration plan file for the HelloWorld application.
wls:/mydomain/ServerConfig> sca_validatePlan("/tmp/myreport.xml", "/tmp/configplan.xml", sar="/tmp/sca_HelloWorld_rev1.0.jar")
The following example validates the configplan.xml configuration plan file for the HelloWorld application. The configplan.xml plan overwrites the existing plan.
wls:/mydomain/ServerConfig> sca_validatePlan("/tmp/myreport.xml", "/tmp/configplan.xml",composite="/tmp/HelloWorld_rev1.0/composite.xml", overwrite=true)
1.6 Task Validation Commands
Use the task validation command, listed in Table 1-6, to validate human workflow tasks.
Table 1-6 Task Validation Command for WLST Configuration
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Validate a human workflow task. |
Offline |
1.6.1 sca_validateTask
Command Category: Task Validation Commands
Use with WLST: Offline
1.6.1.1 Description
Validates a human workflow task contained in the .task file that you created when designing a human task in the Human Task Editor.
1.6.1.2 Syntax
sca_validateTask(taskFile, outXml, [displayLevel])
| Argument | Definition |
|---|---|
|
|
Absolute path to the task definition file ( |
|
|
Absolute path to an output XML file. |
|
|
Optional. The level of information to display. The values can be 1, 2, or 3. The default value is |
1.7 SOA Composite Application Compilation Commands
Use the compilation commands, listed in Table 1-7, to compile SOA composite applications.
Table 1-7 SOA Composite Application Compilation Commands for WLST Configuration
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Set JVM system properties. |
Offline |
|
|
Compile a SOA composite application. |
Offline |
1.7.1 sca_setProp
Command Category: Application Compilation Commands
Use with WLST: Offline
1.7.1.1 Description
Sets JVM system properties. This command can also set secure socket layer (SSL) system properties before using sca_deployComposite and sca_undeployComposite over SSL.
1.7.1.2 Syntax
sca_setProp(propName, propValue)
| Argument | Definition |
|---|---|
|
|
Property name. |
|
|
Property value. |
1.7.2 sca_compile
Command Category: Application Compilation Commands
Use with WLST: Offline
1.7.2.1 Description
Compiles a SOA composite application.
Note:
The sca_compile command requires the oracle.home property to find the ant-sca-compile.xml script. This must be set once. You can use the scac_setProp command or the oracleHome property to set a value.
1.7.2.2 Syntax
sca_compile(composite, [outXml], [error], [appHome], [displayLevel], [oracleHome])
| Argument | Definition |
|---|---|
|
|
Absolute path of a composite file in the expanded (unzipped) SAR directory. |
|
|
Optional. Absolute path of an output XML file. |
|
|
Optional. Absolute path of an error file. |
|
|
Optional only if you are compiling from inside the project directory. Absolute path of the application home directory. This property is required if you have shared data. |
|
|
Optional. The level of information to display. The default value is |
|
|
Optional. The |
|
|
Optional. Indicates whether schema validation error is reported. The default value is false. |
1.7.2.3 Examples
The following example compiles the FirstComposite application.
wls:/mydomain/ServerConfig> sca_compile("/tmp/FirstComposite_ rev1.0/composite.xml", displayLevel=2)
The following example compiles the FirstComposite application and captures details in the myout.xml file. The error.out file captures any errors.
wls:/mydomain/ServerConfig> sca_compile("/tmp/FirstComposite_ rev1.0/composite.xml", outXml="/tmp/myout.xml", error="error.out")
The following example compiles the FirstComposite application. The oracleHome property is set to find the ant-sca-compile.xml script.
wls:/mydomain/ServerConfig> sca_compile("/tmp/FirstComposite_ rev1.0/composite.xml", displayLevel=2, oracleHome="/scratch/myusername/beahome/AS11gR1SOA")
1.8 SOA Composite Application Packaging Commands
Use the packaging command, listed in Table 1-8, to package SOA composite applications into a composite SAR file.
Table 1-8 SOA Composite Application Packaging Command for WLST Configuration
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Package the SOA composite application files into a composite SAR file. |
Offline |
1.8.1 sca_package
Command Category: Application Packaging Commands
Use with WLST: Offline
1.8.1.1 Description
Packages the SOA composite application files into a composite SAR file. This command performs the following operations:
-
Calls
sca_compileto compile the composite artifacts in${compositeDir}. -
Calls
javacto compile any source code under${compositeDir}/src. -
Replaces the revision in
${compositeDir}/composite.xml. -
Packages the artifacts to create
sca_${compositeName}_rev${revision}.jarin${compositeDir}/deploy.
Note:
The sca_package command requires oracle.home to find the ant-sca-package.xml script. This must be set once. You can use the scac_setProp command or oracleHome property to set this property.
1.8.1.2 Syntax
sca_package(compositeDir, compositeName, revision, [appHome], [oracleHome])
| Argument | Definition |
|---|---|
|
|
Absolute path of a directory that contains composite artifacts. |
|
|
Name of the composite. |
|
|
Revision ID of the composite. |
|
|
Optional. Absolute path of the application home directory. This property is required if you have shared data. |
|
|
Optional. The |
1.8.1.3 Examples
The following example packages the OrderBookingComposite application. The appHome property is set because this application uses shared data.
wls:/mydomain/ServerConfig> sca_package("/tmp/app_data/OrderBookingComposite", "OrderBookingComposite", "1.0", appHome="/tmp/app_data")
The following example packages the HelloSOAComposite application.
wls:/mydomain/ServerConfig> sca_package ("/tmp/HelloSOAApplication/HelloSOAComposite", "HelloSOAComposite", "1.0")
The following example packages the HelloSOAComposite application. The oracleHome property is set to find the ant-sca-compile.xml script.
wls:/mydomain/ServerConfig> sca_package ("/tmp/HelloSOAApplication/HelloSOAComposite", "HelloSOAComposite", "1.0", oracleHome="/scratch/myusername/beahome/AS11gR1SOA")
1.9 SOA Composite Application Test Commands
Use the SOA composite application test command, listed in Table 1-9, to test a SOA composite applications.
Table 1-9 SOA Composite Application Test Command for WLST Configuration
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Test deployed SOA composite applications. |
Offline |
1.9.1 sca_test
Command Category: Application Test Commands
Use with WLST: Offline
1.9.1.1 Description
Tests deployed SOA composite applications prior to deployment in a production environment. You create suites of tests in Oracle JDeveloper. The sca_test command calls ant-sca-test.xml.
1.9.1.2 Syntax
sca_test('compositeName', 'revision', 'testsuiteName', 'jndiPropFile',
[oracleHome='oracleHome'], [javaHome='javaHome'])| Argument | Definition |
|---|---|
|
|
Name of the SOA composite application. |
|
|
Revision ID of the SOA composite application. |
|
|
Name of the test suite. |
|
|
Absolute path to the JNDI property file. |
|
|
Optional. The |
|
|
Optional. The |
1.9.1.3 Examples
The following example runs the OrderBookingMainTestsuite test suite.
wls:/mydomain/ServerConfig> sca_test('OrderBookingComposite', '1.0', 'OrderBookingMainTestsuite', '/tmp/tmp-jndi.properties', oracleHome='/scratch/<user>/beahome/AS11gR1SOA/', javaHome='/scratch/<user>/beahome/jdk160_05')
1.10 SOA Composite Application HTTP Client-Based Export and Import Commands
Use the SOA composite application commands, listed in Table 1-10, to export and import SOA composite applications based on the HTTP client. The SOA Infrastructure must be running to use these commands.
Table 1-10 SOA Composite Application Export and Import Commands for WLST Configuration
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Export a SOA composite application into a SAR file. |
Offline |
|
|
Export postdeployment changes of a SOA composite application into a JAR file. |
Offline |
|
|
Import postdeployment changes of a SOA composite application. |
Offline |
|
|
Export shared data of a given pattern into a JAR file. |
Offline |
|
|
Removes a top-level shared data folder. |
Offline |
1.10.1 sca_exportComposite
Command Category: Application Export and Import Commands
Use with WLST: Offline
1.10.1.2 Syntax
sca_exportComposite(serverURL, updateType, sarFile, compositeName, revision, [user], [password], [partition])
| Argument | Definition |
|---|---|
|
|
URL of the server that hosts the SOA Infrastructure application (for example, |
|
|
Type of postdeployment changes to be exported:
|
|
|
Absolute path of a SAR file to generate (a |
|
|
Name of the composite to export. |
|
|
Revision of the composite to export. |
|
|
Optional. The user name for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
|
|
Optional. The password for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
|
|
Optional. The name of the partition in which the SOA composite application is located. The default value is |
1.10.1.3 Examples
The following example exports the composite without including any postdeployment changes.
wls:/offline/mydomain/ServerConfig> sca_exportComposite('http://stabc:8001', 'none', '/tmp/sca_HelloWorld_rev1.0.jar', 'HelloWorld', '1.0')
The following example exports a composite with all postdeployment updates.
wls:/offline/mydomain/ServerConfig> sca_exportComposite('http://stabc:8001', 'all', '/tmp/sca_HelloWorld_ rev1.0-all.jar', 'HelloWorld', '1.0')
The following example exports a composite with property postdeployment updates.
wls:/offline/mydomain/ServerConfig> sca_exportComposite('http://stabc:8001', 'property', '/tmp/sca_HelloWorld_ rev1.0-prop.jar', 'HelloWorld', '1.0')
The following example exports a composite with runtime/metadata postdeployment updates.
wls:/offline/mydomain/ServerConfig> sca_exportComposite('http://stabc:8001', 'runtime', '/tmp/sca_HelloWorld_ rev1.0-runtime.jar', 'HelloWorld', '1.0')
The following example exports a composite in the myPartition partition without including any postdeployment updates:
wls:/offline/mydomain/ServerConfig> sca_exportComposite('http://stabc:8001', 'none', '/tmp/sca_HelloWorld_rev1.0.jar', 'HelloWorld', '1.0', partition='myPartition')
1.10.2 sca_exportUpdates
Command Category: Application Export and Import Commands
Use with WLST: Offline
1.10.2.2 Syntax
sca_exportUpdates(serverURL, updateType, jarFile, compositeName, revision, [user], [password], [partition])
| Argument | Definition |
|---|---|
|
|
URL of the server that hosts the SOA Infrastructure application (for example, |
|
|
The type of postdeployment changes to be exported.
|
|
|
Absolute path of a JAR file to generate. |
|
|
Name of the composite to export. |
|
|
Revision of the composite to export. |
|
|
Optional. The user name for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
|
|
Optional. The password for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
|
|
Optional. The name of the partition in which the SOA composite application is located. The default value is |
1.10.2.3 Examples
The following example exports all postdeployment updates.
wls:/offline/mydomain/ServerConfig> sca_exportUpdates('http://stabc:8001', 'all', '/tmp/all-HelloWorld_rev1.0.jar','HelloWorld', '1.0')
The following example exports property postdeployment updates.
wls:/offline/mydomain/ServerConfig> sca_exportUpdates('http://stabc:8001', 'property','/tmp/prop-HelloWorld_ rev1.0.jar', 'HelloWorld', '1.0')
The following example exports runtime/metadata postdeployment updates.
wls:/offline/mydomain/ServerConfig> sca_exportUpdates('http://stabc:8001', 'runtime','/tmp/runtime-HelloWorld_ rev1.0.jar', 'HelloWorld', '1.0')
The following example exports postdeployment changes of a composite in the partition myPartition into a JAR file.
wls:/offline/mydomain/ServerConfig> sca_exportUpdates('http://stabc:8001', 'runtime', '/tmp/runtime-HelloWorld_rev1.0.jar', 'HelloWorld', '1.0', partition='myPartition')
1.10.3 sca_importUpdates
Command Category: Application Export and Import Commands
Use with WLST: Offline
1.10.3.2 Syntax
sca_importUpdates(serverURL, jarFile, compositeName, revision, [user], [password])
| Argument | Definition |
|---|---|
|
|
URL of the server that hosts the SOA Infrastructure application (for example, |
|
|
Absolute path of a JAR file that contains postdeployment changes. |
|
|
Name of the composite to which the postdeployment changes are imported. |
|
|
Revision of the composite to which the postdeployment changes are imported. |
|
|
Optional. The user name for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
|
|
Optional. The password for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
|
|
Optional. The name of the partition in which the SOA composite application is located. The default value is |
1.10.3.3 Examples
The following example imports postdeployment changes of a SOA composite application.
wls:/offline/mydomain/ServerConfig> sca_importUpdates('http://stabc:8001', '/tmp/all-HelloWorld_rev1.0.jar', 'HelloWorld', '1.0')
The following example imports postdeployment changes of a composite in the partition myPartition.
wls:/offline/mydomain/ServerConfig> sca_importUpdates('http://stabc:8001', '/tmp/all-HelloWorld_rev1.0.jar', 'HelloWorld', '1.0', partition='myPartition')
1.10.4 sca_exportSharedData
Command Category: Application Export and Import Commands
Use with WLST: Offline
1.10.4.2 Syntax
sca_exportSharedData(serverURL, jarFile, pattern, [user], [password])
| Argument | Definition |
|---|---|
|
|
URL of the server that hosts the SOA Infrastructure application (for example, |
|
|
Absolute path of a JAR file to generate. |
|
|
The file pattern supported by MDS transfer APIs. Use the semicolon delimiter ( /Project1/**;/Project2/** This example exports all documents under |
|
|
Optional. The user name for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
|
|
Optional. The password for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
1.10.5 sca_removeSharedData
Command Category: Application Export and Import Commands
Use with WLST: Offline
1.10.5.1 Description
Removes a top-level shared data folder, even if there are composites deployed in the service engine.
1.10.5.2 Syntax
sca_removeSharedData(serverURL, folderName, [user], [password])
| Argument | Definition |
|---|---|
|
|
URL of the server that hosts the SOA Infrastructure application (for example, |
|
|
The name of a top-level shared data folder to be removed. |
|
|
Optional. The user name for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
|
|
Optional. The password for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
1.11 SOA Composite Application MBean-Based Export and Import Commands
Use the deployment commands, listed in Table 1-11, to export and import SOA composite applications on the server-based composite store MBean (CompositeStoreMXBean).
Table 1-11 SOA Composite Application Export and Import Commands for WLST Configuration
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Export a SOA composite application into a SAR file. |
Online |
|
|
Export postdeployment changes of a SOA composite application into a JAR file. |
Online |
|
|
Import postdeployment changes of a SOA composite application. |
Online |
|
|
Export shared data of a given pattern into a JAR file. |
Online |
If you use this option, note that the file generated in the export commands and the file read in the import command must be on the host where the server is running (either an Oracle WebLogic Administration Server or a managed SOA server).
The composite store MBean is registered as both a server runtime MBean of the SOA server and as a domain runtime MBean of the Oracle WebLogic Administration Server, which allows the import and export to continue working while SOA servers are down. Only WLST commands are provided for using the composite store MBean; there are no ant commands.
You must run the connect() command to connect to either a SOA server or an Oracle WebLogic Administration Server.
wls:offline>connect('weblogic', 'password', 't3://stabc:8001')
If you use the domain runtime MBean while the SOA servers are down, you must run the domainRuntime() command.
wls:offline>connect('weblogic', 'password', 't3://stabc:7001') wls:/soainfra/serverConfig>domainRuntime()
1.11.1 sca_exportCompositeMb
Command Category: Application Export and Import Commands
Use with WLST: Online
1.11.1.2 Syntax
sca_exportCompositeMb(updateType, sarFile, compositeName, revision)
| Argument | Definition |
|---|---|
|
|
Type of postdeployment changes to be exported:
|
|
|
Absolute path of a SAR file to generate. |
|
|
Name of the composite to export. |
|
|
Revision of the composite to export. |
1.11.1.3 Examples
This example exports composite without including any postdeployment changes.
wls:/mydomain/ServerConfig> sca_exportCompositeMb('none', '/tmp/sca_HelloWorld_ rev1.0.jar', 'HelloWorld', '1.0')
This example exports a composite with all postdeployment updates.
wls:/mydomain/ServerConfig> sca_exportCompositeMb('all', '/tmp/sca_HelloWorld_ rev1.0-all.jar', 'HelloWorld','1.0')
This example exports a composite with property postdeployment updates.
wls:/mydomain/ServerConfig> sca_exportCompositeMb('property', '/tmp/sca_ HelloWorld_rev1.0-prop.jar', HelloWorld', '1.0')
This example exports a composite with runtime/metadata postdeployment updates.
wls:/mydomain/ServerConfig> sca_exportCompositeMb('runtime', '/tmp/sca_HelloWorld_ rev1.0-runtime.jar','HelloWorld', '1.0')
1.11.2 sca_exportUpdatesMb
Command Category: Application Export and Import Commands
Use with WLST: Online
1.11.2.2 Syntax
sca_exportUpdatesMb(updateType, jarFile, compositeName, revision)
| Argument | Definition |
|---|---|
|
|
Type of postdeployment changes to be exported: |
|
|
Absolute path of a JAR file to generate. |
|
|
Name of the composite to export. |
|
|
Revision of the composite to export. |
1.11.2.3 Examples
The following example exports all postdeployment updates.
wls:/mydomain/ServerConfig> sca_exportUpdatesMb('all', '/tmp/all-HelloWorld_rev1.0.jar','HelloWorld', '1.0')
The following example exports property postdeployment updates.
wls:/mydomain/ServerConfig> sca_exportUpdatesMB('property', '/tmp/prop-HelloWorld_ rev1.0.jar', 'HelloWorld', '1.0')
The following example exports runtime/metadata postdeployment updates.
wls:/mydomain/ServerConfig> sca_exportUpdatesMB('runtime', '/tmp/runtime-HelloWorld_ rev1.0.jar', 'HelloWorld', '1.0')
1.11.3 sca_importUpdatesMb
Command Category: Application Export and Import Commands
Use with WLST: Online
1.11.3.2 Syntax
sca_importUpdatesMb(jarFile, compositeName, revision)
| Argument | Definition |
|---|---|
|
|
Absolute path of a JAR file that contains postdeployment changes. |
|
|
Name of the composite to which the postdeployment changes are imported. |
|
|
Revision of the composite to which the postdeployment changes are imported. |
1.11.4 sca_exportSharedDataMb
Command Category: Application Export and Import Commands
Use with WLST: Online
1.11.4.2 Syntax
sca_exportSharedDataMb(jarFile, pattern)
| Argument | Definition |
|---|---|
|
|
Absolute path of a JAR file to generate. |
|
|
The file pattern supported by MDS transfer APIs. Use the semicolon delimiter ( /Project1/**;/Project2/** This example exports all documents under |
1.12 SOA Composite Application Partition Management Commands
Use the deployment commands, listed in Table 1-12, to manage partitions. Partitioning enable you to logically group different revisions of your SOA composite applications into separate sections. This is similar to the concept of domains in the 10.1.x releases of Oracle BPEL Process Manager.
Table 1-12 SOA Composite Application Partition Management Commands for WLST Configuration
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Create a partition. |
Online |
|
|
Undeploy all SOA composite applications in a partition before deleting the partition. |
Online |
|
|
Start all SOA composite applications in a partition. |
Online |
|
|
Stop all SOA composite applications in a partition. |
Online |
|
|
Activate all SOA composite applications in a partition. |
Online |
|
|
Retire all SOA composite applications in a partition. |
Online |
|
|
List all partitions in the SOA Infrastructure. |
Online |
|
|
List all composites in a specific partition. |
Online |
|
|
Create a partition and associate it with a work manager group. |
Online |
1.12.1 sca_createPartition
Command Category: Application Partition Management Commands
Use with WLST: Online
1.12.1.2 Syntax
sca_createPartition(partitionName)
| Argument | Definition |
|---|---|
|
|
The name of the partition. |
1.12.2 sca_deletePartition
Command Category: Application Partition Management Commands
Use with WLST: Online
1.12.2.2 Syntax
sca_deletePartition(partitionName)
| Argument | Definition |
|---|---|
|
|
The name of the partition. |
1.12.3 sca_startCompositesInPartition
Command Category: Application Partition Management Commands
Use with WLST: Online
1.12.3.2 Syntax
sca_startCompositesInPartition(partitionName)
| Argument | Definition |
|---|---|
|
|
The name of the partition. |
1.12.4 sca_stopCompositesInPartition
Command Category: Application Partition Management Commands
Use with WLST: Online
1.12.4.2 Syntax
sca_stopCompositesInPartition(partitionName)
| Argument | Definition |
|---|---|
|
|
The name of the partition. |
1.12.5 sca_activateCompositesInPartition
Command Category: Application Partition Management Commands
Use with WLST: Online
1.12.5.2 Syntax
sca_activateCompositesInPartition(partitionName)
| Argument | Definition |
|---|---|
|
|
The name of the partition. |
1.12.6 sca_retireCompositesInPartition
Command Category: Application Partition Management Commands
Use with WLST: Online
1.12.6.2 Syntax
sca_retireCompositesInPartition(partitionName)
| Argument | Definition |
|---|---|
|
|
The name of the partition. |
1.12.7 sca_listPartitions
Command Category: Application Partition Management Commands
Use with WLST: Online
1.12.8 sca_listCompositesInPartition
Command Category: Application Partition Management Commands
Use with WLST: Online
1.12.8.2 Syntax
sca_listCompositesInPartition(partitionName)
| Argument | Definition |
|---|---|
|
|
The name of the partition. |
1.12.9 sca_createPartitionWMG
Command Category: Application Partition Management Commands
Use with WLST: Online
1.12.9.1 Description
Creates a partition and associates it with a work manager group. The work manager group is created if it does not exist.
1.12.9.2 Syntax
sca_createPartitionWMG(partitionName, workmanagerGroupName, workmanagerGroupDescription)
| Argument | Definition |
|---|---|
|
|
The name of the partition to be created. |
|
|
The name of the work manager group to use. The work manager group is created if it does not exist. |
|
|
The description of the work manager group if it is to be created. |
1.13 SOA Composite Application Offline Deployment Management Commands
Use the deployment commands, listed in Table 1-13, to manage offline deployments of SOA composite applications and shared data in the following file:
$domain/config/fmwconfig/composite-offline-deployments-default.xml
When you restart the SOA server, the SOA composite applications and shared data registered in the file are deployed.
Table 1-13 SOA Composite Application Offline Deployment Management Commands for WLST Configuration
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Register offline deployments of SOA composite applications and shared data. |
Offline |
|
|
Unregister offline deployments of SOA composite applications and shared data |
Offline |
Note the following guidelines when using these WLST commands:
-
If the same SOA composite application is registered again and the corresponding SAR file has the same name, the composite is not redeployed. The composite is bypassed during offline deployment. This is because offline deployment does not support composite redeployments.
-
Ensure that your SOA composite application JAR name is prefixed with
sca_. Thesca_registerCompositeOfflineDeploymentcommand registers either shared data deployment or composite deployment. The composite SAR file is always named assca_*.jar. Only JAR files that start withsca_are considered composite SAR files. JAR files that do not start withsca_are treated as a shared data file. -
When you register a newer revision of a SOA composite application (for example, revision 2.0 of
sca_HelloWorld.jar) with thesca_registerCompositeOfflineDeploymentcommand and then restart the server, the previous default SOA composite application revision (for example, revision 1.0 ofsca_HelloWorld.jar) is retired. Any runtime changes that were performed in the older 1.0 revision with a runtime tool such as Oracle SOA Composer are merged into the newer 2.0 revision.
For information about offline deployment with configuration files, see Section "Deploying SOA Composite Applications with No Servers Running" of Developing SOA Applications with Oracle SOA Suite.
For more information about SAR file naming conventions, see Section "Deployed Service Archives" of Developing SOA Applications with Oracle SOA Suite.
1.13.1 sca_registerCompositeOfflineDeployment
Command Category: Application Offline Deployment Management Commands
Use with WLST: Offline
1.13.1.1 Description
Registers offline deployments of SOA composite applications and shared data in the composite-offline-deployments-default.xml file. Registration enables the SOA composite applications and shared data listed in the file to be deployed when the SOA server is restarted.
1.13.1.2 Syntax
sca_registerCompositeOfflineDeployment(domainDir, fileLocation, partition)
| Argument | Definition |
|---|---|
|
|
The absolute path to the server domain. |
|
|
The absolute path of a composite SAR file or shared data JAR file. |
|
|
The partition in which to deploy the composite, This argument is optional. If not specified, the default partition named |
1.13.1.3 Examples
This example specifies the domain directory and the file location for the sca_HelloWorld.jar composite.
wls:/mydomain/ServerConfig> sca_registerCompositeOfflineDeployment
('/scratch/aime1/fmwhome12/user_projects/domains/soainfra',
'/tmp/sca_HelloWorld.jar')
This example specifies the domain directory, the file location for the sca_App1.jar composite, and the partition myPartition.
wls:/mydomain/ServerConfig> sca_registerCompositeOfflineDeployment
('/scratch/aime1/fmwhome12/user_projects/domains/soainfra','/tmp/sca_App1.jar', partition='myPartition')
This example specifies the domain directory and the file location for the shareddata.jar shared data file.
wls:/mydomain/ServerConfig> sca_registerCompositeOfflineDeployment
('/scratch/aime1/fmwhome12/user_projects/domains/soainfra',
'/tmp/shareddata.jar')1.13.2 sca_unregisterCompositeOfflineDeployment
Command Category: Application Offline Deployment Management Commands
Use with WLST: Offline
1.13.2.1 Description
Unregisters (removes) the SOA composite application or shared data from the $domain/config/fmwconfig/composite-offline-deployments-default.xml file so that it is not processed during a server restart. The composite or shared data is not checked during the offline deployment process. This does not impact the existing SOA composite applications. It does not undeploy or retire the composite when the server restarts.
1.13.2.2 Syntax
sca_unregisterCompositeOfflineDeployment(domainDir, fileLocation)
| Argument | Definition |
|---|---|
|
|
The absolute path to the server domain. |
|
|
The absolute path of a composite SAR file or a shared data JAR file. |
1.13.2.3 Examples
This example specifies the domain directory and the sca_HelloWorld.jar SAR file.
wls:/mydomain/ServerConfig> sca_unregisterCompositeOfflineDeployment
('/scratch/aime1/fmwhome12/user_projects/domains/soainfra','/tmp/sca_HelloWorld.jar')
This example specifies the domain directory and the shareddata.jar shared data file.
wls:/mydomain/ServerConfig> sca_unregisterCompositeOfflineDeployment('/scratch/aime1/fmwhome12/
user_projects/domains/soainfra','/tmp/shareddata.jar')1.14 SOA Health Check Commands
The SOA Health Check framework provides a number of health checks and health check categories to monitor the health of your system. Checks include memory checks, data source checks, SOA-related service checks, SOA application-targeting checks, BPEL-related checks, and so on.
Use the SOA Health Check commands, listed in Table 1-14, to configure and execute SOA health checks.
Table 1-14 SOA Health Check Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Execute a health check and retrieve the report. |
Online |
|
|
Execute a health check category and retrieve the report. |
Online |
|
|
Execute the specified health checks and retrieve the report. |
Online |
|
|
Retrieve all unsuccessful run ids in the specified time interval. |
Online |
|
|
Retrieve the report corresponding to the specified unsuccessful health check run-id. |
Online |
|
|
List all registered health checks. |
Online |
|
|
List all health checks in the specified category. |
Online |
|
|
List all health check categories. |
Online |
|
|
Delete all health check request results. |
Online |
|
|
Delete health check request results gathered during the specified time interval. |
Online |
|
|
Retrieve the results report of unsuccessful health check runs that match a filter criteria. |
Online |
|
|
Retrieve the current value of a health check parameter. |
Online |
|
|
Set the value for a health check parameter. |
Online |
|
|
Reset a health check parameter to its default value. |
Online |
|
|
Retrieve the list of health check parameters and their values. |
Online |
|
|
Enable or disable the health check startup run. |
Online |
|
|
Change the category used for the health check startup run. |
Online |
|
|
Retrieve the health check startup run details. |
Online |
|
|
Create a health check periodic run with the specified name and settings. |
Online |
|
|
Enable or disable a health check periodic run. |
Online |
|
|
Change the interval for a periodic run. |
Online |
|
|
Change the schedule for a periodic run. |
Online |
|
|
Change the category of a periodic run to the specified category. |
Online |
|
|
Retrieve settings for the specified periodic run. |
Online |
|
|
Retrieve details of all health check periodic runs. |
Online |
|
|
Delete a health check periodic run. |
Online |
|
|
Retrieve the list of disabled health checks. |
Online |
|
|
Disable a health check. |
Online |
|
|
Re-enable a disabled health check. |
Online |
1.14.1 executeHealthCheckAndGenerateReport
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Executes the specified health check and retrieves a report of the run.
Syntax
executeHealthCheckAndGenerateReport(hcName, fileName)
| Argument | Definition |
|---|---|
|
|
Name of the health check to execute. |
|
|
Name and path of the file used to store the output report. |
Example 1-1 Example
The following example executes the DatasourceCheck health check and stores the result in /tmp/myfile.
wls:/mydomain/ServerConfig> executeHealthCheckAndGenerateReport('DatasourceCheck',
'/tmp/myfile')1.14.2 executeHealthCheckCategoryAndGenerateReport
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Executes the specified health check category and retrieves a report of the run.
Syntax
executeHealthCheckCategoryAndGenerateReport(categoryName, fileName)
| Argument | Definition |
|---|---|
|
categoryName |
Name of the health check category to execute. |
|
fileName |
Name and path of the file used to store the output report. |
Example 1-2 Example
The following example executes the Startup health check category and stores the result in /tmp/myfile.
wls:/mydomain/ServerConfig> executeHealthCheckCategoryAndGenerateReport('Startup',
'/tmp/myfile')1.14.3 executeHealthChecksAndGenerateReport
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Executes the specified health checks and retrieves a report of the run.
Syntax
executeHealthChecksAndGenerateReport(hcNames, fileName)
| Argument | Definition |
|---|---|
|
|
Names of the health checks to execute. |
|
|
Name and path of the file used to store the output report. |
Example 1-3 Example
wls:/mydomain/ServerConfig>
executeHealthChecksAndGenerateReport(['DatasourceCheck', 'SOALibraryCheck'],
'/tmp/myfile')1.14.4 getUnsuccessfulHCRequestIds
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Retrieves all unsuccessful run ids in the specified time interval.
Syntax
getUnsuccessfulHCRequestIds(startTime, endTime)
| Argument | Definition |
|---|---|
|
|
Start time of the interval. |
|
|
End time of the interval. |
Example 1-4 Example
The following example retrieves all unsuccessful run ids between 1:00 pm and 3:00 pm on 17th June, 2014.
wls:/mydomain/ServerConfig> getUnsuccessfulHCRequestIds('Jun 17, 2014 1:00:00 PM',
'Jun 17, 2014 3:00:00 PM')1.14.5 getUnsuccessfulHCRequestResultReport
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Retrieves the report corresponding to the specified unsuccessful health check run-id.
Syntax
getUnsuccessfulHCRequestResultReport(id, fileName)
| Argument | Definition |
|---|---|
|
|
Health check run id. |
|
|
Name and path of the file used to store the output report. |
Example 1-5 Example
The following example retrieves the report corresponding to run id 2 and stores it in /tmp/myfile.
wls:/mydomain/ServerConfig> getUnsuccessfulHCRequestResultReport('2',
'/tmp/myfile')1.14.6 listHealthChecks
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Lists all registered health checks.
Syntax
listHealthChecks()
Example 1-6 Example
The following example lists the registered health checks.
wls:/mydomain/ServerConfig> listHealthChecks()
Successfully executed the command. Registered health checks are:
-------------------------------------------------------------------
[DatasourceCheck]
[SOAAppCheck]
[JDBCPoolsCheck]
[SOALibraryCheck]
[BPELAsyncRequestCheck]
[BPELComponentInstanceCheck]
[EDNMessageCheck]
[ServiceCheck]
[MemoryCheck]
------------------------------------------------------------------- 1.14.7 listHealthChecksInCategory
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Lists all health checks in the specified category.
Syntax
listHealthChecksInCategory(categoryName)
| Argument | Definition |
|---|---|
|
|
Name of the health check category. |
Example 1-7 Example
The following example lists all health checks under the Startup category.
wls:/mydomain/ServerConfig> listHealthChecksInCategory('Startup')
Successfully executed the command. Registered health checks in the given category are:
---------------------------------------------------------------------------------
---
[DatasourceCheck]
[SOAAppCheck]
[JDBCPoolsCheck]
[SOALibraryCheck]
[ServiceCheck]
[MemoryCheck]
---------------------------------------------------------------------------------
--- 1.14.8 listHealthCheckCategories
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Lists all health check categories.
Syntax
listHealthCheckCategories()
Example 1-8 Example
The following example lists the health check categories:
wls:/mydomain/ServerConfig> listHealthCheckCategories()
Successfully executed the command. Registered health check categories are:
-----------------------------------------------------------------------------
[Startup]
[Quick]
[Intermediate]
[Extensive]
[Config]
----------------------------------------------------------------------------- 1.14.9 deleteAllHCRequestResults
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Deletes all health check request results.
Syntax
deleteAllHCRequestResults()
Example 1-9 Example
The following example deletes all health check request results:
wls:/mydomain/ServerConfig> deleteAllHCRequestResults()
Successfully executed the command.1.14.10 deleteHCRequestResults
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Deletes health check request results gathered during the specified time interval.
Syntax
deleteHCRequestResults(startTime, endTime)
| Argument | Definition |
|---|---|
|
|
Start time of the interval. |
|
|
End time of the interval. |
Example 1-10 Example
The following example deletes health check request results between 1:00 pm and 3:00 pm on 17th June, 2014.
wls:/mydomain/ServerConfig> deleteHCRequestResults('Jun 17, 2014 1:00:00 PM',
'Jun 17, 2014 3:00:00 PM')1.14.11 getUnsuccessfulHCResultReport
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Retrieves the results report of unsuccessful health check runs that match the specified filter criteria.
If stateNames is not passed, then all states are used. If hcName is not passed, then all health checks are considered. If fileName is not passed, a report called hcResultReport.html is generated in the current working directory.
Syntax
getUnsuccessfulHCResultReport(startTime, endTime, stateNames=[], hcName=None, fileName='hcResultReport.html')
| Argument | Definition |
|---|---|
|
|
Start time of the interval. |
|
|
End time of the interval. |
|
|
Optional. State names (for example, ['Success']) |
|
|
Optional. Name of the health check for which unsuccessful result reports are to be retrieved. |
|
|
Optional. Name and path of the file in which the output report is to be stored. |
Example 1-11 Example
wls:/mydomain/ServerConfig> getUnsuccessfulHCResultReport('Jan 1, 1970 0:00:00
AM', 'Jul 22, 2014 8:00:00 PM', ['Success'], 'DatasourceCheck',
'/tmp/myfile')1.14.12 getHCParameter
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Retrieves the current value of the specified health check parameter.
Syntax
getHCParameter(paramName)
| Argument | Definition |
|---|---|
|
|
Name of the health check parameter to check. |
Example 1-12 Example
wls:/mydomain/ServerConfig> getHCParameter("MemoryCheck.memThreshold")
Health Check Parameter:
----------------------------
Name : MemoryCheck.memThreshold
Value : 25
1.14.13 setHCParameter
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Sets the specified value for a health check parameter. This command overrides the default value of the health check parameter.
Syntax
setHCParameter(paramName, paramValue)
| Argument | Definition |
|---|---|
|
|
Name of the health check parameter to update. |
|
|
New value of the health check parameter. |
Example 1-13 Example
wls:/mydomain/ServerConfig> setHCParameter("MemoryCheck.memThreshold", "35") 1.14.14 resetHCParameter
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Resets the specified health check parameter to its default value.
Syntax
resetHCParameter(paramName)
| Argument | Definition |
|---|---|
|
|
Name of the health check parameter to update. |
Example 1-14 Example
wls:/mydomain/ServerConfig> resetHCParameter("MemoryCheck.memThreshold") 1.14.15 getHCParameters
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Retrieves the list of health check parameters and their values.
Syntax
getHCParameters()
Example 1-15 Example
wls:/mydomain/ServerConfig> getHCParameters()
Successfully executed the command. Health check parameters are:
----------------------------------------------------------------
JDBCPoolsCheck.ConnectionMaxMillis=2000
EDNMessageCheck.pendingMsgOaooCount=5000
EDNMessageCheck.pendingMsgCount=2000
BPELAsyncRequestCheck.pendingAsyncReqCount=1000
BPELComponentInstanceCheck.faultInstanceCount=500
BPELComponentInstanceCheck.openInstanceCount=1000
JDBCPoolsCheck.TestMaxMillis=1000
MemoryCheck.memThreshold=35
----------------------------------------------------------------1.14.16 enableHCStartupRun
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Enables or disables the health check startup run.
Syntax
enableHCStartupRun(enabledFlag)
| Argument | Definition |
|---|---|
|
|
Boolean value (true or false) used to enable or disable the health check startup run. |
Example 1-16 Example
The following example enables the startup run.
wls:/mydomain/ServerConfig> enableHCStartupRun(true) 1.14.17 setHCStartupRunCategory
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Changes the category used for the health check startup run.
Syntax
setHCStartupRunCategory(categoryName)
| Argument | Definition |
|---|---|
|
|
Name of the health check category to be used for the startup run. |
Example 1-17 Example
The following example sets the startup run category to Quick.
wls:/mydomain/ServerConfig> setHCStartupRunCategory('Quick') 1.14.18 getHCStartupRun
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Retrieves the health check startup run details. The details include the startup run health check category and the status of the run (enabled or disabled).
Syntax
getHCStartupRun()
Example 1-18 Example
wls:/mydomain/ServerConfig> getHCStartupRun()
Startup Run
-----------------------------
Category Name : Startup
Enabled : true1.14.19 createHCPeriodicRun
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Creates a health check periodic run with the specified name and settings.
Syntax
createHCPeriodicRun(name, enabledFlag, interval, minuteOfHour, hourOfDay,
dayOfWeek, categoryName)
| Argument | Definition |
|---|---|
|
|
Name of the periodic run. |
|
|
Boolean value (true or false) that determines whether the periodic run is enabled or disabled. |
|
|
Interval or time period (in minutes) between two periodic runs. |
|
|
Minute of the hour at which to start the first run. The value -1 stands for immediate. |
|
|
Hour of the day at which to start the first run. The value -1 stands for immediate. |
|
|
Day of the week at which to start the first run. The value -1 stands for immediate. |
|
|
Name of the health check category to be used for the periodic run. |
Example 1-19 Example
wls:/mydomain/ServerConfig> createHCPeriodicRun('myrun', true, 30, 0, -1, -1,
'Intermediate')1.14.20 enableHCPeriodicRun
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Enables or disables a health check periodic run.
Syntax
enableHCPeriodicRun(name, enabledFlag)
| Argument | Definition |
|---|---|
|
|
Name of the periodic run to enable or disable. |
|
|
Boolean value (true or false) that determines whether the periodic run is to be enabled or disabled. |
Example 1-20 Example
The following example enables the myrun periodic health check:
wls:/mydomain/ServerConfig> enableHCPeriodicRun('myrun', true)1.14.21 setHCPeriodicRunInterval
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Changes the interval of the specified periodic run.
Syntax
setHCPeriodicRunInterval(name, interval)
| Argument | Definition |
|---|---|
|
|
Name of the health check periodic run. |
|
|
Time interval, in minutes, between successive executions of the specified periodic run. |
Example 1-21 Example
The following example sets the interval to 2 hours for the myrun periodic health check:
wls:/mydomain/ServerConfig> setHCPeriodicRunInterval('myrun', 120)1.14.22 setHCPeriodicRunSchedule
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Changes the schedule for the specified periodic run.
Syntax
setHCPeriodicRunSchedule(name, minuteOfHour, hourOfDay, dayOfWeek)
| Argument | Definition |
|---|---|
|
|
Name of the health check periodic run. |
|
|
Minute of the hour at which to start the first run. The value -1 stands for immediate. |
|
|
Hour of the day at which to start the first run. The value -1 stands for immediate. |
|
|
Day of the week at which to start the first run. The value -1 stands for immediate. |
Example 1-22 Example
wls:/mydomain/ServerConfig> setHCPeriodicRunSchedule('hourly', 0, -1, -1)1.14.23 setHCPeriodicRunCategory
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Changes the category of a periodic run to the specified category.
Syntax
setHCPeriodicRunCategory(name, categoryName)
| Argument | Definition |
|---|---|
|
|
Name of the health check periodic run. |
|
|
Name of the health check category to be used for the periodic run. |
Example 1-23 Example
wls:/mydomain/ServerConfig> setHCPeriodicRunCategory('myrun', 'Extensive')1.14.24 getHCPeriodicRun
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Retrieves details (like category, schedule, and enabled status) for the specified periodic run.
Syntax
getHCPeriodicRun(name)
| Argument | Definition |
|---|---|
|
|
Name of the health check periodic run. |
Example 1-24 Example
wls:/mydomain/ServerConfig> getHCPeriodicRun('myrun')
Periodic Run
-----------------------------
Name : myrun
Category Name : Extensive
Enabled : false
Interval : 2
Day of week : -1
Hour of day : -1
Minute of hour : 01.14.25 getHCPeriodicRuns
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Retrieves the details of all the health check periodic runs.
Syntax
getHCPeriodicRuns()
Example 1-25 Example
wls:/mydomain/ServerConfig> getHCPeriodicRuns()
Periodic Run Table
-----------------------------
PeriodicRun: frequently, enabled=false, interval=60, minuteOfHour=7, hourOfDay=-1,
dayOfWeek=-1, category=Quick
PeriodicRun: daily, enabled=false, interval=1440, minuteOfHour=15, hourOfDay=5,
dayOfWeek=-1, category=Intermediate
PeriodicRun: weekly, enabled=false, interval=10080, minuteOfHour=30, hourOfDay=3,
dayOfWeek=1, category=Extensive
PeriodicRun: myrun, enabled=false, interval=2, minuteOfHour=0, hourOfDay=-1,
dayOfWeek=-1, category=Extensive
PeriodicRun: myrun2, enabled=false, interval=2, minuteOfHour=0, hourOfDay=-1,
dayOfWeek=-1, category=Intermediate
PeriodicRun: myrun3, enabled=false, interval=2, minuteOfHour=0, hourOfDay=-1,
dayOfWeek=-1, category=Intermediate
PeriodicRun: myrun4, enabled=false, interval=30, minuteOfHour=0, hourOfDay=-1,
dayOfWeek=-1, category=Intermediate1.14.26 removeHCPeriodicRun
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Deletes the specified health check periodic run.
Syntax
removeHCPeriodicRun(name)
| Argument | Definition |
|---|---|
|
|
Name of the health check periodic run to delete. |
Example 1-26 Example
wls:/mydomain/ServerConfig> removeHCPeriodicRun('myrun')1.14.27 getDisabledHealthChecks
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Retrieves the list of disabled health checks.
Syntax
getDisabledHealthChecks()
Example 1-27 Example
wls:/mydomain/ServerConfig> getDisabledHealthChecks()1.14.28 addDisabledHealthCheck
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Disables the specified health check.
Syntax
addDisabledHealthCheck(hcName)
| Argument | Definition |
|---|---|
|
|
Name of the health check to disable. |
Example 1-28 Example
wls:/mydomain/ServerConfig> addDisabledHealthCheck('DatasourceCheck')1.14.29 removeDisabledHealthCheck
Command Category: SOA Health Check Commands
Description
Use with WLST: Online
Re-enables the disabled health check.
Syntax
removeDisabledHealthCheck(hcName)
| Argument | Definition |
|---|---|
|
|
Name of the health check to enable. |
Example 1-29 Example
wls:/mydomain/ServerConfig> removeDisabledHealthCheck('DatasourceCheck')