bw:batch-extract-xml-bw
Full name:
fr.fastconnect.factory.tibco.bw.maven:bw-maven-plugin:2.4.1:batch-extract-xml-bw
Description:
This goal performs an export of a TIBCO domain to a directory.
The result can be used by batch goals such as bw:batch-delete-bw, bw:batch-deploy-bw, bw:batch-start-bw, bw:batch-stop-bw or bw:batch-undeploy-bw.
Attributes:
- Binds by default to the lifecycle phase: prepare-package.
Required Parameters
| Name | Type | Since | Description |
|---|---|---|---|
| batchExportDeployed | boolean | - | Whether to export deployed configuration (-exportDeployed switch from AppManage). Default value is: false. User property is: deploy.batch.exportDeployed. |
| batchMax | boolean | - | Whether to perform a maximal export or not (-max switch from AppManage). Default value is: false. User property is: deploy.batch.max. |
| batchMin | boolean | - | Whether to perform a minimal export or not (-min switch from AppManage). Default value is: false. User property is: deploy.batch.min. |
| batchNoEAR | boolean | - | Whether to extract EAR or not (-noear switch from AppManage). Default value is: false. User property is: deploy.batch.noear. |
| batchTemplate | boolean | - | Whether to extract in template format or not (-template switch from AppManage). Default value is: false. User property is: deploy.batch.template. |
| 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. |
| dir | File | - | Directory to use for batch commands (-dir switch from AppManage). This directory is where the exported archives and deployment configuration files are stored or used. User property is: deploy.batch.dir. |
| 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. |
| 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. |
| 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. |
Parameter Details
Whether to export deployed configuration (-exportDeployed switch from AppManage).
- Type: boolean
- Required: Yes
- User Property: deploy.batch.exportDeployed
- Default: false
Whether to perform a maximal export or not (-max switch from AppManage).
- Type: boolean
- Required: Yes
- User Property: deploy.batch.max
- Default: false
Whether to perform a minimal export or not (-min switch from AppManage).
- Type: boolean
- Required: Yes
- User Property: deploy.batch.min
- Default: false
Whether to extract EAR or not (-noear switch from AppManage).
- Type: boolean
- Required: Yes
- User Property: deploy.batch.noear
- Default: false
Whether to extract in template format or not (-template switch from AppManage).
- Type: boolean
- Required: Yes
- User Property: deploy.batch.template
- Default: false
- Type: java.io.File
- Required: Yes
- User Property: project.build.directory.lib
- Default: ${project.build.directory}/lib
- Type: java.io.File
- Required: Yes
- User Property: project.build.directory.src
- Default: ${project.build.directory}/src
- Type: java.lang.String
- Required: No
- User Property: project.build.classifier
- Type: java.lang.String
- Required: No
- User Property: deploy.contact
- Type: java.util.ArrayList
- Required: No
- Type: java.lang.String
- Required: Yes
- User Property: deploy.project.name
- Type: java.io.File
- Required: No
- User Property: deploy.descriptor
- Default: ${project.package.directory}/${project.build.finalName}.xml
- Type: java.io.File
- Required: No
- User Property: deploy.descriptor.final
- Default: ${project.package.directory}/${project.build.finalName}-final.xml
- Type: java.io.File
- Required: No
- User Property: deploy.properties.globalVariables
- Default: ${project.package.directory}/${project.build.finalName}.gv.properties
deploymentGlobalVariablesCommon:
- Type: java.io.File
- Required: No
- User Property: deploy.properties.globalVariables.common
- Default: ${project.package.directory}/${project.artifactId}.gv.properties
deploymentGlobalVariablesReference:
- Type: java.io.File
- Required: No
- User Property: deploy.properties.globalVariables.reference
- Default: ${project.package.directory}/${project.artifactId}.gv.properties
- Type: java.io.File
- Required: No
- User Property: deploy.properties.services
- Default: ${project.package.directory}/${project.build.finalName}.services.properties
- Type: java.io.File
- Required: No
- User Property: deploy.properties.services.common
- Default: ${project.package.directory}/${project.artifactId}.services.properties
- Type: java.io.File
- Required: No
- User Property: deploy.properties.services.reference
- Default: ${project.package.directory}/${project.artifactId}.services.properties
- Type: java.lang.String
- Required: No
- User Property: deploy.description
dir:
Directory to use for batch commands (-dir switch from AppManage).
This directory is where the exported archives and deployment configuration files are stored or used.
- Type: java.io.File
- Required: Yes
- User Property: deploy.batch.dir
- Type: java.lang.String
- Required: Yes
- User Property: tibco.domain.name
- Type: java.lang.String
- Required: Yes
- User Property: tibco.domain.password
- Type: java.lang.String
- Required: Yes
- User Property: tibco.domain.username
- Type: fr.fastconnect.factory.tibco.bw.maven.packaging.Events
- Required: No
- User Property: events
- Type: boolean
- Required: No
- User Property: deploy.properties.filterProperties
- Default: false
- Type: java.lang.String
- Required: Yes
- User Property: project.build.finalName
- Type: java.lang.String
- Required: No
- User Property: hawk.domain
- Default: ${tibco.domain.name}
- Type: java.lang.String
- Required: No
- User Property: hawk.rv.daemon
- Default: tcp:7474
- Type: java.lang.String
- Required: No
- User Property: hawk.rv.network
- Default: ;
- Type: java.lang.String
- Required: No
- User Property: hawk.rv.service
- Default: 7474
- Type: java.lang.Integer
- Required: No
- User Property: hawk.subscribe.interval
- Default: 10
- Type: java.lang.Integer
- Required: No
- User Property: hawk.subscribe.retry.count
- Default: 30
- Type: java.lang.String
- Required: No
- User Property: tibco.hawk.version
- Type: boolean
- Required: No
- User Property: bw.hide.library.resources
- Type: boolean
- Required: No
- User Property: ignoreCommonFiles
- Default: false
- Type: boolean
- Required: No
- User Property: ignoreReferenceFiles
- Default: false
- Type: java.lang.String
- Required: No
- User Property: deploy.maxDeploymentRevision
- Default: -1
- Type: java.io.File
- Required: Yes
- User Property: project.build.outputDirectory
- Type: java.io.File
- Required: Yes
- User Property: project.package.directory
- Default: ${project.build.directory}/package
- Type: java.io.File
- Required: No
- User Property: bw.project.location
- Type: java.lang.String
- Required: No
- User Property: repoHttpExtraPropertyFile
- Type: java.lang.String
- Required: No
- User Property: repoHttpPassword
- Type: java.lang.String
- Required: No
- User Property: repoHttpServer
- Type: java.lang.Integer
- Required: No
- User Property: repoHttpTimeout
- Default: 600
- Type: java.lang.String
- Required: No
- User Property: repoHttpUrl
- Type: java.lang.String
- Required: No
- User Property: repoHttpUser
- Type: java.lang.String
- Required: No
- User Property: repoLocalEncoding
- Default: UTF-8
- Type: java.lang.String
- Required: No
- User Property: repoRvDaemon
- Default: tcp:7500
- Type: java.lang.Integer
- Required: No
- User Property: repoRvDiscoveryTimeout
- Default: 10
- Type: java.lang.String
- Required: No
- User Property: repoRvExtraPropertyFile
- Type: java.lang.String
- Required: No
- User Property: repoRvNetwork
- Type: java.lang.Integer
- Required: No
- User Property: repoRvOperationRetry
- Default: 0
- Type: java.lang.String
- Required: No
- User Property: repoRvPassword
- Type: java.lang.String
- Required: No
- User Property: repoRvRegionalSubject
- Type: java.lang.String
- Required: No
- User Property: repoRvServer
- Type: java.lang.String
- Required: No
- User Property: repoRvService
- Default: 7500
- Type: java.lang.Integer
- Required: No
- User Property: repoRvTimeout
- Default: 600
- Type: java.lang.String
- Required: No
- User Property: repoRvUser
- Type: java.lang.String
- Required: No
- User Property: repoSelectInstance
- Default: local
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
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
- Type: java.lang.Boolean
- Required: No
- User Property: bw.package.skip
- Default: false
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
- Type: java.io.File
- Required: Yes
- User Property: project.build.test.directory
- Default: ${project.build.directory}/test
- Type: java.io.File
- Required: Yes
- User Property: project.build.test.directory.lib
- Default: ${project.build.test.directory}/lib
- Type: java.io.File
- Required: Yes
- User Property: project.build.test.directory.src
- Default: ${project.build.test.directory}/src
- Type: java.io.File
- Required: No
- User Property: appmanage.path
- Type: java.io.File
- Required: No
- User Property: appmanage.tra.path
- Type: java.io.File
- Required: Yes
- User Property: bwengine.tra.path
- Type: java.io.File
- Required: No
- User Property: buildear.tra.path
- Type: boolean
- Required: No
- User Property: tra.buildear.uses.designer.tra.path
- Type: java.io.File
- Required: No
- User Property: buildlibrary.tra.path
tibcoBuildLibraryUseDesignerTRA:
- Type: boolean
- Required: No
- User Property: tra.buildlibrary.uses.designer.tra.path
- Type: java.io.File
- Required: No
- User Property: designer.path
- Type: java.io.File
- Required: No
- User Property: designer.tra.path
- Type: java.io.File
- Required: No
- User Property: tibco.home
- Type: java.io.File
- Required: No
- User Property: tibrv.home.path
- Type: int
- Required: No
- User Property: timeOut
- Default: 180
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:
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
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
