Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
Installation Guide
This installation guide explains how to install and configure the WebSphere MQ Interface for Alliance Access (MQSA). The document also describes how to add and remove MQSA patches. This document is for programmers, system administrators, and support staff who implement a message-exchange interface. Familiarity with the basics of Alliance Access and WebSphere MQ is a prerequisite for readers of this document.
30 September 2011
Table of Contents
. Preface .............................................................................................................................................................................3 1 Introduction ....................................................................................................................................................... 4
1.1 1.2 1.3 MQSA Product Overview ......................................................................................................................... 4 Supported Platforms ................................................................................................................................. 4 Overview of Installation Procedure ......................................................................................................... 4
Installation Guide
Preface
Preface
Purpose of this document This document explains how to install and configure the WebSphere MQ Interface for Alliance Access (referred to in this document simply as MQSA). It also includes information about upgrading MQSA, and adding and removing MQSA patches. Read this document in conjunction with Alliance Access guides and WebSphere MQ guides, before installing or upgrading MQSA. Intended audience This document is intended for programmers, system administrators, and support staff who are responsible for implementing a message-exchange interface. It is assumed that the reader of this document is familiar with the basics of Alliance Access and WebSphere MQ to install, configure, maintain, and operate the MQSA software. Related documentation This document references the following documents: WebSphere MQ Interface Release Letter WebSphere MQ Interface User Guide Alliance Access Installation and Administration Guide Alliance Workstation Installation and Administration Guide
30 September 2011
1
1.1
Introduction
MQSA Product Overview
What is WebSphere MQ Interface for Alliance Access? The WebSphere MQ Interface for Alliance Access software application (referred to in this document as MQSA) provides a reliable communication between financial applications and Alliance Access through IBM WebSphere MQ. It enables SWIFT messages to be exchanged between Alliance Access and other financial applications. MQSA is a product of the Alliance Access Developers Toolkit (referred to in this document as ADK). It accesses message-queuing services by using ADK functions to communicate with Alliance Access and WebSphere MQ functions. Alliance Access and MQSA Alliance Access enables you to build components that can be fully integrated using the ADK. MQSA is composed of two such components, SMQS and SMQA. The SMQS component runs on the same host as the Alliance Access servers and handles the messaging between Alliance Access and WebSphere MQ. SMQA is the GUI component and runs on Alliance Workstation.
1.2
Supported Platforms
Alliance Access MQSA is available for Alliance Access running on the operating systems specified in the WebSphere MQ Interface Release Letter. MQSA graphical user interface The MQSA graphical user interface (GUI) runs on Alliance Workstation, which runs on the operating systems specified in the WebSphere MQ Interface Release Letter.
1.3
Installation Guide
Introduction
Upgrading MQSA If you are upgrading MQSA, then see the WebSphere MQ Interface Release Letter for details of valid upgrade paths. Note You can upgrade from MQSA 6.0 or MQSA 6.3 to MQSA 7.0 in a UNIX environment. On Windows, a fresh installation of MQSA 7.0 is required. Switching between server and client versions It is sometimes necessary to switch between the MQSA Server and the MQSA Client versions. This is explained in "Choosing WebSphere MQ Server or WebSphere MQ Client" on page 21. Windows and UNIX The procedure for installing and registering a component is similar on Windows and UNIX. Therefore, this document shows screenshots from only the Windows platform - the application has a similar interface on UNIX.
30 September 2011
2
2.1
Installation Guide
the environment variable TMPDIR if it is defined the default value /tmp on UNIX the default value C:\temp on Windows. Back-up Before installing MQSA, back up Alliance Access fully (database and software). See the appropriate Installation and Administration Guide for your system.
2.2
When installing MQSA, the system administrator must decide whether to use the WebSphere MQ Server version or the WebSphere MQ Client version. The installation media name for SMQS is suffixed by -S for the server version, and -C for the client version. For patch media, the media name contains an indication of the patch, where <mmnn> refers to the patch level being added, as shown in the following table:
Installation media for patches Platform AIX AIX AIX SunOS SunOS SunOS Win32
30 September 2011
Installation Guide
3
3.1
30 September 2011
3.2
Verify the success of the installation, by using the contents of the adk_install window to track progress. If verification fails, then see Appendix A, "Recovering from an Installation Failure" on page 24.
7. 8.
After successful installation, clear the Input Device field and select the Register option button under Services. Start the registration by clicking OK . Verify the success of the registration, by using the contents of the adk_install window to track progress. If verification fails, then see Appendix A, "Recovering from an Installation Failure" on page 24.
The SMQS component is now installed and registered. Warning Do not quit the installation utility yet. You must first install the graphical application (SMQA), as described in "Installation and Registration of SMQA" on page 10.
3.3
10
3.
In the Input device field, type the path of the installation files. For example: For AIX, type the following: /tmp/SMQAMediumAIX For Windows, type the following: C:\Temp\SMQAMediumWin32
4. 5. 6.
In the Cipher field, type the installation secret code (provided in the WebSphere MQ Interface Release Letter). Start the installation by clicking
OK
Verify the success of the installation, by using the contents of the adk_install window to track progress. If verification fails, then see Appendix A, "Recovering from an Installation Failure" on page 24.
7. 8.
After successful installation, clear the Input Device field and select the Register option button under Services. Start the registration by clicking OK . Verify the success of the registration, by using the contents of the adk_install window to track progress. If verification fails, then see Appendix A, "Recovering from an Installation Failure" on page 24. The SMQA component is now installed and registered.
9.
Click
Quit
3.4
30 September 2011
11
4. 5. 6.
In the Component field, type SMQA. Select the Install component option button. In the Input device field, type the path of the installation files (note that the path must not contain spaces, and must not refer to a network drive). For example: C:\Temp\SMQAMediumWin32
7. 8. 9.
In the Cipher field, type the installation secret code (provided in the WebSphere MQ Interface Release Letter). Start the installation by clicking Click
Quit OK
12
Installation Guide
4
4.1
SMQS-specific If the SMQS exit library being used was supplied by an external vendor, then it must be safestored. In such cases, it is imperative that you contact the vendor to make sure that the version of the exit library is compatible with the latest version of MQSA. The exit library in previous releases has one of the following names, depending on the platform used: libSMQSExits.a (for AIX) libSMQSExits.so (for Oracle Solaris) SMQSExits.dll (for Windows) Since release 6.2, the exit libraries are standardised across all platforms and are named as follows: libSMQSExits.a (for AIX) libSMQSExits.so (for Oracle Solaris) libSMQSExits.dll (for Windows) Note The name of the exit library on Windows has changed and must therefore be renamed to libSMQSExits.dll if you restore a previous (externally supplied) library from earlier than release 6.2.
The location of the exit library is as follows: On UNIX, the library is in the $ALLIANCE/SMQS/bin/$ARCH directory, where $ARCH refers to the platform on which the Alliance Access servers are running. On Windows, the library is located in the %ALLIANCE%\SMQS\bin\%ARCH% folder.
30 September 2011
13
SMQA-specific On Alliance Workstation, the SMQA configuration file, SMQA.dat, must be backed up prior to the upgrade. This file is located in %ALLIANCE%\SMQA\data.
4.2
.
Installation Guide
14
8.
Verify the success of the installation, by using the contents of the adk_install window to track progress. If verification fails, then see Appendix A, "Recovering from an Installation Failure" on page 24.
9.
Then clear the Input device field and click the Register option button followed by
OK
10. Verify the success of the registration, by using the contents of the adk_install window to track progress. If verification fails, then see Appendix A, "Recovering from an Installation Failure" on page 24. Warning After you have successfully verified the registration, do not stop the adk_install utility. Perform the same actions to upgrade the SMQA component, as explained in the following steps.
11. In the adk_install window, enter the component name (SMQA), the input device name (such as /tmp/SMQAMediumAIX or C:\temp\SMQAMediumWin32), and the cipher key (see the WebSphere MQ Interface Release Letter). 12. Select the Upgrade component option button, and start the installation by clicking
OK
13. Verify the success of the upgrade, by using the contents of the adk_install window to track progress. If verification fails, then see Appendix A, "Recovering from an Installation Failure" on page 24. 14. Then clear the Input device field and click the Register option button followed by
OK
15. Verify the success of the registration, by using the contents of the adk_install window to track progress. If verification fails, then see Appendix A, "Recovering from an Installation Failure" on page 24. MQSA is now upgraded. 16. Click
Quit
4.3
30 September 2011
15
4.4
5. 6.
Verify the success of the installation, by using the contents of the adk_install window to track progress. If verification fails, then re-check all required pre-requisites and try the process again. If the installation still fails, then make a note of the exact failure reported and call Support for assistance.
7.
Click
Quit
Note
It is not necessary to register SMQA on Alliance Workstation. The installation of SMQA on Alliance Workstation must be performed at the same time as the SMQA is upgraded on the Alliance Access server. Otherwise a version failure occurs and SMQA cannot be started.
4.5
16
Installation Guide
Location of SMQA configuration file For reference purposes, the following table outlines the location of the SMQA configuration file in several releases:
Release 6.0 6.2, and 6.3 7.0
%ALLIANCE%\SMQA\data C:\Documents and Settings\<username>\Application Data\SWIFT \SWIFTAlliance Workstation\<instance configuration name>\SMQA\data C:\Users\<username>\AppData\Roaming\SWIFT\SWIFTAlliance Workstation\<instance configuration name>\SMQA\data
Location
30 September 2011
17
5.1
Adding a Patch
Validity Adding patches to the SMQS component must be done on the Alliance Access server. Adding patches to the SMQA component must be done on the Alliance Access server and on each Alliance workstation that has SMQA installed. To add a patch: 1. Remove any existing MQSA patches that are already installed. For details, see "Removing a Patch" on page 19. 2. 3. Copy the correct media. For details, see "Installation media for patches" on page 7 Start the adk_install utility, as follows: On Windows: a. Start the Installation application by clicking Start/Programs/Alliance Access/ Installation. b. In the Installation Application - Alliance window, double-click Command Prompt. c. At the command prompt, enter the following commands in the order shown: cd /D %ALLIANCE%\INA\bin\win32 adk_install On UNIX: a. Log on to the system as the Alliance administrator (in most cases the administrator is all_adm). b. From the System Administration application, open an Xterm window. c. Invoke the ADK installation utility, by entering the following commands in the order shown: cd $ALLIANCE/INA/bin/$ARCH ./adk_install STANDALONE
18
Installation Guide
The Alliance Access Set-up program starts, and shows the following dialog box:
4. 5. 6.
In the Component field, type the name of the patch to be added (SMQA or SMQS). Select the Add patch option button under Software. In the Input device field, type the path and filename of the patch media (note the path must not contain spaces). For example, for an SMQA patch for AIX: /tmp/SMQAMediumAIXPatch1234.
7. 8.
In the Cipher field, type the installation secret code (provided in the WebSphere MQ Interface Release Letter). Start the installation by clicking
OK
5.2
Removing a Patch
Validity Removing patches from the SMQS component must be done on the Alliance Access server. Removing patches from the SMQA component must be done on the Alliance Access server and for each Alliance workstation that has SMQA installed. To remove a patch: 1. Perform one of the following procedures: On Windows: a. Start the Installation application by clicking Start/Programs/Alliance Access/ Installation. b. In the Installation Application - Alliance window, double-click Command Prompt. c. At the command prompt, start adk_install by entering the following commands in the order shown: cd /D %ALLIANCE%\INA\bin\win32 adk_install
30 September 2011
19
On UNIX: a. Log on to the system as the Alliance administrator (in most cases the administrator is all_adm). b. From the System Administration application, open an Xterm window. c. Invoke the ADK installation utility, by entering the following commands in the order shown: cd $ALLIANCE/INA/bin/$ARCH ./adk_install STANDALONE The Alliance Access Set-up program starts, and shows the following dialog box:
2. 3. 4.
In the Component field, type the name of the patch to be removed (SMQA or SMQS). Select the Remove patch option button under Software. Start the removal by clicking
OK
20
Installation Guide
6
6.1
6.2
30 September 2011
21
5.
22
Installation Guide
30 September 2011
23
Appendix A
24
Installation Guide
Legal Notices
Legal Notices
Copyright SWIFT 2011. All rights reserved. You may copy this publication within your organisation. Any such copy must include these legal notices. Confidentiality This publication may contain SWIFT or third-party confidential information. Do not disclose this publication outside your organisation without the prior written consent of SWIFT. Disclaimer SWIFT supplies this publication for information purposes only. The information in this publication may change from time to time. You must always refer to the latest available version on www.swift.com. Translations The English version of SWIFT documentation is the only official version. Trademarks SWIFT is the trade name of S.W.I.F.T. SCRL. The following are registered trademarks of SWIFT: SWIFT, the SWIFT logo, the Standards Forum logo, 3SKey, Innotribe, Sibos, SWIFTNet, SWIFTReady, and Accord. Other product, service, or company names in this publication are trade names, trademarks, or registered trademarks of their respective owners.
30 September 2011
25