Installing Microsoft BizTalk Accelerator for SWIFT Message Pack 2013 Microsoft Corporation Published: September 2013 Contents Prerequisites ................................................................................................................................................. 4 Installing Message Pack 2013 ....................................................................................................................... 4 Configuring Message Pack 2013 ................................................................................................................... 5 Enabling SWIFT 2013 SRG Validation ............................................................................................................ 6 Deploying and Undeploying Assemblies and Policies ............................................................................... 6 Publishing and Unpublishing InfoPath Forms ........................................................................................... 7 Disabling SRG 2013 Validation .................................................................................................................. 8 Updating Custom MRSR ................................................................................................................................ 9 Known Issues............................................................................................................................................... 10 Uninstalling the Message Pack 2013 .......................................................................................................... 11 Copyright ..................................................................................................................................................... 11 Installing Microsoft BizTalk Accelerator for SWIFT Message Pack 2013 In order to provide industry-standard compliance with the SWIFT 2013 Standards Release Guide (SRG) specification, Microsoft® has released the following: SWIFT Message Pack 2013 for Microsoft BizTalk Accelerator for SWIFT (A4SWIFT) 2009 SWIFT Message Pack 2013 for Microsoft BizTalk Accelerator for SWIFT (A4SWIFT) 2010 SWIFT Message Pack 2013 for Microsoft BizTalk Accelerator for SWIFT (A4SWIFT) 2013 Upgrading to a new release provides the compatibility required for ongoing use of the SWIFT standard that is to be imposed starting in November 2013. This document provides upgrade guidance to ensure minimum downtime. It also describes the feature updates in the release so you can plan accordingly. The A4SWIFT Message Pack 2013 contains the following: Complete re-packaging of all SWIFT FIN FF message types and business rules (not just net change). Updates to schemas and business rules that are fully compliant with SWIFT 2012 certification requirements. Support for SWIFTNet Phase 2 PKI header information. Note The Message Pack carries forward all hot-fixes related to schemas and business rules that are not superseded by 2012 requirements. The Microsoft BizTalk Accelerator for SWIFT Message Pack 2012 does not have any components outside of schemas, business rules and Microsoft Office InfoPath® Forms. Prerequisites Ensure that the following prerequisites are installed prior to running setup: Microsoft Windows Server® 2003 SP2, Microsoft Windows Server® 2008, Microsoft Windows 7, Microsoft Windows Server® 2008 R2, Microsoft Windows 8, or Microsoft Windows Server® 2012 (depending on the Microsoft BizTalk Server used). The A4SWIFT Message Pack 2013 is available as one distinct downloadable package. A4SWIFT Version and Service Pack (if required) BizTalk Server Version Microsoft Visual C++ 2005 SP1 Redistributable Package Microsoft .NET Framework BizTalk Server 2009 A4SWIFT 2009 No 3.5 BizTalk Server 2010 A4SWIFT 2010 No 4.0 BizTalk Server 2013 A4SWIFT 2013 No 4.0 Install the hot fix corresponding to the A4SWIFT version you are working with. This installs the fix for the validation of Country/Currency codes and messaging of MT202COV and MT205COV. A4SWIFT Version A4SWIFT 2009 Hot fix KB Article Number 971999 Installing Message Pack 2013 To install Message Pack 2013 1. If any schemas and Business Rule Engine (BRE) rules are deployed from earlier version of message pack, then run the BRE Deployment utility and point it to the schema assembly. Undeploy all existing (SWIFT 2012 SRG) BRE policies by running the BRE Deployment utility. Note: Manually remove the A4SWIFT_Codelist and A4SWIFT_Functions vocabularies using the Business Rule Composer tool. 2. Back up the A4SWIFT database or any other database that is used for SWIFT. Also back up your SWIFT message schemas. 3. Unzip the package corresponding to the A4Swift version you are working with: A4Swift Version Package Name A4SWIFT 2013 MP_2013_v35 A4SWIFT 2010 MP_2013_v35 A4SWIFT 2009 MP_2013_v35 4. Run Setup.exe to install the Message Pack 2013. 5. On the Installation Completed page, click Finish. Note If Run Configuration Wizard is selected on the Installation Completed page (the default), the Message Pack 2013 configuration wizard will run automatically when you click Finish. 6. After the installation completes, continue to the following section, Configuring Message Pack 2013, to configure the Message Pack as it is mandatory for BRE Validations. Configuring Message Pack 2013 To configure Message Pack 2013 1. On the Microsoft BizTalk Accelerator for SWIFT Message Pack 2013 Configuration page, click DB Configuration in the left pane. 2. In the DB Configuration pane, select Do you want to create a new database group to create the groups shown in the Group pane. Clear Do you want to create a new database group to join an existing database group. 3. Click Apply Configuration. 4. On the Summary page, verify the configuration settings, and then click Apply Configuration. Note You can save the configuration settings as an XML file if desired. 5. On the Configuration Wizard page that indicates that you have successfully completed the Configuration Wizard, click Finish. Note Installing the SWIFT Message Pack 2013 will not automatically validate messages for SWIFT 2013 SRG compliance. Use the following procedure to enable SWIFT 2013 SRG validation. Enabling SWIFT 2013 SRG Validation Deploying and Undeploying Assemblies and Policies To deploy and undeploy assemblies and policies 1. Undeploy all existing (SWIFT 2012 SRG) schema assemblies. In a multi-computer environment, you must manually remove these schema assemblies from the GAC on all run-time servers and the Business Activity Services (BAS)/ MRSR Site (A4Swift2009/A4Swift2010/A4Swift2013) 2. Rebuild and deploy the schema assemblies with the schemas provided in the Message Pack under <drive>:\Program Files\Microsoft BizTalk Accelerator for SWIFT Message Pack 2013\SWIFT Messages\A4SWIFT-SRG2013. (OR) <drive>:\Program Files (x86)\Microsoft BizTalk Accelerator for SWIFT Message Pack 2013\SWIFT Messages\A4SWIFT-SRG2013. The rebuilt schema assemblies need to be installed in the global assembly cache (GAC) on all computers that have the A4SWIFT run-time components installed. Note If any custom changes have been made to these schemas, the same changes must be made to the Message Pack schemas after adding them to the schema projects. Note The Message Pack does not support side-by-side deployment of SWIFT 2013 SRG schema assemblies with SWIFT 2012 SRG schema assemblies. Message instances that were originally parsed with SWIFT 2012 SRG schema assemblies may be suspended. Suspended messages can then be resumed so that they use SWIFT 2013 SRG schemas and validation policies. 3. Back up the BREDeployment utility configuration file BREDeployment.exe.config from the <drive>\Program Files\Microsoft BizTalk Accelerator for SWIFT\SDK\Tools folder. Open the configuration file in Notepad and modify the values of the following keys to point to the appropriate directories in the SWIFT Message Pack 2013 installation directory. For example: <add key="BasePoliciesDirectory" value="%Program Files%\Microsoft BizTalk Accelerator for SWIFT Message Pack 2013\SWIFT Messages\A4SWIFT-SRG2013\Base Policies" /> <add key="SchemasDirectory" value="%Program Files%\Microsoft BizTalk Accelerator for SWIFT Message Pack 2013\SWIFT Messages\A4SWIFT-SRG2013" /> <add key="VocabularyDirectory" value="%Program Files%\Microsoft BizTalk Accelerator for SWIFT Message Pack 2013\SWIFT Messages\A4SWIFT-SRG2013\Base Policies\Vocabulary" /> <add key="LogFileName" value="C:\Documents Data\BREDeploymentLog.txt" /> and Settings\All Users\Application 4. Go to <drive>:\Program Files\ Microsoft BizTalk Accelerator for SWIFT Message Pack 2013\SWIFT Messages\A4SWIFT-SRG2013\Base Policies. Open the file DBConnection_Master_Policy.xml. Change the “DATBASE SERVER” and “DATABASE NAME”. Ensure that “DATABASE NAME” is the same as you have entered when configuring the Message Pack 2013. 5. Manually deploy policy DBConnection_Master_Policy.xml using the Business Rule Engine Deployment Wizard. The file path to DBConnection_Master_Policy.xml is <drive>:\Program Files\\Microsoft BizTalk Accelerator for SWIFT Message Pack 2013\SWIFT Messages\A4SWIFTSRG2013\Base Policies\. 6. Run the BRE Deployment utility and point it to the schema assembly as in step 1. 7. Deploy the policies. Note: Use “%ProgramFiles(x86)%” instead of %ProgramFiles% for (x64) bit OS. Publishing and Unpublishing InfoPath Forms If Microsoft Office InfoPath 2003 forms have been published previously, they need to be unpublished and republished with the forms in the Message Pack on the server that hosts BAS. In a command prompt, navigate to the <drive>:\Program Files\Microsoft BizTalk Accelerator for SWIFT Message Pack 2013\Tools folder and run FormPublish.exe with the –d option. It will unpublish your previous forms. Then publish the SWIFT Message Pack 2013 InfoPath forms by running FormPublish.exe again with the –p option. To work with A4SWIFT 2013 and Message Pack 2013, user needs to generate the InfoPath forms 2007 manually using FormGenerator utility and publish them onto the SharePoint site. The steps to achieve the generation and publishing of forms can be followed from the Form Generator help documentation. Form Generator utility and the related help guides can be downloaded from: "http://download.microsoft.com/download/F/6/F/F6F63F8A-5505-4D28-91BE-5DF6ECCCE364/Form Generator MT help Guide.docx" "http://download.microsoft.com/download/F/6/F/F6F63F8A-5505-4D28-91BE5DF6ECCCE364/Form_Generator_help_Guide.docx" "http://download.microsoft.com/download/F/6/F/F6F63F8A-5505-4D28-91BE5DF6ECCCE364/FormGenerator.zip" "http://download.microsoft.com/download/F/6/F/F6F63F8A-5505-4D28-91BE5DF6ECCCE364/FormGenerator_MT.zip" Note: The Business Activity Services (BAS) feature has been deprecated in the BizTalk Server 2009. Therefore, to run the Message repair in SWIFT 2009, you will have to run the MRSR 2009 scenario. Disabling SRG 2013 Validation To disable SRG 2013 validation 1. Undeploy all SWIFT Message Pack 2013 BRE policies by running the BRE Deployment utility. Manually remove the A4SWIFT_Codelist and A4SWIFT_Functions vocabulary using the Business Rule Engine Composer tool. 2. Undeploy all existing SRG 2013 schema assemblies and remove them from the GAC on all runtime servers and the BAS server/MRSR site server in your deployment environment. Note Before rebuilding and redeploying your schemas project, remove all Message Pack 2013 schemas and replace them with schemas from Message Pack 2011/Message Pack 2012. Any custom changes made to those schemas may not be preserved. 3. Rebuild and deploy the schema assemblies with the schemas provided in the original SWIFT Accelerator under one of the following locations: <installation drive>:\%Program Files%\Microsoft BizTalk Accelerator for SWIFT\SWIFT Messages\A4SWIFT 2009 <installation drive>:\%Program Files%\Microsoft BizTalk Accelerator for SWIFT\SWIFT Messages\A4SWIFT 2010 <installation drive>:\%Program Files%\Microsoft BizTalk Accelerator for SWIFT\SWIFT Messages\A4SWIFT 2013 Rebuild and deploy schema assemblies to the GAC on all runtime servers and the BAS server/MRSR site server in your deployment environment. 4. Go to the <installation drive>:\%Program Files%\Microsoft BizTalk Accelerator for SWIFT\SDK\Tools folder and back up the existing BREDeployment.exe.config file. Replace the BREDeployment utility configuration file that was backed up in step 3 of the “Deploying and Undeploying Assemblies and Policies” section of this document, so that the keys listed below now point to the appropriate directories in the A4Swift2009/A4SWIFT2010/ A4SWIFT2013 or the Message Pack 2012 installation directory. Here the path of the files would be different on the version of the Message Pack currently being rolled back to. For example: <add key="BasePoliciesDirectory" value="%Program Files%\Microsoft BizTalk Accelerator for SWIFT Message Pack 2012\SWIFT Messages\A4SWIFT-SRG2012\Base Policies" /> <add key="SchemasDirectory" value="%Program Files%\Microsoft BizTalk Accelerator for SWIFT Message Pack 2012\SWIFT Messages\A4SWIFT-SRG2012" /> <add key="VocabularyDirectory" value="%Program Files%\ Microsoft BizTalk Accelerator for SWIFT Message Pack 2012\SWIFT Messages\A4SWIFT-SRG2012\Vocabulary" /> 5. Run the BREDeployment utility and point it to the schema assembly deployed in step 3. 6. If you have published any InfoPath forms previously, you will have to unpublish them. At a command prompt, navigate to the <installation drive>:\%Program Files%\Microsoft BizTalk Accelerator for SWIFT\SDK\Tools folder. 7. Run FormPublish.exe –d. It will unpublish your previous forms.Rebuild and deploy any projects or assemblies that you had previously used with A4Swift 2009 / A4SWIFT 2010 / A4SWIFT 2013 or Message Pack 2012 as applicable. Note: Use “%ProgramFiles(x86)%” instead of %ProgramFiles% for (x64) bit OS. Updating Custom MRSR If you are using custom MRSRs located in the <drive>:\%Program Files%\Microsoft BizTalk Accelerator for SWIFT \SDK\Samples\CustomMRSRModel folder, you must update the tables in the custom MRSR database to make the Message Pattern feature compatible with changes in the SWIFT 2013 Standards Release Guide specifications. To update the custom MRSR tables, run the UpdateDefaultDataSRG2006.sql script located in the <drive>:\Program Files\Microsoft BizTalk Accelerator for SWIFT Message Pack 2013\SDK\Samples\CustomMRSRModel\DB\SRG2006\ folder. If you do not run the script, you will not be able to create patterns specific to the SRG 2013 update. Patterns related to non-SRG2013 changes will continue to function. Known Issues 1. Uninstalling the SWIFT Message Pack 2013 leaves behind the root folder. Issue: When you uninstall the SWIFT Message Pack 2013, you might notice that the following folder is not deleted: Microsoft BizTalk Accelerator for SWIFT Message Pack 2013. Resolution: You can safely delete this folder manually after uninstalling the Message Pack. 2. Failed upgrade Issue: During Upgrade, upgrade will fail if a prerequisite is missing otherwise upgrade will be successful but Upgrade will not show prerequisite missing dialog. Setup Log file will contain particular prerequisite missing statement in case of prerequisite missing. Resolution: Install prerequisite software mentioned in the Prerequisite section above. 3. Unconfiguring MessagePack deletes A4Swift Database. Issue: If you don’t close MessagePack configuration wizard before unconfiguring MessagePack, the A4Swift database gets deleted. Resolution: After configuring MessagePack, close the configuration wizard and start the wizard to unconfigure MessagePack. 4. Issue: All the validations for field 98E (Date Time UTC Indicator) have been incorporated except for the one where in we put the Sign character "N" in case of UTC indicator. Because of the limitation we have with the schema, we are not able to validate the sign unit. If you enter any character, this will not be validated by the schema and the instance will pass successfully and also one more positive instance (:98E::PREP//20080513123548/0215) fails to pass validation. In the above instance /0215 is the UTCIndicator Sub field. The instance fails validation because it treat 0 as sign unit,21 as SignFirstPart and throw error for secondPart i.e 5. SecondPart field is optional and of length two. This limitation was pre-existing in other MT's (provided by the customer) as well. 5. No Upgrade Support for MP2006/MP2007/MP2008/MP2009/MP2010 to MP2013 Issue: If any of MP2006/MP2007/MP2008/MP2009/MP2010/MP2011 is installed on the system and its upgrade to MP2013 is tried, then it will fail. Only MP2012’s upgrade is supported to MP2013. Resolution: Uninstall MP2006/MP2007/MP2008/MP2009/MP2010/MP2011 first, and then install MP2013 on the system. Uninstalling the Message Pack 2013 1. Click Start, go to Control Panel, and then click Add or Remove Programs. 2. In Add or Remove Programs, click Microsoft BizTalk Accelerator for SWIFT Message Pack 2013, and then click Remove. Copyright Information in this document, including URL and other Internet Web site references, is subject to change without notice. Unless otherwise noted, the companies, organizations, products, domain names, e-mail addresses, logos, people, places, and events depicted in examples herein are fictitious. No association with any real company, organization, product, domain name, e-mail address, logo, person, place, or event is intended or should be inferred. Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written permission of Microsoft Corporation. Microsoft may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. Except as expressly provided in any written license agreement from Microsoft, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property. © 2013 Microsoft Corporation. All rights reserved. Microsoft, BizTalk, InfoPath, Windows Server are trademarks of the Microsoft group of companies. SWIFT, S.W.I.F.T., the SWIFT logo, Sibos, SWIFT Net, SWIFT Alliance, SWIFT Standards, SWIFT Ready and Accord are trademarks of S.W.I.F.T. SCRL. Other SWIFT-derived product and service names, such as but not limited to SWIFT Solutions and SWIFT Support, are trade names of S.W.I.F.T. SCRL. All other trademarks are property of their respective owners.