Voorbereiden TOPdesk KB integratie

TOPdesk is een veel gebruikte IT Service Management applicatie met een self-service portal (SSP) en een knowledge base. Organisaties die gebruik maken van TOPdesk profileren de SSP aan de gebruikers als de plek waar antwoorden en oplossingen te vinden zijn. De ProductivityPerformer heeft de mogelijkheid de TOPdesk knowledge base te vullen op basis van AWI's. Het integreren van beide producten heeft meerdere voordelen, waaronder: makkelijker en beter vullen van de knowledge base, soepelere overdrachten en betere vindbaarheid van kennis.

Deze integratie is optioneel en kan in overleg met PolderValley geconfigureerd worden. Hieronder zijn de noodzakelijke stappen ter voorbereiding van de integratie beschreven. Na het uitvoeren van de stappen kan contact opgenomen worden met support@poldervalley.com om de TOPdesk KB integratie te configureren.

Overzicht:

De voorbereiding bestaat uit de onderstaande drie stappen, met als resultaat: een operator account dat rechten heeft om de knowledge base te bewerken via de API.

  1. TOPdesk KB configuratie
  2. Permissie groep aanmaken
  3. Operator aanmaken
  4. Application password aanmaken
  5. Gegevens doorgeven

Afhankelijk van de eigen inrichting en voorkeuren kan van de stappen afgeweken worden, mits het resultaat hetzelfde is.

1. TOPdesk KB configuratie

Aanzetten knowledge base API

Voor de integratie wordt gebruik gemaakt van de TOPdesk KB API, deze bevindt zich in de Labs en is standaard uitgeschakeld. Zorg er voor dat de API enabled is binnen Labs. Bekijk Knowledgebase-api | TOPdesk API voor meer informatie.

Taal configuratie

Bij het aanmaken van een KB item wordt de Nederlandse en / of Engelse vertaling ingevuld, dit vereist dat in TOPdesk minimaal één van beide talen beschikbaar is. Volg onderstaande stappen om de taalinstelling te controleren:

  1. Open TOPdesk en log in met een administrator account
  2. Klik op TOPdesk Menu om het menu uit te klappen en selecteer Settings
  3. Open Functional Settings -> Region and Language -> Language
  4. Controleer of de talen beschikbaar zijn, kijk daarbij naar Windows Country Code Dutch en English

2. Permissie groep aanmaken

Het bewerken van de TOPdesk knowledge base door middel van de API is alleen mogelijk als specifieke permissies zijn toegekend. Uitgaande van het 'least priviles' principe raden we aan een nieuwe permissie groep te creëren met alleen de rechten die nodig zijn.

  1. Open TOPdesk en log in met een account met voldoende rechten om permissie groepen te beheren
  2. Klik op TOPdesk Menu om het menu uit te klappen en selecteer Modules
  3. Klik op Supporting Files in de navigator
  4. Klik op Permission Groups onder Overview
  5. Klik op New Permission Group
  6. Geef de permission group een beschrijvende naam en de permissies zoals hieronder weergegeven
  7. Klik op Save om de nieuwe permissie groep op te slaan

3. Operator aanmaken

De ProductivityPerformer moet authenticeren bij de TOPdesk API om wijzigingen te kunnen maken in de knowledge base. De authenticatie gebeurd met een operator account. Het beste kan hiervoor een eigen account voor worden aangemaakt, om de volgende twee redenen:

  • In de historie van een knowledge item is de naam van de operator zichtbaar die de wijziging maakt. Door een eigen account te gebruiken is duidelijk dat de ProductivityPerformer de wijziging maakt en niet een persoon.
  • Het account van een medewerker is aan verandering onderhevig en wachtwoorden worden gereset, permissies worden aangepast of het account wordt zelfs verwijderd. Door een eigen account voor de integratie te creëren worden problemen in de toekomst voorkomen.

De stappen hieronder beschreven hoe een nieuw account met de juiste permissies aangemaakt kan worden

  1. Open TOPdesk en log in met een account met voldoende rechten om operators te beheren
  2. Klik op TOPdesk Menu om het menu uit te klappen en selecteer Modules
  3. Klik op Supporting Files in de navigator
  4. Klik op Operators onder Overview
  5. Klik op New Operator
  6. Geef de operator een beschrijvende naam, bijvoorbeeld ProductivityPerformer
  7. Geef de operator de rechten om in te login in TOPdesk
  8. Klik op Save om de nieuwe operator aan te maken
  1. Klik op Authorization om het tabblad te openen
  2. Klik op Links Wizard om de eerder aangemaakte permissie groep toe te voegen
  3. Zoek op de eerder aangemaakt permissie groep, selecteer de permissie groep en klik op Link

4. Application password aanmaken

De operator is nu aangemaakt en heeft voldoende rechten om te kunnen werken met de TOPdesk knowledge base via de TOPdesk API. Authenticatie bij de TOPdesk API maakt gebruik van een application password. De stappen hieronder tonen hoe een applicatie password aangemaakt moet worden voor de nieuwe operator.

  1. Log in als operator met het nieuwe operator account.
  2. Open het persoonlijke menu door rechtsboven op het icoontje te klikken.
  1. Selecteer My Settings.
  2. Onderaan de pagina worden de application passwords beheerd. Klik op Add.
  3. Geef een naam op, kies een einddatum en klik op Create.
  4. In een nieuw venster wordt nu het application password getoond. Kopieer deze direct en sla deze op. Dit wachtwoord is nodig voor de ProductivityPerformer integratie.

5. Gegevens doorgeven

Neem contact op met support@poldervalley.com om de TOPdesk KB integratie te configureren. De onderstaande informatie moet doorgegeven worden:

  • TOPdesk url
  • De Operator username van de operator die in stap 3 is aangemaakt
  • Application password die in stap 4 is aangemaakt