Integrate with Axway Gateway

Use this integration to have a community in Interchange poll and retrieve files from Axway Gateway. Clear-text files are retrieved via HTTP. Upon receipt, Interchange delivers the files to back-end integration, just as it does for any message received from a partner.

From the Interchange perspective, this integration is set up almost like a typical trading relationship between a community and partners who exchange e-commerce business messages. But in this case, Interchange is not exchanging messages, only retrieving files from a queue within Axway Gateway. The retrieved files are not packaged, encrypted or compressed. Interchange sends the retrieved files to back-end integration without further processing. Interchange does not send Gateway receipts or any other messages.

Once Interchange has retrieved a file, Axway Gateway marks its copy of the file as processed successfully.

Axway Gateway configuration

Use this procedure to enable Axway Gateway to integrate with Interchange.

  1. Set up HTTP virtual file directories (VFDs) or real file directories (RFDs) for users who represent the instances of Interchange. One VFD or RFD is required for each user. Interchange polls the VFD for files to retrieve. See the Axway Gateway documentation for information on how to add VFDs and RFDs.
  2. Edit the template.html file to include only the following lines:
  3. <XFER_LIST>
      <REAL_FILE>
      <FILE_INFO>
       <FNAME>@fname@</FNAME>
       <SIZE>@SIZE@</SIZE>
       <DATE>@DATE@</DATE>
      </FILE_INFO>
     </REAL_FILE>
     <XFER_AVAIL>
      <FILE_INFO>
       <FNAME>@FNAME@?local_ident=@LOCAL_ID@&%I</FNAME>
       <SIZE>@SIZE@</SIZE>
       <DATE>@DATE@</DATE>
      </FILE_INFO>
     </XFER_AVAIL>
    </XFER_LIST>

  4. Template.html is at <install directory>\samples\web\templates.
  5. Including this code directs Axway Gateway to generate a list of files available to consume. Each listed file is separated by a line feed.
  6. The template.html file is the default template. In a production environment, the default template is left in place. A special template file, edited as described here, is created. The Axway Gateway administrator assigns the special template to the Interchange users who are retrieving files from Axway Gateway.
  7. For Interchange to connect with a username and password, web authentication must be set instead of CGI (common gateway interface) in Axway Gateway.
  8. Select Session > Local and right-click, then select Configure to open the configuration dialog window. Select Connectivity > Internet protocols > HTTP and click Options. Under server identification, select Web in the Method field drop-down list.
  9. If Interchange is to connect via HTTPS (HTTP over SSL) rather than HTTP, run the following sample scripts in this order:
    1. cert.bat
    2. sprof.bat
    3. netprof.bat
  10. The Axway Gateway server must be running when you execute the scripts. The scripts are located at <install directory>\samples\tls\case1.
  11. The scripts import sample certificates and create two security profiles and many network profiles.
  12. Add a port specification, using 6331 as the port and SPROF_IN as the Transport Layer Security (TLS) profile. The netprof.bat script creates port 6331; the sprof.bat script creates SPROF_IN.
  13. Restart the Axway Gateway server for the changes to take effect.
Note   If the security options are disabled when creating the port specification, return to the configuration dialog window and change the SecureRelay access policy field to Through SecureRelay and directly. You must delete all existing port specifications to do this.
  1. Changing settings for dynamic server processes is recommended.
  2. Select Session > Local and right-click, then select Configure to open the configuration dialog window. Select Connectivity > Internet protocols > HTTP and click Options, then click Advanced. Under dynamic server processes, set these values:
    • No. processes min 15
    • No. processes max 30
    • Balance ratio 25
  3. Provide necessary information to the Interchange administrator. This can include:
    • The URL for connecting to Axway Gateway. Each URL is unique per partner. The following are examples of URLs:
      • HTTP: http://<host>:<port>/<user1>/transfer/<partner1>/
      • HTTPS: https://<host>:<port>/<user2>/transfer/<partner2>/
      • Where:
      • <host> is the fully qualified domain name or IP address of the computer running Axway Gateway.
      • <port> is the number of the port Axway Gateway listens for connections from Interchange.
    • If HTTPS, provide a file containing a certificate and public key. Interchange must import and trust this certificate.
    • The username and password that Interchange must use to connect.

Interchange configuration

Use this procedure to enable Interchange to integrate with Axway Gateway.

  1. Add and configure a community profile. See Add a community.
  2. This can be the same profile as the one used to exchange e-commerce messages with partners other than Axway Gateway. If you use the same profile, make sure the delivery exchange added in step 3 is not the default. The default should be the exchange you want partners to use for sending e-commerce messages to your community.
  3. Add a partner profile to represent Axway Gateway. See Add a partner to a community.
  4. Adding this partner is not required, but doing so makes it easier to use Message Tracker to search for messages retrieved from Axway Gateway. Use a partner name you can identify with Axway Gateway.
  5. When adding the profile, only a partner name and contact name are needed. Associate the profile with your community. No other setup is required, including no delivery exchange or certificate.
  6. On the community profile summary page, click Delivery exchange in the navigation graphic at the top of the page. On the Pick a delivery exchange page, click Add a delivery exchange to open the Delivery exchange wizard.
  7. Select No packaging and click Next.
  8. For the From address, select Specify the address. Always use a fixed address. Click Pick party and select the Axway Gateway partner as the sender. Click Next.
  9. If you did not add a partner profile in step 2, select your community as the sender.
  10. For the To address, select Specify the address. Always use a fixed address. Click Pick party and select your community as the receiver. Click Next.
  11. Select HTTP and click Next. The Axway Gateway HTTP interface delivery exchange is selected by default. Click Next to open the HTTP configuration page.
  12. Complete the fields and click  Finish.
  13. URL
    • The URL for connecting to the server.
    • If Encode and Decode buttons display, click Encode if the URL contains spaces or non-alphanumeric characters to encode the characters. Click Decode to reverse the transformation. For example, if you enter http://foo.com/foo= bar and click Encode, the URL becomes http://foo.com/foo%3D%20%20bar .
  14. Clients must use SSL to connect to this server
    • Select this to have Secure Sockets Layer protocol in use during connections. The server presents a certificate for verification. To do this, a certificate in a profile must be designated as the SSL certificate. The server must support SSL. If this is not selected, connections are not encrypted.
    • Enable host name verification
    • If selected, Interchange compares the name of the SSL server to the name in the server's certificate to ensure they are the same.
    • If you use DMZ nodes, it is recommended that you do not select this. If host name verification is enabled, messages may fail because the client is connecting to the DMZ node and not to the Interchange server. This is not applicable to integration exchanges.
    • This server requires a username and password
    • If selected, type a username and password to connect to the server.

If using SSL, import to your community the certificate and public key being used by Axway Gateway.

Related topics

Related Links