Setup Assistent
Wenn Sie sich erstmals als Nutzer mit Administrator-Rechten am System anmelden, wird KIX 18 mit dem Setup Assistent geöffnet. Dieser führt Sie durch die wichtigsten Schritte der Ersteinrichtung.
Abb.: Der Setup Assistent
Bis zur vollständigen Ersteinrichtung wird KIX immer mit dem Setup Assistent gestartet, wenn Sie sich mit Admin-Rechten (Rollen Admin oder Superuser) anmelden. Abhängig von Ihren Benutzerrechten können Sie den Setup Assistenten auch jederzeit über den Explorer im Admin-Dashboard öffnen.
Vorbereitung
Bei der Ersteinrichtung legen Sie einen Superuser an, ändern die Zugangsdaten für den Initialbenutzer, konfigurieren den Postein- und -ausgang und hinterlegen die Daten zu Ihrer Organisation (Unternehmen). Halten Sie dazu folgende Informationen bereit:
Vorname, Nachname, E-Mail-Adresse des Benutzers "Superuser"
Die URLs, auf denen Ihr KIX System liegt und über die es erreichbar ist.
Anmeldeinformationen für den Posteingangsserver
Login-Name des E-Mail-Kontos
Passwort des E-Mail-Kontos
Abholstelle des E-Mail-Servers (Host:Port)
Abholmethode mit oder ohne Verschlüsselung (z. B. "IMAP" oder "IMAPTLS")
bei IMAP: Verzeichnis, in dem die eingehenden E-Mails liegen (i.d.R. "INBOX")
Anmeldeinformationen für den Postausgangsserver
Adresse zur SMTP-Schnittstelle des E-Mail-Servers (z. B. "smtp.mailbox.org")
Nummer des Ports, über den die E-Mails versendet werden
Nutzername (Login des E-Mail-Kontos)
Passwort des E-Mail-Kontos
Wenn Sie den Mailserver eines Dienstleisters (GMail, IONOS, Strato etc.) verwenden, erhalten Sie von diesem die erforderlichen Anmeldeinformationen.
Wenn Sie einen eigenen Mailserver nutzen, sollten Ihnen die Anmeldeinformationen bekannt sein.
Die Ersteinrichtung durchführen
Der Setup Assistent führt Sie schrittweise durch die Ersteinrichtung. Sie können zwischen den einzelnen Schritten wechseln, einzelne Schritte überspringen und die Ersteinrichtung jederzeit unterbrechen, um sie zu einem späteren Zeitpunkt fortzusetzen. Ihre bisherigen Eingaben bleiben erhalten.
Um zwischen den einzelnen Schritten zu wechseln, klicken Sie auf die Icons im Assistenten. Die Farbe der Icons kennzeichnet den Fortschritt im Assistenten:
Weißes Icon: Schritt ist noch unbearbeitet
Blaues Icon: aktuell geöffneter Schritt
Gelbes Häkchen: Schritt ist unvollständig
Grünes Häkchen: Schritt ist vollständig
Alternativ können Sie die Schaltflächen benutzten:
Überspringt diesen Schritt und spring zum nächsten offenen Schritt.
: Speichert den Nutzer als neuen Kontakt und loggt nach Abschluss den Nutzer aus (nur Schritt "Nutzer Superuser").
Speichert die Konfiguration des E-Mail-Kontos und ruft den Posteingang vom Server ab (nur Schritt "Posteingang").
Speichert den Nutzer als neuen Kontakt und springt zum nächsten offenen Schritt
: Zeigt eine Vorschau der Benachrichtigungs-Vorlage an (nur KIX Pro).
Wenn Sie den Mailserver eines Dienstleisters (GMail, IONOS, Strato etc.) verwenden, erhalten Sie von diesem die erforderlichen Anmeldeinformationen.
Wenn Sie einen eigenen Mailserver nutzen, sollten Ihnen die Anmeldeinformationen bekannt sein.
Ersetzen Sie hier die initialen Beispiel URLs für das KIX Front- und Backend durch die URLs, über die Ihr KIX System erreichbar ist. Hinterlegen Sie zusätzlich noch die URL für das Self Service Portal, wenn Sie KIX Pro nutzen.
Geben Sie den FQDN (Full Qualified Domain Name) zu Ihrem KIX System an. Diese Angaben werden im SysConfig-Schlüssel hinterlegt und so den verschiedenen Mechanismen in KIX bereitgestellt, z. B. in OAuth2 Profilen oder im Webformular.
Abb.: Verwendung der FQDN im Webformular
Für On-Premises Installationen:
Frontend: Geben Sie FQDN + Portnummer an, unter dem das Agentenportal erreichbar ist (z. B.: your.docker.host:20001)
Backend: Geben Sie FQDN + Portnummer an, über den die KIX REST-API erreichbar ist (z. B.: your.docker.host:20000).
SSP: Geben Sie FQDN + Portnummer an, unter dem das Self Service Portal erreichbar ist (z. B.: your.docker.host:20002)
Geben Sie jeweils die im
environment-File hinterlegten Portnummern an.Alternativ können Sie die FQDN im SysConfig-Schlüssel hinterlegen (Menü ):
Für KIX.Cloud Umgebungen:
Bitte lesen Sie die Informationen, die wir Ihnen in der Benachrichtigungs-Mail mitgeteilt haben.
HTTP Type: Optionale Angabe des Protokolls, welches der Webserver zur Bereitstellung der Anwendung verwendet.
Wichtig
Wenn das https-Protokoll anstelle des einfachen http-Protokolls verwendet werden soll, muss es hier angegeben werden.
Geben Sie den HTTP Type an, über den von "außen" auf das Frontend zugegriffen wird. Die Kommunikation zwischen Frontend und Backend ist von dieser Einstellung nicht betroffen.
Sie werden nicht daran gehindert, sich an der Anwendung anzumelden, wenn hier ein falscher HTTP Type angegeben ist.
Diese Einstellung hat keinen Einfluss auf die Einstellungen oder das Verhalten des Webservers und wirkt sich nicht auf die Zugriffsmethode der Anwendung aus. Sie wird lediglich als KIX Variable <KIX_CONFIG_HttpType> verwendet. Diese wird von der Anwendung in verwendeten Nachrichtenformen genutzt, z. B.: Benachrichtigungen oder Passwort zurücksetzen.
In diesem Schritt legen Sie einen Nutzer der Rolle "Superuser" an. Der Superuser ist ein Systemnutzer auf Benutzerebene mit Berechtigungen auf das gesamte System. Seine Berechtigungen sind weitreichender als die des Administrators (Rolle "System Admin").
Warnung
Der Initialbenutzer für den Erstlogin arbeitet im System als Root User mit Komplettberechtigung bis auf die unterste Systemebene. Er ist nicht für die Arbeit im Systems vorgesehen! Um die Sicherheit des Systems nicht zu gefährden, müssen Sie einen Benutzer der Rolle "Superuser" anlegen und das Passwort für den Initialbenutzer ändern.
Löschen Sie den Initialbenutzer nicht, an diesen sind grundlegende Systemfunktionen gebunden! Anderenfalls würden Sie sich vom System aussperren.
Der Superuser wird im Menü als Nutzer mit den hier angegebenen Daten angelegt. Er wird automatisch der Organisation "My Organisation (MY_ORGA)" zugewiesen. Diese Daten können Sie jederzeit in der Nutzerverwaltung ändern.
Loggen Sie sich anschließend aus und danach als Superuser wieder ein, um die weitere Einrichtung mit Superuser-Berechtigungen fortzusetzen. Klicken Sie dazu auf die Schaltfläche .
In diesem Schritt legen Sie ein neues Passwort für den Initialbenutzer fest.
Mit der Bereitstellung von KIX erhalten Sie auch das Passwort für den Initialbenutzer "admin". Um das System vor unberechtigtem Zugriff durch Dritte zu schützen, müssen Sie den Nutzernamen und das Passwort ersetzen.
Achtung
Verwenden Sie ein sicheres Passwort mit Groß- und Kleinbuchstaben sowie mit Sonderzeichen und Ziffern.
Verwahren Sie das Passwort sorgfältig und sicher, um unberechtigten Zugriff durch Dritte zu verhindern.
Wird das Passwort vergessen, können Sie sich vom System aussperren.
Um Tippfehler bei der Passwortvergabe auszuschließen, müssen Sie das Passwort zweimal eingeben. Die Eingaben müssen identisch sein. Zum Überprüfen Ihrer Eingaben können Sie auf das Auge-Symbol klicken. Dann wird Ihnen das Passwort im Klartext angezeigt. Achten Sie darauf, dass in diesem Moment das Passwort nicht durch unberechtigte Personen gelesen werden kann.
Hinweis
Das Admin-Passwort kann nur über den Setup Assistenten geändert werden, da der Initialbenutzer unterhalb der Benutzerebene liegt.
In diesem Schritt richten Sie ein E-Mail-Konto für den Posteingang ein.
Tipp
Sie können diesen Schritt überspringen, wenn Sie sich als Interessent nur einen Überblick über KIX verschaffen möchten.
KIX ruft in regelmäßigen Abständen den Posteingang Ihres E-Mail-Servers ab und generiert aus den eingehenden E-Mails neue Tickets. Dazu müssen Sie ein E-Mail-Konto angeben, von welchem eingehende E-Mails abgerufen werden. Die hierfür benötigten Informationen erhalten Sie von Ihrem Web Hoster oder liegen Ihnen vor, wenn Sie einen eigenen Mailserver betreiben.
Nachdem Sie die Informationen eingegeben haben, können Sie den E-Mail-Empfang testen. Klicken Sie auf . Sollte der Versand fehlschlagen, erhalten Sie einen Hinweis. Im Menü können Sie weitere E-Mail-Konten einrichten und bearbeiten.
In diesem Schritt richten Sie einen Postausgangsserver (Sendmail) und die Standard-E-Mail-Adresse für den Postausgang ein.
Tipp
Sie können diesen Schritt überspringen, wenn Sie sich als Interessent nur einen Überblick über KIX verschaffen möchten.
Um E-Mails aus KIX versenden zu können, müssen Sie einen Mail-Server und eine Standard-Absender-Adresse für den Postausgang angeben. Die benötigten Server-Informationen erhalten Sie von Ihrem Web Hoster oder liegen Ihnen vor, wenn Sie einen eigenen Mailserver betreiben.
Abhängig von Ihren Systemrechten, können Sie diese Angaben jederzeit im Menü sowie im Menü ändern.
In diesem Schritt hinterlegen Sie die Stammdaten Ihres Unternehmens.
Für die interne und externe Kommunikation benötigt KIX die Stammdaten zu Ihrem Unternehmen. Diese Daten werden unter der initialen Organisation "MY_ORGA" bzw. unter der von Ihnen hier festgelegten Kundennummer im System hinterlegt. Im Modul können Sie die Unternehmensdaten jederzeit ändern.
Optional können Sie zusätzliche Unternehmensdaten in den Konfigurationsschlüsseln (s. SysConfig-Keys) hinterlegen. Diese können an verschiedenen Stellen als Referenz genutzt werden. Beispielsweise in Textbausteinen und E-Mail-Signaturen oder für die dynamische Platzhalterersetzung in Jobs und Benachrichtigungen.
Parameter | Beschreibung |
|---|---|
Kunden-Informationen |
|
Adresse | Die postalische Adresse Ihres Unternehmens-Hauptsitzes. |
Avatar | Optionale Bilddatei zur symbolischen Kennzeichnung Ihres Unternehmens bspw. in der Sidebar. |
Kommentar | Eigene Notizen (optional). |
Gültigkeit | Der Setup Assistent legt beim Speichern Ihrer Unternehmensdaten eine neue Organisation mit der unter KNR angegebenen ID an. Sie können diese Organisation wahlweise auf gültig oder (temporär) ungültig setzen.
|
SysConfig Keys | Die hier hinterlegten Informationen werden in der initial gesetzten Team-Signatur verwendet. Zudem können diese Informationen auch in KIX-Platzhaltern verwendet werden. Der Setup Assistent speichert diese Angaben in den gleichnamigen SysConfig-Schlüsseln der Systemkonfiguration. Alternativ können Sie die einzelnen Schlüssel im Menü konfigurieren.
|
KIX kann bei bestimmten Ticketereignissen automatisierte Benachrichtigungen versenden, sodass Agenten über diese Ticketereignisse informiert werden.
In diesem Schritt können Sie für diese Benachrichtigungen das von KIX mitgelieferte Standard-Layout individualisieren.
Sie können den HTML-Quellcode ändern und somit das Layout an Ihr Corporate Identity anpassen, um ein einheitliches Auftreten Ihrer Unternehmenskommunikation zu erzielen.
Abb.: Beispiel einer HTML-E-Mail
Sie können den Text und die Style-Angaben ändern. Dazu benötigen Sie Kenntnisse in HTML und CSS. Unter https://www.selfhtml.orgfinden Sie eine gute Hilfestellung. Gern unterstützt Sie auch unser Support bei der Gestaltung des Benachrichtigungen-Layouts.
Zum leichteren Bearbeiten können Sie den Quellcode in einen HTML-Editor (z. B. Notepad++ ) kopieren.
Inhalte zwischen
<style>und</style>definieren die Formatierung der einzelnen Elemente auf der Seite, wie Seitenhintergrund, Kopf- und Fußzeile der Mail, Darstellung der Überschriften und Verlinkungen usw.Inhalte zwischen
<body>und</body>bilden den Seiteninhalt. Der Seiteninhalt wird in einzelnen Containern gruppiert. Diese Container werden mit<div> [...] </div>gebildet.Inhalte zwischen
<!--und-->sind Kommentare. Diese Hinweise dienen zu Ihrer Information und finden bei der E-Mail-Darstellung keine Berücksichtigung. Wenn Sie möchten, können Sie diese bedenkenlos entfernen.Nicht ändern sollten Sie die Zeilen
[% Data.Subject | html %]und[% Data.Body [....] %]. Dies sind die HTML-Platzhalter für den E-Mail-Betreff und den Inhalt der E-Mail.
Klicken Sie auf , um die von Ihnen geänderte Konfiguration vor dem Speichern zu überprüfen.
Initiale Benachrichtiungs-Vorlage
Der nachfolgende Quellcode definiert die initiale Standard-Vorlage. Mit diesem können Sie bei Bedarf Ihre eigene Vorlage ersetzen und so die Ausgangsbasis wieder herstellen.
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<style type="text/css">
body {
width: 100%;
margin: 5px;
padding: 0px;
background-color: #efefef;
}
.bodyContent,
.bodyContent * {
color: #323232;
font-family: Arial;
font-size: 13px;
line-height: 150%;
text-align: left;
}
.bodyContent a:link,
.bodyContent a:visited,
.footerContent div a:link,
.footerContent div a:visited {
color: #1491D2;
font-weight: normal;
text-decoration: none
}
#templateFooter {
background-color: #FFFFFF;
border-top: 0px;
}
.footerContent div {
color: #707070;
font-family: Arial;
font-size: 13px;
line-height: 125%;
text-align: left;
}
#links {
background-color: #FAFAFA;
border: 0;
color: #008DD2
}
#links div {
text-align: center;
}
.bodyContent a {
color: #008DD2;
}
.bodyContent h1,
.bodyContent h2,
.bodyContent h3,
.bodyContent h4,
.bodyContent h5,
.bodyContent h6 {
color: #04537D;
display: block;
font-weight: bold;
line-height: 100%;
margin-top: 0px;
margin-right: 0px;
margin-bottom: 5px;
margin-left: 0px;
}
.bodyContent h1 {
font-size: 26px;
}
.bodyContent h2,
.bodyContent h3,
.bodyContent h4,
.bodyContent h5,
.bodyContent h6 {
margin-top: 5px;
margin-bottom: 5px;
}
.bodyContent h2 {
font-size: 22px;
}
.bodyContent h3 {
font-size: 18px;
}
.bodyContent h4 {
font-size: 16px;
}
.bodyContent h5 {
font-size: 12px;
}
.bodyContent h6 {
font-size: 12px;
}
.notifyHeader {
background: #04537D;
border-radius: 20px 20px 0px 0px;
padding: 20px;
line-height: 120%;
color: #ffffff;
margin: 0px;
font-family: Arial;
font-size: 18px;
font-weight: bold;
text-align: center;
}
</style>
</head>
<body>
<center>
<div id="templateBody" style="padding:0.5em;width:95%">
<div valign="top" class="notifyHeader">
<!-- THIS IS WHERE THE NOTIFICATION SUBJECT IS PUT -->
[% Data.Subject | html %]
<!-- EO THIS IS WHERE THE NOTIFICATION SUBJECT IS PUT -->
</div>
<div valign="top" class="bodyContent" style="background-color: #ffffff; padding: 15px; font-size: 13px;">
<!-- THIS IS WHERE THE NOTIFICATION BODY IS PUT -->
[% Data.Body
.replace('<p>', '<div>')
.replace('</p>', '</div>')
.replace('<div\s+type="cite"[^>]*>', '<div type="cite" style="background: #f5f5f5; border: 1px solid #e0e0e0 !important; color: #555; margin: 10px 0px 0px 0px; padding: 10px;">')
.replace('border:none;border-left:solid\s+blue\s+1.5pt;padding:0cm\s+0cm\s+0cm\s+4.0pt', 'border: none; border-left: 1px solid #f92 !important; color: #555; margin: 10px 5px 10px 0px; padding: 0px 10px;')
%]
<!-- EO THIS IS WHERE THE NOTIFICATION BODY IS PUT -->
</div>
</div>
</center>
</body>
</html>Den Setup Assistenten zurücksetzen oder Status ändern
Konfigurationsschlüssel | SetupAssistantState |
Bei Bedarf können Sie den Status des Setup Assistenten auf den Ausgangszustand zurücksetzen oder ändern. Dies erfolgt im SysConfig-Schlüssel (Menü ).
Achtung
Änderungen an der Systemkonfiguration sind stets ein grundlegender Eingriff in das zentrale System von KIX 18 und können zu schwerwiegenden Schäden am System führen.
Wir weisen Sie darauf hin, dass unbedachte Änderungen an den Konfigurationsdateien zu schwerwiegenden Systemfehlern bis hin zum Systemversagen führen können.
Änderungen an der Systemkonfiguration sollten daher nur durch versierte KIX-Nutzer oder durch unseren Support erfolgen!
Zögern Sie bitte nicht, uns zu kontaktieren, wenn Sie Hilfe benötigen. Gern passen wir KIX für sie an oder helfen Ihnen bei der Konfiguration.
Der Status kann für jeden einzelnen Schritt im Setup Assistent separat festgelegt werden. Sie können somit jeden Schritt explizit:
auf seinen Auslieferungszustand zurücksetzen, bspw. um die Informationen erneut einzugeben
auf "abgeschlossen" setzen, bspw. wenn die im Schritt geforderten Informationen bereits an anderer Stelle im System hinterlegt wurden (z. B. wenn die im Schritt 1 anzugebenden FQDN bereits im SysConfig-Schlüssel "FQDN" hinterlegt wurden)
auf "übersprungen" setzen, bspw. wenn die im Schritt geforderten Informationen noch nicht vollständig eingegeben wurden oder die Initialdaten keiner Änderung bedürfen (z. B. wenn "admin" als Super User ausreichend ist und kein anderer Super User gesetzt werden soll)
Parameter | Beschreibung | Mögliche Werte |
|---|---|---|
stepID | ID des Schrittes (eindeutiger Bezeichner) |
|
completed | Entspricht einem Klick auf den Button . Wenn |
|
skipped | Entspricht einem Klick auf den Button Wenn Er kann zu einem späteren Zeitpunkt erneut bearbeitet werden. |
|
result | Ergebnis des Setup-Schrittes Wird für das Laden der Werte genutzt, wenn der Schritt erneut geöffnet wird (z. B. für Schritt "Eigene Firma") Inwieweit die angegebenen Werte ausgewertet werden, ist von den jeweiligen Steps (Code) abhängig. |
|
Die nachfolgende Beispielkonfiguration enthält alle Konfigurationsparameter des Setup Assistenten und setzt alle Schritte im Setup Assistenten auf "unbearbeitet".
Codebeispiel 1 - Grundkonfiguration
[
{
"stepId": "setup-system-settings",
"completed": false,
"skipped": false,
"result": null
},
{
"stepId": "SuperUserAccount",
"completed": false,
"skipped": false,
"result": null
},
{
"stepId": "Mail",
"completed": false,
"skipped": false,
"result": null
},
{
"stepId": "MailAccount",
"completed": false,
"skipped": false,
"result": null
},
{
"stepId": "setup-sending-email",
"completed": false,
"skipped": false,
"result": null
},
{
"stepId": "SetupMyOrganisation",
"completed": false,
"skipped": false,
"result": null
},
{
"stepId": "setup-notification-template",
"completed": false,
"skipped": false,
"result": null
}
]Navigieren Sie zum Menü .
Suchen Sie den Schlüssel und öffnen Sie diesen.
Kopieren Sie entweder den Wert des SysConfig-Schlüssels oder das Codebeispiel 1 (teilweise oder komplett) in einen JSON-Editor (z. B. jsonformatter.io).
Setzen Sie je nach Erfordernis die Parameter
completedund/oderskippedauf true bzw. false.Setzen Sie je nach Erfordernis den Parameter result auf null oder hinterlegen Sie dort eine Datenstruktur für Werte (s. Codebeispiel 2).
Minimieren Sie den JSON-String, um doppelte Leerzeichen und Zeilenumbrüche zu entfernen.
Kopieren Sie den minimierten JSON-String in die Zwischenablage.
Wechseln Sie zurück zum Konfigurationsschlüssel und ersetzen Sie den Wert durch den JSON-String der Zwischenablage.
Speichern Sie Ihre Änderung.
Der Status des Setup Assistenten entspricht nun Ihrer manuellen Konfiguration.
Navigieren Sie zum Menü .
Suchen Sie den Schlüssel und öffnen Sie diesen.
.
Der Status des Setup Assistenten ist nun auf den Auslieferungszustand zurückgesetzt, sodass die Angaben erneut hinterlegt werden können. Der Auslieferungszustand ist ein leerer Wert.
Ist KIX bereits eingerichtet, wird der Setup Assistent dennoch bei Anmeldung eines Nutzers mit Superuser-Rolle angezeigt, bis er einmal "durchgeklickt" wurde. Um das zu unterbinden, setzen Sie für alle Schritte den Parameter completed auf true. Gehen Sie wie folgt vor:
Navigieren Sie zum Menü System > SysConfig.
Suchen Sie den Schlüssel "SetupAssistantState" und öffnen Sie diesen.
Kopieren Sie das Codebeispiel 1 oder 2 in einen JSON-Editor (z. B. jsonformatter.io).
Setzen Sie für alle Schritte den Parameter completed auf true.
Setzen Sie je nach Erfordernis den Parameter result auf null oder hinterlegen Sie dort eine Datenstruktur für Werte (s. Codebeispiel 2).
Minimieren Sie den JSON-String, um doppelte Leerzeichen und Zeilenumbrüche zu entfernen.
Kopieren Sie den minimierten JSON-String in die Zwischenablage.
Wechseln Sie zurück zum Konfigurationsschlüssel und ersetzen Sie den Wert durch den JSON-String in der Zwischenablage.
Speichern Sie Ihre Änderung.
Die einzelnen Schritte im Setup Assistenten gelten nun als vollständig abgearbeitet, sodass der Setup Assistent fortan nicht mehr angezeigt wird. Er kann jederzeit über das Admin-Menü erneut aufgerufen werden.
Hinweis
Der Setup Assistent wird nach einem Update erneut angezeigt, wenn er um weitere Schritte ergänzt wurde. So wird sichergestellt, dass alle erforderlichen Informationen im Setup Assistent angegeben werden können.
Sie können den Setup Assistenten erneut deaktivieren, wenn Sie für die neuen Schritte den Parameter completed ebenfalls auf true setzen.
[
{
"stepId": "setup-system-settings",
"completed": true,
"skipped": false,
"result": null
},
{
"stepId": "SuperUserAccount",
"completed": true,
"skipped": false,
"result": {
"contactId": 999,
"userId": 999
}
},
{
"stepId": "Mail",
"completed": false,
"skipped": true,
"result": null
},
{
"stepId": "MailAccount",
"completed": true,
"skipped": false,
"result": {
"accountId": 2
}
},
{
"stepId": "setup-sending-email",
"completed": true,
"skipped": false,
"result": {
"systemAddressId": 1
}
},
{
"stepId": "SetupMyOrganisation",
"completed": true,
"skipped": false,
"result": {
"organisationId": 1
}
},
{
"stepId": "setup-notification-template",
"completed": false,
"skipped": true,
"result": null
}
]