Skip Headers
Oracle® Fusion Middleware WebLogic Scripting Tool Command Reference
11g Release 1 (10.3.5)

Part Number E13813-10
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

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

For additional details about deployment, configuration plans, and test suites, see Oracle Fusion Middleware Developer's Guide for Oracle SOA Suite.

Overview of WSLT Command Categories

WLST commands are divided into the categories shown in Table 9-1.

Table 9-1 Oracle SOA Suite Command Categories

Command category Description

Deployment Commands

Deploy and undeploy SOA composite applications.

SOA Composite Application Management Commands

Start, stop, activate, retire, assign a default revision version, and list deployed SOA composite applications.

Configuration Plan Management Commands

Attach, extract, generate, and validate configuration plans for SOA composite applications.

Task Validation Commands

Validate human workflow tasks.

SOA Composite Application Compilation Commands

Compile SOA composite applications.

SOA Composite Application Packaging Commands

Package SOA composite applications into archive files to deploy.

SOA Composite Application Test Commands

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 (CompositeStoreMXBean).

SOA Composite Application Partition Management Commands

Logically group different revisions of your SOA composite applications into separate sections.


Deployment Commands

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

sca_deployComposite

Deploy a SOA composite application.

Offline

sca_undeployComposite

Undeploy a SOA composite application.

Offline


sca_deployComposite

Command Category: Deployment Commands

Use with WLST: Offline

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.

Syntax

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:
  • SOA archive (SAR) file.

    A SAR file is a special JAR file that requires a prefix of sca_ (for example, sca_HelloWorld_rev1.0.jar). The SAR file can be deployed with the deployment commands (such as sca_deployComposite()), but a regular .jar file is not treated as a special SAR file.

  • ZIP file that includes multiple SARs, metadata archives (MARs), or both.

  • Enterprise archive (EAR) file that contains a SAR file.

overwrite Optional. Indicates whether to overwrite an existing SOA composite application file.
  • false (default): Does not overwrite the file.

  • true: Overwrites the 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.
  • true (default): Makes it the default composite.

  • false: Does not make it the default composite.

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.

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

sca_undeployComposite

Command Category: Deployment Commands

Use with WLST: Offline

Description

Undeploys a currently deployed SOA composite application.

Syntax

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.

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

SOA Composite Application Management Commands

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

sca_startComposite

Start a previously stopped SOA composite application.

Offline

sca_stopComposite

Stop a SOA composite application.

Offline

sca_activateComposite

Activate a previously retired SOA composite application.

Offline

sca_retireComposite

Retire a SOA composite application.

Offline

sca_assignDefaultComposite

Assign the default revision version to a SOA composite application.

Offline

sca_getDefaultCompositeRevision

List the revision of the default composite of the given composite series.

Offline

sca_listDeployedComposites

List the deployed SOA composite applications.

Offline


sca_startComposite

Command Category: Application Management Commands

Use with WLST: Offline

Description

Starts a previously stopped SOA composite application.

Syntax

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.

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

sca_stopComposite

Command Category: Application Management Commands

Use with WLST: Offline

Description

Stops a currently running SOA composite application.

Syntax

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.

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

sca_activateComposite

Command Category: Application Management Commands

Use with WLST: Offline

Description

Activates a retired SOA composite application and its instances. You can then create new instances.

Syntax

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.

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

sca_retireComposite

Command Category: Application Management Commands

Use with WLST: Offline

Description

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.

Syntax

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.

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

sca_assignDefaultComposite

Command Category: Application Management Commands

Use with WLST: Offline

Description

Sets a SOA composite application revision as the default version. This revision is instantiated when a new request comes in.

Syntax

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.

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

sca_getDefaultCompositeRevision

Command Category: Application Management Commands

Use with WLST: Offline

Description

Lists the revision of the default composite of the given composite series.

Syntax

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.

Example

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

sca_listDeployedComposites

Command Category: Application Management Commands

Use with WLST: Offline

Description

Lists all SOA composite applications deployed to the SOA platform.

Syntax

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.

Example

The following example lists all the deployed SOA composite applications on the server myhost.

wls:/mydomain/ServerConfig> sca_listDeployedComposites('myhost', '7001', 
'weblogic', 'welcome1')

Configuration Plan Management Commands

Use the configuration plan management commands, listed in Table 9-4, to attach, extract, generate, and validate configuration plans for SOA composite applications.

Table 9-4 Configuration Plan Management Commands for WLST Configuration

Use this command... To... Use with WLST...

sca_attachPlan

Attach the configuration plan file to the SOA composite application JAR file.

Offline

sca_extractPlan

Extract a configuration plan packaged with the JAR file for editing.

Offline

sca_generatePlan

Generate a configuration plan for editing.

Offline

sca_validatePlan

Validate the configuration plan.

Offline


sca_attachPlan

Command Category: Configuration Plan Management Commands

Use with WLST: Offline

Description

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.

Syntax

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.
  • false (default): Does not overwrite the plan.

  • true: Overwrites the plan.

verbose Optional. Indicates whether to print more information about the configuration plan attachment.
  • true (default): Prints more information.

  • false: Does not print more information.


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)

sca_extractPlan

Command Category: Configuration Plan Management Commands

Use with WLST: Offline

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.

Syntax

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.
  • false (default): Does not overwrite the plan.

  • true: Overwrites the plan.

verbose Optional. Indicates whether to print more information about configuration plan extraction.
  • true (default): Prints more information.

  • false: Does not print more information.


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)

sca_generatePlan

Command Category: Configuration Plan Management Commands

Use with WLST: Offline

Description

Generates a configuration plan for editing.

Syntax

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:
  • false (default): Does not overwrite the plan.

  • true: Overwrites the plan.

verbose Indicates whether to print more information about plan generation:
  • true (default): Prints more information.

  • false: Does not print more information.


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)

sca_validatePlan

Command Category: Configuration Plan Management Commands

Use with WLST: Offline

Description

Validates the configuration plan. This command identifies all search and replacement changes to be made during deployment. Use this option for debugging only.

Syntax

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:
  • false (default): Does not overwrite the plan.

  • true: Overwrites the plan.

verbose Optional. Indicates whether to print more information about configuration plan validation.
  • true (default): Prints more information.

  • false: Does not print more information.


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)

Task Validation Commands

Use the task validation command, listed in Table 9-5, to validate human workflow tasks.

Table 9-5 Task Validation Command for WLST Configuration

Use this command... To... Use with WLST...

sca_validateTask

Validate a human workflow task.

Offline


sca_validateTask

Command Category: Task Validation Commands

Use with WLST: Offline

Description

Validates a human workflow task contained in the .task file that you created when designing a human task in the Human Task Editor.

Syntax

sca_validateTask(taskFile, outXml, [displayLevel])
Argument Definition
taskFile Absolute path to the task definition file (.task).
outXml Absolute path to an output XML file.
displayLevel Optional. The level of information to display. The default value is 1.

Example

The following example validates the WFTaskDefinition.task file of the human task.

wls:/mydomain/ServerConfig> sca_validateTask("/tmp/WFTaskDefinition.task", 
"/tmp/out.xml", displayLevel=2)

SOA Composite Application Compilation Commands

Use the compilation commands, listed in Table 9-6, to compile SOA composite applications.

Table 9-6 SOA Composite Application Compilation Commands for WLST Configuration

Use this command... To... Use with WLST...

sca_setProp

Set JVM system properties.

Offline

sca_compile

Compile a SOA composite application.

Offline


sca_setProp

Command Category: Application Compilation Commands

Use with WLST: Offline

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.

Syntax

sca_setProp(propName, propValue)
Argument Definition
propName Property name.
propValue Property value.

Example

The following example sets the property name and property value.

wls:/mydomain/ServerConfig> sca_setProp("oracle.home",
"/scratch/myusername/beahome/AS11gR1SOA")

sca_compile

Command Category: Application Compilation Commands

Use with WLST: Offline

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.

Syntax

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.

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

SOA Composite Application Packaging Commands

Use the packaging command, listed in Table 9-7, to package SOA composite applications into a composite SAR file.

Table 9-7 SOA Composite Application Packaging Command for WLST Configuration

Use this command... To... Use with WLST...

sca_package

Package the SOA composite application files into a composite SAR file.

Offline


sca_package

Command Category: Application Packaging Commands

Use with WLST: Offline

Description

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:

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.

Syntax

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.

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

SOA Composite Application Test Commands

Use the SOA composite application test command, listed in Table 9-8, to test a SOA composite applications.

Table 9-8 SOA Composite Application Test Command for WLST Configuration

Use this command... To... Use with WLST...

sca_test

Test deployed SOA composite applications.

Offline


sca_test

Command Category: Application Test Commands

Use with WLST: Offline

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.

Syntax

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.

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

SOA Composite Application HTTP Client-Based Export and Import Commands

Use the SOA composite application commands, listed in Table 9-9, to export and import SOA composite applications based on the HTTP client. The SOA Infrastructure must be running to use these commands.

Table 9-9 SOA Composite Application Export and Import Commands for WLST Configuration

Use this command... To... Use with WLST...

sca_exportComposite

Export a SOA composite application into a SAR file.

Offline

sca_exportUpdates

Export postdeployment changes of a SOA composite application into a JAR file.

Offline

sca_importUpdates

Import postdeployment changes of a SOA composite application.

Offline

sca_exportSharedData

Export shared data of a given pattern into a JAR file.

Offline

sca_removeSharedData

Removes a top-level shared data folder.

Offline


sca_exportComposite

Command Category: Application Export and Import Commands

Use with WLST: Offline

Description

Exports a SOA composite application into a SAR file.

Syntax

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:
  • all: Includes all postdeployment changes.

  • property: Includes only property postdeployment changes (binding component properties, composite properties such as audit level settings and payload validation status, and policy attachments).

  • runtime: Includes only runtime (rules dictionary and domain value maps (DVMs)) and metadata postdeployment changes.

  • none: Exports the original composite without any postdeployment changes (including property changes and runtime changes).

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:

user='username'

password Optional. The password for accessing the server when basic configuration is configured. Use the following syntax for this argument:

password='password'

partition Optional. The name of the partition in which the SOA composite application is located. The default value is default.

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

sca_exportUpdates

Command Category: Application Export and Import Commands

Use with WLST: Offline

Description

Exports postdeployment changes of a SOA composite application into a JAR file.

Syntax

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.
  • all: Includes all postdeployment changes.

  • property: Includes only property postdeployment changes (binding component properties, composite properties such as audit level settings and payload validation status, and policy attachments).

  • runtime: Includes only runtime (rules dictionary and domain value maps (DVMs)) and metadata postdeployment changes.

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:

user='username'

password Optional. The password for accessing the server when basic configuration is configured. Use the following syntax for this argument:

password='password'

partition Optional. The name of the partition in which the SOA composite application is located. The default value is default.

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(serverURL, updateType,
 jarFile, compositeName, revision, user=None, password=None,
 partition='myPartition')

sca_importUpdates

Command Category: Application Export and Import Commands

Use with WLST: Offline

Description

Imports postdeployment changes of a SOA composite application.

Syntax

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:

user='username'

password Optional. The password for accessing the server when basic configuration is configured. Use the following syntax for this argument:

password='password'

partition Optional. The name of the partition in which the SOA composite application is located. The default value is default.

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(serverURL, jarFile,
 compositeName, revision, user=None, password=None, partition='myPartition')

sca_exportSharedData

Command Category: Application Export and Import Commands

Use with WLST: Offline

Description

Exports shared data of a given pattern into a JAR file.

Syntax

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 /apps/Project1 and /apps/Project2.

user Optional. The user name for accessing the server when basic configuration is configured. Use the following syntax for this argument:

user='username'

password Optional. The password for accessing the server when basic configuration is configured. Use the following syntax for this argument:

password='password'


Examples

The following example exports shared data of a given pattern into a JAR file.

wls:/offline/mydomain/ServerConfig> sca_exportSharedData('http://stabc:8001',
'/tmp/MySharedData.jar', '/Project1/**')

sca_removeSharedData

Command Category: Application Export and Import Commands

Use with WLST: Offline

Description

Removes a top-level shared data folder, even if there are composites deployed in the service engine.

Syntax

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:

user='username'

password Optional. The password for accessing the server when basic configuration is configured. Use the following syntax for this argument:

password='password'


Examples

The following example removes the top-level shared data Project1 folder.

sca_removeSharedData('http://stabc:8001', 'Project1')

SOA Composite Application MBean-Based Export and Import Commands

Use the deployment commands, listed in Table 9-10, to export and import SOA composite applications on the server-based composite store MBean (CompositeStoreMXBean).

Table 9-10 SOA Composite Application Export and Import Commands for WLST Configuration

Use this command... To... Use with WLST...

sca_exportCompositeMb

Export a SOA composite application into a SAR file.

Online

sca_exportUpdatesMb

Export postdeployment changes of a SOA composite application into a JAR file.

Online

sca_importUpdatesMb

Import postdeployment changes of a SOA composite application.

Online

sca_exportSharedDataMb

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

sca_exportCompositeMb

Command Category: Application Export and Import Commands

Use with WLST: Online

Description

Exports a SOA composite application into a SAR file.

Syntax

sca_exportCompositeMb(updateType, sarFile, compositeName, revision)
Argument Definition
updateType Type of postdeployment changes to be exported:
  • all: All postdeployment changes are included.

  • property: Property changes are included (binding component properties, composite properties such as audit level settings and payload validation status, and policy attachments).

  • runtime: Postdeployment runtime changes are included (rules dictionary and domain value maps (DVMs)).

sarFile Absolute path of a SAR file to generate.
compositeName Name of the composite to export.
revision Revision of the composite to export.

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

sca_exportUpdatesMb

Command Category: Application Export and Import Commands

Use with WLST: Online

Description

Exports postdeployment changes of a SOA composite application into a JAR file.

Syntax

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.

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

sca_importUpdatesMb

Command Category: Application Export and Import Commands

Use with WLST: Online

Description

Imports postdeployment changes of a SOA composite application.

Syntax

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.

Examples

The following example imports postdeployment changes of a SOA composite application.

wls:/mydomain/ServerConfig> sca_importUpdatesMb('/tmp/all-HelloWorld_rev1.0.jar', 
'HelloWorld', '1.0')

sca_exportSharedDataMb

Command Category: Application Export and Import Commands

Use with WLST: Online

Description

Exports shared data of a given pattern into a JAR file.

Syntax

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 /apps/Project1 and /apps/Project2.


Examples

This example exports shared data of given pattern into a JAR file.

wls:/mydomain/ServerConfig> sca_exportSharedDataMb('/tmp/MySharedData.jar',
'/Project1/**')

SOA Composite Application Partition Management Commands

Use the deployment commands, listed in Table 9-11, 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-11 SOA Composite Application Partition Management Commands for WLST Configuration

Use this command... To... Use with WLST...

sca_createPartition

Create a partition.

Online

sca_deletePartition

Undeploy all SOA composite applications in a partition before deleting the partition.

Online

sca_startCompositesInPartition

Start all SOA composite applications in a partition.

Online

sca_stopCompositesInPartition

Stop all SOA composite applications in a partition.

Online

sca_activateCompositesInPartition

Activate all SOA composite applications in a partition.

Online

sca_retireCompositesInPartition

Retire all SOA composite applications in a partition.

Online

sca_listPartitions

List all partitions in the SOA Infrastructure.

Online

sca_listCompositesInPartition

List all composites in a specific partition.

Online


sca_createPartition

Command Category: Application Partition Management Commands

Use with WLST: Online

Description

Creates a partition.

Syntax

sca_createPartition(partitionName)
Argument Definition
partitionName The name of the partition.

Examples

This example creates a partition named myPartition.

wls:/mydomain/ServerConfig> sca_createPartition('myPartition')

sca_deletePartition

Command Category: Application Partition Management Commands

Use with WLST: Online

Description

Undeploys all composites in a partition before deleting the partition.

Syntax

sca_deletePartition(partitionName)
Argument Definition
partitionName The name of the partition.

Examples

This example undeploys all composites in the myPartition partition before deleting the partition.

wls:/mydomain/ServerConfig> sca_deletePartition('myPartition')

sca_startCompositesInPartition

Command Category: Application Partition Management Commands

Use with WLST: Online

Description

Starts all composites in a partition.

Syntax

sca_startCompositesInPartition(partitionName)
Argument Definition
partitionName The name of the partition.

Examples

This example starts all composites in the myPartition partition.

wls:/mydomain/ServerConfig> sca_startCompositesInPartition('myPartition')

sca_stopCompositesInPartition

Command Category: Application Partition Management Commands

Use with WLST: Online

Description

Stops all composites in a partition.

Syntax

sca_stopCompositesInPartition(partitionName)
Argument Definition
partitionName The name of the partition.

Examples

This example stops all composites in the myPartition partition.

wls:/mydomain/ServerConfig> sca_stopCompositesInPartition('myPartition')

sca_activateCompositesInPartition

Command Category: Application Partition Management Commands

Use with WLST: Online

Description

Activates all composites in a partition.

Syntax

sca_activateCompositesInPartition(partitionName)
Argument Definition
partitionName The name of the partition.

Examples

This example activates all composites in the myPartition partition.

wls:/mydomain/ServerConfig> sca_activateCompositesInPartition('myPartition')

sca_retireCompositesInPartition

Command Category: Application Partition Management Commands

Use with WLST: Online

Description

Retires all composites in a partition.

Syntax

sca_retireCompositesInPartition(partitionName)
Argument Definition
partitionName The name of the partition.

Examples

This example retires all composites in the myPartition partition.

wls:/mydomain/ServerConfig> sca_retireCompositesInPartition('myPartition')

sca_listPartitions

Command Category: Application Partition Management Commands

Use with WLST: Online

Description

Lists all partitions in the SOA Infrastructure.

Syntax

sca_listPartitions()

Examples

This example lists all partitions in the SOA Infrastructure.

wls:/mydomain/ServerConfig> sca_listPartitions()

sca_listCompositesInPartition

Command Category: Application Partition Management Commands

Use with WLST: Online

Description

Lists all composites in a partition.

Syntax

sca_listCompositesInPartition(partitionName)
Argument Definition
partitionName The name of the partition.

Examples

This example lists all composites in the myPartition partition.

sca_listCompositesInPartition(myPartition)