Performs environment-specific property replacement, determines next composite revision and deploys the SCA artifact or the patch artifact (12.2.1+ only) to the server or cluster. You must have built SCA artifact or the patch artifact (12.2.1+ only) as part of soaBuild operation prior to running deploy, i.e. soaBuild execution generates artifact file and is recorded in FlexDeploy as project version and then deployment is done using that project version to specific environments. Composite specific configuration plans or global configuration plans can be used during deploy, see information on project property and plugin input below.
Composite revision purging is an optional feature that allows the developer to control the number of revisions actively deployed on the server upon successful deployment of the composite.
This operation should be run on any SOA managed server endpoint.
Configure SOA Server Host and Port for any SOA managed server and after deployment composite will be available on all managed servers in the SOA cluster.
Target Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
SOA Server Host |
| Yes | Host name of the SOA managed server. |
SOA Server Port |
| Yes | Port number of the SOA managed server, which will be the SSL Listen Port or Listen Port based on whether you desire to connect using SSL. |
SOA Use SSL |
| No | Whether or not to use SSL when connecting to the SOA Server. Is unchecked by default. If checked, SOA Server Port must be set to the SSL Listen Port and Weblogic Domain Directory must be set. |
Weblogic Admin User |
| Yes | Admin username for WebLogic server. |
Weblogic Admin Password |
| Yes |
|
Weblogic Domain Directory |
| Yes* | Weblogic Domain Directory for the WebLogic server. *Only required if SOA Use SSL option is checked. |
MDS UserID |
| Yes | Username for MDS access. |
MDS Password |
| Yes | Password for |
MDS JDBC URL |
| Yes | Database URL for MDS access. |
Oracle SOA Home |
| Yes | Oracle SOA Home indicates where SOA Suite is installed. |
SOA Extend Classpath |
| No | Ability to extend the plugin classpath for external java classes or custom xpath functions |
Composite Revisions To Keep |
| No | Number of composite revisions to retain on the server after successful deployment |
Project Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
SOA Composite Name |
| Yes | Name of composite that is being deployed. |
SOA Deploy Config Plan |
| No | Ability to define config plan specific to a composite. (see Configuration Plans section below). When using composite specific configuration plans, they are stored in configPlans folder in artifacts, but you do not need to specify configPlans folder in this property value, just provide name of the configuration plan file as appropriate. You can also override this property for various environments to use different value for each environment. For example, mycomposite-cfgplan.xml |
SOA Partition |
| Yes | Name of the partition to hold the composite on the server. |
SOA Overwrite Revision |
| Yes | Flag to indicate if the composite revision on the server should be overwritten or a new revision created (Composite Revisions). |
SOA Make Default Revision |
| Yes | Flag to indicate if the deployed composite should be marked as the default revision. |
Use composite.xml revision |
| No | If checked, use the revision from the composite.xml file. If a revision is provided in Composite Revision input that will take precedence. Otherwise the version in composite.xml will be used (and SOA Overwrite Revision project property would be ignored). |
Set Retired State |
| No | If checked, set the mode equal to retired in composite.xml. This means the state will be retired |
Inputs
Input Name | Input Code | Required | Description |
|---|---|---|---|
Deploy Config Plan |
| No | Deployment config plan that is to be used for the composite deployment. Takes a Wildcard expression or filename. Can be a relative or absolute path (see Configuration Plans section below). |
Composite Revision |
| No | Provide the composite revision, this input will override the |
Stop On Purge Failure |
| No | Provides the ability to control whether a failed purge stops the workflow (default is False) |
Activate Purge On Deploy |
| No | Activates the composite revision purge on deploy feature (default is False) |
Preview Mode For Purge |
| No | Activates the purge preview mode. If purge is activated, preview mode will show in the logs the composite revisions that would have been purged with no purge occurring. (default is False) Composite Revision Purge for examples |
Stop After Deploy |
| No | Stops the most recently deployed composite revision after successful deployment (default is False). If other revisions are active, this input will adjust the default revision. Note that the shutdown is asynchronous, so it is possible that a polling composite could poll before it is shutdown. This is the same caveat that would apply to all SOA deployments whether performed through Ant or the Oracle APIs. The shutdown will happen within moments of the deployment. |
Outputs
Output Name | Required | Description |
|---|---|---|
| Yes | Revision of the composite for this deployment. |
| Yes | Revision of the composite for the previous default revision. |
Artifacts
This operation consumes an SCA composite jar from the artifacts repository.
Endpoint Selection
This operation will select all available endpoints associated to the Target.
Endpoint Execution
This operation will execute on any one of the selected endpoints and will be random in the determination of which one.
Special Considerations
Utilize the SOA Extend Classpath environment variable to extend the plugin classpath to allow the compile to succeed with custom java classes or xpath functions.
NOTE: when patching a long running process revision that isn't the default revision, the patching process will make the patched revision the default revision.
Composite Revisions
The revision for a composite is calculated unless Composite Revision (plugin input) is used, Use Composite Revision is checked, or SOA Overwrite Revision (project property) is checked. The input will override all revision logic and use the value that is passed in. If the input is empty, the use composite revision is unchecked, and the project property is unchecked, then the plugin will determine the largest revision on the server and increment the revision before deploying. The revision format is N.nn[.nn][.nn] with an initial value of 1.0, with
N– initial segment that will increment with no limitationnn– 0 through 99, when segment hits 100 it rolls to the next higher segment
Current revision | Next revision |
|---|---|
1.0 | 1.01 |
1.99 | 2.00 |
1.0.0 | 1.0.01 |
1.0.99 | 1.01.00 |
Composite Revision Purge
The composite revision purge will undeploy specific revisions based on the "Composite Revisions to Keep" Target property, defaulted to 1. The retained revisions will start at the default revision and retain composites until the property value is met. If there are more recent revisions than the default revision, those recent revisions will also be retained but will not count against the property value. Default revision is bold and Composite Revisions to Keep is 2.
Revision Ex 1 | Action | Revision Ex 2 | Action |
|---|---|---|---|
1.01 | purged | 1.01 | purged |
1.02 | purged | 1.02 | kept due to property count |
1.03 | purged | 1.03 | kept due to default revision |
1.04 | kept due to property count | 1.04 | kept due to more recent than default revision |
1.05 | kept due to default revision | 1.05 | kept due to more recent than default revision |
In addition, the Preview Mode for Purge input can activate the preview feature that will show the revisions that would have been purged in the logs. No purge will occur in preview mode.
Configuration Plans
See the SOA Configuration Plan documentation.
Replacement Properties
All files with the following suffix ("xml", "txt", "wsdl", "bpel", "jca", "xsd", "componentType", "dvm", "xref", "xsl", "wadl", "mplan", "task") within the composite file structure are pre-processed by the plugin to transform any defined replacement properties.
A deployment config plan file or composite.xml will have server host names within it and will vary from environment to environment.