+ All Categories
Home > Documents > TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for...

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for...

Date post: 06-Mar-2018
Category:
Upload: dothu
View: 246 times
Download: 9 times
Share this document with a friend
263
TIBCO ActiveMatrix ® Adapter for SWIFTNet - FIN User’s Guide Software Release 5.11 August 2013 Two-Second Advantage ®
Transcript
Page 1: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix® Adapter for SWIFTNet - FIN

User’s GuideSoftware Release 5.11 August 2013

Two-Second Advantage®

Page 2: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN LICENSE.PDF) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc.TIBCO, Two-Second Advantage, TIBCO, The Power of Now, TIBCO ActiveMatrix BusinessWorks, TIBCO ActiveEnterprise, TIBCO Rendezvous, TIBCO Designer, TIBCO Administrator, TIBCO Adapter SDK, TIBCO Runtime Agent, TIBCO ActiveMatrix Adapter, TIBCO ActiveMatrix Adapter for MQSeries, TIBCO Enterprise Message Service, and TIBCO Hawk are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform Enterprise Edition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle Corporation in the U.S. and other countries.All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only.THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README.TXT FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.Copyright © 1998-2013 TIBCO Software Inc. ALL RIGHTS RESERVED.TIBCO Software Inc. Confidential Information

Page 3: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| iii

Contents

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xivTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xivOther TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv

Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviiHow to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviiHow to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviiHow to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii

Chapter 1 Concepts of TIBCO ActiveMatrix Adapter for SWIFT . . . . . . . . . . . . . . . . . . . . . . . . . .1

Terminology and Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

SWIFT Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4SWIFT Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Communicating with the SWIFT Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Adapter Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Adapter Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Adapter Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Adapter Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Chapter 2 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

Prerequisites for the Configuration Exercise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Configuring an Adapter Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Deploying the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Tester Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Chapter 3 Adapter Instance Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

Overview of an Adapter Instance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Page 4: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

iv | Contents

Configuration Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Adapter Instance Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Configuration Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Runtime Connection Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Specification Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Logging Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Startup Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Monitoring Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Chapter 4 Adapter Services Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Adapter Services Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48SWIFTNet - FINReceiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48SWIFTNet - FINSender . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Transport Specific Service Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Transport Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Quality of Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Delivery Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Connection Factory Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Wire Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Publication Service and Subscription Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Configuration Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Transport Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Using Validation Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Filter Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Path Specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Chapter 5 Deploying and Starting the Adapter Using TIBCO Administrator . . . . . . . . . . . . . . 63

Creating an EAR File in TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Deploying a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Starting or Stopping the Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Monitoring the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Chapter 6 Advanced Configuration Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Modifying TIBCO Rendezvous Session Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Modifying TIBCO JMS Session Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Using Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Changing Global Variable Values at Runtime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Predefined Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Parsing and Validating SWIFT Files Using SwiftCheck. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Page 5: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Contents | v

SwiftCheck Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Loading SWIFT Message Types into a Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Sending and Validating SWIFT Messages using SwiftPublisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Running the Utility on the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Running the Utility with a Properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Chapter 7 Using the Adapter with CASmf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81

Overview of Operation Using CASmf. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Pre-configured Services Used in CASmf Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Configuring the Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Loopback Testing on Windows Using CASmf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Starting the Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Loopback Testing on Solaris and AIX Using CASmf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

CASmf Recovery Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Chapter 8 Using the Adapter with MQSA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .93

Overview of Operation Using MQSA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Pre-configured Services Used in MQSA Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Configuring the Adapter to Work with MQSA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Testing the Adapter Using MQSA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Configuring TIBCO ActiveMatrix Adapter for WebSphere MQ to Work with MQSA . . . . . . . . . . . . . . . . . . . . . . 101Subscription Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Publication Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Processing Local Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Chapter 9 Using the Adapter with FTP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113

Overview of Operation Using FTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Configuring the Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

Starting and Stopping the Adapter and the Tester. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Chapter 10 Using TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN . . . . . . . .123

Overview of TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN . . . . . . . . . . . . . . . . . . . . . . . . . . 124

Installation of TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN . . . . . . . . . . . . . . . . . . . . . . . . . 125

SWIFTNet - FIN Schema Loader. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

SWIFTNet - FIN Router . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

SWIFTNet - FIN Parser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

SWIFTNet - FIN Renderer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Page 6: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

vi | Contents

BICPlusIBAN Generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Generating the IBAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

BICPlusIBAN Validator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138The Scenarios of BICPlusIBAN Validation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138BICPlusIBAN Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Limitations and Recommendations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Chapter 11 Processing Acknowledgment Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Overview of Acknowledgment Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Processing Acknowledgment Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Using the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Processing ACK and NAK Messages Using TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN147

Reconciling Acknowledgment Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Chapter 12 Using the Adapter with a Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

Overview of Using the Adapter with a Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

Configuring the Adapter for Use with a Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

SWIFT Messages Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

Logical Reply Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

DeliveryReports Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

Transmission Reports Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

LocalReports Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

Chapter 13 Monitoring the Adapter Using TIBCO Hawk. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Overview of Using TIBCO Hawk to Monitor the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Starting TIBCO Hawk Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

The Auto-Discovery Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

Invoking Microagent Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

Available Microagents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168activateTraceRole() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171deactivateTraceRole() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172getActivityStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173getAdapterServiceInformation(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174getComponents() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175getConfig() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176getConfigInformation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177getConfigProperties(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178getConnectionStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179getHostInformation() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

Page 7: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Contents | vii

getRvConfig() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181getStatus() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182getThreadStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183getTraceSinks(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184getVersion() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185_onUnsolictedMsg() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186preRegisterListener() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187resetActivityStatistics() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188resetConnectionStatistics(). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189reviewLedger() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190setDocumentDelay() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192setTraceSinks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193stopApplicationInstance() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194unRegisterListener() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195getPerfMonSetting() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

Appendix A TIBCO ActiveEnterprise Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .197

Schema for CASmf Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198LogicalReply Schema. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198NetworkReport Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

Schema for MQSA Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200LocalReport Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200TransmissionNotification Schema. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200DeliveryNotification Schema. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

Schema for FTP Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203LogicalReply Schema. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

Appendix B Migrating to the Current SWIFT Standards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .205

Migrating to the Current SWIFT Standards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

Appendix C Dynamic BIC Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .207

Overview of Dynamic BIC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

Using Dynamic BIC or BEI Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

Appendix D Trace Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211

Overview of Trace Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

Trace Message Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

Status Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .243

Page 8: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

viii | Contents

Page 9: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Tables | ix

Tables

Table 1 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv

Table 2 Adapter Instance Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Table 3 Adapter Instance Runtime Connection Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Table 4 Adapter Instance General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Table 5 Adapter Instance Specification Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Table 6 Adapter Instance Logging Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Table 7 Adapter Instance Startup Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Table 8 Adapter Instance Monitoring Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Table 9 Configuration Tab of Publication Service and Subscription Service . . . . . . . . . . . . . . . . . . . . . . . 54

Table 10 Transport Tab of Publication Service and Subscription Service . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Table 11 Path Specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Table 12 Using Validation Filters: Valid Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Table 13 Using Validation Filters: Invalid Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Table 14 Predefined Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Table 15 Report of Performing OR operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Table 16 Report of MQ Series Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Table 17 SWIFTNet - FIN Schema Loader Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Table 18 SWIFTNet - FIN Router Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

Table 19 SWIFTNet - FIN Router Input Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

Table 20 SWIFTNet - FIN Router Output Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Table 21 SWIFTNet - FIN Router Error Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Table 22 SWIFTNet - FIN Parser Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Table 23 SWIFTNet - FIN Parser Input Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Table 24 SWIFTNet - FIN Parser Output Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Table 25 SWIFTNet - FIN Parser Error Output Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Table 26 SWIFTNet - FIN Renderer Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Table 27 SWIFTNet - FIN Renderer Input Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Table 28 SWIFTNet - FIN Renderer Output Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Page 10: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

x | Tables

Table 29 SWIFTNet - FIN Renderer Error Output Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Table 30 Components of the IBAN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Table 31 Modes and Database Used by SWIFTNet - FINSender and SWIFTNet - FINReceiver . . . . . . . . 150

Table 32 SWIFT Message Table Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

Table 33 LogicalReplies Table Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

Table 34 DeliveryReports Table Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

Table 35 DeliberyReport Status Value Table Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

Table 36 TransmissionReports Table Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

Table 37 TransmissionReport Status Value Table Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

Table 38 LocalReports Table Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

Table 39 LocalReport Status Value Table Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

Table 40 Microagent Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Table 41 LogicalReply Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

Table 42 NetworkReport Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

Table 43 LocalReport Schema. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

Table 44 TransmissionNotification Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

Table 45 TransmissionNotification Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

Table 46 LogicalReply Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

Table 47 List of Trigger Types and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

Table 48 Trace Message Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

Page 11: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Figures | xi

Figures

Figure 1 SWIFT Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Figure 2 How the adapter fits into the overall picture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Figure 3 SWIFTNet - FINSender Adapter Instance Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Figure 4 SWIFTNet - FINReceiver Adapter Instance Flow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Figure 5 Typical Publication Service Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Figure 6 Typical Subscription Service Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Figure 7 Create a New Empty Project in TIBCO Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Figure 8 Save the New Empty Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Figure 9 Creating Log Sinks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Figure 10 Creating a New Log Sink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Figure 11 TIBCO Rendezvous Session Configuration Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Figure 12 TIBCO Enterprise Message Service Session Configuration Screen . . . . . . . . . . . . . . . . . . . . . . . . 71

Figure 13 Adapter Operations Using CASmf Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Figure 14 Loopback Testing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Figure 15 CASmf Dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Figure 16 Monitoring CASmf GUI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Figure 17 Adapter Operations Using MQSA Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Figure 18 Adapter Operations Using FTP Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

Figure 19 Configuring the SWIFTNet - FINSender with FTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Figure 20 Selecting the SWIFT message in the Specification Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Figure 21 Export the Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

Figure 22 Configuring the SWIFTNet - FINReceiver with FTP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Figure 23 Input of the SWIFTNet BICPlusIBAN Generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

Figure 24 Output of the SWIFTNet BICPlusIBAN Generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

Figure 25 Configuration of the SWIFTNet BICPlusIBAN Validator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Figure 26 Input of the SWIFTNet BICPlusIBAN Validator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Figure 27 Output of the SWIFTNet BICPlusIBAN Validator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Figure 28 JDBC MessageSession Configuration Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

Page 12: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

xii | Figures

Figure 29 TIBCO Hawk Enterprise Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

Figure 30 Microagents, Methods and Arguments Dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Figure 31 Invocation Results Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

Page 13: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| xiii

Preface

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN software is a bidirectional gateway between the SWIFT Network and the TIBCO applications.

This manual describes the architecture and supported features of TIBCO ActiveMatrix Adapter for SWIFTNet - FIN. It also describes how to install and configure the adapter.

Topics

• Related Documentation, page xiv

• Typographical Conventions, page xv

• Connecting with TIBCO Resources, page xvii

Page 14: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

xiv | Related Documentation

Related Documentation

This section lists documentation resources.

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN DocumentationThe following documents form the TIBCO ActiveMatrix Adapter for SWIFTNet - FIN documentation set:

• TIBCO ActiveMatrix Adapter for SWIFT Installation Read this manual for instructions on site preparation and installation.

• TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide Read this manual for the concepts relating to the adapter, the application with which the adapter interacts, configuration and deployment information.

• TIBCO ActiveMatrix Adapter for SWIFTNet - FIN Examples Guide Read this manual to work through the examples provided with the adapter.

• TIBCO ActiveMatrix Adapter for SWIFT Release Notes Read this release notes for a list of new and changed features. This document also contains lists of closed issues and known issues for this release.

Other TIBCO Product DocumentationYou may find it useful to read the documentation for the following TIBCO products:

• TIBCO Administrator™

• TIBCO ActiveMatrix Adapter™

• TIBCO ActiveMatrix Adapter™ for MQSeries

• TIBCO ActiveMatrix BusinessWorks™

• TIBCO® Adapter SDK

• TIBCO Designer™

• TIBCO Enterprise Message Service™

• TIBCO Hawk®

• TIBCO Rendezvous™

• TIBCO Runtime Agent™

Page 15: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Preface | xv

Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions

Convention Use

TIBCO_HOME

ENV_NAME

TIB_ADSWIFT_HOME

CONFIG_HOME

TIBCO products are installed into an installation environment. A product installed into an installation environment does not access components in other installation environments. Incompatible products and multiple instances of the same product must be installed into different installation environments.

An installation environment consists of the following properties:

• Name Identifies the installation environment. This name is referenced in documentation as ENV_NAME. On Microsoft Windows, the name is appended to the name of Windows services created by the installer and is a component of the path to the product shortcut in the Windows Start > All Programs menu.

• Path The directory into which the product is installed. This directory is referenced in documentation as TIBCO_HOME.

The product is installed into a directory within a TIBCO_HOME.

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN installs the product in the directory which is referenced in documentation as TIB_ADSWIFT_HOME. The default value of TIBCO_ADSWIFT_HOME depends on the operating system. For example, on Windows systems, the default value is C:\tibco\adapter\adswift\version.

A TIBCO configuration directory stores configuration data generated by TIBCO products. Configuration data can include sample scripts, session data, configured binaries, logs, and so on. This directory is referenced in documentation as CONFIG_HOME. The default location of the directory is USER_HOME\ENV_NAME\tibco\cfgmgmt\product_name. For example, on Windows, the default location is C:\Documents and Settings\username\Application Data\ENV_NAME\tibco\cfgmgmt\product_name.

code font Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example:

Use MyCommand to start the foo process.

Page 16: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

xvi | Typographical Conventions

bold code font Bold code font is used in the following ways:

In procedures, to indicate what a user types. For example: Type admin.

In large code samples, to indicate the parts of the sample that are of particular interest.

In command syntax, to indicate the default parameter for a command. For example, if no parameter is specified, MyCommand is enabled: MyCommand [enable | disable]

italic font Italic font is used in the following ways:

To indicate a document title. For example: See TIBCO BusinessWorks Concepts.

To introduce new terms For example: A portal page may contain several portlets. Portlets are mini-applications that run in a portal.

To indicate a variable in a command or code syntax that you must replace. For example: MyCommand pathname

Key combinations Key name separated by a plus sign indicate keys pressed simultaneously. For example: Ctrl+C.

Key names separated by a comma and space indicate keys pressed one after the other. For example: Esc, Ctrl+Q.

The note icon indicates information that is of special interest or importance, for example, an additional action required only in certain circumstances.

The tip icon indicates an idea that could be useful, for example, a way to apply the information provided in the current section to achieve a specific result.

The warning icon indicates the potential for a damaging situation, for example, data loss or corruption if certain steps are taken or not taken.

Table 1 General Typographical Conventions (Cont’d)

Convention Use

Page 17: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Preface | xvii

Connecting with TIBCO Resources

How to Join TIBCOmmunityTIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is a place to share and access the collective experience of the TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety of resources. To register, go to http://www.tibcommunity.com.

How to Access TIBCO DocumentationYou can access TIBCO documentation here:

http://docs.tibco.com

How to Contact TIBCO SupportFor comments or problems with this manual or the software it addresses, contact TIBCO Support as follows:

• For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this site:

http://www.tibco.com/services/support

• If you already have a valid maintenance or support contract, visit this site:

https://support.tibco.com

Entry to this site requires a username and password. If you do not have a username, you can request one.

Page 18: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

xviii | Connecting with TIBCO Resources

Page 19: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| 1

Chapter 1 Concepts of TIBCO ActiveMatrix Adapter for SWIFT

This chapter provides an overview of TIBCO ActiveMatrix Adapter for SWIFT and also explains how the adapter integrates with the SWIFT network.

Topics

• Terminology and Acronyms, page 2

• SWIFT Overview, page 4

• Adapter Overview, page 9

• Adapter Components, page 11

• Adapter Features, page 15

• Adapter Services, page 18

Page 20: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

2 | Chapter 1 Concepts of TIBCO ActiveMatrix Adapter for SWIFT

Terminology and Acronyms

The following terminology and acronyms are used in this manual:

Acronym Meaning

API Application Programming Interface

ACK Positive Acknowledgement

ADK Alliance Development Kit provided by SWIFT to create interface programs to SWIFT Alliance.

BEI Business Entity Identifier

BIC Bank Identifier Code

CASmf Common Application Server from SWIFT. CASmf is an application that connects to a SWIFT messages from the SWIFT Alliance Server. The CASmf application exposes TCP/IP sockets that TIBCO Adapter for SWIFT connects to. The adapter connects to the CASmf application using the CASmf API.

CASmf API SWIFT provides a C library and an API that connects to the TCP/IP sockets exposed by the CASmf application. This API is used by the adapter to read and write SWIFT messages and reports.

DMAPID.DAT Configuration file in the .DAT subdirectory of the CASmf installation. It defines all the names or MAPID’s that can be used to open sessions with CASmf. For each name, it specifies parameters such as the hostname oft he SWIFT Alliance Server it connects to and the port on which it listens for connections.

Delivery Report The SWIFT network can, either on its own or in response to a request from the user, report the delivery status of a user message. Typically, this message specifies whether the message was successfully delivered, could not be delivered, was acknowledged or not acknowledged (ACK or NACK) by the receiver or sender. Such a message is called a Delivery Report.

FIN Financial Message Type in SWIFT

IBAN International Bank Account Number

JMS Java Messaging Service

JNI Java Native Interface

Page 21: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Terminology and Acronyms | 3

Logical Reply SWIFT Alliance Server sends an acknowledgement for every message sent from the adapter. The acknowledgement message (ACK or NACK) is called a logical reply.

LTA Logical Terminal Address

MAPID Message Application Partner Identifier. This names a CASmf session that is used by the CASmf API to open a session with the CASmf application.

MT Message Type in SWIFT

MQSA The MQSeries Interface for SWIFT Alliance Access. The MQSA application enables communication between financial applications and SWIFT Alliance through MQSeries. The MQSA interface is based on SWIFT ADK and uses ADK functions to communicate with SWIFT Alliance Access and MQSeries functions.

NAK Negative Acknowledgement

SWIFT Society for Worldwide Interbank Financial Telecommunication. This organization maintains a global store and forward network for secure financial messaging. In addition, it defines standard formats for interbank messages.

SAA SWIFT Alliance Access. It is an application that runs on a server and connects the global SWIFT network with an adapter through either a phone line, or a leased line. It performs the actual message or report exchange with the SWIFT network.

SAE SWIFT Alliance Entry

Transmission Report

The transmission report is a message that states whether the user message was accepted or not (ACK or NACK) by the network. Since the SWIFT network is a store and forward network, every user message is stored by the network before being forwarded to the receiver. At the time of storing, the network also validates the message.

UAK Positive User Acknowledgement

UNK Negative User Acknowledgement

Acronym Meaning

Page 22: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

4 | Chapter 1 Concepts of TIBCO ActiveMatrix Adapter for SWIFT

SWIFT Overview

SWIFT (Society for Worldwide Interbank Financial Telecommunications) is an organization that provides a fast, safe, automated, and universal means of sending and receiving financial messages between financial institutions worldwide.

SWIFT users include financial institutions such as banks, brokers, dealers, or investment managers. Typical users of SWIFT deal in payments, securities, foreign exchange, money markets, treasury, and trade. All SWIFT users are identified on the SWIFT network by a unique address called a Bank Identifier Code (BIC). To exchange messages over the SWIFT network, every user must have at least one unique BIC.

SWIFT processes information (that is, data, text, or commands) in the form of messages. SWIFT offers the following two applications which together provide all the messaging functions and facilities available to users:

• General Purpose Application (GPA) Controls how users communicate within SWIFT.

• Financial Application (FIN) Controls the user-to-user messaging facilities within SWIFT.

SWIFT Messages

Type of Messages

All SWIFT messages start with the literal "MT" followed by a 3-digit number. The first digit represents the message category, the second digit represents a group of related parts in a transaction life cycle, and the third digit represents the message type.

SWIFT messages mainly include the following types:

• System Messages Messages sent by a user to the SWIFT system (delivery notifications, retrievals) or vice versa (retrieved messages, non-delivery warnings). System messages are represented by MT0nn, and used for system-level information, such as delivery notifications and non-delivery warnings.

• User-to-User Messages These messages enable financial transactions and are sent from one user to another. These messages are represented by MT1nn through MT9nn.

Page 23: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

SWIFT Overview | 5

• Service Messages These messages are also known as control messages, and are related either to system commands (for example, LOGIN, SELECT, or QUIT) or to message acknowledgements. For example, when you send a message to the SWIFT network, SWIFT accepts the message and sends you an ACK if the syntax of the message is correct. If not, it returns a NAK.

Standard of Messages

SWIFT uses a set of FIN standards and message format validation rules to validate all messages sent across the SWIFT network. All sending messages from the financial institutions must comply with the standards so that the receiving institutions can correctly understand and process them.

Structure of Messages

All SWIFT FIN messages are ASCII text messages and, in general, have the following structure:

• Basic header block This block is represented by {1:} and includes details, such as the application ID, service ID, address of the logical terminal, session number, sequence number, and so on.

The application ID in this block helps you identify whether a message is a GPA message (system message) or a FIN message (user-to-user message). For example, ’F’ indicates that the message is a FIN message and ’A’ indicates that the message is a GPA message.

• Application header block This block is represented by {2:}. Application headers contain two types: input and output. The structure of the block varies depending on the type of the application header. This header block typically includes details, such as the message type, message priority, delivery monitoring, and so on.

• User header block This block is represented by {3:} and includes details, such as the banking priority code and so on. This is an optional block.

• Text block This block is represented by {4:} and contains the actual MTnnn message. This block includes details, such as the ordering customer, beneficiary customer, amount, currency code, date, and so on. This block consists of field tags of the format :nna: where nn is a number and a is an optional letter which may be present on selected tags. The symbol CrLf is a control character and represents Carriage Return/Line Feed. The symbol CrLf is a mandatory delimiter in this block.

The adapter does not process service messages. It only processes system messages and user-to-user messages.

Page 24: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

6 | Chapter 1 Concepts of TIBCO ActiveMatrix Adapter for SWIFT

• Trailer block A message always ends in a trailer block and this block is represented by {5:}. It is used for control purposes and includes details, such as message authentication code and checksum calculated for all message types.

The following is a graphical representation of a typical SWIFT message:

Basic Message Flow

When you send a message to the SWIFT network, SWIFT validates the syntax of the message. If the message is correct, SWIFT accepts the message and sends you an ACK and attempts to deliver the message to the receiver. If the message does not comply with the standards, it is rejected and SWIFT returns a NAK. The NAK contains an error code which allows the sender to identify the type of error and its location. The sender can then correct the message before re-sending it to SWIFT.

SWIFT delivers the message as soon as the receiver is logged in to the SWIFT network. The interface at the receiver's end automatically confirms the receipt and acceptance of the message by sending a UAK. When a UAK is received by SWIFT, the message is considered to be delivered. If the message received is corrupted, the interface of the receiver will send a UNK to SWIFT, and SWIFT will attempt to re-deliver the message.

{1:--------}

:nn:-----------------<CrLf>:nna:----------------<CrLf>:nna:----------------<CrLf>:nna:----------------<CrLf>:nna:----------------<CrLf>:nn:-----------------<CrLf>:nna:----------------<CrLf>:nna:----------------<CrLf>:nna:----------------<CrLf>:nna:----------------<CrLf>:nn:-----------------<CrLf>:nna:----------------<CrLf>-}{5: {MAC:--------}{CHK:--------}}

B a s ic H e a d e r A p p lic a tio n H e a d e r U s e r H e a d e r

T ra ile r B lo c k

T e x t B lo c k

{2:--------}{3:--------}{4:<CrLf>

Page 25: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

SWIFT Overview | 7

Communicating with the SWIFT NetworkTo be able to communicate with the SWIFT network, a user must have SAA, SAE, or any other interface approved by SWIFT. Messages can be produced on a variety of user applications but they can only be sent to SWIFT through SAA or SAE. Similarly, messages can be processed on a variety of user applications, but can only be received through SAA or SAE.

You can communicate with SAA using one of the following interfaces:

• CASmf

• FTP

• MQSA

The next diagram shows how the above interfaces are used to integrate SAA with the user application.

Figure 1 SWIFT Interfaces

• CASmf

CASmf is a software used for communicating between SWIFT Alliance Access and other user applications. CASmf uses a MAPID, a name given to each instance of the messaging application, to establish the communication between the user application and SAA. The MAPID is defined in the user’s host as well as in the SWIFT interface.

Institution Y

SW

IFT

Alli

ance

Acc

ess

SWIFTNetwork

Institution X

Institution Z

En

d us

er a

pplic

atio

n

Inside Institution X

MQ SeriesMQSA

CASmf

FTP

Page 26: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

8 | Chapter 1 Concepts of TIBCO ActiveMatrix Adapter for SWIFT

CASmf also provides APIs to developers of the user application. APIs allow the user host environment and the SWIFT interface to communicate, establishing a “real-time” session. Once a “real-time” session is established, financial messages can be exchanged. APIs can open, close or abort a session, and send or receive data. The CASmf software uses TCP/IP as the communication protocol.

For information on how the CASmf interface integrates with TIBCO Runtime Agent, see Overview of Operation Using CASmf on page 82.

• MQSA

MQSA is a software used to interact between SWIFT Alliance Access and MQSeries. The MQSA interface is based on the SWIFT ADK. It uses ADK functions to communicate with SWIFT Alliance, and MQSeries functions to access message queuing services.

For information on how the MQSA interface integrates with TIBCO Runtime Agent, see Overview of Operation Using MQSA on page 94.

• FTP

An FTP server can be used for communication between SWIFT interfaces and user applications. The user application transfers SWIFT messages to a specified directory on the server. SAA picks up the SWIFT messages from this directory and sends them to the SWIFT network.

For information on how the FTP interface integrates with TIBCO Runtime Agent, see Overview of Operation Using FTP on page 114.

Page 27: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Adapter Overview | 9

Adapter Overview

The adapter enables exchange of data between the SWIFT network and applications configured for the TIBCO environment. It sends and receives SWIFT messages to and from the SWIFT network. It also parses, validates, and unparses SWIFT messages for publishing and subscribing in the TIBCO environment.

TIBCO Adapter for SWIFT has the following components:

• TIBCO Adapter for SWIFTNet - FIN This component is described in details throughout this guide.

• TIBCO BusinessWorks Plug-in for SWIFTNet - FIN For more information, see Chapter 9, Using the Adapter with FTP, on page 113.

Messages Processed by the Adapter

The message types that are processed by the adapter are:

• All user-to-user messages.

• Some system messages (FIN-to-user, user-to-FIN, FIN/GPA-to user, user-to-FIN/GPA, user-to-SWIFT headquarters and SWIFT headquarters-to-user).

• FIN and GPA acknowledgements.

The message types that are not processed by the adapter are:

• Pure GPA messages (GPA-to-user or user-to-GPA).

• FIN-to-FIN Copy Server.

• FIN Copy Server-to-FIN messages.

The SWIFTNet - FIN Parser does not check that an unidirectional message is flowing in the expected direction. For example, message MT011 always flows from SWIFT to the user; but the SWIFTNet - FIN Parser does not check this. Currently, the adapter also allows you to render the message MT011.

For a general introduction to adapters and the services they provide, read TIBCO Adapter Concepts. The book is part of the adapter documentation set.

TIBCO Adapter for SWIFT is SWIFTReady 2013 Gold certified. The SWIFTReady label is given to vendor products that meet a published set of conditions - please ask your vendor or SWIFT Partner Solutions for details. TIBCO ActiveEnterprise and TIBCO Adapter for SWIFT are products developed by TIBCO Software Inc. The SWIFTReady Gold label does not include or imply any warranty or condition of any type relating to the Product (including quality and fitness for purpose) from SWIFT.

Page 28: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

10 | Chapter 1 Concepts of TIBCO ActiveMatrix Adapter for SWIFT

Figure 2 shows how the adapter fits into the overall picture.

Figure 2 How the adapter fits into the overall picture

Institution Z

SWIFTadapter

MQSeries

MQ Seriesadapter

Institution Y

SWIFTNetwork

Institution X

End

use

r ap

lpic

atio

n

Inside Institution X

CASmf

TIB

CO

Tra

nsp

ort

SW

IFT

Alli

ance

Acc

ess

MQSA

FTP

Page 29: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Adapter Components | 11

Adapter Components

The adapter has two main components: adapter palette and runtime adapter. The adapter palette allows you to configure the adapter and store the configuration in a project. You will require TIBCO Designer for this, which is installed as part of the TIBCO Runtime Agent installation. TIBCO Runtime Agent must be installed before installing the adapter.

The runtime adapter uses this configuration information and metadata to exchange messages between the SWIFT network and applications in the TIBCO environment. The adapter provides TIBCO ActiveEnterprise schemas for all supported SWIFT message types.

The runtime adapter consists of the following three components:

SWIFTNet - FINSender Adapter Instance

SWIFTNet - FINSender listens for ActiveEnterprise (AE) or XML messages sent by other applications in the TIBCO environment. When a message arrives, SWIFTNet - FINSender validates it, renders it into a FIN message and sends it to the SWIFT network using the CASmf, FTP, or MQSA interfaces.

Figure 3 SWIFTNet - FINSender Adapter Instance Flow

Page 30: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

12 | Chapter 1 Concepts of TIBCO ActiveMatrix Adapter for SWIFT

SWIFTNet - FINReceiver Adapter Instance

SWIFTNet - FINReceiver receives FIN messages from the SWIFT network using the CASmf, FTP or MQSA interface. When a message arrives, SWIFTNet - FINReceiver validates it, parses it into a message and publishes it to the TIBCO environment. Applications that subscribe to the subject on which SWIFTNet - FINReceiver publishes receive the SWIFT messages.

Figure 4 SWIFTNet - FINReceiver Adapter Instance Flow

Pre-configured Adapter Services

The following pre-configured publication services are used to send messages.

Service Description

AdminPublisher Sends logical replies, network reports and delivery notifications from SWIFT Alliance Access to applications in the TIBCO environment.

MessagePublisher(in SWIFTNet - FINReceiver)

Sends SWIFT messages received from SWIFT Alliance Access to the TIBCO ActiveEnterprise environment.

TIBPublisher (in SWIFTNet - FINSender)

Sends SWIFT messages to TIBCO ActiveMatrix Adapter for WebSphere MQ when MQSA interface is used.

Page 31: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Adapter Components | 13

The following pre-configured subscription services are used to subscribe to messages:

The SWIFTNet - FINSender and SWIFTNet - FINReceiver have a set of pre-configured services defined. The pre-configured publication services allow SWIFT messages to be published on a different address than acknowledgements and logical replies. The AdminPublisher and MessagePublisher can be configured to publish on the same subject if required.

To distinguish between the adapter's ACKs/NAKs and those coming from the SWIFT network, use the following configuration.

Service Description

MessageSubscriber (in SWIFTNet - FINSender)

Subscribes to AE or XML messages that are to be sent to the SWIFT Network.

ExitSubscriber Stops a running adapter. A message sent on the subject defined for the ExitSubscriber associated with the adapter instance stops that adapter instance.

Note: CTRL+C must NEVER be used to shut down the adapter as it could lead to a potential loss or duplication of messages.

TIBSubscriber (in SWIFTNet - FINReceiver)

Subscribes to FIN messages published by TIBCO ActiveMatrix Adapter for WebSphere MQ when the MQSA interface is used.

DeliveryNotificationSubscriber (in SWIFTNet - FINSender)

Subscribes to delivery notification messages published by TIBCO ActiveMatrix Adapter for WebSphere MQ when MQSA interface is used.

LocalReportSubscriber (in SWIFTNet - FINSender)

Subscribes to local reports published by TIBCO ActiveMatrix Adapter for WebSphere MQ when MQSA interface is used.

TransmissionNotificationSubscriber(in SWIFTNet - FINSender)

Subscribes to TransmissionNotificationReports published by TIBCO ActiveMatrix Adapter for WebSphere MQ when MQSA interface is used.

Page 32: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

14 | Chapter 1 Concepts of TIBCO ActiveMatrix Adapter for SWIFT

• For an ACK from the adapter:

— Set -1 in the Dispose field

— Set -1 in the RejectReason field

— Set NULL in the RejectText field

• For a NACK from the adapter:

— Set -1 in the Dispose field

— Set 101 in the RejectReason field

RejectText is the validation warning or any other exception message that caused the failure.

Page 33: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Adapter Features | 15

Adapter Features

The adapter contains the following features:

• An easy-to-use GUI TIBCO Designer is used to configure and maintain the adapter. You can quickly specify operational parameters and change them as needed.

• Support for TIBCO BusinessWorks TIBCO BusinessWorks is a scalable, extensible, and easy to use integration platform that allows you to develop, deploy, and run integration projects. A TIBCO BusinessWorks project integrates enterprise applications and automates business processes.

• Pre-configured Adapter Services The adapter provides a set of pre-configured publication and subscription services, which encapsulate common activities.

• Delayed Acknowledgement The adapter supports delayed acknowledgement for the subscription service and the certified messaging. Delayed acknowledgment is a feature built upon certified messaging. When enabled, the adapter will not send the reception confirmation upon receiving the message. Instead, it delays confirmation until the message is consumed by the target application. In this way, the sender can be sure that its message has reached its final destination.

• Support for TIBCO Messaging Transports The adapter supports TIBCO Rendezvous and JMS as messaging transports.

The TIBCO Rendezvous transport supports the following qualities of service:

Reliable—This ensures that each multicast or broadcast message is received as long as the physical network and packet recipients are working, and the loss of a message is detected.

Certified Delivery—Assures every certified message reaches each intended recipient in the order sent. When delivery is not possible, both sending and listening programs receive explicit information about each undelivered message.

Distributed Queue—This is designed to deliver a message to one-of-many service listeners (workers). It contains features of both certified messaging and fault tolerance. Senders of distributed queue messages are ordinary certified message senders.

The JMS transport supports the following connection types (The TIBCO Enterprise Message Service software must be installed when using the JMS transport.)

Queue—Where a service sends to a queue or receives from a queue. This message protocol is known as point-to-point because one and only one

Page 34: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

16 | Chapter 1 Concepts of TIBCO ActiveMatrix Adapter for SWIFT

receiver consumes messages sent to a queue. A queue retains all messages sent until such time the messages are consumed or expired. Each message has only one receiver, though multiple receivers can connect to the queue. JMS messages use the XML message wire format only.

Topic—Where a service publishes to a topic or subscribes to a topic. This type of message protocol is also known as broadcast messaging because messages are sent over the network and received by all interested subscription services, similar to how radio or television signals are broadcast and received.

The JMS mode of transport supports two type of delivery modes, Persistent and Non-Persistent.

• Support for the CASmf, MQSA and FTP Dispose Types The adapter sends and receives valid SWIFT messages to and from the SWIFT network, using the CASmf interface, the MQSeries interface, or the FTP interface. The TIBCO ActiveMatrix Adapter for WebSphere MQ is used to exchange messages when the MQSA interface is used.

• Message Validation You can configure the adapter to parse and validate messages at a granular level. For example, you can turn validation on or off for message character sets, data types, code words, BIC, and so on. See General Tab on page 38 for details.

• CASmf Recovery Session Every outgoing SWIFT message from the adapter is recorded in a file. This is used when retrieving SWIFT messages if the CASmf application is down.

For more information, see CASmf Recovery Session on page 92.

• Support for SWIFT Message Types The adapter supports all system (MT0nn) and user-to-user (MT1nn through MT9nn) message types defined according to the 2012 and 2013 SWIFT Message Standards including message types conforming to ISO 15022 standards.

• Support for Database Logging The adapter supports database logging for CASmf, FTP and MQSA interfaces. In addition to SWIFT user messages, logical replies, delivery reports, and transmission reports are logged to the same database.

• Support for Logical Definition of Schema Attributes The adapter configuration contains a schema corresponding to each SWIFT message type that is to be handled by the adapter. The schema attributes now contain the logical definition of the SWIFT message data tags.

• Easy Message Loading The adapter allows you to easily select the SWIFT messages that are to be part of your integration project. See Guidelines for Validating the Message Structure on page 41 for details.

Page 35: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Adapter Features | 17

• Display of Mandatory Fields The mandatory fields in the schemas are now tagged with the M_ prefix. Optional fields are marked with the O_ prefix.

• Support for BIC and BEI Codes SWIFT BIC and BEI codes can be validated against a user-supplied BIC file.

• Validation Filter This feature enables you to specify and thus selectively filter out validation warnings that the adapter may generate while processing an invalid message. This feature gives the adapter user a fine-grained control over the overall validation feature; in addition to the predefined validation features provided. For more information on the validation filter, refer to Using Validation Filters on page 58.

• TIBCO BusinessWorks Plug-in for SWIFTNet - FIN The TIBCO BusinessWorks Plug-in for SWIFTNet - FIN enables you to parse, validate, and render FIN messages using TIBCO BusinessWorks. It also allows you to route FIN messages to different activities based on the message types. For more information, refer to Using the Adapter with FTP on page 113.

Page 36: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

18 | Chapter 1 Concepts of TIBCO ActiveMatrix Adapter for SWIFT

Adapter Services

The adapter provides the following services:

• Publication service Examples of this service are AdminPublisher, MessagePublisher, and TIBPublisher.

• Subscription service Examples of this service are MessageSubscriber, ExitSubscriber, TIBSubscriber, DeliveryNotificationSubscriber, LocalReportSubscriber, and TransmissionNotificationSubscriber.

Publication Service

The adapter gets a message from the SWIFT network and sends the message to the TIBCO environment.

Figure 5 Typical Publication Service Flow

Subscription Service

The adapter gets a message from the TIBCO environment and sends the message to the SWIFT network.

Message

TIBCO Environment

SWIFTNetwork

TIBCO Adapterfor SWIFT

Publication Service

Page 37: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Adapter Services | 19

Figure 6 Typical Subscription Service Flow

Message

TIBCO Environment

SWIFTNetwork

TIBCO Adapterfor SWIFT

Subscription Service

Page 38: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

20 | Chapter 1 Concepts of TIBCO ActiveMatrix Adapter for SWIFT

Page 39: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| 21

Chapter 2 Getting Started

The chapter provides a short exercise that helps you get started with the adapter. It shows you how to configure the adapter with a publication service, and start and stop the adapter.

Topics

• Prerequisites for the Configuration Exercise, page 22

• Creating a Project, page 23

• Configuring an Adapter Instance, page 25

• Deploying the Adapter, page 26

• Tester Utility, page 29

Page 40: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

22 | Chapter 2 Getting Started

Prerequisites for the Configuration Exercise

Before starting the configuration exercise, ensure that all required software has been installed and is operating correctly. For a list of required software, see TIBCO ActiveMatrix Adapter for SWIFT Installation.

You should know how to drag and drop icons in TIBCO Designer and be familiar with saving projects. If you are not familiar with these topics, read the documentation for TIBCO Designer. It can be accessed from the Help > Designer Help menu option within the Designer.

A set of pre-configured examples is included in the examples directory. See TIBCO ActiveMatrix Adapter for SWIFTNet - FIN Examples Guide for information about using the examples.

Page 41: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Creating a Project | 23

Creating a Project

The TIBCO Designer is used to configure adapter instances. When starting the Designer, you must create or select a project. A project contains the configuration files that define options used by a runtime adapter.

To create a project:

1. Start TIBCO Designer by executing the following commands, depending on your operating system.

— On Microsoft Windows, select Start > All Programs > TIBCO > TIBCO Designer version_number > Designer.

— On UNIX, from a command window, run TIBCO_HOME/designer/version_number/bin/designer.

2. Click the New Empty Project button in the TIBCO Designer dialog, and the Save Project dialog appears.

Figure 7 Create a New Empty Project in TIBCO Designer

3. In the Save Project dialog, click the Browse button for the Project Directory field. Create a directory to store the project: C:\tibco\projects\adswiftnet-fin, then click the OK button. The project will be saved in the adswiftnet-fin directory. See Figure 8.

Page 42: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

24 | Chapter 2 Getting Started

Figure 8 Save the New Empty Project

Page 43: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Configuring an Adapter Instance | 25

Configuring an Adapter Instance

An adapter is configured as a SWIFTNet - FINSender and a SWIFTNet - FINReceiver. SWIFTNet - FINSender subscribes to messages sent by other applications in the SWIFT environment. When a message arrives, SWIFT - FINSender validates it, renders it into a FIN message and sends it to the SWIFT network. SWIFTNet - FINReceiver receives FIN messages from the SWIFT network, then validates it, parses it into a message and publishes it to the TIBCO environment.

Use the following steps to configure the instance:

1. Drag the SWIFTNet - FINSenderConfiguration or SWIFTNet - FINReceiverConfiguration icon from the Palettes panel to the Design panel. This creates an instance named SWIFTNet - FINSenderConfiguration or SWIFTNet - FINReceiverConfiguration. The name can be changed, but in this exercise, use the name assigned by TIBCO Designer.

2. Click the Runtime Connection tab. In the Dispose Type field, select CASmf, FTP or MQSA transferring messages mode from the drop-down list. The default value is CASmf.

3. Configure the required fields according to the different mode you selected, and click the Apply button to save the changes. See Chapter 7, Chapter 8, and Chapter 9 for detailed configuration information.

4. Select Project > Save from the Menu.

Page 44: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

26 | Chapter 2 Getting Started

Deploying the Adapter

This section describes how to deploy the runtime adapter from the command line. The adapter instance configured in the last section will be deployed.

To deploy the adapter from the command line, follow these steps:

1. Modify the .tra files.

a. Open a command window and change directory to the adapter bin directory:

cd C:\TIBCO\adapter\adswift\version\bin

b. Copy the adswiftsender.tra file to a new text file named sub.tra.

copy adswiftsender.tra sub.tra

c. Open the sub.tra file by using a text editor.

write sub.tra

d. Set the following properties. Note that you must supply the absolute path name to the local repository created earlier.

tibco.repourl C:/tibco/projects/export/gsftp.dat

tibco.configurl SWIFTNet-FINSenderConfiguration

application.args adswiftSender -system:propFile

C:/TIBCO/adapter/adswift/version/bin/sub.tra

e. Save and close the sub.tra file, then copy the file to a new text file named pub.tra.

copy sub.tra pub.tra

f. Open the pub.tra file by using a text editor.

write pub.tra

g. Change the following properties:

tibco.configurl SWIFTNet-FINReceiverConfiguration

application.args adswiftReceiver -system:propFile

C:/TIBCO/adapter/adswift/version/bin/pub.tra

h. Save and close the pub.tra file.

Page 45: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Deploying the Adapter | 27

2. Deploy the adapter instance from the command line:

a. Open three command windows.

b. In a command window, start the SWIFTNet - aFINSender from the adapter bin directory:

adswiftSender --run --propFile sub.tra

c. In the second command window, change directory to the adapter examples directory:

cd C:\TIBCO\adapter\adswift\version_number\examples

d. Start Tester.exe. The tester publishes SWIFT messages for the example.

e. Check the FTP server remote directory that was specified for the SWIFTNet - FINSenderConfiguration. It now contains the FTPSender_datetime.txt and FTPSender_datetime.txt messages.

f. In the third command window, start the SWIFTNet - FINReceiver from the adapter bin directory:

adswiftReceiver --run --propFile pub.tra

g. Check the FTP server for the SWIFT messages. The FTPSender_datetime.txt and FTPSender_datetime.txt messages are copied to the messageBackup directory.

3. Stop the adapter

To stop the adapter, in a command window, send messages on the ExitSubscriber subject for the SWIFTNet - FINSender and SWIFTNet - FINReceiver. For example:

tibrvsend domain.gsftp.adswift.Sender.exit exit

tibrvsend domain.gsftp.adswift.Receiver.exit exit

The Tester utility sends a message on the subject %%Domain%%.%%Deployment%%.adswift.%%SenderInstanceId%%.message and the SWIFTNet - FINSender also subscribes on the same subject. However, the Deployment global variable can be different in the case of the Tester utility and the SWIFTNet - FINSender leading to a mismatch in the subject name. To avoid this mismatch, override the tibco.clientVar.Deployment global variable in the Tester.tra file with the deployment value of your project:

tibco.clientVar.Deployment deployment_value

CTRL+C must NEVER be used to shut down the adapter as it could lead to a potential loss or duplication of messages.

Page 46: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

28 | Chapter 2 Getting Started

Exit the Tester.

Page 47: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Tester Utility | 29

Tester Utility

The Tester utility is included in the adapter installation in the examples directory, to test some of the bundled examples.

The utility is used to publish the messages MT101 and MT517 contained in SampleMT.txt file on the subject %%Domain%%.%%Deployment%%.adswift.%%SenderInstanceId%%.message.

• The Tester utility is included to verify adapter configurations. The utility is not supported to use in production environments.

• The Tester utility sends a message on the subject %%Domain%%.%%Deployment%%.adswift.%%SenderInstanceId%%.message and the SWIFTNet - FINSender also subscribes on the same subject. However, the Deployment global variable can be different in the case of the Tester utility and the SWIFTNet - FINSender leading to a mismatch in subject name. To avoid this mismatch, override the tibco.clientVar.Deployment global variable in the Tester.tra with the deployment value of your project:

tibco.clientVar.Deployment deployment value

Page 48: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

30 | Chapter 2 Getting Started

Page 49: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| 31

Chapter 3 Adapter Instance Options

This chapter explains how to create an adapter instance and assign its services by configuring standard settings. All configuration tasks are performed in TIBCO Designer and the information is stored in a project that is later used by the runtime adapter.

Topics

• Overview of an Adapter Instance, page 32

• Adapter Instance Fields, page 33

Page 50: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

32 | Chapter 3 Adapter Instance Options

Overview of an Adapter Instance

All adapter configuration is done with TIBCO Designer. Make sure it has been installed appropriately before continuing (see TIBCO Designer User’s Guide). The guide can be accessed from the TIBCO Designer Help > Designer Help menu.

Configuration TasksA typical configuration session entails the following steps:

1. Start TIBCO Designer and open the default project provided at installation. See the TIBCO Designer User’s Guide for details.

2. Drag the SWIFTNet-FINReceiverConfiguration icon or SWIFTNet-FINSenderConfiguration icon from the Palettes panel to the Design panel. This creates an adapter of the same name.

3. In the Configuration tab, enter a value in the Database Log Prefix field and check the Database Failure Fatal checkbox.

4. Click the Runtime Connection tab, select the CASmf, FTP, or MQSA item from the Dispose Type drop-down list. Configure the properties for the mode that you have selected.

5. Select Project > Save from the Menu to save the project.

6. Select Tools > Show Adapter Tester to verify your adapter configuration.

7. Create an enterprise archive file that will later be imported into TIBCO Administrator. See Chapter 5, Deploying and Starting the Adapter Using TIBCO Administrator, on page 63.

8. Exit TIBCO Designer.

Page 51: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Adapter Instance Fields | 33

Adapter Instance Fields

You can configure an adapter instance in the following tabs:

• Configuration Tab, page 33

• Runtime Connection Tab, page 35

• General Tab, page 38

• Logging Tab, page 42

• Monitoring Tab, page 45

Configuration TabAfter dragging the SWIFTNet - FINSenderConfiguration or theSWIFTNet - FINReceiverConfiguration icon from the Palettes panel to the Design panel, the Configuration tab is selected by default. Table 2 lists and explains the contents in the Configuration tab.

Table 2 Adapter Instance Configuration Tab

Item Description

Instance Name The name of the Adapter Service Engine instance.

Use the default name or replace it with a name of your choice.

See Guidelines for Choosing an Instance Name for more information.

Version The version string indicates the TIBCO ActiveEnterprise (AE) format in which the adapter instance is saved.

Description (optional)

Provide information about the adapter instance stored in the project.

Transformation Plug-in

Specify a transformation plug-in when you have configured a transformation plug-in resource to use with the adapter. The plug-in allows you to manipulate incoming and outgoing data before sending it on the network or handing it to the target application. Plug-ins can be written using the TIBCO Adapter SDK. See the TIBCO Adapter SDK Programmers for information about writing a transformation plug-in.

Role Indicates whether this instance is a SwiftReceiver or SwiftSender.

Receive Time Out Specify the time out value in seconds for receiving logical replies.

Page 52: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

34 | Chapter 3 Adapter Instance Options

Guidelines for Choosing an Instance Name

Use the default name or replace it with a name of your choice.

• An instance name must use alphanumeric characters, and the length of the name must be less than 80 characters. An underscore (_) can be used in an instance name, but the space character cannot be used.

• An instance name cannot use global variables.

• An instance name must be unique with respect to other adapter instances for the same adapter in the project. The same instance name can be used to name an adapter instance for a different adapter in the same project. For example, a SWIFT adapter instance named TEST and a Siebel adapter instance named TEST can coexist in the same project.

• Each instance name must be unique per adapter within a project even if each instance is defined in a different directory. That is, configuring the same-named adapter instances in different directories will not make their names unique.

When you create an adapter instance, the palette automatically creates several resources for it. The names of these resources derive from the name of the instance they belong to. Changing the adapter instance name results in an automatic regeneration of the names of the resources. If you manually modify any resource name, that particular name will not be automatically regenerated next time your rename the adapter instance.

Database Log Prefix Create database tables for logging all messages. For example: SWIFTNet - FINSender or SWIFTNet - FINReceiver. You can specify any value that will be prefixed to the tables created in the database.

Database Failure Fatal

• If an error occurs when logging information to the database and this attribute is checked, the adapter stops operations.

• If an error occurs when logging information to the database and this attribute is not checked, the adapter continues operations and does not log information to the database.

Table 2 Adapter Instance Configuration Tab (Cont’d)

Item Description

Page 53: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Adapter Instance Fields | 35

Runtime Connection TabIn the Runtime Connection tab, the Dispose Type is selected by default. The Dispose Type indicates the mode of transferring messages, and the default value is CASmf. The contents in the Runtime Connection tab can be different, depending on different adapter instance and the dispose type you select. Table 3 lists and explains all contents in the Runtime Connection tab.

Table 3 Adapter Instance Runtime Connection Tab (Sheet 1 of 4)

Contents Description Dispose Type

CASmf FTP MQSA

MAPID Specify the CASmf message partner ID to which the adapter connects.

Yes No No

Number of Reconnect Attempts Before Suspending Impacted Service(s)

Specify the number of reconnection attempts to make before suspending a runtime adapter or adapter service.

Yes Yes No

Maximum Number of Reconnect Attempts

The total number of reconnection attempts to make after the service has been suspended. When this number is reached, the runtime adapter or adapter service will be stopped. A value of -1 means reconnection attempts will continue indefinitely.

Yes Yes No

Interval Between Reconnect Attempts (milliseconds)

Specify the time interval in milliseconds to elapse between each reconnection attempt.

Yes Yes No

User A valid account name to be used to logon to the FTP server.

No Yes No

Password A valid password for the account used to logon to the FTP server.

No Yes No

Host Specify the FTP server host name. No Yes No

Port Specify the FTP server port number. No Yes No

Page 54: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

36 | Chapter 3 Adapter Instance Options

TimeOut Enter the timeout value in milliseconds to read operation from the FTP server. If it does not succeed within this time period, then the read operation is terminated.

No Yes No

Remote File Prefix

(SWIFTNet - FINSender)

Enter a name for this associate attribute. Use this prefix for the files that are placed in the remote directory.

No Yes No

File Extension Specify the file extension to identify files that are considered for transfer. Only those files that have the specified extension are considered for transfer.

No Yes No

Remote Directory Specify the remote directory from which files are transferred. This is the directory that is accessible by SWIFT Alliance Access.

No Yes No

Remote Backup Directory (SWIFTNet - FINReceiver)

Specify the directory where messages from SWIFT Alliance Access should be archived after publishing.

No Yes No

Remote Error Directory (SWIFTNet - FINSender)

If a validation error occurs in a message file, the file is moved to the directory specified in this field.

No Yes No

Polling Count

(SWIFTNet - FINReceiver)

Specify the number of polling periods to wait before polling the source directory.

No Yes No

Table 3 Adapter Instance Runtime Connection Tab (Sheet 2 of 4)

Contents Description Dispose Type

Page 55: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Adapter Instance Fields | 37

Polling Period

(SWIFTNet - FINReceiver)

Specify the polling period in milliseconds. Each FTP transfer is performed with a frequency that is an integral multiple of the polling period.

Note:

When the SWIFT adapter is configured to poll an FTP server at very frequent intervals, there is a risk of the FTP server running out of system resources. Upon encountering such a situation, the adapter displays the following error message:

AESWIFT-000041 "FTP could not

get list of files from remote

directory

/export/home/swift/in: Can't

open passive connection:

Permission denied."

You can resolve the issue by increasing the polling interval of the adapter.

No Yes No

Persist File Prefix Specify the file prefix for the persist files created by the adapter Remote Directory. A persist file is created by the adapter when it is terminated using the exit subscriber, if the value for Persist File Prefix is specified. The value entered gets prefixed to the Persist File name created by the adapter. If no value is specified, the persist file is not created. The persist file stores the filenames of the message that are already processed by the adapter, so that the same messages are not picked up again once the adapter restarts.

No Yes No

Table 3 Adapter Instance Runtime Connection Tab (Sheet 3 of 4)

Contents Description Dispose Type

Page 56: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

38 | Chapter 3 Adapter Instance Options

General TabThe General tab contains some checkboxes and fields. Check or uncheck those checkboxes to decide whether you want to perform the relevant operations or not. Table 4 lists and explains all the contents in the General tab.

mqsaReplyToQueueManager (SWIFTNet - FINSender)

Enter the name of the MQSeries queue manager for the queue where the local reports and outbound messages are placed.

No No Yes

mqsaReplyToQueue

(SWIFTNet - FINSender)

Enter the name of the MQSeries queue where the local reports are placed.

No No Yes

mqsaReport

(SWIFTNet - FINSender)

The adapter supports the positive action notification and the negative action notification reports from MQSA. Therefore this value must be 3.

No No Yes

Table 3 Adapter Instance Runtime Connection Tab (Sheet 4 of 4)

Contents Description Dispose Type

Table 4 Adapter Instance General Tab (Sheet 1 of 4)

Item Description / Action

Parse Message Specify that messages should be parsed into a correctly constructed format.

Validate Message Structure

Perform the structural validation of SWIFT messages. See Guidelines for Validating the Message Structure.

Validate Field Format Perform the format validation of SWIFT messages. This format specification includes character set membership, mandatory subfield presence, fixed- and maximum-length subfield enforcement, and multi-line subfield line count enforcement. All SWIFT text and header fields must follow their format specifications exactly.

Note: certain field format errors are considered parse errors and will appear even when this validation feature is disabled.

Page 57: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Adapter Instance Fields | 39

Validate Data Types Perform the datatype validation of SWIFT messages. SWIFT header and text subfields, such as message types, currency codes, amounts, dates, and times are all validated for correct format. And the syntactic BIC and LTA validation are part of this feature. Validation against the BIC database requires use of the Validate BIC/BEI field.

Validate Qualifier Code Words

Perform code word validation of SWIFT messages. SWIFT code words are various qualifier-dependent values used in various text subfields. The SWIFT network is currently in a transition for code word validation and not all customers may wish to validate code words.

Validate BIC/BEI Perform validation of SWIFT message BIC/BEI codes against a BIC directory. SWIFT BIC and BEI codes are entity identifiers that appear in various subfields of the text block. Validating them is expensive because data must be searched for in a very large (65MB) database that is time- and memory-consuming to load.

The application has provided an FI.dat BIC directory to the validator at the initialization time, then full BIC/BEI validation is performed against the provided directory. If no BIC directory is provided, then the adapter uses the default BIC file.

If this feature is not enabled, syntactic BIC/BEI validation is still performed, but only if Validate Data Types is enabled.

Note: use the latest BIC file provided by SWIFT for up-to-date BIC or BEI validation.

Validate Field-Level Semantics

Perform the field-level semantic validation of SWIFT text blocks. Field-level rules are SWIFT network validation rules that relate data in the subfields of a single field. Examples include "field 22H must have one of subfield Narrative, or Amount, but not both".

Note: this validation is not performed for SWIFT-to-USER system messages even if this feature is enabled. Because these messages are always coming from SWIFT, and they are assumed to be valid.

Table 4 Adapter Instance General Tab (Sheet 2 of 4) (Cont’d)

Item Description / Action

Page 58: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

40 | Chapter 3 Adapter Instance Options

Validate Message-Level Semantics

Perform the message-level semantic validation of SWIFT text blocks. Message-level rules are SWIFT network validation rules that relate data in different parts of a message. Examples include "if field 22H in sequence A has value X, then field 98A in sequence B must be

present". These rules are complex and slow the validation process. Furthermore, customers frequently enforce these rules downstream of the validator in their own business logic, so it isn't always necessary to enable this sort of validation.

Note: This validation is not performed for SWIFT-to-USER system messages even if this feature is enabled. Because these messages are always coming from SWIFT, and they are assumed to be valid.

Validate Structured Narrative

Perform the structured narrative validation of SWIFT message headers. Various SWIFT narrative tags (for example, 71B, 72, party fields) require structure when they are used in various messages. The structure typically consists of keywords, continuation characters, or both, sometimes in a particular order.

Validate Advanced Header

Perform the advanced validation of SWIFT message headers. Such validation includes enforcing the order of tags in the user header section; enforcing the order of tags in the trailer section; and enforcing relationships between delivery options, message types, and obsolescence periods in the application header.

BIC Code File (FI.dat) Click the Browse button and navigate to the location of the BIC or BICPlus file. Select the file and click the Open button to load it.

Note: the BIC or BICPlus file is extremely large and, if specified, will cause the adapter startup time to increase. If this file is not specified, BIC/BEI codes are checked for structural validity only.

ISO3166 Country Code File (CT.dat)

Click the Browse button and navigate to the location of the country code data file. Select the file and click the Open button to load it.

Note: ISO3166 country codes is used if the file is specified here. Otherwise, an internal database of country codes is used.

ISO4217 Currency Code File (CU.dat)

Click the Browse button and navigate to the location of the currency code data file. Select the file and click the Open button to load it.

Note: ISO4217 currency codes is used if the file is specified here. Otherwise, an internal database of currency codes is used.

Table 4 Adapter Instance General Tab (Sheet 3 of 4) (Cont’d)

Item Description / Action

Page 59: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Adapter Instance Fields | 41

Guidelines for Validating the Message Structure

Structural validation contains the following:

• The fields of all required basic and application headers appear with the correct length.

• The basic header and service identifiers are valid.

• Application input and output indicators are valid.

• Application input delivery monitoring and obsolescence are not allowed to display in the message unless the priority appears.

• Application input obsolescence is not allowed to display in the message unless the delivery monitoring appears.

• The user header appears if required.

• Message types requiring a user header field validation tag 119 have such a tag.

• No duplicate user header or trailer tags are found.

• No invalid user header, trailer, or system acknowledgement tags are found.

• The length of all user header, trailer, and system acknowledgement tag values are correct.

• Message types requiring user header field validation tags to select correct message metadata (types 102, 103, and 574) have validation tags with valid values.

• All mandatory text block sequences and fields appear in the message.

• The text block contains no invalid fields.

Validation Filter File (ValidationFilter.xml)

Click the Browse and navigate to the location of the ValidationFilter.xml file. See Using Validation Filters on page 58 for more information.

Table 4 Adapter Instance General Tab (Sheet 4 of 4) (Cont’d)

Item Description / Action

Page 60: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

42 | Chapter 3 Adapter Instance Options

Specification TabTable 5 lists and explains all contents in the Specification tab.

Logging TabUse these settings to configure a log file or log sinks, including which types of trace messages you want to log and where they are sent. Table 6 lists and explains all contents in the Logging tab.

Table 5 Adapter Instance Specification Tab

Items Descriptions

Specification Contains the SWIFT specifications that you can select.

Message Types The table contains the list of all the message types supported by SWIFT. Check the checkbox next to the message type for which the schema needs to be loaded.

Table 6 Adapter Instance Logging Tab

Items Description

Use Advanced Logging

When Use Advanced Logging is unchecked (the default), you can set two standard output destinations (sinks) for trace messages and set the tracing level for the roles selected.

When Use Advanced Logging is checked, you have complete control on selecting the destinations and associating desired roles with each of the destinations.

The following are the sink types available:

• File

• Hawk

• Network

• STDIO

See Creating Log Sinks for more information.

Log to Standard I/O

(stdioSink only) When it is checked, trace messages are displayed in the command prompt window where the adapter is started. When it is unchecked, trace messages are not displayed in the window.

Page 61: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Adapter Instance Fields | 43

Creating Log Sinks

When you check the Use Advanced Logging checkbox, you configure log sinks using icons in the TIBCO Designer project panel. This gives you complete control on selecting the destinations and associating desired roles with each of the destinations.

1. Check the Use Advanced Logging checkbox in the Logging tab.

2. Click the Apply button.

3. In the TIBCO Designer project panel, select the SWIFTNet - FINSenderConfiguration or SWIFTNet - FINReceiverConfiguration icon, then select the Log Sinks directory in the Advanced directory. See Figure 9.

Log File Specify the name of the log file (log sink) to which trace messages are written. Global variables can be used to specify the location of the log file. See Using Global Variables on page 72 for more information.

The available roles of Log File are Info, Debug, Warning, and Error messages. The trace message generated depending on the roles selected. Turning on the roles can affect the performance of the adapter. Therefore, it is recommended that you turn on the required roles only.

Log Info/Debug/Warning/Error Messages

Trace messages of the selected level(s) will be collected in the named log sink. You can configure what levels of trace messages you want to log, and where the trace messages are sent. There are three types of logs (log sinks) that you can configure to hold trace messages, information, warning, and error. The fourth level of the trace messages, Debug, is reserved and should not be enabled unless requested by the TIBCO Product Support Group. This option writes a lot of information to the log file and significantly reduces the speed of the adapter.

Table 6 Adapter Instance Logging Tab (Cont’d)

Items Description

Page 62: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

44 | Chapter 3 Adapter Instance Options

Figure 9 Creating Log Sinks

4. To create a new log sink, drag the Generic Log Sink icon from the Palette panel to the Design panel. Select the sink type from the Sink Type drop-down list in the Configuration tab, then click the Apply button. See Figure 10.

Figure 10 Creating a New Log Sink

Page 63: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Adapter Instance Fields | 45

5. With the desired log sink icon selected in the design panel, fill in the fields in the Configuration tab. You can also change the name and enter a description for each sink by right-clicking on the sink icon in the project panel.

— When File and STDIO sinks are created from the generic log sink, more further configuration options are displayed. For the File sink, by the default, the file limit and the file count are specified as 30000 bytes and 3, and the append mode checkbox is checked. For the STDIO sink, the option to write to stdout or stderr can be selected. By default, stdout radio button is selected.

— The Hawk sink is created and used by the adapter for monitoring purposes. It uses the hawk session to send tracing messages to the TIBCO Hawk monitor or display. For details on Hawk sessions, see Using Global Variables on page 72. The configuration for the Hawk sink involves specifying the MicroAgent Name that must be specified in the configuration panel.

— The Network sink is used to publish tracing message on TIBCO Rendezvous. The configuration for the network sink involves specifying the session, and the subject on which the trace messages needs to be published.

Startup TabThis tab displays the startup behaviors. Table 7 lists and explains all contents in the Startup tab.

Monitoring TabMany of the following fields make use of global variables. Click the Global Variables tab in the project panel to enter a value for a global variable. Table 8 lists and explains all contents in the Monitoring tab.

Table 7 Adapter Instance Startup Tab

Items Description

Show Startup Banner

When it is checked, the adapter’s startup banner displays the runtime adapter version, the infrastructure version on which the adapter is built, and the copyright information in the console window from which the adapter is started.

Metadata Search URL

The field specifies the location where the adapter searches for base schemas. The adapter searches for any schema that has been defined and saved at this location, and that should be loaded at startup.

Page 64: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

46 | Chapter 3 Adapter Instance Options

Table 8 Adapter Instance Monitoring Tab

Items Description

Enable Standard MicroAgent

Allows you to turn on or off the standard TIBCO Hawk MicroAgent. The way to turn it on or off is also configurable. Clicking the Globe button, a standard checkbox or text value (true or false) can be used to turn the standard microagent on or off.

Standard MicroAgent Name

This is the name for the standard microagent that will be registered with the TIBCO Hawk system. In most cases the default value is used. The InstanceId variable need not be set because it is automatically set at runtime by the runtime adapter.

Standard MicroAgent Timeout (ms)

The timeout value for the standard microagent in milliseconds.

The default value is 10000.

Enable Class MicroAgent

Allows you to turn on or off the instance or class specific standard TIBCO Hawk microagent. The way to turn it on or off is also configurable. By clicking the Globe button, a standard check box or text value (true or false) can be used to turn the class microagent on or off.

Class Microagent Name

This is the name for the class microagent that will be registered with the TIBCO Hawk system. In most cases the default value is used.

Class MicroAgent Timeout (ms)

The timeout value for the class microagent in milliseconds.

The default value is 10000.

Default Microagent Session

Specify the name of the TIBCO Rendezvous session that will be used by the standard, class, and custom microagents.

TIBCO Designer automatically generates the session name and the corresponding session. Do not change the session name or the session. However, you can modify the session parameters if required. Navigate to the Sessions directory in the Advanced directory to modify the session parameters.

Make sure you have set the correct parameter value for the global variables that correspond to the TIBCO Hawk configuration. If the session parameters are not set properly, the microagents will not display in the TIBCO Hawk Display.

Page 65: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| 47

Chapter 4 Adapter Services Options

Topics

• Adapter Services Overview, page 48

• Transport Specific Service Options, page 50

• Publication Service and Subscription Service, page 54

Page 66: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

48 | Chapter 4 Adapter Services Options

Adapter Services Overview

The following sections describe the fields available for the pre-configured adapter services that are included in SWIFTNet - FINReceiver and SWIFTNet - FINSender.

SWIFTNet - FINReceiverSWIFTNet - FINReceiver receives SWIFT messages from the SWIFT network via MQSA, CASmf or FTP, parses the message (if the Parse Message checkbox is checked in the General tab) and publishes it on the transport selected. The following pre-configured services are available for SWIFTNet - FINReceiver:

• AdminPublisher—A reliable or certified publication service used to send logical replies, delivery reports, and transmission reports.

• MessagePublisher—A reliable or certified publication service in SwiftReceiver that publishes the SWIFT messages received from the SWIFT network as TIBCO ActiveEnterprise messages.

• ExitSubscriber—A reliable or certified subscription service in both adapter configurations, used to shut down only the particular adapter instance.

• TIBSubscriber—A reliable or certified subscription service in the SWIFTNet - FINReceiver instance when the MQSA interface is in use. Subscribes to and parses messages being sent from the SWIFT network via TIBCO Adapter for MQ Series.

SWIFTNet - FINSenderSWIFTNet - FINSender subscribes to messages on the selected transport and sends SWIFT messages to the SWIFT network via MQSA, CASmf or FTP. The following services are available for SWIFTNet - FINSender:

• MessageSubscriber—A reliable or certified subscription service in SwiftSender that subscribes to SWIFT messages received from the TIBCO environment as ActiveEnterprise or XML messages.

• AdminPublisher—A reliable or certified publication service used to send logical replies, delivery reports, and transmission reports. If message validation fails within the adapter, error messages are published in the logical reply schema using AdminPublisher.

• TIBPublisher—A reliable or certified publication service in the SWIFTNet - FINSender instance when the MQSA interface is in use. Publishes SWIFT

Page 67: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Adapter Services Overview | 49

messages to TIBCO ActiveMatrix Adapter for WebSphere MQ, which in turn sends it to the SWIFT network via MQSA.

• ExitSubscriber—A reliable or certified subscription service in both adapter configurations, used to shut down only the particular adapter instance.

• DeliveryNotificationSubscriber—A reliable or certified subscription service in the SWIFTNet - FINSender instance when the MQSA interface is used. Subscribes to and parses Delivery Reports published by TIBCO ActiveMatrix Adapter for WebSphere MQ, which receives the message from the SWIFT network via MQSA.

• LocalReportSubscriber—A reliable or certified subscription service in the SWIFTNet - FINSender instance when the MQSA interface is used. Subscribes to and parses local reports published by TIBCO ActiveMatrix Adapter for WebSphere MQ, which receives the message from the SWIFT network via MQSA.

• TransmissionNotificationSubscriber—A reliable or certified subscription service in the SWIFTNet - FINSender instance when the MQSA interface is in use. Subscribes to and parses Transmission Notifications published by TIBCO ActiveMatrix Adapter for WebSphere MQ, which receives the message from the SWIFT network via MQSA.

Page 68: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

50 | Chapter 4 Adapter Services Options

Transport Specific Service Options

The transport type (Rendezvous or JMS) you select for the runtime adapter determines transport specific service options such as quality of service, delivery mode, wire format, and so on. Only options that are compatible with a service’s transport type will be available.

This section explains transport type and some of the transport specific service configuration options, as follows:

• Transport Type, page 50

• Quality of Service, page 51

• Delivery Mode, page 51

• Connection Factory Type, page 52

• Wire Format, page 52

Transport TypeThere are two transport types available for the runtime adapter, namely JMS and Rendezvous. After selecting the transport type, you can configure the transport specific options.

The transport can be configured to use a trusted store and identity resource for use in SSL (Secure Sockets Layer) configurations. TIBCO Rendezvous session and JMS session have an SSL configuration field which uses a dialog to perform SSL configuration.

To enable and configure SSL:

1. In the Project panel, select the adapter instance.

2. Expand Advanced > Sessions, then select the DefaultRVCMSession or DefaultJmsTopicSession item.

3. Check the Use SSL? checkbox in the Configuration tab, then click the Configure SSL... button to do further configuration.

The SSL configuration options are explained in the online help associated with the session dialog.

Page 69: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Transport Specific Service Options | 51

Quality of ServiceThis drop-down list appears only when TIBCO Rendezvous is selected as the transport type in the Configuration tab. There are two types of services that can be selected:

• Certified

Guarantees that every certified message reaches its intended recipient in the order sent. The message can be sent across network boundaries, and if a network fails, delivery attempts continue until delivery succeeds or until the message's time limit expires. This is often called certified message delivery.

If certified message delivery is used, data is stored in a ledger file. The size of the ledger depends on several factors, the most important of which is the retention rate of stored data. That is, the ledger grows fastest in response to the cumulative length of undeliverable messages. You must ensure that sufficient disk space is available for the expected size of the ledger.

• Reliable

Ensures that each multicast or broadcast message is received as long as the physical network and packet recipients are working, and that the loss of a message is detected. This choice can compensate for brief network failures because it can retransmit a message on request if the first attempt failed. This choice is appropriate when message delivery is expected but some loss can be tolerated.

• Distributed Queue

Indicates that load balancing is enabled. An RVCMQ Session allows applications to use distributed queues for certified delivery, to any number of listeners using queuing member sessions that act together to process inbound task messages.

Delivery ModeThis drop-down list appears only when JMS is selected as the transport type in the Configuration tab.

• For Publication and Request-response Invocation services, the delivery modes are:

— Persistent

In general, a message marked persistent will be available to a JMS client even if TIBCO Enterprise Message Service server goes down. Persistent messages are held in secondary storage in the server and have guaranteed delivery when sent to a topic that has durable subscribers. (If a topic has no durable subscribers, there are no subscribers that need messages resent in

Page 70: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

52 | Chapter 4 Adapter Services Options

the event of a server failure and therefore messages do not need to be saved.) Performance is improved because disk I/O is not required.

— Non-persistent

A message marked non persistent will not be available to a JMS client if the TIBCO Enterprise Message Service server goes down. These messages are never written to persistent storage.

• For Subscription and Request-response services, the delivery modes are:

— Durable

Indicates that the service is registered with the EMS server. Messages sent to a durable Subscription service are held by the EMS server until they are consumed by the service. The service can be down and expect to receive its messages when it comes back up.

— Non-durable

Indicates that the service is not registered with the EMS server. Messages sent to a non-durable Subscription service are not held by the EMS server. If the service is down, it will not receive the messages that arrived at the EMS server while the service is down.

The semantics for these fields are somewhat more complex than the explanation given here. See the TIBCO Enterprise Message Service User’s Guide for more information.

Connection Factory TypeThis drop-down list appears only when JMS is selected as the transport type in the Configuration tab. There are two types of services that can be selected:

• Topic

A message published to a topic is broadcast to one or more subscribers. All messages published to the topic are received by all services that have subscribed to the topic. This messaging model is known as publish-subscribe.

• Queue

One and only one receiver consumes a message sent to a queue. Each message has only one receiver though multiple receivers may connect to the queue. The first receiver that accesses the queue gets the message. The other receivers do not. This messaging model is known as point-to-point.

Wire FormatServices must use the same wire format to exchange data.

Page 71: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Transport Specific Service Options | 53

• Rendezvous Message (TIBCO Rendezvous only)

Control information for validation is not sent in the message. When you use this format, the adapter is compatible with adapters not developed with TIBCO Adapter SDK.

• XML Message (TIBCO Rendezvous or JMS)

The XML Message wire format conforms to specifically construct, and fully compliant with the XML Schema (XSD) based on the existing definition of the ActiveEnterprise schema.

• ActiveEnterprise Message (TIBCO Rendezvous only)

Control information for validation is sent in the message. If no control information is included, an exception is returned to the subscriber. ActiveEnterprise standard wire format provides class information and packing rules for the TIBCO Adapter SDK set of data types. This format allows ActiveEnterprise components to perform extra validation on messages sent or received.

See TIBCO Adapter SDK Programmer’s Guide for details about the control information generated and sent with TIBCO ActiveEnterprise messages.

Page 72: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

54 | Chapter 4 Adapter Services Options

Publication Service and Subscription Service

The publication service sends messages that it gets from the SWIFT network to applications configured for the TIBCO environment. The subscription service receives messages from applications configured for the TIBCO environment and sends them to the SWIFT network.

The following tabs are available for both services:

• Configuration Tab on page 54

• Transport Tab on page 55

Configuration TabYou can specify a name and select the transport type for a Publication service or a Subscription service in this tab.

Table 9 Configuration Tab of Publication Service and Subscription Service

Field Description

Name You can use the default name or replace it with a name of your choice.

• An instance name must use alphanumeric characters, and the length of the name must be less than 80 characters. An underscore (_) can be used in an instance name, but the space character cannot be used.

• An instance name cannot use global variables.

Description This field provides the additional information about the Publication service or Subscription service being configured.

Transport Type Select the transport type from the drop-down list, JMS or Rendezvous, to be used by the runtime adapter. After selecting the transport type, the transport-specific configuration fields display.

The transport type can be configured to use a trusted store and identity resource for use in SSL (Secure Sockets Layer) configurations. TIBCO Rendezvous sessions and JMS topics have an SSL configuration field which uses a dialog to perform SSL configuration. See Transport Type for enabling and configuring the SSL.

Page 73: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Publication Service and Subscription Service | 55

Transport TabMessage Transport options can be set for a Publication service or a Subscription service depending on the transport type selected in the Configuration tab.

Table 10 Transport Tab of Publication Service and Subscription Service (Sheet 1 of 3)

Field Description

When TIBCO Rendezvous is selected as the transport type, the following options are available.

Message Subject

By default a service uses a message subject that is generated using the Domain and Deployment global variables, the adapter acronym, the adapter instance name, and the service name. If you use this default subject, make sure the values for Domain and Deployment are not empty. You can type a TIBCO Rendezvous subject name different from the default in this field.

See TIBCO Rendezvous Concepts for information about specifying subject names.

Reply Message Subject

(Publication service only) This field is disabled for Publication service.

Quality of Service

Select the level of service that determines how messages are sent.

For Publication service, there are two options can be selected:

• Reliable

• Certified

For Subscription service, there are three options can be selected:

• Reliable

• Certified

• Distributed Queue

After selecting Distributed Queue, a session called DefaultRVCMQSession is created in the Project. You can modify the parameters of this default session if needed.

An Endpoint called TIBSubscriberEndPoint is automatically created upon the creation of the DefaultRVCMQSession session for the subscription service. No attributes of this endpoint need to be manually edited.

Note that the Transactional quality of service is not supported.

See Quality of Service for a description of these options.

Page 74: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

56 | Chapter 4 Adapter Services Options

Wire Format The wire format in which data will be sent. See Wire Format for a description of these

formats.

• ActiveEnterprise Message

• XML Message

Session Reference

When you create a service, TIBCO Designer creates a corresponding session resource in the Advanced > Sessions directory. The session resource displays in this field. If you have explicitly created a custom session of the same type, you can click the Browse button to replace the autocreated session. Changing the session for a service is not recommended.

Endpoint Reference

Specify the location in TIBCO Repository where the endpoint information will be stored. Endpoints store information, such as message subject, endpoint type (reliable publication service and certified publication service), and startup state (active and inactive).

Note that it is recommended that you retain pre-configured endpoint references.

When JMS is selected as the transport type, the following options are available.

Destination By default a service uses a dynamic destination that is generated using the Domain and Deployment global variables, the adapter acronym, the adapter instance name, and the service name. If you use this default dynamic destination, make sure the values for Domain and Deployment are not empty. You can override the default dynamic destination by specifying the static destination in this field. The static destination must be defined on the JMS server before it can be used by the runtime adapter. See TIBCO Enterprise Message Service User’s Guide for information about destinations.

Reply Destination

(Publication service only) This field is disabled for Publication service.

Wire Format The wire format in which messages are to be published. See Wire Format for a description of the format.

• XML Message

Table 10 Transport Tab of Publication Service and Subscription Service (Sheet 2 of 3)

Field Description

Page 75: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Publication Service and Subscription Service | 57

Connection Factory Type

Select one of the following:

• Topic

• Queue

See Connection Factory Type for a description of connection factory type.

Delivery Mode The delivery mode for each message sending operation.

For Publication service, select the following two options:

• Persistent

• Non-Persistent

For Subscription service and only available when you select Topic as the connection factory type, select the following two options:

• Durable

• Non-Durable

See Delivery Mode for a description of each mode.

Session Reference

When you create a service, TIBCO Designer creates a corresponding session resource in the Advanced > Sessions directory. The session resource displays in this field. If you have explicitly created a custom session of the same type, you can click the Browse button to replace the autocreated session. Changing the session for a service is not recommended.

Endpoint Reference

Specify the location in TIBCO Repository where the endpoint information will be stored. Endpoints store information, such as message subject, endpoint type (reliable publication service and certified publication service), and startup state (active and inactive).

Note that it is recommended that you retain pre-configured endpoint references.

Table 10 Transport Tab of Publication Service and Subscription Service (Sheet 3 of 3)

Field Description

Page 76: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

58 | Chapter 4 Adapter Services Options

Using Validation Filters

This feature enables you to specify and thus selectively filter out validation warnings that the adapter may generate when processing an invalid message. This feature gives the adapter user a fine-grained control over the overall validation feature; in addition to the predefined validation features provided. This section contains an example of how to do this.

Filter GroupsThe file consists of a list of filter groups. Each filter group has a specification that defines the SWIFT message type or types to which the group's filters apply. A wildcard "*" character is permitted as the entire message type specification, or can appear after one or more message type characters. The specification "*", for example, would apply its filter group to all SWIFT message types; the specification "5*" would apply its filter group to all SWIFT message types whose first digit was 5; and so on.

FiltersWithin each filter group are zero or more filters. Each filter contains a "disable path specification" and an optional error code. A path specification is an XPath-like string that identifies one or more fields in a SWIFT message. See Path Specification on page 59 for details on how to construct path specifications. All fields that match the filter's path specification will have their validation warnings suppressed.

If the filter also contains a SWIFT error code, then in addition to a path match with a field, only those validation errors with that particular error code will be suppressed. This feature allows even finer-grained control of validation. Consider the following filter:

<FILTER PATH="Text/A/22C//"/>

The above filter will suppress validation for all occurrences of field 22C in sequence A, for all messages in the filter's filter group. Another example:

<FILTER PATH="Text/A/22C//" ERRORCODE="T22"/>

Suppression DOES NOT apply to parse errors, only validation errors. If a SWIFT message is invalid at a fundamental structural level, and cannot be parsed, then such parse errors cannot be filtered out.

Page 77: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Using Validation Filters | 59

This filter is more fine-grained than the previous filter. It only suppresses validation errors on field 22C in sequence A with SWIFT error code T22. All other validation errors for this field pass through the filter.

Not all filters need apply to the text block of a SWIFT message. The following filter disables validation of the basic header's Logical Terminal Address:

<FILTER PATH="Basic/LT"/>

The following XML contains examples of how to disable various kinds of validation:

--> - <FILTERLIST>- <!--Disable validation of 23G and 98B, but only for message

type 509 --> - <FILTERGROUP MESSAGETYPE="509">

<FILTER PATH="Text/A/23G//" /> <FILTER PATH="Text/B/QG98/98B//" />

</FILTERGROUP>- <!-- Disable basic header LTA validation for all SWIFT messages

--> - <FILTERGROUP MESSAGETYPE="*">

<FILTER PATH="Basic/LT" /> </FILTERGROUP>

- <!-- Very specific validation of field 22C --> - <FILTERGROUP MESSAGETYPE="365">

<FILTER PATH="Text/A/22C//" ERRORCODE="T22" /> </FILTERGROUP>

</FILTERLIST>

Path SpecificationThe filter uses a subset of the XPath grammar with a few additional abbreviations to identify one or more elements of a message.

The XPath like syntax for the identifying path is composed of tokens separated by the slash (/) character. Each token is composed of an element name or the wildcard character (*). Optionally a predicate can be added inside square brackets immediately following the element name. The predicates supported are a simple one based index to identify the position of an element and an expression to identify an attribute of the element. Only one predicate in square brackets is allowed per element name. In addition, only tag fields support the attribute value expression. An additional abbreviation is allowed with the attribute matching expression. Multiple values can be entered separated by a vertical bar to denote that either of the supplied values should match.

Page 78: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

60 | Chapter 4 Adapter Services Options

The slash separator character is used to mark the separation of element names. They are also used to identify characteristics of the start and end of the path. A slash at the start of a path identifies the path as an absolute path. Since all paths are evaluated from the message the path can be a relative path that does not start with a slash or an absolute path that does start with a slash. As an addition to XPath a slash at the end of the path indicates that the path should match the last name in the path as well as any immediate children of that element. Two slashes indicate all descendents of the element should match.

Valid Paths

As an example, the following are valid paths:

Table 11 Path Specification

Field Description

Text The message Text block as sequences.

Basic The message Basic Header: AppId, Service, LT, Session, Sequence.

App The message Application Header:

io—IO flag, either "I" or "O".

I—Input Header: Type, Receiver, Priority, Delivery, Obsolescence.

O—Output Header: Type, InputTime, MIR, OutputDate, OutputTime, Priority.

User The message User Header.

Tags The message Text block as a flat list of tag fields.

Trailer The message Trailer.

S The message SWIFT Alliance trailer if it exists.

Table 12 Using Validation Filters: Valid Paths

Field Description

/Basic/AppId The AppId in the Basic Header.

/Basic/* Any subfield of the Basic Header.

Basic/*[2] The second subfield in the Basic Header.

Basic/2 The second subfield in the Basic Header.

/Text/A/A1[2]/A1a/16R/1 Returns the first subfield of a 16R.

Page 79: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Using Validation Filters | 61

Invalid Paths

The following paths are not valid:

/Text/A/*[2]/16R/Qualifier Refers to any second sequence in A.

Text/A/*/57D/2-3 Refers to subfield 2 to 3 of tag field 57D in any sequence in A.

/Tags/16R/Qualifier Identified the subfield by name.

Tags/*/1 The first subfield of the any tag field.

/App/O/MIR MIR in the Output Header of the Application Header.

/App/io The io value for the Application Header.

/User/119 Subfield 119 of the User Header.

Trailer/MAC Subfield MAC of the Trailer.

/Text/A/ Refers to A and any immediate sequences, qualifier groups, or fields.

Text/A// Refers to A and any descendent sequences, qualifier groups, or fields.

/Text/A/A1[2]/QG22/22F [@Qualifier=MICO]

A 22F tag field where the Qualifier subfield is 'MICO'.

Text/A/A1[2]/QG22/22F [@Qualifier=MICO|FORM]

A 22F tag field where the Qualifier subfield is 'MICO' or 'FORM'.

// Refers to the message and any element in the message.

Table 12 Using Validation Filters: Valid Paths (Cont’d)

Field Description

Table 13 Using Validation Filters: Invalid Paths

Field Description

Text/A/A1[2]/A1a/16RS/Qualifier

Multiple option characters for tags with different field names are not supported.

Invalid/12A/2 Not a valid part of the message.

Page 80: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

62 | Chapter 4 Adapter Services Options

Page 81: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| 63

Chapter 5 Deploying and Starting the Adapter Using TIBCO Administrator

This chapter provides an overview about deploying, starting, stopping, and monitoring adapters using the TIBCO Administrator.

Topics

• Creating an EAR File in TIBCO Designer, page 64

• Deploying a Project, page 65

• Starting or Stopping the Adapter, page 66

• Monitoring the Adapter, page 67

See the TIBCO Administrator documentation set for details about using TIBCO Administrator.

Page 82: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

64 | Chapter 5 Deploying and Starting the Adapter Using TIBCO Administrator

Creating an EAR File in TIBCO Designer

Generate an Enterprise Archive file (EAR) that contains information about the adapter services and processes to deploy.

You can deploy one or more adapter services, one or more TIBCO ActiveMatrix BusinessWorks process engines, or both.

In TIBCO Designer, follow these steps to create an EAR:

1. Configure the adapter services for an adapter instance.

2. Drag the Enterprise Archive icon from the Palette panel to the Design panel. If there are any configured adapter services in your project, an Adapter Archive resource becomes available in the Palette panel.

3. Specify information in the Configuration tab, then click the Apply button.

4. Click the Build Archive button to create the archive file.

See Also

See TIBCO Designer User’s Guide for more information about this procedure. The guide is available from the Designer Help menu.

Building an archive creates the EAR file, which you can then deploy from TIBCO Administrator. If you make changes to the business processes or adapter services included in the archive, you need to rebuild the archive. Saving the project does not affect the archive.

You can also create an adapter archive from Tools > Create Project EAR if you have an existing process or adapter instance.

Page 83: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Deploying a Project | 65

Deploying a Project

Before deploying a project, the machine on which the adapter is installed must be part of a TIBCO administration domain. After you have installed the TIBCO Administration Server, any machine on which you install TIBCO Runtime Agent (required by an adapter) can be added to the administration domain. The TIBCO software installed on the machine is then visible and accessible via the TIBCO Administrator GUI.

When you deploy a project, startup scripts and other information about the different components are sent to the machines to which the components were assigned. The project data store and TIBCO Administration Server are updated with the deployed components.

To deploy a project:

1. Start TIBCO Administrator and import the EAR file into TIBCO Administrator Enterprise Edition.

2. Assign adapter archives in the EAR file to adapters installed in the administration domain and likewise assign process archives to process engines.

3. Specify startup options for each adapter service.

4. If desired, set up your deployment for fault tolerance by specifying more than one adapter service to run on different machines. The secondary services will run in standby mode until they are needed.

See Also

See the TIBCO Administrator User’s Guide for an introduction to the TIBCO administration domain and detailed information about the above steps.

See the TIBCO Administrator Server Configuration Guide for fault tolerance information.

Page 84: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

66 | Chapter 5 Deploying and Starting the Adapter Using TIBCO Administrator

Starting or Stopping the Adapter

The TIBCO Administrator Application Management module allows you to start and stop deployed applications.

Starting the Adapter

To start the adapter service from the module:

1. In TIBCO Administrator GUI left pane, expand Application Management > Application_Name > Service Instances.

2. In the Service Instance panel, check the checkbox next to the adapter service.

3. Click the Start button. The service status changes from Stopped to Starting Up to Running.

Stopping the Adapter

To stop the adapter service, click the Stop button. The service status changes from Running to Shutting Down to Stopped.

See Also

See TIBCO Administrator User’s Guide for more information.

Page 85: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Monitoring the Adapter | 67

Monitoring the Adapter

TIBCO Administrator offers a number of monitoring options.

• Specify alerts and TIBCO Hawk rulebases for each machine in the domain.

• Specify alerts and TIBCO Hawk rulebases for each adapter service.

• View the log for each adapter service.

See Also

See TIBCO Administrator User’s Guide for information about configuring the above monitoring options.

Page 86: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

68 | Chapter 5 Deploying and Starting the Adapter Using TIBCO Administrator

Page 87: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| 69

Chapter 6 Advanced Configuration Options

This chapter explains the advanced topics, such as modifying TIBCO Rendezvous session parameters, modifying TIBCO JMS session parameters, using global variables, parsing and validating SWIFT files using SwiftCheck, loading SWIFT message types into a respository, and sending and validating SWIFT messages using SwiftPublisher.

Topics

• Modifying TIBCO Rendezvous Session Parameters, page 70

• Modifying TIBCO JMS Session Parameters, page 71

• Using Global Variables, page 72

• Parsing and Validating SWIFT Files Using SwiftCheck, page 76

• Loading SWIFT Message Types into a Repository, page 78

• Sending and Validating SWIFT Messages using SwiftPublisher, page 79

Page 88: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

70 | Chapter 6 Advanced Configuration Options

Modifying TIBCO Rendezvous Session Parameters

By default, TIBCO Runtime Agent uses predefined TIBCO Rendezvous sessions named DefaultRVSession. These sessions are configured to use the default TIBCO Rendezvous session parameters, but these parameters can be modified to fit your environment. For instance, if you are running a remote daemon, you will need to specify the Service, Network and Daemon parameters.

1. Open TIBCO Desinger, and create a new project.

2. In the Project panel, expand the required adapter configuration directory, then expand the Advanced > Sessions directory, and click the DefaultRVSession item.

3. Click the Help for DefaultRVSession button for a description of field values.

Figure 11 TIBCO Rendezvous Session Configuration Screen

Page 89: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Modifying TIBCO JMS Session Parameters | 71

Modifying TIBCO JMS Session Parameters

When the transport type for an adapter service is changed from TIBCO Rendezvous to JMS, DefaultJmsQueueSession or DefaultJmsTopicSession is created.

1. Open TIBCO Desinger, and create a new project.

2. In the Project panel, expand the required adapter configuration directory, then expand the Advanced > Sessions directory, and click the DefaultJmsTopicSession item.

3. Click the Help for DefaultJmsTopicSession button for a description of field values.

Figure 12 TIBCO Enterprise Message Service Session Configuration Screen

Page 90: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

72 | Chapter 6 Advanced Configuration Options

Using Global Variables

The variable substitution mechanism can override the global variables predefined in the project in a restricted manner. Predefined variables can be viewed and set in TIBCO Designer. Variables are specified as %%VARNAME%% and cannot contain any white space.

Variable substitution allows you to accomplish the following.

• Substitute string variables specified in the project at the startup time.

• Locally define the value for a variable for a specific project. The local value takes precedence over any global value.

• Specify the value for a variable in a properties file. This overrides the project repository and values set in code, but not variables set on the command line.

• Enforce the predefined variables listed in Predefined Global Variables on page 74.

Variables can be used anywhere in the configuration and will be replaced by the locally defined adapter instance.

Specifying Variables Using TIBCO Designer

Global variables provide an easy way to set defaults for use throughout your project. There are several ways in which they can be used:

• Define a variable using TIBCO Designer, then override the value for individual applications at deployment time using TIBCO Administrator. You can also override values for predefined variables, unless the GUI does not allow you to make them settable later.

• Predefine a variable using TIBCO Designer, then override the value for individual services (for example, Publication service or TIBCO ActiveMatrix BusinessWorks process) at deployment time using TIBCO Administrator. The values you specify are then used at runtime. You can also override values for predefined variables, unless the GUI does not allow you to make them settable later.

For example, you can assign the value 7474 to the predefined global variable RvDaemon, then use the variable in different sessions in your adapter. If you want to change the TIBCO Rendezvous daemon for your adapter, you can globally set it to a different value or override it from the command line.

Page 91: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Using Global Variables | 73

To use global variables in your project, follow these steps:

1. Click the Global Variables panel, then click the Open Advanced Editor button . You now have these choices:

— To assign or change a variable value, select that region and triple-click the variable, then you can change either the variable name or the variable value. Click the OK button when you are done.

— To add a new global variable group, click the Add a Variable Group button at bottom of the dialog box. Specify the name of the group, then click

the OK button.

— To add a global variable, click the Add a Variable button . A new global variable item is added to the bottom of the list. Supply the variable name and, optionally, the value. Click the OK button when you are done.

The global variable is now displayed in the global variables list.

2. When you want to use the global variable in the fields of a resource, enter the variable name surrounded by %% on both sides.

When the project is deployed and the configured components are run, all occurrences of the global variable name are replaced with the global variable value unless it was overridden in a way that had higher precedence.

A number of global variables are predefined. See Predefined Global Variables on page 74 for information. You may add definitions of any variables you need to predefine.

Changing Global Variable Values at RuntimeYou can change the value of a global variable when you deploy your project in TIBCO Administrator. See the section on modifying runtime variables in TIBCO Administrator User’s Guide for more information on using TIBCO Administrator.

You can also specify values for global variables when starting a process engine on the command line. To do this, specify the following as a command line argument when starting the process engine:

-tibco.clientVar.variablePathAndName value

where variablePathAndName is the name of the variable you wish to set, including the path to the variable if it is contained in a directory. value is the value you w to set the variable to. For example, if you have a global variable named item1 contained in a directory named myGroup and you wish to set its value to 500, add the following argument to the command line when starting the process engine:

-tibco.clientVar.myGroup/item1 500

Page 92: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

74 | Chapter 6 Advanced Configuration Options

Predefined Global VariablesThe next table lists and explains the predefined global variables. Some global variables are automatically used within the system when an adapter instance is configured.

Table 14 Predefined Global Variables

Variable Description

Deployment Defaults to the TIBCO Designer project name. This global variable is used by the system to partially define the subject name defined for a service.

DirLedger Used by the system when defining the path name of the TIBCO Rendezvous certified messaging ledger file. The default is the root installation directory.

DirTrace Used by the system to partially create the path name for log file used by the adapter. The default is the root installation directory.

Domain The default value for file-based local projects is MyDomain. This value for server-based projects is the domain to which the project was saved.

HawkEnabled Indicates whether TIBCO Hawk is used to monitor the adapter. True indicates that a TIBCO Hawk microagent is defined for the adapter. False indicates the microagent is not to be used.

JmsProviderUrl Tells applications where the JMS daemon is located. Setting this value mostly makes sense in early stages of a project, when only one JMS daemon is used.

JmsSslProviderUrl Specifies where the JMS SSL daemon is located.

ReceiverInstanceId Identify the SWIFT receiver instance. The default value is Receiver.

RemoteRvDaemon Used by the system to identify the TIBCO Rendezvous routing daemon. See TIBCO Rendezvous Administration for details about specifying the routing daemon name.

RvDaemon Used by the system to identify the TIBCO Rendezvous daemon parameter. The parameter instructs the transport object about how and where to find the Rendezvous daemon and establish communication. The default value is 7500.

RvNetwork Used by the system to identify the TIBCO Rendezvous network parameter. Every network transport communicates with other transports over a single network interface. On computers with more than one network interface, the network parameter instructs the TIBCO Rendezvous daemon to use a particular network for all outbound messages from this transport.

In most cases, you can leave the default.

Page 93: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Using Global Variables | 75

RvService Used by the system to identify the TIBCO Rendezvous service parameter. The TIBCO Rendezvous daemon divides the network into logical partitions. Each transport communicates on a single service; a transport can communicate only with other transports on the same service.

Unless you are using a non-default TIBCO Rendezvous configuration, you should leave the default (7500).

RvaHost Used by the system to identify the computer on which the TIBCO Rendezvous agent (rva) runs. See TIBCO Rendezvous Administration for details about specifying the rva parameters.

RvaPort Used by the system to identify the TIBCO Rendezvous agent (rva) TCP port where the agent listens for client connection requests. See TIBCO Rendezvous Administration for details about specifying the rva parameters.

SenderInstanceId Identify the SWIFT sender instance. The default value is Sender.

TIBHawkDaemon Used by the system to identify the TIBCO Hawk daemon parameter. See TIBCO Hawk Installation and Configuration manual for details about this parameter.

TIBHawkNetwork Used by the system to identify the TIBCO Hawk network parameter. See TIBCO Hawk Installation and Configuration manual for details about this parameter.

TIBHawkService Used by the system to identify the TIBCO service parameter. See TIBCO Hawk Installation and Configuration manual for details about this parameter.

Table 14 Predefined Global Variables (Cont’d)

Variable Description

Page 94: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

76 | Chapter 6 Advanced Configuration Options

Parsing and Validating SWIFT Files Using SwiftCheck

The SwiftCheck utility allows you to parse and validate one or more SWIFT files. The utility has no dependencies on the adapter infrastructure, and can be used for low-level testing of SWIFT message files.

You can provide the options to use in the SwiftCheck.tra file, then run the utility against the file.

The utility is in the adapter bin directory.

SwiftCheck OptionsMetadata options:

-data or --dataDir file metadata directory-set or --dataSet file metadata set-fi or --fiFile file bank data file (BIC codes)-ff file or --filterFile file allows warning filter file.

See Using Validation Filters on page 58.-cu or --cuFile file currency code file-ct or --ctFile file country code file

Validation options: -v or --valAll validate using all rules-vc or --valFormat turn on character validation-vt or --valType turn on data type validation-vw or --valWord turn on code word validation-vb or --valBic turn on BIC code validation-vf or --valField turn on field level semantics validation-vm or --valMsg turn on message level semantics validation-vn or --valNarr turn on narrative validation-va or --valAdvanced turn on advanced header validation-vs or --valStructural enables structural validation.

To provide the options in the SwiftCheck.tra file, run the utility against the file:

1. Change the directory to the adapter bin directory.

cd TIB_ADSWIFT_HOME\bin

2. Copy the SwiftCheck.tra file to a new file.

3. Using a text editor to open the copied file.

4. Change the application.args property to include the metadata and validation options to use. For example:

application.args -data TIB_ADSWIFT_HOME/bin/data -set 2013 -v TIB_ADSWIFT_HOME/examples/SampleMT.txt

Page 95: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Parsing and Validating SWIFT Files Using SwiftCheck | 77

5. Save the properties file and exit the text editor.

6. Start the utility on the command line:

SwiftCheck --run --propFile mySwiftCheck.tra

Page 96: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

78 | Chapter 6 Advanced Configuration Options

Loading SWIFT Message Types into a Repository

You can use the adswiftSchemaLoader utility to load SWIFT message types into a repository.

You can run the utility on the command line by providing the arguments to use in the adswiftSchemaLoader.tra file, then run the utility against the file.

The utility is located in the adapter bin directory.

To provide the arguments in the adswiftSchemaLoader.tra file, run the utility against the file:

1. Change directory to the adapter bin directory.

cd TIB_ADSWIFT_HOME\bin

2. Copy the adswiftSchemaLoader.tra file to a new file.

3. Using a text editor to open the copied file.

4. Change the application.args property with the location of the repository, adapter home directory, SWIFT specification, load or unload (-l, -u) and message types. For example:

application.args -system:propFile TIB_ADSWIFT_HOME/bin/mySchemaLoader.tra -r TIB_ADSWIFT_HOME/examples/tester.dat -h TIB_ADSWIFT_HOME -s 2013 -l -m 517

5. Save the properties file and exit the text editor.

6. Start the utility on the command line:

adswiftSchemaLoader --run --propFile mySchemaLoader.tra

Page 97: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Sending and Validating SWIFT Messages using SwiftPublisher | 79

Sending and Validating SWIFT Messages using SwiftPublisher

You can use the SwiftPublisher utility to publish and validate a file containing one or more SWIFT messages. SwiftPublisher sends the file using a TIBCO Rendezvous subject, then moves the file into a sent directory. Applications subscribing to the subject will receive the SWIFT messages.

The subject name used depends on whether you are publishing a RAW or XML SWIFT message, the prefix you provide and the validation results. The subject is subject prefix followed by XML (if XML format) or RAW (if RAW format). That is followed by VALID if the message is valid or INVALID if it is not. Finally the message TYPE (such as 101, 102, and so on) is the last element. For example, if the subject prefix is test, the subject name would be testXML.VALID.102 for a valid XML format message of type 102.

Note that SwiftPublisher is not transactional. If you interrupt SwiftPublisher, messages may be republished when restarting.

SwiftPublisher scans the input directory and publishes files with the file extension you provide. It then moves the published files into the sent directory. It is important to place only completed files that use the specified file extension in the input directory as the files can be published at any time.

For example, you can use SwiftPublisher to redirect SWIFT messages based on message validity or type.

You can run the utility on the command line by specifying the arguments to use, or you can provide the arguments to use in the SwiftPublisher.tra file, then run the utility against the file.

The utility is located in the adapter bin directory.

Processing options

-in or --inDir dir incoming message directory -ext or --fileExt ext incoming message file extension -sent or --sentDir dir sent message directory -raw publish raw swift message -xml publish swift message as XML -scan seconds scan interval

TIBCO Rendezvous options

-subject subject prefix for subject to publish on -daemon daemon TIBRV daemon parameter -service service TIBRV service parameter -network network TIBRV network parameter

Page 98: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

80 | Chapter 6 Advanced Configuration Options

Metadata options

-data or --dataDir file metadata directory -set or --dataSet file metadata set -fi or --fiFile file bankdata file (BIC codes) -cu or --cuFile file currency code file -ct or --ctFile file country code file -ff or --filterFile file validation warning filter file

Validation options

-v or --valAll validate using all rules -vc or --valChar turn on character validation -vt or --valType turn on data type validation -vw or --valWord turn on code word validation -vb or --valBic turn on BIC code validation -vf or --valField turn on field level semantics validation -vm or --valMsg turn on message level semantics validation -vn or --valNarr turn on narrative validation -va or --valAdvanced turn on advanced header validation

Running the Utility on the Command LineFor example, using the following command line, SwiftPublisher scans the messagedir directory for files that use the .swf extension. When a file is found, it is published on the testXML.VALID.102 subject (if validation is successful), then moved to the sentdir directory.

SwiftPublisher -in c:\messagedir -ext .swf -sent c:\sentdir -xml -scan 5 -subject test -data c:\data -set 2013 -v

Running the Utility with a Properties FileTo provide the arguments in the SwiftPublisher.tra file, run the utility against the file:

1. Change directory to the adapter bin directory.

cd TIB_ADSWIFT_HOME\bin

2. Copy the SwiftPublisher.tra file to a new file.

3. Using a text editor to open the copied file.

4. Specify the properties to use in the application.args property.

5. Save the properties file and exit the text editor.

6. Start the utility on the command line:

SwiftPublisher --run --propFile mySwiftPublisher.tra

Page 99: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| 81

Chapter 7 Using the Adapter with CASmf

This chapter explains how to use the adapter with CASmf

Topics

• Overview of Operation Using CASmf, page 82

• Configuring the Adapter, page 85

• Loopback Testing on Windows Using CASmf, page 87

• Loopback Testing on Solaris and AIX Using CASmf, page 90

• CASmf Recovery Session, page 92

Page 100: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

82 | Chapter 7 Using the Adapter with CASmf

Overview of Operation Using CASmf

The following diagram shows the adapter operations using CASmf. An application uses a TIBCO transport to communicate with the adapters. One adapter is configured as a SWIFTNet - FINSender and another as a SWIFTNet - FINReceiver. The adapters communicate with the CASmf application, which is installed on the SWIFT Alliance Access (SAA) machine. The machine also has the SAA server installed, which communicates with the SWIFT network.

Figure 13 Adapter Operations Using CASmf Interface

The numbers in the diagram correspond to the numbers used in the next sections. Non shaded numbers refer to SWIFTNet - FINSender activities. Shaded numbers refer to SWIFTNet - FINReceiver activities.

The SWIFTNet - FINSender and SWIFTNet - FINReceiver instances each open one CASmf session. The session is identified by a MAPID, defined as a short string. The MAPID corresponds to a record in the DMAPID.DAT file. This record specifies the hostname and port number for the SWIFT Alliance Access along with the SWIFT Alliance Access session to which the CASmf session connects. In addition, the MAPID specifies the port number on which CASmf listens for a connection for this session.

Page 101: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Overview of Operation Using CASmf | 83

SWIFTNet - FINSender Activities

SWIFTNet - FINSender listens for messages sent by other applications in the TIBCO environment to send to the CASmf session.

1. SWIFTNet - FINSender validates and renders the AE or XML messages it receives into FIN messages.

2. SWIFTNet - FINSender transfers the FIN message to CASmf.

3. When CASmf receives the message from the adapter, it verifies the message structure again and sends an acknowledgement to the adapter. The acknowledgement indicates if the message is valid or not. If the message is valid, CASmf passes the message to SWIFT Alliance Access. SWIFT Alliance Access validates the message received from CASmf, sends an acknowledgement to CASmf, and passes the message to the SWIFT network.

SWIFTNet - FINReceiver Activities

SWIFTNet - FINReceiver loops for messages sent by other applications in the SWIFT environment.

1. When a message is sent on the SWIFT network, the SAA passes the message to CASmf. CASmf validates the message from SAA and sends an acknowledgment message to SAA.

2. SwiftReceiver loops and on each iteration of the loop checks for a new message from the CASmf session. When a new FIN message is detected, the SWIFTNet - FINReceiver gets the message, validates it, parses it into an AE or XML message, then publishes it on the TIBCO environment.

3. The message is received by all applications in the TIBCO environment that have subscribed to that subject.

Pre-configured Services Used in CASmf ModeBoth the SWIFTNet - FINSender and SWIFTNet - FINReceiver use pre-configured services. You can change values assigned to each pre-configured service by opening the project in TIBCO Designer and modifying the service. For example, you can configure each service to use the JMS transport type instead of the default Rendezvous transport type.

For details on the pre-configured services for SWIFTNet - FINSender and SWIFTNet - FINReceiver, see Pre-configured Adapter Services on page 12.

The following pre-configured services are used by SWIFTNet - FINSender and SWIFTNet - FINReceiver when CASmf is used:

• AdminPublisher

Page 102: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

84 | Chapter 7 Using the Adapter with CASmf

• MessageSubscriber

• ExitSubscriber

Page 103: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Configuring the Adapter | 85

Configuring the Adapter

Before starting, make sure that the SwiftAdapter.dll file has been built. See TIBCO ActiveMatrix Adapter for SWIFT Installation for details. After building the dll file, complete the following tasks:

• Task A Configuring SWIFTNet - FINSender to Work with CASmf, page 85

• Task B Configuring SWIFTNet - FINReceiver to Work with CASmf, page 85

• Task C Creating the Adapter Properties Files, page 86

Task A Configuring SWIFTNet - FINSender to Work with CASmf

Use the following steps to configure SWIFTNet - FINSender to work with CASmf:

1. Start TIBCO Designer and create a project.

2. Drag the SWIFTNet - FINSenderConfiguration icon from the Palettes panel to the Design panel.

3. Click the Runtime Connection tab. Select CASmf from the Dispose Type drop-down list. Type loopback in the Map ID field. Leave other fields unchanged and click the Apply button.

4. Click the Specification tab and select SWIFT November 2013 specification, if it is not selected. Scroll through the list and check the checkboxes for messages 101 and 517.

5. Save the project, then select Project > Export Full Project from the Menu to export the project.

Task B Configuring SWIFTNet - FINReceiver to Work with CASmf

Use the following steps to configure SWIFTNet - FINReceiver to work with CASmf:

1. Start TIBCO Designer and create a project.

2. Drag the SWIFTNet - FINReceiverConfiguration icon from the Palettes panel to the Design panel.

3. Click the Runtime Connection tab. Select CASmf from the Dispose Type drop-down list. Type CBTemulator in the Map ID field. Leave other fields unchanged and click the Apply button.

4. Click the Specification tab and select SWIFT November 2013 specification, if it is not selected. Scroll through the list and check the checkboxes for messages 101 and 517.

Page 104: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

86 | Chapter 7 Using the Adapter with CASmf

5. Save the project, then select Project > Export Full Project from the Menu to export the project.

Task C Creating the Adapter Properties Files

Use the following steps to create the adapter properties files:

1. Open a command window and change directory to the adapter bin directory:

cd TIB_ADSWIFT_HOME\bin

2. Copy the adswiftsender.tra file to a new text file named sender.tra.

3. Using a text editor to open the sender.tra file.

4. Set the following properties. Note that you must supply the absolute path name to the local repository created earlier.

tibco.repourl C:/tibco/projects/export/casmfsender.dat

tibco.configurl SWIFTNet-FINSenderConfiguration

application.args adswiftSender -system:propFile

TIB_ADSWIFT_HOME/bin/sender.tra

5. Save and close the sender.tra file.

6. Copy the adswiftReceiver.tra file to a new text file named receiver.tra.

7. Using a text editor to open the receiver.tra file.

8. Set the following properties. Note that you must supply the absolute path name to the local repository created earlier.

tibco.repourl C:/tibco/projects/export/casmfreceiver.dat

tibco.configurl SWIFTNet-FINReceiverConfiguration

application.args adswiftSender -system:propFile

TIB_ADSWIFT_HOME/bin/receiver.tra

9. Save and close the receiver.tra file.

Page 105: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Loopback Testing on Windows Using CASmf | 87

Loopback Testing on Windows Using CASmf

An adapter configuration called Tester is provided along with the installation to test the adapter.

The Tester reads sample SWIFT messages and loops them back through CASmf. See Figure 14. In the process, the Tester tests the parsing of SWIFT messages, conversion to and from TIBCO AE messages, and connectivity to CASmf.

Figure 14 Loopback Testing

This program demonstrates the following:

1. The Tester reads SWIFT messages from a file and publishes them.

2. SWIFTNet - FINSender receives the messages, validates them and converts them into a FIN message.

3. SWIFTNet - FINSender passes the messages to CASmf.

4. CASmf loops the messages back to SWIFTNet - FINReceiver.

5. SWIFTNet - FINReceiver converts the messages back to AE messages and publishes them.

6. The messages that are received by an application configured for the TIBCO environment.

Page 106: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

88 | Chapter 7 Using the Adapter with CASmf

Starting the Applications1. Select Start > All Programs > CASmf > CASmf. The Monitoring-CASmf

window appears.

2. Click the space shuttle icon at top of the left corner.

Figure 15 CASmf Dialog

3. Click the OK button on the dialog box. The CASmf session has been started.

Figure 16 Monitoring CASmf GUI

Page 107: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Loopback Testing on Windows Using CASmf | 89

4. Start the SWIFTNet - FINReceiver adapter configuration using the properties file you configured earlier. See Configuring the Adapter on page 85.

In a few seconds, the TIBCO Adapter SDK banner is displayed in the window. This indicates that SwiftReceiver is running.

When the SWIFTNet - FINReceiver is started, the session state in the CASmf user interface becomes SERVER for CBTemulator.

5. Start the SWIFTNet - FINSender adapter configuration using the properties file you configured earlier. See Configuring the Adapter on page 85.

In a few seconds, the TIBCO Adapter SDK banner is displayed in the window. This indicates that SwiftSender is running.

When SWIFTNet - FINSender is started, the session state in the CASmf user interface becomes OPEN for both loopback and CBTemulator.

6. Change directory to the adapter examples directory:

cd TIB_ADSWIFT_HOME\examples

7. Start tester.exe. The tester publishes SWIFT messages for the example.

In a few seconds, the TIBCO Adapter SDK banner is displayed in the window. This indicates that Tester is running. At this point, you can watch the message counts keep going up in the Monitoring - CASmf window.

8. Click the Stop button to stop CASmf.

9. Stop the adapters by sending a message on the ExitSubscriber subject for the SWIFTNet - FINSender and SWIFTNet - FINReceiver. For example:

tibrvsend domain.casmfsender.adswift.Sender.exit exittibrvsend domain.casmfreceiver.adswift.Receiver.exit exit

10. Stop the Tester.

The Tester utility sends a message on the subject %%Domain%%.%%Deployment%%.adswift.%%SenderInstanceId%%.message and the SWIFTNet - FINSender also subscribes on the same subject. However, the Deployment global variable can be different in the case of the Tester utility and the SWIFTNet - FINSender leading to a mismatch in subject name. To avoid this mismatch, override the tibco.clientVar.Deployment global variable in Tester.tra with the deployment value of your project:

tibco.clientVar.Deployment deployment value

CTRL+C must NEVER be used to shut down the adapter as it could lead to a potential loss or duplication of messages.

Page 108: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

90 | Chapter 7 Using the Adapter with CASmf

Loopback Testing on Solaris and AIX Using CASmf

This section describes how to test the adapter on Solaris and AIX. This procedure assumes the SAA is installed and configured appropriately for the SWIFT network.

Run the cus_profile under the CASMF_HOME directory to set the CASmf variables, then run the swift_profile under the version_num directory of the adapter installation.

The install_path/tibco/adapter/adswift/version_num/bin directory contains all the shell scripts needed to run the adapter.

• StartCASmf—This shell script is used to clean out the CASmf databases and start the CASmf application. The adapters connect to CASmf to send and receive SWIFT messages.

• MonitorCASmf—This shell script is used to monitor the CASmf.

• StopCASmf—This shell script is used to shutdown the CASmf.

Running the Adapter

To start the adapter:

1. Run the shell script StartCASmf.sh under install_path/tibco/adapter/adswift/version_num/bin

The following message is displayed indicating that the CASmf has successfully started:

launch custra modulelaunch cusctl modulelaunch cusshd module

launch cusnet module

2. Run the MonitorCASmf.sh shell scripts to view the CASmf monitor.

3. Open another command window and start SWIFTNet - FINReceiver. See Configuring the Adapter on page 85 for configuration information.

Before running cus_profile, check if the TOP variable in the cus_profile field is set to $CASMF_HOME.

Check the CASmf manual for commands used by the monitor system.

Page 109: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Loopback Testing on Solaris and AIX Using CASmf | 91

The TIBCO Adapter SDK banner is displayed indicating that SWIFTNet - FINReceiver is running. In the Monitoring - CASmf window, the CBTemulator Session state changes from FREE to SERVER.

4. Open another command window and start SWIFTNet - FINSender. See Configuring the Adapter on page 85 for configuration information.

5. Change directory to the adapter examples directory:

cd TIB_ADSWIFT_HOME\examples

6. Start the Tester.exe. The tester publishes SWIFT messages for the example.

In a few seconds, the TIBCO Adapter SDK banner is displayed in the window. This indicates that Tester is running. At this point, you can watch the message counts keep going up in the Monitoring-CASmf window.

7. Click the Stop button to stop CASmf.

8. Stop the adapters by sending a message on the ExitSubscriber subject for the SWIFTNet - FINSender and SWIFTNet - FINReceiver. For example:

tibrvsend domain.casmfsender.adswift.Sender.exit exittibrvsend domain.casmfreceiver.adswift.Receiver.exit exit

9. Stop the Tester.

The Tester utility sends a message on the subject %%Domain%%.%%Deployment%%.adswift.%%SenderInstanceId%%.message and the SWIFTNet-FINSender also subscribes on the same subject. However, the Deployment global variable can be different in the case of the Tester utility and the SWIFTNet-FINSender leading to a mismatch in subject name. To avoid this mismatch, override the tibco.clientVar.Deployment global variable in Tester.tra with the deployment value of your project:

tibco.clientVar.Deployment deployment value

CTRL+C must NEVER be used to shut down the adapter as it could lead to a potential loss or duplication of messages.

Page 110: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

92 | Chapter 7 Using the Adapter with CASmf

CASmf Recovery Session

If a CASmf session is not closed normally, a Recovery Session must be immediately following. A CASmf session not being closed normally results in a logical reply not being received for a particular SWIFT message. For instance, for the SwiftSender, this happens when the CASmf session closes without CASmf receiving a logical reply from the SWIFT Alliance Access for the last outgoing SWIFT message.

Similarly, for SwiftReceiver, an abnormal close of the CASmf session might result in CASmf not receiving a logical reply from SwiftReceiver for the last incoming SWIFT message. This fact is recorded by CASmf in files with an .rvy extension residing in the /dat directory of the CASmf installation. The adapter reads the appropriate .rvy file on startup to see if the last CASmf session was closed properly. If not, it initiates a recovery session. The main impact of this occurs in the SwiftSender. The SwiftSender needs to retrieve the last SWIFT message that was sent out, and resend it to the SWIFT Alliance Access.

To enable SwiftSender to retrieve the last SWIFT message that was sent out by the last CASmf session, every outgoing SWIFT message is recorded in a file in the /dat directory of the CASmf installation. This file is deleted when a logical reply is received for this message. This keeps the number of files in the /dat directory from becoming too large, while allowing formerly sent SWIFT messages to be retrieved in the absence of database logging.

Page 111: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| 93

Chapter 8 Using the Adapter with MQSA

This chapter explains how to enable TIBCO ActiveMatrix Adapter for WebSphere MQ to work synchronously with TIBCO Runtime Agent.

Topics

• Overview of Operation Using MQSA, page 94

• Configuring the Adapter to Work with MQSA, page 97

• Testing the Adapter Using MQSA, page 98

• Configuring TIBCO ActiveMatrix Adapter for WebSphere MQ to Work with MQSA, page 101

• Processing Local Reports, page 107

Page 112: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

94 | Chapter 8 Using the Adapter with MQSA

Overview of Operation Using MQSA

Figure 17 shows the adapter operations using MQSA. An application uses a TIBCO transport to communicate with the adapters. One adapter is configured as a SWIFTNet - FINSender and another as a SWIFTNet - FINReceiver. The adapters communicate with TIBCO ActiveMatrix Adapter for WebSphere MQ, which sends its messages to the WebSphere MQ application, then WebSphere MQ sends its messages to the MQSA interface. The machine also has the SAA server installed, which communicates with the SWIFT network.

Figure 17 Adapter Operations Using MQSA Interface

The numbers in the figure correspond to the numbers used in the next sections. Non shaded numbers refer to SWIFTNet - FINSender activities. Shaded numbers refer to SWIFTNet - FINReceiver activities.

SWIFTNet - FINSender Activities

SWIFTNet - FINSender listens for messages sent by other applications in the TIBCO environment to send to TIBCO ActiveMatrix Adapter for WebSphere MQ.

1. SWIFTNet - FINSender validates and renders the AE or XML messages it receives into FIN messages. The FIN messages are sent using a TIBCO transport.

Page 113: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Overview of Operation Using MQSA | 95

2. TIBCO ActiveMatrix Adapter for WebSphere MQ receives the FIN messages published by SWIFTNet - FINSender and sends them to the SWIFT network routed through the WebSphere MQ and MQSA.

3. SAA validates the message received from MQSA, sends an acknowledgement to MQSA, and passes the message to the SWIFT network. The message is received at the destination connected on the SWIFT network.

SWIFTNet - FINReceiver Activities

SWIFTNet - FINReceiver listens for FIN messages sent by TIBCO ActiveMatrix Adapter for WebSphere MQ.

1. When message is sent from the SWIFT network, it is sent to TIBCO ActiveMatrix Adapter for WebSphere MQ through the MQSA interface, and the WebSphere MQ publishes the message.

2. SWIFTNet - FINReceiver listens for messages published by TIBCO ActiveMatrix Adapter for WebSphere MQ. When SWIFTNet - FINReceiver gets a message, it validates and parses it into an AE or XML message, then publishes it on the TIBCO environment.

3. The message is received by all applications in the TIBCO environment that have subscribed to that subject.

Pre-configured Services Used in MQSA ModeBoth the SWIFTNet - FINSender and SWIFTNet - FINReceiver use pre-configured services. You can change values assigned to each pre-configured service by opening the project in TIBCO Designer and modifying the service. For example, you can configure each service by using the JMS transport type instead of the default Rendezvous transport type.

For details on the pre-configured services for SWIFTNet - FINSender and SWIFTNet - FINReceiver, see Pre-configured Adapter Services on page 12.

The following pre-configured services are used by SWIFTNet - FINSender when MQSA is used:

• AdminPublisher

• MessageSubscriber

• ExitSubscriber

• TIBPublisher

• DeliveryNotificationSubscriber

• LocalReportSubscriber

Page 114: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

96 | Chapter 8 Using the Adapter with MQSA

• TransmissionNotificationSubscriber

The following pre-configured services are used by SWIFTNet - FINReceiver when MQSA is used:

• AdminPublisher

• MessagePublisher

• ExitSubscriber

Page 115: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Configuring the Adapter to Work with MQSA | 97

Configuring the Adapter to Work with MQSA

Before starting, make sure the following additional components are installed to enable TIBCO Runtime Agent to work in MQSA mode. See the readme file for more details of the supported versions and required patches.

• TIBCO ActiveMatrix Adapter for WebSphere MQ

• IBM WebSphere MQSeries

• MQSeries Interface in SAA Server (MQSA)

After installation, log in to SAA to verify that the Queues configured are enabled. Also in IBM WebSphere MQseries, verify that QueueManager is running.

Use the following steps to configure SWIFTNet - FINSender and SWIFTNet - FINReceiver to work with MQSA:

1. Start TIBCO Designer and create a project.

2. Drag the SWIFTNet - FINSenderConfiguration icon from the Palettes panel to the Design panel. Click the Runtime Connection tab, and select MQSA from the Dispose Type drop-down list. Enter the following information in the respective field:

mqsaReplyToQueueManager—Enter the name of the MQSeries queue manager for the queue where the local reports and outbound messages are placed.

mqsaReplyToQueue—Enter the name of the MQSeries queue where the local reports are placed.

mqsaReport—The adapter supports only the Positive Action Notification (PAN) and Negative Action Notification (NAN) reports from MQSA and therefore this value must be 3.

3. Leave other fields unchanged and click the Apply button.

4. Drag the SWIFTNet - FINReceiverConfiguration icon from the Palettes panel to the Design panel. Click the Runtime Connection tab, and select MQSA from the Dispose Type drop-down list.

5. Leave all fields unchanged, and click the Apply button. Select Project > Save from the Menu.

6. Click the Specification tab and select SWIFT November 2013 specification, if it is not selected. Scroll through the list and check the required messages checkboxes.

7. Select Project > Save from the Menu. Select Project > Export Full Project from the Menu to export the project.

Page 116: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

98 | Chapter 8 Using the Adapter with MQSA

Testing the Adapter Using MQSA

Complete the following steps to test SWIFTNet - FINReceiver with the MQSA interface:

1. Use TIBCO Designer to configure SWIFTNet - FINReceiver. See Configuring the Adapter to Work with MQSA on page 97.

2. Deploy the SWIFTNet - FINReceiver adapter configuration by copying the default adswiftReceiver.tra properties file to a new file and setting the following properties.

tibco.repourl absolute path name to local repository

tibco.configurl SWIFTNet-FINReceiverConfiguration

application.args adswiftReceiver -system:propFile absolute path name to local repository

3. Start the SWIFTNet - FINReceiver adapter using the properties file you defined.

adswiftReceiver --run --propFile absolute path name to local repository

4. Use TIBCO Designer to configure TIBCO ActiveMatrix Adapter for WebSphere MQ.

5. Deploy the TIBCO ActiveMatrix Adapter for WebSphere MQ configuration by copying the default admqs.tra properties file to a new file and setting the following properties.

tibco.repourl absolute path name to local repository

tibco.configurl configuration name

application.args admqs -system:propFile absolute path name to local repository

6. Start the TIBCO ActiveMatrix Adapter for WebSphere MQ configuration using the properties file you defined.

admqs --run --propFile absolute path name to local repository

7. Use MQSA to publish a message using the MQSA_Message class. The message node contains the message received from the SWIFT network.

8. The SWIFTNet - FINReceiver configuration subscribes to the message parses it and publishes the message under the appropriate message class.

9. Go to a command prompt and listen for the following pre-configured subject name:

tibrvlisten swift.receiver.application.message

Page 117: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Testing the Adapter Using MQSA | 99

Messages received from the SWIFT Network will be published after processing.

The SWIFTNet - FINReceiver configuration has been tested successfully.

Complete the following steps to test the SWIFTNet - FINSender with the MQSA interface:

1. Use TIBCO Designer to configure SWIFTNet - FINSender. See Configuring the Adapter to Work with MQSA on page 97.

2. Deploy the SWIFTNet - FINSender adapter configuration by copying the default adSWIFTSender.tra properties file to a new file and setting the following properties.

tibco.repourl absolute path name to local repository

tibco.configurl SWIFTNet-FINSenderConfiguration

application.args adswiftSender -system:propFile absolute path name to local repository

3. Start the SWIFTNet - FINSender adapter using the properties file you defined.

adswiftSender --run --propFile absolute path name to local repository

4. Use TIBCO Designer to configure TIBCO ActiveMatrix Adapter for WebSphere MQ.

5. Deploy the TIBCO ActiveMatrix Adapter for WebSphere MQ configuration by copying the default admqs.tra properties file to a new file and setting the following properties.

tibco.repourl absolute path name to local repository

tibco.configurl configuration name

application.args admqs -system:propFile absolute path name to local repository

6. Start the TIBCO ActiveMatrix Adapter for WebSphere MQ configuration using the properties file you defined.

admqs --run --propFile absolute path name to local repository

7. The Subscription service listens for messages published by TIBCO ActiveEnterprise applications, targeted at the SWIFT network.

8. Change directory to the adapter examples directory:

cd TIB_ADSWIFT_HOME\examples

Page 118: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

100 | Chapter 8 Using the Adapter with MQSA

9. Start tester.exe. The tester publishes SWIFT messages for the example.

10. SWIFTNet - FINSender unparses the AE message and publishes it using MQSA_Message class.

11. Go to a command prompt and listen for the message using the following pre-configured subject name:

tibrvlisten swift.sender.application.message

Messages published from the SWIFT Network will be published after processing.

The SWIFTNet - FINSender configuration has been tested successfully.

The Tester utility sends a message on the subject %%Domain%%.%%Deployment%%.adswift.%%SenderInstanceId%%.message and the SWIFTNet-FINSender also subscribes on the same subject. However, the Deployment global variable can be different in the case of the Tester utility and the SWIFTNet-FINSender leading to a mismatch in subject name. To avoid this mismatch, override the tibco.clientVar.Deployment global variable in Tester.tra with the deployment value of your project:

tibco.clientVar.Deployment deployment value

Page 119: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Configuring TIBCO ActiveMatrix Adapter for WebSphere MQ to Work with MQSA | 101

Configuring TIBCO ActiveMatrix Adapter for WebSphere MQ to

Work with MQSA

Before TIBCO ActiveMatrix Adapter for WebSphere MQ can be started, the services listed in this section need to be added to a project.

Note that the example project, admqsSample.dat, located in install_path\tibco\adapter\adswift\version_num\examples has the services defined.

To add the services:

1. Open the project you created in the previous section.

2. Drag the MQSeriesAdapterConfiguration icon from the Palettes panel to the Design panel.

3. Click the Runtime Connection tab. Enter the following information in the respective field:

Queue Manager—Specify the name of the MQSeries queue manager.

Error Queue—Specify the name for the Error Queue that will be used to write errors generated by the adapter.

4. Expand the MQSeriesAdapterConfiguration directory and select the Adapter Services directory. Drag one Subscription Service and three Publication Services to the design panel.

The next sections describe the services and fields that must be set for each service. After creating the services, complete the following steps:

5. Select Project > Save from the Menu. Then select Project > Export Full Project from the Menu to export the project. Then exit the Designer.

Subscription ServiceThe Subscription service receives SWIFT messages from SWIFTNet - FINSender‘s TIBPublisher service and puts these messages in a Queue called ORDERQ.

Configuration Tab

Name—SubscriptionService

MQ Queue Name—ORDERQ

MQ Error Queue Name—Specify the error queue name that you have configured.

Page 120: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

102 | Chapter 8 Using the Adapter with MQSA

Transport Type—Rendezvous

Wire Format—ActiveEnterprise Message

Quality of Service—Certified

Class Reference—/AESchemas/ae/MQSeries/Classes/ExtendedTIBMsg

Conversion Tab

Conversion Type—None

Conversion Argument—MQSeriesMessage

Adapter Encoding—ASCII

Queue Options Tab

Set IDs in Hexadecimal Format—Select this check box.

Message Type—MQMT_DATAGRAM

Message Format—MQFMT_STRING

Persistence—MQPER_PERSISTENCE_AS_Q_DEF

Context—MQPMO_DEFAULT_CONTEXT

Priority—-1

Expiry—-1

Coded Character Set ID—0

Advanced Tab

Subject name—TIBPublisher.sender.message

Session Reference — /MQSeriesAdapterConfiguration/Advanced/Sessions/DefaultRVSession

Publication ServicesThis section describes how to configure the following publication services:

• PublicationService

• AcknowEndpoint

The subject name in this field must be the same as the subject name of the SWIFTNet - FINSender’s TIBPublisher service.

Page 121: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Configuring TIBCO ActiveMatrix Adapter for WebSphere MQ to Work with MQSA | 103

• LocalReportEndpoint

PublicationService

The Publication service is configured to read the SWIFT messages from a Queue called PRODUCTQ. These messages are then published on a specific subject name that the SWIFTNet - FINReceiver’s TIBSubscriber would be listening on.

Configuration Tab

Name—PublicationService

MQ Queue Name—PRODUCTQ

MQ Error Queue Name—Specify the error queue name that you have configured.

Polling Interval in msecs—100

Transport Type—Rendezvous

Wire Format—ActiveEnterprise Message

Quality of Service—Certified

Class Reference — /AESchemas/ae/SWIFTAdapter/SWIFTLibrary/Classes/MQSAMessage

Conversion Tab

Conversion Type—none

Conversion Argument—Message

Convert to TIB Encoding—check this checkbox

Are there numeric values in EBCDIC?—check this checkbox

Adapter Encoding—ASCII

Queue Options Tab

Queue Access—MQOO_INPUT_AS_Q_SHARED

After Retrieving a Message—Remove it from the queue

Coded Character Set ID—0

Page 122: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

104 | Chapter 8 Using the Adapter with MQSA

Advanced Tab

Subject name—TIBSubscriber.receiver.message

Session Reference — /MQSeriesAdapterConfiguration/Advanced/Sessions/DefaultRVSession

AcknowEndpoint

The Publication service is configured to read all the acknowledgement messages from the ACKQ Queue and publish on a specific subject, which the SWIFTNet - FINSender’s TransmissionNotificationSubscriber would be listening on.

Configuration Tab

Name—AcknowEndpoint

MQ Queue Name—ACKQ

MQ Error Queue Name—Specify the error queue name that you have configured.

Polling Interval in msecs—100

Transport Type—Rendezvous

Wire Format—ActiveEnterprise Message

Quality of Service—Certified

Class Reference—/AESchemas/ae/MQSeries/Classes/ExtendedTIBMsg

Conversion Tab

Conversion Type—MQMD to ExtendedTIBMsg

ID Format—MQ_ID_STRING_ASCII_FORMAT

Convert to TIB Encoding—check this checkbox

Are there numeric values in EBCDIC?—check this checkbox

Adapter Encoding—ASCII

Queue Options Tab

Queue Access—MQOO_INPUT_AS_Q_SHARED

After Retrieving a Message—Remove it from the queue

The subject name in this field must the same as the subject name of the SWIFTNet - FINReceiver’s TIBSubscriber service.

Page 123: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Configuring TIBCO ActiveMatrix Adapter for WebSphere MQ to Work with MQSA | 105

Coded Character Set ID—0

Advanced Tab

Subject name—Transmission.Message

Session Reference — /MQSeriesAdapterConfiguration/Advanced/Sessions/DefaultRVSession

LocalReportEndpoint

The Publication service is configured to read all the local report messages from the LocalReportQ Queue and publish on a specific subject, which the SWIFTNet - FINSender’s LocalReportSubscriber would be listening on.

Configuration Tab

Name—LocalReportEndpoint

MQ Queue Name—LocalReportQ

MQ Error Queue Name—Specify the error queue name that you have configured.

Polling Interval in msecs—100

Transport Type—Rendezvous

Wire Format—ActiveEnterprise Message

Quality of Service—Certified

Class Reference—/AESchemas/ae/MQSeries/Classes/ExtendedTIBMsg

Conversion Tab

Conversion Type—MQMD to ExtendedTIBMsg

ID Format—MQ_ID_STRING_ASCII_FORMAT

Are there numeric values in EBCDIC?—check the checkbox

Adapter Encoding—ASCII

Queue Options Tab

Queue Access—MQOO_INPUT_AS_Q_SHARED

The subject name in this field must the same as the subject name of the SWIFTNet - FINSender’s TransmissionNotificationSubscriber service.

Page 124: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

106 | Chapter 8 Using the Adapter with MQSA

After Retrieving a Message—Remove it from the queue

Use MQGMO_CONVERT—check the checkbox

Coded Character Set ID—0

Advanced Tab

Subject name—Local.Message

Session Reference — /MQSeriesAdapterConfiguration/Advanced/Sessions/DefaultRVSession

The subject name in this field must the same as the subject name of the SWIFTNet - FINSender’s LocalReportSubscriber service.

Page 125: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Processing Local Reports | 107

Processing Local Reports

The local report messages inform an application about expected or unexpected events related to the original message. The report type field allows to specify which report messages are required. The adapter supports processing of Positive Action Notification (PAN) and Negative Action Notification (NAN) reports. However to process other types of local reports, use TIBCO ActiveMatrix BusinessWorks.

Processing PAN and NAN Reports

A PAN report indicates that the message has been successfully stored in SAA.

A NAN report indicates that the message could not be stored in SSAA or it failed validation.

To receive a PAN or NAN report:

1. Set the value of the Report Type field to 3 (MQRO_PAN 1 + MQRO_NAN 2).

The field is in the adapter sender component configuration that is configured to publish a FIN message in the MQSA mode.

2. Set the ReplyToQueueManage and ReplyToQueue attributes to receive the PAN or NAN report.

3. Configure the MQ Publisher to receive on this local report queue and publish the message on ExtendedTIBMsg Schema on the subject on which LocalReportSubscriber of Sender instance is configured. The adapter publishes the PAN or NAN report on LocalReportSchema on AdminPublisher.

Page 126: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

108 | Chapter 8 Using the Adapter with MQSA

Processing Other Local Reports

To receive a report other than PAN or NAN report.

Perform OR operation on the corresponding report constants and enter the resulting value in the Report Type field of the adapter sender instance. For example, if you want to generate the PAN, NAN, COD, and COA reports, do the bitwise OR operation on the corresponding hexadecimal values or do the ADD operation of the corresponding integer values. For example, 1+2+768+6144 = 6915. Enter the value in the Report Type field. Also enter the values for ReplyToQueueManager and ReplyToQueue attributes.

Configure the MQ Publisher on the local report queue specified earlier to send the report.

Table 15 Report of Performing OR operation

Constant Integer Hexadecimal

MQRO_EXCEPTION 16777216 X'01000000'

MQRO_EXCEPTION_WITH_DATA 50331648 X'03000000'

MQRO_EXCEPTION_WITH_FULL_DATA 117440512 X'07000000'

MQRO_EXPIRATION 2097152 X'00200000'

MQRO_EXPIRATION_WITH_DATA 6291456 X'00600000'

MQRO_EXPIRATION_WITH_FULL_DATA 14680064 X'00E00000'

MQRO_COA 256 X'00000100'

MQRO_COA_WITH_DATA 768 X'00000300'

MQRO_COA_WITH_FULL_DATA 1792 X'00000700'

MQRO_COD 2048 X'00000800'

MQRO_COD_WITH_DATA 6144 X'00001800'

MQRO_COD_WITH_FULL_DATA 14336 X'00003800'

MQRO_PAN 1 X'00000001'

MQRO_NAN 2 X'00000002'

Page 127: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Processing Local Reports | 109

You also need to configure the AdapterSubscriber activity of TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN with ExtendedTIBMsg schema to listen to the message sent by MQ Publisher. The schema contains the Feedback field, which contains the status of the report.

The following are the MQ Series Feedback constants for your quick reference. For details of the values of the Feedback field, see TIBCO ActiveMatrix Adapter for Websphere MQ user documentation.

Table 16 Report of MQ Series Feedback (Sheet 1 of 3)

Constant Integer Hexadecimal

MQFB_NONE 0 X'00000000'

MQFB_SYSTEM_FIRST 1 X'00000001'

MQFB_QUIT 256 X'00000100'

MQFB_EXPIRATION 258 X'00000102'

MQFB_COA 259 X'00000103'

MQFB_COD 260 X'00000104'

MQFB_CHANNEL_COMPLETED 262 X'00000106'

MQFB_CHANNEL_FAIL_RETRY 263 X'00000107'

MQFB_CHANNEL_FAIL 264 X'00000108'

MQFB_APPL_CANNOT_BE_STARTED 265 X'00000109'

MQFB_TM_ERROR 266 X'0000010A'

MQFB_APPL_TYPE_ERROR 267 X'0000010B'

MQFB_STOPPED_BY_MSG_EXIT 268 X'0000010C'

MQFB_ACTIVITY 269 X'0000010D'

MQFB_XMIT_Q_MSG_ERROR 271 X'0000010F'

MQFB_PAN 275 X'00000113'

MQFB_NAN 276 X'00000114'

MQFB_STOPPED_BY_CHAD_EXIT 277 X'00000115'

MQFB_STOPPED_BY_PUBSUB_EXIT 279 X'00000117'

Page 128: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

110 | Chapter 8 Using the Adapter with MQSA

MQFB_NOT_A_REPOSITORY_MSG 280 X'00000118'

MQFB_BIND_OPEN_CLUSRCVR_DEL 281 X'00000119'

MQFB_MAX_ACTIVITIES 282 X'0000011A'

MQFB_NOT_FORWARDED 283 X'0000011B'

MQFB_NOT_DELIVERED 284 X'0000011C'

MQFB_UNSUPPORTED_FORWARDING 285 X'0000011D'

MQFB_UNSUPPORTED_DELIVERY 286 X'0000011E'

MQFB_DATA_LENGTH_ZERO 291 X'00000123'

MQFB_DATA_LENGTH_NEGATIVE 292 X'00000124'

MQFB_DATA_LENGTH_TOO_BIG 293 X'00000125'

MQFB_BUFFER_OVERFLOW 294 X'00000126'

MQFB_LENGTH_OFF_BY_ONE 295 X'00000127'

MQFB_IIH_ERROR 296 X'00000128'

MQFB_NOT_AUTHORIZED_FOR_IMS 298 X'0000012A'

MQFB_IMS_ERROR 300 X'0000012C'

MQFB_IMS_FIRST 301 X'0000012D'

MQFB_IMS_LAST 399 X'0000018F'

MQFB_CICS_INTERNAL_ERROR 401 X'00000191'

MQFB_CICS_NOT_AUTHORIZED 402 X'00000192'

MQFB_CICS_BRIDGE_FAILURE 403 X'00000193'

MQFB_CICS_CORREL_ID_ERROR 404 X'00000194'

MQFB_CICS_CCSID_ERROR 405 X'00000195'

MQFB_CICS_ENCODING_ERROR 406 X'00000196'

MQFB_CICS_CIH_ERROR 407 X'00000197'

Table 16 Report of MQ Series Feedback (Sheet 2 of 3)

Constant Integer Hexadecimal

Page 129: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Processing Local Reports | 111

MQFB_CICS_UOW_ERROR 408 X'00000198'

MQFB_CICS_COMMAREA_ERROR 409 X'00000199'

MQFB_CICS_APPL_NOT_STARTED 410 X'0000019A'

MQFB_CICS_APPL_ABENDED 411 X'0000019B'

MQFB_CICS_DLQ_ERROR 412 X'0000019C'

MQFB_CICS_UOW_BACKED_OUT 413 X'0000019D'

MQFB_SYSTEM_LAST 65535 X'0000FFFF'

MQFB_APPL_FIRST 65536 X'00010000'

MQFB_APPL_LAST 999999999 X'3B9AC9FF'

The WebSphere MQ Constants provided in this document are only indicative. For accurate values, see WebSphere MQ user documentation.

Table 16 Report of MQ Series Feedback (Sheet 3 of 3)

Constant Integer Hexadecimal

Page 130: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

112 | Chapter 8 Using the Adapter with MQSA

Page 131: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| 113

Chapter 9 Using the Adapter with FTP

This chapter explains how to use the adapter with FTP.

Topics

• Overview of Operation Using FTP, page 114

• Configuring the Adapter, page 116

• Starting and Stopping the Adapter and the Tester, page 121

Page 132: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

114 | Chapter 9 Using the Adapter with FTP

Overview of Operation Using FTP

Figure 18 shows the adapter operations using FTP interface. An application uses a TIBCO transport to communicate with the adapters. One adapter is configured as a SWIFTNet - FINSender and another as a SWIFTNet - FINReceiver. The adapters communicate with the FTP server installed on the SAA machine. The machine also has the SAA server installed, which communicates with the SWIFT network.

Figure 18 Adapter Operations Using FTP Interface

The numbers in the above figure correspond to the numbers used in the next sections. Non-shaded numbers refer to SWIFTNet - FINSender activities. Shaded numbers refer to SWIFTNet - FINReceiver activities.

SWIFTNet - FINSender Activities

SWIFTNet - FINSender listens for messages sent by other applications in the TIBCO environment.

1. The user application sends an AE or XML message to SWIFTNet - FINSender.

2. SWIFTNet - FINSender validates and renders the message into a FIN message.

Page 133: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Overview of Operation Using FTP | 115

3. Using FTP, SWIFTNet - FINSender transfers the FIN message to the remote directory on the FTP server. In case of any error, the message is transferred to an error directory on the FTP server.

4. The SAA picks up the message from the remote directory on the FTP server, validates the message, sends an acknowledgement to the adapter, and passes the message to the SWIFT network.

SWIFTNet - FINReceiver Activities

SWIFTNet-FINReceiver polls for messages sent by other applications in the SWIFT environment.

1. When a message is sent on the SWIFT network, the SAA places the message in the remote directory on the FTP server.

2. SWIFTNet - FINReceiver logs in to the FTP server and constantly polls the FTP server’s remote directory.

3. When a new FIN message file is detected, the SWIFTNet - FINReceiver gets the message, validates it and parses it into an AE or XML message. After publishing the message, it is moved from the remote directory to the backup directory on the FTP server.

4. The message is received by all applications in the TIBCO environment that have subscribed to that subject.

Pre-configured Services Used in FTP Mode

Both the SWIFTNet - FINSender and SWIFTNet - FINReceiver use pre-configured services. You can change values assigned to each pre-configured service by opening the project in TIBCO Designer and modifying the service. For example, you can configure each service to use the JMS transport instead of the default Rendezvous transport.

For details on the pre-configured services for SWIFTNet - FINSender and SWIFTNet - FINReceiver, see Pre-configured Adapter Services on page 12.

The following pre-configured services are used by SWIFTNet - FINSender and SWIFTNet - FINReceiver when FTP is used:

• AdminPublisher

• MessageSubscriber

• ExitSubscriber

Page 134: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

116 | Chapter 9 Using the Adapter with FTP

Configuring the Adapter

Before starting, make sure that all required software has been installed and is operating correctly.

Configuring the SWIFTNet - FINSender to Work with FTP

Use the following steps to configure the SWIFTNet - FINSender to work with FTP:

1. Start TIBCO Designer and create a project.

2. Drag the SWIFTNet - FINSenderConfiguration icon from the Palettes panel to the Design panel.

3. Click the Runtime Connection tab. Select FTP from the Dispose Type drop-down list. Enter the following information in the respective fields:

User—Username for the account used to access the FTP server

Password—Password for above account

Host—FTP server hostname

Port—FTP server port

Remote File Prefix—FTPSender

Remote Directory—FTP server virtual directory for SWIFT messages

Remote Error Directory—FTP server virtual directory for SWIFT error messages

Persist File Prefix—PersistOut

4. Leave other fields unchanged and click the Test Connection button to verify that the parameters you entered are correct for your setup. Click the Apply button.

Page 135: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Configuring the Adapter | 117

Figure 19 Configuring the SWIFTNet - FINSender with FTP.

5. Click the Specification tab and select SWIFT November 2013 specification, if it is not selected. Select the SWIFT message that the tester utility is configured to use. In this exercise, check the checkboxes for message 101 and 517.

Figure 20 Selecting the SWIFT message in the Specification Tab

Page 136: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

118 | Chapter 9 Using the Adapter with FTP

6. Select Project > Save from the Menu. Then select Project > Export Full Project from the Menu to export the project.

7. In the Project Name field, type gstart. In the Dir Name, type c:\tibco\projects\export. Click the OK button, the Overwrite dialog appears.

Figure 21 Export the Project

8. Click the Yes button, then select Project > Exit from the Menu.

Configuring the SWIFTNet - FINReceiver to Work with FTP

Use the following steps to configure the SWIFTNet - FINReceiver to work with FTP:

1. Start TIBCO Designer and create a project.

2. Drag the SWIFTNet - FINReceiverConfiguration icon from the Palettes panel to the Design panel.

3. Click the Runtime Connection tab. Select FTP from the Dispose Type drop-down list. Enter the following information in the respective fields:

User—Username for the account used to access the FTP server

Password—Password for the above account

Host—FTP server hostname

Port—FTP server port

File Extension—.txt

Page 137: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Configuring the Adapter | 119

Remote Directory—FTP server virtual directory for SWIFT messages

Remote BackUp Directory—FTP server virtual directory for the SWIFT messages after they are published

Persist File Prefix—PersistOut

4. Leave other fields unchanged and click the Test Connection button to verify that the parameters you entered are correct for your setup. Click the Apply button.

Figure 22 Configuring the SWIFTNet - FINReceiver with FTP

5. Click the Specification tab and select SWIFT November 2013 specification, if it is not selected. Scroll through the message list and check the checkboxes for messages 101 and 517.

6. Select Project > Save from the Menu. Then select Project > Export Full Project from the Menu to export the project. The exit the Designer.

Creating the Adapter Properties Files

Using the following steps to create the adapter properties files:

1. Open a command window and change directory to the adapter bin directory:

cd TIB_ADSWIFT_HOME\bin

2. Copy adswiftsender.tra to a new text file named sub.tra.

copy adswiftsender.tra sub.tra

Page 138: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

120 | Chapter 9 Using the Adapter with FTP

3. Open the sub.tra file by using a text editor.

write sub.tra

4. Set the following properties. Note that you must supply the absolute path name to the local repository created earlier.

tibco.repourl C:/tibco/projects/export/gsftp.dat

tibco.configurl SWIFTNet-FINSenderConfiguration

application.args adswiftSender -system:propFile

TIB_ADSWIFT_HOME/bin/sub.tra

5. Save and close the sub.tra file, then copy the file to a new text file named pub.tra.

copy sub.tra pub.tra

6. Open the pub.tra file by using a text editor.

write pub.tra

7. Change the following properties:

tibco.configurl SWIFTNet-FINReceiverConfiguration

application.args adswiftReceiver -system:propFile

TIB_ADSWIFT_HOME/bin/pub.tra

8. Save and close the pub.tra file.

Page 139: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Starting and Stopping the Adapter and the Tester | 121

Starting and Stopping the Adapter and the Tester

To start and stop the adapter and the tester, complete the following steps:

1. Open three command windows.

2. In the first command window, start the SWIFTNet - aFINSender from the adapter bin directory:

adswiftSender --run --propFile sub.tra

3. In the second command window, change directory to the adapter examples directory:

cd TIB_ADSWIFT_HOME\examples

4. Start tester.exe. The tester publishes SWIFT messages for the example.

5. Check the FTP server remote directory that was specified for the SWIFTNet - FINSenderConfiguration. It now contains the FTPSender_<datetime>.txt and FTPReceiver_datetime.txt messages.

6. In the third command window, start the SWIFTNet - FINReceiver from the adapter bin directory:

adswiftReceiver --run --propFile pub.tra

7. Check the FTP server for the SWIFT messages. The FTPSender_datetime.txt and FTPReceiver_datetime.txt messages are copied to the messageBackup directory.

8. To stop the adapter, in a command window, send a message on the ExitSubscriber subject for the SWIFTNet - FINSender and SWIFTNet - FINReceiver.

The Tester utility sends a message on the subject %%Domain%%.%%Deployment%%.adswift.%%SenderInstanceId%%.message and the SWIFTNet - FINSender also subscribes on the same subject. However, the Deployment global variable can be different in the case of the Tester utility and the SWIFTNet - FINSender leading to a mismatch in the subject name. To avoid this mismatch, override the tibco.clientVar.Deployment global variable in the Tester.tra file with the deployment value of your project: tibco.clientVar.Deployment <deployment value>

CTRL+C must NEVER be used to shut down the adapter as it could lead to a potential loss or duplication of messages.

Page 140: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

122 | Chapter 9 Using the Adapter with FTP

For example:

tibrvsend domain.gsftp.adswift.Sender.exit exit

tibrvsend domain.gsftp.adswift.Receiver.exit exit

9. Exit the Tester.

Page 141: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| 123

Chapter 10 Using TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN

This chapter describes the features of the TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN.

Topics

• Overview of TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN, page 124

• Installation of TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN, page 125

• SWIFTNet - FIN Schema Loader, page 126

• SWIFTNet - FIN Router, page 127

• SWIFTNet - FIN Parser, page 129

• SWIFTNet - FIN Renderer, page 131

• BICPlusIBAN Generator, page 133

• BICPlusIBAN Validator, page 138

• Limitations and Recommendations, page 143

Page 142: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

124 | Chapter 10 Using TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN

Overview of TIBCO ActiveMatrix BusinessWorks Plug-in for

SWIFTNet - FIN

TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN enables you to parse, validate, and render FIN messages using TIBCO ActiveMatrix BusinessWorks. It also allows you to route FIN messages to different activities based on the message type.

Some advantages of the plug-in are:

• Allows you parse or render FIN messages without having to interact with a live SWIFT network. The plug-in would be useful for customers, such as Custodian brokers and dealers using the SWIFT FIN format internally.

• Gives you more control as to how you dispose and transfer messages to the SWIFT network.

• Avoids having to run a standalone adapter.

The plug-in includes the following:

• SWIFTNet - FIN Schema Loader—The loader allows you to select a SWIFT specification from a list and then load or unload the message type schemas for the selected SWIFT specification.

• SWIFTNet - FIN Router—The router allows you to route FIN messages to different activities based on the message type.

• SWIFTNet - FIN Parser—The parser allows you to parse an incoming FIN message to an XML format.

• SWIFTNet - FIN Renderer—The renderer allows you to render an incoming FIN message from the XML format to a FIN message format.

• BICPlusIBAN Generator—The generator allows you generate the IBAN.

• BICPlusIBAN Validator—The Validator allows you validate the IBAN.

Before you parse or render the FIN message, you must load the corresponding message type schema using the SWIFT Schema Loader.

Page 143: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Installation of TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN | 125

Installation of TIBCO ActiveMatrix BusinessWorks Plug-in for

SWIFTNet - FIN

The installer adds the SWIFTNet - FIN palette to TIBCO BusinessWorks during Typical installation of the adapter. See TIBCO ActiveMatrix Adapter for SWIFT Installation for more information.

Page 144: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

126 | Chapter 10 Using TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN

SWIFTNet - FIN Schema Loader

The SWIFTNet - FIN Schema Loader allows you to select a SWIFT specification from a list and then load or unload the message type schemas for the selected SWIFT specification. The schemas loaded using the schema loader are used by SWIFTNet - FIN Parser and SWIFTNet - FIN Router.

Configuration TabThe Configuration tab has the following fields:

The schema loader is not a TIBCO ActiveMatrix BusinessWorks activity and, hence, is disabled when you are configuring a process in TIBCO ActiveMatrix BusinessWorks. It is enabled only when you are adding a resource to the project. For example, when you are at the root (/) level.

Table 17 SWIFTNet - FIN Schema Loader Configuration Tab

Field Description

Specification Allows you to select a specification from a list of supported SWIFT specifications.

Note: Changing from one specification to another unloads all existing SWIFT-related schemas. Hence, we recommend that you do not change from one SWIFT specification to another. However, if you need to change the SWIFT specification using the SWIFTNet - FIN Schema Loader, delete the existing SWIFT activity instances and configure them again.

Message Types Contains a list of all the message types supported by the selected SWIFT specification. Check the checkbox next to the message type to load the schema in TIBCO Designer. Uncheck the checkbox to unload a schema.

To load or unload multiple message type schemas in one operation:

1. Select a message, then hold the Shift key, scroll and select other message types.

2. Click the Load Selected button to load all highlighted message types. Similarly, click the Unload Selected button to unload highlighted message types.

Page 145: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

SWIFTNet - FIN Router | 127

SWIFTNet - FIN Router

The SWIFTNet - FIN Router allows you to route messages to different activities based on the message type. The input to the router can be a single FIN message or multiple $-delimited FIN messages received from any upstream activity in a TIBCO ActiveMatrix BusinessWorks process. The output of the router is an array of the message types and the FIN messages. Any downstream

activities in the process can be configured depending on the message type output by the router.

Configuration Tab

The Configuration tab has the following fields.

Input Tab

The Input tab for the router is the following.

The SWIFTNet - FIN Router is a TIBCO ActiveMatrix BusinessWorks activity and is enabled only after you select a process.

Table 18 SWIFTNet - FIN Router Configuration Tab

Field Description

Name Specifies the default name of the SWIFT Router.

Description Specifies a short description of the SWIFT Router.

SWIFT Specification

Displays the SWIFT specification for which the SWIFT Router is configured.

Select All Validations

Allows you to select all the types of validations listed in the Configuration tab.

Validation Types Supported

For more information on the different types of validations that can be performed, refer to General Tab on page 38.

Table 19 SWIFTNet - FIN Router Input Tab

Input Item Datatype Description

FINMessage String Single or multiple $-delimited FIN messages in the FIN message format.

Page 146: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

128 | Chapter 10 Using TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN

Output Tab

The Output tab for the router is an array of the following.

Error Output Tab

The Error Output tab lists the possible exceptions that can be thrown by this activity.

Table 20 SWIFTNet - FIN Router Output Tab

Output Item Datatype Description

MessageType String Message type of the input FIN message.

FINMessage String This message is the same as the input FIN message.

Table 21 SWIFTNet - FIN Router Error Output Tab

Exception Thrown When...

ValidationException The FIN message has validation errors when the validation is against the selected SWIFT specification.

SwiftException The router breaks if it cannot locate the metadata directory or fails to initialize the metadata.

Page 147: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

SWIFTNet - FIN Parser | 129

SWIFTNet - FIN Parser

The SWIFTNet - FIN Parser allows you to parse an incoming FIN message to an XML format. The input to the parser is a FIN message in the FIN message format and the output is a FIN message in the XML format.

Configuration Tab

The Configuration tab has the following fields.

• The SWIFTNet - FIN Parser is a TIBCO ActiveMatrix BusinessWorks activity and is only enabled after you select a process.

• Before configuring the parser, load the appropriate message type schema using the SWIFTNet - FIN Schema Loader.

Table 22 SWIFTNet - FIN Parser Configuration Tab

Field Description

Name Specifies the default name of the parser.

Description Specifies a short description of the parser.

SWIFT Specification

Displays the SWIFT specification for which the parser is configured.

SWIFT Message Schema

Select the SWIFT message type schema for which you want to configure the parser.

Select All Validations

Allows you to select all the different types of validations.

Validation types supported

For more information on the different types of validations that can be performed, refer to General Tab on page 38.

Page 148: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

130 | Chapter 10 Using TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN

Input Tab

The Input tab for the SWIFT Parser is the following.

Output Tab

The Output tab for the parser is the following.

Error Output Tab

The Error Output tab lists the possible exceptions that can be thrown by this activity.

Table 23 SWIFTNet - FIN Parser Input Tab

Input Item Datatype Description

FINMessage String FIN message in the string format.

Table 24 SWIFTNet - FIN Parser Output Tab

Output Item Datatype Description

SWIFTMessage XML XML representation of the input FIN message.

The XML schema structure corresponding to the message type selected is displayed in the Output tab only after you click the Apply button and save the project. After you run the process, the XML structure is populated with the contents of the input FIN message.

Table 25 SWIFTNet - FIN Parser Error Output Tab

Exception Thrown When...

ValidationException The FIN message has validation errors when the validation is against the selected SWIFT specification.

SwiftException The parser breaks if it cannot locate the metadata directory or fails to initialize the metadata.

Page 149: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

SWIFTNet - FIN Renderer | 131

SWIFTNet - FIN Renderer

The SWIFTNet - FIN Renderer allows you render an incoming FIN message from the XML format to the FIN message format. The input to the renderer is a FIN message in the XML format and the output is a FIN message in the FIN message format.

Configuration Tab

The Configuration tab has the following fields.

• The SWIFTNet - FIN Renderer is a TIBCO ActiveMatrix BusinessWorks activity and is enabled only after you select a process.

• Before configuring the renderer, load the appropriate message type schema using the SWIFTNet - FIN Schema Loader.

Table 26 SWIFTNet - FIN Renderer Configuration Tab

Field Description

Name Specifies the default name of the renderer.

Description Specifies a short description of the renderer.

SWIFT Specification

Displays the SWIFT specification for which the renderer is configured.

SWIFT Message Schema

Select the SWIFT message schema for which you want to configure the renderer.

Select All Validations

Allows you to select all the different types of validations.

Validation types supported

For more information on the different types of validations that can be performed, refer to General Tab on page 38.

Page 150: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

132 | Chapter 10 Using TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN

Input Tab

The Input tab for the renderer is the following.

Output Tab

The Output tab for the renderer is the following.

Error Output Tab

The Error Output tab lists the possible exceptions that can be thrown by this activity.

Table 27 SWIFTNet - FIN Renderer Input Tab

Input Item Datatype Description

SWIFTMessage XML XML representation of the input FIN message.

The XML schema structure corresponding to the message type selected is displayed in the Input tab only after you click the Apply button and save the project.

Table 28 SWIFTNet - FIN Renderer Output Tab

Output Item Datatype Description

FINMessage String FIN message in String format.

Table 29 SWIFTNet - FIN Renderer Error Output Tab

Exception Thrown When...

ValidationException The FIN message has validation errors when the validation is against the selected SWIFT specification.

SwiftException The renderer breaks if it cannot locate the metadata directory or fails to initialize the metadata.

Page 151: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

BICPlusIBAN Generator | 133

BICPlusIBAN Generator

The SWIFTNet BICPlusIBAN Generator allows you generate the IBAN. The inputs to the generator are country code and BBAN, and the output is the IBAN.

From Table 30, you can get the following information:

• The country code - 2 characters, for example, GR stands for Greece.

• The check digits - 2 characters, system generated.

• The BBAN (Basic Bank Account Number) consists of the IBAN national ID and account number. The IBAN national ID itself includes a bank identifier and a branch identifier. Based on the international standards, the length of the bank identifier and the branch identifier are different with different countries.

— Bank identifier - a standardized and unique code that is used to identify a specific bank. For example, the length of the bank identifier for Greece is 3-character, which is 060 in the Table 30.

— Branch identifier - part of the branch prediction system that gives and address to indicate if there is a branch at that address, and possibly what type of branch (conditional, call, return, indirect, and so on.) it is. For example, the length of the branch identifier for Greece is 4-character, which is 1095 in the Table 30.

— Account number - the rest part of the numbers in Table 30 is the account number.

• IBAN (International Bank Account Number) is an international standard for identifying bank accounts across national borders with a minimal risk of propagating transcription errors. IBAN imposes a flexible but regular format sufficient for account identification, and contains validation information to avoid errors of transcription.

• The SWIFTNet BICPlusIBAN Generator is a TIBCO ActiveMatrix BusinessWorks activity and is enabled only after you select a process.

Table 30 Components of the IBAN

Country Code Check Digits BBAN (Basic Bank Account Number)

IBAN National ID Account Number

GR 45 0601095 0000000000627399

Page 152: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

134 | Chapter 10 Using TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN

Generating the IBANBefore processing the BICPlusIBAN Generation activity, you need to set the heap size to 1024 M in case the memory outbound error occurs.

Assume that you are required to generate the IBAN for Germany, then you must complete the following tasks:

• Task A File Download, page 134

• Task B Configuring the BICPlusIBAN Generator, page 134

• Task C Generating the IBAN, page 136

Task A File Download

The BICPlusIBAN files are available as download packages. You can download BICPlusIBAN:

• From www.swift.com/SWIFTRef, over the Internet.

• From the SWIFTNet Portal, over SWIFTNet (using Browse, and Alliance WebStation or Starter Set): for more information about SWIFTNet Portal, see the SWIFTNet Portal User Guide, available on www.swift.com > Support > Documentation.

• SWIFT now supports the automated download of BICPlusIBAN files from www.swift.com. BICPlusIBAN files are also distributed over FileAct.

Task B Configuring the BICPlusIBAN Generator

Before generating the IBAN, go through the following steps to configure the BICPlusIBAN generator:

1. Start TIBCO Designer, and click the New Empty Project button. The Save Project dialog appears.

2. Click the Browse button in the Save Project dialog. Create a directory to store the project: C:\tibco\projects\IBANGeneration. Then click the OK button, the project files will be saved in the IBANGeneration directory.

After downloading the BICPlusIBAN directory, make sure there are 4 data files inside:

— BI file (BICPlusIBAN information), required.

— IS file (IBAN structure information), required.

— CT file (ISO country information), required.

— CU file (ISO currency code information), optional.

Page 153: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

BICPlusIBAN Generator | 135

3. Drag the Process icon from the Palettes panel to the Design panel, then double-click the Process icon in the Design panel.

4. Drag the SWIFTNet BICPlusIBAN Generator icon from the Palettes panel to the Design panel. In the Configuration tab, browse to the directory where the BICPlusIBAN files is saved and select it.

5. Click the Input tab, expend the SWIFTBICPlusIBANGeneratorInput item in the Activity Input panel, then enter the values in the CountryCode and the BBAN fields. See Figure 23.

6. Click the Apply button. Select Project > Save from the Menu.

When you specify the BICPlusIBAN directory, pay attention to the following:

— BICPlusIBAN directory is a mandatory field with an appropriate value.

— The BICPlusIBAN directory you provide must have the written permission.

— Within one project, the value of the BICPlusIBAN directory in BICPlusIBAN generator must be consistent with the one in BICPlusIBAN validator.

— When you are working with two different projects and setting the same value for the BICPlusIBAN directory. You must finish processing the first project, then start to process the second project.

— You can also use the Global Variable to set the BICPlusIBAN directory.

Page 154: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

136 | Chapter 10 Using TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN

Figure 23 Input of the SWIFTNet BICPlusIBAN Generator

Task C Generating the IBAN

1. In the Design panel, make the transition connection for the SWIFTNet BICPlusIBAN Generator, then click the Tester panel, and click the Start Testing Viewed Process button.

2. In the Process Selection dialog that appears, the process checkbox is checked by default. Click the Load Selected button. When the process executes, you will find the black arrows that point to each activity have turned to green.

Page 155: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

BICPlusIBAN Generator | 137

3. Click the Stop Testing icon to return to design mode. Then click the SWIFTNet BICPlusIBAN Generator icon, and click the Output tab, the generated IBAN is displayed in the IBAN filed. See Figure 24.

Figure 24 Output of the SWIFTNet BICPlusIBAN Generator

During the process of the IBAN generation, two steps are operated at the backstage:

• Validate BBAN.

• Generate Check Digit-the check digit enables the sending bank (or its customer) to perform a sanity check of the routing destination and account number from a single string of data at the time of data entry. It is guaranteed to detect any instances where a single character has been omitted, duplicated, mistyped, or where two characters have been transposed. Thus routing and account number errors are virtually eliminated.

Page 156: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

138 | Chapter 10 Using TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN

BICPlusIBAN Validator

The SWIFTNet BICPlusIBAN Validator allows you validate the IBAN. The inputs to the validate are IBAN, BIC, and Branch Code, and the output is the whole record of the information about the financial institutions and their IBAN-related data.

The Scenarios of BICPlusIBAN Validation• Worldwide Related

— Translate IBAN into BIC

This validation method is used to create messages to any country that has a registered ISO IBAN structure, and enables users to automatically derive the beneficiary’s BIC from the IBAN. This can be useful in situations where the IBAN is present but the BIC of the beneficiary is missing or incorrect.

— Lookup the bank’s participation in the Real Time Gross Settlement (RTGS) systems

This validation method is used to validate whether the bank participates in the RTGS systems or not. If yes, then BICPlusIBAN will validate the transactions are settled as soon as they are processed with one to one basis without bunching with any other transaction.

— Lookup for the bank’s details

This validation method is used to validate the bank details (name, address, and so on).

• SEPA (Single Euro Payments Area) Related

— Derive the BIC from the IBAN

This validation method is used to derive the BIC from the IBAN. This can be useful in situations where the IBAN is present but the BIC is missing in a SPEPA payment instruction. The method takes no arguments, and will return an array list of BIC code and BRANCH code.

— Validate IBANs and BICs

Validate IBANs - this validation method is used to validate that the Bank ID contained in an IBAN is a valid Bank ID. This can be useful in situations where the ordering customer has constructed the IBAN. However, the

Page 157: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

BICPlusIBAN Validator | 139

validation does not guarantee that the IBAN itself is valid. The method takes no arguments, and will return a boolean result.

Validate BICs - this validation method is used to validate that the BIC is a valid BIC. This can be useful in situations when the ordering customer attempted to derive the BIC itself from financial institution’s name and address. The method takes no arguments, and will return a boolean result.

— Validate IBAN-BIC combinations in payments

This validation method is used to validate that the BIC and the IBAN belong to one and the same institution. The method takes no arguments, and will return a boolean result.

BICPlusIBAN ValidationBefore processing the BICPlusIBAN Validation activity, you need to set the heap size to 1024 M in case the memory outbound error occurs.

To process the BICPlusIBAN validation, complete the following tasks:

• Task A Configuring the BICPlusIBAN Validator, page 139

• Task B BICPlusIBAN Validation, page 141

Task A Configuring the BICPlusIBAN Validator

Before the BICPlusIBAN validation, go through the following steps to configure the BICPlusIBAN validator:

1. Start TIBCO Designer, and click the New Empty Project button. The Save Project dialog appears.

2. Click the Browse button in the Save Project dialog. Create a directory to store the project: C:\tibco\projects\BICPlusIBANValidator. Then click the OK button, the project files will be saved in the BICPlusIBANGenerator directory.

3. Drag the Process icon from the Palettes panel to the Design panel, then double-click the Process icon in the Design panel.

4. Drag the SWIFTNet BICPlusIBAN Validator icon from the Palettes panel to the Design panel. In the Configuration tab, browse to the directory where the BICPlusIBAN files is saved and select it. See Figure 25.

Note: see the note in Task B Configuring the BICPlusIBAN Generator in BICPlusIBAN Generator section.

Page 158: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

140 | Chapter 10 Using TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN

Figure 25 Configuration of the SWIFTNet BICPlusIBAN Validator

5. Click the Input tab, expend the SWIFTBICPlusIBANValidatorInput item in the Activity Input panel, then enter the values in the IBAN filed (for example, ’DE70750903004510002321’). See Figure 26..

6. Click the Apply button. Select Project > Save from the Menu.

IBAN field is a mandatory field, and the BIC and BrachCode fields are optional.

Page 159: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

BICPlusIBAN Validator | 141

Figure 26 Input of the SWIFTNet BICPlusIBAN Validator

Task B BICPlusIBAN Validation

1. In the Design panel, make the transition connection for the SWIFTNet BICPlusIBAN Validator, then click the Tester panel, and click the Start Testing Viewed Process button.

2. In the Process Selection dialog that appears, the process checkbox is checked by default. Click the Load Selected button. When the process executes, you will find the black arrows that point to each activity have turned to green.

3. Click the Stop Testing icon to return to the Design mode. Then click the SWIFTNet BICPlusIBAN Validator icon, and click the Output tab, the whole record of the information about the financial institutions and their IBAN-related data is displayed. See Figure 27.

Page 160: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

142 | Chapter 10 Using TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN

Figure 27 Output of the SWIFTNet BICPlusIBAN Validator

During the BICPlusIBAN validation, the following items are validated:

• Country code

• Check digits

• IBAN length

• IBAN format

• IBAN National ID

• BIC

• IBAN/BIC Combination

Page 161: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Limitations and Recommendations | 143

Limitations and Recommendations

• Two schema loaders are currently available - one is in the TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN and another is in the SWIFT Adapter palette. It is recommended that you use only one schema loader to load the message schema in TIBCO Designer.

• Changing from one specification to another unloads all existing SWIFT-related schemas. Hence, we recommend that you do not change from one SWIFT specification to another. However, if you need to change the SWIFT specification using the SWIFT Schema Loader, delete the existing SWIFT activity instances and configure them again.

• For message types containing more than one Qualifier Groups, the order in which the Qualifier Groups appear in the output FIN message after rendering can be different from that of the input FIN message. This is not an error. The Qualifier Groups can appear in any order according to the SWIFT specification.

Page 162: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

144 | Chapter 10 Using TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN

Page 163: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| 145

Chapter 11 Processing Acknowledgment Messages

The chapter provides information on how to process ACK and NAK messages.

Topics

• Overview of Acknowledgment Messages, page 146

• Processing Acknowledgment Messages, page 147

• Reconciling Acknowledgment Messages, page 148

Page 164: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

146 | Chapter 11 Processing Acknowledgment Messages

Overview of Acknowledgment Messages

The acknowledgement is sent by the FIN service to the Logical Terminal to confirm receipt of a message and its safe storage by the service.

If an ACK is returned, the message is accepted by the FIN service for delivery to its destination. If a NAK is returned, the message, though safe stored, is not accepted for delivery. The structure of an ACK or a NAK message is the same, except that value of tag 451 in the text block of Acknowledgement message, 0 indicates the ACK and 1 indicates the NAK.

Page 165: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Processing Acknowledgment Messages | 147

Processing Acknowledgment Messages

FIN acknowledgement messages are parsed using Message_FIN_Acknowledgment schema. The schema loads automatically when you drag and drop the adapter configuration or the Schema Loader resource of the SWIFT palette to the design panel in TIBCO Designer.

Using the AdapterThe adapter receiver instance receives the acknowledgment message and publishes it to the TIBCO bus. The configuration of the receiver instance to receive the acknowledgment message is exactly the same as its configuration to receive a FIN message. See Chapter 7, Chapter 8, and Chapter 9 for configuration in CASmf, MQSA, and FTP modes, respectively. After receiving the message, the receiver parses and validates this message and publishes it on the MessagePublisher service on the Message_FIN_Acknowledgment schema.

Processing ACK and NAK Messages Using TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN

The TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN activities supports parsing and rendering of the ACK and NAK messages. To use the parser or renderer for processing the acknowledgment messages, configure the SWIFT Message Schema field of these activities to point to the Message_FIN_Acknowledgment schema.

Page 166: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

148 | Chapter 11 Processing Acknowledgment Messages

Reconciling Acknowledgment Messages

The acknowledgment message from the SWIFT network contains the field 108. The field carries Message User Reference (MUR) information of the original message. This information can be one of the following:

• MUR is present in the user header of the original message.

• If no MUR is present in the original message, contents of Field 20 of the original message or (for Category 5 messages only) the contents of Field 20C, with the code word SEME, but only when all alphabets are upper case.

• Contents of Field 20C.

For reconciling, you need the reference information of the FIN message sent and value of the tag 108 of the acknowledgment message received. Compare both information. If they match, the reconciliation is a success.

Page 167: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| 149

Chapter 12 Using the Adapter with a Database

The adapter can be configured to log messages to a database. This chapter explains how to set up the adapter for use with a database and describes the tables used by the adapter.

Topics

• Overview of Acknowledgment Messages, page 146

• Configuring the Adapter for Use with a Database, page 151

• SWIFT Messages Table, page 153

• Logical Reply Table, page 154

• DeliveryReports Table, page 156

• Transmission Reports Table, page 158

• LocalReports Table, page 160

Page 168: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

150 | Chapter 12 Using the Adapter with a Database

Overview of Using the Adapter with a Database

The adapter supports logging of messages that are sent and received from CASmf, FTP, or MQSA mode into database tables. Logging to a database is optional. The adapter creates the required database tables during initialization.

A database is used with the adapter for the following reasons:

• Auditing—Most financial institutions need financial messages to be logged to a database to provide an audit trail. The database specified by you in the adapter configuration. It is not used for duplicating the detection or recovery from a crash.

• Message tracking—The database is also used to track the current status of a SWIFT message that you have sent. All logical replies, delivery reports, and transmission reports for the message are logged to the database. This enables you to obtain the current status of every outgoing SWIFT message.

The following table shows each mode and the database tables used by the SWIFTNet - FINSender and SWIFTNet - FINReceiver.

The names of the tables are obtained by appending different suffixes to the value of Database Log Prefix field that is specified when configuring the adapter.

Table 31 Modes and Database Used by SWIFTNet - FINSender and SWIFTNet - FINReceiver

Mode SWIFTNet - FINSender SWIFTNet - FINReceiver

CASmf • SWIFT Messages Table

• Logical Reply Table

• DeliveryReports Table

• Transmission Reports Table

• SWIFT Messages Table

FTP • SWIFT Messages Table • SWIFT Messages Table

• Logical Reply Table

• DeliveryReports Table

MQSA • SWIFT Messages Table

• Logical Reply Table

• DeliveryReports Table

• Transmission Reports Table

• LocalReports Table

• SWIFT Messages Table

Page 169: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Configuring the Adapter for Use with a Database | 151

Configuring the Adapter for Use with a Database

To log adapter messages to a database, you must:

• Set the database logging parameters.

• Specify the JDBC URL.

• Modify the adapter’s property file with the location of the supplied JDBC drivers. Merant's DataDirect JDBC drivers are included in the TIBCO Runtime Agent installation.

Setting Database Logging Parameters and Specifying the JDBC URL

To set database logging parameters:

1. Using TIBCO Designer, open a project.

2. Drag the SWIFTNet - FINReceiverConfiguration or SWIFTNet - FINSenderConfiguration icon from the Palette panel to the Design panel.

3. In the Configuration tab, specify a value for the Database Log Prefix field. The value is prefixed to the table names created in the database.

4. If required, check the Database Failure Fatal checkbox. When it is enabled, the adapter stops if an error occurs while writing into the database. Otherwise, the adapter continues even though an error occurs while writing to the database.

5. Click the Apply button, then select Project > Save from the Menu.

To specify the JDBC URL:

1. In the Project panel, expand the SWIFTNet - FINReceiverConfiguration or SWIFTNet - FINSenderConfiguration icon, then expand the Advanced > Sessions directory and select JDBCMessageSession. The following screen displays:

The Oracle "thin" JDBC driver is not supported since it cannot handle BLOB data. You can use the provided Merant drivers or use the Oracle OCI-based JDBC driver.

Page 170: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

152 | Chapter 12 Using the Adapter with a Database

Figure 28 JDBC MessageSession Configuration Screen

2. Specify the following options in the Configuration tab:

Driver Class—tibcosoftwareinc.jdbc.oracle.OracleDriver

JDBC URL—jdbc:tibcosoftwareinc:oracle://localhost: 1521;SID=DB

User—A valid user account to access the database.

Password—The password to the user account.

3. Click the Apply button, then select Project > Save from the Menu.

Modifying the Adapter’s Property File

To add the JDBC driver location to the adapter’s property file:

1. Using a text editor to open the adapter’s property file.

2. Add the following to the tibco.env.CUSTOM_CP_EXT property:

install_path/tibco/tpcl/version_num/jdbc

3. Save and exit the text editor.

Page 171: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

SWIFT Messages Table | 153

SWIFT Messages Table

This table is used to log all incoming or outgoing SWIFT user messages. The name of this table is obtained by appending ’_SWIFT’ to the value of SwiftLogPrefix.

For CASmf, the session and sequence number are the CASmf session and sequence number.

For FTP and MQSA, the session and sequence number are the adapter session and sequence number.

Table 32 SWIFT Message Table Structure

Column Name Function Type

Time Contains the time when the message is logged to the database.

Date

SessionNumber Session number of the current session. Int

SequenceNumber Sequence number of the current message. Int

Reference Reference for the current message. Varchar(48)

Message The current message. Long

Page 172: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

154 | Chapter 12 Using the Adapter with a Database

Logical Reply Table

This table is used to log all incoming and outgoing logical replies. The name of this table is obtained by appending ’_LOGICAL’ to the value of SwiftLogPrefix.

The Logical Reply is an acknowledgement (ACK or NAK) of a new SWIFT message from the SwiftSender to the TIBCO AE application. The SwiftSender adapter instance sends a Logical Reply for every SWIFT message it receives from the TIBCO AE application.

• If the adapter detects a validation error, it does not send the SWIFT message to CASmf. Instead, it replies with a Logical Reply indicating NAK to the TIBCO AE application. The NAK includes the reasons the message failed validation.

• If the message is declared valid by the adapter, it is converted to a SWIFT message string and sent to CASmf. CASmf then replies with a Logical Reply that contains an acknowledgement (ACK or NAK) for the message. This reply is passed back to the TIBCO AE application.

In either case, the Logical Reply is logged to the database before being published to the TIBCO AE application.

In the case of FTP Interface, the SWIFTNet - FINReceiver receives any Logical Replies from SWIFT and this Logical Reply is logged into the database.

The LogicalReplies Table structure is shown below.

Table 33 LogicalReplies Table Structure

Column Name Function Type

Time Contains the time when the logical reply was logged to the database.

Date

Sess Session number of the current session. Int

Seq Sequence number of the current message. Int

Reference Reference for the message being acknowledged (ACK or NAK). Varchar(48)

RejectRea If not accepted (NAK), gives the reason. For CASmf, the values are listed in the Logical Reply Schema:

• 0 indicates no errors detected.

• 1 indicates validation errors were detected.

For FTP, the value is always –1.

Int

Page 173: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Logical Reply Table | 155

To distinguish between the adapter's ACKs/NAKs and those coming from the SWIFT network, use the following information.

• For an ACK from the adapter:

— Dispos is set to -1

— RejectRea is set to -1

— RejectTex is NULL

• For a NAK from the adapter:

— Dispos is set to -1

— RejectRea is set to 101

— RejectTex is the validation warning or any other exception message that caused the failure.

RejectTex If not accepted, gives an explanatory message. For FTP, the RejectText will be an alphanumeric reject code, which is obtained as part of the message. For the error description of the reject code, please refer to FIN Error Codes.

Varchar(26)

Success Number indicating whether the message had validation errors or not.

• 1 - No errors (ACK)

• 0 - Validation errors detected (NAK)

Int

Dispos For CASmf, it indicates the disposition of the message in the computer-based terminal.For FTP, the value is -1.

Int

Table 33 LogicalReplies Table Structure (Cont’d)

Column Name Function (Cont’d) Type

Page 174: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

156 | Chapter 12 Using the Adapter with a Database

DeliveryReports Table

This table is used to log all incoming delivery reports. The name of this table is obtained by appending ’_DELREPORT’ to the value of SwiftLogPrefix.

Delivery reports are responses from the SWIFT network to prior sends of SWIFT messages. There can be a number of delivery reports in response to a single SWIFT message sent by the TIBCO AE application. The delivery report informs the SWIFTNet - FINSender (CASmf and MQSA Interfaces only) of events, such as timeout of a message delivery to the destination, successful delivery of the message to the target, an acknowledgement (ACK or NAK) from the recipient of the message, and so on.

For FTP, the delivery report informs the SWIFTNet - FINReceiver about the events such as timeout of a message delivery to the destination, successful delivery of the message to the target, an acknowledgement (ACK or NAK) from the recipient of the message, and so on.

The DeliveryReports table structure is shown below.

DeliveryReport Status Value Table

The DeliveryReport Status Value table structure is shown below.

Table 34 DeliveryReports Table Structure

Column Name Function Type

Time The time the delivery report is logged to the database. Date

Sess Current session number. Int

Seq Sequence number of the current message. Int

Ref Reference for the current message. Varchar(48)

DelSta Delivery status of the message that is being reported.

Possible values for CASmf are listed in the DeliveryReport schema.

For MQSA, the possible values are listed in the DeliveryReport Status Value table.

Int

Table 35 DeliberyReport Status Value Table Structure

Column Name Description

275 Indicates successful delivery

Page 175: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

DeliveryReports Table | 157

276 Indicates a non-delivery warning

65549 Indicates message is aborted

-1 Indicates status is not available

Table 35 DeliberyReport Status Value Table Structure (Cont’d)

Column Name Description

Page 176: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

158 | Chapter 12 Using the Adapter with a Database

Transmission Reports Table

This table logs all incoming transmission reports. The name of this table is obtained by appending ’_TRANSREPORT’ to the value of SwiftLogPrefix.

Transmission reports provide the status of a SWIFT message in the SWIFT network (during transmission). Remember that the SWIFT network is a store and forward network. The transmission reports provide information on whether the network acknowledged (ACK or NAK) the message. The network checks all messages to see if they pass all the validation rules specified in the SWIFT User Handbook.

The TransmissionReports table structure is shown below.

TransmissionReport Status Value Table

The TransmissionReport Status Value table structure is shown below.

Table 36 TransmissionReports Table Structure

Column Name Function Type

Time The time the delivery report is logged to the database. Date

Sess Current session number. Int

Seq Sequence number for the current message. Int

Ref Reference for the current message. Varchar(48)

DelSta Delivery status of the message that is being reported.Possible values for CASmf are listed in the TransmissionReport schema.For MQSA, the possible values are listed in the TransmissionReport Status Value table.

Int

Table 37 TransmissionReport Status Value Table Structure

DeliveryStatus Value Description

275 A positive SWIFT acknowledgement

276 A negative SWIFT acknowledgement

65546 SWIFT Alliance is still waiting for SWIFT acknowledgement

65547 Message timed out

65548 Message is rejected

Page 177: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Transmission Reports Table | 159

65549 Message is aborted

-1 Status is not available

Table 37 TransmissionReport Status Value Table Structure (Cont’d)

DeliveryStatus Value Description (Cont’d)

Page 178: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

160 | Chapter 12 Using the Adapter with a Database

LocalReports Table

This table logs all incoming local reports received from MQSA to MQSA Interface. The name of this table is obtained by appending _LOCALREPORT to the value of SwiftLogPrefix.

The local reports table provide information on whether the SWIFT message from the SWIFTNet - FINSender to MQSA Interface through MQSeries is acknowledged (ACK or NAK).

The LocalReports Table structure is shown below.

LocalReport Status Value Table

The LocalReport Status Value table structure is shown below.

Table 38 LocalReports Table Structure

Column Name Function Type

Time The time the delivery report is logged to the database. Date

Sess Current session number. Int

Seq Sequence number for the current message. Int

Ref Reference for the current message. Varchar(48)

DelSta The possible values are listed in the LocalReport Status Value table. Int

Table 39 LocalReport Status Value Table Structure

DeliveryStatus Value Description

275 Indicates a positive action notification.

65537 Indicates that the message fails validation.

65538 Indicates the message is stored in SWIFT Alliance but not routed or moved.

65539 Indicates the message is not added into SWIFT Alliance.

65540 Indicates the message is not converted into SWIFT Alliance Format.

-1 Indicates the status is not available.

Page 179: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| 161

Chapter 13 Monitoring the Adapter Using TIBCO Hawk

This chapter explains how to use TIBCO Hawk microagents to monitor and manage the adapter.

Topics

• Overview of Using TIBCO Hawk to Monitor the Adapter, page 162

• Starting TIBCO Hawk Software, page 163

• The Auto-Discovery Process, page 164

• Invoking Microagent Methods, page 165

• Available Microagents, page 168

Page 180: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

162 | Chapter 13 Monitoring the Adapter Using TIBCO Hawk

Overview of Using TIBCO Hawk to Monitor the Adapter

TIBCO Hawk is a sophisticated tool for enterprise-wide monitoring and managing of all distributed applications and systems. System administrators can use it to monitor adapters in a wide area network of any size. TIBCO Hawk can be configured to monitor system and adapter parameters and to take actions when predefined conditions occur. These actions include: sending alarms that are graphically displayed in the TIBCO Hawk display, sending e-mail, paging, running a executable, or modifying the behavior of a managed adapter.

Unlike other monitoring applications, TIBCO Hawk relies on a purely distributed intelligent agent architecture using Publication or Subscription to distribute alerts. TIBCO Hawk uses TIBCO Rendezvous for all messaging and thus gains the benefits and scalability from the TIBCO Rendezvous features of Publication or Subscription, subject name addressing, interest-based routing, and reliable multicast.

TIBCO Hawk is a purely event-based system that uses alerts. The agents are configured with rules that instruct them on everything from what and how to monitor to what actions to take when problems are discovered. Thus the workload is fully distributed throughout the enterprise. Every agent is autonomous in that it does not depend on other components to perform its functions.

The TIBCO Hawk Enterprise Monitor consists of these components:

• Display—GUI front end that displays alarms and provides editors to create rule bases, create tests, view messages, and invoke microagents to request information or initiate an action.

• Agents—Intelligent processes that perform monitoring and take actions as defined in rules.

• Rulebases—Rules that are loaded by agents to determine agent behavior.

• Application Management Interface (AMI)—Manages network applications via TIBCO Rendezvous and supports communication between a network application and monitoring TIBCO Hawk agents, including the ability to examine application variables, invoke methods, and monitor system performance.

• Microagents—Feed information back to TIBCO Hawk and expose action methods to rulebases.

For more information, see the TIBCO Hawk documentation.

Page 181: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Starting TIBCO Hawk Software | 163

Starting TIBCO Hawk Software

The TIBCO Hawk agent can be configured to start automatically during the system boot cycle. See TIBCO Hawk Installation and Configuration for information about starting TIBCO Hawk.

The TIBCO Hawk Administrator’s Guide explains how to start the TIBCO Hawk Display.

Page 182: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

164 | Chapter 13 Monitoring the Adapter Using TIBCO Hawk

The Auto-Discovery Process

After you start an instance of TIBCO Hawk Display, it continue to search for machines running TIBCO Hawk Agents on your network. Container icons are created for each agent, and arranged hierarchically in clusters. By default, agent icons are clustered according to subnets.

At first, the Agents container is empty. Its counter displays a value of zero and, on the right, the Discovered counter is also at zero. Both icons are initially green in color to show that no alerts or warning messages are in effect. As agents are discovered, the counters increment to reflect the current number of discovered agents:

Figure 29 TIBCO Hawk Enterprise Monitor

Monitored network nodes are arranged in a hierarchical tree of containers. Click a container in the left panel displays nested items on the right.

Icon colors change to reflect the highest level of alert found on discovered agents. For explanations of icon elements and characteristics, see TIBCO Hawk Administrator’s Guide.

Page 183: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Invoking Microagent Methods | 165

Invoking Microagent Methods

A set of default microagents is loaded when a TIBCO Hawk Agent is started. When you install and start the adapter, its microagents are dynamically added to the local agent.

The following steps describe how to invoke a microagent method:

1. Start TIBCO Hawk Display, then right-click the agent icon and select Get Microagents.

If TIBCO Hawk security is implemented on your system and you do not have access to microagents on this agent, an error dialog displays. Select another agent, or contact your system administrator to obtain access.

The Microagents, Methods and Arguments dialog displays. The panel on the upper left lists microagents you can access on the current agent.

This dialog has two modes, Invoke and Subscribe. Invoking a method immediately returns a single set of current results. Subscribing provides updates of current results at regular intervals. Radio buttons at the bottom of the dialog control these modes.

2. Click a microagent name, such as Self, to display a list of associated methods and text descriptions in the panels below.

3. Click the name of the method to invoke, such as getComponentInfo.

If the method accepts arguments, fields for each argument display in the upper right panel. Detailed help text displays in the lower panel.

Page 184: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

166 | Chapter 13 Monitoring the Adapter Using TIBCO Hawk

Figure 30 Microagents, Methods and Arguments Dialog

4. Specify any arguments for the method invocation.

5. Verify that the Invoke radio button is selected.

6. Click the Invoke button to invoke the selected method.

The Invocation Results dialog displays the results returned by the method.

Figure 31 Invocation Results Dialog

Page 185: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Invoking Microagent Methods | 167

7. Click the Done button to close the dialog.

These steps describe how to interactively invoke a microagent method and receive a single set of results in TIBCO Hawk Display. You can also use a microagent method as the data source of a TIBCO Hawk rule. Rules automatically receive method results, apply tests to evaluate them, then take action if necessary. For more information on building TIBCO Hawk rules and rule bases, see your TIBCO Hawk Administrator’s Guide.

Page 186: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

168 | Chapter 13 Monitoring the Adapter Using TIBCO Hawk

Available Microagents

Each adapter has three microagents, a standard TIBCO Hawk microagent named COM.TIBCO.ADAPTER.xyz where xyz is the adapter configuration name, a custom microagent and a class microagent. The microagents provide:

• Business level statistics—statistics that report the progress of the adapter as it interacts with the vendor application. For example, in a database adapter such statistics might indicate whether objects were successfully or unsuccessfully inserted, updated, or deleted in the database.

• Queries that return information about the state of the adapter. This can be an important tool for seeing the internals of an adapter and debugging it if something appears wrong. For example, methods can return information about threads, internal queues, or connections to the target system. Using these methods, one might be able to identify certain bottlenecks or gauge how successfully an adapter is scaling with respect to the current environment.

• Updates of the adapter runtime parameters. This includes retrieving the current runtime parameters and setting new runtime parameters without restarting the adapter. An example of this is getting and setting the polling interval. Updating a runtime parameter through the Hawk microagent only affects the setting of the instance that is running. It does not make a permanent change of the setting in either the repository or the .tra file.

By default, all microagents are available at runtime.

perfMon property value set in the adapter’s property file affects the business statistics related methods. If this property is set to on, the adapter does all the performance related calculations. When you invoke the methods, if the perfMon property is set to off, default values are displayed and not the valid values.

You can disallow adding custom methods to the class microagent when deploying the adapter by changing the addCustomHawkMethodstoClassMAgent property value in the adapter’s property file. If this property is set to on, custom methods are added to the class microagents. If set to off, these methods are not visible.

The following table lists each method available for the adapter and page on which the method is explained.

Custom microagents are deprecated in this release. All business statistics related methods which were part of the custom microagent are now available in the class microagent.

Page 187: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Available Microagents | 169

Table 40 Microagent Methods

Method Description Page

activateTraceRole() Activates a mapping of a role to a sink at runtime.

171

deactivateTraceRole() Deactivates a mapping of a roles to sinks at runtime.

172

getActivityStatistics() Returns the total number of objects processed for all the schemas.

173

getAdapterServiceInformation() Returns information about the services implemented by this adapter.

174

getComponents() Returns information about the publisher, subscriber, and IODescriptor.

175

getConfig() Returns basic configuration information. More specific information is accessed by the more specific methods.

176

getConfigInformation() Returns the configuration information about the current adapter instance.

177

getConfigProperties() Returns all attributes and elements for the given repository object.

178

getConnectionStatistics() Returns the state and statistics for all the current connections used by the adapter.

179

getHostInformation() Returns standard and extended application information.

180

getRvConfig() Returns information about all TIBCO Rendezvous sessions defined.

181

getStatus() Returns general status information, such as the number of TIBCO Rendezvous messages received and published, the number of errors since the last call, the PID of the application, and more.

182

getThreadStatistics() Returns the operation counts of the current threads.

183

Page 188: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

170 | Chapter 13 Monitoring the Adapter Using TIBCO Hawk

getTraceSinks() Returns information about sinks to which traces currently go.

184

getVersion() Returns the configuration ID, application name, version, and date for this adapter instance.

185

_onUnsolictedMsg() Displays alert messages sent to the current adapter.

186

preRegisterListener() Preregisters an anticipated listener. 187

resetActivityStatistics() Resets all the counts for the activity statistics. 188

resetConnectionStatistics() Resets all the counts for the connection statistics. 189

reviewLedger() Returns information retrieved from the ledger file of a certified messaging session for a publisher adapter.

190

setDocumentDelay() Sets the document delay for a publication service. 192

setTraceSinks() Adds a role or changes the file limit of a previously specified sink.

193

stopApplicationInstance() Stops the running adapter instance. 194

unRegisterListener() Unregisters a currently preregistered listener. 195

getPerfMonSetting() Returns the setting of the perfMon option. 196

Table 40 Microagent Methods (Cont’d)

Method (Cont’d) Description (Cont’d) Page

Page 189: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

activateTraceRole() | 171

activateTraceRole()

Activates a mapping of a role to a sink at runtime. This replaces the now-deprecated setTraceSink() TIBCO Hawk method.

Input Parameters Type Description

Role Name string Name of the role to activate.

Sink Name string Name of the sink for which to activate the role.

Page 190: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

172 | Chapter 13 Monitoring the Adapter Using TIBCO Hawk

deactivateTraceRole()

Deactivates a mapping of a roles to sinks at runtime.

Input Parameters Type Description

Role Name string Name of the role to activate.

Sink Name string Name of the sink for which to activate the role.

Page 191: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

getActivityStatistics() | 173

getActivityStatistics()

Returns the total number of objects processed for all the schemas, based on the request type. Also, returns the number of success and error objects.

Input Parameter Type Description

GetSubTotalBy string Indicates how to group the subtotals, by message types, local reports, delivery reports, or transmission reports.

Returns Type Description

Name string Name of the service or operation.

Total integer Total number of messages processed including both success and failures.

Success integer Total number of messages successfully processed.

Failure integer Total number of messages that caused an error during processing.

MeasurementInterval integer Displays the time (in seconds) since last time the adapter was reset, or if never reset, since the adapter started.

Page 192: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

174 | Chapter 13 Monitoring the Adapter Using TIBCO Hawk

getAdapterServiceInformation()

Returns information about the services implemented by this adapter.

Input Parameter Type Description

Service Name string Name of the service from which to get information. Default is ALL.

Returns Type Description

Line integer Sequential row number.

Service Name string Name of the service as defined at design-time.

Endpoint Name string Name of the endpoint used for this service.

Type string Type of the endpoint, for example, publisher or subscriber.

Quality of Service string Quality of service for the endpoint. For example RVCM or JMS Persistent.

Subject string Subject defined for this endpoint.

Class string Class associated with the endpoint.

Number of Messages

integer Number of messages processed for this endpoint.

Page 193: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

getComponents() | 175

getComponents()

Returns information about the currently active TIBCO Hawk components such as publishers, subscribers, or timers.

Input Parameters Type Description

Component Name string Name of the component. If no value is entered, all components display.

Component Type string Any of Publisher, Subscriber, Timer, or IODescriptor. The default value is All.

Returns Type Description

Instance ID string Name of this adapter instance as defined at design-time.

Adapter Name string Name of the adapter.

Component Name string Name of the component.

Component Type string The name of the TIBCO Adapter SDK class for this component, such as Publisher, Subscriber, or IODescriptorSource. For more information about the class, see your TIBCO Adapter SDK documentation.

Session Name string Name of the session.

Description string Information about this component, for example, time interval, signal type, and validating the publisher or subscriber.

Page 194: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

176 | Chapter 13 Monitoring the Adapter Using TIBCO Hawk

getConfig()

Retrieves generic configuration information. More specific configuration information is accessed through separate methods.

Returns Type Description

Instance ID string Configuration ID of this adapter.

Adapter Name string Name of the adapter.

Repository Connection

string URL of the repository used for adapter instance.

Configuration URL string Location of the adapter project; either a file name or configuration URL.

Command string Command line arguments used to start the adapter.

Page 195: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

getConfigInformation() | 177

getConfigInformation()

Returns the configuration information about the current adapter instance. If an instance has multiple Publication and Subscription services, it returns configuration information about each of the services.

This method does not require any input parameters.

Page 196: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

178 | Chapter 13 Monitoring the Adapter Using TIBCO Hawk

getConfigProperties()

Returns all attributes and elements for the given repository object.

Input Parameter Type Description

Property string Name of the property for which elements (tags) and attributes are desired. For example, agentone/startup.

If no value is given, all properties are returned.

Returns Type Description

Element Name string Repository directory for the property.

Attribute Name string Name of the repository object attribute.

Attribute Value string Value of the repository object attribute.

Line integer Line number in which this property is defined in the project file.

Page 197: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

getConnectionStatistics() | 179

getConnectionStatistics()

Returns the state and statistics for all the current connections used by the adapter.

Returns Type Description

Connection ID string A unique identification of a particular connection.

Connection Type string Type or key that will match this connection to a thread or queue.

State string Current state: UP or DOWN.

NumRetries integer Total number of times this connection had to be reestablished.

TotalNumOperations integer Total number of operations processed by this connection since the adapter started.

CurrentNumOperations integer Total number of operations processed by this connection since the last reconnection.

NumLostConnections integer Total amount of time that this connection has been lost.

MeasurementInterval integer Displays the time (in seconds) since last time the adapter was reset, or if never reset, since the adapter started.

Page 198: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

180 | Chapter 13 Monitoring the Adapter Using TIBCO Hawk

getHostInformation()

Return standard and extended application information set. It returns the following information.

Returns Type Description

Name string Name of the property.

Value string Value of the property.

Page 199: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

getRvConfig() | 181

getRvConfig()

Returns information about the TIBCO Rendezvous session defined by this adapter. Information about all currently defined sessions is returned if no sessionName is provided.

Input Parameter Type Description

Session Name string Name of the TIBCO Rendezvous session for which configuration is required. If not given, information about all sessions is returned. The default is all.

Returns Type Description

Instance ID string Configuration ID of this adapter.

Adapter Name string Name of the adapter.

Session Name string Name of the session.

Service string Service parameter for this session.

Daemon string Daemon parameter for this session.

Network string Network parameter for this session.

Synchronous? boolean Returns 1 if this is a synchronous session, 0 otherwise.

Session Type string Type of session; one of M_RV, M_RVCM, or M_RVCMQ.

Certified Name string Name of this certified session.

Ledger File string Ledger file for this certified messaging session. Returns the empty string for sessions that are not certified messaging sessions.

CM Timeout string Timeout for this certified messaging session. Returns the empty string for sessions that are not certified messaging sessions.

Page 200: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

182 | Chapter 13 Monitoring the Adapter Using TIBCO Hawk

getStatus()

Retrieves basic status information about the adapter.

This information is fairly limited; for more detail, methods getConfig() and getRvConfig() can be used.

Returns Type Description

Instance ID string Configuration ID for this adapter instance.

Adapter Name string Name of the adapter.

Uptime integer Number of seconds since startup.

Messages Received integer Number of TIBCO Rendezvous messages received.

Messages Sent integer Number of TIBCO Rendezvous messages published.

New Errors integer Number of errors since the last call to this method.

Total Errors integer Total number of errors since startup.

Process ID integer Process ID of the application.

Host string Name of host machine on which this adapter is running.

Page 201: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

getThreadStatistics() | 183

getThreadStatistics()

Returns the operation counts of the current threads.

Returns Type Description

ThreadID string A unique identification of a particular thread.

ThreadType string A type that tells what part of the adapter this thread belongs. Valid types include Publisher, Subscriber, RPC, or Connection.

TaskType string One-word description of the tasks this thread processes.

TaskCount integer Number of tasks processed by this thread.

MeasurementInterval integer Displays the time (in seconds) since last time the adapter was reset, or if never reset, since the adapter started.

Page 202: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

184 | Chapter 13 Monitoring the Adapter Using TIBCO Hawk

getTraceSinks()

Returns information about sinks to which traces currently go.

Input Parameters Type Description

Sink Name string Name of the sink for which you need information. If no name is specified, information about all sinks is returned. Default is all.

Role Name string Name of the role for which you need information for the specified sink or sinks. Default is all.

Returns Type Description

Instance ID string Name of this adapter instance as a string.

Adapter Name string Name of the application for this sink.

Sink Name string Name of the sink.

Sink Type string Type of this sink. One of fileSink, rvSink, hawkSink, stderrSink.

Roles string Roles this sink supports, as a string. For example, warning, error, and debug.

Page 203: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

getVersion() | 185

getVersion()

Retrieves version information for the current application. Two lines may be returned, one for the TIBCO Adapter SDK, another one for the adapter.

Returns Description

Instance ID Configuration ID as a string, for example, SDK.

Adapter Name Name of the adapter as a string, for example, agentone.

Version Version number as a string, for example, 5.4.

Page 204: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

186 | Chapter 13 Monitoring the Adapter Using TIBCO Hawk

_onUnsolictedMsg()

Displays all alert messages sent from the adapter or an error if not successful.

Page 205: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

preRegisterListener() | 187

preRegisterListener()

Preregisters an anticipated Subscription service. Some sending applications can anticipate requests for certified delivery even before the listening applications start running. In such situations, the Publication service can preregister subscription services, so TIBCO Rendezvous software begins storing outbound messages in the Publication service ledger. If the listening correspondent requires old messages, it receives the backlogged messages when it requests certified deliver.

Returns OK if the Subscription service was preregistered successfully, false otherwise.

Input Parameters Type Description

Session Name string Name of the session that anticipates the listener.

Publisher Name string Name of the component for which the listener should be preregistered.

Listener Session Name

string Name of the Subscription service to preregister.

Page 206: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

188 | Chapter 13 Monitoring the Adapter Using TIBCO Hawk

resetActivityStatistics()

Resets all the counts for the activity statistics.

Page 207: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

resetConnectionStatistics() | 189

resetConnectionStatistics()

Resets all the counts for the connection statistics.

Page 208: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

190 | Chapter 13 Monitoring the Adapter Using TIBCO Hawk

reviewLedger()

Returns information retrieved from the ledger file of a TIBCO Rendezvous certified messaging session.

Before invoking this method, ensure that the certified messaging publisher adapter has established a certified delivery agreement with its subscriber agents.

Input Parameters Type Description

Session Name string Name of the TIBCO Rendezvous session for which ledger information is desired (default is all).

Subject string Name of the subject for which ledger information is desired.

Returns Type Description

Session Name string Name of the TIBCO Rendezvous CM session to which this information applies.

Subject string Subject name for this session.

Last Sent Message integer Sequence number of the most recently sent message with this subject name.

Total Messages string Total number of pending messages with this subject name.

Total Size integer Total storage (in bytes) occupied by all pending messages with this subject name.

If the ledger contains ten messages with this subject name, then this field sums the storage space over all of them.

Listener Session Name

string Within each listener submessage, the Listener Session Name field contains the name of the delivery-tracking listener session.

Last Confirmed string Within each listener submessage, the Last Confirmed field contains the sequence number of the last message for which this listener session confirmed delivery.

Line integer Row number in ledger file.

Page 209: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

reviewLedger() | 191

UnacknowledgedMessages

integer Number of RVCM messages pending for this listener. The value is computed by subtracting the last sent sequence number from the last acknowledged sequence number.

Returns (Cont’d) Type Description

Page 210: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

192 | Chapter 13 Monitoring the Adapter Using TIBCO Hawk

setDocumentDelay()

Sets the document delay for a Publication service.

Input Parameter Type Description

DocumentDelay integer Document delay time in milliseconds.

ServiceName string Name of the Publication service to set.

Page 211: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

setTraceSinks() | 193

setTraceSinks()

Adds a role or changes the file limit of a previously specified sink.

Returns OK if successful or an error if not successful.

Input Parameters Type Description

Sink Name string Name of the sink for which you want to add a role or change the file limit.

Role Name string Name of the role you want to add to this sink (warning, error, debug, or user defined). Default is all.

File Size integer Maximum file size for this sink.

This parameter is ignored if the sink specified by sinkName is not a file sink.

Page 212: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

194 | Chapter 13 Monitoring the Adapter Using TIBCO Hawk

stopApplicationInstance()

Stops the specified adapter by calling the internal stop() method. This method returns OK if successful or an error if not successful.

Page 213: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

unRegisterListener() | 195

unRegisterListener()

Unregisters a currently preregistered subscription service.

This method returns true if the Subscription service was unregistered successfully, false otherwise.

Input Parameters Type Description

Session Name string Name of the session that anticipates the Subscription service.

Publisher Name string Name of the Publication service to which the Subscription service is preregistered.

Listener Session Name

string Name of the Subscription service to unregister.

Page 214: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

196 | Chapter 13 Monitoring the Adapter Using TIBCO Hawk

getPerfMonSetting()

Returns the setting of the perfMon option. It returns the following information.

Returns Type Description

Setting string Value of the perfMon option.

Page 215: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| 197

Appendix A TIBCO ActiveEnterprise Schemas

The following section describes the schema used by the adapter.

Topics

• Schema for CASmf Interface, page 198

• Schema for MQSA Interface, page 200

• Schema for FTP Interface, page 203

Page 216: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

198 | Appendix A TIBCO ActiveEnterprise Schemas

Schema for CASmf Interface

The following section describes the schemas used by the adapter when it is interfacing with the SWIFT network using the CASmf interface.

LogicalReply SchemaThe LogicalReply schema is used by the SwiftSender to send logical replies (acknowledgement as ACK or NAK) back to the TIBCO ActiveEnterprise application.

Table 41 LogicalReply Schema

Attribute Name Type Description

Success I4 Indicates how a message is acknowledged (ACK or NAK) by CASmf.

0 - No errors detected. 1 - Validation errors detected.

SessionNumber I4 Session number of the message being acknowledged (ACK or NAK).

SequenceNumber I4 Sequence number of the message being acknowledged (ACK or NAK)

Reference String Sender reference for the message being acknowledged (ACK or NAK).

RejectReason I4 If validation errors are found, gives the reason. Possible values are:

0–Message acknowledged, no errors

1–Illegal value

2–Unknown sender address

3–Checksum validation failed

4–Requested disposition failed

5–Requested level of text validation failed

6–Semantic validation failed

7–Field length error

8–Missing field

Disposition I4 Specifies the destination for messages on the SWIFT Alliance Access.

RejectText String Error or exception messages describing why a message is rejected.

Page 217: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Schema for CASmf Interface | 199

NetworkReport SchemaThe NetworkReport schema is used to convey a message transmission and delivery (or non-delivery) report from the SWIFT network to the TIBCO ActiveEnterprise application. This schema is used by the SwiftSender to tell the ActiveEnterprise application whether a SWIFT message has been delivered or not.

Table 42 NetworkReport Schema

Attribute Name Type Description

SessionNumber I4 Current CASmf session number.

SequenceNumber I4 Current sequence number for this message.

Reference String Unique identifier for the message.

ReportType I4 Identifies whether the report is a Transmission report or a Delivery report.

DeliveryStatus I4 Delivery status of the message that is being reported. Possible values are:

0–Message status unknown.

1–Message not delivered before it becomes obsolete.

2–Message delivered.

3–Message delivery has been aborted.

4–Message has a delayed non-acknowledgement.

5–Message has been acknowledged by the receiver.

6–Message has not been acknowledged by the receiver.

NetworkSession I4 Network session number from the basic header block.

NetworkSequence I4 Network sequence number from the basic header block.

Page 218: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

200 | Appendix A TIBCO ActiveEnterprise Schemas

Schema for MQSA Interface

The following section describes the schemas used by the adapter when it is interfacing with the SWIFT network using the MQSA interface.

LocalReport SchemaWhen the MQSA interface is used by the adapter, the LocalReport schema is used to publish the local reports from MQSA to the TIBCO ActiveEnterprise application. The local reports are used for local reconciliation in order to ensure that a message is correctly stored in SWIFT Alliance.

TransmissionNotification SchemaTransmissionNotification schema is used to publish the transmission notification from SWIFT when the MQSA interface is in use.

Table 43 LocalReport Schema

Attribute Name Type Description

MsgId String The System Unique Message Identifier (SUMID) generated for the local report.

OriginalMsgCorrelId String The System Unique Message Identifier (SUMID) of the original message for which the report is generated.

Date String The date when the report was inserted into MQSeries by MQSA.

Time String The time when the report was inserted into MQSeries by MQSA.

ReportStatus String The status of the original message sent from MQSA to SWIFT Alliance Access. Possible values are:

Positive Action Notification

Message Failed Validation

Message is stored in SWIFT Alliance but not routed or moved

Message could not be added into SWIFT Alliance

Message could not be converted to SWIFT Alliance format

Page 219: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Schema for MQSA Interface | 201

A transmission notification is a message representing the result of the transmission to the SWIFT network. Full syntax and semantic checks are performed by SWIFT before an acknowledgement (ACK) is returned. Other checks, such as validity of the sender and receiver, are also performed. These checks can cause a message to be rejected and a negative acknowledgement (NAK) is returned.

DeliveryNotification SchemaDeliveryNotification schema is used to publish the DeliveryNotification from SWIFT when the MQSA interface is in use.

Delivery notifications are system messages sent by SWIFT in response to any input message. They are used in monitoring the progress of the message.

Table 44 TransmissionNotification Schema

Attribute Name Type Description

MsgId String The System Unique Message Identifier (SUMID) generated for the transmission notification.

OriginalMsgCorrelId String The System Unique Message Identifier (SUMID) of the original message for which the report is generated.

Date String The date when the report was inserted into MQSeries by MQSA.

Time String The time when the report was inserted into MQSeries by MQSA.

TransmissionStatus String The status of message transmission from SWIFT Alliance Access to the SWIFT Network. Possible values are:

Positive SWIFT Acknowledgement

Negative SWIFT Acknowledgement

SWIFT Alliance is waiting for SWIFT ACK

Message Timed Out

Message is rejected

Message is Aborted

None

Table 45 TransmissionNotification Schema

Attribute Name Type Description

MsgId String The System Unique Message Identifier (SUMID) generated for the delivery notification.

Page 220: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

202 | Appendix A TIBCO ActiveEnterprise Schemas

OriginalMsgCorrelId String The System Unique Message Identifier (SUMID) of the original message for which the report is generated.

Date String The date when the report is inserted into MQSeries by MQSA.

Time String The time when the report is inserted into MQSeries by MQSA.

MsgDeliveryStatus String The status of message delivery. Possible values are:

Successful Delivery of the Message

Non Delivery Warning

Message is Aborted

None

Table 45 TransmissionNotification Schema (Cont’d)

Attribute Name Type Description

Page 221: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Schema for FTP Interface | 203

Schema for FTP Interface

The following section describes the schemas used by the adapter when it is interfacing with the SWIFT network using the FTPinterface.

LogicalReply SchemaThe LogicalReply schema is used by the SwiftSender to send logical replies (acknowledgement as ACK or NAK) back to the TIBCO ActiveEnterprise application.

Table 46 LogicalReply Schema

Attribute Name Type Description

Disposition I4 Specifies the destination for messages on the SWIFT Alliance Access.

Reference String Sender reference for the message being acknowledged (ACK or NAK).

RejectReason I4 If validation errors are found, gives the reason. Possible values are:

0–Message acknowledged, no errors

1– Illegal value

2–Unknown sender address

3–Checksum validation failed

4–Requested disposition failed

5–Requested level of text validation failed

6–Semantic validation failed

7–Field length error

8–Missing field

RejectText String Error or exception messages describing why a message is rejected.

SequenceNumber I4 This will be set to -1 in case of validation errors.

SessionNumber I4 This will be set to -1 in case of validation errors.

Success I4 Indicates how a message is acknowledged (ACK or NAK) by FTP.

1 - No errors detected. 0 - Validation errors detected.

Page 222: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

204 | Appendix A TIBCO ActiveEnterprise Schemas

Page 223: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| 205

Appendix B Migrating to the Current SWIFT Standards

This appendix explains how to migrate your projects to the current SWIFT standards.

Topics

• Migrating to the Current SWIFT Standards, page 206

Page 224: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

206 | Appendix B Migrating to the Current SWIFT Standards

Migrating to the Current SWIFT Standards

Every year SWIFT releases new message standard. This release of the adapter supports the standards release 2013.

To upgrade your projects that use the previous standards to the new standards of SWIFT, perform the following steps:

1. Install the new version of the adapter.

2. Open the projects developed using previous versions of the adapter or the plug-in, you are prompt to upgrade to the new release. To upgrade, click the OK button.

3. Click the SWIFTNet - FIN Schema Loader item, select the new SWIFT specification (for example, SWIFT November 2013 specification) from the Specification drop-down list in the Configuration tab.

4. Click the Yes button.

The message schemas of previous SWIFT standards release are unloaded.

5. Load the required message schemas.

In SWIFT Standards Release 2013, structural changes in a SWIFT message can cause the mappings from the existing projects to break. Restore the broken links manually.

Page 225: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| 207

Appendix C Dynamic BIC Update

The following section discusses the Dynamic BIC Update feature.

Topics

• Overview of Dynamic BIC, page 208

• Using Dynamic BIC or BEI Update, page 209

Page 226: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

208 | Appendix C Dynamic BIC Update

Overview of Dynamic BIC

The adapter supports BIC or BEI validations.

In the previous releases of the adapter and the plug-in, if changes are made to the BIC file, then they will not update dynamically for BIC or BEI validations when the adapter or the plug-in runs. With the new Dynamic BIC or BEI update feature, if changes are made in the BIC file, they will update without restarting the adapter or the plug-in instances.

If you use the adapter, specify the BIC file to be used for validation in the General tab of SWIFTNet - FINSender or SWIFTNet - FINReceiver as applicable. The BIC or BEI information provided in this file is used for BIC or BEI validations on the messages processed by the adapter or the plug-in.

If you use the plug-in, specify the BIC file to be used for validation in the Configuration tab of TIBCO ActiveMatrix BusinessWorks activities.

Dynamic BIC update can be triggered using any of the following:

• TIBCO Rendezvous message

• TIBCO Enterprise Message Service message

• TIBCO Hawk method, which is provided by the adapter

Page 227: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Using Dynamic BIC or BEI Update | 209

Using Dynamic BIC or BEI Update

Using the Dynamic BIC Update feature involves the following:

• Activate Dynamic BIC or BEI Update, page 209

• Trigger Dynamic BIC or BEI Update on page 209

Activate Dynamic BIC or BEI Update

You must activate the Dynamic BIC or BEI Update feature before you can use it. To activate the feature, you need to specify the values of the property BIC_UPDATE_CONFIG_FILE_PATH in the files listed in the following table. The value of the property is the file name that contains the configuration information for Dynamic BIC Update.

Trigger Dynamic BIC or BEI Update

The BIC information of the FI.dat file changes if you perform any of the following:

• Edit the FI.dat file.

• Overwrite the FI.dat file.

Generating a trigger to indicate to the adapter the changes made to the file. You can generate the trigger manually or automatically.

Manually

Using this method, you send a message using TIBCO Rendezvous, TIBCO Enterprise Message Service, or TIBCO Hawk to the adapter or the plug-in.

Automatically

Automatic triggering of the message is possible if you use TIBCO Rendezvous or TIBCO Enterprise Message Service.

In TIBCO ActiveMatrix BusinessWorks, design this process:

Adapter Plug-in

Files • adswiftSender.tra

• adswiftReceiver.tra

bwengine.tra

Syntax java.property.BIC_UPDATE_CONFIG_FILE_PATH = TIBCO_Home/adapter/adswift/version_num/examples/BICUpdate.properties

Page 228: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

210 | Appendix C Dynamic BIC Update

• Poll the BIC file (using File Poller activity) to identify the changes in its content.

• Configure the TIBCO Rendezvous or TIBCO Enterprise Message Service publisher activity for the required subject, topic, or queue. See Table 47 for the configuration information.

To receive the trigger, the adapter updates its temporary memory (in-memory cache) with new BIC information.

The following table lists the trigger types and parameters.

Table 47 List of Trigger Types and Parameters

Trigger Type (triggerType) Parameters Notes

TIBCO Rendezvous (RV)

TIBCO Rendezvous ParametersRV_Service

RV_Network

RV_Daemon

RV_Subject

If you update the BIC file, you must send a TIBCO Rendezvous message on the configured subject that the BIC file name as its message body.

TIBCO Enterprise Message Service (EMS)

Server ParametersEMS_Server_URL

EMS_Username

EMS_Password

Destination ParametersEMS_DestinationName

EMS_DestinationType(Topic or Queue)

If you update the BIC file, you must send a TIBCO Enterprise Message Service message on the configured topic or queue that has BIC file name as the message body.

TIBCO HAWK (HAWK)

TIBCO Hawk ParametersHAWK_Network

HAWK_Daemon

HAWK_Service

HAWK_MicroAgentName

HAWK_MicroAgentName—The name to be displayed for TIBCO Hawk microagent.

In the adapter:

The files, adswiftSender.tra and adswiftReceiver.tra contain the property, tibco.env.CUSTOM_CP_EXT. To this property, prefix the path

TIBCO_ Home/hawk/lib.

In the TIBCO ActiveMatrix BusinessWorks Plug-in for SWIFTNet - FIN:

The bwengine.tra file contains the property, tibco.env.CUSTOM_EXT_PREPEND_CP. To this property, prefix the path

TIBCO_ Home/hawk/lib.

Page 229: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| 211

Appendix D Trace Messages

This appendix explains the trace messages that are logged to a location specified at configuration time.

Topics

• Overview of Trace Messages, page 212

• Trace Message Fields, page 214

• Status Messages, page 217

Page 230: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

212 | Appendix D Trace Messages

Overview of Trace Messages

Trace messages provide information about adapter activities. The messages are logged to the console where the runtime adapter is started and to a log file. Trace messages can also be redirected to the TIBCO Hawk Display application, or sent to other applications using the TIBCO Rendezvous transport.

Each trace message can include the following fields: Timestamp Adapter Identifier Role Category Status Code Tracking Identifier

The above fields are explained in Trace Message Fields on page 214. The following diagram shows an example trace message and calls out the fields.

Trace Message Examples

The following trace messages are written during a session where TIBCO Adapter for SWIFT received an object from TIBCO Adapter for R/3 and then processed the object.

The first message indicates that TIBCO Adapter for SWIFT has started successfully. The timestamp indicates when the adapter started, and the role indicates that the trace message is informational, which means the activity is normal for the adapter. The category is identified, and the corresponding status code is displayed.2003 Mar 07 15:13:36:512 GMT +5 SubCancelPO Info [System] AESWFT-4003018 Adapter Initialized Successfully....

The second trace message indicates that the adapter received an object (in this case a Business Event).2003 Mar 07 15:52:24:740 GMT +5 SubCancelPO Info [Adapter] AESWFT-4003005 Received an Event.

The third trace message indicates that the adapter is processing the event with the name FROM_SAP_CANCEL_PO.

2003 Mar 07 15:52:25:501 GMT +5 SubCancelPO Info [Adapter]

AESWFT-4003006 Processing Business Event FROM_SAP_CANCEL_PO.

2003 Feb 22 20:15:12:937 GMT -8

SWIFTAdapter.SWIFTAdapterConfiguration Info [Adapter]

2003 Mar 07 15:13:36:512 GMT +5 SubCancelPO Info [System]

tracking=#MU3oTJ/WWCV1MU96J0zzwA9kzzw#

Timestamp

Adapter Identifier Role Category

Status Code

Tracking Identifier

AESWFT-4003018 Adapter Initialized Successfully....

Page 231: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Overview of Trace Messages | 213

The fourth trace message indicates that the adapter has successfully processed the event FROM_SAP_CANCEL_PO.

2003 Mar 07 15:52:33:833 GMT +5 SubCancelPO Info [Adapter]

AESWFT-4003031 Finished Processing..: FROM_SAP_CANCEL_PO.

Page 232: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

214 | Appendix D Trace Messages

Trace Message Fields

Each trace message includes the following fields:

Table 48 Trace Message Fields (Sheet 1 of 3)

Field Name Description

Timestamp Timestamp of occurrence. For example, 2003 Feb 22 20:14:51:718 GMT -8.

Adapter Identifier Name of the adapter that writes the trace message. This is a combination of the adapter acronym and adapter configuration name. For example, the application identifier, adswift.publisher1 identifies a TIBCO ActiveMatrix Adapter for SWIFT service named publisher1.

Role A role can be:

• Info. indicates normal adapter operation. No action is necessary. A tracing message tagged with Info. indicates that a significant processing step is reached and logged for tracking or auditing purposes. Only info. messages preceding a tracking identifier are considered significant steps.

• Warn. an abnormal condition is found. Processing will continue, but special attention from an administrator is recommended.

• Error. an unrecoverable error occurs. Depending on the error severity, the adapter may continue with the next operation or may stop altogether.

• Debug. a developer-defined tracing message. In normal operating conditions, debug messages should not display.

When configuring the adapter, you need to define what roles should be or should not be logged. For example, you may decide not to log Info roles to increase performance.

Page 233: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Trace Message Fields | 215

Category One of the following:

• Adapter: the adapter is processing an event.

• Application: the adapter is interacting with SWIFT.

• Configuration: the adapter is reading configuration information.

• Database: the adapter is interacting with a database.

• Metadata: the adapter is retrieving metadata from SWIFT.

• Palette: the adapter is interacting with the palette.

• Publication Service: the Publication service is reporting this trace message.

• Request-response Client Service: the Request-response Invocation service is reporting this trace message.

• Request-response Server: the Request-response service is reporting this trace message.

• Shutdown: the adapter is shutting down.

• Startup: the adapter is starting.

• Subscription Service: the Subscription service is reporting this trace message.

• System: this category is not linked to a specific event process. The trace message may be related to a Windows service related messages, memory allocation, file system error, and so on.

• TibRvComm: the adapter is communicating with TIBCO Rendezvous.

• XML: the adapter is parsing XML documents.

Status Code Unique code for the message and description. Status codes are identified by a unique number and description. If a trace message includes an error or a warn role, the status code documentation includes a resolution.

Table 48 Trace Message Fields (Sheet 2 of 3)

Field Name Description

Page 234: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

216 | Appendix D Trace Messages

Tracking Identifier

A unique identifier that is "stamped" on each message by the originating adapter. The tracking identifier remains in effect from a message’s beginning to its completion as it is exchanged by TIBCO applications. If the adapter is the termination point of the message, the tracking identifier is not displayed in the trace message.

You cannot modify the tracking identifier format or configure what information is displayed.

Application-specific Information

Application-specific information added to the tracking info to trace the message back to its source. Set initially by the originating adapter and carried forward. It is augmented by each intermediate component.

Table 48 Trace Message Fields (Sheet 3 of 3)

Field Name Description

Page 235: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Status Messages | 217

Status Messages

In environments where multiple applications are used simultaneously, the possible status of messages increases as well. This section lists the various messages in numerical order.

Resolutions are provided wherever possible for error and warning messages. If there is no resolution provided, or if you need additional help, contact TIBCO Support at http://support.tibco.com.

Message Role Category Resolution

AESWIFT-000001: Encountered an internal error: %1

errorRole System Indicates an unanticipated disruption of adapter operation.

AESWIFT-000002: %1

debugRole Adapter Generic debug message template. Indicates normal adapter operation. No action required.

AESWIFT-000003: Entering SwiftAdapter.onInitialize()

infoRole Adapter Indicates normal adapter operation. No action required.

AESWIFT-000004: Could not initialize the metadata store for specification %2 in data directory %1

errorRole Configuration Set the data directory and specification by properly creating a SWIFT adapter instance through Designer, or by overriding the settings using the system properties ADSWIFT_HOME, ADSWIFT_DATA, and ADSWIFT_SPECIFICATION.

AESWIFT-000005: Could not stop the SWIFT Adapter: %1

errorRole Adapter An internal termination error that refers to the root cause.

AESWIFT-000006: The SWIFT adapter is stopping: %1

errorRole Adapter An internal termination error that refers to the root cause.

Page 236: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

218 | Appendix D Trace Messages

AESWIFT-000007: The SWIFT adapter is stopping.

errorRole Adapter The adapter has encountered an abnormal condition that has caused it to stop, check the error logs.

AESWIFT-000008: The SWIFT adapter configuration is damaged.

errorRole Configuration The adapter configuration is corrupted. Re-export the configuration from TIBCO Designer and try again.

AESWIFT-000009: Activating all publishers and subscribers.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000010: Activating all publishers and subscribers in SwiftAdapter.onInitialize().

debugRole Adapter Provides additional runtime information. No action required.

AESWIFT-000011: Could not start SWIFT Adapter: Could not set explicit confirm for endpoint %1.

errorRole Startup Contacts TIBCO Support.

AESWIFT-000012: Initializing start up properties.

infoRole Configuration Indicates a normal adapter operation. No action required.

AESWIFT-000013: Initializing start up properties.

debugRole Configuration Not Applicable

AESWIFT_000014: Database Failure Fatal set to true requires a Log Prefix, but it is missing.

errorRole Configuration Specifies a Log Prefix in the configuration.

AESWIFT_000015: Unknown Dispose method %1: supported values are CASmf, FTP or MQSA.

errorRole Configuration Specifies a valid Dispose method of CASmf, FTP, or MQSA.

AESWIFT-000016: %1 could not create an instance of %2.

errorRole Configuration Ensures that the schema is loaded in the configuration.

Message Role Category Resolution

Page 237: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Status Messages | 219

AESWIFT-000017: Could not create FTP client: %1

errorRole Startup Verifies all configured FTP connection parameters.

AESWIFT-000018: Unable to create a connection with the target application %1 using connection parameter %2 and the target application error is %3.

errorRole Startup Verifies that the remote server is up and running.

AESWIFT-000019: Could not find the JDBCMessageSession for connecting to the log database.

errorRole Database Configures the JDBC parameters correctly.

AESWIFT-000020: Could not connect to the log database: %1

errorRole Connection Verifies the configuration parameters for the log database.

AESWIFT-000021: Database Failure Fatal is set: error %1 is stopping the adapter.

errorRole Database Verifies the configuration parameters for the log database.

AESWIFT-000022: WorkerThread started.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000023: Connection to CASmf failed.

errorRole Connection Checks if the CASmf server is up and running.

AESWIFT-000024: Added resend of SWIFT message to worker thread: %1

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000025: Initializing to logging database.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000026: Could not activate listeners: %1

errorRole Adapter Restarts the adapter.

Message Role Category Resolution

Page 238: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

220 | Appendix D Trace Messages

AESWIFT-000027: Could not suspend listeners: %1

errorRole Adapter Restarts the adapter.

AESWIFT-000028: SWIFT Adapter is running.

debugRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000029: SWIFT Adapter is running.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000030: Publishing SWIFT message %1.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000031: Warning: %1.

infoRole Message Indicates a normal adapter operation. No action required.

AESWIFT-000032: Could not convert a message of type %1 (make sure that its schema is loaded): %2

errorRole Message Checks if the particular schema exists in the repository.

AESWIFT-000033: %1 could not serialize %2: %3

errorRole Message Checks if the data is in the correct format.

AESWIFT-000034: Publishing Swift Message.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000035: %1 subscriber received inbound event with no data.

errorRole Subscription Sends valid SWIFT data.

AESWIFT-000036: %1 could not deserialize inbound event data: %2

errorRole Message Checks if the data is in the correct format.

AESWIFT-000037: %1 could not convert message instance to SWIFT: %2

Message Role Category Resolution

Page 239: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Status Messages | 221

errorRole Message Checks if the data is in the correct format.

AESWIFT-000038: %1 could not convert SWIFT message to text: %2

errorRole Message Check if the data is in the correct format.

AESWIFT-000039: CASmf added message to sender: reference %1, message %2

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000040: %1 putting message file %2 on directory %3 (session %4, sequence %5, reference %6)

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000041: %1 could not get list of files from remote directory %2: %3

errorRole Adapter Checks that the FTP server is up and that the remote directory exists.

AESWIFT-000042: Placed outgoing SWIFT Message on SwiftAlliance with reference %1.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000043: Processing of Message Completed.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000044: Could not send Message Type %1 to SWIFT Alliance: %2

errorRole Adapter Checks if the message is proper and the corresponding schema is present in the repository.

AESWIFT-000045: Adapter is publishing the MQSA Message on the TIB.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000046: Adapter is publishing the MQSA Message on the TIB.

debugRole Adapter Provides additional runtime information.

AESWIFT-000047: %1 cannot confirm receipt of %2: %3

Message Role Category Resolution

Page 240: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

222 | Appendix D Trace Messages

errorRole Adapter Checks the configuration of the RVCM session.

AESWIFT-000048: MQSA Message Published: %1

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000049: Database Error: %1 occurred when logging the %2 Swift message for the %3 interface.

errorRole Database Checks for the database connectivity.

AESWIFT-000050: Publication service encountered error %1 while publishing %2 to the Active Enterprise for the %3.

errorRole Publisher Checks if the SwiftMessage is valid.

AESWIFT-000051: Admin Publisher sent %1.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000052: %1

debugRole Adapter A debugging dump of a stack trace.

AESWIFT-000053: Could not initialize SWIFT validator: %1

errorRole Configuration Checks the configuration of the BIC Code, Directory Currency Code, and Country Code files.

AESWIFT-000054: Configuration property %1 is %2

debugRole Configuration Provides additional runtime information.

AESWIFT-000055: Configuration property %1 is %2

infoRole Configuration Not applicable.

AESWIFT-000056: Configuration property %1 is required, but is either missing or has an empty value.

errorRole Configuration Checks the configuration for the required properties. Make sure all required properties are set in TIBCO Designer before the export.

AESWIFT-000057: Configuration password property %1 could not be decrypted: %2

Message Role Category Resolution

Page 241: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Status Messages | 223

errorRole Configuration Resets the password in TIBCO Designer and re-exports the project.

AESWIFT-000058: Configuration property %1 with a value of %2 is supposed to be an integer, but is not.

errorRole Configuration Checks the configuration for the required properties. Make sure all required properties are set in TIBCO Designer before the export.

AESWIFT-000059: Configuration property %1 with a value of %2 is supposed to be at least %3 and at most %4, but is not.

errorRole Configuration Checks the configuration for the required properties.

AESWIFT-000060: Configuration property %1 with a value of %2 is supposed to be at least %3, but is not.

errorRole Configuration Checks the configuration for the required properties.

AESWIFT-000061: Configuration property %1 with a value of %2 is supposed to be at most %3, but is not.

errorRole Configuration Checks the configuration for the required properties.

AESWIFT-000062: %1 could not create an instance of publisher %2.

errorRole Configuration Ensures that the publisher's service is loaded in the configuration.

AESWIFT-000063: %1 could not create an instance of subscriber %2.

errorRole Configuration Ensures that the subscriber's service is loaded in the configuration.

AESWIFT-000064: %1 could not create an instance of %2.

infoRole Configuration Ensures that the schema is loaded in the configuration.

AESWIFT-000065: %1 could not convert FIN message %2 to a SWIFT message: %3

errorRole Adapter The underlying FIN message is completely unreadable.

AESWIFT-000066: Parsing FIN message %1 to a SWIFT message: %2

Message Role Category Resolution

Page 242: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

224 | Appendix D Trace Messages

errorRole Adapter The underlying FIN message has basic syntactic errors. Repairs it and reprocesses.

AESWIFT-000067: Error validating FIN message %1: %2

errorRole Adapter The underlying FIN message is broken. Repairs it and reprocesses.

AESWIFT-000068: %1 could not convert SWIFT message %2 (message type %3) to an MInstance: %4

errorRole Adapter The underlying FIN message is broken. Repairs it and reprocesses.

AESWIFT-000069: Could not serialize MInstance for %1 onto wire: %2

errorRole Adapter The SDK does not serialize the MInstance. Checks the required schemas and underlying transports.

AESWIFT-000070: Sending %1

infoRole Adapter The SDK is about to send. Normal operation.

AESWIFT-000071: Could not send %1: %2

errorRole Adapter The SDK does not send. Checks the required schemas and underlying transports.

AESWIFT-000072: %1 could not put message file %2 on directory %3 (session %4, sequence %5, reference %6): %7

errorRole Adapter Checks that the remote directory exists.

AESWIFT-000073: Closing FTP client.

infoRole Adapter The adapter is closing its FTP client. Normal adapter operation.

AESWIFT-000074: %1 using publisher %2 sending %3.

infoRole Adapter A message is being published. Normal adapter operation.

AESWIFT-000075: %1 using publisher %2 could not send %3: %4

errorRole Adapter A message is not published. Checks the required schemas and underlying transports.

Message Role Category Resolution

Page 243: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Status Messages | 225

AESWIFT-000076: Expected %1 attribute %2 to be a %3, but it was a %4

errorRole Adapter The incoming message has an attribute of an unexpected type. Checks the message source.

AESWIFT-000077: %1 received a message for processing.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000078: %1 is processing a message.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000079: %1 could not poll remote directory: %2

errorRole Adapter Logs off from the FTP server and tries logging in again.

AESWIFT-000080: %1 encountered FTP error: %2

errorRole Connection Verifies that the FTP server is up and running.

AESWIFT-000081: %1 connecting to remote server.

infoRole Connection Indicates a normal adapter operation. No action required.

AESWIFT-000082: %1 reconnecting to remote server.

infoRole Connection Indicates a normal adapter operation. No action required.

AESWIFT-000083: %1 connected to remote server.

infoRole Connection Indicates a normal adapter operation. No action required.

AESWIFT-000084: %1 could not get remote file %2 from remote directory %3: %4

errorRole Adapter Checks that the FTP server is up and running, and the remote directory exists.

AESWIFT-000085: Could not locate or initialize CASmf gateway library %1: %2

Message Role Category Resolution

Page 244: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

226 | Appendix D Trace Messages

errorRole StartUp Checks if the SwiftAdapter.dll/libSwiftAdapte.so exists in the bin directory of the adapter installation.

AESWIFT-000086: CASmf error: %1

errorRole Connection Verifies that the CASmf gateway server is up and running.

AESWIFT-000087: Could not create CASmf client: %1

errorRole Startup Verifies all configured FTP connection parameters.

AESWIFT-000088: %1

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000089: Could not disconnect from %1: %2.

errorRole Shutdown Adapter is waiting as long as it can be for the component to shut down, but then continues. No action required.

AESWIFT-000090: Could not set %1 attribute %2 to value %3: %4

errorRole Adapter The adapter does not set an attribute on an outgoing message. Ensures your configuration is valid.

AESWIFT-000091: Could not get %1 attribute %2: %3

errorRole Adapter The adapter does not access an attribute from in incoming message. Ensures that the message is valid.

AESWIFT-000092: Starting %1

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000093: Stopping %1

infoRole Adapter Indicates a normal adapter operation. No action required.

Message Role Category Resolution

Page 245: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Status Messages | 227

AESWIFT-000094: Could not resend to CASmf the message in %1: %2

errorRole Adapter Tries again. If the problem persists, contact TIBCO Support.

AESWIFT-000095: The SWIFT adapter received an exit message and is stopping.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000096: Could not determine a directory for persistent connection state: missing adswift.state.

errorRole Configuration Sets adswift.state in the .tra file or in the Java environment.

AESWIFT-000097: Could not process a directory for persistent connection state: %1

errorRole Configuration Sets adswift.state in the .tra file or in the Java environment.

AESWIFT-000098: CASmf resending %1.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000099: CASmf resent message file %1.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000100: CASmf updating time stamp of message file %1.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000101: CASmf could not update the time stamp of resend message file %1: %2

errorRole Adapter Checks if the file has write permission.

AESWIFT-000102: CASmf could not send: reference %1, message %2

errorRole Adapter Checks that CASmf is up and running.

AESWIFT-000103: CASmf logging message to %1: reference %2, message %3

infoRole Adapter Checks that CASmf is up and running.

AESWIFT-000104: CASmf could not log message to %1: %2

Message Role Category Resolution

Page 246: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

228 | Appendix D Trace Messages

errorRole Adapter Checks that CASmf is up and running.

AESWIFT-000105: Could not append %1 attribute %2: %3

errorRole Adapter The adapter does not add an attribute on an outgoing message. Ensures your configuration is valid.

AESWIFT-000106: %1 processing message file %2 from remote directory %3.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000107: CASmf failed to receive a message, reconnecting.

errorRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000108: Could not publish %1: %2.

errorRole Adapter Checks configuration for required metadata.

AESWIFT-000109: CASmf received a logical reply: session %1, sequence %2

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000110: CASmf could not delete logged message at %1.

errorRole Adapter Checks if the file exists and the directory has the correct permissions.

AESWIFT-000111: CASmf received a FIN message: session %1, sequence %2, reference %3, message %4.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000112: CASmf sending a logical reply to gateway.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000113: CASmf failed to send a logical reply to the gateway.

errorRole Adapter Verifies that the gateway is up and running.

AESWIFT-000114: CASmf received a Transmission Report: session %1, sequence %2, reference %3, status %4.

Message Role Category Resolution

Page 247: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Status Messages | 229

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000115: CASmf received a Delivery Report: session %1, sequence %2, reference %3, status %4.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000116: CASmf sending FIN message: reference %1, message %2.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000117: Error in logging database (user '%1' and url '%2'): %3

errorRole Adapter Logging database operation failed. Makes sure it is configured properly and is available.

AESWIFT-000118: Error in logging database (user '%1' and url '%2'), and adapter is configured to stop on failure: %3

errorRole Adapter Logging database operation failed. Makes sure it is configured properly and is available.

AESWIFT-000119: Connecting to logging database.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000120: Closing logging database.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000121: Logging %1 to database: session %2, sequence %3, reference %4.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000122: Unexpected %1: %2

errorRole Adapter Checks if the obtained event is a valid event.

AESWIFT-000123: Advisory Error Message: %1

Message Role Category Resolution

Page 248: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

230 | Appendix D Trace Messages

errorRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000124: Advisory Warning Message: %1

warnRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000125: Warn Advisory Message, %1

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000126: Could not report on %1 statistics: %2

errorRole Message Checks the attributes of the indicated report type.

AESWIFT-000127: Could not create a custom Hawk Micro Agent named %1: %2

errorRole StartUp Checks if the microagent exists.

AESWIFT-000128: Activating listeners.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000129: Suspending listeners.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000130: Publishing Logical Reply.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000133: %1 backing up message file %2 from remote directory %3 to backup directory %4.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000134: %1 could not back up message file %2 from remote directory %3 to backup directory %4: %5

errorRole Adapter Indicates a normal adapter operation. No action required.

Message Role Category Resolution

Page 249: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Status Messages | 231

AESWIFT-000135: %1 could not connect to remote directory %2 on FTP server: %3

errorRole Adapter Checks that the remote directory exists.

AESWIFT-000136: %1 has parsing enabled, but it received an AE message that is an unparsed FIN message.

errorRole Message Checks that the publisher is parsing on.

AESWIFT-000137: %1 has parsing disabled, but it received an AE message that is a parsed SWIFT message.

errorRole Message Checks that the publisher is parsing off.

AESWIFT-000138: %1 received an AE message that does not appear to be either an unparsed FIN message or a parsed SWIFT message.

errorRole Message Checks that the subscriber is listening to the correct subject or topic.

AESWIFT-000139: %1 sent a message with session %2 and sequence %3, but received session %4 and sequence %5: adapter is resynchronizing.

infoRole Message The CASmf session and sequence number need to be synchronized, and this is not an error.

AESWIFT-000140: CASmf could not log message with reference %1 to file %2, but that file already exists.

errorRole Adapter The adapter is not synchronized with CASmf, and is in danger of overwriting messages.

AESWIFT-000141: Could not load JDBC driver '%1': check your class path and driver class name.

errorRole Configuration Checks the JDBC message session.

AESWIFT-000142: Could not load Merant DataDirect JDBC, incorrect license key.

errorRole Configuration Checks that the product is installed correctly.

AESWIFT-000143: Logging %1 to database: session %2, sequence %3, reference %4, network session %5, network sequence %6.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000144: %1 could not rename '%2' to '%3'.

Message Role Category Resolution

Page 250: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

232 | Appendix D Trace Messages

errorRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000145: Writing message to %1 (%2).

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000146: Could not write message to %1 (%2): %3

errorRole Adapter Checks that the disposal server is up and running.

AESWIFT-000147: %1 processing message file %2.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000148: %1 processed message file %2.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000149: %1 could not process %2: %3

errorRole Adapter There is a problem processing a caught message to send to SWIFT. If the error message is correctable, do so. Otherwise, manually removes the caught message file. Restarts the adapter.

AESWIFT-000150: %1 could not process %2 (session %3, sequence %4, reference %5): %6

errorRole Adapter There is a problem sending a caught message to SWIFT using the disposal method. If the error message is correctable, do so. Otherwise, manually removes the caught message file. Restarts the adapter.

AESWIFT-000151: %1 deleting processed cached message file %2.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWIFT-000152: %1 could not delete processed cached message file %2: %3

errorRole Adapter Checks that the file and its directory are not read-only.

Message Role Category Resolution

Page 251: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Status Messages | 233

AESWIFT-000153: Adapter failed to receive logical reply from CASmf : %1.

errorRole Adapter Checks that CASmf is running.

AESWIFT-000154: Adapter received a message from CASmf which is not logical reply.

errorRole Adapter None

AESWFTINFO-0000001: Connecting to log database url %1 driver %2 user %3.

infoRole Database Indicates a normal adapter operation. No action required.

AESWFTINFO-0000002: Connected to log database.

infoRole Database Indicates a normal adapter operation. No action required.

AESWFTINFO-0000003: Ensured Swift log.

infoRole Database Indicates a normal adapter operation. No action required.

AESWFTINFO-0000007: Put outgoing Swift Message on SwiftAlliance %1.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWFTINFO-0000008: Starting Swift Adapter Tester initialization.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWFTINFO-0000009: Swift Adapter Tester initialized.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWFTINFO-0000010: Processed Message Files.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWFTINFO-0000011: CASmf sent outgoing Swift message %1.

infoRole Application Indicates a normal adapter operation. No action required.

Message Role Category Resolution

Page 252: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

234 | Appendix D Trace Messages

AESWFTINFO-0000012: Outgoing Swift message written to file %1.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWFTERROR-0000001: Exception in closing Log database %1.

errorRole Database Checks for the tables's state in the database.

AESWFTERROR-0000002: Could not link to CASmf native library.

errorRole Application Checks if CASmf is running.

AESWFTERROR-0000003: No AdminPublisher found.

errorRole Configuration Checks if Admin Publisher exists in the repository.

AESWFTERROR-0000005: Could not set explicit confirm for MessageSubscriber.

errorRole Adapter Checks the MessageSubscriber in the repository.

AESWFTERROR-0000006: No MessagePublisher or MessageSubscriber found.

errorRole Configuration Checks if the Message Publisher or the Message Subscriber exists in the repository.

AESWFTERROR-0000007: No ExitSubscriber found.

errorRole Configuration Checks if Exit Subscriber exists in the repository.

AESWFTERROR-0000008: Environment variable CUS not defined, CASmf not installed.

errorRole Application Checks if CASmf is running.

AESWFTERROR-0000009: No recovery file named %1 found.

errorRole Application Checks if the file exists.

AESWFTERROR-0000010: recovery file line: %1 not 18 digits, file: %2

errorRole Application Specifies the correct recovery file.

AESWFTERROR-0000011: FTP properties not present at: %1

errorRole Adapter Checks if FTPUrl is given correctly.

Message Role Category Resolution

Page 253: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Status Messages | 235

AESWFTERROR-0000012: FTP properties do not specify FTP server host.

errorRole Configuration Specifies the FTP server host.

AESWFTERROR-0000013: FTP properties do not specify FTP server timeout.

errorRole Configuration Specifies the FTP server timeout.

AESWFTERROR-0000014: FTP properties do not specify polling period for transfers.

errorRole Configuration Specifies the FTP Polling timeout.

AESWFTERROR-0000015: Could not create FTPClient.

errorRole Adapter Checks if all parameters related to FTP are given.

AESWFTERROR-0000016: Startup properties not present %1.

errorRole Adapter Checks if the URL specified is correct.

AESWFTERROR-0000017: No MAPID specified in startup properties.

errorRole Configuration MAPID is specified for CASmf. Specifies it in the repository.

AESWFTERROR-0000018: No Role specified in startup properties.

errorRole Configuration Roles are specified for CASmf. Specifies them in the repository.

AESWFTERROR-0000019: ReceiveTimeout not an integer %1.

errorRole Configuration Receiver timeout is an integer.

AESWFTERROR-0000021: ReceiveTimeout should be between 1 and 500, value %1.

errorRole Configuration Specifies the receiver timeout between 1 and 500.

AESWFTERROR-0000022: Unknown Dispose value %1.

errorRole Configuration Specifies valid dispose value FTP, CASmf, and MQSA.

AESWFTERROR-0000023: DatabaseFailureFatal true without SwiftLogPrefix specified.

errorRole Configuration Specifies SwiftLogPrefix.

Message Role Category Resolution

Page 254: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

236 | Appendix D Trace Messages

AESWFTERROR-0000024: Cannot create instance of schema LogicalReply.

errorRole Adapter Checks for the parameters in the Logical Reply class.

AESWFTERROR-0000025: Cannot create instance of schema NetworkReport.

errorRole Adapter Checks for the parameters in the Network class.

AESWFTERROR-0000026: Cannot create instance of schema.

errorRole Adapter Specifies the correct message format.

AESWFTERROR-0000027: No JDBCMessageSession specified.

errorRole Configuration Specifies JDBC parameters correctly.

AESWFTERROR-0000028: CASmf open failed %1.

errorRole Application Checks if CASmf is running.

AESWFTERROR-0000036: Unmarshal error %1.

errorRole Adapter Specifies a valid message format.

AESWFTERROR-0000037: Unknown event received by ReceiverSubscriber, type: %1

errorRole Adapter An obtained event is not a valid MDataEvent.

AESWFTERROR-0000038: Unknown event received by SenderSubscriber, type: %1

errorRole Adapter An obtained event is not a valid MDataEvent.

AESWFTERROR-0000039: Unknown event received by MessageSubscriber, type: %1

errorRole Adapter An obtained event is not a valid MDataEvent.

AESWFTERROR-0000040: WorkerThread halting.

errorRole Adapter Restarts the adapter and checks if it starts well.

AESWFTERROR-0000042: Error in encoding Swift message: %1

Message Role Category Resolution

Page 255: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Status Messages | 237

errorRole Adapter Specifies valid message format.

AESWFTERROR-0000043: Could not log outgoing Swift message %1 message %2.

errorRole Adapter Checks if the message is in correct format.

AESWFTERROR-0000045: Could not start SwiftAdapter % 1.

errorRole Adapter Checks in the repository and specifies the startup parameters correctly.

AESWFTERROR-0000046: Could not read recovery file %1.

errorRole Adapter Checks if the file exists.

AESWFTERROR-0000047: No ReceiveTimeout specified.

errorRole Adapter Specifies receive timeout parameter in the custom tab of the adapter instance.

AESWFTERROR-0000048: Invalid connection parameters specified for Log Database.

errorRole Database Specifies valid parameters for the database connectivity.

AESWFTERROR-0000049: Could not connect to Log database.

errorRole Database Specifies valid parameters for the database connectivity.

AESWFTERROR-0000050: % 1 MAPID not defined in DMAPID.DAT.

errorRole Configuration Specifies the MAPID that exists in the dmapid.dat.

AESWFTERROR-0000051: Could not read saved Swift message %1.

errorRole Adapter Restarts the adapter.

AESWFTERROR-0000052: Could not Stop Adapter % 1.

errorRole Adapter Specifies the message in the subject name in which the exit subscribers are listening.

AESWFTERROR-0000053: Exception generating MInstance %1.

errorRole Adapter Specifies the message format is correct.

Message Role Category Resolution

Page 256: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

238 | Appendix D Trace Messages

AESWFTERROR-0000054: Cannot log in coming Swift Message to database.

errorRole Database Checks if the database connectivity is made.

AESWFTINFO-0000013: Recovery file %1 %2 % 3.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWFTINFO-0000014: No logging to database specified.

infoRole Database Indicates a normal adapter operation. No action required.

AESWFTDEBUG-0000001: Control In the MainSwiftAdapter.

debugRole Adapter Not Applicable

AESWFTDEBUG-0000002: Swift Adapter's start calling Oninitialization function.

debugRole Adapter Not Applicable

AESWFTDEBUG-0000004: Activating all Publishers and Subscribers.

debugRole Adapter Not Applicable

AESWFTDEBUG-0000007: Started Worker thread for CASmf section.

debugRole Adapter Not Applicable

AESWFTDEBUG-0000008: Started FTP Specific Operation.

debugRole Adapter Not Applicable

AESWFTDEBUG-0000009: Started MQSA Operation.

debugRole Adapter Not Applicable

AESWFTDEBUG-0000010: Worker Thread Run method is invoked to send and receive messages from CASmf.

debugRole Adapter Not Applicable

AESWFTDEBUG-0000011: Sending Message to CASmf Interface.

debugRole Adapter Not Applicable

AESWFTDEBUG-0000012: Receiving Message from CASmf Interface.

Message Role Category Resolution

Page 257: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Status Messages | 239

debugRole Adapter Not Applicable

AESWFTDEBUG-0000013: Calling processmessage in Worker thread to process the received messages from CASmf.

debugRole Adapter Not Applicable

AESWFTDEBUG-0000014: Processing Logical Reply from the message obtained from CASmf.

debugRole Adapter Not Applicable

AESWFTDEBUG-0000015: Processing Network Report from the message obtained from CASmf.

debugRole Adapter Not Applicable

AESWFTDEBUG-0000016: Processing Swift Message from the message obtained from CASmf.

debugRole Adapter Not Applicable

AESWFTDEBUG-0000017: Publishing Swift Message.

debugRole Adapter Not Applicable

AESWFTDEBUG-0000018: Publishing Network Report.

debugRole Adapter Not Applicable

AESWFTDEBUG-0000019: Publishing Logical Reply.

debugRole Adapter Not Applicable

AESWFTDEBUG-0000020: In readFTPPRoperties, required info about User, password, host are obtained.

debugRole Adapter Not Applicable

AESWFTDEBUG-0000022: Invoking the FTPClient's handleInMessages function to send the messages out.

debugRole Adapter Not Applicable

AESWFTDEBUG-0000024: MQSA is listening to the swift message on the TIB.

debugRole Adapter Not Applicable

AESWFTINFO-0000016: ExitSubscriber received exit message.

infoRole Adapter Not Applicable

AESWFTERROR-0000055: SwiftSender: Could not decode Swift MInstance: % 1 , % 2 , % 3.

Message Role Category Resolution

Page 258: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

240 | Appendix D Trace Messages

errorRole Adapter Specifies the correct message format.

AESWFTERROR-0000056: %1, Could not send FTP outgoing Swift message: %2 %3

errorRole Adapter Specifies the FTP parameters are correct.

AESWFTERROR-0000057: Exception Generating AE SwiftInstance.

errorRole Adapter Checks for the message in the remote directory.

AESWFTERROR-0000058: Exception sending Report message to AE application.

errorRole Adapter Checks for the attributes of Report Message.

AESWFTERROR-0000060: Could not log outbound Swift message.

errorRole Adapter Messages are not in the expected format.

AESWFTERROR-0000061: No Persist file prefix provided.

errorRole Adapter Specifies the value for it when using FTP.

AESWFTERROR-0000062: Remote directory not specified.

errorRole Adapter Specifies the RemoteDirectory when using FTP.

AESWFTERROR-0000063: FTP transfer direction not specified.

errorRole Adapter Specifies the transfer direction when using FTP.

AESWFTERROR-0000064: No polling count specified for FTP transfer.

errorRole Adapter Specifies the polling count when using FTP

AESWFTERROR-0000065: Could not perform FTP operation.

errorRole Adapter Specifies that all required parameters for FTP are correct.

AESWFTERROR-0000066: Error %1

errorRole Adapter Common errors are thrown here.

AESWFTINFO-0000022: Got Data Event

Message Role Category Resolution

Page 259: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Status Messages | 241

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWFTINFO-0000023: Got Time out Event.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWFTINFO-0000024: Got Timer Event

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWFTINFO-0000025: Got Exception Event

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWFTINFO-0000026: Terminate

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWFTINFO-0000027: Receiversubscriber received event.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWFTINFO-0000028: Sendersubscriber received event.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWFTINFO-0000029: Tester published %1 messages.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWFTINFO-0000068: Adapter is publishing the AE Message in the TIB.

infoRole Adapter Indicates a normal adapter operation. No action required.

AESWFTINFO-1000001: State : %1

infoRole Adapter Indicates a normal adapter operation. No action required.

Message Role Category Resolution

Page 260: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

242 | Appendix D Trace Messages

AESWIFT_870002: Message Error.Error: %1 occurred while setting %2%3 in %4. Please check the format of the %5.

errorRole Message Checks the format of the status.

AESWIFT_920010: Subscription error. Subscription service received event with missing attribute %1 in class %2.

errorRole Message Checks if it is a valid schema.

AESWIFT_930002: Publication error. Publication service encountered error %1 while trying to create publish event with schema %2.

errorRole Message Checks the instance attributes for the Transmission Notification.

AESWIFT_870003: Message Error.Error: %1 occurred in the tester.

errorRole Message Checks if it is a valid message.

AESWIFT_870004: Message Error.Error: %1 occurred.Unknown event received by the Subscriber in the %2.

errorRole Message Not Applicable

Message Role Category Resolution

Page 261: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

| 243

Index

A

activateTraceRole() 171adapter components 11adapter features 15adapter instance fields

configuration tab 33general tab 38logging tab 42monitoring tab 45runtime connection tab 35specification tab 42startup tab 45

adapter operationsCASmf 82FTP 114MQSA 94

adapter servicespublication service 18subscription service 18

Advanced Configuration Options 69auto-discovery process 164

C

CASmfloopback testing on Solaris and AIX 90loopback testing on Windows 87overview 7recovery session 92schema 198

CASmf recovery session 92Concepts of TIBCO ActiveMatrix Adapter for

SWIFT 1CONFIG_HOME xvconfiguration task summary 32connecting with TIBCO resources xvii

connection factory typeQueue 52Topic 52

customer support xvii

D

deactivateTraceRole() 172delivery mode

durable 52non-durable 52non-persistent 52persistent 51

delivery reports table 156dynamic BIC update 207

E

ENV_NAME xv

F

FTPoverview 8schema 203start and stop 121

Page 262: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

244 | Index

G

general tabBIC code file (FI.dat) 40parse message 41validate advanced header 40validate BIC/BEI 39validate data types 39validate field format 41validate field-level semantics 39validate message structure 38validate message-level semantics 40validate qualifier code words 39validate structured narrative 40validation filter file (ValidationFilter.xml) 41

getActivityStatistics() 173getAdapterServiceInformation() 174getComponents() 175getConfig() 176getConfigInformation() 177getConfigProperties() 178getConnectionStatistics() 179getHostInformation() 180getPerfMonSetting() 196getRvConfig() 181getStatus() 182getThreadStatistics() 183getTraceSinks() 184getVersion() 185global variables 72

J

JMS connection typesQueue 15Topic 16

JMS session parameters 71

L

logging tablog file 43log info, debug, warning, error messages 43log to standard I/O 42use advanced logging 43

logical reply table 154

M

migrating current SWIFT standards 205monitoring by using TIBCO Hawk

overview 162the auto-discovery process 164

MQSAconfigure TIBCO adapter for MQSeries 101overview 8processing local reports 107schema 200testing 98

O

onUnsolictedMsg() 186

P

predefined global variables 74preRegisterListener() 187Processing Acknowledgment Messages 145processing acknowledgment messages 147publication service fields

configuration tab 54transport tab 55

Page 263: TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User s · PDF fileTIBCO ActiveMatrix Adapter for SWIFTNet - FIN Documentation . . ... Chapter 1 Concepts of TIBCO ActiveMatrix Adapter

TIBCO ActiveMatrix Adapter for SWIFTNet - FIN User’s Guide

Index | 245

Q

qualities of servicecertified delivery 15distributed queue 15reliable 15, 51

R

reconciling acknowledgment messages 148related documentation xivresetActivityStatistics() 188resetConnectionStatistics() 189reviewLedger() 190

S

session parametersJMS 71TIBCO Rendezvous 70

setDocumentDelay() 192setTraceSinks() 193stopApplicationInstance() 194support, contacting xviisupported microagent methods 169SWIFT messages 4SWIFT messages table 153SwiftCheck utility 76SWIFTNet - FINReceiver

AdminPublisher 48ExitSubscriber 48MessagePublisher 48TIBSubscriber 48

T

technical support xviiterminology and acronyms 2tester utility 29

TIB_ADSWIFT_HOME xvTIBCO ActiveMatrix BusinessWorks Plug-in for

SWIFTNet - FINBICPlusIBAN generation 143BICPlusIBAN valication 138limitations and recommendations 143SWIFTNet-FIN parser 129SWIFTNet-FIN renderer 131SWIFTNet-FIN router 127SWIFTNet-FIN schema loader 126

TIBCO Rendezvous sessions 70TIBCO_HOME xvtrace messages

overview 212status messages 217trace message fields 214

transmission reports table 158typographical conventions xv

U

unRegisterListener() 195using validation filters

filter groups 58filters 58path specification 59

W

wire format 52ActiveEnterprise message 53Rendezvous message 53XML message 53


Recommended