Swift Functional Overview Alliance Access Entry 7 0
Swift Functional Overview Alliance Access Entry 7 0
Functional Overview
This document provides a high level description of the main functional enhancements provided by Alliance
Access/Entry 7.0, available beginning of 2011.
The purpose of this document is to provide an advanced description of these enhancements, so that customers can
assess how to take advantage of these new features and accordingly plan for it.
This document also briefly covers the functional enhancements specific to Alliance Entry 7.0.
The target audience are users familiar with current Alliance Access/Entry functionality.
December 2010
Connectivity - Alliance Access - R7.0
Table of Contents
1 Summary Overview ..................................................................................................................4
2 Operational Integration ..........................................................................................................10
2.1 Operational Monitoring ..........................................................................................................10
2.2 Operational Management......................................................................................................13
3 Configuration Management ...................................................................................................16
3.1 Concepts ...............................................................................................................................16
3.2 Export Tool ............................................................................................................................17
3.3 Import Tool ............................................................................................................................18
4 Web Platform Evolution .........................................................................................................22
4.1 Web Platform Finalisation .....................................................................................................22
4.2 Graphical Packages ..............................................................................................................23
4.3 Monitoring Dashboard ...........................................................................................................24
5 Disaster Site Recovery Support............................................................................................26
5.1 Enhanced Database Recovery .............................................................................................26
5.2 Hosted Database ..................................................................................................................26
5.3 Database Repair Service ......................................................................................................30
5.4 Duplicate Detection ...............................................................................................................31
6 Query Operational Data .........................................................................................................33
6.1 Overview ...............................................................................................................................33
6.2 RMA Web Service .................................................................................................................34
6.3 Message and Event Query Service ......................................................................................36
7 SOAP Host Adapter ................................................................................................................39
7.1 Configuration .........................................................................................................................39
7.2 Session handling ...................................................................................................................39
7.3 Emission logic .......................................................................................................................40
7.4 Reception logic ......................................................................................................................40
8 FileAct Support .......................................................................................................................41
8.1 General Principles .................................................................................................................41
8.2 File Transfer Support ............................................................................................................42
8.3 MQ Support ...........................................................................................................................43
8.4 SOAP Support .......................................................................................................................44
8.5 Real-Time File Get Support ..................................................................................................44
8.6 Direct FileAct Adapter ...........................................................................................................45
8.7 Other enhancements.............................................................................................................47
9 RMA Evolution ........................................................................................................................48
9.1 RMA beyond FIN ...................................................................................................................48
9.2 Functional Enhancements ....................................................................................................48
9.3 Usability Enhancements........................................................................................................50
10 Other Functional Enhancements ..........................................................................................54
10.1 Installation .............................................................................................................................54
10.2 Application Service Profile Support .......................................................................................55
2 Functional Overview
December 2010
3
Connectivity - Alliance Access - R7.0
1 Summary Overview
This section provides a summary of the functional enhancements provided by Access 7.0 and
Entry 7.0. These enhancements are further detailed in following sections of this document.
4 Functional Overview
December 2010
The use of additional resiliency Oracle options on the external instance must be transparent to
Access software1.
Note that the Web Platform, which also embeds an Oracle database, also supports the hosted
database option.
Configuration Management
Access 7.0 provides a new set of command-line tools supporting the export of selected
configuration data into an external, user modifiable text file, and the import of configuration data
from an external file.
These tools address various configuration management needs:
They facilitate the exchange of configuration data between a test and a production system,
where the possibility to alter the configuration data is required to cope with the inherent
differences between the two systems (like T&T BICs versus production BICs).
The availability of command-line based options also facilitates the automatic transfer of
configuration changes between cloned production instances.
The possibility to manually create and alter the configuration file also helps to automate
repetitive configuration tasks, typical of a service bureau activity.
1
For example, Access will be Oracle RAC-compatible, but not Oracle RAC-aware. Meaning that upon a node failure, Access will
not try to reconnect to another node and replay the in-flight messages.
5
Connectivity - Alliance Access - R7.0
In comparison with the database backup tool, the export process allows the operator to precisely
specify the configuration data to export.
The import process validates the data to import and aborts the operation in case of error. In case
some entities were already updated when the import process is aborted, these updates are kept.
The import process shares the same pre-update constraints and post-update approval rules that
are applicable to the equivalent manual operations available from Access graphical interfaces
(Workstation or Web Platform).
Note The message and event query service is not delivered with Access 7.0, but as a
functional patch to be installed on top of Access 7.0. This patch is planned to be
delivered during Q2 of 2011.
6 Functional Overview
December 2010
Workstation 7.0 is still mandatory to use these ADK based GUI. This includes ADK applications
developed by vendors and the use of MQSA configuration GUI.
RMA Enhancements
Access/Entry 7.0 provides a set of RMA enhancements, aiming at:
Supporting RMA beyond FIN
The enhancement extends the management of RMA authorisations currently limited to
FIN to also support RMA authorisations for InterAct and FileAct services.
The enhancement also supports filtering of InterAct and FileAct traffic based on RMA
authorisations.
Providing an audit trail per RMA authorisation.
This trail lists all actions performed on an RMA authorisation, providing an easy way to audit
the actions done on an RMA authorisation.
Supporting the transmission status.
Each authorisation to receive has a new status, the "transmission status", indicating the
processing the status of the underlying RMA InterAct message. The message reconciliation
process is also capable of properly reporting this status when the RMA InterAct message
referenced by the non-delivery notification, is already archived (a common situation as the
notification can be generated 14 days after the InterAct emission).
Making the management of RMA authorisations easier.
It is possible to clean up RMA authorisations for which there is no BIC defined in the
Correspondent Information File.
A configuration parameter allows the automatic export of RMA authorisations as soon as
they are changed.
Search and display enhancements are provided in the user interfaces, mainly in the Alliance
Web Platform RMA package.
FileAct Support
Access 6.3 introduced FileAct support, over the File Transfer adapter only.
Access 7.0 extends FileAct support, by supporting it over MQ based back-office connections.
The MQ FileAct support is available on the MQHA adapter only (MQSA does not support FileAct
transactions).
settings.
7
Connectivity - Alliance Access - R7.0
Note The SOAP Adapter on Access 7.0 does not yet support FileAct.
The SOAP evolution to support FileAct is planned to be made available in a
functional patch to be installed on top of Access 7.0. This patch is planned to be
delivered during Q2 of 2011.
Access 7.0 also supports a new host adapter simplifying the integration of FileAct between back-
office applications and Access. This new adapter, 'Direct FileAct', enables the back-office
application to only provide the payload file to initiate a FileAct exchange. The back-office
application does not need to generate an XMLv2 file to provide the FileAct settings. These
settings are statically configured in each 'Direct FileAct' based Message Partner.
The 'Direct FileAct' adapter enables legacy applications, already producing a payload file, to
integrate with SWIFTNet FileAct without requiring any additional developments.
The 'Direct FileAct' adapter also facilitates the prototyping of a new FileAct solution with Access,
as a base integration can be tested without requiring the development of an XMLv2 file.
LDAP Support
Access/Entry support LDAPv3 repositories for user authentication. This allows institutions to re-
use their existing user directories with Access/Entry to perform central user management.
LDAP authentication is available as an additional authentication mechanism in Access/Entry,
next to the standard local user authentication and authentication via One-Time passwords.
Using this new feature implies the following:
If an operator is defined in Access/Entry to be authenticated through LDAP, then Alliance
Access/Entry forwards the login request to the LDAP server for the user authentication.
The LDAP server(s) must be defined and configured within Access/Entry.
This function is included in Access/Entry core functionality.
8 Functional Overview
December 2010
9
Connectivity - Alliance Access - R7.0
2 Operational Integration
Overview
The operational integration is based on two new command-line based tools, available on the
Access server (one for monitoring and one for operational management). These tools provide
control and monitoring commands that can be invoked from a command-line prompt or from a
command script (Windows batch file or a UNIX script).
Some key characteristics of these tools are:
Selective control of access rights, based on 2 alternatives:
Providing the credentials (user name and password) of an Access operator, to use the
associated Access profiles for access control.
The password is either provided from the command line, prompted or read from a file.
Executing, without providing credentials, from the Access owner account only
('all_adm' account).
This privileged access method needs to be authorised by the LSO and RSO, who will
then assign an operator profile to this account determining the authorised operations.
The command-line tools are local to the Access server. If a remote execution is needed, it is
the customer's responsibility to implement the necessary procedures and security checks.
This configuration is in-line with most supervision architectures which rely on agents running
locally on the system.
The command-line tools make use of the exit code to indicate successful execution. These
exit codes allow customers to sequence the execution of multiple commands, in particular
when the execution of a command depends on the execution status of the prior command.
Integration Alternatives
These command-line tools are using control and monitoring Web Services, available internally to
support these functions on the Web Platform. These Web Services remain internal (i.e. they are
not documented and can be changed by SWIFT) with Access 7.0. The command-line tools are
the only documented way of controlling and monitoring Access from an external application.
The use of SNMP queries, although quite powerful and sophisticated, has been considered but is
not supported, as not being often used for integration.
Note SNMP queries should not to be confused with SNMP traps. Access will continue to
support SNMP traps, which are the preferred method to push information to an
external system (to the opposite of a command-line based tool that pulls information
on request). There are no plans to further enhance SNMP trap support (V1 protocol
only).
Note In a future release of Access, these Web Services might be documented to provide
an alternative integration method for control and monitoring applications.
10 Functional Overview
December 2010
-monitoroutputfile <monitor_output_file>
[-user|-application <username>]
[-password <password>] | [-passwordfile <password_file>]
[-cycle <nnnn_sec>]
[-duration <nnnn_h>]
[-continue_on_error]
[-port <port_number>]
[-overwrite]
Some key characteristics of the saa_monitor tool are:
The monitor parameter file specifies the information to be monitored. The file can specify
different entities (like monitoring 'Message Partner' and 'Logical Terminal' in a single
command).
The monitored information is output into a user specified file, using a documented XML
schema.
The tool can either run once (i.e. no cycle provided) or run continuously, at a specified
'cycle' interval.
11
Connectivity - Alliance Access - R7.0
12 Functional Overview
December 2010
13
Connectivity - Alliance Access - R7.0
Please refer to Section 'Entities Eligible for Managing', in the Installation and Administration
guide for more detailed description of the Access entities that can be managed, along with a
detailed description of the operational actions allowed for each entity.
14 Functional Overview
December 2010
15
Connectivity - Alliance Access - R7.0
3 Configuration Management
3.1 Concepts
Access 7.0 allows to export its configuration into an external text file, and to import this
configuration file to update its configuration.
The basic principles of the import/export functionality are highlighted below:
Export Import
Access 7.0 Tool Tool
Access 7.0
A new export tool (saa_export) is provided to export selected configuration data into a text
file.
A search criteria available per configuration entity allows to control which configuration
elements to export. Operational entities like Messages or Events are not included.
Different entities can be exported in the same file.
The name and location of the exported file is defined by the user.
The configuration file, generated by the export tool, is based on a documented XML
schema.
This is a text file that can be further modified by the end user (using a regular text editor), for
example to substitute all Test and Training BICs with a production BIC in the whole
configuration.
Operator passwords can be exported on request. LAU settings cannot be exported.
A new import tool (saa_import) is provided to import the configuration information
contained in the text file and update Access configuration.
The import process can either add new entities or modify existing ones. It does not support
deletion of existing entities, except for routing rules updates.
The import process first validates the import file format. It also validates that the entities to
be modified are in the correct state (i.e. allowed for configuration changes).
The import process follows the same update rules as applicable to an operator when using
the Workstation or the Web Platform. Entities must be in the correct state to be modified
(e.g. disabled state), and security related changes still needs to be approved by another
user (e.g. schema changes, operator permission changes).
The export and import tools are executables available on the Access server only.
They can be invoked by any account defined on the system where Access is installed (i.e.
not limited to the Access owner account 'all_adm' only).
A regular account will need to provide the credentials of an Access operator to use the
tools. The entitlements associated to this Access operator will determine the allowed
actions.
The Access owner account ('all_adm') has the possibility to execute the tools without
providing credentials. A specific profile, associated to the owner account, determines the
allowed rights. This security bypass must be enabled by the LSO and RSO.
16 Functional Overview
December 2010
17
Connectivity - Alliance Access - R7.0
The list of supported entities, along with the available search criteria is detailed in the Installation
and Administration guide, mostly in 'Replication of Configuration Data' section. The sub-section
'Exported Fields' details the entities and their associated fields that can be exported.
Export Log
The export generates a log providing:
The date/time of export
The export arguments
The name and type of each exported entity. It also logs if LAU settings are defined but not
exported, or if the operator password is not exported.
The total number of exported entities
18 Functional Overview
December 2010
Note The import tool does not provide means to alter the state of an entity before
modification. This operation is however available from the operational management
(See Section 2.2.2, Control Commands). It is therefore be possible, within the script,
to first alter the operational status of the entities to modify, then import the
modification, then reset the operational status back to an operational state.
References
The import process aborts if, when having imported all entities from the file, there is
any 'unresolved' reference (i.e. an entity referring to an undefined entity).
The import process also aborts, if after processing a configuration file, there are still
entities with mandatory references that are undefined.
Sensitive data
LAU Settings
When importing entities that were configured with LAU based security, the tool does
not import the LAU keys (as the information is not present in the file), but indicates in
the import log that LAU settings were set for the entity but were not imported.
19
Connectivity - Alliance Access - R7.0
If the entity to import exists and has LAU settings already set, these settings remain
unchanged.
Operator Passwords
Operator passwords, if present in the file, are imported but set as expired. At first login,
the operator will have to change its password. If not present in the file, the existing
operator password is left unchanged (or the system generated password is set for a
new operator).
Please refer to the Section 'Handling the Export and Import of Sensitive Data' in the
Installation and Administration guide for more details.
The import process first validates the import file and cancels in case errors are found, ensuring
that the database is always consistent. The import process is however not capable of 'rolling
back' the configuration updates already done, the updates already done before the import
process aborted are kept. The customer must correct the import file and launch again the import
process. The entities already updated can be skipped (depending on the -overwrite mode)
If the customer wants to implement an 'all or nothing' function for the import procedure (i.e. all
entities are updated or none is updated), the customer is required to take a backup of the
database before the import process, and in case of import errors, to restore this database
backup.
Import Log
The import process generates a log providing:
The date/time of import
The import arguments
The name and type of each imported entity, indicating if the entity was added, modified or
skipped.
The entities with skipped LAU settings
For the operator, whether the password was imported or reset.
Summary counters providing:
The total number of skipped occurrences
The total number of added occurrences
The total number of updated occurrences
Approval rules
The import process does not bypass the standard approval rules that are applicable in Access
when manually changing some sensitive entities. For example:
Left and Right approval of operator changes
Approval of schema modification
20 Functional Overview
December 2010
After the import process, all sensitive entities that were either added or modified are set in their
corresponding approval state. A manual user intervention, from Access graphical interface, is
required to approve these entities.
21
Connectivity - Alliance Access - R7.0
Administration Rationalisation
With Web Platform 7.0, there was an opportunity to rationalise the current Workstation
administration applications.
The main operational difference between the Web Platform and the Workstation is the use of on
an 'object' based view, instead of an 'application' based view as used on the Workstation.
For example, on the Workstation, the 'Logical Terminal' entity is accessible both from the 'SWIFT
Interface' application and from the 'SWIFT Support' application. On the Web Platform, as the
notion of application disappears, there is a single 'Logical Terminal' entity, defined in the
'SWIFTNet Interface' group, on which all activities related to 'SWIFT Interface' and 'SWIFT
Support' for a Logical Terminal are available.
The screen and display layout of the Access administration functions is harmonised with
Gateway, supporting a similar layout as introduced on Web Platform 6.3 for the Gateway
administration. The Access administrator primarily works with a list of objects to configure and
monitor on the Web Platform 7.0. For each selected object, detailed information is displayed, and
the relevant administration functions are available on the screen.
Note The security model of Access 7.0 remains based on the existing 3 levels organisation
of Workstation: application, function, and permission.
On Web Platform 7.0, the notion of application does not exist. The Workstation based
security model is mapped to the Web Platform model (for new Access customers,
using only the Web Platform, the mapping may not always be intuitive).
It is foreseen to reorganise this security model, to map to the Web Platform structure.
This will be considered when the majority of existing Access/Entry customers will
have stopped using the Workstation in favour of the Web Platform.
22 Functional Overview
December 2010
Monitoring Rationalisation
The monitoring functions, available on the Workstation, have also been rationalised when
implemented on the Web Platform 7.0, available through a new 'Monitoring Dashboard'
application:
On one hand, on the Monitoring Dashboard, the detail monitoring functions are attached to
their relevant object (such as detail monitoring of a logical terminal, emission/reception
profile, message partner). So, when administrating an object, the user has the possibility to
directly view the monitoring information (if authorised).
On the other hand, the Monitoring Dashboard is designed to provide a more intuitive and
efficient way of monitoring Access functions, compared to the Workstation 7.0 Monitoring
application. The Monitoring Dashboard also supports the monitoring of multiple Access
instances.
The Monitoring Dashboard provides a clear distinction between the summary, high level
monitoring information, and the detailed monitoring information available for each relevant object.
It is possible to directly navigate from a monitored entity on the Monitoring Dashboard to display
its monitoring details, along with its configuration information (in read-only mode).
23
Connectivity - Alliance Access - R7.0
Export reports in HTML, xls, PDF, and CSV formats (as from 6.3)
Dashboard
The central point for Monitoring application is a single-window dashboard view, displaying the
latest alarms and exceptions raised for a specific Access/Entry instance. The information is
displayed on the screen in a chronological order and is refreshed at a configurable rate.
The main elements of the monitoring dashboard are:
The left navigation tree, provide a high level, at a glance view of the Access/Entry
instance(s) being monitored. Colour codes are used to indicate the overall status of an
object.
24 Functional Overview
December 2010
The main Access/Entry node shows the overall status (which is a consolidation of all
the objects being monitored).
Each monitored object is visible, with its monitoring status.
The Exceptions and Alarms pane provides a summary of the last alarms raised for the
Access being monitored and selected.
Multi-instance monitoring
The Monitoring Dashboard also provides a single consolidated view of all the monitored Access
instances, bringing the following features:
It is possible to monitor all Access instances of the infrastructure on the same screen.
It is possible to investigate incidents and take operational actions on different Access
instances within the same screen.
Additional Access instances can be included in the general monitoring tree, to show their global
statuses.
The Exceptions and Alarms view shows the summary information related to the instance
selected in the monitoring tree.
25
Connectivity - Alliance Access - R7.0
26 Functional Overview
December 2010
Primary Site
Main
Access 7.0
Software
Oracle
Server
Note The term Oracle instance refers to the set of Oracle processes managing a database
instance, capable of hosting multiple database schemas. It will be possible to install
the Access database schema on this instance, along with other schemas.
In such a configuration, the recovery of the Oracle database is managed by the customer using
its own tools and procedures. This means that the Database Recovery option is not available in
the hosted database configuration.
Architecture Resiliency
The hosted database model separates the software server (i.e. the machine running Access
software) from the data server (i.e. the Oracle configuration hosting the Access database).
This architectural separation between the software and the data servers already provides a first
level of additional resiliency.
In contrast with the embedded database model, where a loss of the Access server also results in
the loss of its database, the loss of Access server in hosted model does not result in the lost of
the Access database. The Access database, running in the hosted Oracle environment is still
available, and is left 'frozen' in the situation of the failure, i.e. with a set of in-flight messages to
recover.
27
Connectivity - Alliance Access - R7.0
In such a configuration, as the database is still available on the Oracle infrastructure (it is
assumed that the Oracle configuration is highly resilient), the recovery of these in-flight
messages can be transparently managed (i.e. without requiring the EAI to perform retrieval and
re-emission logic) by reconnecting a 'dormant' Access instance that can connect to this database
and process the in-flight messages.
The recovery scenario performed at that moment is identical to the one performed by the
standard recovery of Alliance Access server after an unplanned shutdown (like a power supply
loss or a forced immediate shutdown).
Note SWIFT does not qualify Oracle tools that can be used to setup a resilient
infrastructure. The important assumption is that the use of such tools in the Oracle
infrastructure remains completely transparent to Access.
Data Guard
Asynchronous Copy
In case of an incident on the primary site, a consistent Access database can be immediately
available on the backup site. No manual intervention is required on the backup site to recover the
database (hence sometimes referred to a 'hot standby').
The use of Oracle Data Guard, in asynchronous mode, can also result in the same information
loss as present when using Database Recovery for a disaster recovery scenario. The Database
28 Functional Overview
December 2010
Repair Service must be manually invoked by the administrator on the disaster site to prevent
duplicate emissions.
In this configuration, it is therefore the customer responsibility to execute the repair service
before resuming communication with SWIFT network.
EAI
With the hosted model, it is possible to apply the same configuration, as depicted below. Each
Access instance still has its own dedicated database, hosted on the Oracle environment.
EAI
Access Access Access
Warning The model below, where multiple Access servers are updating a single common
Oracle database, is not supported. Access 7.0 will actually check this situation in
hosted mode and refuse multiple concurrent connections on the database.
29
Connectivity - Alliance Access - R7.0
EAI
Access Access Access
Not Supported
Software Software Software
Oracle Server
30 Functional Overview
December 2010
The administrator can decide whether the default action (none, complete or route) should be
fixed (through the configuration of a security parameter) or should be prompted when the Repair
Service tool is invoked during a recovery situation.
31
Connectivity - Alliance Access - R7.0
32 Functional Overview
December 2010
Configuration
A WSDL (Web Service Description Language) file is available that describes the services
provided. In order to make use of that service, the customer or application vendor has to develop
a client application. Due to the loose coupling nature of Web Services, this client application can
be developed in any programming language, assuming that a toolkit is provided for that
environment to interpret the WSDL file and invoke the exposed functions. The available Web
Services are described in the Alliance Access Web Services Developer Guide.
The Web Services interface requires the application to first authenticate with credentials of an
Access account (user name and password), before invoking the services. The application is able
to authenticate through an interactive or an application based account. This authentication
enables Alliance Access to validate the incoming request and make sure that the account used
has the appropriate permissions to read the requested data.
An operator with "application password" can be defined by the security officers, the same way as
for an interactive operator. These application accounts have strong password validation rules
and can only be used by a non-interactive application (it is not allowed to login with an
application account from Alliance Web Platform or Workstation). Furthermore these accounts are
never locked in case of invalid logins and there is no login time restriction. The Access security
profiles, associated to the authenticated account, determine the scope of the data that can be
accessed. For more information on how to define an operator with application password, please
refer to the Alliance Access System Management Guide, section Defining Operators.
In Alliance Access, the Web Services Service (WSS) has to be started for Alliance Access to
respond to incoming requests. To start this service from the System Management application,
please refer to the Alliance Access System Management Guide, section Stopping and Restarting
Components.
The use of Web Services requires the activation of the licence option 91:WEB SERVICES,
whether to be used for development or for run-time usage.
33
Connectivity - Alliance Access - R7.0
Therefore, direct SQL queries to the Access database are not supported by SWIFT (even for the
Hosted Database model). The Access database schema is not documented.
The Web Services provide the only supported method for querying Access database.
RMA Operations
Once the client application has successfully opened an authenticated a session with Access, it
can make use of the search and get operations to read RMA authorisations and query/answer
records or verify whether the exchange of messages is authorised for specified criteria. The
following operations are available:
SearchAuthorisation
GetAuthorisation
SearchQueryAnswer
GetQueryAnswer
MayExchange
When using the Search services (SearchAuthorisation and SearchQueryAnswer) the back office
application provides search criteria, based on RMA fields, to retrieve corresponding
authorisations or query/answers. The search criteria are similar to the search criteria available on
Alliance Web Platform or Workstation. The service then returns a list of authorisations or
query/answers matching the search criteria. A page based mechanism is used to handle long
search results, ensuring that only a controlled limited set of information is returned to the client.
The table below shows in the second column which search criteria can be used by the back
office to search for authorisations. The third column shows which information is returned in the
response.
The Get services (GetAuthorisation and GetQueryAnswer) allow the application to obtain the full
details of a specific authorisation or query/answer. In the case of GetAuthorisation, the
application must provide the RMA key (service + own BIC + correspondent BIC). The service
then returns the full details of the authorisation specified. The table below shows in the fourth
column the search criteria that have to be used for a GetAuthorisation. The fifth column shows
which information is returned in the response.
34 Functional Overview
December 2010
Own BIC x x x x
Correspondent BIC x x x x
Service name x x x x
Authorisation status x x x
Transmission status x x x
Issued date/time x x
Stored date/time x x x
Preparation status x x x
Related Query/Answer x x
Audit trail x
Operator name x
Auth origin x
Auth origin x
MayExchange
The MayExchange service allows verifying if the exchange of messages from a specific message
type or request type is authorised between institutions at a given time. This service simplifies the
integration of RMA filtering logic in a back-office application. The back-office application can
simply invoke the service to know whether a message exchange is allowed. Without this service,
the back-office application would need to query the appropriate RMA authorisation, and
implement the RMA logic to interpret its content. The table below shows in the second column
35
Connectivity - Alliance Access - R7.0
the criteria that have to be used for a MayExchange. The third column shows which information
is returned in the response.
MayExchange Response
Own BIC x
Correspondent BIC x
Service name x
Type of authorisation x
Date date/time x
Authorisation status x
Overview
Access 7.0 supports a new set of Web Services, the 'Message and Event Query Service',
complementing the RMA Web Services already provided with Access 6.3.
This new service offers the capability to search and query messages and events present in the
Access database. The service implementation is similar to the RMA search and query service
already implemented on Access 6.3:
Message/Event Search Service
The Message/Event Search Service enables an application to search for messages and
events in the database. As input, a filtering criteria is provided to the service, which provides
on output the list of messages or events matching the criteria.
The main search criteria is based on the message/event creation date. Additional fields are
also available in the search criteria (such as message type).
Message/Event Query Service
The Message/Event Query Service returns the details of a specific message or event, in a
documented XML structure:
For a message, the different records constituting a message (the message header, the
text, the instances and their associated network and system interventions) are
returned.
For each record, the fields returned are most of the fields visible when consulting a
message through the Workstation or Web Platform.
36 Functional Overview
December 2010
The XML support for repetitive and hierarchical representation enables to represent, in
a single document, all the message elements (header, text, instances and associated
interventions).
For an event, the fields returned are most of the fields visible when consulting an event
through the Workstation or Web Platform.
Archive Access Support
The Message/Event Web Service can access messages and events for active days but can
also access messages and events in archived days, as long as these archived days are not
removed from the database. It can also access message and event in archived days
restored in Access database using the restore of backup of messages or events function.
The Message/Event Web Service indicates that the message or event returned by the query
service is either coming from an active or an archived day.
Note The access to archived days of messages and events primarily guarantees that the
information used for reporting is complete and non-changeable and can reliably be
used for audit reporting. The access to information on active days, even for
completed transactions, is never 100% reliable. The information is still subject to
change, as it is always possible to re-activate a message.
Benefits
The main benefit of this Message Query Service is to address the needs for analysing, from an
external application, the operational data present in Access database. This operational data
consists of:
FIN, InterAct or FileAct messages, providing both the business data (text block, InterAct
payload) and the message audit trail (i.e. the message history within Access).
Events, providing the details for each event.
The needs for an external analysis of operational data are multiple. The list below gives some
typical needs:
Audit Reporting
The ability to trace in detail the history of a financial transaction, including its business
content.
End of Day Reporting
The ability to generate message traffic statistics, either on a specific transaction (e.g. to
calculate the time taken to process the whole message flow in Access) or on a group of
transactions (e.g. statistics on message traffic per day, week or month, peak traffic hours,
etc).
External Archiving
The need to incorporate into external archiving systems, in a specific format, large volumes
of messages, containing all the required audit information (typically the transaction header
and business data, along with its Access audit trail).
37
Connectivity - Alliance Access - R7.0
On the other hand, the ADK remains the only solution to integrate external applications into
Access main message flow (via the creation of additional ADK based queues, integrated in the
whole Access routing).
38 Functional Overview
December 2010
7.1 Configuration
The SOAP adapter is based on Web Services technology. A WSDL (Web Service Description
Language) file is provided to describe the operations supported by the SOAP adapter. In order to
make use this adapter, the customer or application vendor has to develop a client application
making use of these services. Due to the loose coupling nature of Web Services, this client
application can be developed in any programming language, assuming that a toolkit is provided
for that environment to interpret the WSDL file and invoke the exposed functions.
The client application must provide the MT or MX messages using Access XMLv2
representation, using Revision 2 at a minimum. XMLv2 specifications can be found in the System
Management Guide, Appendix E, section XML Format 2.
In Alliance Access, the Web Services Service (WSS) subsystem has to be started for Access to
respond to incoming requests. To start this service from the System Management application,
please refer to the System Management Guide, section Stopping and Restarting Components.
Note The SOAP adapter and the Web Services interface should not be confused, although
they both rely on Web Service technology. SOAP is a back-office adapter, providing
all the logic to reliably exchange messages between Access and a back-office
application, while the Web Service interface is a new method to query the content of
Access database.
39
Connectivity - Alliance Access - R7.0
of messages that the back office application can send or receive, and that will be recovered in
case of an interruption of the link. The value should be between 1 and 10.
To guarantee one-time delivery, messages should have a unique sequence number. This
sequence number is generated automatically by Access when it sends messages to the back-
office. It is provided as a sequential continuous number by the back-office when the messages
are emitted by the back-office to Access. This unique number is used either by the back-office or
by Alliance Access to identify the message and determine if the message has already been sent
or received.
The SOAP protocol and the window size concept are explained in detail in the System
Management Guide, Appendix G, section SOAP.
40 Functional Overview
December 2010
8 FileAct Support
Access 6.3 initiated the support for FileAct, limited to the File Transfer adapter. With release 7.0,
FileAct support has been extended to the MQHA adapter.
Access 7.0 also provides a new adapter, the 'Direct FileAct' adapter, which can also be used by
back-office applications for FileAct integration. The use of this new adapter is subject to the
activation of a new licence option.
This section provides a summary description how FileAct is supported in Access.
XMLv2 usage
The creation of a FileAct transaction through the File Transfer or the MQHA adapter requires that
the back office provides the FileAct settings necessary to generate the transaction using Access
XMLv2 representation (the XMLv2 revision 2, at least, is required).
Monitoring
Access provides graphical monitoring of file transfers (the Monitoring application on Workstation
or the Monitoring Dashboard on Web Platform). The monitoring application shows the file
transfers in progress, indicating the percentage of total file size already sent or received.
It is also possible to abort an ongoing File Transfer from the Monitoring graphical interfaces.
Various events are also generated during a file exchange session. The event "File Emission
Progress" shows in percentage (%) how much of the total file size has been transferred. These
41
Connectivity - Alliance Access - R7.0
events can be forwarded to external applications, using the SNMP protocol, to support external
monitoring file transfers.
File Storage
When processing a file, Access stores the content of the file into the database. A special area of
the database (a dedicated 'saa_file.dbf' tablespace) is used to store this file content.
Access stores the file content in the database to ensure that the file is always accessible when
needed for an operation (like sending the file to SWIFTNet, re-activating a file transaction).
As a general rule, the file content is internally stored in Access database but is not visible to end-
users, or to external applications (like the ADK interface or the Message Query interface).
The file content is physically deleted from the database when the associated file message is
archived in Access. This also means that the file content is not included in the backup of
message archives. The message backup does however contain the file digest.
Emission logic
The emission logic is as follows:
The back office stores the payload file in the input attachment directory and puts the XMLv2
file in the message partner input directory.
The payload file must be provided before the XMLv2 file.
The message partner will detect the XMLv2 file either automatically (if AFT (Automatic File
Transfer) is activated) or on manual initiation of a message partner session.
Access analyses the XMLv2 file. When it identifies a File message. Access will get the path
to the payload file from the message partner configuration and the physical file name of the
payload file from the XMLv2 message.
The FileAct header information (Requestor DN, Responder DN, Service Name, Request
Type) is retrieved from the XMLv2 file.
42 Functional Overview
December 2010
If the payload file is correctly stored in the database, Access creates a "File" message. The
payload file and XMLv2 file are moved to the backup directory.
The routing rules should send the file message eventually to _SI_to_SWIFTNet.
Eventually, the FileAct request is created and sent to SWIFTNet.
If requested, a delivery notification can be received and forwarded to the back office.
Reception logic
The reception logic is as follows:
Alliance Access receives an incoming SWIFTNet File Transfer request via an activated
SWIFTNet reception profile.
Once the File Transfer is complete (the file payload is stored in the database), Access
creates a File message.
The routing rules send the file message to the relevant exit point from which it will be
processed by an output message partner.
When the message partner session is run (automatically or manually), it stores the payload
file in the output attachment directory. Access 7.0 generates the physical file name based
on the logical file description (with Access 6.3, the file name was an automatically generated
file name). The extension of the file is as configured in the message partner. Furthermore,
an XMLv2 file is produced containing FileAct detailed information (such as the HeaderInfo)
on this transaction.
8.3 MQ Support
Overview
With Access 7.0, the MQHA adapter is enhanced to support FileAct flows over IBM WebSphere
MQ.
FileAct support over MQ requires the usage of the XMLv2 data format. The back-office
application must provide the FileAct settings, using the XMLv2 data format.
MQHA supports two different modes (Full & Mixed mode) to transfer the payload file.
Mixed Mode
In Mixed mode, the payload file is provided to Access 7.0 and stored in a local directory, defined
in the WebSphere MQ message partner.
The MQ channel is only used by the back-office to transmit the XMLv2 message. This XMLv2
message provides the actual name of the payload file. The reception of the XMLv2 message by
Access 7.0 triggers the processing of the payload file in Access.
The exchange method is very similar to the File Transfer method. In both cases, the payload file
is transferred 'as a whole' between the back office and Access 7.0. The difference is how the
XMLv2 message is transferred (through an MQ message for MQ or as a separate file for the File
Transfer).
For emitting a file, the back office must transfer the payload file to Access, into the local directory
associated to the WebSphere MQ message partner, create the XMLv2 message and send it over
MQ to Access.
For receiving a file, the back office will receive through the MQ channel the XMLv2 message
generated by Access. Upon reception of this MQ message, the back office is responsible for
locating the file present in the local directory of the MQ message partner and to transfer this file
to the back-office.
43
Connectivity - Alliance Access - R7.0
Full Mode
In Full mode, all information (XMLv2 settings and payload file) is exchanged through a single MQ
queue.
In full mode, multiple MQ messages must be created in order to generate a FileAct transaction.
Access 7.0 makes use of MQ Message Group feature, along with segmentation support, to
ensure that all the MQ messages needed for a FileAct transaction are treated as a whole.
The MQ Message Group must include at least 2 MQ messages:
The first MQ message in the group provides the FileAct settings using the XMLv2
representation.
The following MQ messages provide the file payload. It is necessary to segment a large file
into multiple MQ messages.
This grouping of XMLv2 message and file payload into a single MQ Message Group allows the
FileAct transaction to be sent over a single MQ queue.
When sending a file to SWIFTNet, it is the responsibility of the back-office application to generate
the MQ message group, to create the initial XMv2 message and to convert the file data into one
or multiple MQ messages.
When receiving a file, Access 7.0 will automatically generate the MQ message group. The split of
file payload in multiple messages is controlled by a configuration parameter determining the
maximum MQ message size. It is the responsibility of the back-office application to extract the
MQ messages from the Message group and to reconstitute the payload file.
Resiliency
The MQHA adapter uses generic WebSphere MQ functionality to ensure that it does not end up
with partial messages.
When reading FileAct messages from the MQ queue, MQHA will only process messages for
which all the MQ segments are available. If a MQ segment of a FileAct message is missing, the
FileAct message is not read by the MQHA adapter. If all the MQ segments of a FileAct message
are present, MQHA starts a transaction when the first segment is read and commits it once the
FileAct message is successfully added in the Alliance Access database.
When sending FileAct messages to a MQ queue, MQHA starts a transaction before sending the
XMLv2 message containing the FileAct settings and commits it after the last MQ segment has
been sent. This ensures that MQHA will only route the FileAct message in Alliance Access once
it has been successfully sent to the MQ queue.
Note FileAct real-time mode also describes the Get operation, acting as a server (also
referred to 'FileAct download server'). Access 7.0 does not support this mode,
meaning that it cannot act as a FileAct server, responding to file get requests initiated
by correspondent's.
This command can be invoked interactively from a command prompt or from a script, allowing it
to be invoked from an external scheduler.
44 Functional Overview
December 2010
The command invocation initiates the file transfer and returns as soon as the FileAct negotiation
has been successfully accepted by the correspondent. The actual reception of the file follows the
normal route in Access, i.e. reception of the file through the specified SWIFTNet Reception
profile, routing to a message partner for transmission to a back-office application.
No additional licence is required to use this functionality.
Note Access 7.0 currently only provides a command-line based initiation. An equivalent
initiation available from a graphical interface on Web Platform is under study for a
future update of Access 7.0.
Note Customers having the necessary skills and resources to produce an XMLv2 file
sometimes require such a configuration based approach to easily prototype a new
FileAct service. This easy and cost effective set-up helps them build the business
case before investing the required development resources to implement an XMLv2
based integration.
Sending Files
The 'Direct FileAct' adapter can operate in automatic or manual mode for session initiation.
In automatic mode, Access automatically picks the files dropped by the back-office systems, in
the configured input directory.
In manual mode, the user activates the session, selecting the (payload) file to be sent. This
method provides a mechanism in Access 7.0 to manually initiate the emission of a file over
FileAct.
45
Connectivity - Alliance Access - R7.0
In both automatic and manual modes, Access uses the FileAct settings stored in the associated
Message Partner handling the file to generate the FileAct message in Access and route the
message internally to send it to SWIFT.
Note The FileAct functionality supported by the File Transfer Message Partner is not
practical for interactive use, because to initiate a session, the operator must select
the XMLv2 file and not the payload file.
Receiving Files
Access allows routing of incoming FileAct transactions to a 'Direct FileAct' Message Partner. The
Message Partner only produces the payload file (based on the logical name), without producing
an additional XMLv2 based file to contain the FileAct settings.
This mode can be used by back-office applications processing payload files only and not
interested in examining the FileAct settings detailed in the associated XMLv2 file (when using a
File Transfer based message partner).
46 Functional Overview
December 2010
The FTA parameter file on Gateway, which can optionally be used to provide FileAct
settings, is not supported on Access. This means that specific SWIFTNet features cannot
be set by the back-office when using the Direct FileAct connection method.
If a back-office application has developed logic to generate the FTA parameter file, the File
Transfer adapter of Access should be used. The FTA parameters must be mapped to the
XMLv2 data format supported by Access.
The dependency between the payload file and the parameter file is also different between
Access and Gateway.
On Gateway, the parameter file must be provided before the payload file, as the
payload file is the trigger for the file exchange.
On Access, the XMLv2 file is the trigger, so the payload file must be provided before
the XMLv2 file.
File Authorisation
Access/Entry 7.0 supports the authorisation of FileAct transaction. Similarly to FIN and InterAct
messages, it is possible to route FileAct messages to the authorisation queue where they need
to be manually authorised by an operator.
The authorisation of FileAct transaction is only available on Web Platform. The authorisation
application allows viewing the various FileAct settings, including the optional enhanced FileAct
header, before authorising the message. The file content remains invisible to any Access users.
RMA Support
Access/Entry 7.0 supports the management of RMA authorisations related to FileAct traffic and
the associated RMA filtering. Further information is available in section 9.1.
47
Connectivity - Alliance Access - R7.0
9 RMA Evolution
9.1 RMA beyond FIN
The Access/Entry 7.0 RMA application, already supporting the management of FIN based
authorisations, is enhanced to support the management of InterAct and FileAct based
authorisations.
The RMA filtering, currently handling FIN traffic only, is enhanced to filter InterAct and FileAct
messages.
Note For each InterAct and FileAct service, the corresponding ASP loaded in Access/Entry
defines the RMA characteristics.
Consequently, Access/Entry 7.0 can support the coexistence within the same system, of a mix of
InterAct and FileAct services, some being subject to RMA filtering and others not.
48 Functional Overview
December 2010
Since release 6.3, Access/Entry supports a new network transmission status for each
authorisation to receive, directly providing the status of the underlying RMA InterAct message.
This transmission status can be seen directly from the Relationship Management Application.
The possible values are:
Waiting Transmission, the RMA InterAct message is waiting to be transmitted over
SWIFTNet
Transmission Failed, the RMA InterAct message failed delivery to SWIFT
Sent to Correspondent, the RMA InterAct message has been sent over SWIFTNet and was
received in the SWIFT central systems. This does not mean that the correspondent
received the message already.
Not delivered to Correspondent, the RMA InterAct message could not be delivered to the
correspondent.
Delivered to Correspondent: this status is only available when a delivery notification has
been requested for the underlying RMA InterAct message.
The RMA application also allows to search for RMA authorisations based on their specific
transmission status.
Enabled Status
Because of this new transmission status, the status of an authorisation will remain „enabled‟,
even if the underlying RMA InterAct message failed delivery.
Previously, the state was reset back to „Draft‟ when the underlying RMA message could not be
sent.
49
Connectivity - Alliance Access - R7.0
In the cleanup window for stale authorisations a new checkbox is provided: "Authorisations
without BIC in Correspondent Info". The operator can select this new option to delete these
authorisations.
This operation is only available on Web Platform.
This procedure does not cover the deletion of authorisations related to Test & Training BICs.
50 Functional Overview
December 2010
When this box is unselected, all new authorisations are excluded from the search. When
selecting this checkbox, a dropdown field "Preparation Status" appears, listing all possible
preparation statuses. The preparation status dropdown allows the selection of one of the internal
statuses an authorisation can have (for example draft, pending reject approval, ...) or the value
'Any'.
51
Connectivity - Alliance Access - R7.0
Authorisation to Send: the current authorisation statuses are displayed as checkboxes. The
possibilities are Enabled, Revoked, Rejected and Deleted. The new authorisation statuses
are displayed similarly with checkboxes.
It is possible to select any number of these checkboxes or none to search for everything.
52 Functional Overview
December 2010
53
Connectivity - Alliance Access - R7.0
Note This ZIP file only contains configuration data. The operational data like messages
and events is not included in this file, to avoid the potential risk of creating duplicate
transactions.
In summary, compared to previous 6.x releases, this new installation option greatly facilitates the
installation from scratch of an Access/Entry system on a new host.
This installation option is available both for UNIX and Windows:
On UNIX, its use is optional.
On Windows, the use of this procedure is mandatory. This is because Access/Entry 6.x is
not compatible with Windows Server 2008 R2, and Access/Entry 7.0 is not compatible with
Windows Server 2003.
This incompatibility between the operating system and Access/Entry imposes that
Access/Entry 7.0 is installed from scratch, on a fresh Windows 2008 R2 system. This new
54 Functional Overview
December 2010
installation option allows preserving the existing 6.X configuration when upgrading to 7.0, on
Windows.
Note Access/Entry 7.0 only works with the ASP package to load FCP information. The FCP
files, used to load FIN Copy Profile information in Access/Entry 6.x, are not supported
by Access/Entry 7.0.
ASP Update
Access/Entry 7.0 must be regularly updated with the information contained in the ASP package,
in order to ensure that the service definitions known by Access/Entry 7.0 are up to date with their
provisioning on SWIFTNet 7.0.
Compared to the FCPs, all the ASPs provided in the ASP package are loaded in Access/Entry,
regardless whether these services are actually used by the customer. Access/Entry 7.0 provides
a mechanism to hide to the end users the services that are not used.
As an ASP package contains hundreds of services, they are by default loaded as hidden
services in Access/Entry 7.0. The only exceptions are the ASPs requiring RMA support, which
are visible by default.
In order to update the ASP information contained in the ASP package, Access/Entry 7.0 supports
two methods:
A new 'Application Service Profile' application, available on Web Platform 7.0 only, provides
a graphical interface to load the application service profiles present in the ASP package.
This application also deciding which services loaded from the ASP package should be
visible to other GUI applications (such as the RMA application).
55
Connectivity - Alliance Access - R7.0
A new tool saa_manageasp that allows loading the ASP package from a command line.
This tool is documented in Appendix B of Access/Entry Installation and Administration
guide.
Note Workstation 7.0 does not provide support for management of ASPs. Customers that
are not using the Web Platform 7.0 should therefore use the saa_manageasp tool to
load in Access/Entry 7.0 the services contained in an ASP package file.
Output Channels
Access/Entry supports output channels introduced in SWIFTNet 7.0.
This support impacts the definition of reception profiles using store-and-forward delivery in the
SWIFTNet Interface Application.
Through the use of output channels on a shared queue, Access/Entry 7.0 allows to receive
InterAct and FileAct traffic exchanged in store-and-forward mode through multiple sessions
accessing the same store-and-forward queue.
56 Functional Overview
December 2010
Note Access/Entry 7.0 does not implement a dedicated logic to analyse the response
message and automatically download the bulk S&F FileAct files. The process to
receive these S&F files will be similar to any other FileAct reception.
Note The commercial 'Standalone RMA' product offering remains available, with its related
options (RMA+, Web Services for RMA, Database Recovery).
57
Connectivity - Alliance Access - R7.0
Embedded RA
Access/Entry 7.0 does not require anymore installing the RA software, needed for
communicating with the Gateway. The RA software is included in the Access/Entry 7.0
installation (hence the term 'Embedded RA').
This evolution simplifies operations as there is no need to install and maintain the RA software
anymore. It is also not necessary anymore to configure the RA instance.
Relaxed Mode
In previous releases, each Gateway connection defined in Access/Entry required the definition of
an authoriser DN, linked to a certificate used in strict mode in Gateway. Access/Entry needed to
provide certificate management features and HSM monitoring function to support the
management of these certificates2.
With the mandatory use of the Gateway to handle the SWIFTNet connection, Access/Entry 7.0
can rely on the functionality provided by the Gateway to simplify operations.
Access/Entry 7.0 stops using certificates adopted in Strict mode, but instead uses certificates
adopted in Relaxed mode.
This change brings an important operational simplification to the setup and management of the
Gateway connection. In this mode, the certificates operations (adoption, renewal, password
changes, HSM assignation, etc) are entirely handled by Gateway, and are removed from
Access/Entry 7.0. This enhancement also eliminates many of the operational issues linked to the
2
The use of certificates adopted in strict mode usage comes from the days when Access/Entry interfaced directly to SWIFTNet
Link.
58 Functional Overview
December 2010
10.7.1 Configuration
The connection to the LDAP server has to be configured in Access/Entry. It can only be
configured by operators who have the appropriate permissions (configure LDAP and approve
LDAP). Optionally a backup LDAP server can also be defined. When a backup server is
configured, Access/Entry will automatically switch to this server when the primary LDAP server
becomes unavailable. After a restart of the Alliance Access/Entry servers, the primary LDAP
server is contacted again. To configure the LDAP servers, please refer to the Alliance
Access/Entry System Management Guide, section Configuring LDAP Authentication.
There are now 3 authentication methods possible for operators: local authentication, one-time
password and LDAP authentication. The Security Officers can configure each user individually in
Access/Entry. To configure an operator for LDAP authentication, please refer to the Alliance
Access/Entry System Management Guide, section Defining Operators.
59
Connectivity - Alliance Access - R7.0
60 Functional Overview
December 2010
The database integrity check verifies the integrity of the Access/Entry database. The result
of the check indicates any problem detected. You can view entity-specific details for any
check that failed.
10.10.1 Configuration
The FIN cold start information must be configured in Access/Entry. This configuration is subject
to the four-eyes principle.
The configuration allows specifying FINCopy services for which messages should not be resent.
The date and time of the generation of the most recent undelivered message report before the
service interruption must not be provided as it is included in the specific undelivered message
report (MT082) received after a FIN cold start. This date and time is published on swift.com.
For information on how to configure and approve the FIN cold start information, please refer to
the Daily Operations Guide, section FIN Cold Start.
61
Connectivity - Alliance Access - R7.0
Note The upgrade procedure will remove any asynchronous line or terminal type device
that is still defined in the database.
Mirrored-disks Support
Use of Oracle technology for database.
Local 103 Addition
To allow the installation of multiple FINCopy profiles with the same CID.
As of release 7.0, the FIN-Copy field in the Header tab for a manually created message or
the tag 103 for batch input must be defined explicitly.
alliance_root Script
Security enhancement
62 Functional Overview
December 2010
Legal Notices
Copyright
SWIFT © 2010. 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.
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, 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.
63