Azure Logic Apps framework za poveznike drugih proizvođača

  • Članak

Gradimo okvir koji će partnerima i pružateljima rješenja omogućiti izradu konektora i njihovu integraciju s Microsoft Sustainability Manager rješenjem. U ovom su članku navedene pojedinosti o prvoj grupi poveznika koje smo izgradili pomoću aplikacija Azure Logic Apps u suradnji s partnerskim timom. Ovaj članak sadrži smjernice o tome kako izraditi poveznik logičkih aplikacija za i podijeliti podatke potrebne za Microsoft Sustainability Manager izračun ugljičnog otiska i otiska održivosti za kupce.

Ključni pojmovi

Morat ćete znati sljedeće definicije korištene u ovom članku:

Davatelj usluga: davatelj je partner koji nudi jednu ili više usluga koje omogućuju obogaćenu, unaprijed konfiguriranu vezu s podatkovnim rješenjem. Organizacije odabiru davatelje usluga koji se prijavljuju na njihovu tvrtku povezivanjem s njima. Nakon što se povežu, stvara se instanca tog davatelja usluga koja može uključivati više rješenja davatelja usluga. Korisnici mogu uspostaviti vezu sa svakim rješenjem davatelja usluga kako bi unijeli svoje podatke Microsoft Sustainability Manager.

Poveznik: Poveznik je softver koji je ugrađen unutar proizvoda ili isporučen kao zaseban modul koji korisniku omogućuje unos (ili uvoz) podataka Microsoft Sustainability Manager. Svaki davatelj usluga može imati jedan ili više poveznika za svako svoje rješenje s kojima se korisnik povezuje.

Logičke aplikacije: Azure Logic Apps platforma je u oblaku na kojoj možete stvarati i pokretati automatizirane tijekove rada s malo ili nimalo koda. Pomoću vizualnog dizajnera i odabirom unaprijed izrađenih operacija možete brzo izraditi tijek rada koji integrira vaše aplikacije, podatke, usluge i sustave i upravlja njima.

Sljedeća tablica ukratko definira osnovnu terminologiju i koncepte u aplikacijama Azure Logic Apps.

Pojam Opis
Logička aplikacija Resurs servisa Azure koji stvarate kada želite izgraditi tijek rada. Postoji više vrsta resursa logičke aplikacije koje se izvode u različitim okruženjima.
Workflow Niz koraka koji definiraju zadatak, poslovni proces ili radno opterećenje. Svaki tijek rada započinje jednim okidačem, nakon čega morate dodati jednu ili više akcija.
Okidač Uvijek prvi korak u bilo kojem tijeku rada i određuje uvjet za izvođenje daljnjih koraka u tom tijeku rada. Na primjer, u ovom ćemo članku koristiti HTTP okidač za pokretanje logičkih aplikacija i prosljeđivanje parametara okidača kao sadržaja tijela.
Radnja Svaki sljedeći korak u tijeku rada koji slijedi okidač. Svaka akcija pokreće neku operaciju u tijeku rada.
Predložak Azure Resource Manager (ARM) ARM predložak je JavaScript Object Notation (JSON) datoteka koja definira infrastrukturu i konfiguraciju vašeg projekta. Predložak koristi deklarativnu sintaksu. U deklarativnoj sintaksi opisujete namjeravanu implementaciju bez pisanja slijeda programskih naredbi za stvaranje implementacije.

Preduvjeti za rješenja davatelja usluga

Microsoft Cloud for Sustainability A njegovi partneri izradit će konektore za rješenje kako bi dobili potpune skupove podataka za Microsoft Sustainability Manager jednu ili više kategorija emisija ugljika i održivosti. Konektori moraju ispunjavati sljedeće zahtjeve:

  • Budite dostupni u svim zemljopisnim područjima i služite različitim vrstama industrije kupaca i operativnim veličinama.

  • Dopusti razdvajanje korisnika za vjerodajnice za povezivanje (ciljni administrator sustava) i konfiguraciju veze (Microsoft Sustainability Manager korisnik).

  • Pružite alate za razvojne inženjere, memoriju za testiranje i popratnu dokumentaciju za izradu POC-a ako je potrebno.

Osim toga, svaki poveznik mora sadržavati sljedeće stavke:

  • Podaci o djelatnosti, referentni podaci ili unaprijed izračunate emisije ključne za definiranje prava na ugljik i održivost

  • Mogućnost dohvaćanja podataka iz partnerskog rješenja autentifikacijom putem korisničkih vjerodajnica

  • Mogućnost automatizacije mapiranja podataka entiteta i atributa

Dizajn poveznika logičkih aplikacija na visokoj razini

Sljedeći dizajn konektora logičkih aplikacija na visokoj razini uključuje kratak pregled tijeka gutanja iz perspektive korisnika. Ovi koraci nisu oni koje biste slijedili za stvaranje poveznika, već pregled načina na koji se poveznik koristi.

  1. Odabir poveznika:

    1. Od korisnika će se zatražiti vrsta podataka koje želi unijeti zajedno s opsegom i kategorijom.
    2. U sljedećem koraku prikazuje Power Query se popis i prilagođeni poveznici koji podržavaju vrstu podataka, opseg i kategoriju koju je korisnik odabrao.

  2. Odabir vjerodajnica:

    1. Da bi stvorili novu vjerodajnicu za poveznik logičkih aplikacija, korisnici moraju navesti vjerodajnice.
    2. Microsoft Sustainability Manager Provjerava valjanost vjerodajnica pomoću protokola koji je odredio partner i šalje zahtjev za povezivanje pozadinskom sustavu.

  3. Stvaranje i pokretanje veze:

    1. Da bi ispunio zahtjev za povezivanjem, Microsoft implementira instancu logičkih aplikacija pomoću ARM predloška koji je odredio partner. ARM predložak trebao bi slijediti paradigmu konektora opisanu kasnije u ovom članku.
    2. Nakon što se instanca logičkih aplikacija implementira, pokreće se jednom i korisnik je može zakazati za dnevna trčanja. Stvaranje veze sada je dovršeno.
    3. Korisnik po želji može sam pokrenuti instancu Logic Apps iz korisničkog sučelja.

  4. Gutanje u Dataverse:

    1. Svako izvršavanje tijeka rada logičkih aplikacija (bilo da se pokreće ručno ili zakazano) šalje transformirane podatke u dijelovima putem HTTPS poziva mikroservisu Održivost. Podaci bi se zatim potvrdili i progutali u okruženje kupca.

  5. Brisanje veze:

    1. Brisanjem veze upravlja okvir logičkih aplikacija. Kada korisnik izbriše vezu logičkih aplikacija, poništavamo dodjelu resursa instanci logičkih aplikacija za navedenu vezu, a zatim brišemo samu vezu.
    2. Brisanje entiteta veze također bi kaskadno izbrisalo ID-ove osvježavanja veze.

Sastavljanje poveznika logičkih aplikacija

Da biste stvorili poveznik drugog proizvođača, slijedite ove korake da biste sastavili definiciju poveznika Microsoft Sustainability Manager, definiciju davatelja usluga, ARM predložak logičkih aplikacija i konfiguraciju vjerodajnica. Dodajte ove datoteke u privatno spremište GitHuba i dodajte naš tim kao suradnik: mcfsconnectors@microsoft.com.

Prvi korak: pregled podataka

Prvi korak u izgradnji konektora uključuje pregled vrste podataka dostupne iz partnerskog rješenja i njegove primjene unutar Microsoft Sustainability Manager. Te vrste podataka mogu uključivati podatke o djelatnosti, referentne podatke ili unaprijed izračunate emisije, a sve su ključne za definiranje prava na ugljik i održivost.

Drugi korak: definiranje poveznika i davatelja usluga ili partnera

Sljedeći korak za izgradnju konektora uključuje prikupljanje dodatnih informacija o rješenju s kojim se integrira Microsoft Sustainability Manager.

  • Definicija davatelja usluga:

    Informacije Opis
    Ime/naziv Naziv vaše tvrtke.
    Opis Kratak opis vaše tvrtke.
    Logotip Logotip tvrtke u SVG formatu.
    URL URL tvrtke.

  • Definicija poveznika:

    Informacije Opis
    Ime/naziv Poveznik zaslonsko ime.
    Opis Kratak opis od dvije rečenice o povezniku.
    Logotip Ikona poveznika u SVG formatu.
    Vrsta podataka Vrsta podataka koju ovaj poveznik unosi za korisnika. Na primjer: Podaci o aktivnosti, opseg 1, kategorija 2. Dodatne informacije o vrstama podataka potražite u odjeljku Zapis.

Ova slika pruža primjer prikaza poveznika. Ovaj primjer prikazuje ogledni logotip. Distribucijski podatkovni konektor je zaslonsko ime, Johnnie McConnel je ime davatelja usluga, a naši interni podaci su opis.

Ogledni prikaz poveznika logičkih aplikacija.

Treći korak: definiranje izvor podataka

Prije stvaranja logičke aplikacije morate definirati izvor podataka i način na koji mu se može pristupiti pomoću korisničkih vjerodajnica. Evo nekoliko primjera za referencu:

  • HTTP REST: HTTP REST API možete izložiti da biste podatke izložili logičkoj aplikaciji. Za pristup tim podacima iz naše logičke aplikacije možete koristiti HTTP mehanizme provjere autentičnosti.

  • Azure Data Lake Storage: <https://<adlsname>.blob.core.windows.net/<naziv> mape/<naziv>> datoteke, u kojem slučaju bi logičkoj aplikaciji bio potreban relevantan pristup ovom URL-u s odgovarajućim SAS tokenom.

  • MySQL tablica:jdbc:mysql:replication//myUser: <myPassword@[address=(host=myHost1)(port=1111)(key1=value1)]> Podaci se mogu pohraniti u bazu podataka. U tom slučaju logička aplikacija može zahtijevati krajnja točka baze podataka zajedno s valjanim korisničkim ID-om i lozinkom. Može zahtijevati i naziv tablice u kojoj se pohranjuju podaci koje treba progutati. Dodatne informacije o povezivanju s SQL bazom podataka potražite u članku Povezivanje s SQL bazom podataka iz tijekova rada u aplikacijama Azure Logic.

  • AWS S3:s3.Region.amazonaws.com <Podaci mogu biti pohranjeni u S3> kanti ili sličnoj pohrani datoteka. Instanca logičkih aplikacija zahtijevala bi odgovarajuću kontrolu pristupa za pristup ovoj grupi za pohranu.

Četvrti korak: pribavljanje informacija o vjerodajnicama

Nakon što definirate detalje o izvor podataka i pristupu, morate navesti podatke o vjerodajnicama koje korisnik mora prikupiti za provjeru autentičnosti izvorišnih podataka.

Za poveznike Microsoft Sustainability Manager drugih proizvođača trenutno ne podržava SSO. Vjerodajnice će se prikupljati i pohranjivati u okruženju klijenta Dataverse .

Kada korisnici stvore vezu logičkih aplikacija iz, Microsoft Sustainability Manager od njih će se zatražiti stranica slična sljedećoj slici za unos relevantnih pojedinosti o vezi između Microsoft Sustainability Manager hostirane logičke aplikacije i partnera.

Snimka zaslona stranice Dodavanje vjerodajnica.

Napomena

Stranica Dodavanje vjerodajnica dinamička je stranica koja se može razlikovati ovisno o povezniku partnera. Ta su polja definirana JSON datotekom i mogu se razlikovati za svaki poveznik, kako je definirao partner. Provjera valjanosti provodi se kako bi se osiguralo da su te vjerodajnice valjane prije spremanja.

Microsoft će izraditi stvarnu JSON datoteku za stranicu vjerodajnica. Samo trebate odgovoriti na sljedeća pitanja kako bismo generirali datoteku.

Pitanje Primjer
Koje podatke o vjerodajnicama trebate od korisnika? Korisničko ime, lozinka, tajne, API ključ itd.
Koje su različite vrste polja? Podržavamo sve vrste HTML ulaza kao što su tekstni okvir, potvrdni okvir, padajući izbornik, izborni gumb itd. Korisničko ime: tekstni okvir,Lozinka : tekstni okvir,Regija: padajući izbornik.
Unesite naziv polja koja je potrebno maskirati. Lozinka, tajna.
Unesite URL sa zaglavljima i tijelom gdje možemo uputiti HTTP poziv s vjerodajnicama za provjeru valjanosti. Dodajte i odgovor sa sadržajem odgovora i kodom stanja. POST: https:api.partner.com/token
Tijelo:"korisničko ime":"xyz", "lozinka":"test"Odgovor:"status":"poruka":"vrsta":
{

}




}

Peti korak: stvaranje logičke aplikacije

Sljedeći korak uključuje stvaranje logičke aplikacije. Microsoft će ponuditi ogledni ARM predložak koji možete prenijeti u pretplatu na Azure i početi ga koristiti za razvoj logičke aplikacije koja izvodi sljedeće akcije:

  • Koristite korisničke vjerodajnice za provjeru autentičnosti njihovog sustava i dobivanje podataka iz izvor podataka na određeni način.

  • Primijenite transformacije i mapirajte podatke na podatkovni model održivosti ili model podataka o vodi.

  • Dodajte transformirane podatke u JSON polje.

Da biste automatski implementirali predložak logičke aplikacije na Azure, možete odabrati sljedeći gumb Implementiraj na Azure , koji vas prijavljuje na portal Azure i traži ID pretplate i naziv grupe resursa u kojem će se ta logička aplikacija implementirati.

Implementacija na Azure

Ova ogledna logička aplikacija početna je točka za poveznik prve strane. Ulazi za ovaj poveznik šalju se putem HTTPS okidača iz Microsoft Sustainability Manager korisničke instance. Ovaj HTTP okidač sadrži detalje navedene tijekom postavljanja poveznika (uključujući prilagođene krajnja točka i vjerodajnice).

Nakon implementacije logičke aplikacije možete je pregledati i urediti iz dizajnera aplikacije:

Snimka zaslona dizajnera aplikacija.

Kratak opis akcija:

  1. Okidač:pokrenut će aplikaciju Logika partnera putem HTTP okidača koji prolazi detalje veze koje je dostavio klijent iz Microsoft Sustainability Manager četvrtog koraka: pribavite podatke o vjerodajnicama. Logičke aplikacije partnera koristit će podskup sljedećih parametara okidača:

    Snimka zaslona parametara okidača.

    • ID klijenta i tajna klijenta: vjerodajnice koje korisnik unosi na stranicu vjerodajnica iznutra Microsoft Sustainability Manager. Ti se parametri mogu razlikovati ovisno o tome kako provjeravate autentičnost izvor podataka. Na primjer, umjesto ID-a klijenta i tajne, možete koristiti korisničko ime, lozinku ili API ključ. Zamijenite ih vjerodajnicama koje ste identificirali u prethodnom koraku.

    • Vrijeme zadnjeg osvježavanja: ovaj je parametar vremenska oznaka u UTC vremenskoj zoni i koristi se za postupno osvježavanje. Logička aplikacija trebala bi povlačiti i obrađivati podatke samo tamo gdje dataCreateTime>= lastRefreshTime.

  2. InitializeContinuationToken: Ova akcija inicijalizira varijabluContinuationToken na null. Ta će se varijabla zatim koristiti za izlaz iz petlje do petlje, koja povlači podatke na određeni način.

  3. Pokušajte: Svaka logika povlačenja i transformacije podataka trebala bi biti unutar bloka pokušaja. Ako bilo koji korak unutar bloka pokušaja ne uspije, tijek izvršavanja preskočit će se u blok hvatanja, gdje će Microsoftov tim dodati logiku za obradu scenarija pogrešaka. Sljedeća slika prikazuje akcije unutar bloka pokušaja.

    Snimka zaslona bloka pokušaja.

Akcija dohvati token koristi vjerodajnice korisnika za dobivanje pristupni token i korištenje za pozivanje krajnja točka partnera i povezivanje s izvor podataka radi dohvaćanja korisničkih podataka. Ovisno o veličini podataka, podacima s vašeg izvor podataka treba pristupiti na određeni način kako bi se izbjeglo vremensko ograničenje. Sljedeći korak preslikat će vaše podatke na podatkovni Microsoft Sustainability Manager model.

Snimka zaslona mapiranja podataka u podatkovni Microsoft Sustainability Manager model.

Ovaj predložak koristi entitet Kupljena električna energija kao primjer za prikaz logike mapiranja , ali podatke ćete morati mapirati u entitet koji vaš poveznik podržava. Nakon mapiranja podataka pohranit ćete podatkovno polje u varijablu i poslati podatke Microsoft Sustainability Manager u POST zahtjevu. PostDataToMSM primjer je kako treba konstruirati HTTP zahtjev.

Podatke možete slati Microsoft Sustainability Manager u više serija upućivanjem više POST zahtjeva ili odjednom, ovisno o veličini podataka. Akcija Dovrši gutanje pokazuje kako bi trebao izgledati posljednji zahtjev Microsoft Sustainability Manager . Microsoft poziva istu krajnja točka i postavlja varijablu isIngestionComplete na true. Nakon ovog zahtjeva, Microsoft Sustainability Manager započet će s obradom podataka kako bi ih progutao u okruženje kupca.

Na sljedećoj je slici prikazan primjer strukture zapisa podataka:

Snimka zaslona s načinom strukturiranja zapisa podataka.

Šesti korak: slanje datoteka poveznika

Sve datoteke stvorene u prethodnim koracima morate dodati u privatno spremište GitHuba i dodati Microsoftov tim kao suradnik. Korijenska mapa spremišta trebala bi biti broj verzije (na primjer, v1.0), a sljedeće datoteke trebaju biti u mapi:

  • logic_apps_armtemplate.json
  • credentials_info.csv
  • connector_definition.csv
  • provider_definition.csv
  • company_logo.svg
  • connector_logo.svg

Microsoftov tim započet će postupak provjere valjanosti logičke aplikacije i dodavanja dodatnih akcija za dovršetak postupka gutanja. Nakon koraka provjere valjanosti Microsoft će stvoriti Microsoft Sustainability Manager okruženje s operativnim poveznikom kako bi partner testirao funkcionalnost. Microsoft će također provesti vlastito funkcionalno testiranje prije pokretanja mogućnosti za korisnike u pretpregledu ili općoj dostupnosti.

Zahtjevi za podršku davatelja usluga ili partnera

Partner je vlasnik održavanja i rada izvor podataka. Potrebna nam je osoba za kontakt s ugovorom o razini usluge (SLA) s kojom se Microsoftov tim može obratiti tijekom prekida rada i pogrešaka povezanih s rješenjem. Sljedeći scenariji su primjeri za koje će biti potrebna podrška partnera:

  • Promjena podatkovnog modela: Jedan od najkritičnijih koraka u izgradnji integracije s je mapiranje podatkovnog modela partnerskog rješenja s Microsoft Sustainability Manager modelom podataka o održivosti. Ako se podatkovni model partnerskog rješenja promijeni, partner će morati surađivati s timom Microsoft Sustainability Manager kako bi ponovno mapirao podatkovni model ili pružio ažurirani ARM predložak i osigurao da se potrebni atributi podataka mogu dobiti iz njihovog rješenja.

  • Upravljanje vjerodajnicama: Primarni mehanizam za pristup partnerskom rješenju unutar Microsoft Sustainability Manager je putem vjerodajnica iz partnerskog rješenja. Ako korisnici ne mogu provjeriti autentičnost svojih vjerodajnica, partner će pružiti podršku za provjeru autentičnosti i ažuriranje korisničkih vjerodajnica Microsoft Sustainability Manager.

  • Rješenje nije u funkciji: Partner će također morati pomoćii svojim korisnicima u Microsoft Sustainability Manager situacijama kada njihovo rješenje nije operativno ili funkcionalno. Microsoft Sustainability Manager surađivat će s partnerom kako bi utvrdio rokove uzroka i rješavanja kako bi mogao komunicirati s krajnjim korisnicima.

  • Ažuriranja rješenja: partner mora pružiti prethodnu obavijest prije bilo kakvih većih ažuriranja, zajedno s potencijalnim utjecajem na korisnički pristup unutar Microsoft Sustainability Manager. Prije integracije rješenja unutar Microsoft Sustainability Manager, partner će pružiti okvirne rokove za kadencu ažuriranja rješenja zajedno s popratnom dokumentacijom o tome kako će proširiti podršku Microsoft Sustainability Manager i njegove korisnike u slučaju da ne mogu pristupiti rješenju davatelja usluga i uvesti podatke.

  • Testno okruženje: Partner mora osigurati testno okruženje za Microsoft Sustainability Manager testiranje mogućnosti prije nego što ih uvede svojim kupcima.

Slučajevi ažuriranja

Za sva ažuriranja logičke aplikacije ili konfiguracije poveznika, partner mora stvoriti novu mapu u korijenu spremišta s novim brojem verzije (na primjer, v2.0) i dodati sve datoteke u tu mapu. Partner također mora uključiti datoteku readme.md u mapu s kratkim objašnjenjem onoga što je ažurirano. Nakon što Microsoft primi ažurirane datoteke, slijedit ćemo isti postupak kao i za objavljivanje prve verzije poveznika. Nakon što se ažurirana logička aplikacija objavi krajnjem korisniku, logičke aplikacije za postojeće veze bit će uklonjene, a najnovija verzija bit će implementirana. Ovaj proces rješava naš sustav usporedbom brojeva verzija u ARM predlošku.

Zahtjevi u pogledu usklađenosti

Značajke i servisi Microsoftovih proizvoda moraju proći kroz preglede privatnosti, sigurnosti i usklađenosti prije nego što se prebace u proizvodnju. Microsoftov tim bit će vlasnik i upravljati tim procesom, ali će zahtijevati koordinaciju s partnerskim timom kako bi prikupio potrebne informacije o njihovom rješenju s Microsoft Sustainability Manager kojim se integrira.

Pogledajte

Uvoz podataka
Podatkovni model dokumentacije
Microsoft Sustainability Manager
Microsoft Cloud for Sustainability aplikacija Azure Logic Apps