Specifying dtacli Filters

Document ID : KB000028191
Last Modified Date : 14/02/2018
Show Technical Document Details

Introduction: 

DTACLI Filters can be used extensively to configure the transfer of data between endpoints. This document summarizes these details.

 

Environment:  

Data Transport Service – All versions

 

Instructions: 

One of the most compelling features of the Unicenter TNG Data Transport Service is its use of filters. Filters allow you to specify various kinds of processing to be performed on a transferred file both at the source and the destination. Common uses for filters include encryption, compression, and virus checking.

There are three types of filters supported by the dtacli:

  • Well-known filters
  • Reserved filters
  • External filters

The mechanisms for specifying each of these filters are outlined in the remaining sections of this document.

Well-Known Filters

The dtacli supports two methods for specifying filters. The principal method is very expressive but is verbose and can be intimidating to first time users. A second method allows certain common filters (called the well-known filters) to be specified using a convenient shorthand:

dtacli ?f<filter_name>[::<filter_parameters>] ...

The filter_name is selected from one of the following:

  • binary
  • text
  • dir
  • pds
  • binvarrec
  • vsam
  • savefile
  • staging
  • virus
  • compress
  • encrypt
  • fattr

The filters listed in bold are mutually exclusive.

Some filters require additional parameters and these can be specified using the optional filter_parameters argument. For example:

dtacli ?ffattr::"ATTR=<R>" ...


For details of the various filter parameters, consult the CA Reference Guide.

When using well-known filters, the dtacli takes responsibility for specifying the matching read- and write-filters in the correct order.

Reserved Filters

For greater control over the filters that are applied and for access to non-well-known filters, the dtacli provides a much more expressive method of specifying filters. Using this method, you lose the convenience of having the dtacli perform the ordering and pairing of filters. The basic form for specifying a filter is as follows:

dtacli -<filter_type><filter_position><filter_name>[::<filter_parameters>] ...


Filters are processed in left-to-right order.

The range of values for the filter_type is as follows:

  • e - Read parcel filter
  • E - Read file filter
  • w - Write parcel filter
  • W - Write file filter

The range of values for the filter_position is as follows:

  • b - Insert the filter at the beginning of the list
  • e - Insert the filter at the end of the list

The filter_name must be the name of a filter as recognised by the Data Transport Agent, for example:

  • BINARY_READ
  • BINARY_WRITE
  • TEXT_READ
  • TEXT_WRITE
  • DIRTREE_READ
  • DIRTREE_WRITE
  • PDS_LOAD
  • PDS_UNLOAD
  • PDS_UNLOADED_READ
  • PDS_UNLOADED_WRITE
  • BINARY_VARREC_READ
  • BINARY_VARREC_WRITE
  • VSAM_LOAD
  • VSAM_UNLOAD
  • VSAM_UNLOADED_READ
  • VSAM_UNLOADED_WRITE
  • SAVE_FILE_READ
  • SAVE_FILE_WRITE
  • HOP_READ
  • HOP_WRITE
  • HUFFMAN_COMPRESS
  • HUFFMAN_UNCOMPRESS
  • PLAIN_ENCRYPT
  • PLAIN_DECRYPT
  • STAGING
  • VIRUS_SCAN
  • FILE_ATTRIBUTE
  • CACRYPT_ENCRYPT
  • CACRYPT_DECRYPT

Filter parameters are specified as for well-known filters.

External Filters

External filters allow you to plug in you own application specific file filters (all external filters are file filters rather than parcel filters). The basic form for specifying an external filter is as follows:

dtacli -<filter_type><filter_position><pathname>[::<filter_parameters>] ...


Filters are processed in left-to-right order.

The range of values for the filter_type is as follows:

  • E - Read file filter
  • W - Write file filter

The range of values for the filter_position is as follows:

  • b - Insert the filter at the beginning of the list
  • e - Insert the filter at the end of the list

The pathname is the fully qualified path to the external filter. For example:

dtacli -Ebc:\filters\myfilter.exe ...


Filter parameters are specified as for well-known filters.

To summarize, the dtacli provides a comprehensive and expressive mechanism for specifying a wide variety of filters and through its support for external filters allows you to extend its functionality in accordance with your own needs.