ESS: Efecte Service Management -konnektori
ESS: Efecte Service Management -konnektori
Efecte Service Management -konnektori pähkinänkuoressa
Tämän konnektorin avulla Efecte Self-Service voi
- Luoda uusia häiriöitä ja palvelupyyntöjä Efecte Service Managementiin
- Hakea päivityksiä, kun häiriöitä tai palvelupyyntöjä muutetaan Efecte Service Managementissa (esimerkiksi kun pyynnön tila muuttuu)
- Hakea ja lähettää tietämyskannan artikkeleiden arviointitietoja Tips & Tricks -toimintoon liittyen
- Hakea ja lähettää arviointitietoja ja kommentteja uusista ideoista Like My Idea -toimintoon liittyen
- Hakea dynaamista käyttäjätietoa Efecte Service Managementista (MyServices)
- Hakea tietoa palvelutarjousten pitämiseksi ajan tasalla (Catalog items)
- Lähettää hyväksymispäätöksiä Visual Workflow Approvals -toiminnolle Efecte Service Managementissa
- Lähettää loppukäyttäjiltä kerättyä palautetta Efecte Service Managementiin
Suurin osa konnektorin toiminnallisuudesta toimii automaattisesti oletusarvoja käyttäen, joihin viitataan läpi tämän dokumentin.
Tässä artikkelissa kuvataan Efecte Service Management -konnektorin toiminta ESS-versiossa 2022.3 tai uudemmassa.
Huomautus
Kahdessa käyttötapauksessa Efecte Service Management lähettää aktiivisesti tietoa Efecte Self-Servicelle. Nämä ovat ilmoitukset useita käyttäjiä koskevista ongelmista sekä Visual Workflow Automationin hyväksynnät, joissa päätös odotetaan tehtävän Efecte Self-Servicessä. Kaikessa muussa Efecte Self-Service on aktiivinen osapuoli.
Tuetut mallit
Efecte-konnektori tukee oletusarvoisesti kahta mallia – palvelupyyntöä (ServiceRequest) ja häiriötä (incident). Jos tarvitaan tukea useammalle mallille, vuokralaiselle voidaan ottaa käyttöön useita ESM-konnektoreita, ja pyyntöjen kohde voi poiketa oletuksesta. Tällöin vain yhdessä konnektorissa saa olla määritetty tietämyskanta- ja like my idea -asetukset – jos useammassa konnektorissa on jompikumpi määritetty, etusivulla artikkeleiden näyttämiseen käytetään viimeksi Efecte Self-Serviceen haettua tulosjoukkoa, mikä saattaa aiheuttaa sekavan käyttökokemuksen erityisesti ESM:n sisäisiin eri lähteisiin viitattaessa.
Toisaalta yhden mallin käyttäminen voi olla kiinnostava vaihtoehto. Oikealla määrityksellä kaikki pyynnöt voidaan ohjata haluttuun malliin. Kiinnitä kuitenkin huomiota attribuuttikoodeihin, tila-arvoihin sekä eri pyyntötyyppien mahdollisiin erotteluihin, jotta vältetään virheellisistä määrityksistä johtuvien ylimääräisten lokimerkintöjen syntyminen.
ESM-viestien muoto
ESS- ja ESM-tuotteiden välillä vaihdettujen viestien muoto on kiinteästi määritetty.
Huomautus: MyService-toiminnon monivalintakentät välitetään CSV-muodossa xml-tagien sisällä.
Yhteyden määritys
Määritä ESM:n yhteys käyttämällä luokan com.efecte.integration.connector.configuration.ConnectionConfiguration beania seuraavan esimerkin mukaisesti:
<bean id="connectionConfiguration" class="com.efecte.integration.connector.configuration.ConnectionConfiguration">
<property name="url" value="https://xxxxxxxxx.efectecloud.com/api/itsm" />
<property name="user" value="webapi-user" />
<property name="password" value="xxxxxxxxxxxxxxxxxxxxxxxxxx" />
<property name="connectionRequestTimeout" value="300" />
<property name="connectTimeout" value="300" />
<property name="socketTimeout" value="300" />
<property name="acceptSelfSignedCertificates" value="false"/>
<property name="allowAllHostnamesInCertificate" value="false"/>
</bean>Huomautus! Kun käytetään useita konnektoreita ja osa niistä viittaa eri yhteysmääritykseen (esimerkiksi eri ympäristöön), niillä tulee olla yksilöllinen ID kutakin yhteysmääritystä kohden. Toisin sanoen varmista, ettei kahdella eri yhteysmäärityksellä ole samaa bean-ID:tä. Tämä koskee tilannetta, jossa yhdestä ESS:stä yhdistetään kahteen eri ESM-ympäristöön, joten ympäristön merkitseminen bean-ID:hen voi olla hyvä idea, esim.
bean id="connectionConfigurationEnvName”
Tämä bean tukee seuraavia ominaisuuksia:
| Name | Default value | Description |
| url | http://efecte.company.com | ESM-rajapinnan URL-osoite |
| user | webapi-user | käyttäjätunnus |
| password | ESM-rajapinnan salasana | |
| acceptSelfSignedCertificates | false | Jos arvo on ”true”, itse allekirjoitetut varmenteet hyväksytään |
| allowAllHostnamesInCertificate | false | Jos arvo on ”true”, varmenteiden palvelimen isäntänimen tarkistus poistetaan käytöstä. Tuotantojärjestelmissä tämä tulee aina asettaa arvoon false! |
| connectionRequestTimeout | 300 | Palauttaa aikakatkaisun sekunteina, jota käytetään pyydettäessä yhteyttä yhteydenhallinnalta. Aikakatkaisuarvo nolla tulkitaan äärettömäksi aikakatkaisuksi. Aikakatkaisuarvo nolla tulkitaan äärettömäksi aikakatkaisuksi. Negatiivinen arvo tulkitaan määrittelemättömäksi (järjestelmän oletusarvo). |
| connectTimeout | 300 | Määrittää aikakatkaisun sekunteina, kunnes yhteys muodostuu. Aikakatkaisuarvo nolla tulkitaan äärettömäksi aikakatkaisuksi. Negatiivinen arvo tulkitaan määrittelemättömäksi (järjestelmän oletusarvo). |
| socketTimeout | 300 | Määrittää socket-aikakatkaisun (SO_TIMEOUT) sekunteina, joka on tietojen odottamisen aikakatkaisu, eli toisin sanoen enimmäisaika passiivisuudelle kahden peräkkäisen datapaketin välillä. Aikakatkaisuarvo nolla tulkitaan äärettömäksi aikakatkaisuksi. Negatiivinen arvo tulkitaan määrittelemättömäksi (järjestelmän oletusarvo). |
Palvelupyynnön määritys
Palvelupyynnön attribuuttien kartoitukset voidaan määrittää connector-efecte.xml-tiedostossa. Esimerkkimääritys kaikista käytettävissä olevista vaihtoehdoista:
<bean id="connectorEfecte"
class="com.efecte.integration.connector.efecte.EfecteConnector">
<property name="serviceRequestAttributes">
<bean class="com.efecte.integration.connector.configuration.ServiceRequestAttributes">
<property name="templateCode" value="ServiceRequest"/>
<property name="bundleTemplateCode" value="ServiceRequestBundle"/>
<property name="folderCode" value="ServiceRequests"/>
<property name="attachmentAttribute" value="RequestAttachments"/>
<property name="statusAttribute" value="status"/>
<property name="reopenReasonAttribute" value="reopen_reason"/>
<property name="creationDateAttribute" value="created"/>
<property name="deadlineAttribute" value="deadline"/>
<property name="updatedAttribute" value="updated"/>
<property name="efecteIdAttribute" value="efecte_id"/>
<property name="languageAttribute" value="Language"/>
<property name="feedbackAttribute" value="rating"/>
<property name="resolutionTextAttribute" value="resolution"/>
<property name="supportPersonAttribute" value="support_person"/>
<property name="serviceOfferingNameAttribute" value="ServiceOffering"/>
<property name="serviceItemNameAttribute" value="ServiceItemName"/>
<property name="serviceItemExternalIdAttribute" value="ServiceItem"/>
<property name="priceAttribute" value="Price"/>
<property name="monthlySubscriptionAttribute" value="MonthlySubscription"/>
<property name="requestedForAttribute" value="RequestedFor"/>
<property name="costCenterAttribute" value="CostCenter"/>
<property name="deliveryAddressAttribute" value="DeliveryAddress"/>
<property name="orderedByAttribute" value="OrderedBy"/>
<property name="additionalInformationAttribute" value="AdditionalInformation"/>
<property name="siteIDAttribute" value="SiteID"/>
<property name="siteNameAttribute" value="SiteName"/>
<property name="requestBundleAttribute" value="RequestBundle"/>
<property name="requestBundleNameAttribute" value="RequestBundleName"/>
<property name="orderedByEmailAttribute" value="OrderedBy:email"/>
<property name="requestedForEmailAttribute" value="RequestedFor:email"/>
<property name="commentAttribute" value="external_comments"/>
<property name="reasonAttribute" value="user_reason"/>
<property name="dedicatedApproverAttribute" value="DedicatedApprover"/>
<property name="superiorApproverAttribute" value="approving_manager"/>
<property name="totalPriceAttribute" value="totalPrice"/>
<property name="quantityAttribute" value="quantity"/>
<property name="totalMonthlySubscriptionAttribute"value="TotalMonthlySubscription"/>
<property name="punchout" value="punchOutOrderId"/>
</bean>
</property>
<!-- other configuration -->
</bean> Häiriöiden kartoitusta voidaan muokata vuokralaisen pääkäyttäjän käyttöliittymässä, tukikanavan määritysvälilehdellä. Uutta tukikanavaa luotaessa oletusarvot näkyvät määrityksessä.
Yksityiskohtaiset säännöt palvelupyynnön ominaisuuksien käsittelylle ovat seuraavat:
| Attribute name | Description |
| integrationIdAttribute | Jos määritetty, olemassa olevaa palvelupyyntöä päivitetään (kartoitettu GeneralConfiguration-beanissa, ei suositella muutettavaksi – oletusarvo on WebShopId) |
| efecteIdAttribute | Jos integrationIdAttribute on tyhjä eikä ESS:ssä ole pyyntöä annetulla efecteIdAttribute-arvolla, luodaan uusi palvelupyyntö; jos pyyntö kyseisellä efecteIdAttribute-arvolla on jo olemassa ESS:ssä, olemassa oleva päivitetään |
| requestedForEmailAttribute | Kyseisellä sähköpostiosoitteella tulee olla käyttäjä ESS:n organisaatiotiedoissa. Jos näin ei ole, palvelupyyntö hylätään ja asianmukainen tieto kirjataan ESS:n lokitiedostoon (esimerkkilokimerkintä: Couldn't match user with email ... to user. Service request is not created for id ...) |
| orderedByEmailAttribute | Vastaavalla sähköpostiosoitteella tulee olla käyttäjä organisaatiotiedoissa. Jos käyttäjää ei ole, palvelupyyntö hylätään ja asianmukainen tieto kirjataan ESS:n lokitiedostoon. Jos kentän arvo on tyhjä, käytetään sen sijaan requestedForEmailAttribute-arvoa |
| serviceItemExternalIdAttribute | Palvelunimikkeen, jolla on kyseinen Item ID, tulee olla olemassa ja voimassa (tarkistukset tehdään myös työkopiota vasten). Jos tämä ehto ei täyty, palvelupyyntö hylätään ja asianmukainen tieto kirjataan ESS:n lokitiedostoon |
| serviceOfferingNameAttribute | Jos asetettu, palvelupyyntö luodaan kyseisellä nimellä. Jos attribuuttia ei ole asetettu, palvelutarjouksen nimi kopioidaan serviceItemExternalIdAttribute-arvon perusteella löydetystä palvelutarjouksesta |
| itemNameAttribute | Jos asetettu, palvelupyyntö luodaan kyseisellä nimellä. Jos attribuuttia ei ole asetettu, palvelunimikkeen nimi kopioidaan serviceItemExternalIdAttribute-arvon perusteella löydetystä palvelunimikkeestä |
| priceAttribute / monthlySubscriptionAttribute | Jos asetettu, palvelupyyntö luodaan kyseisellä hinnalla/kuukausimaksulla. Jos attribuuttia ei ole asetettu, arvot kopioidaan serviceItemExternalIdAttribute-arvon perusteella löydetystä palvelunimikkeestä |
| additionalInformationAttribute | Jos ESM:n lisätietoattribuutin arvo alkaa merkkijonolla "Description:", konnektori ottaa tekstin "Description:"-osan jälkeen rivin loppuun asti. Jos lisätietokenttä ei ala "Description:"-etuliitteellä, koko attribuutin sisältö käsitellään |
| reasonAttribute | Kerää arvon, jonka käyttäjä on antanut kentässä ”Reason” tilauksen vahvistusvaiheessa. Oletusarvoisesti arvo kartoitetaan ESM-attribuuttikoodiin ”user_reason”. |
| requestBundleAttribute | Tämän attribuutin arvo on yksilöllinen jokaiselle pakettitilaukselle ESS-tietokannassa. Arvo kartoitetaan ESM-attribuuttiin ”RequestBundle”. Jokaisella pakettitilauksella voi olla yksi tai useampi palvelupyyntö, joilla kullakin on oma yksilöllinen serviceItemExternalIdAttribute-arvonsa. |
| requestBundleNameAttribute | Tämän attribuutin arvo on ohjatun tarjouksen nimi. Arvo kartoitetaan ESM-attribuuttiin ”RequestBundleName”. |
Jos palvelutarjoukselle on valittu ”Item quantity enabled”, palvelupyynnölle käsitellään seuraavat lisäsäännöt:
| Attribute name | Description |
|
quantityAttribute
|
ESS:n tilauksen määrätieto lähetetään ESM-attribuuttiin, jonka koodi on quantity. Attribuutin tyypin ESM:ssä tulee olla number. |
|
totalPriceAttribute
|
Kunkin ESS:n palvelunimiketilauksen kokonaishinta lähetetään ESM-attribuuttiin, jonka koodi on totalPrice. Attribuutin tyypin ESM:ssä tulee olla decimal number. |
|
totalMonthlySubscriptionAttribute
|
Kunkin ESS:n palvelunimiketilauksen kokonaiskuukausimaksu lähetetään ESM-attribuuttiin, jonka koodi on TotalMonthlySubscription. Attribuutin tyypin ESM:ssä tulee olla decimal number. |
Huomautus! Yllä luetellut attribuutit ovat oletusarvoja. Jos niitä on tarpeen muuttaa, vastaavat koodit tulee määrittää konnektoritiedostossa.
PunchOut-toiminto mahdollistaa sen, että Efecte Self-Servicen käyttäjät voivat käyttää ulkoista verkkokauppaa nimikkeiden keräämiseen palvelupyyntöönsä. PunchOut-toimintoa varten konnektorissa tarvitaan seuraavat attribuutit. Lisätietoja löytyy PunchOut-määritysoppaasta.
| Attribute name | Description |
|
totalPriceAttribute
|
Katso yllä |
|
punchout
|
Punchout-attribuutin punchOutOrderId-koodia käytetään tilauksen tunnisteena. Sillä tulee olla arvo, ennen kuin hyväksytty tilaus lähetetään PunchOut-palveluntarjoajalle. |
Seurantakonnektori (Tracking connector)
Seurantakonnektori käynnistää päivitysten haun Efecte Service Managementista sekä häiriöille että palvelupyynnöille. ESM:stä ESS:ään tulevien häiriöiden oletusaluekartoitus ja palvelupyyntöjen palvelunimikekartoitus voidaan määrittää asettamalla seuraavat EfecteTrackingConnector-beanin ominaisuudet:
| Name | Default value | Description |
| defaultIntegrationCategoryId | DEFAULT_CATEGORY | Häiriöiden oletusaluekartoitus |
| defaultIntegrationServiceItemId | DEFAULT_SERVICE_ITEM | Palvelupyyntöjen oletuspalvelunimikekartoitus |
| pollNewServiceRequestEnabled | false | Ottaa käyttöön uusien palvelupyyntöjen haun ESM:stä |
| pollNewIncidentEnabled | true | Jos asetettu arvoon false, ei haeta häiriöitä, joilla on tyhjä uuid (eli ne, jotka on luotu ESM:ssä eikä ESS:ssä) |
Huomautus! Oletusarvoisesti haetaan häiriöitä, ei palvelupyyntöjä. Jotta myös palvelupyyntöjä haetaan, Efecte Tracking Connector tulee lisätä konnektoritiedostoon.
Jotta uusien palvelupyyntöjen haku toimisi oikein, seuraavat attribuutit ovat pakollisia ESM:n puolella:
- Pyynnön tunniste välitetään efecteIdAttribute-attribuutissa, oletusarvo ’efecte_id’
- Tila välitetään statusAttribute-attribuutissa, oletusarvo ’status’
- Asiakkaan tunniste välitetään requestedForEmailAttribute-attribuutissa, oletusarvo ’RequestedFor:email’
- Nimiketunnus (Item ID) välitetään serviceItemExternalIdAttribute-attribuutissa, oletusarvo ’ServiceItem’ - jos tämän attribuutin arvo on tyhjä, konnektori käyttää arvoa seurantakonnektorin määrityksen defaultIntegrationServiceItemId-kohdasta
Jotta uusien häiriöiden haku toimisi oikein, seuraavat attribuutit ovat pakollisia ESM:n puolella:
- Häiriön tunniste välitetään efecteIdAttribute-attribuutissa, oletusarvo ’efecte_id’
- Tila välitetään statusAttribute-attribuutissa, oletusarvo ’status’
- Asiakkaan tunniste välitetään customer email -attribuutissa, oletusarvo customer:email
- Kategoriatunnus (Category ID) välitetään integrationCategoryAttribute-attribuutissa, oletusarvo WebShopCategory - jos tämän attribuutin arvo on tyhjä, konnektori käyttää arvoa seurantakonnektorin määrityksen defaultIntegrationCategoryId-kohdasta (kyseisellä kategoriatunnuksella tulee olla julkaistu kategoria ESS:ssä)
Hakutiheyttä voidaan säätää luokan 'EfecteTrackingConnector' ominaisuuksilla 'updateFrequency' ja 'errorUpdateFrequency'. Arvot ilmaistaan määritettävissä olevina yksikköinä.
Huomautus! On hyvin harvinaista, että 'updateQuerySlidingWindowTime'-arvoa tarvitsee muuttaa oletuksesta. Haettu tieto sisältää aina kaikki ajanjakson aikana muuttuneet tietokortit, ja pidemmällä ajanjaksolla samat tiketit palautuvat tulosjoukkoon toistuvasti. Jo ensimmäisellä kerralla tiketti päivitetään ESS:ään. Tämän ikkunan laajentaminen saattaa hidastaa toimintaa sekä ESS:ssä että ESM:ssä ilman lisähyötyä.
| Name | Default value | Description |
| updateFrequency | 10 | Päivitysväli, kun tiedon haku onnistui |
| updateFrequencyUnit | MINUTES | Refresh period frequency unit (successful) |
| errorUpdateFrequency | 10 | Päivitysväli, kun tiedon haku epäonnistui |
| errorUpdateFrequencyUnit | MINUTES | Päivitysvälin yksikkö (virhe) |
Kun konnektori suoritetaan ensimmäistä kertaa, se hakee pyynnöt ja häiriöt viimeisen 24 tunnin ajalta. Tätä aikaa voidaan säätää määrittämällä ominaisuudet initialQuerySlidingWindowTime ja initialQuerySlidingWindowUnit.
Efecte Tracking Connectorin muut oletusarvot ovat:
| Name | Default value | Description |
| updateQuerySlidingWindowTime | 20 | Ajanjakso, jolta tietoa haetaan verrattuna ESM:n viimeisimpään päivitysaikaan (esim. viimeisten 20 minuutin ajalta) |
| updateQuerySlidingWindowUnit | MINUTES | Refresh period frequency unit (successful) |
| initialQuerySlidingWindowTime | 1 | Ajanjakso, jolta tietoa haetaan ensimmäisellä suorituskerralla verrattuna ESM:n viimeisimpään päivitysaikaan (esim. viimeisten 24 tunnin ajalta) |
| initialQuerySlidingWindowUnit | DAYS | Refresh period frequency unit (error) |
| serviceRequestPollCondition | Palvelupyyntöjen päivitysten haun oletusehto | |
| incidentPollCondition | Häiriöiden päivitysten haun oletusehto |
Esimerkkimääritys:
<property name="efecteTrackingConnector">
<bean class="com.efecte.integration.connector.efecte.EfecteTrackingConnector">
<property name="updateQuerySlidingWindowTime" value="20"/>
<property name="updateQuerySlidingWindowUnit" value="MINUTES"/>
<property name="initialQuerySlidingWindowTime" value="1"/>
<property name="initialQuerySlidingWindowUnit" value="DAYS"/>
<property name="updateFrequency" value="10" />
<property name="updateFrequencyUnit" value="MINUTES" />
<property name="errorUpdateFrequency" value="10" />
<property name="errorUpdateFrequencyUnit" value="MINUTES" />
<property name="defaultIntegrationServiceItemId" value="DEFAULT_SERVICE_ITEM" />
<property name="pollNewServiceRequestEnabled" value="false" />
<property name="defaultIntegrationCategoryId" value="DEFAULT_EFECTE_CATEGORY"/>
<property name="serviceRequestPollCondition" value="and $creator$ = 'WebAPI'"/>
<property name="incidentPollCondition" value="and $creator$ = 'WebAPI'"/>
<property name="pollNewIncidentEnabled" value="true" />
</bean>
</property>Jos 'updateQuerySlidingWindowTime'-ominaisuutta ei ole määritetty seurantakonnektorissa, oletusliukuvan ikkunan kokona käytetään 'pollingInterval'-arvoa kerrottuna kahdella (2).
Palautelomake
Palautelomake on oletuksena tuettu ESM-konnektorissa. ESM-kenttiin kartoittamiseen käytettävät attribuutit voidaan määrittää säätämällä EfecteFeedbackFormConnector-luokan beanin ominaisuuksia sekä itse lomakkeella pääkäyttäjän käyttöliittymän Feedback management -välilehdellä. Seuraavia ominaisuuksia tuetaan:
| Name | Default value | Description |
| templateCode | feedback_management | Palautelomakkeen mallikoodi |
| folderCode | feedback | Palautelomakkeen kansio |
| efecteIdAttribute | ticket_id | Attribuutin nimi, joka sisältää tiketin tunnisteen |
| customerAttribute | customer | Attribuutin nimi, joka sisältää asiakasviittauksen |
| ratingAttribute | ticket_rating | Attribuutin nimi, joka sisältää numeerisen arvion |
Esimerkkimääritys EfecteFeedbackFormConnectorista EfecteConnectorin sisällä connector-efecte.xml-tiedostossa:
<bean id="defaultConnectorEfecte" class="com.efecte.integration.connector.efecte.EfecteConnector">
<property name="connectionConfiguration" ref="connectionConfiguration" />
<property name="feedbackFormConnector">
<bean class="com.efecte.integration.connector.efecte.EfecteFeedbackFormConnector">
<property name="feedbackAttributes">
<bean class="com.efecte.integration.connector.configuration.FeedbackAttributes">
<property name="templateCode" value="feedback_management" />
<property name="folderCode" value="feedback" />
<property name="efecteIdAttribute" value="ticket_id" />
<property name="customerAttribute" value="customer" />
<property name="ratingAttribute" value="ticket_rating" />
</bean>
</property>
</bean>
</property>
</bean>Huomautus
Jotta palautetta voidaan antaa ensin Efecte Service Management -työkaluun kirjatuille asioille, varmista, että asiat haetaan ensin Efecte Self-Service -portaaliin seurantakonnektorin kautta. Asian tulee olla ESS:n tietokannassa, ennen kuin siitä voidaan antaa palautetta.
Tips & Tricks
Tämä ominaisuus mahdollistaa tietämyskannan tuomisen Efecte Service Management -järjestelmästä. Lisätietoja täydellisestä määrityksestä löytyy ConfiguringTipsTricks-oppaasta.
Integration Suiten määritys
Kaikki Integration Suiten määritystiedostot sijaitsevat /etc/integration-hub/-hakemistossa ja sen alihakemistoissa. Vuokralaiskohtaiset konnektorit sijaitsevat tenant-configs/{tenant_name}-alihakemistoissa.
Määrittääksesi tuen "Tips & Tricks" -toiminnolle Integration Suitessa, muokkaa connector-efecte.xml-tiedostoa. Lisää luokan "EfecteKnowledgeBaseConnector" bean ja anna sille ESM-yhteyden määritys-bean.
<bean id="connectionConfiguration"
class="com.efecte.integration.connector.configuration.ConnectionConfiguration">
<property name="url" value=" http://efecte.efecte.com/efecte " />
<property name="user" value="webapi-user" />
<property name="password" value="PASSWORD" />
</bean>
<bean id="efecteKnowledgeBaseConnector" class="com.efecte.integration.connector.efecte.EfecteKnowledgeBaseConnector">
<property name="connectionConfiguration" ref="connectionConfiguration"/>
</bean>Huomautus! On hyvä käytäntö jakaa yhteysmääritys Efecte-konnektoreiden kesken, joten seuraava koodi (yleisesti käytetty määrityksissä):
<bean id="defaultConnectorEfecte" class="com.efecte.integration.connector.efecte.EfecteConnector">
<property name="connectionConfiguration">
<bean class="com.efecte.integration.connector.configuration.ConnectionConfiguration">
<property name="url" value="http://efecte.company.com" />
<property name="user" value="webapi-user" />
<property name="password" value="PASSWORD" />
</bean>
</property>
</bean>voidaan korvata seuraavalla:
<bean id="defaultConnectorEfecte" class="com.efecte.integration.connector.efecte.EfecteConnector">
<property name="connectionConfiguration" ref="connectionConfiguration"/>
</bean>Tietämyskannan mallin parametrien määrittäminen
Jos haluat muuttaa ESM:ssä Knowledge Base -tuelle käytettävien attribuuttien nimiä, mallin parametrit voidaan määrittää lisäämällä efecteKnowledgeBaseConnector-beaniin knowledgeBaseAttributes-ominaisuus. Muutoin käytetään oletusasetuksia.
<bean id="efecteKnowledgeBaseConnector" class="com.efecte.integration.connector.efecte.EfecteKnowledgeBaseConnector">
<property name="connectionConfiguration" ref="connectionConfiguration"/>
<property name="knowledgeBaseAttributes" >
<bean id="knowledgeBaseAttributes" class="com.efecte.integration.connector.configuration.KnowledgeBaseAttributes">
<property name="templateCode" value="knowledge_base_article"/>
<property name="pollingFolderCode" value="knowledge_base"/>
<property name="updateReadStatsFallbackFolderCode" value="knowledge_base"/>
<property name="ratingFallbackFolderCode" value="knowledge_base"/>
<property name="publishedInEssAttr" value="published_in_self_service"/>
<property name="publishedInEssValue" value="Yes"/>
<property name="deletedAttr" value="deleted"/>
<property name="nameAttr" value="solution_name"/>
<property name="descriptionAttr" value="solution_description"/>
<property name="categoryAttr" value="category"/>
<property name="adGroupsAttr" value="ad_groups"/>
<property name="efecteIdAttr" value="efecte_id"/>
<property name="updatedAttr" value="updated"/>
<property name="ratingAttr" value="rating"/>
<property name="rankingAttr" value="rating"/>
<property name="readStatsAttr" value="read_count"/>
<property name="keywordsAttr" value="solution_keywords"/>
<property name="keywordsSeparator" value=","/>
</bean>
</property>
</bean>KnowledgeBaseAttributes-luokan beanille tuetaan seuraavia ominaisuuksia:
| Name | Default value | Description |
| templateCode | knowledge_base_article | Knowledge Base -mallin koodi |
| pollingFolderCode | jos pollingFolderCode on määritetty, artikkeleita haetaan vain tästä kansiosta. Jos pollingFolderCode ei ole määritetty, artikkeleita haetaan ilman kansiorajoitusta. |
|
| ratingFallbackFolderCode | knowledge_base | Varakansion koodi, jota käytetään äänestystä tallennettaessa. |
| updateReadStatsFallbackFolderCode | knowledge_base | Varakansion koodi, jota käytetään lukutilastoja päivitettäessä. |
|
|
Attribuutin nimi, joka ilmaisee, tulisiko artikkeli hakea ESS:ään |
|
|
Attribuutin publishedInEssAttr arvo, joka ilmaisee, että artikkeli tulisi hakea. |
|
|
Attribuutin nimi, joka ilmaisee, onko KB-artikkeli poistettu |
|
|
Attribuutin nimi, joka sisältää KB-artikkelin nimen |
|
|
Attribuutin nimi, joka sisältää KB-artikkelin sisällön |
|
|
Attribuutin nimi, joka sisältää KB-artikkelin kategorian |
|
|
ESM-attribuutti, jota käytetään Tips & Tricks -suodatukseen kirjautuneen käyttäjän EIM-roolin perusteella |
|
|
Attribuutin nimi, joka sisältää KB-artikkelin efecte-tunnisteen |
|
|
Attribuutin nimi, joka sisältää KB-artikkelin viimeisimmän päivitysajan |
|
|
Attribuutin nimi, joka ilmaisee, mihin tietämyskannan palaute tallennetaan |
|
|
Attribuutin nimi, joka ilmaisee, mihin tietämyskannan sijoitus (ranking) tallennetaan |
|
|
Attribuutin nimi, joka sisältää KB-artikkelin lukutilaston |
|
|
Attribuutin nimi, joka sisältää KB-artikkelin avainsanat |
|
|
Jos KB-artikkelilla on useita avainsanoja, tätä avainsanaerotinta on käytettävä |
"Tips & Tricks"-päivitystiheyden määrittäminen
Oletusarvoisesti, jos virhettä ei ilmene, tietämyskanta päivitetään joka 2. tunti. Jos virhe ilmenee, päivitysaika muutetaan 2 minuuttiin.
Ajastuksen aloitusviivettä (aika, jonka jälkeen konnektori alkaa toimia integraatiohubin käynnistymisestä laskettuna) voidaan määrittää connectorScheduler-beanin startUpDelay-ominaisuudella hub.xml-tiedostossa.
| Name | Default value | Description |
| startUpDelay | 20000 | Aika (millisekunteina), jonka jälkeen ensimmäinen haku tehdään (oletus: 20 sekuntia) |
Esimerkki hub.xml-tiedostosta:
<bean name="connectorScheduler" class="com.efecte.integration.container.ConnectorScheduler">
<property name="taskScheduler" ref="taskScheduler"/>
<property name="startUpDelay" value="20000"/>
</bean> Päivitys- ja virhepäivitystiheydet voidaan määrittää konnektorin xml-määrityksessä (connector-efecte.xml). Käytä seuraavia ominaisuuksia:
| Name | Default value | Description |
| updateFrequency | 2 | Päivitysväli, kun tietämyskannan haku onnistui (oletus: 2 tuntia) |
| updateFrequencyUnit | HOURS | Päivitysvälin yksikkö (onnistunut) |
| errorUpdateFrequency | 2 | Päivitysväli, kun tietämyskannan haku epäonnistuu (oletus: 2 minuuttia) |
| errorUpdateFrequencyUnit | MINUTES | Refresh period frequency unit (error) |
Esimerkki connector-efecte.xml-tiedostosta:
<bean id="efecteKnowledgeBaseConnector" class="com.efecte.integration.connector.efecte.EfecteKnowledgeBaseConnector">
<property name="connectionConfiguration" ref="connectionConfiguration"/>
<property name="updateFrequency" value="30"/>
<property name="updateFrequencyUnit" value="SECONDS"/>
</bean>Like My Idea
Tämä ominaisuus mahdollistaa Efecte Service Management -järjestelmään tallennettujen ideoiden näyttämisen ja kommentoinnin.
Kaikki Integration Suiten määritystiedostot sijaitsevat /etc/integration-hub/-hakemistossa ja sen alihakemistoissa. Vuokralaiskohtaiset konnektorit sijaitsevat tenant-configs/{tenant_name}-alihakemistoissa.
Määrittääksesi tuen "Like My Idea" -toiminnolle Integration Suitessa, muokkaa connector-efecte.xml-tiedostoa. Lisää "http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.2.xsd" schema-sijainnit pääbeans-määritykseen.
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://camel.apache.org/schema/spring http://camel.apache.org/schema/spring/camel-spring.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.2.xsd">Lisää "annotation-config"-elementti sekä luokan "EfecteLikeMyIdeaConnector" bean ja anna sille ESM-yhteyden määritys-bean. Lisää myös yksi "EfecteConnectorContext"-tyyppinen bean.
<bean id="efecteLikeMyIdeaConnector" class="com.efecte.integration.connector.efecte.EfecteLikeMyIdeaConnector" autowire="constructor">
<property name="connectionConfiguration" ref="connectionConfiguration"/>
<property name="likeMyIdeaAttributes" >
<bean id="likeMyIdeaAttributes" class="com.efecte.integration.connector.configuration.LikeMyIdeaAttributes">
<property name="nameAttr" value="demand_name"/>
<property name="ratingFallbackFolderCode" value="ideas"/>
<property name="descriptionAttr" value="demand_details"/>
<property name="efecteIdAttr" value="efecte_id"/>
<property name="createdAttr" value="created"/>
<property name="likesAttr" value="likes"/>
<property name="dislikesAttr" value="dislikes"/>
<property name="templateCode" value="ideas"/>
<property name="pollingFolderCode" value="ideas"/>
<property name="deletedAttr" value="deleted"/>
<property name="commentsAttr" value="comment"/>
<property name="publishedInEssAttr" value="publish_for_rating" />
<property name="publishedInEssValue" value="Yes" />
</bean>
</property>
</bean> LikeMyIdeaAttributes-luokan beanille tuetaan seuraavia ominaisuuksia:
| Name | Default value | Description |
| templateCode | demand_management_eng | Like My Idea -mallikoodi |
| pollingFolderCode | ideas | jos pollingFolderCode on määritetty, ideoita haetaan vain tästä kansiosta. Jos pollingFolderCode ei ole määritetty, ideoita haetaan ilman kansiorajoitusta. |
| ratingFallbackFolderCode | ideas | Varakansion koodi, jota käytetään äänestystä tallennettaessa. |
|
|
Attribuutin nimi, joka ilmaisee, tulisiko artikkeli hakea ESS:ään |
|
|
Attribuutin publishedInEssAttr arvo, joka ilmaisee, että artikkeli tulisi hakea. |
|
|
Attribuutin nimi, joka ilmaisee, onko idea poistettu |
|
|
Attribuutin nimi, joka sisältää luontipäivämäärän |
|
|
Attribuutin nimi, joka sisältää idean nimen |
|
|
Attribuutin nimi, joka sisältää idean sisällön |
|
|
Attribuutin nimi, joka sisältää idean efecte-tunnisteen |
|
|
Attribuutin nimi, joka sisältää tykkäysten määrän |
|
|
Attribuutin nimi, joka sisältää ei-tykkäysten määrän |
|
|
Attribuutin nimi, joka sisältää kommentit |
"Like My Idea"-päivitystiheyden määrittäminen
Oletusarvoisesti, jos virhettä ei ilmene, "like my ideas" päivitetään joka 2. tunti. Jos virhe ilmenee, päivitysaika muutetaan 2 minuuttiin.
Ajastuksen aloitusviivettä (aika, jonka jälkeen konnektori alkaa toimia integraatiohubin käynnistymisestä laskettuna) voidaan määrittää connectorScheduler-beanin startUpDelay-ominaisuudella hub.xml-tiedostossa. Katso ohjeet Tips & Tricks -osiosta.
Päivitys- ja virhepäivitystiheydet voidaan määrittää konnektorin xml-määrityksessä (connector-efecte.xml). Käytä seuraavia ominaisuuksia:
| Name | Default value | Description |
| updateFrequency | 2 | Päivitysväli, kun ideoiden haku onnistui (oletus: 2 tuntia) |
| updateFrequencyUnit | HOURS | Refresh period frequency unit (successful) |
| errorUpdateFrequency | 2 | Päivitysväli, kun idean haku epäonnistuu (oletus: 2 minuuttia) |
| errorUpdateFrequencyUnit | MINUTES | Refresh period frequency unit (error) |
Esimerkki connector-efecte.xml-tiedostosta:
<bean id="efecteLikeMyIdeaConnector" class="com.efecte.integration.connector.efecte.EfecteLikeMyIdeaConnector">
<property name="connectionConfiguration" ref="connectionConfiguration"/>
<property name="updateFrequency" value="30"/>
<property name="updateFrequencyUnit" value="SECONDS"/>
</bean> My Services
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
- 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 Service Management -konnektori
-
Efecte Service Managementista tuleva mallin data kartoitettuna MyServices-kenttään (kirjaudu Efecte Service Managementiin -> Administration -> Templates -> valitse malli)
- Folder code – valinnainen, rajaa haettavat elementit määriteltyyn kansioon
- Template code - täytä Template code -arvolla
- Name attribute code - nimenä käytettävän attribuutin koodi (tämä attribuutti saattaa näkyä käyttäjälle)
- Technical ID attribute code - DataCard-tunnisteena käytettävän attribuutin koodi (tulisi merkitä ESM:ssä Primary-attribuutiksi)
- User attribute code - viittaus malliin, joka kuvaa tähän malliin liitettyä käyttäjää (kohdemallilla tulee olla sähköpostiattribuutti, jotta käyttäjäliitokset toimivat oikein)
- Paina Update-painiketta - jos virheitä ei ilmene, MyServices field elements -taulukossa tulisi näkyä DataCards-korttien nimet Efecte Service Managementista
- Voit varmistaa tämän tarkastelemalla taulukkoa, jossa näkyvät valittuun malliin liitetyt DataCards-kortit ESM:ssä
My Services ja tarjousluettelo
MyService-tietue palvelunimiketunnusten (Service Item ID) lähteenä
- Avaa pääkäyttäjäsivulla Services-välilehti ja valitse Service Item palvelutarjouksesta
- Avaa nimikkeen ominaisuuksissa External Data Link -pudotusvalikko ja valitse External Data -kentän nimi
- Valitse 'Item ID'-pudotusvalikosta tarvitsemasi elementti.
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 DataCards-tietojen hakemisesta, vaan myös:
- DataCards-korttien ja käyttäjien 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 DataCards-korteista, joihin hänet on liitetty
- User not using - tässä tapauksessa käyttäjälle näytetään lista DataCards-korteista, joihin häntä ei ole liitetty
Palvelunimikkeen tilauksen lähettäminen johtaa seuraavaan:
- Poistamiseen
- Lisäämiseen
liitos tilauksen tekevän käyttäjän ja DataCard-kortin välillä
Luettelon nimikkeet (Catalog items)
Seuraavat ESM-attribuuttien tietotyypit ovat tuettuja luettelon nimikkeitä määritettäessä
| Kentän nimi | ESM-attribuutin tyyppi |
| Technical ID | String |
| Name | String |
| Model | String |
| Information page | String |
| Price | Decimal Number |
| Monthly subcription | Decimal Number |
Konnektoriesimerkki
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://camel.apache.org/schema/spring http://camel.apache.org/schema/spring/camel-spring.xsd">
<bean id="connectionConfiguration" class="com.efecte.integration.connector.configuration.ConnectionConfiguration">
<property name="url" value="https://xxxxxxxxx.efectecloud.com/api/itsm" />
<property name="user" value="WebAPI" />
<property name="password" value="xxxxxxxxxxxxxxxxxxxxxxxxxx" />
<property name="connectionRequestTimeout" value="300" />
<property name="connectTimeout" value="300" />
<property name="socketTimeout" value="300" />
<!--property name="acceptSelfSignedCertificates" value="true"/>
<property name="allowAllHostnamesInCertificate" value="true"/-->
</bean>
<bean id="defaultConnectorEfecte" class="com.efecte.integration.connector.efecte.EfecteConnector">
<property name="connectionConfiguration" ref="connectionConfiguration" />
<!-- property name="generalConfiguration"> NOT RECOMMENDED TO BE CHANGED
<bean class="com.efecte.integration.connector.configuration.GeneralConfiguration">
<property name="dateTimeFormat" value="yyyy-MM-dd HH:mm:ss z"/>
<property name="integrationIdAttribute" value="WebShopId"/>
<property name="integrationCategoryAttribute" value="WebShopCategory"/>
</bean>
</property -->
<!-- property name="serviceRequestAttributes">
<bean class="com.efecte.integration.connector.configuration.ServiceRequestAttributes">
<property name="templateCode" value="ServiceRequest"/>
<property name="bundleTemplateCode" value="ServiceRequestBundle"/>
<property name="folderCode" value="ServiceRequests"/>
<property name="attachmentAttribute" value="RequestAttachments"/>
<property name="statusAttribute" value="status"/>
<property name="reopenReasonAttribute" value="reopen_reason"/>
<property name="creationDateAttribute" value="created"/>
<property name="deadlineAttribute" value="deadline"/>
<property name="updatedAttribute" value="updated"/>
<property name="efecteIdAttribute" value="efecte_id"/>
<property name="languageAttribute" value="Language"/>
<property name="feedbackAttribute" value="rating"/>
<property name="resolutionTextAttribute" value="resolution"/>
<property name="supportPersonAttribute" value="support_person"/>
<property name="serviceOfferingNameAttribute" value="ServiceOffering"/>
<property name="serviceItemNameAttribute" value="ServiceItemName"/>
<property name="serviceItemExternalIdAttribute" value="ServiceItem"/>
<property name="priceAttribute" value="Price"/>
<property name="monthlySubscriptionAttribute" value="MonthlySubscription"/>
<property name="requestedForAttribute" value="RequestedFor"/>
<property name="costCenterAttribute" value="CostCenter"/>
<property name="deliveryAddressAttribute" value="DeliveryAddress"/>
<property name="orderedByAttribute" value="OrderedBy"/>
<property name="additionalInformationAttribute" value="AdditionalInformation"/>
<property name="siteIDAttribute" value="SiteID"/>
<property name="siteNameAttribute" value="SiteName"/>
<property name="requestBundleAttribute" value="RequestBundle"/>
<property name="requestBundleNameAttribute" value="RequestBundleName"/>
<property name="orderedByEmailAttribute" value="OrderedBy:email"/>
<property name="requestedForEmailAttribute" value="RequestedFor:email"/>
<property name="commentAttribute" value="external_comments"/>
<property name="reasonAttribute" value="user_reason"/>
<property name="dedicatedApproverAttribute" value="DedicatedApprover"/>
<property name="superiorApproverAttribute" value="approving_manager"/>
<property name="totalPriceAttribute" value="totalPrice"/>
<property name="quantityAttribute" value="quantity"/>
<property name="totalMonthlySubscriptionAttribute" value="TotalMonthlySubscription"/>
</bean>
</property -->
<!-- property name="approvalResponseAttributes"> NOT RECOMMENDED TO BE CHANGED
<bean class="com.efecte.integration.connector.configuration.ApprovalResponseAttributes">
<property name="templateCode" value="approval"/>
<property name="folderCode" value="approvals"/>
<property name="efecteId" value="efecte_id"/>
<property name="actualApprover" value="ActualApprover"/>
<property name="approvalDecision" value="ApprovalDecision"/>
<property name="reason" value="Reason"/>
<property name="esmApprovedCode" value="approved"/>
<property name="esmRejectedCode" value="rejected"/>
</bean>
</property -->
<!-- property name="efecteTrackingConnector">
<bean class="com.efecte.integration.connector.efecte.EfecteTrackingConnector">
<property name="updateQuerySlidingWindowTime" value="20"/>
<property name="updateQuerySlidingWindowUnit" value="MINUTES"/>
<property name="initialQuerySlidingWindowTime" value="1"/>
<property name="initialQuerySlidingWindowUnit" value="DAYS"/>
<property name="updateFrequency" value="10" />
<property name="updateFrequencyUnit" value="MINUTES" />
<property name="errorUpdateFrequency" value="10" />
<property name="errorUpdateFrequencyUnit" value="MINUTES" />
<property name="defaultIntegrationServiceItemId" value="DEFAULT_SERVICE_ITEM" />
<property name="pollNewServiceRequestEnabled" value="false" />
<property name="defaultIntegrationCategoryId" value="DEFAULT_EFECTE_CATEGORY"/>
<property name="serviceRequestPollCondition" value="and $creator$ = 'SefServicePortal'"/>
<property name="incidentPollCondition" value="and $creator$ = 'Webshop'"/>
</bean>
</property -->
<!-- property name="feedbackFormConnector">
<bean class="com.efecte.integration.connector.efecte.EfecteFeedbackFormConnector">
<property name="feedbackAttributes">
<bean class="com.efecte.integration.connector.configuration.FeedbackAttributes">
<property name="templateCode" value="feedback_management" />
<property name="folderCode" value="feedback" />
<property name="efecteIdAttribute" value="ticket_id" />
<property name="customerAttribute" value="customer" />
<property name="ratingAttribute" value="ticket_rating" />
</bean>
</property>
</bean>
</property -->
</bean>
<bean id="efecteKnowledgeBaseConnector" class="com.efecte.integration.connector.efecte.EfecteKnowledgeBaseConnector">
<property name="connectionConfiguration" ref="connectionConfiguration"/>
<property name="knowledgeBaseAttributes" >
<bean id="knowledgeBaseAttributes" class="com.efecte.integration.connector.configuration.KnowledgeBaseAttributes">
<property name="templateCode" value="knowledge_base_article"/>
<property name="pollingFolderCode" value="knowledge_base"/>
<property name="updateReadStatsFallbackFolderCode" value="knowledge_base"/>
<property name="ratingFallbackFolderCode" value="knowledge_base"/>
<property name="publishedInEssAttr" value="published_in_self_service"/>
<property name="publishedInEssValue" value="Yes"/>
<property name="deletedAttr" value="deleted"/>
<property name="nameAttr" value="solution_name"/>
<property name="descriptionAttr" value="solution_description"/>
<property name="categoryAttr" value="category"/>
<property name="efecteIdAttr" value="efecte_id"/>
<property name="updatedAttr" value="updated"/>
<property name="ratingAttr" value="rating"/>
<property name="rankingAttr" value="rating"/>
<property name="readStatsAttr" value="read_count"/>
<property name="keywordsAttr" value="solution_keywords"/>
<property name="keywordsSeparator" value=","/>
</bean>
</property>
</bean>
</beans>
Table of Contents