Skip to main content

Konfiguration des Layouts

Konfigurationsschlüssel

ssp-layout- configuration

Sie können die Farbdarstellung, den Titel und die verwendeten Logos für das Self Service Portal ändern und damit die Darstellung des Self Service Portals an Ihr Corporate Identity anpassen.

Ändern Sie dazu im Menü System > GUI Konfiguration > Self Service Portal die Werte im Konfigurationsschlüssel ssp- layout-configuration nach Erfordernis.

Attribut

Beschreibung

ID

Die ID (Nummer) des Konfigurationsbocks.

Die ID darf nur 1x im gesamten Schlüssel existieren.

Vergeben Sie jedem Konfigurationsblock eine eigene ID, wenn Sie Layouts für mehrere Organisationen konfigurieren.

name

Frei definierbare Bezeichnung des Konfigurationsblocks

Sie können hier bspw. beschreiben, für welche Organisation die Konfiguration gilt.

vHostPattern

Regulärer Ausdruck des VHosts (z. B.: ^service4companyA\\.kix\\.de*)

KIX prüft den Ausdruck gegen den aktuellen Host der Domain. Wird der VHost nicht gefunden, wird der nächste erreichbare VHost verwendet (i.d.R. der Host der Default-Konfiguration)

Beachten Sie: Die Reihenfolge ist entscheidend. KIX arbeitet die Konfiguration von oben nach unten ab; der erste Treffer führt zum Match. D. h.: Ist in der ersten Konfiguration ein RegEx .* angegeben, wird diese Konfiguration immer verwendet.

primaryOrgID

Optional: ID der Organisation

  • Ist eine ID angegeben, wird die Konfiguration auf die Organisation mit dieser ID angewendet.

    Sie können mehrere Organisations-IDs angeben, um ein Layout für mehrere Organisationen zu verwenden.

  • Ist keine ID angegeben, wird die Konfiguration auf alle Organisationen angewendet, für die keine andere Konfiguration zutrifft (Default und Fallback).

design

Konfigurationsblock für die Layout Definition

favicon

Definiert das Favicon, welches als Tab-Icon im Browser angezeigt wird. Sie können das Favicon austauschen.

SSP_Konfig_Favicon.png
  • content: base64-String des Favicons

    Erwartet wird eine Grafik im Base64-Format. Diverse Online-Tools helfen Ihnen dabei, eine Grafik nach Base64 zu konvertieren.

  • contentType: Datenformat des Favicons (z. B. img/jpg, img/png, xml/svg)

logo

Definiert das Logo, welches im Anmeldefenster und in der Titelzeile angezeigt wird. Sie können das Logo austauschen.

SSP_Konfig_Logo.png
  • content: base64-String des Favicons

    Erwartet wird eine Grafik im Base64-Format. Diverse Online-Tools helfen Ihnen dabei, eine Grafik nach Base64 zu konvertieren.

  • contentType: Datenformat des Favicons (z. B. img/jpg, img/png, xml/svg)

colorScheme

Definiert das Farbschema des Layouts

Sie können die Farben ändern. Es werden nur Hexadezimalwerte unterstützt. Die Farbänderungen wirken sich nur auf die Ansicht im "light mode" aus, nicht auf den "darkmode".

"colorScheme": {
  "primary": "#04537D",
  "secondary": "#5B5B5B",
  "accent": "#82C826"
},

Defaultwerte:

Attribut

Beschreibung

Farbe

Farbcode

Verwendung u.a. in

primary

Primärfarbe

Blau

#04537D

Titelzeile, Menüleiste, Überschriften

secondary

Sekundärfarbe

Grau

#5B5B5B

Abbrechen-Button

accent

Akzentfarbe

Grün

#82C826

Label der Vorlagen

imprint

Optionaler Link zum Impressum, der in der Fußzeile des Self Service Portals angezeigt wird. Die Angabe erfolgt als HTML-String.

Die Inhalte werden sprachsensitiv geladen, sodass für jede Sprache ein anderer Inhalt bereitgestellt werden kann.

"imprint": {
   "en": "<a href=\"https://www.kixdesk.com/en/legal-notice\" target=\"_blank\">Imprint</a>",
   "de": "<a href=\"https://www.kixdesk.com/impressum\" target=\"_blank\">Impressum</a>"
},

title

Definiert den Titel im Self Service Portal. Sie können den Titel ändern.

Z. B: "title": "KIX Self Service Portal"

SSP_Konfig_Titel.png

Sie können für jede in KIX angelegte Organisation ein eigenes Layout definieren und damit das Layout des Self Service Portals dem Corprorate Identity des jeweiligen Unternehmens anpassen:

  1. Navigieren Sie im Admin Modul des Agentenportals zu System > GUI Konfiguration > Self Service Portal

  2. Suchen und Öffnen Sie den Schlüssel ssp-layout-configuration.

  3. Duplizieren Sie den initialen JSON-Code (ggf. mehrfach) und geben Sie jedem Konfigurationsblock eine eigene ID.

  4. Geben Sie jeweils unter primaryOrgID die ID der Organisation an, für die diese Konfiguration gilt.

    Sie können mehrere Organisations-IDs angeben, um ein Layout für mehrere Organisationen zu verwenden.

    Die ID einer Organisation können Sie der URL entnehmen, wenn Sie die Detailansicht der Organisation geöffnet haben.

    ssp_admin_org-id-finden.png
  5. Passen Sie in jedem Konfigurationsblock die Farbwerte, Titel, Logos und ggf. den Link zum Impressum an.

    Achtung

    KIX arbeitet die Konfiguration von oben nach unten ab und fällt im Bedarfsfall selbständig auf das Standardverhalten (Vorgabewerte) zurück. Platzieren Sie daher die Default-Konfiguration mit vHostPattern ".*" ganz nach unten. Sie dient damit als Fallback und als Standardkonfiguration, falls der Endpunkt nicht erreichbar ist oder keine Antwort liefert.

{
    "id": 0,
    "name": "Layout für Kunde A",
    "vHostPattern": "service4companyA.kix...*",
    "primaryOrgId": [23, 24, 25],
    "design": {
        "favIcon": {
            "content": "<base64-string>",
            "contentType": "img/png"
        },
        "logo": {
            "content": "<base64-string>",
            "contentType": "img/jpg"
        },
        "colorScheme": {
            "primary": "#ffcc00",
            "secondary": "#333333",
            "accent": "#f0f0f0"
        },
        "imprint": {
            "en": "<a href=\"https://www.kixdesk.com/en/legal-notice\" target=\"_blank\">Imprint</a>",
            "de": "<a href=\"https://www.kixdesk.com/impressum\" target=\"_blank\">Impressum</a>"
        },
        "title": "Customer A - Self Service"
    }
},
{
    "id": 1,
    "name": "Layout für Kunde B",
    "vHostPattern": "service4companyB.kix....*",
    "primaryOrgId": "456",
    "design": {
        "favIcon": {
            "content": "<base64-string>",
            "contentType": "xml/svg"
        },
        "logo": {
            "content": "<base64-string>",
            "contentType": "img/png"
        },
        "colorScheme": {
            "primary": "#333300",
            "secondary": "#336600",
            "accent": "#339900"
        },
        "imprint": {
           "en": "<a href=\"https://www.kixdesk.com/en/legal-notice\" target=\"_blank\">Imprint</a>",
           "de": "<a href=\"https://www.kixdesk.com/impressum\" target=\"_blank\">Impressum</a>"
        },
        "title": "Customer B - Self Service"
    }
},
{
    "id": 9999999,
    "name": "Default Layout",
    "vHostPattern": ".*",
    "primaryOrgId": [],
    "design": {
        "favIcon": {
            "content": "<base64-string>",
            "contentType": "image/png"
        },
        "logo": {
            "content": "<base64-string>",
            "contentType": "image/png"
        },
        "colorScheme": {
            "primary": "#04537D",
            "secondary": "#5b5b5b",
            "accent": "#82C826"
        },
        "imprint": {
           "en": "<a href=\"https://www.kixdesk.com/en/legal-notice\" target=\"_blank\">Imprint</a>",
           "de": "<a href=\"https://www.kixdesk.com/impressum\" target=\"_blank\">Impressum</a>"
        },
        "title": "KIX Self Service Portal"
    }
}