Axway Gateway: Managing Transfers

Managing transfers

About transfers and transfer requests

Gateway processes file Transfers. A file Transfer is a set of processes that results in the exchange of files between two computers. In a transfer, one computer is the sender, the other is the receiver. The sender and receiver are linked together by a network. A file Transfer consists of sending:

  • The file
  • All related technical parameters associated with the file. For example: connected partners, local file storage format, and so on.

Transfer types

Gateway enables you to submit three types of Transfer:

Transfer objects

Gateway provides a set of objects that enable you to create and define the characteristics of a Transfer. To create a Transfer you choose the objects useful for your Transfer and enter the object property values that define the processing that you require.

To execute a Transfer, you need:

  • A Transfer Request
  • A pair of Site objects

You may require additional objects to define additional transfer characteristics, depending on the nature of the Transfer and the context in which you want to execute it. For example, to handle any incoming connection request, you also need a CGate definition.

The following table lists the Gateway objects you can use to manage Transfers and summarizes the way you can use them.

Object

Description

Refer to

Application

To process files during transfer, Gateway requires information about the file characteristics.

Application objects define:

  • Local file attributes, such as record format and length, local directory for received files and so on
  • Transferred file attributes, such as data code, record length, compression and so on

You can enter values for certain Application object parameters directly in the Transfer Request.

If you set the same parameters values in both the Transfer Request and the Application object, the Transfer Request parameter values override the Application parameter values.

About Applications

Connection Gate/ Connection Gate Group

Before Gateway can accept protocol connections from external entities, the access permissions and connection characteristics must be defined for the entity.

The Connection Gate object enables you to attribute permission to connect to Gateway and exchange files with it. It also controls the connecting-client access to files stored in the Virtual File Directory.

About CGates and CGateGroups

Decision Rule

You can optionally configure Gateway to process the files it handles according to pre-set criteria.

Decision Rules objects determine the processing for the current transfer based on a set of conditions that Gateway applies to the transfer. If all conditions specified in the Decision Rule match the parameters defined in the transfer, Gateway applies the specified execution type (for example, execute Perl script, redirect to Axway Integrator, and so on).

Managing Events on Gateway

Diffusion List

Diffusion List objects enable you to transmit a Transfer Request to multiple destination Sites.

You apply a Diffusion List object by first creating the Diffusion List object, and then selecting the Diffusion List object as a Transfer Request parameter.

About Diffusion Lists

Model

A Model is a template of a Transfer Request that groups a set of common parameters to apply to multiple Transfer Requests. Models accelerate and simplify the process of defining Transfer Requests.

To use a Model, you:

  • Create the Model object
  • Select the Model object as a Transfer Request parameter

You can enter values for certain Model object parameters directly in the Transfer Request.

If you set the same parameters values in both the Transfer Request and the Model object, the Transfer Request parameters values override the Model parameter values.

About Models

Security

Security objects provide added security for user access and for TLS and SSH file transfers. Security objects include:

  • For user access security:
    • User definitions and Profiles
  • For file transfers:
    • Certificates and keys
    • Network Profiles
    • TLS and SSH Security Profiles

See Security guide for further information.

Site

Every file exchange involves a sending and receiving partner. Site objects represent these partners.

A Site object can represent a Local or Remote partner.

Typically the Local Site object defines characteristics of the machine that hosts the Gateway.

The Remote Site object defines the following parameters for the remote partner:

  • Protocol used for exchanges with this partner
  • Role: responder or initiator, file sender or receiver
  • Connection information (max number of connections to / from this Site, and so on)
  • Network type used for connections (TCP/IP, LU 6.2)
  • Network security information
  • Protocol-specific parameters

Once you have created a Site you can select the Site as a transfer partner in a Transfer Request.

If a Remote Site definition does not exist, when processing a Transfer Request, Gateway can create a dynamic Site.

About Site objects

Transfer Request

To create a transfer with Gateway you create a Transfer Request.

A Transfer Request defines the set of parameters required to submit a file transfer:

  • Name of file to transfer
  • Physical file attributes
  • Compression or encryption options
  • Behavior in case of transfer failure
  • Transfer scheduling, restarting and routing

A Transfer Request can collect and reuse the parameters that you may have defined in other Gateway objects, such as the Model, the Remote Site and the Application.

If you set values for the same parameters in both the Transfer Request and other objects, the Transfer Request parameter values override the other object parameter values.

Submitting Transfers

Groups

Most Gateway objects have a field called "group", that can be used as a namespace. Groups apply in a number of use cases:

  • Mandatory: an application object used for an inbound transfer must be in the same group as its origin site object
  • Mandatory: an application object used for an outbound transfer must be in the same group as its destination site object
  • It is possible to give the same name to different applications, on condition they belong to different groups
  • For ssh key objects, when performing authentication, a site can be used to represent a remote peer presenting distinct keys to authenticate with Gateway's SFTP server. In this case, all partners key can be grouped and the site having the protocol identifier equal to that peer login name would point to that group via the 'remote_public_key_group' attribute.

Related topics

Overview: File Transfers and Transfer Requests

Submitting Transfers

About Virtual File Directories

Parameters (Applications and Models)

Monitoring Transfers

Links to documentation set for Axway Gateway 6.17.3:

Related Links