You are on page 1of 313

Alliance Access 7.6.

20

Message Management Guide

This guide describes how to use Alliance Message Management to manage messages through Alliance Access through
the Alliance Web Platform. An Alliance Access operator can use Alliance Message Management to create, modify, verify,
and authorise messages, as well as search for messages, create reports, and send and receive batch files.

17 December 2021

Link to this document: https://www2.swift.com/go/book/book127273


Alliance Access 7.6.20 Table of Contents
Message Management Guide

Table of Contents

Preface............................................................................................................................................................... 6

1 SWIFT Training........................................................................................................................................ 7

2 Alliance Message Management..............................................................................................................8

3 Logging in to Alliance Message Management......................................................................................9


3.1 Log in Using Two-Factor Authentication (TOTP)..................................................................................... 9
3.2 Log in Using an Identity Provider...........................................................................................................13
3.3 Log in Using a SWIFT Personal Token..................................................................................................17
3.4 Log in Using a User Name and Password.............................................................................................19
3.5 Change Your Password......................................................................................................................... 21

4 The Alliance Message Management GUI ............................................................................................23


4.1 Online Help............................................................................................................................................23
4.2 Tips and Tricks for Using Alliance Message Management.................................................................... 23
4.3 Alarm Notifications.................................................................................................................................24
4.4 Wildcards for Searching or Filtering.......................................................................................................25
4.5 Behaviour and Format of Date and Time Fields.................................................................................... 26
4.6 User Assistance.....................................................................................................................................28
4.7 Change Your List View...........................................................................................................................34
4.8 Choose File............................................................................................................................................36
4.9 Print a Report Directly from the GUI...................................................................................................... 36
4.10 Report Types and Settings (Export Function)........................................................................................36
4.11 Change the Preferences........................................................................................................................38

5 UETR and SLA ID Fields in Alliance Access.......................................................................................41

6 Universal Confirmations....................................................................................................................... 45

7 ISO 20022 Programme.......................................................................................................................... 46

8 Message Preparation............................................................................................................................ 47
8.1 Message Editor......................................................................................................................................47
8.2 Messages and Message Instances....................................................................................................... 51
8.3 General Message Structure...................................................................................................................52
8.4 Management of Messages.................................................................................................................... 53

17 December 2021 2
Alliance Access 7.6.20 Table of Contents
Message Management Guide

8.5 Message Queues and Routing.............................................................................................................. 55


8.6 Message Information for FIN and APC Messages................................................................................ 56
8.7 Message Information for SWIFT MX Messages.................................................................................... 58
8.8 Business Identifier Code (BIC).............................................................................................................. 61

9 Help about Message Standards........................................................................................................... 64


9.1 Help for Messages.................................................................................................................................64
9.2 Category Volumes: MT Message Text Standards..................................................................................68
9.3 Help for a FIN Message.........................................................................................................................68
9.4 Structure of Fields in FIN Messages......................................................................................................72
9.5 Field Formatting Rules...........................................................................................................................74

10 Message Creation..................................................................................................................................93
10.1 Create Messages...................................................................................................................................93
10.2 Create FIN Messages............................................................................................................................94
10.3 Create APC Messages........................................................................................................................ 100
10.4 Create MX Messages.......................................................................................................................... 101
10.5 Use Message Templates..................................................................................................................... 106
10.6 Create a Message from an Existing Message..................................................................................... 122
10.7 Fast Mode............................................................................................................................................123
10.8 Validate a Message............................................................................................................................. 126
10.9 Route a Message.................................................................................................................................130
10.10 Send a Message to a Queue (Dispose to)...........................................................................................131
10.11 File Message: Send.............................................................................................................................133
10.12 File Message: Get................................................................................................................................141
10.13 RMA Check Failure for File Messages................................................................................................ 148

11 Message Modification......................................................................................................................... 150


11.1 Message Modification Page Example..................................................................................................152
11.2 Modify a Message................................................................................................................................154
11.3 Messages in the Text Modification Queue...........................................................................................156
11.4 Messages in the Emission Security Modification Queue..................................................................... 158
11.5 Messages in the Reception Security Modification Queue................................................................... 159
11.6 Messages in the Modification for Transmission Queue....................................................................... 161
11.7 Messages in the Modification After Reception Queue.........................................................................161

12 Message Approval...............................................................................................................................162
12.1 Message Verification Page.................................................................................................................. 166
12.2 Message Verification............................................................................................................................168

17 December 2021 3
Alliance Access 7.6.20 Table of Contents
Message Management Guide

12.3 Verify a FIN, APC, or MX Message..................................................................................................... 171


12.4 Verify a FileAct Message..................................................................................................................... 172
12.5 Message Authorisation Page...............................................................................................................173
12.6 Message Authorisation........................................................................................................................ 175
12.7 Authorise a Message...........................................................................................................................176
12.8 Message Recovery Page.....................................................................................................................178
12.9 Recover Messages..............................................................................................................................181
12.10 InterAct and FileAct Retrieval.............................................................................................................. 184

13 RMA Central SWIFTNet Database: Negative Acknowledgement.................................................... 186

14 Message Search and Report.............................................................................................................. 187


14.1 Searching for Messages, Instances, and Templates........................................................................... 187
14.2 Message Search..................................................................................................................................190
14.3 Specify Search Criteria........................................................................................................................209
14.4 Message Instances..............................................................................................................................230
14.5 Message Templates.............................................................................................................................239
14.6 File Transfer Monitoring.......................................................................................................................242
14.7 Types of Reports..................................................................................................................................247
14.8 Generate a Report of Messages from Search Criteria........................................................................ 257
14.9 Generate a Report of Messages from Search Results........................................................................ 259
14.10 Generate a Message Instance Report.................................................................................................260
14.11 Generate a Message Count Report.....................................................................................................261
14.12 Generate a Messages in Queues Report............................................................................................ 262

15 Operational Reporting.........................................................................................................................264
15.1 Ready-to-Use Reports.........................................................................................................................265
15.2 Terminology......................................................................................................................................... 278
15.3 Set Up and Manage the Reporting Data Store....................................................................................280
15.4 Manage Reports from the Reporting GUI............................................................................................ 286
15.5 Overview of the Reporting Command-Line Tool.................................................................................. 294
15.6 Manage Reports and Data from the Command Line........................................................................... 298

16 Batch File Transfer.............................................................................................................................. 301


16.1 Message Partners................................................................................................................................301
16.2 Overview of Manual File Transfer........................................................................................................301
16.3 Recovery of Batch Sessions................................................................................................................303
16.4 Batch File Transfer Sessions...............................................................................................................303
16.5 Message Partner Session Details........................................................................................................309

17 December 2021 4
Alliance Access 7.6.20 Table of Contents
Message Management Guide

Legal Notices................................................................................................................................................. 313

17 December 2021 5
Alliance Access 7.6.20 Preface
Message Management Guide

Preface
Purpose
This guide describes how to perform business and administration tasks in Alliance Message
Management using the interface that is provided as a package for the Alliance Web Platform
Server-Embedded.

Audience
This guide is for operators who perform business and administration tasks using the Alliance
Message Management interface.

About Alliance Web Platform Server-Embedded


Alliance Web Platform Server-Embedded is the framework that hosts browser-based graphical user
interfaces (GUI) of the Alliance portfolio. It offers a consistent end-user interface to the functionality
managed by the Alliance servers. Alliance Web Platform Server-Embedded runs in an application
server environment, enabling centralised deployment of the software.

17 December 2021 6
Alliance Access 7.6.20 SWIFT Training
Message Management Guide

1 SWIFT Training
SWIFT provides training about standards, products, and services to suit different needs. From
tailored training to self-paced e-learning modules on SWIFTSmart, a range of training options are
available for all SWIFT end users.

SWIFTSmart
SWIFTSmart is an interactive, cloud-based training service that offers a large variety of courses for
different levels of knowledge. The courses contain exercises and quizzes and are available in
multiple languages. The SWIFTSmart catalogue provides a list of courses that are organised into
these learning tracks:
• General knowledge
• Work with messages
• Deploy and manage SWIFT software solutions
• Security and audit
• Compliance and shared services
SWIFTSmart is accessible from the desktop or a mobile device. No installation is required.
SWIFTSmart is available to all connected SWIFT end users and registered SWIFT partners with a
swift.com account. For more information, see How to become a swift.com user.

Tailored training
A full range of tailored programmes is available to meet specific training needs. For more
information, visit the Training web page.

17 December 2021 7
Alliance Access 7.6.20 Alliance Message Management
Message Management Guide

2 Alliance Message Management


Alliance Message Management is a browser-based Graphical User Interface (GUI) for managing
messages manually. Alliance Message Management provides an interface to Alliance Access,
which manages the flow and life cycle of messages.
Alliance Access offers comprehensive message management functionality, such as manual
message creation, verification, authorisation, repair (modification) and consultation.

When applicable, operators can also consult, verify, authorise, and modify messages created by
back-office applications. Back-office applications can send a message as read-only, meaning that it
cannot be modified in Alliance Access.

Supported messages
Alliance Message Management supports FIN and APC messages (MT), Standards XML messages
(MX), FpML messages, and file messages (FileAct). When Alliance Message Management
connects to Alliance Access, messages with the format AnyXML and Proprietary can also appear
in queues, search results, or reports.

Operator permissions
The permissions defined in the profile of the operator determine the specific message processing
tasks that an operator can perform with Alliance Message Management.

Related information
The Alliance Message Management GUI on page 23

17 December 2021 8
Alliance Access 7.6.20 Logging in to Alliance Message Management
Message Management Guide

3 Logging in to Alliance Message Management


The Alliance Message Management workspace displays the Welcome page by default when a user
logs in.
A Welcome page is available that enables you to access all of the Alliance Access GUI applications
at once, using a single sign-on.
To access the Welcome page, use the following URL:
https://<host>[:<port>]/swp/group/access.

When logged in to Alliance Message Management hosted on Alliance Web Platform Server-
Embedded, you can open a new browser window or tab (depending on browser configuration) by
using the browser's embedded options within a single session.
Your Alliance security officer defines the login method that you must use.
Procedure
Follow the steps in the appropriate procedure.
• Log in Using Two-Factor Authentication (TOTP) on page 9
• Log in Using an Identity Provider on page 13
• Log in Using a SWIFT Personal Token on page 17
• Log in Using a User Name and Password on page 19
Note Login with a user name and password without a second factor of authentication
must be avoided as it is not in line with the Customer Security Programme SWIFT
Customer Security Controls Framework Detailed Description.
Related information
Alliance Access Security Guide

3.1 Log in Using Two-Factor Authentication (TOTP)


This procedure describes how to log in to Alliance Message Management hosted on Alliance Web
Platform Server-Embedded using two-factor authentication (TOTP).
Before you begin
You will need your two-factor authentication code. For additional information, see Two-Factor
Authentication on page 11.
You also need the following:
• A valid URL for Alliance Message Management. The administrator of Alliance Web Platform
Server-Embedded provides this information.
This is the default URL:
https://<host>[:<port>]/swp/group/messagemgmt

Where:
- <host> is the Alliance Web Platform Server-Embedded host name
- <port> indicates the port number

It is not necessary to specify a value for <port> if the default port for HTTPS is used.
- swp refers to Alliance Web Platform Server-Embedded

17 December 2021 9
Alliance Access 7.6.20 Logging in to Alliance Message Management
Message Management Guide

- group/messagemgmt refers to Alliance Message Management

To optimally display the information in Alliance Message Management pages, set your screen
resolution to 1280 by 768 pixels or higher.
If you use the zoom functionality of the browser, then please note that the layout of Alliance
Message Management labels can be incorrect when the display value of the browser is not set at
100 percent.
Procedure
1. Start your browser.
2. Perform one of these actions to provide the URL for Alliance Message Management, as
applicable:
• Type the URL in the address bar of your browser and press ENTER.
• Select the URL from your list of saved links, for example, from Favourites or Bookmarks.
• Select the URL from the list of previously visited addresses.
3. The How would you like to login? window appears.

4. Select the authentication type Two-factor authentication code.


The browser will remember your option the next time you log in and will only display the
authentication option you selected. In order to select a different authentication option, click on
Select different login option .

Note An announcement may be displayed, if your administrator has configured to show


an informational message before you log in. You must dismiss this message in
order to enter your login credentials.
5. Type your two-factor authentication code.
If this is your first log on, or your password has been reset, you will need to 'enroll'. See Two-
Factor Authentication on page 11.
6. If multiple Alliance Access instances have been configured for the Alliance Web Platform
Server-Embedded host, then select the applicable instance from the Alliance Server Instance
drop-down list.

17 December 2021 10
Alliance Access 7.6.20 Logging in to Alliance Message Management
Message Management Guide

7. Click Login .
Tip If you experience problems logging in, then delete the browser cache and try
again.
You can delete these files from the Tools menu or Options window. The exact
location depends on your browser type and release.
You have successfully logged in, when you see the Welcome page.

The Welcome page shows a list of shortcuts to tasks that are also available through the menus in
the navigation area.
The list of tasks available depends on your operator profile and the application group. The Alliance
Web Platform administrator configures an application group through the GUI application.
Tip When you log out of any browser tab or window, then the system will end any
sessions opened in the other remaining browser tabs or windows.

3.1.1 Two-Factor Authentication


Two-factor authentication (2FA) is a method of user authentication where at least two different
components are required to authenticate a user. Typically, this is something you know (user name/
password) and something you have (for example, a one-time-password generator or a token).
In addition to the RADIUS one-time password method, Alliance Access provides a secure 2FA
setup using an off-the-shelf application that can be installed on a separate device, such as a mobile
phone or tablet.
Two-factor authentication using LDAP can be achieved by enabling a feature or plug-in for the
LDAP server that provides time-based one-time password (TOTP) or One-time Password (OTP) in
addition to the fixed password.
As with the LDAP and RADIUS solution, SWIFT does not recommend a specific vendor of client
time-based one-time password (TOTP) solutions. The solution selected for the TOTP second factor
must be able to generate passwords (PINs) of exactly 8 digits, support SHA-256, and accept an
activation code, either by scanning the bar code or by typing the code manually.

Time-based one-time passwords


Time-based one-time passwords (TOTP) are temporary passwords (PINs), generated by an
algorithm for use in authenticating access to computer systems.
The algorithm that generates each password uses the current time of day as one of its time-based
one-time factors, ensuring that each password is unique.
With two-factor authentication, the user must enter the Alliance Access user name and password
and the TOTP code to gain access.

17 December 2021 11
Alliance Access 7.6.20 Logging in to Alliance Message Management
Message Management Guide

Personal token
Personal tokens are small USB-based hardware devices that a user carries to authenticate access
to data or services. Personal tokens contain a pair of public and private keys which can be used for
cryptographic operations.

3.1.2 Configure Two-Factor Authentication (TOTP)


Two-factor authentication uses a temporary passcode to strengthen the authentication process
when you log in to an application.
If your operator has been configured for two-factor authentication, then you must configure two-
factor authentication in the following situations:
• when you restore a full or partial database backup from another Alliance Access system
• the first time that you log in
• after your TOTP secret is reset
• if you change the device or application used to generate your time-based one-time password
Before you begin
The Authentication Type parameter for your operator definition must be set to Password and TOTP.
You must have an authenticator mobile phone application or other software or hardware
authenticator tool to generate the time-based one-time password.
If the client device used for generating the time-based one-time password is not available (lost,
stolen, damaged, for example), then the password of the user must be reset, and the configuration
process redone.
Procedure
1. Enter your user name and password (and Instance name, if applicable), and click Login.
Note For configuration itself, the "Use Two-factor Authentication" check box should not
be selected.

17 December 2021 12
Alliance Access 7.6.20 Logging in to Alliance Message Management
Message Management Guide

2. Once your user name and password have been verified, a secret key from Alliance Access is
displayed.

3. Either scan the QR code with an authenticator mobile phone application or other software or
hardware authenticator tool or enter the string on the device manually.

Important Scan or save the key as quickly as possible. Do not leave it displayed on your
screen so that others can observe it.

4. Enter the code generated from your authentication device in the configuration screen, and click
Continue .

5. Alliance Access validates the credentials (user name, password, and authentication code).
If validation is successful, you are logged on.
If not, you can repeat the step with another authentication code. If you quit without entering the
authentication code, then you can set up two-factor authentication the next time you log in (you
will receive a new secret).

3.2 Log in Using an Identity Provider


This procedure describes how to log in to Alliance Message Management hosted on Alliance Web
Platform Server-Embedded using an identity provider (IdP).

17 December 2021 13
Alliance Access 7.6.20 Logging in to Alliance Message Management
Message Management Guide

It is the responsibility of the Identity Provider Server to log authentication attempts.


Before you begin
You must have your IdP credentials that you received from your IdP administrator. For more
information, including the prerequisites, see "Configure Identity Provider Authentication" in the
Alliance Access Configuration Guide.
You also need the following:
• A valid URL for Alliance Message Management. The administrator of Alliance Web Platform
Server-Embedded provides this information.
This is the default URL:
https://<host>[:<port>]/swp/group/messagemgmt

Where:
- <host> is the Alliance Web Platform Server-Embedded host name
- <port> indicates the port number

It is not necessary to specify a value for <port> if the default port for HTTPS is used.
- swp refers to Alliance Web Platform Server-Embedded
- group/messagemgmt refers to Alliance Message Management

To optimally display the information in Alliance Message Management pages, set your screen
resolution to 1280 by 768 pixels or higher.
If you use the zoom functionality of the browser, then please note that the layout of Alliance
Message Management labels can be incorrect when the display value of the browser is not set at
100 percent.
Procedure
1. Start your browser.
2. Perform one of these actions to provide the URL for Alliance Message Management, as
applicable:
• Type the URL in the address bar of your browser and press ENTER.
• Select the URL from your list of saved links, for example, from Favourites or Bookmarks.
• Select the URL from the list of previously visited addresses.

17 December 2021 14
Alliance Access 7.6.20 Logging in to Alliance Message Management
Message Management Guide

3. The How would you like to login? window appears.

4. Select the authentication type Identity provider.


The browser will remember your option the next time you log in and will only display the
authentication option you selected. In order to select a different authentication option, click on
Select different login option .

Note An announcement may be displayed, if your administrator has configured to show


an informational message before you log in. You must dismiss this message in
order to enter your login credentials.
5. In the next window, select the Identity Provider and the Alliance server instance to be used and
click Login .

17 December 2021 15
Alliance Access 7.6.20 Logging in to Alliance Message Management
Message Management Guide

6. You will be redirected to the IdP login page provided by your institution, where you must
provide your credentials.

For example:

Tip If you experience problems logging in, then delete the browser cache and try
again.
You can delete these files from the Tools menu or Options window. The exact
location depends on your browser type and release.
You have successfully logged in, when you see the Welcome page.

The Welcome page shows a list of shortcuts to tasks that are also available through the menus in
the navigation area.

17 December 2021 16
Alliance Access 7.6.20 Logging in to Alliance Message Management
Message Management Guide

The list of tasks available depends on your operator profile and the application group. The Alliance
Web Platform administrator configures an application group through the GUI application.
Tip If you have configured your IdP server with a logout URL, when you log out of any
browser tab or window, then the IdP server will log you out from all the other groups
you are logged in on other browser tabs or windows.

3.3 Log in Using a SWIFT Personal Token


This procedure describes how to log in to Alliance Message Management hosted on Alliance Web
Platform Server-Embedded using a SWIFT personal token.
Before you begin
You must have the token and the token password. For more information including the prerequisites,
see "Using Personal Tokens on Alliance Access" in the Alliance Access Configuration Guide.
You also need the following:
• A valid URL for Alliance Message Management. The administrator of Alliance Web Platform
Server-Embedded provides this information.
This is the default URL:
https://<host>[:<port>]/swp/group/messagemgmt

Where:
- <host> is the Alliance Web Platform Server-Embedded host name
- <port> indicates the port number

It is not necessary to specify a value for <port> if the default port for HTTPS is used.
- swp refers to Alliance Web Platform Server-Embedded
- group/messagemgmt refers to Alliance Message Management

To optimally display the information in Alliance Message Management pages, set your screen
resolution to 1280 by 768 pixels or higher.
If you use the zoom functionality of the browser, then please note that the layout of Alliance
Message Management labels can be incorrect when the display value of the browser is not set at
100 percent.
Procedure
1. Start your browser.
2. Perform one of these actions to provide the URL for Alliance Message Management, as
applicable:
• Type the URL in the address bar of your browser and press ENTER.
• Select the URL from your list of saved links, for example, from Favourites or Bookmarks.
• Select the URL from the list of previously visited addresses.

17 December 2021 17
Alliance Access 7.6.20 Logging in to Alliance Message Management
Message Management Guide

3. The How would you like to login? window appears.

4. Select the authentication type SWIFT Personal token.


The browser will remember your option the next time you log in and will only display the
authentication option you selected. In order to select a different authentication option, click on
Select different login option .

Note An announcement may be displayed, if your administrator has configured to show


an informational message before you log in. You must dismiss this message in
order to enter your login credentials.
5. If multiple tokens are inserted, select the appropriate token from the drop-down list. Alliance
Web Platform Server-Embedded displays the DN from the certificate with the matching policy
ID. Click on Login . In the new window, type the token password and click OK .
Tip If you experience problems logging in, then delete the browser cache and try
again.
You can delete these files from the Tools menu or Options window. The exact
location depends on your browser type and release.
You have successfully logged in, when you see the Welcome page.

The Welcome page shows a list of shortcuts to tasks that are also available through the menus in
the navigation area.

17 December 2021 18
Alliance Access 7.6.20 Logging in to Alliance Message Management
Message Management Guide

The list of tasks available depends on your operator profile and the application group. The Alliance
Web Platform administrator configures an application group through the GUI application.
Tip When you log out of any browser tab or window, then the system will end any
sessions opened in the other remaining browser tabs or windows.
The GUI displays warnings as follows:
• Token certificate expiry
The GUI displays a token certificate expiry warning when the expiration date is within the next
30 days.
For more information, see "Renew Token Certificate" in the Alliance Access Configuration
Guide.
• Token password expiry
The GUI displays a token password (PIN) expiry warning according to the token password
policy selected by your security officer during the DN creation process. For more information,
see "Personal Token Passwords" in the SWIFTNet PKI Certificate Administration Guide.
• Token is locked
The GUI displays a warning when the token is locked or when it is the last password attempt
before the token will be locked. The number of failed attempts before an account is locked is
also determined by the token password policy.
If the token is locked, then no other warnings are displayed.

3.4 Log in Using a User Name and Password


This procedure describes how to log in to Alliance Message Management hosted on Alliance Web
Platform Server-Embedded using a user name and password (including LDAP and RADIUS).
Before you begin
You must have a user name and a password that correspond to your operator definition. The
administrator of your Access server provides this information.
You also need the following:
• A valid URL for Alliance Message Management. The administrator of Alliance Web Platform
Server-Embedded provides this information.
This is the default URL:
https://<host>[:<port>]/swp/group/messagemgmt

Where:
- <host> is the Alliance Web Platform Server-Embedded host name
- <port> indicates the port number

It is not necessary to specify a value for <port> if the default port for HTTPS is used.
- swp refers to Alliance Web Platform Server-Embedded
- group/messagemgmt refers to Alliance Message Management

To optimally display the information in Alliance Message Management pages, set your screen
resolution to 1280 by 768 pixels or higher.

17 December 2021 19
Alliance Access 7.6.20 Logging in to Alliance Message Management
Message Management Guide

If you use the zoom functionality of the browser, then please note that the layout of Alliance
Message Management labels can be incorrect when the display value of the browser is not set at
100 percent.
Procedure
1. Start your browser.
2. Perform one of these actions to provide the URL for Alliance Message Management, as
applicable:
• Type the URL in the address bar of your browser and press ENTER.
• Select the URL from your list of saved links, for example, from Favourites or Bookmarks.
• Select the URL from the list of previously visited addresses.
3. The How would you like to login? window appears the first time you log in from a given
browser.

4. Select the authentication type User name and password.


The browser will remember your option the next time you log in and will only display the
authentication option you selected. In order to select a different authentication option, click on
Select different login option .

Note An announcement may be displayed, if your administrator has configured to show


an informational message before you log in. You must dismiss this message in
order to enter your login credentials.
5. Enter your User Name and Password. Both are case sensitive.
If you are using your password for the first time, then you must enter the password received
from the security officers of your Alliance Access server.
When you click Login , you are prompted to change it. See Change Your Password on page
21 for details. This is not applicable if the authentication method used for your operator
definition is either RADIUS or LDAP.

17 December 2021 20
Alliance Access 7.6.20 Logging in to Alliance Message Management
Message Management Guide

6. If multiple Alliance Access instances have been configured for the Alliance Web Platform
Server-Embedded host, then select the applicable instance from the Alliance Server Instance
drop-down list.
7. Click Login .
Tip If you experience problems logging in, then delete the browser cache and try
again.
You can delete these files from the Tools menu or Options window. The exact
location depends on your browser type and release.
You have successfully logged in, when you see the Welcome page.

The Welcome page shows a list of shortcuts to tasks that are also available through the menus in
the navigation area.
The list of tasks available depends on your operator profile and the application group. The Alliance
Web Platform administrator configures an application group through the GUI application.
Tip When you log out of any browser tab or window, then the system will end any
sessions opened in the other remaining browser tabs or windows.

3.5 Change Your Password


You can change your password on demand or if it is requested by the system.
All operators with the authentication type Password or Password and TOTP are requested to
change their password when logging in the following situations:
• at the first login with a new user password
• when the password has expired
• if the password was reset on the Alliance server
The frequency with which you have to change your password depends on the security
configuration parameters set on the Alliance server. For password requirements, check with the
security officers of your Alliance server.
The possible maximum length of the password is 64 characters. The minimum length is set by your
organisation's security policy.
Note This procedure does not apply for the following authentication types:
• Personal token
• Identity provider (IdP)
• LDAP
• RADIUS

17 December 2021 21
Alliance Access 7.6.20 Logging in to Alliance Message Management
Message Management Guide

Procedure
1. If you want to change your password on demand, then click the User: <name> menu in the
upper right corner of the navigation area.
There are three options displayed. Change Password, Session Info, and Time Zone.
2. Click the Change Password menu option.
The Change Password window appears.
3. Type your current password in the Old Password field. Then type your new password in the
New Password and Password Verification fields.
4. Click Change Password .
The password is changed.

17 December 2021 22
Alliance Access 7.6.20 The Alliance Message Management GUI
Message Management Guide

4 The Alliance Message Management GUI


The Alliance Message Management GUI displays the home page by default when a user logs in.
Note To optimally display the information in Alliance Message Management pages, set your
screen resolution to 1280 by 768 pixels or higher.

4.1 Online Help


All pages within Alliance Message Management contain the Help link in the upper-right corner of
the navigation area of the GUI.
Clicking the Help link displays the online help that corresponds to the page or entity that is
currently selected. It also enables you to navigate to other topics within the online help.

Help for messages


If the online help for message standards is installed, then Alliance Message Management can
display help about a specific message in a message standard. The help about messages is not
available from the Help link in the title bar.
For more information about how to display the help about messages, see Help for Messages on
page 64.

Help for entering values in fields


Alliance Message Management provides tools to help you enter values with the correct syntax, for
example, how to select and enter dates or times. For more information, see User Assistance in the
Online Help, available after login.

Behaviour
If you click the Help link, then the corresponding help file opens in a new window. The system
opens the help file at the content that corresponds to the page or entity that is currently selected.
You can use the navigational links that are available in the help window to show other topics from
within the online help.
The page from which you click the Help link determines the topics that the system shows:
• If you click the Help link on a page within Alliance Message Management, then the system
opens the Alliance Message Management online help.

4.2 Tips and Tricks for Using Alliance Message


Management
Click the logo at any time to return to the home page.

Navigation between task pages


In Alliance Message Management, you can open several items at the same time from different
menus. This enables you to edit messages and switch between the message editor and other task
pages at the same time.
If you are creating a FIN message (Creation menu), then you can open an MX message template,
and also open a message in the Modification menu. The information remains active for all three
tasks.

17 December 2021 23
Alliance Access 7.6.20 The Alliance Message Management GUI
Message Management Guide

You cannot open the same task twice. For example, you cannot create two MX Message: New at
the same time.
You can also do a message search (Search and Report menu) while you edit messages or
complete other tasks. However, if you do a Message Search and view the message search results
for a particular message then return to another task, the search results are discarded. This means
that you must run the message search again.

Changing page size and possible impact


You can use the Change View function to set the value for Page Size, which changes the
maximum number of rows that the list shows at a time. You can use the Change View function to
change the column width, and to show or hide columns, if it is applicable for the current list. It is
also possible to drag and drop items to re-order them.
Note The default and recommended value is 100. Using a higher value may have an impact
on the performance of Alliance Message Management. The more items that you ask
to be displayed on a page, the longer it takes to receive the page in your browser.
Changing the Page Size value must be done with care.

Data input or modification in a form


The background of a property field changes to a different colour when it contains a value that is not
valid. You can move the cursor over the property field to display details about the error. You cannot
save properties if any field contains a value that is not valid.

Selection lists
Some pages in Alliance Message Management display a list that enables you to select one or more
values for a field.
To select a group of values that are not sequential, click a value and then hold down the CTRL key
and click the other values.

4.3 Alarm Notifications


Alarm notification banner
When one or multiple alarm(s) happen(s) while the operator is logged in (and the operator is in the
distribution list), a wide banner appears on the top of the page, with a clickable summary list of
alarms for action.
When clicked, the link opens the alarm details pop-up windows.
This wide banner can be discarded by clicking on a close icon. Otherwise, it disappears after 10
seconds (unless the mouse cursor is not on it, in which case the banner will stay until you move the
cursor outside the banner).
When an alarm for action is raised, all operators in the distribution list receive the alarm. Once the
alarm is treated by an operator, the alarm description is appended with the details of the
intervention (date, time, and operator user name).
The alarm banner and counter are displayed in the individual GUI applications only. They are not
displayed on the Home page, because the Home page is part of Alliance Web Platform Server-
Embedded.

17 December 2021 24
Alliance Access 7.6.20 The Alliance Message Management GUI
Message Management Guide

Configure alarm notifications


The Alarm system parameter Timeout represents the amount of time the alarm is kept in the
Alliance Access database before being removed. When the alarm is removed from Alliance
Access, Web Platform no longer displays the alarm.
The maximum number of alarms that can be displayed is controlled by the Alarm system
parameter Maximum.

Alarm button
An alarm button is located on the top right of the page (in the Web Platform banner) and indicates
the number of alarms for action and information.
The alarm counter is increased and highlighted when there are new alarms not treated. The alarm
counter is also increased (and not highlighted) when there is a new alarm already treated.
When this button is clicked, it opens a pop-up window that displays the list of alarms. Each entry
has two buttons, to treat or dismiss the alarm.
Once an alarm is treated or dismissed, it is no longer counted in the alarms total.

4.4 Wildcards for Searching or Filtering


Where the functionality is available, you can use criteria to search or to filter the list for the current
page for a specific set of information.

Criteria
This is the behaviour for the search or filtering operation:
• If you do not specify a value for a criterion, then the system does not take that criterion into
account.
• If you specify values for more than one criterion, then the system uses an AND relationship to
evaluate these criteria.

Wildcards
Some of the search criteria and the filtering criteria fields allow you to use these wildcards:

Wildcard Purpose Example

% (percent) Replaces one or more contiguous unknown a%a matches for example the
characters in a string following strings:
• aba
• afedpa
• azhgjdhsa

_ (underscore) Replaces one unknown character in a string aa_a matches for example the
following strings:
• aa1a
• aaGa

17 December 2021 25
Alliance Access 7.6.20 The Alliance Message Management GUI
Message Management Guide

4.5 Behaviour and Format of Date and Time Fields


Alliance Message Management lets you enter values manually or select values from a picker for
fields that require date or time values.
You can enter relative values in date or time fields, except for fields that use ISO date and time
formats.
A relative value is automatically converted to an absolute date or time value when the cursor
leaves the field. The conversion generates an absolute date or time value that corresponds to the
syntax for the field. The absolute value is calculated relative to the current date or time of the host
running the browser. For example, use a relative value to calculate quickly the date "five days ago".
The relative date calculation supports dates within the range of years 1970 to 2037.

Relative date and time values


The following is the syntax used to enter relative date or time values:
<symbol><number><unit>
Where:

Variable Values

<symbol> + or -

<number> a numeric value

<unit> d, D, m(M), y or Y for a date field, with d as default.


h, H, m (no M), s or S for a time field, with h as default
Uppercase letters are accepted.
The expected syntax for a field determines which values are relevant.

You can enter both m and M. As the date field does not use minutes, the m is converted into M to
represent months. For example: +12m becomes +12M and represents 12 months in the future.
If you enter an incorrect character, then Alliance Access removes it automatically.
Examples

Typed value Field type Result

+6h or +6 Time Alliance Message Management increases the current time by six hours.

-7d or -7 Date Alliance Message Management sets the date to seven days before the
current date.

+0 or -0 Time Alliance Message Management sets the time to the current time.

+0 or -0 Date Alliance Message Management sets the date to the current date.

Date formats
To view the format of the data that a field requires, move the mouse over the picker icon or the
field.

17 December 2021 26
Alliance Access 7.6.20 The Alliance Message Management GUI
Message Management Guide

The Alliance Web Platform Server-Embedded administrator defines the date format that Alliance
Message Management displays. For information about how to change the default date format, see
"Alliance Web Platform Configuration Parameters" in the Alliance Web Platform Server-Embedded
Administration and Operations Guide.
The date picker supports these date formats:

Date format Example

YYYY/MM/DD 16 June 2021 is represented as: 2021/06/16

DD/MM/YYYY 16 June 2021 is represented as: 16/06/2021

MM/DD/YYYY 16 June 2021 is represented as: 06/16/2021

Picker for Date, Time, and Time Zone


Alliance Message Management provides an additional picker to specify dates and times, and
optionally time zones, when working with messages.
The content of the field that is next to the picker determines the initial value of the picker:
• Both the Date/Time From and Date/Time To fields can be empty. The field remains empty, and
the search does not take any date into account.
• If the first date picker is filled in with a valid date, but the second remains empty, when the
search is launched, the second field is filled in automatically.

Date From Time From Date To Time To Date From Time From Date To Time To
Result Result Result Result

Field is filled Remains the 1899-12-31T0 Set to current 1899-12-31T2


Field is empty Field is empty Field is empty
in same 0:00:00.000 date 3:59:59.000

Field is filled Set with the 1899-12-31T0 Remains the 1899-12-31T2


Field is empty Field is empty Field is empty
in Date To value 0:00:00.000 same 3:59:59.000

Field is filled Set to current Remains the Set to current 1899-12-31T2


Field is empty Field is empty Field is empty
in date same date 3:59:59.000

Field is filled Set to current 1899-12-31T0 Set to current Remains the


Field is empty Field is empty Field is empty
in date 0:00:00.000 date same

• If the field already contains a value that uses the correct format and syntax, for example,
2012-04-18T15:13:43, then the picker is set to that date and time. Click the picker if you want
to change the value in this field to the current date and time or to select another date and time.
• If the field is set to a date that is not valid (for example, 2012-02-31T11:08:10), then the field
displays the error colour. If you then click the picker, then the field will be set to the current date
and time. One example of how the field can be set to a date that is not valid is if you manually
type an incorrect date.
• The Time drop-down list allows you to change the time.
• The Time Zone drop-down list allows you to select the offset from UTC (that is, the number of
hours deviation).
If you select a specific offset from UTC, then the picker formats the date and time accordingly.
For example, UTC -06:00 hours are represented as 2012-04-18T15:13:43-06:00.

17 December 2021 27
Alliance Access 7.6.20 The Alliance Message Management GUI
Message Management Guide

4.6 User Assistance


This section describes the user assistance that is available to help you enter data in fields in
Alliance Message Management using the correct format and syntax.
A picker is a graphical element that is located beside a field in some pages. It helps you to enter
data (such as dates or times) according to the correct syntax and format that the field requires.
For more information about the purpose of a field, or a description of the values that you can enter,
see Online Help on page 23 and Help for Messages on page 64.

4.6.1 Pickers
Description
A picker is a graphical element that is located beside a field in some pages. It helps you to enter
data according to the correct syntax and format that the field requires.
If Alliance Message Management shows to the right of a field, then the picker lets you enter the
following types of information:
• a file name using the Choose File function
• data that is appropriate to the field, such as a date

Types of pickers
These are the different types of pickers available within Alliance Message Management:
• Date picker (see Date Picker on page 28 )
• Time picker (see Time Picker on page 30 )
• Picker for date, time, and time zone (see Picker for Date, Time, and Time Zone on page 31 )
• BIC picker (see Choosing a BIC on page 32 )
• Currency picker (see Currency Picker on page 34 )

4.6.2 Date Picker


Purpose
There are two types of date pickers in Alliance Message Management. The date picker that is
described here is the generic date picker for Alliance Web Platform Server-Embedded. An
additional picker is provided for working with messages. For more information, see Picker for Date,
Time, and Time Zone on page 31.
A date picker enables you to select and enter a date using the correct format in the date field of an
MT or MX message, or in the date range fields in a search.

17 December 2021 28
Alliance Access 7.6.20 The Alliance Message Management GUI
Message Management Guide

Example of a date picker

The following is an example of the calendar that appears in a date picker:

Date formats
To view the format of the data that a field requires, move the mouse over the picker icon or the
field.
The Alliance Web Platform Server-Embedded administrator defines the date format that Alliance
Message Management displays. For information about how to change the default date format, see
"Alliance Web Platform Configuration Parameters" in the Alliance Web Platform Server-Embedded
Administration and Operations Guide.
The date picker supports these date formats:

Date format Example

YYYY/MM/DD 16 June 2012 is represented as: 2012/06/16

DD/MM/YYYY 16 June 2012 is represented as: 16/06/2012

MM/DD/YYYY 16 June 2012 is represented as: 06/16/2012

How to use a date picker


To open the date picker, click .
Select the values for the year, the month, and the day. If required, navigate to another year or
month by clicking the arrow icons in the top left or right corners of the calendar.
The content of the field that is related to the picker determines the subsequent behaviour of the
picker:
• If the field already contains a value that is syntactically correct, then the picker is set to that
value.
• If the field is empty, then the picker shows the current date.
• If the field is set to a date that is not valid (for example, 31 February 2009), then the colour of
the date field changes. You must select a valid date in the correct format.

Type a date in a date field


You can type a date directly in the date field without using a date picker. The date that you type
must use the correct format that the field requires.

17 December 2021 29
Alliance Access 7.6.20 The Alliance Message Management GUI
Message Management Guide

Tip When you enter a date directly in the date field, you can omit the separator.
You can also enter a relative date, such as plus one month or minus five days. For
information about relative dates, see Behaviour and Format of Date and Time Fields
on page 26.

4.6.3 Time Picker


Purpose
There are two types of time pickers in Alliance Message Management. The time picker that is
described here is the generic time picker for Alliance Web Platform. An additional picker is provided
for working with messages. For more information, see Picker for Date, Time, and Time Zone on
page 31.
Alliance Message Management requires that a value entered in a time field be syntactically correct.
The time picker enables you to select a time and then adds it to the field using the correct syntax.
To open the time picker, click .
When you search for messages based on creation time, the time picker is also available for
selecting a from time and a to time.

Example

Allowed values
The time picker enables you to select a time from a drop-down list, which is either on the hour or at
a half past the hour. To enter a more specific time, for example 10:13:45, you can enter it directly
in the time field.
When you enter a time, it is not necessary to include the colons, but you must include leading
zeros where applicable. For example, you can enter either 082500 or 08:25:00.
If you enter a time that does not follow this syntax, then the time picker ignores it and sets the field
to its default value.
Tip You can also enter a relative time, such as plus 1 hour, or minus 5 minutes. For
information about relative times, see Behaviour and Format of Date and Time Fields
on page 26.

17 December 2021 30
Alliance Access 7.6.20 The Alliance Message Management GUI
Message Management Guide

How to use a time picker


When the time picker is opened, the content of the related field determines the subsequent
behaviour of the time picker:
• If the field does not contain a value, then the time picker drop-down list does not display any
selected time.
• If the field already contains a value that is not syntactically correct, then the same behaviour
occurs as if the field does not contain a value.
• If the field already contains a value that is syntactically correct and is a time on the hour or half
hour, then the time picker is set to that value.

4.6.4 Picker for Date, Time, and Time Zone


Purpose
Alliance Message Management provides an additional picker to specify dates and times, and
optionally time zones, when working with messages.

Example of a picker for date, time, and time zone

How to use a date, time, and time zone picker


To open the picker, click .
The content of the field that is next to the picker determines the initial value of the picker:
• If the field is empty, then click the picker. The field now shows the current date and time.
• If the field already contains a value that uses the correct format and syntax, for example,
2012-04-18T15:13:43, then the picker is set to that date and time. Click the picker if you want
to change the value in this field to the current date and time or to select another date and time.
• If the field is set to a date that is not valid (for example, 2012-02-31T11:08:10), then the field
displays the error colour. If you then click the picker, then the field will be set to the current date
and time. One example of how the field can be set to a date that is not valid is if you manually
type an incorrect date.
• The Time drop-down list allows you to change the time.

17 December 2021 31
Alliance Access 7.6.20 The Alliance Message Management GUI
Message Management Guide

• The Time Zone drop-down list allows you to select the offset from UTC (that is, the number of
hours deviation).
If you select a specific offset from UTC, then the picker formats the date and time accordingly.
For example, UTC -06:00 hours are represented as 2012-04-18T15:13:43-06:00.

4.6.5 Choosing a BIC


Alliance Message Management requires that a business identifier code (BIC) value entered in a
relevant field be syntactically correct. The BIC picker enables you to search for BIC information
based on values that you specify. Then, it adds the information about the selected BIC from the
search results, to the field or fields, using the correct syntax.
The BIC picker is only available if your operator profile has the Correspondent Info entity
selected.

Search criteria
The BIC picker enables you to enter a value in one or more search criteria and then click Search or
press ENTER to submit the criteria.
Choose the type required from the Type drop-down list:
• Institution
• Department
• Individual
Depending on the type of BIC required, the BIC picker offers these fields as search criteria:

Field Description

Institution To search based on the BIC or part of it.


If lower-case letters are typed, then they are converted to upper-case letters. If a value
is already typed in the field in Alliance Message Management, then it is proposed in this
field in the criteria. If the entered value is less than the expected value, then the wildcard
% is added automatically. The wildcard _ can also be used.

Institution Name To search based on the name of the institution or part of it.
This is a case-sensitive field. Wildcards can be used.

Branch To search based on the branch name of the institution or part of it.
This is a case-sensitive field. Wildcards can be used.

City To search based on the city name of the institution or part of it.
This is a case-sensitive field. Wildcards can be used.

Country Code To search based on the country code of the institution or part of it.
If lower-case letters are typed, then they are converted to upper-case letters. Wildcards
are not allowed.

Department To search based on department-related information for an institution.


This is a case-sensitive field.

17 December 2021 32
Alliance Access 7.6.20 The Alliance Message Management GUI
Message Management Guide

Field Description

First Name To search based on a person's first name.


This is a case-sensitive field.

Last Name To search based on a person's last name.


This is a case-sensitive field.

Note The wildcard % replaces one or more contiguous unknown characters in a string. The
wildcard _ replaces one unknown character.

How to use the BIC picker


To open the picker, click .
Provide values for the search criteria and initiate the search.
The BIC picker sorts the search results in alphanumerical order by institution. The list shows no
more than 20 search results at a time. If necessary, Alliance Message Management truncates the
values to display them in the column width that is available.
Clicking a row in search results adds the information about the BIC in the relevant field or fields.
The expansion text for the value selected appears.
You can move the mouse over a row in the search results to display the complete institution name,
city, and branch information.
You can sort the rows in the search results by clicking the name of a column.

Example

Related information
Online BIC Search

17 December 2021 33
Alliance Access 7.6.20 The Alliance Message Management GUI
Message Management Guide

4.6.6 Currency Picker


Purpose
Alliance Message Management requires that a currency code value entered in a relevant field for
an MT or an MX message be a relevant value. The picker enables you to select a currency code
and then adds it to the field.
The Currency picker is only available if your operator profile has the Correspondent Info entity
selected.

Example

How to use the currency picker


To open the picker, click .
The picker shows a list of currency codes, which are sorted in alphabetical order. If the field already
contains a valid value, then the picker is positioned to the corresponding value in the list.
To add a currency code value to the relevant field, click a row from the list of results. The expansion
text for the value selected appears.
To sort the rows in the list, click the name of the column.
Note If the Alliance Administrator changes the currency information in the Correspondent
Information application during your session, then you must log out and log in again to
use the latest information.

4.7 Change Your List View


The Change View function changes the layout of the list for the current page or window.
You can use the Change View function to do the following:
• specify the maximum number of rows that the list shows at a time (page size)
• show or hide columns
• change the order of the columns
• save changes to column widths
• reset a list to the default layout, including column width
• reset a list to the default layout, except for column width changes

17 December 2021 34
Alliance Access 7.6.20 The Alliance Message Management GUI
Message Management Guide

Procedure
1. If you want to increase or decrease the width of a column in the list, then move the mouse
pointer over the right-side edge of the column header, then click and drag.
2. Repeat the previous step for the other columns in the list, as necessary.
3. Click Change View .
The Change View window opens.
4. Use these methods to change the list layout, as necessary:
• Select or clear the check box for a column to show or hide it.
• Click the name of a column and use the up or down arrow to change its position in the list.
Alternatively, you can drag and drop the column names to reorder them.
5. If you made any changes to the column widths in the current list, then select or clear the Save
Column Widths check box, as necessary.
If you select the Save Column Widths check box, then the system saves the changes to the
column widths and retains them in subsequent sessions.
If you clear the Save Column Widths check box, then the system discards the changes to the
column widths when the current session ends.
6. Type the number of rows for the list to show at a time into the Page Size field, if it is available.
The value must be between 10 and 999.
Note The default and recommended value is 20. Using a higher value may have an
impact on the performance of the GUI. The more messages that you ask to be
displayed on a page, the longer it takes to receive the page in your browser.
Changing the Page Size value must be done with care.
7. Click OK .
The Change View window closes and the list layout changes accordingly.
The system also saves any changes to the column widths, if the Save Column Widths check
box is selected.

4.7.1 Reset List Layout


Procedure
1. Click Change View .
The Change View window opens.
2. If you made any changes to the column widths in the current list, then select or clear the Save
Column Widths check box, as necessary.
If you select the Save Column Widths check box, then the system saves the changes to the
column widths and retains them in subsequent sessions.
If you clear the Save Column Widths check box, then the system discards the changes to the
column widths when the current session ends.

17 December 2021 35
Alliance Access 7.6.20 The Alliance Message Management GUI
Message Management Guide

3. Click Reset and then click OK .


The Change View window closes and the system restores the original layout of the list:
• the default page size
• the original set of columns in the original sequence
• the original column widths (if the Save Column Widths check box is cleared)

4.8 Choose File


This function enables you to select a file from the user space.
Procedure
1. Click next to the corresponding field.
2. Navigate to the parent folder or file that you require.
3. Select the file that you require.
4. Click OK .
The Choose File window closes and the file name populates the corresponding field.

4.9 Print a Report Directly from the GUI


To print a report directly from the Alliance Access GUI, click Print . The behaviour is similar to that
of the Export function of the same GUI, with the following differences:
• The output format is always HTML.
• For font size, you can choose either small, medium, or large.
• The Page Orientation and Page Format options do not apply.
• If you select the All check box for a list, all of the entities displayed on the search page are
displayed. In the Print window, Print Range is set to Selected items.
• If you select nothing in a list, all of the entities matching the criteria across all results (that is, not
limited to the results on the page) are selected. In the Print window, Print Range is set to All
items.
• If you select a subset of the entities in the list, only those entities are selected for printing. In the
Print window, the Print Range is set to Selected items. However, you can change the
selection to All items, which causes all of the entities matching the filters to be printed.
• When the output HTML page is opened in a new tab, the browser print menu is automatically
displayed.

4.10 Report Types and Settings (Export Function)


Purpose
The Export function enables you to run a report about information in the database, and is
available:
• in the search or filtering criteria area of a page
• in the button bar of a list
• in the bottom button bar of a page

17 December 2021 36
Alliance Access 7.6.20 The Alliance Message Management GUI
Message Management Guide

Output
You can use the Export function to produce these types of reports:
• Summary report
Available only from pages that contain lists of entities, this report type enables you to include the
information from at least one or more columns on the page for every entity included in the
report.
• Details report
This report type includes all details for every entity included in the report. You can only choose
the output format and formatting options.
• Count report
This report type shows the number of entities that match the search criteria provided, as well as
the criteria.
If available in the search or filtering criteria area of a page, then the corresponding report includes
all the entities that the current search or filtering criteria return. In the Export window, checking the
"Search Criteria" box will include the current values for search or filtering criteria in the report.
Tip For more information about the types of reports that you can run for messages, see
Message Search and Report on page 187.
Configuring the maximum number of entities in a report
To configure the maximum number of entities that can be displayed in a report, use the Alliance
Web Platform Server-Embedded administration parameter Maximum Number of Entities per
Report. If the number configured in this parameter is exceeded, you will receive the prompt:
Incomplete report: maximum number of entities - as currently configured - is
exceeded.

To avoid this situation, provide a higher value for this parameter. For more information on this
parameter, see Alliance Web Platform Server-Embedded configuration parameters in the Alliance
Web Platform Server-Embedded Administration and Operations Guide.

Sorting in all-entities reports


All-entities reports are reports that include all entities matching the search criteria, without requiring
the manual selection of each individual entity. The entities are sorted in the report as they are
displayed in the GUI list. If there is no list displayed, they are sorted as they would be had you
clicked Search to get a list. This sorting applies to all entities matching the search criteria.

Saving report settings


When you run a report of all entities or a report from a list, you can define settings for the report,
such as Export Type, Page Orientation, Output Format, and Page Format. These settings are
saved as initial values when you re-run the same report.

4.10.1 Run a Report (Export)


The Export function enables you to run a report about information in the database.
Procedure
1. If applicable, select the entities in the list that you want to include in the report.
2. Click Export .
The Export window opens.

17 December 2021 37
Alliance Access 7.6.20 The Alliance Message Management GUI
Message Management Guide

3. If applicable, select the export type.


4. If you select the All check box for a list, all of the entities displayed on the current page are
selected. In the Export window, Export Range is set to Selected items.
If you select nothing in a list, all of the entities matching the criteria across all results (that is,
not limited to the results on the page) are selected. In the Export window, Export Range is set
to All items.
If you select a subset of the entities in the list, only those entities are selected for export. In the
Export window, the Export Range is set to Selected items. However, you can change the
selection to All items, which causes all of the entities matching the filters to be exported.
5. Select the options that you require for the output format and formatting, such as page
orientation (landscape or portrait), page format, and font size (either small, medium, or large).
The Add page break check box is only available when the Export Type is Details and the
Output Format is PDF. This option adds a page break after each record in the report that is
generated.
6. For summary reports, you can choose the columns for which details should be included in the
report from the Available list.
7. Check the options Display Expanded Text, Include Header/Footer, Message Partner Print
Layout, Report Header/Footer, Search Criteria, Sender/Receiver, Instances, and
Interventions as required.
8. Click OK .
The File Download window opens and prompts you to open or save the report file.
9. If necessary, click Open to open the report or Save to save the report, as you require.
To open the report, you must have a tool installed that reads the corresponding file format:
PDF, CSV (only for summary reports), TXT, or XLS.
The system opens or saves the report accordingly.

4.11 Change the Preferences


Some preferences will take effect the next time you log in. The changes to preferences apply only
to you, and not to other users.
These preferences are preserved across sessions, after a system restart, after deletion of the
browser cache or history, and if you connect through a different Alliance Web Platform. These
preferences are also preserved during a database backup, but not during saa_export.
These preferences are also used when you create a message from an existing message using the
Add as button. For more information, see Create a Message from an Existing Message on page
122.

Important You cannot set preferences for FileAct messages.

Procedure
1. Click the Preferences link in the navigation area of the Alliance Message Management GUI.
The Preferences window opens.

17 December 2021 38
Alliance Access 7.6.20 The Alliance Message Management GUI
Message Management Guide

The fields in the window vary depending on the task window that was open when you clicked
the Preferences link.

The following is an example of the Preferences window:

2. To change the value of a setting, select the option you want from the drop-down list next to the
setting:

Preference Task window Description

Date Format All Select either to use the default AWP server value, or a
specific format (for example, American or European).
You must restart the application for any changes to take
effect.

Amount All Select either to use the default server value, or a


Format specific format (for example, Decimal-Comma/
Thousand-Nothing).
You must restart the application for any changes to take
effect.

Mandatory Creation: FIN, MX and APC You can set a colour to indicate mandatory fields. See
Field Colour Message Template or Step 3 on page 40.
Message New

Error Field Creation: FIN, MX and APC You can set a colour to indicate which fields have
colour Message Template or validation or format errors. See Step 3 on page 40.
Message New

Enable Creation: FIN, MX and APC This preference enables you to produce a printed copy
Message Print Message Template or of a message that is being created. .
for Creation Message New

Print to File Creation: FIN, MX and APC When selected, the printed copy of the message goes
Message Template or to file. At print time, the user can modify the export
Message New settings and download the report.
Modification: all items When unselected, the printed copy of the message is
sent to the printer. At print time, the user can modify the
Approval: all items
font size, content, and the printer.

17 December 2021 39
Alliance Access 7.6.20 The Alliance Message Management GUI
Message Management Guide

Preference Task window Description

Enable Modification : all items This setting enables you to produce a printed copy of a
Message Print message that is being modified, after it is routed or
for disposed. .
Modification

Enable Approval: all items This preference enables you to produce a printed copy
Message Print of a message that is being approved (verified or
for Approval authorised), after it is routed or disposed to a message
queue.
The setting for this preference does not affect
messages being authorised without viewing the
content. .

Expansion Creation: FIN, MX and APC This preference enables you to select the language
Language used for displaying field expansions on screen, in the
Modification: FIN, MX and
report obtained by clicking Export , and in the printed
APC
version obtained when the Enable message print for
Approval: FIN, MX and Creation, Modification, or Approval preferences are set.
APC
In reports obtained by clicking Export , this value is
Search and Report: FIN, used if the report type is Details and if the Display
MX and APC expanded text option is selected. In instance reports
obtained by clicking Instance report , this value is used if
both the Display expanded text and Message Partner
Print Layout options are selected.
As well as the supported languages, the Server default
value is displayed. If this value is selected, the language
defined in the Expansion language global
configuration parameter will be used.

Search Search and Report: FIN, If you have the Message File, Search Message
Template MX and APC permission and are opening a new instance of the
(template of Message Search GUI, this preference enables you to
search criteria) automatically execute a search criteria template of your
choosing. The results of the search are displayed in the
list of messages.
This preference is displayed only when you select the
Message Search option.
This field is blank by default, but you can choose from
the drop-down list the name of a search criteria
template that is assigned to your unit.

3. Do the following to change the background colour of Mandatory Field or Error Field:
a) Click next to the appropriate field type box.
A colour palette appears with the colours available for that field type.
b) Click the colour that you want.
The field type box is displayed with the newly selected colour.
4. Click OK to confirm the changes or Cancel to discard the changes.

17 December 2021 40
Alliance Access 7.6.20 UETR and SLA ID Fields in Alliance Access
Message Management Guide

5 UETR and SLA ID Fields in Alliance Access


For certain FIN messages, Alliance Access generates automatically a unique end-to-end
transaction reference (UETR) in the MT header. Alliance Access also checks if the SLA ID (Service
Level Agreement identifier) is populated and generates the value based on the system
configuration parameter.
A UETR is a unique end-to-end transaction reference in the MT header: field 121. This field
provides an end-to-end reference across a payment transaction.
An SLA ID is the service type identifier in the MT header: field 111. This field identifies which
SWIFT gpi service the sender is subscribed to.

FIN Message Types with automatically generated UETR


Alliance Access automatically generates a random RFC4122 v4 UETR value for the following
message types. This feature can be deactivated using the Auto-generate UETR parameter.
Alliance Access also verifies if the SLA ID (field 111 in block 3) is populated for these messages. If
there is no SLA ID, then Alliance Access generates and populates the value if the Auto-generate
SLA ID configuration parameter is activated.
• MT 103
• MT 103 REMIT
• MT 103 STP
• MT 202
• MT 205
• MT 205 COV
• MT 199
MT 202 COV:
If configured to do so using the MT 103 look-up parameter, Alliance Access retrieves the related
Single Customer Credit Transfer MT 103, MT 103 REMIT, or MT 103 STP (using the value for fields
20/21) and copies the UETR used in the MT 103 into the MT 202 COV.
If Alliance Access is not able to retrieve the MT 103 related to the MT 202 COV or if Alliance
Access finds more than one matching MT 103, then the MT 202 COV is sent to the text
modification queue with a reason that indicates that Alliance Access was not able to generate the
UETR value.
If the MT 202 COV is sent without validation (for example, sent by a back-office application), then
the message will not be routed to the text modification queue.
Otherwise, Alliance Access generates a random UETR value.

UETR field in FIN message header


By default, Alliance Access generates automatically a 36 character alphanumeric unique end-to-
end transaction reference (UETR) after you route or dispose the message. Alternatively, you can
manually generate the UETR. If you do this, then you will see the UETR before you route or
dispose the message.
Alliance Access also automatically adds a UETR to messages routed out of the _MP_mod_text
queue if the Auto-generate UETR parameter is set to Yes. The UETR is added when the message
leaves the _MP_mod_text queue.
The network will use NAK code U13 to reject messages that are sent without the UETR.

17 December 2021 41
Alliance Access 7.6.20 UETR and SLA ID Fields in Alliance Access
Message Management Guide

For more information about the fields in the FIN message header, see Complete the Header of a
FIN or APC message on page 97.

UETR in ISO 20022 messages


it is now possible to add a UETR in ISO 20022 messages that have UETR fields. When you create
an MX message in Message Management, in the Body tab there is a Generate button next to fields
of the type UUIDv4Identifier. Contrary to what Alliance Access did during the introduction of the
UETR for FIN messages, Alliance Access does not automatically add random UETR to messages
that were created by a back office or custom code module.
For more information about the XPath of the UETR in the body of pacs.008 messages, see the list
of keywords in the latest Information for FINplus Deployment Package document.

Scenario where the UETR is not added automatically


When messages are received from back-office, and they do not have the UETR in block 3, then
Alliance Access generates automatically a random UETR when the message is stored in the
Alliance Access database.
The UETR will not be added automatically to an MT202.COV when one of the following conditions
are met:
1. The message partner is configured with the option No Validation. (See Levels of Validation in
the Alliance Access Configuration Guide).
2. The MT 103 look-up configuration parameter is configured to find the matching MT 103, MT
103 REMIT, or MT 103 STP.
3. The routing in _AI_from_APPLI is configured to route messages directly to the SWIFT
network.
The UETR is not added because Alliance Access does not parse or validate the message, and as
a result, keywords are not extracted to perform the MT 103 look-up.
For this scenario, SWIFT recommends that users change the message partner validation level or
change the routing and route messages to any message processing queue, such as,
_MP_Authorisation, _MP_Verification, or _MP_mod_text before sending them to the SWIFT
network.

Intermediary institutions
Alliance Access does not provide the feature to forward the UETR. The UETR is present in the
received message and must be passed on unchanged to the next message in the transaction
chain.

Scenarios when the UETR and SLA ID fields are cleared


The UETR and SLA ID fields are cleared when opening or creating the following:
• Text Modification > Add as
• Emission Security Modification > Add as
• Emission Security Modification > Add as
• Modification for Transmission > Add as
• Message Authorisation > Add as
• Message Search > Details > Add As
• Creation of FIN Msg Templates *
• Creation of APC Msg Templates *

17 December 2021 42
Alliance Access 7.6.20 UETR and SLA ID Fields in Alliance Access
Message Management Guide

SLA ID field in MT 199s


There are three ways to populate the SLA ID field in an MT 199:
1. Add the SLA ID manually in the Alliance Access Message Management GUI
2. Correctly configure the Auto-generate SLA ID, as explained in this topic
3. Use the CSV file that is generated by your back office. The field is updated automatically with
the value from the CSV file. See "Universal Confirmation Process using a CSV File " in the
Alliance Access Configuration Guide.

Alliance Access configuration parameters and fields


Name Where to Description More information
configure

Auto-generate UETR System > Use this configuration parameter to deactivate Alliance Access
Configuration the automatic generation of the UETR. Configuration Guide
parameter
If you deactivate the Auto-generate UETR
parameter, then the MT 103 look-up feature is
ignored.
The default value is Yes.

MT 103 look-up System > Use this configuration parameter to specify per Alliance
Configuration 8-character BIC whether Alliance Access must AccessConfiguration
parameter find the related MT103 UETR when Guide
automatically generating the UETR of a MT 202
COV.
The default value is Yes.

Transfer UETR Message Partner This option indicates if Alliance Access must Alliance Access
Details Window: transmit the UETR field to the back office in the Configuration Guide
Configuration Tab > message partner transmissions.
Emission section
Important This option is not present for
message partners configured with
the data format XML because the
UETR is always transferred for this
data format.
For the following data formats, this
option is present and selected by
default:
• DOC/PCC
• MERVA/2
• RJE
• MQ-MT

17 December 2021 43
Alliance Access 7.6.20 UETR and SLA ID Fields in Alliance Access
Message Management Guide

Name Where to Description More information


configure

Auto-generate SLA ID System > Alliance Access verifies if the SLA ID (field 111 in Alliance Access
Configuration block3) is populated for the FIN messages listed Configuration Guide
parameter in FIN Message Types with automatically
generated UETR on page 41.
If there is no SLA ID, then Alliance Access
generates and populates the value based on the
Auto-generate SLA ID configuration parameter.
By default, this feature is deactivated.

Configuration steps
1. Install the appropriate Message Syntax Table. See Install a New Message Syntax Table in the
Alliance Access Configuration Guide.
2. Assign the new Message Syntax Table to the Logical Terminals. See Modify the Syntax Table
Assigned to One or More Logical Terminals in the Alliance Access Configuration Guide.
3. Install the FIN SR <yyyy> for Message Management and Online Help package (linked to the
Message Syntax Table in step 1) that is available on the Download Centre.
4. Update the UETR and SLA ID Alliance Access configuration parameters and fields listed
previously, as appropriate.

Related information
Alliance Access/Entry: UETR Addition SWIFTSmart module

17 December 2021 44
Alliance Access 7.6.20 Universal Confirmations
Message Management Guide

6 Universal Confirmations
Starting November 2020, financial institutions must provide a confirmation to the Tracker on the
status of all incoming MT 103 messages, cross-border and domestic.
For more information, see Universal Confirmations in Alliance Access in the Alliance Access
Configuration Guide.

17 December 2021 45
Alliance Access 7.6.20 ISO 20022 Programme
Message Management Guide

7 ISO 20022 Programme


As of end 2022, banks will start to transition from the legacy SWIFT MTs (for Financial Institution to
Financial Institution payments and reporting) to Cross-Border Payments and Reporting Plus (CBPR
+) messages. CBPR+ messages, which are subsets of ISO 20022 messages, will be carried on
one specific instance of InterAct, which is named FINplus.
For more information, see ISO 20022 Programme in Alliance Access in the Alliance Access
Configuration Guide.

17 December 2021 46
Alliance Access 7.6.20 Message Preparation
Message Management Guide

8 Message Preparation
Introduction
This section provides background information about the types of messages that an operator can
manage through Alliance Message Management.
It also describes the concepts that the tasks descriptions refer to. For example, it explains the types
of messages that you can send, and provides details about the key concepts related to those types
of messages.
It also describes the message editors that are used to manage MT, MX, and APC messages.

Types of messages
Alliance Message Management allows you to create and send various kinds of messages:

Type of message Description Reference

FIN FIN messages are divided in two Message Information for FIN and
groups: APC Messages on page 56
• FIN user-to-user messages Category Volumes: MT Message
Text Standards on page 68
the financial SWIFT MT
messages that allow you to
conduct transactions with your
correspondents on the SWIFT
network.
• FIN system messages
You send FIN system
messages to communicate
with the SWIFT organisation
and its user community.

APC (MT) System message only that allow Message Information for FIN and
you to communicate with the APC Messages on page 56
SWIFT organisation and its user
community.

MX ISO 20022 XML-based (MX) Message Information for SWIFT


messages that enable the transfer MX Messages on page 58
of richer data for more complex
business transactions.

File (FileAct) Send or receive files using the File Message: Send on page 133
FileAct service. and File Message: Get on page
141

Note Messages with the format FpML, AnyXML, or Proprietary may also be visible in some
queues. You cannot create such messages using Alliance Message Management, but
it is possible to open them when they are present in a queue. Alliance Message
Management displays a message with format FpML or AnyXML with the body text in
fast mode.

8.1 Message Editor

17 December 2021 47
Alliance Access 7.6.20 Message Preparation
Message Management Guide

Purpose
Alliance Message Management includes a form for creating and managing MT, MX, or system
messages (APC). The form is referred to as a message editor. The form is also used to edit a
template for MT, APC, or MX messages.
The editor used to send and receive FileAct messages differs slightly from the message editor for
MT, MX, and APC. For more information about working with FileAct messages, see FileAct Details
(Send) Window on page 135 or FileAct Details (Get) Window on page 143.
Note The Receiver field for FIN messages and Responder DN field for MX messages is
validated for RMA immediately after it is modified. This on the fly validation allows the
field to be immediately highlighted as an error if the RMA validation is not successful.

Message management actions


The management actions that you can perform on a message are controlled through the
permissions in your operator profile, and also on the current status of the message in the message
lifecycle.
Management actions include:
• Create a message
• Validate a message
• Modify a message
• Complete a message (that is, specify that a message instance is at the end of its life cycle)
• Send message to a queue (dispose or route)
• Verify and approve a message
• Repair a damaged message

Example of the message editor

The following is an example of a message displayed in the Message Editor:

17 December 2021 48
Alliance Access 7.6.20 Message Preparation
Message Management Guide

Legend

Item Explanation More information

1 The name of message. Help for Messages on


page 64
Click the name to display the help about the message from the Message
Standards.

2 The tabs display the message and information about the message.

3 The sender's reference field.

4 A repetition add button to include a sequence in a message. Each time Help for Messages on
you click the add button, the repetition is automatically expanded. page 64
Some messages can have several sequences and subsequences. Within
a sequence, some fields are mandatory and some are optional.

5 A repetition remove button to remove a sequence and the values from the
fields in the sequence.

6 The expand arrow works when there is something to expand:


• for a mandatory field
• an optional field where the checkbox is selected (you want the field to
be present in the message)
• a sequence with a repetition with at least one count

7 A picker to help you enter data in a field. Format of values in


fields on page 50

8 A checkbox to expand an optional field.

9 The value of a field in a message. Different types of drop-


down lists on page 50
Mandatory fields are denoted by a blue colour by default. Fields with
invalid values appear in a different colour. Format of values in
fields on page 50
Help for Messages on
page 64

10 The field name and a detailed description of the field name. Format of values in
fields on page 50

11 Buttons that provide access to actions that you can perform on the Management of
message. Messages on page 53
The buttons that are available depend on the permission in the operator
profile that is assigned to you.

Tabs
The message editor displays the information in a message in the following tabs.

17 December 2021 49
Alliance Access 7.6.20 Message Preparation
Message Management Guide

For more information about these tabs, see General Message Structure on page 52.
• Header
• Application Header (for MX messages only)
• Body
• Comments
The Validation Report tab appears in the message editor to provide errors and warnings about an
action that an operator performed.
If Alliance Message Management detects errors during the various stages of message preparation,
then the Validation report outlines the following information:
• the location of the problem detected (for example, in the header or the body of the message)
• a description of the error or the warning
Tip Orange is the default colour for error messages. For information about how to change
the error colour, see Change the Preferences on page 38.

Format of values in fields


The values that you enter in a field for a FIN or an MX message must be syntactically correct and
compliant with the message standards that are installed.
Some pages show the following icons to the right of a field:

Icon Purpose

Display the format of a field.


Click the icon to display the expected syntax of the field. For more information
about how to interpret the format descriptions, see Help for a FIN Message on
page 68.

Open a picker to help you enter a value in a field.

Where relevant, you can use the drop-down lists to select values for the fields in a message, or
type the value directly in the field.
For text fields, the following information is shown:
• Number of characters already entered in the line on which the cursor is currently positioned
• Maximum number of characters allowed for the line in which the cursor is currently positioned
If the text field accepts multiple lines of input, then the following information is shown:
• Number of lines already entered
• Maximum number of lines allowed in that field

Different types of drop-down lists


Some fields use a drop-down list from which the operator selects a value from the list only. Alliance
Access also uses drop-down list that enable an operator to input a specific value that is different
from the values that are defined in the message standards schema. This feature is useful to handle
intermediate changes in the message standards because you can use new keywords in this way.
You can recognise the different types of drop-down lists by the background colour of the field and
the background colour of the arrow.

17 December 2021 50
Alliance Access 7.6.20 Message Preparation
Message Management Guide

This table shows the different types of drop-down lists, and explains how to recognise when you
can type a value that is not in the list:

Usage Description Mandatory field Not a mandatory


icon field icon

Select a value from the list only The drop-down arrow is grey
and the background colour of
the arrow is different from the
colour of the field.

Type a value that is specific for The background colour of the


your institution, or select a value arrow is the same as the
from the list. colour of the field.
If you type a value that is not in
the list, then Alliance Access does
not check that the value is valid.
However, a warning appears in
the Validation Report tab.

8.2 Messages and Message Instances


Overview
Alliance Access can create additional copies of a message during message processing. These
copies are known as message instances. For example, when a message is sent, a message
instance can be created and stored in a log file, so that there is a record of every message sent.
Therefore, a message in Alliance Message Management is a collection of message instances.

Message instances
There are three different types of message instances:
• Original instance
• Copy instance
• Notification instance (transmission, information, or history)
A source instance is the instance that is being currently processed. It can be an original instance,
new instance, copy instance, or notification instance.
Each message instance has an independent existence and is processed separately from the
original instance.

Original instance
When an operator creates a message through the Creation application, or when Alliance Access
receives a message, the first instance of the message is the original instance. Each message has
only one original instance.
You can modify only the message text of an original instance.

Copy instance
The routing software in Alliance Access creates a copy instance of an original instance. A copy
instance is for information purposes only, and therefore, an operator cannot use a copy instance to
change the message text. A copy instance can only "point" to the message text.

17 December 2021 51
Alliance Access 7.6.20 Message Preparation
Message Management Guide

Alliance Access can create any number of copy instances from an original instance.

Notification instance
The routing software in Alliance Access creates a notification instance.
After the original instance is created and sent to a correspondent, Alliance Access can duplicate
the notification instance (ACK/NAK) of the message.
Alliance Access can create any number of notification instances from an original instance.
A notification instance provides information about the delivery status of a message. For example:
• The SWIFT network has acknowledged or rejected the message (that is, the original instance).
• The message failed authentication.
An operator cannot use a notification instance to change the message text. Like copy instances,
they can only "point" to the text.

Status of a message instance


A message instance can have one of the following statuses:

Status Description

Live The message instance is being processed or is awaiting processing at one


or more routing points. A routing point is a queue in Alliance Access.

Completed The instance has been processed.


A message is not considered to be completed unless all of its instances
have been completed. When a message is completed, it can be archived.

Reserved A Live or a Completed instance that the Message Processing Function


has reserved. The instance is being processed , and you cannot perform an
action on it.

8.3 General Message Structure


Message part Description FIN/APC MX
messages messages

Header • FIN/APC messages ✓ ✓


Defines the sender, receiver, message type, and options
such as the message priority. A message is divided into
blocks with the header information in blocks 1, 2 and 3.
• MX messages
Includes Distinguished Names (DNs) for requestor and
responder, and other details needed to send the message
through SWIFTNet.

Application For MX messages only ✓


Header
Depends on the service for which messages are processed.
Check with your supervisor for more information.

17 December 2021 52
Alliance Access 7.6.20 Message Preparation
Message Management Guide

Message part Description FIN/APC MX


messages messages

Body The contents (that is, the payload) of the message. The body ✓ ✓
carries the financial information that the sender wants to send
to the receiver.
The data in the text block is usually structured into a
predefined sequence and format, as determined by SWIFT's
message standards. For FIN/APC messages, the text is in
block 4 of the message.
The payload of the message is carried in the application
header and in the body of the message. In the body of the
message, the data is stored as a Document element, which
also identifies the XML schema for the message.

Comments Comments are optional and not sent externally. You can add a ✓ ✓
comment for the people in your institution who further process
the message. (1)

Trailer Confirms the authenticity of the sender, contains control ✓


information, and indicates whether any special handling is
required of the receiver. The trailer is in block 5 of the
message, and is identified by a 3-letter code.

(1) When an operator has added content in the Comments tab, and then validated or stored the message, the Comments tab
includes a * after the tab name. The * indicates that an operator has added comments.

All messages processed by Alliance Access must comply with the Standards MT and Standards
MX. For more information, see Help about Message Standards on page 64.

8.4 Management of Messages


Life cycle of message depends on message type
Messages of different types have a different life cycle:
• MT and MX messages must be verified and authorised.
• System messages do not need to be verified, but must usually be authorised.
In addition, the management of messages within Alliance Access also depends on the permissions
of the operator and the routing rules that are defined in Alliance Access for the institution.

17 December 2021 53
Alliance Access 7.6.20 Message Preparation
Message Management Guide

Example of message management steps

The following graphic shows the possible message management steps for FIN or APC (MT 0_ _)
messages:

MT 0_ _
MT 999

Creation Verification Authorisation _SI_to_SWIFT


SWIFT Outbound Queue
Ready-To-Send
Approval

D0540211
Text Modification

Overview
Message management includes the following steps:
1. Create a message
An operator creates a message manually through the Creation application in Alliance Message
Management. This creates an original instance of the message.
For more information, see Message Creation on page 93.
2. Route the message
An operator can take any of the following actions if the permissions in their operator profile
allow them to:
• Route a valid message to a queue that is defined in the routing rules.
• Move a message to a specific queue that the operator selects from the message editor. This
is called Dispose in Alliance Message Management.
• Close a message, and in this case the message is not saved.
To save a message for editing later, an operator can save it as a message template.
For more detailed information, see Message Queues and Routing on page 55.
3. Modify the message, if needed
Optionally, an operator can move messages to the Text Modification queue for editing later.
These messages can be modified through the Modification application in Alliance Message
Management.
For example, you can move an invalid message to the Text Modification queue when you are
waiting for more information to include in the message.

17 December 2021 54
Alliance Access 7.6.20 Message Preparation
Message Management Guide

4. Verify the message - only for MT and MX messages


Certain fields in MT and MX messages, such as value dates, currencies, and amounts, must be
verified.
In general, the creator of a message does not verify a message. Another operator verifies the
message and re-enters the values for the fields that require verification. These fields appear
empty when the verifier views the message. The values of fields in the original message must
match the values in the re-entered fields for the message to pass the verification successfully.
5. Authorise the message
An operator authorises a message by checking the message visually. Then, the authorised
messages are sent to the SWIFT network. Only operators with the appropriate profile can
authorise messages.

Operator permissions and security


For maximum security and accuracy, the message preparation process requires the following
people:
• a creator
• a verifier (for MT and MX messages only)
• an authoriser
For security reasons, the specific permissions in your operator profile may limit your role in
message management. An operator profile also defines what types of messages that you can
create. The Alliance security officers are responsible for modifying profiles and units, and for
assigning them to operators.
You can reduce the number of people involved in message preparation by giving operators
permission in their profiles to create, verify, and authorise messages, but ensuring that they are not
allowed to verify/authorise the messages that they have created themselves.
Operator profiles also define the sort of message that operators can prepare and which queues, if
any, they can bypass.
Routing rules determine the message flow and consequently, may influence the message
management tasks that you are allowed to perform.
If operators in your institution belong to different units, then this also affects which messages they
can prepare.
The Alliance Administrator uses the Configuration package on Alliance Web Platform to view and
modify profiles and assign them to operators. For more information, see the Configuration Guide.

8.5 Message Queues and Routing


Validity of a message format
Alliance Message Management validates the syntax of a message when an operator clicks
Validate , Fast , Route , or Dispose to .

For more information about how Alliance Message Management validates a message, see Validate
a Message on page 126.

Message queues
Alliance Access holds a message instance in a message queue according to the current status of
the message.

17 December 2021 55
Alliance Access 7.6.20 Message Preparation
Message Management Guide

The _MP_creation queue holds message templates, but Alliance Access holds messages there for
a fraction of a second before routing the message instantaneously to the next queue.
You use the Creation, Modification, and Approval menus to process the messages in the
different queues.
You can change the default message queue settings in Alliance Access Configuration. For more
information, see routing in the Configuration Guide.
If you cannot send a message to the next normal queue, then you can send it to the Text
Modification queue (_MP_mod_text). For example, you can send it to the Text Modification queue if
you do not have enough information to finish preparing the message. If Alliance Access has a
problem with an input or output message and cannot process it, then the message is held in one of
several other modification queues. You can use the Modification menu to edit the messages in
these queues, to allow Alliance Access to finish processing the messages.

Routing
Each message queue has a set of routing rules. These determine the default flow of messages
from one queue to the next. If needed, the routing rules can be changed to suit your institution.
An operator can move a message from one queue to another queue in the following ways:
• Route a message to the next logical queue, according to the routing rules.
For information about routing rules, see queues in the Configuration Guide.
• Send (dispose) a message to a queue. In general, you can select the required queue from a list
of available queues.
• Move a message to the Text Modification queue (_MP_mod_text) for editing later.
There are restrictions on the methods that you can use to move a message. Details are given in
the next section.

8.6 Message Information for FIN and APC Messages


This section describes:
• SWIFT message trailers
• Unique Message Identifiers (UMIDs)

8.6.1 SWIFT Message Trailers


Every FIN and APC message has a trailer that:
• Indicates the status of the message (for example, whether the message is for Test and Training
purposes (TNG))
• Assists in checking the integrity of the message, for example, to convey checksums.
Note With SWIFTNet PKI for FIN, a signature element is generated in the enveloping
InterAct message.
• Warns the receiver that some special handling may be required for the message, for example,
the message may already have been delivered by SWIFT, or the message may have been sent
before (PDM, PDE).
When a PDE or PDM is added to the message at emission, or detected at reception, then the
event is marked in the event journal.

17 December 2021 56
Alliance Access 7.6.20 Message Preparation
Message Management Guide

Most trailers are computed and attached automatically to the end of the message. They do not
normally appear as part of the message. The only exception is the PDE (Possible Duplicate
Emission) trailer, which is added to a message, at the sender's request, to indicate to the recipient
that the same transaction may already have been conveyed in an earlier message.
A PDE trailer is usually added if the sender is unsure whether a previous message was actually
sent to the recipient, for example, following an application system failure. On receipt of a message
with a PDE trailer, the recipient will try to match the transaction to an earlier message, for example,
by reference to the TRN. If none is found, then the message containing the PDE trailer is
processed as normal. If a duplicate transaction is found, then the message with the PDE trailer is
discarded.

8.6.2 Unique Message Identifiers (UMIDs)


Every message stored in Alliance Access can be uniquely identified based on information
contained within parts of the header and text.
A Unique Message Identifier (UMID) consists of a User Unique Message Identifier (UUMID) plus a
suffix, which makes it unique in the scope of Alliance Access. A UUMID, which is unique from the
point of view of a single Alliance Access user, consists of the following:
I/O + Correspondent + ID (type of message) + Reference
where Reference is either TRN or MUR (MUR can be empty). However, note that the UUMID will not
always be unique to a user, for example, if the user puts the same Reference twice in a single
message.
The following table lists the information contained in the UMID:

Message identifier Description

I/O This is a single-character direction indicator. "I" means an input message, that is, a
message input to the network specified within the message, from Alliance Access.
"O" - means an output message, that is, a message output from a network to
Alliance Access.

Correspondent This is 11 alphanumeric characters long and is the full BIC address of the sender or
receiver of the message. If no specific branch code is given, then the last 3
characters of the BIC address default to "XXX". For messages with a direction
indicator of "I", the BIC address identifies the receiver of the message. Where the
direction indicator is "O", it identifies the sender of the message.

ID For SWIFT format, this is always a 3-character number and refers to the message
type, for example, "100" for a customer transfer.

Reference This is either the Transaction Reference Number (TRN) as given in field 20 of the
message, or the Message User Reference (MUR) extracted from the User Header
block of the message, in SWIFT format. This reference may be up to 16 characters
in length. The exact form of reference used - TRN or MUR - is determined during the
installation of SWIFT Message Syntax Tables into Alliance Access.

Suffix The suffix is a system-generated value that can help uniquely identify a message.
The first part is the creation date of the message in YYMMDD format, a six-digit
number. The second part consists of a 1-to-10 digit number that the system
generates. This number is incremental and unique for all messages.

17 December 2021 57
Alliance Access 7.6.20 Message Preparation
Message Management Guide

8.7 Message Information for SWIFT MX Messages


MX messages are grouped according to the corresponding message standard. The list of message
standards messages available within Alliance Message Management depends on the services your
institution uses, as well as on the version of Standards installed.
This section describes:
• Standards XML syntax
• Extraction of MX keywords
• Message UUMIDs
• Message formatting and expansion
• Derivation of correspondents

8.7.1 Standards XML Syntax


The Standards XML defines a structure which is defined as the request payload. Within the
payload are the message header and the body of the message called the Document which
contains the XML schemas. All MX messages processed by Alliance Access must comply with the
Standard MX message format and syntax definition.

8.7.2 Extraction of MX Keywords


Overview
Alliance Access extracts the MX keyword fields from the MX message payloads. The extraction is
based on the MX keyword XPath definitions defined by Standards XML. The MX keywords are
extracted from the messages by default and are available for display and routing purposes.
The following table provides the mapping between the MX keywords and the internals of Alliance
message representation:

Alliance Access field InterAct field Description Routing


keyword

mesg_xml_query_ref1 The field is defined by the A keyword field is an existing Y


XPath contained in the field that is specified as being
keyword 1 definition. searchable from within Alliance
Message Management.
(SwInt:RequestPayload)

mesg_xml_query_ref2 The field is defined by the A keyword field is an existing Y


XPath contained in the field that is specified as being
keyword 2 definition. searchable from within Alliance
Message Management
(SwInt:RequestPayload)

mesg_xml_query_ref3 The field is defined by the A query reference field is an Y


XPath contained in the existing field that is specified as
keyword 3 definition. being searchable from within
Alliance Message Management.
(SwInt:RequestPayload)

17 December 2021 58
Alliance Access 7.6.20 Message Preparation
Message Management Guide

Some fields are reused as search criteria


MX keywords refer to fields within a message that are defined as being searchable from within
Alliance Message Management. These fields vary per message and per message standard. All
messages require a field to be defined as MX Keyword 1. Messages may optionally have up to
two additional fields defined as MX keywords. The cover letter for a message standards
deployment package includes the list of fields that are defined as MX keywords. For more
information about MX keywords, see Help for Messages on page 64.
When searching for MX messages, you can look for a specific message by entering values as
required for one or more MX keywords. See Search by ID and Content on page 210 for information
about providing search criteria.

8.7.3 MX Message UUMIDs


Alliance Access maintains a User Unique Message Identifier (UUMID) used to identify each
message. The UUMID is constructed for MX messages as follows:

Message Description
identifier

I/O This is a single-character direction indicator. "I" means an input message, that is, a
message input to the network specified within the message, from Alliance Access. "O"
means an output message, that is, a message output from a network to Alliance
Access.

Correspondent Eleven-alphanumeric character long and is the full BIC8 address of the sender or the
receiver of the message plus "XXX". For messages with a direction indicator of "I", the
BIC address identifies the receiver of the message. Where the direction indicator is "O",
it identifies the sender of the message.

Message type Three-character number that indicates the message type. It is extracted from the
schema name or defaulted to "MX ".

Reference This is a maximum of 30 characters and contains the "Request Reference" (equivalent
to the TRN or MUR for a SWIFT MT message). It is extracted from the
mesg_user_reference_text.

Example: IGEBABEBBXXX007myref

8.7.4 Message Formatting and Expansion


Example of an expanded MX message
The following is an example of an MX message with its text expanded:
<AppHdr xmlns="urn:swift:xsd:$ahV10">
<MsgRef>123456789</MsgRef>
<CrDate>2002-09-09T13:20:00.001-05:00</CrDate>
</AppHdr>
<Document xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"
xmlns="urn:swift:xsd:mas.mepsplus.mval.br$camt.007.001.01">
<camt.007.001.01>
<CompoundTag2>
<SingleTag1>value</SingleTag1>
<SingleTag2/>
</CompoundTag2>

17 December 2021 59
Alliance Access 7.6.20 Message Preparation
Message Management Guide

</camt.007.001.01>
</Document>

Overview
Alliance Access is responsible for formatting an MX message payload in an expanded form.
Payloads in UTF-8 encoding are accepted.
The expanded message is generated using the following conventions (indentation is two space
characters):
• Only printable US-ASCII characters below 127 appear. All other characters are replaced by a
full stop (.).
• CR, LF, and CR/LF are replaced by a new line.
• Tab is replaced by a space character.
• Lines are wrapped based on the maximum line length provided with the format API (typically
72). The wrapped line keeps the current indentation and is aligned with the text on the previous
line (that is, after the tag).
• A tag is never indented with more than 30 positions (nesting of 15 levels). If the tag goes deeper
than 15 levels, then only an indentation of 15 levels is used, and the indentation is only undone
upon the return to level 14.
• Start and end tags appear as follows:
- On one line if the field contained within the tags contains a value and no further subfields.
Line wrapping is as described above.
- The end tag on a new line and is aligned with the starting < character of the corresponding
start tag, if the field contained within the tags contains further subfields.
- Empty tags appear as one single tag ending with />.
• Tags that do not fit on one line are wrapped keeping the current indentation and are aligned with
the starting < character on the first line.

8.7.5 Derivation of Correspondents


If not provided explicitly by the back-office application, then the Alliance Access correspondents
(internal and external) are derived from the Requestor DN and the Responder DN contained in the
message.
When a message is received by the SWIFTNet Interface, the correspondent names are derived
from the Requestor DN (sender) and the Responder DN (receiver) as follows:
• mesg_sender_X1 (institution) = second node of the requestor DN (o=swift,o=<institution>),
padded with XXX or truncated at 11 characters
• mesg_sender_X2 (department) = third node of the requestor DN (o=swift,o=<institution>,
ou=<department>)
• mesg_receiver_X1 (institution) = second node of the responder DN (o=swift,o=<institution>),
padded with XXX or truncated at 11 characters
• mesg_receiver_X2 (department) = third node of the responder DN (o=swift,o=<institution>,
ou=<department>)

17 December 2021 60
Alliance Access 7.6.20 Message Preparation
Message Management Guide

Note No mapping is done for mesg_sender_X3, mesg_sender_X4, mesg_receiver_X3,


mesg_receiver_X4.
For mesg_sender_X2, if no "ou=" item is present, mesg_sender_X2 is not filled in.
For mesg_receiver_X2, if no "ou=" item is present, mesg_receiver_X2 is not filled in.

8.8 Business Identifier Code (BIC)

8.8.1 Business Identifier Code (BIC)


Overview
In the financial environment, a number of telecommunication services have defined coding
schemes for identifying financial institutions as well as corporate entities. As a result, many
financial institutions and some corporates have more than one code assigned, while others have
no codes assigned.
To ensure the availability of a unique identifier, an International Standard - ISO 9362 - has been
established. This standard specifies a universal method for identifying financial institutions and is
intended to facilitate automated processing of telecommunication messages.
SWIFT is the designated ISO Registration Authority for these ISO codes, and is responsible for
their assignment and subsequent publication.

BICs in messages
Business Identifier Codes (BICs) are used in certain fields of messages (for example, field 53A,
Sender's Correspondent, or field 59A, Beneficiary Customer) to identify a party in the transaction.
ISO 9362 allows alphanumeric values for the first 4 characters in the BIC, but SWIFT has
implemented a more restrictive structure in message types only allowing alphabetic indications for
the party prefix (BIC format 4!a2!a2!c[3!c] ). SWIFT, as registration authority, has no plans to issue
BICs with numeric characters in the first 4 characters.
When a BIC is available (for example, the party to be specified has been assigned a BIC), it should
be used whenever possible, as it is standardised and can therefore be automatically processed by
the receiver.
Both financial institutions and non-financial institutions can be identified with a BIC.

Related information
For more information about the BIC format and use of the BIC in SWIFT messages, see the BIC
Policy on swift.com.

8.8.2 Business Identifier Code Structure

8.8.2.1 Components of a Business Identifier Code


Description
The Business Identifier Code (BIC) consists of eight or eleven characters, comprised of the first
three, or all four of the following components:

17 December 2021 61
Alliance Access 7.6.20 Message Preparation
Message Management Guide

PARTY PREFIX 4!a A 4-character code (BBBB) that identifies all instances of a
particular institution worldwide (this is sometimes referred to
as the BIC-4 address).

COUNTRY CODE 2!a A 2-character code (CC) that identifies a country in which an
institution operates (this, along with the Party Prefix, is
sometimes referred to as the BIC-6 address).

PARTY SUFFIX 2!c A 2-character code (LL) that identifies a particular location
within a country.

BRANCH IDENTIFIER [3!c] A 3-character code (BCD) that identifies a particular branch of
an institution in a particular location. In messages, if the
branch identifier is not known or not used, the characters
"XXX" are used instead.

If a BIC address is given without a branch identifier, then the eight characters, "BBBBCCLL",
uniquely identify a financial institution, at a particular location, within a particular country. This form
of address is called the "BIC-8" address for that institution and is identical to the institution's SWIFT
"destination address".
If a BIC address is given with a branch identifier, then the eleven characters, "BBBBCCLLBCD",
uniquely identify a particular branch of a financial institution at a particular location, within a
particular country. This form of address is called the "BIC-11" address for that institution. If a branch
is not known, or not used, then BIC-11 addresses may be expressed as "BBBBCCLLXXX".

Terminal code
During message preparation, the sender and receiver of a message are identified by their BIC-8 or
BIC-11 addresses. A further character, called a Terminal Code, is combined with the BIC to identify
the logical terminals used by the sender and the receiver of the message. The Terminal Code
occupies the ninth position of the BIC address (in front of the branch identifier):
"BBBBCCLLXBCD". The Terminal Code of the receiver defaults to "X" because the sender has no
way of knowing which logical terminal the receiver will use to receive the message.

8.8.3 Standards for connected BICs and non-connected BICs


This section describes the standards for registered connected BICs and non-connected BICs used
in SWIFT messages.
Details regarding SWIFT's policy concerning the use of connected BICs can also be found in the
FIN Service Description.

17 December 2021 62
Alliance Access 7.6.20 Message Preparation
Message Management Guide

8.8.3.1 Components of a BIC


All connected BICs and non-connected BICs have the same basic structure except that non-
connected BICs are identified with the digit '1' in the eighth position. For addressing purposes, the
BIC is used with an additional character in the ninth position, shown as the logical terminal code:

Party prefix
Country code
Party suffix
Logical terminal code
Branch identifier

a a a a a a c c c c c c
1 2 3 4 5 6 7 8 9 10 11 12

SWIFT Destination

Logical Terminal Identifier

D0200002
Note: a = Letters only
c = Letters and digits only

Related information
For more information, see:
www.swift.com/bic
BIC Policy

17 December 2021 63
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

9 Help about Message Standards


This section describes the following information:

Topic For MT For MX


messages messages

Help for Messages on page 64 ✓ ✓

Category Volumes: MT Message Text Standards on page 68 ✓

Help for a FIN Message on page 68 ✓

Structure of Fields in FIN Messages on page 72 ✓

For more information about MT Field Formatting Rules and characters for MT and MX messages,
click Help in the upper right-hand corner of the screen.

9.1 Help for Messages


Help for message standards
SWIFT provides online help in Alliance Message Management for the messages:
• MT and APC messages: the help content is derived from the Standards MT User Handbook.
• MX messages: the help is derived from the documentation for Solutions.
You can also find additional information about message standards and Solutions on
www.swift.com, under Support > Resources > Documentation (User Handbook).
The online help for message standards is provided with a message standards release, and must be
installed at the same time as a message standard. For more information about installing a
message standard, see installing a message standard in the Configuration Guide.
For more information about message formats, BICs, SWIFT characters, and field formatting rules,
you can also click Help in the upper right-hand corner of the Alliance Message Management
screen.
Note Even though you may have installed multiple help packages, you can only access the
last-installed package, because existing help package records are overwritten when a
new package is installed. In order to view the newly installed help package, you need
to wait 15 minutes after installing the package, so that the cache is cleared.

17 December 2021 64
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

To display the help for a message


Clicking the name of the message in the message entry form (for a message or a message
template) displays message-level help, if it is installed.

The following is an example of the message help for a FIN message, MT 103:

17 December 2021 65
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

To display the help for a message field


To display the help for a message field, in the Body tab of the message, select the field (for
example, F20):

The help for the selected message field is displayed:

17 December 2021 66
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

To display the help for a network error code


To display the help for a network error code, in the Validation Report tab of the message, select the
error code (for example, D70):

Following is an example of help for error code D56:

MX keywords
When you search for MX messages, you can provide values for the fields that are defined as MX
keywords. Alliance Message Management provides a list that includes the identifier, keyword, and
path information for the messages within an MX standard. The information is based on the
message standards that are installed in the Alliance Access database.
If the configuration parameter, MX Keyword Extraction is set to Off, then keywords are not
extracted from incoming MX traffic.

17 December 2021 67
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

A link to a list of the MX keywords for all of the messages in a particular standard is available in the
following situations:
• You select an MX standard in the Standard field of the ID & Content tab of the Message
Search Criteria or the Report Search Criteria page.
The link is displayed next to the Message Name field.
• You view an MX message in the Message Details page.
The link is displayed next to the MX keyword text on the Header tab.

9.2 Category Volumes: MT Message Text Standards


MT messages are organised into the following categories:
• Category 1 - Customer Payments and Cheques
• Category 2 - Financial Institution Transfers
• Category 3 - Treasury Markets - Foreign Exchange, Money Markets, and Derivatives
• Category 4 - Collection and Cash Letters
• Category 5 - Securities Markets
• Category 6 - Treasury Markets - Commodities
• Category 6 - Reference Data
• Category 7 - Documentary Credits and Guarantees/Standby Letters of Credit
• Category 8 - Travellers Cheques
• Category 9 - Cash Management and Customer Status
• Category n - Common Group Messages
A FIN or APC message has a unique number, which consists the category number (0 through 9)
and a unique 2-digit number. The resulting 3-digit number is known as the message type (MT).
Therefore, the message name MT 510 indicates message 10 within category 5 (Registration Status
and Processing Advice) is referred to as "MT 510". In Alliance Message Management, this
message has the identifier fin.510. In some documents, the character "n" represents a group of
messages. For example, all category 5 messages are referred to as "MT 5nn", where "nn" is a 2-
digit number.

9.3 Help for a FIN Message


Overview
This section outlines the conventions that are used in the message standards for describing the
formatting rules for FIN messages.
Note Alliance Message Management uses a colour rather than the letter "M" to denote
mandatory tags. For more information about the colour for mandatory messages, see
Change the Preferences on page 38.

Message type scope


The scope of a message specifies the sender and receiver of the message and provides an
explanation about how the message is used. In the help for some messages, an example of the
message flow is also provided.

17 December 2021 68
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

Message type format specifications


MT nnn (Message Type name)

The format specifications are the rules for the layout of the message type. This information is
provided in a table as shown below:

Status Tag Field Name Content/Options No.

M 20 Transaction Reference Number 16x 1

M 21 Related Reference 16x 2

Mandatory Sequence A (Sequence Name)

M 25 Account Identification 35x 3

M 32A Value Date, Currency Code, 6!n3!a15d 4


Amount

----> Optional Repetitive Sequence B (Sequence Name)

O 52a Ordering Institution A or D 5

M 71B Detail of Charges 6*35x 6

O 72 Sender to Receiver Information 6*35x 7

----|

M = Mandatory O = Optional - Network Validated Rules may apply

MT nnn (Message Type name) provides the message type number and name.
The table headings have the following meanings:
• Status indicates if the field is:
- M = Mandatory
- O = Optional - Network Validated Rules may apply
The status M for fields in optional (sub)sequences means that the field must be present if the
(sub)sequence is present, and is otherwise not allowed.
• Tag is the field identification.
• Field Name is the detailed name of the field tag, for this message type.
• Content/Options provides permitted field length and characteristics.
• No. identifies the number of the field in the field specifications for the message type. It is also
called Index.
Only fields and field tag options, which are shown in the message format, may be used in that
message type.

17 December 2021 69
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

Some message formats are separated into sequences of fields, as shown below. An arrow
indicates that a sequence of fields may be repeated:

Status Tag Field Name Content/Options No.

First sequence

---->
Second sequence

----|
Third sequence

M = Mandatory O = Optional - Network Validated Rules may apply

The arrows (----> and ----|) indicate that the second sequence may be repeated.

MT network validated rules


Network validated rules are validated on the network, that is, they are identified with an error code.
Rules specified in this section affect more than one field in the message, placing a "condition" on
one of the fields specified. They are identified as Cn, or conditional rules.
For example, in the MT 202, a rule states that if field 56a (Intermediary) is present, then field 57a
(Account With Institution) must also be present (Error code C81).

MT usage rules
Usage rules are not validated on the network, that is, no error code is defined for them, but are
nevertheless mandatory for the correct usage of the message. Rules specified in this section affect
more than one field in the message, or more than one SWIFT message.

MT market practice rules


Market practice rules specify the rules published by a recognised Market Practice Group, for
example, for Category 5, the Securities Market Practice Group (SMPG). Market practice rules
indicate the existence of a global market practice document on the business process in which the
concerned field or message type is used. The absence of a market practice rule notation does not
mean that no market practices exist for the concerned field or message type. The presence of a
market practice rule is merely an indicator of a known market practice. Furthermore, readers
should be aware that in addition to global market practices there may also be country-specific
requirements that should be considered when using the field or message type.

17 December 2021 70
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

MT guidelines
Guidelines are not validated on the network and are not mandatory for the correct usage of the
message. They concern good practices. Guidelines specified in this section affect more than one
field in the message, or more than one SWIFT message.

MT field specifications
The rules for the use of each field in the message are specified in this section. Each field is
identified by its index number (as shown in the No. column of the MT format specifications), field
tag and detailed field name, followed by a description of the field.
The description may contain some, or all, of the following:
1. FORMAT specifies the field formats which are allowed in the field.
2. PRESENCE indicates if the field is mandatory, optional, or conditional in its sequence.
3. DEFINITION specifies the definition of the field in this sequence of the message type.
4. CODES lists all codes available for use in the field. If there is more than one subfield for which
codes are defined, each separate code list will be identified with a CODES heading. When a list
of codes is validated by the network, the error code will be specified.
5. NETWORK VALIDATED RULES specifies rules that are validated on the network, that is, rules
for which an error code is defined. Generally, rules specified in this section affect only the field
in which they appear. In some cases, rules which are validated at the message level, that is,
rules which affect more than one field, are repeated in this section. This is the case when the
rule does not affect the presence of the field, but information within several fields, for example,
a currency which must be the same for more than one field in the message.
6. USAGE RULES specifies rules that are not validated on the network, that is, rules for which no
error code is defined, but are nevertheless mandatory for the correct usage of the field. Rules
specified in this section affect only the field in which they appear.
7. EXAMPLES provides one or more examples of the field as it will be formatted/used.

MT mapping
MT mapping explains how to map the fields of the message into another SWIFT message, either of
the same, or a different, message type.
MT example
Examples are provided to illustrate the correct use of a message.
Examples always include:
• narrative, which provides a brief description of a transaction
• information flow, which illustrates the relationships between the parties involved in the
message (see below diagram)
• SWIFT format, which provides the message using the defined SWIFT format, and providing an
explanation, where necessary, of the fields which have been used
The sender, receiver, and message type are summarily identified. Trailer contents are not shown.
Note For further information about the header and trailer, see the FIN Service Description.

17 December 2021 71
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

9.4 Structure of Fields in FIN Messages


Overview
This section describes the structure and format of fields in MT messages, which is visible when you
view the message in fast mode.

Structure

Delimiter
Field tag number
Letter option
Delimiter

D0200005
: nn [a] :

Rules
Field structure must comply with the following rules:
• Each field is identified by a tag which consists of two digits, or two digits followed by a letter
option.
• Lower case "a" next to the field tag number indicates that there are different formats available to
capture the information for this field. When this field is used in an MT, a specific format must be
indicated by replacing the lower case "a" with an upper case letter option.
An upper case letter next to the field tag number refers to the format option that will be used for
validating this field.
• Each field consists of a colon :, followed by a tag, followed by another colon :, and then the
field content.
• The following character restrictions apply to the field content:
- The field content must not start with a Carriage Return, Line Feed (CrLf).
- The field content must not be composed entirely of blank characters.
- Within the field content, apart from the first character of the field content, a colon : or hyphen
- must never be used as the first character of a line.
- The format of each field must comply with the standards. For more information, see the
Format Description of the field in the Message Help on Alliance Message Management.
Alternatively, you can view the format descriptions in the Standards MT General Field
Definitions Plus, on www.swift.com .
• Fields are separated by a 'Field Separator within Text' (CrLf).
• The first field in a message is preceded by a 'Start of Text' (CrLf:) and the last field in a
message is followed by an 'End of Text' (CrLf-).
• Field content may be composed of one or several subfields.
When subfields appear on separate lines, the Carriage Return, Line Feed (CrLf), which is not
included in the number of characters for the length of the subfield, serves as the subfield
separator.

17 December 2021 72
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

Subfields:
- Subfields may themselves be of fixed or variable length.
- The order of subfields is fixed.
- When necessary, subfields are separated by special symbols, for example, / or //.
- Subfields must not be entirely composed of blank characters.
- Subfields and/or components must consist of at least one meaningful character.
• If a field content contains mandatory and optional subfields, then at least all of the mandatory
subfields must appear when that field is used.
• The specification of field or subfield content may consist of:
- restrictions on the length of field or subfield content, using the descriptions listed in
Restrictions on Length on page 73
- special formats, for example, for numbers and dates
- codes, for example, currency codes
(See the BIC Plus, which is available for download from www.swiftrefdata.com.)
• In some messages, the field specifications may indicate specific characters, or sets of
characters, for inclusion in the text of the field.
These take the following forms:
- codes, for example, AMEND, TRF, or 08
- slash / or double slash //
- slash or double slash followed by a code, for example, //CH or /FIXED
- slash followed by a code and another slash, for example, /REC/
Note All codes must be in uppercase alphabetic characters. When codes contain a mix of
alphabetic and numeric characters, the alphabetic character must also be in
uppercase.

Restrictions on Length
Restrictions on length Types of Characters Allowed

nn maximum length n numeric digits (0 through 9) only


(minimum is 1)

nn-nn minimum and a alphabetic letters (A through Z), upper


maximum length case only

c alphabetic letters (upper case) and digits


only

h hexadecimal letters A through F (upper


case) and digits only

nn! fixed length x any character of the X permitted set


(General FIN application set) upper and
lower case allowed

y any character of the EDIFACT level A


character set as defined in ISO 9735
upper case only

17 December 2021 73
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

Restrictions on length Types of Characters Allowed

z any character as defined by the


Information Service

nn*nn maximum number of d decimals


lines times maximum
line length e blank space

Examples

2n up to 2 digits

3!a exactly 3 uppercase letters

4*35x up to 4 lines of up to 35 characters each

16-64h at least 16 and up to 64 hexadecimal characters

9.5 Field Formatting Rules

9.5.1 General Rules


The following general rules apply to all fields:
• The field length and type of character(s), for example, letters, numbers, are specified in the
Standards MT General Field Definitions Plus and in the field specifications for individual
message types.
• Unless otherwise stated in the Standards MT General Field Definitions Plus or message field
specifications, all specified subfields must be present:
- in the order (that is, sequence) specified
- with no separator symbols (except a slash '/' or double slash '//' when specified).
• Brackets, [ ], around the format of a particular subfield (in a field containing more than one
subfield), indicate that the subfield is optional within that field.
For example, if the format for a field is '16x[/4x]', up to 16 characters must be present (when the
field is used). The following 4 characters, preceded by a slash '/', are optional, and therefore
need not be present in the field.
• A field format may be shown on two or more lines:
3!n
6!n
When this is the case, the information must be formatted with the CrLf character sequence
separating each line.
Note In the ISO 15022 securities messages, generic fields are used to specify Party,
Amount, Date, Reference and Other types of data. For further explanation of this
approach, see Category 5 - Securities Markets - Message Usage Guidelines.

17 December 2021 74
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

9.5.2 Numbers
Format

nn...nn, nn...n

Fractional part (optional)

D0200006
Integer part

Usage rules
Wherever they represent a numeric value, numbers always take the same form:
• The integer part must contain at least one digit.
• Decimal points are not permitted. A decimal comma ',' shall precede the fractional part.
• The maximum length includes the decimal comma.
• The fractional part may be missing, but the decimal comma must always be present.
• Neither blank spaces, nor any symbols other than the decimal comma are permitted.
• The integer part is mandatory in the number component, and at least one character must
appear. Leading zeros are allowed.
• Normally, when a number represents an amount of money, the number of places following the
decimal comma may not exceed the number of decimal digits valid for the specified currency.
The specifications for the individual message types will indicate the fields where this is not the
case. Details regarding the allowable fractional parts for each currency code may be found in
the BIC Directory download file (CU***.txt file), which is available on www.swiftrefdata.com.

Examples
Valid Invalid

000,00 0000
0, 0
0,67 .67
0,25 ,25
100000, 100.000
25768, 25-768
99999999, 999.999.999
100, 100
10500,00 10500.00
5,25 5 1/4

17 December 2021 75
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

9.5.3 Currency Codes


Format
Format: 3!a

Description
A currency code must be a valid ISO 4217 currency code, which normally consists of a two-letter
ISO country code followed by a third letter denoting the particular currency or type of funds.

9.5.4 Party Identification


Parties may be represented in several ways:
• Identifier Code (BIC)
• branch (city) of the sender or the receiver
• name and address
• other identification codes, for example, account number
When necessary, party identification can be supplemented by an account number line preceding
other party information.

9.5.4.1 Party Identifier


Overview
When further identification of a party, for example, specification of an account number to be
credited, is necessary, the party identifier should be used.
Format: [/1a][/34x]
Where:

Subfield 1 [/1a] Specifies which account is involved:

/C The receiver's account serviced by the sender is credited.

/D The sender's account serviced by the receiver is debited.

Subfield 2 [/34x] The account number information, preceded by a slash '/'.

Rules
When the party identifier is present, the following rules apply:
• The party specified in the field with the account must be the account owner. The optional party
identifier must specify the account known to the account servicing institution.
• Extreme care must be taken when formatting the party identifier, for example, when only
subfield 2 '[/34x]' is entered, and its first and third characters consist of '/', the system can only
presume that both subfields 1 and 2 are present. It will then qualify the second character for
either code 'C' or 'D', and NAK the message if one or the other is not present (Error code T51).

17 December 2021 76
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

Note Other examples of fields impacted by this form of validation are:


• 42A, 42D
• 50D, 50F*, 51A, 51D, 52A, 52B, 52D, 53A, 53B, 53D, 54A, 54B, 54D, 55A, 55B,
55D, 56A, 56B, 56D, 57A, 57B, 57D, 58A, 58B, 58D
• 82A, 82B, 82D, 83A, 83D, 84A, 84B, 84D, 85A, 85B, 85D, 86A, 86B, 86D, 87A,
87B, 87D, 88A, 88B, 88D
* See additional structure for party identifier in section Option F: Party Identifier/Name
and Address on page 83.

Additional rules
The following additional rules apply:
• An account specified in field 58a or 59a must be owned by that party and must be serviced by
the financial institution in field 57a or, if field 57a is absent, by the receiver.
• An account specified in field 57a must be owned by that party and must be serviced by the
financial institution in field 56a or, if field 56a is absent, by the receiver.
• An account specified in field 56a must be owned by that party and must be serviced by the
receiver.
• In field 53a, when an account is used it normally indicates:
- which account is to be used for reimbursement, if multiple accounts in the currency of the
transaction are serviced for the other party. In this case, the account should be specified.
- whether the sender's account serviced by the receiver, or the receiver's account serviced by
the sender, is to be used for reimbursement, if they both service accounts for each other in
the currency of the transaction. In this case, the account to be debited or credited shall be
indicated in the party identifier by either the code /C or /D, or the account, or both.
In both cases, this information should be specified in field 53a with the format option B (party
identifier only).

Examples
Valid Invalid

:53A:/C/12-12 :53A:/6/12-12
CITIUS33CHI CITIUS33CHI

:53B:/D/24-24 :53B:/A/24-24

:53D:/52/48-48 :53D:/:/48-48
John Doe John Doe
122 Peyton Place 122 Peyton Place
Elyria, OH 22216 Elyria, OH 22216

:87E:FREE :87E:APMT
/C/12-12 /A/12-12
CHASUS33 CHASUS33

17 December 2021 77
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

Valid Invalid

:87F:APMT :87F:APMT
/D/12-12 /:/48-48
John Doe John Doe
122 Peyton Place 122 Peyton Place
Elyria, OH 22216 Elyria, OH 22216

Example
Bank A in New York services an account in USD for Bank B in London. Bank B also services, in
London, a USD account (number 567-3245-01) for Bank A.
Bank A sends a USD transfer to Bank B, using its USD account in London, serviced by Bank B, for
reimbursement. Bank A will request that Bank B debit its account in London as follows:
:53B:/D/567-3245-01
Note In certain message types, there are exceptions to the rules for use of the party
identifier detailed in this section, for example, field 57a in Category 3 messages. In
those cases, the intended use of the party identifier is described in the relevant field
specification for the message type.

9.5.4.2 Option No Letter: Name and Address


Format
[/34x] (Account)

4*35x (Name and Address)

Definition
Name and address of the party, with an optional account.

Network validated rules


If the first line of this field starts with a slash '/', then it is assumed that Account is present and then
at least 1 line of Name and Address must be present (Error code T77).

Usage rules
If Account is absent, then Name and Address must not start with a slash '/'.

Field assigned to this option


59

9.5.4.3 Option A: Identifier Code


Format
[/1a][/34x] (Party Identifier)

4!a2!a2!c[3!c] (Identifier Code)

17 December 2021 78
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

Definition
Identifier code such as a BIC. Optionally, the account of the party.
Network validated rules
Identifier Code must be a registered BIC (Error codes T27, T28, T29 and T45).

Fields assigned to this option


• 41A*, 42A
• 50A**, 51A, 52A, 53A, 54A, 55A, 56A, 57A, 58A, 59A
• 82A, 83A, 84A, 85A, 86A, 87A, 88A
Note When this option is used, the SWIFT system will validate the correctness of the
Identifier Code, that is, to ensure that it is registered: either connected or non-
connected.
(*) Field 41A does not have the optional party identifier, but does have an additional
subfield.
See Option D: Name and Address on page 80 on the use of clearing codes.
(**) Field 50A has the format [/34x] for Party Identifier.

9.5.4.4 Option B: Branch of Sender/Receiver


Format
[/1a][/34x] (Party Identifier)

[35x] (Location)

Usage rules
When used, at least one line must be present.
An account number only, not followed by any other identification, is allowed (field 53a).
For field 52a, the field specifications for individual message types specify whether this option
identifies a branch of the sender or the receiver.
In field 53a, this option specifies either the account to be debited or credited, or a branch of the
sender, that is, of the financial institution specified in the sender's address in the header.
In fields 54a and 57a, this option specifies a branch of the receiver, that is, of the financial
institution specified in the receiver's address in the header.

Fields assigned this option


52B, 53B, 54B, 55B, 57B, 58B
82B, 84B, 85B, 87B, 88B

9.5.4.5 Option C: Account Number/Party Identifier


Format
/34x (Account)

17 December 2021 79
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

Definition
A code uniquely identifying an account and/or party.
In the MTs 101, 102, 102 STP, 103, 103 REMIT, 103 STP, and 104, clearing codes may be used.

Fields assigned this option


51C, 52C, 53C, 56C, 57C, 58C
82C, 83C, 85C, 87C, 88C
Note See Option D: Name and Address on page 80 on the use of clearing codes.

9.5.4.6 Option D: Name and Address


Format
[/1a][/34x] (Party Identifier)

4*35x (Name and Address)

Note This option is used when no other option is available.


This information also applies to fields 50 (when option representing name and address
is selected) and 59 (without letter option).

Definition
Name and address and, optionally, the account or clearing code of the party.

Network validated rules


If the first line of this field starts with a slash '/', then it is assumed that Party Identifier is present
and then at least 1 line of Name and Address must be present (Error code T77).

Usage rules
When the party identification is provided by name and address (whether by full postal address or
informal identification), the following rules apply:
• at least one line of the name and address must be present, in addition to the party identifier
• the street address must be on a new line following the name
• when a city is present, it must be on the last line, with the postal code (zip, etc.), state and
country identification
Although more than one element of an address may appear on each line, care should be taken
that, when possible, no element, for example, street address, should be spread over more than one
line.
If a Party Identifier is absent, then Name and Address must not start with a slash '/'.

National clearing codes list


When the party identifier is used to indicate a national clearing system code preceded by a double
slash '//', the following codes may be used:

AT 5!n Austrian Bankleitzahl

AU 6!n Australian Bank State Branch (BSB) Code

17 December 2021 80
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

BL 8!n German Bankleitzahl

CC 9!n Canadian Payments Association Payment Routing Number

CH 6!n CHIPS Universal Identifier

CN 12..14n China National Advanced Payment System (CNAPS) Code

CP 4!n CHIPS Participant Identifier

ES 8..9n Spanish Domestic Interbanking Code

FW 9!n Fedwire Routing Number

GR 7!n HEBIC (Hellenic Bank Identification Code)

HK 3!n Bank Code of Hong-Kong

IE 6!n Irish National Clearing Code

IN 11!n Indian Financial System Code (IFSC) is the identification scheme


defined by the Reserve Bank of India

IT 10!n Italian Domestic Identification Code

NZ 6!n New Zealand National Clearing Code

PL 8!n Polish National Clearing Code (KNR)

PT 8!n Portuguese National Clearing Code

RT Pay by Real Time Gross Settlement

RU 9!n Russian Central Bank Identification Code

SC 6!n UK Domestic Sort Code

SW 3..5n Swiss Clearing Code (BC code)

SW 6!n Swiss Clearing Code (SIC code)

ZA 6!n South African National Clearing Code

In some messages, some of these clearing codes may also be used with option A, that is, the MTs
101, 102, 102 STP, 103, 103 REMIT, 103 STP, and 104. This is indicated with the field
specifications of each message type.
When one of the codes //FW (with or without the 9-digit number), //AU, //CP or //RT is used, it
should appear only once, and in the first of the fields 56a and 57a of the payment instruction.
When it is necessary that an incoming SWIFT payment be made to the party in this field via
Fedwire, US banks require that the code FW appears in the optional Party Identifier.
When it is necessary that an incoming SWIFT payment be made to the party in this field via a real-
time gross settlement system (RTGS), the code RT should appear in the optional Party Identifier.

17 December 2021 81
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

Option D must only be used in exceptional circumstances, that is, when the party cannot be
identified by a BIC, and when there is a bilateral agreement between the sender and the receiver
permitting its use. Unless qualified by a clearing system code or an account number, the use of
option D may prevent the automated processing of the instruction(s) by the receiver.

National clearing codes formats


List of codes and formats:
• The Australian BSB code is the identification scheme defined by APCA (Australian Payments
Clearing Association).
Its structure is either:
for financial institutions with an extensive branch network:
- 2!n = Bank Code
- 1!n = State Code
- 3!n = Branch Code
or for institutions with a small network:
- 3!n = Bank Code
- 3!n = Branch Code
• The Bank Code for Hong-Kong is structured as follows:
- 3!n = Bank Code
• The Hellenic Bank Identification Code (HEBIC) is the identification scheme defined by the
Hellenic Bank Association. Its structure is:
- 3!n = Bank Code
- 4!n = Branch Code
• The Indian Financial System Code (IFSC) is the identification scheme defined by the Reserve
Bank of India. Its structure is:
- 4!a = Bank Code (same as party prefix in BIC - ISO 9362)
- 1!n = Zero - Reserved for future use
- 6!c = Branch Code
• The structure of the Irish NSC code is 2!n4!n, where:
- 2!n = Bank Code
- 4!n = Branch Code
• The Italian ITBI code is the identification scheme defined by ABI (Associazione Bancaria
Italiana). Its structure is:
- 5!n = Bank Code (ABI)
- 5!n = Branch Code (CAB)
• The New Zealand Bank/Branch Code is the identification scheme defined by NZBA (New
Zealand Bankers Association). Its structure is:
- 2!n = Bank Code
- 4!n = Branch Code

17 December 2021 82
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

• The Portuguese National Clearing code is defined by the Banco de Portugal. Its structure is 4!
n4!n, where:
- 4!n = Bank Code (IFRI), potentially containing leading zeros
- 4!n = Branch Code (BLCI) which is unique for each branch and locally assigned by the
financial institution
• The Russian Central Bank Identification Code is to be considered as one, uniform, indivisible
code. Its structure is 2!n2!n2!n3!n, where:
- 2!n = Country Code. The first position is always 0 and is not shown in the database of the
Central Bank of Russia.
- 2!n = Region Code within the country
- 2!n = Code of the division of the Central Bank in the region
- 3!n = Bank Code
• The South African National Clearing code is defined by BankServ, the South African Bankers
Services Company Ltd. Its structure is 3!n3!n, where:
- 3!n = Bank Code, potentially with leading zeros
- 3!n = Branch Code, potentially with leading zeros
• The Spanish Domestic Interbanking Code is the identification scheme defined by CCI (Centro
de Cooperacion Interbancaria). Its structure is:
- 4!n = Bank Code
- 4!n = Branch Code
- [1!n] = Check Digit

Fields assigned to this option


42D
50D, 51D, 52D, 53D, 54D, 55D, 56D, 57D, 58D
82D, 83D, 84D, 85D, 86D, 87D, 88D
Note Field 41D does not have the optional party identifier but does have an additional
subfield.

9.5.4.7 Option F: Party Identifier/Name and Address


Format
[35x] (Party Identifier)

4*35x (Name and Address)

The following line formats must be used (Error code(s): T54):

Line 1 (subfield Party Identifier) /34x (Account)

Line 2-5 (subfield Name and 1!n/33x (Number)(Details)


Address)

Or

17 December 2021 83
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

Line 1 (subfield Party Identifier) 4!a/2!a/27x (Code)(Country Code)(Identifier)

Line 2-5 (subfield Name and 1!n/33x (Number)(Details)


Address)

Or

Line 1 (subfield Party Identifier) [/34x] (Account)

Line 2-5 (subfield Name and 1!n/33x (Number)(Details)


Address)

Definition
Name and address in a structured format to facilitate straight-through processing.

Codes
When Party Identifier is used with the (Code)(Country Code)(Identifier) format, for example in field
50F Ordering Customer, one of the following codes must be used:

ARNU Alien Registration Number The code followed by a slash, '/' must be followed by the
ISO country code, a slash, '/' and the Alien Registration
Number.

CCPT Passport Number The code followed by a slash, '/' must be followed by the
ISO country code, a slash, '/' and the Passport Number.

CUST Customer Identification Number The code followed by a slash, '/' must be followed by the
ISO country code of the issuer of the number, a slash, '/',
the issuer of the number, a slash, '/' and the Customer
Identification Number.

DRLC Driver's License Number The code followed by a slash, '/' must be followed by the
ISO country code of the issuing authority, a slash, '/', the
issuing authority, a slash, '/' and the Driver's License
Number.

EMPL Employer Number The code followed by a slash, '/' must be followed by the
ISO country code of the registration authority, a slash, '/',
the registration authority, a slash, '/' and the Employer
Number.

NIDN National Identity Number The code followed by a slash, '/' must be followed by the
ISO country code, a slash, '/' and the National Identity
Number.

SOSE Social Security Number The code followed by a slash, '/' must be followed by the
ISO country code, a slash, '/' and the Social Security
Number.

TXID Tax Identification Number The code followed by a slash, '/' must be followed by the
ISO country code, a slash, '/' and the Tax Identification
Number.

17 December 2021 84
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

Codes
On each line of Name and Address, subfield Number must contain one of the following values
(Error code(s): T56):

1 Name of the Ordering Customer The number followed by a slash, '/' must be followed by the
name of the ordering customer.

2 Address Line The number followed by a slash, '/' must be followed by an


address line (Address Line can be used to provide for
example, street name and number, or building name).

3 Country and Town The first occurrence of number 3 must be followed by a


slash, '/', the ISO country code, and optionally a slash '/'
followed by additional details.
Other occurrence(s) of number 3 must be followed by a
slash '/' and the continuation of additional details.
Additional details can contain town, which can be
complemented by postal code (for example zip) and
country subdivision (for example state, province, or
county).
The country code and town should, preferably, indicate the
country and town of residence.

Some option F fields also allow for these values in Number:

4 Date of Birth The number followed by a slash, '/' must be followed by the
date of birth in the YYYYMMDD format.

5 Place of Birth The number followed by a slash, '/' must be followed by the
ISO country code, a slash '/' and the place of birth.

6 Customer Identification Number The number followed by a slash, '/' must be followed by the
ISO country code of the issuer of the number, a slash, '/',
the issuer of the number, a slash, '/' and the customer
identification number.

7 National Identity Number The number followed by a slash, '/' must be followed by the
ISO country code, a slash, '/' and the national identity
number.

8 Additional Information The number followed by a slash, '/' is followed by


information completing one of the following:
• the Identifier provided in subfield 1 (Party Identifier)
used with the (Code)(Country Code)(Identifier) format
• the Customer Identification Number provided in
subfield 2 (Name and Address) with number 6
• the National Identity Number provided in subfield 2
(Name and Address) with number 7

Network validated rules


In subfield 1 (Party Identifier) used with the (Code)(Country Code)(Identifier) format: Country Code
must be a valid ISO country code (Error code(s): T73).

17 December 2021 85
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

In subfield 2 (Name and Address):


• The first line must start with number 1 (Error code(s): T56).
• Numbers must appear in numerical order (Error code(s): T56).
• A line starting with number 3 must be present (Error code(s): T56).
• The first occurrence of number 3 must be followed by a valid ISO country code (Error code(s):
T73).
• Numbers 1, 2, and 3 may be repeated. The same number must not occur more than 2 times
(Error code(s): T56).
• Option F fields that also allow the numbers 4 – 8 in Number, for example field 50F, have these
additional network validated rules:
- Number 4 must not be used without number 5 and vice versa (Error code(s): T56).
- Number 4 must be followed by a valid date in the format YYYYMMDD and this date, local to
the sender, must not be later than the date on which the message is successfully sent to
SWIFT (Error code(s): T50).
- Numbers 5, 6, and 7 must be followed by a valid ISO country code (Error code(s): T73), a
slash '/' and additional Details (Error code(s): T56).
- Numbers 4, 5, 6, 7, and 8 must not be repeated (Error code(s): T56).
- The use of number 8 is only allowed in the following instances (Error code(s): T56):
▪ to continue information on the Identifier of the ordering customer provided in subfield 1
(Party Identifier) used with the (Code)(Country Code)(Identifier) format
▪ to continue information on the Customer Identification Number provided in subfield 2
(Name and Address) following number 6
▪ to continue information on the National Identity Number provided in subfield 2 (Name and
Address) following number 7

Usage rules
• In subfield 2: numbers 1, 2, and 3 may be repeated.
• In subfield 2: if number 2 is present, the first occurrence of number 3 must include the town in
additional details.
For ordering customer:
• Subfield 1 (Party Identifier) used with the (Code)(Country Code)(Identifier) format: if additional
space is required for providing the Identifier of the ordering customer, one of the following
options must be used:
- First option (preferred): identify the ordering customer with a different identifier where the
length is not an issue.
- Second option: continue the information in subfield 2 (Name and Address) using number 8.
• Subfield 2 (Name and Address): if additional space is required for providing the Customer
Identification Number (number 6) or the National Identity Number (number 7) of the ordering
customer, one of the following options must be used:
- First option (preferred): identify the ordering customer with a different identifier where the
length is not an issue.
- Second option: continue the information in subfield 2 (Name and Address) using number 8.

Field assigned to this option


50F, 59F

17 December 2021 86
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

9.5.4.8 Option G: Identifier Code


Format
/34x (Account)

4!a2!a2!c[3!c] (Identifier Code)

Definition
Identifier code of the party with mandatory account number.
Network validated rules
Identifier Code must be a registered BIC (Error codes T27, T28, T29, and T45).

Fields assigned to this option


50G, 52G

9.5.4.9 Option H: Name and Address


Format
/34x (Account)

4*35x (Name and Address)

Definition
Name and address of the party with a mandatory account.

Field assigned to this option


50H

9.5.4.10 Option J: Party Identification with no Party Identifier


Format
5*40x (Narrative)

Definition
Identification of the party.

Codes
In option J, Party Identification must be specified as a list of pairs (Code)(Value) and one or more of
the following codes and formats must be used (Error code(s): T78).
The codes must be placed between slashes ('/').

Code Format Description

ABIC 4!a2!a2!c[3!c] or 4!a Identifier Code

17 December 2021 87
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

Code Format Description

ACCT 34x account followed by the account number

ADD1 35x address followed by the first line of the address

ADD2 35x address followed by the second line of the address

CITY 35x city followed by the name of city (and state, country)

CLRC 35x Clearing Code followed by a clearing code

LEIC 18!c2!n Legal Entity Identifier

NAME 34x name followed by the name

NETS - a net settlement is taking place

SSIS - standard settlement instructions are used

The codes do not need to be put on separate lines. It is the '/' at the beginning of a code, not the
end-of-line, that marks the end of the information behind the previous code.
As a result, the narrative following the code may not contain a slash '/'. The end-of-line may be part
of the narrative text following the code, but it is to be ignored when reading the field. However, the
end-of-line may not be part of the code.

Examples
/ABIC/BNKAXA11/NAME/BANK A OF XANADU(CrLf)

/NAME/BANK A OF XANADU/ABIC/BNKAXA11(CrLf)

/ABIC/BNKAXA11(CrLf) /NAME/BANK A OF XANADU(CrLf)

/ABIC/BNKAXA11/NAME/BRANCH B OF THE(CrLf)

SECOND NATIONAL BANK A OF XANADU(CrLf)

Fields assigned to this option


53J, 56J, 57J, 58J
82J, 83J, 84J, 85J, 86J, 87J, 88J.

9.5.4.11 Option K: Name and Address


Format
[/34x] (Account)

4*35x (Name and Address)

Definition
Name and address of the party, with an optional account.

17 December 2021 88
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

Network validated rules


If the first line of this field starts with a slash '/', then it is assumed that Account is present and then
at least 1 line of Name and Address must be present (Error code T77).
Usage rules
If Account is absent, then Name and Address must not start with a slash '/'.

Field assigned to this option


50K

9.5.4.12 Option L: Party Identification


Format
35x (Narrative)

Definition
Identification of the party
Field assigned to this option
50L

9.5.4.13 Option P: Party


Format
:4!c//4!a2!a2!c[3!c] (Qualifier)(Identifier Code)

Definition
Identification of the party, with a qualifier and an identifier code such as a BIC.

Field assigned to this option


95P

9.5.4.14 Option Q: Party


Format
:4!c//4*35x (Qualifier) (Name and Address)

Definition
Identification of the party, with a qualifier and name and address.

Field assigned to this option


95Q

17 December 2021 89
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

9.5.4.15 Option R: Party


Format
:4!c/8c/34x (Qualifier) (Data Source Scheme) (Proprietary Code)

Definition
Identification of the party, with a qualifier, issuer code and proprietary code.

Field assigned to this option


95R

9.5.4.16 Option S: Party


Format
:4!c/[8c]/4!c/2!a/30x (Qualifier) (Data Source Scheme) (Type of ID) (Country
code) (Alternate ID)

Definition
Identification of the party, with a qualifier, an optional issuer code, type of ID, country code and
alternate ID.

Field assigned to this option


95S

9.5.4.17 Option T: Party


Format
:4!c//2*35x (Qualifier) (Name)

Definition
Identification of the party, with a qualifier and name.

Field assigned to this option


95T

9.5.4.18 Option U: Party


Format
:4!c//3*35x (Qualifier) (Name)

Definition
Identification of the party, with a qualifier and names.

17 December 2021 90
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

Field assigned to this option


95U

9.5.5 Times
Formats
4!n
6!n

Rules
Times are represented as either four or six digit integers, that is, in form HHMM or HHMMSS
respectively, where (Error code T38):
• H = hour
• M = minutes
• S = seconds
No blank spaces or other characters are permitted.

Examples
0000

1200

235959

9.5.6 Value Date Ordering


Overview
The SWIFT system allows the receiver to request value date ordering of its value date sensitive
messages.
The value date sensitive messages are:
• MT 910
• all Category 1 and Category 2 messages containing fields 30 or 32A, or both 30 and 32A,
except common group messages 192, 292, 195, 295, 196, and 296
The valid range of value dates implemented on the SWIFT system for these MTs is from 2001 to
2060, and must meet the following requirements:
• allowed: a year component, for example, "YY" in the range of 01 through 60, of an ISO defined
six digit integer date "YYMMDD"
• not allowed: any "YY" component outside of this range

Example
ACKed NAKed

:32A:061130USD1, :32A:611130USD1,
:30:181130 :30:791130

17 December 2021 91
Alliance Access 7.6.20 Help about Message Standards
Message Management Guide

For the purpose of value date ordering, if there is more than one value date field in a message, the
lesser date will be selected:

MTxxx

:30:151218 Value date = 18 December 2015


:32A:200103USD123000,00 Value date = 03 January 2020

In this example, field 30 Value Date (18 December 2015) is selected for value date ordering of the
message. Error code T50 is returned after an invalid value date.

17 December 2021 92
Alliance Access 7.6.20 Message Creation
Message Management Guide

10 Message Creation
Overview
You can create a message from scratch, from a message template, or from an existing message.
You create messages according to the permissions defined in your operator profile, including any
restrictions limiting the message types, currencies, or amounts.

Message editor
Messages are created in Alliance Message Management through a message editor. The message
editor is a form with tabs which display the mandatory and optional fields that must be completed
with information by the sender or the requestor.
The forms for creating and editing FileAct message manually differ slightly from the form for
creating and modifying FIN, APC, and MX messages.
For more information about message editor forms, see the following sections:
• Message Editor on page 47
• FileAct Details (Send) Window on page 135
• FileAct Details (Get) Window on page 143
Message standards help
If the online help for message standards is installed, then help about the fields in a message is
available from Alliance Message Management. See Help for Messages on page 64.

Navigation between menu items


You can also open several menu items at the same time from different menus. This enables you to
create messages and switch from the message editor to other tasks at the same time.

Flagging of message duplicates


When you create a FIN, MX, or File message using the Message Management GUI and you
attempt to save the changes (by clicking Route or Dispose ), before saving the changes in the
database, Alliance Access first performs its own duplicate detection on the message, based on the
latest values as displayed in the GUI.
If the message is detected to be a duplicate according to its criteria, Alliance Access displays a
Duplicate detected by interface warning in a pop-up window. You are prompted to either
continue or cancel the message processing. If you click Cancel , Alliance Access does not try to
route or dispose the message. If you click OK , the message processing continues.

10.1 Create Messages


Overview of how to create a message
The creation of a message involves the following tasks:
1. If required, select the logical terminal from which the message must be sent.
2. Choose the type of message to create: FIN, APC, MX, or FileAct.
3. Decide whether to create a message from scratch, from a message template, or from an
existing message.

17 December 2021 93
Alliance Access 7.6.20 Message Creation
Message Management Guide

To create a message from scratch, see the following sections:


• Create a FIN or a System Message on page 95
• Create an MX Message on page 102
• Send a File Manually on page 139 (in real-time or store-and-forward))
• Download a File Manually on page 146 (for real-time services)
For information about using message templates, see Use Message Templates on page 106.
For information about creating a message from an existing message, see Create a Message
from an Existing Message on page 122.
4. Validate the message.
5. Route or send the message for further processing.

Fast and prompted mode


You can create the body of an MT or MX message in the following modes:
• Prompted mode: Alliance Access displays structured information about the fields in the body, or
application header of a message, and provides user assistance for selecting and for entering
values in the message.
• Fast mode: Alliance Access displays in text format the fields in the body, or application header,
of the message. No additional information is provided about what to enter in each field.
For more information, see Fast Mode on page 123.

Permission checks for MT and MX messages


Operators cannot create MT and MX messages with a currency/amount above the limit, if any,
specified in their Mesg Creation, Create message, CCY/amount permission detail. If the operator
profile has a Mesg Creation, Dispose message, Bypass Verification, CCY/amount limit and the new
MT or MX message has a currency/amount that is above that limit, then the message can only be
disposed to the verification queue or the text modification queue.
If the operator profile has a Mesg Creation, Dispose message, Bypass Authorisation, CCY/amount
limit and the new MT or MX message has a currency/amount that is above that limit, then the
message can only be disposed to the verification queue, the authorisation queue, or the text
modification queue.
Otherwise, the message can be disposed to any queue.

10.2 Create FIN Messages


Overview
This section explains how to create FIN messages from scratch. To create FIN messages based on
existing message templates, see Create a Message from a Message Template on page 112.
Navigation between menu items
When you create a FIN message, you can also open other menu items (messages) at the same
time from the Creation, Modification, Approval, and Search and Report menus.

17 December 2021 94
Alliance Access 7.6.20 Message Creation
Message Management Guide

10.2.1 FIN Message: New Page


Overview
The FIN Message: New page allows you to select the sender logical terminal, the FIN category,
and the message type.

Page example

The following is an example. The list of standards that are installed in your institution may differ:

Page description

Sender Logical The logical terminal that you want the message to be sent from. You can
Terminal only send a message from a logical terminal that is licensed for your
installation and allowed by your profile. The value selected in Sender
Logical Terminal determines the message syntax version to use.

FIN Category You can select a message category from the ones that are available. The list
also includes the names of the message categories from the installed
MyStandards packet, if applicable. Each category contains only the
messages that you are allowed to create (as defined in your operator
profile).

Name The message type.

Identifier The internal name of the message type.

Description Text that explains the business purpose of the message type.

Version The message syntax version assigned to the logical terminal selected.

10.2.2 Create a FIN or a System Message


Procedure
1. From the Creation menu, select FIN Message: New.

17 December 2021 95
Alliance Access 7.6.20 Message Creation
Message Management Guide

2. Select a logical terminal from the Sender Logical Terminal drop-down list.
The value entered for the Sender Logical Terminal field by an operator when creating a
message is automatically saved. It is proposed as the initial value when the same operator
creates another message.
Note If you select a Sender Logical Terminal ending in X, then the default syntax
when creating and validating the message will be used. If this syntax is different
from the installed version of a FIN message standard, you will be unable to see all
of the FIN category.
3. Select the appropriate message category in the FIN Category drop-down list.
The (installed) MY FIN message standards are displayed in the FIN Category list, next to the
name of the installed base FIN message standards. Although a My FIN message standard can
contain different FIN messages categories, the FIN Category field is not renamed.
The value entered for the FIN Category field by an operator when creating a FIN message is
automatically saved. It is proposed as the initial value when the same operator creates another
FIN message using the above GUI.
The list of message types available in the selected category appears.
4. Select a message type from that list.
The message editor appears and displays the fields that are appropriate for that message type.
The Header tab is selected by default.
Tip For more information about how to use the message editor, see Message Editor
on page 47.
5. Enter the values for the fields in each tab:
• Complete the Header of a FIN or APC message on page 97
• Complete the Body of a FIN or APC Message on page 99
• Define the Network of a FIN or APC Message on page 100
• Complete the Comments, if any. Comments can contain a maximum of 500 characters.
6. Next, take the appropriate action:

Button Action More information

Close Message Closes the message without saving the


changes.

Export Creates a report of the message. Report Types and Settings (Export
Function) on page 36

Print Prints a report directly from the GUI. Print a Report Directly from the
GUI on page 36

Save as Template Saves the information in the message as a Create a Template for FIN, APC,
template. Then, you can close the message, or MX Messages on page 111
or perform another action.

New Fast With this mode, you can choose how tags Fast Mode on page 123
are displayed when creating messages,
either All Tags or Mandatory Tags.
This button is not available for locked
templates.

17 December 2021 96
Alliance Access 7.6.20 Message Creation
Message Management Guide

Button Action More information

Validate Validates the message format. Validate a Message and Correct


Errors on page 126

Fast / Prompted Allows you to create the body of an MT Fast Mode on page 123
message in fast or prompted mode.

Route Routes a valid message according to the Route a Message on page 130
routing rules defined within Alliance Access.

Dispose to Sends a valid message to a queue that is Send a Message to a Queue


chosen by the operator. However, you can (Dispose to) on page 131
move invalid messages to the Text
Modification queue.

Note Online help for the message is also available (see Help for Messages on page
64). The online help is based on the information in the User Handbook and
explains how to complete specific fields.

10.2.3 Complete the Header of a FIN or APC message


In the message header, you specify the identity of the sender and the receiver of the message. You
also provide information regarding the priority of the message, as well as other details that are
relevant for the particular message that you are creating.

Procedure
1. In the Sender part, select a unit from the Unit drop-down list. This is the unit to which the
message is assigned.
The value entered for the Unit field by an operator when creating a FIN message is
automatically saved. It is proposed as the initial value when the same operator creates another
FIN message.
2. The Sender Logical Terminal field shows the logical terminal that you have selected in the
previous page.
3. Click Type to select the type of correspondent sending the message: Institution, Department,
or Individual. If you select Department or Individual, then extra fields appear so that you can
enter additional details.
4. The Institution field displays the sender institution BIC8 corresponding to the logical terminal
as a read-only value before the input area for the branch code. Select the branch code from the
drop-down list.
5. If the correspondent Type is Department or Individual, then complete the extra fields so that
the Department or Individual is clearly identified. The combination of details in the Institution
field and these other fields make up a Full Name which uniquely identifies the correspondent.
6. In the Receiver part, you can specify that the message is sent to an alias provided the alias is
defined in the Correspondent Information File. The Alliance Access Configuration package is
used to define aliases for correspondents. An alias is an alternative name for one or more
correspondents.
If you select Alias, then select an alias name in the field that appears. If the alias is for a group
of correspondents, then the message type must be MT 999. The message is broadcast to the
group of correspondents. If the alias represents only one correspondent then there is no
restriction on the message type.

17 December 2021 97
Alliance Access 7.6.20 Message Creation
Message Management Guide

In order to use an alias, the Message Creation, Can create broadcasting permission is
required. For more information on creating messages by using an alias, see Knowledge Base
tip 22392.

7. Click Type to select the type of correspondent receiving the message: Institution,
Department, or Individual. If you select Department or Individual, then extra fields appear so
that you can enter additional details.
8. In the Institution field, provide the BIC11 address of the Receiver correspondent. This is
usually a BIC11 address for an external correspondent, that is, one not owned by your
organisation, and so having a different BIC11 to your organisation. It can, however, be an
internal one.
If a record exists for this BIC11 address in the CIF, then Alliance Message Management
displays the address details. If the BIC is not found in the CIF, then the Address Expansion
fields remain empty. It is possible that the BIC is not yet included in the CIF. If Alliance Message
Management does not display values in the Address Expansion fields, then you can type the
data yourself, although this is not mandatory.
The validation of existing RMA is performed when you fill in the message receiver data.
9. If you specified the correspondent Type as Department or Individual, then you must complete
the extra fields.
10. In the Options part, complete the FIN Copy field if you use the FINCopy service. From the
drop-down list, select the FINCopy service corresponding to the central institution destination
that you want to copy the message to.
FIN Copy is shown only for relevant message types according to the sender LT and the
FINCopy profiles that are installed on Alliance Access.
11. In the Options part, click Priority to select the priority of the message on the network. In the
absence of user-specified delivery criteria, system messages are always delivered first,
followed by messages with urgent priority, and then messages with normal priority.
12. From the Monitoring list, select an option for monitoring the delivery of the message:
• For messages with normal priority
None for no monitoring

Delivery for delivery notification

• For messages with urgent priority


Non-Delivery for non-delivery warning

Full for both non-delivery warning and delivery notification

SWIFT sends an MT 011 (delivery notification) to you after the message has been delivered to
your correspondent.
SWIFT sends an MT 010 (non-delivery warning) if the message is not delivered to your
correspondent within a fixed period.
13. Select Yes in the User PDE field if you suspect that the message that you are creating was
sent previously. Otherwise you can leave the field empty. By default, messages are sent
without a Possible Duplicate Emission trailer.
14. In the Banking Priority field, type a priority with which your correspondent must process the
message. This field is optional. Any value that you enter in this field must be agreed with the
correspondent in advance.

17 December 2021 98
Alliance Access 7.6.20 Message Creation
Message Management Guide

15. In the MUR field, enter a message user reference of 16 alphanumeric characters maximum.
This field is optional. How the reference is derived and how it is used is for individual
organisations to decide.
16. Optional: If you have activated the Auto-generate SLA ID parameter, then the SLA ID field is
populated automatically.
The SLA ID is the service type identifier. For gpi, this field identifies which SWIFT gpi service
the sender is subscribed to.
For more information about the Auto-generate SLA ID parameter, see the Alliance Access
Configuration Guide.
17. UETR field: By default, for certain FIN messages, Alliance Access generates automatically a 36
character alphanumeric unique end-to-end transaction reference (UETR) after you route or
dispose the message. Alternatively, you can click Generate . If you do this, then you will see the
UETR before you route or dispose the message.
You can edit this field only during message creation or in message modification.
You can deactivate the automatic generation of the UETR using the Auto-generate UETR
parameter. See the Alliance Access Configuration Guide.
See also UETR and SLA ID Fields in Alliance Access on page 41.

10.2.4 Complete the Body of a FIN or APC Message


Introduction
You enter the text of the message in the message body. The layout of the message body varies
according to the structure of the message.
The fields that appear depend on the message type selected and on the syntax version which
varies according to the sender logical terminal selected. You may need to use the vertical scroll bar
to display all the fields, depending on the message length. Complete the fields in their displayed
sequence. Some parts of the body can be collapsed to ease navigation.
For more information, see Message Editor on page 47.
Fast mode
If you are an experienced operator, and you are familiar with message syntax, then you can also
complete the body of the message in fast mode.
For more information, see Fast Mode on page 123 and Structure of Fields in FIN Messages on
page 72.

Procedure
1. Complete all mandatory fields.
2. Complete any optional fields as needed.

Related information
Fast Mode on page 123

17 December 2021 99
Alliance Access 7.6.20 Message Creation
Message Management Guide

10.2.5 Define the Network of a FIN or APC Message


By selecting the Network tab, you can define the network to be used for sending messages,
including:
• SWIFT
• APPLI
• OTHER
• IPLA
The default value that is displayed for the network is derived from the Correspondent Information
File (CIF), if this information is available. Otherwise, the first value from the Preferred Order
system parameter is displayed.
Procedure
1. When you select APPLI, the Target Exit Point for Message Disposal drop-down allows you
to select an exit point where the message can be later disposed. It is only editable by operators
with the Mesg Creation (Modification), Change Network permission. This field is mandatory
when the Network field is APPLI.
You must have the System Management, Routing, or Application Interface permissions to
retrieve the list of exit points that are displayed in this tab.
2. When you route a message with network APPLI and set the selected routing rule of the queue
routes to the addressee (as done in Message Authorisation), the message is routed to the exit
point specified in the receiver correspondent information (APPLI tab). If no exit point is
specified in the correspondent information (or if the receiver correspondent is not known), the
route to Addressee rule is skipped and the next routing rule is evaluated.
3. When you route a message with network OTHER and set the selected routing rule of the queue
routes to the addressee (as done in Message Authorisation), the message is routed to
_OI_to_OTHER. When you route a message with network IPLA and set the selected routing
rule of the queue routes to the addressee (as done in Message Authorisation), the routing rule
is skipped.
4. When you dispose a message with network OTHER or IPLA, the SWIFT option in the Dispose
to drop-down will not appear.
5. When you dispose a message with network APPLI, the SWIFT option in the Dispose to drop-
down is replaced with the exit point selected in the Network tab.
Note The Network tab is always displayed, but its content is only editable by operators
with the Mesg Creation (Modification), Change Network permission.

10.3 Create APC Messages


APC messages only include category 0 messages, that is system messages for the General
Purpose Application. Online help for the message is also available (see Help for Messages on
page 64). The online help is based on the information in the User Handbook and explains how to
complete specific fields.
APC messages are created in the same way as FIN messages. See Create a FIN or a System
Message on page 95 for detailed instructions.
Note The Receiver fields are automatically completed for new APC messages.

17 December 2021 100


Alliance Access 7.6.20 Message Creation
Message Management Guide

10.4 Create MX Messages


Overview
The permissions that you have regarding message processing tasks for MX messages depend on
your operator profile.
MX messages that are delivered in real time may receive a business response message. Such a
message is stored as an intervention called transmission response, which is visible when the
message is retrieved from the database (on the back-end instance) through message search.

Navigation between menu items


When you create an MX message, you can also open other menu items (messages) at the same
time from the Creation, Modification, Approval, and Search and Report menus.

Extraction of currency, amount, value date, and usage identifier keywords


When you create an MX message in the Alliance Access database, if the Deployment Package or
Universal Standards Archive (USA) package corresponding to the MX service/request type
indicates that it contains the currency, amount, value date, or usage identifier (RequestSubType)
keywords, then Alliance Access extracts those keywords and stores their value in the
corresponding currency, amount, and value date fields of the message in the Alliance Access
database.
If the value of the amount keyword to be extracted is longer than the amount field of the Alliance
Access database, then the currency and amount are not extracted (however, the value date is
extracted) and an event is logged in the Event Journal.

10.4.1 MX Message: New Page


Overview
The MX Message: New page allows you to select the message standard and the message.

Page example

The following is an example. The list of standards that are installed in your institution may differ:

Page description

Standard Each MX standard groups the messages used within a particular Solution. The
list also includes the names of the message groups from the installed
MyStandards packet, if applicable.

Name The message name.

Identifier The internal name of the message.

17 December 2021 101


Alliance Access 7.6.20 Message Creation
Message Management Guide

Usage Identifier The RequestSubType of the MX message standard


The RequestSubType value must be provided by the sender only when multiple
usage guideline flavours apply for the same request type.

Description The expanded text of the Name column.

Version The message standards version.

Delivery Mode Real-time or store-and-forward.

10.4.2 Create an MX Message


Before you begin
To display the MX Message: New option:
• The Mesg Creation / Create Message, Service&Identifier - InterAct messages detail of your
operator profile must be different from Allowed: None.
• The Mesg Creation / Create Message, Own Destination(s) for InterAct & FileAct (DN) detail
of your operator profile must allow or explicitly not prohibit the Requestor DN of the message.
Procedure
1. From the Creation menu, select MX Message: New.
2. Select a message standard from the Standard drop-down list.
The (installed) MY MX message standards are displayed in the Standard list, next to the name
of the installed base MX message standards.
The list of messages available for the standard selected appears.
The value entered for the Standard field by an operator when creating an MX message is
automatically saved. It is proposed as the initial value when the same operator creates another
MX message using the above GUI.
3. Click a message from that list.
The message editor appears and displays the fields that are relevant for the message. The
Header tab selected by default.
Tip For more information about how to use the message editor, see Message Editor
on page 47.
4. Enter the values for the fields in each tab:
• Complete the Header of an MX Message on page 103
• Complete the Application Header of an MX Message on page 105
• Complete the Body of an MX Message on page 105
• Define the Network of an MX Message on page 106
• Complete the Comments, if any. Comments can contain a maximum of 500 characters.

17 December 2021 102


Alliance Access 7.6.20 Message Creation
Message Management Guide

5. Next, take the appropriate action:

Button Action More information

Close Message Closes the message without saving the


changes.

Export Creates a report of the message. Report Types and Settings


(Export Function) on page 36

Print Prints a report directly from the GUI. Print a Report Directly from the
GUI on page 36

Save as Template Saves the information in the message as a Create a Template for FIN, APC,
template. Then, you can close the message, or MX Messages on page 111
or perform another action.

Validate Validates the message format. Validate a Message and Correct


Errors on page 126

Fast / Prompted Allows you to create the body of an MX Fast Mode on page 123
message in fast or prompted mode.

Route Routes a valid message according to the Route a Message on page 130
routing rules defined within Alliance Access.

Dispose to Sends a valid message to a queue that is Send a Message to a Queue


chosen by the operator. However, you can (Dispose to) on page 131
move invalid messages to the Text
Modification queue.

10.4.3 Complete the Header of an MX Message


If the Requestor DN that is provided in the header of an MX message does not contain a BIC8 part
(for example, o=xxxxxxxx) that is an allowed sender destination according to your operator profile,
then Alliance Message Management does not allow you to further process this message, not even
to dispose it to the Text Modification queue.
The Responder DN must end with o=<bic8>,o=swift or, if relevant, o=swift,o=swift.
For more information about DN structure, see the SWIFTNet Naming and Addressing Guide. The
guide is available on www.swift.com, under Support >Knowledge Centre (User Handbook) .
Note An error in either the Requestor DN or the Responder DN field prevents you from
routing or disposing the message, even to the Text Modification queue.
Alliance Access creates and maintains a Last Used DN store. Each time a DN is
successfully used for a message, the entry corresponding to the type of DN, operator,
service, and DN itself is created or updated. Therefore, when you create a message,
the DN can be selected from the drop-down list in the message header.
About this task
Some of the following field names can differ based on the Deployment Package or Universal
Standard Archive package:

17 December 2021 103


Alliance Access 7.6.20 Message Creation
Message Management Guide

Procedure
1. Select a unit from the Unit drop-down list. This is the unit to which the message is assigned.
Only operators belonging to the same unit are able to access the message.
The value entered for the Unit field by an operator when creating a MX message is
automatically saved. It is proposed as the initial value when the same operator creates another
MX message.
2. Complete the Requestor DN field, or select it from the drop-down list. It must be a valid DN
and must contain a BIC8 which is an allowed sender destination according to your operator
profile. The BIC8 must be an internal correspondent for the Alliance Access instance.
Note The Requestor DN and Responder DN fields may already contain default values
configured during the installation of the message standards using the Alliance
Access/Entry Configuration GUI.
3. Complete the Responder DN field, or select it from the drop-down list. If REACHPLUS has
been installed, you can also use the DN picker to select the DN from BICs and Other Codes.
4. If the message is going to a service that is not the live one, then type the relevant characters
after ! next to the Service or Service Name field (for example, "p" for a pilot service). The
service name entered is subject to operator permission as defined in the operator profile.
5. You cannot edit the Identifier field or the MessageIdentifier field.
6. If the Usage Identifier field is empty, then you can edit this optional field.
7. Complete the User Ref field (optional).
8. Click Priority to select the priority of the message on the network. Select Normal for a normal
priority message or Urgent for urgent messages. The default value is Normal. If no delivery
criteria are specified, then messages with urgent priority are delivered before messages with
normal priority.
9. Signed field. You can select Yes or No, or leave the field empty.
The default value depends on the application service profile.
10. Non-Repudiation field. You can select Yes or No, or leave the field empty.
The default value depends on the application service profile.
Note This is not related to the signing of messages as discussed in section Message
Authorisation Page on page 173 and section Authorise a Message on page 176.
11. The Delivery Mode field cannot be edited and shows the delivery mode of the message being
created.
12. The Possible Duplicate field is used to warn the receiver that some special handling may be
required for the message (for example, the message was already delivered by SWIFT or was
sent before). You can select Yes or No.
13. Notification Required field (only for messages sent using store-and-forward delivery). You can
select Yes or No, or leave the field empty.
14. SWIFTNet Copy field (only for messages sent using store-and-forward delivery). You can
select Yes or No. The default value depends on the application service profile.
15. Third Party DN (only if available for the selected service as defined by the application service
profile). The possible values are retrieved from the application service profile.
16. Authorisation Notification Required (only for messages sent using store-and-forward
delivery for a Y-Copy service). You can select Yes or No. The default value depends on the
application service profile.

17 December 2021 104


Alliance Access 7.6.20 Message Creation
Message Management Guide

17. Overdue Warning Time field (only for messages sent using store-and-forward delivery). You
can select time in UTC after which store-and-forward must generate an overdue warning if the
message remains undelivered.
18. Overdue Warning Delay field (only for messages sent using store-and-forward delivery). You
can select the number of minutes after which store-and-forward must generate an overdue
warning if the message remains undelivered (min 5, max 1440).

10.4.4 Complete the Application Header of an MX Message


Procedure
1. Click the Application Header tab and complete the mandatory fields:
• From
• To
• BusinessDefinitionIdentifier
• MessageDefinitionIdentifier
Note The system automatically completes the CreationDateTime field.
When creating an MX message or modifying an MX template or message, the
Time zone drop-down list in the picker of the CreationDateTime field must
contain all values between -13:00 and +14:00 inclusive.
2. Complete optional fields if needed. To display some optional fields, you need to check the
boxes.
For more information about these fields, refer to the Standards documentation for the specific
Solution.

10.4.5 Complete the Body of an MX Message


In the message body, you enter the text of the message. The layout of the message body varies
according to the structure of the message.
For more information, see Message Editor on page 47.
If you are an experienced operator, and you are familiar with message syntax, then you can also
complete the body of the message in fast mode. The application header is also visible in fast mode,
as it is part of the payload.
For more information, see Fast Mode on page 123.
Procedure
1. Complete the mandatory and possibly optional fields as needed. Mandatory fields must be
completed.
2. The fields that appear depend on the message selected and on the message standard version.
You may need to use the vertical scroll bar to display all the fields, depending on the message
length. Complete the fields in their displayed sequence. Some parts of the body can be
collapsed to ease navigation.

17 December 2021 105


Alliance Access 7.6.20 Message Creation
Message Management Guide

10.4.6 Define the Network of an MX Message


By selecting the Network tab, you can define the network to be used for sending messages,
including:
• SWIFTNet
• APPLI
• OTHER
• IPLA
The default value that is displayed for the network is derived from the Correspondent Information
File (CIF), if this information is available. Otherwise, the first value from the Preferred Order
system parameter is displayed.
About this task
Implications of defining the network
Procedure
1. When you select APPLI, the Target Exit Point for Message Disposal drop-down allows you
to select an exit point where the message can be later disposed. It is only editable by operators
with the Mesg Creation (Modification), Change Network permission. This field is mandatory
when the Network field is APPLI.
You must have the System Management, Routing, or Application Interface permissions to
retrieve the list of exit points that are displayed in this tab.
2. When you route a message with network APPLI and set the selected routing rule of the queue
routes to the addressee (as done in Message Authorisation), the message is routed to the exit
point specified in the receiver correspondent information (APPLI tab). If no exit point is
specified in the correspondent information (or if the receiver correspondent is not known), the
route to Addressee rule is skipped and the next routing rule is evaluated.
3. When you route a message with network OTHER and set the selected routing rule of the queue
routes to the addressee (as done in Message Authorisation), the message is routed to
_OI_to_OTHER. When you route a message with network IPLA and set the selected routing
rule of the queue routes to the addressee (as done in Message Authorisation), the routing rule
is skipped.
4. When you dispose a message with network OTHER or IPLA, the SWIFT option in the Dispose
to drop-down will not appear.
5. When you dispose a message with network APPLI, the SWIFT option in the Dispose to drop-
down is replaced with the exit point selected in the Network tab.
Note The Network tab is always displayed, but its content is only editable by operators
with the Mesg Creation (Modification), Change Network permission.

10.5 Use Message Templates


This section describes message templates and how to create them for FIN, APC, and MX
messages.
For more information about how to create FileAct message templates, see the following sections:
• Send a File Manually on page 139 (for real-time or store-and-forward services)
• Download a File Manually on page 146 (for real-time services)

17 December 2021 106


Alliance Access 7.6.20 Message Creation
Message Management Guide

10.5.1 Message Templates


Definition
A template is a message where some fields are pre-filled with relevant values. You can create
message templates for FIN, APC, and MX messages .
The content of a message template can be modified, if needed. For more information, see
Message Template Management on page 115.

Users and permissions


To import and export MT and MX message templates, your operator profile must have these
actions:
• Access Control / Files on User Space
• SWIFT Support / Export Template and Import Template

Benefit of using a message template


You can use message templates to create messages that you send on a regular basis.
A message template contains values that do not change often, such as the sender and the receiver
of the message. When you create a message from a template, then you only need to enter values
for fields that are variable, such as dates and amounts. You can use one template to create any
number of new messages.
A template can be assigned to a unit within the business. A unit is a group of operators within an
organisation that has common requirements, such as the need to deal with the same confidential
information. Templates that are assigned to the unit None are available to everyone. If a template is
assigned to a unit, then that template is only available to operators who have that unit assigned in
their operator definition. For more information about unit definition and assignment, see the
Configuration Guide.

Import and export of message templates


It is possible to export and import MT, MX, and APC message templates, which are then saved in a
single file. For example, you can export the templates from a previous release of Alliance Access,
and then import them to the current release.

10.5.2 Locked Message Templates


Definition
A locked message template is a message template where the fields cannot be modified. A locked
template is created from normal FIN and MX message templates. When such a message arrives in
the modification queue, it is fully editable.

Locked message templates with automatic fields


If you try to create a message using a locked template which contains data in automatic fields
(such as UETR, SLA ID or address expansion), then an error message is displayed:
Message cannot be created with this locked template which contains automatic
fields. Please correct the template.

You can correct the message template by clearing the contents in the automatic fields.

17 December 2021 107


Alliance Access 7.6.20 Message Creation
Message Management Guide

Users and permissions


To manage locked templates, your operator profile must have this action:
Mesg Creation / Add/Mod/Rem Template with the Locked detail set to Yes.
To create FIN or MX messages only from an approved locked template, your operator profile must
have this action:
Mesg Creation / Create Message with the From locked templates only detail set to Yes.
This means that you will not have permission to create FIN or MX messages from scratch, or from
other messages, or from normal templates.
When a template is created, Alliance Access verifies that if a subfield is locked then the parent field
must be locked as well. If this verification fails, then an error message is displayed and the locked
template cannot be saved. The same error message is displayed if the template fails validation
because of this issue.
To approve a locked template, the security parameter Mesg Templ Approval must be turned on.

Locked message template management


If you have the permission to manage locked templates, then you can:
• mark normal templates as locked
• define the content of a locked template
• modify the content of a locked template
• approve a locked template
• delete a locked template
• change locked templates into normal templates
When a template is marked as locked, you can define a subset of locked fields in the Header,
Application Header and Body tabs. A template marked as locked has all its fields locked. You must
modify the template and unlock the mandatory fields to be able to edit them when creating a
message from a locked template.

CAUTION All locked mandatory fields must be completed when creating a locked template,
otherwise the message created from the locked template will be unusable, as the
fields will no longer be modifiable (messages with empty mandatory fields will always
be rejected).

When modifying a locked template, a check box next to each field or subfield is selected if the field
is locked, and cleared if the field is unlocked.
After a locked template is created or modified, the Approved/Not Approved status can be viewed
only if the security parameter Mesg Templ Approval is turned on. Then messages from locked
templates can be created ONLY if the template status is Approved.
Approving a locked template can only be done by an operator different than the one that created or
modified it. This second operator must have the Mesg Creation / Add/Mod/Rem Template with
the Locked detail set to Yes.

17 December 2021 108


Alliance Access 7.6.20 Message Creation
Message Management Guide

10.5.3 Message Templates Page


Overview
This section describes the content of the pages that list message templates for FIN, APC, and MX
messages.
Note The buttons related to the locked template functions are not available for APC
messages.

Page example

The following is an example of a FIN Message: Templates page:

Button description

Change View Allows you to select the columns to be displayed and number of rows to be
displayed.

Remove Removes the selected template.

Modify Modifies the selected template.

Re-assign Standard Re-assigns the selected template to a base standard schema or a


MyStandards schema. This function is not available for locked templates. A
template can only be re-assigned if it has the same identifier (which may
contain a Usage part for MX templates) and service code. MX templates can
be re-assigned when the usage guidelines are different. See also Re-Assign a
Standard to Message Template on page 114.
Note Base standard schemas are the XML schemas of MT and MX
messages (so-called Base messages). MyStandards schemas
are XML schemas of Base messages to which a number of
restrictions have been added, such as restricting the length of a
field, making an optional field mandatory, prohibiting the use of
certain codes in a field, and so on. In order to use MyStandards,
you must register on www.swift.com.

Mark as Locked Marks a normal template as locked. If the security parameter Msg Templ
Approval is set to Yes, then the template becomes unapproved locked. This
button is available to operators with the Mesg Creation, Add/Mod/Rem
Templ, Locked = Yes permission.
This functions is not available for APC messages.

Unmark as Locked Unmarks a locked template. If confirmed, all fields are unlocked. As a result,
the template becomes unapproved normal. This button is available to

17 December 2021 109


Alliance Access 7.6.20 Message Creation
Message Management Guide

operators with the Mesg Creation, Add/Mod/Rem Templ, Locked = Yes


permission.
This functions is not available for APC messages.

Approve Template Only displayed if the Msg Templ Approval security parameter is set to Yes.
Approves an unapproved locked/normal template. As a result, the template
becomes approved. This button is available to operators with the Mesg
Creation, Add/ Mod/ Rem Templ permission. Only operators with the
Locked = Yes permission detail can approve a locked template.

Page description

Filtering criteria Enables you to filter the list of message templates according to various
area criteria. For details, see Filter a List of Message Templates on page 114.

Name Name of the message template.


The permissions in the operator's profile for viewing and modifying a message
templates control the templates that appear in the list.

Status If the Msg Templ Approval security parameter is set to Yes, the value is
either: Locked/Approved (for approved locked templates), Locked / Not
Approved (for unapproved locked templates), Approved (for approved
normal templates), or Not Approved (for unapproved normal templates).
if the Msg Templ Approval security parameter is set to Yes, the value is
either: Locked (for locked templates), or blank (for normal templates).

Identifier The value identifies the template.

Display Name The message standard (either base or MyStandards) assigned to messages
in the list.

Open by If a message template has an operator name in the Open by column, then
this means that operator is currently modifying the message template.

Unit Name of the unit to which the message template is assigned.

Sender Identifies the sender BIC used for this message template.

Usage Count The total number of times that the template has been used to manually build a
message.

Last Usage The timestamp (in the local time of the browser) when the template was used
to manually build a message.

Creation Date/ The date and time when the template was created.
Time

Version The Message Syntax Version used by the template.

Last Modifier The operator who last modified the template.

17 December 2021 110


Alliance Access 7.6.20 Message Creation
Message Management Guide

Additional columns for MX message templates

Identifier The internal name of the message type.

Service Name The service that corresponds to the standard.

Usage Identifier The RequestSubType of the message standard

10.5.4 Create a Template for FIN, APC, or MX Messages


This procedure enables you to create a new template for FIN, APC, or MX messages.
It is not possible to create a locked template for FIN or MX messages from the Save as Template
operation. A Save as Template action always creates a normal (non locked) template even if the
message being saved as template is marked as locked because it has been created from a locked
template.
Tip When you create a message template, you can also open other menu items
(messages) at the same time from the Creation, Modification, Approval, and
Search and Report menus.
Before you begin
To add a message or file template using the Message Creation application:
The User MT, System MT, or APC MT of the FIN/APC message template, the Service&Identifier of
the MX message template, or the Service&Identifier of the File message template must be checked
to be explicitly allowed or not explicitly prohibited by the following permission detail of your operator
profile:
• Mesg Creation, Add/Mod/Rem Templ
• User MTs
• System MTs
• APC MTs
• Service&identifier - InterAct messages
• Service&identifier - FileAct messages
Procedure
1. Follow the steps to create a new message.
For MX messages, ensure that you have entered values for the Requestor DN field and the
Responder DN field.
2. After you enter the message details, click Save as Template .
The Save as Template page appears, and prompts you to enter a name for the message
template.
3. Type the name of the message template. This name identifies the template and appears in the
list of message templates.
Message template names must comply with the following requirements:
• The name must contain a maximum of 31 characters.
• The following characters are permitted: A-Z, a-z, 0-9, and special characters, except for
single and double quotation marks.
• Spaces are allowed.

17 December 2021 111


Alliance Access 7.6.20 Message Creation
Message Management Guide

• The first character can be a space, or any of the letters, numbers or characters mentioned
previously.
Note It is possible to add a message template with a name that is already used. The
existing and the new message templates coexist with the same name.
4. Click Save .
A confirmation message appears in the Status area, to confirm that the template was saved.
A FIN or APC message template includes the sender logical terminal and the message type the
operator had selected when the template was created. An MX message template includes the
identifier of the message standard that was selected when the operator created the template.
An MX messages template also includes the requestor DN and the responder DN.
5. You can continue to edit the message, send the message for further processing, or close the
message.

10.5.5 Create a Message from a Message Template


This procedure enables you to create a FIN, APC, or MX message from a message template.
For more information about File messages, see File Message: Send on page 133 and File
Message: Get on page 141.
Note The UETR field is cleared when creating a new FIN message from a template.
Procedure
1. From the Creation menu, select one of the following options:
• FIN Message: Templates
• APC Message: Templates
• MX Message: Templates
The list of message templates available appears. For more information, see Message
Templates Page on page 109.
You can navigate through the pages displaying the list, or refine the list using the filtering
criteria. For more information, see Filter a List of Message Templates on page 114.
2. Click the name of the message template that you want to use.
When a template is opened or a message is created from a template, syntax validation is
performed. The following behaviour can be observed:
• If there are no errors and one or more warnings, when opening the template, the Header
page is displayed.
• If there are one or more errors, when opening the template, the page of the location of the
first reported error is displayed.
The message entry form appears.
A FIN or APC message template includes the sender logical terminal and the message type the
operator had selected when the template was created.
An MX message template includes the identifier of the message standard and the usage
identifier (if provided by the message standard) that was selected when the operator created
the template. An MX messages template also includes the requestor DN and the responder
DN.

17 December 2021 112


Alliance Access 7.6.20 Message Creation
Message Management Guide

3. Complete the message fields.


When you create a message based on a locked message template (FIN and MX messages
only):
• You can modify any non-locked fields from the template that are displayed in the message
entry form.
• You cannot modify any locked fields from the template with the value READONLY that are
displayed in the message entry form.
• Any optional locked fields from the template without a value are hidden in the message
entry form.
When you create a message based on a message template, any editable data from the
template displayed in the message entry form can be modified.
4. Next, take the appropriate action in the following table.
Table of actions

Button Action More information

Close Message Closes the message without saving the


changes.

Export Creates a report of the message. Report Types and Settings (Export
Function) on page 36

Print Prints a report directly from the GUI. Print a Report Directly from the GUI
on page 36

Save as Template Saves the information in the message as a Create a Template for FIN, APC, or
template. Then, you can close the message, MX Messages on page 111
or perform another action.

New Fast With this mode, you can choose how tags are Fast Mode on page 123
displayed when creating messages, either All
Tags or Mandatory Tags.
This button is not available for locked
templates.

Validate Validates the message format. Validate a Message and Correct


Errors on page 126

Unlock Allows you to unlock the message, if your Locked Message Templates on
operator profile detail Mesg Creation / page 107
Create Message with the From locked
templates only detail is set to No.
If you unlock a message, then all the fields
are no longer locked and it is not possible to
return to a locked state.

Fast / Prompted Allows you to create the body of an MT or Fast Mode on page 123
MX message in fast or prompted mode.
These buttons are not available for locked
templates.

17 December 2021 113


Alliance Access 7.6.20 Message Creation
Message Management Guide

Button Action More information

Route Routes a valid message according to the Route a Message on page 130
routing rules defined within Alliance Access.

Dispose to Sends a valid message to a queue that is Send a Message to a Queue


chosen by the operator. However, you can (Dispose to) on page 131
move invalid messages to the Text
Modification queue.
Locked messages cannot be sent to the Text
Modification queue.

10.5.6 Filter a List of Message Templates


Follow this procedure to filter a list of message templates according to specific criteria.
Procedure
1. From the Creation menu, select one of the following options:
• FIN Message: Templates
• APC Message: Templates
• MX Message: Templates
The list of message templates available appears. For more information, see Message
Templates Page on page 109.
2. Define the criteria to use to filter the list of message templates based on the following
information:
• Template Name
You can use the following wildcards in the Template Name field:
- "_", to replace one unknown character
- ''%'', to replace zero, or one or more contiguous unknown characters
• Match Case (applies only to the value provided for template name)
• Created By (name of the operator who created the template)
• Creation From and Creation To (use the date picker to select the creation date period)
• Modified By (name of the last operator who modified the template)
• Usage Count use the symbols <, <=, =, >=, > to specify the number of records you
want to display
• Last Usage
- From Date use the date picker provided to choose the date
- To Date use the date picker provided to choose the date
3. Click Submit .
The list of templates is filtered according to the selected criteria.

10.5.7 Re-Assign a Standard to Message Template


You can re-assign a selected template to a base standard schema or a MyStandards schema.

17 December 2021 114


Alliance Access 7.6.20 Message Creation
Message Management Guide

Before you begin


This function is not available for locked templates. A template can only be re-assigned to a base
standard schema or a MyStandards schema as follows:
• For MX messages
Must have the same identifier (which may contain a usage part for MX templates) and service
code and not be marked as obsolete (for Deployment Packages (DP)). The usage guidelines
can be different.
• For FIN templates
Must have the same identifier and service code
Procedure
1. From the FIN: Message Templates or MX Message: Templates page, select the check box
next to the template.
2. Click Re-assign Standard .
3. In the Re-assign Standard window, select the appropriate Message Standard and click OK .
Two schemas can potentially be displayed: an Alliance Access Deployment Package (DP) and
a Universal Standards Archive (USA) package. The window also displays the source (DP or
USA) and the Usage Guideline. Usage Guidelines describe how to use message definitions in
specific business contexts.

10.5.8 Message Template Management


Introduction
This section provides information about the maintenance and the management of message
templates in Alliance Message Management.
For more information about FileAct message templates, see the following sections:
• Send a File Manually on page 139
• Download a File Manually on page 146

Message Template Guidelines


This section provides information about managing and migrating your message templates in
Alliance Access. This can help you with preparing for new FIN Message Standards, or if you
planning to start using the Message Management GUI.
Once you assign a new message standard to an LT, whenever you open a template that was
created with the previous message standard, a warning pop-up will be displayed, it will try to
resolve the template with the new standard or indicate that the resolution had failed and manual
actions are required. This pop-up will always appear at template opening until this template is
updated.

17 December 2021 115


Alliance Access 7.6.20 Message Creation
Message Management Guide

Bulk operations
By doing the bulk processing, you can avoid having the pop-up every time you open a template
that is still resolved with a previous message standard.
In the Message Management GUI package you can:
• Do a bulk resolution of templates.
• Do a bulk simulation resolution of templates to see which ones will be properly resolved and
which ones will require manual intervention. As a result you will have a report available in your
userspace with the list of templates that were in the simulation and the corresponding simulated
result.

Tips and tricks


• You can launch the simulation of resolution of templates (at the time of import), whether you are
importing templates into Message Management with the same message standards or with new
message standards. The resulting report will provide information on which templates can be
migrated successfully versus the ones that did not and will require manual intervention.

• When importing an exported set of templates from (an) older FIN Standards Release(s), it is
possible that Alliance Access is unable to fully convert the template in accordance with the new
message syntax. In such cases, the template will only appear in Fast mode. The template then
either needs to be updated in Fast mode by adding/removing/modifying the relevant fields or
manually recreated from a new FIN message (which is saved as a template)
• If you are uncertain about the MSTV ID version that is currently assigned to your message
template, then you can also export your templates and open the exported file in your favourite
editor. Locate the desired template within the export file using the mesg_template_name field.
Once you have located the template entry, check the text_swift_prompted field and if it starts

17 December 2021 116


Alliance Access 7.6.20 Message Creation
Message Management Guide

with XML#. If so, then this template has been migrated to the Message Management format,
otherwise it is still in the Workstation format:

• If you are uncertain if a template has been converted to the Message Management format (if
you cannot open/access a template export), you can open the template in the Message
Management GUI. If no Information window appears informing you that the content of the
template will be migrated, then it has already been converted:

10.5.8.1 Modify Templates


Before you begin
You cannot change the message type of a message template.
To modify a message or file template using the Message Creation application:
• The User MT, System MT, or APC MT of the FIN/APC message template, the Service&Identifier
of the MX message template, or the Service&Identifier of the File message template must be
checked to be explicitly allowed or not explicitly prohibited by the Mesg Creation,
Add/Mod/Rem Templ, User MTs, System MTs, APC MTs, Service&identifier - InterAct
messages, or Service&identifier - FileAct messages permission detail of your operator
profile.
Procedure
1. From the Creation menu, select one of the following options:
• FIN Message: Templates
• APC Message: Templates
• MX Message: Templates
The list of message templates available appears. For more information, see Message
Templates Page on page 109.

17 December 2021 117


Alliance Access 7.6.20 Message Creation
Message Management Guide

2. Select the check box beside the name of the message template that you want to modify.
If needed, navigate through the pages or refine the list using filtering criteria. For more
information, see Filter a List of Message Templates on page 114.
3. Click Modify .
The message entry form appears and the title of the window includes Edit Template.
When an operator modifies a message template, the operator's name appears in the Open by
column of the message template list to show that the template is being modified.
4. Change the values in the template, as required.
When modifying a locked template, a checkbox next to each field or subfield is selected if the
field is locked and unselected if the field is unlocked.
5. Any data which appears in the message entry form can be modified except the MX message
fields that follow:
• Service Name
You can add extensions to the service name, if required (and if allowed by your operator
permissions).
• Identifier
• Usage Identifier
• Delivery Mode
6. Next, take the appropriate action in the following table.
Table of actions

Button Action More information

Close Template Closes the template without saving the


changes.

Export Creates a report of the template. Report Types and Settings (Export
Function) on page 36

Print Prints a report directly from the GUI. Print a Report Directly from the GUI
on page 36

New Fast With this mode, you can choose how tags are Fast Mode on page 123
displayed when creating templates, either All
Tags or Mandatory Tags.
This button is not available for locked
templates.

Validate Validates the template format. Validate a Message and Correct


Errors on page 126

Approve Allows you to approve the locked template, if Locked Message Templates on
the security parameter Mesg Templ page 107
Approval is turned on, and if you are not the
last modifier of the template.

17 December 2021 118


Alliance Access 7.6.20 Message Creation
Message Management Guide

Button Action More information

Fast / Prompted Allows you to create the body of an MT or Fast Mode on page 123
MX message in fast or prompted mode.
These buttons are not available for locked
templates.

Save Template Saves the information in the template and


closes the window.
If the template was approved, it becomes
unapproved (regardless of the value of the
Mesg Templ Approval security parameter).

10.5.8.2 Remove a Message Template


Before you begin
To remove a message or file template using the Message Creation application:
• The User MT, System MT, or APC MT of the FIN/APC message template, the Service&Identifier
of the MX message template, or the Service&Identifier of the File message template must be
checked to be explicitly allowed or not explicitly prohibited by theMesg Creation,
Add/Mod/Rem Templ, User MTs, System MTs, APC MTs, Service&identifier - InterAct
messages, or Service&identifier - FileAct messages permission detail of your operator
profile.
Procedure
1. From the Creation menu, select one of the following options:
• FIN Message: Templates
• APC Message: Templates
• MX Message: Templates
The list of message templates available appears. For more information, see Message
Templates Page on page 109.
2. Select the check box beside the name of the message template, or templates, that you want to
remove.
If needed, navigate through the pages or refine your list using filtering criteria. For more
information, see Filter a List of Message Templates on page 114.
You can also remove all the templates listed on a page by checking the box next to the Name
column.
3. Click Remove .
A dialog box appears that asks you to confirm the removal of the selected templates.
4. Click OK .

10.5.8.3 Copy a Message Template


You can create a message template from another template, which is faster and more convenient
than re-entering similar data.

17 December 2021 119


Alliance Access 7.6.20 Message Creation
Message Management Guide

Before you begin


To copy a message or file template using the Message Creation application:
• The User MT, System MT, or APC MT of the FIN/APC message template, the Service&Identifier
of the MX message template, or the Service&Identifier of the File message template must be
checked to be explicitly allowed or not explicitly prohibited by theMesg Creation,
Add/Mod/Rem Templ, User MTs, System MTs, APC MTs, Service&identifier - InterAct
messages, or Service&identifier - FileAct messages permission detail of your operator
profile.
Procedure
1. From the Creation menu, select one of the following options:
• FIN Message: Templates
• APC Message: Templates
• MX Message: Templates
The list of message templates available appears. For more information, see Message
Templates Page on page 109.
2. Click the name of the template that you want to copy.
The message entry form for the template selected appears.
3. Change the values in the template, as required.
4. Click Save as Template .
A page appears that asks you to enter a name for the template.
5. Type a name for the template.
This name identifies the template and appears in the page that displays the list of templates.
6. Click Save .
A confirmation message appears in the Status area to inform you that the message was saved
as a template.
7. Click Close Message .

10.5.8.4 Template Incompatibility with Message Standards


You may still have templates for FIN and MX messages standards releases that were removed.
After a message standards release is removed, you cannot open or modify a message template
that is based on that standards release. An error message alerts you that the message description
could not be found.
If necessary, you can display the content of such a template by searching as described in Search
by Source and Creation on page 223.
If you are sure that the message template is no longer required, then you can remove it. Otherwise,
check with your Alliance Message Management administrator for details about message standards
that were removed.

17 December 2021 120


Alliance Access 7.6.20 Message Creation
Message Management Guide

10.5.8.5 Migration of FIN and MX Message Templates


Introduction
When you use a message template to create a message or when you open a template to modify it,
Alliance Message Management checks whether a newer version of the standard needs to be used
for the template.
Message template migration can result in a structure that is valid or invalid. If the migration is
invalid, then the message appears in fast mode. Make any necessary changes as described in
Validate a Message on page 126. Alternatively, remove the migrated message template and create
another template based on the new standard.
The migration of a message template depends on the type of message template.

Migration of FIN message templates


If Alliance Message Management detects that the message syntax version used in the template is
not the same as the version assigned to the logical terminal, then Alliance Message Management
checks whether there is a schema corresponding to the logical terminal:
1. If there is a schema with the appropriate version, then Alliance Message Management migrates
the message to the new template and an information message informs you that the message
template was migrated.
The next step differs depending on whether you are creating a message from a message
template, or you are modifying a message template:
• Create a message from a message template
If you are creating a message from a message template, then the result may be that the
message is displayed in fast mode. Message entry can continue.
• Modify a message template
If you are modifying a message template, then save the template to confirm the migration.
Message entry can continue.
2. If there is no schema with the appropriate version, then an error message informs you that the
message description could not be found. Message entry cannot continue: refer to your Alliance
Message Management administrator to install the correct message standards.
Migration of MX message templates
If Alliance Message Management detects that the message version used in the template is
obsolete or that the standard with the corresponding version was removed, then Alliance Message
Management checks whether there is a schema corresponding to the most recent version amongst
available message schemas:
1. If there is a schema with a more recent version, then an information message informs you that
the message template was migrated.
The next step differs depending on whether you are creating a message from a message
template, or you are modifying a message template:
• Create a message from a message template
If you are creating a message from a message template, then the message entry can
continue.
If an incompatible change is detected between the old and newer version of an MX
message type, then the message will be available in fast mode.
• Modify a message template

17 December 2021 121


Alliance Access 7.6.20 Message Creation
Message Management Guide

If you are modifying a message template, then save the template to confirm the migration.
Message entry can continue.
2. If there is no schema with a more recent version, then an error message informs you that the
message description could not be found. Message entry cannot continue: refer to your Alliance
Message Management administrator to install the correct message standards.

10.6 Create a Message from an Existing Message


Overview
If you have the correct permission, you can create a new message from an existing (source)
message of the same MT type or the same MX service/request type. A message created in this
way is of the same message type/service/request type/request subtype as the source message,
and is displayed in exactly the same way as a message created from scratch or from a template.
This functionality is available for MT and MX messages. A FIN or MX Deployment Package or
Universal Standards Archive (USA) package is also assigned to the newly created messages.
You can create such messages from certain applications in the following application groups, where
the Add as button is available:
• Modification
• Approval
• Search and Report

Criteria for message eligibility


A message is eligible as a source message in the Add as message functionality when it meets the
following criteria:
• It must be an (archived or not) (invalid or not) input (to SWIFT) MT or MX non-locked message.
If these conditions are not met, the Add as button is unavailable.
• Its type must be an enterable type (for example, MT671 is not eligible because it is not
enterable). If this condition is not met, the following error message is displayed: No message
can be created from the selected message. The message type <full message type>
is not enterable.
• For MT messages, its type must still be present in the Standards currently assigned to the
logical terminal (in December 2021, it can be either SR2019, SR2020, or SR2021) of the source
message (which will also be the logical terminal of the new message). If this condition is not
met, the following error message is displayed: Failed to create a new message because
the source message needs to be migrated and no alternative was found for
message type <message type>.
• For MX messages, its type must still be defined in a current deployment package or Universal
Standards Archive (USA) package(in December 2021, it can only be SR2021). If this condition
is not met, the following error message is displayed: Failed to create a new message
because the source message needs to be migrated and no alternative was found
for message type <message type>.

All of the fields of the new MT or MX message are editable.

Permissions required
In order to use the Add as button, you must have the Mesg Creation, Create Message permission.
In addition, you must have the permission(s) required to view all details of a message in the
Modification, Approval, and Search and Report application groups. In addition, you must have the
permissions required to route or dispose the message to the required destination queue.

17 December 2021 122


Alliance Access 7.6.20 Message Creation
Message Management Guide

Applications where the Add as button is available


The Add as button is available to operators in the following message operation applications of the
Message Management package:
• In the Modification application group, this button is located next to the Change View button and is
available in the following applications:
- Text Modification
- Emission Security Modification
- Modification for Transmission
• In the Approval application group, this button is located next to the Change View button and is
available in the following application:
- Message Authorisation
• In the Search and Report application group, for the following application:
- Message Search

Handling of standards, Deployment Packages, Universal Standard Archive (USA) packages, and
verifiable fields
When creating a new MT message with Add as , Alliance Access assigns to the new MT message
the FIN Standards that is assigned to the logical terminal that is assigned to the message. If
necessary (that is, if the FIN Standards is not the most recent one), the new message is migrated
as a prerequisite, whether the source message resides in a queue or in Message Search, similar to
when creating a message from a template. See Migration of FIN and MX Message Templates on
page 121 for more information about migration.
When creating a new MX message with Add as , Alliance Access assigns to the new MX message
the current deployment package or USA package that corresponds to the service/request type of
the source message. If necessary, the new message is migrated as a prerequisite, whether the
source message resides in a queue or in Message Search.
In support of MT and MX message verification and user-defined verifiable fields, when a new MT or
MX message is created using Add as , the Mesg_needs_verification field of the new message is set
to Yes if the Web Platform deployment package active at that moment indicates that it contains
verifiable fields. Otherwise, this field is set to No, as in the case of File messages, for which this
functionality is not available.
For more information on verifiable fields, see Message Verification on page 168.

10.7 Fast Mode


Purpose
Fields appear by default in the message editor in prompted mode, where the field labels are easy
to read, and the message structure is expanded.
If you are an experienced operator, and you are familiar with message syntax, then you can create
FIN and MX messages in Fast mode. Fast mode does not provide expanded field labels or
structures. Therefore, you must type the field tags and their corresponding values, as are required
for the type of message being prepared. However, fast mode allows you to copy and paste the
body of a message from another source. MT 0nn messages (that is, FIN system messages and
APC messages) cannot be created in fast mode.
You can also select 'New Fast' mode, where you can choose either 'All Tags' or 'Mandatory Tags'
while creating messages.

17 December 2021 123


Alliance Access 7.6.20 Message Creation
Message Management Guide

For FIN messages, fast mode presents the message body as plain text, that is, the original string
representation.
For MX messages, fast mode presents the message body as a beautified XML representation
(assuming that discrete XML elements can be parsed) or possibly as a mixture of beautified XML
and plain text.
Note You cannot create FIN System Messages (MT 0nn messages), or APC messages in
fast mode.
Note You can enter some fields in fast mode only. For more information, see Knowledge
Base tip 5020378 (in regard to field 22C).

How to use fast mode


Clicking Fast at the bottom of the screen displays the message in fast mode in the Body tab.
The content of the message body tab is entered as a sequence of fields. You must start a new field
at the beginning of a new line and the data that you enter must obey the syntax rules required for
that field. You can also paste in text that has been prepared in other applications.
The fields and the values that you include in the message must conform to the message standards
that are installed. For more information about the message standards, see Help about Message
Standards on page 64.
In this mode, no validation is performed as you enter the text for each field.
Fields are validated when you move to prompted mode. Errors and warnings appear in the
Validation Report tab.
If you click Prompted , and some fields are still invalid, then those fields may appear in fast mode,
while the other valid fields are expanded and displayed in prompted mode. For example, if a
combined field containing a currency, date, or amount is invalid, it is displayed in fast mode, while
the other fields in the message appear in prompted mode.

Field syntax
For each FIN or MX message, the message structure, syntax, field options, and code words must
be used when you edit a message in fast mode. These are detailed in the User Handbook, and in
the help for messages. For more information, see Help about Message Standards on page 64. You
can also find information about the character sets through the help link on the top right corner of
the message editor form.
When typed in fast mode, the on-screen appearance and format of a message text must be the
same as the various examples detailed in the Standards books.

17 December 2021 124


Alliance Access 7.6.20 Message Creation
Message Management Guide

Example - FIN message

Rules for entering a FIN message in fast mode


This section provides a summary of the rules for MT messages. For more information about the
message standards, see Help about Message Standards on page 64.
A field always begins with a two-digit field tag and, if applicable, an option letter. The field tag and
option letter must be enclosed by colons, for example, :20: or :32A:.
The value of the field is entered after the second colon. For example, a transaction reference
number 25/2/96-RM43-100.
A field can consist of several subfields. Each new line is a continuation of the field defined in the
first line. Some fields have alternative sets of subfields, with each alternative identified by an option
letter after the field tag. For example, 32A and 32B
Subfields can be of fixed or variable length. A field with two fixed length subfields (date, currency),
and one variable length subfield (amount), looks like this:
:32A:040528EUR1958,47
A field with variable length subfields must have "/" as a separator between each subfield is like:
:22:NEW/BEBEBB1831CRESZZ
Note In field 22, the application only checks the syntax of subfield 2. Make sure that the
semantic content is correct.
Where a message consists of a defined set of sequences, type each sequence of fields in the order
in which they must appear in the message. Do no use / as a separator in this case.
Where a field, or series of fields, is repeated in the form of a loop, type the fields for each loop and
repeat the fields as required. Do no use / as a separator in this case.

17 December 2021 125


Alliance Access 7.6.20 Message Creation
Message Management Guide

Example - MX message

Example of a FIN message as viewed in fast mode


A complete message text for an MT 103 looks like this:
:20:25/2/96-RM43-100
:23B:CRED
:32A:040528EUR1958,47
:50K: Ordering Customer
:59A: Beneficiary Customer
:71A:SHA
Some fields, such as field 72, contain more than one line. A typical multiple line field looks like:
:72:SWIFT
Avenue Adèle 1
La Hulpe
Belgium

10.8 Validate a Message

10.8.1 Validate a Message and Correct Errors


This procedure explains how to validate a message and fix errors in the message, if any. An invalid
message cannot be routed to the SWIFT network.
A message is valid if it has the correct syntax and completed header and mandatory text fields. For
more information about what validation involves, see Validation of a Message on page 128.
Procedure
1. Click Validate .
The results are presented as follows:

Result Evidence Action

Message is valid A pop-up window appears that confirms Click OK .


that there are no errors.

17 December 2021 126


Alliance Access 7.6.20 Message Creation
Message Management Guide

Result Evidence Action

Message is The Validation Report tab displays errors Go to Step 2 on page 127.
invalid and warnings.

Note Warnings do not prevent a message from being routed within Alliance Access.
2. You can review the errors or warnings in the Validation Report.

The validation report displays errors received from SWIFTNet or found locally:

Column Description

Type Displays the type of issue: error, warning, or info

Location Location of the error, such as the application header or the body of the message

Node The Node column displays the name of the field that contains the error. This
name is the last node of the XPath.
For MX messages only

Error Code The local or SWIFTNet error codes


For SWIFTNet errors (NAK) received during central validation, the value from the
SwGbl:Code is displayed.
For MX messages only

Message For MX messages, you can view the full XPath expression if you hover over the
Message column. The XPath is shown only if the error is in the Application
Header or the Body of the message.
SWIFTNet errors may no longer be relevant after the message has been
modified.

Error Source Source of the error: LOCAL or SwiftNet

Tip You can navigate between the Validation Report and the message tabs.
3. Click the error or warning in the Validation Report tab that you want to address, to move directly
to the field.
Complete the field correctly.

17 December 2021 127


Alliance Access 7.6.20 Message Creation
Message Management Guide

Here is an example of an error for a FIN message:

For example, a box indicates that this is the second of a total of two errors or warnings.
Use the up and down arrows in the rectangle to move directly to the previous or the next
occurrence, without returning to the Validation Report.
Tip You can click the name of the message to view the help about the expected
content of the fields in the message.
4. If a message has many errors, then all or part of the message may be displayed in fast mode.
For more information about how to use fast mode, see Fast Mode on page 123
You can return to prompted view when the message is valid.
5. Click Validate to check that the message is correct.
The Validation Report shows errors and warnings that remain.
6. If you cannot correct all the errors in a message, then you can take one of the following steps:
• Select Text Modification from the drop-down list next to Dispose to .
This moves the message to the Text Modification queue, where it can be edited later. See
Send a Message to a Queue (Dispose to) on page 131.
• Click Close Message , to discard the message. A draft of the message is not saved.

10.8.2 Validation of a Message


Validity of a message format
A message is valid if it has the correct syntax and completed header and mandatory text fields. An
invalid message cannot be routed to the SWIFT network.
For MX messages that use an "enhanced" deployment package or a Universal Standards Archive
(USA) package (which contains additional, richer information), Alliance Message Management
does both syntax validation and cross-field validation (also known as semantic validation).
If a USA package is available, then the validation is performed using the USA package.
If no USA package is available , then the validation is performed using the enhanced deployment
package.

17 December 2021 128


Alliance Access 7.6.20 Message Creation
Message Management Guide

Note For information about validation of File messages, see RMA Check Failure for File
Messages on page 148.

When to validate a message


You can request Alliance Message Management to validate a FIN, APC, or MX message at any
time and correct any errors or warnings before trying to route or dispose it. Alliance Message
Management indicates the fields that contain errors and warnings in a Validation Report.
Alliance Message Management may also display global warnings within the Validation Report that
are not related to a specific message field.
Alliance Message Management validates the syntax of a FIN message when an operator clicks
Validate , Fast , Route , or Dispose to . For MX messages, if a Deployment Package or Universal
Standards Archive (US) package is installed, then Alliance Message Management performs
semantic and syntax validation.
Alliance Message Management can also display a warning if there is no business relationship
(RMA authorisation) between the sender and the receiver.

Checks performed to validate a message


Alliance Message Management validates the following:
• The message structure is correct:
- All mandatory fields, subfields, and sequences are complete.
- Any optional fields selected are complete.
- All text loops have at least the minimum number of occurrences.
- All completed fields and subfields have the correct syntax.
• The operator profile permissions are correct, that is, that the operator is permitted to manage
messages using the specified currency, amount, types of message, and so on).
• A business relationship (RMA authorisation) exists between the sender and the receiver.
• The values of the Requestor DN and the Responder DN in the header of an MX message
comply with expected syntax, as described in the SWIFTNet Naming and Addressing Guide.
This guide is available on www.swift.com, under Support > Knowledge Centre (User
Handbook) .
If the Requestor DN provided in the header of an MX message does not contain a BIC8 part (for
example, o=xxxxxxxx) that is an allowed sender destination according to your operator profile,
then Alliance Message Management does not allow you to further process this message, not
even to dispose it to the Text Modification queue.
• The Receiver field of an MT message is not empty. If it is, then Alliance Message Management
prevents you from processing the message further.
Semantic validation of a message
Although the syntax of an MT message is checked during message preparation, no semantic
checks are performed during message preparation.
SWIFT performs full syntax and semantic checks before it sends a positive acknowledgement
(ACK) or negative acknowledgement (NAK) to the sender of the message.
The emission appendix contains the ACK or NAK code indicating whether a message was
accepted or rejected. The negative acknowledgement specifies the reason for the rejection. Other
checks, such as the validity of the sender and the receiver, also occur and can cause a message to
be rejected. An operator can view the ACK and NAK details through the interventions that are
stored with a message.

17 December 2021 129


Alliance Access 7.6.20 Message Creation
Message Management Guide

Validation of MX messages
For MX messages, the Message Validation (MVal) processing can fail in case of errors or because
of problems with semantic checks. Responses from that processing are included in the emission
appendix.
Alliance Message Management performs a validation of the XML structure of the payload in an MX
message. The validation also checks the following:
• The size of an InterAct XML payload does not exceed 100,000 bytes.
• The InterAct XML payload has a structure that is compliant with the Standards MX.
• Syntax and semantic validation for the enhanced deployment packages and Universal Standard
Archive packages

10.9 Route a Message


When you route a message through the message editor, the message is sent from its current
queue to the next logical queue within Alliance Access. The message must be valid before it can
be routed.
Alliance Access routes the message according to:
• the routing rules defined for the current queue (to determine which queue to store the message
in)
• the format of the message
• the type of message
When routing a message, Alliance Access adds any relevant criteria (such as suffix or UMID) to
identify the message in a unique way.
Tip During message authorisation, you may decide not to route a message. Although
messages being authorised are presumed to be syntactically valid, you may notice
errors in the data during message authorisation. As it is not possible to change
message detail during authorisation, you must move the message to the Text
Modification queue instead of routing it.
If you are connected to Alliance Access and are broadcasting an MT 999, then you must route the
message. You cannot send it (dispose it) to a queue that you choose.
Before you begin
The permissions in the profile of the operator control who can route messages. If an operator is
permitted to, the operator can route a valid message at any stage of its creation, verification, or
authorisation.
Procedure
1. Click Route in the message editor.
Alliance Message Management checks that the message is valid.
2. A duplicate check is performed before a message is routed. If a duplicate is detected, the
following confirmation message is displayed: Alliance Access reports this message as
being a duplicate. Are you sure you want to continue?. Click OK to continue or
Cancel to cancel the operation.

17 December 2021 130


Alliance Access 7.6.20 Message Creation
Message Management Guide

3. Two cases can occur.


• If no errors are detected, then you receive a confirmation in the Status area that the
message was routed successfully.
• If errors are detected, then a Validation Report is generated. You must correct all the errors
before trying to route the message again. For more information, see Validate a Message on
page 126.
What to do next
An event is recorded in the Event Log each time that you move a message.
For each message, the event describes the following:
• the queue the message came from
• the queue the message is in
• which operator routed the message

10.10 Send a Message to a Queue (Dispose to)


If you click Route instead of Dispose to , then the message is routed according to the routing rules
that are defined within Alliance Access.
However, you can click Dispose to to send a message to a specific queue at any stage of its
creation, verification, or authorisation.
A duplicate check is performed before a message is disposed. If a duplicate is detected, the
following confirmation message is displayed: Alliance Access reports this message as
being a duplicate. Are you sure you want to continue?. Click OK to continue or Cancel
to cancel the operation.
Before you begin
The permissions in the profile of the operator control who can send messages to specific queues.
The ability to dispose a message to a queue other than Text Modification depends on the
permissions assigned to your profile in the relevant application (Message Approval, Message
Creation, Message Modification).
Procedure
1. From the message editor, select the queue that you want from the drop-down list next to
Dispose to .

For a list of queues, see Message Queues on page 132.


Alliance Message Management verifies that the message is valid (except for the Text
Modification queue).
If the message is valid, then the message is moved to the selected queue. A confirmation that
the message was disposed successfully appears in the Status area.
2. If errors are detected, then a Validation Report is generated. You must correct all the errors
before trying to route the message again. For more information, see Validate a Message on
page 126.
An event is recorded in the Event Log each time that you move a message.

17 December 2021 131


Alliance Access 7.6.20 Message Creation
Message Management Guide

For each message, the event describes the following:


• the queue the message came from
• the queue the message is in
• which operator routed the message

10.10.1 Message Queues


An operator with the correct permissions can send messages to the following queues:

Queue Description

Text Modification This queue holds messages that need data modification or data correction.
You can dispose a message to the Text Modification queue if you have not
finished creating it (for example, due to a lack of information, or if it is invalid)
and want to save it in its current state.
For MX messages, you cannot dispose the message to this queue if the
following conditions are true:
• there are errors in the DN for requestor or responder
• your operator permissions do not allow the service name

Verification This queue holds MT messages that must be verified.

Authorisation This queue holds messages that must be authorised before they are sent to
the SWIFT network.

Swift This queue holds messages that are valid and authorised and sends them to
the appropriate message queue:
• MT messages go to _SI_to_SWIFT
• MX messages go to _SI_to_SWIFTNet

an exit point If the preferred network of the correspondent is APPLI, then the list of queues
also displays the exit points that are available for routing messages to the
correspondent.
If the network in the Network tab is set to APPLI, the exit point must be
specified in the Target Exit Point for Message Disposal field in the same tab.

Other This queue is available if _OI_to_OTHER is a valid routing target. For more
information, see the Queue Details window: Routing Info tab in the
Configuration Guide.

Availability of queues
The queues available depend on the following:
• the permissions in the operator profile
• the format of the message
• the type of message
• the configuration parameters that are defined for the correspondent

17 December 2021 132


Alliance Access 7.6.20 Message Creation
Message Management Guide

It is not required that the queue to which you move a message be the next queue as defined in the
routing rules.
Before Alliance Access moves the message to a selected queue (except for the Text Modification
queue), Alliance Message Management validates the message. If validation is successful, then the
message is stored in the selected queue, and may be available for further processing (depending
on the queue) by authorised operators.
Note For Alliance Message Management connected to Alliance Access, a FIN message
with an alias representing several receivers cannot be disposed.

10.11 File Message: Send

10.11.1 File Message: Send Process


Purpose
File Message: Send allows you to send a file manually using a FileAct service with real-time or
store-and-forward delivery.

File Message: Send process


1. Create a new FileAct message, or a new FileAct message based on a FileAct message
template.
2. Upload the payload file for the message from one of the following locations:
• a directory in the user space (on the server)
• a directory local to the operator browser's desktop
3. Use the transmission parameters of the application service profiles of the FileAct service, or
provide custom transmission parameters which do not conflict with the application service
profile.
4. Do one of the following:
• Route the FileAct message using the following routing keywords together:
- Creating_mpfn is set to MPC
- Format is set to File
• Send the message to the _SI_To_SWIFTNet queue.
For more information about routing keywords, see the Configuration Guide.
5. Monitor the request for file transfer as follows:
• through a pop-up window, File Transfer Details
• through the File Transfer Monitoring page, which is available from the Search and Report
menu (see File Transfer Monitoring on page 242)
6. Save the payload file in one of these ways:
• Directly after the file emission from the File Transfer Details window.
The File Transfer Details window appears as a pop-up after file emission.
• From the Search and Report menu > Message Search, do a search on messages and
select a file message to open the Message Details, then in the action bar, click Save File .

17 December 2021 133


Alliance Access 7.6.20 Message Creation
Message Management Guide

The Message Details are also accessible from the File Transfer Details window. To save
the file, click Save File from the Message Details window.
• From the Search and Report menu > File Transfer Monitoring, select a file message and
save the payload file from the File Transfer Details window by clicking Save File .
Note If a SWIFTNet service is configured to delete FileAct payload on message completion
for that service, the payload of File messages for that service is deleted upon
message completion, for example, when all instances of that message are completed.
If a SWIFTNet service is configured to archive FileAct payload for that service, the
payload of File messages for that service is archived with the message. As a result,
the payload is also included in archive backups and restored when the message
archives are restored. This is visible in the Message Search application of Message
Management, where you can successfully request to save the payload of a File
message (using the Save File button on the Message Details, File tab) even if the
message has already been archived (and backed up or not, but not removed) or
restored, provided the archive took place with Alliance Access or later.

10.11.2 File Message: Send Page


Users and permissions
To display the File Message: Send option:
• The Mesg Creation / Create Message, Service & identifier - FileAct messages detail of your
operator profile must be different from Allowed: None.

Overview
The File Message: Send page displays a list of the FileAct messages for transferring a file to
correspondents.
From this page, you can perform the following tasks:
• create a FileAct message to send a file to a correspondent, and save the message as a
template
• view, select, edit, and delete FileAct message templates
Page example

Filtering Criteria area

Filtering Criteria Enables you to filter a list of FileAct message templates according to various
criteria.

Columns in the list

Template Name The name of the template

17 December 2021 134


Alliance Access 7.6.20 Message Creation
Message Management Guide

Service Name The name of the service over which the file is sent

Request Type The specific function within the service being provided

Requestor DN Your distinguished name

Responder DN The distinguished name of the organisation to which the file is being
transferred (also called the receiver). Please use the DN Picker provided.

Unit The unit that is assigned to the file message when an operator sends a file.

Last Modified By The name of the last operator who modified the template

Functions

New Enables you to create a FileAct message manually to send a file, and if needed, to save
the message as a template.

Delete Enables you to delete a file message template.

10.11.3 FileAct Details (Send) Window


Overview
This window displays details about the FileAct message.
If you are working with a FileAct message template, then the name of the window includes the
template name: FileAct Template Details - <template name> (Get) window.
This window contains three tabs:
• Header (see Header tab description on page 136)
• File (see File tab description on page 138)
• Comments
Functions
Function Description

Save as template Saves a new or existing file message template or saves an existing file
message template with a new name

Route Routes the file to Alliance Access based on active routing schema

Send Sends the file to the _SI_To_SWIFTNet queue

10.11.3.1 FileAct Details Window (Send): Header Tab


Overview
In the Header tab, you specify the header information of the payload file.

17 December 2021 135


Alliance Access 7.6.20 Message Creation
Message Management Guide

Header tab example

Header tab description

Unit The unit of the operator that is sending the file


The value entered for the Unit field by an operator when creating a file
message is automatically saved when the message is created successfully. It
is proposed as the initial value when the same operator creates another file
message.

Requestor DN The distinguished name of the sender

Responder DN The distinguished name of the correspondent that to which the file is
transferred (also called the receiver)

Service Name The name of the service over which the FileAct message is sent (for
example, swift.fileact.snf for store-and-forward)

Request Type The specific function within the service being provided

User Reference This optional field allows you to enter additional information about the file
transfer.

Priority The SWIFTNet priority that is requested for the exchange:


• Urgent
• Normal

Possible There may be occasions when you need to re-send a file. Selecting this
Duplicate check box informs the receiver that it is a possible duplicate. The receiver
then has the option to check the files and accept the re-send, or if the file was

17 December 2021 136


Alliance Access 7.6.20 Message Creation
Message Management Guide

successfully received before, the receiver can mark the transfer as duplicated
and the file is ignored.
Select from the drop-down list:
• Yes
• No

Header Info This field allows you to add additional information in the header of the file
transfer.

Advanced If you select the Advanced Settings check box, then additional fields
Settings appear.
Note You must not use Advanced Settings. Using Advanced
Settings may disable your FileAct traffic temporarily.

Security Level Select from the drop-down list:


• Automatic
• Without Signature: The message sent does not have to be signed
• With Signature: The file message sent must be signed. If this method is
selected, then you can choose the signature method to sign messages.
• With signature and non repudiation: The file message sent must be
signed and non-repudiation is required. If this method is selected, then
you can choose the signature method to sign messages.
This is an advanced setting for FileAct messages.

Notification This allows you to require a delivery notification


Required
Select from the drop-down list:
• Automatic
• Yes
• No

This is an advanced setting for FileAct messages.

Overdue Warning You can request that the store-and-forward system generates an overdue
Type warning if a sent file has not been delivered within a certain delay or at a
certain date and time. You can optionally flag a file with the overdue warning
option. This indicates that you want to receive an overdue warning from
SWIFT if the file was not delivered within a time frame.
• None
• Time: If you select Time, then the Overdue Warning Time field appears.
• Delay: If you select Delay, then the Overdue Warning Delay (Min) field
appears.
This is an advanced setting for FileAct messages.

SnF Copy This feature allows you to require a store-and-forward copy of the header of a
file transfer request, or the full file to a third party, as provisioned for the
service.

17 December 2021 137


Alliance Access 7.6.20 Message Creation
Message Management Guide

Select from the drop-down list:


• Automatic
• Yes
• No

This is an advanced setting for FileAct messages.

Third Party DNs The distinguished names of third parties for the store-and-forward copy
This is an advanced setting for FileAct messages.

Authorisation Select from the drop-down list to indicate whether a system message with the
Notification third party's decision to authorise the transfer is expected:
• Automatic
• Yes
• No

This is an advanced setting for FileAct messages.

Functions For more information, see Functions on page 135.

10.11.3.2 FileAct Details Window (Send): File Tab


Overview
In the File tab, you specify the details of the payload file. This information includes the file name
and the description of information that the file contains.

File tab example

File tab description

File On Select from the drop-down list:


• Local Drive
• User Space

17 December 2021 138


Alliance Access 7.6.20 Message Creation
Message Management Guide

File Name Click Browse to select the file on a Local Drive.


Use the picker to select the file from the User Space.

Logical File The logical file name defined in the database for that file message.
Name

File Info This optional field is for structured data that can be used by the receiver for
automatic processing of the file. It has to be agreed between you and the
receiver. Backus-Naur Form (BNF) notation is used as the syntax for this field.
For more information, see the Alliance Gateway File Transfer Interface Guide.
File compression can be used only if you have an agreement with your
counterparty to use the same file compression algorithm and tools. If file
compression is to be used, then it is the responsibility of the users to compress
the file before it is transferred, and to de-compress it after it is received.
SWIFT defines the SwCompression keyword in the FileInfo field to indicate if a
file has been compressed. The usage of the SwCompression keyword is
mandatory for all file transfers and must be the first keyword in the FileInfo
field. If the file is not compressed, then the File Info must contain
SwCompression=None.

Examples of possible values for SwCompression are:


• Zip
• Gzip
• None
Note Other values are possible, as long as both sides of the file
transfer understand the compression used.

File Description This optional field allows you to provide information for the receiver about the
file.

Transfer Info An optional field for structured data that can be used by the receiver to
process the file transfer automatically. The contents of this field must be
agreed between you and the receiver. Backus-Naur Form (BNF) notation is
used as the syntax for this field. For more information, see the Alliance
Gateway File Transfer Interface Guide.

Transfer An optional field where you can enter information about the file transfer that
Description you want to exchange with the receiver.

Functions For more information, see Functions on page 135.

10.11.4 Send a File Manually


This procedure enables you to do the following tasks:
• create a FileAct message manually to send a file to a correspondent using real-time or store-
and-forward delivery
• create templates for FileAct messages, and create messages from these templates
• save the payload file that is associated with the FileAct message to a local directory

17 December 2021 139


Alliance Access 7.6.20 Message Creation
Message Management Guide

Before you begin


Action Permissions needed

File Message: Send(1) Mesg Creation / Create Message

Route Mesg Creation / Create Message


Mesg Creation / Route Message

Send Mesg Creation / Create Message


Mesg Creation / Dispose Message

Save As Template Mesg Creation / Add/Mod/Rem Template

Message details(2) Message File / Search

(1) To display the User space option of the File on field in the File tab of the FileAct Message Details (Send) view, the Access
Control, Files on User Space permission is also needed in your operator profile.
(2) Show Message displays the message details and is available through the File Transfer Details window.

Note Adjust additional permissions accordingly to allow or prohibit for Own Destinations,
services, and request types.
Procedure
1. From the Creation menu, select File Message: Send.
The File Message: Send window opens.
2. Do you want to use a FileAct message template? Choose the next action:
• If yes, click the row of the template.
The FileAct Template Details - <template name> (Send) window opens.
• If not, click New . The FileAct Message Details (Send) window opens.
3. Enter the message details in the tabs:
• Header: see FileAct Details Window (Send): Header Tab on page 135
• File: see FileAct Details Window (Send): File Tab on page 138
• Comments: if you want to, you can enter comments about the message.
4. Choose the action to take:

Action Next, go to

Save the message as a template Step 5 on page 140

Route the message based on the active routing Step 6 on page 141
schema

Send the message to the _SI_To_SWIFTNet queue

5. To save the message as FileAct message template, do the following:


a) Click Save as template .
The Save as template window opens

17 December 2021 140


Alliance Access 7.6.20 Message Creation
Message Management Guide

b) Type the name of the message template.


Tip The name must be unique for a given unit.
If the message was created from an existing template with the same value for
Unit, then Alliance Message Management proposes a name for the template.
c) Click OK .
Note The only field that is mandatory for a FileAct message template is Unit. The other
fields can be empty.
If you have set an Authoriser DN for FileAct in your operator profile, its value is
used as the authoriser DN for sending the file.
6. Click Send or Route .
• Route the FileAct message using the following routing keywords together:
- Creating_mpfn is set to MPC
- Format is set to File
RMA validation occurs. The outcome is as follows:
• If RMA validation succeeds (or if it fails but you click OK ), then the File Transfer Details
window opens.
• If there is an RMA check failure, then a pop-up window appears. Click OK or Cancel . For
more information, see RMA Check Failure for File Messages on page 148.
7. For more information about how to monitor file transfers, see File Transfer Monitoring on page
242.
You can abort the file transfer if needed by clicking Abort .
8. You can save the payload file to a local directory by clicking Save File .
Alternatively, you can:
• Save the payload from the message details.
Click Show Message from the File Transfer Details window or go to the Search and Report
menu > Message Search, search for messages and select a file message to view its
Message Details.
Click Save File .
• Save the payload from the file transfer details.
Go to the Search and Report menu > File Transfer Monitoring.
Select the file message and save the payload file from the File Transfer Details window.

10.12 File Message: Get

10.12.1 File Message: Get Process


Purpose
File Message: Get allows you to request a file from a correspondent using a FileAct service that
supports real-time delivery.

17 December 2021 141


Alliance Access 7.6.20 Message Creation
Message Management Guide

Note In the context of real-time file get functionality (whether triggered by means of the
Manual FileAct GUI or the saa_rtfilegetrequest tool), the Authoriser DN permission
detail has been added to the SWIFTNet Interface, RT File Get Request permission.
See the Alliance Access Security Guide for more information.

File Message: Get process


1. Create a FileAct message, or a new FileAct message based on a FileAct message template.
2. Use the transmission parameters of the application service profile for the selected FileAct
service, or provide custom transmission parameters which do not conflict with the application
service profile.
3. Route the FileAct message by using the Routing Code ManFileAct.
4. Send the request to get the file from the correspondent.
5. Monitor the file-transfer request as follows:
• through a pop-up window, File Transfer Details
• through the File Transfer Monitoring page, which is available from the Search and Report
menu (see File Transfer Monitoring on page 242)
6. Save the payload file in one of these ways:
• Directly after the requested file has been received from the File Transfer Details window.
The File Transfer Details window appears as a pop-up after file reception.
• From the Search and Report menu > Message Search, do a search on messages and
select a file message to open the Message Details, then from the File tab, click Save File .
The Message Details are also accessible from the File Transfer Details window with the
Show Message button.

• From the Search and Report menu > File Transfer Monitoring, select a file message and
save the payload file from the File Transfer Details window.

10.12.2 File Message: Get Page


Overview
The File Message: Get page displays a list of the FileAct messages for requesting files from
correspondents.
From this page, you can perform the following tasks:
• create a FileAct message to download a file from a correspondent using FileAct in real-time
mode, and save the message as a template
• view, select, edit, and delete FileAct message templates
Note Regarding users and permissions, to display the File Message: Get option, the RT
File Get Request, Service&Identifier detail of your operator profile must be different
from Allowed: None.

17 December 2021 142


Alliance Access 7.6.20 Message Creation
Message Management Guide

Page example

Filtering Criteria area

Filtering Criteria Enables you to filter a list of FileAct message templates according to various
criteria.

Columns in the list

Template Name The name of the template

Service Name The name of the service over which the file download is requested

Request Type The specific function within the service being provided

Requestor DN Your distinguished name

Responder DN The distinguished name of the organisation from which file is requested (also
called the sender)

Unit The unit that is assigned to the file message when an operator requests a file
transfer

Last Modified By The name of the last operator who modified the template

Functions

New Enables you to create a FileAct message manually to request a file for download.

Delete Enables you to delete a file message template.

10.12.3 FileAct Details (Get) Window


Overview
This window displays details about the FileAct message.
If you are working with a FileAct message template, then the name of the window includes the
template name: FileAct Template Details - <template name> (Get) window.
This window contains three tabs:
• Header (see Header tab description on page 144)
• File (see File tab description on page 146)
• Comments

17 December 2021 143


Alliance Access 7.6.20 Message Creation
Message Management Guide

Functions
Function Description

Save as template Saves a new or existing file message template or saves an existing file
message template with a new name.

Get Send the request to download the file.

10.12.3.1 FileAct Details Window (Get): Header Tab


Overview
In the Header tab, you specify the header information of the payload file.

Header tab example

Header tab description

Unit The unit that is assigned to the file message when an operator requests a file
transfer
The value entered for the Unit field by an operator when creating a file GET
request is automatically saved when the message is created successfully. It is
proposed as the initial value when the same operator creates another file GET
request.

Requestor DN Your distinguished name

Authoriser DN The Authoriser DN to be used for the file get request. If present, its level 2
BIC8 must be the same as the level 2 BIC8 of the Requestor DN.

Responder DN The distinguished name of the organisation the file is transferred from (also
called the sender)

Service Name The name of the service over which file download is requested.

Request Type The specific function within the service being provided

17 December 2021 144


Alliance Access 7.6.20 Message Creation
Message Management Guide

User Reference This optional field allows you to enter your own reference information
concerning the file download

Priority The SWIFTNet priority that is requested for the exchange.


Select from the drop-down list:
• Urgent
• Normal

Possible There may be occasions when you need to re-send a request. Selecting this
Duplicate check box informs the receiver that it is a possible duplication. The receiver
then has the option to re-send the file or not.
Select from the drop-down list:
• Yes
• No

Advanced If you select the Advanced Settings check box, then additional fields appear.
Settings

Security Level Select from the drop-down list:


• Automatic
• Without Signature: The message sent does not have to be signed
• With Signature: The file message sent must be signed. If this method is
selected, then you can choose the signature method to sign messages.
• With signature and non repudiation: The file message sent must be
signed and non-repudiation is required. If this method is selected, then you
can choose the signature method to sign messages.
This is an advanced setting for FileAct messages.

Reception The name of the real-time SWIFTNet reception profile to be used for the
Profile request, its response, and the subsequent file reception.
This is an advanced setting for FileAct messages.

Functions For more information, see Functions on page 144.

10.12.3.2 FileAct Details Window (Get): File Tab


Overview
In the File tab, you specify the details of the payload file. This information includes the file name
and the description of information that the file contains.

17 December 2021 145


Alliance Access 7.6.20 Message Creation
Message Management Guide

File tab example

File tab description

Logical File Logical name of the file to be downloaded. This name must be known also by
Name the correspondent from whom the file transfer is requested.

Transfer Info An optional field for structured data that can be used by the correspondent to
process the file transfer automatically. It has to be agreed between you and
your correspondent. The contents of this field must be agreed between you
and the correspondent. Backus-Naur Form (BNF) notation is used as the
syntax for this field. For more information, see the Alliance Gateway File
Transfer Interface Guide

Transfer An optional field where you can enter information about the file transfer that
Description you want to exchange with the correspondent.

Functions For more information, see Functions on page 144.

10.12.4 Download a File Manually


This procedure enables you to do the following tasks:
• create a FileAct message manually to request a file from a correspondent that will be
downloaded in real-time mode
• create templates for FileAct messages, and create messages from these templates
• save the payload file after the file has been downloaded successfully from the correspondent
Before you begin
Action Permissions needed

Unit The unit that is assigned to the operator must match the unit
that is assigned to the File: Get message.

File Message: Get Mesg Creation / Create Message

Get SWIFTNet Interface / RT File Get Request

17 December 2021 146


Alliance Access 7.6.20 Message Creation
Message Management Guide

Action Permissions needed

Open a Template SWIFTNet Interface / Open/Print RProf RT

Save As Template Mesg Creation / Add/Mod/Rem Template


SWIFTNet Interface / Open/Print RProf RT

Save file Message File / Open/Save File

Message details(1) Message File / Open/Save File

(1) The Payload tab displays the message details and is available through the File Transfer Details window.

Procedure
1. From the Creation menu, select File Message: Get.
The File Message: Get window opens.
2. Do you want to use a FileAct message template? Choose the next action:
• If yes, click the row of the template.
The FileAct Template Details - <template name> (Get) window opens.
• If not, click New . The FileAct Message Details (Get) window opens.
3. Enter the message details in the tabs:
• Header: see FileAct Details Window (Get): Header Tab on page 144
• File: see FileAct Details Window (Get): File Tab on page 145
• Comments: if you want to, you can enter comments about the message.
4. To save the message as FileAct message template, do the following:
a) Click Save as template .
The Save as template window opens
b) Type the name of the message template.
Tip The name must be unique for a given unit.
If the message was created from an existing template with the same value for
Unit, then Alliance Message Management proposes a name for the template.
c) Click OK .
Note The only field that is mandatory for a FileAct message template is Unit. The other
fields can be empty.
5. To send the request to download the file, click Get .
RMA validation occurs. The outcome is as follows:
• If RMA validation succeeds, then the File Transfer Details window opens. For more
information about how to monitor file transfers, see File Transfer Monitoring on page 242.
• If there is an RMA check failure, then a pop-up window appears. Click Cancel . Correct the
data and perform the action again. For more information, see RMA Check Failure for File
Messages on page 148.
• If RMA validation fails but you ignore the message and click OK , then an Error pop-up
window opens. The error message explains why the file message is invalid and asks you to
correct the data and perform the action again.

17 December 2021 147


Alliance Access 7.6.20 Message Creation
Message Management Guide

6. For more information about how to monitor file transfers, see File Transfer Monitoring on page
242.
You can abort the file transfer if needed by clicking Abort .
7. You can save the payload file to a local directory by clicking Save File .
Alternatively, you can:
• Save the payload from the message details. Click the Payload tab from the File Transfer
Details window or go to the Search and Report menu > Message Search, do a search on
messages and select a file message to open the Message Details, then from the File tab,
click Save File .
• Save the payload from the file transfer details. Go to the Search and Report menu > File
Transfer Monitoring, select the file message and save the payload file from the File
Transfer Details window.
If the file message is not available yet in the Alliance Access database, then Save File and the
Payload tab is unavailable.
What to do next
Route the FileAct message by using the Routing Code ManFileAct.

10.13 RMA Check Failure for File Messages


Overview
If RMA is required for the selected service, then the following applies:
• File Message: Send
The requestor DN must have a valid authorisation to send files to the responder DN.
• File Message: Get
The requestor DN must have a valid authorisation to receive files from the responder DN.
The RMA validation occurs after you do the following:
• click Route or Send from File Message: Send
• click Get from File Message: Get

RMA check failure messages


A pop-up window appears with one of the following messages when an RMA check failure occurs:

Status of authorisation RMA check failure message(1)

RMA not authorised The business relationship between sender {0} and
receiver {1} does not allow you to send this message.
Are you sure you want to continue?

No business relationship exists There is no business relationship between sender {0}


and receiver {1}. Are you sure you want to continue?

RMA is not enabled The business relationship between sender {0} and
receiver {1} is not enabled. Are you sure you want to
continue?

17 December 2021 148


Alliance Access 7.6.20 Message Creation
Message Management Guide

Status of authorisation RMA check failure message(1)

Authorisation is not within validity period The business relationship between sender {0} and
receiver {1} does not allow you to send this message at
this moment. Are you sure you want to continue?

(1) {0} and {1} correspond to the BIC8 of the requestor DN and the responder DN.

Example for File Message: Send


After the pop-up window appears, you must click OK or Cancel .
If you click OK , then the file transfer is created on Alliance Access, but the file message is not
sent. It is routed by default to the Emission Security Modification queue (_MP_mod_emi_secu).
For more information, see Messages in the Emission Security Modification Queue on page 158.
For more information about Relationship Management, see the Relationship Management Guide.
Example for File Message: Get
If there is an RMA check failure, then a pop-up window appears. Click Cancel . Correct the data and
perform the action again.
If RMA validation fails but you ignore the message and click OK , then an Error pop-up window
opens. The error message explains why the file message is invalid and asks you to correct the data
and perform the action again.

17 December 2021 149


Alliance Access 7.6.20 Message Modification
Message Management Guide

11 Message Modification
Introduction
By default, if Alliance Access cannot process a message, it routes it automatically to the
appropriate queue. For example, if a message fails authentication or cannot be authorised because
there is no business relationship, Alliance Access routes it to the Emission Security Modification
queue. Messages or files are in the Text Modification queue because operators deliberately sent
them there or they may arrive there because of routing rules. You can view and work with
messages held in modification queues depending on your operator profile.

Modification queues
Messages or files that require modification are held in the following modification queues in Alliance
Access:
• Text Modification
• Emission Security Modification
• Reception Security Modification
• Modification for Transmission
• Modification after Reception

Allowed changes
Your operator profile determines which message queues that you can display and which messages
that you can modify. For example, you can only modify messages assigned to your operator profile.
To modify a message, you may need to contact the person who originally put the message in the
modification queue to find out which fields are incorrect.
The list of messages displayed for a modification queue may include messages that are reserved.
These messages are already open by other operators. Only one operator at a time can modify a
message, to prevent concurrent updates.
The fields that you can change in a message depend on the modification queue in which the
message is held.
After modifying a message, you must either route it or dispose it so that its processing continues.
Note A file message or a message with format FpML or AnyXML can potentially appear in a
modification queue. Such messages are displayed with the body in fast mode.

Opening multiple messages for modification


You can open one or multiple messages for modification in all modification queues, by clicking
Open .

When more than one messages are selected, the behaviour is:
• The first message of the selection is opened with the editor
• Once the current message has been modified and the editor closed, a popup appears asking
you to confirm that the next message in the selection must be opened with the editor. If you
confirm, the next message is opened and the current message is removed from the selection. If
you cancel, then no further message from the selection is opened with the editor and the
selection is emptied.
• If a message from the selection, by the time it is opened, has been reserved or moved to
another queue, an error message is displayed. When this error is acknowledged, a popup is

17 December 2021 150


Alliance Access 7.6.20 Message Modification
Message Management Guide

displayed asking you to confirm that the message after the one in error in the selection can be
opened.
• If the Route or Dispose operation fails on one message, after it is handled, you are asked to
confirm the next message in the selection.
Note No status message is displayed when returning to the full list of messages in the
modification queue.

Permission checks for MT and MX messages


Operators cannot modify MT and MX messages with a currency/amount above the limit, if any,
specified in their Mesg Modification, Modify message, CCY/amount permission detail. If the
operator profile has a Mesg Modification, Dispose message, Bypass Verification, CCY/amount limit
and the modified MT or MX message has a currency/amount above that limit, then the message
can only be disposed to the verification queue.
If the operator profile has a Mesg Modification, Dispose message, Bypass Authorisation, CCY/
amount limit and the modified message has a currency/amount above that limit, then it can only be
disposed to the verification queue or to the authorisation queue.
Otherwise, the message can be disposed to any queue.

Fast mode
You can use fast mode to modify messages in certain queues.
Fast mode presents the message information as follows:
• MX messages:
- beautified XML representation, if the elements of the message can be parsed, or possibly as
a mixture of beautified XML and plain text
• FIN messages:
- plain text, that is, the original string representation

Flagging of message duplicates


When a FIN, MX, or File message is initially opened, it may have one or more of the following
sentences in its validation report, based on whether or not the message is a possible duplicate
received from the network, if it has been set locally as a possible duplicate, or if it has been
detected as a duplicate by Alliance Access:
• Possible duplicate information received from network (based on the
mesg_possible_dup_creation field)
• Possible duplicate indicator set locally (based on the mesg_user_issued_as_pde
field)
• Duplicate detected by interface (based on the mesg_zz41_is_possible_dup field)

These sentences are only visible in the Validation tab when the message is re-opened.
After modifying the message, if you attempt to save the changes (by clicking Route or Dispose ),
before trying to save the changes in the database, Alliance Access first performs its own duplicate
detection on the message, based on the latest values as displayed in the GUI. This check occurs
only if there has been a change to a field that is included in the digest calculation or if the message
was already a duplicate as detected by Alliance Access.
If the message is detected to be a duplicate according to its criteria, Alliance Access displays a
Duplicate detected by interface warning in a pop-up window. You are prompted to either
continue or cancel the message processing. If you click Cancel , Alliance Access does not try to
route or dispose the message. If you click OK , the message processing continues.

17 December 2021 151


Alliance Access 7.6.20 Message Modification
Message Management Guide

11.1 Message Modification Page Example


Overview
The list of messages held in a queue shows various attributes for each message.
The messages are sorted in order of priority. System messages are listed first, followed by urgent
priority messages and then normal priority messages.

List example

The example that follows shows a list of messages held in the Text Modification queue:

Buttons in the list

Change View Allows you to select the columns to be displayed and number of rows to be
displayed.

Add As Adds a message based on the currently selected message, if not locked.

Open Opens the message. Enables you to see the contents of the header,
application heade, body of the message, and any operator comments.

Complete Completes the selected message and removes it from the list.

Re-assign Standard Re-assigns the selected message to a base standard schema or a


MyStandards schema. A message can only be re-assigned if it has the same
identifier (which may contain a Usage part for MX messages) and service
code. MX messages can be re-assigned when the usage guidelines are
different. In addition, an MX message must not be marked as obsolete in
order to re-assign it. See also Re-Assign a Standard to Message Template on
page 114.
Note Base standard schemas are the XML schemas of MT and MX
messages (so-called Base messages). MyStandards schemas
are XML schemas of Base messages to which a number of
restrictions have been added, such as restricting the length of a
field, making an optional field mandatory, prohibiting the use of
certain codes in a field, and so on. In order to use MyStandards,
you must register on www.swift.com.

Columns in the list

I/O Input or output message.


• I stands for inputmessages, that is, messages that were created for input to
the network.
• O stands for output messages, that is, messages received from the network.

17 December 2021 152


Alliance Access 7.6.20 Message Modification
Message Management Guide

Correspondent The sender of the message if the message was output from the network. The
receiver of the message if the message was input to the network.

Display Name Identifies the base or MyStandards standard assigned to the message.

Identifier The message identifier that uniquely identifies the message type (within a
particular service).

Reference A transaction reference number or a message user reference.

Suffix Value that helps identify the message.

Open By Name of the operator who reserved the message, that is, who has already
opened it and is currently working on it.

In Queue Since Time when the message entered the queue.

Inst Type The message instance type (original, copy, notification.)

Cur/Amt The currency code and amount of the transaction.

Value Date The date on which the transaction is to be completed.

NAK Code For FIN or APC messages, this is the error code returned by the SWIFT
network. For more information about NAK codes, see the FIN Error Codes.

Last Change Name of the last operator who modified the message

Unit The unit to which the message is assigned.

Sender The sender of the message.

SLA ID The applicable service type identifier that is used for services such as gpi (field
111 in the MT header).

UETR An end-to-end reference across a payment transaction (field 121 in the MT


header).

Status Indication of whether the message is locked (if not, the entry in this column is
blank).

Additional columns not displayed by default


By default, the following columns are not displayed. To display a column, click Change View .

Format The format of the message (for example, Swift, MX, or File).

Network The network used to send messages (SWIFT or SWIFTNet).

Dup from network A message that has been received with duplicate information from the
network.

Dup set locally A message that has been marked as duplicate locally (inside Alliance
Access) by a user

17 December 2021 153


Alliance Access 7.6.20 Message Modification
Message Management Guide

Interface detected dup A message that Alliance Access has identified as duplicate by means of
its duplicate detection mechanism.

Inst Creator Name of the operator who created the message instance.

Inst Creation
The creation date and time of the message instance.

Inst Last Modifier Name of the last operator who modified the message instance.

Inst Last Modification


The date and time of the last modification of the message instance.

Message Description The name of the message. For MT and MX messages, the Message
Description field contains the Display Name of the message type.

Service Name The service that corresponds to the standard selected.

Status Indication of whether the message is locked (if not, the entry in this
column is blank).

Usage Identifier The RequestSubType of the MX message, which contains an


identification of the validation expected to be performed by sender,
receiver and SWIFT, if Message Validation (MVal) applies.

11.2 Modify a Message


Procedure
1. From the Message Modification menu, select the appropriate queue.
A page appears with the list of messages currently held in the selected queue.

The list shows the name of the selected queue and includes various attributes for each
message. For a description of these attributes, see Message Modification Page Example on
page 152.
2. If needed, refine the list using filtering criteria. For details, see Filter a List of Messages in a
Queue on page 155.
You can open a selection of multiple messages in any of the GUIs of the Message Modification
and Message Approval application groups of the Message Management package. When
opening a selection of multiple messages, the first message of the selection is opened. When
you close, route, or dispose that first message, you are prompted to either open the next
message of the selection or to return to the list of messages. This happens for all messages in
the selection until the last message is reached, in which case you are automatically returned to
the list of messages.

17 December 2021 154


Alliance Access 7.6.20 Message Modification
Message Management Guide

3. Click the message that you want to open. If the message is valid, then it is displayed with the
Header tab open by default. If the message contains errors, then a Validation Report is
displayed in addition.
4. The fields that you can change depend in which of the following queues the message is held:
• Text Modification, see Messages in the Text Modification Queue on page 156
• Emission Security Modification, see Messages in the Emission Security Modification Queue
on page 158
• Reception Security Modification, see Messages in the Reception Security Modification
Queue on page 159
• Modification for Transmission, see Messages in the Modification for Transmission Queue on
page 161
• Modification after Reception, see Messages in the Modification After Reception Queue on
page 161
5. If you need to correct errors for a message in the Text Modification queue, then you can click
Validate to verify that you have corrected them properly and that no errors remain.

6. When you have finished entering modifications, either route the message or dispose it to
another queue. The Status area informs you that the message was routed or disposed
successfully.
If the message still contains errors or warnings, you can dispose it to the Text Modification
queue for later editing.
7. You can generate a report of the message. Click Report . For more information about
generating a report, see Report Types and Settings (Export Function) on page 36.
8. Click another message to be modified or perform any other available task.

11.2.1 Filter a List of Messages in a Queue


When the list of messages is returned for a selected queue, it includes all the messages that are
relevant to you. You can reduce this list by using filtering criteria.
Several criteria allow you to view a subset of messages in the queue based on the following
information:
• I/O
• Correspondent
• Format
• Identifier
• Suffix
• Created By (name of the message creator)
• Created From
• Created To
• Modified By (name of the last operator who modified the message)
• Reference
• SLA ID The service type identifier (field 111 in the MT header)
• UETR An end-to-end reference across a payment transaction (field 121 in the MT header)

17 December 2021 155


Alliance Access 7.6.20 Message Modification
Message Management Guide

You can use the following wildcards in the I/O, Correspondent, Identifier, and Reference fields:
• ''_'', to replace one unknown character
• ''%'', to replace zero, one or more contiguous unknown characters
When filtering for Correspondent or Reference, the use of the "%" wildcard is not recommended,
because the filter results may not be as expected.
Check the Match Case box if you want to restrict the search to the messages matching the case of
the value entered in the Reference field.
It is possible to search for multiple message type families when using the message Identifier field
in one search. If multiple values are provided for the Identifier field, then the values must be
separated by a comma ",".
Procedure
1. From the Modification menu, select the queue that you want. The page for the selected queue
appears with the list of messages currently held in that queue.
2. Define the values to use in filtering the list in the filtering criteria fields.
Note When using filtering criteria for FIN messages, you must key the Identifier (for
example, fin.103) instead of just the MT (for example, 103).
3. Once you have provided all relevant criteria, click Submit . A new list is returned according to
the criteria submitted.

11.3 Messages in the Text Modification Queue


The Text Modification queue stores valid and invalid messages and files:
• Messages or files disposed deliberately by an operator to the Text Modification queue for data
modification.
• Messages rejected by the SWIFT network and routed back to the Text Modification queue as
NAKs.
Usually in Text Modification you change the content of a valid message or correct errors in an
invalid message (for example, syntax errors, incorrect amount detected during message verification
or authorisation). Some fields cannot be modified (for example, the sender, the logical terminal or
the message type).
The following message parts can be modified from Text Modification:
• the header
• the application header (MX messages only)
• the body
• the comment
For File messages in Text Modification, the following applies:
• The message header information including Requestor DN, Responder DN, User Reference, and
Possible Duplicate can be modified.
• The comment can be modified.
• The file header (Logical file name, File Description) is read-only.
• The file payload is not accessible and therefore cannot be edited.
A duplicate check is performed before a message is disposed. If a duplicate is detected, the
following confirmation message is displayed: Alliance Access reports this message as

17 December 2021 156


Alliance Access 7.6.20 Message Modification
Message Management Guide

being a duplicate. Are you sure you want to continue?. Click OK to continue or Cancel
to cancel the operation.
Note You can use fast mode to modify messages in this queue.
Messages held in the Text Modification queue can also be completed, that is discarded. For details,
see Complete Messages on page 157.

11.3.1 Complete Messages


You may want to discard a message that was created, for example, for training purposes.
Completing a message removes it from the Text Modification queue. You need the permission to
complete a message in your operator profile.
A completed message has no further processing performed on it. It is no longer available for
routing to any other queue and is no longer visible in the Text Modification queue. It is stored in the
Alliance Access database (and in subsequent archives).
Procedure
1. From the Modification menu, select Text Modification. A page appears with the list of
messages currently held in the Text Modification queue (_MP_mod_text).
2. Select one or more messages to complete by checking the box next to the messages. To
complete all the messages in the displayed page, check the top box.
3. Click Complete . A confirmation window appears.
4. Click OK to confirm or Cancel to return to the list of messages.

11.3.2 Save Messages as Templates


Operators with the Add/mod/rem template permission can save as a template, a message whose
details are being edited in the Text Modification queue (_MP_Modification). This applies to MT and
MX messages and does not apply to File messages (which can never be routed or disposed to the
Text Modification queue).

Saving a message as a template

17 December 2021 157


Alliance Access 7.6.20 Message Modification
Message Management Guide

To save a message in this queue as a template, click Save as Template . You are prompted to enter a
name for the new template (which can be a duplicate name if you choose). Click Save . When the
template is created, you can continue editing the details of the source message. To further modify
or delete the template just created, you must use the Create/Edit template applications and
screens.

11.4 Messages in the Emission Security Modification


Queue
Overview
An input message or file message is routed to the Emission Security Modification queue
(_MP_mod_emi_sec) if the following occurs:
• an authentication (PKI) problem at emission time
• an authorisation (RMA) problem at emission time
When you route or dispose a message that is in this queue, Alliance Message Management
displays information in the Validation Report to indicate the current authentication state. You cannot
change header or body text for a message or file message in this queue. Only the comments can
be modified.
You can also search for a message to display the message intervention details (emission appendix
or reception appendix), which contains information about message authentication or authorisation.
See View Message Instance Details on page 205.
You can toggle to fast mode and come back to prompted mode to display the body of the message.

Example

Here is an example of the validation report for a FIN message that has been opened from this
queue:

FIN message authentication


Alliance Access uses SWIFTNet Public Key Infrastructure certificates to authenticate messages.
Signature-related details for a message are visible in the emission appendix. For a FIN message,
these PKI-related details are shown in the area for Authentication Information and, if relevant,
Proprietary Authentication Information. A FIN message that has a PKI-related authentication
problem arrives in this queue.
You can authenticate a message after the problem that caused it to fail authorisation is solved. For
example, correct wrong data in the CIF or update incorrect details for the Relationship
Management authorisation.

InterAct and FileAct message authentication


Authentication for these messages relies on SWIFTNet Public Key Infrastructure and its signature-
related operations. Signature-related details are visible in the SWIFTNet Options area of the
reception appendix. If a message that you are trying to send fails authentication, then first
investigate the problem.

17 December 2021 158


Alliance Access 7.6.20 Message Modification
Message Management Guide

Message authorisation
Alliance Access uses authorisations created with the Relationship Management interface to check
that it is possible to send messages or files to a correspondent. Authorisation fails if there is no
appropriate authorisation. For example, the authorisation does not exist, the message is not
allowed, or the message is outside the validity period specified in the authorisation. The
authorisation result is also in the emission appendix, shown in the RMA Check field.

Procedure
1. Investigate the problem that caused authentication or authorisation to fail.
2. Correct information as needed for RMA.
3. Open or select a message and click Authenticate .
Alliance Access attempts to authenticate the message and send it to the appropriate input
queue. If authentication fails, then the message returns to the Emission Security Modification
queue.

11.5 Messages in the Reception Security Modification


Queue
Overview
An output message or file message is routed to the Reception Security Modification queue
(_MP_mod_rec_secu) if the following occurs:
• an authentication (PKI) problem at reception time
• an authorisation (RMA) problem at reception time
When you open a message in this queue, Alliance Message Management displays information in
the Validation Report to indicate why the message arrived in the queue. You cannot change header
or body text for a message in this queue. Only the comments can be modified. You can
authenticate messages that have authentication as well as authorisation problems.
You can also search for a message to display the message intervention details (emission appendix
or reception appendix), which contains information about message authentication or authorisation.
See View Message Instance Details on page 205.
You can toggle to fast mode and come back to prompted mode to display the body of the message.

Here is an example of the Validation Report for a FIN message which was opened from this queue:

FIN message authentication


Alliance Access uses certificates to authenticate FIN messages received with a logical terminal.
The reception appendix shows how the message was authenticated. It contains either MAC-related
and PAC-related details, or PKI-related information. After solving the problem that caused the FIN
message to fail authentication, you can authenticate again the message.

InterAct and FileAct message authentication


Authentication for these messages relies on SWIFTNet Public Key Infrastructure and its signature-
related operations. Signature-related details and the SWIFTNet Partial Copy-related digest are

17 December 2021 159


Alliance Access 7.6.20 Message Modification
Message Management Guide

visible in the SWIFTNet Options area of the reception appendix. If a received message failed
authentication, then first investigate the problem. You may decide to bypass security for the
message.
SWIFTNet Copy
When the SWIFTNet Copy destination's Alliance Access receives an InterAct Partial Copy
message, the SWIFTNet partial copy digest is available in the appendix of the xcop message
received from SWIFTNet.
When you open the message in the Reception Security Modification queue, the Validation Report
tab displays an information or warning message:
• passed the partial copy digest verification
• bypassed the partial copy digest verification
• did not pass the partial copy digest verification due to invalid digest
If you decide to bypass security, then the Partial copy Digest Result field in the Interventions tab
is updated with the value PartialCopy_Bypassed.
For more information about SWIFTNet Copy, see the Alliance Access Configuration Guide.
Message authorisation
Alliance Access uses business relationships from RMA to authorise messages received. If the
message needs to be authorised using RMA, then Alliance Access checks whether an appropriate
RMA relationship exists when attempting to receive a message. If there is no appropriate business
relationship, then RMA authorisation will fail. The authorisation result is visible in the RMA Check
field in the reception appendix. After solving the problem that caused the message to fail
authorisation, you can reauthorise the message. For example, an RMA authorisation is received
after the message is routed to the _MP_mod_rec_secu queue. The trailer of a reauthenticated
message now shows that the authorisation is successful. During the reauthorisation, the RMA
Check Service is also filled with the service coming from the ASP.
You can also possibly bypass security for the message if you have the appropriate permissions.

Procedure
1. Investigate the problem that caused authentication or authorisation to fail.
2. Correct information as needed for RMA.
3. If you open the message
Open the message by clicking the message or select the check box to the left of the message
and click Open then perform one of the following actions:
• Bypass Security

• Route

• Dispose to the Modification for Transmission queue (see Messages in the Modification for
Transmission Queue on page 161)
4. If you select the message without opening it
Select the check box to the left of the relevant message or messages and perform one of the
following actions:
• Authenticate

• Bypass Security

If you click Open , then see the previous step.

17 December 2021 160


Alliance Access 7.6.20 Message Modification
Message Management Guide

Note Depending on security practices at your institution, you or another operator with
appropriate permissions may decide to bypass security for the message so that
processing can continue. When you bypass security for a message, Alliance Access
routes it according to the defined routing rules, but without authentication.
Alternatively, it may be necessary to complete a message that failed authentication
(after moving it to the Text Modification queue).

11.6 Messages in the Modification for Transmission


Queue
If a message cannot be transmitted once it has arrived in Alliance Access, then it is routed to the
Modification for Transmission queue (_MP_mod_transmis).
No details can be updated for messages in this queue except for the following:
• comments can be updated for original instances of all kinds of messages
• receiver details can be updated for copy instances of input FIN messages.
To correct a message held in the Modification for Transmission queue, the Receiver details must be
updated on Alliance Access (for example, the address or network information in the CIF). Then,
from Alliance Message Management, route or dispose the message.
You can toggle to fast mode and come back to prompted mode to display the body of the message.

11.7 Messages in the Modification After Reception


Queue
Messages may be sent to the Modification After Reception queue (_MP_mod_reception) as a
result of user-defined routing rules.
You can correct some details in the header, or details that affect the business relationship.
The following header details can be modified:
• For FIN messages only
- the receiver's BIC11
- add a value for the routing code (related to Alliance Access routing rules)
• the unit assigned to the message
• the user-assigned possible duplicate indication
• comments can be added for all kinds of messages
Note For file messages, only the comments can be updated.
You can toggle to fast mode and come back to prompted mode to display the body
of the message.
After modifying the message, validate it to make sure that no errors remain, then route it or dispose
it. Any routed message with a network address that Alliance Access cannot recognise is routed
back to the Modification After Reception queue.

17 December 2021 161


Alliance Access 7.6.20 Message Approval
Message Management Guide

12 Message Approval
Introduction
Approval can include three tasks:
• Verify MT and MX messages, that is, verify the accuracy of certain fields, such as currency or
amount.
• Authorise messages, that is, perform a visual check on the messages before sending them to
the network input queue.
• Recover FIN, InterAct, or FileAct messages and initiate actions to route a message, complete a
message instance, or move a message instance back to the original queue.
You can generate a report of the details of a message that is opened from the recovery
investigation queue. For more information, see Report Types and Settings (Export Function) on
page 36.
Note Messages with format FpML or AnyXML can potentially appear in the authorisation
queue. Such messages can be opened using fast mode.

Permission checks for approving and rejecting messages


The following permission checks are performed when approving or rejecting messages during
message verification, authorisation, and recovery:

GUI View Action Single Permission check for Permission check for Permission check for
Applicatio type or FIN InterAct FileAct
n multipl
e
messa
ges

Message List view Reject S Mesg Approval, Approve Mesg Approval, Approve Mesg Approval, Approve
Verificatio Message, Own Message, Own Message, Own
n Destination(s)/ Can Destination(s) for InterAct Destination(s) for InterAct
Verify/ Verify own entered & FileAct (DN)/Service $ & FileAct (DN)/Service $
msg/ Ccy-amount/ identifier - InterAct identifier - FileAct
Message types messages/ Can Verify/ messages/ Can Verify/
Verify own entered msg/ Verify own entered msg
AND
Ccy-amount/
AND
(Mesg Approval, Route
AND
Messages, Own (Mesg Approval, Route
Destination(s) OR Mesg (Mesg Approval, Route Message, Own
Approval, Approve Message, Own Destination(s) for InterAct
Message, Group Destination(s) for InterAct & FileAct (DN)/Service $
Authorise) & FileAct (DN)/Service $ identifier - FileAct
identifier - InterAct messages OR Mesg
messages OR Mesg Approval, Approve
Approval, Approve Message, Group
Message, Group Authorise)
Authorise)

17 December 2021 162


Alliance Access 7.6.20 Message Approval
Message Management Guide

GUI View Action Single Permission check for Permission check for Permission check for
Applicatio type or FIN InterAct FileAct
n multipl
e
messa
ges

M Mesg Approval, Approve Mesg Approval, Approve Mesg Approval, Approve


Message, Own Message, Own Message, Own
Destination(s)/ Can Destination(s) for InterAct Destination(s) for InterAct
Verify/ Verify own entered & FileAct (DN)/Service $ & FileAct (DN)/Service $
msg/ Ccy-amount/ identifier - InterAct identifier - FileAct
Message types/ Group messages/ Can Verify/ messages/ Can Verify/
Authorise Verify own entered msg/ Verify own entered msg/
Ccy-amount/ Group Group Authorise
Authorise

Details Reject S Mesg Approval, Approve Mesg Approval, Approve Mesg Approval, Approve
view Message, Own Message, Own Message, Own
Destination(s)/ Can Destination(s) for InterAct Destination(s) for InterAct
Verify/ Verify own entered & FileAct (DN)/Service $ & FileAct (DN)/Service $
msg/ Ccy-amount/ identifier - InterAct identifier - FileAct
Message types messages/ Can Verify/ messages/ Can Verify/
Verify own entered msg/ Verify own entered msg/
AND
Ccy-amount/
AND
Mesg Approval, Route
AND
Message, Own Mesg Approval, Route
Destination(s). Mesg Approval, Route Message, Own
Message, Own Destination(s) for
Destination(s) for InterAct/FileAct Message/
InterAct/FileAct Message/ Service $ identifier -
Service $ identifier - FileAct messages
InterAct messages

Message List view Authorise/ S Mesg Approval, Approve Mesg Approval, Approve Mesg Approval, Approve
Authorisat Reject Message, Own Message, Own Message, Own
ion Destination(s)/ Can Destination(s) for InterAct Destination(s) for InterAct
Authorise/ Auth own & FileAct (DN)/Service $ & FileAct (DN)/Service $
entered msgs/ Auth own identifier - InterAct identifier - FileAct
verif msgs/ Ccy-amount/ messages/ Can messages/ Can
Message types/ Trans Authorise/ Auth own Authorise/ Auth own
app limit, Daily app limit. entered msgs/ Auth own entered msgs/ Auth own
verif msgs/ Ccy-amount/ verif msgs/ Trans app
AND
Trans app limit, Daily app limit, Daily app limit.
(Mesg Approval, Route limit.
AND
Message, Own
AND
Destination(s) OR Mesg (Mesg Approval, Route
Approval, Approve (Mesg Approval, Route Message, Own
Message, Group Message, Own Destination(s) for InterAct
Authorise) Destination(s) for InterAct & FileAct (DN)/Service $
& FileAct (DN)/Service $ identifier - FileAct
identifier - InterAct messages OR Mesg
messages OR Mesg Approval, Approve
Approval, Approve Message, Group
Message, Group Authorise)
Authorise)

17 December 2021 163


Alliance Access 7.6.20 Message Approval
Message Management Guide

GUI View Action Single Permission check for Permission check for Permission check for
Applicatio type or FIN InterAct FileAct
n multipl
e
messa
ges

M Mesg Approval, Approve Mesg Approval, Approve Mesg Approval, Approve


Message, Own Message, Own Message, Own
Destination(s)/ Can Destination(s) for InterAct Destination(s) for InterAct
Authorise/ Auth own & FileAct (DN)/Service $ & FileAct (DN)/Service $
entered msgs/ Auth own identifier - InterAct identifier - FileAct
verif msgs/ Ccy-amount/ messages)/ Can messages/ Can
Message types/ Trans Authorise/ Auth own Authorise/ Auth own
app limit, Daily app limit/ entered msgs/ Auth own entered msgs/ Auth own
Group Authorise verif msgs/ Ccy-amount/ verif msgs/ Trans app
Trans app limit, Daily app limit, Daily app limit/
limit/ Group Authorise Group Authorise

Details Authorise/ S Mesg Approval, Approve Mesg Approval, Approve Mesg Approval, Approve
Reject Message, Own Message, Own Message, Own
Destination(s)/ Can Destination(s) for InterAct Destination(s) for InterAct
Authorise/ Auth own & FileAct (DN)/Service $ & FileAct (DN)/Service $
entered msgs/ Auth own identifier - InterAct identifier - FileAct
verif msgs/ Ccy-amount/ messages/ Can messages/ Can
Message types/ Trans Authorise/ Auth own Authorise/ Auth own
app limit, Daily app limit. entered msgs/ Auth own entered msgs/ Auth own
verif msgs/ Ccy-amount/ verif msgs/ Trans app
AND
Trans app limit, Daily app limit, Daily app limit.
Mesg Approval, Route limit.
AND
Message, Own
AND
Destination(s) Mesg Approval, Route
Mesg Approval, Route Message, Own
Message, Own Destination(s) for InterAct
Destination(s) for InterAct & FileAct (DN)/Service $
& FileAct (DN)/Service $ identifier - FileAct
identifier - InterAct messages
messages

Message List view Authorise/ S Mesg Approval, Treat Mesg Approval, Treat Mesg Approval, Treat
Recovery Reject Recovered Msg, Own Recovered Msg, Own Recovered Msg, Own
Destination(s) Destination(s) for InterAct Destination(s) for InterAct
& FileAct (DN)/Service $ & FileAct (DN)/Service $
AND
identifier - InterAct identifier - FileAct
(Mesg Approval, Route messages messages
Message, Own
AND AND
Destinations OR Mesg
Approval, Treat (Mesg Approval, Route (Mesg Approval, Route
Recovered Msg, Group Message, Own Message, Own
Authorise) Destination(s) for InterAct Destination(s) for InterAct
& FileAct (DN)/Service $ & FileAct (DN)/Service $
identifier - InterAct identifier - FileAct
messages OR Mesg messages OR Mesg
Approval, Treat Approval, Treat
Recovered Msg, Group Recovered Msg, Group
Authorise) Authorise)

17 December 2021 164


Alliance Access 7.6.20 Message Approval
Message Management Guide

GUI View Action Single Permission check for Permission check for Permission check for
Applicatio type or FIN InterAct FileAct
n multipl
e
messa
ges

M Mesg Approval, Treat Mesg Approval, Treat Mesg Approval, Treat


Recovered Msg, Own Recovered Msg, Own Recovered Msg,Own
Destination(s)/Group Destination(s) for InterAct Destination(s) for InterAct
Authorise details & FileAct (DN)/Service $ & FileAct (DN)/Service $
identifier - InterAct identifier - FileAct
messages /Group messages/Group
Authorise details Authorise details

Details Route (S) Mesg Approval, Treat Mesg Approval, Treat Mesg Approval, Treat
view Recovered Msg, Own Recovered Msg, Own Recovered Msg, Own
(=authoris
Destination(s) Destination(s) for InterAct Destination(s) for InterAct
e)
& FileAct (DN)/Service $ & FileAct (DN)/Service $
AND
identifier - InterAct identifier - FileAct
Mesg Approval, Route messages messages
Message, Own
AND AND
Destination(s)
Mesg Approval, Route Mesg Approval, Route
Message, Own Message, Own
Destination(s) for InterAct Destination(s) for InterAct
& FileAct (DN)/Service $ & FileAct (DN)/Service $
identifier - InterAct identifier - FileAct
messages messages

Permission checks for MX messages


Operators cannot verify or approve MX messages with a currency/amount above the limit, if any,
specified in their Mesg Approval, Approve message, CCY/amount permission detail. If the operator
profile has a Mesg Approval, Dispose message, Bypass authorisation, CCY/amount limit and a
verified MX message has a currency/amount above that limit, the verified MX message can only be
disposed to the authorisation queue or to the text modification queue.
Rejecting MT and MX messages that are syntactically incorrect and cannot be opened
Operators can reject one or more messages selected from the list of MT and MX messages in the
verification queue using the Reject button. In order to reject a group of messages, an operator
requires the Mesg Approval, Approve message, Can verify, Group authorise permission/permission
detail. On the other hand, this permission detail is not required to reject a single message. This
action enables the operator to move syntactically incorrect messages that cannot be opened from
the verification queue to the text modification queue.

Moving between messages


If you select multiple messages in a list and then click Open , by clicking Next , you can display the
details of the next message in the list, relative to the one that was first opened. When you click
Close , you return to the previous list of messages.

If the details of a message are opened in prompted (or fast) mode, when moving to the details of
the next message using Next , the details of the next message are also displayed in the same
prompted (or fast) mode.

17 December 2021 165


Alliance Access 7.6.20 Message Approval
Message Management Guide

Flagging of message duplicates (during Message Verification, Authorisation, and Recovery)


When a FIN, MX, or File message is initially opened, it may have one or more of the following
sentences in its validation report, based on whether or not the message is a possible duplicate
received from the network, if it has been set locally as a possible duplicate, or if it has been
detected as a duplicate by Alliance Access:
• Possible duplicate information received from network (based on the
mesg_possible_dup_creation field)
• Possible duplicate indicator set locally (based on the mesg_user_issued_as_pde
field)
• Duplicate detected by interface (based on the mesg_zz41_is_possible_dup field)

These sentences are only visible in the Validation tab when the message is re-opened.

12.1 Message Verification Page


Overview
The Message Verification page displays a list of messages available for verification.

Page example

Filtering criteria area


Enables you to filter a list of messages according to various criteria. When filtering for
Correspondent or Reference, the use of the "%" wildcard is not recommended, because the
search results may not be as expected. For more information, see Filter a List of Messages in a
Queue on page 155:

I/O Input or output message.


• I stands for input messages, that is, messages that were created for input to
the network.
• O stands for output messages, that is, messages that Alliance Access
received from the network.

Correspondent The receiver of the message.

Format The format of the message (for example, Swift or MX)

Identifier The message identifier that uniquely identifies the message type.

Suffix Value that helps identify the message.

Created by Name of the operator who created the message.

Modified by Name of the operator who last modified the message.

17 December 2021 166


Alliance Access 7.6.20 Message Approval
Message Management Guide

Reference A transaction reference number or a message user reference.

Match Case You can check the Match Case box to restrict entries in the results to the
messages matching the case used in the Reference field.

SLA ID Service Level Agreement (SLA) identifier in the MT header: field 111. This field
identifies the service type identifier that is used for services such as gpi.

UETR Unique end-to-end transaction reference in the MT header: field 121. This field
provides an end-to-end reference across a payment transaction.

Columns in the list

I/O Input or output message.


• I stands for input messages, that is, messages that were created for input to
the network.
• O stands for output messages, that is, messages received from the network.

Correspondent The receiver of the message.

Display Name The message standard (either base or MyStandards) assigned to messages in
the Verification queue.

Identifier The message identifier that uniquely identifies the message type.

SLA ID The applicable service type identifier that is used for services such as gpi (field
111 in the MT header).

UETR An end-to-end reference across a payment transaction (field 121 in the MT


header).

Reference A transaction reference number or a message user reference.

Suffix Value that helps identify the message.

Open By Name of the operator who reserved the message, that is, who has already
opened it and is currently working on it.

In Queue Since Time when the message entered the queue.

Network The network used to send MT messages (SWIFT).

Inst Type The message instance type (original, copy, notification.)

Last Change Name of the last operator who modified the message

Unit The unit to which the message is assigned.

Sender The sender of the message.

Status Indication of whether the message is locked (if not, the entry in this column is
blank).

17 December 2021 167


Alliance Access 7.6.20 Message Approval
Message Management Guide

Additional columns not displayed by default


By default, the following columns are not displayed. To display a column, click Change View .

Inst Creator Name of the operator who created the message instance.

Inst Creation The creation date and time of the message instance.

Inst Last Modifier Name of the last operator who modified the message instance.

Inst Last Modification The date and time of the last modification of the message instance.

Dup from network A message that has been received with duplicate information from the
network.

Dup set locally A message that has been marked as duplicate locally (inside Alliance
Access) by a user

Interface detected dup A message that Alliance Access has identified as duplicate by means of
its duplicate detection mechanism.

Usage Identifier The RequestSubType of the MX message, which contains an


identification of the validation expected to be performed by sender,
receiver and SWIFT, if Message Validation (MVal) applies.

12.2 Message Verification


After you have created MT or MX messages, authorised operators can verify certain fields. Alliance
Access stores the messages that are awaiting verification in the Message Verification queue. A
valid message that was verified can be routed or disposed, if the permissions in your operator
profile allow these actions. You can also reject a message.

Messages to be verified
Messages in the verification queue are retrieved according to their priority. System Messages
(APC) are listed first, followed by urgent priority messages, and then normal priority messages.
The following criteria in your Alliance Access operator profile determine which messages are
presented to you for verification:
• Units assigned to you
• Sender Logical Terminal
• Message Type
• Currency code
• Amount
• Verify own entered message
Note If No validation is defined in the Reception parameters of a message partner
profile, then the list of messages in the Message Authorisation page may include
messages that your operator profile forbids based on certain keywords. For example,
if you are limited to an amount of N, messages with amounts greater than N may
appear in the list of messages. This happens because keywords are not extracted
from the message when the validation level is No validation.

17 December 2021 168


Alliance Access 7.6.20 Message Approval
Message Management Guide

Different versions of the message standards


If a message schema was changed between the creation of a message and its verification, then
this message is displayed with relevant errors when it is opened for verification. In such a case, you
must dispose the message to the Text Modification queue so that errors can be corrected.

Verifiable fields
The FIN message standards determine which fields are verifiable for a given MT message. For
more information, see Help about Message Standards on page 64.
The Standards (or official) definition of verifiable fields for MX messages is provided by the SWIFT
Standards department, and the Message Management Deployment Packages and Universal
Standards Archive packages delivered by SWIFT to customers contains the official definition of
verifiable fields for MX standards.
Note As opposed to MT messages, for which most message types have verifiable fields,
only a few MX service/request type standards will initially have verifiable fields.
Typically, the fields that you can verify include the following kinds of information:
• currency
• amount
• value date

User-defined verifiable fields


Using the Alliance Access/Entry Configuration GUI, Messages / Message Standards application,
operators with the SWIFT Support, Install Msg Standard permission can overwrite the Standards
list of verifiable fields for MT message types and MX service/request types and define their own
selection of verifiable fields.
Operators can enter their own definition of verifiable fields in the Verifiable fields section at the
bottom of the detailed view of an MT or MX message standard. In practice, operators must enter
the XPath expression of the fields they want to define as verifiable. Following is an example of the
syntax of an XPath expression for a currency field: Body/Document/SttlmOblgtnRpt/RptDtls/
SttlmOblgtnDtls/SttlmAmt/Amt/@Ccy.

Tip The XPath expression of a field can be copied and pasted from the field-level help that
is available when creating a new message of that type. The operator can target ALL of
the instances of a repeated field by removing the [n] in the path. In addition, qualifier
values can contain (or be replaced by) wildcards, such as *.
Both mandatory and optional fields can be defined as verifiable. When a optional field defined as
verifiable field is not present and is moved to the verification queue, the optional (empty) field is not
displayed as there is no value to be retyped in/verified.
When saving their changes, operators overwrite the verifiable fields of that particular MT or MX
message standard in the Message Management Deployment Packageor Universal Standards
Archive (USA) package. Changes to verifiable fields take effect immediately on all MT/MX
messages that arrive in the verification queue.
Verifiable fields for a message and service that are contained in both a USA business message
and a Deployment Package message are shared. If you install both packages and you edit a
verifiable field, then the updated field is visible in both the USA package and the Deployment
Package.
Operators can add or remove verifiable fields in any MT or MX standard irrespective of whether or
not the message is enterable and irrespective of whether or not the default standard from SWIFT
contains verifiable fields for that MT or MX standard.

17 December 2021 169


Alliance Access 7.6.20 Message Approval
Message Management Guide

If a new version of a FIN MT or MX standard is installed and contains a different set of verification
fields than the set of verifiable fields (including user-defined verifiable fields) contained in the
previous version of the standard, the previous version is not updated (and retains its set of
verifiable fields) and the new version is installed with its own set of verifiable fields. The new
version is not automatically updated with the previous set of user-defined verifiable fields.
Alliance Access also supports the definition of verifiable fields in some MX and MT message
header fields, including:
• For MX messages:
- Requestor DN
- Responder DN
- User Reference
• For MT messages:
- Receiving Institution
- MUR
The definition of verifiable fields by operators does not require four-eyes approval.

Handling of verifiable fields for messages created with Add as


In support of MT and MX message verification and user-defined verifiable fields, when a new MT or
MX message is created using Add as , the Mesg_needs_verification field of the new message is
populated as follows:
• For an MT or MX message, its Mesg_needs_verification field is set to Yes if the Web Platform
deployment package active at that moment indicates that it contains verifiable fields. Otherwise,
this field is set to No.

Generating reports of MT/MX verifiable fields


Using the Alliance Access/Entry Configuration GUI, Messages / Message Standards application,
you can generate printable reports that contain the list of verifiable fields of the MT and MX
message types. This function is available from both the Message Standards and Message List
views.
In the Message Standards view, if the option Include message type details is selected, the report
will contain all details from the deployment package, of the message types included in the selected
message standards, including their verifiable fields. The report does not indicate if a verifiable field
is coming from the official SWIFT Standards definition or if it has been defined by the user. If that
option is not selected, the report will contain only the list of message types for the selected
message standards (and no details from the deployment package).
In the Message List view, if the option Include message type details is selected, the report will
contain all details from the deployment package, of all message types included in the message
standard displayed, including the verifiable fields. The report does not indicate if a verifiable field is
coming from the official SWIFT Standards definition or if it has been defined by the user. If that
option is not selected, the report will contain only the list of message types included in the message
standard displayed (and no details from the deployment package).

Changing the mode of MT messages


When opening the details of an MT message, the message is initially opened in prompted mode.
You can change to fast mode by clicking Fast . The verifiable fields are shown as '####' and
operators with the relevant permission can re-enter values in these fields, which are then shown in
clear. After you have re-entered values in the verifiable fields in fast mode, you cannot return to
prompted mode. If data other than the verifiable fields is changed, the operation is denied.

17 December 2021 170


Alliance Access 7.6.20 Message Approval
Message Management Guide

Related information
Verify a FIN, APC, or MX Message on page 171

12.3 Verify a FIN, APC, or MX Message


Before you begin
See Permission checks for approving and rejecting messages on page 162.
Procedure
1. From the Message Approval menu, select Message Verification.
The Message Verification page appears with a list of messages available for verification. For
more information, see Message Verification Page on page 166.

Messages shown as reserved (that is, having a name in the Open By column) are already
open by other operators. This prevents concurrent updates because another operator cannot
open a reserved message.
2. If needed, filter the list of messages. For more information, see Filter a List of Messages in a
Queue on page 155.
3. Click the message that you want to verify.
The message editor displays the message as follows:
• Only some fields in the message body can be verified. Verifiable fields are empty.
Fields that require verification are highlighted in the colour selected for mandatory fields in
Preferences.
• Non-verifiable fields are displayed as originally entered, and you cannot change their
values.
• Optional fields that were empty in the original message no longer appear in the message.
4. Complete the verifiable fields with the same data as entered by the message creator.
If there are differences, then message verification fails and a Validation Report is generated
when routing or disposing the message. Try to provide the correct data again and route or
dispose the message.
You can toggle to fast mode by clicking the Fast button, which is located between the Validate
and Route buttons. The verifiable fields are shown as '####', and if you have the relevant
permission, you can re-enter values in them, which are then shown in clear. After you have re-
entered values in the verifiable fields in fast mode, you cannot return to prompted mode. If you
modify something else than the verifiable fields, the operation is denied.
Tip If you cannot correct the errors, then select one of the following:
• Select Text Modification beside Dispose to , to move the message and edit it
later.
• Click Reject , to route the message with an indication of failure.
5. Optionally, select the Comments tab and add your comment.

17 December 2021 171


Alliance Access 7.6.20 Message Approval
Message Management Guide

6. Next, take the appropriate action:

Button Action More information

Close Message Closes the message without saving the


changes.

Export Creates a report of the message. Report Types and Settings (Export
Function) on page 36

Validate Validates the message format Validate a Message and Correct


Errors on page 126

Route Routes a valid message according to the Route a Message on page 130
routing rules defined within Alliance Access
A notification message appears in the Status
area.

Reject The message is sent to the Text Modification Rejecting a message in the
queue by default, or to another routing queue verification queue enables you to
defined in the routing in Alliance Access. move syntactically incorrect MT or
MX messages that cannot be
Optionally, add a comment with more
handled in the verification queue
information for the rejection.
to the text modification queue.

Dispose to Sends the message to a queue that the Send a Message to a Queue
operator chooses: (Dispose to) on page 131
• Text Modification, where an operator can
fix the message
• Authorisation, sends the message to the
Authorisation queue
• Swift, sends the message to SWIFTNet
A notification message appears in the Status
area.

A confirmation appears to indicate that the message was successfully routed or disposed.
The list of messages for verification appears. Open another message to verify or select any
other task available.

12.4 Verify a FileAct Message


Prerequisites
To verify FileAct messages, your operator profile must have the following permission set: Mesg
Approval / Approval with the Can verify set to Yes. This permission allows you to validate or
reject a message.
To download or to preview a FileAct message, your operator profile must have the following
permission set: Message File / Open/Save File.

Procedure
For the steps to verify a FileAct message, see Verify a FIN, APC, or MX Message on page 171.

17 December 2021 172


Alliance Access 7.6.20 Message Approval
Message Management Guide

Note FileAct messages do not contain verifiable fields.

12.5 Message Authorisation Page


Overview
The Message Authorisation page displays a list of messages available for authorisation.

Page example

Filtering criteria area

Enables you to filter a list of messages according to various criteria. When


filtering for Correspondent or Reference, the use of the "%" wildcard is not
recommended, because the search results may not be as expected.
Enables you to filter a list of messages according to various criteria. For more
information, see Filter a List of Messages in a Queue on page 155

I/O Input or output message.


• I stands for input messages, that is, messages that were created for input to
the network.
• O stands for output messages, that is, messages that Alliance Access
received from the network.

Correspondent The receiver of the message.

Format The format of the message (for example, Swift or MX).

Identifier The message identifier that uniquely identifies the message type.

Suffix Value that helps identify the message.

Created by Name of the operator who created the message.

Modified by Name of the operator who last modified the message.

Reference A transaction reference number or a message user reference.

Match Case You can check the Match Case box to restrict entries in the results to the
messages matching the case used in the Reference field.

SLA ID Service Level Agreement (SLA) identifier in the MT header: field 111. This field
identifies the service type identifier that is used for services such as gpi.

UETR Unique end-to-end transaction reference in the MT header: field 121. This field
provides an end-to-end reference across a payment transaction.

17 December 2021 173


Alliance Access 7.6.20 Message Approval
Message Management Guide

Columns in the list

I/O Input or output message.


• I stands for input messages, that is, messages that were created for input to
the network.
• O stands for output messages, that is, messages that Alliance Access
received from the network.

Correspondent The receiver of the message.

Display Name Identifies the base or MyStandards standard assigned to the message

Identifier The message identifier that uniquely identifies the message type.

SLA ID The applicable service type identifier that is used for services such as gpi (field
111 in the MT header).

UETR An end-to-end reference across a payment transaction (field 121 in the MT


header).

Reference A transaction reference number or a message user reference.

Suffix Value that helps identify the message.

Open By Name of the operator who reserved the message, that is, who has already
opened it and is currently working on it.

In Queue Since Time when the message entered the queue.

Inst Type The message instance type (original, copy, notification).

Cur/Amt The currency code and amount of the transaction.

Value Date The date on which the transaction is to be completed.

Last Verify Name of the last operator who verified the message.

Last Change Name of the last operator who modified the message

Sender The sender of the message.

Additional columns not displayed by default


By default, the following columns are not displayed. To display a column, click Change View .

Inst Creator Name of the operator who created the message instance.

Inst Creation The creation date and time of the message instance.

Inst Last Modifier Name of the last operator who modified the message instance.

Inst Last Modification The date and time of the last modification of the message instance.

17 December 2021 174


Alliance Access 7.6.20 Message Approval
Message Management Guide

Format The format of the message (for example, Swift or MX).

Message The name of the message. For MT and MX messages, the Message
Description Description field contains the Display Name of the message type.

Network The network used to send messages (SWIFT or SWIFTNet).

Service Name The service that corresponds to the standard selected.

Unit The unit to which the message is assigned.

Dup from network A message that has been received with duplicate information from the
network.

Dup set locally A message that has been marked as duplicate locally (inside Alliance
Access) by a user

Interface detected A message that Alliance Access has identified as duplicate by means of
dup its duplicate detection mechanism.

Transaction The Transaction Reference Number (TRN) of FIN messages (usually field
Reference 20 of the message), and the MX keyword 1 of MX messages. This field is
left blank for File and proprietary messages.

Related Reference The Related Reference of FIN messages (usually field 21 of the
message), and the MX keyword 2 of MX messages. This field is left blank
for File and proprietary messages.

Usage Identifier The RequestSubType of the MX message, which contains an identification


of the validation expected to be performed by sender, receiver and SWIFT,
if Message Validation (MVal) applies.

12.6 Message Authorisation


Overview
During authorisation, you open the message and visually inspect it to confirm that the message
content is accurate.
You can authorise a group of messages without viewing their content.
During authorisation, if you notice that some data needs to change, then you can move the
message to the Text Modification queue for editing. It is not possible to modify the content of a
message during its authorisation.
The permissions in your operator profile may allow you to authorise messages without viewing their
content. In this case, you can route those messages from the authorisation queue using Authorise .
Your permissions may not allow you to authorise a certain amount or currency, depending on the
first occurrence of the amount or currency. Keywords are always extracted from their first
occurrence. In the case of repetitive sub-sequences, only the value of the first occurrence is taken
into account.
Authorised messages can be routed or disposed, depending on your Alliance Access operator
profile permissions.

17 December 2021 175


Alliance Access 7.6.20 Message Approval
Message Management Guide

You can also open a message and reject it using Reject . To reject a group of messages without
viewing their content, you require the Mesg Approval, Approve message, Can verify, Group
authorise permission/permission detail. On the other hand, to reject a single message, this
permission detail is not required.
Note If No validation is defined in the Reception parameters of a message partner
profile, then the list of messages in the Message Authorisation page may include
messages that your operator profile forbids based on certain keywords. For example,
if you are limited to an amount of N, messages with amounts greater than N may
appear in the list of messages. This happens because keywords are not extracted
from the message when the validation level is No validation.

Different versions of the message standards


If a message schema was changed between the creation of the message and its authorisation,
then errors may be detected and displayed when opening this message. In such a case, you must
dispose the message to the Text Modification queue so that errors can be corrected.
A message schema might also be removed between the creation of the message and opening it for
authorisation. In this case, the message opened using fast mode. An error message alerts you that
the message description could not be found. For more information about using fast mode, see Fast
Mode on page 123.

12.7 Authorise a Message


Before you begin
See Permission checks for approving and rejecting messages on page 162.
To view the content of the Payload tab, an operator must have the Message File / Open/Save File
permission.
For File messages, to have access to the option Save File , an operator must have the Message
File / Open/Save File.
Procedure
1. From the Approval menu, select Message Authorisation.
The Message Authorisation page appears with a list of messages available for authorisation.

The list shows various attributes for each message. For a description of these attributes, see
Message Authorisation Page on page 173.
Messages shown as reserved (that is, having a name in the Open By column) are already
open by other operators. To prevent concurrent updates, any other operator cannot open a
reserved message.
2. If needed, refine the list using filtering criteria. For more information, see Filter a List of
Messages in a Queue on page 155.

17 December 2021 176


Alliance Access 7.6.20 Message Approval
Message Management Guide

3. Do you want to view the message before you authorise or reject it? Choose the appropriate
step:
• Yes: go to Step 5 on page 177
• No: go to Step 4 on page 177
4. Select the checkbox of the left of the message or messages, in the Message Authorisation
page.
Choose the appropriate action:
• Click Authorise .
A confirmation window appears. Click OK to authorise the message.
A message appears in the Status area to confirm that the message was successfully routed.
• Click Reject . The message is sent to the Text Modification queue by default, or to another
routing queue defined in the routing in Alliance Access.
The Message Authorisation page appears with the list of messages. Open another message
to authorise, and repeat this procedure, or select another task.
5. Click the message to view the message details. Review the content of the message and verify
that the data is correct.
The message editor displays the message.
Select the Payload tab to partially display the content of the file payload. Click Save File to save
the content.

If the message has validation errors then the Validation Report appears. For more
information, see Validate a Message and Correct Errors on page 126.
6. To view the body of the message in fast mode, click Fast .
The body of the message appears in fast mode.
To return to prompted mode, click Prompted .
7. Optionally, click the Comments tab and add your comment.

17 December 2021 177


Alliance Access 7.6.20 Message Approval
Message Management Guide

8. Next, take the appropriate action. You authorise a valid message if you route it or if you dispose
it to the Swift queue.

Button Action More information

Close Message Closes the message.

Export Creates a report of the message. Report Types and Settings (Export
Function) on page 36

Validate Validates the message format. Validate does Validate a Message and Correct
not appear if you are in fast mode. Errors on page 126

Fast / Prompted View the body of an MT or MX message in Step 6 on page 177


fast mode or prompted mode.
Fast Mode on page 123

Route This button authorises the valid message Route a Message on page 130
and routes it according to the routing rules
defined within Alliance Access.

Reject The message is sent to the Text


Modification queue by default, or to another
routing queue defined in the routing in
Alliance Access.
Optionally, add a comment with more
information for the rejection.

Dispose to Sends the message to a queue that you Send a Message to a Queue
choose. You authorise the message if you (Dispose to) on page 131
dispose the message to Swift.
• Text Modification, where an
operator can fix the message
• Swift, sends the message to SWIFTNet
A notification message appears in the Status
area.

12.8 Message Recovery Page


Overview
The Message Recovery page displays the messages that are placed in the recovery investigation
queue after one of the following recovery processes:
• Cold start recovery
• SWIFTNet recovery
• Disaster site recovery

17 December 2021 178


Alliance Access 7.6.20 Message Approval
Message Management Guide

Page example

Filtering criteria area

Enables you to filter a list of messages according to various criteria. When


filtering for Correspondent or Reference, the use of the "%" wildcard is not
recommended, because the filter results may not be as expected.

I/O Input or output message.


• I stands for input messages, that is, messages that were created for input
to the network.
• O stands for output messages, that is, messages that Alliance Access
received from the network.

Correspondent The receiver of the message. The wild cards % and _ are accepted.

Format The format of the message (for example, Swift).

Identifier The message identifier that uniquely identifies the message type.

Suffix Value that helps identify the message.

Created by Name of the operator who created the message.

Modified by Name of the operator who last modified the message.

Reference A transaction reference number or a message user reference.

Match Case You can check the Match Case box to restrict entries in the results to the
messages matching the case used in the Reference field.

From BIC Enables you to enter a BIC. The wild cards % and _ are accepted.

Service Suggests values for all Store-and-Forward/Interact/FileAct services that are


marked as visible in the ASP. By default, the field is empty. If the field is empty,
the messages that are returned are those messages that meet the other
filtering criteria (regardless of their service). This criterion is only applicable to
non-FIN messages.

FINCopy Service Suggests values of the FIN Copy services from the FIN Copy Alliance Access
table or 'None'. By default, the field is left empty. If the field is empty, the
messages that are returned are those messages that meet the other filtering
criteria (regardless of whether they are for a FIN Copy service). If the field is
set to 'None', then only messages for non-FIN Copy services are returned.
This criterion is only applicable to FIN messages.

17 December 2021 179


Alliance Access 7.6.20 Message Approval
Message Management Guide

SLA ID Service Level Agreement (SLA) identifier in the MT header: field 111. This field
identifies the service type identifier that is used for services such as gpi.

UETR Unique end-to-end transaction reference in the MT header: field 121. This field
provides an end-to-end reference across a payment transaction.

Columns in the list

I/O Input or output message.


• I stands for input messages, that is, messages that were created for input to
the network.
• O stands for output messages, that is, messages that Alliance Access
received from the network.

Correspondent The receiver of the message.

Identifier The message identifier that uniquely identifies the message type.

SLA ID The applicable service type identifier that is used for services such as gpi.(field
111 in the MT header).

UETR An end-to-end reference across a payment transaction (field 121 in the MT


header).

Reference A transaction reference number or a message user reference.

Suffix Value that helps identify the message.

In Queue Since Time when the message entered the queue.

Open By Name of the operator who reserved the message, that is, who has already
opened it and is currently working on it.

Inst Type The message instance type (original, copy, notification).

Cur/Amt The currency code and amount of the transaction (for FIN messages only).

Value Date The date on which the transaction is to be completed (for FIN messages only).

Last Change Name of the last operator who modified the message

Last Verify Name of the last operator who verified the message.

Sender The sender of the message.

Original Queue This value is populated only for disaster recovery.

Additional columns
The columns that follow can also be shown in the list using Change View :

Inst Creator Name of the operator who created the message instance.

17 December 2021 180


Alliance Access 7.6.20 Message Approval
Message Management Guide

Inst Creation The creation date and time of the message instance.

Inst Last Modifier Name of the last operator who modified the message instance.

Inst Last Modification The date and time of the last modification of the message instance.

Format The format of the message (for example, Swift).

Message Description The name of the message. For MT and MX messages, the Message
Description field contains the Display Name of the message type.

Network The network used to send messages (SWIFT).

Service Name The service that corresponds to the standard selected.

Unit The unit to which the message is assigned.

ACK/NAK Reception The date and time of the receipt of the notification instance (ACK/NAK),
Date/Time in GMT.

SnF Input Time The store-and-forward input time, if this delivery mode was used.

Usage Identifier The RequestSubType of the MX message, which contains an


identification of the validation expected to be performed by sender,
receiver and SWIFT, if Message Validation (MVal) applies.

12.9 Recover Messages


Overview
During message recovery, you can recover FIN, InterAct, or FileAct messages following cold start,
SWIFTNet, or disaster site recovery.
It is not possible to modify the content of a message during message recovery.
You can route, complete message instances, or move a message instance back to the original
queue in the context of disaster recovery. When a message is sent to SWIFT by Alliance Access,
its status changes to "Completed" (that is, it is no longer in any queue). In case of disaster, if a
certain set of messages could not be processed by the network, Alliance Access moves these
messages to the recovery queue. However, if a message was in the meantime reactivated
manually to queue XYZ, then the recovery procedure moves the message to the recovery queue
with the Original Queue field set to queue XYZ.
Note If the message schema has been removed between the creation of the message and
opening it during message recovery, then the message will be opened using fast
mode. An error message alerts you that the message description could not be found.
Note Messages listed in the recovery queue are retrieved according to priority although
priority is not a field that is visible for messages in the list. System messages are
presented first, followed by urgent priority messages and then by normal priority
messages.

17 December 2021 181


Alliance Access 7.6.20 Message Approval
Message Management Guide

Support for mass operations


You can authorise, complete, reject, and move to the original queue all messages that meet the
filtering criteria (regardless of whether there is enough space to display them all on the screen)
without having to select each individual message. When an operation is executed on all messages
meeting the filtering criteria, it is called a mass operation.
Mass operations are requested by means of the same buttons and require the same permissions
as when performed on a selection of messages. It is assumed that a mass operation is required
when you click Authorise , Complete , Reject , or Move to original without selecting any messages in the
list. You are then prompted to confirm that the operation can be executed on all messages meeting
the filtering criteria, or to cancel and select messages for a normal authorise, complete, reject, or
move to original operation.
Conversely, when you click Authorise , Complete , Reject , or Move to original and have selected
messages in the list of messages, you are prompted to confirm the operation or to click Cancel to
de-select all of the messages and restart the operation.
These same actions are available in the Message Details view.

12.9.1 Recover a Message


Before you begin
The Complete operation requires the operator to have the Mesg Approval, Treat Recovered Msg,
Own destination permission. This permission check is similar to the one performed for the
Move to Original operation.

See Permission checks for approving and rejecting messages on page 162.
Procedure
1. From the Approval menu, select Message Recovery.
The Message Recovery page appears with a list of messages in the recovery queue. For
more information, see Message Recovery Page on page 178.
Messages shown as reserved (that is, having a name in the Open By column) are already
open by other operators. To prevent concurrent updates, any other operator cannot open a
reserved message.
2. If needed, refine the list using filtering criteria. For more information, see Filter a List of
Messages in a Queue on page 155.
3. Click the message that you want to view.
The message editor displays the message:
• Optional fields that were left blank in the original message no longer appear.
• Fields that contain information are displayed as originally entered, but the content cannot be
changed.
4. You can generate a report of the message. Click Export . For more information about generating
a report, see Report Types and Settings (Export Function) on page 36.
5. Review the message to ensure that it is correct.
Choose the appropriate action:
• Click Route to send the message instance directly to the appropriate network input queue.
• Click Complete to complete the message instance. For more information, see Message
Instances on page 230.

17 December 2021 182


Alliance Access 7.6.20 Message Approval
Message Management Guide

• For disaster site recovery


Click Move to Original if the original queue is defined. The message is moved to the original
queue.
A status window briefly appears that confirms the message was successfully routed. To view
the content of this window again after it closes, click Status .
Note You may click Close Message without taking any action. The message remains in
the recovery queue and you or another operator can route or complete it later.
6. Open another message to route or select any other task available.

12.9.2 Route Messages without Viewing Content


Before you begin
The Complete operation requires the operator to have the Mesg Approval, Treat Recovered Msg,
Own destination permission. This permission check is similar to the one performed for the
Move to Original operation.

Procedure
1. From the Approval menu, select Message Recovery.
The Message Recovery page appears with a list of messages in the recovery queue. For
more information, see Message Recovery Page on page 178.
Messages shown as reserved (that is, having a name in the Open By column) are already
open by other operators. To prevent concurrent updates, any other operator cannot open a
reserved message.
2. If needed, refine the list using filtering criteria. For more information, see Filter a List of
Messages in a Queue on page 155.
3. Select the relevant message or messages by checking the box on their left. You can then
perform one of the following actions:
• Click Authorise to send the message instance directly to the addressee through appropriate
network input queue.
• Click Reject .

CAUTION In Message Recovery, if you click Reject , then the message instance is also
sent directly to addressee through the appropriate network input queue . If you
want to change this behaviour, then you must modify the routing rules in
Alliance Access .

• Click Complete to complete the message instance. For more information, see Message
Instances on page 230.
• For disaster site recovery
Click Move to Original if the original queue is defined. The message is moved to the original
queue.
A status window briefly appears that confirms the message was successfully routed. To view
the content of this window again after it closes, click Status .

17 December 2021 183


Alliance Access 7.6.20 Message Approval
Message Management Guide

12.10 InterAct and FileAct Retrieval


Reception of InterAct and FileAct retrieved messages and files
Alliance Access (including a T-copy or Y-copy CID Alliance Access) receives the retrieved InterAct
and FileAct messages through the store-and-forward queues. The original message or file may be
an input message/file or an output message/file.

Retrieval process
1. The user sends an xsys.015.001.01 or xsys.015.001.02 Retrieval Request, which specifies the
retrieval criteria and the store-and-forward queue to which the retrieved messages or files and
optional Retrieval Report are to be queued. The user can also make a manual retrieval request
outside of Alliance Access, using SWIFTNet Online Operations Manager.
xsys.015.001.02 is used for InterAct and FileAct retrievals. xsys.015.001.02 contains an
element to specify the scope of the retrieval: FILE, MESG, or ALLL
A single xsys.015.001.01 or xsys.015.001.02 Retrieval Request can retrieve a range of
SWIFTNet messages or files sent or received in a given 24-hour period. If retrievals are
needed over a longer period of time, then multiple retrieval requests must be sent.
2. SWIFTNet store-and-forward processes the Retrieval Request. Retrieved messages and files
are queued to the queue specified in the Retrieval Request.
Note Retrieval Requests are not always processed immediately. Some time may elapse
between when the Retrieval Request is sent, and the availability of the retrieved
messages and files.
3. If the optional Retrieval Report has also been requested, then SWIFTNet store-and-forward
queues the xsys.016.001.01 Retrieval Report to the specified queue.

InterAct and FileAct retrieved message/file processing


As opposed to FIN retrieved messages that are always sent by SWIFT to Alliance Access in an MT
021 envelope instead of being sent directly, InterAct retrieved messages are sent by SWIFTNet to
Alliance Access directly (that is, not enveloped in any other message). As a result, the Retrieved
message extract global security configuration parameter value has no effect on the processing of
InterAct retrieved messages received from SWIFTNet.
Alliance Access can distinguish between an InterAct/FileAct retrieved message or file and a normal
message based on the presence of the Sw:RetrievedDescriptor in the InterAct/FileAct message
retrieval. The Sw:RetrievalDescriptor contains information about the Acknowledgement, as well as
elements from the SwInt:RequestControl of the original message or Sw:FileRequestControl of
the original file.
Regardless of whether the message/file to be retrieved was an input or an output message/file, the
message actually retrieved is an output message/file and Alliance Access processes it, routes it,
and stores it in the database as any other output message/file. The RetrievalInfo field shows if the
original message/file was an input or an output message/file.
Note If the Sw:RetrievedDescriptor is present (indicating a retrieval message), then
Alliance Access checks the original direction of the message in the
Sw:RetrievalDirection element of the Sw:RetrievalInfo block.

If the Retrieval direction is input, then Alliance Access applies the own destination
permission on the sender of the message.
If the Retrieval direction is output, then Alliance Access applies the own destination
permission check on the receiver of the message.

17 December 2021 184


Alliance Access 7.6.20 Message Approval
Message Management Guide

Retrieved_message routing keyword


As part of the support of InterAct and FileAct retrievals by Alliance Access, a routing keyword
Retrieved_message can be used for FIN and InterAct messages, and FileAct files. It contains the
Mesg_is_retrieved message field.

RBAC roles required


The RBAC role swift.snf.system/OnLineRetriever is required by an Authorisation DN for it to
send InterAct retrieval requests (xsys.015.001.01) and InterAct and FileAct retrieval requests (xsys.
015.001.02).
SWIFT automatically provides this role to all institutions, so that security officers can grant the role
to their users.

Retrieval of FileAct store-and-forward files

17 December 2021 185


Alliance Access 7.6.20 RMA Central SWIFTNet Database: Negative Acknowledgement
Message Management Guide

13 RMA Central SWIFTNet Database: Negative


Acknowledgement
SWIFT validates FIN and FINplus traffic exchanged by customers against a RMA central
SWIFTNet database. If the authorisation has the status rejected, expired, or does not exist, then
any FIN or FINplus messages sent to a correspondent will be rejected centrally.
For more information, see the RMA Service Operations Guide.
An outgoing (input) FIN or FINplus message will be NAKed (Negative Acknowledgement) by the
RMA central database as follows:

Error code Reason

For FIN messages: The authorisation has been revoked.


H53

For FINplus messages:


SwReq.RMARevoked

For FIN messages: The authorisation:


H54 • does not exist
• has been rejected
For FINplus messages:
• has expired
SwReq.RMANotAuthorised

How Alliance Access processes the messages


Alliance Access does the following if a message is NAKed as described above:
• sets the RMA Check to "No RMA Record"
• for FIN messages: adds the NAK code in the message appendix
• for FINplus messages: adds "The Message did not pass the RMA Central Check" to the
ACK/NAK text
• creates an intervention with the text Authorisation not present
• routes the message by default to the Emission Security Modification queue with the result No
RMA record
The Validation Report tab for the message in the Emission Security Modification queue displays a
warning with information about the Negative Acknowledgement.

17 December 2021 186


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

14 Message Search and Report


Introduction
You can query the Alliance Access message file using search criteria to find specific messages,
based on business needs. For example, you may need to check whether an urgent message was
sent or received. You can then open a message and view extensive details about it and its
instances. Instances can be completed, reactivated, moved to a specific routing point, change the
priority, or reassigned to a different unit. You can create message search criteria templates for
searches that you make on a regular basis.
When searching for messages, you can always generate a report of any selected messages (see
Generate a Report of Messages from Search Results on page 259). In addition to generating a
report of selected messages, Alliance Message Management allows you to generate a report of
messages that match criteria that you provide. You can choose to include message details or
message summary information in the report. A count report is available to show the total number of
entries that match the criteria, along with the values provided as criteria. Alliance Message
Management also offers a simple report that lists the number of messages in each queue of
Alliance Access.
The content available on the search results page depends on the search criteria provided and on
the operator profile permissions. The resulting list may include messages or message templates,
depending on the source searched. You can also search directly for message instances.
The actions that you can perform on messages and message instances depend on the permissions
defined in your Alliance Access operator profile.
Tip Internal delivery notifications for MX and File messages are created with the receiver
XXXXXXXXXXX.
Operators cannot view these messages if their access is restricted to certain BICs
only.
In such cases, it is recommended to install the SWIFTNet 7 - System Messages
deployment package and configure the delivery notifications as system messages.

Manual FileAct search and monitor


Message Search also allows you to save the payload files to a local directory. This option is
available for all sent file messages and received file messages. For more information, see File tab
(File messages only) on page 202 and Download a File Manually on page 146.
File Transfer Monitoring allows you to search, view, and monitor all file transfers and file message
details. This command also allows you to save the payload files on a local directory. For more
information, see File Transfer Monitoring on page 242.

14.1 Searching for Messages, Instances, and Templates


In Alliance Message Management, you can search for messages, message instances, and
message templates.
This topic summarises the different search criteria options and the actions that can be performed
on the search results.
Different search criteria options exist to search for messages, including the ID & Content, the
Source and Creation, the Transmissions, and the Units tabs (see Specify Search Criteria on
page 209).

17 December 2021 187


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

To search for instances and templates, you must first specify the search type in the Source and
Creation tab.
When searching for messages and instances in the Source and Creation tab, you can also refine
your search in the Instances Location tab.
When you click on a row in the search results list, the Message Details page opens (see Message
Details Page on page 197). Depending on what you are searching for, a series of actions can be
taken on the search result.

17 December 2021 188


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

I am searching for Search criteria options Actions that can be taken Actions that can be taken
from the search results list on a search result

Messages Search by ID and Content on page • Change View You can take the following
210 actions within all tabs in the
• Sorting
Message Details:
Search by Source and Creation on • Export
page 223(1) • Export
• Print
Search by Instances Location on • Print
page 227 • Add as: create a new
Search by Transmission Details on message from an existing
page 225 one

Search by Units on page 228 • Find Related: displays the


following:
- details for an MX
message
- For MT 103s, Alliance
Access finds the
related MT199 (based
on the shared UETR)
that contains the
confirmation for the MT
103.
If you open the
MT199 , then it will
also find the related
MT103.
Within the Instances tab, you
can take the following actions
(based on your operator
profile and the state of the
instance):
• Complete
• Move to
• Re-assign
• Re-activate
• Cancel Emission
• Change Expiry Date Time
• Instance Export
• Instance Print
• Change Priority
For more information, see
View Message Instance
Details on page 205.

17 December 2021 189


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

I am searching for Search criteria options Actions that can be taken Actions that can be taken
from the search results list on a search result

Instances Search by Source and Creation on Based on your operator profile You can take the following
page 223(2) and the state of the instance, actions within all tabs in the
you can take the following Message Details:
Depending on the state of the
actions:
instance (Live, Completed, or • Export
Reserved), you can refine your • Change View
• Print
search in the following tabs: • Sorting
• Find Related: displays the
Search by ID and Content on page • Refresh following:
210
• Change Priority - details for an MX
Search by Instances Location on message
page 227 • Re-assign
• Re-activate (if it was - For MT 103s, Alliance
completed in the detail Access finds the
Instance tab) related MT199 (based
on the shared UETR)
• Complete that contains the
• Move to confirmation for the
MT103.
• Cancel Emission
If you open the
• Change Expiry Date Time MT199 , then it will
• Instance Export also find the related
MT103.
• Instance Print
For more information, see
Message Instances on page
230.

Templates Search by Source and Creation on • Change View You can take the following
page 223(3) actions within all tabs in the
• Sorting
Message Details:
Refine your search for templates • Export
in the following tab: • Export
• Print
Search by ID and Content on page • Print
210
Within the Instances tab, you
also take the following
actions:
• Change View
• Re-assign
• Instance Export
• Instance Print

(1) Search Type=Messages


(2) Search Type=Instances
(3) Search Type=Templates

14.2 Message Search


This section describes how to search for messages and view message details.

17 December 2021 190


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

14.2.1 Search for Messages


Procedure
1. From the Search and Report menu, select Message Search.
The Message Search page appears with the Source & Creation tab open by default.

2. Specify search criteria by completing the fields as needed. See Specify Search Criteria on
page 209 for details. You can also use a search criteria template to perform a message search.
See Save Search Criteria as Template on page 228 for details.
Provide search criteria as needed so that the messages returned are a useful subset.
Search criteria that you specify remain until you change or clear the information, which allows
you to refresh the list without having to re-key criteria. Click Clear if you want to remove the
criteria previously provided and enter new criteria.
Click Export (next to Search ) in the Message Search Criteria to generate a report of
messages matching the search criteria that you entered. You are advised to generate a Count
report because this report function includes all messages in the Alliance Message
Management, see Generate a Message Count Report on page 261 for details.
If you have the Message File, Count permission, click Count (next to Search ) in the Message
Search Criteria to display in a pop-up the number of messages meeting the search criteria.
The associated search results are not displayed. The messages that are counted are filtered
based on your Message File, Count permission details.

CAUTION If you do not provide search criteria, then you will not easily find what you are
looking for. The server will only fetch a limited number of records (that is, enough
to show a first page of results).

Validation of date fields


3. Use the date picker to choose a date: If you manually type a date in the From Date and To
Date fields, then Alliance Access validates the length and format and removes the additional
characters (maximum 10 characters). See Behaviour and Format of Date and Time Fields on
page 26 and Date Picker on page 28.
4. Click Search . While messages are being added to the list, the text Please wait may appear.
The search results appear with the list of messages that meet your search criteria. If a search
returns no results, then a message is displayed that indicates that no results match the current
criteria.
The total number of messages matching the search criteria is displayed next to Rows in list in
the list. This total is computed or refreshed only when you click Search . Otherwise, it is not
automatically refreshed at regular intervals. If the number of messages matching the search
criteria is above 10.000 occurrences, in order to avoid a degradation of performance, Alliance
Access stops counting and displays the link Total: More than 10.000 in the top menu, instead
of the counting result. If you select this link, the full counting function is resumed.

17 December 2021 191


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Use Previous and Next, if necessary, to navigate through the pages of the complete list.
Click Change View to select the number of rows displayed.
You can use the check boxes to select the messages for which you want to generate a report of
the message details, or the message summary. You then click Export to generate a report. See
Generate a Report of Messages from Search Results on page 259 to select and generate a
report of one or more messages from this page.

For MX messages, the Reference column is populated with the content of the RequestRef
field. This field is extracted from MX keyword 2 in the MX System Messages Deployment
Package, for the following MX system messages:
• xsys.002.001.01
• xsys.003.001.01
• xsys.010.001.01
• xsys.010.001.02
• xsys.011.001.01
• xsys.011.001.02
• xsys.012.001.01
• xsys.012.001.02
5. Click a message in the list to open it and view its details. The Message Details page appears
with the Header tab open by default. For a description of that page, see Message Details Page
on page 197.
You can generate a report of the message details, or the message summary by clicking Export .
See Generate a Report of Messages from Search Results on page 259 to select and generate
a report of one or more messages from this page.
6. To save a payload file for a File message, click the File tab then click Save File . Your operator
profile must have the following permission set: Message File / Open/Save File.
Note Save File is only available if at least one instance of the message has a unit in
common with the units assigned to your operator profile.
7. Take one of the following actions.
• Click Previous or Next to go directly to the previous or next message in the list without
closing the message currently displayed.
• Click Search Results (located between Previous and Next) or Close to go back to the list
of messages.

14.2.2 The Message Search Window


When you run a message search, to customise the columns of data that are displayed, click
Change View . In the dialog box, select the check box next to a column to show it. You can also click

17 December 2021 192


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

the column name and use the arrows to change its position in your search results. Click OK to
save your view.

Change View dialog box for messages

Columns of data available for display

SUMID System generated unique identifier of a message

I/O Specifies the direction of message flow:


• I - The message was created as input to a network, such as SWIFT.
Alliance Access sends the message.
• O - The message was output from a network, such as SWIFT. Alliance
Access receives this message.

Correspondent The BIC-11 address of the correspondent

Identifier Identifies the type of message

Usage Identifier The RequestSubType of the MX message, which contains an identification


of the validation expected to be performed by sender, receiver and SWIFT,
if Message Validation (MVal) applies.

Mesg Description A description of the message. For MT and MX messages, the Message
Description field contains the Display Name of the message type.

SLA ID The service type identifier (field 111 in the MT header) that is used for
services such as SWIFT gpi.

17 December 2021 193


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Reference Message Value in the Reference field


Format

MT The Reference field contains one of the following:


• Transaction reference number, which is located in field 20 of
the MT message
• Message user reference, which is located in the SWIFT user
header

MX A user reference

other formats The number from the header or message text

MUR Message User Reference extracted from the User Header in block 3 of a
FIN message

UETR An end-to-end reference across a payment transaction (field 121 in the MT


header). For more information, see UETR and SLA ID Fields in Alliance
Access on page 41.

Transaction Contains the Transaction Reference Number (TRN) of FIN messages


Reference (usually field 20 of the message), and the MX keyword 1 of MX messages.
This field is left blank for File and proprietary messages.

Related Reference Contains the Related Reference of FIN messages (usually field 21 of an
MT message), and the MX keyword 2 of MX messages. This field is left
blank for File and proprietary messages.

Suffix A system generated value intended to make the UMID unique. The first
part is the creation date of the message in YYMMDD format, a six-digit
number. The second part consists of a number (1 to 10 digits) that the
system generates. This number is incremental and unique for all
messages.

Value Date The date on which funds are credited or debited to or from the receiver's
account.
The field is extracted based on the deployment package that is loaded for
the message/service combination.
Alliance Access only displays the value of the Value Date field if you are a
member of a unit to which at least one of the message instances is
assigned. If this requirement is not met, then the value has asterisks
(*****), and if you produce a message details report, the value is not
printed. For more information about assigning units, see the Configuration
Guide.
The Value Date field is not populated when the message is coming from a
message partner where No validation level is used.

Cur/Amt The financial amount prefixed by a currency code.


The field is extracted based on the deployment package that is loaded for
the message/service combination.

17 December 2021 194


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Messages that are assigned to a unit to which you belong are displayed
first.
Messages without currency/amount are shown before those with currency/
amount.
Alliance Access only displays the value of the Currency/Amount field if
you are a member of a unit to which at least one of the message instances
is assigned. If this requirement is not met, then the value has asterisks
("*****"), and if you produce a message details report, the value is not
printed. For more information about assigning units, see the Configuration
Guide.
The Currency/Amount field is not populated when the message is coming
from a message partner where No validation level is used.

Format/Status The message format and current processing state of the message. For
example, a message may be in SWIFT format with a status of "live", which
means the message has one or more instances undergoing or awaiting
processing. Alternatively, a message can have a status of "complete",
which means that all instances have been processed.

Translation Result The result of the message translation:


• Success: the translation of the ISO 20022 message was successful.
• Truncation Non Ref: truncation or character replacement occurred in
non-reference fields.
• Truncation Ref: truncation or character replacement occurred in
reference fields.
• Failure: translation was bypassed (the ISO 20022 message fails a
minimum check).
• Partial: partial success where the resulting MT is fully translated but
not all elements of the ISO 20022 message are in the translated MT.
This can happen when no applicable fields exist in the MT.
• Other: if an unknown translation code is received from the translation
service, then Alliance Access maps it to the pseudo code Other.

Transaction Data The code that indicates the completeness of the generated message by
Result the transaction manager at SWIFT based on the central transaction data.
• Success: the translation of the ISO 20022 message was successful.
• Partial
• Truncation Non Ref: truncation or character replacement occurred in
non-reference fields.
• Truncation Ref: truncation or character replacement occurred in
reference fields.

Secondary Format • SWIFT


• MX
• AnyXML

17 December 2021 195


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Netw. Status The network processing result of the last transmission. The data for this
field is taken from the information contained in the last transmission
intervention attached to the corresponding message instance. To see the
transmission result of previous networks, use the Transmission tab to
search for messages based on details of their transmission interventions.
For more information, see Search by Transmission Details on page 225.

Netw. Status The timestamp of the network ACK or NAK in GMT for FIN and MX
Timestamp (GMT) messages. This is the same value as provided on the Message Details
page, History tab.

Orig Inst RP The queue or routing point in Alliance Access where the original instance
of the message is located. If the original instance has been completed,
then no routing point appears.

Dup from Network A message that has been received with duplicate information from the
network

Dup Set Locally A message that has been marked as duplicate locally (inside Alliance
Access) by a user

Interface Detected A message that Alliance Access has identified as duplicate by means of its
Dup duplicate detection mechanism

Mesg Creation The date and time when the message was created

Service Name SWIFTNet service

Emission Info The network name, session number, and sequence number of the last
emission appendix of the original message instance have the following
format:
<network name><session number><sequence number>

Reception Info The network name, session number, and sequence number of the last
reception appendix of the original message instance. It has the format:
<network name><session number><sequence number>

Sender/Receiver The BIC-11 address of the sender, and receiver of the message

Requestor DN The distinguished name of the sender

Responder DN The distinguished name of the correspondent to which the message is


transferred (also called the receiver).

Location Location of the message (database or archive). The name of an archive is


shown as a date, the format of which is specified in the System
Management application.

Validation Flag Message User Group

Logical File Name The value of SwLogicalName which is part of the AckMessage sent to
SWIFT by Alliance Access when it receives a file.

17 December 2021 196


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

MX Keyword 1 First keyword for an MX message (if present)

MX Keyword 2 Second keyword for an MX message (if present)

MX Keyword 3 Third keyword for an MX message (if present)

Payments Control
Info For Receiver

Payment Status Contains the value of the Payment Confirmation Status : Empty (no
payment confirmation status), Accepted, Pending, Rejected, Returned, or
Invalid. If you select None, then Alliance Access lists all messages without
a confirmation status.

Sorting search results


In the Message Search GUI, the search criteria or the sorting option are applied by means of a
contextual menu that is displayed by clicking the sortable columns headers or by clicking the
Sorting button. This contextual menu enables you to perform ascending or descending sorting and
to define nested sorting (up to three levels deep) on most of the available columns.
The nested sorting determines the order in which the results of a search are made available to the
GUI in the list of messages/instances. For example, if Mesg Creation, Identifier, and Service
Name are selected (in that order), the messages/instances will be sorted first by Mesg Creation,
then by Identifier, and then by Service Name.
The sorting selected on the table header applies to all messages or messages instances and is not
limited to the subset of results displayed in the GUI page.
While sorting, you can click Abort to cancel the ongoing sorting action. In this case, no results are
returned.
Note The default sorting for message and instance searches is based on Mesg Creation.
You receive an error message when you attempt to sort an unsortable column, such
as Mesg Description or Suffix.
During a search, if some fields are returned empty and need to be sorted on, The
empty values are displayed at the beginning of the returned list. The empty values
include: null values (for optional fields), empty string values (for mandatory string
fields), or 0 values (for mandatory numeric fields).

14.2.3 Message Details Page


Overview
The Message Details page enables you to view extensive details about retrieved messages and
their instances.

17 December 2021 197


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Page example

Message Details page for a FIN message

17 December 2021 198


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Message Details page for an MX message

Message Details for multi-format messages

17 December 2021 199


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Message Details page for a File message

Page description

Header tab Contains information about the message header.

17 December 2021 200


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

For multi-format messages, indicates the primary and secondary format, the
translation result, and the translation result details (in case of errors).
For MX messages, the Usage Identifier field displays the RequestSubType.
For messages generated by the transaction manager, the code that indicates
the completeness of the message is displayed along with the Transaction data
version.
For subscribers to Transaction Screening, Sanctions compliance - Message
blocked indicates that the Transaction Screening service has flagged the MX
message instance as a true hit. The header also contains the field Transaction
Screening Info for Receiver provides information from the Transaction
Screening service about the decision on the screened message. Only applicable
to output messages.
For subscribers to Sanctions Screening, Sanctions compliance - Message
blocked indicates that Sanctions Screening or Transaction Screening has
flagged the MT message instance as a true hit. For more information about
configuration for Sanctions Screening, see the Configuration Guide.
You can display help for MX keywords of a message that is opened from
searching (see Help for Messages on page 64).

Sender/ Contains details of the sender and the receiver of the message.
Receiver tab
When you click Show Recipients in the Recipients field, the list of recipient
DNs to which a message or file is distributed is displayed. It also indicates
whether the list can be made public to all recipients. On the reception side, the
field Public Recipients List is always set to No. However, the list of recipient
DNs is displayed. This field is not applicable for FIN messages.

Text tab (not Displays the content of the message body.


applicable for
The text of a message can be displayed in either normal or expanded format,
File messages)
provided the corresponding message standards are installed in Alliance
Message Management. Expanded format provides descriptive names for each
field. To use this option, check the Display expanded text box (default).
Display expanded text does not appear if the corresponding message
standard is not installed.
The Display expanded text option selected by an operator when viewing the
Text tab details of a FIN/MX message in Message Search is automatically
saved. It is proposed as initial value when the same operator opens another
FIN/MX message details in Message Search.
Depending on the value of the configuration parameter FIN User Header in
Alliance Access, the Text tab can also show the contents of the FIN User
Header (block 3) of the message.
If you subscribe to Sanctions Screening, then block 3 contains Sanctions
Screening information. For more information about configuration for Sanctions
Screening, see the Configuration Guide.
IPLA messages may contain characters that are not compatible with the
expected syntax. To ensure that the message text is properly displayed, any
binary characters will be converted into their hexadecimal representation.

17 December 2021 201


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Response Text For MX messages sent using real-time delivery, the Response Text tab
tab (real-time contains a business response from the message receiver. The Display
MX AnyXML or expanded text option is also available on this tab. This option is only shown
other XML when Alliance Message Management was able to retrieve the message
messages sent definition of the response (Deployment Packageor Universal Standards Archive
only) (USA) package installed) and the response is valid according to its schema
definition.

File tab (File Shows the message details of File messages.


messages
Enables you to save the payload file with the Save File function. For more
only)
information, see Send a File Manually on page 139 and Download a File
Manually on page 146.

Payload tab Regardless of whether the message is stored compressed or uncompressed in


(File messages the Alliance Access database, this tab shows a text representation (UTF-8) or a
only) beautified XML view of the file message payload in uncompressed form. If the
size of the file is larger than 10 kilobytes, only the first 10 kilobytes of the file are
displayed.
To see the Payload tab and the save file function an operator must have the
permission Message File / Open/Save File.

History tab Shows the history of a message, which is derived from message interventions.
The message history is presented chronologically as individual paragraphs.
Starting with the original instance, each paragraph refers to a separate instance
associated with the message, such as copy or notification.
For MT, MX, and File messages, the History tab shows information related to
RMA checks along with the service and the result. For example, RMA Check
for service swift.fin with result Success.

For InterAct Partial Copy, the partial copy digest result for output messages is
displayed: Success, Failure, or Bypassed.
For multi-format messages (MX and MT), this tab shows Multi Format
Message Signed with result, following by the Translation Digest Result. This
information is not displayed if the translation failed.
The History tab shows only the final routing rule that was applied to the original
message.
For example, if a routing rule was applied to an original instance but without an
action defined to apply to the message, and then a second routing rule was
applied, then the history of the message does not include details of the first
routing rule.
If there are more than 50 appendices, then only the 25 first appendices and 25
last appendices are displayed. The same rule applies to interventions.
Alliance Access automatically displays the date and time for each event. To
remove the date and time, you can change the parameter Date/Time in Msg
History. See Message in the Alliance AccessConfiguration Guide.

Instances tab Shows all the instances, both live and complete, that were created for a
message.

17 December 2021 202


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

You can also cancel message instance emissions on this page. For more
information, see Cancel Message Instance Emissions on page 237

Other tab Contains further information about the message, including the following:
• For MT 103s: Payment Confirmation Status, Confirmed Amount,
Confirmed Currency, and Confirmed Date
These fields are displayed only if the Payment Confirmation Status
contains a value, that is when the payment has been confirmed to the
Tracker with an MT 199 or there is a CSV status update. If a payment has
not been confirmed by an MT 199 or a CSV, then these fields will not be
visible.
If the MT 199 sent to the Tracker is NAKed by the network, then the
Payment Confirmation Status information is emptied, and these fields are
not visible.
If the MT 199 is ACKed by the network, but it fails validation at the Tracker
level and the Tracker sends back an Alert MT 199, then the Payment
Confirmation Status is set to Invalid, Confirmed Amount and
Confirmed Currency are cleared, and the Confirmed Date is replaced by
the date included in the Alert MT 199 from the Tracker.
• The message priority
• The number of signatures required by the messageif the Enforce NRS Sign
global system security parameter is set to Yes
• For FIN and MX messages, the ACK/NAK Reception field displays the date
and time in GMT when the ACK or NAK was received from SWIFT or
SWIFTNet.
This tab also contains information related to emissions, such as:
• Expiry Date Time, which indicates the date and time after which Alliance
Access should stop attempting to send a real-time FileAct or InterAct
message to SWIFTNet, should the emission repeatedly fail until that date
and time. This information is applicable to input SWIFTNet messages only.
• Next Emission Date Time, which indicates the date and time before which
Alliance Access will not attempt to send a real-time FileAct or InterAct
message to SWIFTNet. This field provides information about the Alliance
Access retry logic only, which regularly recalculates the sending interval to
maximise the chance of sending the message successfully.
You can set an emission expiry date and time in either of the following ways:
• By setting an emission expiry date and time directly in each real-time FileAct
or InterAct message submitted to Alliance Access through a message
partner. In this case, the emission expiry date and time apply only to that
specific message. This is only possible through message partners whose
connection method is based on XMLv2.
• By defining an emission expiry time in the message partner. In this case, the
emission expiry time applies to a date and time to all real-time FileAct and
InterAct messages received from that message partner. The date and time
are calculated as follows: the absolute date and time of the message
creation in the database plus the value of the Emission Expiry field at the
message partner (which is a relative value in hours and/or minutes

17 December 2021 203


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

expressed as h, m). This is possible with all message partners, irrespective


of their connection method. The value from the File message has
precedence over the value set at the message partner level, when both are
present.
When it is up and running, the Alliance Access SNIS component checks every
five minutes if messages with an emission expiry date and time that are in the
_SI_to_SWIFTNet queue have expired. The expiry criterion is that the File
message emission expiry date and time is earlier than or equal to the current
date and time.
When a message is found to be expired, it is immediately rejected locally as if it
had been rejected by the network, and Alliance Access no longer attempts to
send it to SWIFTNet. The detailed process is as follows:
1. An emission appendix is created with:
• Network Delivery Status: Rejected Locally
• Session number: 0
• Sequence number: 0
• Session holder: expired
• The pseudo Network ACK/NAK text: T08 - Message expired
2. The function result is set to Failure.
3. The message is routed.
4. An intervention Message Expired is created for the message.
5. SNIS event 28149 is logged in the Event Journal.

Properties tab This tab is displayed if a message has a message property or user-defined
routing keyword assigned to it. It contains all of the message properties defined,
the name of the message properties and user -defined routing keywords, and
their value.

Monitoring tab If a File message has any instance whose transfer over SWIFTNet is on-going,
(File messages this tab contains the same information as the File Transfer Details view (which
only) is obtained when launching the File Transfer Monitoring application and double-
clicking a row in the list of file transfers). However, only the Abort button is
available, which is subject to the same permissions as when used in the File
Transfer Monitoring application. For more information on the File Transfer
Monitoring application, see File Transfer Monitoring on page 242.
Viewing this tab requires the Monitoring permission.

Related Appears in the message details if the message that you open is related to at
Messages tab least one other message. For more information, see Find and View Related
(MX Messages on page 208.
messages;
relevant only
for store-and-
forward
delivery)

Export Clicking this button generates a report of a message or messages. For more
information, see Report Types and Settings (Export Function) on page 36.

17 December 2021 204


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Print Prints a report directly from the GUI. For more information, see Print a Report
Directly from the GUI on page 36.

14.2.4 View Message Instance Details


Procedure
1. Click the Instances tab from the Message Details page. The Instances List appears.
Depending on your Alliance Access operator profile, you can perform one of the following
actions on an instance:
• complete it
• move it to a different routing point
• reassign the unit assigned to it
• reactivate it if it was completed
• cancel emission
• change expiry date and time
• generate a report that simulates a report printed from a message partner
• change the priority
• open the details of the message that contains the message instance
For details on these actions, see further in this section.
2. Click the relevant instance to view its details.
Those details contain two types of information:
• Instance Description & Comments
• List of interventions
If the message contains several instances, then you can navigate to other instances by clicking
Previous and Next, without having to close the instance. You can also return to the list of
instances by clicking Instances List.
3. Click Interventions to view the list of interventions for the currently displayed instance.
For more information, see Interventions Tab on page 206.
If there are more than 50 appendices, then only the 25 first appendices and 25 last appendices
are displayed. The same rule applies to interventions.
4. You can then click a specific intervention to view its details. The ACK reception section of the
screen contains the date and time (local to the browser) at which the SWIFT ACK or NAK was
received from SWIFT, which is stored with the emission appendix. This information is also
displayed in the detailed reports.
After you view the intervention details, you can perform one of the following actions:
• Navigate to another intervention of the list by clicking Previous or Next, depending where
you are in the list.
• Return to the list of interventions by clicking Interventions List.
• Return one level higher to the list of instances by clicking Instances List.
• View another tab of the message.
• Navigate to the previous or next message without closing the current one.

17 December 2021 205


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

• Close the current message.

14.2.5 Interventions Tab


The Appendix Description in the Interventions tab contains the following fields.

Appendix Description example

Page description

Section Field Description Message format

Message User Unique Message Identifier


MX
UUMID

Instances No. MX

Type MT/MX

Appendix Network MT/MX

Session
MT/MX
Number

17 December 2021 206


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Section Field Description Message format

Unit MT/MX

Session Holder MT/MX

Sequence No. MT/MX

Real-Time For outgoing messages


Response The request type of the business response for an InterAct MX
Request Type real-time message

Input
Message Input Reference for MT MT
Reference

Input
Message Input Reference for MX MX
Reference
Message Reference
Swift
MX
Reference

Swift Request
MX
Reference

The Checksum value for a MT Message.

Value For a multi-format message, the checksum information is Only MT


displayed even if the primary format or the display format is
MT.
Checksum Information
The checksum result for a MT Message.

Result For a multi-format message, the checksum information is Only MT


displayed even if the primary format or the display format is
MT.

Business Relationship RMA Check MT

Signing DN MX

Signature
MX
Result

Signature
MX
Method

Non-
SwiftNet Options Repudiation MX
Setting

Delivery
Notification MX
Request

The Partial Copy digest result from the appendix details of


Partial Copy
the received partial copied message. Present only in the MX
Digest Result
instance zero and on the Reception intervention only.

17 December 2021 207


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Section Field Description Message format

Receiver
MX
Delivery Status

Delivery/Cancellation Network
MX
Status Delivery Status

Sender
MX
Delivery Status

Translation The translation result details from the appendix of a


Multi-Format
Result Details translated message

The Digest Result from the appendix of a translated


Translation
message. If the Translation Result is TRNK, the translation Multi-Format
Digest Result
digest result is not displayed.
Multi-Format
Translation The Checksum Result from the appendix of a Translated
Checksum message. If the Translation Result is TRNK, then the Multi-Format
Result translation Checksum result is not displayed.

Translation The Checksum Value from the appendix of a Translated


Checksum message. If the Translation Result is TRNK, then the Multi-Format
Value translation Checksum Value is not displayed.

Appl/Serc

Creation RP & FT Routing point

Date/Time

14.2.6 Find and View Related Messages


Alliance Message Management offers a quick way to view both MT 103s and related MT 199s
generated for Universal Confirmations, and MX messages that share some common values based
on data contained in those messages
MT 103s and related MT 199s for Universal Confirmations
For MT 103s, Alliance Access finds the related MT199 (based on the shared UETR) that contains
the confirmation for the MT 103.
If you open the MT 199, then it will also find the related MT103.
MX messages
Alliance Message Management offers a quick way to view MX messages that share some common
values based on data contained in those messages. This relationship is established through values
used in the messages. The concept of related messages refers specifically to values provided for
two of the MX keyword fields of messages for Solutions that use store-and-forward delivery. As
explained in Create MX Messages on page 101, these fields are defined as part of the message
standards for a particular service.
The relationship between messages is established based on the following rule: the value of the MX
Keyword 1 field for the message that you opened must be the same as the value for the MX
Keyword 2 field for any message or more messages related to it.

17 December 2021 208


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

The opposite also applies. If you opened a message for which the value of the MX Keyword 2 field
matches the value of the MX Keyword 1 field for another message, then it is that other message
that appears on this tab.
The Find Related button appears on all tabs that display message details for an MX message sent
using store-and-forward delivery.
Procedure
1. Display an MT 103 and its related MT 199 (or an MT 199 and its related MT 103,) or an MX
message that was sent using store-and-forward delivery.
2. Click the Find Related button.
Alliance Message Management retrieves any related messages and refreshes the content of
the message that appears.
Note This refresh presents the initial view of all tabs. For example, if you were on the
Instances tab and had opened a particular message instance or an intervention
for an instance before clicking Find Related , the content of the Instances tab would
be refreshed with the instances list.
3. Click a message displayed on the Related Messages tab. Alliance Message Management
opens it and displays its details instead of the details of the message that you opened from the
list.
4. After you view details of a message or a related message, close the message or navigate
within the list.
If you click Previous or Next , then Alliance Message Management displays details of the
previous or next message in the list relative to the one that you opened from the list.

14.3 Specify Search Criteria


To run a search, you must specify search criteria.
To obtain a list of messages, you must start a search in either live days or one or more selected
archives. Every message has a number of attributes associated with it, which are used as criteria
for searching for messages or groups of messages. A number of tabs are available to specify the
search criteria.
Message attributes are grouped in four categories:
• ID & Content
• Source & Creation
• Transmissions
• Instances Location
• Units
You can combine search criteria from different tabs. For example, you can search for all messages
in a specific queue (selected from the Instances Location tab) that were created between 9 am
and 10 am (defined in the Source & Creation tab).
Frequently performed searches using the same criteria can be saved. See Save Search Criteria as
Template on page 228 for details.

17 December 2021 209


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

14.3.1 Search by ID and Content


The ID & Content tab enables you to specify the message format, UMID, and content (that is,
sender, receiver, nature, and search text).
You can also search for copy messages and files for FIN messages (FINCopy, FINInform) and for
MX, File, or Any Messages, including SWIFTNet Copy and SWIFTNet Inform Copy (InterAct
message only).
The search criteria values that are available depend on the Alliance Access licence options. For
more information, see ID and Content Tab Search Criteria on page 210.
Procedure
1. From the Search and Report menu, select Message Search.
2. Click the ID & Content tab.
3. To specify the message format, select a message format from the Standard field in the
Message Format part. For more information, see Message Format on page 211.
It is possible to search for multiple message type families when using the message Identifier
field in one search. If multiple values are provided for the Identifier field, then the values must
be separated by a comma ",".
For example:
• For FIN : fin.1%, fin.2% will return all MT1% and MT2% messages
• For MX : secl.001% will return all SECL.001% messages
• For BOTH : camt%, fin.1% will return all CAMT% and MT1 messages
4. The UMID or Other (for file or other standard) part enable you to define the structure of the
message UMID. In the fields of this part, you can either specify the UMID in full, to locate an
individual message, or you can specify messages, in part, by using wildcards. For more
information, see UMID on page 213.
You can use the following wildcards:
• "_", to replace one unknown character
• "%", to replace zero, one or more contiguous unknown characters
When searching for Correspondent, Type, Qual, or Reference (in the UMID part), the use of
the "%" wildcard is not recommended, because the search results may not be as expected.
Instead, if you need to use this wildcard in your search, you should search for Sender or
Receiver (in the User part), as appropriate.
5. The Content part enables you to search for messages based on the sender, receiver and what
the message contains, including the payment status for Universal Confirmations and the
translation result for multi-format messages. You can search for a particular type of message,
such as financial messages, and then search on some aspect of their contents, such as their
amount fields or message properties. The message property field also displays user-defined
keywords in messages stored in the Alliance Access database.. You can also search for
messages by specifying a search text. For more information, see ID and Content Tab Search
Criteria on page 210.

14.3.1.1 ID and Content Tab Search Criteria


This topic describes the search criteria available in the ID & Content tab.

17 December 2021 210


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Message Format

Select To search for Complete additional fields as follows

FIN MT messages only Identifier. Enter a message identifier to filter upon. This is a free-text field
that accepts the wildcards _ and %.
You can select a MyStandards message standard to restrict the search to
messages associated with that particular MyStandards standard.
When you select FIN as the standard, all messages assigned to either a
FIN base or FIN MyStandards message standard are in the scope of the
search. When you select a FIN MyStandards message standard, only the
FIN messages assigned to that FIN MyStandards standard are in the
scope of the search.
It is possible to search for multiple message type families when using the
message Identifier field in one search. If multiple values are provided for
the Identifier field, then the values must be separated by a comma ",".

Any Messages of any Identifier. Enter a message identifier to filter upon. This is a free-text field
format that accepts the wildcards _ and %.
It is possible to search for multiple message type families when using the
message Identifier field in one search. If multiple values are provided for
the Identifier field, then the values must be separated by a comma ",".
The RequestSubType of the MX message, which contains an
identification of the validation expected to be performed by sender,
receiver and SWIFT, if Message Validation (MVal) applies.
Translation Result. To search for translated messages.

File File message only Service. You can enter a service code to search for messages sent to a
service for which the message standards are no longer installed. You can
search for messages of a specific service even if the message standards
were removed.
You can type a value in the Identifier field, which is a free-text field that
accepts the wildcards _ and %.

Internal Store-and-forward Identifier. Enter a message identifier to filter upon. This is a free-text field
delivery notifications; that accepts the wildcards _ and %.
also for messages that
The RequestSubType of the MX message, which contains an
may have arrived with
identification of the validation expected to be performed by sender,
an unrecognised format
receiver and SWIFT, if Message Validation (MVal) applies.
Translation Result. To search for translated messages.

Proprietary Messages in a Identifier. Enter a message identifier to filter upon. This is a free-text field
proprietary format that accepts the wildcards _ and %.

17 December 2021 211


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Select To search for Complete additional fields as follows

Other Standard ... Service. You can enter a service code to search for messages sent to a
service for which the message standards are no longer installed. You can
search for messages of a specific service even if the message standards
were removed.
You can type a value in the Identifier field, which is a free-text field that
accepts the wildcards _ and %.
The RequestSubType of the MX message, which contains an
identification of the validation expected to be performed by sender,
receiver and SWIFT, if Message Validation (MVal) applies.
Translation Result. To search for translated messages.

For Solutions that you MX messages The Service is automatically filled in to correspond to the MX message
have implemented standard that you select.
If you select a specific message from the Message Name drop-down list,
then the Identifier is automatically filled in.
When you select an MX base message standard as the standard, all
messages assigned to that base message standard, as well as any MX
MyStandards message standard corresponding to that base standard, are
in the scope of the search. When you select an MX MyStandards
message standard, only the MX messages assigned to that MX
MyStandards standard are in the scope of the search.
The RequestSubType of the MX message, which contains an
identification of the validation expected to be performed by sender,
receiver and SWIFT, if Message Validation (MVal) applies.
Translation Result. To search for translated messages. See the following
table.

Translation Result

To search for Complete the fields as follows

Translated messages Select one of the following:


• Any
• Success: the translation of the ISO 20022 message was
successful.
• Truncation Non Ref: truncation or character replacement
occurred in non-reference fields.
• Truncation Ref: truncation or character replacement
occurred in reference fields.
• Failure: translation was bypassed (the ISO 20022
message fails a minimum check).
• Partial
• Other

17 December 2021 212


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Transaction Data

To search for Complete the fields as follows

Transaction Data Result The code indicates the completeness of the


generated message by the transaction manager at
SWIFT based on the central transaction data.
Select one of the following:
• Any
• Success
• Partial
• Truncation Non Ref: truncation or character
replacement occurred in non-reference fields.
• Truncation Ref: truncation or character
replacement occurred in reference fields.

UMID

If you selected The following fields Complete the fields as follows


appear

FIN I/O Select one of the following:


• I - Sent, to search for input messages, that is, messages that were
created for input to a network
• O - Received, to search for output messages, that is, messages that
were received from a network
• %, to search for both input and output messages

Correspondent Type the applicable BIC11 according to the directional indicator:


• I, type the receiver BIC11
• O, type the sender BIC11
If no specific branch code is given, the last three characters of the BIC
address default to "___" (for example, three wildcards).

Type Enter the message type that is the object of the search (for example,
103). It must be a three-digit number.

Qual If necessary enter a qualifier. For example, use STP or REMIT in the case
of MT 103.STP and MT 103.REMIT.

Reference Enter one of the following:


• the transaction reference number, located in field 20 of the SWIFT
message
• the message user reference, located in the message header

System Unique Enter a value for the following:


Message Identifier
System generated unique identifier of a message

Any I/O Same as FIN messages

17 December 2021 213


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

If you selected The following fields Complete the fields as follows


appear

Correspondent Same as FIN messages

Reference Enter a value that corresponds to the user reference in the message.

System Unique Enter a value for the following:


Message Identifier
System generated unique identifier of a message

File I/O Same as FIN messages

Correspondent Same as FIN messages

Reference Same as FIN messages

System Unique Enter a value for the following:


Message Identifier
System generated unique identifier of a message

Internal I/O Same as FIN messages

Correspondent Same as FIN messages

Reference Same as FIN messages

System Unique Enter a value for the following:


Message Identifier
System generated unique identifier of a message

Proprietary I/O Same as FIN messages

Correspondent Same as FIN messages

Type Enter the message type that is the object of the search (for example,
103). It must be a three-digit number.

Reference Same as FIN messages

System Unique Enter a value for the following:


Message Identifier
System generated unique identifier of a message

Other Standard ... I/O Same as FIN messages

Correspondent Type the sender BIC8 (if the message was output from the network) or
the receiver BIC8 (if the message was input to the network).

Reference Enter a value that corresponds to the user reference in the message
header.

System Unique Enter a value for the following:


Message Identifier
System generated unique identifier of a message

17 December 2021 214


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

For the FIN message format:

Select To search for messages based on Complete additional fields as follows

Receiver The receiver Type the name of the receiver Any,


Institution, Department, or Individual.

Sender The sender Type the name of the sender Any,


Institution, Department, or Individual.

Message Property A message property that has been This is a suggest field, which contains
assigned to an instance. the names of all message properties
injected by Integration Platform (IPLA)
that exist in the messages stored in the
Alliance Access database.
The field also displays user-defined
keywords in messages stored in the
Alliance Access database. Alliance
Access refreshes the user-defined
keywords when you update or modify a
message. See also Add a Routing
Keyword in the Alliance Access
Configuration Guide.

Value The value assigned to a Message Type the value of the message property.
Property. If you specify only the wildcard % in this
field, all messages that have at least one
instance of that message property are
returned, regardless of the value set for
that message property. This is a free text
field with a maximum of 512 characters
allowed.

Nature Their business nature (for example, • All


financial messages) and also to some
• Financial
aspect of their contents (for example,
their amount fields) • Text
• Network
• Security
• Binary
• Service
• Other
Depending on what you select here,
there are additional fields that can be
completed.

Amount From and To A range of amounts Amount range search criteria can be
used without having to provide a
currency criteria

17 December 2021 215


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Select To search for messages based on Complete additional fields as follows

Currency The currency Currency search criteria can be used


without having to provide an amount
range criteria.
In addition to the currency picker, a drop-
down list also allows you to refine your
search by selecting equal or not
equal.

Search Text A string contained in the message Type a string, which must begin and end
with %.
Consider the following restrictions:
• this field is case-sensitive
• the search is limited to the message
body only
For improved results use wildcards.
You can specify the character string fully
or partially by using wildcards:
• "_", to replace one unknown
character. For example, type A_Z to
match both "AUZ" and "ABZ".
• "%", to replace zero, one or more
contiguous unknown characters. For
example, type A%Z to match both
"ABCDEZ" and "AZ".

FIN-Copy The possible values of the list depend on


the FIN-Copy services installed on the
Alliance Access instance.

FIN-Inform The name of a FIN-Inform service (field


165) that is installed on the Alliance
Access instance.

Banking Priority Maximum length is 4, only alphanumeric


values are allowed.

User Reference MUR Maximum length is 16, only


alphanumeric values are allowed.

SLA ID The Service Level Agreement (SLA) The service type identifier that is used
identifier for services such as gpi (field 111 in the
MT header).

17 December 2021 216


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Select To search for messages based on Complete additional fields as follows

UETR The unique end-to-end transaction An end-to-end reference across a


reference (UETR) payment transaction.
Field 121 in the MT header
In the pacs.008 message (FINplus), the
UETR appears in the body of the
message.
This field is not case-sensitive.

Payments Control Info For Receiver This field provides information to the Use information from field 434 (block 3).
receiver from the Payment Controls
The format of field 434 is:
service about the screened message.
/<code-word>3!a/
[<additional-information>20x]

Payment Status Payment confirmation status Select from:


• Any
• None
• Accepted
• Pending
• Rejected
• Returned
• Invalid

For the Any, Internal message format:

Select To search for messages based on Complete additional fields as follows

Receiver The receiver Type the name of the receiver Any,


Institution, Department, or Individual.

Sender The sender Type the name of the sender Any,


Institution, Department, or Individual.

Message Property A message property that has been This is a suggest field, which contains
assigned to an instance. the names of all message properties
injected by Integration Platform (IPLA)
that exist in the messages stored in the
Alliance Access database.
The field also displays user-defined
keywords in messages stored in the
Alliance Access database. Alliance
Access refreshes the user-defined
keywords when you update or modify a
message. See also Add a Routing
Keyword in the Alliance Access
Configuration Guide.

17 December 2021 217


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Select To search for messages based on Complete additional fields as follows

Value The value assigned to a Message Type the value of the message property.
Property. If you specify only the wildcard % in this
field, all messages that have at least one
instance of that message property are
returned, regardless of the value set for
that message property. This is a free text
field with a maximum of 512 characters
allowed.

Copy MX, File, or Any Messages Select the check box to include copy
messages, including SWIFTNet
Does not display for Internal
InformCopy (InterAct message only)

Nature Their business nature (for example, • All


financial messages) and also to some
• Financial
aspect of their contents (for example,
their amount fields) • Text
• Network
• Security
• Binary
• Service
• Other
Depending on what you select here,
there are additional fields that can be
completed.

Requester DN The requester DN Type the requester DN. The wildcards '_'
and '%' can be used in the name. No
normalisation is performed, so the DN
criteria you provide must exactly match
the DN of the message to be found.

Responder DN The responder DN Type the responder DN. The wildcards


'_' and '%' can be used in the name. No
normalisation is performed, so the DN
criteria you provide must exactly match
the DN of the message to be found.

Amount From and To A range of amounts Amount range search criteria can be
used without having to provide a
currency criteria

Currency The currency Currency search criteria can be used


without having to provide an amount
range criteria.
In addition to the currency picker, a drop-
down list also allows you to refine your
search by selecting equal or not
equal.

Value Date From and To A range of value dates

17 December 2021 218


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Select To search for messages based on Complete additional fields as follows

Search Text A string contained in the message Type a string, which must begin and end
with %.
Consider the following restrictions:
• this field is case-sensitive
• the search is limited to the message
body only
For improved results use wildcards.
You can specify the character string fully
or partially by using wildcards:
• "_", to replace one unknown
character. For example, type A_Z to
match both "AUZ" and "ABZ".
• "%", to replace zero, one or more
contiguous unknown characters. For
example, type A%Z to match both
"ABCDEZ" and "AZ".

For the File message format:

Select To search for messages based on Complete additional fields as follows

Receiver The receiver Type the name of the receiver Any,


Institution, Department, or Individual.

Sender The sender Type the name of the sender Any,


Institution, Department, or Individual.

Message Property A message property that has been This is a suggest field, which contains
assigned to an instance. the names of all message properties
injected by Integration Platform (IPLA)
that exist in the messages stored in the
Alliance Access database.
The field also displays user-defined
keywords in messages stored in the
Alliance Access database. Alliance
Access refreshes the user-defined
keywords when you update or modify a
message. See also Add a Routing
Keyword in the Alliance Access
Configuration Guide.

Value The value assigned to a Message Type the value of the message property.
Property. If you specify only the wildcard % in this
field, all messages that have at least one
instance of that message property are
returned, regardless of the value set for
that message property. This is a free text
field with a maximum of 512 characters
allowed.

17 December 2021 219


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Select To search for messages based on Complete additional fields as follows

Copy MX, File, or Any Messages Select the check box the include copy
messages.

Requester DN The requester DN Type the requester DN. The wildcards '_'
and '%' can be used in the name. No
normalisation is performed, so the DN
criteria you provide must exactly match
the DN of the message to be found.

Responder DN The responder DN Type the responder DN. The wildcards


'_' and '%' can be used in the name. No
normalisation is performed, so the DN
criteria you provide must exactly match
the DN of the message to be found.

Logical File Name The logical file name Type the logical file name. The wildcards
'_' and '%' can be used in the name.

Transfer Description The transfer description Type the transfer description. The
wildcards '_' and '%' can be used. A '%'
wildcard is automatically appended to
values that do not already contain a '%'
wildcard. This applies regardless of
whether the value contains space
character(s) and/or '_' characters.

For the Proprietary message format:

Select To search for messages based on Complete additional fields as follows

Receiver The receiver Type the name of the receiver Any,


Institution, Department, or Individual.

Sender The sender Type the name of the sender Any,


Institution, Department, or Individual.

Message Property A message property that has been This is a suggest field, which contains
assigned to an instance. the names of all message properties
injected by Integration Platform (IPLA)
that exist in the messages stored in the
Alliance Access database.
The field also displays user-defined
keywords in messages stored in the
Alliance Access database. Alliance
Access refreshes the user-defined
keywords when you update or modify a
message. See also Add a Routing
Keyword in the Alliance Access
Configuration Guide.

17 December 2021 220


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Select To search for messages based on Complete additional fields as follows

Requester DN The requester DN Type the requester DN. The wildcards '_'
and '%' can be used in the name. No
normalisation is performed, so the DN
criteria you provide must exactly match
the DN of the message to be found.

Responder DN The responder DN Type the responder DN. The wildcards


'_' and '%' can be used in the name. No
normalisation is performed, so the DN
criteria you provide must exactly match
the DN of the message to be found.

Search Text A string contained in the message Type a string, which must begin and end
with %.
Consider the following restrictions:
• this field is case-sensitive
• the search is limited to the message
body only
For improved results use wildcards.
You can specify the character string fully
or partially by using wildcards:
• "_", to replace one unknown
character. For example, type A_Z to
match both "AUZ" and "ABZ".
• "%", to replace zero, one or more
contiguous unknown characters. For
example, type A%Z to match both
"ABCDEZ" and "AZ".

For the Other Standard message format:

Select To search for messages based on Complete additional fields as follows

Receiver The receiver Type the name of the receiver Any,


Institution, Department, or Individual.

Sender The sender Type the name of the sender Any,


Institution, Department, or Individual.

17 December 2021 221


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Select To search for messages based on Complete additional fields as follows

Message Property The value of a message property that This is a suggest field, which contains
has been assigned to an instance. This the names of all message properties
is a suggest field, which contains the injected by Integration Platform (IPLA)
name of all message properties existing that exist in the messages stored in the
in the messages stored in theAlliance Alliance Access database.
Access database. You can also enter
The field also displays user-defined
free text (up to 128 characters).
keywords in messages stored in the
Alliance Access database. Alliance
Access refreshes the user-defined
keywords when you update or modify a
message. See also Add a Routing
Keyword in the Alliance Access
Configuration Guide.

Copy Select the check box the include copy


messages.

Requester DN The requester DN Type the requester DN. The wildcards '_'
and '%' can be used in the name. No
normalisation is performed, so the DN
criteria you provide must exactly match
the DN of the message to be found.

Responder DN The responder DN Type the responder DN. The wildcards


'_' and '%' can be used in the name. No
normalisation is performed, so the DN
criteria you provide must exactly match
the DN of the message to be found.

Amount From and To A range of amounts Amount range search criteria can be
used without having to provide a
currency criteria

Currency The currency Currency search criteria can be used


without having to provide an amount
range criteria.
In addition to the currency picker, a drop-
down list also allows you to refine your
search by selecting equal or not
equal.

Value Date From and To A range of value dates

MX Keyword 1, MX keywords Enter values of message fields


corresponding to MX keyword 1, 2 and 3
MX Keyword 2,
as required. Wildcards can be used. For
MX Keyword 3 more information, see Create MX
Messages on page 101.
The list of MX keywords for all messages
in the selected MX standard can be
displayed by clicking "?" located next to
the Message Name field.

17 December 2021 222


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Select To search for messages based on Complete additional fields as follows

Search Text A string contained in the message Type a string, which must begin and end
with %.
Consider the following restrictions:
• this field is case-sensitive
• the search is limited to the message
body only
For improved results use wildcards.
You can specify the character string fully
or partially by using wildcards:
• "_", to replace one unknown
character. For example, type A_Z to
match both "AUZ" and "ABZ".
• "%", to replace zero, one or more
contiguous unknown characters. For
example, type A%Z to match both
"ABCDEZ" and "AZ".

Related information
Search by ID and Content on page 210

14.3.2 Search by Source and Creation


The Source & Creation tab enables you to search for messages, instances, and templates. You
can also search based on live and archived criteria along with the creation date and time.
Procedure
1. From the Search and Report menu, select Message Search.
2. The Source & Creation tab is selected by default.
3. In the Search Type drop-down list, specify the source in which you want to perform a search:
• Messages: go to step 4 on page 223
• Instances: go to step 5 on page 224
• Templates: go to step 6 on page 224
4. If you select Messages, then do the following:

Select To search for

Live Days Messages in the Alliance Access database, that is live and
completed messages for days that have not been archived yet.

Archived Days Messages in an archive file, that is a file containing messages that
were archived (and are no longer live).
Use the arrows to move the values required from the Available field
to the Selected field.

17 December 2021 223


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Select To search for

Archives and Live Days Messages that are either live and completed, or archived (a
combination of the Live Days and Archived options).

Complete the Creation date/time range and the Find Possible Duplicates check box. For
more information, see step 7 on page 224 and step 9 on page 225.
5. If you select Instances, then the Search In field automatically shows Live Days. Select the
appropriate value from the State drop-down list:
• Live
• Completed
• Reserved
6. If you select Templates, then the ID & Content tab is the only other tab available.
7. To specify creation date and time criteria, complete the Date and Time fields in the Creation
part.
For message search this criteria applies to the message creation date and time.
For instance search this criteria applies to the instance creation date and time.

Field Complete as follows

From Date Type the date of the earliest message to be found, using numeric characters. The date
must be entered with slashes, for example, DD/MM/YY. The date format is interpreted
according to the Alliance Web Platform settings, for example European, US, or ISO
format. The maximum length is 10 characters.

From Time Type the time of the earliest message to be found. Provide either the entire HH:MM:SS
value with or without the : or only the one-digit or two-digit (HH) hour value. Alliance
Web Platform interprets this value as 24 hour time format, and fills in the values for
MM:SS automatically with the current settings.
If no value is entered, the field is automatically filled in with a time of 00:00:00.

To Date Type the date of the latest message to be found, using numeric characters only. The
date must be entered with slashes.

To Time Type the time of the latest message to be found. Provide either the entire HH:MM:SS
value with or without the : or only the one-digit or two-digit (HH) hour value. Alliance
Web Platform interprets this value depending as 24 hour time format, and completes the
values for MM:SS automatically with the current settings.
If no value is entered, then the field is automatically completed with a time of 23:59:59.

8. To specify message template usage tracking criteria, complete the Usage Count and Last
Usage From Date fields in the Usage Statistics part. This part is available only when the
Search In field is set to Templates.

Field Complete as follows

17 December 2021 224


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Usage Count This field indicates the total number of times that the MT or MX
template has been used to manually build a message.
In the first field, select a threshold value, either: '=', '>', '<', '>=', or
'<='. In the second field, specify an integer. Both fields are optional,
but must be present together.

Last Usage From Date This field indicates the timestamp (in the local time of the browser)
when the MT or MX template was used to manually build a message.
Specify either a start date field or an end date (or both). Both fields
are optional.

9. To search for duplicate messages or templates, select the option Find Possible Duplicates.
This search criterion returns all messages that have been received with duplicate information
from the network, messages that Alliance Access has identified as duplicate by means of its
duplicate detection mechanism, or messages that have been marked as duplicate locally
(inside Alliance Access) by a user. Messages that Alliance Access identifies as duplicate are
also automatically marked as having been flagged locally as duplicate by the user.
For more information, see Detecting Duplicate Messages on page 229.
10. To search for messages that have been manipulated by a human, select the option Touched
By Human. Type the name of the operator in the Operator field. You can use wildcards in this
field.
Each time that an intervention performed by an operator is recorded on a message instance of
a message, the whole message is considered as Touched by Human.
Examples of a message that involve human intervention:
• The text of a message is modified.
• An instance of a message is completed.
• A message is created from the message creation application.
11. When you have finished making your search criteria selection, click Search .

14.3.3 Search by Transmission Details


The Transmissions tab enables you to search for messages based on details of their transmission
interventions.
Note The Transmissions tab is only available if you selected Message in the Source &
Creation tab.
Procedure
1. From the Search and Report menu, select Message Search.
2. Click the Transmissions tab.

17 December 2021 225


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

3. To specify details of the transmission interventions of the message, complete the fields in the
Interventions part.

Field Complete as follows Complete additional


fields as follows

Network Name Select the network used to send or receive the message: The Reference field
appears if you selected
• Any, to search for messages sent or received on any
SWIFTNet as a
networks
network.
• APPLI
The Message Input
• OTHER Reference field
• SWIFT appears if you selected
SWIFT as a network.
• SWIFTNet
Enter a value for the
• IPLA reference in the
message header. You
can use wildcards in
this field.

From/To Network Select the search direction:


• From, for messages received from the network
selected
• To, for messages sent to the network selected
• Any, for messages in both directions

Session Holder Type the name of the logical terminal or message partner
profile that established the session during which the
message was exchanged with Alliance Access.
If you selected OTHER, SWIFT or SWIFTNet as a
network, then enter the following in a continuous string
for the logical terminal:
• a nine-character logical terminal identifier through
which the message is sent or received
• a three-character branch code (this is always "XXX")
• a single-character code identifying the session type
(this is either "A" for APC sessions or "F" for FIN
sessions)
Example: SWHQUS33AXXXF
If you selected APPLI as a network, then type the name
of the message partner through which Alliance Access
exchanges the messages that you are searching for.

Session Number Type the number of the communications session during


which the messages were transmitted.

Sequence
Number:

From Type a sequence number to search from. This is a


sequence number within the communications session
specified in the Session Number field.

17 December 2021 226


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Field Complete as follows Complete additional


fields as follows

To Type a sequence number to search to. This field


specifies the upper limit of the search.

4. To specify the networks that sent or received the messages to be searched, use the Available
and Selected columns in the Status part. Move the networks that you want to include in your
search to the Selected column. Click the appropriate networks in the Available column and
click the > arrow, or double-click them to move them directly to the Selected column. You can
select several networks simultaneously. To do so, press the CTRL key and click on the networks
that you want.
The following networks are available:
• APPLI
• OTHER
• SWIFT
• SWIFTNet
5. After selecting a network, options appear for you to specify transmission details.
Select one of the following:
• Transmission Failure, to search for messages whose transmission has failed
• Waiting Delivery, to search for messages that are awaiting delivery
• Waiting Transmission, to search for messages that have not been transmitted yet

14.3.4 Search by Instances Location


When searching for messages or instances, the Instances Location tab enables you to specify
the queues in which they are held.
Procedure
1. From the Search and Report menu, select Message Search.
2. The Source & Creation tab is selected by default.
3. In the Search Type drop-down list, select Messages or Instances.
The Search In field automatically shows Live Days.
4. Select the Instances Location tab.
5. The Queues part enables you to select which queues that you want to search for messages in.
Move the queues that you want to the Selected column. If you do not select any queue, then a
search is made for all queues.
Note If you are searching for instances, selecting Completed as the value for Status
prevents you from selecting any entry in the Available column.
6. Click Search . The instances corresponding to your criteria are displayed.
You can perform the following actions:
• Select one or several instances and perform any of the tasks available on the page.
• Open a message instance to view its details
• Run a new search based on different criteria.

17 December 2021 227


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

• Refresh the list by searching again with the same criteria.


• Click Home to return to your home page.

14.3.5 Search by Units


The Units tab enables you to search for messages according to their live or completed instances.
You can also specify the units to which the instances are assigned.
Procedure
1. From the Search and Report menu, select Message Search.
2. In the Search Type drop-down list, select Messages.
3. Select the Units tab.
4. The Units part enables you to search for message instances that are assigned to specific units.
Move the units that you want to the Selected column as described in step 4 on page 227. If
you do not select any unit, then a search is made for all units.

14.3.6 Save Search Criteria as Template


You can save the criteria provided for a search by creating a search criteria template. This is useful
when a number of different searches are performed frequently.
Procedure
1. From the Search and Report menu, select Message Search.
The Message Search page appears.
2. Specify the message search criteria that you want to save as template. See Specify Search
Criteria on page 209 for details.
3. Click Save as Template.
The Save as Search Criteria Template window appears.
4. Give a name to your template by typing it in the Name field. It can be a maximum of 50
characters long, including spaces and underscores.
5. Select a unit from the Unit drop-down list. A search criteria template must be assigned to a
unit.
6. Click Save .

14.3.7 Use Search Criteria Templates


Procedure
1. From the Search and Report menu, select Message Search.
The Message Search page appears.
2. Select Use Template.
The Search Criteria Templates window appears. The list of available search criteria templates
appears.
3. Click the required search criteria template.
The criteria of the template is loaded to the search criteria fields.

17 December 2021 228


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

4. The search is triggered automatically when selecting the template name. While messages are
being added to the list, the text Please wait may appear.
The Message Search page displays the list of returned messages.
Use Previous and Next, if necessary, to navigate through the pages of the complete list.
5. To close the search template, select Close Template.

14.3.8 Update Search Criteria Templates


Procedure
1. From the Search and Report menu, select Message Search.
The Message Search page appears.
2. Select Use Template.
The Search Criteria Templates window appears. The list of available search criteria templates
appears.
3. Click the required search criteria template.
4. Make the necessary changes to the message search criteria. See Specify Search Criteria on
page 209 for details.
5. Click Update Template.
A confirmation status message appears.

14.3.9 Detecting Duplicate Messages


Duplicate detection applies only to non-archived messages (that is, only for live days).

Description
Alliance Access distinguishes between three types of duplicate messages:
• Messages received with duplicate information from the network (either the back office or
SWIFT/SWIFTNet)
• Messages marked as duplicate locally (inside Alliance Access) by the user
• Messages identified as duplicate by Alliance Access by means of its duplicate detection
mechanism. Such messages are also automatically marked as having been flagged locally as
duplicate by the user.
Duplicate detection is based on digest comparison.

Actions on the possible duplicate messages


When a message is added to or updated in the database, the message is checked if it is a
duplicate message depending on the digest comparison value.
The following tasks are performed using the digest-based duplicate detection functionality:
• For every message added or updated in the Alliance Access database, a digest is calculated
and compared with all digests of the active messages present in the database. The digest is
calculated for all FIN, InterAct, and FileAct messages, except for FIN messages from category 0
(system messages).
• When a message is updated, the digest is re-calculated only when the message payload or the
value in one of the fields used for the digest calculation is changed.

17 December 2021 229


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

• When the same digest is found in the database, an extra comparison is performed on the
payload itself and if it is identical, then the routing keywords possible_duplicate and
user_duplicate are set to "True" for the message.

Note If a duplicate FileAct message is sent or received using a different file digest
algorithm, then it will not be flagged as a duplicate.

Duplicate message digest


The digest is calculated for each FIN, XML-based or File message, and the calculation uses, as
input, the message payload and a fixed set of fields:
• Sender: BIC11 for FIN, Requestor DN for InterAct and FileAct
• Receiver: BIC11 for FIN, Responder DN for InterAct and FileAct
• Direction: I or O
• Message type: Message type for FIN, Request Type for InterAct and FileAct
• Unique message identifier (UUMID): Generated by Alliance Access.
The duplicate messages can be found in the Message File application.

Calculation of message digest


1. The digest of the message is calculated as follows:
• FIN message: digest of Block 4 (maximum 4 KB) plus the additional fields listed above
• XML-based message: digest of the document (maximum 100 KB) plus the additional fields
listed above
• File message: digest of the file payload digest (32 bytes) plus the additional fields listed
above
Note If the back office provides the same file twice, but each file has a different
digest value, then the duplicate message is not detected.
2. The message is stored in the database along with its digest and when it is stored, the system
checks whether the digest already exists.
• If the digest does not exist already in the database, then the check stops.
• If the digest already exists in the database, then an extra comparison is performed on the
payload itself to ensure a complete duplicate check.
• If the comparison check returns a difference, then the check stops.
• If the comparison check identifies the messages to be identical, then the routing keywords
possible_duplicate and user_duplicate are set to "True" for the message.
3. The message is added to the database or updated. A duplicate message is flagged as a
possible duplicate.
Note File messages cannot be updated.

14.4 Message Instances


The status of a message can be live or completed. A message is not considered to be completed
unless all of its instances are completed.

17 December 2021 230


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

You can perform the following actions on a message instance that you select from the Message
Search page:
• complete it
• move it to a different routing point
• reassign the unit assigned to it
• reactivate it if it was completed
• generate a report
• change the priority
• open the details of the message that contains the message instance
• cancel message instance emissions for FIN, InterAct, and FileAct messages
• change the emission expiry date/time of the selected instance(s)
For information about generating a report of an instance, see Generate a Message Instance Report
on page 260. For details on the other actions, see further in this section.
These actions can be performed on a group of instances when you search specifically for message
instances.

14.4.1 Search for Message Instances


Procedure
1. From the Search and Report menu, select Message Search.
2. In the Source & Creation tab, select Instances in the Search Type drop-down list,
3. Go to step 5 on page 224 in Search by Source and Creation on page 223.
Related information
The Message Instance Search Window on page 231

14.4.2 The Message Instance Search Window


When you run an message instance search, to customise the columns of data that are displayed,
click Change View . In the dialog box, select the check box next to a column to show it. You can also
click the column name and use the arrows to change its position in your search results. Click OK
to save your view.

17 December 2021 231


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Change View dialog box for instances

Columns of data available for display

SUMID System generated unique identifier of a message

I/O Specifies the direction of message flow:


• I - The message was created as input to a network, such as SWIFT.
Alliance Access sends the message.
• O - The message was output from a network, such as SWIFT.
Alliance Access receives this message.

Correspondent The BIC-11 address of the correspondent

Identifier Identifies the type of message

SLA ID The service type identifier (field 111 in the MT header) that is used for
services such as SWIFT gpi.

17 December 2021 232


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Reference Message Value in the Reference field


Format

MT The Reference field contains one of the following:


• Transaction reference number, which is located in field 20 of
the MT message
• Message user reference, which is located in the SWIFT user
header

MX A user reference

other formats The number from the header or message text

UETR An end-to-end reference across a payment transaction (field 121 in the


MT header). For more information, see UETR and SLA ID Fields in
Alliance Access on page 41.

Suffix A system generated value intended to make the UMID unique. The first
part is the creation date of the message in YYMMDD format, a six-digit
number. The second part consists of a number (1 to 10 digits) that the
system generates. This number is incremental and unique for all
messages.

Inst #

In Queue The queue in which the message instance is located.

In Queue Since The date when the message instance was assigned to the queue.

Type Type of message instance:


• Original
• Copy
• Notification/Transmission
• Notification/History

Priority The priority of the message instance:


• 1 - Highest
• 3 - System
• 5 - Urgent
• 7 - Normal
• 9 - Lowest

Mesg Creation The date when the message to which the message instance is linked
was created.

Creating Function The name of the function responsible of the creation of the message
instance.

17 December 2021 233


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Related instance The amount of related message instances.

Unit The unit to which the instance is assigned.

Service Name SWIFTNet service

Application The name of the application responsible for the creation of the message
instance.

Function The name of the last function applied on the message instance.

Mesg Description A description of the message. For MT and MX messages, the Message
Description field contains the Display Name of the message type.

Status

Inst Creator Name of the operator who created the message instance.

Inst Creation The date and time when the message instance was created.

Inst Last Modifier Name of the last operator who modified the message.

Inst Last Modification The date and time of the last modification of the message instance.

Sorting search results


In the Message Search GUI, the search criteria or the sorting option are applied by means of a
contextual menu that is displayed by clicking the sortable columns headers or by clicking the
Sorting button. This contextual menu enables you to perform ascending or descending sorting and
to define nested sorting (up to three levels deep) on most of the available columns.
The nested sorting determines the order in which the results of a search are made available to the
GUI in the list of messages/instances. For example, if Mesg Creation, Identifier, and Service
Name are selected (in that order), the messages/instances will be sorted first by Mesg Creation,
then by Identifier, and then by Service Name.
The sorting selected on the table header applies to all messages or messages instances and is not
limited to the subset of results displayed in the GUI page.
While sorting, you can click Abort to cancel the ongoing sorting action. In this case, no results are
returned.
Note The default sorting for message and instance searches is based on Mesg Creation.
You receive an error message when you attempt to sort an unsortable column, such
as Mesg Description or Suffix.
During a search, if some fields are returned empty and need to be sorted on, The
empty values are displayed at the beginning of the returned list. The empty values
include: null values (for optional fields), empty string values (for mandatory string
fields), or 0 values (for mandatory numeric fields).

14.4.3 Complete Instances


Procedure
1. From the Search and Report menu, select Message Search.

17 December 2021 234


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

2. Specify your search criteria as described in Search by Instances Location on page 227.
3. Select the relevant instance by checking the box to the left of the list.
If you want to complete a group of instances simultaneously, then select all the relevant ones.
To complete all the instances displayed on the current page, check the box in the column
heading line.
If you want to complete all of the message instances resulting from the search (including those
not displayed on the current page), do not select any instances in the list.
4. Click Complete . A confirmation window appears. Click OK to confirm or Cancel to return to the
list of instances.

14.4.4 Move Instances


When Alliance Message Management is connected to Alliance Access, you can move an instance
to another routing point.
Procedure
1. Select the relevant instance by checking the box on its left from a search with Message
Instance Search.
If you want to move a group of instances simultaneously, then select all the relevant ones. To
move all the instances displayed on the current page, check the box in the column heading
line.
2. Click Move to .
3. Select a routing point from the list by clicking it and then click Move .
The Move Confirmation window appears that confirms the routing point and the number of
messages that will be moved.
4. Click OK .

14.4.5 Reassign Instances


When Alliance Message Management is connected to Alliance Access, you can reassign an
instance to a different unit.
Procedure
1. Select the relevant instance by checking the box on its left, from the list resulting from a search
with Message Instance Search.
If you want to reassign a group of instances simultaneously, then select all the relevant ones.
To reassign all the instances displayed on the current page, check the box in the column
heading line.
2. Click Re-assign .
3. Select a unit from the list by clicking it and then click Re-assign .
The Reassign Feedback window appears that confirms the action. Click OK .

14.4.6 Change Priority of Instances


Depending on their operator profile, operators can change the priority of a message instance.

17 December 2021 235


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Procedure
1. Select the relevant instance by checking the box on its left from a search with Message
Instance Search.
If you want to change the priority of a group of instances simultaneously, then select all the
relevant ones. To change the priority of all the instances displayed on the current page, check
the box in the column heading line.
2. Click Change Priority .
3. The Change Priority window appears.
4. Select a priority from the Available Priorities drop-down list and click Change .
A message appears in the Status area that confirms the change.

14.4.7 Reactivate a Single Instance


When Alliance Message Management is connected to Alliance Access, you can reactivate a
message instance if it was previously completed.
You can reactivate an individual instance as follows or reactivate multiple instances at the same
time (see Reactivate Multiple Instances on page 236).
Procedure
1. Select the relevant instance by clicking a message from a search with Message Search.
2. On the Messages Details page, click the Instances tab.
3. Select the relevant instance by checking the box on its left.
4. Click Re-activate .
5. The Re-activate Instance window appears.
6. Select a Target Routing Point and enter a comment in the Re-activation Comment field.
7. Click Re-activate .
The Re-activate Confirmation window appears that contains the name of the queue and the
total number of message instances that will be reactivated to the selected queue.
8. Click OK .
A message appears in the Status area that confirms the reactivation.
Note Reactivation of the original instance or a copy instance of a File message that does
not have a payload is not possible. An error message is displayed if you try this action.
If you try to reactivate a message instance that has been copy-pasted to another live
message instance (in the context of the forced archiving of live messages), the
operation is not performed and an error message is displayed.

14.4.8 Reactivate Multiple Instances


When Alliance Message Management is connected to Alliance Access, you can reactivate multiple
completed message or file instances .
You can reactivate multiple instances at the same time as follows or reactivate an individual
instance (see Reactivate a Single Instance on page 236).

17 December 2021 236


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Procedure
1. In the Source & Creation tab in Message Search, select Search Type = Instances and
State = Completed.
2. Click Search .
3. Select the relevant instances by checking the boxes to the left.
4. Click Re-activate .
The Re-activate Confirmation window appears that contains the name of the queue and the
total number of message instances that will be reactivated to the selected queue.
5. Click OK .
A message appears in the Status area that confirms the reactivation.

14.4.9 Open a Message Instance


You can open the details of the message containing the message instance.
Procedure
1. Click the relevant message from a search with Message Search.
2. Select the relevant message instance and click the message instance to open it.
The Message Instance Detail page appears.

14.4.10 Cancel Message Instance Emissions


Before you begin
If you have the appropriate Message File, Cancel Msg Emission permission, then you can cancel
message instance emissions for FIN, InterAct, and FileAct messages. The following permission
details must also be explicitly allowed or not explicitly prohibited:
• FIN: Own Destination(s) for FIN
• InterAct: Service & identifier - InterAct messages
Own Destinations(s) for InterAct & FileAct (DN)
• FileAct: Service & identifier - FileAct messages
Own Destinations(s) for InterAct & FileAct (DN)
Procedure
1. Click the relevant message from a search with Message Search.
2. Select one or more message instances.
3. Click Cancel Emission . On the popup that is displayed, click OK to confirm the cancellation.
4. Specify a NAK code (up to 20 characters long; CAN is the default) and a NAK reason (up to
250 characters of free text). The NAK reason will be used for InterAct or FileAct message
instances only. Click OK . The Status icon shows the identifiers of the instances for which the
cancellation was successful.

17 December 2021 237


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Note • If any of the selected instances have a sender destination that is not allowed by the
Message File, Cancel Msg Emission permission, then the entire operation is
refused (also for the instances whose sender destinations are allowed by the same
permission).
• If any of the selected are either not in an emission queue (_SI_to_SWIFT or
_SI_to_SWIFTNet) or are non-File messages instances that are in Waiting ack
status, then these instances are not cancelled, but the other selected instances are
cancelled. An error popup is displayed that indicates the number and identifier of
the instances on which the operation failed or was successful.
• If one or more instances are File message instances in Waiting ack status, the
instances are aborted.
• The function result of a cancelled message instance is set to Nack'd for a FIN
message instance and to Failure for an InterAct or FileAct message instance.

14.4.11 Change the Emission Expiry Date/Time


Before you begin
If you have the appropriate Message File, Change Expiry Date permission, then you can change
the emission expiry date/time of one or more instances. The following permission details must also
be explicitly allowed or not explicitly prohibited:
• FIN: Own Destination(s) for FIN
• InterAct: Service & identifier - InterAct messages
Own Destinations(s) for InterAct & FileAct (DN)
• FileAct: Service & identifier - FileAct messages
Own Destinations(s) for InterAct & FileAct (DN)
Procedure
1. Select the relevant message from a search with Message Search.
2. Select one or more message instances.
3. Click Change Expiry Date Time .
4. In the confirmation message window, click OK .
5. In the pop-up window that appears, select a new emission expiry date and time, which can be
in the past or in the future. The current emission expiry date time is shown only if the selection
contains one instance only.

17 December 2021 238


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Note • If there are any instances selected whose sender destination is not allowed by your
Message File, Change Expiry d/t permission, then the entire operation is refused
(including the instances whose sender destinations are allowed by the above
permission.
• If there are any instances selected that are not original instances, whose direction
is not To SWIFT/SWIFTNet output messages, or are in status 'Waiting ack' , then
the emission expiry date time of these instances is not changed. It is only changed
for the other selected instances. An error pop-up is displayed with the number and
identifier of the instances on which the operation failed or was successful.
• The Status icon (at the right bottom of the screen) shows the identifiers of the
instances for which the operation was successful.
• The next emission date time of each instance for which the emission expiry date
and time has been successfully changed is reset to 0 (which corresponds to the 1
Jan 1970).

14.5 Message Templates

14.5.1 Search for Message Templates


Procedure
1. From the Search and Report menu, select Message Search.
2. In the Source & Creation tab, select Templates in the Search Type drop-down list,
3. Go to step 6 on page 224 in Search by Source and Creation on page 223.
Related information
The Message Template Search Window on page 239

14.5.2 The Message Template Search Window


When you search for message templates, to customise the columns of data that are displayed,
click Change View . In the dialog box, select the check box next to a column to show it. You can also
click the column name and use the arrows to change its position in your search results. Click OK
to save your view.

17 December 2021 239


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Change View dialog box for templates

Columns of data available for display

Template UUMID The template's User Unique Message Identifier

Template Name The name of the template

Status

Identifier Identifies the type of message

Mesg Description A description of the message. For MT and MX messages, the Message
Description field contains the Display Name of the message type.

17 December 2021 240


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Suffix A system generated value intended to make the UMID unique. The first part
is the creation date of the message in YYMMDD format, a six-digit number.
The second part consists of a number (1 to 10 digits) that the system
generates. This number is incremental and unique for all messages.

Value Date The date on which funds are credited or debited to or from the receiver's
account.
The field is extracted based on the deployment package that is loaded for the
message/service combination.
Alliance Access only displays the value of the Value Date field if you are a
member of a unit to which at least one of the message instances is assigned.
If this requirement is not met, then the value has asterisks (*****), and if you
produce a message details report, the value is not printed. For more
information about assigning units, see the Configuration Guide.
The Value Date field is not populated when the message is coming from a
message partner where No validation level is used.

Format/Status The message format and current processing state of the message. For
example, a message may be in SWIFT format with a status of "live", which
means the message has one or more instances undergoing or awaiting
processing. Alternatively, a message can have a status of "complete", which
means that all instances have been processed.

Orig Inst RP The queue or routing point in Alliance Access where the original instance of
the message is located. If the original instance has been completed, then no
routing point appears.

Mesg Creation The date when the message was created

Usage Count The total number of times that the MT or MX template has been used to
manually build a message.

Last Used The timestamp (in the local time of the browser) when the MT or MX template
was used to manually build a message.

Service Name SWIFTNet service

Sender/Receiver The BIC-11 address of the sender, and receiver of the message

MX Keyword 1 First keyword for an MX message (if present)

MX Keyword 2 Second keyword for an MX message (if present)

MX Keyword 3 Third keyword for an MX message (if present)

Sorting search results


In the Message Search GUI, the search criteria or the sorting option are applied by means of a
contextual menu that is displayed by clicking the sortable columns headers or by clicking the
Sorting button. This contextual menu enables you to perform ascending or descending sorting and
to define nested sorting (up to three levels deep) on most of the available columns.
The nested sorting determines the order in which the results of a search are made available to the
GUI in the list of messages/instances. For example, if Mesg Creation, Identifier, and Service

17 December 2021 241


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Name are selected (in that order), the messages/instances will be sorted first by Mesg Creation,
then by Identifier, and then by Service Name.
The sorting selected on the table header applies to all messages or messages instances and is not
limited to the subset of results displayed in the GUI page.
While sorting, you can click Abort to cancel the ongoing sorting action. In this case, no results are
returned.
Note The default sorting for message and instance searches is based on Mesg Creation.
You receive an error message when you attempt to sort an unsortable column, such
as Mesg Description or Suffix.
During a search, if some fields are returned empty and need to be sorted on, The
empty values are displayed at the beginning of the returned list. The empty values
include: null values (for optional fields), empty string values (for mandatory string
fields), or 0 values (for mandatory numeric fields).

14.6 File Transfer Monitoring

14.6.1 File Transfers Page


Overview
The File Transfers page allows you to monitor file transfers, and search for file transfers and view
the file message details. This includes file transfers based on a message partner with connection
method Direct FileAct. The search results display the file transfers that are in progress and the file
transfers that have ended (completed or aborted file transfers).
The FT Monitoring Retention configuration parameter controls the number of days that completed
and aborted file transfers remain visible in the list.
From the File Transfer Details window, you can save the payload file to a local directory.

Page example

Filtering Criteria area

Filtering criteria Enables you to filter a list of File messages according to various criteria.

Columns in the list

I/O The file transfer direction: Input (I), which means that a file is sent to
SWIFTNet, or Output (O), which means that a file is received from
SWIFTNet

Transfer Reference A unique identifier for the file transfer that is automatically generated when
the file transfer occurs

17 December 2021 242


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

User Reference This optional field allows you to enter your own reference information for the
transfer, for example, the date, an ID number, or a reference code

Start Date/Time The start date/time of the file transfer

Status The status of the file transfer:


• Not started
• Ongoing
• Completed
• Aborted

Progress Shows the progress of the file transfer

File Size The size of the file (Bytes)

Service Name The name of the service over which the file transfer is requested

Request Type A specific function within the service being provided

Profile Name The emission or reception profile name

Correspondent The BIC8 address of the Responder DN for an input message or the BIC8
address of the Requestor DN for an output message

File Name The name of the file

Unit The unit that is sending the file or that is assigned to the File message when
an operator initiates a file transfer

Function

Abort An operator can abort a file transfer that has the status Ongoing.

14.6.2 File Transfer Details Window


Overview
The File Transfer Details window contains information about the transmission of the File
message. This information includes the service name, the request type, information about the
correspondent, and the transfer reference.

17 December 2021 243


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

File Transfer Details window example

File Transfer Details window description

I/O The file transfer direction: Input (I), which means that a file is sent to
SWIFTNet, or Output (O), which means that a file is received from
SWIFTNet

17 December 2021 244


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Service Name The name of the service over which the File message is sent or the file
download is requested

Request type A specific function within the service being provided

Profile Name The emission or reception profile name

Correspondent The BIC8 address of the correspondent

Network Priority The SWIFTNet priority that was requested for the exchange

Possible Duplicate Indicator of possible duplicate

Start Date/Time The start date/time of the file transfer

Status The status of the file transfer

Progress Shows the progress of the file transfer

Copy Required Indicates whether a copy was requested (input only)

Copy Type The type of copy (output only)

Copy Status The status of the copy (output only)

Transfer Reference A unique identifier for the file transfer that is automatically generated when
the file transfer takes place

User Reference This optional field allows you to enter your own reference information
concerning the transfer

Stored Transfer Ref. A unique transfer reference generated by the SWIFTNet store-and-forward
systems to identify a store-and-forward file transfer

Logical File Name The logical file name that is defined in the database for the payload file.

File Size The size of the payload file (Bytes)

File Description The description of the payload file

File Info This optional field displays structured data used by the receiver for
automatic processing of the file. The use of this field is agreed between
sender (you) and the receiver. For example, the field contents can start
with SwCompression= to indicate whether the file is compressed, and also
to identify the compression algorithm.

Transfer Description Information about the file transfer

Transfer Info Data that can be used by the receiver for automatic processing of the file
transfer

17 December 2021 245


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Functions
Function Description

Refresh Updates the information in the window.

Save File Saves the payload of the File message to a local directory

Show Message Opens the Message Details page

Previous Shows details of the previous file transfer entry.

Next Shows details of the next file transfer entry.

14.6.3 Monitor File Transfers


This procedure enables you to monitor the following types of file transfers through Alliance
Message Management:
• a manual FileAct file transfer
• a file transfer based on a message partner with connection method Direct FileAct
Before you begin
Action Permissions needed

File Transfer Monitoring Monitoring

File Transfer Details Monitoring

Abort Monitoring / Abort File Transfer

Save File Message File / Search

Show Message Message File / Search

Procedure
1. From the Search and Report menu, select File Transfer Monitoring.
2. Use the filtering criteria to search for a FileAct message.
3. Click a file-transfer row to view the request details and content.
The File Transfer Details window opens.
4. If needed, you can abort the file transfer, as follows:
a) Click Abort .
The Confirmation Message window opens.
b) Click OK .
5. You can save the payload file to a local directory by clicking Save File .
Alternatively, you can:
• Save the payload from the message details. Click Show Message from the File Transfer
Details window or go to the Search and Report menu > Message Search, do a search on

17 December 2021 246


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

messages and select a file message to access the Message Details, then from the File tab,
click Save File .
• Save the payload from the file transfer details. Go to the Search and Report menu > File
Transfer Monitoring, select the File message and save the payload file from the File
Transfer Details window.

14.7 Types of Reports


Overview
Alliance Message Management offers the following kinds of reports:
• a message summary report, that summaries the information of messages that match the search
criteria, or from search results
• a message details report, that contains detailed information of messages that match the search
criteria, or from search results
• a message count report, with total matching number
• summary report of the number of messages per queue
Format of Reports
The reports are generated to be exported to a file or displayed for printing.
The report can be generated in the following formats:
• PDF
• CSV (only available for summary report, that is, message summary and messages per queue
reports)
• XLS
• TXT (formatted), which is the same format as PDF reports converted into text format. Note that
this format cannot be used as input to other automated computing processes.

Operator permissions
The Alliance Access operator profile permission to search for messages (Message File / Search)
is required for producing the message details and message summary reports in Alliance Message
Management.
The Alliance Access operator profile permission Monitoring is required for producing the
messages in queues report.

Configuring the maximum number of entities in a report


To configure the maximum number of entities that can be displayed in a report, use the Alliance
Web Platform administration parameter Maximum Number of Entities per Report. If the number
configured in this parameter is exceeded, you will receive the prompt: Incomplete report:
maximum number of entities - as currently configured - is exceeded.

To avoid this situation, provide a higher value for this parameter. For more information on this
parameter, see Alliance Web Platform configuration parameters in the Alliance Web Platform
Administration and Operations Guide.
Reports generated using Operational Reporting are not affected by this parameter.

17 December 2021 247


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

14.7.1 Details Report


Report structure
Information at the top of the first page of the details report shows:
• the application used
• report type
• name of operator who generated the report
• Alliance server instance
• date and time when the report was generated
The content for details of a message resembles the content shown when viewing a message
located using the message search functionality of Alliance Message Management. However, it
does not include the interventions for each instance.
Note If you create a details report from search results, then the interventions for each
instance are included in the report if you have the right permission. The permission is
set in Alliance Access configuration parameter MXS > Print >Skip Interventions.
This parameter specifies whether the interventions are included or not in the message
details.
You can generate a report that includes the interventions by selecting one or more messages and
clicking Export and selecting Details on the Report Window. See Generate a Report of Messages
from Search Results on page 259. The message details report includes the following sections for
each message:
• warning text (optional; if a three-character eye-catcher code is provided for the message, then it
refers to the most recent emission appendix of an input message or the reception appendix of
an output message)
• message identifier
• request type (if different from message identifier)
• message header details
• sender/receiver details
• message text
The message text always appears in expanded format even if the Display expanded text box
is not selected (see Text tab).
• message file
• message history
• message instances and transmission
• interventions
• end of message indicator

Warning text and eye-catcher codes


If a warning header or eye-catcher is present for a message, then Alliance Message Management
prints it. The Alliance Access configuration parameter setting for Print - ST200-like Format
determines the appearance of warning header details and the presence of eye-catcher text.
If you subscribe to Sanctions Screening or Transaction Screening and the service flags a message
as a true hit, then the warning includes the text Sanctions compliance - Message blocked. For

17 December 2021 248


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

more information about configuration for Sanctions Screening and Transaction Screening, see the
Configuration Guide.
The user documentation provided with Alliance Access describes the meaning of text and codes
that may be printed to indicate warning conditions for a message. For more information about eye-
catchers, see Printed Message Reports on page 250.

Message text
Depending on the value of the configuration parameter FIN User Header in Alliance Access, the
message text section shows the contents of the FIN User Header (block 3) of the message.
If you subscribe to Sanctions Screening, then block 3 contains Sanctions Screening information.
For more information about configuration for Sanctions Screening, see the Configuration Guide.
For more information about configuration for Transaction Screening, see the Configuration Guide.

14.7.2 Summary Report


Report structure
Text at the top of the first page of the summary report shows the following information:
• the application used
• report type
• name of operator who generated the report
• Alliance server instance
• date and time when the report was generated
The summary report includes at least one line per message. Depending on the columns that you
select, information related to one message may require multiple lines on the printed report.
The bottom of the last page of the summary report shows the number of messages that correspond
to the report search criteria.

Column selection
The columns selected by default for summary information correspond to the set of columns that is
used for the Search Results page when searching for messages. You can modify this default set
of columns by clicking Change View on the Search Results page.
You can always select a different set of columns by selecting them in the Export window when you
click Export . You can reset the selected set of columns to its default value at any moment by
clicking Reset .

Sort order
Sort order is only applicable when running a Summary or a Details report from search criteria.
Alliance Message Management presents summary results in the sequence that Alliance Access
provides them. You can select a value in the Sort Order field to determine the order in which
Alliance Access returns the resulting output.

Value Result

Creation Date (default) The output is sorted in descending order so that the most recent message appears
first.

17 December 2021 249


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Value Result

UMID The output is sorted in alphanumerical order.

Currency / Amount The output is first sorted in alphabetical order by currency code, and then sorted in
ascending order by amount.
Use Currency / Amount for a report that includes only FIN messages.

14.7.3 Count Report


The report shows the following information:
• the application used
• report type
• name of operator who generated the report
• Alliance server instance
• date and time
• number of messages that correspond to the report search criteria
• report search criteria provided

14.7.4 Messages in Queues Report


The report includes the following kind of information:
• queue name
• message count
The list of queues includes the names as defined for Alliance Access. The number of messages
shown is provided directly from Alliance Access at the moment the list is generated for display on
Alliance Message Management.

14.7.5 Printed Message Reports


Introduction
Printed message reports are generated when a message is routed to a Print message partner, or
when messages are printed on demand.

Report content
The report for a message instance consists of the following sections:
• Warning header
• Transmission section
• Message Header section
• Message Text section
• Message Trailer section
• Intervention section

17 December 2021 250


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Each message starts on a new page.


The page header includes date and time information, as well as the name of the message partner
and its session and sequence number. The report indicates that the information is a reprint and
thus the values for session and sequence number are all zero.
The configuration parameters of the classes Print and Display/Print influence the content of the
printed report.

Eye-catcher text
When printing in ST200-like format, a warning identification, which is called eye-catcher text,
indicates an exceptional condition.
Note Eye-catchers are not printed when the option for printing to a file is used.
The eye-catcher codes in the following table are shown in order of preference. This means that if
more than one condition applies, then only the eye-catcher that is related to the first condition is
printed:

Eye-catcher Text Condition

NAK NAK'd message. Message is an input message, the delivery status is Not
Acknowledged (NAK).

SAI Authentication Message is an output message, the message authentication


and/or and/or authorisation verification failed.
authorisation
incorrect.

SAB Authentication Message is an output message, the authentication and/or


and/or authorisation were bypassed.
authorisation
bypassed.

FAI FINCopy Message is a FINCopy output message, the FINCopy


Authentication authentication verification failed.
incorrect.

FAB FINCopy Message is a FINCopy output message, the FINCopy


Authentication authentication code verification was bypassed.
bypassed.

FAN FINCopy Message is a FINCopy output message, the FINCopy


Authentication authentication is not present.
missing.

RTV Retrieved message. Message is an input or output message that has been retrieved.

*** Original Message is an output message received from the SWIFT


network and the instance is an original. Note: This means that
only 1 instance contains the *** eye-catcher.

PAI Partial Copy Message is an output InterAct message that requires Partial
Authentication Copy digest authentication in case the Partial Copy digest
Result: Incorrect verification failed or the Partial Copy digest is missing.

17 December 2021 251


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Eye-catcher Text Condition

PAB Partial Copy Message is an output InterAct message that requires Partial
Authentication Copy digest authentication in case the IA Partial Copy digest
Result: Bypassed verification was bypassed.

Partial Copy Message is an output InterAct message that requires Partial


Authentication Copy digest authentication in case the IA Partial Copy digest
Result: Correct verification was successful.

Warning headers - Alliance format


The default warning header is the Alliance format.
If Sanctions Screening or Transaction Screening flags a message as a true hit, then the warning
header includes the warning, Sanctions compliance - Message blocked.
With this format, the warning header indicates that a message is a possible duplicate under any of
the following conditions:
• The message was sent to the network with a Possible Duplicate Emission trailer
• The message was received with a Possible Duplicate Emission or Possible Duplicate Message
trailer
• The message instance is a notification and an emission appendix exists before the related
appendix
If a previous transmission attempt was made, then the warning header includes transmission-
related details for the network, session holder, session number, sequence number, and delivery
status.
Brief information prints in case authentication was successful or was not applicable for the
message.
If the message being printed is a retrieved MT message, then the text prints accordingly.

Warning headers - ST200-like format


Text Description

*** Nacked Message *** Prints only for an input message. Appears if the
network delivery status of the related appendix
indicates that the message was not
acknowledged (NAK).

*** Sanctions compliance - Message blocked Appears if Sanctions Screening or Transaction


*** Screening flags a message as a true hit.. (1)

*** Authentication Result: <value> *** The following values are possible for the
authentication result message, based on
whether the message is MT, MX or a File
message, and depending on the related
appendix:

• Correct with current key


• Incorrect
• Authentication bypassed

17 December 2021 252


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Text Description

*** Authentication/Authorisation Result: Printed only for an output MT message.


value> ***
The following value is possible:
• Incorrect

*** Authorisation Result: <value> *** Printed only for a message that requires
authorisation.
The following values are possible:
• No Record
• Not Enabled
• Invalid Period
• Unauthorised

*** Authorisation key not present *** Prints only for an output MT message that
requires authorisation. Printed if no
authorisation key is available.

*** FIN-Copy Authentication Result: <value> Prints only for an output MT message that
*** requires proprietary authentication.
The following values are possible for an MT
message, based on the related appendix:

• Correct with current key


• Incorrect
• Authentication bypassed
• Proprietary Authentication Code
trailer missing

*** Partial Copy Authentication Result: Prints only for an output InterAct Partial Copy
<value> *** message that requires proprietary
authentication.
The following values are possible:
• Correct
• Incorrect
• Bypassed

*** FIN-Copy Authentication/Authorisation Prints only for an output MT message that


Result: <value> *** requires proprietary authentication. The
following values are possible for an MT
message, based on the related appendix.
The following value is possible:
• Incorrect

17 December 2021 253


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

Text Description

*** Possible duplicate information received Prints if a message was received from SWIFT
from network *** or from a back-office application as a possible
duplicate. The possible duplicate information
was set externally and received by Alliance
Access.

*** Possible duplicate indicator set locally Prints if a message was locally marked (within
*** Alliance Access, either by means of a manual
operation or otherwise) as a possible duplicate.

*** Duplicate detected by interface *** Prints if Alliance Access has detected that a
message is possibly a duplicate of another
message in the database.

*** Possible duplicate delivery *** If the original instance has one emission
appendix, prints when printing/reprinting the
original instance or when reprinting the
transmission notification instance
corresponding to the emission appendix.
If the original instance has more than one
emission appendix, prints when printing/
reprinting the original instance or when
reprinting any of the transmission notification
instances corresponding to the emission
appendices.(2)(1)

*** Possible Duplicate Emission *** If the original instance has more than one
emission appendix, prints when printing/
reprinting the second, third, or later notification
instances corresponding to the emission
appendices.(2)(1)

*** Possible Duplicate Reception *** Prints if the message is received from the
network with a possible duplicate emission or
Possible Duplicate Message trailer.

*** Test and Training Mode *** Prints if the MT message sent or received is
from/to a Test & Training destination.

(1) Applies to a 'Printing message to a Print MP' printout or a 'Printing with MXS layout from MMA" printout. A 'Printing message
to a Print MP' printout creates an additional emission appendix (but no transmission notification instance), while a 'Printing with
MXS layout from MMA' printout does not.
(2) With status other than DLV_REJECTED_LOCALLY or DLV_NACKED.

If a previous transmission attempt was made, the warning header includes transmission-related
details for the network, session holder, session number, sequence number, and delivery status.

Instance type and transmission


The content of this section of the report varies, depending on the instance type and the type of
transmission. The report always shows the network used to send the emission or reception

17 December 2021 254


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

appendix for a message. The following table explains additional content that can appear in the
Instance Type and Transmission section:

Instance type / transmission Content

Notification / emission Indicates the notification type, and includes the type of the related
instance. Network acknowledgement information is printed. For
notification type "Transmission", the report includes Network
Delivery Status: <value>. For notification type "Delivery", the
report includes User Delivery Status: <value>, possibly
followed by NAK information.
If the instance is for an MT message that is not an APC message, then
the report includes Priority/Delivery : <value>. This
information indicates the priority (System, Urgent, or Normal) and can be
followed by the delivery status (Non-Deliv Warning or Deliv
Notif).
The message input reference prints in this part of the report.

Notification / reception Indicates the notification type, and includes the type of the related
instance. If the instance is for an MT message that is not an APC
message, then the report includes Priority: <value>.
The message output reference prints in this part of the report, along with
the correspondent input reference.

Original or Copy / emission Indicates the instance type and whether there is a related instance, and
shows network acknowledgement information. If the instance is not for a
FIN system message, then the report includes Priority/Delivery :
<value>. This information indicates the priority (System, Urgent, or
Normal) and can be followed by the delivery status (Non-Deliv
Warning or Deliv Notif).
The message input reference prints in this part of the report.

Original or Copy / reception Indicates the instance type and whether there is a related instance. If the
instance is for an MT message that is not an APC message, then the
report includes Priority: <value>.
The message output reference prints in this part of the report, along with
the correspondent input reference.

Message header
The content of this section of the report is relevant to the message itself, and not specific to the
particular instance that has been printed.
Some content is common for both MT and MX messages:
• Message format
• Message direction (input or output)
• Transmission network
• Message type and message name
Details from the reference data print for sender and receiver (MT message) or for the BIC8 that is
part of the Requestor DN and Responder DN (MX message).

17 December 2021 255


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

The following additional information prints for an MT message, if present:


• Message User Reference
• Banking Priority
• Server to Receiver Instructions
• FINCopy service
• Textblock Authentication, which includes User Code and MAC Result
For an MX message, the following information is included in the report:
• User Reference
• Service Name
• Non-repudiation Indicator
• Non-repudiation Type
• Non-repudiation Warning
• SWIFT reference
• SWIFT Request Reference
• CBT Reference
• Store-and-forward Input Time (if relevant)
• Signing DN

FIN User Header


The printed report contains the section, FIN User Header, in the following conditions:
1. The value of the Display/Print - FIN User Header configuration parameter is set to Yes, and
2. The message instance is printed through a Print message partner

Message text
The text of the message prints for any fields that contain values.
The FIN User Header (Block 3) is printed in the following conditions:
1. The value of the Display/Print - FIN User Header configuration parameter is set to Yes, and
2. The message instance is not printed through a Print message partner

Message trailer
The message trailer of an MT message prints after the message text.

Interventions
The interventions print for an instance if the Print - Skip Interventions parameter is set to No.
For an MX message sent using real-time delivery, intervention details of a Transmission Response
(containing the Business Response) are preceded by the following information:
• SWIFT Reference
• Responder Reference
• Signing DN
• Signature Result
• Non-repudiation Type
• Non-repudiation Warning

17 December 2021 256


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

• CBT-Reference
• Possible Duplicate Indication
• Responder DN
End of message trailer
When printing reports in ST200-like format, each message is terminated by an end-of-message
trailer:
*End of Message

14.8 Generate a Report of Messages from Search


Criteria
Alliance Message Management allows you to generate a report of details, summary, or count
information of messages that match the search criteria provided. The resulting report may include
messages (if the source selected is for live days or archives) or it may include message templates
(if the source selected is templates).
You are able to select a detailed report or summary report, but this is not advised because the
report can contain too many messages. It is better to redefine your search and then use the report
function of messages from search results. For this procedure, see Generate a Report of Messages
from Search Results on page 259. If you want to create a details or summary report from search
criteria, then use the following procedure.
Procedure
1. Specify the search criteria, see Specify Search Criteria on page 209.
2. Click Export in the search criteria.
The Export window appears.
3. For Export Range, the following rules apply.
• If you have selected all of the entities in the search list, the Export Range is set to Selected
items.
• If you have not selected an entity on the search page, then all of the entities matching the
criteria across the results are selected (not limited to the results on the page). The Export
Range is set to All items.
• If you have selected a subset of the entities in the list, then only those entities are selected
for export. The Export Range is set to Selected items. However, you can alternatively
select All items, which causes all entities matching the filters to be exported.
4. Select a report type from the Export Type drop-down list.
The report types available are:
• Count
• Summary
• Details
If you select to create a Details report, the following check boxes are activated:
• Display Expanded Text: if selected, descriptive names for each field are displayed in the
report, provided that the corresponding message standards are installed.
• Include History: if selected, message history details are included in the report. The history
is derived from message interventions.

17 December 2021 257


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

• Include Header/Footer: if selected, headers and footers are included in the report.
• Include Search criteria: if selected, the search criteria are included in the report.
• Include Sender/Receiver: if selected, the sender and receiver are included in the report.
• Include Instances: if selected, the message instances are included in the report. This
information is derived from the instance type and transmissions.
• Include Interventions: if selected, the message interventions are included in the report.
This option is available only if you select Include Instances and if the Skip Interventions
global parameter is set to off.
If any of the above check boxes are not selected, the corresponding section of the message
Details report is omitted.

To generate a Count report, see Generate a Message Count Report on page 261.
5. Select a format from the Output Format drop-down list.
The formats available are:
• PDF
• XLS
• CSV (only available for Summary Report)
• TXT
6. Select the orientation of the report from the Page Orientation drop-down list.
7. Select the page size of the report from the Page Format drop-down list.
8. If you selected the Summary report type then you can modify the default set of Columns used
for the report.

17 December 2021 258


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

9. Click OK .
The File Download window appears. You can then click Open to view or Save to save the
report.
If you click Open , then the report automatically opens assuming that you have a tool installed
to read PDF, CSV or XLS files.

14.9 Generate a Report of Messages from Search


Results
Alliance Message Management allows you to generate a report of details or summary information
of messages retrieved through searching. The content available on the search results page
depends on the search criteria provided. The resulting list may include messages (if the source
selected is for live days or archives) or it may include message templates (if the source selected is
templates).
Reporting is available for one or more messages selected from the list of search results or for a
message that is open.
There are three report types available:
• Selecting Summary outputs the message information displayed in the columns on the Search
Results page for one or more selected messages.
You can use the default column layout provided when Alliance Message Management is
installed or you can use Change View to modify the default selection.
• Selecting Details outputs all the message information retrieved by the search for one or more
selected messages.
• Selecting Count provides the number of messages that satisfy the search criteria.
If your operator profile does not allow you to see the message text, then it does not appear in the
printed output.
Procedure
1. Run the search query.
The Search Results page appears.
2. Use the check boxes to select the messages for which you want to generate a report, or click a
message to open it.
3. Click Export on the top of the table of search results or at the bottom of the message details
page if you opened an individual message.
The Export window appears.
4. For Export Range, the following rules apply.
• If you have selected all of the entities in the search list, the Export Range is set to Selected
items.
• If you have selected no entities on the search page, all of the entities matching the criteria
across the results are selected (not limited to the results on the page). The Export Range is
set to All items.
• If you have selected a subset of the entities in the list, only those entities are selected for
export. The Export Range is set to Selected items. However, you can alternatively select
All items, which causes all entities matching the filters to be exported.

17 December 2021 259


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

5. Select a report type from the Export Type drop-down list.


The report types available are:
• Summary
• Details
• Count
6. Select a format from the Output Format drop-down list. The formats available are: PDF, CSV
(only for summary reports), XLS, and TXT.
Note If you selected TXT or CSV format, then Page Orientation Page Format are not
available.
7. Select the orientation of the report from the Page Orientation drop-down list.
8. Select the page size of the report from the Page Format drop-down list.
9. If you selected the Summary report type then you can modify the default set of Columns used
for the report. It is also possible to select the font size and the content.
10. Click OK .
The File Download window appears. You can then click Open to view or Save to save the
report.
If you click Open , then the report automatically opens assuming that you have a tool installed
to read PDF, CSV or XLS files.

14.10 Generate a Message Instance Report


Alliance Message Management allows you to generate a report of instance-specific information of a
message retrieved through searching.
The report simulates the layout of a report printed from a message partner.
The report consists of the following sections for a message instance:
• Warning header (appears if there is a warning) (see Warning text and eye-catcher codes on
page 248)
Instance Type and Transmission section
• Message Header section
• Message Text section (see Message text on page 249)
• Message Trailer section (appears if block 5 exists in the message)
• Interventions section (appears based on value of configuration parameter in Alliance Access)
Tip The message instance report for an input message always contains the Possible
Duplicate indication even if this is not the case.
Procedure
1. Run the search query.
The Search Results page appears.
2. Open the message for which you want to generate an instance message report and click the
Instances tab.
The list of instances appears.
3. Use the check box to select the instance for which you want to generate a report.

17 December 2021 260


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

4. Click Instance Export .

The Export window appears.


5. Select a format from the Output Format drop-down list. The formats available are: PDF, XLS,
and TXT.
6. Select the orientation of the report from the Page Orientation drop-down list.
7. Select the page size of the report from the Page Format drop-down list.
The File Download window appears. You can then click Open to view or Save to save the
report.
If you click Open , then the report automatically opens assuming that you have a tool installed
to read PDF, CSV, or TXT files.
8. Check the options Display Expanded Text, Include Header/Footer, and Message Partner
Print Layout as required. The Message Partner Print Layout option applies only to output
messages that have been completed.
9. Click OK .
10. Click Close to return to the list of messages.

14.11 Generate a Message Count Report


The availability of the Count Report depends on the operator's profile, as mentioned in Types of
Reports on page 247.
If you clicked Export in Message Search Criteria of the Message Search page, then you are able
to generate a count report. A count report presents the total count of messages that match search
criteria.
Note You are also able to select a detailed report or summary report, but this is not advised
because the report can contain too many messages. It is better to redefine your
search and then use the report function of messages from search results. For this
procedure, see Generate a Report of Messages from Search Results on page 259.
Tip Click Count in the Message Search Criteria to display in a pop-up the number of
messages meeting the search criteria. The associated search results are not
displayed.
Procedure
1. From the Search and Report menu, select Message Search.
The Message Search page appears.
2. Specify search criteria by completing the fields as needed. See Specify Search Criteria on
page 209 for details. You can also use a search criteria template to perform a message search.
See Save Search Criteria as Template on page 228 for details.

17 December 2021 261


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

3. Click Export in the Message Search Criteria.


The Export window appears.
4. For Export Range, the following rules apply.
• If you have selected all of the entities in the search list, the Export Range is set to Selected
items.
• If you have selected no entities on the search page, all of the entities matching the criteria
across the results are selected (not limited to the results on the page). The Export Range is
set to All items.
• If you have selected a subset of the entities in the list, only those entities are selected for
export. The Export Range is set to Selected items. However, you can alternatively select
All items, which causes all entities matching the filters to be exported.
5. Select Count from the Report Type drop-down list.
Note The report types Summary and Details are also available. If you want to generate
a summary report or a details report, then see Generate a Report of Messages
from Search Results on page 259.
6. Select a format from the Output Format drop-down list.
The formats available are:
• PDF
• XLS
• TXT
7. Select the orientation of the report from the Page Orientation drop-down list.
8. Select the page size of the report from the Page Format drop-down list.
9. Click OK .
The File Download window appears. You can then click Open to view or Save to save the
report.
If you click Open , then the report automatically opens assuming that you have a tool installed
to read PDF or XLS files.

14.12 Generate a Messages in Queues Report


If your Alliance Access operator profile includes the Monitoring permission, then you can produce
a Messages in Queues report.
The report lists the names of all the queues and the number of messages in each queue.
Procedure
1. From the Search and Report menu, select Messages in Queues
The Messages in Queues page appears.
2. Click Export .
The Export window appears.

17 December 2021 262


Alliance Access 7.6.20 Message Search and Report
Message Management Guide

3. Select a format from the Output Format drop-down list.


The formats available are:
• PDF
• XLS
• CSV
• TXT
4. Select the orientation of the report from the Page Orientation drop-down list.
Note If you selected CSV format, then Page Orientation is unavailable.
5. Select the page size of the report from the Page Format drop-down list.
Note If you selected CSV format, then Page Format is unavailable.
6. The default columns for the report display in the Columns field. You can change the order of
columns in Columns field.
7. Click OK .
The File Download window appears. You can then click Open to view or Save to save the
report.
If you click Open , then the report automatically opens assuming that you have a tool installed
to read PDF, CSV or XLS files.
8. Click Close to return to the list of messages.

17 December 2021 263


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

15 Operational Reporting
Overview
Alliance Access Operational Reporting is a licence option of Alliance Access. When installed on the
Alliance Access host, Reporting can be used during an evaluation period or when it is purchased.
Operational Reporting offers value-added reporting and analysis of MT and FIleAct messages in
the Alliance Access message store. It is implemented by means of the Reporting graphical user
interface (GUI), which is included in the Web Platform-based Message Management package, and
a scriptable command-line tool. It is available with Alliance Access only.

Interaction of Operational Reporting with other Alliance Access components

Alliance Access Server

Alliance Access
Ready-to-use Web Platform
reports
Alliance Access Database Operator
Interactive t
in
Report Pr
Raw Reporting Queries
Update Reporting Execution
Message Data
Engine

Sa Dis
Data Store

ve k
on
Command
Line

Report on file Report on file


(PDF, XLS) (PDF, XLS)

Reporting Framework

D0540213
The Message Management and Configuration packages of Alliance Access provide the following
Reporting functionality:
• continuously synchronise up-to-date message data stored in Alliance Access tables to the
Reporting data store. Reporting always includes the latest version of the messages that are
present in the Alliance Access database.
• enable the configuration of the various Operational Reporting parameters, such as the selection
of BICs to be covered by the Reporting licence and the management of the Reporting
permission of operator profiles
• enable the triggering, running, and storage of reports via the Reporting GUI of the Message
Management package or the command-line tool. Based on user input, the installed reports
extract the relevant data from the Reporting data store and assemble it into reports using the
Reporting engine. These reports can be either delivered directly on-screen to the user in PDF,
XLS, or CSV format (when launched from the GUI), sent by e-mail, printed, or stored on disk for
later use.

17 December 2021 264


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

Audience
There are two distinct types of users of Reporting:
• Alliance Access administrators, who can enable the Reporting function (using an evaluation
period or licensing option) and assign the global Reporting permission to Alliance Access
operators
• operators, who do not require IT knowledge in order to run reports and create reusable report
templates

Alliance Access Operational Reporting


Alliance Access Operational Reporting provides the following:
• a framework for accessing the Reporting data store, which is part of the Alliance Access
database
• a reporting engine for generating reports
• report bundles that contain report definitions
• a command-line tool for running reports from templates and manually deleting old message
data in the Reporting data store

Alliance Web Platform


The Alliance Web Platform hosts the Alliance Access Operational Reporting application, which
allows administrators to administer reporting by means of the Alliance Access Configuration GUI,
including the following tasks:
• assign the Reporting permission to operators.
• select the BICs used for Reporting
The Alliance Web Platform allows operators to perform tasks such as:
• view ready-to-use reports
• select a report to run from the list of ready-to-use reports
• create and run their own reusable report templates
• specify and change values for report (either ready-to-use or report template) parameters, which
are used to filter and/or group the information provided by the report
• run reports in either foreground mode (in which the report output can be displayed on screen, or
stored on disk, in the selected output format) or in background mode (in which you are only
notified of the report completion)
• save the report in PDF or XLS format (List reports can also be saved in comma-separated value
(CSV) format).
• distribute the report by e-mail

15.1 Ready-to-Use Reports


Overview
Reporting provides a set of ready-to-use reports that can help address the operational needs of an
Alliance Access administrator. These reports include:
• end-of-day reports, which provide different ways of identifying message exceptions. These
reports are typically run at the end of the day to resolve such exceptions (although they can be
run at any time).

17 December 2021 265


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

• message reconciliation reports, which are typically used by the business applications
exchanging messages with Alliance Access. These reports help reconcile the message network
status information that is present in the back office with the information available in Alliance
Access.
• statistical reports, which provide the volume of messages grouped into various criteria. In terms
of the complete volume of traffic, these reports can provide hourly statistics on traffic, traffic
evolution, and day peaks. In terms of individual messages, they can help the administrator
understand how various systems are using Alliance Access, as well as the ratio of manually
created messages versus back-office flows.
In addition, reports can be classified by type:
• list reports: reports that list the details of one or more messages that match specific criteria.
Selected message fields are shown in a tabular format. These messages can be grouped into
different categories that are specific to the report type. Each group lists all associated
messages.
• statistical reports: reports that provide statistical information (most often, message counts) of a
set of messages that match specific criteria. These reports can group messages for further
statistics consolidation, where appropriate. For example, NAK statistics can be grouped by
either message partner, creating operator or unit, or NAK category, depending on the report.
To date, a set of ready-to-use operational management reports are provided with Reporting, as
listed in the following table. All of these ready-to-use reports handle MT messages only.
Ready-to-use report details

Report Type Report Category Report Name Report Title

Statistical Exception Statistics - FIN NAK-rate-STP NAK Rate - STP


Messages

NAK-rate-man NAK Rate - Manual


Messages

NAK-reason NAK Error Codes by


Reason

PDE-to-STP PDE Rate to SWIFT -


Manual

PDE-to-man PDE Rate to SWIFT -


Manual

PDE-from-corr PDE Rate from SWIFT

PDM-from-LT PDM Rate from SWIFT

Excep-to-STP Exception Rate to SWIFT


- STP

Excep-to-man Exception Rate to SWIFT


- Manual

Excep-from-corr Exception Rate from


SWIFT

17 December 2021 266


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

Live-msgs-summ Summary of Live


Messages

Live-msgs-summ-fin Financial Summary of


Live Messages

Statistical (continued) Capacity Management - Avg-pro-to-STP Average Processing Time


FIN to SWIFT - STP

Avg-rou-to-STP Average Roundtrip Time


to SWIFT - STP

Avg-pro-to-man Avg. Processing Time to


SWIFT - Manual

Avg-pro-from-STP Average Processing Time


from SWIFT - STP

Msg-vol-FIN FIN Message Volume

Pro-List-From-STP STP Processing Time


From SWIFT

Capacity Management - Msg-vol-FA FileAct Message Volume


FA
Pro-List-To-STP-FA STP Processing Time To
SWIFTNet

Pro-List-From-STP-FA STP Processing Time


from SWIFTNet

List Audit - FIN MIR-list MIR List - Messages Sent


to SWIFT

MOR-list MOR List - Messages


Received from SWIFT

Oper-act-list Operator Activity List

Msg-act-list Message Activity List

Exception Handling - FIN Live-to-STP Live Messages to SWIFT


- STP

Live-to-man Live Messages to SWIFT


- Manual

Live-from-corr Live Messages from


SWIFT - Correspondent

Live-to-SWIFT-NAK Live STP Messages to


SWIFT - NAK

Live-to-man-NAK Live Manual Messages to


SWIFT - NAK

17 December 2021 267


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

Emi-stat-STP Emission Status - STP

FINCopy-Status-S FINCopy message status


- Sender

FINCopy-Status-C FINCopy message status


- Central Institution

Exception Handling - FA Emi-stat-STP-FA Emission status of


Outgoing STP messages

Ready-to-use report descriptions

Report Name Report Description

NAK-rate-STP This report provides the count and rate of Straight Through
Processing (STP) messages sent to SWIFT that have
been NAKed. The results are grouped by message
partner, which represents the emitting business
application.
The purpose of this report is to identify the business
applications that have created the highest number and
highest proportion of invalid messages, and that therefore
require the most intervention. This report will help you
prioritise the improvements that can be made on the STP
flows.

NAK-rate-man This report provides the count and rate of manual


messages sent to SWIFT that have been NAKed. The
results are grouped by creating operator or unit.
The purpose of this report is to identify the operators and
units that have created the highest number and highest
proportion of invalid messages, and that therefore require
the most intervention. This report will help you prioritise the
improvements that can be made on the manual flows.

NAK-reason This report provides a list of all NAK codes encountered for
messages sent to SWIFT, along with their corresponding
number of occurrences. The results are grouped by NAK
category.
The purpose of this report is to identify which NAK codes
are the most frequent, and that therefore require the most
intervention. This report will help you prioritise the
improvements that can be made on message formatting.

17 December 2021 268


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

PDE-to-STP This report provides the count and rate of Straight Through
Processing (STP) messages that have been sent to
SWIFT with a Possible Duplicate Emission (PDE) flag. The
results are grouped by message partner, which represents
the emitting business application.
The purpose of this report is to identify the business
applications that have produced the highest number and
highest proportion of PDE messages, either by explicitly
flagging the message as a PDE or by re-sending the same
message (which causes Alliance Access to automatically
flag the message as a PDE). This report will help you
prioritise the improvements that can be made on the STP
flows.

PDE-to-man This report provides the count and rate of manual


messages that have been sent to SWIFT with a Possible
Duplicate Emission (PDE) flag. The results are grouped by
creating operator or unit.
The purpose of this report is to identify the operators and
units that have produced the highest number and highest
proportion of PDE messages, either by explicitly flagging
the message as a PDE or by re-sending the same
message (which causes Alliance Access to automatically
flag the message as a PDE). This report will help you
prioritise the improvements that can be made on the
manual flows.

PDE-from-corr This report provides the count and rate of messages that
have been received from SWIFT with a Possible Duplicate
Emission (PDE) flag. The results are grouped by emitting
correspondent.
The purpose of this report is to identify the correspondents
that have sent the highest number and highest proportion
of PDE messages. This report will help you prioritise the
correspondent interactions that can be improved.

PDM-from-LT This report provides the count and rate of messages that
have been received from SWIFT with a Possible Duplicate
Message (PDM) flag. The results are grouped by logical
terminal.
The purpose of this report is to identify trends in the
occurrences of PDM messages in order to establish the
root cause of the problem (logical terminal, network
provider, and so on). This report will help you prioritise the
investigations that should be performed.

17 December 2021 269


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

Excep-to-STP This report provides the count and rate of Straight Through
Processing (STP) messages sent to SWIFT that have
passed through an exception queue at some point in time.
The results are grouped by message partner, which
represents the emitting business application.
The purpose of this report is to identify the business
applications that have created the highest number and
highest proportion of invalid messages, and that therefore
require the most intervention. This report will help you
prioritise the improvements that can be made on the STP
flows.

Excep-to-man This report provides the count and rate of manual


messages sent to SWIFT that have passed through an
exception queue at some point in time. The results are
grouped by creating operator or unit.
The purpose of this report is to identify the operators and
units that have created the highest number and highest
proportion of invalid messages, and that therefore require
the most intervention. This report will help you prioritise the
improvements that can be made on the manual flows.

Excep-from-corr This report provides the count and rate of messages


received from SWIFT that have passed through an
exception queue at some point in time. The results are
grouped by emitting correspondent.
The purpose of this report is to identify trends in message
reception errors in order to establish the root cause of the
problem. This report will help you prioritise the
correspondent interactions that can be improved.

Live-msgs-summ This report provides a summary of all of the messages that


are still live in Alliance Access. The results are grouped by
flow (from SWIFT or to SWIFT) and by queue.
The purpose of this report is to provide an easy-to-read
summary view of all of the messages that are still in-
progress in Alliance Access, which could potentially reveal
the presence of a problem (messages "piling up"). This
report will help you prioritise the interventions required on
outstanding queues.

Live-msgs-summ-fin This report provides a financial summary of all of the


messages that are still live in Alliance Access. The results
are grouped by flow (from SWIFT or to SWIFT) and by
message type.
The purpose of this report is to provide an easy-to-read
summary view of the financial value that is still in-progress
in Alliance Access, which could potentially reveal the
presence of a problem (messages "piling up"). This report
will help you prioritise the interventions required on
outstanding currencies.

17 December 2021 270


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

Avg-pro-to-STP This report provides the average time to process Straight


Through Processing (STP) messages sent to SWIFT, from
the moment they are received by Alliance Access to the
moment they are sent to SWIFT (and either ACKed or
NAKed). The results are grouped by message partner,
which represents the emitting business application.
The purpose of this report is to identify any potential
latency issues with regard to the service levels provided by
Alliance Access for processing outgoing messages. This
report will help you prioritise the improvements that can be
made on the STP flows.

Avg-rou-to-STP This report provides the average round-trip time for


Straight Through Processing (STP) messages sent to
SWIFT, from the moment they are received by Alliance
Access to the moment the associated ACK or NAK is sent
by Alliance Access back to the emitting business
application. The results are grouped by message partner,
which represents the emitting business application.
The purpose of this report is to identify any potential
latency issues with regard to the service levels provided by
Alliance Access for processing outgoing messages. This
report provides a more complete view than what is
obtained from the Average Processing Time to SWIFT -
STP (Avg-pro-to-STP) report, because it takes into account
the return trip of the ACK or NAK. This report will help you
prioritise the improvements that can be made on the STP
flows.

Avg-pro-to-man This report provides the average time to process manual


messages sent to SWIFT, from the moment they are
created in Alliance Access to the moment they are sent to
SWIFT (and either ACKed or NAKed). The results are
grouped by creating operator or unit.
The purpose of this report is to analyse the average time to
fully process outgoing manual messages, which can vary
significantly, because messages can sometimes stay in
intermediate queues for a long period of time. This report
will help you prioritise the improvements that can be made
on the manual flows.

Avg-pro-from-STP This report provides the average time to process Straight


Through Processing (STP) messages received from
SWIFT, from the moment they are received by Alliance
Access to the moment they are sent back to the business
application. The results are grouped by logical terminal.
The purpose of this report is to identify any potential
latency issues with regard to the service levels provided by
Alliance Access for processing incoming messages. This
report will help you prioritise the improvements that can be
made on the STP flows.

17 December 2021 271


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

MIR-list This report provides a list of all of the messages sent to


SWIFT. The results are grouped by logical terminal.
The purpose of this report is to provide a trace of all of the
messages that were sent to SWIFT during the specified
time period. This report will help you generate an audit trail
of SWIFT messages.

MOR-list This report provides a list of all of the messages received


from SWIFT. The results are grouped by logical terminal.
The purpose of this report is to provide a trace of all of the
messages that were received from SWIFT during the
specified time period. This report will help you generate an
audit trail of SWIFT messages.

Live-to-STP This report provides a list of all of the Straight Through


Processing (STP) messages sent to SWIFT that are still
live in Alliance Access. The results are grouped by
message partner, which represents the emitting business
application.
The purpose of this report is to identify messages that are
still in-progress in Alliance Access and that may require
intervention. This report will help you prioritise the
interventions required for the messages that are currently
still live.

Live-to-man This report provides a list of all of the manual messages


sent to SWIFT that are still live in Alliance Access. The
results are grouped by last modification operator or unit.
The purpose of this report is to identify messages that are
still in-progress in Alliance Access and that may require
intervention. The last modification operator is shown in
order to speed up the root-cause analysis. This report will
help you prioritise the interventions required for the
messages that are currently still live.

Live-from-corr This report provides a list of all of the messages received


from SWIFT that are still live in Alliance Access. The
results are grouped by correspondent and message type.
The purpose of this report is to identify messages that are
still in-progress in Alliance Access and that may require
intervention. This report will help you prioritise the
interventions required for the messages that are currently
still live.

Live-to-STP-NAK This report provides a list of all of the Straight Through


Processing (STP) messages sent to SWIFT that are still
live in Alliance Access after being NAKed by SWIFT. The
results are grouped by message partner, which represents
the emitting business application.
The purpose of this report is to identify the messages that
are still in-progress in Alliance Access due to an invalid
format and that therefore require intervention. This report
will help you prioritise the interventions required for the
messages that are currently still in a NAK state.

17 December 2021 272


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

Live-to-man-NAK This report provides a list of all of the manual messages


sent to SWIFT that are still live in Alliance Access after
being NAKed by SWIFT. The results are grouped by
creating operator or unit.
The purpose of this report is to identify the messages that
are still in-progress in Alliance Access due to an invalid
format and that therefore require intervention. This report
will help you prioritise the interventions required for the
messages that are currently still in a NAK state.

Emi-stat-STP This report provides a list of all of the Straight Through


Processing (STP) messages sent to SWIFT, along with
their corresponding emission status. The results are
grouped by message partner, which represents the
emitting business application.
The purpose of this report is to reconcile the SWIFT
transmission status of messages at the level of Alliance
Access against their status at the level of the emitting
business application. This report will help you identify any
inconsistencies between Alliance Access and the business
application.

Oper-act-list This report provides a list of manual operations (creation,


verification, authorisation, modification, and completion)
performed by the specified operators or units on messages
sent to SWIFT. The results are grouped by operator or unit.
The purpose of this report is to identify trends in the
different operations performed by different operators and
units on Alliance Access. This report eases the generation
of audit trails of operations performed by Alliance Access
operators and units.

Msg-act-list This report lists all of the FINCopy messages sent, along
with their delivery status. As a result of the reconciliation
between these FINCopy messages and MTs 019/012, the
delivery status also indicates whether the messages were
accepted or rejected by the central institution.
This report will help you identify all of the FINCopy
messages that failed to be delivered.

Msg-vol-FIN This report provides the volume of FIN messages sent and
received for each own destination.
The purpose of this report is to provide statistics on
message flows. This report will also help you cross-charge
the various destinations.

Msg-vol-FA This report provides the volume of FileAct messages sent


and received for each own destination.
The purpose of this report is to provide statistics on
message flows. This report will also help you cross-charge
the various destinations.

17 December 2021 273


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

FINcopy-Status-S This report lists all of the FINCopy messages sent, along
with their delivery status. As a result of the reconciliation
between these FINCopy messages and MTs 019/012, the
delivery status also indicates whether the messages were
accepted or rejected by the central institution.
This report will help you identify all of the FINCopy
messages that failed to be delivered.

FINcopy-Status-C This report lists all of the MT096 messages received within
the specified time range, along with their reconciled status
(Accepted / Rejected / No MT097). The results are
grouped by service code.
This report will help you identify messages to be treated.

Pro-List-To-STP This report provides the processing and round-trip times of


all of the Straight Through Processing (STP) messages
sent to SWIFT, within the specified time range. The
processing time is the elapsed time from the moment a
message is received by Alliance Access to the moment it
is sent to SWIFT (and either ACKed or NAKed). The
round-trip time is the elapsed time from the moment a
message is received by Alliance Access to the moment the
associated ACK or NAK is sent by Alliance Access back to
the emitting business application.
The purpose of this report is to highlight the messages for
which the processing time is high and to identify trends.
This report will help you prioritise the improvements that
can be made on the STP flows.

Pro-List-From-STP This report provides the processing time of all of the


Straight Through Processing (STP) messages received
from SWIFT, within the specified time range. The
processing time is the elapsed time from the moment a
message is received by Alliance Access to the moment it
is sent back to the business application.
The purpose of this report is to highlight the messages for
which the processing time is high and to identify trends.
This report will help you prioritise the improvements that
can be made on the STP flows.

Pro-List-To-STP-FA This report provides the processing and round-trip times of


all of the FileAct Straight Through Processing (STP)
messages sent to SWIFTNet, within the specified time
range. The processing time is the elapsed time from the
moment a message is received by Alliance Access to the
moment it is sent to SWIFTNet (and either ACKed or
NAKed). The round-trip time is the elapsed time from the
moment a message is received by Alliance Access to the
moment the associated ACK or NAK is sent by Alliance
Access back to the emitting business application.
The purpose of this report is to highlight the messages for
which the processing time is high and to identify trends.
This report will help you prioritise the improvements that
can be made on the STP flows.

17 December 2021 274


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

Pro-List-From-STP-FA This report provides the processing time of all of the


FileAct Straight Through Processing (STP) messages
received from SWIFTNet, within the specified time range.
The processing time is the elapsed time from the moment
a message is received by Alliance Access to the moment it
is sent back to the business application.
The purpose of this report is to highlight the messages for
which the processing time is high and to identify trends.
This report will help you prioritise the improvements that
can be made on the STP flows.

Emi-stat-STP-FA This report provides a list of all of the Straight Through


Processing (STP) messages sent to SWIFTNet, along with
their corresponding emission status. The results are
grouped by message partner, which represents the
emitting business application.
The purpose of this report is to reconcile the transmission
status of messages at the level of Alliance Access against
their status at the level of the emitting business application.
This report will help you identify any inconsistencies
between Alliance Access and the business application.

17 December 2021 275


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

When a report is run, the output includes a cover page and the results of the query. Following is a
sample cover page of a report in PDF:

Sample cover page

A cover page includes the following information:


• title of the report run (for example, NAK Error Codes by Reason). This name is also displayed
as a header on each page of the report. You can change this title with each run of the report. If
you save the report as a template, each subsequent time that you run the report the same title
is used, unless you update it.
• description of the report run (for example, This report provides a list of all NAK codes
encountered for messages sent to SWIFT, along with their corresponding number of
occurrences. The results are grouped by NAK category. The purpose of this report is to identify
which NAK codes are the most frequent, and that therefore require the most intervention. This
report will help you prioritise the improvements that can be made on message formatting.). You
can change this description with each run of the report. If you save the report as a template,

17 December 2021 276


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

each subsequent time that you run the report the same description is used, unless you update
it.
• short name of the report (for example, NAK-reason)
• category of the report (for example, Exception Statistics - FIN)
• operator who ran the report (for example, opAll)
• output filename of the report (for example, NAK-reason-opAll-20130626-1355.pdf)
• run on, which is the date and time that the report was run (for example, 26/06/13 13:55)
• version, which is the build version information from the report definition (for example, 3.0.1)
• parameters used in the report (such as Start Date and End Date)
Following is an excerpt of typical results from the NAK Error Codes by Reason ready-to-use report:

Excerpt of report

Report rules
The following rules are common to all reports:
• In Adobe PDF, the cover page is the first page of the report. In Microsoft Excel (XLS) format, the
cover-page information is displayed at the beginning of the Report sheet.
• For table layouts (in PDF only), after each table, there are one or more summary rows
summarising the table data rows.

17 December 2021 277


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

• Priority is the network priority, which is either S (System), N (Normal), or U (Urgent).


• In PDF only, numbers and amounts use the thousands and decimals separators that are
configured in Alliance Access by means of the Amount global system configuration parameter
(in the BSA component, Display Format class).
• In statistical (count) reports, the column containing the rate of messages (XXX Rate) with the
feature in the group of messages is in the uppermost right-hand column and is sorted in
descending order. The intermediary columns contain (from left to right): XXX Count (the count of
messages with the feature in the group) and No. of Messages (the total number of messages in
the group). In PDF only, the XXX Rate value in the Summary row is calculated on the total
messages across all groups (the weighted average) and is not the simple arithmetical average
of the rates of all of the individual data rows.
• In statistical (sum) reports (in PDF only), the No. of Messages values in the Summary row are
calculated on the total messages across all groups (and are the arithmetical sums of all of the
No. of Messages values in the data rows).
• In statistical (time) reports (in PDF only), the Avg Time value in the Summary row is calculated
on the total messages across all groups (and is not the simple arithmetical average of the Avg
Time of all of the individual data rows).
• In statistical reports (in PDF only), the NAK Count value in the Summary row is the sum of the
NAK Count values of all of the data rows.
• Date formats are configured in Alliance Access by means of the Date global system
configuration parameter (in the BSA component, Display Format class).
• The creation time shown for messages is in Coordinated Universal Time (UTC).
• Manual and STP reports do not contain Integration Platform (IPLA) or Alliance Developers
Toolkit (ADK) messages (except for ADK MQSA messages, which are included in STP reports).
To include ADK MQSA messages in STP reports, perform either of the following:
- Using the New button of the Message Partner parameter, specify one or more specific
MQSA queues whose messages must be included in the report. In this way, the report
includes messages from the selected MQSA queues only.
- Leave the Selected box of the Message Partner parameter empty. In this way, the report
includes the messages of all MQSA queues.

15.2 Terminology
Term Definition

manual messages Messages that are created manually in Alliance Access using the
message-creation application in the Message Management package

post-processing option Contains the full definition of the post-processing rules (for e-mail
distribution) of a report, namely:
• its type (either the notification of the report run by e-mail, or the
transmission of the results of the report by e-mail)
• the list of parameters for which you can or must provide a value for
the post-processing option to execute (for example, one or more e-
mail addresses in the case of e-mail distribution)

17 December 2021 278


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

report category Indicates the general purpose of a set of reports. A report category can
contain several reports. A report belongs to only one category (for
example, audit, exception statistics, or capacity management).

report definition Contains the full definition of a report, namely:


• the report category
• the report name (maximum length of 20 characters)
• the report title (maximum length of 40 characters), which you can
modify before running a report
• the report description (maximum length of 4000 characters), which
you can modify before running a report
• the report version
• the list of parameters. For each parameter, the report definition
provides:
- the name of the parameter
- the format of the parameter and associated information
- the multiplicity (single versus multiple occurrence) of the
parameter
- if it is mandatory, the default value of the parameter
• the list of possible output formats for the results produced when
running the report
• the default output format (from the list of possible output formats)

report run A specific occurrence of the running of a report or report template,


including:
• the name of the report or report template
• the values used for the parameters of the report and of the post-
processing options
• a link to the output results

report template (My Report) A "recording" of the parameters of a report run, which can be reused as-
is or partially changed before usage, if desired. By creating templates
and defining reports that use relative dates, you can perform similar
report runs without re-creating reports from scratch.
A report template is associated with a single report and optionally with a
single post-processing option. Several report templates can be
associated with the same combination of reports and post-processing
options. In the Reporting GUI and command-line tool, report templates
are referred to as "My Reports".
A report template contains:
• the name of its associated report (maximum length of 20 characters)
• the title of its associated report (maximum length of 40 characters)
• the name of its associated post-processing options
• a set of values for the parameters of its associated report and a set
of values for the parameters of its associated post-processing
option. The set of values must be complete (that is, it must at least
contains a value for each parameter of the associated report or post-
processing option that is mandatory).

17 December 2021 279


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

Straight Through Processing All messages originating from a back office (that is, by means of a
(STP) messages message partner), including messages that are sent by a back office by
means of a manual message partner

15.3 Set Up and Manage the Reporting Data Store


Overview
When Reporting is activated (that is, when the Alliance Access global system configuration
parameter Activate Reporting is switched on), all live message tables in the Alliance Access
database are automatically copied to the Reporting data store. This ensures that any reports will
include all message data present in the Alliance Access database from the time of the Reporting
activation. For message archives, you must restore them in order for them to be synchronised to
the Reporting data store. Depending on the number of messages in the database, the
synchronisation operation could take a significant amount of time. When the initial synchronisation
is complete, event 32013, <today's date> daily table synchronization is completed
(from the Reporting application), will be written to the Event Log. Event 32013 is also written to the
Event Log to inform you when restored message archives are being synchronised. Refer to "Event
logging" and "Tracing and logging" in this section for more information.
Note SWIFT recommends that you activate Reporting during a messaging maintenance
period in order to avoid impacting the normal message flow of Alliance Access. In
addition, you should not stop the Reporting component or reset the Activate
Reporting parameter while the messages present in the Alliance Access database
are being copied to the Reporting data store.

Relicensing and evaluating Reporting


In order to use Reporting, you need to relicense Alliance Access to include it.
Note You can also evaluate the Reporting functionality for 90 days without using a license.
See the following section for details.

Starting the evaluation period


In order to start the Reporting evaluation period, retrieve the activation code (see Knowledge Base
Tip 5017441).

17 December 2021 280


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

To apply the activation code, perform the following steps:


1. In Alliance Access Configuration, under System, select Parameters. For the RPT component,
select Start Evaluation.

Starting the evaluation

2. Enter the activation code that SWIFT has provided. Note that the valid activation codes are not
case-sensitive. Click Save .

Entering the activation code

17 December 2021 281


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

3. Refresh the Parameter window by clicking Submit and then returning to the window. The
Activate Reporting parameter is now visible. Note that the Start Evaluation parameter
remains visible until the next restart of the server.

Refreshing the Parameter window

4. Select the Activate Reporting parameter and set it to Activate.

Activating Reporting

5. Proceed with the steps in the following sections.


When the 90-day evaluation period has started and 15 days before it expires, if there is no
Reporting licence, then events are logged on a daily basis in the Event Log to remind you to
purchase a Reporting licence in order to continue Reporting after the expiration of the evaluation
period.
When the evaluation period ends and you have no Reporting licence, Alliance Access
automatically switches off the Activate Reporting configuration parameter.
To use the Reporting functionality once the evaluation period has ended, you must purchase a
Reporting licence and enter the activation code that SWIFT provides. This licence enables
Reporting for a specific (banded) maximum number of BICs, either 5, 10, 20, 50, or all BICs. This
number can differ from the number of destinations licensed in the Alliance Access instance.

17 December 2021 282


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

Granting permissions to operators


In order to access the parameters and templates of the Reporting application, following are the
required permissions for the profile of the Reporting operator:
• Access Control > Sign On
• Message File > Search, which is required only if the operator is to run reports
• Reporting > View Oper Reports
• Security Definition
• SWIFT Support > Own Destination List
• Application Interface > Open/Print Partner

Activating Reporting
When you activate Reporting (by switching on the Activate Reporting configuration parameter):
• Live message data becomes available for reporting in the Reporting data store.
• You must restore message archives in order to synchronise them with the Reporting data store.
• If you have the Reporting permission, the Alliance Access Operational Reporting GUI becomes
visible and can be used, along with the saa_report command-line tool.
Note In order to activate (or deactivate) Reporting, an operator requires System
Management permission.
Once Reporting is activated, all messages are copied to the reporting data store. When the initial
synchronisation is complete, event 32013, <today's date> daily table synchronization is
completed (from the Reporting application), will be written to the Event Log. Event 32013 is also
written to the Event Log to inform you when restored message archives are being synchronised.
Refer to "Event logging" and "Tracing and logging" in this section for more information.

Selecting BICs for Reporting


Your Reporting license determines the number of BICs that you can select, either 5, 10, 20, 50, or
all BICs.
Note In order to select BICs, an operator requires System Management permission.
After activating Reporting, you must explicitly select the BICs to be covered by Reporting, from the
live and T&T destinations that are licensed in the Alliance Access instance. To do so, perform the
following steps:
1. In Alliance Access Configuration, under System, select Reporting - BIC selection.

Selecting BICs

2. Select the desired set of BICs by moving them from the Available list box to the Selected list
box, then click Save .

17 December 2021 283


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

During the evaluation period, you can select any (or all) licensed live and T&T BICs.
Outside of the evaluation period, you can select any number of licensed T&T BICs (regardless of
your Reporting band), but the number of live licensed BICs that you can select is limited by your
Reporting band. For example, if you have 10 licensed live BICs and 8 licensed T&T BICs, and you
have a Reporting band for 5 BICs, you can select a maximum of 5 live BICs in addition to as many
T&T BICs as you wish.
Using the BIC Selection for Reporting application, you can change your selection of BICs
(subject to your licence) at any time, but you need to restart Alliance Access before any new BIC
selection is effective.

Deactivating Reporting
When you deactivate Reporting (by switching off the Activate Reporting configuration
parameter):
• The Reporting data store is automatically emptied of all messages.
• The Reporting component is automatically stopped and is no longer visible in the list of Alliance
Access components that you can start and stop.
• Your BIC selection is reset.
Note In order to deactivate Reporting, an operator requires System Management
permission.
You can stop or start the Reporting component for maintenance purposes when necessary.
However, the component must not be stopped when Reporting data is being initialised (that is,
when the Alliance Access database is initially copied in full to the Reporting data store). In addition,
it is recommended that you do not stop the Reporting component for extended periods when
Reporting is activated, because an excessive amount of data synchronisation could be required
upon restart.
Tip Stopping the Reporting component temporarily stops the synchronisation of data only.
Deactivating Reporting stops the component and erases all of the existing reporting
data. If you reactivate Reporting, a complete synchronisation must be performed
again, which could take a significant amount of time to complete, and you must re-
select your BICs for reporting.

Reporting on messages
When Reporting is activated, the details of all of the messages that undergo a change in the
Alliance Access database are copied to the Reporting data store. This copy overwrites any
messages in the Reporting data store if they already exist there.
The following message changes are considered for copying to the Reporting data store:
• addition (following the reception of a new message from the back office or from SWIFT/
SWIFTNet, or following manual creation)
• update (modification, verification, or approval of a message; or addition or update of an
intervention)
• completion

Reporting on restored or recovered data


After a full database restore or a partial database restore with messages and events cleanup (the -
e y option), Reporting is automatically deactivated. If you want to continue to use Reporting,
Reporting must be reactivated (with the Activate Reporting parameter) to re-initialise the
Reporting store with all of the (mostly archived) messages present in the Alliance Access
database.

17 December 2021 284


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

The restored archive data does not contain the name of the Alliance Access instance that the
restored archive comes from (namely, the Alliance Access instance in which the archives were last
backed up). The restoration of archives coming from different Alliance Access instances is not
recommended, because there is the risk of overwriting messages with the same identifier in the
Alliance Access instance in which the archive is restored.
Note When an archive is removed from Alliance Access, the messages it contains are not
removed from the Reporting data store.
Similarly, during a database recovery, reporting is automatically deactivated. If you want to continue
to use Reporting, Reporting must be reactivated (with the Activate Reporting parameter) to re-
initialise the Reporting store with all of the messages present in the Alliance Access database.

Message data filtering


When a report is run, a message and information from all of its instances are included in the report
if all of the following conditions are met:
• The Sender BIC (for messages to SWIFT) or the Receiver BIC (for messages from SWIFT)
must be explicitly allowed or not explicitly prohibited in the Own BIC permission detail of the
Message Search permission in the profile of the operator in whose name the report is run.
• The Sender BIC (to SWIFT) or the Receiver BIC (from SWIFT) is one of the BICs that is
selected for reporting.
• At least one instance of the message has a unit in common with the operator in whose name
the report is run.

Event logging
Events related to Reporting are logged in the Event Log when:
• initial activation data or restored message archives are being synchronised
• the evaluation period starts or expires
• if there is no Reporting licence and 15 days before the expiration of the evaluation period, to
remind you to purchase a Reporting licence in order to continue Reporting after the evaluation
period expires.
• Reporting is activated or deactivated
• the BIC selection is changed
• a report template is created, updated, or deleted
• a report run is deleted or completed (either successful or failed)
• rpt_trace is set or reset
• saa_rpt -purge is started or completed

Tracing and logging


The rpt_trace command-line tool allows you to set (activate) or reset (deactivate) tracing related
to Reporting. The syntax of the command is: rpt_trace [-set | -reset | -help].
The tool logs event 32012 whenever it is set or reset. Once set, tracing is performed continuously
until it is explicitly reset with the tool.
User credentials are mandatory to launch the rpt_trace command line.
It must be launched on the machine where Alliance Access is installed.
Activating trace collects any available trace and debug-related information, in addition to the details
of info, warning, and error statements that are normally provided in the rpt.log file, which is an
application server log file. When you install Reporting, the default properties for this file are set,

17 December 2021 285


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

including its name (rpt.log), location (/$ALLIANCE/log/rpt), threshold level ("INFO" or higher)
and maximum size (100 MB). A maximum of 10 versions of the rpt.log file are maintained at any
one time.
The output of tracing does not include highly confidential information such as passwords. However,
trace output may contain message-payload information. Trace files, which are also added to the /
$ALLIANCE/log/rpt directory, are named rpt_trace.log.n. A maximum of 100
rpt_trace.log.n files are maintained at any one time.

Report queuing
Reports that you launch are run sequentially. When a report is running and you launch a second
report, the launch of the second report is queued until the first report completes. A maximum of 10
report launches can be queued. Once this limit is reached and you attempt to run another report,
you will receive an error message informing you to wait before launching further reports.

15.4 Manage Reports from the Reporting GUI


The Reporting GUI is accessed from the Alliance Message Management package. Under the
Search and Report category, select the Reporting link.
Note The Reporting permission is required in order to view and access the Reporting GUI.

Alliance Message Management main window

15.4.1 View Available Reports


Overview
To view a list of the ready-to-use reports that are available, arranged by report category, expand
Available Reports in the left-hand pane.

17 December 2021 286


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

Select a report to view


Select a report name to view the details of a particular report (for example, the Live-to-STP-NAK
(Live STP Messages to SWIFT - NAK) report under the Exception Handling category).

Available Reports - Report Parameters

Specify the report parameters


On the Report Parameters window, you can view or update the report title and description, as well
as the reporting execution criteria for the report, such as message partners and dates. The default
value of each mandatory parameter is initially displayed. You can modify these values before
running or saving the report.
If applicable to the current report, a double list box is displayed that enables you to use data from
the Alliance Access configuration tables. The Available list box (on the left-hand side) lists all of
the parameter's entities that exist in the Alliance Access configuration tables.
• To move the entities that it contains to the Selected list box (on the right), select one or more
entities and then click > . To select multiple non-adjacent or adjacent entities, hold down the
Ctrl or Shift key on your keyboard while selecting, respectively. To move all of the entities to the
Selected list box, click >> .
• Use the < or << button to move items from the Selected list box back to the Available list
box.
• Use the New button to add to the Selected list box (one at a time) entities other than those
listed in the Available list box. If you later remove such an entity from the Selected list box
using < or << , it is removed from the Selected list box but is not moved to the Available list
box, because the removed entity did not originate in the Alliance Access configuration tables.
For information on entering absolute and relative dates, see Rules for Specifying Dates on page
293.
When you start to update the report parameters, the Cancel button is displayed. Click Cancel to
cancel any unsaved updates that you have made to the report parameters. This button is not
available when parameters have already been saved as a template.

17 December 2021 287


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

Specify the output settings


On the Report Output Settings window, you can view or update the report's output settings, such
as the output format and delivery method.

Available Reports - Report Output Settings

In the Output format field, the default output format for the ready-to-use report is initially displayed,
but you can modify this value before running or saving the report. Select the desired format, either
PDF (Adobe), .xlsx (Microsoft Excel), CSV (comma-separated value), .docx (Microsoft Word), or
Browser. The CSV format is available for List reports only. The Browser format displays the report
run results in your browser, which can be further exported to PDF, Word, XLS, or CSV format. The
Browser format is available only Accounts and Inbox/Outbox reports. The available output formats
can vary with each ready-to-use report.
Note A maximum of 65,536 rows can be displayed within a report in XLS format.
Reporting automatically provides a unique name for the report, composed of the ready-to-use
report name, the operator name, and a date-and-time timestamp, in the format
<AvailableReportName>-<OperatorName>-<YYYYMMDD>-<HHMM>.

To specify the delivery method for a report:


• Select the E-mail Distribution check box if the report output should be sent by means of e-
mail, then specify one or more e-mail addresses, separated by commas. Select Yes for
Notification E-mail Only? if the report results should not be sent, but rather an e-mail should
be sent notifying the recipient that the report is complete and available for viewing or
downloading from the History of Reports Run window. If you select No for Notification E-mail
Only?, the report results are included with the e-mail as an attachment.

17 December 2021 288


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

Note When you select Notification E-mail Only?, ensure that you enter your own e-mail
address, because the only other location where the report results can be found is the
History of Reports Run window, where operators can see only the report runs that
they have personally launched. When a report run fails, no e-mail is sent.
If you select E-mail Distribution (regardless of whether you select Notification E-
mail Only? or not), then the system configuration parameter Mail Server must be
configured. For more information, see the classes of configuration parameters in the
Configuration Guide.
SWIFT does not protect the confidentiality of e-mails, which is the customer's
responsibility. If you wish avoid usage of this e-mail delivery method, do not configure
an e-mail server address in Alliance Access. For more information, see the
appropriate Installation Guide: AIX Linux Windows.

Run the report and view the output


When you click Run, a dialog box is displayed that indicates that the report is running. Click
Continue in background to run the report in background mode. You will be notified when the report is
complete by means of the Web Platform notification mechanism. Otherwise, a pop-up is displayed
that provides you with the option to open the report output on-screen in the format you have
specified or to store it.
Click Save to My Reports to save the report with the current parameters. In the dialog box that is
displayed, specify a new, unique report name, then click Save .

15.4.2 View History of Reports Run


Overview
To see a list of the reports that have been launched (by the current operator) from either the GUI or
the saa_report command-line tool, select History of Reports Run in the left-hand pane.
Operators can see only their own report runs.

History of Reports Run

17 December 2021 289


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

Using the interface


You can filter this list by selecting values from the Report Category, Report Name, and Status
reporting criteria drop-down lists at the top of the window. Click Search to filter the list according to
your criteria, or click Clear to clear the filtering criteria before searching. If you select a report
category for filtering, further filtering on report names is available only on the reports of the selected
category.
The list of reports is arranged in descending order of the start date and time.
Click the icon in the Download column next to the report name to see the output results in the
format that was specified when you ran the report. This icon appears only if the report has
completed and is available on the server.
If the report was run from Available Reports (see View Available Reports on page 286), the
Report name column contains the ready-to-use report name. If the report was run from My
Reports (see View My Reports on page 290), the Report Name column contains the My Reports
name.
The Status column contains the report status, either Submitted, Started, Completed, or Failed.
To delete one or more reports from the history of reports run (along with the resulting output file),
select the check box corresponding to the report, then click Delete . This button is available only
when the selected report run (or runs) has a status of either Completed or Failed.
Note Because the list contains only the reports that the current operator has run, an
operator can delete only the report runs for that operator.
To refresh this list with the latest history of reports run, click Refresh .

15.4.3 View My Reports


Overview
To view a list of your saved reports (templates), expand My Reports in the left-hand pane.
Note This node is not displayed until you save a set of report parameters as a template.

17 December 2021 290


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

Select a saved report template


Select a saved report from the My Reports list.

My Reports - Report Parameters

Specify the report parameters


On the Report Parameters window, you can view or update the report title and description, as well
as message selection criteria for the report, for example, units and dates.
The values stored with the report are initially displayed. You can modify these values before
running or saving the report.
If applicable to the current report, a double list box is displayed that enables you to use data from
the Alliance Access configuration tables. The Available list box (on the left-hand side) lists all of
the parameter's entities that exist in the Alliance Access configuration tables.
• To move the entities that it contains to the Selected list box (on the right), select one or more
entities and then click > . To select multiple non-adjacent or adjacent entities, hold down the
Ctrl or Shift key on your keyboard while selecting, respectively. To move all of the entities to the
Selected list box, click >> .
• Use the < or << button to move items from the Selected list box back to the Available list
box.
• Use the New button to add to the Selected list box (one at a time) entities other than those
listed in the Available list box. If you later remove such an entity from the Selected list box
using < or << , it is removed from the Selected list box but is not moved to the Available list
box, because the removed entity did not originate in the Alliance Access configuration tables.
When you start to update the report parameters, the Cancel button is displayed. Click Cancel to
cancel any unsaved updates that you have made to the report parameters. This button is not
available when parameters have already been saved or saved as a template.
For information on entering absolute and relative dates, see Rules for Specifying Dates on page
293.

17 December 2021 291


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

Specify the report output settings


On the Report Output Settings window, you can view or update the report's output settings, such
as output format and delivery method.

My Reports - Report Output Settings

In the Output format field, the output format values stored with the report are initially displayed,
but you can modify this value before running or saving the report. Select the desired format, either
PDF (Adobe), .xlsx (Microsoft Excel), CSV (comma-separated value), .docx (Microsoft Word), or
Browser. The CSV format is available for List reports only. The Browser format displays the report
run results in your browser, which can be further exported to PDF, Word, XLS, or CSV format. The
Browser format is available only Accounts and Inbox/Outbox reports.
Note The available output formats can vary with each report.
Reporting automatically provides a unique name for the report, composed of the ready-to-use
report name, the operator name, and a date-and-time timestamp, in the format
<AvailableReportName>-<OperatorName>-<YYYYMMDD>-<HHMM>.

The report is placed in the path usrdata/report/results.


To specify the delivery method for a report:
• Select the E-mail Distribution check box if the report output should be sent by means of e-
mail, then specify one or more e-mail addresses, separated by commas. Select Yes for
Notification E-mail Only? if the report should not be sent, but rather an e-mail should be sent
notifying the recipient that the report is complete and available for viewing or downloading from
the History of Reports Run window. If you select No for Notification E-mail Only?, the report
results are included with the e-mail as an attachment.
In My Reports, the delivery method values that are initially displayed are the values that are stored
for the report.

Run the report and view the output


When you click , a dialog box is displayed that indicates that the report is running. Click
Run
Continue in backgroundto run continue running the report in background mode. You will be notified
when the report is complete by means of the Web Platform notification mechanism. If you click

17 December 2021 292


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

Close , the dialog is closed and the output of the report is displayed on screen in the format that you
have specified.
Click Save to save any changed values.
Click Save As to save the report (with any changed values) with a new name. In the dialog box that
is displayed, specify the new report name, then click Save .
Click Delete to delete the report template.

15.4.4 Rules for Specifying Dates


Overview
If a report requires the use of one or more date parameters, you can specify either an absolute
date (for example, 16 May 2012), with the assistance of a date picker, or a relative date (for
example, last month).
Dates use the time zone that is local to the Alliance Access server.

Format of absolute dates


You can express an absolute date (Absolute) as either YYYY/MM/DD or (-|+)[n](d|m|y). In the
latter case, as in the Message Search functionality of the Message Management package, (-|+)
[n](d|m|y) is changed to an absolute date when you tab away from the field. Date pickers are
available to assist you when entering absolute dates.

Example of absolute dates

Format of relative dates


You can express a relative date (Relative) as (LAST|CURRENT)[n](DAY|MONTH|YEAR), where n is
an integer that can be provided when LAST is used. If n is not specified when Last is used, its
value defaults to 1.

Example of relative dates

Following are some additional examples of relative dates (assuming that today is Tuesday, 22 June
2012):
• The last 2 months covers the period 1 April 2012 until 31 May 2012.
• The last 1 year covers the period 1 Jan 2011 till until 31 December 2011.
• The last 2 days covers the period 20 and 21 June 2012.
• The current month covers the period 1 June 2012 until 22 June 2012 (included).
• The current year covers the period 1 Jan 2012 until 22 June 2012 (included).
• The current day covers 22 June 2012.

Relative dates and templates


When you enter a relative date (for example, LAST 2 MONTH), the actual absolute starting and
ending dates (01 April 2012 and 31 May 2012, in the above example) that this relative date

17 December 2021 293


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

currently represents are displayed next to the field for information only (and are unavailable for
editing).
When you save the report parameters in a report template (by means of the My Reports window),
any relative dates that you have specified are saved with the template. If the report template is
used at a later date, the saved relative date is displayed as a relative date, along with the absolute
date that it currently represents (for example, on 14 July 2012, the absolute start and end dates
would be 1 May 2012 and 30 June 2012).

Date format on the front page of a generated report


The front page of report results always contains absolute dates for the date parameters, even if you
have specified relative dates for the parameters for the report. The format is defined in the Date
global system configuration parameter (in the BSA component, Display Format class).

15.5 Overview of the Reporting Command-Line Tool


Summary and usage
Using the command-line tool, you can perform the following:
• trigger the running of a report from a report template
• obtain a list of the ready-to-use reports that are available (either all reports or those in a
particular category)
• obtain a list of report templates and the name of the ready-to-use reports on which they were
built
• purge message data that is older than a specified number of days from the Reporting data store
To run the tool on Windows, run saa_report.cmd. On AIX or Linux, run saa_report. Use the
syntax in the following sections to run commands.

Prerequisites
Following are the prerequisites for using this tool:
• The tool must be launched by any operating system account providing valid Alliance Access
operator credentials with the appropriate permissions in the command line.
• The Alliance Access server must be running, and the tool must be launched from the command
line accessible from the Alliance Access installation.
• Reporting must be activated (that is, the Activate Reporting system configuration parameter
must be switched on).

Description of parameters
The following table describes the parameters that are used to perform various tasks with the
Reporting command-line tool (saa_report), as outlined in the sections that follow.
Parameters of the saa_report command

Parameter Description

17 December 2021 294


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

[-user <username>] Name of the Access operator of type Human that is


executing the command.
Optional (but mandatory when using the -run or -
listMyReports options)
If omitted and the -application parameter is not
present, the user launching and executing the
command must provide valid Alliance Access
operator credentials.
If the Alliance Administrator runs the command and
the -user or -application parameters are
excluded, then the Software Owner Profile security
parameter must specify a valid operator profile. The
Software Owner profile must have the Reporting
permission assigned.

[-application <username>] Name of the Access operator of type Application that


is executing the command.
Optional. Not applicable when using the -run or -
listMyReports options.
If omitted and the -user parameter is not present,
the user launching and executing the command must
provide valid Alliance Access operator credentials.
If the Alliance Administrator runs the command and
the -user or -application parameters are
excluded, then the Software Owner Profile security
parameter must specify a valid operator profile. The
Software Owner profile must have the Reporting
permission assigned.

[-password <password>] Password of the Access operator.


Optional.
If present, the -user or -application parameter
must also be present. This parameter must be
omitted if -passwordfile is present.

[-passwordfile <[path]filename>] Name of the file containing the password of the


Alliance Access operator.
Optional.
If present, the -user or -application parameter
must also be present. This parameter must be
omitted if -password is present.

-run <MyReportName> Runs one of the operator's reports.


<MyReportName> is the name of the report template
to be run.
The -run, -listAvailableReports, -
listMyReports, and -purge parameters are
mutually exclusive, but one of them must be
specified.

17 December 2021 295


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

-listAvailableReports Lists all of the ready-to-use reports that are available.


The -run, -listAvailableReports, -
listMyReports, and -purge parameters are
mutually exclusive, but one of them must be
specified.

-listMyReports Lists all of the operator's report templates.


The -run, -listAvailableReports, -
listMyReports, and -purge parameters are
mutually exclusive, but one of them must be
specified.

-purge <x> Purges messages older than <x> days from the
Reporting data store. The value of <x> must be
greater than 7 and less than 10000.

-category <Category> Category of ready-to-use reports to be listed.


This parameter can be optionally used with the -
listAvailableReports parameter.
If the category name contains spaces, <Category>
must be enclosed within double quotes (for example,
"Exception Statistics").

17 December 2021 296


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

[-outputfile <Filename>] Name of the file (not including the extension) that will
contain the report run results.
This parameter can be optionally used with the -run
parameter. If present, the file name you specify will
overwrite the output file name specified in the report
template. If you provide a file extension, it will be
ignored.
If this parameter is not provided with the -run
parameter, the output file name is automatically built
as follows: <ReportName>-<OperatorName>-
<Date>-<Time>, where:
• ReportName is the report name (if the report was
run from a ready-to-use report definition) or the
report template name (if the report was run from a
report template).
• OperatorName is the name of the operator in
whose name the report was run.
• Date is the date in the format YYYYMMDD.
• Time is the time in the format HHMM.
If the Filename in the -outputfile <Filename>
parameter is present with the -run parameter and:
• it contains %d, then %d is replaced by YYMMDD in
the actual name of the generated output file.
• it contains %t, then %t is replaced by HHMM in the
actual name of the generated output file.
• it contains %u, then %u is replaced by the name of
the operator in the name of which the report is
run, in the actual name of the generated output
file.
If the output file name is not provided or does not
contain a path, then the default path is usrdata/
report/results. If a path is provided that does
not already exist, the report run is stopped and an
error message is displayed.

[-overwrite] Indicates that the output file will be overwritten.


This parameter can be optionally used with the -run
parameter, but it can only be used if the -
outputfile parameter is also present.
If present and if the specified output file already
exists prior to the report run, the output file will be
fully overwritten. If -overwrite is not used and the
specified output file already exists prior to the report
run, the report run stops and is considered failed.

[-port <portnumber>] Alliance Access port to be used by the tool for


accessing Alliance Access.
Optional.
If omitted, the default Alliance Access port is used.

17 December 2021 297


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

15.6 Manage Reports and Data from the Command Line


You can perform the following operations using the Reporting command-line tool, as outlined in the
following sections:
• run a report from a report template that you have already created by means of the Reporting
GUI
• list the ready-to-use reports that are available
• list the templates (My Reports) that are available to the current operator
• purge messages from the Reporting data store

15.6.1 Run a Report from a Report Template (My Report)


Overview
A report template contains the names of its associated report, along with the relevant parameters.
A report template is associated with a single report and optionally with a single post-processing
option. Several report templates can be associated with the same combination of reports and post-
processing options.
A report template contains the following:
• the name of its associated report
• the name of its associated post-processing option
• a set of values for the parameters of its associated report, and a set of values for the
parameters of its associated post-processing option. Templates must contain a value for each
mandatory parameter.

Syntax
To run a report from a report template that you have already created by means of the Reporting
GUI, run the following command from the command line:
saa_report -user <username> [-password <password> | -passwordfile
<[path]filename>] -run <MyReportName> [-outputfile <Filename>] [-overwrite] [-
port <portnumber>]

Note When you run a report from a template, ensure that the output file name includes
symbols such as %u, %d, and %t, so that the resulting output file name is unique.
Otherwise, the report run may fail (if the output file name already exists and the -
overwrite option was not provided).

Example
saa_report -user test -run MyReport1 -outputfile MyReport1_%u_%d%t

Following is some sample output of this command, where [ALLIANCE_HOME] is the root folder
where Alliance Access is installed:
id=123,status=SUBMITTED
start polling for report...
finished polling for report
fetching...
Report available: [ALLIANCE_HOME]\usrdata\report\results\MyReport1_all_adm_
201209041023.pdf

17 December 2021 298


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

15.6.2 List Available Ready-to-Use Reports


Overview
You can generate a list of the reports (for the selected category or for all categories) that are
available. The results that are returned include the report name (Available report name), the
report category (Report category), and the report version (Version).

Syntax
To generate a list of the available ready-to-use reports, run the following command from the
command line:
saa_report [-user <username> | -application <username>] [-password <password> | -
passwordfile <[path]filename>] -listAvailableReports [-category <category>] [-
port <portnumber>]

Example
saa_report -listAvailableReports -category "Capacity Management"

Following is some sample output of this command:


Available report name |Report category |Version
-------------------------+--------------------------+-------
Avg-pro-from-STP |Capacity Management |1.0.0
Avg-pro-to-STP |Capacity Management |1.0.0
Avg-pro-to-man |Capacity Management |1.0.0
Avg-rou-to-STP |Capacity Management |1.0.0

15.6.3 List My Reports


Overview
You can generate a list of the report templates that have been created by the operator who is
executing the command. This list will inform you of the report templates that you can launch from
the command line. The results that are returned include the report template name (MyReport) and
the name of the available ready-to-use report (Based on available report) on which each
report template was built (if a ready-to-use report has been removed, its associated template
names are not returned).

Syntax
To generate a list of report templates, run the following command from the command line:
saa_report -user <username> [-password <password> | -passwordfile
<[path]filename>] -listMyReports [-port <portnumber>]

Example
saa_report -user test -passwordfile C:\temp\pwd.txt -listMyReports

Following is some sample output of this command, assuming that user test created these three
templates using the Reporting GUI:
MyReport |Based on available report
--------------------------+-----------------------------------
MyAvgProFrmSTP-PDF |Avg-pro-from-STP
MIR-list-XLS |MIR-list
TestRpt-Live1 |Live-msgs-summ

17 December 2021 299


Alliance Access 7.6.20 Operational Reporting
Message Management Guide

15.6.4 Purge Messages from the Reporting Data Store


Overview
You can purge messages that are older than a specified number of days from the Reporting data
store.

Syntax
To specify the age of messages to be purged, run the following command from the command line.
Specify a value for <x> (days) that is greater than 7 and less than 10000.
saa_report [-user <username> | -application <username>] [-password <password> | -
passwordfile <[path]filename>] -purge <x> [-port <portnumber>]

Example
saa_report -purge 30

Following is the output of this command:


The purge of the reporting tables was successfully triggered.

17 December 2021 300


Alliance Access 7.6.20 Batch File Transfer
Message Management Guide

16 Batch File Transfer


This chapter explains how to manage manual file transfer for batch input/output and to view details
about a file transfer session for a message partner.

16.1 Message Partners


Alliance Access profiles
Alliance Message Management allows batch input/output with message partners that are already
defined on Alliance Access. The data format established for a message partner is part of its profile
definition. The Alliance Access security profile assigned to the profile of a message partner controls
its specific permissions.
Your operator profile controls the particular message partners that you are allowed to use. Alliance
Message Management shows input message partners that you are allowed to use, provided that
your operator profile includes permission to start a session. Alliance Message Management shows
output message partners that you are allowed to use, provided that your operator profile includes
permission to run a session. Profile definition (for operators and for message partners) is part of
Alliance Access functionality and is outside the scope of this document. For more information, see
the Configuration Guide.

Requirements for message partner profiles


Alliance Message Management allows you to initiate sessions for message partners that are
already defined on Alliance Access.
The list of message partners is restricted to those with appropriate values for the session:
• The connection method must be file transfer or direct FileAct.
• The session initiation must be manual.
• The message partner profile must be defined to deal with files located on the server or in the
user space.
• The value for Direction must be set to From Message Partner for file input to Alliance Access.
• The value for Direction must be set to To Message Partner for file output from Alliance
Access.
• The value for Parameter File must not be set to Required.

16.2 Overview of Manual File Transfer


This section explains the flow of activities for manual file transfer sessions. Separate descriptions
are provided for batch input and batch output. The section after this one includes step-by-step
instructions as well as descriptions of the relevant pages.

16.2.1 Batch File Input


Running a batch input session with Alliance Message Management includes the following activities:
• The back-office application produces a file with messages.
• After selecting the input message partner, an operator uploads the file to Alliance Access.

17 December 2021 301


Alliance Access 7.6.20 Batch File Transfer
Message Management Guide

One of two options are provided to operators when starting the session. Based on the message
partner profile, operators can either select a file located on the server of the Alliance Access
host or a file located in the user space. If using the user space, then an operator can download
a file from the desktop to the user space before starting the session. A file picker allows the
operator to browse the content of the user space and pick the appropriate file. If the files are
located on the server, then the operator must provide the name and the path of the file.
• When starting the session for the message partner, an operator can choose whether to route or
dispose messages in the file. One or both choices may be available, as determined by the
profile assigned to the message partner. If dispose is used, then a queue must be selected.
• If necessary, the operator can optionally add a Possible duplicate Emission trailer. Every
message in the file will be marked as a possible duplicate.
• If necessary, the operator can select Allow Batch Duplication. When selected, this option allows
an operator to reuse batch files that have already been used by a message partner.
Note If an operator tries to start a session with a batch file that has already been used to
start another session, then an error is given and states that the batch file has
already been "used".
If you select the option Allow Batch Duplication, then it allows you to start the
session anyway and to bypass this check.
• An input session will stop automatically when the input file that contains messages has been
read. The name of the operator who started the session becomes the "creator" of any
messages that the message partner accepts.
• It is possible to view session details for the message partner while the session is in progress or
after it has finished.
• After the session has finished, Alliance Access sends messages to the appropriate destination.
• The operator is responsible for removing the uploaded file when it is no longer needed.

16.2.2 Batch File Output


Running a batch output session with Alliance Message Management includes the following
activities:
• Alliance Access receives messages and routes them to the appropriate exit points.
• After selecting the output message partner, an operator runs the session and indicates the file
name to be used.
Alliance Access places the resulting file in the user space or also directly on the server into the
directory path (on the Alliance Access host) specified as part of the message partner definition
(connection point).
• An output session will stop automatically whenever the messages that were in the queue when
the session was started have been written to the file. The messages that arrive after a session
was started stay queued at the exit point until the next session starts.
• It is possible to view session details for the message partner while the session is in progress or
after it has finished.
• After transferring the file to the back-office application, the operator is responsible for removing
the file when it is no longer needed.

17 December 2021 302


Alliance Access 7.6.20 Batch File Transfer
Message Management Guide

16.3 Recovery of Batch Sessions


Batch output
An output message partner configured with connection method set to File Transfer writes the
messages to a file. If anything goes wrong with the session, then the recovery mechanism
unreserves and requeues the messages at the exit point. An event concerning the session failure is
recorded in the Event Journal.

Batch input
An input message partner configured with connection method set to File Transfer reads the
messages from a file.
With batch input sessions, the session operation and recovery principle is very similar. If anything
goes wrong with the session, then the recovery mechanism unreserves, removes, and discards the
messages in the AI inbound queue.

Automatic sessions
If an error occurs, then the batch input message file is moved into a storage location known as the
Automatic Input Error Directory (set by the system parameter Automatic - Error Dir).
If a parameter file is being used, then the parameter file is moved into this Error Directory. If the
message file and parameter file are located in the same connection point directory, then both are
moved into the Error Directory.
To avoid filename clashes, each file placed in the Error Directory is given a file extension
YYMMDDHHMMSS.

An event concerning the reason for the session failure is recorded in the Event Log.

16.4 Batch File Transfer Sessions

16.4.1 Choose a Message Partner Page


Overview
This section describes the content of the File Input - Choose a Message Partner and File Output
- Choose a Message Partner pages.
When you select File Input or File Output you are presented with a list of message partners to
select from to perform the selected task.

File Input - Choose a Message Partner page

17 December 2021 303


Alliance Access 7.6.20 Batch File Transfer
Message Management Guide

File Output - Choose a Message Partner page

Description of the list columns

Name Displays the name of the message partner.

Direction Indicates the direction that the message partner sends files relative to the
Alliance Message Management session. From Message Partner
indicates input to Alliance Access. To Message Partner indicates output
from Alliance Access.

Connection Method Shows File Transfer or Direct FileAct.

Format Recognition Shows the type of format recognition defined for the message partner.
This column appears only in the File Input - Choose a Message Partner
page.

Message Count Shows the number of messages currently available for output for the
message partner. This column appears only in the File Output - Choose
a Message Partner page.

Data Format Shows the data format defined for the message partner.
Note When the Format Recognition is set to Auto then the Data
Format does not need to be specified in the message partner
configuration. When it is set to Forced, then you must specify
it.

Session Status Shows the current status of the message partner session.

Authentication Shows if the message partner session requires authentication.


Required

16.4.2 Start a File Input Session


This section explains how to upload a file to use it for a batch input session.
Note The maximum size of FileAct files to be uploaded is 250 MB.
The name specified in the Connection Point field has a maximum limit of 32
acceptable characters.
Before you begin
In order to start a session for manual File Transfer message partners (which requires you to set the
Userspace option for the File on field in the Start Session pop-up), the File on User Space
(Access Control application) permission is required.

17 December 2021 304


Alliance Access 7.6.20 Batch File Transfer
Message Management Guide

Procedure
1. From the Batch File menu, select File Input.
The File Input - Choose a Message Partner page opens and displays the list of available
message partners.
2. Click the message partner to use for the batch input session then click Start Session .
The Start Session page opens.
For the File On selection, the message partner profile determines whether the file can be
selected from the server or the user space. If you select Local, you can specify one of the local
or network directories available on your desktop. The file is then generated and processed from
the user space.
3. Select the file.

If Then

The file is located in the User Space, and you know Type the path and file name in the Connection
the path and file name. Point field.

The file is located in the User Space, and you need • Click to locate and select the file to upload.
to select the file.
• Select the file for input.
The file appears in the File Name field
• Click OK .
The file name selected appears in the
Connection Point field. You can use this field
to specify a different file name for the file on
Alliance Access.

The file is located on the server Type the path and file name in the Connection
Point field. You can use this field to specify a
different file name for the file on Alliance Access.

4. If necessary, click the Add a PDE check box.


5. If necessary, click the Allow Batch Duplication check box.
6. Select Route or Dispose from the drop-down list. If you select Dispose, then select the
appropriate queue from the drop-down list that appears.
7. Click OK .
The Session Details page opens. For more information, see Session Details Page on page
310
8. Click Reset , Refresh , or Close .

16.4.3 Start a File Output Session


This section explains how to run a batch output session so that you can download the resulting file
of messages.
Before you begin
In order to run a session for manual File Transfer message partners (which requires you to set the
Userspace option for the File on field in the Run Session pop-up), the File on User Space
(Access Control application) permission is required.

17 December 2021 305


Alliance Access 7.6.20 Batch File Transfer
Message Management Guide

Procedure
1. From the Batch File menu, select File Output.
The File Output - Choose a Message Partner page opens and displays the list of available
message partners.
2. Click the message partner to use for the batch output session then click Run Session .
The Run Session window opens.
For the File On selection, the message partner profile determines whether the file can be
selected from the server, the userspace, or locally. If you select Local, you can select one of
the local or network directories available on your desktop as the final destination of the file. The
file is first generated in the userspace, and then downloaded from the userspace to the local/
network directory.
Once the session has ended, the file download is automatically initiated.
3. If the file is located on User Space, then type the path and file name in the Connection Point
field or click to locate and select the file to upload.
The file name selected appears in the Connection Point field. You can use this field to specify
a different file name for the file on Alliance Access.
If the file is located on Server, then you must type the path and file name in the Connection
Point field.
If the file is located on Local, click Browse to browse to the location of the file in the
Connection Point field.
4. If necessary, click the Overwrite Target File check box.
5. Click OK .
While the file is being output, the Session Details page opens. For more information, see
Session Details Page on page 310
To download the output file, see Download a File from the User Space on page 308.

16.4.4 Abort a Session


You can abort any session that is in progress and has status "open" by using Abort Session on the
Session Details page (see Session Details Page on page 310) if you have the necessary
permissions defined in your operator profile.
You can find more information, see Recovery of Batch Sessions on page 303.

16.4.5 User Space

16.4.5.1 User Space


Purpose
Alliance Message Management provides functionality to enable you to manage files available for
input and output. The functionality is available by selecting User Space from the Batch File menu.
The User Space is a file management system which enables you to upload or download files for
further processing by Alliance Access.

17 December 2021 306


Alliance Access 7.6.20 Batch File Transfer
Message Management Guide

Files are located on the Alliance Access server. The root path of the User Space is defined by the
Root Path for User Space security parameter. Each operator has a User Space and cannot
access folders or files which are located in the User Space of other operators.
In the User Space, the files are identified by User Space names which are not necessarily the
same as the physical names of the files.

Users and permissions


In order to manage folders and upload or download files on the user space, the File on User Space
(Access Control application) permission is required.

16.4.5.2 Add a Folder to the User Space


This procedure enables you to create a folder at the current folder level within the User Space.
Procedure
1. From the User Space page, click Add Folder .
The Add Folder to User Space window opens.
2. Type a name in the Folder Name field.
3. Click Add Folder .
The Add Folder to User Space window closes.
A folder with the name that you specified appears in the list for the current User Space folder.

16.4.5.3 Upload a File to the User Space


This procedure enables you to copy a file located on your desktop to the User Space. You must
define a User Space name which will be used to identify the file in the User Space.
Procedure
1. From the User Space page, click a folder.
2. Click Upload .
The Upload window opens.
3. Click Browse .
The Choose file window opens.
4. Browse to the location of the file, select it and click Open .
The Choose file window closes.
5. In the User Space File Name field, type a name for the file.
This name is used for the file in the User Space. The physical name does not change.

17 December 2021 307


Alliance Access 7.6.20 Batch File Transfer
Message Management Guide

6. Click Upload .
The Upload window closes.
The file appears in the list.
If a file with the same User Space name exists in the folder, then the File Overwrite Confirmation
window opens.

16.4.5.4 Download a File from the User Space


This procedure enables you to get a copy of a file located in the User Space and save it to a local
drive.
Procedure
1. From the User Space page, navigate to the file that you want to download.
2. Click Download .
The File Download window opens.
3. Click Save .
The File Download window closes.
The Save As window opens.
4. Browse to a location for the file and click Save .
The Save As window closes.
The Download complete window opens.
5. Click Close .
The Download complete window closes.
The file is downloaded.

16.4.5.5 Rename a User Space Folder or File


This procedure enables you to change the User Space name of a folder or a file. For files, the
physical names remain unchanged.
Procedure
1. From the User Space page, select the check box of the element that you want to rename.
2. Click Rename .
The Rename Item From User Space window opens.
3. Type a name in the New Name field.
4. Click Rename .
The Rename Item From User Space window closes.
The element is renamed.

16.4.5.6 Delete a User Space Folder or File


This procedure enables you to delete folders or files from the User Space.

17 December 2021 308


Alliance Access 7.6.20 Batch File Transfer
Message Management Guide

Before you begin


You cannot delete folders which contain files. You must first delete all the files contained in the
folder that you want to delete.
Procedure
1. From the User Space page, select the check boxes for one or several elements in the left
column.
2. Click Delete .
The Delete Confirmation window opens.
3. Click OK .
The Delete Confirmation window closes.
The element or elements selected are deleted.

16.5 Message Partner Session Details


You can view session details for a message partner while a session is in progress or after it ends.
Session details are replaced when another session is started for a message partner .

16.5.1 Overview of Message Partners Page


Overview
This section describes the content of the Session Details - Choose a Message Partner page.
When you select Session Details you are presented with a list of message partners to select from.

Page example

Description of the list columns

Name Displays the name of the message partner .

Direction Indicates the direction that the message partner sends files relative to the
Alliance Message Management session. From Message Partner indicates
input to Alliance Access. To Message Partner indicates output from
Alliance Access.

Connection Method Shows File Transfer or Direct FileAct.

Status Shows if the message partner is currently enabled or disabled.

Session Status Shows the current status of the message partner session.

17 December 2021 309


Alliance Access 7.6.20 Batch File Transfer
Message Management Guide

Date/Time Shows the date and time of the latest session.

16.5.2 Session Details Page


Overview
This section describes the content of the Session Details page for a message partner. This page
appears automatically as soon as an input or output session starts to run. You can also display this
page for a message partner that you select from the list described in Overview of Message
Partners Page on page 309. Refer to the instructions in View Session Details on page 311.
Alliance Message Management automatically refreshes the content of the Session Details page
every few seconds. You can also refresh the content on demand.
Page example

Field descriptions

Session Status The current state of the session:


• Closed - no transfer of messages is currently taking place. The
information shown in the Exchanged Messages section belongs to the
previous session.
• Opening - the session is initialising.
• Open - the session is active and messages are being transferred. The
Abort Session button is present only for a session while its status is Open.

• Closing - the session is closing down because the end of file has been
reached.
• Aborting - the session is closing down because of a failure, such as an
authentication failure, or because someone selected Abort Session .
• Recovering - the session is recovering from a sudden closure, such as
an abort or a system restart.

17 December 2021 310


Alliance Access 7.6.20 Batch File Transfer
Message Management Guide

Last Error Shows the last error that occurred in the session. If no error occurred, then
this field contains SUCCESS.

Session Identifier The session number for the message partner. Alliance Access increments
this number for each consecutive session.

Connection Point The location of the message file on Alliance Access.

To Partner or From Displays the direction defined in the message partner profile. The
Partner perspective is that of Alliance Access: "to" means output from Alliance
Access and "from" means input from the message partner to Alliance
Access.

Sequence Number Shows the sequence number of the next message expected to be
processed during this session.

Accepted Shows the number of messages that have been accepted. During file
transfer, the entire file must be read in and processed before a number
appears here. Messages are routed after the entire file is read in.

Rejected Shows how many messages have been rejected so far in the current
session. Rejection can occur for a number of reasons, for example,
message syntax errors. The reason for the rejection of a message is logged
on the Alliance Access Event Journal.

Bypassed Appears only for output message partners . Displays the number of output
messages that were bypassed (and completed). Messages are bypassed
when the output data format selected for the exchange is one that does not
support certain types of message. For example, RJE does not support
notifications. When an unsupported type of message appears at the exit
point it is moved to the text modification queue and completed. Each
message bypass is recorded as an event in the Alliance Access Event
Journal.

Not yet Shows the number of processed messages that are waiting to be
acknowledged "Accepted". Acceptance occurs only when the entire file has been
processed.

Since Last Reset Shows the number of processed messages since the last reset.

16.5.3 View Session Details


Procedure
1. From the Batch File menu, select Session Details.
The Session Details - Choose a Message Partner page opens and displays the list of
available message partners.
2. Click a message partner to view the details of the current (or last) session.
The Session Details screen opens.
3. Alliance Message Management automatically refreshes content of this page every few
seconds, for as long the page is displayed in the browser. You can click Refresh at any time.

17 December 2021 311


Alliance Access 7.6.20 Batch File Transfer
Message Management Guide

4. Click the appropriate Reset button to reset the message counters manually.
5. Click Next or Previous to view details for other sessions.
6. When you have finished viewing the session details, click Close or click any other task.

17 December 2021 312


Alliance Access 7.6.20 Legal Notices
Message Management Guide

Legal Notices
Copyright
SWIFT © 2021. All rights reserved.

Restricted Distribution
Do not distribute this publication outside your organisation unless your subscription or order
expressly grants you that right, in which case ensure you comply with any other applicable
conditions.

Disclaimer
The information in this publication may change from time to time. You must always refer to the
latest available version.

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. SC. The following are registered trademarks of SWIFT:
3SKey, Innotribe, MyStandards, Sibos, SWIFT, SWIFTNet, SWIFT Institute, the Standards Forum
logo, the SWIFT logo, SWIFT gpi with logo, the SWIFT gpi logo, and UETR. Other product, service,
or company names in this publication are trade names, trademarks, or registered trademarks of
their respective owners.

17 December 2021 313

You might also like