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

FDSOA_SERVER_HOST

Yes

Host name of the SOA managed server.

SOA Server Port

FDSOA_SERVER_PORT

Yes

Port number of the SOA managed server.

Weblogic Admin User

FDWLS_ADMIN_USER

Yes

Admin user name for WebLogic server.

Weblogic Admin Password

FDWLS_ADMIN_PASSWORD

Yes

Weblogic Admin User password for WebLogic server.

MDS UserID

FDMDS_USERID

Yes

User name for MDS access.

MDS Password

FDMDS_PASSWORD

Yes

Password for MDS UserID.

MDS JDBC URL

FDMDS_JDBCURL

Yes

Database URL for MDS access.

Oracle SOA Home

FD_ORACLE_SOA_HOME

Yes

Oracle SOA Home, indicates where SOA Suite is installed.

SOA Extend Classpath

FDSOA_EXT_CLASSPATH

No

Ability to extend the plugin classpath for external java classes or custom xpath functions

SOA Deploy Config Plan

FDSOA_DEPLOY_CFG_PLAN

No

Ability to define config plan specific to a composite (see special considerations).

Composite Revision To KeepFDSOA_REVISIONS_TO_KEEPNoNumber of composite revisions to retain on the server after successful deployment

Project Properties

Property Name

Property Code

Required

Description

SOA Composite Name

FDSOA_COMPOSITE_NAME

Yes

Name of composite that is being deployed.

SOA Deploy Config PlanFDSOA_DEPLOY_CFG_PLANNo

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

FDSOA_PARTITION

Yes

Name of the partition to hold the composite on the server.

SOA Overwrite Revision

FDSOA_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

FDSOA_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

FDSOA_INP_DEPLOY_CFG_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

FDSOA_INP_REVISION

No

Provide the composite revision, this input will override the SOA Overwrite Revision project property (see special considerations).

Stop On Purge FailureFDSOA_INP_STOP_ON_PURGE_FAILNoProvides the ability to control whether a failed purge stops the workflow (default is False)
Activate Purge On DeployFDSOA_INP_ACTIVATE_PURGENoActivates the composite revision purge on deploy feature (default is False)
Preview Mode For PurgeFDSOA_INP_PURGE_PREVIEWNoActivates 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

FDSOA_DEPLOYED_REVISION

Yes

Revision of the composite for this deployment.

FDSOA_LAST_DFLT_REVISION

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 revisionNext revision
1.01.01
1.992.00
1.0.01.0.01
1.0.991.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.
Revision Ex 1Action
Revision Ex 2Action
1.01purged
1.01purged
1.02purged
1.02kept due to property count
1.03purged
1.03kept due to default revision
1.04kept due to property count
1.04kept due to more recent than default revision
1.05kept due to default revision
1.05kept 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 Configuration Plans

Replacement Properties 

See the Appendix.