bpmDeploy
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. Choose any managed server to deploy the composite to all managed servers in the cluster.
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.
Environment/Instance 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. |
Weblogic Admin User |
| Yes | Admin user name for WebLogic server. |
Weblogic Admin Password |
| Yes |
|
MDS UserID |
| Yes | User name 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 |
SOA Deploy Config Plan |
| No | Ability to define config plan specific to a composite (see special considerations). |
Composite Revision To Keep | FDSOA_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 | FDSOA_DEPLOY_CFG_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 (see special considerations). |
SOA Make Default Revision |
| Yes | Flag to indicate if the deployed composite should be marked as the default revision. |
Inputs
Input Name | Input Code | Required | Description |
---|---|---|---|
Deploy Config Plan |
| No | Deployment config plan that is to be used for the composite. Takes a Wildcard expression or filename. Can be a relative or absolute path (see special considerations). |
Composite Revision |
| No | Provide the composite revision, this input will override the |
Stop On Purge Failure | FDSOA_INP_STOP_ON_PURGE_FAIL | No | Provides the ability to control whether a failed purge stops the workflow (default is False) |
Activate Purge On Deploy | FDSOA_INP_ACTIVATE_PURGE | No | Activates the composite revision purge on deploy feature (default is False) |
Preview Mode For Purge | FDSOA_INP_PURGE_PREVIEW | 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) see Composite Revision Purge for examples |
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 Environment/Instance.
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.
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 either Composite Revision
(plugin input) is used 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 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 limitation
nn
– 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" environment/instance 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. 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.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
Configuration Plans
Replacement Properties
See the Appendix.
- style