Connectivity - Alliance 7.0 - FileAct Support in SWIFTNet Release 7.0 - April 2011 - IP - Alliance - Interfaces - Fileact - Support - in - Swiftnet - Rel - 7 PDF
Connectivity - Alliance 7.0 - FileAct Support in SWIFTNet Release 7.0 - April 2011 - IP - Alliance - Interfaces - Fileact - Support - in - Swiftnet - Rel - 7 PDF
Alliance 7.0
Alliance Interfaces
FileAct support in SWIFTNet Release 7.0
April 2011
Table of Contents
Preface .................................................................................................................................................3 1 2 Introduction ...............................................................................................................................4 Portfolio FileAct Support .........................................................................................................6
2.1 Alliance Gateway ....................................................................................................................6 2.1.1 Overview ............................................................................................................................. 6 2.1.2 Alliance WebStation Support .............................................................................................. 7 2.1.3 Qualification Status ............................................................................................................. 7 Alliance Access .......................................................................................................................8 2.2.1 Overview ............................................................................................................................. 8 2.2.2 Short Term Evolution .......................................................................................................... 9 2.2.3 Known limitations.............................................................................................................. 10 2.2.4 Qualification Status ........................................................................................................... 10 Alliance Entry ........................................................................................................................10 2.3.1 Overview ........................................................................................................................... 10 2.3.2 Qualification Status ........................................................................................................... 11 Alliance Integrator .................................................................................................................11
2.2
2.3
2.4
3 4
4.4
Preface
Purpose of this document
This document describes the support of FileAct in SWIFTNet release 7.0 on the Alliance portfolio. In particular, it covers the impact of the introduction of SWIFT's Relationship Management Application (RMA) for FileAct in SWIFTNet 7.0. This document should be read together with the "RMA for SWIFTNet 7.0: Frequently asked questions " document. An important driver for this document is the fact that RMA and Application Service Profile (ASP) have become optional requirements in the FileAct 7.0 Interface qualification. This impacts how existing FileAct applications connected through the Alliance Gateway can evolve in release 7.0. The purpose of this document is to provide sufficient information for an analyst to understand how to strategically support FileAct in the future with Alliance portfolio. This document also provides high level information about the impact of keeping the current configuration or of migrating FileAct flows from Alliance Gateway to Alliance Access/Entry. It is not the purpose of this document to provide detailed technical information on the migration. SWIFT plans to provide dedicated technical information for this purpose.
Intended audience
This document is intended for business analysts of SWIFT customers, allowing them to assess the impact of the evolution of FileAct on their SWIFT infrastructure.
Related documentation
Alliance Gateway File Transfer Interface Guide SWIFTNet 7.0 release overview Alliance 7.0 release overview RMA for FileAct in SCORE RMA for SWIFTNet 7.0: Frequently asked questions
Introduction
This section provides a high level description of FileAct main evolution, both in terms of SWIFTNet 7.0 features and in terms of Alliance 7.0 portfolio evolution. This section helps the customer assess how its current FileAct infrastructure is affected by this evolution, and why this infrastructure might need to be reviewed to support FileAct flows in the future.
1 2
RMA for FileAct is used by the SCORE service and RMA filtering will be mandatory by November 2012. Available as of May 2011. 3 Available as of September 2011 Alliance Access 7.0 and Entry 7.0, on the Web Platform only.
Qualification requirements
The qualification of messaging interfaces using InterAct or FileAct services becomes mandatory with Release 7.0. This qualification ensures that the interface or application (provided by SWIFT, third party vendors or customers) properly implements the new SWIFTNet 7.0 InterAct and FileAct features. An application, whether developed by a vendor or in-house by the customer, is considered as a messaging interface, when it uses Alliance Gateway RAHA or MQHA to communicate with SWIFTNet. The implementation (and qualification) of SWIFTNet 7.0 RMA and ASP features for InterAct and FileAct is optional. However, an interface or application qualified without RMA/ASP support can only be used in the context of InterAct and FileAct flows associated to SWIFTNet services not subject to RMA filtering.
Migration Option
This important evolution of FileAct with Release 7.0, both in terms of SWIFTNet functionality and in terms of portfolio support, impacts customers who have more choices to integrate FileAct flows and who may need to revisit their current architecture to support RMA filtering on FileAct flows. The purpose of the remaining sections of this document is to: Explain with more details how FileAct is supported over the whole portfolio, including where RMA/ASP support is provided. Help the customer identify, based on current FileAct usage, whether a migration is needed. Provide a high level explanation of the identified migration scenarios.
2
2.1
2.1.1
Alliance Gateway
Overview
Alliance Gateway supports different modes to exchange files over SWIFTNet depending on the way the applications use its FileAct features:
WebStation 7.0
FT GUI
B/Os
RA Client MQ Client
RAHA
MQHA
FTA
File Drop
FTI
Gateway 7.0
As a communication interface In this mode, applications use the Host Adapters of Alliance Gateway (RAHA and MQHA) to exchange files over SWIFTNet. In this situation, the FileAct protocol and features are managed by these applications, not by Alliance Gateway, which just acts as a communication interface. As a FileAct messaging interface. In this mode, applications use the Gateway File Transfer interface to ease FileAct exchanges, as available since earlier releases. File Transfer Adapter (FTA) When a file becomes available in a predefined directory on Gateway (potentially one per correspondent), FTA handles the entire FileAct exchange automatically; including any retransmission attempts and file signature verifications. It also provides receipt acknowledgements and, acting as a download server, is able to respond to download requests. Besides the simple "File Drop" mechanism for which all routing related information is pre-defined within Gateway, a second working mode is supported which allows an application to specify for each individual file transfer the routing information that must be used. This is done by means of companion parameter files. File Transfer Integrated (FTI) FTI supports command line scripting with an optional parameter file to invoke a number of integrated FileAct commands. FTI allows your business applications to control specific retransmission logic or file prioritisation. Additionally, FTI is able to generate file download requests.
2.1.2
2.1.3
Qualification Status
Release 7.0 impacts the evolution of the applications supporting FileAct on Gateway and WebStation, for the following reasons: Advanced SWIFTNet 7.0 FileAct features may not be fully supported. Qualification for FileAct messaging interfaces is mandatory as of release 7.0 Support for RMA filtering and ASP are optional items of the FileAct qualification As a consequence, release 7.0 impact on WebStation and Gateway is: For WebStation 7.0 FT GUI is still available but enters maintenance mode as of release 7.0. FT GUI will not be enhanced further and some advanced features of SWIFTNet FileAct 7.0 are not supported. FT GUI does not support RMA filtering and ASP. As FT GUI does not provide RMA support, it can only be used for FileAct services that do not require RMA filtering. For Gateway 7.0 Gateway is a communication interface often residing in a DMZ. As is already the case with FIN, Gateway does not provide RMA support for InterAct and FileAct. As a consequence: FTA and FTI are still available on Gateway 7.0. FTA/FTI are qualified as FileAct messaging interfaces on release 7.0, but without support for RMA filtering or ASP. FTA and FTI also enter maintenance mode as of release 7.0, with no plans for further functional enhancements. Back-office applications or messaging interfaces can continue to communicate with Gateway 7.0 over RAHA or MQHA, but will need to qualify as a FileAct interface as of Release 7.0. Although optional, if these applications can potentially be used in the context of a FileAct service that mandates RMA, these applications will also need to implement RMA filtering and ASP support, and qualify this RMA/ASP functionality. This FileAct evolution for Gateway 7.0 and WebStation 7.0 is summarised in the diagram below:
R7 qualif ication
RA Client MQ Client
No RMA support
RAHA
MQHA
Maintenance (No RMA support)
B/Os
FTA FTI
File Drop
Gateway 7.0
In Conclusion: 1. An application using FileAct services on top of RAHA or MQHA must qualify as a FileAct interface for 7.0, irrespective of RMA usage. The decision by the vendor to include RMA/ASP support in the qualification is linked to the use of the application in the context of a FileAct service mandating RMA filtering, in manyto-many environments. In that case, RMA/ASP qualification becomes mandatory as well. An application can continue to use FTA/FTI only for FileAct services that do not mandate RMA and ASP. An integration based on FTA/FTI must therefore ensure that no RMA support will be needed in the foreseeable future. FT GUI can only be used for manual usage of FileAct services not mandating RMA filtering.
2.
3.
2.2
2.2.1
Alliance Access
Overview
The diagram below provides a summary view of how FileAct is supported in Access 7.0.
SOAP Client
SOAP
May 2011
B/Os
MQ
Direct FileAct File Adapter
Command Line
Access 7.0
In addition to FIN RMA support, Alliance Access 7.0 provides RMA filtering and ASP support for InterAct and FileAct services. By integrating with Access, FileAct flows can now also benefit from Access rich messaging functionality such as advanced routing, auditing, monitoring, etc. Moreover, files do not need to be located in the DMZ as is the case on Gateway, if Gateway is in a DMZ.
With Release 7.0, Access FileAct support, introduced on Release 6.3, continues to evolve: For back-office integration, the FileAct support already provided by the File Adapter on release 6.3 is complemented with FileAct support over the MQ host adapter. In this mode, on top of the payload file, the back-office application provides the file transfer parameters using the XMLv2 format (as already used for InterAct traffic). File Transfer adapter The File Transfer adapter requires two separate files. The XMLv2 file containing the details of the FileAct transaction, and the actual payload file. MQ Host adapter The MQ Host adapter supports two operating mode, depending how the payload file is provided. In 'Mixed mode', the details of the FileAct transaction are contained in an MQ message, in XMLv2 format. The payload file is locally present on the Access server, in a configured directory. In 'Full mode', the details of the FileAct transaction are contained in an MQ message, in XMLv2 format. The content of the payload file is also provided as one or more MQ messages, grouped with the initial XMLv2 message. Direct FileAct adapter The Direct FileAct Adapter provides a new way to easily set up file exchanges. It allows business applications to provide only the payload file to Alliance Access with no need to provide the additional FileAct transaction details in XMLv2 format. These FileAct settings are statically defined, in the configuration of a Direct FileAct based Message Partner. This integration method is suitable for simple file exchanges, i.e. with a limited number of correspondents (to limit the number of message partners to handle) and with no dynamic FileAct settings (as FileAct configuration is statically defined in the Message Partner configuration). Direct FileAct is therefore not suitable when dynamic information, such as an 'Enhanced FileAct Header', is required with the file exchange. Command-line tool Access provides limited command-line support for file exchanges. A command-line tool can be used to initiate, on the Access server, a real-time File Get Request. This command-line tool is typically used in customer developed scripts to automate the download of files at a given time.
2.2.2
new function, combined with existing template support, will allow for manual initiation of FileAct exchanges on Access, supporting real-time and store-and-forward modes. Access will also provide a new graphical facility, to manually request the real-time download of files, also coupled with template support. When displaying the message details, a new function will be available to save the content of the File message as a local file. These enhancements, referred to as 'FT GUI' in this document, will be available on Web Platform 7.0 only. This update is planned to be available in September 2011, as a 7.0 functional patch.
2.2.3
Known limitations
The following are known Access 7.0 limitations for FileAct support: Download Server Access 7.0 does not support real-time file get requests, initiated from a SWIFTNet correspondent (i.e. acting as a download server). Real-Time File Get Access 7.0 does not support the initiation of real-time file get request, from a back-office application, over its supported range of adapters (File, MQ and SOAP). The only real-time file get support is currently limited to the command-line tool.
2.2.4
Qualification Status
In conclusion, Alliance Access 7.0 is a fully qualified messaging interface (including FileAct) and can be used for services that will mandate RMA and ASP. Access can be used both for automated and manual FileAct exchanges: Over its whole range of adapters (File, MQ and SOAP) supporting all FileAct features Via an additional adapter, 'Direct FileAct', to support simple FileAct setups And full manual support, on Web Platform 7.0, to manually initiate file exchange, both in real-time and store-and-forward mode.
2.3
2.3.1
Alliance Entry
Overview
The diagram below provides a summary view of how FileAct is supported in Entry 7.0.
B/Os
File Drop
File Adapter
Entry 7.0
Alliance Entry 7.0 also provides FileAct support, including RMA filtering and ASP support for InterAct and FileAct services. The functionality available on Entry 7.0 is similar to Access 7.0: File Transfer adapter The File Transfer adapter supports FileAct. As on Access, it requires two separate files. The XMLv2 file containing the details of the FileAct transaction, and the actual payload file. Manual FileAct support
10
The functional patch planned for September 2011 planned to add manual FileAct support will also be available for Entry 7.0. It will add manual FileAct support to Entry The manual creation facilities of Entry, already available for FIN and InterAct messages, will be enriched to also support manual creation of FileAct messages. This new function, combined with existing template support, will allow for manual initiation of FileAct exchanges on Entry, supporting real-time and store-and-forward modes. Entry will also provide a new graphical facility, to manually request the real-time download of files, also coupled with template support. When displaying the message details, a new function will be available to save the content of the File message as a local file. These new GUI functions, to provide manual FileAct support, are available on the Web Platform 7.0 only.
2.3.2
Qualification Status
In conclusion, Alliance Entry 7.0 is a fully qualified release 7.0 messaging interface (including FileAct support) and can be used for services that will mandate RMA and require ASP. A Alliance Entry 7.0 can be used both for back office integration, via the File Transfer adapter, and manual FileAct exchanges.
2.4
Alliance Integrator
Alliance Integrator supports FileAct and, combined with the RMA filtering capabilities of Alliance Access, represents the ultimate solution to ease the integration of your FileAct flows with SWIFT. Alliance Integrator shields the back-office applications from any future changes in the FileAct protocol and can help migration from Alliance Gateway to Alliance Access to enable RMA filtering. Alliance Integrator provides the following FileAct support: Generate FileAct headers and XMLv2 files Automatically pass and receive files to Alliance Access, using MQHA, SOAP or File Transfer adapter, without any manual intervention required Transform file content into any desired format (record by record), providing enrichment if required Simplify the construction of enhanced file headers; Track the status of the file and even individual records within the file. As shown in the diagram below, the Alliance Integrator functions are primarily available to help back-office applications to integrate with Access, when these applications are not capable to generate the FileAct formats mandated by Access/Entry (i.e. XMLv2 support).
File
XMLv2
B/Os
DATA
2
Items
Integrator
Header XMLv2
DATA
XMLv2
MQ SOAP FILE
Transform
DATA
XMLv2
Access 7.0
The two main integration scenario flows are: 1. The back-office application can generate the payload file, but has no ability to generate the additional FileAct information (in Access XMLv2 format), necessary to initiate the transaction.
11
In this flow, Integrator is used to wrap the existing payload file with the appropriate XMLv2 header information. 2. The back-office application can only provide the various elements that need to be assembled into a file. In this flow, Integrator is used to assemble the various individual elements to generate the payload file (transformation of individual records), possibly generate additional information (like the enhanced FileAct header) and generate the transaction in Access format (using XMLv2).
Note
Integrator can also communicate with Entry 7.0, using the File Transfer adapter for FileAct integration.
In conclusion, Integrator in combination with Access 7.0 (or Entry 7.0) can be used for services that will mandate RMA and require ASP. Alliance Integrator shields the back-office applications and can help in the migration of the FileAct handling from Alliance Gateway to Alliance Access.
12
Recommended Configuration
This section describes the recommended configurations for FileAct support that new customers should consider or that existing customers should consider as a strategic future configuration. This configuration excludes the use of FileAct features in maintenance mode.
B/Os
RA Client MQ Client
RAHA MQHA
Gateway 7.0
Alliance Gateway 7.0 does not provide support for RMA/ASP and is not qualified as a FileAct interface: The RA and MQ Host Adapters provide FileAct support for Back-office integration. Messaging interfaces from 3rd party software vendors, or a customer developed application integrating with Gateway over these Host Adapters must qualify as a FileAct messaging interface. The vendor or customer will decide whether optional RMA/ASP functionality should be implemented and qualified.
SOAP Client
SOAP
May 2011
B/Os
MQ Client
MQ
Direct FileAct
File Drop
Access 7.0
Alliance Access 7.0 is a fully qualified interface, including RMA/ASP FileAct support: Web Platform provides manual FileAct support The File Transfer adapter, SOAP adapter and MQ client adapter provide back-office integration support, with the usage of XMLv2 file for parameterization. The Direct FileAct adapter provides FileAct support, using a simple file drop mode A command-line tool provides support to automate real-time File Get requests.
13
B/Os
File Drop
File Adapter
Entry 7.0
Alliance Entry 7.0 is a fully qualified interface, including RMA/ASP FileAct support: Web Platform provides manual FileAct support The File Transfer adapter provides back-office integration support, with the usage of XMLv2 file for parameterization.
Alliance Integrator
Alliance Integrator is a possible option to further facilitate the integration of back-office applications with Access/Entry 7.0. Alliance Integrator implements Access/Entry FileAct protocol on behalf of the back-office applications and shields these any future changes in the FileAct protocol. Alliance Integrator relies on Access/Entry to enable RMA filtering.
14
4
4.1
Migration Options
Overview
For existing customers who were already using SWIFTNet FileAct services prior to Release 7.0, this section will help them decide what are the available FileAct options after upgrading to Release 7.0. The criteria below help existing customers decide whether to keep their FileAct flow on their current interface or to migrate these flows to a fully qualified release 7.0 FileAct application. Note If currently using a solution based on 7.0 features in maintenance mode, the customer can still use this setup, but should consider evolving to a strategic FileAct application to ensure readiness for future FileAct needs.
Your FileAct interface is Alliance Entry/Access? Yes You can continue to use Alliance Entry/Access. See Alliance Access or Alliance Entry for an overview of the FileAct modes on Entry/Access.
Your FileAct interface is a third party application? Yes You can continue to use your third party FileAct application if it qualifies as release 7.0 FileAct interface that supports RMA and ASP features. See Staying on Gateway for more details. If the application will not support RMA/ASP, it can still be used if the RMA/ASP features are provided by another interface such as Alliance Access. See From Gateway to Access for more details.
No
Your FileAct interface is Alliance Gateway? Yes You can continue to use FTA/FTI on Gateway, in maintenance mode. See Staying on Gateway for more details.
Your FileAct interface is Alliance Entry/Access? Yes You can continue to use Alliance Entry/Access. See Alliance Access or Alliance Entry for an overview of the FileAct modes on Entry/Access.
Your FileAct interface is a third party application? Yes You can continue to use your third party FileAct application. With Release 7.0, the qualification of the FileAct interfaces is mandatory. The implementation and qualification of SWIFTNet 7.0 RMA and ASP features for InterAct and FileAct is optional. See Staying on Gateway for more details.
15
No
No
4.2
2.
These customers, who do not have Access or another SWIFT interface to perform RMA management, must consider how to obtain these RMA authorisations: Either acquire an RMA management interface (such as Alliance RMA) Or possibly, use the services of a Service Bureau to manage these authorisations on their behalf.
Customer B/O
Vendor/Customer Application
Messaging Interface
RA / MQ
Destination
Gateway 7.0
IMPORT
RMA Authorisations
16
4.3
WebStation 7.0
FT GUI
B/Os
RAHA
Interactive Client Manual FileAct Support
Gateway 7.0
SOAP Client
SOAP MQ
Direct FileAct
File Adapter Command Line
May 2011
B/Os
MQ Client
File Drop
Access 7.0
4.3.1
4.3.2
Back-office Integration
This migration can be considered by customers currently using the FileAct features from an application connecting to the Gateway over RAHA or MQHA.
17
In order to avoid the qualification of this application or to avoid implementing RMA/ASP , the application can be migrated to communicate with Access, using either the SOAP or the MQ host adapter : An application using RAHA on the Gateway would migrate to the SOAP adapter on Access. Both adapters imply the use of a programmatic interface (C API for RAHA, WSDL for SOAP). An application using MQHA on the Gateway would migrate to the MQ host adapter on Access, as both adapters rely on the same communication concept (WebSphere MQ).
Customer B/O
Vendor/Customer Application
Messaging Interface
RA / MQ
Destination
Gateway 7.0
-FIN
SOAP / MQ
Destination -MX
-FileAct
Access 7.0
The migration of FileAct flows from Gateway to Access also requires an important re-design of the protocol implemented by the application, with the potential benefit of simplifying the application logic: On Gateway, the application, being a messaging interface, implements the SWIFTNet FileAct protocol, and has to support the various InterAct and FileAct request/response primitives required to implement a file exchange. On Access, the application is shielded from the SWIFTNet FileAct protocol, which is fully implemented by Access SWIFTNet interface. The integration with Access is simpler, compared to Gateway: To send a file, the application only needs to provide to Access the payload file to send, along with the FileAct parameters to be used for the exchange. Once the file has been accepted by Access, the emission to SWIFTNet is handled by Access, relieving the application from implementing the SWIFTNet protocol. When a file is received from SWIFTNet, Access will handle the SWIFTNet FileAct protocol and will eventually make the file available in one of its message partner. The application only interacts with Access to receive the payload file, along with the associated FileAct exchange settings, if needed. In all cases, the application must implement the XMLv2 protocol, which is used to specify the FileAct instructions and the file payload to exchange. In conclusion, when migrating from Gateway RAHA/MQHA to Access SOAP/MQHA: The application, is not considered as a messaging interface, and does not need to qualify as a FileAct messaging interface. The application does not need to implement RMA/ASP functionality. The application must re-design its communication protocol from SWIFTNet primitives to XMLv2.
18
The own BIC destinations, used by the FileAct flows, must be licensed and configured in Access if not yet used for FIN or InterAct.
4.3.3
Customer B/Os
Vendor/Customer Application
File Drop
FTA
Destination
DATA
-FIN
Direct FileAct
Destination -MX
-FileAct
DATA
Access 7.0
In conclusion, when migrating from Gateway FTA, with no companion parameter file, to Access Direct FileAct: The application does not need to qualify as a FileAct messaging interface. The application does not need to implement RMA/ASP functionality. The application can continue to be based on a 'file drop' mechanism The application logic to parse FTA response files, if used, must be adapted for Direct FileAct response files. The FTA FileAct configuration must be migrated to the Direct FileAct message partners. The own BIC destinations, used by the FileAct flows, must be licensed and configured in Access if not yet used for FIN or InterAct.
4.3.4
19
Customer B/Os
Vendor/Customer Application
File DROP
FTA
Destination
DATA COMPANION
Gateway 7.0
3
Conversion
-FIN
File Adapter
Destination -MX
-FileAct
DATA
XMLv2
Access 7.0
In conclusion, when migrating from Gateway FTA with companion parameter file to Access File adapter: The application does not need to qualify as a FileAct messaging interface. The application does not need to implement RMA/ASP functionality. The application can continue to be based on a 'file drop' mechanism to provide the payload file. The application logic to parse FTA response files, if used, must be adapted for parse notification files in XMLv2 format. The logic to generate the FTA companion parameter file must be converted to generate an XMLv2 based parameter file. The files drop order is different between Access and Gateway The own BIC destinations, used by the FileAct flows, must be licensed and configured in Access if not yet used for FIN or InterAct.
20
A reverse conversion might be needed as well to produce response files, from the XMLv2 based notification files generated by Access. This approach has the advantage of minimizing the changes required on the application to communicate with Access.
Customer B/Os
Vendor/Customer Application
File DROP
FTA
Destination
DATA COMPANION
Gateway 7.0
3
TOOL
-FIN
File Adapter
Destination -MX
-FileAct
DATA
XMLv2
Access 7.0
4.4
B/Os
RAHA MQHA
Manual FileAct Support
FTA FTI
Gateway 7.0
File Drop
Sept 2011
B/Os
File Drop
File Adapter
Entry 7.0
21
On Entry, the migration options are more limited compared to Access: Manual FileAct support Available to Entry 7.0 customers when the manual FileAct support functions will be available on Web Platform 7.0. This migration will be detailed in the future. Parameterized File Drop support This migration is available to Entry customers, currently using Gateway FTA, with a companion parameter file, and intending to use Entry File Transfer adapter. The migration details are similar to Access 7.0 and are explained in Section 4.3.4.
22
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 contains SWIFT or third-party confidential information. Do not disclose this publication outside your organisation without the prior written consent of SWIFT.
Disclaimer
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 and binding 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, 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.
23