bizappscli tool

You can use the CLI bizappscli tool to manage grouping patterns, grouping pattern processing schedules, grouping pattern configurations and the execution of grouping patterns.
Fix Pack 2You can use the tool to create reports for analyzing the content of business applications.
Fix Pack 3You can use the tool to export the graph of the business application topology to the SVG format.

The script is in the <taddm installation directory>/dist/sdk/bin directory. Depending on the operating system, the following formats of the script are available:
  • For Linux, AIX, and Linux on System z - bizappscli.sh.
  • For Windows - bizappscli.bat.
Note: In the bizappscli tool section, bizappscli.sh format is used in all examples. If you work on Windows operating system, remember to use bizappscli.bat format.
Fix Pack 3Important: To use the bizappscli tool, you must have the Update permission granted for the DefaultAccessCollection.
To run the bizappscli tool, you must specify an action and options. The following options apply to all actions:
  • -H, --hostname <arg> - defines the host name. The default value is 0.0.0.0. If you use the -T parameter, you must also specify the -H parameter.
  • -P, --port <arg> - defines the port. The default value is 9433.
  • -p, --password <arg> - defines the password of the TADDM user.
  • -T, --truststore <arg> - defines the location of the truststore file, jssecacerts.cert, with a certificate for connection to the TADDM server. This parameter is required for secure connection to TADDM. If you use this parameter, you must also specify the -H parameter.
  • -u, --user <arg> - defines the TADDM user name.
Note: When the values of the options contain spaces, you must enclose the values in double quotation marks, for example "my grouping pattern". Otherwise, the tool interprets a word after the first space as the name of the action, and an error is generated.
To see all available actions, run the script without any arguments. To see a description of an action, use the following script:
bizappscli.sh help -a <action>
For example, bizappscli.sh help -a listPatterns.

You can use the bizappscli.sh tool to control the processing of grouping patterns. Multiple patterns can be processed on a single storage server, which by default is primary storage server, and also on multiple storage servers.

Execution groups
The patterns are processed inside a thread pool called ExecutionGroup. Each storage server can devote threads to a particular execution group, which becomes a part of multiple servers thread pool, which then processes patterns. The size of the thread pool defines how many patterns can be run in parallel. Each pattern can be processed by five threads at the same time, which is controlled by the ExecutionGroup mechanism.
If at a given time there are more grouping patterns that require processing than the capacity of the execution group allows for, the outstanding patterns are run at the nearest possible time after one of the threads of the execution group becomes available. A new execution group is created when there is at least one schedule that refers to the execution group name. However, when the execution group is created, it must be enabled on each storage server that is to be a part of that execution group, and the thread pool size needs to be configured separately on each storage server.
By default, there is one execution group available, called default. The group is configured to have only one thread running only on the primary storage server (it does not need to be enabled on the primary server). Other execution groups can be created to make sure that the higher priority patterns always have available threads. All patterns that run inside execution groups have the same priority, and therefore one pattern can block the processing of another if no idle threads are available within the group. The creation of another execution group constitutes the creation of another thread pool.
You can enable the processing of the execution groups on secondary storage servers in addition to the primary storage server. On each secondary storage server, set the following property in the collation.properties file to true:
com.ibm.cdb.internalscheduling.bizapps.<GROUP NAME>.enabled=true
<GROUP NAME> is the name of the group that you want to enable. For example, to enable the default group, set the following property:
com.ibm.cdb.internalscheduling.bizapps.default.enabled=true
Execution schedules
Patterns are run according to their schedule. Each pattern must be associated with a schedule during the creation. A schedule object contains information about when, or how often, the pattern is processed, and what execution group is used for that processing. By default, only one schedule called default is created, with a default interval set to every 4 hours. This default schedule is associated with the default execution group.
If you migrated business applications from TADDM 7.2.2, the default interval is the same as the value of the com.ibm.cdb.topobuilder.groupinterval.bizapps property. You can check the value of this property in the collation.properties file.
Schedules can be based either on intervals or on the cron expression.
Interval
An interval-based schedule triggers the pattern processing periodically with defined intervals. The first processing is triggered after the first interval time passes after the TADDM server is started.
Cron
A cron-based schedule can be created by specifying the cron expression, which allows for more complex schedules, such as 'every Thursday at 18:00'.
For more information about intervals, and cron expressions, see Actions for managing grouping pattern schedules.
Single pattern manual testing
You can test a single pattern manually outside of the defined schedule.
A manual run always triggers a run in the execution group according to the defined schedule. As execution group threads might be spread across multiple servers, the thread that is used for processing might be on a server other than the one used for starting the processing.
The manual run does not change the defined schedule that is associated with the pattern. However, as any pattern can be processed only once at the same time, if a pattern is running because it was triggered by a defined schedule, the manual run fails. When pattern processing was interrupted, the next processing is started according to the defined schedule.
When a pattern is run manually, and an automatic run is scheduled at the same time, the scheduled run is run as soon as possible. It means that the scheduled run is run when the manual run finishes and there is a free thread available in the associated execution group.

Configuring bizappscli tool properties

com.ibm.taddm.bizappscli.jvmArgs=-Xmx1024M
This property defines JVM options for the bizappscli tool usage. If there is not enough memory to run the tool, you can increase the maximum heap size of JVM processes by modifying the value of this property in the $COLLATION_HOME/sdk/etc/collation.properties file. For example, exporting business application topologies to the SVG format might require more memory than defined in the default settings.
Set the value in the following format: -Xmx1024M. In this example, the maximum heap size is 1024 MB (1 GB).