Tools in tools directory

The tools directory at < install directory>\tools contains many tools. The following table summarizes the tools and provides links for more information about some of them. Some of these tools are easy to use, but others are not intended for use by end users or should be used only on the advice of technical support.

If you use Windows, the names of these tools have an extension of .cmd (for example, as1Tool.cmd). If you use UNIX, whether or not the tools have an extension depends on the specific brand of UNIX or Linux OS (for example, as1Tool or as1Tool.sh). This does not apply to scripts with extension of .sql.

Depending on whether you use Windows or UNIX, some of these tools may not have been installed with the application. If a tool changes a value in the database, restart the server for the change to take effect.

Tool

Description

as1Tool

Packages, unpackages and dumps EDIINT messages. This tool is not for use by end users.

as2Tool

Packages, unpackages and dumps EDIINT messages. This tool is not for use by end users.

as3Tool

Packages, unpackages and dumps EDIINT messages. This tool is not for use by end users.

asxTool

Packages, unpackages and dumps EDIINT messages. This tool is not for use by end users.

certScan

Scans public-key certificates and reports information, warnings and errors. See Analyze certificates for errors.

certStats

Collects statistics about the certificates in the database. See Collect data about certificates.

crlPurgeHttpsClient

Removes outdated CRLs from the CRL table and file system. See Purge old CRLs.

dataMover

Migrates data from one database to another. This tool is to be used only by some Activator users under the supervision of technical support.

deallocateClob

De-allocates Character Large Object (CLOB) data types in Oracle databases. Recommended for use only by database administrators and experienced users of Oracle.

Before version 5.6, Interchange misallocated CLOB for some database tables. This could result in a database eventually running out of space. We recommend using this tool if you use a version before 5.6 or are upgrading. The tool performs a limited unit of work at each invocation. As the amount of misallocated storage can vary from one installation to another, you can run the tool repeatedly until the tool generates messages indicating there is no more unnecessary CLOB storage to remove.

Run the tool without parameters from a command line to display instructions for use.

This tool is not necessary if you are using a current version of Interchange.

derby_IJ

Enables SQL queries of a Derby database. This tool is not for use by end users.

diagnose

When performing troubleshooting, this tool can be used to compress and send log files to technical support. Technical support often requests log files when helping users. Run the tool from a command line and follow the menu prompts.

For information about how to submit log files to technical support through the user interface, see Send log files to technical support.

diff

The diff tool is similar to the Unix diff tool and the Windows comp tool. It improves upon these tools by reporting the offsets of differences even in binary files. Also, it is platform independent, and it sets exit codes to allow shell scripts or batch files to make use of the tool. Very large files are processed using Java nio buffers for efficiency. The tool provides help if you invoke it with -? .

dirTester

Tests the Java temp or other specified directory by writing an unbuffered and a buffered temp file. This tool is for use only upon advice of technical support.

ebxmlCpaSchema
tronValidator

Performs tests on the content of the ebXML CPA. The tool makes sure matching elements in each PartyInfo element of the ebXML CPA are consistent. See Tools for CPAs.

ebxmlCpaSecurity
Guard

Used for digitally signing CPAs. Its various functions all relate to signing and verifying digital signatures of a CPA. See Tools for CPAs.

ebxmlCpaValidator

Performs a schema validation on a CPA. See Tools for CPAs.

exportProfile

Exports community and partner profiles to XML files. Community profiles are exported as partner profiles. Partner profiles also can be exported as partner profiles, either singly or in a batch. Run exportProfile without parameters to display directions for using the tool. This tool is only for use with Interchange 5.4 or later.

externalConfigBackupRestore.cmd For the use of this tool, see Back up and restore a custom configuration.
extractSpecialTarFiles

The tar command has a known limitation for archive entries bigger than 8 GB in size.

Use this tool to unpack tar files created by Interchange when they have a size larger than 8GB.

Use this tool from the command line with the following syntax:

extractSpecialTarFiles <soruce_file.tar.gz> <destination_directory>

fillInMessage
Direction

For messages traded before upgrading to version 5.4 or later of Interchange, this tool adds metadata to the database regarding the direction of traded messages (inbound, outbound). Message direction displays in the search results of Message Tracker.

Use of this tool is optional if you have used versions earlier than 5.4. The tool is not needed if you did not use a version earlier than 5.4.

Run this tool only when the server is not running. If the database contains thousands of records, it may take hours for the tool to run. If you start the tool and end the process before it is completed, you can re-start the tool later and it picks up where it left off.

ftpTester

Verifies interoperability of Interchange with FTP servers. See FTP tester tool.

httpTester

Tests whether an HTTP client can connect to the HTTP server. This tool is for use only upon advice of technical support.

jmsTester

Checks for proper configuration of JMS queues.

keyInfoWriter

Extracts KeyInfo element information from a certificate for use in a CPA for ebXML trading. See Extract KeyInfo element for a CPA.

listTimeZones

Lists all available time zones for the JRE in use on a computer.

logViewer

Interleaves multiple log files and sorts log entries chronologically. It also can filter log categories, log levels and threads. This tool is not for use by end users.

manageTrading

Starts/stops trading engines and pauses trading engine message consumption. This tool supports the following options:

  • manageTrading help
  • manageTrading processing start [transient] – Starts all trading engines on the local server. When "transient" option is specified, the nodesmembership table does not update the flag that indicates if a node is automatically started or not at server startup.
  • manageTrading processing stop [transient] – Stops all trading engines on the local server. Same comment on the "transient" option as for start.
  • manageTrading consumption pause – Engages the Pause Consumption system throttler across all trading engines in the cluster.
  • manageTrading consumption resume – Stops the Pause Consumption system throttler across all trading engines in the cluster.

messagePurgeTool

Immediately deletes all database records of traded messages and all files in the backup directory. See Purge Interchange manually.

mmdGenerator

Used to generate all possible MMDs or a specific MMD for an ebXML CPA. See Tools for CPAs.

modifyUIPorts

Resets the HTTP user interface port in the event of a port conflict that makes the UI inaccessible. This tool is for use only upon advice of technical support. Run the tool without parameters to display instructions for use. In addition, read the port resetting instructions in the startup.xml file at <install directory>\conf.

netInfo

Finds network interfaces for a computer. See Configure server IP binding.

oracle_create_table
Spaces.sql

Script for implementing Oracle custom tablespaces. See the Oracle custom tablespaces option of the Interchange Installation Guide .

partyInfo

Lists the names and details about the community, partner and WebTrader profiles configured in Interchange and the totals for each profile type. This tool provides a way to obtain information about profiles outside of the user interface.

passportIntegrationConfig Enables you to set the Axway Interchange / PassPort connection parameters from a command line.

rejectInprocess
Messages

Sets Interchange messages that are stuck in the in-process state to a status of failed. This tool is for use only upon advice of technical support, and only when all TE and CN nodes are stopped. Run the tool without parameters to display a list of valid parameters.

sftpTester

Verifies the operation of the SFTP client in Interchange and a partner’s SFTP server.

sysInfo

Displays system information such as the operating system, memory statistics, JVM class path and JVM library path. This information also writes to <install directory>\logs\sysInfo.log.

treeScan

Scans the collaboration and action trees for corruption. See Check the collaboration and action trees.

uiSslConfig

Backup tool for editing the ...conf\startup.xml file in case the setup method described in Configure UI connection does not work properly.

upgradeCompare

Searches for and lists changes made to an installation tree after a snapshot was taken with the upgradeList tool. This tool is used when upgrading.

upgradeDiff

Recursively compares the sizes of system files in the old and new installation directory trees. This tool is used when upgrading.

upgradeList

Generates a snapshot of the entire application installation directory tree. This tool is used when upgrading.

versionInfo

Lists the version and build number of the installed application. Run the tool without parameters to generate the list.

Related topics

Related Links