Skip to content
Znuny Logo Znuny Community Docs

FAQ Plugin: Introduction and Installation for Znuny

What is the FAQ plugin?

Section titled “What is the FAQ plugin?”

The FAQ plugin extends Znuny 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”
  • Znuny version: 7.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 Znuny admin area.
  • Navigate to System Administration → Package Manager.
  • Search for FAQ and click 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/znuny.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. Display 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. Create 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 of the Znuny FAQ plugin and who benefits from it?

The Znuny FAQ plugin serves as a central knowledge base designed to store, categorize, and make frequently asked questions (FAQs) easily searchable within your Znuny system. Its main purpose is to streamline information access and improve efficiency for both agents and customers. Agents benefit by having quick access to pre-written, standardized answers, which reduces response times and ensures consistent information delivery in ticket handling. Customers gain the ability to find solutions independently through a self-service portal, reducing the volume of incoming support tickets and enhancing their overall experience. This leads to a more efficient support operation and empowered users.

Quellen:

What are the system requirements and compatibility considerations for installing the FAQ plugin in Znuny?

To successfully install and run the FAQ plugin, your Znuny instance must meet specific system requirements. The plugin is compatible with Znuny version 7.0.x and higher, ensuring it integrates seamlessly with modern Znuny environments. Regarding database support, it works with both PostgreSQL and MySQL/MariaDB, offering flexibility depending on your existing infrastructure. Importantly, the FAQ plugin does not introduce any external Perl module dependencies, simplifying the installation process and reducing potential conflicts. This ensures a straightforward setup without the need for additional complex software installations, making it accessible for a wide range of Znuny users.

Quellen:

What are the detailed steps for installing the FAQ plugin in Znuny, including post-installation tasks?

Installing the FAQ plugin in Znuny involves a few critical steps to ensure proper functionality. The recommended method is via the Package Manager:

  1. Log into your Znuny admin area.
  2. Navigate to System Administration → Package Manager.
  3. Search for "FAQ" and click Install.
    Alternatively, for manual installation, 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 Reload File System.

After the initial installation, a crucial post-installation step is the database migration. Open your terminal and execute:
bin/znuny.Console.pl Maint::Database::Upgrade
Finally, verify the installation by checking the system configuration. Go to Admin → System Administration → SysConfig → Core → FAQ to confirm that all default values for the FAQ plugin are available and correctly configured. This ensures the plugin is fully integrated and ready for use.

Quellen:

How can agents and customers access and utilize the FAQ articles after the plugin is successfully installed?

Once the FAQ plugin is installed, both agents and customers gain specific access points to the knowledge base. For agents, a new menu item appears under SelfService → FAQ in the agent interface. This dedicated area allows them to manage, create, edit, and publish FAQ articles. Agents can also search for relevant FAQs to assist customers directly within tickets, improving response accuracy and speed. For customers, a new FAQs module becomes visible in the customer portal. This module enables end users to independently search for answers to their questions, reducing the need to open new support tickets. To ensure customers can see published articles, the relevant frontend modules must be enabled in the system configuration, providing a self-service option that empowers users and lightens the load on support staff.

Quellen:

What are the crucial initial steps to take after installing the FAQ plugin to start building a knowledge base?

After successfully installing the FAQ plugin, there are several crucial initial steps to begin building your knowledge base effectively. First, you should create categories to organize your FAQ articles logically. Navigate to Administration → Categories and establish relevant topic areas, such as "Access Issues," "Billing & Invoices," or "Product Features." This structured approach makes it easier for both agents and customers to find information. Next, proceed to create your first FAQ article. In the agent interface, click on Add FAQ under SelfService → FAQ. Assign a clear title, select an appropriate category, and compose a detailed answer text. It is vital to activate the question by setting its status to Valid to make it visible. For multilingual support, you can also store alternative texts for different languages within the FAQ article, ensuring a broader audience can benefit from your knowledge base.

Quellen: