Yleinen REST API -liitin
Opi helposti muodostamaan yhteys useisiin REST API -rajapintoihin ja olemaan niiden kanssa vuorovaikutuksessa käyttämällä mukautettavaa ja monipuolista yleistä REST API -liitintä.
Yleinen REST API -liitin
Opi helposti muodostamaan yhteys useisiin REST API -rajapintoihin ja olemaan niiden kanssa vuorovaikutuksessa käyttämällä mukautettavaa ja monipuolista yleistä REST API -liitintä.
Yleinen REST API -liitin
Yleinen REST API -liitin on osa Pro Engine Native Connectors -liitintä, ja sitä käytetään tässä ensimmäisessä versiossa datan kirjoittamiseen asiakkaan kolmannen osapuolen ratkaisuun, joka tarjoaa REST API . Sitä voidaan käyttää kaikissa Matrix42 Core , Pro and IGA ratkaisuissa, jotka käyttävät liitinten hallintaa (EPE).
Julkaisussa 2025.2 esiteltiin tämä uusi yleinen REST API -liitin tapahtumapohjaisilla tehtävillä.
Julkaisussa 2025.3 esiteltiin ajoitettujen tehtävien tuki tälle yleiselle REST API -liittimelle.
Kohtuullisen käytön käytäntö
Liitintä saa käyttää rajoituksetta normaaleissa käyttöolosuhteissa. Jos käyttö kuitenkin lisää merkittävästi kuormitusta ja vaatii lisää pilviresursseja (esim. muistia tai prosessointikapasiteettia), siitä voidaan periä lisämaksuja.
Tämän liittimen käyttäminen käyttäjätilien tai ryhmäobjektien luomiseen, päivittämiseen tai poistamiseen edellyttää aktiivista IGA lisenssiä.
Yleinen REST API -liitin vaatii konfiguroinnin asiakkaan käyttötapauksen mukaan, ja periaatteessa konfiguroinnissa on kolme vaihetta:
- Yhdistimen määrittäminen – mahdollistaa yhdistimen yhteyden muodostamisen REST API tarjoavaan ratkaisuun
- Tapahtumatehtävän konfigurointi – käytetään, kun tietoja kirjoitetaan (tapahtumapohjaiset kutsut työnkulun orkestrointisolmusta) REST API tarjoavaan ratkaisuun.
- Työnkulun orkestrointisolmujen määrittäminen tapahtumapohjaisten tehtävien käyttämiseksi
Yleiset toiminnot
Liittimet - yleiset toiminnot
Liittimet - yleiset toiminnot
Tässä artikkelissa kuvataan yleisiä toimintoja natiivien liittimien hallintaan ratkaisussa. Kaikkia natiiveja liittimiä hallitaan samasta liittimien hallintakäyttöliittymästä.
Huomaa, että jokaiselle liittimelle on omat kuvauksensa, joissa liittimen toiminnot ja konfigurointiohjeet on kuvattu yksityiskohtaisesti.
Päästäkseen liittimien hallintaan käyttäjällä on oltava järjestelmänvalvojan tason oikeudet asiakkaan alustan määrityksiin. Kun käyttöoikeudet on myönnetty oikein, liittimien välilehti tulee näkyviin ja käyttäjä voi hallita liittimiä.
Vasen valikko
Liittimien hallinta on jaettu neljään välilehteen:
- Yleiskatsaus – natiivien liittimien luomiseen ja päivittämiseen. Järjestelmänvalvoja voi nähdä niiden tilan, tyypin ja kuinka monta ajoitettua tai tapahtumatehtävää niihin liittyy.
- Todennus – todennustehtävien luomiseen ja päivittämiseen. Todennuksen Pro tarvitaan, jotta Secure Access voi määrittää, mitkä asiakkaiden loppukäyttäjät voivat käyttää Matrix42 Core , Pro and IGA -kirjautumissivua.
- Lokit – Native Connector- ja Secure Access -lokien lataamiseen käyttöliittymästä.
- Asetukset – yleiset asetukset natiiveille liittimille ja Secure Access , mukaan lukien lokinkirjauksen ja valvonnan ympäristötyyppi.
Liittimien yleiskatsausvälilehti
Yleiskatsaussivulta käyttäjä voi helposti ja nopeasti nähdä kaikkien liittimien tilan.
Yläpalkki:
- Natiiviliittimien (EPE) tila
- Vihreä teksti osoittaa, että Native Connectors on verkossa. Kaikki tarvittavat palvelut ovat toiminnassa.
- Punainen teksti osoittaa, että natiiviliittimissä on ongelma, eivätkä kaikki palvelut ole käynnissä.
- Secure Access tila ( ESA )
- Vihreä teksti osoittaa, että Secure Access on verkossa. Kaikki tarvittavat palvelut ovat käytettävissä.
- Punainen teksti osoittaa, että Secure Access on ongelma eikä mikään palvelut ole käynnissä.
- Natiiviliittimien versionumero näkyy oikeassa yläkulmassa
Listanäkymän yläpalkki:
- Uusi liitin - avaa uuden ikkunan uuden liittimen lisäämistä ja määrittämistä varten
- Poista yhdistin(et) - työnkulkuviittaukset lasketaan ja näkyviin tulee ponnahdusikkuna poiston vahvistamiseksi (huomaa, että viittausten laskeminen voi kestää useita sekunteja)
- Vienti - Ylläpitäjä voi viedä yhden tai useamman liittimen (ja tehtävän) ympäristöstä. Yleensä käytetään liittimien ja liittimien (ja tehtävien) viemiseen testiympäristöstä tuotantoympäristöön. Natiivien liittimien salaiset tiedot on suojattu salasanalla.
- Tuonti – Ylläpitäjä voi tuoda yhden tai useamman liittimen (ja tehtävän) ympäristöön. Yleensä käytetään liittimien (ja tehtävien) tuomiseen testistä tuotantoympäristöön.
- Ylläpitäjä ei voi tuoda tietoja vanhasta EPE-käyttöliittymästä (vanhempi kuin 2024.1) uuteen. Lähde- ja kohdeympäristöjen versioiden on oltava samat.
- Tuonti epäonnistuu, jos määritykset (mallit, määritteet) eivät ole samat – esimerkiksi jos jokin määrite puuttuu.
- Jos tuot jotain, jolla on samat liittimen tiedot, se yhdistetään olemassa olevan liittimen alle.
- Päivitä – Ylläpitäjä voi päivittää yhdistinnäkymän napsauttamalla painiketta .
Yleiskatsaus luettelonäkymässä,
- Valitse liittimet - Valitse yksi liitin napsauttamalla liitinrivin edessä olevaa valintaruutua tai napsauta otsikkorivin valintaruutua, jolloin kaikki liittimet valitaan.
- Id - Liittimen automaattisesti luotu yksilöllinen tunnus. Sitä ei voi muokata tai muuttaa.
- Tila - ilmaisee ajoitetun tehtävän tilan
-
Vihreä valintamerkki - Tehtävä suoritetaan ilman virheitä
-
Punainen risti - Tehtävä on suoritettu, mutta on tapahtunut virhe
-
Harmaa kello - Tehtävää ei ole vielä suoritettu, odotetaan ajoitusta -
Oranssi - yhdessä tehtävistä on ongelma
- Ei arvoa - Ajoitettu tehtäväpohjainen tieto puuttuu
-
- Nimi - Liittimen nimi lisätty liittimen asetuksiin. Yhden tietolähteen kokoonpanoa sisältävän liittimen yksilöllinen nimi.
- Tyyppi - osoittaa kohde-/lähdejärjestelmän
- Ajoitettu - kertoo, kuinka monta ajoitettua tehtävää on määritetty
- Tapahtuma - kertoo, kuinka monta tapahtumatehtävää on määritetty
- Hallitse
- Kynäkuvake - avaa yhdistimen asetukset (yhdistimen rivin kaksoisnapsauttaminen avaa myös asetukset)
- Paperikuvake - kopioi liittimen
- Pysäytä - työnkulkuviittaukset lasketaan ja näkyviin tulee ponnahdusikkuna poiston vahvistamiseksi
- Haku - Käyttäjä voi hakea liitintä kirjoittamalla hakusanan vastaavaan kenttään. Haku voidaan tehdä kentistä Tunnus, Tila, Nimi, Tyyppi, Aikataulutettu ja Tapahtuma.
Ajoitetun tehtävän tiedot (napsauta yhdistimen edessä olevaa nuolta)
Kun napsautat yhdistinrivin alussa olevaa nuolta, kaikki asiaankuuluvat ajoitetut tehtävät ja tapahtumatehtävät tulevat näkyviin.
Yläpalkki ajoitetuille tehtäville
- Uusi tehtävä - avaa uuden tehtävän määrityssivun
- Poista tehtävä(t) - poistaa valitut tehtävät järjestelmästä, eikä niitä voida enää palauttaa.
- Päivitä - päivitä ajoitettujen tehtävien näkymä
- Haku – käyttäjä voi hakea tehtäviä kirjoittamalla hakusanan vastaavaan kenttään, kuten Tunnus, Nimi, Käytössä tai Poiminnan/Lataamisen tila.
Ajoitettujen tehtävien luettelonäkymä
- Valitse tehtävä(t) - Valitse poistettava tehtävä luettelonäkymästä rastittamalla se.
- Id - Tehtävän yksilöllinen tunniste. Luodaan automaattisesti, eikä sitä voi muuttaa.
- Nimi - Tehtävän nimi lisätty tehtäväasetuksiin, tehtävän yksilöivä nimi.
- Käytössä - Näyttää, onko tehtävä ajoitettu vai ei
-
Vihreä valintamerkki - Tehtävä on ajoitettu
-
Punainen Risti - Tehtävää ei ole ajoitettu
-
- Poiminnan tila – Näyttää kohdehakemistosta/järjestelmästä poimitun tiedon tilan
- Vihreä valintamerkki - tiedot on purettu onnistuneesti
- Punainen risti - tiedot on poimittu virheellisesti tai poiminta epäonnistui
-
Kello - Tehtävä odottaa suoritusta
-
- Lataustila - Näyttää datan viennin tilan JSON-tiedostosta asiakkaan ratkaisuun
- Vihreä valintamerkki - tiedot on tuotu onnistuneesti asiakkaan ratkaisuun
-
Punainen risti - tietojen tuonnissa on virheitä tai tuonti epäonnistui
-
- Hallitse
- Kynäkuvake - avaa tehtävän asetukset omaan ikkunaansa (tehtävärivin kaksoisnapsauttaminen avaa myös tehtävän asetukset)
- Paperikuvake - kopioi tehtävän
- Kellokuvake - avaa tehtävähistorianäkymän
- Pysäytä - poista tehtävä, ponnahdusikkuna avautuu poiston vahvistamiseksi
Ajoitettujen tehtävien historianäkymä
Napsauttamalla ajoitettujen tehtävien rivillä olevaa kellokuvaketta saat näkyviin ajoituksen historian.
Katseluhistorian yläpalkki
- Päivitä - päivittää ajoitetun tehtävän tilan. Tämä ei vaikuta tehtävään, vaan päivittää käyttöliittymän näyttämään tehtävän suorituksen uusimmat tiedot.
Ajoitettujen tehtävien historian luettelonäkymä
- Rivin väri ilmaisee tilan
- Vihreä - tehtävä suoritettu onnistuneesti
- Punainen - suorituksen aikana tapahtui virhe
-
- Suoritustunnus – ajoitetun tehtävärivin yksilöivä tunnus
- Suunniteltu purkuaika - milloin seuraava purku hakemistosta/sovelluksesta on ajoitettu tapahtumaan
- Poiminnan valmistumisaika - milloin poiminta valmistui
- Purkamisen tila - hakemistosta/sovelluksesta haettavien tietojen tila
- Kuorman aloitusaika - milloin seuraava lataus asiakkaalle on ajoitettu tapahtumaan
- Kuormauksen valmistumisaika - milloin kuormitus on valmis
- Lataustila - tiedon lataustila asiakasratkaisuun
Ajoitettujen tehtävien tilan luettelonäkymä
- Todellinen aloitusaika - todellisen aloituksen aikaleima
- Käyttäjätiedosto - JSON-tiedosto, joka sisältää hakemistosta/sovelluksesta luetut käyttäjätiedot
- Ryhmätiedosto - JSON-tiedosto, joka sisältää hakemistosta/sovelluksesta luetut ryhmätiedot
- Yleinen tiedosto - JSON-tiedosto, joka sisältää hakemistosta/sovelluksesta luettuja yleisiä tietoja
- Poimi tiedot - yksityiskohtaisia tietoja tietojen lukemisesta hakemistosta/sovelluksesta
- Lataustiedot - yksityiskohtaiset tiedot tietojen lataamisesta asiakkaille Matrix42 Core , Pro and IGA -ratkaisussa
Ajoitetun tehtävän muokkausikkuna
Ajoitetun tehtävän määritykset voidaan avata napsauttamalla kynäkuvaketta tai kaksoisnapsauttamalla tehtäväriviä.
Vasemmanpuoleinen valikko ja ominaisuudet vaihtelevat valittujen asetusten mukaan, joten tarkemmat ohjeet tehtävien muokkaamiseen löytyvät liittimen kuvauksesta, mutta kaikille ajoitetuille tehtäville on yhteisiä toimintoja, jotka on kuvattu alla.
Tehtävän tallentaminen
Jos tehtävästä puuttuu pakollisia tietoja, hiiren vieminen tallennuspainikkeen päälle näyttää, mitkä ominaisuudet ovat vielä tyhjiä.
Yläpalkki ajoitetun tehtävän muokkaamista varten
- Suorita tehtävä manuaalisesti - ylläpitäjä voi suorittaa tehtävän manuaalisesti määritetyn aikataulun ulkopuolella
- Pysäytä tehtävä - ylläpitäjä voi pysäyttää parhaillaan käynnissä olevan ajoitetun tehtävän. Tehtävä pysäytetään ja sen tilaksi muutetaan pysäytetty. Se odottaa tässä tilassa seuraavaa ajastusta.
- Tyhjennä datavälimuisti - Käyttäjien ja ryhmien seuraavan käyttöönoton datavälimuisti tyhjennetään. Tämä tarkoittaa, että seuraava suoritus suoritetaan ensimmäisenä suorituksena.
- Oletusarvoisesti tyhjennämme välimuistin joka päivä klo 00:00 UTC
- Jos haluat tyhjentää välimuistin eri aikoina, sen on määritettävä jokin eri arvo isäntätiedostossa 'custom.properties'.
- EPE-välimuisti tyhjennetään myös, kun EPE käynnistetään uudelleen, koko ympäristö käynnistetään uudelleen tai EPE-määrityksiä on muutettu.
Tapahtuman tehtävän tiedot
Kun napsautat yhdistinrivin alussa olevaa nuolta, kaikki asiaankuuluvat ajoitetut tehtävät ja tapahtumatehtävät tulevat näkyviin.
Tapahtumatehtävien yläpalkki
- Uusi tehtävä - avaa uuden tapahtumatehtävän määrityssivun
- Poista tehtävä(t) - poistaa valitut tehtävät, näkyviin tulee ponnahdusikkuna poiston vahvistamiseksi
- Päivitä – päivittää tapahtuman tehtävänäkymän
- Näytä työnkulkuviittaukset - laskee tehtäviin liittyvät työnkulkujen suhteet ja tilat. Tämä on erittäin hyödyllistä, jos et tiedä, mistä työnkuluista tapahtumapohjaisia tehtäviä käytetään.
Tapahtumatehtävien luettelonäkymä
- Valitse tehtävä(t) - Valitse poistettava tehtävä luettelonäkymästä rastittamalla se.
- Id - Tehtävän yksilöllinen tunniste. Luodaan automaattisesti, eikä sitä voi muuttaa.
- Nimi - Tehtävän nimi lisätty tehtäväasetuksiin, tehtävän yksilöivä nimi.
- Työnkulkusuhteet
- Kysymysmerkki näyttää ponnahdusikkunan, jossa on yksityiskohtaisia tietoja viitteestä
- Työnkulun tila
- Ei käytössä - Ei yhteyksiä työnkulkuun
- Käytössä - Työnkulku(t) on liitetty tehtävään, tehtävää ei voi poistaa
- Hallitse
- Kynäkuvake - avaa tehtävän asetukset omaan ikkunaan
- Paperikuvake - kopioi tehtävän
- Pysäytä-kuvake - poistaa tehtävän, näkyviin tulee ponnahdusikkuna poiston vahvistamiseksi
Tapahtumatehtävän muokkausikkuna
Tapahtumatehtävän määritykset voidaan avata napsauttamalla kynäkuvaketta tai kaksoisnapsauttamalla tehtäväriviä.
Vasemmanpuoleinen valikko ja ominaisuudet vaihtelevat valittujen asetusten mukaan, joten tarkemmat ohjeet muokkaustehtäviin löytyvät liittimen kuvauksesta, mutta kaikille tapahtumatehtäville on yhteisiä toimintoja, jotka on kuvattu alla.
Muokkaa tapahtumaa -tehtäväikkuna
- Tehtävän käyttö, muokattavissa? - tämä tulee näkyviin, kun olemassa olevan tehtävän muokkaaminen ja tehtävän käyttötyypin muuttaminen rikkoo työnkulut
- Määritysten tyyppi, muokattavissa? - Tämä tulee näkyviin, kun muokataan olemassa olevaa tehtävää ja määritysten tyypin muuttaminen rikkoo työnkulut
Tehtävän tallentaminen
Jos tehtävästä puuttuu pakollisia tietoja, hiiren vieminen tallennuspainikkeen päälle näyttää, mitkä ominaisuudet ovat vielä tyhjiä.
Todennus-välilehti
Matrix42 Core , Pro and IGA ratkaisujen todennus määritetään todennusvälilehdeltä. Huomaa, että vain osa liittimistä (hakemistoliittimet) tukee todennusta, joten todennustehtäviä ei ole mahdollista luoda kaikille käytettävissä oleville liittimille.
Yläpalkki todennusta varten
- Uusi liitin - avaa uuden ikkunan uuden liittimen määrittämiseen (huomaa, että kaikki liittimet eivät tue todennusta)
- Poista yhdistin(et) - poistaa valitut tehtävät, näkyviin tulee ponnahdusikkuna poiston vahvistamiseksi
- Vienti - käyttäjä voi viedä yhden tai useamman tehtävän ympäristöstä. Yleensä käytetään tehtävien vientiin testiympäristöstä tuotantoympäristöön. EPE-liittimet on suojattu salasanalla.
- Huomaa, että todennustehtävien aluetta ei viedä, se on määritettävä manuaalisesti tuonnin jälkeen.
- Tuonti - käyttäjä voi tuoda yhden tai useamman tehtävän ympäristöön. Yleensä käytetään tehtävien tuomiseen testistä tuotantoympäristöön.
- Päivitä – päivittää todennustehtävien näkymän
Todennuksen yleiskatsauksen luettelonäkymä
- Valitse liittimet - Valitse yksi liitin napsauttamalla liitinrivin edessä olevaa valintaruutua tai napsauta otsikkorivin valintaruutua, jolloin kaikki liittimet valitaan.
- Id - Liittimen automaattisesti luotu yksilöllinen tunnus. Sitä ei voi muokata tai muuttaa.
- Nimi - Liittimen nimi lisätty liittimen asetuksiin. Yhden tietolähteen kokoonpanoa sisältävän liittimen yksilöllinen nimi.
- Tyyppi - osoittaa kohde-/lähdejärjestelmän
- Määrä - kertoo, kuinka monta todennustehtävää on määritetty
- Hallitse
- Kynäkuvake - avaa todennustehtävän asetukset omaan ikkunaansa
- Paperikuvake - kopioi tehtävän
- Pysäytä-kuvake - poistaa valitun tehtävän
Todennustehtävän tiedot
Kun napsautat yhdistinrivin alussa olevaa nuolta, kaikki asiaankuuluvat ajoitetut ja tapahtumatehtävät tulevat näkyviin.
Yläpalkki todennuksen yleiskatsaukseen
- Luo uusi tehtävä - avaa uuden todennustehtävän määrityssivun
- Poista tehtävä(t) - poistaa valitut tehtävät, näkyviin tulee ponnahdusikkuna poiston vahvistamiseksi
- Päivitä – päivittää todennustehtävien näkymän
Listanäkymä todennuksen yleiskatsaukseen,
- Valitse tehtävä(t) - Valitse poistettava tehtävä luettelonäkymästä rastittamalla se.
- Id - Tehtävän yksilöllinen tunniste. Luodaan automaattisesti, eikä sitä voi muuttaa.
- Nimi - Tehtävän nimi lisätty tehtäväasetuksiin, tehtävän yksilöivä nimi.
- Hallitse
- Kynäkuvake - avaa tehtävän asetukset omaan ikkunaansa (tehtävärivin kaksoisnapsauttaminen avaa myös asetusikkunan)
- Paperikuvake - kopioi tehtävän
- Pysäytä-kuvake - poistaa tehtävän, näkyviin tulee ponnahdusikkuna poiston vahvistamiseksi
Lokit-välilehti
Lokit-välilehdellä voi ladata käyttöliittymästä Native Connector- ja Secure Access -lokeja yksityiskohtaista vianmääritystä varten.
- epe-master -lokit - sisältää varoitus-, virhe- ja virheilmoituksia natiiveista liittimistä sekä tietoa siitä, kuinka kauan tehtäviin liittyviä toimia on suoritettu.
- epe-worker-ad lokit - Sisältää Active Directory -liittimen tilan tiedot (mitä Native Connector lataa asiakkaan Matrix42 Core , Pro and IGA ratkaisuun). Jos valinta on tyhjä, hakemisto ei ole käytössä tässä ympäristössä.
- epe-worker-azure -lokit - sisältää Entra ID :n tilatiedot (mitä Native Connector lataa asiakkaan Matrix42 Core , Pro and IGA ratkaisuun). Jos valinta on tyhjä, hakemisto ei ole käytössä tässä ympäristössä.
- epe-worker-ldap lokit - sisältää LDAP:n tilatiedot (mitä Native Connector lataa asiakkaan Matrix42 Core , Pro and IGA ratkaisuun). Jos valinta on tyhjä, hakemisto ei ole käytössä tässä ympäristössä.
- epe-laukaisujen lokit - sisältää tietoa EPE-laukaisuista
- datapump-itsm-l ogs - Sisältää tietoa datan viennistä asiakkaille Matrix42 Core , Pro and IGA ratkaisuissa.
- esa -lokit - Sisältää tietoa Secure Access -todennuksesta.
Asetukset-välilehti
Asetukset-välilehtiä käytetään yhdistimiä sisältävien ympäristöjen valvontaan.
- Ympäristötyyppi - on pakollinen valinta ja tietoja käytetään esimerkiksi hälytyksen kriittiseen määrittelyyn.
- Testi – valitse tämä, kun ympäristöäsi käytetään testiympäristönä
- Pro d - valitse tämä, kun ympäristöäsi käytetään tuotantoympäristönä
- Demo – valitse tämä, kun ympäristöäsi käytetään demo- tai harjoitusympäristönä
- Kehittäjä – valitse tämä, kun ympäristöäsi käytetään kehitysympäristönä
Mitä me valvomme?
- Aikataulun mukaisen provisioinnin epäonnistumiset (tietojen poimiminen, tietojen vienti ESM:ään, vanhentuneet varmenteet, virheelliset salasanat, virheellinen hakukanta/suodatin, virheelliset määritykset jne.)
- Tapahtumapohjaisen provisioinnin epäonnistumiset ( AD / Azure kirjoittaminen jne. epäonnistuu)
- Tapahtumapohjainen valmistelu – mitä liittimiä käytetään tietojen kirjoittamiseen sovelluksiin/hakemistoihin.
- ESA yli kymmenen epäonnistunutta kirjautumisyritystä yhdelle käyttäjälle viimeisen kolmen päivän aikana
- Ympäristötyyppi - on pakollinen valinta ja tietoja käytetään esimerkiksi hälytyksen kriittiseen määrittelyyn.
Tietojen migraatiot
Älä napsauta ”Siirrä attribuuttimääritykset” tai ”Siirrä työnkulut”, ellei Matrix42 pyydä sinua tekemään niin.
Yhdistimen määrittäminen
Tässä luvussa kuvataan konfigurointiohjeet, jotta liitin voidaan muodostaa yhteys REST API :in.
Valmistelun määrittämiseen tarvitset käyttöoikeuden alustan määrityskonsoliin.
1. Avaa hallinta-alue (ratassymboli).
2. Avaa Yhdistimet-näkymä.
3. Valitse "Uusi liitin"
4. Valitse tietolähteen tyypiksi Generic REST API
5. Anna liittimelle nimi ja lisää yhteysasetukset:
- Liittimen nimi – anna liittimellesi käyttäjäystävällinen nimi (nimeä voi muuttaa jälkikäteen)
- Isännän URL-osoite - REST API n perus-URL. Tätä voidaan käyttää etuliitteenä kutsuttavalle lopulliselle URL-osoitteelle.
- REST liittimen tyyppi - Generic tai Google . Google tapauksessa käytä Google ja kaikkien muiden REST API tapauksessa Generalia.
Valitse oikea todennusmenetelmä yhdistettävän järjestelmän perusteella.
- Perustodennus - Perustodennus käyttäjätunnuksella/salasanalla base64-koodattuna todennusotsikkona
- Haltijatunnus - Käytetään vakiota haltijatunnuksen todennusotsikkoa
- Poissa käytöstä - Julkisille API -rajapinnoille ilman todennusta (versiossa 2025.3 ja uudemmissa)
- Valtuutusotsikko - Jatkuvaa salaista otsikkoa varten (versiossa 2025.3 ja uudemmissa)
- Dynaaminen tunnus - OAuth 2.0 -asiakkaan tunnistetietojen käsittelyyn ja vastaaviin (versiossa 2025.3 ja uudemmissa)
Aseta oikea sivutus sen kolmannen osapuolen järjestelmän perusteella, johon yhdistät tämän liittimen.
Yleinen REST API -liittimen sivutus tukee viittä erilaista sivutustyyppiä. Näitä käyttävät ajoitetut tehtävät:
- Poissa käytöstä – API ei tue sivutusta ja palauttaa kaikki tiedot yhdessä vastauksessa.
- Aloitus ja offset - API käyttää aloitus- ja offset-parametreja. Jokaisella pyynnöllä aloitusarvoa kasvatetaan offset-arvolla, kunnes kaikki tiedot on noudettu.
- Sivun lisäys – API käyttää sivunumerointia. Jokaisella pyynnöllä sivunumeroa lisätään yhdellä, kunnes tuloksia ei enää palauteta.
- Linkkitunnus – Vastaus sisältää URL-osoitteen seuraavalle sivulle. Seuraa kyseistä URL-osoitetta, kunnes seuraavaa linkkiä ei enää anneta.
- Linkkiattribuutin tunnus - Vastaus sisältää seuraavan sivun tunnusmerkin. Lähetä kyseinen tunnus kyselyparametrina seuraavassa pyynnössä. Google -tyylinen sivutus.
Fulfill Web API -käyttäjätiedot
- Web API -käyttäjä - valitse oikea Web API -käyttäjä, jota käytetään kirjoitettaessa tietoja ulkoisesta järjestelmästä Matrix42 Core , Pro and IGA ratkaisuihin
- Web API -salasana - Web API -käyttäjän salasana
7. Tallenna liittimen tiedot
8. Lisää ulkoisen REST API -järjestelmän juuri-https-varmenne, jotta yhdistinten hallinta (EPE) voi luottaa siihen. Tämän voi tehdä vain Matrix42 :lla: Lisää varmenne.
9. Matrix42 Core , Pro and IGA ratkaisut pystyvät nyt muodostamaan yhteyden ulkoiseen REST API
- Seuraava vaihe on määrittää ajoitettu tehtävä datan lukemista varten tai tapahtumatehtävä datan kirjoittamista varten ja toiminnot REST API kohti.
Yleisiä uid ajoitettuihin tehtäviin
Yleisiä uid ajoitettuihin tehtäviin
Uuden ajoitetun tehtävän luominen tietojen tuontia varten
Ajoitetun valmistelutehtävän määrittämiseen tarvitset pääsyn Hallinta / Yhdistimet -välilehdelle.
1. Avaa hallinta-alue (ratassymboli).
2. Avaa Yhdistimet- näkymä.
3. Valitse Aikataulun mukaisten tehtävien yhdistin ja valitse Uusi tehtävä
Huom! Jos liitintä ei luoda, sinun on ensin valittava Uusi liitin ja sen jälkeen Uusi tehtävä.
4. Jatka liitinkohtaisten ohjeiden mukaisesti: Natiivit liittimet
Pitäisikö minun käyttää inkrementaalista, täyttä vai molempia?
Ajoitettu tehtävä voi olla joko inkrementaalinen tai täysi -tyyppinen.
Älä tuo käyttöoikeuksia AD ja LDAP-lisätehtävien kanssa
Lisätehtävässä on ongelma käyttöoikeuksien tuonnissa. Tällä hetkellä ei suositella ryhmän jäsenyyksien tuontia lisäajoitetulla tehtävällä.
Poista tämä yhdistämismääritys Microsoft Active Directory ja OpenLDAP liittimissä inkrementaalisessa tehtävässä:
Ajoitettujen tehtävien asettaminen:
Inkrementaalista tyyppiä tuetaan vain Microsoft Active Directory , LDAP- ja Microsoft Graph API (aiemmin tunnettu nimellä Entra ID ) -liittimissä.
Inkrementaalinen tyyppi tarkoittaa, että Native Connectors (EPE) hakee tietoja lähdejärjestelmästä käyttäen muuttuneita aikaleimatietoja, joten se hakee vain tietoja, jotka on muutettu tai lisätty edellisen inkrementaalisen tehtävän suorittamisen jälkeen.
Kun inkrementaalinen tehtävä suoritetaan ensimmäistä kertaa, se suorittaa täyden noudon (ja merkitsee nykyisen aikaleiman EPE-tietokantaan). Tämän jälkeen tehtävä käyttää kyseistä aikaleimaa kysyäkseen tietolähteeltä tietoja, jotka ovat muuttuneet kyseisen aikaleiman jälkeen (ja sitten EPE päivittää aikaleiman EPE-tietokantaan seuraavaa tehtäväajoa varten). Tehtävävälimuistin tyhjentäminen ei vaikuta tähän aikaleimaan, joten inkrementaalinen tehtävä on aina inkrementaalinen ensimmäisen suorituksen jälkeen.
Kaikki liittimet tukevat täyttä tyyppiä.
Täysi tyyppinen tuonti noutaa aina kaikki tiedot (jotka se on määritetty noutamaan) lähdejärjestelmästä jokaisella ajokerralla.
Sekä Full- että Incremental-tyyppiset tehtävät käyttävät myös Task cache -muistia EPE:ssä, mikä tekee tietyistä tuonneista nopeampia ja kevyempiä M42 järjestelmässä.
Oletusarvoisesti kyseisen tehtävän välimuisti tyhjennetään keskiyöllä UTC-aikaa. Kun välimuisti tyhjennetään, seuraava tuonti suoritetaan ilman välimuistia. Tätä käytetään päättelemään, pitäisikö noudetut tiedot lähettää ESM:ään. Kaikki noudetut tiedot lähetetään ESM:ään. Mutta sen jälkeen seuraava tehtävä suoritetaan, kunnes välimuisti tyhjennetään. EPE-välimuistia käytetään sen määrittämiseen, pitääkö noudetut tiedot lähettää ESM:ään vai ei.
Voit määrittää, mihin aikaan päivästä tehtävien välimuisti tyhjennetään, muuttamalla EPE-datapumpun kokoonpanon yleisiä asetuksia:
/opt/epe/datapump-itsm/config/ mukautetut .properties-tiedostot
joka on oletusarvoisesti asetettu arvoon: clearCacheHours24HourFormat=0
Voit myös tyhjentää välimuistin useita kertoja päivässä, mutta se on harkittava huolellisesti, koska sillä on vaikutusta kokonaissuorituskykyyn, koska EPE lähettää ESM:ään muutoksia, jotka luultavasti ovat jo siellä, esimerkiksi (älä lisää välilyöntejä attribuutin arvoon): clearCacheHours24HourFormat=6,12
Kun olet muuttanut tämän arvon, käynnistä EPE-datapumpun säilö uudelleen, jotta muutos tulee käyttöön.
Suositukset:
Ajoitettujen tehtävien tyyppi on aina oletuksena Täysi.
Jos haluat hakea muutoksia jo täyden tehtävän noutamiin tietoihin useammin kuin koko tehtävää voi suorittaa, lisää myös inkrementaalinen tehtävä. Yleensä inkrementaalista tehtävää ei tarvita.
Suositeltu aikataulutusjärjestys
Suositeltu ajoitusjärjestys riippuu siitä, kuinka paljon tietoa luetaan asiakkaan järjestelmästä/hakemistosta Matrix42 Core , Pro tai IGA ratkaisuun, ja onko tuonti inkrementaalista vai täydellistä.
Esimerkkejä aikataulutuksesta,
| Käyttäjien kokonaismäärä | Ryhmien kokonaismäärä | Täysi kuorma -sekvenssi | Lisääntyvä kuormitusjärjestys |
| < 500 | < 1000 | 30 minuutin välein, jos ei käytetä osatäyttöä Neljä (4) kertaa päivässä, jos käytetään osakuormaa |
10 minuutin välein |
| < 2000 | < 2000 | 60 minuutin välein, jos ei käytetä osatäyttöä Neljä (4) kertaa päivässä, jos käytetään osakuormaa |
15 minuutin välein |
| < 5000 | < 3000 | Neljän (4) tunnin välein, jos ei käytetä osatäyttöä Kaksi kertaa päivässä, jos käytetään osakuormaa |
15 minuutin välein |
| < 10 000 | < 5000 | Tuontia enintään kaksi kertaa päivässä riippumatta siitä, käytetäänkö osakuormaa vai ei | 30 minuutin välein |
| < 50 000 | < 7000 | Maksimituonti kerran päivässä riippumatta siitä, käytetäänkö osakuormaa vai ei | 60 minuutin välein |
| Yli 50 000 | Yli 7000 | Saatat tarvita toisen EPE-työntekijän, ota yhteyttä Pro . | Arvioidaan erikseen |
Huomaa, että jos useita tehtäviä on käynnissä samanaikaisesti, saatat tarvita enemmän EPE-työntekijöitä. Tehtävät tulisi ajoittaa eri aikoihin ja ne voidaan suorittaa yllä olevan taulukon mukaisesti. Jos kuitenkin samanaikaisesti on käynnissä yli kuusi tehtävää, ePE-työntekijöiden määrää tulisi lisätä. On parasta käytäntöä olla ajoittamatta tehtäviä suoritettavaksi samaan aikaan, jos mahdollista.
Suorituskykyyn liittyvät suositukset
Jos tuotavan datan määrä on yli 10 000, ota huomioon seuraavat asiat:
Säädä ESM:n ja DATAPUMP:n lokikirjaustaso ERROR-tasolle vähentääksesi lokikirjauksen määrää tehtävien suorituksen aikana
Käytä mahdollisimman vähän automaatioita, jotka alkavat välittömästi tuoduille datakorteille (kuuntelijat, käsittelijät, työnkulut), koska ne hidastavat ESM:n uusien datakorttien käsittelyä.
Aseta poistettujen tilien ja oikeuksien tilaksi poistettu/poistettu
Tämän toiminnon avulla voit merkitä tilin ja oikeuden tilan esimerkiksi Poistettu tai Ei käytössä, kun tili tai oikeus poistetaan lähdejärjestelmästä. Versiosta 2025.3 alkaen voit asettaa tilan myös yleisille objekteille (ei vain tileille/identiteeteille ja oikeuksille/ryhmille).
Versiolle 2025.3 ja uudemmille
Versiossa 2025.3 nämä asetukset on siirretty ominaisuustiedostoista tehtävien käyttöliittymään. Voit nyt myös määrittää nämä asetukset yleisille objekteille, mikä ei ollut mahdollista ennen tätä versiota.
Jokaiselle ajoitetulle tehtävälle ja kaikille kartoitustyypeille on omat määrityksensä. Tässä on esimerkki tästä tehtävän määrityksestä:
Versiolle 2025.2 ja vanhemmille
Tämä toiminto on käytettävissä "täysin"-tyyppisille ajoitetuille tehtäville.
Asetukset löytyvät datapump dockers -määritystiedostosta. Jos haluat muuttaa näitä parametriarvoja, sinun on asetettava ne tiedostoon /opt/epe/datapump-itsm/config/custom.properties .
Kokoonpano
Jotta käytöstäpoistotoiminto voidaan ottaa käyttöön, datapump config -määrityksessä on oltava seuraavat parametrit asetettuna arvoon true:
disable.unknown. esm .users=true
disable.unknown. esm .groups=true
Nuo kaksi parametria ovat oletusarvoisesti epätosia versioissa 2024.2 ja 2025.1. Versioissa 2025.2 ja uudemmissa ne ovat oletusarvoisesti tosia.
Seuraavaksi ovat nämä parametrit:
personTemplateStatusCodeAttributeKey=accountStatus
personTemplateStatusAttributeDisabledValueKey=Deleted
groupTemplateStatusCodeAttributeKey=status
groupTemplateStatusAttributeDisabledValueKey=5 - Removed
Kahden ensimmäisen attribuutin tulisi osoittaa käyttäjämallin DatacardHiddenState-attribuuttiin ja kertoa, mikä arvo lähetetään sinne, kun käyttäjä poistetaan.
Oletusarvoisesti sen accountStatus ja arvo 5 - Removed IGA Account tilimallissa.
Kaikkien näiden on vastattava attribuutin kokoonpanoa:
Sama pätee kahteen seuraavaan parametriin, mutta ne koskevat ryhmiä.
Jos sinun on muutettava näitä parametreja ominaisuustiedostossa, tee muutokset Datapump-säilössä tiedostoon: /opt/epe/datapump-itsm/config/custom.properties . Muutokset säilyvät säilön uudelleenkäynnistyksen jälkeen ja kopioituvat uudelleenkäynnistyksen yhteydessä tiedostoon /opt/epe/datapump-itsm/config/application.properties.
Kuvaus
Tehtävät tallentavat käyttöliittymässä Task Id mapping näkyvän __taskid__ kartoituksen datakortteihin. Sitä käytetään sitten sen määrittämiseen, lisäsikö tämä tehtävä datakortin. Jos tehtäviä on useita, joilla on eri käyttäjäryhmät.
Tätä kenttää käytettiin aiemmin datasourceid:nä, mutta koska siirryimme malliin, jossa liittimellä voi olla useita tehtäviä, sen tunnistetta ei voida enää käyttää, siksi kentän käyttötarkoitus muutettiin taskid:ksi.
Esimerkkinä käyttäjistä ESM :ltä pyydetään tehtävän suorituksen yhteydessä luetteloa käyttäjistä, joiden taskid on Task Id mapping -kartoituskentässä, mutta joilla ei ole personTemplateStatusAttributeDisabledValueKey -arvoa personTemplateStatusCodeAttributeKey -kentässä.
Tätä tulosta verrataan sitten tehtävän hakemaan dataan, ja niiden käyttäjien datakorttien, joita ei noudettu, personTemplateStatus -attribuutti asetetaan määrityksessä määritettyyn arvoon. - 5 - Removed oletusarvoisesti.
Alla oleva esimerkkiloki näyttää kuvatun prosessin ja ilmoittaa, että yksi käyttäjä on poistettu.
Sama pätee ryhmiin, mutta niiden sijaan käytetään groupTemplateStatus -attribuutteja.
Muistiinpanoja
- Ominaisuus toimii vain täysien noutoaikataulutettujen tehtävien kanssa.
- Ei vielä tukea yleisille malleille, vain identiteetti ja käyttöoikeudet
- Kun siirrytään aiemmista versioista, joissa datasourceid:tä käytettiin edelleen, se on suoritettava ainakin kerran, jotta sen taskid:t asetetaan ensin datakorteille.
- EPE tunnistaa käytöstä poistetut käyttäjät tai ryhmät AD :stä poistettuina. Tällä hetkellä emme tue tiloja, jotka liittyvät entiteetin aktiiviseen tai ei-aktiiviseen tilaan.
- EPE ei itsessään ota käyttäjiä takaisin käyttöön.
- Jos useampi kuin yksi tehtävä hakee samoja käyttäjiä tai ryhmiä, se saattaa korvata datakortin tehtävätunnuksen riippuen siitä, mikä tehtävä suoritettiin viimeksi. On ehdotettu, että monet täyden tyypin tehtävät eivät nouda samaa käyttäjää tai ryhmää.
- Tee aina muutokset määritystiedostoihin custom .properties-tiedostoon, äläkä muuta pelkästään application.properties-tiedostoa, sillä nämä muutokset menetetään säilön uudelleenkäynnistyksen yhteydessä, jos et ole tehnyt samoja muutoksia custom.properties-tiedostoon.
Ajoitetun tehtävän määrittäminen tietojen lukemista varten
Versioon 2025.3 lisättiin tuki datan lukemiselle ajoitettujen tehtävien avulla.
Yleistä REST API -liitintä käytetään REST API käyttävien kolmannen osapuolen ratkaisujen tietojen lukemiseen luomalla ajoitettuja provisiointitehtäviä.
Uuden tehtävän luominen ajoitettua Pro varten
Ajoitetun valmistelutehtävän määrittämiseen tarvitset käyttöoikeuden alustan määrityskonsoliin.
Huom! Jos liitintä ei luoda, sinun on ensin luotava ”uusi liitin” ja sen jälkeen voit luoda uusia tehtäviä.
1. Avaa alustan määritysnäkymä (ratassymboli).
2. Avaa Yhdistimet-näkymä.
3. Valitse liitin, jolle aikataulutettu tehtävä on määritetty
4. Valitse oikean yhdistimen alta ”uusi tehtävä”.
5. Määritä tehtävän ajoitus (suoritetaanko ajoitettu tehtävä säännöllisesti ja miten). Valitse ajoitusjärjestys, joka riippuu siitä, kuinka paljon dataa luetaan Matrix42 Core , Pro and IGA -ratkaisuun.
Suositeltu ajoitusjärjestys riippuu siitä, kuinka paljon dataa luetaan asiakkaan hakemistosta Matrix42 Core , Pro and IGA ratkaisuun ja onko tuonti osittainen vai täysi lataus.
Esimerkki datan lukemisen ajoituksesta.
| Käyttäjien kokonaismäärä | Ryhmien kokonaismäärä | Täysi kuorma -sekvenssi | Osittaisen kuormituksen sekvenssi |
| < 500 | < 1000 | 30 minuutin välein, jos ei käytetä osatäyttöä Neljä (4) kertaa päivässä, jos käytetään osakuormaa |
10 minuutin välein |
| < 2000 | < 2000 | 60 minuutin välein, jos ei käytetä osatäyttöä Neljä (4) kertaa päivässä, jos käytetään osakuormaa |
15 minuutin välein |
| < 5000 | < 3000 | Neljän (4) tunnin välein, jos ei käytetä osatäyttöä Kaksi kertaa päivässä, jos käytetään osakuormaa |
15 minuutin välein |
| < 10 000 | < 5000 | Tuontia enintään kaksi kertaa päivässä riippumatta siitä, käytetäänkö osakuormaa vai ei | 30 minuutin välein |
| < 50 000 | < 7000 | Maksimituonti kerran päivässä riippumatta siitä, käytetäänkö osakuormaa vai ei | 60 minuutin välein |
| Yli 50 000 | Yli 7000 | Saatat tarvita toisen EPE-työntekijän, ota yhteyttä Pro . | Arvioidaan erikseen |
5. Täytä tehtävän tiedot
- Täytä ajoitettuun tehtävään yksilöivä tehtävänimi
- Tehtävän käyttö osoittaa, että kyseessä on tehtävä, jota käytetään datan lukemiseen, datan kirjoittamiseen tai todennukseen. Huomaa, että jos tapahtumatyyppiä muutetaan jälkikäteen, se voi rikkoa työnkulut tai integraatiot.
- Yhdistämistyyppi riippuu hakemistosta luettavien tietojen tyypistä. Generic REST API -liittimelle tuetaan vain Generic-yhdistämismuotoa.
- Yleinen (yksi malli) - käytetään, kun hakemistosta luetaan yleistä tietoa
6. Täytä tehtäväparametrit
- Kysely - kutsuttava varsinainen API URL-päätepiste
- Alikyselyt - valinnainen. Voidaan käyttää, jos kyselyyn liittyvää dataa on tarpeen hakea toisesta API päätepisteestä.
- Kyselyotsikot – Mukautetut otsikot lisätään lopulliseen kyselyyn tietojen poiminnan aikana.
Liittimien hallinta (EPE) lisää nämä otsikot automaattisesti, joten niitä ei tarvitse lisätä erikseen:
“Content-Type”, “…”
"Authorization", “…” - Arvomerkki - voi olla tyhjä. Arvo riippuu Query API n palauttamasta JSON-tietorakenteesta. Esimerkiksi jos koko data on resultset JSON -objektissa, aseta tämä arvomerkki arvoon resultset.
- Virhemerkki - voi olla tyhjä. Arvo riippuu Query API n palauttamasta JSON-virheviestirakenteesta. Esimerkiksi jos koko virheviesti on errors JSON -objektin sisällä, aseta tämä arvomerkki arvoon errors.
- API kutsujen turvakynnys - turvakynnys loputtomien silmukoiden estämiseksi. Aseta tämä arvoksi kaksi kertaa suurempi kuin nykyisten kutsujen määrä, joita tämä tehtävä tarvitsee kaikkien tietojen hakemiseen. Jos tämä tehtävä hakee kaikki tiedot, esim. 50 sivutettua kutsua, aseta arvoksi 100.
- Yksilöllinen attribuutti - aseta yksilöllinen attribuutin nimi (kirjainkokoriippuvainen) JSON-tulosjoukosta. Yleensä ID, id tai uid jne. Jokaisella rivillä on oltava yksilöllinen arvo tässä attribuutissa. Sinun on myös lisättävä tämä attribuutti vastaavuustaulukkoon tehtävän konfiguroinnin lopussa. Huom! Ajoitettu tehtävä ei voi noutaa tietoja, jotka eivät sisällä tätä yksilöllistä attribuuttia jokaiselle objektille.
7. Täytä vikatiedot
Valinnaiset asetukset virheiden käsittelyyn. Jos ajoitettu tehtävä epäonnistuu, ESM:ään voidaan luoda datakortti, joka näyttää virheen. Jos virheasetukset on määritetty, järjestelmänvalvojan ei tarvitse tarkistaa ajoitettujen tehtävien tilaa manuaalisesti.
- Virhemalli - Valitse datakortin malli, joka luodaan, jos valmistelun aikana ilmenee virheitä (yhteys tietolähteisiin, aikakatkaisut jne.).
- Vikakansio - Valitse kansio, johon vikatietokortti on tallennettu.
- Virheattribuutti – Valitse attribuutti, mihin virhemallissa virhetiedot tallennetaan. Valitse tekstityyppiattribuutti.
8. Lisää yleisiä määrityksiä
Yhdistämisosiossa määritetään, mikä JSON-viestin attribuutti luetaan mihinkin Matrix42 Core , Pro and IGA -datakortin attribuuttiin.
- Kohdemalli – Valitse malli määrittääksesi attribuuttimääritykset
- Kohdekansio - Valitse kansio kansioluettelosta. Luetteloa rajataan vastaamaan yhteensopivuutta valitun mallin kanssa.
- Tietolähteen tyypin yhdistäminen - valinnainen. Jos se on asetettu, se kirjoittaa yhdistintyypin kyseiseen attribuuttiin.
- Tehtävätunnuksen yhdistämismääritys - Tehtävätunnusnumero kirjoitetaan tähän attribuuttiin.
- Aseta arvo datakortille, jos objekti on poistettu lähdejärjestelmästä - Tämä toiminto aktivoidaan asettamalla valintaruutu päälle. Kun jokin aiemmin kolmannen osapuolen järjestelmästä ratkaisuun luettu objekti poistetaan kolmannen osapuolen järjestelmästä, tämä ajoitettu tehtävä huomaa, että se on poistettu, ja merkitsee kyseisen datakortin valitun attribuutin haluamallasi arvolla. Tätä voidaan käyttää esimerkiksi tilan attribuutin asettamiseen arvoon Poistettu (kuten alla olevassa esimerkkikuvakaappauksessa näkyy).
- Ominaisuusmääritykset
- Ulkoinen attribuutti - mikä kolmannen osapuolen API attribuutti luetaan JSON-rungosta
- Paikallinen attribuutti - mihin Matrix42 Core , Pro and IGA attribuuttiin se on yhdistetty
- Määritysten yhdistämismäärityksiin on mahdollista asettaa lisää määritteitä valitsemalla Uusi määrite .
9 Tallenna valmistelutehtävä Tallenna-painikkeella.
Jos joitakin pakollisia ominaisuuksia puuttuu, tallennuspainike näkyy harmaana ja se näyttää asetuksista puuttuvat tiedot.
10. Olet nyt määrittänyt aikataulun mukaisen yhdistintehtävän yleiselle REST API -luennalle.
- Voit nyt odottaa, kunnes tehtävä aloitetaan aikataulun mukaisesti tai
- Suorita tehtävä manuaalisesti – napsauttamalla tehtävänmuokkausikkunan yläreunassa olevaa ”Suorita tehtävä” -painiketta tehtävä määritetään ajoitettavaksi alkamaan välittömästi. Yleensä testiajoihin tai jos et halua muuttaa aikatauluasetuksia, mutta haluat suorittaa tehtävän nyt.
Esimerkki manuaalisen tehtävän suorituksen aloitusviestistä:
Jos tehtävä suoritetaan manuaalisesti ( suorita tehtävä ) tai se suoritetaan aikataulun mukaisesti, tehtävän tilan voi tarkastella Ajoitettujen tehtävien luettelon hallintasarakkeesta napsauttamalla ” Näytä historia” -painiketta .
Tapahtumapohjaisen tehtävän määrittäminen
Tapahtumatehtävää käytetään, kun dataa kirjoitetaan (tai muita tapahtumapohjaisia REST API -kutsuja tehdään Workflow'sta) asiakkaan ratkaisuun, joka tarjoaa yleisen REST API . Nämä yhdistimien hallintaominaisuudet ovat saatavilla kaikille Matrix42 Core , Pro and IGA -ratkaisuille.
Esimerkkejä tapahtumapohjaisten tehtävien käytöstä:
- Lisää tili
- Päivitä henkilö
- Aktivoi tili
- Luo tukipyyntö
- Passiivinen laite
Kaikki liittimien hallintaan ja tapahtumapohjaiseen valmistelutehtävään liittyvät määritykset määritetään Matrix42 Core , Pro tai IGA -liittimet-näkymässä.
1. Avaa Matrix42 Core , Pro tai IGA -määritysnäkymä (ratassymboli).
2. Avaa yhdistinnäkymä
3. Valitse liitin, joka käyttää tapahtumatehtävää
4. Valitse oikean liittimen alta ”uusi tehtävä”
5. Täytä tehtävän asetukset
- Tehtävän nimi - Anna tehtävälle nimi, se näytetään yhdistinnäkymässä.
- On hyvä käytäntö nimetä tehtävä tavalla, joka kuvaa sen tarkoitusta, esimerkiksi [Mallipohjan nimi]:[Aktiviteetti] IGA -palvelupyyntö: Lisää tili
- Tehtävän käyttö osoittaa, että kyseessä on tehtävä, jota käytetään datan lukemiseen tai datan kirjoittamiseen. Muutosta voidaan tehdä jälkikäteen, mutta sitä ei suositella, jos tapahtumatehtävä on käytössä. Se rikkoo työnkulut.
- Yhdistämismääritysten tyyppi riippuu siitä, minkä tyyppisiä tietoja hakemistosta luetaan. Identiteettiyhdistämismääritykset näytetään tämän asetuksen perusteella.
- Yleinen (yksi malli) - käytetään, kun hakemistosta luetaan yleisiä tietoja. Nämä voivat olla minkä tahansa tyyppisiä tietoja.
Varoitus tehtävän käytön tai yhdistämistyypin muuttumisesta, kun tapahtumatehtävä on käytössä:
6. Täytä tehtäväparametrit
- Kysely - API-päätepiste, jota tämä tehtävä kutsuu. Tämä voidaan jättää tyhjäksi ja antaa työnkulun orkestrointisolmussa. Voit antaa koko päätepisteen osoitteen, kuten: https://apiurl.com/endpointtocall tai vain URL-osoitteen lopun. Jos annat vain URL-osoitteen lopun, esimerkiksi endpointtocall , lopullinen URL yhdistetään käyttämällä kaikkia näitä: liittimen isännän URL + tehtäväkysely + orkestrointisolmun URL.
- Kyselyotsikot - Mukautetut otsikot lisätään lopulliseen REST API -kyselyyn. Katso kohde-/lähdejärjestelmän API dokumentaatiosta, mitä otsikoita se vaatii.
- Päivämääräattribuutin muotoilija - käytetään päivämäärien muotoiluun, kun päivämäärätyyppiattribuuttia valmistetaan kohdejärjestelmälle. Voit valita muodon luettelosta tai lisätä oman mukautetun muodon. Oikeanpuoleinen kenttä näyttää esimerkin muotoillusta päivämäärästä.
- Päivämäärän ja kellonajan muotoilija - käytetään päivämäärän ja kellonajan muotoilemiseen, kun päivämäärän ja kellonajan tyyppiattribuuttia valmistetaan kohdejärjestelmälle. Voit valita muodon luettelosta tai lisätä oman mukautetun muodon. Oikeanpuoleinen kenttä näyttää esimerkin muotoillusta päivämäärästä ja kellonajasta.
7. Määrittele yleiset vastaavuusmääritykset
- Kohdemalli – Valitse malli määrittääksesi attribuuttimääritykset
- Kohdekansio - Valitse kansio kansioluettelosta. Luetteloa rajataan vastaamaan yhteensopivuutta valitun mallin kanssa.
- Ominaisuusmääritykset ( Huomautus! Useimmissa tapauksissa näitä ei tarvitse asettaa. Tapahtumatehtävässä käytetyt tiedot konfiguroidaan Workflow Orchestration -solmussa.
- Efecte-mallin attribuutti - mihin attribuuttiin Efecte-hakemistossa attribuutti on yhdistetty.
- Hakemiston attribuutti - mikä hakemiston attribuutti on yhdistetty Efecteen
- Lisää uusi ominaisuus - Voit asettaa lisää ominaisuuksia valitsemalla Uusi ominaisuus -painikkeen.
8. Tallenna tehtävä
Tallenna valmistelutehtävä “tallenna”-painikkeella
Jos pakollisia tietoja puuttuu, et voi tallentaa tehtävää ja tallennuspainike näyttää puuttuvat tiedot.
9. Määritä työnkulku käyttämään tätä tapahtumapohjaista tehtävää orkestrointisolmun kanssa
Seuraava vaihe on määrittää työnkulku käyttämään tätä tapahtumapohjaista tehtävää.
Alustan työnkulkumoottorista on mahdollista suorittaa asiakashakemistopalveluihin liittyviä provisiointitoimintoja. Tämä tarkoittaa, että mitä tahansa käytettävissä olevien orkestrointisolmujen toimintaa voidaan suorittaa missä tahansa työnkulun vaiheessa.
Työnkulkuviittaukset näkyvät liittimen yleiskatsaussivulla (voit päivittää työnkulkuviittaukset ”Näytä työnkulkuviittaukset” -painikkeella):
Työnkulun orkestrointisolmun aktiviteettien määrittäminen
Yleinen REST kutsu
Lisää Orchestration-solmu työnkulkuusi ja määritä seuraavat asiat.
Nimi - anna kuvaava nimi
Kuvaus - aseta kuvaileva kuvaus
Orkestroi - valitse Pro
Tietolähde - valitse Yleinen REST API
Aktiviteetti - valitse Yleinen REST kutsu
Kohde - valitse tapahtumapohjainen tehtäväsi (voit käyttää samaa tehtävää useille orkestrointisolmuille)
Toiminto – valitse toiminto kutsumasi REST API perusteella (tarkista oikea toiminto API dokumentaatiosta). Tuetut toiminnot ovat: POST, PUT, PATCH, DELETE ja GET
REST URL - kutsuttava API-päätepiste. Tämä voi olla koko URL-osoite tai URL-osoitteen jälkiliite. Jos käytät jälkiliitettä, kutsuttava varsinainen URL-osoite yhdistetään käyttämällä kaikkia näitä: liittimen isännän URL-osoite + tehtäväkysely + orkestrointisolmun URL-osoite. Voit käyttää mallipohjan attribuuttimuuttujia samalla tavalla kuin sähköpostisolmussa käyttämällä dollarisyntaksia, kuten: $attribute_code$ ja $reference:attribute_code$.
Huom! Jos URL-osoitteessasi on välilyöntejä tai $-merkkejä, muista koodata ne URL-osoitteeseen. Joten $ on %24, välilyönti on %20.
Rest Body - JSON-runko API-kutsua varten. Voi olla tyhjä, jos kutsumasi API ei tarvitse runkoa. Katso rungon tiedot API dokumentaatiosta. Voit käyttää mallipohjaisia attribuuttimuuttujia samalla tavalla kuin sähköpostisolmussa käyttämällä dollarin syntaksia, kuten: $attribute_code$ ja $reference:attribute_code$.
Esimerkiksi tässä rungossa on kaksi muuttujaa: $firstname$ ja $lastname$
{"nimi": {
"givenName": "$firstname$",
"perhenimi": "$sukunimi$"}}
Jos sinun täytyy luoda monimutkainen json-runko API kutsua varten, voit ensin rakentaa koko json-koodin johonkin datacard-attribuuttiin. Ja sitten vain kyseisen attribuutin koodi jää rungon osaksi, kuten tässä: $generated_json_body_attributecode$
JSON-rungon luominen koodissa
How to generate JSON in workflow
Use json library to read value from JSON
This example is for example for OnPremisesExtensionAttributes, but this same approach can be used for all kinds of JSON messages for Microsoft Graph API and REST API's.
To read 1 specific value from JSON which looks like this:
{ "extensionAttribute1": "test data1", "extensionAttribute2": null, "extensionAttribute3": null, "extensionAttribute4": "EXT", "extensionAttribute5": null, "extensionAttribute6": null, "extensionAttribute7": null, "extensionAttribute8": null, "extensionAttribute9": "HR functions", "extensionAttribute10": "100", "extensionAttribute11": null, "extensionAttribute12": null, "extensionAttribute13": null, "extensionAttribute14": "test5", "extensionAttribute15": "M365_E5" }
You can do it easily with following code on workflow script.
Example (example uses two esm attributes: onPremisesExtensionAttributes and extensionAttribute14code):
import json
if onPremisesExtensionAttributes:
_data = this.get("onPremisesExtensionAttributes")
_obj = json.loads(_data)
_value = _obj["extensionAttribute14"]
this.set("extensionAttribute14code",_value)Remember to always test, that code selects correct data from JSON for your use-case, and if not, do needed adjustments to it.
Rest-vastausattribuutti - API kutsun resultset json kirjoitetaan tähän attribuuttiin. Kaikki API :t eivät palauta json-vastausta. Katso lisätietoja API dokumentaatiosta.
How to read value from JSON in workflow
Use json library to read value from JSON
This example is for example for OnPremisesExtensionAttributes, but this same approach can be used for all kinds of JSON messages for Microsoft Graph API and REST API's.
To read 1 specific value from JSON which looks like this:
{ "extensionAttribute1": "test data1", "extensionAttribute2": null, "extensionAttribute3": null, "extensionAttribute4": "EXT", "extensionAttribute5": null, "extensionAttribute6": null, "extensionAttribute7": null, "extensionAttribute8": null, "extensionAttribute9": "HR functions", "extensionAttribute10": "100", "extensionAttribute11": null, "extensionAttribute12": null, "extensionAttribute13": null, "extensionAttribute14": "test5", "extensionAttribute15": "M365_E5" }
You can do it easily with following code on workflow script.
Example (example uses two esm attributes: onPremisesExtensionAttributes and extensionAttribute14code):
import json
if onPremisesExtensionAttributes:
_data = this.get("onPremisesExtensionAttributes")
_obj = json.loads(_data)
_value = _obj["extensionAttribute14"]
this.set("extensionAttribute14code",_value)Remember to always test, that code selects correct data from JSON for your use-case, and if not, do needed adjustments to it.
Pro - Jos REST API -kutsussa on ongelma, tähän attribuuttiin kirjoitetaan virhe.
Poikkeusten käsittely:
- Pro on valinnainen ominaisuus tässä työnkulkusolmussa. Järjestelmänvalvojat voivat määrittää tämän ominaisuuden käyttöön siten, että poikkeuksia voidaan kirjoittaa, jos valmistelutoimintojen aikana on poikkeuksia.
- Solmun tulos on tilassa ”Valmis”, jos REST API http -vastauskoodi on 200 tai yli ja alle 400.
- Tiedot onnistuneista/epäonnistuneista REST API -kutsuista löytyvät lokitiedostoista.
Vianmääritys
Tässä luvussa kuvataan vianmääritysvaihtoehtoja,
- Jos käytetään vikamallia, tarkista oikea datakortti
- Tarkista ajoitettujen tehtävien historia liitinten hallinnasta
- Tarkista Efecte Provisioning Engine lokit
Rajoitukset
Tapahtumapohjaisten tehtävien rajoitukset
- Sähköpostit eivät ole tuettuja
- Liitteitä ei tueta
Ajoitettujen tehtävien rajoitukset
- Päivämäärätyyppiattribuutit (sinun on yhdistettävä ne merkkijonotyyppiattribuuttiin)
- DateTime-tyyppiattribuutit (sinun on yhdistettävä ne merkkijonotyyppiattribuuttiin)
- Sähköpostit eivät ole tuettuja
- Liitteitä ei tueta