Data capture utility

This topic describes what is data utility, the circumstances in which you would use it, and the prerequisites for running the wa_pull_info utility.

What is it?

The data capture utility is a script named wa_pull_info which extracts information about a product instance of HCL Workload Automation.

The data capture utility script is located in the following path: TWA_home/TWS/bin.

The script can be run from the UNIX or DOS prompt on the master domain manager, the backup master domain manager, or agents. This utility is not supported on IBM i operating systems.

When to run?

Use the data capture utility in these circumstances:
  • An HCL Workload Automation process has failed, but the automatic ffdc facility has not detected the failure and run the script for you (see First failure data capture (ffdc))
  • HCL Workload Automation is very slow or is behaving in any other abnormal way
  • You are requested to do so by IBM® Software Support

Using the utility when you need to switch to the backup master domain manager

If the master domain manager fails you might decide that you want to switch to the backup master domain manager to keep your scheduling activities running. If you also want to run the data capture utility you have two choices:
Data capture first
Run the data capture utility first to ensure that the information extracted is as fresh as possible. Then run switchmgr.
Switchmgr first
In an emergency situation, where you must continue scheduling activities, run switchmgr immediately and then run the data capture utility on both the new master domain manager and the new backup master domain manager as soon as switchmgr has completed.

Prerequisites

Where the utility can be run
The utility can be run on the master domain manager, the backup master domain manager or a standard or fault-tolerant agent.
Who can run it
The utility must be run by one of the following users:
  • Any HCL Workload Automation user
  • Root (recommended on UNIX or Linux systems)
  • Administrator (on Windows systems)
To determine the best user to run the script, make the following considerations:
Troubleshooting any type of problem
  • On UNIX operating systems, the user running the script must have read access to the /etc and /etc/TWS directories and read access to the /etc/TWS/TWSRegistry.dat file
Troubleshooting installation problems
  • On UNIX operating systems, run the script as root to ensure to gather all installation information.
Troubleshooting problems when the product is running
  • The script will only extract database object descriptions to which the user running it has EXTRACT permission in the Security file. The <TWS_User> (the user who performed the installation) normally has full access to all database objects, so this is the best user to run the script.
  • The HCL Workload Automation instance must have a Symphony file otherwise some information will not be extracted.