TADataCollector command

If you are transforming your architecture to adopt containers, use the TADataCollector command to analyze data from backup files of your IBM® Integration Bus 10.0, IBM App Connect Enterprise 11.0, or IBM App Connect Enterprise 13.0 integration node or deployable BAR file.

Supported platforms

Windows
Linux®

Purpose

You can use the TADataCollector command to collect and assess data about what was deployed to your IBM Integration Bus 10.0, IBM App Connect Enterprise 11.0, or IBM App Connect Enterprise 13.0 integration node, or the contents of a deployable BAR file. You can also use the command to generate reports about potential issues if you plan to transform your architecture to adopt containers.

Usage notes

Before you run the TADataCollector command, you can optionally create a collector directory to write the logs from the command, and set the value of the environment variable TADATACOLLECTORDIRECTORY to the name of the collector directory. If you do not create a collector directory, the logs are written to a temporary subdirectory in the home directory of the user who runs the command. For more information, see Running the Transformation Advisor tool.

Syntax

Parameters

MIDDLEWARE

You must specify a value for MIDDLEWARE, which is the name of the application for which you want to collect and assess data. The value that you need to specify for IBM App Connect Enterprise is ace.

COMMAND

You must specify either the name of the command that you want to run against the middleware or specify help. Valid values for the command are collect, assess, run, and report.

collect Collects data. .
assess Collects and assesses data.
run Collects and assesses data, and generates reports.
report Generates reports about data that was collected and assessed by using the --collect and --assess commands. This command does not require any parameters.
help Outputs advice about how to use the TADataCollector command when only the MIDDLEWARE parameter is specified.

The commands collect, assess, and run, require the parameter Fully_Qualified_Path_To_Backup_Zip_Or_Bar and can take the optional parameters --server, --source-platform, --source-platform-ccsid, and --target. The commands report and help do not take any parameters.

OPTIONS

--server SERVER_NAME

Extract a specific server. For use with backups only.

--source-platform platform-type

The platform type where the backup was taken. This parameter is optional and typically needs to be specified only if the auto-detection fails. Valid values are:

WinX64
LinuxX64
AIXPPC64
Linuxz64
zOS
Linuxz64
LinuxPPCLE64
SolarisSparc64
SolarisX64
HPUXIA64
MacOSX

You can use the parameters --source-platform and --source-platform-ccsid individually, or together when you run the command.

--source-platform-ccsid CCSID

Optionally use this parameter to specify the default CCSID of the platform where the backup was taken. This parameter is required only if the auto-detection fails. (For use with backups only).

You can use the parameters --source-platform and --source-platform-ccsid individually, or together when you run the command.

--target TARGET

Optionally, you can use the --target parameter to specify the target of the analysis to be run by the Transformation Advisor tool. As a result of setting this parameter, the advice that is given by the Transformation Advisor tool is focused on the specified target, which can be one of the items in the following list. (The default is "ACE Containers").

"ACE Containers"
"ACEv11 Software"
"ACEv12 Software"

Fully_Qualified_Path_To_Backup_Zip_Or_Bar

The fully qualified path name of the IBM Integration Bus 10.0, IBM App Connect Enterprise 11.0, or IBM App Connect Enterprise 13.0 backup file, or the deployable BAR file for which you want to collect and assess data. This parameter is required if you select collect, assess, or run as the COMMAND option. This parameter is not required if you select report as the COMMAND option.

--help

Outputs advice about how to use the TADataCollector command when the MIDDLEWARE parameter is specified, and you select collect, assess, run, or report as the COMMAND parameter.

Examples

In most of the following examples, the environment variable TADATACOLLECTORDIRECTORY is set to C:\TADemo. For more information about the environment variable TADATACOLLECTORDIRECTORY, see Running the Transformation Advisor tool.

The parameters for this example are set as follows:

MIDDLEWARE is set to ace
COMMAND is set to collect
The fully qualified path is set to the location of an IBM App Connect Enterprise 11.0 backup file, C:\temp\node11.zip.

TADataCollector ace collect C:\temp\node11.zip

All output will be saved to the C:\TADemo directory.
Command 'run' completed successfully.

The parameters for this example are set as follows:

MIDDLEWARE is set to ace
COMMAND is set to assess
--server is set to myServer
The fully qualified path is set to the location of an IBM App Connect Enterprise 11.0 backup file, C:\temp\node11.zip.

TADataCollector ace assess --server myServer C:\temp\node11.zip

All output will be saved to the C:\TADemo directory.
Command 'assess' completed successfully.

The parameters for this example are set as follows:

MIDDLEWARE is set to ace
COMMAND is set to run
--source-platform is set to WinX64
The fully qualified path is set to the location of an IBM App Connect Enterprise 11.0 backup file, C:\temp\node11.zip.

TADataCollector ace run --source-platform-type WinX64 C:\temp\node11.zip

All output will be saved to the C:\TADemo directory.
Command 'run' completed successfully.

The parameters for this example are set as follows:

MIDDLEWARE is set to ace
COMMAND is set to run
--source-platform is set to WinX64
--target is set to "ACEv11 Software"
The fully qualified path is set to the location of an IBM App Connect Enterprise 11.0 backup file, C:\temp\node11.zip.

TADataCollector ace run --source-platform-type WinX64 --target "ACEv11 Software" C:\temp\node11.zip

All output will be saved to the C:\TADemo directory.
Command 'run' completed successfully.

The parameters for this example are set as follows (no other parameters are required when COMMAND is set to report):

MIDDLEWARE is set to ace
COMMAND is set to report

TADataCollector ace report

All output will be saved to the C:\TADemo directory.
Command 'report' completed successfully.

The following example shows the output when help and no other parameters are specified, and the environment variable TADATACOLLECTORDIRECTORY is not set:

TADataCollector help

TADataCollectorDirectory environment variable not set, defaulting to C:\Users\000117~1\AppData\Local\Temp\TADataCollector
All output will be saved to the C:\Users\000117~1\AppData\Local\Temp\TADataCollector directory.
Usage: TADataCollector MIDDLEWARE COMMAND [OPTIONS]

Middleware:
  Plug-ins available for these middleware [ ace ]

Commands:
  help      Get information on the commands and options available for a middleware

The following example shows the output when MIDDLEWARE is set to ace, help is specified, no other parameters are set, and the environment variable TADATACOLLECTORDIRECTORY is not set:

TADataCollector ace help

TADataCollectorDirectory environment variable not set, defaulting to C:\Users\000117~1\AppData\Local\Temp\TADataCollector
All output will be saved to the C:\Users\000117~1\AppData\Local\Temp\TADataCollector directory.

Usage: TADataCollector ace COMMAND [OPTIONS]

Commands:
  collect        Performs data collection
  assess         Performs data collection and assessment
  report         Generates reports
  run            Performs data collection, assessment, and generate reports


Run 'TADataCollector MIDDLEWARE COMMAND --help' for more information on a command.