User - Software works

Integration Toolbox for IBM® TIVOLI® Storage Manager

Create structured and modern TSM based backup and archive solutions

IBM® Tivoli® Storage Manager (TSM) is an enterprise class backup and archive solution built on more than 25 years of experience. Thousands of enterprises are using and relying upon TSM as a proven backup and archive solution.
TSM offers a lot of functionality, yet many customers fail to recognize its full potential. For example, TSM provides IBM® System Storage® Archive Manager (SSAM), a seldom employed feature, which offers a secure way to archive, protect and expire data whose expiration can be triggered by business events. Utilizing SSAM can dramatically reduce the amount of data in online databases and can help companies to become compliant with records retention regulations.
Using SSAM’s features in business applications, however, is difficult and only possible through its C/C++ API or via IBM provided connectors. For JavaTM based business applications our Integration Toolbox for IBM Tivoli Storage Manager product provides an effortless way to take advantage of existing TSM/SSAM environments using a high level Java API. SOA environments can use our JAX-RS compliant Web Services for TSM feature without having to write a single line of code.

After meeting IBM specifications for validation, in July 2014 Integration Toolbox for IBM Tivoli Storage Manager became the first of User Software Works' offerings to be Ready for IBM Cloud & Smarter Infrastructure.

Accessible data – It is a daunting task for every company to store, access and share millions of documents–especially generated on a daily basis–in a reliable and efficient way. Storing a large number of documents in a relational database is an inefficient option. An enterprise content management system can be efficient, but giving clients access to such an archive may result in huge license costs. Application architects do not consider TSM/SSAM as a possible application backend component. We intend to change this thinking. Using our toolbox you can discover and exploit TSM/SSAM’s wide range of document handling capabilities. It also offers you a fast and cost effective way to store your documents and create an application specific archiving solution.

Simple yet comprehensive API – our toolbox is easy to use, it only takes 11 lines of concise source code to back up an object. It provides object oriented access to all native TSM API functions via a low-overhead gateway, and it also speeds up development of a TSM/SSAM based application by supporting contemporary programming patterns. Features include:

  • Query language: query the server using “fluent” query language instead of obsolete API calls.
  • Object oriented event based retention: use the trigger mechanism to start actions based on external business events.
  • Portable program code: use the same sources on every platform.
  • Stream based object handling: use standard Java streams to send and receive data.
  • Object oriented backup grouping: manage TSM backup groups as Java objects.

How to get started – If you want to get started with Integration Toolbox for IBM Tivoli Storage Manager, please visit our Getting started page. Use the Javadoc API documentation to discover more of what our product can offer. If you have any questions please contact us via e-mail:

Supported platforms:

  • Red Hat® Enterprise Linux® 5 (64 bit)
  • Red Hat® Enterprise Linux® 6 (64 bit)
  • IBM AIX® 6.1
  • IBM AIX® 7.1
  • Microsoft® Windows® 2008 Server, x32 and x64 editions
  • Microsoft® Windows® Server 2008 R2, x64 editions
  • Microsoft® Windows® Server 2012, x64 editions
  • Microsoft® Windows® 7, x32 and x64 editions
  • Microsoft® Windows® 8, x32 and x64 editions
Upon request we provide the Toolbox on any platform supported by TSM API and not listed here.



    Download and Install the following applications:

  • Tivoli Storage Manager Client 6.4 or higher
  • Tivoli Storage Manager Client API 6.4 or higher
  • Java Development Kit 6 or higher
  • Before compiling the sample programs from command line prepare your working directory:

  • In the working directory create three folders: lib, bin, src.
  • Copy the TSMAPI-1.1.jar, TSMAPI_internal.jar and log4j-1.2.17.jar into the lib directory.
  • Copy the (on Linux) or libtsmjapi-1.1.a (on AIX) or tsmjapi-1.1.lib and tsmjapi-1.1.dll (on Windows) into the bin directory depending on your platform.
  • Copy the sample java files to the src directory under the structure hu/user/toolbox/tsm/samples.
  • Copy the file to the root of the working directory
  • Ask your Tivoli Storage Manager administrator to set up the server. The following steps are required to run the samples:

  • Register a new node “TOOLBOX” with the password “PASSWORD” and enable archive and backup delete authorities
  • Define a management class named “TOOLBOX_MGMT” with a valid archive and backup copy group
  • Define a management class named “TOOLBOX_MGMT_ACG” with a valid archive copy group only
  • Define a management class named “TOOLBOX_MGMT_BCG” with a valid backup copy group only
  • Define a management class named “TOOLBOX_MGMT_RET” with a valid archive copy group with retinit set to event
  • Logging

  • Apache log4j provides the logging classes for Toolbox. The log files are created under the “log” folder in the working directory
  • By default the loglevel is DEBUG (most detailed). To change the log level you can modify the file. The used log levels are: DEBUG, WARN, ERROR, OFF.


We have a flat licensing model, the product is licensed per customer regardless the number of physical machines, cpu sockets and cores. If you have any questions please contact us via e-mail:


Phone: +36 1 438 5420
Address: USER Rendszerház Kft.
Zöld utca 2., Budapest, H-1039, Hungary