This chapter describes how to use custom WLST commands in Oracle SOA Suite to deploy, manage, compile, package, test, export, import, partition, and diagnosis SOA composite applications; manage configuration plans; and validate human workflow tasks. Command line syntax, arguments, and command examples are also provided.
Note:
To use these commands, you must invoke WLST from the Oracle home in which the component has been installed. See "Using Custom WLST Commands" in the Oracle Fusion Middleware Administrator's Guide.This chapter includes the following sections:
Section 9.3, "SOA Composite Application Management Commands"
Section 9.4, "SOA Composite Application Compilation Commands"
Section 9.7, "SOA Composite Application HTTP Client-Based Export and Import Commands"
Section 9.8, "SOA Composite Application MBean-Based Export and Import Commands"
Section 9.9, "SOA Composite Application Partition Management Commands"
Section 9.10, "SOA Composite Application Preconfigured WLDF Watches Command"
For additional details about deployment, configuration plans, and test suites, see Oracle Fusion Middleware Developer's Guide for Oracle SOA Suite.
WLST commands are divided into the categories shown in Table 9-1.
Table 9-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 sections. |
Use the deployment commands, listed in Table 9-2, to deploy and undeploy SOA composite applications.
Table 9-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 |
Command Category: Deployment Commands
Use with WLST: Offline
Deploys a SOA composite application to the Oracle WebLogic Server. This command does not package the artifact files of the application for deployment. See Section 9.5, "SOA Composite Application Packaging Commands" for instructions on packaging a SOA composite application.
sca_deployComposite(serverURL, sarLocation, [overwrite], [user], [password], [forceDefault], [configplan], [partition])
| Argument | Definition |
|---|---|
serverURL |
URL of the server that hosts the SOA Infrastructure application (for example, http://myhost10:7001). |
sarLocation |
Absolute path to one the following:
|
overwrite |
Optional. Indicates whether to overwrite an existing SOA composite application file.
|
user |
Optional. User name to access the composite deployer servlet when basic authentication is configured. |
password |
Optional. Password to access the composite deployer servlet when basic authentication is configured. |
forceDefault |
Optional. Indicates whether to set the new composite as the default.
|
configplan |
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. |
partition |
Optional. The name of the partition in which to deploy the SOA composite application. The default value is default. If you do not specify a partition, the composite is automatically deployed into the default partition. |
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.
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")
Command Category: Deployment Commands
Use with WLST: Offline
sca_undeployComposite(serverURL, compositeName, revision, [user], [password], [partition])
| Argument | Definition |
|---|---|
serverURL |
URL of the server that hosts the SOA Infrastructure application (for example, http://myhost10:7001). |
compositeName |
Name of the SOA composite application. |
revision |
Revision ID of the SOA composite application. |
user |
Optional. User name to access the composite deployer servlet when basic authentication is configured. |
password |
Optional. Password to access the composite deployer servlet when basic authentication is configured. |
partition |
Optional. The name of the partition in which the SOA composite application is located. The default value is default. If you do not specify a partition, the default partition is searched for the SOA composite application. However, no other partitions are searched. |
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')
Use the management commands, listed in Table 9-3, to start, stop, activate, retire, assign a default revision version, and list deployed SOA composite applications.
Table 9-3 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 revision of the default composite of the given composite series. |
Offline |
|
|
List the deployed SOA composite applications. |
Offline |
|
|
List the SOA composite applications that failed during server startup. |
Offline |
Command Category: Application Management Commands
Use with WLST: Offline
sca_startComposite(host, port, user, password, compositeName, revision, [label], [partition])
| Argument | Definition |
|---|---|
host |
Hostname of the Oracle WebLogic Server (for example, myhost). |
port |
Port of the Oracle WebLogic Server (for example, 7001). |
user |
User name for connecting to the running server to get MBean information (for example, weblogic). |
password |
Password for the user name. |
compositeName |
Name of the SOA composite application. |
revision |
Revision of the SOA composite application. |
label |
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. |
partition |
Optional. The name of the partition in which the SOA composite application is located. The default value is default. If you do not specify a partition, the default partition is searched for the SOA composite application. However, no other partitions are searched. |
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")
Command Category: Application Management Commands
Use with WLST: Offline
sca_stopComposite(host, port, user, password, compositeName, revision, [label], [partition])
| Argument | Definition |
|---|---|
host |
Hostname of the Oracle WebLogic Server (for example, myhost). |
port |
Port of the Oracle WebLogic Server (for example, 7001). |
user |
User name for connecting to the running server to get MBean information (for example, weblogic). |
password |
Password for the user name. |
compositeName |
Name of the SOA composite application. |
revision |
Revision of the SOA composite application. |
label |
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. |
partition |
Optional. The name of the partition in which the SOA composite application is located. The default value is default. If you do not specify a partition, the default partition is searched for the SOA composite application. However, no other partitions are searched. |
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")
Command Category: Application Management Commands
Use with WLST: Offline
Activates a retired SOA composite application and its instances. You can then create new instances.
sca_activateComposite(host, port, user, password, compositeName, revision, [label], [partition])
| Argument | Definition |
|---|---|
host |
Hostname of the Oracle WebLogic Server (for example, myhost). |
port |
Port of the Oracle WebLogic Server (for example, 7001). |
user |
User name for connecting to the running server to get MBean information (for example, weblogic). |
password |
Password for the user name. |
compositeName |
Name of the SOA composite application. |
revision |
Revision of the SOA composite application. |
label |
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. |
partition |
Optional. The name of the partition in which the SOA composite application is located. The default value is default. If you do not specify a partition, the default partition is searched for the SOA composite application. However, no other partitions are searched. |
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")
Command Category: Application Management Commands
Use with WLST: Offline
Stops and retires a SOA composite application and all its running instances. If the process life cycle is retired, you cannot create a new instance. Existing instances are allowed to complete normally.
sca_retireComposite(host, port, user, password, compositeName, revision, [label], [partition])
| Argument | Definition |
|---|---|
host |
Hostname of the Oracle WebLogic Server (for example, myhost). |
port |
Port of the Oracle WebLogic Server (for example, 7001). |
user |
User name for connecting to the running server to get MBean information (for example, weblogic). |
password |
Password for the user name. |
compositeName |
Name of the SOA composite application. |
revision |
Revision of the SOA composite application. |
label |
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. |
partition |
Optional. The name of the partition in which the SOA composite application is located. The default value is default. If you do not specify a partition, the default partition is searched for the SOA composite application. However, no other partitions are searched. |
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")
Command Category: Application Management Commands
Use with WLST: Offline
Sets a SOA composite application revision as the default version. This revision is instantiated when a new request comes in.
sca_assignDefaultComposite(host, port, user, password, compositeName, revision, [partition])
| Argument | Definition |
|---|---|
host |
Hostname of the Oracle WebLogic Server (for example, myhost). |
port |
Port of the Oracle WebLogic Server (for example, 7001). |
user |
User name for connecting to the running server to get MBean information (for example, weblogic). |
password |
Password for the user name. |
compositeName |
Name of the SOA composite application. |
revision |
Revision of the SOA composite application. |
partition |
Optional. The name of the partition in which the SOA composite application is located. The default value is default. If you do not specify a partition, the default partition is searched for the SOA composite application. However, no other partitions are searched. |
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")
Command Category: Application Management Commands
Use with WLST: Offline
sca_getDefaultCompositeRevision(host, port, user, password, compositeName, partition)
| Argument | Definition |
|---|---|
host |
Hostname of the Oracle WebLogic Server (for example, myhost). |
port |
Port of the Oracle WebLogic Server (for example, 7001). |
user |
User name for connecting to the running server to get MBean information (for example, weblogic). |
password |
Password for the user name. |
compositeName |
Name of the SOA composite application. |
partition |
Optional. The name of the partition in which the SOA composite application is located. The default value is default. If you do not specify a partition, the default partition is searched for the SOA composite application. However, no other partitions are searched. |
The following example returns the revision of the default composite of the given composite series.
wls:/mydomain/ServerConfig> sca_getDefaultCompositeRevision("myhost", "7001", "weblogic", "weblogic","HelloWorld")
The following example returns the revision of the default composite of the given composite series in the partition named myPartition.
wls:/mydomain/ServerConfig> sca_getDefaultCompositeRevision("myhost", "7001", "weblogic", "weblogic", "HelloWorld", partition="myPartition")
Command Category: Application Management Commands
Use with WLST: Offline
sca_listDeployedComposites(host, port, user, password)
| Argument | Definition |
|---|---|
host |
Hostname of the Oracle WebLogic Server (for example, myhost). |
port |
Port of the Oracle WebLogic Server (for example, 7001). |
user |
User name for connecting to the running server to get MBean information (for example, weblogic). |
password |
Password for the user name. |
Command Category: Application Management Commands
Use with WLST: Offline
sca_listCompositesFailedInServerStart (host, port, user, password)
| Argument | Definition |
|---|---|
host |
Hostname of the Oracle WebLogic Server (for example, myhost). |
port |
Port of the SOA server (for example, 7001). |
user |
User name for connecting to the running server to get MBean information (for example, weblogic). |
password |
Password for the user name. |
The following example lists the SOA composite applications that failed during server startup.
wls:/mydomain/ServerConfig> sca_listCompositesFailedInServerStart('myhost' '7001','weblogic', 'welcome1')
If a SOA composite application failed, output is displayed in the following format:
Following 1 composites failed in SOA server start process: 1. BPELInvokesHello[1.0], partition=default, mode=active, state=on, isDefault=true, deployedTime=2012-09-28T00:48:13.182-07:00
Use the compilation commands, listed in Table 9-4, to compile SOA composite applications.
Table 9-4 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 |
Command Category: Application Compilation Commands
Use with WLST: Offline
Sets JVM system properties. This command can also set secure socket layer (SSL) system properties before using sca_deployComposite and sca_undeployComposite over SSL.
Command Category: Application Compilation Commands
Use with WLST: Offline
Compiles a SOA composite application.
Note:
Thesca_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.sca_compile(composite, [outXml], [error], [appHome], [displayLevel], [oracleHome])
| Argument | Definition |
|---|---|
composite |
Absolute path of a composite file in the expanded (unzipped) SAR directory. |
outXml |
Optional. Absolute path of an output XML file. |
error |
Optional. Absolute path of an error file. |
appHome |
Optional. Absolute path of the application home directory. This property is required if you have shared data. |
displayLevel |
Optional. The level of information to display. The default value is 1. |
oracleHome |
Optional. The oracle.home property. |
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")
Use the packaging command, listed in Table 9-5, to package SOA composite applications into a composite SAR file.
Table 9-5 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 |
Command Category: Application Packaging Commands
Use with WLST: Offline
Packages the SOA composite application files into a composite SAR file. This command performs the following operations:
Calls sca_compile to compile the composite artifacts in ${compositeDir}.
Calls javac to compile any source code under ${compositeDir}/src.
Replaces the revision in ${compositeDir}/composite.xml.
Packages the artifacts to create sca_${compositeName}_rev${revision}.jar in ${compositeDir}/deploy.
Note:
Thesca_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.sca_package(compositeDir, compositeName, revision, [appHome], [oracleHome])
| Argument | Definition |
|---|---|
compositeDir |
Absolute path of a directory that contains composite artifacts. |
compositeName |
Name of the composite. |
revision |
Revision ID of the composite. |
appHome |
Optional. Absolute path of the application home directory. This property is required if you have shared data. |
oracleHome |
Optional. The oracle.home property. |
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")
Use the SOA composite application test command, listed in Table 9-6, to test a SOA composite applications.
Table 9-6 SOA Composite Application Test Command for WLST Configuration
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Test deployed SOA composite applications. |
Offline |
Command Category: Application Test Commands
Use with WLST: Offline
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.
sca_test('compositeName', 'revision', 'testsuiteName', 'jndiPropFile',
[oracleHome='oracleHome'], [javaHome='javaHome'])
| Argument | Definition |
|---|---|
compositeName |
Name of the SOA composite application. |
revision |
Revision ID of the SOA composite application. |
testsuiteName |
Name of the test suite. |
jndiPropFile |
Absolute path to the JNDI property file. |
oracleHome |
Optional. The oracle.home system property. |
javaHome |
Optional. The java.passed.home system property. |
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')
Use the SOA composite application commands, listed in Table 9-7, to export and import SOA composite applications based on the HTTP client. The SOA Infrastructure must be running to use these commands.
Table 9-7 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 |
Command Category: Application Export and Import Commands
Use with WLST: Offline
sca_exportComposite(serverURL, updateType, sarFile, compositeName, revision, [user], [password], [partition])
| Argument | Definition |
|---|---|
serverURL |
URL of the server that hosts the SOA Infrastructure application (for example, http://stabc:8001). |
updateType |
Type of postdeployment changes to be exported:
|
sarFile |
Absolute path of a SAR file to generate (a .jar file that begins with sca_). |
compositeName |
Name of the composite to export. |
revision |
Revision of the composite to export. |
user |
Optional. The user name for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
password |
Optional. The password for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
partition |
Optional. The name of the partition in which the SOA composite application is located. The default value is default. |
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')
Command Category: Application Export and Import Commands
Use with WLST: Offline
sca_exportUpdates(serverURL, updateType, jarFile, compositeName, revision, [user], [password], [partition])
| Argument | Definition |
|---|---|
serverURL |
URL of the server that hosts the SOA Infrastructure application (for example, http://stabc:8001). |
updateType |
The type of postdeployment changes to be exported.
|
jarFile |
Absolute path of a JAR file to generate. sca_exportUpdates() creates a regular .jar file that cannot be imported using regular deployment commands. It must be imported by using sca_importUpdates(). |
compositeName |
Name of the composite to export. |
revision |
Revision of the composite to export. |
user |
Optional. The user name for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
password |
Optional. The password for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
partition |
Optional. The name of the partition in which the SOA composite application is located. The default value is default. |
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(serverURL, updateType, jarFile, compositeName, revision, user=None, password=None, partition='myPartition')
Command Category: Application Export and Import Commands
Use with WLST: Offline
sca_importUpdates(serverURL, jarFile, compositeName, revision, [user], [password])
| Argument | Definition |
|---|---|
serverURL |
URL of the server that hosts the SOA Infrastructure application (for example, http://stabc:8001). |
jarFile |
Absolute path of a JAR file that contains postdeployment changes. |
compositeName |
Name of the composite to which the postdeployment changes are imported. |
revision |
Revision of the composite to which the postdeployment changes are imported. |
user |
Optional. The user name for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
password |
Optional. The password for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
partition |
Optional. The name of the partition in which the SOA composite application is located. The default value is default. |
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(serverURL, jarFile, compositeName, revision, user=None, password=None, partition='myPartition')
Command Category: Application Export and Import Commands
Use with WLST: Offline
sca_exportSharedData(serverURL, jarFile, pattern, [user], [password])
| Argument | Definition |
|---|---|
serverURL |
URL of the server that hosts the SOA Infrastructure application (for example, http://stabc:8001). |
jarFile |
Absolute path of a JAR file to generate. |
pattern |
The file pattern supported by MDS transfer APIs. Use the semicolon delimiter (;) if more than one pattern is specified. Exclude the shared data namespace /apps in the pattern. For example:
/Project1/**;/Project2/** This example exports all documents under |
user |
Optional. The user name for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
password |
Optional. The password for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
Command Category: Application Export and Import Commands
Use with WLST: Offline
Removes a top-level shared data folder, even if there are composites deployed in the service engine.
sca_removeSharedData(serverURL, folderName, [user], [password])
| Argument | Definition |
|---|---|
serverURL |
URL of the server that hosts the SOA Infrastructure application (for example, http://stabc:8001). |
folderName |
The name of a top-level shared data folder to be removed. |
user |
Optional. The user name for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
password |
Optional. The password for accessing the server when basic configuration is configured. Use the following syntax for this argument:
|
Use the deployment commands, listed in Table 9-8, to export and import SOA composite applications on the server-based composite store MBean (CompositeStoreMXBean).
Table 9-8 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()
Command Category: Application Export and Import Commands
Use with WLST: Online
sca_exportCompositeMb(updateType, sarFile, compositeName, revision)
| Argument | Definition |
|---|---|
updateType |
Type of postdeployment changes to be exported:
|
sarFile |
Absolute path of a SAR file to generate. |
compositeName |
Name of the composite to export. |
revision |
Revision of the composite to export. |
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')
Command Category: Application Export and Import Commands
Use with WLST: Online
sca_exportUpdatesMb(updateType, jarFile, compositeName, revision)
| Argument | Definition |
|---|---|
updateType |
Type of postdeployment changes to be exported: all, property, or runtime. |
jarFile |
Absolute path of a JAR file to generate. |
compositeName |
Name of the composite to export. |
revision |
Revision of the composite to export. |
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')
Command Category: Application Export and Import Commands
Use with WLST: Online
sca_importUpdatesMb(jarFile, compositeName, revision)
| Argument | Definition |
|---|---|
jarFile |
Absolute path of a JAR file that contains postdeployment changes. |
compositeName |
Name of the composite to which the postdeployment changes are imported. |
revision |
Revision of the composite to which the postdeployment changes are imported. |
Command Category: Application Export and Import Commands
Use with WLST: Online
sca_exportSharedDataMb(jarFile, pattern)
| Argument | Definition |
|---|---|
jarFile |
Absolute path of a JAR file to generate. |
pattern |
The file pattern supported by MDS transfer APIs. Use the semicolon delimiter (;) if more than one pattern is specified. Exclude the shared data namespace /apps in the pattern. For example:
/Project1/**;/Project2/** This example exports all documents under |
Use the deployment commands, listed in Table 9-9, 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 9-9 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 |
Command Category: Application Partition Management Commands
Use with WLST: Online
Command Category: Application Partition Management Commands
Use with WLST: Online
Command Category: Application Partition Management Commands
Use with WLST: Online
Command Category: Application Partition Management Commands
Use with WLST: Online
Command Category: Application Partition Management Commands
Use with WLST: Online
Command Category: Application Partition Management Commands
Use with WLST: Online
Command Category: Application Partition Management Commands
Use with WLST: Online
Use the diagnostic command, listed in Table 9-10, to enable preconfigured WebLogic Diagnostic Framework (WLDF) watches for deployment, memory, and elapsed time of web service calls. You use WLDF watches and notifications to collect diagnostic data to identify problems. This data enables you to isolate and diagnose faults when they occur.
Table 9-10 SOA Composite Application Preconfigured WLDF Watches Command for WLST Configuration
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Enable preconfigured WLDF watches. |
Online |
Use the configuration plan management commands, listed in Table 9-11, to attach, extract, generate, and validate configuration plans for SOA composite applications.
Table 9-11 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 |
Command Category: Configuration Plan Management Commands
Use with WLST: Offline
Attaches the configuration plan file to the SOA composite application file. If a plan already exists in the file, it is overwritten with this new plan.
sca_attachPlan(sar, configPlan, [overwrite], [verbose])
| Argument | Definition |
|---|---|
sar |
Absolute path of the SAR file. |
configPlan |
Absolute path of the configuration plan file. |
overwrite |
Optional. Indicates whether to overwrite an existing configuration plan in the SAR file.
|
verbose |
Optional. Indicates whether to print more information about the configuration plan attachment.
|
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)
Command Category: Configuration Plan Management Commands
Use with WLST: Offline
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.
sca_extractPlan(sar, configPlan, [overwrite], [verbose])
| Argument | Definition |
|---|---|
sar |
Absolute path of a SAR file. |
configPlan |
Absolute path of a configuration plan file to which to be extracted. |
overwrite |
Optional. Indicates whether to overwrite an existing configuration plan file in the SAR file.
|
verbose |
Optional. Indicates whether to print more information about configuration plan extraction.
|
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)
Command Category: Configuration Plan Management Commands
Use with WLST: Offline
sca_generatePlan(configPlan, sar, composite, [overwrite], [verbose])
| Argument | Definition |
|---|---|
configPlan |
Absolute path of the configuration plan file to be generated. |
sar |
Absolute path of the SAR file. |
composite |
Absolute path of the composite.xml file in the expanded (unzipped) SAR directory. |
overwrite |
Optional. Indicates whether to overwrite an existing configuration plan file:
|
verbose |
Indicates whether to print more information about plan generation:
|
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)
Command Category: Configuration Plan Management Commands
Use with WLST: Offline
Validates the configuration plan. This command identifies all search and replacement changes to be made during deployment. Use this option for debugging only.
sca_validatePlan(reportFile, configPlan, [sar], [composite], [overwrite], [verbose])
| Argument | Definition |
|---|---|
reportFile |
Absolute path of the report file to be generated. Validation results are written to this file. |
configPlan |
Absolute path of the configuration plan file. |
sar |
Optional. The absolute path of the SAR file. |
composite |
Optional. The absolute path of the composite.xml file in the expanded (unzipped) SAR directory. |
overwrite |
Optional. Indicates whether to overwrite an existing configuration plan file:
|
verbose |
Optional. Indicates whether to print more information about configuration plan validation.
|
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)
Use the task validation command, listed in Table 9-12, to validate human workflow tasks.
Table 9-12 Task Validation Command for WLST Configuration
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Validate a human workflow task. |
Offline |
Command Category: Task Validation Commands
Use with WLST: Offline
Validates a human workflow task contained in the .task file that you created when designing a human task in the Human Task Editor.
Use the SOA Health Check commands, listed in Table 9-13, to configure and execute SOA health checks.
Table 9-13 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 |
Command Category: SOA Health Check Commands
Use with WLST: Online
Command Category: SOA Health Check Commands
Use with WLST: Online
Executes the specified health check category and retrieves a report of the run.
Command Category: SOA Health Check Commands
Use with WLST: Online
Command Category: SOA Health Check Commands
Use with WLST: Online
Command Category: SOA Health Check Commands
Use with WLST: Online
Retrieves the report corresponding to the specified unsuccessful health check run-id.
Command Category: SOA Health Check Commands
Use with WLST: Online
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]
-------------------------------------------------------------------
Command Category: SOA Health Check Commands
Use with WLST: Online
listHealthChecksInCategory(categoryName)
| Argument | Definition |
|---|---|
categoryName |
Name of the health check category. |
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]
---------------------------------------------------------------------------------
---
Command Category: SOA Health Check Commands
Use with WLST: Online
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]
-----------------------------------------------------------------------------
Command Category: SOA Health Check Commands
Use with WLST: Online
Command Category: SOA Health Check Commands
Use with WLST: Online
Deletes health check request results gathered during the specified time interval.
Command Category: SOA Health Check Commands
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.
getUnsuccessfulHCResultReport(startTime, endTime, stateNames=[], hcName=None, fileName='hcResultReport.html')
| Argument | Definition |
|---|---|
startTime |
Start time of the interval. |
endTime |
End time of the interval. |
stateNames |
Optional. State names (for example, ['Success']) |
hcName |
Optional. Name of the health check for which unsuccessful result reports are to be retrieved. |
fileName |
Optional. Name and path of the file in which the output report is to be stored. |
Command Category: SOA Health Check Commands
Use with WLST: Online
Command Category: SOA Health Check Commands
Use with WLST: Online
Sets the specified value for a health check parameter. This command overrides the default value of the health check parameter.
Command Category: SOA Health Check Commands
Use with WLST: Online
Command Category: SOA Health Check Commands
Use with WLST: Online
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
----------------------------------------------------------------
Command Category: SOA Health Check Commands
Use with WLST: Online
Command Category: SOA Health Check Commands
Use with WLST: Online
Command Category: SOA Health Check Commands
Use with WLST: Online
Command Category: SOA Health Check Commands
Use with WLST: Online
createHCPeriodicRun(name, enabledFlag, interval, minuteOfHour, hourOfDay, dayOfWeek, categoryName)
| Argument | Definition |
|---|---|
name |
Name of the periodic run. |
enabledFlag |
Boolean value (true or false) that determines whether the periodic run is enabled or disabled. |
interval |
Interval or time period (in minutes) between two periodic runs. |
minuteOfHour |
Minute of the hour at which to start the first run. The value -1 stands for immediate. |
hourOfDay |
Hour of the day at which to start the first run. The value -1 stands for immediate. |
dayOfWeek |
Day of the week at which to start the first run. The value -1 stands for immediate. |
categoryName |
Name of the health check category to be used for the periodic run. |
Command Category: SOA Health Check Commands
Use with WLST: Online
Command Category: SOA Health Check Commands
Use with WLST: Online
Command Category: SOA Health Check Commands
Use with WLST: Online
setHCPeriodicRunSchedule(name, minuteOfHour, hourOfDay, dayOfWeek)
| Argument | Definition |
|---|---|
name |
Name of the health check periodic run. |
minuteOfHour |
Minute of the hour at which to start the first run. The value -1 stands for immediate. |
hourOfDay |
Hour of the day at which to start the first run. The value -1 stands for immediate. |
dayOfWeek |
Day of the week at which to start the first run. The value -1 stands for immediate. |
Command Category: SOA Health Check Commands
Use with WLST: Online
Command Category: SOA Health Check Commands
Use with WLST: Online
Retrieves details (like category, schedule, and enabled status) for the specified periodic run.
Command Category: SOA Health Check Commands
Use with WLST: Online
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=Intermediate
Command Category: SOA Health Check Commands
Use with WLST: Online
Command Category: SOA Health Check Commands
Use with WLST: Online
Command Category: SOA Health Check Commands
Use with WLST: Online