Installation und Konfiguration
Zoho Connector
Copyright ©
Mindbreeze GmbH, A-4020 Linz, 2023.
Alle Rechte vorbehalten. Alle verwendeten Hard- und Softwarenamen sind Handelsnamen und/oder Marken der jeweiligen Hersteller.
Diese Unterlagen sind streng vertraulich. Durch die Übermittlung und Präsentation dieser Unterlagen alleine werden keine Rechte an unserer Software, an unseren Dienstleistungen und Dienstleistungsresultaten oder sonstigen geschützten Rechten begründet. Die Weitergabe, Veröffentlichung oder Vervielfältigung ist nicht gestattet.
Aus Gründen der einfacheren Lesbarkeit wird auf die geschlechtsspezifische Differenzierung, z.B. Benutzer/-innen, verzichtet. Entsprechende Begriffe gelten im Sinne der Gleichbehandlung grundsätzlich für beide Geschlechter.
Einleitung
Mithilfe des Zoho Connectors können Tickets in Zoho mit ihren Metadaten und Content indiziert werden.
Konfiguration von Zoho
Generieren der Credentials
- Zuerst müssen die Credentials für den Connector in Zoho generiert werden.
Navigieren Sie zu https://api-console.zoho.com/. Falls Sie noch keinen „Self Client“ erstellt haben, erstellen Sie einen indem Sie auf „Add Client“ und dann „Self Client“ klicken.
Wenn Sie auf den erstellten Self Client klicken, finden Sie im Reiter „Client Secret“ die Client ID und das Client Secret, welche für den Connector benötigt werden.
Zusätzlich muss noch ein Refresh Token generiert werden. Gehen Sie dafür im Self Client in den Reiter „Generate Code“. Fügen Sie folgendes in das Feld „Scope“ ein:
SDPOnDemand.requests.READ,SDPOnDemand.general.READ,SDPOnDemand.setup.READ
Fügen Sie noch eine kurze Beschreibung im Feld „Scope Description“ hinzu. Bevor Sie dann auf „Create“ klicken, ist es am besten, Sie bereiten das nächste Request zum Abholen des Refresh Tokens bereits vor, weil der generierte Code nur maximal 10 Minuten gültig ist.
Sie müssen das folgende Request mit curl oder Postman ausführen:
curl --location --request POST '<AccountsServerUrl>/oauth/v2/token' \
--form 'code="<GeneratedCode>"' \
--form 'grant_type="authorization_code"' \
--form 'client_id="<ClientId>"' \
--form 'client_secret="<ClientSecret>"' \
--form 'redirect_uri="https://www.zoho.com"'
Achtung: Je nach Postman Version kann es sein, dass dieses curl Command nicht richtig importiert wird. Stellen Sie sicher, dass die Werte der Parameter in Postman nicht unter doppelten Anführungszeichen stehen:
Alle Einträge in spitzen Klammern müssen mit den jeweiligen Parametern ersetzt werden:
- AccountsServerUrl: Die Accounts Server Url, basierend auf Ihrem Data Center. Diese finden Sie hier: https://www.manageengine.com/products/service-desk/sdpod-v3-api/getting-started/data-centers.html
- GeneratedCode: Der Code der mit dem Klicken des „Create“ Buttons generiert wird.
- ClientId: Die Client ID im “Client Secret” Reiter im Self Client.
- ClientSecret: Das Client Secret im “Client Secret” Reiter im Self Client.
Wenn Sie das Request erfolgreich ausführen, erhalten Sie eine Response mit einem Refresh Token – dieser wird für die Konfiguration des Connectors benötigt.
Konfiguration von Mindbreeze
Öffnen Sie das Mindbreeze Management Center im Browser, um mit der Konfiguration beginnen zu können.
Konfiguration des Index
Fügen Sie im Tab Indices mit dem Button +Add Index einen neuen Index hinzu. Wählen Sie den gewünschten Index Node und Client Service aus und geben Sie im Feld Data Source die Datenquelle Zoho an. Bestätigen Sie Ihre Eingaben anschließend mit dem Button Apply.
Konfiguration der Datenquelle
Konfigurieren Sie nun die Datenquelle.
Legende:
- Mit * markierte Properties: Pflichtfeld, diese müssen explizit konfiguriert werden.
- Nicht speziell markierte Properties: optionale Felder
- Mit (Advanced Settings) markierte Felder werden nur angezeigt, wenn die „Advanced Settings“ Ansicht in der Konfiguration aktiviert ist. Dies ist nur in speziellen Anwendungsfällen notwendig.
Connection Settings
Die URL Ihrer Zoho Instanz. Falls Sie mehrere Zoho Instanzen haben, müssen Sie die URL auf die genaue Instanz angeben. Wenn zum Beispiel die Homepage Ihrer Instanz https://mycompany.myzoho.com/app/myinstance/ui/ssp/pages/home ist, muss als Zoho URL https://mycompany.myzoho.com/app/myinstance angegeben werden. | |
OAuth Credential* | Ein Credential, welches die Access Token URL, sowie Client ID und Client Secret welche im Schritt Generieren der Credentials generiert wurden, enthält. Die Access Token URL hängt wieder von Ihrem Data Center ab. Das Format ist <AccountsServerUrl>/oauth/v2/token. Ihre Accounts Server URL können Sie hier finden: https://www.manageengine.com/products/service-desk/sdpod-v3-api/getting-started/data-centers.html |
Refresh Token* | Ein Password Credential, welches den Refresh Token enthält, der im Schritt Generieren der Credentials generiert wurde. |
Page Size | Anzahl von Objekten die mit einem Request von der Zoho API abgeholt werden. Der Maximalwert ist 100. |
Log All Requests | Wenn diese Option aktiviert wird, werden alle Requests gegen Zoho in das Logfile „request-log.csv“ geschrieben, solange der Login erfolgreich ist. |
Permissions (Advanced Settings)
Wenn diese Option aktiviert ist, können alle Anfrager alle Anfragen, die in ihrem Standort angelegt wurden, in der Mindbreeze Suche finden. | |||||
Static ACL | Statische Zugriffsregeln, welche auf alle indizierten Dokumente gesetzt werden.
|
Konfiguration des Principal Resolution Service
Für den Zoho Konnektor wird auch ein Principal Resolution Service zur Auflösung der Berechtigungen benötigt.
Um diesen zu erstellen, scrollen Sie im Indices Tab zum Bereich Services und fügen Sie mit dem Button +Add Service einen neuen Service hinzu. Bei diesem wählen Sie dann im Service Dropdown Zoho Principal Resolution Service aus.
Connection Settings
Die Connection Settings sind hier identisch zum Konnektor, wie in diesem Abschnitt beschrieben.
Cache, Health Check, Parent Cache, Service & Consumer Services Settings
Diese Config Optionen sind hier in der Dokumentation des Caching Principal Resolution Service beschrieben.https://help.mindbreeze.com/de/index.php?topic=doc/Installation--Konfiguration---Caching-Principal-Resolution-Service/index.htm
REST API zum Testen
- Um den Caching Principal Resolution Service zu testen, können Sie die Principal Resolution Service REST API verwenden.
Appendix
Principal Names
Wenn mit dem Setting „Static ACL“ Abteilungen, Standorte oder alle Anfrager/Techniker angegeben werden sollen, müssen diese über den Principal Resolution Service aufgelöst werden. Dafür ist es notwendig, die korrekten Namen für die Principals zu verwenden.
Use Case | Principal Name |
Alle Anfrager | zho_all_requesters |
Alle Techniker | zho_all_technicians |
Alle Anfrager eines gewissen Standortes | zho_site_<siteId>_requesters |
Alle Techniker eines gewissen Standortes | zho_site_<siteId>_technicians |
Alle Anfrager einer gewissen Abteilung | zho_department_<departmentId>_requesters |
Alle Techniker einer gewissen Abteilung | zho_department_<departmentId>_technicians |
Herausfinden der Standort Ids
Um die Id eines Standortes herauszufinden, müssen Sie in Zoho auf „Setup“ (Zahnrad oben rechts) gehen, dann unter „Instance Configurations“ -> „Sites“ können Sie alle Standorte einsehen. Mit Rechtsklick auf einen Standort -> „Untersuchen“ können Sie dann die id des Standorts sehen:
Herausfinden der Abteilungs Ids
Um die Id einer Abteilung herauszufinden, müssen Sie in Zoho auf „Setup“ (Zahnrad oben rechts) gehen, dann unter „Instance Configurations“ -> „Departments“ können Sie alle Abteilungen pro Standort einsehen. Wählen Sie in der Dropdownliste oben rechts den Standort aus, in der Ihre Abteilung ist. Mit Rechtsklick auf eine Abteilung-> „Untersuchen“ können Sie dann die Id der Abteilung sehen:
