1 Oracle SOA Suite Custom WLST Commands

This chapter describes WSLT commands for Oracle SOA Suite. These commands enable you to use WLST to configure SOA composite applications.

Note:

To use these commands, you must invoke WLST from SOA_HOME/common/bin.

WLST provides both offline and online modes. Offline commands can be used without connecting to the Administration Server. When you first invoke WLST, you are in offline mode. You need to connect to the Administration server, using the connect command, before you can use the online mode commands.

1.2.1 sca_deployComposite

Command Category: Deployment Commands

Use with WLST: Offline

1.2.1.1 Description

Deploys a SOA composite application to the Oracle WebLogic Server. This command does not package the artifact files of the application for deployment. See SOA Composite Application Packaging Commands for instructions on packaging a SOA composite application.

1.2.1.2 Syntax

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.

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.

keepInstancesOnRedeploy

Optional. Specifies whether to keep the instances on redeploy. The default value is false. This argument is used when BPM is installed.

Note:

Human workflow artifacts such as task mapped attributes (previously known as flex field mappings) and rules (such as vacation rules) are defined based on the namespace of the task definition. Therefore, the following issues are true when the same SOA composite application with a human workflow task is deployed into multiple partitions:

For the same task definition type, mapped attributes defined in one partition are visible in another partition.

Rules defined on a task definition in one partition can apply to the same definition in another partition.

1.2.2.1 Description

1.2.2.2 Syntax

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.

1.3.1 importMetadata

The application metadata can be transferred from one server location (testing) to another server location (production) by exporting and importing the metadata. Metadata can be imported using this command.

A list of Customization Layer names used to restrict the import operation to import customization documents that match the specified customization layers. This option will be ignored if excludeAllCust option is also specified

excludeAllCust

Specifies whether or not to import all customization documents.This option overrides the restrictCustTo

excludeBaseDocs

Specifies whether or not to import base documents

excludeExtendedMetadata

Specifies whether or not to import the Extended Metadata documents

cancelOnException

Whether or not to abort the import operation when an exception is encountered. On abort, the delete is rolled back if supported by the target store

applicationVersion

The application version in case multiple versions of the same application are deployed

1.3.2 exportMetadata

The application metadata can be transferred from one server location (testing) to another server location (production) by exporting and importing the metadata. Metadata can be exported using this command.

A list of Customization Layer names used to restrict the export operation to export customization documents that match the specified customization layers. This option will be ignored if excludeAllCust option is also specified

excludeAllCust

Specifies whether or not to export all customization documents.This option overrides the restrictCustTo

excludeBaseDocs

Specifies whether or not to export base documents

excludeExtendedMetadata

Specifies whether or not to export the Extended Metadata documents

fromLabel

If specified, transfers the documents from the source partition that is associated with this label

toLabel

If specified, will work with fromLabel variable to transfers the delta between fromLabel to toLabel from the source partition

applicationVersion

he application version in case multiple versions of the same application are deployed

Examples

To export the tip of all documents from a metadata repository's applications partition to a share filesystem:

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.

1.4.1.3 Example

The following example starts revision 1.0 of the HelloWorld application.

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.

1.4.2.3 Example

The following example stops revision 1.0 of the HelloWorld application.

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.

1.4.3.3 Example

The following example activates revision 1.0 of the HelloWorld application.

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.

1.4.4.3 Example

The following example retires revision 1.0 of the HelloWorld application.

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.

1.4.5.3 Example

The following example sets revision 1.0 of the HelloWorld application as the default version.

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

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.

1.11.4.3 Examples

1.12 SOA Composite Application Partition Management Commands

Use the deployment commands, listed in Table 1-12, to manage partitions. Partitioning enable you to logically group different revisions of your SOA composite applications into separate sections. This is similar to the concept of domains in the 10.1.x releases of Oracle BPEL Process Manager.

If the same SOA composite application is registered again and the corresponding SAR file has the same name, the composite is not redeployed. The composite is bypassed during offline deployment. This is because offline deployment does not support composite redeployments.

Ensure that your SOA composite application JAR name is prefixed with sca_. The sca_registerCompositeOfflineDeployment command registers either shared data deployment or composite deployment. The composite SAR file is always named as sca_*.jar. Only JAR files that start with sca_ are considered composite SAR files. JAR files that do not start with sca_ are treated as a shared data file.

When you register a newer revision of a SOA composite application (for example, revision 2.0 of sca_HelloWorld.jar) with the sca_registerCompositeOfflineDeployment command and then restart the server, the previous default SOA composite application revision (for example, revision 1.0 of sca_HelloWorld.jar) is retired. Any runtime changes that were performed in the older 1.0 revision with a runtime tool such as Oracle SOA Composer are merged into the newer 2.0 revision.

For more information about SAR file naming conventions, see Section "Deployed Service Archives" of Developing SOA Applications with Oracle SOA Suite.

1.13.1 sca_registerCompositeOfflineDeployment

Command Category: Application Offline Deployment Management Commands

Use with WLST: Offline

1.13.1.1 Description

Registers offline deployments of SOA composite applications and shared data in the composite-offline-deployments-default.xml file. Registration enables the SOA composite applications and shared data listed in the file to be deployed when the SOA server is restarted.

1.13.2 sca_unregisterCompositeOfflineDeployment

Command Category: Application Offline Deployment Management Commands

Use with WLST: Offline

1.13.2.1 Description

Unregisters (removes) the SOA composite application or shared data from the $domain/config/fmwconfig/composite-offline-deployments-default.xml file so that it is not processed during a server restart. The composite or shared data is not checked during the offline deployment process. This does not impact the existing SOA composite applications. It does not undeploy or retire the composite when the server restarts.

1.13.2.2 Syntax

sca_unregisterCompositeOfflineDeployment(domainDir, fileLocation)

Argument

Definition

domainDir

The absolute path to the server domain.

fileLocation

The absolute path of a composite SAR file or a shared data JAR file.

1.13.2.3 Examples

This example specifies the domain directory and the sca_HelloWorld.jar SAR file.

1.14.11 getUnsuccessfulHCResultReport

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.