Table of Contents: Tortoise SVN is used as a source control for FpML.

Transcription

1 Tortoise SVN is used as a source control for FpML. Table of Contents: I. Create your SVN account II. Receive an e mail confirmation that your SVN account is created III. Login and SVN check out:... 2 IV. What is in the folders? V. Modifying files locally and Committing them to FpML SVN repository: VI. Benefits of developing proposals using FpML SVN repository: VII. In addition:

2 I. Create your SVN account. - Send your request to create you SVN account to ISDA staff (Marc Gratacos or Irina Yermakova) II. Receive an e mail confirmation that your SVN account is created. - The confirmation will include url for the FpML repository: 1 III. Login and SVN check out: 1. Click on url for the FpML repository: o 2. Enter SVN userid and Password 1 You will need an SVN Client in order to check-out the repository; at ISDA we use TortoiseSVN (a client built into windows explorer) with nice results. More information about TortoiseSVN can be found here: 2

3 3. SVN check-out. o Create a folder in your windows explorer to which you would check-out the files from FpML repository (e.g. FPML_SVN) 3

4 o Do SVN check-out 4

5 o In the Checkout box, enter ONE of the following and click OK : Check out the entire FpML trunk/tag/branches file tree from Warning: The entire tree is quite large and THIS CHECKOUT PROCESS MIGHT TAKE A QUITE FEW MINUTES. Check out only a specific folders (e.g. trunk/). Warning: THIS CHECKOUT PROCESS REQUIRES THE KNOWLAGE OF THE EXACT PATH TO THAT FOLDER e.g. files from /trunk/ directory- enter e.g. files from a specific folder in the /branches/ directory - enter LCWD-1-EQD/ e.g. files a specific folder in the /tags/ directory - enter Path to the FpML-SVN directory you are checking-out the files from Path to the local folder where you are Checking-out the files to 5

6 o You should get the trunk/tag/branches file tree for FpML-SVN o All users currently have: braches/- read+write access Where the FpML proposals are developed 2. The idea is that if you have a proposal, you can use the branches folder to store it there. Then, if your proposal is approved by the working group, it can easily be integrated with the trunk. tags/ - read-only access Where all published FpML spec versions are stored. trunk/ - read-only access Where the current FpML version is developed 2 Exception FpML-5-0/ and FpML-4-6 Where current FpML5-0 and 4-6 versions get developed 6

7 4. Creating your working folder inside the FPML-SVN /branches/ directory, called FpML-Version-Your-Proposal-Name for your new FpML proposal o Get a fresh copy of the FpML version for which you are creating a proposal. (e.g trunk/) Right Mouse click on /trunk/ folder Select TortoisSVN -> Branch/tag.. 7

8 In the Copy (Branches / Tag) box, make sure it says: From: This should be the folder you are copying the files from (e.g. trunk/) To: Version-Your-Proposal-Name The To URL link can be selected or simply rename the one that appears in the menu. This should have the name of the folder you are coping the files to. It should always say.../branches/fpml-version-your-proposal-name/. It is always a good practice to log a message with the Log Message box. There you would give a reason for which you are creating the new folder in the /branches/ directory. (E.g. My proposal to support my new feature in FpML-4-7 ) Path to the source directory you are copying the files from Path to the FpML-SVN directory where you are coping the files to 8

9 Once The trunk/ folder with the files is copied, the following notification appears o To see your copied folder, do SVN Update on the /branches/ folder. 9

10 o You should get files from your newly created /branches/fpml-version-your- Proposal-Name/ working folder to your machine. 10

11 IV. What is in the folders? - /src/ - holds FpML schema, asset/business process related documentation and examples. - /validation/ - holds business validation tool 3 for FpML schema. The tool utilizing FpML business validation rules. o do-validation-handcoded.bat - generates validation report. - /documentation/ - holds high Products and Messaging Object Model diagrams - /scripts/ - holds all XSLs and Java Scripts needed to generate FpML specification. -.bat scripts in the top folder used for FpML spec generation. A couple of useful.bat scripts: o copyxml.bat - creates xml/ folder with FpML schema and examples o check.bat 4 creates xml/ folder with FpML schema and example and check if the o schema and examples are schema valid. do-schema-merge-xsd.bat 5 creates /merged-schema/ folder and merges subschema into one master schema. Name of the working folder Products and Messaging Object Model diagrams FpML spec XSL/JS scripts used in FpML spec generation Distributed FpML schema validation tool Source files for FpML schema, examples, scheme, documentation and images Scripts used in FpML spec generation 3 Tool created by Hand Coded Software Ltd ( 4 Note: it does not do business validation. For business validation use Head Coded tool in the /validation/ folder 5 Prerequisite - creation of xml/ folder with FpML schema. 11

12 - /src/schema/ holds FpML schema. The schema files get updated directly in that folder. - /src/(asset or business process specific folder)/ - holds product or business process related documentation. For example: o /src/equity-options/fpml-eqd-architecture.xml the documentation related to equity options. - /src/(asset or business process specific folder)/examples/ holds product or business process related examples. For example: o /src/equity-options/examples/ - folder that holds all examples related to equity options (e.g. eqd-ex01-american-call-stock-long-form.xml). FpML examples (All examples are schema* valid) * FpML schema files 12

13 V. Modifying files locally and Committing them to FpML SVN repository: 1. It is always a good practice to update (to synchronize with the FpML-SVN) the folders before you start working with them. Updated your own folder if more than one person is working in it. Always update /trunk/ folder if you planning to view or compare it. This folder gets constantly updated. 13

14 2. From your /branches/fpml-version-your-proposal-name/ working folder, you can open any of the schema files with your XML editor and start working on your proposal. 3. Once a file is modified, its check 6 indicator in your windows explorer turns red. File status indicator. red file modified (not in sync with FpML SVN server.) 6 If the file is committed to the FpML_SVN repository (a copy of the file on your machine is synchronized with the FpML_SVN repository), its check image turns green. Once the file is modified its check image turns red. 14

15 4. To see what is the difference with the original file: o The change will be highlighted 15

16 5. Once you satisfied with your changes, you need to commit them to FpML-SVN repository: 16

17 o In the Enter Log Message enter the description of the changes and press OK button. o Once the file successfully committed (copied to the server), the following notification appears. 17

18 o and the file s check indicated in your windows explorer turns green. File status indicator. green file is in sync with FpML SVN server. 18

19 VI. Benefits of developing proposals using FpML SVN repository: - Code sharing with your FpML working Group. - Group collaboration across projects. - Manage the proposal by which the control of files passes from one member of the group to another. This allows more than one group member participate in developing of a proposal. - Provides a mechanism for choosing the merging/accepting the changes/overwriting files if your local version is outdated. - Modify the files locally and saving then on the FpML server. - Compare modified files with the FpML trunk/ folder or any other folders. - You can merge the changes in the source folder into your working folder - Archiving the successive versions of files. Consequently, you can also designate any version to be the latest version of that item (reverting of the changes to any of the earlier changes). Each version to be compared with the current version. VII. In addition: - to browse the repository on the web: 19