ESS: Efecte Identity Management -konnektori
ESS: Efecte Identity Management -konnektori
Tietoa tästä dokumentista
Tämän dokumentin tarkoituksena on antaa käsitys Efecte Self-Servicen Efecte Identity -konnektorin määrityksestä, siitä miten Efecte Self-Service käyttää Efecte Identity Managementista saamiaan tietoja, sekä tavoista, joilla loppukäyttäjät voivat päivittää tietojaan Efecte Identity Managementiin.
Tässä artikkelissa kuvataan Efecte Identity Management -konnektorin toiminta ESS-versiossa 2022.3 tai uudemmassa.
Huomautus
Efecte Self-Service-versiosta 2018.3.0 alkaen vaaditaan Efecte Identity Management -versio 2018.3.1 tai uudempi konnektoriin tehtyjen muutosten vuoksi.
Efecte Identity Management -konnektori
Tämä konnektori huolehtii integraatiosta Efecte Identity Management -järjestelmän kanssa (jäljempänä EIM tai Efecte Identity). Konnektorin määritys tallennetaan /etc/integration-hub/tenant-configs/<tenant_name >/connector-idm.xml -tiedostoon. Määrityksen muutokset edellyttävät vuokralaisen uudelleenlatausta suorittamalla "integration-hub-tenant reload <tenant_name>" -komento.
Määrityksen yhteinen osa (jota käyttävät tämän konnektorin eri toiminnot) ovat EIM-yhteyden ominaisuudet beanissa, jonka id on ="idmRemoteConfiguration".
Parameter |
Description |
accountType |
ESS:n teknisen käyttäjän tilityyppi Efecte Identityssä |
username |
ESS:n teknisen käyttäjän käyttäjätunnus Efecte Identityssä |
password |
ESS:n teknisen käyttäjän salasana Efecte Identityssä |
host |
Efecte Identity -isäntä (nimi tai IP) |
port |
Efecte Identity -isännän portti etäkutsuja varten, oletuksena JBoss kuuntelee porttia 4447 |
sslEnabled |
käytetäänkö ESS:n ja EIM:n välillä salattua SSL-yhteyttä |
invocationTimeout |
Aikakatkaisu millisekunteina EIM:n EJB-kutsun pyyntö/vastaus-syklille, eli metodikutsulle. Oletusarvo on 30000. |
SSL-salatun yhteyden käyttämiseksi ('sslEnabled'-lipun käyttöönoton lisäksi) tarvitaan myös varmenteen määritys. EIM:n pääkäyttäjän tulisi toimittaa sinulle sopiva varmenne, joka on tuettu myös EIM:n puolella. Tuo varmenne paikalliseen keystoreen Integration Hub -koneella suorittamalla:
yes yes | keytool -importcert -file "idm-remoting.crt" -alias "idm-remoting.crt" -keystore /etc/pki/java/cacerts -storepass changeitKäytä omaa varmennetiedoston nimeäsi ja keystore-salasanaasi.
Organisaatiokonnektori
Kun se on määritetty oikein, Identity-konnektoria voidaan käyttää organisaatiotietojen lähteenä, jolloin se korvaa LDAP-konnektorin.
Organisaatiotietoja käsittelee bean id="idmOrganizationInfoHandler", joka sisältää seuraavat parametrit:
Parameter |
Description |
efecteIdentityFacade |
määritetyn com.efecte.integration.connector.idm.EfecteIdentityFacade-tyyppisen beanin instanssi (katso alla) |
searchLimit |
kerralla Efecte Identitystä haettavien käyttäjien enimmäismäärä |
userFilter |
joukko suodattimia, jotka määrittävät, mitkä käyttäjät tuodaan Efecte Identitystä. Yksi suodatin voi olla esim. "cn=Users,dc=host,dc=domain,dc=com". Voi sisältää useita suodattimia useissa <value>-tageissa. Jos ESS:n pääkäyttäjänäkymän Site-asetukset ovat tyhjät, ESS poimii aktiivisten OU:iden listan userFilter-listasta. |
Esimerkkimääritys:
<bean id="idmOrganizationInfoHandler" class="com.efecte.integration.connector.idm.handler.IdmOrganizationInformationHandler">
<property name="efecteIdentityFacade" ref="efecteIdentityFacade"/>
<property name="searchLimit" value="500"/>
<property name="userFilter">
<set>
<value>cn=Users,dc=host,dc=domain,dc=com</value>
</set>
</property>
</bean>Efecte Identity Managementin ja konnektorin välistä viestintää käsittelee bean id="efecteIdentityFacade" seuraavilla parametreilla:
Parameter |
Description |
accountTypeMethodNames |
joukko Efecte Identity Managementista tuotujen käyttäjien tilien tilityyppimenetelmiä |
serviceAgreementNames |
joukko Efecte Identitystä tuotujen käyttäjien palvelusopimuksia |
roleTypeNames |
joukko Efecte Identitystä organisaatiotietojen mukana tuotuja rooleja |
Lisää ominaisuuksiin accountTypeMethodNames, roleTypeNames ja/tai serviceAgreementNames lisää value-tageja kohteessa efecteIdentityFacade.
Huomautus
Kaikkien konnektorissa määriteltyjen palvelusopimusten nimien tulee olla olemassa Efecte Identity Managementissa, tai organisaatiotietojen haku epäonnistuu.
efecteIdentityFacade
<bean id="efecteIdentityFacade" class="com.efecte.integration.connector.idm.EfecteIdentityFacade">
<constructor-arg ref="idmRemoteConfiguration"/>
<property name="accountTypeMethodNames">
<set>
<value>AD Password</value>
<value>Some Other Password</value>
</set>
</property>
<property name="serviceAgreementNames">
<set>
<value>Customer - AD users</value>
</set>
</property>
<property name="roleTypeNames">
<set>
<value>AD group</value>
</set>
</property>
</bean>Haun suorituskyky
Suorituskykytilastot voidaan ottaa käyttöön tarkemman näkymän saamiseksi suoritusvuosta. Tee tämä määrittämällä metrics-palvelu konnektorin xml-määrityksessä:
<!-- Performance Metrics -->
<bean class="com.efecte.integration.util.Metrics" id="metrics" init-method="init" destroy-method="destroy">
<property name="metricsEnabled" value="true"/>
<property name="metricsLogName" value="Metrics"/>
<property name="metricsLogMarker" value="METRICS"/>
<property name="reportTimeUnit" value="MINUTES"/>
<property name="reportPeriod" value="1"/>
</bean>
<bean id="idmOrganizationInfoHandler" class="com.efecte.integration.connector.idm.handler.IdmOrganizationInformationHandler">
... existing configuration ...
<property name="metrics" ref="metrics"/>
</bean>ja määritä sopiva loki (logger) log4j.xml-tiedostossa:
<appender name="agent-stats" class="org.apache.log4j.RollingFileAppender">
<!-- The active file to log to -->
<param name="file" value="/var/log/integration-agent/agent-stats.log"/>
<param name="append" value="true"/>
<param name="encoding" value="UTF-8"/>
<param name="MaxFileSize" value="100MB"/>
<param name="MaxBackupIndex" value="10"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%c{1}|%p|%d|%t|%X{hostName}|%m%n"/>
</layout>
</appender>
<!-- Application performance metrics -->
<logger name="Metrics">
<level value="info"/>
<appender-ref ref="agent-stats"/>
</logger>Efecte Identity Managementista saatava data
Seuraavassa on lueteltu EIM:n käyttäjän (agentin) keskeiset tietokentät, joita ESS käyttää tietoja hakiessaan ja kirjoittaessaan.
EIM-attribuutti |
Määritelmä |
ESS:n käyttö |
Name |
Pakollinen, yksilöllinen Agentin distinguished name (yksilöivä nimi) |
Erottaa käyttäjät yksilöllisesti toisistaan. Jos kaksi agenttia on täsmälleen samalla nimellä, organisaatiotietojen haussa ilmenee virheitä ja käyttäjiä puuttuu. |
|
Pakollinen, yksilöllinen agentin sähköpostiosoite |
ESS käyttää agentin sähköpostiosoitetta viestiessään ESM:n kanssa sekä sähköposti-ilmoituksia varten. ESS voi käyttää vain ensisijaista sähköpostiosoitetta, muita sähköpostiosoitteita ei voida käyttää. Lisäksi käytetään käyntikorttilomakkeessa. |
|
Display name |
Valinnainen |
Näytetään käyttäjälle käyttäjän nimenä. Display name -kenttää käytetään esimerkiksi kommentointiominaisuudessa ja käyntikorttilomakkeessa. |
Last name |
Valinnainen | Käytetään käyntikorttilomakkeessa ja kommentointiominaisuudessa yhdessä etunimen kanssa; jos molemmat puuttuvat, käytetään display name -kenttää. |
Forename |
Valinnainen |
Käytetään käyntikorttilomakkeessa ja kommentointiominaisuudessa yhdessä etunimen kanssa; jos molemmat puuttuvat, käytetään display name -kenttää. |
Account |
Pakollinen |
Account-käyttäjätunnusta käytetään yhdessä domain-komponenttien (DC) kanssa muodostamaan Authentication ID, jota käytetään tikettien ja pyyntöjen yhdistämiseen käyttäjiin. Tämä authentication ID näytetään käyttäjälle, kun display name -kenttää ei ole määritetty (account@dc.dc2.dc3) tai käyttäjä puuttuu organisaatiotiedoista. Jos agenteilla ei ole määritettyä accountia, ESS ei hae näitä käyttäjiä organisaatiovälimuistiin. Huomautus! Authentication ID on avaintekijä käyttäjän ja pyyntöjen yhdistämisessä ESS:ssä. Minkä tahansa komponentin muuttaminen johtaa siihen, ettei pyyntöhistoria ole näkyvissä ja käyttäjää käsitellään uutena käyttäjänä. Jos account ID:tä ja siten authentication ID:tä muutetaan, vanhoja tikettejä ja hyväksyntäpyyntöjä ei näytetä käyttäjälle. Account ID on kirjainkoosta riippuvainen. |
Cost center |
Valinnainen |
Jos käyttäjä on yhdistetty kustannuspaikkaan, tätä kustannuspaikkaa käytetään oletuksena pyyntöjä tehtäessä. Jos ESS:lle ei palauteta kustannuspaikkoja, kustannuspaikan valintaa ei näytetä vahvistussivulla. Kustannuspaikkaa käytetään myös Employee-lomakkeessa. |
Supervisors |
Valinnainen | Jos käyttäjälle on asetettu voimassa oleva esimies, esimiehen nimi valitaan automaattisesti agentille tapauksissa, joissa vaaditaan hyväksyntä. Esimiesten listaa käytetään myös employee-lomakkeessa. |
Deputies |
Valinnainen |
Käytetään hyväksynnän delegointiin. Käyttäjillä, joilla on alaisia, nimettyjä hyväksyjiä tai delegoituja hyväksyjiä, tämä vaihtoehto on näkyvissä. Tämä voidaan asettaa kenelle tahansa käyttäjälle EIM:ssä, ja organisaatiotietojen haun myötä se tulee näkyväksi käyttäjälle. |
mobile |
Valinnainen, käytetään salasanan nollaukseen |
Käytetään salasanan nollaukseen. Jos käyttäjälle on asetettu matkapuhelinnumero, se näkyy loppukäyttäjän näkymässä. Jos matkapuhelinnumeroa ei ole määritetty, loppukäyttäjä voi asettaa oman matkapuhelinnumeronsa, joka päivittyy välittömästi EIM:ään. |
agent.customString13 |
Valinnainen, käytetään salasanan nollaukseen |
Tätä käytetään toissijaisen sähköpostiosoitteen tiedon välittämiseen ESM:stä EIM:ään ja takaisin. Ei kartoitu automaattisesti agentin tilin kohtaan “E-mail for password reset” |
street address |
Valinnainen |
Tätä käytetään käyntikorttilomakkeessa, yhdistettynä postinumeroon, kaupunkiin ja maahan Street Address -kenttään |
zip code |
Valinnainen |
Tätä käytetään käyntikorttilomakkeessa, yhdistettynä postinumeroon, kaupunkiin ja maahan Street Address -kenttään |
city |
Valinnainen |
Tätä käytetään käyntikorttilomakkeessa, yhdistettynä postinumeroon, kaupunkiin ja maahan Street Address -kenttään |
country |
Valinnainen |
Tätä käytetään käyntikorttilomakkeessa, yhdistettynä postinumeroon, kaupunkiin ja maahan Street Address -kenttään |
Efecte Self Service -määritys
Valitaksesi Efecte Identity -konnektorin organisaatiokonnektoriksi, määritä se Integration Suiten puolella ja avaa sitten Efecte Self Servicen pääkäyttäjäsivu, valitse Integrations -> Organization -> Organization Connector.
Ennen konnektorin vaihtamista muuta pääkäyttäjäryhmät uusien organisaatiotietojen mukaisiksi. Tämä voidaan tehdä kahdella tavalla:
- pääkäyttäjän käyttöliittymässä "Settings"-välilehdellä: "Administrators' AD group" ja “Service owners' AD group”
- webshop.properties-tiedoston parametrissa ldap.administrator.group (huomaa, että tietokannan asetukset ovat etusijalla)
Valitse sitten "Organization Connector" -pudotusvalikosta Efecte Identity -konnektori (jos sitä ei ole asetettu oletukseksi). Huomaa, että tämän jälkeen organisaatiovälimuisti tyhjennetään, ja jos käyttäjä ei ole kirjautunut global adminina, hänet saatetaan kirjata ulos. Kirjaudu tarvittaessa uudelleen ja tarkista organisaatiotiedot napsauttamalla "Show test data" -painiketta.
Huomautus
On erittäin suositeltavaa olla asentamatta useampaa kuin yhtä organisaatiokonnektoria yhdelle vuokralaiselle.
Efecte Identity organisaatiotietojen konnektorina global adminille
Jotta Efecte Identity Management -järjestelmää voidaan käyttää organisaatiotietojen lähteenä global adminille, määritä /etc/webshop/webshop.properties-tiedostossa (ESS-koneella) seuraavat:
- globaladmin.organization.connector.type = com.efecte.integration.connector.idm.IdMConnector
- globaladmin.organization.connector.instanceName = defaultEfecteIdentity
ja käynnistä ESS uudelleen. Jotta käyttäjillä olisi pääsy globaladminiin, heidän tulee lisäksi kuulua AD-ryhmään, joka on määritetty webshop.properties-tiedostossa global administrator -ryhmäksi.
My Services
Identity-konnektori voi toimia tietolähteenä My Services -kentille.
My Services on yleisnimitys joukolle integraatiomekanismeja, jotka mahdollistavat sen, että ulkoiset järjestelmät voivat dynaamisesti muokata käyttäjille näkyvän luettelon sisältöä.
MyServices-kenttien määrittäminen
- Siirry ESS:n pääkäyttäjäsivulle -> Integrations -> External data fields -> External data fields
- Paina Add MyServices field -painiketta
- Enter configuration
- Field name – anna nimi, jota käytetään tämän MyServices-kentän aliaksena
- Data from – valitse Efecte Identity -konnektori
-
Service Efecte Identitystä kartoitettuna MyServices-kenttään (kirjaudu Efecte Identityyn -> Administration -> Services -> Service Name)
- Data list id - tämän arvon tulee olla sama kuin palvelun nimi
- Paina Update-painiketta - jos virheitä ei ilmene, MyServices field elements -taulukossa näkyvät palvelulle Efecte Identityssä määritellyt 'Roles'-nimet (tarkista 'Roles' valitulta palvelulta)
Efecte Identity -konnektori ei vastaa ainoastaan elementtien synkronoinnista, vaan myös elementtien ja käyttäjien välisten liitosten seurannasta.
My Services ja tarjousluettelo
MyService-tietueen käyttäminen palvelunimiketunnusten (Service Item ID) lähteenä
- Avaa pääkäyttäjäsivun Services-välilehdellä palvelu ja valitse Service Item
- Avaa nimikkeen ominaisuuksissa 'External data link' -pudotusvalikko ja valitse käytettävän MyServices-kentän nimi
- Valitse 'Item ID'-pudotusvalikosta elementti, jota käytetään ItemId-arvona tilausta tehtäessä
Valitun elementin tunnusta käytetään ItemID-arvona, kun käyttäjät tilaavat kyseistä nimikettä.
Käyttäjien ja DataCards-korttien väliset liitokset
Konnektori ei vastaa ainoastaan Identity Service -tietojen hakemisesta, vaan myös:
- Identity Servicejen ja käyttäjien (Identity Agents) välisten liitosten seurannasta
- näiden liitosten muuttamisesta
Tämän toiminnon käyttämiseksi:
- Avaa pääkäyttäjäsivulla Service ja valitse Service Item
- Avaa palvelunimikkeen ominaisuuksissa 'MyServices Link' -pudotusvalikko ja valitse MyServices-kentän nimi
- Valitse Sub-items-pudotusvalikosta:
- User using – tässä tapauksessa käyttäjälle näytetään lista palveluista, joihin hänet on liitetty
- User not using – tässä tapauksessa käyttäjälle näytetään lista palveluista, joihin häntä ei ole liitetty
Palvelunimikkeen tilauksen lähettäminen johtaa seuraavaan:
- Poistamiseen
- Lisäämiseen
liitos tilauksen tekevän käyttäjän (agentin) ja Efecte Identity Servicen välillä.
Table of Contents