BEA SWIFT Adapter, User Manual

Page 1: ...SWIFT Adapter User s Guide Version 3 5 ...

Page 2: ...Field Options 32 Entering an Option Format 33 Entering an Option Specification 35 Removing Field Options 36 Adding Qualifiers and Associating them with Options 37 Specifying OR Option for a Qualifier 40 Adding a Non Generic Field 41 Specifying Field Definition and Usage 43 Mapping Formats with Specification Sub fields 43 Representing Complex Formats in Designer 47 ADDING COPY OF FIELDS 53 UPDATING...

Page 3: ...e Info 87 SWIFT Field Info Generic 88 SWIFT Field Qualifier Info 89 SWIFT Field Info Non Generic 90 SWIFT Sub Field Info 91 SYSTEM SERVICE MESSAGE 92 Creating an empty Service System message format 92 Creating a SWIFT System Service Format Based on an Existing SWIFT Message Format 94 Adding a System Field 96 Adding a Simple Field 96 Adding a Complex Field 99 Fields Separated by OR AND 100 Adding a...

Page 4: ...s because of standardization of messages These include automation reduced risk of errors and misunderstandings reduced operating costs improved productivity increased efficiency in processing of messages routing and preparation faster and more cost effective account reconciliation and the ability to maintain more comprehensive management information SWIFT messages are represented by a three digit ...

Page 5: ...be either discrete non generic or generic Generic Field A generic field is used to describe groups of business data that are common throughout the messages It is then made unique by the addition of a qualifier Generic fields allow for the consistent identification of data in a logical and structured way Each generic field will always have the same meaning across all sensitive messages Non Generic ...

Page 6: ...red to as the SWIFT message library Messages of each version are stored as XML in a separate directory with the same name as the version For instance SRG 2008 messages are stored under the directory config swift format SRG 2008 This scheme allows you to manage multiple versions of SWIFT messages side by side For instance you can have MT101 xml under both SRG 2007 and SRG 2008 folders When you crea...

Page 7: ...rprise you may want to make use of the SWIFT message library feature to store the customized SWIFT messages 1 Since the customized messages are not the same as the original SRG messages choose a different version name for them For instance GSCC SRG 2008 can be used as the version name for SRG 2008 messages customized for GSCC 2 When you export the modified messages using the Save SWIFT Message For...

Page 8: ...customized messages to this directory you can make of copy this directory to all Designer installations as required 4 Note that the version name will also be included in the message definition XML as shown below xml version 1 0 encoding UTF 8 SwiftMessageFormat name MT502 standard version GSCC SRG 2008 standard version ...

Page 9: ...sequences and fields are available for the newly created format Though the mandatory elements cannot be changed the user has the option of enabling or disabling the optional sequences and fields as per requirement The existing SWIFT formats are available as XML files in the location installation dir config swift format When using an empty message format the user has to add each sequence and field ...

Page 10: ...ext 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 Click OK 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 ...

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: ...t the Basic Header and Application Header appearing in the Header section UI of the message are set as mandatory The Header Trailer fields cannot be modified removed from UI You have the option to include or not to include validations You also have the option to create the message format in Read Only mode or editable mode After selecting the required options click Finish button 6 The new format is...

Page 13: ...ns 8 The Enabled column of the format table allows the user to pick from the optional fields qualifiers and options for the format By default all the optional entities are enabled To enable a qualifier select the field in the format table and select or deselect the check box in the Enabled column for the qualifiers displayed in the SWIFT Field Info Generic panel below the table ...

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: ...d 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: ... 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 Click OK 3 In the New Swift Message Format dialog that appears select Create empty message format radio button Click Next ...

Page 17: ...clude specific Header Trailer SWIFT Input SWIFT Output SWIFt Input Output FICC Header custom or no Header Trailer as shown in the following picture 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 The Header Trailer fields cannot be modified removed from UI ...

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: ...lated information made up of one or more fields and or sub sequences A field may be either generic or non generic The user can construct a SWIFT message in the External Format UI by adding sequences fields and specifying properties for them See Also Terminology SWIFT External Format UI SWIFT Sequence Adding a SWIFT Sequence Adding a SWIFT Field Updating a SWIFT Field Customize Field Removing a SWI...

Page 20: ...art and end delimiters depending on the format s specification An example of each of the three cases is as follows See Also Sequence Without Delimiters Sequence With Start and End Delimiters Sequence With Start Delimiter Sequence Without Delimiters Consider the message MT101 An extract of the format is given below Status Tag Field Name Content Options Mandatory Sequence A General Information M 20 ...

Page 21: ...e MT543 An extract of the format is given below Status Tag Qual ifier Generic Field Name Detailed Field Name Content Options Mandatory Sequence A General Information M 16R Start of Block GENL M 20C SEM E Reference Sender s Reference 4 c 16x Repetitive Optional Subsequence A1 Linkages M 16R Start of Block LINK O 22F LINK Indicator Linkage Type Indicator 4 c 8c 4 c O 13A LINK Number Identification L...

Page 22: ...ve the Start of Block field 16R and the End of Block field 16S to indicate a sequence To add such a sequence see Adding a SWIFT Sequence with Start and End Delimiters See Also Sequence Without Delimiters Sequence With Start Delimiter Sequence With Start Delimiter Consider the message MT300 An extract of the format is given below Statu s Tag Field Name Content Options Mandatory Sequence A General I...

Page 23: ...e 12d Optional Sequence C Optional General Information M 15C New Sequence CrLf O 29A Contact Information 4 35x Note that the above message has the start indicator field 15X New Sequence for the sequences A B C etc But there is no end indicator To add such a sequence see Adding a SWIFT Sequence with Start Delimiter See Also Sequence Without Delimiters Sequence With Start and End Delimiters ...

Page 24: ...th Start and End Delimiters Sequence With Start Delimiter See Also Adding a SWIFT Sequence without Delimiters Adding a SWIFT Sequence with Start and End Delimiters Adding a SWIFT Sequence with Start Delimiter Adding a SWIFT Field Adding Copy of Fields Adding a SWIFT Sequence without Delimiters 1 Click the Add New Sequence button in the toolbar of the External Format SWIFT UI 2 The SWIFT Sequence d...

Page 25: ...ct 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: ...nd End Delimiters Adding a SWIFT Sequence with Start Delimiter Adding a SWIFT Sequence with Start and End Delimiters 1 Click the Add New Sequence button in the toolbar of the External Format SWIFT UI 2 The SWIFT Sequence dialog appears Enter the Sequence Name and Description ...

Page 27: ...ulated with values 16R and 16S and the corresponding formats are populated with value 16c when the Sequence Delimiter is specified in the step above They can be modified if required 5 Enter the code In case of block delimited sequence only if you give Code you will be able to add the sequence so Code is mandatory not optional in the Code text field Click OK 6 The sequence is added to the format as...

Page 28: ...ce without Delimiters Adding a SWIFT Sequence with Start Delimiter Adding a SWIFT Sequence with Start Delimiter 1 Click the Add New Sequence button in the toolbar of the External Format SWIFT UI 2 The SWIFT Sequence dialog appears Enter the Sequence Name and Description ...

Page 29: ... Of Block and Code are not relevant for this case and hence disabled Click OK 5 The sequence is added to the format as in the previous cases See Also Sequence With Start Delimiter Adding a SWIFT Sequence without Delimiters Adding a SWIFT Sequence with Start and End Delimiters Adding a SWIFT Field Two types of SWIFT fields can be added in the SWIFT External Format UI Generic Field It is used to des...

Page 30: ... Field Generic fields are used to describe the groups of business data that are common throughout the messages A generic field value always starts with a colon followed by a Qualifier of format 4 c followed by zero or more sub fields To add a generic field to the format follow the steps given below 1 Click the Add New SWIFT Field button in the toolbar of the External Format SWIFT UI The Create Fie...

Page 31: ...p them to the Options of the field 8 For a field existing already the description and Options are automatically populated when the field is selected from the Tag list But the Qualifiers have to be added each time a field is added to the message format 9 Click OK The field is added to the format as found in the External Format SWIFT UI Note that the field shows a unique collection of subfields of t...

Page 32: ...at 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 For the first time it is populated as A This can be changed as required To know how to enter the format refer the section Entering an Option Format To enter the specification refer Entering an Option Specifica...

Page 33: ...Adding Qualifiers and Associating them with Options See Also Adding a New Generic Field Entering an Option Format 1 The following table shows how to specify the length of a field and the characters allowed while specifying the format for a field A few examples are also given at the end of the table Restrictions on Length Types of Characters Allowed nn nn nn Maximum length Minimum and n a Digits on...

Page 34: ...mum number of lines times maximum line length e Blank space d Decimal format Examples 2n up to 2 digits 3 a 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 Use of square brackets around the format of a particular subfield indicates that the subfield is optional within that field For example in the following figur...

Page 35: ...ways starts with a colon followed by a Qualifier of format 4 c followed by zero or more sub fields There is no such rule for a non generic field See Also Adding a New Generic Field Entering an Option Specification The specification of a field should describe the field s format and is given as a list of its constituent subfields Each sub field is separated from the next by using the brackets For ex...

Page 36: ...r subfields B and C This is shown in the following example Example Field 69a OPTION A Format 4 c 8 n 8 n Specification Qualifier Date Date Format in Designer 4 c 8 n 8 n Specification in Designer Qualifier Start Date End Date Field 69a present in message format MT564 refers to Period Its two subfield specifications Date are changed to imply their meaning as Start Date and End Date See Also Adding ...

Page 37: ...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 Click the Add New Qualifier button in the Create Field dialog 2 A new row is added to the qualifiers table ...

Page 38: ...ption 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 to specify OR presence Also select Repeating checkbox if the qualifier is repeating as per the specification ...

Page 39: ...er 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 See Also Adding a New Generic Field ...

Page 40: ...ndatory or O Optional as per the specification 2 Add the next qualifier in the group here DEAG and specify its presence as OR from the drop down list 3 Repeat the above step until all the qualifiers in the group have been added 4 As per the above figure one among the qualifiers BUYR DEAG DECU is mandatory as specified for the first qualifier of the group 5 Note that the qualifiers in the OR group ...

Page 41: ...t SWIFT UI The Create Field dialog appears 2 Enter the field tag in the Tag text field and press Enter The toolbar buttons for the options table are now enabled 3 Enter the description of the field in the Description text field 4 Add the Options for the field 5 Uncheck the Generic Field check box 6 The lower panel having the field properties appears now Select the Mandatory check box if the field ...

Page 42: ...red options have to be selected and the properties Mandatory and Repeating have to be set each time a field is added to a message format 9 Click OK The field is added to the format as found in the External Format SWIFT UI The field shows a unique collection of subfields of the options selected See Also Specifying Field Definition and Usage Mapping Formats with Specification Sub fields Representing...

Page 43: ... fields There should be a one to one correspondence between the format and the specification mentioned for a field Only then Designer will be able to interpret the sub fields and their individual formats The following steps ensure that Designer maps the format and specification of sub fields correctly If necessary formats can be merged or split up as explained below 1 Select the required row in th...

Page 44: ...at 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 Consider the following case 4 The Field Formats dialog for this case shows ...

Page 45: ...ve 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 Select the rows to be merged and click the Merge Selected Formats button 7 The mapping is now correct Click OK ...

Page 46: ...These brackets can also be entered in the format directly without going through the Fields Format dialog 10 The reverse is also possible in the Fields Format dialog i e formats can be split up 11 Note that the format is missing for Time 12 Select the row to be split up and click the Split Selected Format button ...

Page 47: ...a2 c 3 c If the brackets were missed the format 4 a2 a2 c 3 c would not apply for a single sub field BIC BEI as in the figure Instead it would imply four sub fields with formats 4 a 2 a 2 c and 3 c See Also Adding a new Generic Field Adding a Non Generic Field Representing Complex Formats in Designer Representing Complex Formats in Designer Some field formats mentioned in the SWIFT specification n...

Page 48: ...only if both are present In the grammar A SEP B there is no way to represent such a requirement without ambiguity Consider the formats A SEP B and A SEP B they do not represent the fact that separator should appear only if both A and B are present Since the grammar cannot convey the meaning correctly the SWIFT specification provides additional information as part of the description or clarifies it...

Page 49: ...2 MT523 and MT530 Format Pattern A1 A2 SEP B Representation A1 A2 SEP B A2 SEP B in Designer This format implies that 1 Either A1 A2 and B are present or A1 and B are present or only B is present 2 A2 and B are present or only B is present In this format pattern the separator does not belong to either of the two formats A and B Also format A is further divided into parts A1 and A2 The separator ap...

Page 50: ...ng Similar Pattern 82a Options A D 83a Options A D 88a Options A D 87a Options A D 85a Options A D 53a Options A D 54a Options A D 57a Options A D 58a Options A D 52a Options A D 56a Options A D 51a Options A D 42a Options A D 88D Format Pattern A1 A2 SEP B Representation A1 A2 SEP B A1 A2 A2 SEP B A2 in Designer This format implies that A1 A2 and B are present or A1 and B are present or only B is...

Page 51: ...tion Format in Designer 1 a 34x CRLF 35x 1 a 34x 34xCRLF 35x 34x Specification in Designer Party Identifier Location Party Identifier Party Identifier Location Party Identifier Present in Message Formats MT521 MT531 MT520 MT522 MT523 MT530 Other Fields Having Similar Pattern 82a Option B 88a Option B 87a Option B 53a Option B 54a Option B 57a Option B 52a Option B Format Pattern A SEP B where A is...

Page 52: ...ave followed the above conversion pattern In this case format A is represented as a combination of the number of possible lines and the maximum length per line The order of the formats is important and should always be maintained Example Field 41a OPTION D Format 4 35x CRLF14x Specification Name Address Code Format in Designer 35x CRLF14x 2 35x CRLF14x 3 35x CRLF14x 4 35x CRLF14x Specification in ...

Page 53: ...lds that occurred in the original message may occur at the end The entire set should be treated as a single field To support this we need to add a separate field Copy of Fields 1 To add Copy of Fields select the button in the toolbar 2 The dialog shown below will be displayed 3 Specify the properties for Copy of Fields in the dialog Select OK to add it ...

Page 54: ... 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 It should not be nested within a sequence See Also Adding a SWIFT Sequence Adding a SWIFT Field Updating a SWIFT Field Removing a SWIFT Field ...

Page 55: ...WIFT 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: ... Field check box appears checked and the qualifiers are populated in the qualifiers table with the properties set Add qualifiers further if needed Refer Adding Qualifiers and Associating them to the Options 5 For a non generic field the dialog looks as below The Generic Field check box appears unchecked and the properties Mandatory and Repeating are checked or unchecked as set previously Modify th...

Page 57: ...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: ...te 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 Hence in order to avoid this the suffix a needs to be changed Anyhow this will not affect the format of the field To change the suffix 1 Click the Add New SWIFT Field button in the External Format SWIFT UI to bring the Create Fie...

Page 59: ...og 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: ... 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 2 Sequences can also be removed by clicking this button But sub fields cannot be removed 3 A field can also be removed by clicking the Remove button in the Create Field or Modify Field dialog ...

Page 61: ...ng a swift field you can also add validations for the sub fields of the swift field The validation types that are currently supported are CODE Time Offset BIC C05 DATE T14 Decimal T26 Currency Code Country Code and Party Identification 1 Select a swift sub field in Swift External Format UI In the Swift Sub Field Info properties panel click the Validations button ...

Page 62: ...s 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: ...oving validations from a sub field Adding a SWIFT Field Specifying properties common for all validations The properties that can be specified for a validation are Type Error Code Field Options Qualifiers Applicable only for generic fields Null Field Comment Codes Applicable only if Type is CODE Date Format Applicable only if Type is DATE Sign Field Applicable only if Type is T14 Currency Field App...

Page 64: ...property is applicable only in case of generic fields Only those qualifiers that contain the applicable field options will be displayed Select the necessary qualifiers Please note that at least one qualifier must be selected for a validation Specifying Null Field This property specifies the field that should be null for the validation to be applied In the Null Field combo box sub fields of the swi...

Page 65: ...predefined values can be specified as codes 1 Add a new validation 2 Select Type as CODE in the Type column 3 Specify Error Code Field Options Qualifiers Null Field and Comment properties as specified earlier Specifying Codes The list of codes for the sub field is to be added to the Codes Table Note that at least one code should be added for a code validation Press the button to add a new code Ent...

Page 66: ... will be pasted Note The code detailed name and description should be separated either by spaces or tabs Only then the paste operation will paste the codes correctly In cases where the detailed name itself is of two words separated by space the second word will be copied to the description column In such cases you have to manually copy the second word back to detail name column Removing Codes You ...

Page 67: ... for this validation type will be displayed at the bottom See Also Specifying properties common for all validations Adding validations for a sub field Removing validations from a sub field Adding T14 Validation This validation is applicable for Amount Rate Balance Number fields whose sign must be present when their value is non zero 1 Add a new validation 2 Select Type as T14 in the Type column 3 ...

Page 68: ...format e g YYYYMMDD 1 Add a new validation 2 Select Type as DATE in the Type column 3 Specify the error code qualifiers field options null field and comment properties as specified earlier Specifying Date Format Specify the date format for the validation in the Format combo box Please note that this is a mandatory property In MT519 sub field Date in field 98a should be a valid date expressed as YY...

Page 69: ...ion type will be displayed at the bottom See Also Specifying properties common for all validations Adding validations for a sub field Removing validations from a sub field Adding Country Code Validation This validation is to verify that the country code specified for a field is a valid ISO country code 1 Add a new validation 2 Select Type as Country Code in the Type column 3 The error code will be...

Page 70: ...n 3 The error code will be automatically set as T16 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 Removing validations from a sub field Adding BIC valida...

Page 71: ...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 Removing validations from a sub field ...

Page 72: ...ayed at the bottom See Also Specifying properties common for all validations Adding validations for a sub field Removing validations from a sub field Adding Decimal Validation This validation is applicable for Amount field to validate that the number of digits following the comma must not exceed the maximum allowed for the specified currency 1 Add a new validation 2 Select Type as Decimal in the T...

Page 73: ...pplicable in cases where a party can be identified using a set of predefined groups The predefined groups can be specified as codes 1 Add a new validation 2 Select Type as Party Identification in the Type column 3 The error code will be automatically set as T78 You need not change it 4 Specify Field Options Null Field and Comment properties as specified earlier Specifying Party Identification Code...

Page 74: ... validations table of the Swift Field Validations dialog box select the validation s that are to be removed 3 Click the Remove Validation s button to remove the selected validation s See Also Adding validations for a sub field SWIFT External Message UI The following properties can be specified in the SWIFT External Message UI Format Name This refers to name of the external format MT543ExternalMess...

Page 75: ...See Also SWIFT External Format UI Creating a SWIFT Format Entering the SWIFT Specification ...

Page 76: ...e Format Options Creating a SWIFT Format Entering the SWIFT Specification SWIFT External Message UI Expanding Collapsing SWIFT Fields External Format SWIFT Header Trailer The External Format SWIFT Header UI shows the pre defined fields as per the Header Trailer option chosen during creation As noted earlier you have the option to choose SWIFT Input SWIFT Output SWIFT Input Output FICC Header Custo...

Page 77: ...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: ...peating 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 The fields cannot be added altered or removed for Header and Trailer ...

Page 79: ...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 See Also SWIFT Input Output Header Trailer FISC Header Format Options ...

Page 80: ...en 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: ...peating 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 The fields cannot be added altered or removed for Header and Trailer ...

Page 82: ...erties 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: ...ader and Trailer sections will be empty See Also SWIFT Input Header Trailer SWIFT Output Header Trailer Format Options Swift User Message Data Swift Format Options You can change the Header Trailer chosen during SWIFT Input Output message creation by using this feature Click the Format Options button in the External Format UI The Swift Format Options dialog box appears as shown below ...

Page 84: ...n the range 0 to 9999 and 10000 During runtime if the length of the input value exceeds the maximum length specified in format options it generates error as Message Length exceeded For example consider a message with maximum length value 10000 If the input value exceeds the length specified then error is thrown as Message Length exceeded Maximum length allowed 10 000 actual message length 10 115 S...

Page 85: ...changes The message format ie the fields is automatically populated when created from a pre defined format Only the optional fields can be enabled or disabled in this case Whereas the table is blank when created from an empty message format and the tool bar buttons are enabled so as to add modify and move the fields as required In this case there is no need for the Enabled column in the table and ...

Page 86: ...ields 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 Field Qualifier Info SWIFT Field Info Non Generic SWIFT Sub Field Info SWIFT Sequence Info When a SWIFT sequence is selected in the External Format SWIFT UI the bottom panel shows the properties of the sequence as shown below The panel shows whether the sequence is Repeating and it is Optional or not The Code of the sequence if available is also displayed The panel just displays the propert...

Page 88: ...alifiers are displayed in a table along with their properties Presence O Optional M Mandatory Repeating Description of the qualifier and the Options mapped to it If the format is created from an existing one an additional Enabled column is also shown only which is editable This is provided to allow the user to select the Qualifiers applicable for the field at that occurrence To modify the field pr...

Page 89: ...n a table The Format and Specification of each option are shown in the table For a format created from an existing one an additional Enabled column is also seen only which is editable This is provided to allow the user to select the associated options of the qualifier for the field at that occurrence To modify the properties refer Updating a SWIFT Field section See Also SWIFT Sequence Info SWIFT F...

Page 90: ...he field are shown in a table along with their Format and Specification For a format created from an existing one an additional Enabled column is also seen only which is editable This is provided to allow the user to select the required options for the field at that occurrence To modify the properties refer Updating a SWIFT Field section See Also SWIFT Sequence Info SWIFT Field Info Generic SWIFT ...

Page 91: ...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: ...essage A System Service message can be created in designer either from Existing SWIFT message format or Empty message format The existing SWIFT formats are available as XML files in the location installation dir config swift format See Also System Field Dictionary Creating an empty Service System message format 1 Right click the Cartridge node in Designer and select the New External Message menu i...

Page 93: ...eader 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 To create a Service message select the type as Service ...

Page 94: ... Group Creating a SWIFT System Service 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 Click OK ...

Page 95: ...ialog that appears you have various options to choose Header Trailer Validation and Edit options Click Finish to create the message after selecting the appropriate options Note The existing SWIFT system service messages are under category System and Service respectively When a format based on a message under these categories is created the type of the message is automatically set as either System ...

Page 96: ... n 6 n See Also Adding a Simple Field Adding a Complex Field Fields Separated by OR AND Adding a Group System Field Dictionary Adding a Simple Field A simple field is a field that does not have any sub fields For e g field swift address tag 102 The format of the field is 4 a2 a2 c1 c3 c To add the field the following steps need to be performed 1 In the SWIFT external format UI click the button The...

Page 97: ...ill 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 The format tag and specification of the field cannot be changed By default a simple field is added as mandatory and non repeating 4 Click OK to add the field ...

Page 98: ... 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 The type tag and format of a field cannot be changed 6 In case the simple field is repeating and the max occurs has been specified it will be added as a section as shown below ...

Page 99: ...er branch code session number isn To add this field the following steps need to be done 1 In the SWIFT external format UI click the button The Add System Field dialog will be displayed 2 Select the field to be added mir in the Name combo box Or else you can type the field tag 106 in the Tag combo box The format details of the field are displayed Specify the min max occurs for the field based on th...

Page 100: ...dding a Group Fields Separated by OR AND In the specification for System messages you occasionally see fields groups separated by OR or AND In such cases the following guidelines need to be followed while adding the fields groups 1 If OR is present between the fields in a table the fields should be added as optional The validation for the presence of the fields has to be done separately 2 If AND i...

Page 101: ...be done separately See Also Adding a Simple Field Adding a Complex Field Adding a Group Adding a Group 1 In SWIFT external format UI click the button to add a group A new group is added 2 The group name can be specified in the Field Name column In System Field Info panel you can specify the min max occurs for a group Groups can be nested within another group ...

Page 102: ... a Group Adding a System Field System Field Dictionary The system field dictionary contains the list of all system fields along with the formats tag specification and description Any additional validation that needs to be done for a field is also specified in the field dictionary Any changes that need to be done to a field s format specification validation should be done here The entry for field s...

Page 103: ... actionmessage Invalid Message Priority value actionmessage Validation Validations SwiftSystemFieldDef The allowed values for the field are S U and N This has been specified using the Validation tag under Validations tag Any formula that can be used in Designer can be specified in the formula tag Error code and action message can also be specified The error code and action message specified will b...

Page 104: ...put Date value actionmessage Validation Validations SwiftSystemFieldDef While specifying validations for sub field in the Validation tag tag subfield must be added The value of this tag should be the name of the sub field for which validation needs to be applied Note The field value can be accessed only using the value literal If the name of a sub field is changed and validation has been specified...

Page 105: ...ds will not be expanded If the sequences themselves are collapsed and Fields are expanded you will not be able to view them You have to expand the sequences first and then expand fields Select Qualifiers sub menu item The qualifiers present within fields will be expanded The fields and sequences themselves should be expanded for the expanded qualifiers to be viewed Collapsing Fields Select the Col...

Page 106: ...ved so that it is available for creating other formats depending on it 1 To Export a SWIFT format to library right click the SWIFT format node in the Explorer and choose the context menu Export to Library 2 The Export to Library dialog appears Enter the Name Version Detailed Name Category and Description of the format The category entered can be an existing one or a new category From the Versions ...

Page 107: ...WIFT Formats saved this way are available for creating formats in future Refer Creating a SWIFT Format based on an existing SWIFT message format See Also Creating a SWIFT Format from an empty message format Exporting a SWIFT Message Format Importing a SWIFT Message Format Sample Exported HTML File Exporting a SWIFT Message Format ...

Page 108: ...ialog that appears select the location to save the exported file Select the file type in the Files of type combo and enter a name to save the file in the File name text field Click Save button 3 Note You also have the option of exporting the file in any format you have chosen to the Clipboard by clicking the Export to Clipboard button in the dialog If you want to simultaneously open the exported f...

Page 109: ...ting a SWIFT Message Format SWIFT message format saved using the export method can be imported This is supported in XML and TPLUS formats 1 To import a SWIFT format right click the SWIFT format node in the Explorer and choose the context menu Import 2 In the Import dialog that appears select the XML or TPLUS file to be imported Click Open button ...

Page 110: ...y be a global custodian which has an account with its local agent sub custodian or an investment management institution or a broker dealer which has an account with their custodian This message is used to 1 instruct the delivery of financial instruments against payment physically or by book entry to a specified party the function of the message is NEWM 2 request the cancellation of a deliver again...

Page 111: ...T543In Format Specifications Status Tag Qualifier Generic Field Name Detailed Field Name Content Optio ns No Mandatory Sequence A General Information M 16R Start of Block GENL 1 M 20C SEME Reference Sender s Reference 4 c 16x 2 M 23G Function of the Message 4 c 4 c 3 O 98a PREP Date Time Preparation Date Time A C 4 O 99B 4 c NumberCount See Qualifier Description 4 c 3 n 5 Repetitive Optional Seque...

Page 112: ...e Qualifier Description 4 c 16x 9 M 16S End of Block LINK 10 End Of Sequence A1 Linkages M 16S End of Block GENL 11 End Of Sequence A General Information Mandatory Sequence B Trade Details Field Specifications Field 16R Start of Block FORMAT Option R 16c PRESENCE Mandatory Field 20C Reference Sender s Reference FORMAT Option C 4 c 16x Qualifier Reference PRESENCE ...

Page 113: ...RMAT Option G 4 c 4 c Function Subfunction PRESENCE Mandatory Field 98a Date Time Preparation Date Time FORMAT Option A 4 c 8 n Qualifier Date Option C 4 c 8 n6 n Qualifier Date Time PRESENCE Optional QUALIFIER Order M O Qualifier R N CR Options Qualifier Description 1 O PREP N A C Preparation Date Time See Also Exporting a SWIFT Message Format ...