Last updated on Jan 21, 2022



Action Transform defines a data mapping that is applied inside the HVR pipeline. A transform can either be a command (a script or an executable), or it can be built into HVR. These transform happens after the data has been captured from a location and before it is integrated into the target, and is fed all the data in that job's cycle. To change the contents of a file as HVR reads it or to change its contents as HVR writes it, use action FileFormat with parameter CaptureConverter or IntegrateConverter. This Transform action happens between the changes from those converters.

A command transform is fed data in XML format. This is a representation of all the data that passes through HVR's pipeline. A definition is in HVR_HOME/etc/xml/hvr_private.dtd.


This section describes the parameters available for action Transform.






Name of the transform command. This can be a script or an executable. Scripts can be shell scripts on Unix and batch scripts on Windows or can be files beginning with a 'magic line' containing the interpreter for the script e.g. #!perl.

Argument path can be an absolute or a relative pathname. If a relative pathname is supplied the agents should be located in HVR_CONFIG/plugin/transform.

A transform command should read from its stdin and write the transformed bytes to stdout. If a transform command encounters a problem, it should write an error to stderr and return with exit code 1, which will cause the replication jobs to fail. The transform command is called with multiple arguments, which should be defined using parameter CommandArguments.

This parameter can either be defined on a specific table or on all tables (*). Defining it on a specific table could be slower because the transform will be stopped and restarted each time the current table name alternates. However, defining it on all tables (*) requires that all data must go through the transform, which could also be slower and costs extra resource (e.g. disk space for a Command transform).

 Command Transform Environment

A transform command inherits the environment from its parent process. On the hub, the parent of the transform's parent process is the HVR Scheduler. On a remote Unix machine, it is the inetd daemon. On a remote Windows machine, it is the HVR Agent Listener service. Differences with the environment process are as follows:

  • Environment variables HVR_CHN_NAME and HVR_LOC_NAME are set.
  • Environment variable HVR_TRANSFORM_MODE is set to either value capintegcmprefr_read or refr_write.
  • Environment variable HVR_CONTEXTS is defined with a comma-separated list of contexts defined with HVR Refresh or Compare (option –Cctx).
  • Environment variables HVR_VAR_XXX are defined for each context variable supplied to HVR Refresh or Compare (option –Vxxx=val).
  • Any variable defined by action Environment is also set in the transform's environment, unless parameter ExecOnHub is defined.
  • The current working directory is HVR_TMP, or HVR_CONFIG/tmp, if this is not defined.
  • stdin is redirected to a socket (HVR writes the original file contents into this), whereas stdout and stderr are redirected to separate temporary files. HVR replaces the contents of the original file with the bytes that the transform writes to its stdout. Anything that the transform writes to its stderr is printed in the job's log file on the hub machine.



Value(s) of parameter(s) for transform (space separated).


Unpack the SAP pool, cluster, and long text table (STXL). By defining this parameter, HVR can capture changes from the SAP pool, cluster, and long text tables (binary STXL data) and transform them into unpacked readable data. For information about the requirements for using this parameter, see section Requirements for SapUnpack.

In case of a HANA source system, unpacking of STXL table (for long text) is possible only during Refresh, it is not possible to unpack during Capture from the database log.

The SAP Unpack license is required for using this functionality.

This parameter:

  • requires Burst Integrate defined in the channel.
  • must be defined only on the target location. Defining on the source location will result in an error.
  • can be used together with parameter ExecOnHub, however, it is not advised because it can have negative impact on the performance.
  • should not be used together with action AdaptDDL or with the parameter Coalesce in action Capture.

Additional Information:

 Additional information about SapUnpack
  • The SapUnpack functionality works only with Unicode systems. Older non-Unicode systems are currently not supported.
  • When this parameter is defined for long text table (STXL), HVR makes the following changes to the target table:
    • Fields SRTF2 and CLUSTR are removed from the target.
    • Field CLUSTD is converted from type varbinary to CLOB/NVARCHAR(MAX).
    • Field CLUSTD stores the text in Unicode format.
  • SAP stores long text table (STXL) in binary format. Each binary text record can have its own encoding. This encoding can be different from the encoding of the SAP system. The SapUnpack functionality for long text supports converting the following SAP code pages to Unicode:
    • 1100, iso-8859-1
    • 1500, iso-8859-5
    • 4102, utf-16be
    • 4103, utf-16le
    • In case the SapUnpack encounters unsupported code page, an error will be displayed. This error can be handled by defining the parameter SapUnpackCoerceErrorPolicy. in action TableProperties.
    • Currently, the SapUnpack functionality does not support converting Japanese stored in an ISO code page.


Execute transform on hub instead of location's machine.



Run transform in N multiple parallel branches. Rows will be distributed using hash of their distribution keys, or round robin if distribution key is not available. Parallelization starts only after first 1000 rows.



Ignore action unless hvrrefresh or hvrcompare context is enabled.

The value should be the name of a context (a lowercase identifier). It can also have form !context, which means that the action is effective unless context is enabled. One or more contexts can be enabled for hvrrefresh or hvrcompare (on the command line with option –Cctx).

Defining an action which is only effective when a context is enabled can have different uses. For example, if parameters Command="C:/hvr/script/myscriptfile" and Context=qqq is defined, then during replication no transform will be performed but if a hvrrefresh is done with context qqq enabled (option –Cqqq), then the transform will be performed. If a 'context variable' is supplied (using option –Vxxx=val) then this is passed to the transform as environment variable $HVR_VAR_XXX.

Requirements for SapUnpack

HVR's SapUnpack feature allows capturing changes from SAP pool, cluster, and long text table (STXL) and replicate into target database as "unpacked" data. For example, HVR can capture the SAP cluster table (RFBLG) from an Oracle based SAP system and unpack the contents (BSEGBSEC) of the cluster table into a Redshift database; the HVR pipeline does the 'unpacking' dynamically.

The SapUnpack feature supports capturing changes from SAP system with either of the databases - Db2 for i, Db2 for LUW, Oracle, and SQL Server.

SAP System

The SAP database typically contains tables that fall into one of the following three categories:

  • Transparent tables: ordinary database tables which can be replicated in a usual way.
  • Pooled and Cluster tables: are special in that the data for several Pooled or Cluster tables are grouped and physically stored together in a single database table.
  • SAP Catalogs: contain metadata and do not usually need to be replicated. HVR's SapUnpack feature needs data from the SAP catalogs for processing the Pooled and Cluster tables.

To enable replication from SAP database using SapUnpack, ensure that the SAP Dictionary tables (DD02LDD03LDD16SDDNTFDDNTT) exist in the source database. HVR uses the information available in SAP dictionary for unpacking data from SAP pool and cluster tables.

There are tables that SAP does not identify in its dictionary as Cluster tables even though the tables contain clustered data. These are not supported. Examples include PCL1PCL2, and MDTC.

License for Unpacking SAP Tables

The regular HVR license does not enable the SapUnpack feature, so an additional license is needed. Contact HVR Support to obtain the proper SAP Unpack license.

HVR supports multi-licensing; this mean a hub system could have several licenses registered at the same time. For example, one license enables all features (except SapUnpack) of HVR to be used perpetually and another license enables the SapUnpack feature.