TWIN - TMX Webservice Interface276 KB

TWIN
TMX WEBSERVICE INTERFACE
Ver weg het beste!
Voor TMX is een uitbreidingsmodule beschikbaar met de naam TWIN, de TMX Webservice Interface.
Deze module omvat een webservice die op het niveau van een Enterprise Service Bus open koppelmogelijkheden
biedt met allerlei andere systemen. Gegevens worden via de TWIN-API uitgewisseld in het standaard JSON
(JavaScript Object Notation) formaat dat compacte berichten waarborgt, ook bij grote hoeveelheden data.
Mogelijkheden met TWIN functies
• Uitlezen van tijdreeksen met registraties
• Toevoegen van tijdreeksen met registraties
• Toevoegen van tijdreeksen met verwachtingen
Krachtige data uitwisseling via TWIN
Voor TMX gebruikers is het uitwisselen van data van
toenemend belang. Gedacht kan worden aan het importeren van gegevens, maar vooral ook aan het doorleveren daarvan uit TMX naar andere applicaties, zoals
systemen voor onderhoudsbeheer en geografische
informatie (OBS en GIS). Omdat moderne systemen
gebruik maken van webtechnologie ligt het voor de
hand dit ook in te zetten voor de onderlinge datauitwisseling. Zo kan een Enterprise Service Bus (ESB)
worden gemaakt waarop alle verschillende systemen
worden ‘aangesloten’ voor een snel en realtime transport van uit te wisselen gegevens. Het is aantrekkelijk
daarvoor gebruik te maken van gestandaardiseerde
open webtechnologie en slimme technieken voor een
efficiënte routering en dataprocessing.
Efficiënt, veilig en open
Vanwege de zeer grote hoeveelheid data is bij de TMX
Webservice Interface (TWIN) gekozen voor toepassing
van de standaard JavaScript Object Notation (JSON)
als uitwisselingsformaat. JSON biedt, net als bijvoor-
• Uitlezen van actuele waarden
• Instellen van setpoints
• Uitlezen van instellingen
beeld XML, een combinatie van een eenduidig, open
en helder uitwisselingsformaat. Bij grotere hoeveelheden data is JSON erg efficiënt wat een vlotte en eenvoudig verwerkbare gegevensuitwisseling waarborgt.
Alle gegevens worden via SSL-encryptie versleuteld.
Iedere applicatie die gebruik wil maken van de TWINAPI dient eerst in te loggen.
Instelbaar koppelvlak
De TMX applicatiebeheerder kan de TWIN interface
gedetailleerd instellen zodat de informatiestroom die
via het koppelvlak uitgewisseld wordt goed hanteerbaar blijft.
Na inloggen in de TWIN interface kan de ontvanger
van gegevens dus alleen bij die gegevens die de TMX
beheerder heeft vrijgegeven. Deze werkwijze voorkomt
dat via TWIN ongewenste wijzigingen worden uitgevoerd of niet relevante gegevens worden opgevraagd,
wat de kans op fouten verminderd en de systeemintegriteit verhoogt.
De afbeeldingen hierna geven een indruk van de instelschermen.
Koppeling 2.0 / SPOC
Iedere applicatie heeft zijn
eigen domeinspecifieke parameters. Om te voorkomen
dat er alleen gekoppeld kan
worden met gegevens die
“toevallig” in beide applicaties
aanwezig zijn, is TMX uitgebreid met de optionele mogelijkheid om ‘vrije velden’ aan
te maken. TMX gebruikers
kunnen hierbij de instellingsschermen van TMX uitbreiden
met extra velden. Dit geeft
de gebruiker de mogelijkheid
om naar eigen inzicht extra
informatie aan TMX instellingen toe te voegen. Denk hierbij bijvoorbeeld aan het typenummer van een
toegepaste sensor of een memo-veld voor extra informatie.
Doordat deze extra instellingsvelden ook via de TWIN interface ontsloten
kunnen worden, ontstaan interessante mogelijkheden. Denk bijvoorbeeld
aan een vrij veld waar een gezamenlijk ID wordt ingevuld waardoor gegevens uniek te identificeren zijn aan beide zijden van de koppeling.
De mogelijkheden gaan nog verder: door de extra instellingen in TMX kan
een andere applicatie vanuit TMX geconfigureerd worden waardoor Single
Point Of Configuration (SPOC) bereikt kan worden. Denk aan de mogelijkheid dat na het toevoegen van een locatie in TMX, deze ook meteen in een
OBS of GIS systeem wordt aangemaakt.
Gegevensuniformiteit
Door toepassing van sjablonen binnen de instellingsvelden kan gegevensuniformiteit worden afgedwongen. Dit
heeft in algemene zin het grote voordeel dat de instellingen van de diverse onderstations veel eenduidiger en
sneller in te stellen zijn. Bovendien zorgt het er ook voor dat zaken als kanaalnamen en eenheden in de TWIN
koppeling ook eenduidig zullen zijn, wat wenselijk kan zijn vanuit het oogpunt van uniforme naamgeving binnen
een organisatie.
Waar meer functionaliteit in de API is gewenst, kan deze op verzoek worden uitgebreid. De TWIN interface is,
evenals de vrije velden en sjablonen functionaliteit, als losse module beschikbaar vanaf TMX versie 3.5 en in
TMX-Net Pro (TMX als Saas via internet). Neem contact met ons op voor eventuele vragen en meer gedetailleerde informatie over TWIN.
Houtkopersstraat 6, 3334 KD Zwijndrecht, Nederland
Telefoon +31-78 - 6100 300 Fax +31-78 - 6100 391
Internet: www.tmx.nl
E-mail: [email protected]
(TWINbro-1327 - wijzigingen voorbehouden)
TWIN-API functies
De TWIN webservice kent onder andere de volgende mogelijkheden:
 Uitlezen van registratie tijdreeksen
Hierbij kan zowel “van..tot…” als “wijzigingen sinds” opgevraagd worden. Registraties worden inclusief de
resultaten van de datavalidatie van TMX doorgegeven waarbij naar keuze ook de afgekeurde registraties
(=ruwe data) meegestuurd kunnen worden
 Toevoegen van tijdreeksen met registraties
Hiermee kunnen registraties uit andere systemen worden toegevoegd aan TMX
 Toevoegen van tijdreeksen met verwachtingen
Hiermee kunnen tijdreeksen met o.a. verwachtingen worden toegevoegd aan TMX
 Uitlezen van actuele waarden
 Instellen van setpoints
 Uitlezen van instellingen
Gewijzigde veranderingen van instellingen sinds een bepaald tijdstip kunnen worden uitgelezen