Skip to content

FAQ Plugin: SysConfig Reference

This document provides a complete overview of all SysConfig parameters for the FAQ plugin, along with a brief explanation.

Core Settings

KeyDescription
FAQ::CacheTTLValidity period of the FAQ cache in seconds (0 = disabled).
FAQ::DefaultStateDefault state for new FAQ entries (e.g., Valid, Invalid).
FAQ::MultiLanguageEnables multilingual FAQ entries (Bool).
FAQ::SortByDefault sorting in the explorer (Title, LastChange, Top10).
FAQ::ExplorerItemsPerPageNumber of entries per page in the FAQ explorer (Integer).

Dynamic Fields

KeyDescription
DynamicFields::DriverRegistration###FAQRegisters the FAQ driver for dynamic fields.
DynamicFields::ObjectTypeRegistration###FAQIDSets ObjectType FAQID for links (LinkObject).

Approval Workflow

KeyDescription
FAQ::ApprovalRequiredActivates the approval process for FAQ entries (Bool).
FAQ::ApprovalGroupGroup(s) that are allowed to approve FAQs (Array).
FAQ::ApprovalQueueQueue(s) where new FAQs are placed until they are approved (Array).
FAQ::NotificationOnApprovalNotification template for approval notifications.

Explorer Configuration

KeyDescription
FAQ::ExplorerPathBreadcrumb path in the explorer (String).
FAQ::QuickSearchEnables free-text search in the explorer (Bool).
FAQ::Top10ItemsNumber of entries in the Top 10 view (Integer).
FAQ::ShowLastChangeShows the modification date in the explorer (Bool).
FAQ::ShowCreateDateShows the creation date in the explorer (Bool).

FAQ Entries (Item)

KeyDescription
FAQ::Item::MaxBodyLengthMaximum length of the body text in the zoom view (chars).
FAQ::Item::HTMLAllowTagsList of allowed HTML tags in the body (Array).
FAQ::Item::CategoryRequiredMakes the category mandatory upon creation (Bool).

Voting & Feedback

KeyDescription
FAQ::Voting::EnableEnables like/dislike voting (Bool).
FAQ::Voting::LimitPerUserMax. votes per user per day (Integer).
FAQ::Voting::NotificationOnVoteNotification template for new feedback.
KeyDescription
FAQ::RelatedArticles::EnableEnable linking of related FAQs (Bool).
FAQ::RelatedArticles::MaxItemsMax. number of related entries in the zoom view (Integer).
FAQ::RelatedArticles::ServiceListServices for which related articles are displayed (Array).

Ticket Embedding

KeyDescription
FAQ::TicketCompose::InsertModeInsertion mode in the ticket (Text, Link, Button).
FAQ::TicketCompose::ButtonLabelLabel of the insert button in the ticket dialog.
FAQ::TicketCompose::LinkTextLink text for insertion as a hyperlink.
KeyDescription
LinkObject::PossibleLink###FAQ2FAQAllows linking FAQ ↔ FAQ (Bool).
LinkObject::PossibleLink###FAQ2TicketAllows linking FAQ ↔ Ticket (Bool).

Frontend Module Registrations (Agent)

KeyDescription
Frontend::Agent::ModuleRegistration###FAQExplorerActivate module in the agent FAQ explorer.
Frontend::Agent::ModuleRegistration###FAQZoomActivate module in the agent FAQ zoom view.
Frontend::Agent::ModuleRegistration###FAQSearchModule for search function in the agent interface.
Frontend::Agent::ModuleRegistration###FAQPrintModule for printing in the agent FAQ mode.

Frontend Module Registrations (Customer/Public)

KeyDescription
Frontend::Customer::ModuleRegistration###FAQExplorerActivate module in the customer portal explorer.
Frontend::Customer::ModuleRegistration###FAQZoomActivate module in the customer portal FAQ zoom view.
Frontend::Public::ModuleRegistration###FAQSearchModule for public search (anonymous users).
Frontend::Public::ModuleRegistration###FAQPrintModule for printing in the public FAQ area.