Skip to content
OTOBO Community Guide

FAQ Plugin: Introduction and Installation for OTOBO

What is the FAQ plugin?

Section titled “What is the FAQ plugin?”

The FAQ plugin extends OTOBO with a central knowledge base where frequently asked questions (FAQs) are recorded, categorized, and made available in a searchable format. This allows agents to quickly access pre-written answers and customers to find solutions independently in the self-service area.

Compatibility & System Requirements

Section titled “Compatibility & System Requirements”
  • OTOBO version: 11.0.x and higher
  • Perl modules: no external dependencies
  • Database: PostgreSQL or MySQL/MariaDB

Installation

Section titled “Installation”
  1. Package Manager (Admin Interface)
  • Log in to the OTOBO admin area.
  • Navigate to System Administration → Package Manager.
  • Search for FAQ and click on Install.
  1. Manual Installation
  • Download the add-on archive and extract it into the Kernel/Config/Files/ directory.
  • In the admin area under System Administration → Update, select Reload File System to integrate the new modules.
  1. Database Migration
  • After installation, run the migration command in the terminal:
Terminal window
bin/otobo.Console.pl Maint::Database::Upgrade
  • Check in Admin → System Administration → SysConfig → Core → FAQ whether all default values are available.

Getting Started

Section titled “Getting Started”
  1. Displaying the FAQ Area
  • Agents will find a new item for managing questions in the menu under SelfService → FAQ.
  • A new FAQs module will appear in the customer portal, allowing end users to search for questions.
  1. Creating Your First FAQ
  • Click on Add FAQ in the agent interface.
  • Assign a title, select a category, and create the answer text.
  • Activate the question with the status Valid.
  1. Categories & Language
  • Create new topic areas in Administration → Categories (e.g., “Access”, “Invoices”).
  • For multilingual support, store alternative texts for different languages.

Congratulations! Your FAQ plugin is installed and ready to use. See the usage guide for daily workflows. For AI-assisted knowledge management, see FAQ with AI.

Frequently asked questions

What is the primary purpose and benefit of integrating the FAQ plugin into OTOBO?

The FAQ plugin significantly enhances OTOBO by providing a centralized knowledge base. Its core purpose is to record, categorize, and make frequently asked questions and their answers readily available. This serves a dual benefit: for agents, it allows quick access to pre-written solutions directly within tickets, drastically reducing the time spent on repetitive inquiries and improving response efficiency. For customers, it empowers them to find solutions independently through a self-service portal, thereby decreasing support ticket volume and improving overall customer satisfaction. This systematic approach to knowledge management streamlines support operations and ensures consistent information delivery.

Quellen

What are the specific system requirements and OTOBO version compatibility for the FAQ plugin?

The FAQ plugin is designed for seamless integration with OTOBO installations. It requires OTOBO version 11.0.x or higher to function correctly, ensuring compatibility with the latest features and security updates of the platform. Regarding database support, the plugin is flexible and works with both PostgreSQL and MySQL/MariaDB environments, which are standard for OTOBO deployments. A significant advantage is that the FAQ plugin has no external Perl module dependencies, simplifying its installation and reducing potential conflicts or additional setup requirements. This makes it a lightweight yet powerful addition to your OTOBO instance.

Quellen

Describe the two main methods for installing the FAQ plugin in OTOBO and the crucial post-installation steps.

The FAQ plugin can be installed in OTOBO using two primary methods. The recommended approach is via the Package Manager: log into the OTOBO admin area, navigate to System Administration → Package Manager, search for "FAQ", and click "Install". Alternatively, for manual installation, you can download the add-on archive, extract it into the Kernel/Config/Files/ directory, and then go to System Administration → Update in the admin area to select Reload File System.

Crucial post-installation steps include running a database migration command in your terminal: bin/otobo.Console.pl Maint::Database::Upgrade. This ensures all necessary database structures are created. Finally, it's vital to verify that all default FAQ settings are available by checking Admin → System Administration → SysConfig → Core → FAQ. These steps ensure the plugin is fully integrated and ready for use.

Quellen

How do agents and customers access and utilize the FAQ knowledge base once the plugin is installed and configured?

After successful installation and initial configuration, both OTOBO agents and customers gain distinct access points to the FAQ knowledge base. Agents, who are responsible for managing and creating FAQ articles, will find a dedicated entry in their interface. They can navigate to SelfService → FAQ to manage questions, add new ones, edit existing entries, and publish them. This area serves as their primary hub for knowledge base administration.

For customers, the FAQ knowledge base becomes available through the customer portal. A new FAQs module will appear, allowing end-users to independently search for answers to common questions. This self-service capability empowers customers to find solutions without needing to open a ticket, significantly improving their experience and reducing the workload on agents. The visibility of articles in the customer portal depends on their published status and relevant frontend module configurations.

Quellen

What are the essential first steps for an agent to create and publish their initial FAQ articles within OTOBO?

To begin populating your OTOBO knowledge base, an agent should follow a few key steps after installation. First, navigate to the agent interface and click on Add FAQ. Here, you will assign a clear title to your question, select an appropriate category (or create new ones if needed under Administration → Categories), and then compose the detailed answer text. Crucially, to make the FAQ article visible and searchable, you must activate it by setting its status to Valid.

For enhanced organization and user experience, it's highly recommended to establish a robust category structure, such as "Access" or "Invoices," which helps users quickly narrow down their search. Additionally, for organizations supporting multiple languages, the FAQ plugin allows storing alternative texts for different languages, ensuring multilingual support for your knowledge base. These initial steps lay the groundwork for a comprehensive and accessible knowledge base.

Quellen