Technische Lieferbedingungen FOF (XML-Format)

Transkript

1 Technische Lieferbedingungen FOF (XML-Format) Version 4 Bearbeitet durch: WMGruppe Erstelldatum: :00 Erstellt von: Udo Spuhl

2 Inhaltsverzeichnis Inhaltsverzeichnis... 2 Änderungsnachweis Aufbau der XML-Files Aufbau der Lieferungen und Namenskonventionen Behandlung von Referenzdaten Bestandsbezogene Lieferung... 7 Änderungsnachweis Datum Änderungen Verantwortlich Beschreibung für bestandsbezogene Lieferung ergänzt Udo Spuhl Behandlung von Referenzdaten ergänzt Udo Spuhl 2/8

3 1 Aufbau der XML-Files Die von WM produzierten Daten werden in Form von XML-Dateien entsprechend der Spezifikation durch das WMS 2.0 (Beschreibung des Export-Formates, Version 2.0) in der aktuellen Streaming- Version ausgeliefert. Je nach Kundenwunsch werden nur die Veränderungen (exportasdiff = 1) oder komplette Objekte (exportasdiff = 0) im Format XML geliefert. Die einzelnen Meldungen werden in eine FO-Message verpackt (exportasfomessage = 1). Der Wurzelknoten ist FOF mit folgenden Attributen: Name erforderlich Name des Profils Date erforderlich Datum der Tagesproduktion (siehe Namenskonventionen) Previous optional Nummer der vorherigen Lieferung innerhalb einer Tagesproduktion, bei der ersten Datei nicht vorhanden Last optional Flag für letzte Lieferung innerhalb einer Tagesproduktion, nur in der letzten Datei vorhanden Die einzelnen FO-Messages sind unmittelbar Kinder des Wurzelknotens. Zum Abschluss der Tagesproduktion kann es vorkommen, dass die letzte Datei keine FO-Messages enthält. 3/8

4 2 Aufbau der Lieferungen und Namenskonventionen Um eine eindeutige Zuordnung aller gelieferten XML-Dateien zu gewährleisten, werden sie mit folgender Namenskonvention ausgeliefert: wm_pppp_jjjjmmtt_xxxxx.xml.gz wm konstanter String WM pppp Bezeichnung des Profiles, vierstellig alphanumerisch JJJJ Jahr, numerisch, vierstellig MM Monat, TT Tag, XXXXX fortlaufende Nummer, numerisch, 5-stellig, mit führenden Nullen Das im Dateinamen enthaltene Datum bezieht sich auf den Produktionstag, zu dem die Datei gehört. Sollte eine Tagesproduktion über 24:00 Uhr hinausgehen (insbesondere auch bei Sonderlieferungen), wird das Datum des Tages verwendet, an dem die Produktion begonnen wurde. Die Anzahl der FO-Messages je Datei beträgt 1000, kann aber durch den Kunden abweichend bestellt werden. Die Dateien werden mit GNU-Zip komprimiert und auf dem FTP-Server bereitgestellt. 4/8

5 3 Behandlung von Referenzdaten Für die Verarbeitung von Referenzdaten gibt es zwei Varianten, aus denen der Kunde auswählen kann: 1. Die Referenzdaten werden im FOF als eigene TopLevelObjekte, ähnlich Instrument oder Institution, mitgeliefert. 2. Die Referenzdaten werden nicht im FOF sondern als separate Dateien bereitgestellt. Referenzdaten können sich ohne vorherige Ankündigung ändern bzw. es können neue Ausprägungen hinzukommen. Eine Ausnahme bilden dabei die Klassen EnumerationDomainScheme und EnumerationDomain: Bei der Variante 1 werden diese auch als separate Dateien bereitgestellt und nicht im FOF mitgeliefert. Mindestens eine Woche vor der ersten Verwendung werden Änderungen bzw. Erweiterungen angekündigt und die Dateien mit den neuen Ausprägungen bereitgestellt. Die Referenzdaten werden je Klasse als eigene FOF-Datei entsprechend folgender Namenskonvention geliefert: wm_refdat_classname_mode_jjjjmmtt.xml.gz wm_refdat konstanter String CLASSNAME Klassenname der Referenzdatenklasse entsprechend weiter unten aufgeführter Liste MODE full oder diff JJJJ Jahr, numerisch, vierstellig MM Monat, TT Tag, XXXXX fortlaufende Nummer, numerisch, 5-stellig, mit führenden Nullen Das im Dateinamen enthaltene Datum bezieht sich auf den Produktionstag, zu dem die Datei gehört. Sie werden nach der Verarbeitung aller Meldungen zu diesem Produktionstag erzeugt. Sollte eine Tagesproduktion über 24:00 Uhr hinausgehen (insbesondere auch bei Sonderlieferungen), wird das Datum des Tages verwendet, an dem die Produktion begonnen wurde. Die Anzahl der FO-Messages je Datei entspricht der Anzahl der Ausprägungen der jeweiligen Referenzdatenklasse. Als Name für den FOF wird in der XML-Struktur REF1 eingetragen. Die für den jeweiligen FOF relevanten Referenzdaten-Dateien werden mit GNU-Zip komprimiert auf dem FTP-Server bereitgestellt. Von Montag bis Freitag werden in den Dateien nur die neuen oder geänderten Ausprägungen der Referenzdaten bereitgestellt, im Dateinamen am MODE = diff zu erkennen. Dabei werden nur dann Dateien erzeugt, wenn tatsächlich Änderungen vorhanden sind. Zusätzlich werden nach Fertigstellung der Produktion vom Freitag Dateien mit den kompletten Referenzdaten (MODE = full) erzeugt und bereitgestellt. Dabei werden auch die Dateien für die Klassen EnumerationDomainScheme und EnumerationDomain bereitgestellt. Wenn in diesen beiden Klassen Änderungen enthalten sind, wird dies separat mitgeteilt (siehe oben). 5/8

6 Liste der Referenzdatenklassen: EnumerationDomainScheme EnumerationDomain AgendaDefinition AmountDefinition BorrowingLimitation BorrowingLimitationScheme CEInstrumentIDScheme CFGroup CFGroupScheme DoubleTaxAgreement FIOMSchemeMapping FormsCondition FutureBondRule GeographicUnit GeographicUnitIDScheme Industry IndustryScheme InstitutionGroup InstitutionGroupScheme InstitutionIDScheme InstitutionLight InstrumentGroup InstrumentGroupScheme InstrumentIDScheme InstrumentServiceGroup InstrumentServiceGroupScheme InstrumentServiceIDScheme LegalForm ListingGroup ListingGroupScheme ListingIDScheme MarketPractice PortfolioStrategyDefinition QuoteType QuoteTypeScheme RatingScheme ReferenceDataOwner ReportingGroup ReportingScheme RestrictionType SettlementType TaxRate TaxRateKeyCategory TaxRelation TaxRelationDefinition TaxType TrustAdministrationDefinition WithholdTaxGroup 6/8

7 4 Bestandsbezogene Lieferung Der FOF kann bestandsbezogen geliefert werden. D.h., vom gesamten Datenhaushalt werden nur die Wertpapiere geliefert, die der Kunde bei der WM Gruppe anfordert. Die Liste der auszuliefernden Instrumente kann durch den Kunden gepflegt werden. Dazu wird auf einem FTP-Server ein Zugang eingerichtet, auf den eine Datei mit der Liste der auszuliefernden Wertpapiere hochgeladen werden kann. Die WM Gruppe liefert einen Initialload der Wertpapiere und anschließend alle Änderungen an diesen Wertpapieren. Die Datei mit der Liste wird zur Abarbeitung vom FTP-Server entfernt. Nach dem Initialload müssen nur noch Änderungen am Bestand mitgeteilt werden, eine komplette Liste aller Wertpapiere ist auch bei Änderungen nicht mehr notwendig. Die Datei muss je Wertpapier eine Zeile enthalten, die folgendermaßen aufgebaut ist: FlagTopLevel,SchemeSymbol,IdSymbol Flag + oder - TopLevel konstanter String Instrument SchemeSymbol konstanter String WKN oder ISIN IdSymbol 6-stellige Wertpapier-Kenn-Nummer oder 12-stellige ISIN Flag und TopLevel stehen unmittelbar hintereinander (kein Trennzeichen), SchemeSymbol und IdSymbol sind davon durch Komma getrennt. Gegenwärtig kann als TopLevel nur Instrument angefordert werden. Ein Flag + bedeutet, dass das Wertpapier als Initialload auszuliefern ist und auf die Liste der auszuliefernden Wertpapiere gesetzt wird. Ab diesem Zeitpunkt werden also alle Updates zu diesem Wertpapier ausgeliefert. Befindet sich das Wertpapier bereits auf der Liste der auszuliefernden Wertpapiere, wird es trotzdem als Initialload ausgeliefert. Ein Flag - bedeutet, dass das Wertpapier von der Liste der auszuliefernden Wertpapiere entfernt wird. Ab diesem Zeitpunkt werden keine Updates mehr zu diesem Wertpapier ausgeliefert. Zeilen, die mit # beginnen, werden als Kommentar behandelt und überlesen. Als Schlüssel (IdSymbol) für das Wertpapier kann entweder die ISIN oder die Wertpapier-Kenn- Nummer (WKN) verwendet werden. Welcher Schlüssel angegeben ist, steht unter SchemeSymbol. Beipiele: +Instrument,WKN, Instrument,WKN, Instrument,ISIN,DE Instrument,ISIN,DE Die Datei mit der Liste der auszuliefernden Wertpapiere unterliegt folgender Namenskonvention: pppp_jjjjmmtt_xxxxx.csv.gz pppp Bezeichnung des Profiles, vierstellig alphanumerisch JJJJ Jahr, numerisch, vierstellig MM Monat, TT Tag, XXXXX fortlaufende Nummer, numerisch, 5-stellig, mit führenden Nullen Das im Dateinamen enthaltene Datum bezieht sich auf den aktuellen Tag. Die laufende Nummer wird je Tag hochgezählt (beginnend mit Null) und muss eindeutig sein. Die Dateien werden in der Reihenfolge des Datums und der laufenden Nummer abgearbeitet. 7/8

8 Die Datei muss mit GNU-Zip (oder einem kompatiblen Programm) komprimiert sein. Über die dabei erzeugte Prüfsumme wird die Konsistenz der Datei geprüft. 8/8