Solution Overview

AMPLIFY Managed File Transfer as seen by the end-users

The diagram below illustrates the added value that we are offering to the end-users

  1. Application and business managers are empowered to…
  2. …create compliant flows by filling in simple forms...
    (the forms are supported by the company’s IT Service Management (ITSM) platform - either custom-built or vendor-provided, such as ServiceNow)
  3. ...or design and develop applications.
    (the applications are based on the APIs provided by AMPLIFY Managed File Transfer)
  4. Data is delivered safely between partners and applications, following the business rules set by the users.

The tools of the solution

The diagram below represents the layers between the Business users of the ITSM solution (mainly the Application managers) and the data flowing from source to destination.

  1. The users (Business managers, Application owners, Architects, Application developers) ...
  2. ... specify flows using the ITSM forms; or design and develop apps based on AMPLIFY Managed File Transfer's APIs.
  3. Policy Studio, API Gateway and API Manager are the tools the IT team use to make the APIs available to the layers above.
    The rest of this documentation explains how to make that possible.
  4. APIs are the building blocks of the solution
  5. The MFT infrastructure (Managed File Transfer) is typically comprising Axway Central Governance, connected to Axway Secure Transport and Axway Transfer CFT. Central Governance holds the flow configuration. Once created in Central Governance, the configuration can be deployed in the Transfer products (CFT or SecureTransport).

  6. Data is delivered safely between partners and applications, following the business rules set by the users
  7. Axway provides an environment for managing the process, for example tools for analytics

One example of implementing the solution

Using AMPLIFY Managed File Transfer, a company can create a portal empowering end users to create their flows. Very few questions need be asked to the end users. Technical information will be automatically determined by the portal, depending o:

  • the end user's answers, and
  • the rules set in the portal.

An example of the interface of such a portal could look like this:

The sequence diagram representing the interactions between the user, the portal and the APIs could be as follows:

Focus on the API Management layer

To speed up the configuration of the API Management layer, some artifacts (API Management pre-configurations) are provided by Axway:

Following the flow of data from left to right:

  1. Business Flow message: these are the business values filled in by the user

  2. Pattern Input message: the intermediate format to limit the flow configuration complexity

  3. CG Flow configuration message: the input format expected by CG with a large number of fields

It's easier to comprehend the design logic of the solution if we follow it upstream, from right to left:

  • To create a flow in Central Governance using its API, Central Governance (CG) requires a specific body format (CG Flow configuration in the previous diagram). The message body must contain all parameters necessary to describe the flow. The number of parameters can be huge.
  • To simplify the flows, Axway provides certain patterns (the most common ones). When a pattern is set, some parameters can be fixed and fulfilled with default values. This defines an intermediate format, with less parameters (Pattern input message in the previous diagram).
  • Finally the simplest Business Flow message is filled in by the end-user

Samples and Product artifacts

The diagram below points out which of the artifacts delivered with AMPLIFY Managed File Transfer require customizing:

  1. A sample Model map is provided with the delivery. You can customize this map to determine which values the end-users should specify. (see how: Creation of a new business flow API )
    This Model map exposes the simplified Business Flow message to the end-user. Some fields from the Pattern Input message are determined using default values.
  2. Pattern maps are provided by Axway for some patterns. 
    Their function is to mediate the Pattern input message into the CG Flow configuration message.

    Pattern maps must not be modified by the customers, otherwise support cannot be ensured on this part

Available features through REST API :

The AMPLIFY MFT solution provides two sets of REST API :

  • The BusinessAPI containing samples of model maps developed for each model.
  • The PatternAPI containing the technical pattern maps for each model.

The AMPLIFY MFT solution also provides REST API for three Central Governance resources :

For each  of those REST API resources the following operations are available :

  1. CREATE : to create a new resource based on a model, this function uses the HTTP POST method.
  2. READ : to read information from one or more resources, this function uses the HTTP GET method
    1. GET one specific object based on its businessId
    2. GET a filtered list of objects :
  3. UPDATE : to update an existing resource based on a model, this function uses the HTTP PUT method.
  4. DELETE : to delete an existing resource based on its businessId, this function uses the HTTP DELETE method

Definitions of the PatternAPI REST API are available in the form of swagger documentations at the following addresses :

The next chapter explains how to install and configure the customizable artifacts.

Related Links