FC TIBCO Factory/BWMaven plugin

bw:start-bw

Full name:

fr.fastconnect.factory.tibco.bw.maven:bw-maven-plugin:2.4.1:start-bw

Description:

This goal starts a TIBCO BusinessWorks application deployed on a TIBCO domain.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: deploy.

Required Parameters

Name Type Since Description
buildLibDirectory File - Path to the dependencies (Projlibs, JARs...) for the build. Default is "target/lib"
Default value is: ${project.build.directory}/lib.
User property is: project.build.directory.lib.
buildSrcDirectory File - Path to the BusinessWorks sources for the build. Default is "target/src"
Default value is: ${project.build.directory}/src.
User property is: project.build.directory.src.
deployedProjectName String - Name of the project once deployed in TIBCO domain
User property is: deploy.project.name.
domainName String - TIBCO domain name
User property is: tibco.domain.name.
domainPassword String - TIBCO domain password
User property is: tibco.domain.password.
domainUsername String - TIBCO domain username
User property is: tibco.domain.username.
finalName String - Name of the generated artifact (without file extension).
User property is: project.build.finalName.
outputDirectory File - Directory containing the generated artifact.
User property is: project.build.outputDirectory.
packageDirectory File - Path to the package folder. Default is "target/package"
Default value is: ${project.build.directory}/package.
User property is: project.package.directory.
testDirectory File - Path to the test folder. Default is "target/test"
Default value is: ${project.build.directory}/test.
User property is: project.build.test.directory.
testLibDirectory File - Path to the dependencies (Projlibs, JARs...) for the test. Default is "target/test/lib"
Default value is: ${project.build.test.directory}/lib.
User property is: project.build.test.directory.lib.
testSrcDirectory File - Path to the BusinessWorks sources for the test. Default is "target/test/src"
Default value is: ${project.build.test.directory}/src.
User property is: project.build.test.directory.src.
tibcoBWEngineTRAPath File - Path to the BusinessWorks Engine TRA configuration file.
User property is: bwengine.tra.path.

Optional Parameters

Name Type Since Description
classifier String - (no description)
User property is: project.build.classifier.
contact String - (no description)
User property is: deploy.contact.
dependenciesIgnored ArrayList - List of "groupId:artifactId" to ignore when building
deploymentDescriptor File - (no description)
Default value is: ${project.package.directory}/${project.build.finalName}.xml.
User property is: deploy.descriptor.
deploymentDescriptorFinal File - (no description)
Default value is: ${project.package.directory}/${project.build.finalName}-final.xml.
User property is: deploy.descriptor.final.
deploymentGlobalVariables File - (no description)
Default value is: ${project.package.directory}/${project.build.finalName}.gv.properties.
User property is: deploy.properties.globalVariables.
deploymentGlobalVariablesCommon File - (no description)
Default value is: ${project.package.directory}/${project.artifactId}.gv.properties.
User property is: deploy.properties.globalVariables.common.
deploymentGlobalVariablesReference File - (no description)
Default value is: ${project.package.directory}/${project.artifactId}.gv.properties.
User property is: deploy.properties.globalVariables.reference.
deploymentServices File - (no description)
Default value is: ${project.package.directory}/${project.build.finalName}.services.properties.
User property is: deploy.properties.services.
deploymentServicesCommon File - (no description)
Default value is: ${project.package.directory}/${project.artifactId}.services.properties.
User property is: deploy.properties.services.common.
deploymentServicesReference File - (no description)
Default value is: ${project.package.directory}/${project.artifactId}.services.properties.
User property is: deploy.properties.services.reference.
description String - (no description)
User property is: deploy.description.
events Events - (no description)
User property is: events.
failWhenTimeoutReached Boolean - Whether to fail the Maven build when timeout is reached or not.
Default value is: false.
User property is: failWhenTimeoutReached.
filterProperties boolean - (no description)
Default value is: false.
User property is: deploy.properties.filterProperties.
hawkDomain String - (no description)
Default value is: ${tibco.domain.name}.
User property is: hawk.domain.
hawkRvDaemon String - (no description)
Default value is: tcp:7474.
User property is: hawk.rv.daemon.
hawkRvNetwork String - (no description)
Default value is: ;.
User property is: hawk.rv.network.
hawkRvService String - (no description)
Default value is: 7474.
User property is: hawk.rv.service.
hawkSubscribeInterval Integer - (no description)
Default value is: 10.
User property is: hawk.subscribe.interval.
hawkSubscribeNumberOfRetry Integer - (no description)
Default value is: 30.
User property is: hawk.subscribe.retry.count.
hawkVersion String - (no description)
User property is: tibco.hawk.version.
hideLibraryResources boolean - Allows to ignore any alias when building EAR or Projlib. This will mimic the "Hide Library Resources" behaviour of the TIBCO Designer.
User property is: bw.hide.library.resources.
ignoreCommonFiles boolean - (no description)
Default value is: false.
User property is: ignoreCommonFiles.
ignoreReferenceFiles boolean - (no description)
Default value is: false.
User property is: ignoreReferenceFiles.
maxDeploymentRevision String - (no description)
Default value is: -1.
User property is: deploy.maxDeploymentRevision.
numberOfRunningStatuses int - (no description)
Default value is: 3.
User property is: bw.start.running.statuses.number.
projectDirectory File - Path to the BusinessWorks project.
User property is: bw.project.location.
repoHttpExtraPropertyFile String - (no description)
User property is: repoHttpExtraPropertyFile.
repoHttpPassword String - (no description)
User property is: repoHttpPassword.
repoHttpServer String - (no description)
User property is: repoHttpServer.
repoHttpTimeout Integer - (no description)
Default value is: 600.
User property is: repoHttpTimeout.
repoHttpUrl String - (no description)
User property is: repoHttpUrl.
repoHttpUser String - (no description)
User property is: repoHttpUser.
repoLocalEncoding String - (no description)
Default value is: UTF-8.
User property is: repoLocalEncoding.
repoRvDaemon String - (no description)
Default value is: tcp:7500.
User property is: repoRvDaemon.
repoRvDiscoveryTimeout Integer - (no description)
Default value is: 10.
User property is: repoRvDiscoveryTimeout.
repoRvExtraPropertyFile String - (no description)
User property is: repoRvExtraPropertyFile.
repoRvNetwork String - (no description)
User property is: repoRvNetwork.
repoRvOperationRetry Integer - (no description)
Default value is: 0.
User property is: repoRvOperationRetry.
repoRvPassword String - (no description)
User property is: repoRvPassword.
repoRvRegionalSubject String - (no description)
User property is: repoRvRegionalSubject.
repoRvServer String - (no description)
User property is: repoRvServer.
repoRvService String - (no description)
Default value is: 7500.
User property is: repoRvService.
repoRvTimeout Integer - (no description)
Default value is: 600.
User property is: repoRvTimeout.
repoRvUser String - (no description)
User property is: repoRvUser.
repoSelectInstance String - (no description)
Default value is: local.
User property is: repoSelectInstance.
skipCompile Boolean - Whether to skip the compilation of EAR and Projlib.

NB: shall be used with 'bw.package.skip', 'maven.install.skip' and 'maven.deploy.skip' set to true.
Default value is: false.
User property is: bw.compile.skip.
skipEARCompile Boolean - Whether to skip the compilation of EAR.

NB: shall be used with 'bw.package.skip', 'maven.install.skip' and 'maven.deploy.skip' set to true.
Default value is: false.
User property is: bw.compile.ear.skip.
skipPackage Boolean - Whether to skip the package goals. NB: shall be used with 'maven.install.skip' and 'maven.deploy.skip' set to true.
Default value is: false.
User property is: bw.package.skip.
skipProjlibCompile Boolean - Whether to skip the compilation of Projlib.

NB: shall be used with 'bw.package.skip', 'maven.install.skip' and 'maven.deploy.skip' set to true
Default value is: false.
User property is: bw.compile.projlib.skip.
tibcoAppManagePath File - Path to the TIBCO "AppManage" binary.
User property is: appmanage.path.
tibcoAppManageTRAPath File - Path to the TIBCO "AppManage" TRA configuration file.
User property is: appmanage.tra.path.
tibcoBuildEARTRAPath File - Path to the TIBCO "buildear" TRA configuration file.
User property is: buildear.tra.path.
tibcoBuildEARUseDesignerTRA boolean - Sometimes a TRA can reference another TRA, for instance 'buildear.tra' will reference 'designer.tra'. This field specifies whether we will use the default referenced TRA or override with a provided TRA.
User property is: tra.buildear.uses.designer.tra.path.
tibcoBuildLibraryTRAPath File - Path to the TIBCO Designer "buildlibrary" TRA configuration file.
User property is: buildlibrary.tra.path.
tibcoBuildLibraryUseDesignerTRA boolean - Sometimes a TRA can reference another TRA, for instance 'buildlibrary.tra' will reference 'designer.tra'. This field specifies whether we will use the default referenced TRA or override with a provided TRA.
User property is: tra.buildlibrary.uses.designer.tra.path.
tibcoDesignerPath File - Path to the TIBCO Designer binary.
User property is: designer.path.
tibcoDesignerTRAPath File - Path to the TIBCO Designer TRA configuration file.
User property is: designer.tra.path.
tibcoHome File - Path to the TIBCO home directory.
User property is: tibco.home.
tibcoRvHomePath File - Path to the TIBCO RendezVous folder.
User property is: tibrv.home.path.
timeOut int - Timeout for the execution of TIBCO commands to build artifacts. This time is given in seconds.
Default value is: 180.
User property is: timeOut.
touchEARIfSkipped Boolean - Whether to "touch" the EAR file when EAR compilation is skipped.

NB: must be used with 'bw.compile.skip' or 'bw.compile.ear.skip' set to true.
Default value is: false.
User property is: bw.compile.ear.skip.touch.
touchFinalDeploymentDescriptorIfSkipped Boolean - Whether to "touch" the final deployment descriptor file when final deployment descriptor generation is skipped.

NB: must be used with 'bw.package.skip' set to true.
Default value is: false.
User property is: bw.package.skip.deploy.descriptor.final.touch.
touchProjlibIfSkipped Boolean - Whether to "touch" the Projlib file when Projlib compilation is skipped.

NB: must be used with 'bw.compile.skip' or 'bw.compile.projlib.skip' set to true.
Default value is: false.
User property is: bw.compile.projlib.skip.touch.
waitForRunningInstances Boolean - Whether to wait for instances to be started or not.
The waiting process is performed with Hawk methods subscriptions.

NB: it is mandatory to configure Hawk properly.
Default value is: false.
User property is: waitForRunningInstances.

Parameter Details

buildLibDirectory:

Path to the dependencies (Projlibs, JARs...) for the build. Default is "target/lib"
  • Type: java.io.File
  • Required: Yes
  • User Property: project.build.directory.lib
  • Default: ${project.build.directory}/lib

buildSrcDirectory:

Path to the BusinessWorks sources for the build. Default is "target/src"
  • Type: java.io.File
  • Required: Yes
  • User Property: project.build.directory.src
  • Default: ${project.build.directory}/src

classifier:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: project.build.classifier

contact:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: deploy.contact

dependenciesIgnored:

List of "groupId:artifactId" to ignore when building
  • Type: java.util.ArrayList
  • Required: No

deployedProjectName:

Name of the project once deployed in TIBCO domain
  • Type: java.lang.String
  • Required: Yes
  • User Property: deploy.project.name

deploymentDescriptor:

(no description)
  • Type: java.io.File
  • Required: No
  • User Property: deploy.descriptor
  • Default: ${project.package.directory}/${project.build.finalName}.xml

deploymentDescriptorFinal:

(no description)
  • Type: java.io.File
  • Required: No
  • User Property: deploy.descriptor.final
  • Default: ${project.package.directory}/${project.build.finalName}-final.xml

deploymentGlobalVariables:

(no description)
  • Type: java.io.File
  • Required: No
  • User Property: deploy.properties.globalVariables
  • Default: ${project.package.directory}/${project.build.finalName}.gv.properties

deploymentGlobalVariablesCommon:

(no description)
  • Type: java.io.File
  • Required: No
  • User Property: deploy.properties.globalVariables.common
  • Default: ${project.package.directory}/${project.artifactId}.gv.properties

deploymentGlobalVariablesReference:

(no description)
  • Type: java.io.File
  • Required: No
  • User Property: deploy.properties.globalVariables.reference
  • Default: ${project.package.directory}/${project.artifactId}.gv.properties

deploymentServices:

(no description)
  • Type: java.io.File
  • Required: No
  • User Property: deploy.properties.services
  • Default: ${project.package.directory}/${project.build.finalName}.services.properties

deploymentServicesCommon:

(no description)
  • Type: java.io.File
  • Required: No
  • User Property: deploy.properties.services.common
  • Default: ${project.package.directory}/${project.artifactId}.services.properties

deploymentServicesReference:

(no description)
  • Type: java.io.File
  • Required: No
  • User Property: deploy.properties.services.reference
  • Default: ${project.package.directory}/${project.artifactId}.services.properties

description:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: deploy.description

domainName:

TIBCO domain name
  • Type: java.lang.String
  • Required: Yes
  • User Property: tibco.domain.name

domainPassword:

TIBCO domain password
  • Type: java.lang.String
  • Required: Yes
  • User Property: tibco.domain.password

domainUsername:

TIBCO domain username
  • Type: java.lang.String
  • Required: Yes
  • User Property: tibco.domain.username

events:

(no description)
  • Type: fr.fastconnect.factory.tibco.bw.maven.packaging.Events
  • Required: No
  • User Property: events

failWhenTimeoutReached:

Whether to fail the Maven build when timeout is reached or not.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: failWhenTimeoutReached
  • Default: false

filterProperties:

(no description)
  • Type: boolean
  • Required: No
  • User Property: deploy.properties.filterProperties
  • Default: false

finalName:

Name of the generated artifact (without file extension).
  • Type: java.lang.String
  • Required: Yes
  • User Property: project.build.finalName

hawkDomain:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: hawk.domain
  • Default: ${tibco.domain.name}

hawkRvDaemon:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: hawk.rv.daemon
  • Default: tcp:7474

hawkRvNetwork:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: hawk.rv.network
  • Default: ;

hawkRvService:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: hawk.rv.service
  • Default: 7474

hawkSubscribeInterval:

(no description)
  • Type: java.lang.Integer
  • Required: No
  • User Property: hawk.subscribe.interval
  • Default: 10

hawkSubscribeNumberOfRetry:

(no description)
  • Type: java.lang.Integer
  • Required: No
  • User Property: hawk.subscribe.retry.count
  • Default: 30

hawkVersion:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: tibco.hawk.version

hideLibraryResources:

Allows to ignore any alias when building EAR or Projlib. This will mimic the "Hide Library Resources" behaviour of the TIBCO Designer.
  • Type: boolean
  • Required: No
  • User Property: bw.hide.library.resources

ignoreCommonFiles:

(no description)
  • Type: boolean
  • Required: No
  • User Property: ignoreCommonFiles
  • Default: false

ignoreReferenceFiles:

(no description)
  • Type: boolean
  • Required: No
  • User Property: ignoreReferenceFiles
  • Default: false

maxDeploymentRevision:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: deploy.maxDeploymentRevision
  • Default: -1

numberOfRunningStatuses:

(no description)
  • Type: int
  • Required: No
  • User Property: bw.start.running.statuses.number
  • Default: 3

outputDirectory:

Directory containing the generated artifact.
  • Type: java.io.File
  • Required: Yes
  • User Property: project.build.outputDirectory

packageDirectory:

Path to the package folder. Default is "target/package"
  • Type: java.io.File
  • Required: Yes
  • User Property: project.package.directory
  • Default: ${project.build.directory}/package

projectDirectory:

Path to the BusinessWorks project.
  • Type: java.io.File
  • Required: No
  • User Property: bw.project.location

repoHttpExtraPropertyFile:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: repoHttpExtraPropertyFile

repoHttpPassword:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: repoHttpPassword

repoHttpServer:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: repoHttpServer

repoHttpTimeout:

(no description)
  • Type: java.lang.Integer
  • Required: No
  • User Property: repoHttpTimeout
  • Default: 600

repoHttpUrl:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: repoHttpUrl

repoHttpUser:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: repoHttpUser

repoLocalEncoding:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: repoLocalEncoding
  • Default: UTF-8

repoRvDaemon:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: repoRvDaemon
  • Default: tcp:7500

repoRvDiscoveryTimeout:

(no description)
  • Type: java.lang.Integer
  • Required: No
  • User Property: repoRvDiscoveryTimeout
  • Default: 10

repoRvExtraPropertyFile:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: repoRvExtraPropertyFile

repoRvNetwork:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: repoRvNetwork

repoRvOperationRetry:

(no description)
  • Type: java.lang.Integer
  • Required: No
  • User Property: repoRvOperationRetry
  • Default: 0

repoRvPassword:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: repoRvPassword

repoRvRegionalSubject:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: repoRvRegionalSubject

repoRvServer:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: repoRvServer

repoRvService:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: repoRvService
  • Default: 7500

repoRvTimeout:

(no description)
  • Type: java.lang.Integer
  • Required: No
  • User Property: repoRvTimeout
  • Default: 600

repoRvUser:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: repoRvUser

repoSelectInstance:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: repoSelectInstance
  • Default: local

skipCompile:

Whether to skip the compilation of EAR and Projlib.

NB: shall be used with 'bw.package.skip', 'maven.install.skip' and 'maven.deploy.skip' set to true.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: bw.compile.skip
  • Default: false

skipEARCompile:

Whether to skip the compilation of EAR.

NB: shall be used with 'bw.package.skip', 'maven.install.skip' and 'maven.deploy.skip' set to true.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: bw.compile.ear.skip
  • Default: false

skipPackage:

Whether to skip the package goals. NB: shall be used with 'maven.install.skip' and 'maven.deploy.skip' set to true.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: bw.package.skip
  • Default: false

skipProjlibCompile:

Whether to skip the compilation of Projlib.

NB: shall be used with 'bw.package.skip', 'maven.install.skip' and 'maven.deploy.skip' set to true
  • Type: java.lang.Boolean
  • Required: No
  • User Property: bw.compile.projlib.skip
  • Default: false

testDirectory:

Path to the test folder. Default is "target/test"
  • Type: java.io.File
  • Required: Yes
  • User Property: project.build.test.directory
  • Default: ${project.build.directory}/test

testLibDirectory:

Path to the dependencies (Projlibs, JARs...) for the test. Default is "target/test/lib"
  • Type: java.io.File
  • Required: Yes
  • User Property: project.build.test.directory.lib
  • Default: ${project.build.test.directory}/lib

testSrcDirectory:

Path to the BusinessWorks sources for the test. Default is "target/test/src"
  • Type: java.io.File
  • Required: Yes
  • User Property: project.build.test.directory.src
  • Default: ${project.build.test.directory}/src

tibcoAppManagePath:

Path to the TIBCO "AppManage" binary.
  • Type: java.io.File
  • Required: No
  • User Property: appmanage.path

tibcoAppManageTRAPath:

Path to the TIBCO "AppManage" TRA configuration file.
  • Type: java.io.File
  • Required: No
  • User Property: appmanage.tra.path

tibcoBWEngineTRAPath:

Path to the BusinessWorks Engine TRA configuration file.
  • Type: java.io.File
  • Required: Yes
  • User Property: bwengine.tra.path

tibcoBuildEARTRAPath:

Path to the TIBCO "buildear" TRA configuration file.
  • Type: java.io.File
  • Required: No
  • User Property: buildear.tra.path

tibcoBuildEARUseDesignerTRA:

Sometimes a TRA can reference another TRA, for instance 'buildear.tra' will reference 'designer.tra'. This field specifies whether we will use the default referenced TRA or override with a provided TRA.
  • Type: boolean
  • Required: No
  • User Property: tra.buildear.uses.designer.tra.path

tibcoBuildLibraryTRAPath:

Path to the TIBCO Designer "buildlibrary" TRA configuration file.
  • Type: java.io.File
  • Required: No
  • User Property: buildlibrary.tra.path

tibcoBuildLibraryUseDesignerTRA:

Sometimes a TRA can reference another TRA, for instance 'buildlibrary.tra' will reference 'designer.tra'. This field specifies whether we will use the default referenced TRA or override with a provided TRA.
  • Type: boolean
  • Required: No
  • User Property: tra.buildlibrary.uses.designer.tra.path

tibcoDesignerPath:

Path to the TIBCO Designer binary.
  • Type: java.io.File
  • Required: No
  • User Property: designer.path

tibcoDesignerTRAPath:

Path to the TIBCO Designer TRA configuration file.
  • Type: java.io.File
  • Required: No
  • User Property: designer.tra.path

tibcoHome:

Path to the TIBCO home directory.
  • Type: java.io.File
  • Required: No
  • User Property: tibco.home

tibcoRvHomePath:

Path to the TIBCO RendezVous folder.
  • Type: java.io.File
  • Required: No
  • User Property: tibrv.home.path

timeOut:

Timeout for the execution of TIBCO commands to build artifacts. This time is given in seconds.
  • Type: int
  • Required: No
  • User Property: timeOut
  • Default: 180

touchEARIfSkipped:

Whether to "touch" the EAR file when EAR compilation is skipped.

NB: must be used with 'bw.compile.skip' or 'bw.compile.ear.skip' set to true.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: bw.compile.ear.skip.touch
  • Default: false

touchFinalDeploymentDescriptorIfSkipped:

Whether to "touch" the final deployment descriptor file when final deployment descriptor generation is skipped.

NB: must be used with 'bw.package.skip' set to true.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: bw.package.skip.deploy.descriptor.final.touch
  • Default: false

touchProjlibIfSkipped:

Whether to "touch" the Projlib file when Projlib compilation is skipped.

NB: must be used with 'bw.compile.skip' or 'bw.compile.projlib.skip' set to true.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: bw.compile.projlib.skip.touch
  • Default: false

waitForRunningInstances:

Whether to wait for instances to be started or not.
The waiting process is performed with Hawk methods subscriptions.

NB: it is mandatory to configure Hawk properly.
  • Type: java.lang.Boolean
  • Required: No
  • User Property: waitForRunningInstances
  • Default: false

Back to top

Copyright ©2011-2016 FastConnect SAS. All Rights Reserved.

Version: 2.4.1. Last Published: 2016-01-22.