Running BW Design Utility Goal

Introduction

"bwdesignUtility" maven goal provides a command line interface to validate BW project and generate the process diagram for the same. This wiki page has steps to run the "bwdesignUtility" goal.

Prerequisites

• Apche Maven: https://maven.apache.org/download.cgi>
• BusinessWorks Installer BW 6.6.1 /BWCE 2.5.3
• BusinessWorks Maven Plugin 2.7.0 – https://github.com/TIBCOSoftware/bw6-plugin-maven/releases

All Prerequisites should be installed on the same machine.

Note : From 2.7.1 onwards, the plugin also imports the projects into the workspace.

Running "bwdesignUtility" goal

This section assumes that the user already has BW Unit Test Project with POM generated includes valid Tibco Home and BW Home

1. Navigate to BW unit test parent project workspace and open the command prompt or Git Bash

Validate BW project

2.To validate BW project run the "bwdesignUtility" goal by passing the "commandName" argument with value "validate" in a following way:
mvn com.tibco.plugins:bw6-maven-plugin:bwdesignUtility -DcommandName=validate
This will validate the BW project

Microsoft Windows [Version 10.0.18362.657]
(c) 2019 Microsoft Corporation. All rights reserved.

C:\Users\sdarekar\workspace\BW6.6.1V15\UnitTestDemoProject.application.parent>mvn com.tibco.plugins:bw6-maven-plugin:bwdesignUtility -DcommandName=validate
[INFO] Scanning for projects...
[INFO] Starting Maven Build for BW6 Project.................................
[INFO] Checking for In-Project JAR dependencies if any and Pushing them to Local Maven Repository
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Build Order:
[INFO]
[INFO] UnitTestDemoProject.application.parent                             [pom]
[INFO] UnitTestDemoProject                                           [bwmodule]
[INFO] UnitTestDemoProject.application                                  [bwear]
[INFO]
[INFO] --------< com.tibco.bw:UnitTestDemoProject.application.parent >---------
[INFO] Building UnitTestDemoProject.application.parent 1.0.0-SNAPSHOT     [1/3]
[INFO] --------------------------------[ pom ]---------------------------------
[INFO]
[INFO] --- bw6-maven-plugin:2.6.0:bwdesignUtility (default-cli) @ UnitTestDemoProject.application.parent ---
[INFO]
[INFO] ------------------< com.tibco.bw:UnitTestDemoProject >------------------
[INFO] Building UnitTestDemoProject 1.0.0-SNAPSHOT                        [2/3]
[INFO] ------------------------------[ bwmodule ]------------------------------
[INFO]
[INFO] --- bw6-maven-plugin:2.6.0:bwdesignUtility (default-cli) @ UnitTestDemoProject ---
[INFO]
[INFO] ------------< com.tibco.bw:UnitTestDemoProject.application >------------
[INFO] Building UnitTestDemoProject.application 1.0.0-SNAPSHOT            [3/3]
[INFO] -------------------------------[ bwear ]--------------------------------
[INFO]
[INFO] --- bw6-maven-plugin:2.6.0:bwdesignUtility (default-cli) @ UnitTestDemoProject.application ---
[info] ---------------------Validating BW Project-----------------------
org.eclipse.m2e.logback.configuration: The org.eclipse.m2e.logback.configuration bundle was activated before the state location was initialized.  Will retry after the state location is initialized.
org.eclipse.m2e.logback.configuration: Logback config file: C:\Users\sdarekar\workspace\BW6.6.1V15\.metadata\.plugins\org.eclipse.m2e.logback.configuration\logback.1.6.2.20151013-0836.xml
TIBCO ActiveMatrix BusinessWorks version 6.6.1 V15 2020-04-07, build V15, 2020-04-07
Workspace [C:\Users\sdarekar\workspace\BW6.6.1V15]

BusinessWorks Design Time Console

Type 'help' or 'help -a|-all' for the list of available commands
and 'help command' for help on any specific command.
Enter 'exit' to exit the shell.

bwdesign>


[INFO]Validation started for the module [UnitTestDemoProject]
[INFO]No validation errors found for the module [UnitTestDemoProject]
[INFO]Validation started for the module [UnitTestDemoProject.application]
[INFO]No validation errors found for the module [UnitTestDemoProject.application]
[INFO]Validation started for the module [UnitTestDemoProject.application.parent]
[ERROR]Unable to load bundle for the BW module [UnitTestDemoProject.application.parent]. Check if it exists.
[INFO]Found 0 errors and 0 warnings in module [UnitTestDemoProject.application.parent]
[INFO]Found 0 errors and 0 warnings in module [UnitTestDemoProject.application]
[INFO]Found 0 errors and 0 warnings in module [UnitTestDemoProject]

bwdesign>
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary for UnitTestDemoProject.application.parent 1.0.0-SNAPSHOT:
[INFO]
[INFO] UnitTestDemoProject.application.parent ............. SUCCESS [  0.332 s]
[INFO] UnitTestDemoProject ................................ SUCCESS [  0.572 s]
[INFO] UnitTestDemoProject.application .................... SUCCESS [ 27.366 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  30.440 s
[INFO] Finished at: 2020-04-22T16:20:11+05:30
[INFO] ------------------------------------------------------------------------

Generate Process Diagram

3. To generate the process diagram for the project enter "bwdesignUtility" goal by passing the commandName argument with value "gen_diagrams" in the following way:
mvn com.tibco.plugins:bw6-maven-plugin:bwdesignUtility -DcommandName=gen_diagrams
This will generate a process diagram in "resources" folder of BW application project.

C:\Users\sdarekar\workspace\BW6.6.1V15\UnitTestDemoProject.application.parent>mvn com.tibco.plugins:bw6-maven-plugin:bwdesignUtility -DcommandName=gen_diagrams
[INFO] Scanning for projects...
[INFO] Starting Maven Build for BW6 Project.................................
[INFO] Checking for In-Project JAR dependencies if any and Pushing them to Local Maven Repository
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Build Order:
[INFO]
[INFO] UnitTestDemoProject.application.parent                             [pom]
[INFO] UnitTestDemoProject                                           [bwmodule]
[INFO] UnitTestDemoProject.application                                  [bwear]
[INFO]
[INFO] --------< com.tibco.bw:UnitTestDemoProject.application.parent >---------
[INFO] Building UnitTestDemoProject.application.parent 1.0.0-SNAPSHOT     [1/3]
[INFO] --------------------------------[ pom ]---------------------------------
[INFO]
[INFO] --- bw6-maven-plugin:2.6.0:bwdesignUtility (default-cli) @ UnitTestDemoProject.application.parent ---
[INFO]
[INFO] ------------------< com.tibco.bw:UnitTestDemoProject >------------------
[INFO] Building UnitTestDemoProject 1.0.0-SNAPSHOT                        [2/3]
[INFO] ------------------------------[ bwmodule ]------------------------------
[INFO]
[INFO] --- bw6-maven-plugin:2.6.0:bwdesignUtility (default-cli) @ UnitTestDemoProject ---
[INFO]
[INFO] ------------< com.tibco.bw:UnitTestDemoProject.application >------------
[INFO] Building UnitTestDemoProject.application 1.0.0-SNAPSHOT            [3/3]
[INFO] -------------------------------[ bwear ]--------------------------------
[INFO]
[INFO] --- bw6-maven-plugin:2.6.0:bwdesignUtility (default-cli) @ UnitTestDemoProject.application ---
[info] ---------------------Generating Process diagram-----------------------
org.eclipse.m2e.logback.configuration: The org.eclipse.m2e.logback.configuration bundle was activated before the state location was initialized.  Will retry after the state location is initialized.
org.eclipse.m2e.logback.configuration: Logback config file: C:\Users\sdarekar\workspace\BW6.6.1V15\.metadata\.plugins\org.eclipse.m2e.logback.configuration\logback.1.6.2.20151013-0836.xml
TIBCO ActiveMatrix BusinessWorks version 6.6.1 V15 2020-04-07, build V15, 2020-04-07
Workspace [C:\Users\sdarekar\workspace\BW6.6.1V15]

BusinessWorks Design Time Console

Type 'help' or 'help -a|-all' for the list of available commands
and 'help command' for help on any specific command.
Enter 'exit' to exit the shell.

bwdesign>
bwdesign>
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary for UnitTestDemoProject.application.parent 1.0.0-SNAPSHOT:
[INFO]
[INFO] UnitTestDemoProject.application.parent ............. SUCCESS [  0.380 s]
[INFO] UnitTestDemoProject ................................ SUCCESS [  0.503 s]
[INFO] UnitTestDemoProject.application .................... SUCCESS [ 27.972 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  30.861 s
[INFO] Finished at: 2020-04-22T16:43:26+05:30
[INFO] ------------------------------------------------------------------------

Generate Manifest JSON

4. To generate Manifest JSON from the project whose Deployment Target is TibcoCloud enter "bwdesignUtility" goal by passing the commandName argument with value "generate_manifest_json" in the following way:
mvn com.tibco.plugins:bw6-maven-plugin:bwdesignUtility -DcommandName=generate_manifest_json
This will generate Manifest JSON file in BW application project.

This goal will be available from version 2.8.1 onwards

5. To validate BW project, To generate generate process diagram and the Manifest JSON for BW project sequentially, run the "bwdesignUtility" command without passing an argument "commandName"

mvn com.tibco.plugins:bw6-maven-plugin:bwdesignUtility