Helix.Hekla.Api 1.6.6

Hekla API

Hugtök

Hekla er skeytamiðlari sem tengir saman hinar ýmsu heilbrigðisstofnanir. Heklubroker er miðjan sem sér um að tengja saman allar Heklugáttir og miðla samskiptum. Heklugátt er aðgangspunktur fyrir stofnanir til að geta sent og tekið á móti skeytum. Hver stofnun er með sýna Heklugátt inn á innrineti stofnunarinnar og ætti ekki að vera aðgengileg utanfrá. Bakendi er sá hugbúnaður sem talar við Heklugátt. Hver bakendi er með sitt notendanafn og lykilorð. Hekluþjónusta er biðröð (e. queue) í Heklu til að miðla upplýsingum á milli Heklugátta.

Dæmi um skeyta sendingu milli bakenda A og bakenda B:

API skil

GW_PEEK_ASYNC

Sækir maxCount af skeytum af Heklu þjónustu. Tekur eftirfarandi parametra:

Skilar:

Mögulegar týpur [type]:

• XML: Er skeyti sem inniheldur xml

• BINARY: Er skeyti sem inniheldur gögn á binary formati

• ACK: Skilaboð frá Heklubroker um að skeyti sé mótekið

• NACK: Villumelding ef skeytasending misheppnast

GW_DONE_ASYNC

Fjarlægir skeyti af Hekluþjónustu. Tekur inn parametrana:

Skilar engu

GW_RECEIVE_ASYNC

Sækir og fjarlægir eitt skeyti af hekluþjónustu

Skilar sömu gögnum og GW_PEEK_ASYNC nema bara 1 færslu eða engri.

Þetta fall sækir fremsta skeytið af hekluþjónustunni og fjarlægir í leiðinni.

Ekki þarf að kalla á GW_DONE_ASYNC ef þetta fall er notað.

Ef ekkert skeyti er á hekluþjónustunni bíður fallið í [timeout] millisekúndur eftir nýju skeyti og skilar skeytinu til baka um leið og það kemur á hekluþjónustuna. Ef ekkert skeyti berst skilar þetta fall tómum lista af skeytum.

Hægt er að keyra þetta fall inn í transaction. Ef transaction-inni er rollback-að endar skeytið aftur fremst á hekluþjónustunni. ATH ef transaction er rollback-að fjórum sinnum í röð óvirkjast Hekluþjónustan þar til kerfistjóri virkjar hana aftur.

GW_SEND_XML_ASYNC

Sendir XML skeyti til annarar heklugáttar á ákveðna hekluþjónustu.

Skilar engu en það get þó komið upp villumeldingar eins “Access Denied”

Bakendi þarf að hafa aðgang að hekluþjónustunni til að geta sent. Hægt að sjá hvaða aðgang bakendi hefur með því að kalla á GW_GET_SERVICES.

Bakendi þarf að hafa réttindi til að senda á ákveðna heklugátt. Hægt er að sjá hvaða aðgang bakendi hefur til að senda með GW_GET_NODES_FOR_SERVICE

Þegar skeyti er sent skilar broker alltaf ACK eða NACK skeyti á sömu hekluþjónustu og var sent fyrir. Þessi skeyti þarf að fjarlægja svo hekluþjónustan fyllist ekki af skeytum.

GW_SEND_BINARY_ASYNC

Er eins og GW_SEND_XML_ASYNC nema að message parameter er binary gildi.

GW_GET_SERVICES

Sækir lista af þjónustum sem bakendinn hefur aðgang að.

GW_GET_NODES_FOR_SERVICE

Sækir lista fyrir heklugáttir sem hægt er að senda á með gefinni þjónustu.

GW_SEND_SYNC

Sendir og skilar til baka niðurstöðu í sama kalli. Hekluþjónustan þarf að styðja þá virkni.

GW_WAITFOR_SYNC

Bíður eftir synchronous fyrirspurn

Skilar:

Bíður eftir og skilar strax fyrirspurninni þegar hún kemur.

Ef message_type_name er af tegund SYNC_REQUEST að þá ætti syncRequest parameterinn að innihalda fyrirspurnina.

Til að senda svar til baka er kallað á GW_SYNC_SEND_RESPONSE sem tekur inn conversation_handle og svo svarinu sem texta.

Ef message_type_name er ekki af tegund SYNC_REQUEST þarf að kalla á fallið GW_SYNC_END_CONVERSATION sem tekur inn conversation_handle til að ljúka samskiptunum við gáttina sem sendi fyrirspurnina.

Dæmi um notkun

var api = new HeklaApi("Data Source=heklagatewway;User ID=HEKLA_GW_API_LOGIN;Password=thepassword;Initial Catalog=HEKLA", "MYBACKEND", "SOMEPASSWORD");

var messages = api.Peek("HEKLA_SERVICE", 500);
foreach (var message in messages)
{
   DoStuff(message);
   api.Done("HEKLA_SERVICE", message.Handle);
}

await api.SendXMLAsync("HEKLA_SERVICE", "SVALA", messageXml, "SomeId");
await api.ReceiveAsyncMessageAsync("HEKLA_SERVICE", TimeSpan.FromSeconds(10), (Message) => { return DoStuff(Message); }, new System.Threading.CancellationToken());