Install the SWIFTNet Remote API (RA)

Edit online

About this task

You need to install the SWIFTNet Remote API on the machine on which the SWIFTNet Server will be installed. This is the software distributed by SWIFT, the API that the SWIFTNet Server uses to connect to the SWIFTNet SAG/SNL instance to link into a SAG. Remote API is software supplied by SWIFT that establishes a communication link with the RA Host adapter component of the SWIFTAlliance Gateway (SAG), either from a SWIFTNet application existing on a remote machine or from a SWIFTNet application existing on the machine where SAG is installed. RA offers two sets of APIs: SWIFTNet Link-specific APIs and SWIFTAlliance Gateway-specific APIs.

Before you install the SWIFTNet Remote API (RA), verify that you have performed the following:

  • The SWIFTAlliance Gateway software is installed on the machine you wish to connect, with the RAHA option checked in the licensing screen. Otherwise you will only be able to install the RA locally on the SAG system.
  • You know the host name or IP address of the machine on which the SWIFTAlliance Gateway software is installed.
  • You know the port number used by SAG to communicate with its remote applications. This is the port number specified during the SAG installation, and its default value is 48002.
  • You have 300MB of free disk space as working space is available on the machine where you will install the RA software.
  • The patch level requirements in the Release Letter from SWIFT are respected. The same patch requirements apply for both the machines on which RA and/or SAG are installed. This is particularly important for Java™ patches.

The following requirements apply to UNIX systems only:

  • The Remote API installer is graphical and should be run using a dedicated UNIX X display terminal. If this is not possible or desirable, run the installer using a PC based X server such as Exceed, PC-Xware, XManager or Reflection-X. It is important that the PC X server is configured to run in single window mode and uses XDM to start a UNIX desktop session such as CDE. Failure to comply with these requirements may cause the installer not to display correctly. The method used to configure it in single window depends on your product. If you are using Exceed software, select Window Mode in the Xconfig module and toggle the mode from Multiple to Single.
  • The home directory must have at least 60 MB of free space.
  • On AIX® platforms, if the disk space requirements for the temporary files for the install program cannot be satisfied, the installer option -is:tempdir <TMPDIR> can be used to specify an alternate temporary directory.

Complete the following steps to install the RA:

Note: See the SWIFT Remote Developers Toolkit Installation Guide for complete installation instructions.

Procedure

  1. Install the remote API on the machine where you will install SWIFTNet Server.
  2. Configure the RA to point to the SAG instance you will be accessing, or if the RA is already configured, verify that it points to the correct SAG instance.
  3. If you are installing on the Windows operating system, add SYSTEM to the Security settings, allow SYSTEM Full Control and select Allow inheritable permissions from parent to propagate to this object. See the documentation for the SWIFTNet Remote API for more information.
    1. Right-click and select Properties on <SWIFT RA API installdir>.
    2. Select the Security tab.
    3. Click Add to and select SYSTEM.
    4. Allow Full Control to SYSTEM.
    5. Select the Allow inheritable permissions from parent to propagate this object option.
    6. To confirm, navigate to the <applicationinstalldir\SWIFTAlliance\RA\lib> directory, and right-click and select Properties.
    7. Select the Security tab.
    8. Verify that SYSTEM has Full Control permissions for the <applicationinstalldir\SWIFTAlliance\RA\lib> directory.
  4. If you are installing on a Windows operating system, following the SWIFT RA installation, you will need to set the PATH system environment variables: 
    
PATH : append <Swift RA API installdir>\bin;<Swift RA API installdir>\lib
SWNET_HOME : <Swift RA API installdir>
SWNET_CFG_PATH : <Swift RA API installdir>\Ra1\cfg;