FAQ-Plugin: SysConfig-Referenz für OTOBO
In diesem Dokument findest du eine vollständige Übersicht aller SysConfig-Parameter des FAQ-Plugins samt kurzer
Erläuterung.
Core-Einstellungen
Abschnitt betitelt „Core-Einstellungen“| Schlüssel | Beschreibung |
|---|---|
FAQ::CacheTTL | Gültigkeitsdauer des FAQ-Cache in Sekunden (0 = deaktiviert). |
FAQ::DefaultState | Standardzustand für neue FAQ-Einträge (z. B. Valid, Invalid). |
FAQ::MultiLanguage | Aktiviert mehrsprachige FAQ-Einträge (Bool). |
FAQ::SortBy | Standard-Sortierung im Explorer (Title, LastChange, Top10). |
FAQ::ExplorerItemsPerPage | Anzahl der Einträge pro Seite im FAQ-Explorer (Integer). |
Dynamic Fields
Abschnitt betitelt „Dynamic Fields“| Schlüssel | Beschreibung |
|---|---|
DynamicFields::DriverRegistration###FAQ | Registriert den FAQ-Driver für dynamische Felder. |
DynamicFields::ObjectTypeRegistration###FAQID | Legt ObjectType FAQID für Verknüpfungen (LinkObject) fest. |
Freigabe-Workflow (Approval)
Abschnitt betitelt „Freigabe-Workflow (Approval)“| Schlüssel | Beschreibung |
|---|---|
FAQ::ApprovalRequired | Aktiviert den Genehmigungsprozess für FAQ-Einträge (Bool). |
FAQ::ApprovalGroup | Gruppe(n), die FAQs freigeben dürfen (Array). |
FAQ::ApprovalQueue | Queue(s), in der neuen FAQs landen, bis sie freigegeben sind (Array). |
FAQ::NotificationOnApproval | Notification-Template für Genehmigungs-Benachrichtigungen. |
Explorer-Konfiguration
Abschnitt betitelt „Explorer-Konfiguration“| Schlüssel | Beschreibung |
|---|---|
FAQ::ExplorerPath | Breadcrumb-Pfad im Explorer (String). |
FAQ::QuickSearch | Aktiviert Freitextsuche im Explorer (Bool). |
FAQ::Top10Items | Anzahl der Einträge in der Top-10-Ansicht (Integer). |
FAQ::ShowLastChange | Zeigt Änderungsdatum im Explorer an (Bool). |
FAQ::ShowCreateDate | Zeigt Erstellungsdatum im Explorer an (Bool). |
FAQ-Einträge (Item)
Abschnitt betitelt „FAQ-Einträge (Item)“| Schlüssel | Beschreibung |
|---|---|
FAQ::Item::MaxBodyLength | Maximale Länge des Body-Texts im Zoom (chars). |
FAQ::Item::HTMLAllowTags | Liste erlaubter HTML-Tags im Body (Array). |
FAQ::Item::CategoryRequired | Kategorie bei Erstellung verpflichtend machen (Bool). |
Voting & Feedback
Abschnitt betitelt „Voting & Feedback“| Schlüssel | Beschreibung |
|---|---|
FAQ::Voting::Enable | Aktiviert Like-/Dislike-Bewertung (Bool). |
FAQ::Voting::LimitPerUser | Max. Bewertungen pro Benutzer und Tag (Integer). |
FAQ::Voting::NotificationOnVote | Notification-Template bei neuem Feedback. |
Verwandte Artikel & Service-Zuordnung
Abschnitt betitelt „Verwandte Artikel & Service-Zuordnung“| Schlüssel | Beschreibung |
|---|---|
FAQ::RelatedArticles::Enable | Verknüpfen verwandter FAQs aktivieren (Bool). |
FAQ::RelatedArticles::MaxItems | Max. Anzahl verwandter Einträge im Zoom (Integer). |
FAQ::RelatedArticles::ServiceList | Services, für die verwandte Artikel angezeigt werden (Array). |
Ticket-Einbettung
Abschnitt betitelt „Ticket-Einbettung“| Schlüssel | Beschreibung |
|---|---|
FAQ::TicketCompose::InsertMode | Einfügemodus im Ticket (Text, Link, Button). |
FAQ::TicketCompose::ButtonLabel | Beschriftung des Insert-Buttons im Ticket-Dialog. |
FAQ::TicketCompose::LinkText | Link-Text für Einfügen als Hyperlink. |
Objektverknüpfungen (LinkObject)
Abschnitt betitelt „Objektverknüpfungen (LinkObject)“| Schlüssel | Beschreibung |
|---|---|
LinkObject::PossibleLink###FAQ2FAQ | Erlaubt Verknüpfung FAQ ↔ FAQ (Bool). |
LinkObject::PossibleLink###FAQ2Ticket | Erlaubt Verknüpfung FAQ ↔ Ticket (Bool). |
Frontend-Modulregistrierungen (Agent)
Abschnitt betitelt „Frontend-Modulregistrierungen (Agent)“| Schlüssel | Beschreibung |
|---|---|
Frontend::Agent::ModuleRegistration###FAQExplorer | Modul im Agenten-FAQ-Explorer aktivieren. |
Frontend::Agent::ModuleRegistration###FAQZoom | Modul im Agenten-FAQ-Zoom aktivieren. |
Frontend::Agent::ModuleRegistration###FAQSearch | Modul für Suchfunktion im Agenten-Interface. |
Frontend::Agent::ModuleRegistration###FAQPrint | Modul für Drucken im Agenten-FAQ-Modus. |
Frontend-Modulregistrierungen (Customer/Public)
Abschnitt betitelt „Frontend-Modulregistrierungen (Customer/Public)“| Schlüssel | Beschreibung |
|---|---|
Frontend::Customer::ModuleRegistration###FAQExplorer | Modul im Kundenportal-Explorer aktivieren. |
Frontend::Customer::ModuleRegistration###FAQZoom | Modul im Kundenportal-FAQ-Zoom aktivieren. |
Frontend::Public::ModuleRegistration###FAQSearch | Modul für öffentliche Suche (anonyme Nutzer). |
Frontend::Public::ModuleRegistration###FAQPrint | Modul für Drucken im öffentlichen FAQ-Bereich. |
Häufig gestellte Fragen
Wo konfigurieren Sie das OTOBO-FAQ-Plugin und welche Hauptbereiche gibt es?
Die Konfiguration des OTOBO-FAQ-Plugins erfolgt hauptsächlich über die SysConfig. Sie finden diese Einstellungen im Admin-Bereich unter Admin → Systemverwaltung → SysConfig. Dort sind die Parameter in verschiedene Gruppen unterteilt, um eine übersichtliche Verwaltung zu ermöglichen. Zu den wichtigsten Konfigurationsbereichen gehören:
- Core-Einstellungen: Grundlegende Parameter wie Cache-Gültigkeit (
FAQ::CacheTTL), Standardzustand neuer FAQs (FAQ::DefaultState) und die Aktivierung von Mehrsprachigkeit (FAQ::MultiLanguage). - Dynamic Fields: Einstellungen zur Registrierung dynamischer Felder für FAQs (
DynamicFields::DriverRegistration###FAQ). - Freigabe-Workflow (Approval): Optionen zur Aktivierung und Steuerung des Genehmigungsprozesses für FAQ-Artikel (
FAQ::ApprovalRequired). - Explorer-Konfiguration: Anpassungen für die FAQ-Ansicht, z.B. die Anzahl der Einträge pro Seite (
FAQ::ExplorerItemsPerPage) oder die Schnellsuche (FAQ::QuickSearch). - FAQ-Einträge (Item): Spezifische Einstellungen für den Inhalt von FAQ-Artikeln, wie die maximale Textlänge (
FAQ::Item::MaxBodyLength) oder erlaubte HTML-Tags (FAQ::Item::HTMLAllowTags). - Voting & Feedback: Aktivierung und Steuerung der Bewertungsfunktion (
FAQ::Voting::Enable). - Verwandte Artikel & Service-Zuordnung: Konfiguration der Anzeige verwandter FAQs und deren Zuordnung zu Services.
- Ticket-Einbettung: Optionen zum Einfügen von FAQs in Tickets.
- Objektverknüpfungen (LinkObject): Ermöglicht das Verknüpfen von FAQs mit anderen OTOBO-Objekten wie Tickets.
- Frontend-Modulregistrierungen: Aktivierung der FAQ-Module für Agenten, Kunden und den öffentlichen Bereich.
Quellen:
Wie kann der Freigabe-Workflow für FAQ-Artikel in OTOBO konfiguriert werden?
Um einen Freigabe-Workflow für FAQ-Artikel in OTOBO zu implementieren, müssen Sie die entsprechenden SysConfig-Parameter im Bereich "Freigabe-Workflow (Approval)" konfigurieren. Zuerst aktivieren Sie den Genehmigungsprozess, indem Sie FAQ::ApprovalRequired auf Ja setzen. Anschließend definieren Sie die Gruppe(n) von Agenten, die berechtigt sind, FAQs freizugeben, indem Sie diese in FAQ::ApprovalGroup hinterlegen. Dies stellt sicher, dass nur autorisiertes Personal neue oder geänderte FAQ-Artikel überprüfen und genehmigen kann, bevor sie veröffentlicht werden. Zusätzlich können Sie eine oder mehrere Queues in FAQ::ApprovalQueue festlegen, in denen neue oder zur Überarbeitung markierte FAQs landen. Dies ermöglicht eine klare Zuweisung und Nachverfolgung des Freigabestatus. Für Benachrichtigungen über Genehmigungsanfragen oder -ergebnisse können Sie ein spezifisches Notification-Template unter FAQ::NotificationOnApproval hinterlegen, um die Kommunikation im Workflow zu automatisieren.
Quellen:
Welche Möglichkeiten bietet das FAQ-Plugin zur Integration von Dynamic Fields und wofür werden sie genutzt?
Das OTOBO FAQ-Plugin ermöglicht eine flexible Erweiterung von FAQ-Artikeln durch die Integration von Dynamic Fields (Dynamische Felder). Diese Funktion ist besonders nützlich, um strukturierte Metadaten zu FAQs hinzuzufügen, die über die Standardfelder hinausgehen. Um Dynamic Fields für FAQs zu nutzen, müssen Sie zwei zentrale SysConfig-Parameter konfigurieren:
DynamicFields::DriverRegistration###FAQ: Dieser Parameter registriert den FAQ-Treiber für das Dynamic Fields-System. Dadurch wird OTOBO mitgeteilt, dass FAQs als Objekte für dynamische Felder zur Verfügung stehen.DynamicFields::ObjectTypeRegistration###FAQID: Dieser Parameter legt denObjectTypeFAQIDfest, der für Verknüpfungen (LinkObject) mit dynamischen Feldern spezifisch für FAQs verwendet wird.
Durch die Nutzung von Dynamic Fields können Sie beispielsweise zusätzliche Klassifizierungen, Gültigkeitszeiträume, interne Referenznummern oder spezifische Produktinformationen zu jedem FAQ-Artikel hinzufügen. Dies verbessert die Suchbarkeit, Filterbarkeit und die allgemeine Datenqualität Ihrer FAQ-Sammlung erheblich und unterstützt komplexere Geschäftslogiken oder Berichte.
Quellen:
Wie können die Anzeige und Suche im FAQ-Explorer für Agenten und Kunden angepasst werden?
Die Anzeige und Suche im FAQ-Explorer kann sowohl für Agenten im Agenten-Interface als auch für Kunden im Kundenportal und öffentliche Nutzer umfassend angepasst werden. Für die allgemeine Explorer-Funktionalität sind folgende SysConfig-Parameter relevant:
FAQ::QuickSearch: Aktiviert oder deaktiviert die Freitextsuche im Explorer, was die Auffindbarkeit von Artikeln erheblich verbessert.FAQ::SortBy: Legt die Standardsortierung der FAQ-Artikel fest, z.B. nach Titel (Title), letzter Änderung (LastChange) oder den Top-10-Artikeln (Top10).FAQ::ExplorerItemsPerPage: Bestimmt, wie viele FAQ-Einträge pro Seite im Explorer angezeigt werden, um die Übersichtlichkeit zu optimieren.FAQ::ShowLastChangeundFAQ::ShowCreateDate: Steuern die Anzeige des Änderungs- bzw. Erstellungsdatums der FAQ-Artikel im Explorer, was für die Aktualität der Informationen wichtig sein kann.
Zusätzlich müssen die entsprechenden Frontend-Module registriert werden, damit der FAQ-Explorer, die Zoom-Ansicht und die Suchfunktion in den jeweiligen Portalen verfügbar sind. Dies geschieht über Parameter wieFrontend::Agent::ModuleRegistration###FAQExplorerfür Agenten,Frontend::Customer::ModuleRegistration###FAQExplorerfür das Kundenportal undFrontend::Public::ModuleRegistration###FAQSearchfür die öffentliche Suche.
Quellen:
Welche Einstellungen sind für die Verwaltung von FAQ-Inhalten und deren Darstellung relevant, insbesondere bei mehrsprachigen Artikeln?
Die Verwaltung und Darstellung von FAQ-Inhalten kann über verschiedene SysConfig-Parameter detailliert gesteuert werden, was besonders bei der Pflege einer umfangreichen Wissensdatenbank wichtig ist. Ein zentraler Aspekt ist die Unterstützung mehrerer Sprachen:
FAQ::MultiLanguage: Wenn dieser Parameter aufJagesetzt ist, können Sie FAQ-Artikel in verschiedenen Sprachen erstellen und verwalten, was für international agierende Unternehmen oder mehrsprachige Kundenkreise unerlässlich ist.
Für die Gestaltung und Integrität des Inhalts selbst gibt es weitere wichtige Einstellungen:FAQ::Item::MaxBodyLength: Definiert die maximale Zeichenanzahl für den Body-Text eines FAQ-Artikels in der Zoom-Ansicht. Dies hilft, die Lesbarkeit zu gewährleisten und übermäßig lange Artikel zu vermeiden.FAQ::Item::HTMLAllowTags: Eine Liste von erlaubten HTML-Tags, die im Body-Text von FAQs verwendet werden dürfen. Dies ist entscheidend für die Sicherheit und Konsistenz der Formatierung, da es unerwünschte oder schädliche HTML-Elemente herausfiltert.FAQ::Item::CategoryRequired: Wenn aufJagesetzt, wird die Zuweisung einer Kategorie beim Erstellen oder Bearbeiten eines FAQ-Artikels verpflichtend. Dies fördert eine strukturierte Organisation und erleichtert die Navigation im FAQ-Explorer.
Quellen:
Wie können Nutzer FAQs bewerten und wie wird dieses Feedback in OTOBO verwaltet?
Das OTOBO FAQ-Plugin bietet eine integrierte Bewertungsfunktion, die es Nutzern ermöglicht, Feedback zu FAQ-Artikeln zu geben. Dies ist ein wertvolles Tool, um die Qualität und Relevanz Ihrer Wissensdatenbank zu messen und kontinuierlich zu verbessern. Die Konfiguration erfolgt über die SysConfig-Parameter im Bereich "Voting & Feedback":
FAQ::Voting::Enable: Dieser Parameter aktiviert die Like-/Dislike-Bewertungsfunktion für FAQ-Artikel. Ist er aufJagesetzt, sehen Nutzer die Möglichkeit, Artikel positiv oder negativ zu bewerten.FAQ::Voting::LimitPerUser: Um Missbrauch zu verhindern und aussagekräftiges Feedback zu gewährleisten, können Sie mit diesem Parameter die maximale Anzahl von Bewertungen pro Benutzer und Tag begrenzen. Ein Wert von1würde beispielsweise bedeuten, dass ein Nutzer einen Artikel nur einmal pro Tag bewerten kann.FAQ::Voting::NotificationOnVote: Hier können Sie ein Notification-Template hinterlegen, das bei neuem Feedback ausgelöst wird. Dies ermöglicht es Administratoren oder Content-Managern, zeitnah über Bewertungen informiert zu werden und bei Bedarf auf Feedback zu reagieren.
Die Bewertungsfunktion hilft Ihnen, die beliebtesten und hilfreichsten Artikel zu identifizieren (z.B. über die Top-10-Ansicht) und Bereiche zu erkennen, in denen FAQ-Artikel verbessert oder erweitert werden müssen.
Quellen:
Wie können verwandte Artikel und Service-Zuordnungen für FAQs konfiguriert werden, und welche Optionen gibt es für die Einbettung von FAQs in Tickets?
Das FAQ-Plugin in OTOBO bietet flexible Möglichkeiten, FAQ-Artikel miteinander zu verknüpfen und in den Ticket-Workflow zu integrieren.
Für verwandte Artikel und Service-Zuordnungen sind folgende SysConfig-Parameter relevant:
FAQ::RelatedArticles::Enable: Aktiviert die Funktion, verwandte FAQs anzuzeigen. Dies hilft Nutzern, schnell weitere relevante Informationen zu finden.FAQ::RelatedArticles::MaxItems: Legt die maximale Anzahl der verwandten Einträge fest, die in der Zoom-Ansicht eines FAQ-Artikels angezeigt werden.FAQ::RelatedArticles::ServiceList: Hier können Sie spezifische Services definieren, für die verwandte Artikel angezeigt werden sollen. Dies ermöglicht eine gezielte Anzeige basierend auf dem Kontext des Services.
Die Einbettung von FAQs in Tickets ist eine effiziente Methode, um Agenten bei der Beantwortung von Kundenanfragen zu unterstützen:FAQ::TicketCompose::InsertMode: Bestimmt, wie ein FAQ-Artikel in ein Ticket eingefügt wird. Optionen sindText(der gesamte FAQ-Text),Link(ein Hyperlink zum FAQ) oderButton(ein Button, der den FAQ-Inhalt einfügt).FAQ::TicketCompose::ButtonLabel: Definiert die Beschriftung des Insert-Buttons im Ticket-Dialog, wenn derInsertModeaufButtongesetzt ist.FAQ::TicketCompose::LinkText: Legt den Text für den Hyperlink fest, wenn derInsertModeaufLinkeingestellt ist.
Diese Funktionen verbessern die Effizienz der Agenten, indem sie schnellen Zugriff auf relevante Informationen ermöglichen und die Konsistenz der Antworten erhöhen.
Quellen: