Tools and options > Tools in tools directory > Check the collaboration and action trees

Check the collaboration and action trees

A command-line tool is provided to detect corrupted action or collaboration tree. The treeScan tool is in the tools directory.

Usage

The tool has the following usage. All options can be specified by a full name (for example, iterations) or an abbreviation (for example, i). Also, the treeScan command must be entered on a single command line.

treeScan

[-license|-l <license_file>]

[-iterations|-i <iteration_count>]

[-sleep|-s <sleep_time>]

[-emailTo|-et <address>]...

[-emailLevel|-el error|warn|info|all]

[-minCommunities|-mc <integer>]

[-minExchanges|-me <integer>]

Where:

license_file is the name of the license file corresponding to the database configured in ../conf/datastoreconfig.xml. The default license file is in ../conf/license.xml.
iteration_count is the number of scan cycles, with each of the two trees being scanned once per cycle. The default number of iterations is 1. A value of 0 (zero) indicates an infinite number of iterations; the tool should scan forever until terminated by the user.
sleep_time is the number of seconds to wait between scan cycles. The default value is 30 seconds.
address is a valid email address for sending the results of a scan. Multiple -emailTo options can be given to specify multiple email recipients. A message is sent only when a scan's results are different from the last successfully emailed scan results. See the next bullet for more criteria on emailing scan results. The tool sends messages via the global external SMTP server as set in the instance of Activator whose trees are being scanned (see Configure the global external SMTP server).
error|warn|info|all indicates the minimum level of notification in the scan that is required to send an email message.
- error, which is the default, indicates at least one error must be reported in a scan for the scan's results to be emailed to the specified recipients.
- warn indicates the results of a scan containing any warnings or errors that are potentially emailed.
- info indicates the results of a scan containing any warnings, errors or infos that are potentially emailed.
- all indicates all scan results that are potentially emailed.
integer is a non-negative integer indicating the minimum number of distinct trading communities or distinct exchanges that must be referenced by the action and collaboration trees. The only types of exchanges that are referenced by the trees are application pickup and community pickup exchanges.

Functionality

The tool checks for the following peculiarities in the action and collaboration trees:

Bad number of root nodes (nodes with NULL parent) in action or collaboration tree. Each tree must have exactly one root node.
Bad root node name in the action or collaboration tree.
Missing required nodes in the action or collaboration tree. Required nodes are determined by the licensed product and features indicated in the license file.
Missing or unexpected selection criteria in an action or collaboration tree node.
Missing or unexpected action in an action tree node.
No community nodes in the action or collaboration tree.
A change in the number of community nodes in the action and collaboration trees from the previous scan.
No exchange point nodes in the action or collaboration tree.
A change of the number of exchange point nodes in the action tree from the previous scan.
Missing community node in the action or collaboration tree. All nodes in the action and collaboration trees with children corresponding to local parties are scanned for local party nodes. A set of all found local parties is constructed to verify whether all action and collaboration tree nodes that are supposed to have children corresponding to local parties do have children for all the found local parties.
Missing required building block in a collaboration tree node. All required building blocks are checked for type (for example, ReliableMessaging, BusinessProtocol, TransportRetryCount) but not necessarily values. All BusinessProtocol building blocks are checked for the required business protocol types (for example, AS1, AS2, email and RosettaNet). Required business protocol types are determined by the licensed message protocol features indicated in the license file.
Found peculiarities are logged at an info, warn or error level, depending on severity. Log messages are routed to standard output and to the treeScan.log file in the logs directory. Also, at the end of each scan a summary of the number of each level of peculiarity is logged.