IBM Support

Release Notes for IBM Transformation Extender, V10.0.2.0

Release Notes


Abstract

These release notes contain the information required to install and configure IBM Transformation Extender, version 10.0.2.0

Content

© Copyright IBM Corp 2006, 2019 © Copyright HCL Technologies Ltd. 2017, 2019


=====================================================================
CONTENTS
=====================================================================

About this release
Installation and configuration
Design Server
Runtime and monitoring
IBM App Connect Enterprise (ACE) Notes
Configuring IBM Transformation Extender for Sterling B2B Integrator
API-specific installation
Adapter-specific installation and configuration
Upgrade and migration
New and changed behavior
SSL Configuration
Resolved Authorized Program Analysis Reports (APARs)
Software Development Kit notes
Launcher notes
Contacting customer support
Notices and trademarks


=====================================================================
ABOUT THIS RELEASE
=====================================================================

IBM Transformation Extender was formerly called WebSphere Transformation Extender. Documentation, some interfaces, and some web sites might still refer to it as WebSphere Transformation Extender.


Where to find the software to download

To download the software for IBM Transformation Extender Version 10.0.2.0, go to Fix Central.

For details about supported hardware and software, see the system requirements .
 

Additional IBM Transformation Extender V10.0.2.0 documentation is available only on the IBM Transformation Extender online documentation . No documentation is installed with the product.

For answers to frequently asked questions and workarounds for known problems in all IBM Transformation Extender releases, review the tech notes that are on the IBM Support website.

The release notes in this document apply to the IBM Transformation Extender components listed below. There are also sections for notes that apply to specific components.

  • IBM Transformation Extender Design Server
  • IBM Transformation Extender Design Studio
  • IBM Transformation Extender Runtime and Monitoring

Note: A Launcher Docker image for Linux platforms is available.

IBM Runtime Environment, Java Technology Edition

IBM Transformation Extender V10.0.2.0 installs the operating system-appropriate version of IBM® 64-bit Runtime Environment, Java™ Technology Edition, Version 8 SR 5 FP 27.

About translations

IBM Transformation Extender products are available in the following languages:

  • Brazilian Portuguese
  • English (United States)
  • French
  • German
  • Italian
  • Japanese
  • Korean
  • Russian
  • Simplified Chinese
  • Spanish
  • Traditional Chinese

IBM Transformation Extender products display in English if the IBM representative of a country did not choose to translate them.
The IBM Transformation Extender online documentation has been translated into French.
For the latest documentation, see the English documentation in available in the IBM Transformation Extender online documentation.

=====================================================================
INSTALLATION AND CONFIGURATION
=====================================================================

Supported platforms

This version of IBM Transformation Extender is supported on the following platforms:

  • AIX
  • Windows
  • Linux (x64)
  • Linux for System z®
Loading and running the Launcher Docker image
The Docker image of IBM Transformation Extender Launcher is a Linux Ubuntu-based image that contains a full TX Linux X64 Launcher installation that is ready to run in a Docker container. It is based on a Linux Ubuntu base, with updates to the latest packages. It also contains:
  • ksh
  • rpm
  • curl
  • gdb
  • strace
All TX environment variables are pre-set. The Launcher runs in the container with a DTX_HOME_DIR location of /opt/ibm/wsdtx
Systems, maps, and data, as well as configuration files such as dtx.ini, reside on the host machine and are mounted in the container for access inside the container.

Image name
The image name is:
itx-launcher-vrm/ubuntu:n.n
where vrm is the version, release and modification number and n.n is the build number.  For example:
itx-launcher-1002/ubuntu:0.10

Configuration
Load the TX Launcher Docker image by using the Docker "load" command.
For example:
   docker load -i itx-launcher-10.0.2.0_10_ubuntu.tar.gz
The v.r.m.n.n refer to the version, release, modification and build number.  For example, itx-launcher-10.0.2.0_10_ubuntu.tar.gz.
You can then see the image by using the Docker "images" command.
For example:
 REPOSITORY                            TAG        IMAGE ID       CREATED            SIZE
 itx-launcher-1002/ubuntu        0.10        9f84ebaa0c10 8 minutes ago        788MB

To run the TX Launcher image, use the Docker "run" command. These are some of the parameters you can use to run the image:
  •  Use -it (interactive with a terminal) if you want or need to be in the container to validate mapped volumes, etc.,
  •  Use the -h option to name the Docker container's host name. This is important if you are running multiple TX Launcher Docker containers and using Launcher cooperative file listening:
    -h <hostname>
  • The -v option allows files and directories on the host to be mapped inside the container. This is typically how TX systems, maps, and data are visible inside the container. You can use multiple -v options on the Docker "run" command:
    -v <host-directory>:<container-mount>
To override the container's dtx.ini configuration file from /home/config/dtx.ini on the host:
    -v /home/config/dtx.ini:/opt/ibm/wsdtx/config/dtx.ini
To map the container's TX systems directory for .msl files with /home/systems:
    -v /home/systems:/opt/ibm/wsdtx/systems
   Similarly, map the host directories where TX maps are located to container directories where the .msl files point to the maps.

 Example launcher configuration and startup
 To add a directory to the launcher system directory:
 docker run -w /opt/ibm/wsdtx -v /yourdir/config/:/opt/ibm/wsdtx/config/ -v
/yourdir/dockerdemo/systems:/opt/ibm/wsdtx/systems -v
/yourdir/dockerdemo/logs:/opt/ibm/wsdtx/logs  itx-launcher-1001/ubuntu:0.10 launcheradmin.sh -auto -addir /opt/ibm/wsdtx/systems
To start the launcher and block the shell: 
 docker run  -h Launcher1 --name Launcher1  -w /opt/ibm/wsdtx -v
/yourdir/dockerdemo/LauncherAdmin.bin:/opt/ibm/wsdtx/LauncherAdmin.bin -v
/yourdir/dockerdemo/config/dtx.ini:/opt/ibm/wsdtx/config/dtx.ini  -v
/yourdir/dockerdemo/systems:/opt/ibm/wsdtx/systems -v
/yourdir/dockerdemo/logs:/opt/ibm/wsdtx/logs  itx-launcher-1001/ubuntu:0.10 launcher.sh -start
 
Use -d docker option to run the command in detached mode.
 To stop the launcher from the other shell:
 docker exec Launcher1 launcher.sh -stop
 
 For HTTP listener ports, the -p option maps ports within the container to the host. All containers can reference the same port with in the container, but they must be mapped to different host ports:
 -p <host-port>:<container-port>
Use multiple -p options to map multiple ports to the host.
 
 The following option is required for the strace utility, which  assists in debugging Launcher issues:
   --security-opt seccomp:unconfined

 Entrypoint
 You can use the --entrypoint option of the Docker "run" command to specify a command to be executed when the image starts. Note that the container exits when the command  specified on the --entrypoint ends.

 The command 'launcher.sh -start' blocks and can be used as the last command in the entry script.
 If you do not use --entrypoint, the default entrypoint script in the TX docker image is:
 #!/bin/bash 
 . /opt/ibm/wsdtx/setup
 if [ "$#" -eq 0 ]; then
         /bin/bash
 else
         exec "$@"
 fi

The entrypoint example
 Create a docker entry point script in /yourdir/dockerdemo/start_launcher.sh
 
The script content is:
 # Example docker entry to start the launcher process
 #!/bin/ksh
 . /opt/ibm/wsdtx/setup
 launcheradmin.sh -auto -addir /yourdir/dockerdemo/systems
 launcher.sh -start
 #########
 To start the docker, use:
 docker run -name Launcher1 -w /opt/ibm/wsdtx -v /yourdir/dockerdemo/LauncherAdmin.bin:/opt/ibm/wsdtx/LauncherAdmin.bin -v
/yourdir/dockerdemo/config/dtx.ini:/opt/ibm/wsdtx/config/dtx.ini  -v
/yourdir/dockerdemo:/yourdir/dockerdemo -v
/yourdir/dockerdemo/logs:/opt/ibm/wsdtx/logs --entrypoint
/yourdir/dockerdemo/start_launcher.sh  itx-launcher-1002/ubuntu:0.10
Use ps option to list active docker containers:
 docker ps
 To stop the launcher, from the other shell use:
 docker exec Launcher1 launcher.sh -stop
 See the Docker documentation for Docker command and usage details.

Potential issues with glibc component on RHEL V7.2 systems

As described in Red Hat Linux® Bug 1293976 and Bug 1256285 , Red Hat Enterprise Linux V7.2 can include a defective version of the glibc component. The affected versions are glibc-2.12-1.149.el6.x86_64 through glibc-2.12-1.163.el6.x86_64. These versions of glibc can cause unpredictable behavior in IBM Transformation Extender.

Enter the following command to display the version of glibc that is installed on your system:

rpm -qi glibc

If you have an affected version of glibc, correct the issue as described in the bug reports before you run IBM Transformation Extender.

Default installation location

IBM Transformation Extender products are installed in the following default location:
C:\IBM\TransformationExtender_n.n.n

Where n.n.n indicates the installed location of the IBM Base product.

When you upgrade from an earlier release, you can reuse existing references to the original installation path, for example, references in batch, configuration, or initialization files, if the original installation path did not specify a version number. To reuse existing references when you upgrade the product, install the new release in the same path as the earlier release.

For example, if you installed IBM Transformation Extender V8.4.1 in the C:\WebSphere Transformation Extender directory. To reuse existing V8.4.1 references after you upgrade to this version of the product, first uninstall V8.4.1. When you install this version of the product, specify C:\WebSphere Transformation Extender as the installation path.

Installing the example files

The Typical installation of IBM Transformation Extender Design Studio does not install example files. Use the Custom installation option to install the example files.

For example, to install the IBM Transformation Extender example files on Windows operating systems:
  1. During installation of the IBM Transformation Extender Design Studio, click Custom installation in the Setup Type window.
  2. Ensure that Example Files is selected in the Select Components window.

IBM Transformation Extender Design Studio installs the example files in the install_dir\examples folder.


Changing the JVM heap size in Design Studio

IBM Transformation Extender Design Studio sets a default Java® Virtual Machine (JVM) heap size. You can adjust the heap size of the JVM to meet the needs of your installation. To change the heap size, edit the C:\IBM\TransformationExtender_n.n.n\DesignStudio\wtx_eclipse\eclipse\eclipse.ini file and change the value of the -Xmx1024m parameter. For example, to set the default heap size to 512 MB, change -Xmx1024m to -Xmx512m.


Installing on Windows operating systems

When you install the IBM Transformation Extender products on a Microsoft Windows operating system, do not specify C:\Program Files in your target installation location because of compatibility issues.

Before using third-party software with IBM Transformation Extender installed on your Windows 7 operating system, check with your vendor to ensure that it is compatible with the operating system.


Overriding the default UTF-8 encoding of XML documents

UTF-8 is the default encoding when an XML document does not explicitly specify the encoding. Use the DTX_SCHEMA_ENCODING Language Environment variable to override the default encoding. The encoding that you specify applies to all input and output cards in a map.
  • In a Launcher environment, the encoding applies to the XML input and output of all maps in the Launcher instance.
  • In an IBM App Connect Enterprise environment, the encoding applies to the XML input and output of all maps in the broker where the variable is set.

Specify the code page and export the DTX_SCHEMA_ENCODING variable. For example:

export DTX_SCHEMA_ENCODING=IBM-1047


Malloc-bucket memory allocation in 64-bit Launcher on AIX systems

An APAR in AIX® V7 versions can cause memory corruption in processes that use malloc buckets. When malloc buckets are enabled, the memory corruption causes crashes or hangs in random Launcher processes on 64-bit IBM Transformation Extender on AIX systems.

To avoid this memory corruption, IBM Transformation Extender enables malloc buckets only when the AIX APAR is fixed on the computer where the Launcher is installed. This is because one of the following conditions exists:
  • The APAR fix is included in the installed version of AIX
  • The required AIX APAR fixes are installed:
When malloc-bucket memory allocation is enabled, the install_dir/tmp/wtxlauncher.log file logs a message that is similar to:

Malloc buckets set Mon Mar  2 13:51:41 EST 2015 HOME: /AIX_install_dir

The log file is discarded when AIX restarts.

Configuring the size and number of the Launcher system_name_timestamp.log file

The dtx.ini configuration file can specify the maximum size of the Launcher system_name_timestamp.log file and the maximum number of log files to keep before the oldest log file is deleted. See the Launcher documentation for details about the CircularLogSize and CircularLogFileNum options.


Installation error: uncompress not found

The IBM  Transformation Extender installation programs for UNIX® operating systems rely on the UNIX uncompress program. The uncompress program might not be available in some Linux installations. If you encounter the "uncompress: not found" installation error, install the uncompress program.


Configuring UNIX environment variables

The environment variables required to execute an IBM Transformation Extender map or system must be set prior to execution.

You can set the environment variables (PATH, DTX_TMP_DIR, DTX_HOME_DIR, and the appropriate library path variable for your platform) by running the setup program.

After you log on to your computer, execute the setup program in the IBM Transformation Extender installation directory before executing a map or system file (using the Launcher). This sets the required environment variables for this session only. Modify the .profile script to set the environment variables for all sessions.

Note: The following command procedure assumes that your UNIX command line environment is the Korn (ksh) shell.
 
Source the command as follows:
.  /install_dir/setup

where install_dir is the directory where you installed the IBM Transformation Extender products. For example, if /home/itx is the installation directory, source the . /home/itx/setup command.

Note: There must be a space between the initial source operator (.) and the command path.


Soft DATA segment or heap size on UNIX systems

The default setting for the Soft DATA segment or heap size parameter can cause problems on UNIX platforms. The root user must reset the Soft DATA Segment value to a value larger than the default.

Note: On AIX platforms, use IBM's smit (System Management Interface Tool) utility to reset the Soft DATA Segment value.

Set this value one time for each user (not for each session). Choosing the correct value depends on the following factors:
  • Amount of memory available on the machine
  • Size of data being processed
  • Type of processing occurring on the respective data
  • Other major applications that run on the machine

If memory permits, start with the default value and increase it as needed. Use the following command to test the value by temporarily setting the value within your own environment:

ulimit -d <value>

Note: When setting the Soft DATA Segment value, the change takes effect only for the current session.


Required IBM XL C/C++ runtime package maintenance level on AIX
AIX 72 and C/C++ v16.1 runtime are required. If the compiler, v16.1, is not installed, install the runtime from the following location:
https://www.ibm.com/support/pages/ibm-xl-cc-runtime-aix-161
 

Microsoft .NET Framework 4.0 requirement

IBM Transformation Extender requires .NET Framework 4.0 to register an assembly such as dtxInterop.dll.
  1. Download and install .NET Framework 4.0.
  2. To ensure that the current dtxCom.dll is registered:
a. Unregister the current dtxCom.dll:
regsvr32 /u dtxCom.dll

b. Register the V10.0.2.0 dtxCom.dll:
regsvr32 dtxCom.dll

Now you can use Microsoft .NET Framework 4.0 to register assemblies such as dtxInterop.dll. The regasm utility might require you to run the command prompt with administrator privilege.

Invoke the regasm utility from the Microsoft.NET\Framework directory. For example:
C:\Windows\Microsoft.NET\Framework\v4.0.30319\regasm dtxInterop.dll


To do before opening the Design Studio

By default, Eclipse applications cache plug-ins. In certain circumstances, the default Eclipse behavior might prevent Design Studio from opening, cause Design Studio to be unstable or to exhibit the behavior of an earlier release, or cause the run map process to fail.

To avoid these problems, take one of the following steps before you open the Design Studio application:
  • Clear the cached version of the Design Studio plug-ins by running the cleanextenderstudio.bat file. The cleanextenderstudio.bat file is installed at the root of the install_dir directory.
  • Delete the .metadata folder that is in your workspace, and then reimport the workspace, or switch to a different workspace.

Run the cleanextenderstudio.bat file to clear the cached version of the Design Studio plug-ins under the following circumstances:
  • Your workspace got corrupted.

    In this case, the open process fails when Eclipse attempts to open the Design Studio.
  • You installed a patch provided by the IBM Transformation Extender customer support team that copied files to the wtxstudio directory.

    In this case, when Eclipse attempts to open the Design Studio, it uses the cached versions of the Design Studio plug-ins from the prior release on which this patch was installed, which causes the open Design Studio process to fail.
  • You installed a fix pack release on top of an IBM Transformation Extender 10.0.x release.

    In this case, when Eclipse attempts to open the Design Studio, it uses the cached versions of the Design Studio plug-ins from the prior release on which this fix pack was installed, which causes the open Design Studio process to fail.

Delete the .metadata folder and reimport the workspace, or switch to a different workspace under the following circumstance:
  • You ran a map that could not be loaded into memory, which caused the map to fail and the Design Studio application to terminate abnormally. When you tried to reopen the application, the open process failed.
=====================================================================
DESIGN SERVER
=====================================================================
Installing Design Server
To install the Design Server follow these steps:
  1. Download the Linux package from Fix Central.
  2. Decompress the .tar.gz file.
  3. Follow the instructions contained in the README file. The README file is contained in the default location.
Generating a custom self-signed certificate for your ITX environment
The IBM Transformation Extender Design Server includes a default SSL self-signed certificate with the CN (common name) attribute set to localhost.
To create your own SSL self-signed certificate with attributes that meet the needs of your Design Server execution environment, follow these steps:
  1. Install Design Server:
    a. Download the *.tar.gz file to any Linux OS.
    b. gunzip the *.tar.gz file
    c. tar -xvf the *.tar file
    d. Run ./install.sh script file
    e. Run ./start.sh
  2. To interact with the container tx-client run the following from the Linux prompt:
    docker exec -it tx-client /bin/bash
  3. cd ssl-certificates/self-signed
  4. vi server-crt.cnf and change localhost to the hostname being used for the docker install of Design Server.
  5. vi server-crt.ext and change localhost to the hostname being  used for the docker install of Design Server.
  6. Under directory ssl-certificates/self-signed verify the script file, genselfsigned.sh.
  7. chmod +x genselfsigned.sh to allow execution of the script.
  8. Execute:
    . ./genselfsigned.sh
  9. You are prompted several times to provide a password phrase. Make sure the password phrase is complex for greater security.
  10. Exit from the tx-client container.
  11. Stops all four containers (mongodb, redis, tx-client and tx-server) by using the command:
    ./stop.sh
  12. Start all four containers (mongodb, redis, tx-client and tx-server) by using the command:
    ./start.sh
  13. Open a browser to import the certificate.
  14. In the Chrome browser, click on the vertical ellipsis and select Settings.
  15. Under Settings, click Advanced.
  16. Under Privacy and security select Manage certificates the Certificates window opens.
  17. Under the certificates window click Import to install the certificate. When the certificate installs it is displayed under the Authorities tab.
=====================================================================
RUNTIME AND MONITORING
=====================================================================
Install the runtime and monitoring server
NOTE: Before using third-party software with IBM Transformation Extender, check with your vendor to ensure that the software is compatible with the operating system.

To install Runtime and Monitoring on Windows systems
On Microsoft® Windows® systems, download and run the executable file. On Windows systems, IBM Transformation Extender products are installed in the following default directory:
C:\IBM\TransformationExtender_n.n.n 
When you install IBM Transformation Extender products on a Microsoft Windows operating system, do not specify C:\Program Files as your target installation location because of compatibility issues.
 
To install Runtime and Monitoring on Linux, zLinux and AIX systems:
A single Linux® and AIX installation provides the Command Server, Launcher, IBM Transformation Extender API and monitoring tools. The supported UNIX® shells are ksh and bash.
  1. Download and extract the archive (.tgz) file to a directory of your choice.
  2. Go to the installation directory and run the setup command:
. ./setup
Use the dtxcmdsv execution command to run a map with the Command Server.
Example installation
IBM Transformation Extender installs the example files in the install_dir\examples folder.
Silent installation on Windows systems
Silent installation records responses during the interactive installation of one Windows system to reuse in the unattended installation of another Windows system.
  1. Download the Integration Platform installation package to all Windows systems where you want to install Integration Platform.
  2.  Install IBM Transformation Extender interactively and record your installation responses by running the setup executable file as follows:
    install_dir\txrt_10.0.2.0_build_win64.exe -r
    Your responses during installation are recorded in the C:\Windows\setup.iss response file.
  3. Copy the setup.iss response file to the Windows system where you want to silently install IBM Transformation Extender.
  4. Silently install IBM Transformation Extender by running the package executable file as follows. Note that there is no space between the -f1 keyword and the full path to the setup.iss file:
    install_dir\txrt_10.0.2.0_build_win64.exe -s -f1full_path\setup.iss
    This step replicates all of your responses from the interactive installation.

Runtime and  monitoring  notes

Installation information:

The additional Command Servers for z/OS (Batch and CICS) are available on platform-specific media. For system requirements and installation procedures for these Command Servers, see the platform-specific release notes and the Program Directory.

Additional UNIX runtime information:

You must manually set the shared library path according to your platform.

Do not execute the setup program if you want to configure the environment variables manually. Instead, use the DTX_TMP_DIR environment variable to set the location of temporary files, as described in the following procedure.

Set location for temporary files (DTX_TMP_DIR):

During map execution, the Command Server creates temporary files for resource handling and for retaining debug information. The default directory for these temporary files is /tmp. To specify a different directory for temporary files, set the DTX_TMP_DIR environment variable. For example:

DTX_TMP_DIR=install_dir/tmp
export DTX_TMP_DIR

If multiple users or groups are to access the Command Server engine, define DTX_TMP_DIR instead of using the default /tmp directory. Define and export the DTX_TMP_DIR variable manually or with the setup script. The directory specified for DTX_TMP_DIR must have permission 777 to provide permission to the user, the group, and all others. Define and export the DTX_TMP_DIR variable before you set the directory permission. To set the permission, run the chmod command:

chmod 777 $DTX_TMP_DIR


Enabling environmental debug information (DTX_DEBUG):

When the DTX_DEBUG environment variable is defined, the Command Server can produce environmental diagnostic information that can be helpful when a problem is encountered during map execution. By default, the DTX_DEBUG environment variable is not defined and environmental diagnostic information is not recorded.

When you define the DTX_DEBUG environment variable, environmental diagnostic information is recorded in a file named dtxinfo.log located in the directory defined by the DTX_TMP_DIR environment variable (or in the /tmp directory, if DTX_TMP_DIR is not defined).

To enable the environmental debug facility, set the DTX_DEBUG environment variable to TRUE. For example:

DTX_DEBUG=TRUE
export DTX_DEBUG

To disable the environmental debug facility, set the DTX_DEBUG environment variable to FALSE. For example:

DTX_DEBUG=FALSE
export DTX_DEBUG

The following is a sample of the information contained in the environmental debug file:

PROCESS_ID: 2309, API_REF: 1
Date/Time: Fri Jul 25 14:30:09.279783 2012
FILE: mercmain.c, line: 714
info: [IBM Transformation Extender Product Version: 10.0]

PROCESS_ID: 2309, API_REF: 1
Date/Time: Fri Jul 25 14:30:09.280252 2012
FILE: mercmain.c, line: 744
info: [IBM Transformation Extender RUNNING: Fri Jul 25 14:30:09 2012]

PROCESS_ID: 2309, API_REF: 1
Date/Time: Fri Jul 25 14:30:09.470357 2012
FILE: mercrun.c, line: 1951
New Map File - Fri Jul 25 14:30:09 2012
[/install_dir/examples/general/map/sinkmap/sinkmap.mmc]


Tracing I/O problems (DebugName and DebugAppend):

You can enable the DebugName and DebugAppend options in the [Connections Manager] section of the dtx.ini file to enable the Command Server to trace I/O-related problems.


Setting shared libraries environment variables:

After you install mapping components on UNIX platforms, set the appropriate shared object path environment variable to access the shared libraries. This procedure varies slightly depending on the platform being used.

For example, to set this variable for an IBM AIX platform, enter:

LIBPATH=$LIBPATH:install_dir/libs
export LIBPATH

Note: Because the AIX platform caches shared libraries, if you update a shared library on the disk, you will not be able to see the update. Use the slibclean command as the root user to remove the old shared library from system memory.
To set this variable for Linux platform, enter:

LD_LIBRARY_PATH=$LD_LIBRARY_PATH:install_dir/libs
export LD_LIBRARY_PATH

Note: In the examples, install_dir/libs is the directory where the shared libraries are located.
=====================================================================
IBM APP CONNECT ENTERPRISE (ACE) NOTES
=====================================================================

NOTE: Currently, integration with IBM  App Connect Enterprise (ACE) version 11 with IBM Transformation Extender (ITX) version 10.0 is only available using the ITX Eclipse User Interface.
Design Studio integration with IBM App Connect Enterprise Toolkit

In this version of the product, IBM Transformation Extender Design Studio integrates with IBM App Connect Enterprise Toolkit without the need to install IBM Transformation Extender Runtime and Monitoring on the design-time computer. IBM App Connect Enterprise V11.0.0.4 is the minimum required version.
Configuring Resource Registry under App Connect Enterprise
Prior to IBM App Connect Enterprise (ACE) 11, the IBM Transformation Extender resource registry configuration file was set by the mqsichangeproperties command. As this version of IBM Transformation Extender supports ACE 11, that mechanism is no longer supported by ACE. Instead, perform the following manual steps:

NOTE:  For these steps, the following should be replaced with their actual values:

<MQSI_WORKPATH> The ACE environment variable set by mqsiprofile
<NODE> The integration node (broker) name
<SERVER> The server (execution group) name
  1. Edit the file <MQSI_WORKPATH>/components/<NODE>/servers/<SERVER>/server.conf.yaml.  Back up the original file.
  2. Find the section starting in column one titled “UserDefinedPlugins:”.  If this section does not exist, add it to the bottom of the file.
  3. Under UserDefinedPlugins from 2), indented by two spaces, there should be a ComIbmWTXManager: entry.  If this does not exist, add it.
  4. There should be an entry under ComIbmWTXManager from 3) indented by four spaces resourceConfigFile:.  If this does not exist, add it.
  5. Add the path to the IBM Transformation Extender resource configuration file as the value of resourceConfigFile.
Example:
UserDefinedPlugins:
  ComIbmWTXManager:
    resourceConfigFile: C:\IBM\TransformationExtender_n.n.n\resourceconfig.mrc
The indentation for each entry is important: 0 spaces for UserDefinedPlugins:, 2 spaces for ComIbmWTXManager:, 4 spaces for resourceConfigFile:.
IBM Transformation Extender support for IBM ACE - for Windows systems
This section describes IBM Transformation Extender support for IBM App Connect Enterprise (ACE) 11.0.0.4

Windows TX Jar Limitation:
Due to a Windows maximum command line length of 8191 characters, by default, the IBM Transformation Extender java adapters under the “jars” directory of the IBM Transformation Extender install are not enabled when running under ACE.

When ACE starts, it calls the IBM Transformation Extender profile script located in ACE’s profile directory. IBM Transformation Extender profile script will now call a script in the IBM Transformation Extender's install location’s wmqi directory setTXjarsForACE.cmd. This is how you configure which of the java adapters you can use under ACE.

The setTXjarsForACE command script is also how you can configure your custom jars for IBM Transformation Extender java class adapter or the TX JEXIT function when running under ACE.

To enable an IBM Transformation Extender java adapter under ACE, in setTXjarsForACE.cmd, remove the @rem  text so the set CLASSPATH= is executed for that adapter.

For example, to enable the JDBC adapter:
@rem JDBC
@rem set CLASSPATH=%CLASSPATH%;%DTXHOME%\jars\com.hcl.hip.adapters.m4jdbc\m4jdbc.jar
becomes

@rem JDBC
set CLASSPATH=%CLASSPATH%;%DTXHOME%\jars\com.hcl.hip.adapters.m4jdbc\m4jdbc.jar
When using custom java classes in the TX JEXIT function, or Java Class adapter under ACE, ‘jar’ your classes and add them to the CUSTOM USER JARS section, removing @rem on the set CLASSPATH=%CLASSPATH%; line.  Delimit multiple jars with semi-colons.
For example:

@rem CUSTOM USER JARS
set CLASSPATH=%CLASSPATH%;c:\myjars\myjar1.jar;c:\myjars\myjar2.jar
If you enable all the java adapters in setTXjarsForACE.cmd, the CLASSPATH variable will exceed Windows maximum command line length.

To determine if you have exceeded the maximum length or not, you can test by the following two steps:
  1. Start an IBM App Connect Enterprise command session.

    If  the Welcome to ACE-11 banner displays, a success is indicated. Confirm the success by performing step 2 of this procedure.

    If the Welcome banner does not display, a failure is indicated. Confirm the failure by performing step 2 of this procedure.
     
  2. If the command session from above, change directory to %MQSI_WORKPATH%\common\profiles and run the dtxwmqi1000_64.cmd script from the command prompt.
     
  3. If you see output of the system environment with a list of environment variables the process succeeded.

    If you see the errors The input line is too long  and  The syntax of the command is incorrect  You must @rem one or more adapter entries in setTXjarsForACE.cmd to shorten the CLASSPATH, and retest with a new ACE command session.
Integrating the IBM Transformation Extender perspective with IBM App Connect Enterprise (ACE) Toolkit
Follow these steps to integrate the IBM Transformation Extender perspective with the IBM ACE Toolkit:
  1.  Open IBM App Connect Enterprise, V11.0.0.4.
  2.  Click Help > Install New Software
  3.  Click Add.
  4.  Click Local.
  5.  Browse to <install_dir>\Design Studio\wtx_repo
  6.  Click OK.
  7.  Select Group items by category.
  8.  Select ITX for IBM App Connect Enterprise from the list of categories.
  9.  Click Next.
  10.  Accept the  new license, then click Finish.
IBM Transformation Extender support for IBM ACE - for Non-Windows systems
Perform these steps to integrate IBM Transformatin Extender with ACE:
1. Run setup as Sourced:
.  /install_dir/setup
2. Run this script:
/install_dir/wmqi/ibmace_integration.sh
NOTE: The ibmace_integration.sh script is used to edit the dtxwmqi_1000_64.sh script to update the DTX_HOME_DIR_64 variable
and copy the script to the /var/mqsi/common/profiles directory.
=====================================================================
CONFIGURING IBM TRANSFORMATION EXTENDER ECLIPSE  FOR STERLING B2B INTEGRATOR
=====================================================================
Configuring IBM Transformation Extender Design Studio for Sterling B2B Integrator on Windows systems
  1. Shutdown the Sterling B2B Integrator server if it is running.
  2. Edit the InstallWTXService.bat file in the Transformation Extender installation directory:

    Update the Transformation Extender and Sterling B2B Integrator installation paths.

    Optional: To use Transformation Extender Java™-based adapters and third-party .jar files at runtime, update the section labelled Optional: Install user configurable thirty party .jars to the SI classpath as described in the InstallWTXService.bat file.
     
3. Run the InstallWTXService.bat file.
4. To add the IBM Transformation Extender installation path to the PATH variable, go to Start > Control Panel > System > Advanced Settings > Environment variables, and then add WTX to the PATH variable in the System variables.
5. Start the Sterling B2B Integrator server.
6. Open Design Studio and run the IVT example that is shipped with the IBM Transformation Extender examples to validate the installation.
Configuring IBM Transformation Extender for Sterling B2B Integrator on UNIX systems
  1. Shutdown the Sterling B2B Integrator server if it is running.
  2. Edit the InstallWTXService.sh file in the IBM Transformation Extender installation directory.

    Update the Transformation Extender and Sterling B2B Integrator installation path

    Optional: If Transformation Extender Java-based adapters and third-party .jar files are to be used at runtime, update the section labeled "Optional: Install user configurable thirty party jars to the SI classpath" as described in the InstallWTXService.sh file
     
  3. Run the InstallWTXService.sh file.
  4.  Start the Sterling B2B Integrator server.
  5. Open Design Studio and run the IVT example that is shipped with IBM Transformation Extender examples to validate the installation.
On 64-bit platforms only, make a copy of the <install_dir>\dtxjpi64.dll file and rename it to <install_dir>\dstxjpi64.dll
=====================================================================
API-SPECIFIC INSTALLATION AND CONFIGURATION
=====================================================================

ITX REST API
NOTICE: Before you use the REST API in V10.0.2.0
Before you can use the REST API in V10.0.2.0, you must obtain, and install, a patch that contains the following APARs:
 
  • APAR PH19804 - INCORRECT MAP CARD OR FLOW TERMINAL IS OVERRIDDEN WHEN USING THE TX REST API
  • APAR PH19822 - CHANGES TO MAP ARE NOT SEEN AFTER REDEPLOYING
To obtain the patch, contact IBM Customer Support.
 

The ITX REST API is a .war file that you can deploy in any web server that supports the Servlet 3.0 specification, such as Apache Tomcat. These instructions describe how to deploy to Tomcat, but the instructions can be adjusted for other web servers.

These instructions also describe how to create and run a Docker image that contains the ITX REST API.

See the ITX Programming Interface documentation in the IBM Transformation Extender online documentation and the tutorial installed in install_dir\examples\restapi for details about using the ITX REST API.

Installing the ITX REST API in a web server

Prerequisites:
  • A web server that supports Servlet 3.0 containers, such as Tomcat, Glassfish, or Jetty
  • A Redis server to run maps asynchronously or in fenced mode. If you don't require these functions (for example, to use the API for demo purposes), you can use the ITX REST API without a Redis server.
 

Configuring the tx-rest.properties configuration file

The tx-rest.properties configuration file is installed in the ITX installation directory (install_dir). Comments in the file explain each property.

At a minimum, set the following properties in the tx-rest.properties file. The directories you specify in the configuration file must be existing directories:

  • map.dirs – one or more directories that contain the compiled map files
  • catalog.dir – the directory where the map catalog file is to be created
  • work.dir – the directory for temporary files used during map execution
  • redis.host – the host (and port) of the Redis server. By default, this is set to localhost
  • exec.log.dir – the directory where map execution logs are written
Set up the Tomcat installation for Linux runtime
  1. Download the .tar.gz runtime file.
  2. Extract the files from .tar.
  3. If running design server and dtxtomcat.sh on the same platform, change directory to rest api/tomcat
  4. Run linux command: vi dtxtomcat.ini
  5. Perform a search pod number 8443 and change to 9443.
  6. Save and exit from vi.
  7. From the root of the installation, run . ./setup which will set up the environmental variables for Tomcat.
  • cd from the root, to restapi/tomcat.
  • Run ./dtxtomcat.sh. This will return a list of command line arguments.
  • Run ./dtxtomcat.sh list. This will show you what is stopped and what is running.
  • Run ./dtxtomcat.sh install. This installs the Apache Tomcat server and start the tx-rest.
  • Run ./dtxtomcat.sh list. This will show that Apache Tomcat server and tx-rest are started.
Set up the docker installation for Linux runtime
  1. Download the .tar.gz runtime file.
  2. Extract the files from .tar.
  3. cd from the root, to restapi/docker.
  4. Run the following docker command: docker system prune -a.
  5. Run the following script file: ./build_image.sh.
  6. Run the following docker command to display the docker images: docker images. Verify tx-rest is a part of the image list.
  7. Create the tomcat container: docker create --name tx-rest -it -p 8080: 8080 tx-rest.
  8. Start the tx-rest container: docker start tx-rest.
  9. Verify the tx.rest is started: docker ps -a.
Deploying the WAR file

The tx-rest.war file implements the REST API for ITX. It's installed in the $DTX_HOME_DIR/restapi directory. Deploy the .war file like any other web application. In the case of Tomcat, copy the .war file to the Tomcat webapps folder, either manually or through the Tomcat web console (for example http://<server>:8080/manager/html/list ).

Depending on how your web server is configured, you might need to restart the server after deploying the application.

The console of the web server displays whether the application started correctly. If the application did not start correctly, search the web server's log file for errors related to the tx-rest application.

Validating deployment

After you deploy the tx-rest application, by default, it runs with a context root of tx-rest.

In a browser specify: http://<server>:8080/tx-rest/ . If the tx-rest app is running correctly, it reports version and status information:

{

version: "1.0.0",
status: "OK",
name: "ITX Map REST API",
up_time: "0 days, 0 hours, 0 mins, 25 secs"
}

Swagger documentation

To view the Swagger documentation for the ITX REST APIs, enter the following URL in a browser:

http://<server>:8080/tx-rest/api-docs?url=/tx-rest/openapi.json

You can invoke the APIs directly from the Swagger interface by clicking Try it out under each API definition.

Running in a Docker container

Use these instructions to run the ITX REST API in a Docker container. These instructions apply only to the Linux platform.

To build the Docker image:

1. Install ITX Runtime and Monitoring.

2. Enter cd /opt/ibm/wsdtx/restapi/docker

3. Run build_image.sh to build the Docker image. If you want to customize the content of the Docker image (such as by adding components), edit the Dockerfile.

4. To confirm that the image is in the Docker repository, run docker images and look for the "tx-rest" image.

5. Create a directory on the host to hold the map files, the catalog, and the map execution log. The directory can be anywhere on the host file system but must contain the following subdirectories:

mydir

mydir/maps

mydir/catalog

mydir/logs

6. Copy your map files to the /maps directory. You can create subdirectories under the /maps directory.

7. The tx-rest Docker image contains ITX and the tx-rest application installed in Tomcat. A Redis docker image is also required.

To run the Docker images:

docker run --name tx-rest-redis -d -p 6379:6379 redis

  • The following command automatically downloads the Redis docker image from the Docker repository:
  • In the following command, replace mydir with the path of the directory you created in step 5.
  • docker run --name tx-rest -it -d -p 8080:8080 --link tx-rest-redis:redis -v mydir:/tx-rest tx-rest

    If you want to invoke the API on a different port, change the -p command. For example, to use port 4444, change the command to -p 4444:8080.

8. Follow the steps described in Validating deployment to test that the server is running.

=====================================================================
ADAPTER-SPECIFIC INSTALLATION AND CONFIGURATION
=====================================================================

Apache HDFS adapter
Apache Kafka adapter
Aspera adapter
SNMP adapter

Apache HDFS adapter

The Apache HDFS adapter is supported with Apache Hadoop v2.9.0 or later.


Apache Kafka adapter

The Apache Kafka adapter is supported with Apache Kafka v0.11.0.0 or later.


Aspera adapter
The Aspera adapter is supported only on the Linux on Intel® platform.
CICS adapter 

Use this procedure to install the required CICS server-side components  on a z/OS system. 

The CICS adapter requires the cicssrvr.loadlib file that is shipped with IBM Transformation Extender and is located in the installation directory. The cicssrvr.loadlib file includes server-side components required to use the CICS adapter to connect to CICS.

To install the cicssrvr.loadlib file:

1) Transfer the cicssrvr.loadlib file in binary mode from the installation directory on your computer to a z/OS data set with
80-byte fixed-length records (RECFM=FB, LRECL=80,system-determined blksize).

This means no ASCII-to-EBCDIC translation and no elimination of carriage-return or line-feed characters.

2) After you have installed the file on z/OS, issue the TSO RECEIVE command to create a load library from it. At the
"READY" prompt, type the following:

receive inda(‘my.upload’)

The following messages are displayed:

INMR901I Dataset MY.UPLOAD from USER on NODENAME
INMR906A Enter restore parameters or 'DELETE' or 'END' +

3) Type the name of the load library to be created as follows:

da('my.loadlib')

Messages are displayed, indicating that the load library is being created.

4) Define the programs to the CICS region that will be running the CICS adapter server-side components.

The programs can be defined to CICS by adding the following statements to the CICS CSD definitions. To update the CSD, use
either the DFHCSDUP CICS batch utility program or use the CEDA transaction and use the following statements as an example:

DEFINE PROGRAM(DTXC3270)
GROUP(DTXCICS)
DESCRIPTION(3270 BRIDGE EXIT)
LANGUAGE(LE)
DATA(ANY)

DEFINE PROGRAM(DTXCDRIV)
GROUP(DTXCICS)
DESCRIPTION(ADAPTER DRIVER)
LANGUAGE(LE)
DATA(ANY)

5) Add the cicssrvr load library to the DFHRPL concatenation for the CICS region that will be running the CICS adapter
server-side components.

Connect:Direct adapter

Important: IBM Transformation Extender Connect:Direct adapter is thread unsafe on UNIX® platforms

The Command Server runtime environment ensures threadsafe processing when using the new Connect:Direct adapter. To ensure threadsafe processing when using the Connect:Direct adapter in other IBM Transformation Extender runtime environments on UNIX platforms, follow these design guidelines for your solution implementation:
  • In a Launcher runtime environment, run only one map that uses the Connect:Direct adapter, and set the Max Concurrent Map Instances setting to 1. You still can deploy multiple Launcher processes to achieve parallel execution.
  • In an Integration Server runtime environment, run only one map that uses the Connect:Direct adapter, and disable concurrent instances. You still can deploy multiple IBM App Connect Enterprise execution groups to achieve parallel execution.
  • When using IBM Transformation Extender APIs, run only one map that uses the Connect:Direct adapter, and run only one map instance at a time from the same process.
DB2 adapter

For the DB2 adapter to connect with a DB2 database from a Linux, UNIX, or Microsoft Windows system, install an IBM Data Server Client Package. An IBM Data Server Client Package is available for you to download from the internet for free. Select an IBM Data Server Client Package that includes the CLI driver, which the DB2 adapter uses to connect to a DB2 database. When configuring a database connection for a z/OS or IBM i operating system, you also need a DB2 Connect license. For further information about choosing, installing, and configuring an IBM Data Server Client Package, see the IBM DB2 Database for Linux, UNIX, and Windows knowledge center.

Specify the DB2 adapter from either the map command line, for example, -DBTYPE DB2, or from the Database Interface Designer, for example, in the "Adapter Type" field of the "Database Definition" window.

For more details about using the DB2 adapter, see the related topics in the IBM Transformation Extender online documentation .

Email adapter

To use any email adapter, you must update the dtx.ini file on the runtime system.

On a Microsoft Windows system:

1. Edit the install_dir\dtx.ini file. The install_dir is the directory where IBM Transformation Extender is installed.
2. Search for the string [JVM Options], and set option1 as follows:

option1=-Djava.ext.dirs= install_dir\java\lib\ext; install_dir\extjar

On a UNIX system:
1. Edit the install_dir/config/dtx.ini file. The install_dir is the directory where IBM Transformation Extender is installed.
2. Search for the string [JVM Options], and set option1 as follows:

option1=-Djava.ext.dirs= install_dir/java/lib/ext: install_dir/libs/extjar
Java-based adapters

To configure the Java-based adapters, modify the CLASSPATH environment variable, either directly or by adding the JAR file entries to the [External Jar Files] section of the dtx.ini file. Alternatively, you can add directories that contain JAR files to the [External Jar Directories] section of the dtx.ini file.

The [External Jar Files] and [External Jar Directories] sections are valid only when the adapter is invoked by the Command Server, Launcher, or a non-Java-based API.

For example:
[External Jar Files]
jarN=c:\mypath\myjar.jar

Note: N represents the next available number when there are multiple JAR entries or JAR directories. Environment variables cannot be used in these entries.

For example:
[External Jar Files]
jar1=c:\J2EE\lib\j2ee.jar
jar2=c:\mypath\myjar.jar

To specify directories that contain the JAR files:

[External Jar Directories]
Dir1=c:\J2EE\lib
Dir2=c:\mypath

You can use CLASSPATH environment variables to locate external JAR modules. For example:
  1. Set environmental variable J2EE_HOME to point to the installed directory.
  2. Update the CLASSPATH environment variable as described below.
    Platform CLASSPATH Environment Variable
    Windows %J2EE_HOME%\lib\j2ee.jar
    Linux $J2EE_HOME/lib/j2ee.jar

JNDI adapter

The following indicates the supported JNDI drivers for use with the JNDI adapter:

- COS Naming service provider, 1.2.1 release
- DNS Service Provider, 1.2 release
- File system service provider, 1.2 release
- LDAP service provider, 1.2.4 release
- RMI registry service provider, 1.2.1 release
MIME adapter

The MIME adapter requires the j2ee.jar and mail.jar files, or equivalent jar files that contain the J2EE and "javax.mail" classes. These modules are not shipped with IBM Transformation Extender. After installing the .jar files from an appropriate Java Platform, Enterprise Edition installation, modify the CLASSPATH to include the modules.
ODBC adapter
Before you use the ODBC adapter, you must install the ODBC driver for your specific database. 

For details about using the ODBC adapter, see the online documentation.


Follow these steps to install and configure the ODBC adapter on Windows systems:

  1. Install the latest ODBC Driver for your specific database.
  2. Go to Administrative Tools and select: ODBC Data Sources (64-bit)
  3. Select: Start > Settings > Control Panel > System and Security> Administrative Tools > Data Sources (ODBC)
  4. Select the System DSN tab, and click Add.
  5. In the Create New Data Source window, select the ODBC driver and click Finish.
Follow these steps to install and configure the ODBC adapter on Linux and UNIX systems:
  1. Install the ODBC driver for your specific database.

  2. Edit the $DTX_HOME_DIR/unixODBC/etc/odbc.ini file with the following contents. As an example, for MS SQL Server, use your libmsodbcsql version and location on the "Driver=" entry.

    NOTE: The odbc.ini file is an example.  Refer to your ODBC driver vendor for parameter details.

    NOTE: The name that you assign to the data source name is what you will use for the ODBC Adapter -SOURCE command.

         [<data source name>]
         Driver=<full path to driver library>
         Description=<Optional>
         Trace=NO
         Server=<ipaddress, or hostname>
         Port=<port number>
         Database=<database name>

  3. Edit the $DTX_HOME_DIR/unixODBC/etc/odbcinst.ini file with the following contents:
     [<data source name>]
     Driver=<full path to driver library>
     Description=<Optional>
    UsageCount=1

    NOTE: In product versions later than 9.0.0.x, the following lines in the $DTX_HOME_DIR/unixODBC folder are part of the setup scrip, and do not need to be manually added:

    export LD_LIBRARY_PATH=$DTX_HOME_DIR/unixODBC/linux/lib:$LD_LIBRARY_PATH
    export ODBCINI=$DTX_HOME_DIR/unixODBC/etc/odbc.ini
    export ODBCSYSINI=$DTX_HOME_DIR/unixODBC/etc

  4. Run the  . ./setup script from the root installation location.

  5. Run the following command to test the connection:
       isql -v <data source name> <userid> <password>

OpenPGP adapter

In V10.0.0 and later, the OpenPGP adapter is installed as part of the base product.

Downloading the GnuPG libraries for the OpenPGP Adapter

This release of the OpenPGP adapter supports GnuPG V1.4.2 and later for Windows and UNIX® operating systems.

The OpenPGP Adapter uses the Gnu Privacy Guard (GnuPG) third-party product to perform the functionality required by the adapter. To use the OpenPGP Adapter, you must first download and install the GNU PG libraries from the GNU website.
  • For Windows operating systems, the binary images for the GnuPG product are available for download.
  • For UNIX operating systems, you must download and recompile the GnuPG source to generate the binary images.
After you download and install the GnuPG files, use the following instructions to configure the location of the GnuPG (gpg.exe) executable file for the OpenPGP Adapter.

Configuring the gpg.exe file location in the Windows registry

The OpenPGP Adapter requires the following change to the registry for it to determine the location of the GnuPG (gpg.exe) executable file.

To specify the location of the GnuPG gpg.exe file in the registry:
  1. Click Start > Run and enter regedit to launch the Registry Editor.
  2. Navigate to the HKEY_LOCAL_MACHINE\SOFTWARE\GNU\GNUPG key.
  3. Right click on the GNUPG key, select New > String Value from the menu, and name the string value gpgProgram.
  4. Double-click gpgProgram to assign a value to it.
  5. In the Value field, enter the full path to the GnuPG gpg.exe file. For example:
    C:\IBM\GNU\GnuPG\gpg.exe
  6. Click OK.
  7. Select File > Exit to exit the Registry Editor.

Configuring the gpg.exe file location on UNIX systems

The IBM Transformation Extender OpenPGP Adapter requires the GPG_PATH environment variable to be set to the directory of the GnuPG gpg executable file. Use either of the following methods to set the GPG_PATH environment variable:
  • Add the setting of this variable to the user login profile, so that it is always set.
  • Add it to the bottom of the setup script that contains all of the environment variables needed by IBM Transformation Extender.

If you use the /usr/local/bin default installation location, add the following line to the setup script:
export GPG_PATH=/usr/local/bin
Oracle and Oracle AQ adapters

See the IBM Transformation Extender system requirements for the supported database versions.
Support for Oracle databases does not include support for the Oracle Exadata platform.
SNMP adapter
The SNMP adapter is automatically included with all base editions of IBM Transformation Extender. The SNMP Agent is an optionally installed component of IBM Transformation Extender Runtime and Monitoring.

To use the SNMP adapter or the SNMP Agent, you must install the Java™ Dynamic Management Kit (JDMK) runtime module available from the OpenDMK project.
 
 
Sybase adapter

With the Sybase adapter, you can connect to the Sybase Adaptive Server Enterprise (ASE) and Sybase IQ databases. See the IBM Transformation Extender system requirements for the supported database versions. See the Sybase adapter documentation for the list of supported data types.
 
Adapter considerations
Design Server
  • Maps with cards that utilize IBM MQ or Database (Legacy) connection types do not run successfully in web UI. Such maps can be designed in the web UI but then need to be deployed to a runtime server and executed there.
Design Studio
  • Apache Active MQ adapter: The OnSuccess target card property lists Create and CreateOnContent as supported options, but the only supported option is Create. The OnFailure target card property lists Commit and Rollback as supported options, but the only supported option is Commit.
  • Amazon S3 and Amazon SQS adapters: The OnSuccess source card property lists Keep and Delete as supported options, but the only supported option is Keep.
  • Amazon S3, Amazon SQS and Amazon SNS adapters: The OnSuccess target card property lists Create and CreateOnContent as supported options, but the only supported option is Create.
     
Command Server
  • When running maps that utilize one or more of Apache Kafka, Apache HDFS, JDBC, Amazon S3, Amazon SQS, Amazon SNS, Apache Active MQ, SFTP, REST, Salesforce, OData and Azure SQL connection types, the DTXHOME or DTX_HOME_DIR environment variable need to be set to point to the product install home directory. If the environment variable is not set, the “Adapter not found” message is reported when running the map. This requirement applies to all platforms on which the Command Server is supported.

=====================================================================
UPGRADE AND MIGRATION
=====================================================================

Support for 64-bit platforms only

This version of IBM Transformation Extender supports 64-bit platforms only, Connect:Direct integration is not supported on the Windows platform.

Changes to anyType XML schema fields prevent older maps from compiling

A fix to the native schema type tree to properly process anyType XML schema fields changed the format of the type tree. Because anyType fields include anyAttribute, additional levels are added to the native schema type tree to handle any attributes that might occur in the data. As a result, maps older than V9.0.0.2 do not compile because the path to these elements changed.

To eliminate the need for remapping, set the new ITX_NS_NOANYTYPE environment variable to TRUE. When enabled, ITX_NS_NOANYTYPE forces the IBM Transformation Extender native schema type tree generator to create the type tree identical to the one before the anyAttribute fix was added.

Running IBM Transformation Extender with locally vs globally installed GSKit

IBM Transformation Extender installs a local version of IBM Global Security Kit (GSKit) in the install_dir/GSKit directory. Local GSKit installation enables IBM Transformation Extender to automatically run its installed version of GSKit without additional software installation or environment configuration.

IBM products that IBM Transformation Extender integrates with might use:
  • A local version of GSKit that is installed by that product
  • A global version of GSKit that is installed by the GSKit installation program.

  • When globally installed, the security modules of GSKit are available on a system-wide basis.

To prevent IBM Transformation Extender from using its locally installed version of GSKit, rename the install_dir/GSKit directory. At run time, IBM Transformation Extender searches the platform-specific environment path for the GSKit modules.


64-bit support for EXIT structure of C API

Customers who use the C Exit must rebuild their EXIT library for V9.0.0 or higher.


Change to resolution of relative paths for some interfaces that use files as arguments

In earlier releases, IBM Transformation Extender changed from the directory of the currently running process to the map directory before it ran a map.

For example, before running the /home/abc_acct/8413/maps/myoracle.mmc map, IBM Transformation Extender changed from the directory of the currently running process to the /home/abc_acct/8413/maps directory. If the myoracle.mmc map used a relative path to specify files, the path resolves relative to the map directory. In this example, IBM Transformation Extender creates an adapter trace file called m4oracle.mtr in the /home/abc_acct/8413/maps directory if the trace file was defined with any of the following relative paths:
../../8413/maps/m4oracle.mtr  
./m4oracle.mtr
m4oracle.mtr

IBM Transformation Extender V9.0.0 or higher does not change to the map directory before it runs a map. V9.0.0 or higher resolves relative paths by appending the relative path to the directory of the currently running process. The following interfaces are affected by this change:
  • Custom functions that use files as arguments
  • Adapter trace files in IBM Transformation Extender Runtime and Monitoring integrations
  • API implementations that open files after calling a map

For example, the following xmllib functions that can specify files as arguments are affected:

xmllib->XSLTEX( "ipo.in.xml", "ipo.xsl", "transform.log")
  • The first two arguments can be data or a file.
  • The third argument is always a file.

xmllib->XPATHEX( "ipo.in.xml", "./order/item[1]/shipDate", "/ipo:purchaseOrders ", "xpathlog.txt")
  • The first argument can be be data or a file.
  • The fourth argument is always a file.
xmllib->VALIDATEEX( "ipo.in.xml", "http://www.example.com/IPO  ipo.xsd", "numtotext.log"
  • The first argument can be data or a file.
  • The second argument is always a file (optionally prefixed by default name space).
  • The third argument is always a file.

To restore the pre-V9.0.0 behavior so that affected relative paths resolve relative to the map directory, set the environment variable DTX_CHDIR=TRUE. In a multi-threaded environment such as Launcher or IBM Transformation Extender for IBM App Connect Enterprise, all of the maps must run in the same directory to ensure thread safety.

On UNIX systems:

export DTX_CHDIR=TRUE

On Windows systems:

set DTX_CHDIR=TRUE

For best results, use an absolute path for adapter trace files. You can use the GETDIRECTORY function to dynamically build an absolute path.


Native XML schemas with prologs must use XSD as the type of the main input card

When a native XML schema has a prolog, the Type setting of the main input card must be XSD (the root of the XML document). A parser error results when the XML schema has a prolog and the Type setting specifies a sub-element of the root.

As a general practice, use XSD as the Type setting in the main input card of all native XML schemas. The XSD setting parses correctly regardless of whether the schema includes a prolog.

For all Xerces type trees, use Doc XSD as the Type setting of the main input card, regardless of whether the XML document has a prolog. Parsing errors can result if the XML document includes a prolog and you specify a sub-element of Doc XSD as the Type setting of the main input card.


Recompile existing V8.4.1.1 maps that use the Standards Processing Engine adapter

A map that uses the Standards Processing Engine (SPE) adapter to run adapter action commands such as ENVELOPE, DEENVELOPE, and TRANSFORM must be compiled with IBM Transformation Extender V8.4.1.2 or later. To upgrade a map that you developed with IBM Transformation Extender V8.4.1.1, delete the existing Response.mtx file and recompile the map using the updated Response.xsd file that is included with a later version of Transformation Extender. The schema for the SPE adapter response was updated in V8.4.1.2. A map must use the new version of the Response.xsd file to correctly process the SPE response.


Maps cannot reuse work files from earlier releases

IBM Transformation Extender V8.4.1 and later work files are not compatible with work files from earlier releases. If a map reuses work files that were created with an earlier release, you must delete the work files and run the map to create new work files that are compatible with version 8.4.1 and later.


Custom function memory allocation on Windows systems

IBM Transformation Extender version 8.4 and later releases require custom functions that run on Microsoft Windows systems to use the new mpiMemMalloc and mpiMemRealloc memory management functions to allocate or reallocate the lpDataFromApp buffer.


Migrating maps, type trees, and systems

Maps, type trees, and systems from versions 5.0 and later can be used with V9.0.0 and later. You must regenerate systems. Although it is not always required for running maps from an earlier version, you should reanalyze and save the type trees, and save and recompile the maps; otherwise, the processes must convert the files each time they load the files.

  • If you are migrating from V8.0 to V10.0.2.0, you must run your database triggering scripts in order to successfully run source-triggered database systems. After V10.0.2.0 is installed on the supported Oracle or SQL Server databases, no earlier release of IBM Transformation Extender can use triggering on that database, because the client and source reference different names.
  • To use the new code page functionality, you must make new selections for the Data Language and National Language type properties in your type trees.
  • If you previously used a non-international version of IBM Transformation Extender (formerly DataStage TX or Mercator), Native has been redefined to be Latin1 instead of ASCII.
  • During installation, if you are prompted to register this version as the default program for opening IBM Transformation Extender file types and you choose "Yes," all IBM Transformation Extender files, such as *.mtt or *.mms, open with this version.

Opening Files from an earlier version

When you save a source file from an earlier version of an IBM Transformation Extender product in the current version, the content and structure of that file is automatically converted to the format for the current version.

After conversion to the current version formats, do not open these files in earlier versions of an IBM Transformation Extender product component. After conversion, the format of the source has changed and there are added features that are not supported in the earlier versions.
  • *.mtt files are converted in memory when the file is opened. The backup *.omt file is created when the file is saved.
  • *.mms files do not need to be converted for the current version.
  • A map created in an earlier version opens in the current version.
  • *.msl files do not need to be regenerated. They are converted dynamically.
  • *.mmc files do not need to be recompiled.
  • *.msd files still work the same way, creating an *.osd when the file is opened.
  • *.mdq files open in the current version.


Preparing maps to run in this version
  • Analyze each type tree file for logic and structure and then save it in the current version of the Type Designer.
  • Regenerate type trees for queries, tables, and stored procedures.
  • For maps that will be executed using a current version of the Command Server or Launcher, build all maps using the equivalent (current) version of the Map Designer.
  • Build and generate the Launcher system (.msl) file or the command file for all systems defined in the current version of the Integration Flow Designer.
  • If you have designed maps that could produce 0 bytes of data to an adapter (this is especially critical for R/3 adapters), you must change the OnSuccess setting to CreateOnContent or use the -XO adapter option.
  • When you open a map that references a custom adapter, or an adapter that is no longer supported in this version of the product, the Source or Target in the Edit Card window is blank. The map builds successfully, but returns a "Source not available" or "Target not available" message when it executes. The solution is to select an adapter from the list in the Edit Card window.
Update Microsoft SQL Server drivers for Windows 10

Install latest Microsoft SQL Server drivers to support SSL 1.2

If you are migrating from an earlier version, you should be aware of the relative performance of running maps in this version .
 
=====================================================================
NEW AND CHANGED BEHAVIOR
=====================================================================

For an overview of new features in this release, see the What's New information in the IBM Transformation Extender online documentation.
IBM Transformation Extender Design Server
The web-based Design Server UI is new in this  product release. See the following video for usage instructions:

Deprecated functions, components, and platforms

The following functions, components, and platforms are deprecated in V10.0.0.0 and later:

  • tbcconv utility
    Use Design Studio API instead.
  • WSDL Classic Importer

Removed functions, components, and platforms

For version 10.0.0.0 and higher, Launcher Hypervisor Edition is not supported.

The following platforms are no longer supported:

  • Solaris SPARC platform
  • HP-UX Itanium platform
  • SUSE Linux Enterprise Server (SLES) for x86
  • SUSE Linux Enterprise Server (SLES) for z/Series
  • Red Hat Enterprise Linux (RHEL) for POWER System Big Endian
  • SUSE Linux Enterprise Server (SLES) for POWER System Big Endian

Removed IBM Transformation Extender editions:

  • IBM Transformation Extender with Command Server
  • IBM Transformation Extender with Launcher 
  • IBM Transformation Extender Launcher Studio
  • IBM Transformation Extender for Integration Servers
  • IBM Transformation Extender for Application Programming

The removed editions are consolidated in IBM Transformation Extender Runtime and Monitoring Edition.

Removed adapters and adapter functions:

  • Tibco adapter
Integration removed with BPM
This release of IBM Transformation Extender removes integration with IBM Business Process Manager Advanced (BPM).
=====================================================================
SSL CONFIGURATION
=====================================================================
Resolving the invalid SSL certificate error
Your browser will report the "Invalid SSL certificate" error when it loads the IBM Transformation Extender Design Server application. To resolve the SSL certificate error, import the Design Server root certificate into your browser.
 
To import the certificate:
  1. In the Design Server installation folder, start the Design Server application:
    ./start.sh
  2. Copy the Design Server self_ca_root.pem root certificate file to the installation folder:
    docker cp hip-client:/usr/src/app/ssl-certificates/self-signed/self_ca_root.pem
  3. Transfer the self_ca_root.pem root certificate file to the computer where the Design Server will run.
  4. Start the browser and import the self_ca_root.pem file into the root certificate truststore:
    If you are using a Chrome browser:
    a.  Go to Settings > Advanced > Manage Certificates.
    b.  In the Trusted Root Certification Authorities tab, click Import and import the self_ca_root.pem file.

    If you are using a Firefox browser:
    a.  Go to Options > Privacy Security > Certificates and click View Certificates.
    b.  In the Authorities tab, click Import and import the self_ca_root.pem file.
     
  5. Restart your browser.
=====================================================================
RESOLVED AUTHORIZED PROGRAM ANALYSIS REPORTS (APARs)
=====================================================================
For a list of APARs that are fixed in this version of the product, see the fix list.
 

=====================================================================
SOFTWARE DEVELOPMENT KIT NOTES
=====================================================================

The following Software Development Kit components are automatically included when you install the Design Studio. Use IBM Transformation Extender Runtime and Monitoring as the runtime environment with the Software Development Kit.

IBM Transformation Extender Application Programming Interface requirements

The IBM Transformation Extender Programming Interface consists of C, COM, Java, REST, RMI and Python APIs.

The required header files, library files for these APIs are located in the following directories:
Files Windows Directory UNIX Directory
Headers install_dir $install_dir/src
Library install_dir $install_dir/libs
Schemas install_dir $install_dir/src
JARs install_dir\tools

Linking an application to an alternate ICU library version

This release of IBM Transformation Extender uses ICU version 55.1.0.

An IBM Transformation Extender Application Programming Interface (API) user can link an application to a version of ICU other than ICU V55.1.0 by including the ICU version's lib names in the link line.

For example, to link your application to ICU V3.4.1, use the following link line:

-licuuc341 -licuuc18n341 -licudata341

If you do not want to specify the version numbers in the link line, the ICU team recommends that you start the icu-config script from the $(ICU_INSTALL)/bin/ directory.

To start the icu-config script, include the following code in your makefile:

ICU_LDFLAGS=`$(ICU_INSTALL)/bin/icu-config --ldflags-libsonly`

If you are using ICU V3.4.1, the icu-config script returns the following required link lines:

-licui18n341 -licuuc341 -licudata341

=====================================================================
LAUNCHER  NOTES
=====================================================================

These notes are for the Launcher Administration, Management Console, and Resource Registry components of the IBM Transformation Extender Runtime and Monitoring.

Resource Registry trace file

Use the [Launcher] logging options in the install_dir\dtx.ini configuration file to set the Resource Registry trace options. The trace file logs encrypted aliases and displays them as masked values.

Configuration requirements in non-Windows environments

To use these products in a non-Windows environments, the X Window server must be running on the local host machine or system. You must set the DISPLAY environment variable and export it.

The DISPLAY environment variable identifies the X Window server that is to display the X Window IBM Transformation Extender GUI client. The syntax might vary depending on the shell version that you are using. To set the DISPLAY environment variable:

export DISPLAY=<display_name>:<server_display[.screen_number]>
  • The DISPLAY environment variable name must be in uppercase letters.
  • The display_name is the IP address or domain name of the local host machine that is to display the X Window IBM Transformation Extender GUI client application.
  • server_display is the number assigned to the X Window server that is to display on the host machine.

Because most local host machines have a maximum of one display monitor, keyboard, and mouse, in most cases, you specify the server_display as :0, and omit the screen_number .

If your system has more than one monitor (display screen) as in multi-headed systems, each monitor is identified by a unique screen number. You specify the screen_number by appending it to the end of the X server_display specification, for example, :0.1. The default screen_number is 0, which refers to the primary screen, and when it is 0, you do not need to specify it; for example, you can specify only the server_display simply as :0.

Example 1:

export DISPLAY=mycomputer.ibm.com:0

Where:
  • mycomputer.ibm.com is the domain name of the local host that is to display the X Window IBM Transformation Extender GUI client application.
  • 0 is the value for the server_display that is assigned to the DISPLAY environment variable.

The host system exports the value to the X Window client so that it will display the X Window IBM Transformation Extender GUI client application on the primary screen of the computer with the mycomputer.ibm.com domain name through the X server assigned as 0.

Example 2:

export DISPLAY=192.168.1.110:0

Where:
  • 192.168.1.110 is the IP address of the local host that is to display the X Window IBM Transformation Extender GUI client application.
  • 0 is the value for the server_display that is assigned to the DISPLAY environment variable.

The host system exports the value to the X Window client so that it will display the X Window IBM Transformation Extender GUI client application on the primary screen of the computer with the 192.168.1.110 IP address through the X server assigned as 0.


Display errors in non-Windows environments

To avoid display errors related to font.properties when starting the Launcher Administration, Management Console, or Resource Registry, ensure that the display X server has access to all fonts used in the font.properties of the Java installation.
 

=====================================================================
CONTACTING CUSTOMER SUPPORT
=====================================================================

Contact Customer Support at 1-800-IBM-SERV, or go to the support portal .
 
=====================================================================
NOTICES AND TRADEMARKS
=====================================================================
This information was developed for products and services offered in the US. This material might be available from IBM in other languages. However, you may be required to own a copy of the product or product version in that language in order to access it.

IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing
IBM Corporation
North Castle Drive, MD-NC119
Armonk, NY 10504-1785
US

 

HCL
330 Potrero Ave.
Sunnyvale, CA 94085
USA
Attention: Office of the General Counsel


For license inquiries regarding double-byte character set (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property Licensing
Legal and Intellectual Property Law
IBM Japan Ltd.
19-21, Nihonbashi-Hakozakicho, Chuo-ku
Tokyo 103-8510, Japan

 

HCL
330 Potrero Ave.
Sunnyvale, CA 94085
USA
Attention: Office of the General Counsel

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some jurisdictions do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Any references in this information to non-IBM websites are provided for convenience only and do not in any manner serve as an endorsement of those websites. The materials at those websites are not part of the materials for this IBM product and use of those websites is at your own risk.

IBM may use or distribute any of the information you provide in any way it believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:

IBM Director of Licensing
IBM Corporation
North Castle Drive, MD-NC119
Armonk, NY 10504-1785
US

HCL
330 Potrero Ave.
Sunnyvale, CA 94085
USA
Attention: Office of the General Counsel

 

Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.

The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us.

Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.

This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to actual people or business enterprises is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. The sample programs are provided "AS IS", without warranty of any kind. IBM shall not be liable for any damages arising out of your use of the sample programs.


Trademarks

IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the web at "Copyright and trademark information" at www.ibm.com/legal/copytrade.shtml .
  • Intel and Itanium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries.
  • Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates.
  • Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.
  • Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both.
  • UNIX is a registered trademark of The Open Group in the United States and other countries.
Terms and conditions for product documentation

Permissions for the use of these publications are granted subject to the following terms and conditions.

Applicability
These terms and conditions are in addition to any terms of use for the IBM website.

Personal use
You may reproduce these publications for your personal, noncommercial use provided that all proprietary notices are preserved. You may not distribute, display or make derivative work of these publications, or any portion thereof, without the express consent of IBM.

Commercial use
You may reproduce, distribute and display these publications solely within your enterprise provided that all proprietary notices are preserved. You may not make derivative works of these publications, or reproduce, distribute or display these publications or any portion thereof outside your enterprise, without the express consent of IBM.

Rights
Except as expressly granted in this permission, no other permissions, licenses or rights are granted, either express or implied, to the publications or any information, data, software or other intellectual property contained therein.

IBM reserves the right to withdraw the permissions granted herein whenever, in its discretion, the use of the publications is detrimental to its interest or, as determined by IBM, the above instructions are not being properly followed.

You may not download, export or re-export this information except in full compliance with all applicable laws and regulations, including all United States export laws and regulations.

IBM MAKES NO GUARANTEE ABOUT THE CONTENT OF THESE PUBLICATIONS. THE PUBLICATIONS ARE PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.


IBM Online Privacy Statement

IBM Software products, including software as a service solutions, (“Software Offerings”) may use cookies or other technologies to collect product usage information, to help improve the end user experience, to tailor interactions with the end user, or for other purposes. In many cases no personally identifiable information is collected by the Software Offerings. Some of our Software Offerings can help enable you to collect personally identifiable information. If this Software Offering uses cookies to collect personally identifiable information, specific information about this offering’s use of cookies is set forth below.

This Software Offering does not use cookies or other technologies to collect personally identifiable information.

If the configurations deployed for this Software Offering provide you as customer the ability to collect personally identifiable information from end users via cookies and other technologies, you should seek your own legal advice about any laws applicable to such data collection, including any requirements for notice and consent.

For more information about the use of various technologies, including cookies, for these purposes, see IBM’s Privacy Policy at http://www.ibm.com/privacy and IBM’s Online Privacy Statement at http://www.ibm.com/privacy/details in the section entitled “Cookies, Web Beacons and Other Technologies,” and the “IBM Software Products and Software-as-a-Service Privacy Statement” at http://www.ibm.com/software/info/product-privacy .

[{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSLU4JS","label":"IBM Sterling Transformation Extender"},"Component":"","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"10.0.2.0","Edition":"","Line of Business":{"code":"LOB59","label":"Sustainability Software"}}]

Document Information

Modified date:
03 October 2022

UID

ibm11097637