BEA SWIFT Adapter User Manual
BEA SWIFT Adapter User Manual

BEA SWIFT Adapter User Manual

Bea inc. swift adapter user's guide
Table of Contents

Advertisement

Quick Links

SWIFT Adapter
User's Guide
Version 3.5

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the SWIFT Adapter and is the answer not in the manual?

Questions and answers

Summary of Contents for BEA SWIFT Adapter

  • Page 1 SWIFT Adapter User’s Guide Version 3.5...
  • Page 2: Table Of Contents

    SWIFT ... 4 TERMINOLOGY ... 5 SWIFT CONFIGURATION ... 6 SWIFT ... 6 MESSAGE LIBRARY SWIFT ... 7 USTOM MESSAGES CREATING A SWIFT FORMAT ... 9 SWIFT F REATING A ORMAT ASED ON AN SWIFT F REATING A ORMAT FROM AN EMPTY MESSAGE FORMAT ENTERING THE SWIFT SPECIFICATION ...
  • Page 3 Adding Currency Code Validation ... 69 Adding Country Code Validation ... 69 Adding Time Offset Validation ... 70 Adding BIC validation... 70 Adding C05 validation... 72 Adding Decimal Validation ... 72 Adding Party Identification Validation ... 73 Specifying Party Identification Codes ... 73 EMOVING ALIDATIONS FROM A SWIFT EXTERNAL MESSAGE UI...
  • Page 4: Swift

    SWIFT S.W.I.F.T. SCRL is the abbreviation for Society for Worldwide Interbank Financial Telecommunication, Societé Coopérative à Responsibilité Limitée. SWIFT’s purpose is to provide technology-based communication services across all financial markets through member banks so that they can profitably meet their own and their end-customers’...
  • Page 5: Terminology

    Export a SWIFT Message Format Terminology Sequence Each message type contains zero, one or more sequences. A sequence is a group of related information made up of one or more fields and/or sub-sequences. A sequence may or may not be delimited. For delimiting a sequence use a start indicator and end indicator or start indicator alone.
  • Page 6: Swift Configuration

    SWIFT Configuration SWIFT field dictionary and message library are stored under <installation dir>\config\swift folder. This folder contains the following files and folders. QualifierList.csv List SWIFT qualifiers with description. SwiftField.xml Field dictionary for ISO15022 & ISO7754 user messages SwiftSystemField.xml Field dictionary for system and service messages format Directory contains all SWIFT messages.
  • Page 7: Custom Swift Messages

    Custom SWIFT messages Depending on your requirement you may have to customize the SWIFT messages or make minor modifications to it. One such case is GSCC SWIFT messages. If these customized messages are used often or across the enterprise, you may want to make use of the SWIFT message library feature to store the customized SWIFT messages.
  • Page 8 3. The exported message will be saved under a directory by the same name as the version. Once you have exported all the customized messages to this directory, you can make of copy this directory to all Designer installations as required. 4.
  • Page 9: Creating A Swift Format

    This detail is generally not important; but if you are manually editing the version (in say messages you already have) in XML’s remember to update the standard-version tag appropriately. The advantage of the above is that you have the same message library support for your customized SWIFT messages just like standard SWIFT messages.
  • Page 10: Creating Aswift Format Based On An Existing Swift Message Format

    Creating a SWIFT Format Based on an Existing SWIFT Message Format 1. Right-click the Cartridge node in the Designer. Select the New External Message menu item from the context menu to create a SWIFT external format. 2. In the New External Message dialog that appears enter the Transformation Name and select SWIFT from the External Message listbox .
  • Page 11 4. In the next dialog that appears you have various options to choose Header/Trailer, Validation and Edit options as shown in the following picture:...
  • Page 12 5. As seen in the above picture, you have the option to include specific Header/Trailer (SWIFT Input/SWIFT Output/SWIFT Input Output/FICC Header(custom) or no Header/Trailer) from the list box. (Note that if you choose SWIFT Input or SWIFT Output, the Basic Header and Application Header appearing in the Header section UI of the message are set as mandatory.
  • Page 13 7. Note that the Design Element UI tool bar buttons in the figure are disabled thereby not allowing the user to modify the format as we have chosen Read Only mode in the Edit options. 8. The Enabled column of the format table allows the user to pick from the optional fields, qualifiers and options for the format.
  • Page 14 Similarly to pick the options for a qualifier, select the qualifier in the table and select or deselect the check box in the SWIFT Field Qualifier Info panel below.
  • Page 15 To pick the options for a non-generic field, select the field in the table and select or deselect the check box in the Enabled column of the options displayed in the SWIFT Field Info (Non-Generic) panel below the table. See Also: Creating a SWIFT Format from an empty message format Entering the SWIFT Specification Exporting a SWIFT Message Format to Library...
  • Page 16: Creating Aswift Format From An Empty Message Format

    Creating a SWIFT Format from an empty message format 1. Right-click the Cartridge node in Designer and select the New External Message menu item from the context menu to create a SWIFT external format. 2. In the New External Message dialog that appears, enter the Transformation Name and select SWIFT from the External Message listbox.
  • Page 17 4. In the next dialog box that appears see that the “Validation Options” and “Edit Options” pane are disabled as they are not applicable in this case. You have the option to include specific Header/Trailer (SWIFT Input/SWIFT Output/SWIFt Input/Output/FICC Header(custom) or no Header/Trailer as shown in the following picture.
  • Page 18 5. After selecting the required Header/Trailer from the list box, click Finish button. 6. An empty message format is created as shown below.
  • Page 19: Entering The Swift Specification

    See Also: Creating a SWIFT Format based on an existing SWIFT message format Entering the SWIFT Specification Exporting a SWIFT Message Format to Library Entering the SWIFT Specification A SWIFT message is composed of sequences and fields. A sequence is a group of related information made up of one or more fields and/or sub-sequences.
  • Page 20: Swift Sequence

    Removing validations from a sub field SWIFT Sequence A Sequence is a group of related information, delimited in most of SWIFT message formats. However, there are a few formats, which have sequences without delimiters. The Designer provides for creating sequences with or without delimiters. Furthermore, the sequences with delimiters either have only the start delimiter, or both the start and end delimiters, depending on the format’s specification.
  • Page 21: Sequence With Start And End Delimiters

    -----| Note sequences A and B of this format. They have neither the start delimiter nor the end delimiter. To add such a sequence, see Add a SWIFT Sequence without Delimiters. See Also: Sequence With Start and End Delimiters Sequence With Start Delimiter Sequence With Start and End Delimiters Consider the message MT543.
  • Page 22: Sequence With Start Delimiter

    -----| End of Subsequence A1 Linkages M 16S End of Sequence A General Information Mandatory Sequence B Trade Details M 16R O 94B TRAD Place -----> …… …… …… Note that in the above format, the sequences A and A1 have the ‘Start of Block’ field 16R and the ‘End of Block’...
  • Page 23 Statu Tag Field Name Related Reference …… …… …… Mandatory Sequence B Transaction Details 15B New Sequence Trade Date 30V Value Date Exchange Rate …… …… …… Optional Sequence C Optional General Information 15C New Sequence 29A Contact Information …… ……...
  • Page 24: Adding Aswift Sequence

    Adding a SWIFT Sequence A sequence is a group of related information made up of one or more fields and/or sub-sequences. A sequence may or may not be delimited. Three types of SWIFT sequences can be added. They are Sequence Without Delimiters Sequence With Start and End Delimiters Sequence With Start Delimiter See Also:...
  • Page 25 3. Select None in Sequence Delimiter. Select the Mandatory and Repeating properties of the sequence as required. 4. For this case, the last section about the delimiters and their format is not required and hence disabled. Click OK. 5. The new sequence is added to the format as shown below.
  • Page 26: Adding A Swift Sequence With Start And End Delimiters

    See Also: Sequence Without Delimiters Adding a SWIFT Sequence with Start and End Delimiters Adding a SWIFT Sequence with Start Delimiter Adding a SWIFT Sequence with Start and End Delimiters 1. Click the Add New Sequence - SWIFT UI. 2. The SWIFT Sequence dialog appears. Enter the Sequence Name and Description.
  • Page 27 3. Select Block Delimited in Sequence Delimiter. Select the Mandatory and Repeating properties of the sequence as per the specification. 4. The Start Of Block and End Of Block text fields are automatically populated with values 16R and 16S and the corresponding formats are populated with value 16c when the Sequence Delimiter is specified in the step above.
  • Page 28: Adding A Swift Sequence With Start Delimiter

    See Also: Sequence With Start and End Delimiters Adding a SWIFT Sequence without Delimiters Adding a SWIFT Sequence with Start Delimiter Adding a SWIFT Sequence with Start Delimiter 1. Click the Add New Sequence button - SWIFT UI. 2. The SWIFT Sequence dialog appears. Enter the Sequence Name and Description.
  • Page 29: Adding Aswift Field

    3. Select New Sequence Indicator in Sequence Delimiter. Select the Mandatory and Repeating properties of the sequence as per the specification. 4. The Start Of Block text field is automatically populated with value 15A when the Sequence Delimiter is specified in the step above. This can be changed to your requirement.
  • Page 30: Adding A New Generic Field

    Non Generic Field- Unlike a generic field, is used for one purpose only. See Also: Terminology Adding a new Generic Field Adding a Non-Generic Field Updating a SWIFT Field Removing a SWIFT Field Customize Field Adding validations for a sub-field Removing validations from a sub field Adding Copy of Fields Adding a SWIFT Sequence...
  • Page 31 3. Enter the description of the field in the Description text field. 4. For customizing a field, refer section Add the Options for the field. 6. Make sure the Generic Field check box is selected. Add the Qualifiers and map them to the Options 8.
  • Page 32: Adding Field Options

    See Also: Adding a Non-Generic Field Adding Field Options 1. Click the Add New Options button dialog. 2. A new row is added in the options table. Enter the Option, its format, specification and description in the respective columns. 3. When a row is added, the option name by default is populated in the alphabetical order, considering the option name of the last row.
  • Page 33: Entering An Option Format

    4. For a generic field, the checkbox in the Selected column is not enabled at this point, as qualifiers are not yet added. Only on adding the qualifiers the column is enabled, so as to allow the mapping of the qualifier with the Option. See Qualifiers and Associating them with See Also: Adding a New Generic Field...
  • Page 34 maximum length Fixed length nn*nn Maximum number of lines times maximum line length Examples = up to 2 digits = always 3 letters upper case only 4*35x = up to 4 lines of up to 35 characters each 16-64h = at least 16 and up to 64 hexadecimal digits 2.
  • Page 35: Entering An Option Specification

    3. The formats within the brackets ( ) should be treated as a single unit. In the following figure, note option P. The format is :4!c(//4!a2!a2!c[3!c]). The ( ) brackets separates :4!c from the rest, thus implying only two sub-fields with formats 4!c and //4!a2!a2!c[3!c].
  • Page 36: Removing Field Options

    Specification (Sub-Field1) (Sub-Field2) (Sub-Field2) In this format pattern, the specification for subfields B and C are the same. ie, Sub-Field2. If this pattern is entered, only one instance of Sub-Field2 will be created, though the format indicates 3 subfields, which is not correct. In order to avoid this, the specification of the subfields should be made distinct.
  • Page 37: Adding Qualifiers And Associating Them With Options

    The option is removed from the options table. If there is any qualifier associated with the removed option, in the case of a generic field, map it to the correct option or remove it. See Also: Adding a New Generic Field Adding Qualifiers and Associating them with Options 1.
  • Page 38 3. Select the required Qualifier from the drop-down list as shown above. The Description is automatically populated on selecting the Qualifier. 4. Select the Presence of the Qualifier among O (Optional), M (Mandatory), OR (OR). See Specifying OR option for a Qualifier Repeating checkbox if the qualifier is repeating as per the specification.
  • Page 39 5. Map the options to the qualifier. To map, select the qualifier row. Select the options that apply to this qualifier by selecting the checkbox in the Selected column of the required options, as shown below. 6. On selecting the options, they appear in the Options column in the qualifier table.
  • Page 40: Specifying Or Option For A Qualifier

    Specifying OR Option for a Qualifier The OR option, allows grouping of qualifiers. This is useful when one of the many possible qualifiers can appear for a field option as per the specification. For example, field 95a allows one among a group of qualifiers BUYR, DEAG, DECU, etc. Follow the steps given below to specify the OR option, 1.
  • Page 41: Adding A Non-Generic Field

    Adding a Non-Generic Field A Non-Generic field, unlike a generic field, is a discrete data item used for one purpose only. To add a non-generic field to a message format, follow the steps given below. 1. Click the Add New SWIFT Field button Format - SWIFT UI.
  • Page 42 7. Select the required options by selecting the check box in the Selected column of the options table. Note that this column is enabled only on step 5. 8. For a field existing already, the description and Options are automatically populated when the field is selected from the Tag list.
  • Page 43: Specifying Field Definition And Usage

    Specifying Field Definition and Usage A field’s definition and usage can be specified by clicking the button in the Create Field or Modify Field dialog. For example field definition and usage of field ‘23G’ in MT519 can be specified as shown below. See Also: Adding a new Generic Field Adding a Non-Generic Field...
  • Page 44 2. The selected row has a simple format and specification. Hence there is no ambiguity for Designer in mapping the format with the specification. Designer shows the correct mapping in this case 3. But in complex cases, where there is ambiguity in resolving the format and specification of sub-fields, Designer is clueless and the mapping needs to be done by the user.
  • Page 45 5. Note that there is no one-to-one correspondence between the Format and the Specification. In the above figure, all the formats that have no specification actually belong to BIC/BEI sub-field. Hence in order to correct the mapping, those formats have to be merged for the specification BIC/BEI. 6.
  • Page 46 8. The format of option P in options table now looks like 9. Note the ( ) brackets added in the format after merging. These brackets can also be entered in the format directly, without going through the Fields Format dialog.
  • Page 47: Representing Complex Formats In Designer

    13. The format now looks correct as below. Click OK. Use of brackets ( ) around a set of (two or more) formats indicates that they should be treated as a single unit. Consider the format:4!c(//4!a2!a2!c[3!c]). The ( ) brackets separates :4!c from the rest, thus implying only two sub-fields with formats 4!c and //4!a2!a2!c[3!c].
  • Page 48 changing the format, the corresponding specification should also be changed to reflect the format as shown in the following cases. Conventions A, B refer to independent sub-fields. (e.g.) in the format ([ISIN1!e12!c])CRLF[4*35x] A is [ISIN1!e12!c] and B is [4*35x] A1, A2 refer to parts of a sub-field. (e.g.) if A is [/1!a][/34x] then A1 is [/1!a] and A2 is [/34x] SEP means SEPERATOR.
  • Page 49 Field Format ([ISIN1!e12!c])CRLF[4*35x] Specification (Identification Of Security)(Description Of Security) Format in (ISIN1!e12!c)([CRLF4*35x]) | 4*35x Designer Specification (Identification Of Security)(Description Of Security) | in Designer (Description Of Security) Note that the field specification is also changed to match the format. Present in Message Formats: MT541, MT543, MT524, MT521, MT531, MT520, MT522, MT523, and MT530 Format Pattern Representation...
  • Page 50 Example Field 82a – OPTION A Format [/1!a][/34x]CRLF4!a2!a2!c[3!c] Specification (Party Identifier)(BIC) [/1!a[/34x]CRLF])(4!a2!a2!c[3!c]) | Format in Designer ([/34xCRLF])(4!a2!a2!c[3!c]) Specification (Party Identifier)(BIC) | (Party Identifier)(BIC) in Designer Present in Message Formats: MT521, MT531, MT520, MT522, MT523, MT530 Other Fields Having Similar Pattern: 82a - Options A, D 83a - Options A, D 88a - Options A, D...
  • Page 51 In this format pattern the separator does not belong to either of the two formats (A and B). In this case, format A is further divided into two parts A1 and A2. The separator appears only if either one or both of A1 and A2 is/are present and format B is also present.
  • Page 52 Number of lines that range between 1 and maximum number possible is present in format A along with format B. Maximum number of lines that is possible is present in format A along with format B. In this format pattern, format A can have multiple lines in its data, which are separated by CRLF.
  • Page 53: Adding Copy Of Fields

    Adding Copy of Fields In some SWIFT messages a set of fields need to be treated as single entity. For e.g. in common group messages (MTnxx), a copy of the fields that occurred in the original message may occur at the end. The entire set should be treated as a single field.
  • Page 54 From the above diagram it can be seen that the ‘Copy of Fields’ gets added as the last field in the message with the occurrence property. Note: The ‘Copy of Fields’ of fields should be the last field in the message. It should be a top-level field.
  • Page 55: Updating Aswift Field

    Updating a SWIFT Field 1. Select the field to be modified in the External Format - SWIFT UI and click the Modify SWIFT Field button in the toolbar. 2. The Modify Field dialog appears with the selected field in the Tag drop-down box.
  • Page 56 3. The options available for the field are populated in the options table, with the apt options selected. Add any missing option if needed, refer Select the required options. 4. For a generic field, the Generic Field check box appears checked and the qualifiers are populated in the qualifiers table with the properties set.
  • Page 57 6. Click the Remove button to remove the selected field from the Tag list, subsequently from the External Format - SWIFT UI. 7. To change the suffix, refer the section Customize Field. See Also: Adding a SWIFT Field Adding a SWIFT Sequence Removing a SWIFT Field...
  • Page 58: Customize Field

    Customize Field Consider the message format MT101. Status Tag Field Name Mandatory Sequence A General Information Sender's Reference Customer Specified Reference 28D Message Index/Total Instructing Party Ordering Customer Account Servicing Institution ……. ……. ……. Note that the field 50a appears twice consequently. When such a data format is entered in the designer and validated, the designer shows an error that the field is duplicated.
  • Page 59 2. In the Create Field/Modify Field dialog that appears, click the Customize button. 3. In the Customize Field dialog that appears enter the suffix and click OK. 4. Click OK in the Create Field/Modify Field dialog. Now the External Format - SWIFT UI shows the field with the suffix entered.
  • Page 60: Removing Aswift Field

    See Also: Adding a new Generic Field Adding a Non-Generic Field Removing a SWIFT Field Removing a SWIFT Field 1. Select the fields to be removed in the External Format - SWIFT UI and click the Remove Selected Fields button in the toolbar. The fields are removed from the format.
  • Page 61: Adding Validations For A Sub-Field

    This removes the field from the Tag list. See Also: Adding a SWIFT Field Updating a SWIFT Field Adding a SWIFT Sequence Adding validations for a sub-field While adding a swift field you can also add validations for the sub-fields of the swift field.
  • Page 62 2. The Swift Field Validations dialog will be displayed. 3. In the top tool bar select the button to add a new validation. 4. The default type will be ‘CODE’. Click the ‘Type’ column. The list of validation types will be displayed. Select the appropriate validation type.
  • Page 63: Specifying Properties Common For All Validations

    Note: For the ‘Format Option’ sub field the validation button will not be enabled. If a sub-field has validations the text of the validations button will be ‘Red’ in color. If a sub-field does not have validation the text will be in normal color. You can click the ‘...
  • Page 64: Specifying Error Code

    Specifying Error Code Specify the error code in the ‘Error Code’ column. Specifying Field Options In the field options list only those options that are applicable to the selected sub field will be displayed. By default all the displayed options will be selected when you add a validation.
  • Page 65: Specifying Comment

    Specifying Comment Comment for the validation can be specified in the comment text area. This is an optional property. See Also: Adding validations for a sub-field Adding Code validation Adding Code validation Code validation is applicable in cases where a field’s value should be one of a set of predefined values.
  • Page 66: Removing Codes

    For example in MT519 sub-field ‘Function’ of field 23G must contain the following codes CANC and NEWM They can be added as shown below Pasting Codes From Clipboard You can also use the button to paste a set of codes from clipboard. Copy a set of codes along with their detail names and description from the swift standard documentation to an application like Excel.
  • Page 67: Adding T26 Validation

    Adding T26 Validation T26 validation is applicable in cases where a field’s value should not start or end with a slash ‘/’ and not contain two consecutive slashes ‘//’. 1. Add a new validation. 2. Select ‘Type’ as ‘T26’ in the ‘Type’ column. 3.
  • Page 68: Adding Date Validation

    In MT514 sub-field ‘Rate’ in field 92A has a validation that when Sign is present, Rate must not be zero. For this field, T14 validation can be added as shown below. See Also: Specifying properties common for all validations Adding validations for a sub-field Removing validations from a sub field Adding Date Validation Date validations are applicable for Date/Time fields, whose value should be...
  • Page 69: Adding Currency Code Validation

    Adding Currency Code Validation This validation is to verify that the currency code specified for a field is a valid ISO 4217 currency code. 1. Add a new validation. 2. Select ‘Type’ as ‘Currency Code’ in the ‘Type’ column. 3. The error code will be automatically set as ‘T52’. You need not change it. 4.
  • Page 70: Adding Time Offset Validation

    See Also: Specifying properties common for all validations Adding validations for a sub-field Removing validations from a sub field Adding Time Offset Validation Time Offset validations are applicable for Time fields, whose value should be expressed, in a particular format HHMM and whose value should be within a particular range.
  • Page 71 3. The error codes will be automatically set as ‘T27, T28, T29, T45’. You need not change it. 4. Specify the qualifiers, field options, null field and comment properties as specified earlier. The description and usage for this validation type will be displayed at the bottom. See Also: Specifying properties common for all validations Adding validations for a sub-field...
  • Page 72: Adding C05 Validation

    Adding C05 validation This validation is to verify that the BIC specified for a field is not a BEI, ie must not be of subtype BEID, MCCO, TESP or TRCO 1. Add a new validation. 2. Select ‘Type’ as ‘C05’ in the ‘Type’ column. 3.
  • Page 73: Adding Party Identification Validation

    In MT567, sub-field ‘Amount’ in field 19A has a validation that the number of digits following the comma must not exceed the maximum allowed for the specified currency. For this field, Decimal validation can be added as shown below. See Also: Specifying properties common for all validations Adding validations for a sub-field Removing validations from a sub field...
  • Page 74: Removing Validations From A Sub Field

    Removing Codes You can use the ‘ ’ button to remove an existing Party Identification code. Note that atleast one code should be present for a Party Identification Code validation. Note: You can use the ‘ ’ and ‘ See Also: Specifying properties common for all validations Adding validations for a sub-field Removing validations from a sub field...
  • Page 75 See Also: SWIFT External Format UI Creating a SWIFT Format Entering the SWIFT Specification...
  • Page 76: Swift External Format Ui

    SWIFT External Format UI The External Format – SWIFT UI has 3 tabs – Header, Data and Trailer to represent the header block, text block and trailer block of the SWIFT message. The header and trailer types have to be specified while creating the external format. The header/trailer fields cannot be modified or removed.
  • Page 77: Swift Input Header/Trailer

    SWIFT Input Header/Trailer When you choose this option, the Header and Trailer panel has the following fields for a SWIFT external message format.
  • Page 78 The Section Properties panel in the Header panel shows the properties of the header block, such as whether it is Repeating and Optional. The Properties panel shows the properties of a field (shown when a field is selected). It shows whether the field is Optional and it’s Length.
  • Page 79: Swift Output Header/Trailer

    The field and section properties displayed are not editable. See Also: SWIFT Output Header/Trailer SWIFT Input/Output Header/Trailer FISC Header Format Options Swift User Message (Data) SWIFT Output Header/Trailer When you choose this option, the Header and Trailer panel has similar fields as that of a SWIFT Input Header/Trailer except for the Application Header block in Header section which has different set of fields as shown below.
  • Page 80: Swift Input/Output Header/Trailer

    Swift User Message (Data) SWIFT Input/Output Header/Trailer When you choose this option, the Header and Trailer panel has similar fields as that of a SWIFT Input Header/Trailer except for the Application Header block in Header section which is divided as Application Header Input and Application Header Output as shown below.
  • Page 81 The Section Properties panel in the Header panel shows the properties of the header block, such as whether it is Repeating and Optional. The Properties panel shows the properties of a field (shown when a field is selected). It shows whether the field is Optional and it’s Length. For fields of User Header block and Trailer, additionally the Tag of the field is shown.
  • Page 82: Fisc Header

    The field and section properties displayed are not editable. See Also: FISC Header Format Options Swift User Message (Data) FISC Header When you choose this option, the Header and Trailer panel has the following fields for a SWIFT input/output message format.
  • Page 83: Swift Format Options

    The trailer has no fields and is blank in this case. Field properties Optional and Length are displayed in the Properties panel for the header. Note: When you choose the option ‘None’, the Header and Trailer sections will be empty. See Also: SWIFT Input Header/Trailer SWIFT Output Header/Trailer...
  • Page 84 The same set of Header/Trailer options that were available during message creation is available here too. (Custom Header/Trailer corresponds to FICC Header). You can set the maximum length for the message by entering the length value in the ‘Max Length’ text box. The value specified should be an integer value. Max Length accepts values in the range ‘0 to 9999’...
  • Page 85: Swift User Message (Data)

    Swift User Message (Data) The External Format - SWIFT User message (Data) UI looks as below. The message format is shown in the table at the top, and a panel at the bottom shows the properties of the row selected in the table. The properties panel dynamically changes as the row selected in the table changes.
  • Page 86 The sub-fields displayed under the fields are a collection of sub-fields in the options selected while creating or modifying the field (using the Create Field or Modify Field dialog). ie, in the above figure the qualifier BUYR lists the sub-fields of the selected options P, Q, R only though other options are also available (See figure below).
  • Page 87: Swift Sequence Info

    Note that the sub-fields of a generic field are displayed under the qualifier in the External Format - SWIFT UI, similar to a sequence or field. This is because, though the qualifier is also a sub-field, it distinguishes the generic field. Hence the rest of the sub-fields are shown under it.
  • Page 88: Swift Field Info (Generic)

    See Also: SWIFT Field Info (Generic) SWIFT Field Qualifier Info SWIFT Field Info (Non-Generic) SWIFT Sub Field Info Adding a SWIFT Sequence SWIFT Field Info (Generic) When a generic field is selected in the External Format - SWIFT UI, the bottom panel shows the properties of the field as below.
  • Page 89: Swift Field Qualifier Info

    SWIFT Field Qualifier Info When a qualifier of a generic field is selected in the External Format - SWIFT UI, the bottom panel shows the properties of the qualifier. The check boxes Repeating and Optional show the qualifier properties. The Options that are associated with the qualifier are shown in a table.
  • Page 90: Swift Field Info (Non-Generic)

    SWIFT Field Info (Non-Generic) When a non-generic field is selected in the External Format - SWIFT UI, the bottom panel shows the properties of the field as shown below. The check boxes Repeating and Optional show the field properties. The Options that are associated with the field are shown in a table along with their Format and Specification.
  • Page 91: Swift Sub Field Info

    SWIFT Sub Field Info For a sub-field of a field (generic or non-generic) selected in the External Format - SWIFT UI, the bottom panel looks as shown below. Sub-field Info (Generic Field)
  • Page 92: System/Service Message

    Sub-field Info (Non-Generic Field) The SWIFT Sub Field Info panel shows the sub-field’s Format, whether it is Optional and the Option in which it occurs. For each option (if the sub-field is specified in more than one option), the sub-field details are shown in separate rows. Validations can be added by clicking the ‘Validations’...
  • Page 93 4. Click ‘Next’. In the next dialog box select the header type required and the message type. The ‘Message Type’ combo box lists the message types. The types of messages are ‘User’, ‘System’ and ‘Service’. To create a System message select the type as ‘System’.
  • Page 94: Creating A Swift System/Service Format Based On An Existing Swift Message Format

    5. Click ‘Finish’ to create the System/Service message. See Also: Creating a SWIFT System/Service Format Based on an Existing SWIFT Message Format Adding a System Field Adding a Group Creating a SWIFT System/Service Format Based on an Existing SWIFT Message Format 1.
  • Page 95 3. In the New Swift Message Format dialog that appears, select an existing format based on which the new format is to be created. Select Create based on selected format radio button. Click Next. 4. In the next dialog that appears you have various options to choose Header/Trailer, Validation and Edit options.
  • Page 96: Adding A System Field

    See Also: Creating an empty Service/System message format Adding a System Field Adding a Group Adding a System Field A system field can be either A simple field. A field that does not have any sub-fields. For e.g. field ‘swift- address’...
  • Page 97 3. You can specify the min/max occurs of the field in this dialog. If the field is non- repeating the field will be added as a simple field. In case a simple field is repeating select the max occurs accordingly. In this case the field will be added as a section.
  • Page 98 5. You can change the optional property of the field in the ‘System Field Info’ panel. In some cases the same field may be present twice in the message. The name of the field can be changed in such cases. The description of the field can also be changed.
  • Page 99: Adding A Complex Field

    7. The min/max Occurs, description and field name can be changed. See Also: Adding a Complex Field Fields Separated by OR/AND Adding a Group Adding a Complex Field A complex field consists of several sub-fields. For e.g. field ‘mir’ (tag 106) has the following format ‘(6!n)(4!a2!a2!c1!c)(3!c)(4!n)(6!n)’...
  • Page 100: Fields Separated By Or/And

    3. The field can be set as optional/repeating by specifying values for ‘min/max occurs’ in the ‘System Field Info Panel’. In case the same field is present twice in the message, the name of the field can be changed in the ‘Field Name’ column. Please note that the name of sub-fields cannot be changed.
  • Page 101: Adding A Group

    3. If ‘AND’ is present between the fields and the first field is optional, enter the fields as optional. Additional validation for the presence of fields needs to be done separately. See Also: Adding a Simple Field Adding a Complex Field Adding a Group Adding a Group 1.
  • Page 102: Deleting A Field/Group

    Note: ‘Choice’ is not supported in case of groups. The groups added are treated as sequence. So while adding an OR group, make sure that it is added as an optional group. Validations to check the presence of the groups need to be done separately.
  • Page 103: Specifying Validations For A Field

    Adding a System Field Adding a Group Specifying Validations for a Field In case where validation needs to be done for the value of a field, it can be specified along with the field definition. The entry for field ‘msg-priority’ (tag 104) is shown below.
  • Page 104: Expanding/Collapsing Swift Fields

    In some cases validation may need to be specified for a ‘sub-field’ of a field. For e.g. for field ‘mir’ (tag 106) validation needs to be done for sub-field ‘date’. It is specified as shown below <SwiftSystemFieldDef Name="mir" Tag="106"> <Format>(6!n)(4!a2!a2!c1!c)(3!c)(4!n)(6!n)</Format> <Specification>(date)(lt-identifier)(branch-code)(session- number)(isn) </Specification>...
  • Page 105: Expanding Fields

    Right click the SWIFT External Format UI table and select ‘Expand’ menu item. You can select ‘Expand/Collapse’ menu items to expand/collapse SWIFT fields. Expanding Fields Select the ‘Expand’ menu item. Select ‘All’ sub menu item. All fields including sequences, fields and qualifiers will be expanded.
  • Page 106: Exporting A Swift Message Format To Library

    Select ‘Qualifiers’ sub menu item. All expanded qualifiers will be collapsed. See Also: SWIFT External Format UI Exporting a SWIFT Message Format to Library Exporting a SWIFT Message Format to Library A SWIFT message format once fully entered in Designer can be saved so that it is available for creating other formats depending on it.
  • Page 107: Exporting A Swift Message Format

    3. The SWIFT message format is saved as XML file in the location <installation dir>\config\swift\format in the given Format Name. 4. SWIFT Formats saved this way are available for creating formats in future. Refer Creating a SWIFT Format based on an existing SWIFT message See Also: Creating a SWIFT Format from an empty message format Exporting a SWIFT Message Format...
  • Page 108 SWIFT message format can also be saved using the usual export method, allowing to save the format in XML, HTML and TPLUS formats. 1. To save a SWIFT format, select the SWIFT format node in the Explorer and choose the context menu Export…. 2.
  • Page 109: Importing A Swift Message Format

    4. The SWIFT format is saved in the location with the file name mentioned. See Also: Sample Exported HTML File Importing a SWIFT Message Format Importing a SWIFT Message Format SWIFT message format saved using the export method, can be imported. This is supported in XML and TPLUS formats.
  • Page 110: Sample Exported Html File

    The message format in the file is imported. See Also: Exporting a SWIFT Message Format Sample Exported HTML File A sample of the SWIFT message format exported in HTML: MT543In SCOPE This message is sent by an account owner to an account servicer (account servicing institution).
  • Page 111 3. pre-advise the account servicer of a forthcoming deliver against payment instruction (the function of the message is PREA). The instruction may be linked to other settlement instructions, eg, for a turnaround or back-to-back, or other transactions, eg, foreign exchange deal, using the linkages sequence.
  • Page 112 Status Qualifier LINK -----| End Of Sequence A1 Linkages End Of Sequence A General Information Mandatory Sequence B Trade Details …. ….. Field Specifications Field 16R: Start of Block FORMAT Option R PRESENCE Mandatory Field 20C: Reference: Sender's Reference FORMAT Option C (Qualifier) (Reference) PRESENCE...
  • Page 113 Mandatory QUALIFIER Order Qualifier SEME Field 23G: Function of the Message FORMAT Option G (Subfunction) PRESENCE Mandatory Field 98a: Date/Time: Preparation Date/Time FORMAT Option A Option C PRESENCE Optional QUALIFIER Order Qualifier PREP See Also: Exporting a SWIFT Message Format Options 4!c[/4!c] :4!c//8!n...

Table of Contents

Save PDF