FAQ Plugin: SysConfig Reference

In this document, you will find a complete overview of all SysConfig parameters of the FAQ plugin with a brief explanation.

Core Settings

Key	Description
FAQ::CacheTTL	Validity period of the FAQ cache in seconds (0 = disabled).
FAQ::DefaultState	Default state for new FAQ entries (e.g., Valid, Invalid).
FAQ::MultiLanguage	Activates multilingual FAQ entries (Bool).
FAQ::SortBy	Default sorting in the Explorer (Title, LastChange, Top10).
FAQ::ExplorerItemsPerPage	Number of entries per page in the FAQ Explorer (Integer).

Dynamic Fields

Key	Description
DynamicFields::DriverRegistration###FAQ	Registers the FAQ driver for dynamic fields.
DynamicFields::ObjectTypeRegistration###FAQID	Sets ObjectType FAQID for links (LinkObject).

Approval Workflow

Key	Description
FAQ::ApprovalRequired	Activates the approval process for FAQ entries (Bool).
FAQ::ApprovalGroup	Group(s) allowed to approve FAQs (Array).
FAQ::ApprovalQueue	Queue(s) where new FAQs land until approved (Array).
FAQ::NotificationOnApproval	Notification template for approval notifications.

Explorer Configuration

Key	Description
FAQ::ExplorerPath	Breadcrumb path in the Explorer (String).
FAQ::QuickSearch	Activates full-text search in the Explorer (Bool).
FAQ::Top10Items	Number of entries in the Top 10 view (Integer).
FAQ::ShowLastChange	Displays modification date in the Explorer (Bool).
FAQ::ShowCreateDate	Displays creation date in the Explorer (Bool).

FAQ Entries (Item)

Key	Description
FAQ::Item::MaxBodyLength	Maximum length of the body text in the zoom (chars).
FAQ::Item::HTMLAllowTags	List of allowed HTML tags in the body (Array).
FAQ::Item::CategoryRequired	Make category mandatory upon creation (Bool).

Voting & Feedback

Key	Description
FAQ::Voting::Enable	Activates like/dislike rating (Bool).
FAQ::Voting::LimitPerUser	Max. ratings per user and tag (Integer).
FAQ::Voting::NotificationOnVote	Notification template for new feedback.

Related Articles & Service Assignment

Key	Description
FAQ::RelatedArticles::Enable	Link related FAQs (Bool).
FAQ::RelatedArticles::MaxItems	Max. number of related entries in the zoom (Integer).
FAQ::RelatedArticles::ServiceList	Services for which related articles are displayed (Array).

Ticket Embedding

Key	Description
FAQ::TicketCompose::InsertMode	Insert mode in the ticket (Text, Link, Button).
FAQ::TicketCompose::ButtonLabel	Label of the insert button in the ticket dialog.
FAQ::TicketCompose::LinkText	Link text for inserting as a hyperlink.

Link Objects

Key	Description
LinkObject::PossibleLink###FAQ2FAQ	Allows FAQ ↔ FAQ linking (Bool).
LinkObject::PossibleLink###FAQ2Ticket	Allows FAQ ↔ Ticket linking (Bool).

Frontend Module Registrations (Agent)

Key	Description
Frontend::Agent::ModuleRegistration###FAQExplorer	Activate module in the Agent FAQ Explorer.
Frontend::Agent::ModuleRegistration###FAQZoom	Activate module in the Agent FAQ Zoom.
Frontend::Agent::ModuleRegistration###FAQSearch	Module for search function in the Agent interface.
Frontend::Agent::ModuleRegistration###FAQPrint	Module for printing in Agent FAQ mode.

Frontend Module Registrations (Customer/Public)

Key	Description
Frontend::Customer::ModuleRegistration###FAQExplorer	Activate module in the customer portal Explorer.
Frontend::Customer::ModuleRegistration###FAQZoom	Activate module in the customer portal FAQ Zoom.
Frontend::Public::ModuleRegistration###FAQSearch	Module for public search (anonymous users).
Frontend::Public::ModuleRegistration###FAQPrint	Module for printing in the public FAQ area.