Doc en-faq

Documentation
FAQ
The FAQ/knowledge base. Version 4.0.1 Edition
Build Date:
2014-11-21

ii
Table of Contents
Preface .............................................................................................................................. viii
1. Feature List ..................................................................................................................... 1
1. FAQ Explorer ............................................................................................................ 1
2. WYSIWYG Editor ...................................................................................................... 1
3. FAQ Articles ............................................................................................................. 1
4. FAQ Attachments ..................................................................................................... 1
5. Agent And Customer Interfaces .............................................................................. 1
6. Comfortable Navigation / Clickable Keywords ......................................................... 1
7. Linked Objects ......................................................................................................... 1
8. Full-text And Quick Search ...................................................................................... 1
9. Top 10 Articles ......................................................................................................... 1
10. Ranking / Voting Of FAQ Articles ........................................................................... 1
11. Inserting FAQ Articles In OTRS Replies .................................................................. 1
12. Release Workflow .................................................................................................. 2
13. RSS Feeds For Public FAQ Articles ......................................................................... 2
14. OpenSearch Format ............................................................................................... 2
15. Create Links Using The Category Name ................................................................ 2
16. Generic Interface FAQ Connector For Public Interface ........................................... 2
17. Dynamic Fields for FAQ ......................................................................................... 3
2. System Requirements ..................................................................................................... 4
1. Framework ............................................................................................................... 4
2. Packages .................................................................................................................. 4
3. Operating System .................................................................................................... 4
4. Third Party Software ................................................................................................ 4
3. Installation ....................................................................................................................... 5
1. Admin Interface ....................................................................................................... 5
2. Command Line ........................................................................................................ 5
4. Configuration ................................................................................................................... 6
1. General .................................................................................................................... 6
1.1. CustomerFrontend::HeaderMetaModule###3-FAQSearch. ........................... 6
1.2. CustomerFrontend::Module###CustomerFAQExplorer. ................................ 6
1.3. CustomerFrontend::Module###CustomerFAQPrint. ...................................... 6
1.4. CustomerFrontend::Module###CustomerFAQSearch. .................................. 6
1.5. CustomerFrontend::Module###CustomerFAQZoom. .................................... 6
1.6. DashboardBackend###0398-FAQ-LastChange. ............................................ 6
1.7. DashboardBackend###0399-FAQ-LastCreate. ............................................. 6
1.8. DynamicFields::ObjectType###FAQ. ............................................................. 6
1.9. FAQ::Agent::StateTypes. ................................................................................ 7
1.10. FAQ::ApprovalGroup. ................................................................................... 7
1.11. FAQ::ApprovalQueue. ................................................................................... 7
1.12. FAQ::ApprovalRequired. ............................................................................... 7
1.13. FAQ::ApprovalTicketBody. ............................................................................ 7
1.14. FAQ::ApprovalTicketDefaultState. ................................................................ 7
1.15. FAQ::ApprovalTicketPriority. ......................................................................... 7
1.16. FAQ::ApprovalTicketSubject. ........................................................................ 7
1.17. FAQ::ApprovalTicketType. ............................................................................ 7
1.18. FAQ::CacheTTL. ........................................................................................... 7
1.19. FAQ::Customer::StateTypes. ........................................................................ 8
1.20. FAQ::Default::Language. .............................................................................. 8
1.21. FAQ::Default::RootCategoryComment. ........................................................ 8
1.22. FAQ::Default::RootCategoryName. .............................................................. 8

iii
1.23. FAQ::Default::State. ..................................................................................... 8
1.24. FAQ::Explorer::ItemList::VotingResultColors. ............................................... 8
1.25. FAQ::Explorer::ItemList::VotingResultDecimalPlaces. ................................... 8
1.26. FAQ::Explorer::LastChange::Limit. ............................................................... 8
1.27. FAQ::Explorer::LastChange::Show. ............................................................... 8
1.28. FAQ::Explorer::LastChange::ShowSubCategoryItems. ................................. 8
1.29. FAQ::Explorer::LastCreate::Limit. ................................................................. 8
1.30. FAQ::Explorer::LastCreate::Show. ................................................................ 9
1.31. FAQ::Explorer::LastCreate::ShowSubCategoryItems. ................................... 9
1.32. FAQ::Explorer::Path::Separator. ................................................................... 9
1.33. FAQ::Explorer::Path::Show. .......................................................................... 9
1.34. FAQ::Explorer::QuickSearch::Show. .............................................................. 9
1.35. FAQ::Explorer::Top10::Limit. ........................................................................ 9
1.36. FAQ::Explorer::Top10::Show. ........................................................................ 9
1.37. FAQ::Explorer::Top10::ShowSubCategoryItems. ........................................... 9
1.38. FAQ::FAQHook. ............................................................................................. 9
1.39. FAQ::Frontend::AgentFAQAdd###DynamicField. ........................................ 9
1.40. FAQ::Frontend::AgentFAQAdd###RichTextHeight. .................................... 10
1.41. FAQ::Frontend::AgentFAQAdd###RichTextWidth. ..................................... 10
1.42. FAQ::Frontend::AgentFAQEdit###DynamicField. ...................................... 10
1.43. FAQ::Frontend::AgentFAQEdit###RichTextHeight. .................................... 10
1.44. FAQ::Frontend::AgentFAQEdit###RichTextWidth. ..................................... 10
1.45. FAQ::Frontend::AgentFAQExplorer###Order::Default. .............................. 10
1.46. FAQ::Frontend::AgentFAQExplorer###SearchLimit. .................................. 10
1.47. FAQ::Frontend::AgentFAQExplorer###ShowColumns. .............................. 10
1.48. FAQ::Frontend::AgentFAQExplorer###SortBy::Default. ............................. 10
1.49. FAQ::Frontend::AgentFAQJournal###JournalLimit. .................................... 11
1.50. FAQ::Frontend::AgentFAQJournal###ShowColumns. ................................. 11
1.51. FAQ::Frontend::AgentFAQPrint###DynamicField. ..................................... 11
1.52. FAQ::Frontend::AgentFAQSearch###Defaults###ApprovedSearch. ........ 11
1.53. FAQ::Frontend::AgentFAQSearch###Defaults###CategoryIDs. .............. 11
1.54. FAQ::Frontend::AgentFAQSearch###Defaults###CreatedUserIDs. ......... 11
1.55. FAQ::Frontend::AgentFAQSearch###Defaults###Fulltext. ...................... 11
1.56.
FAQ::Frontend::AgentFAQSearch###Defaults###ItemChangeTimePoint. ........ 11
1.57.
FAQ::Frontend::AgentFAQSearch###Defaults###ItemChangeTimeSlot. .......... 11
1.58.
FAQ::Frontend::AgentFAQSearch###Defaults###ItemCreateTimePoint. .......... 11
1.59.
FAQ::Frontend::AgentFAQSearch###Defaults###ItemCreateTimeSlot. ............ 12
1.60. FAQ::Frontend::AgentFAQSearch###Defaults###Keyword. .................... 12
1.61. FAQ::Frontend::AgentFAQSearch###Defaults###LanguageIDs. ............. 12
1.62.
FAQ::Frontend::AgentFAQSearch###Defaults###LastChangedUserIDs. .......... 12
1.63. FAQ::Frontend::AgentFAQSearch###Defaults###Number. ..................... 12
1.64. FAQ::Frontend::AgentFAQSearch###Defaults###RateSearchType. ......... 12
1.65. FAQ::Frontend::AgentFAQSearch###Defaults###StateIDs. .................... 12
1.66. FAQ::Frontend::AgentFAQSearch###Defaults###Title. ........................... 12
1.67. FAQ::Frontend::AgentFAQSearch###Defaults###ValidIDs. ..................... 12
1.68. FAQ::Frontend::AgentFAQSearch###Defaults###VoteSearchType. ......... 12
1.69. FAQ::Frontend::AgentFAQSearch###DynamicField. .................................. 12
1.70. FAQ::Frontend::AgentFAQSearch###Order::Default. ................................ 13
1.71. FAQ::Frontend::AgentFAQSearch###SearchCSVDynamicField. ................. 13

iv
1.72. FAQ::Frontend::AgentFAQSearch###SearchLimit. .................................... 13
1.73. FAQ::Frontend::AgentFAQSearch###ShowColumns. ................................. 13
1.74. FAQ::Frontend::AgentFAQSearch###SortBy::Default. ............................... 13
1.75. FAQ::Frontend::AgentFAQZoom###DynamicField. ................................... 13
1.76. FAQ::Frontend::AgentHTMLFieldHeightDefault. .......................................... 13
1.77. FAQ::Frontend::AgentHTMLFieldHeightMax. ............................................... 13
1.78. FAQ::Frontend::CustomerFAQExplorer###Order::Default. ........................ 13
1.79. FAQ::Frontend::CustomerFAQExplorer###SearchLimit. ............................ 14
1.80. FAQ::Frontend::CustomerFAQExplorer###SearchPageShown. .................. 14
1.81. FAQ::Frontend::CustomerFAQExplorer###SortBy::Default. ....................... 14
1.82. FAQ::Frontend::CustomerFAQOverview###DynamicField. ........................ 14
1.83. FAQ::Frontend::CustomerFAQPrint###DynamicField. ............................... 14
1.84. FAQ::Frontend::CustomerFAQSearch###DynamicField. ............................ 14
1.85. FAQ::Frontend::CustomerFAQSearch###Order::Default. .......................... 14
1.86. FAQ::Frontend::CustomerFAQSearch###SearchCSVDynamicField. ........... 14
1.87. FAQ::Frontend::CustomerFAQSearch###SearchLimit. .............................. 14
1.88. FAQ::Frontend::CustomerFAQSearch###SearchPageShown. .................... 14
1.89. FAQ::Frontend::CustomerFAQSearch###SortBy::Default. ......................... 15
1.90. FAQ::Frontend::CustomerFAQZoom###DynamicField. ............................. 15
1.91. FAQ::Frontend::CustomerHTMLFieldHeightDefault. .................................... 15
1.92. FAQ::Frontend::CustomerHTMLFieldHeightMax. ......................................... 15
1.93. FAQ::Frontend::JournalOverview###Small. ............................................... 15
1.94. FAQ::Frontend::MenuModule###000-Back. .............................................. 15
1.95. FAQ::Frontend::MenuModule###010-Edit. ................................................ 15
1.96. FAQ::Frontend::MenuModule###020-History. ........................................... 15
1.97. FAQ::Frontend::MenuModule###030-Print. ............................................... 15
1.98. FAQ::Frontend::MenuModule###040-Link. ............................................... 15
1.99. FAQ::Frontend::MenuModule###050-Delete. ........................................... 16
1.100. FAQ::Frontend::Overview###Small. ....................................................... 16
1.101. FAQ::Frontend::OverviewSmall###DynamicField. .................................. 16
1.102. FAQ::Frontend::PublicFAQExplorer###Order::Default. ............................ 16
1.103. FAQ::Frontend::PublicFAQExplorer###SearchLimit. ................................ 16
1.104. FAQ::Frontend::PublicFAQExplorer###SearchPageShown. ...................... 16
1.105. FAQ::Frontend::PublicFAQExplorer###SortBy::Default. ........................... 16
1.106. FAQ::Frontend::PublicFAQOverview###DynamicField. ............................ 16
1.107. FAQ::Frontend::PublicFAQPrint###DynamicField. ................................... 16
1.108. FAQ::Frontend::PublicFAQSearch###DynamicField. ................................ 17
1.109. FAQ::Frontend::PublicFAQSearch###Order::Default. .............................. 17
1.110. FAQ::Frontend::PublicFAQSearch###SearchCSVDynamicField. ............... 17
1.111. FAQ::Frontend::PublicFAQSearch###SearchLimit. .................................. 17
1.112. FAQ::Frontend::PublicFAQSearch###SearchPageShown. ........................ 17
1.113. FAQ::Frontend::PublicFAQSearch###SortBy::Default. ............................. 17
1.114. FAQ::Frontend::PublicFAQZoom###DynamicField. ................................. 17
1.115. FAQ::Item::Field1. .................................................................................... 17
1.116. FAQ::Item::Field2. .................................................................................... 17
1.117. FAQ::Item::Field3. .................................................................................... 17
1.118. FAQ::Item::Field4. .................................................................................... 18
1.119. FAQ::Item::Field5. .................................................................................... 18
1.120. FAQ::Item::Field6. .................................................................................... 18
1.121. FAQ::Item::HTML. ..................................................................................... 18
1.122. FAQ::Item::Voting::Rates. ......................................................................... 18
1.123. FAQ::Item::Voting::Show. ......................................................................... 18
1.124. FAQ::MultiLanguage. ................................................................................ 18
1.125. FAQ::Public::StateTypes. .......................................................................... 18

v
1.126. FAQ::TicketCompose###IncludeInternal. ............................................... 18
1.127. FAQ::TicketCompose###InsertMethod. .................................................. 18
1.128. FAQ::TicketCompose###ShowFieldNames. ............................................ 19
1.129. FAQ::TicketCompose###ShowInsertLinkButton. ..................................... 19
1.130. FAQ::TicketCompose###ShowInsertTextAndLinkButton. ........................ 19
1.131. FAQ::TicketCompose###ShowInsertTextButton. ..................................... 19
1.132. FAQ::TicketCompose###UpdateArticleSubject. ...................................... 19
1.133. FAQ::Voting. ............................................................................................. 19
1.134. Frontend::HeaderMetaModule###3-FAQSearch. .................................... 19
1.135. Frontend::Module###AgentFAQAdd. ...................................................... 19
1.136. Frontend::Module###AgentFAQCategory. .............................................. 19
1.137. Frontend::Module###AgentFAQDelete. .................................................. 19
1.138. Frontend::Module###AgentFAQEdit. ...................................................... 19
1.139. Frontend::Module###AgentFAQExplorer. ................................................ 20
1.140. Frontend::Module###AgentFAQHistory. .................................................. 20
1.141. Frontend::Module###AgentFAQJournal. ................................................. 20
1.142. Frontend::Module###AgentFAQLanguage. ............................................. 20
1.143. Frontend::Module###AgentFAQPrint. ..................................................... 20
1.144. Frontend::Module###AgentFAQRichText. ............................................... 20
1.145. Frontend::Module###AgentFAQSearch. .................................................. 20
1.146. Frontend::Module###AgentFAQSearchSmall. ......................................... 20
1.147. Frontend::Module###AgentFAQZoom. ................................................... 20
1.148. Frontend::Output::FilterElementPost###FAQ. ......................................... 20
1.149. Frontend::Output::OutputFilterTextAutoLink###FAQ. ............................. 21
1.150. Frontend::Search###FAQ. ...................................................................... 21
1.151. Frontend::ToolBarModule###90-FAQ::AgentFAQAdd. ............................. 21
1.152. GenericInterface::Operation::Module###FAQ::LanguageList. ................ 21
1.153. GenericInterface::Operation::Module###FAQ::PublicCategoryList. ........ 21
1.154. GenericInterface::Operation::Module###FAQ::PublicFAQGet. ................ 21
1.155. GenericInterface::Operation::Module###FAQ::PublicFAQSearch. ........... 21
1.156. LinkObject::PossibleLink###8301. ......................................................... 21
1.160. Loader::Agent::CommonCSS###200-FAQ. ............................................. 22
1.161. Loader::Agent::CommonJS###200-FAQ. ................................................. 22
1.162. PreferencesGroups###FAQJournalOverviewSmallPageShown. ............... 22
1.163. PreferencesGroups###FAQOverviewSmallPageShown. .......................... 22
1.164. PublicFrontend::CommonParam###Action. ............................................ 22
1.165. PublicFrontend::HeaderMetaModule###3-FAQSearch. ........................... 22
1.166. PublicFrontend::Module###PublicFAQ. ................................................... 22
1.167. PublicFrontend::Module###PublicFAQExplorer. ...................................... 22
1.168. PublicFrontend::Module###PublicFAQPrint. ............................................ 22
1.169. PublicFrontend::Module###PublicFAQRSS. ............................................. 23
1.170. PublicFrontend::Module###PublicFAQSearch. ........................................ 23
1.171. PublicFrontend::Module###PublicFAQZoom. .......................................... 23
2. Approval function .................................................................................................. 23
5. Usage ............................................................................................................................ 24
1. Create A New FAQ Article ...................................................................................... 24
2. Create a New Category ......................................................................................... 25
3. Create a New Language ........................................................................................ 25
6. File List .......................................................................................................................... 26
7. Tests .............................................................................................................................. 31
1. Test Cases .............................................................................................................. 31

vi
2. Unit Tests ............................................................................................................... 31
8. ChangeLog .................................................................................................................... 32
A. Generic Interface FAQ Connector Configuration ........................................................... 33
1. Web Service configuration ..................................................................................... 33
B. Generic Interface FAQ Connector API ........................................................................... 35
1. LanguageList .......................................................................................................... 35
2. PubliCategoryList ................................................................................................... 35
3. PublicFAQGet .......................................................................................................... 36
4. PublicFAQSearch .................................................................................................... 39

vii
List of Tables
4.1. Variables for FAQ Approval message ......................................................................... 23

viii
Preface
The FAQ Module is an OTRS extension providing an FAQ or rather a knowledge database.
It facilitates speeding-up the knowledge transfer between agents or (using a public web in-
terface) between organizations and their customers, therefore effectively saving time.
If you have questions regarding this document or if you need further information, please log
in to our customer portal at portal.otrs.com with your OTRS ID and create a ticket. You do
not have an OTRS ID yet? Register here for free.

1
Chapter 1. Feature List
1. FAQ Explorer
Intuitive navigation and flexible mapping of theme hierarchies within the FAQ Explorer enable
easy navigation through the database.
2. WYSIWYG Editor
Using the WYSIWYG Editor you can change the formatting of articles and include screen shots
or images.
3. FAQ Articles
FAQ articles with various attributes like "Symptom", "Problem", "Solution", "Title", "Lan-
guage", "Category", "Keywords", "State", "Created" and "Changed"
4. FAQ Attachments
You can add attachments to FAQ articles, which are available in the customer interface, too
(e. g. user guides in pdf format).
5. Agent And Customer Interfaces
Using the FAQ state you can determine the interface(s), in which an FAQ article should be dis-
played. Articles with their state set to "internal" are only visible for agents via the Agent In-
terface; Articles whose state is set to "external" are also displayed in the protected customer
section, and articles tagged as "public" are available in the non-protected public area as well.
6. Comfortable Navigation / Clickable Keywords
The key words feature enables comfortable navigation to alternative articles using clickable
key words.
7. Linked Objects
FAQ articles can be linked to other objects such as tickets, FAQ articles or (CMDB) configu-
ration items.
8. Full-text And Quick Search
You can execute a full-text and quick search in the entire knowledge database. You can also
use OTRS operators for "AND" or "OR" relations.
9. Top 10 Articles
An overview showing the Top 10 most often accessed, most recently generated and most
recently changed articles.
10. Ranking / Voting Of FAQ Articles
A personal ranking / voting of FAQ articles providing other users with information about the
quality of FAQ articles.
11. Inserting FAQ Articles In OTRS Replies
You can insert FAQ articles (including images and attachments) in new tickets or replies you
generate in OTRS.

2
12. Release Workflow
Workflow to release FAQ articles that have been newly generated or changed.
13. RSS Feeds For Public FAQ Articles
In the public area, an option is provided to subscribe to RSS Feeds providing information
about changes in FAQ articles.
14. OpenSearch Format
The FAQ Module supports Open Search format (enabling quick searches directly from the
browser).
15. Create Links Using The Category Name
From FAQ 2.2.x it is possible to refer to FAQ items by creating a link for web browser using
the category name instead of just the category ID
To be able to use this feature just replace the CategoryID parameter with Category parameter
in your current links. Category parameter is the full category path, each sub-category is
separated by "::" (which is also called the "Category Long Name"). Imagine the following
category tree:
|--GrandParent
| |--Parent
| | |--|Son
To create a link to the "Son" category we need to specify the following path:
Category=GrandParent::Parent::Son.
See the link examples below:
from: http://localhost/otrs/index.pl?Action=AdminFAQExplorer;CategoryID=1
to: http://localhost/otrs/index.pl?Action=AdminFAQExplorer;Category=Misc
Other Examples:
http://localhost/otrs/index.pl?Action=AdminFAQExplorer;Category=My%20Category
http://localhost/otrs/index.pl?
Action=CustomerFAQExplorer;Category=GrandParent::Parent::Son
http://localhost/otrs/index.pl?Action=PublicFAQExplorer;Category=My
%20Category::Subcategory
16. Generic Interface FAQ Connector For Public Interface
Allow you to use the functions for FAQ public interface via OTRS Generic Interface by adding
the following operations.
• LanguageList
This operation returns the list of all FAQ languages available in the system. The response
of this operation is a list of languages including the ID and Name for each language.

3
• PublicCategoryList
This operation is used to get the system FAQ categories that have at least one public FAQ
item, as a consequence also the category ancestors are also listed even if they don't have
any public FAQ item. The output of this operation is a list of categories including ID and
Name for each category.
• PublicFAQSearch
By using this operation is possible to perform a FAQ search for the public FAQ items using
the same search parameters as in the public web interface. It will return a list of IDs for
matched FAQ items.
• PublicFAQGet
This operation can be used to easily obtain one or more FAQ items. The response will one
or more main containers called 'FAQItem' that has all the FAQ item information, including
attachments, each attachment is represented by an 'Attachment' sub-containers and they
could be more than one.
Note
Please take a look into the appendix: Generic Interface FAQ Connector Configuration
below to learn more about how to activate this feature, as well as the appendix: Gener-
ic Interface FAQ Connector API for details on using the above functions.
17. Dynamic Fields for FAQ
From FAQ 4, basic Dynamic Fields (Text, TextArea, Checkbox, Dropdown, Multiselect, Date
and Date/Time) has been implemented for FAQ items. It creation, behavior and configuration
is similar to the Dynamic Fields for Ticket.
Already created Dynamic Fields can not be used for FAQ, new Dynamic Fields for FAQ (exclu-
sively) has to be created (Same as Ticket and Article Dynamic Fields).
Dynamic Fields extend FAQ by adding multiple options to store and present information on
FAQ Items, beyond the normal fields (e.g. Symptom, Problem, Solution, etc. ).

4
Chapter 2. System Requirements
1. Framework
The following OTRS framework is required:
• 4.0.x
2. Packages
The following packages are required:
• None
3. Operating System
This package requires one of the following operating systems:
• None
4. Third Party Software
This third party software is required to use this package:
• None.

5
Chapter 3. Installation
The following instructions explain how to install the package.
After having successfully completed the installation, please follow the instructions provided
in the chapter "First steps".
1. Admin Interface
Please use the following URL to install the package utilizing the Admin Interface (please note
that you need to be in the "admin" group).
http://localhost/otrs/index.pl?Action=AdminPackageManager
2. Command Line
Whenever you cannot use the Admin Interface for whatever reason, you may use the follow-
ing command line tool ("bin/otrs.PackageManager.pl") instead.
shell> bin/otrs.PackageManager.pl -a install -p /path/to/FAQ-4.0.1.opm

6
Chapter 4. Configuration
1. General
The package can be configured via the SysConfig in the Admin Interface. The following con-
figuration options are available:
1.1. CustomerFrontend::HeaderMetaModule###3-FAQSearch.
Group: FAQ, Subgroup: Frontend::Customer::ModuleMetaHead.
Module to generate HTML OpenSearch profile for short faq search in the customer interface.
1.2. CustomerFrontend::Module###CustomerFAQExplorer.
Group: FAQ, Subgroup: Frontend::Customer::ModuleRegistration.
Frontend module registration for the customer interface.
1.3. CustomerFrontend::Module###CustomerFAQPrint.
1.4. CustomerFrontend::Module###CustomerFAQSearch.
1.5. CustomerFrontend::Module###CustomerFAQZoom.
1.6. DashboardBackend###0398-FAQ-LastChange.
Group: FAQ, Subgroup: Frontend::Agent::Dashboard.
Defines the parameters for the dashboard backend. "Limit" defines the number of en-
tries displayed by default. "Group" is used to restrict access to the plugin (e. g. Group:
admin;group1;group2;). "Default" indicates if the plugin is enabled by default or if the user
needs to enable it manually. "CacheTTL" indicates the cache expiration period in minutes
for the plugin.
1.7. DashboardBackend###0399-FAQ-LastCreate.
Group: FAQ, Subgroup: Frontend::Agent::Dashboard.
Defines the parameters for the dashboard backend. "Limit" defines the number of en-
tries displayed by default. "Group" is used to restrict access to the plugin (e. g. Group:
admin;group1;group2;). "Default" indicates if the plugin is enabled by default or if the user
needs to enable it manually. "CacheTTL" indicates the cache expiration period in minutes
for the plugin.
1.8. DynamicFields::ObjectType###FAQ.
Group: FAQ, Subgroup: DynamicFields::ObjectType::Registration.

7
DynamicField object registration.
1.9. FAQ::Agent::StateTypes.
Group: FAQ, Subgroup: Interface.
List of state types which can be used in the agent interface.
1.10. FAQ::ApprovalGroup.
Group: FAQ, Subgroup: Core::Approval.
Group for the approval of FAQ articles.
1.11. FAQ::ApprovalQueue.
Queue for the approval of FAQ articles.
1.12. FAQ::ApprovalRequired.
New FAQ articles need approval before they get published.
1.13. FAQ::ApprovalTicketBody.
Ticket body for approval of FAQ article.
1.14. FAQ::ApprovalTicketDefaultState.
Default state of tickets for the approval of FAQ articles.
1.15. FAQ::ApprovalTicketPriority.
Default priority of tickets for the approval of FAQ articles.
1.16. FAQ::ApprovalTicketSubject.
Ticket subject for approval of FAQ article.
1.17. FAQ::ApprovalTicketType.
Default type of tickets for the approval of FAQ articles.
1.18. FAQ::CacheTTL.
Group: FAQ, Subgroup: Core.
Cache Time To Leave for FAQ items.

8
1.19. FAQ::Customer::StateTypes.
List of state types which can be used in the customer interface.
1.20. FAQ::Default::Language.
Default language for FAQ articles on single language mode.
1.21. FAQ::Default::RootCategoryComment.
Default category name.
1.22. FAQ::Default::RootCategoryName.
Default category name.
1.23. FAQ::Default::State.
Default state for FAQ entry.
1.24. FAQ::Explorer::ItemList::VotingResultColors.
Group: FAQ, Subgroup: Core::Explorer.
CSS color for the voting result.
1.25. FAQ::Explorer::ItemList::VotingResultDecimalPlaces.
Decimal places of the voting result.
1.26. FAQ::Explorer::LastChange::Limit.
Number of shown items in last changes.
1.27. FAQ::Explorer::LastChange::Show.
Show last change items in defined interfaces.
1.28. FAQ::Explorer::LastChange::ShowSubCategoryItems.
Show items of subcategories.
1.29. FAQ::Explorer::LastCreate::Limit.

9
Number of shown items in last created.
1.30. FAQ::Explorer::LastCreate::Show.
Show last created items in defined interfaces.
1.31. FAQ::Explorer::LastCreate::ShowSubCategoryItems.
1.32. FAQ::Explorer::Path::Separator.
FAQ path separator.
1.33. FAQ::Explorer::Path::Show.
Show FAQ path yes/no.
1.34. FAQ::Explorer::QuickSearch::Show.
Interfaces where the quick search should be shown.
1.35. FAQ::Explorer::Top10::Limit.
Number of shown items in the top 10 feature.
1.36. FAQ::Explorer::Top10::Show.
Show top 10 items in defined interfaces.
1.37. FAQ::Explorer::Top10::ShowSubCategoryItems.
1.38. FAQ::FAQHook.
The identifier for a FAQ, e.g. FAQ#, KB#, MyFAQ#. The default is FAQ#.
1.39. FAQ::Frontend::AgentFAQAdd###DynamicField.
Group: FAQ, Subgroup: Frontend::Agent::FAQ::ViewAdd.
Dynamic fields shown in the FAQ add screen of the agent interface. Possible settings: 0 =
Disabled, 1 = Enabled, 2 = Enabled and required.

10
1.40. FAQ::Frontend::AgentFAQAdd###RichTextHeight.
Defines the height for the rich text editor component for this screen. Enter number (pixels)
or percent value (relative).
1.41. FAQ::Frontend::AgentFAQAdd###RichTextWidth.
Defines the width for the rich text editor component for this screen. Enter number (pixels)
1.42. FAQ::Frontend::AgentFAQEdit###DynamicField.
Group: FAQ, Subgroup: Frontend::Agent::FAQ::ViewEdit.
Dynamic fields shown in the FAQ edit screen of the agent interface. Possible settings: 0 =
Disabled, 1 = Enabled, 2 = Enabled and required.
1.43. FAQ::Frontend::AgentFAQEdit###RichTextHeight.
Defines the height for the rich text editor component for this screen. Enter number (pixels)
1.44. FAQ::Frontend::AgentFAQEdit###RichTextWidth.
Defines the width for the rich text editor component for this screen. Enter number (pixels)
1.45. FAQ::Frontend::AgentFAQExplorer###Order::Default.
Group: FAQ, Subgroup: Frontend::Agent::FAQ::ViewExplorer.
Defines the default FAQ order in the FAQ Explorer result of the agent interface. Up: oldest
on top. Down: latest on top.
1.46. FAQ::Frontend::AgentFAQExplorer###SearchLimit.
Maximum number of FAQ articles to be displayed in the FAQ Explorer result of the agent
interface.
1.47. FAQ::Frontend::AgentFAQExplorer###ShowColumns.
Defines the shown columns in the FAQ Explorer. This option has no effect on the position of
the column.
1.48. FAQ::Frontend::AgentFAQExplorer###SortBy::Default.
Defines the default FAQ attribute for FAQ sorting in the FAQ Explorer of the agent interface.

11
1.49. FAQ::Frontend::AgentFAQJournal###JournalLimit.
Group: FAQ, Subgroup: Frontend::Agent::FAQ::ViewJournal.
Maximum number of FAQ articles to be displayed in the FAQ journal in the agent interface.
1.50. FAQ::Frontend::AgentFAQJournal###ShowColumns.
Group: FAQ, Subgroup: Frontend::Agent::FAQ::ViewJournal.
Defines the shown columns in the FAQ journal. This option has no effect on the position of
the column.
1.51. FAQ::Frontend::AgentFAQPrint###DynamicField.
Group: FAQ, Subgroup: Frontend::Agent::FAQ::ViewPrint.
Dynamic fields shown in the FAQ print screen of the agent interface. Possible settings: 0 =
Disabled, 1 = Enabled.
1.52. FAQ::Frontend::AgentFAQSearch###Defaults###ApprovedSearch.
Group: FAQ, Subgroup: Frontend::Agent::FAQ::ViewSearch.
Defines the default shown FAQ search attribute for FAQ search screen.
1.53. FAQ::Frontend::AgentFAQSearch###Defaults###CategoryIDs.
1.54. FAQ::Frontend::AgentFAQSearch###Defaults###CreatedUserIDs.
1.55. FAQ::Frontend::AgentFAQSearch###Defaults###Fulltext.
1.56. FAQ::Frontend::AgentFAQSearch###Defaults###ItemChangeTimePoint.
1.57. FAQ::Frontend::AgentFAQSearch###Defaults###ItemChangeTimeSlot.
1.58. FAQ::Frontend::AgentFAQSearch###Defaults###ItemCreateTimePoint.

12
1.59. FAQ::Frontend::AgentFAQSearch###Defaults###ItemCreateTimeSlot.
1.60. FAQ::Frontend::AgentFAQSearch###Defaults###Keyword.
1.61. FAQ::Frontend::AgentFAQSearch###Defaults###LanguageIDs.
1.62. FAQ::Frontend::AgentFAQSearch###Defaults###LastChangedUserIDs.
1.63. FAQ::Frontend::AgentFAQSearch###Defaults###Number.
1.64. FAQ::Frontend::AgentFAQSearch###Defaults###RateSearchType.
1.65. FAQ::Frontend::AgentFAQSearch###Defaults###StateIDs.
1.66. FAQ::Frontend::AgentFAQSearch###Defaults###Title.
1.67. FAQ::Frontend::AgentFAQSearch###Defaults###ValidIDs.
1.68. FAQ::Frontend::AgentFAQSearch###Defaults###VoteSearchType.
1.69. FAQ::Frontend::AgentFAQSearch###DynamicField.

13
Dynamic fields shown in the FAQ search screen of the agent interface. Possible settings: 0 =
Disabled, 1 = Enabled, 2 = Enabled and shown by default.
1.70. FAQ::Frontend::AgentFAQSearch###Order::Default.
Defines the default FAQ order of a search result in the agent interface. Up: oldest on top.
Down: latest on top.
1.71. FAQ::Frontend::AgentFAQSearch###SearchCSVDynamicField.
Dynamic Fields used to export the search result in CSV format.
1.72. FAQ::Frontend::AgentFAQSearch###SearchLimit.
Maximum number of FAQ articles to be displayed in the result of a search in the agent in-
terface.
1.73. FAQ::Frontend::AgentFAQSearch###ShowColumns.
Defines the shown columns in the FAQ search. This option has no effect on the position of
the column.
1.74. FAQ::Frontend::AgentFAQSearch###SortBy::Default.
Defines the default FAQ attribute for FAQ sorting in a FAQ search of the agent interface.
1.75. FAQ::Frontend::AgentFAQZoom###DynamicField.
Group: FAQ, Subgroup: Frontend::Agent::FAQ::ViewZoom.
Dynamic fields shown in the FAQ zoom screen of the agent interface. Possible settings: 0 =
1.76. FAQ::Frontend::AgentHTMLFieldHeightDefault.
Set the default height (in pixels) of inline HTML fields in AgentFAQZoom.
1.77. FAQ::Frontend::AgentHTMLFieldHeightMax.
Set the maximum height (in pixels) of inline HTML fields in AgentFAQZoom.
1.78. FAQ::Frontend::CustomerFAQExplorer###Order::Default.
Group: FAQ, Subgroup: Frontend::Customer::FAQ::ViewExplorer.
Defines the default FAQ order in the FAQ Explorer result of the customer interface. Up: oldest

14
1.79. FAQ::Frontend::CustomerFAQExplorer###SearchLimit.
Maximum number of FAQ articles to be displayed in the FAQ Explorer result of the customer
interface.
1.80. FAQ::Frontend::CustomerFAQExplorer###SearchPageShown.
Number of FAQ articles to be displayed in the FAQ Explorer of the customer interface.
1.81. FAQ::Frontend::CustomerFAQExplorer###SortBy::Default.
Defines the default FAQ attribute for FAQ sorting in the FAQ Explorer of the customer interface.
1.82. FAQ::Frontend::CustomerFAQOverview###DynamicField.
Group: FAQ, Subgroup: Frontend::Customer::FAQOverview.
Dynamic fields shown in the FAQ overview screen of the customer interface. Possible settings:
0 = Disabled, 1 = Enabled, 2 = Enabled and required.
1.83. FAQ::Frontend::CustomerFAQPrint###DynamicField.
Group: FAQ, Subgroup: Frontend::Customer::FAQ::ViewPrint.
Dynamic fields shown in the FAQ print screen of the customer interface. Possible settings:
0 = Disabled, 1 = Enabled.
1.84. FAQ::Frontend::CustomerFAQSearch###DynamicField.
Group: FAQ, Subgroup: Frontend::Customer::FAQ::ViewSearch.
Dynamic fields shown in the FAQ search screen of the customer interface. Possible settings:
0 = Disabled, 1 = Enabled, 2 = Enabled and shown by default.
1.85. FAQ::Frontend::CustomerFAQSearch###Order::Default.
Defines the default FAQ order of a search result in the customer interface. Up: oldest on top.
1.86. FAQ::Frontend::CustomerFAQSearch###SearchCSVDynamicField.
1.87. FAQ::Frontend::CustomerFAQSearch###SearchLimit.
Maximum number of FAQ articles to be displayed in the result of a search in the customer
interface.
1.88. FAQ::Frontend::CustomerFAQSearch###SearchPageShown.

15
Number of FAQ articles to be displayed on each page of a search result in the customer
interface.
1.89. FAQ::Frontend::CustomerFAQSearch###SortBy::Default.
Defines the default FAQ attribute for FAQ sorting in a FAQ search of the customer interface.
1.90. FAQ::Frontend::CustomerFAQZoom###DynamicField.
Group: FAQ, Subgroup: Frontend::Customer::FAQ::ViewZoom.
Dynamic fields shown in the FAQ zoom screen of the customer interface. Possible settings:
0 = Disabled, 1 = Enabled.
1.91. FAQ::Frontend::CustomerHTMLFieldHeightDefault.
Set the default height (in pixels) of inline HTML fields in CustomerFAQZoom (and PublicFAQ-
Zoom).
1.92. FAQ::Frontend::CustomerHTMLFieldHeightMax.
Set the maximum height (in pixels) of inline HTML fields in CustomerFAQZoom (and Public-
FAQZoom).
1.93. FAQ::Frontend::JournalOverview###Small.
Group: FAQ, Subgroup: Frontend::Agent::FAQJournalOverview.
Defines an overview module to show the small view of a FAQ journal.
1.94. FAQ::Frontend::MenuModule###000-Back.
Group: FAQ, Subgroup: Frontend::Agent::FAQ::MenuModule.
Shows a link in the menu to go back in the FAQ zoom view of the agent interface.
1.95. FAQ::Frontend::MenuModule###010-Edit.
Shows a link in the menu to edit a FAQ in the its zoom view of the agent interface.
1.96. FAQ::Frontend::MenuModule###020-History.
Shows a link in the menu to access the history of a FAQ in its zoom view of the agent interface.
1.97. FAQ::Frontend::MenuModule###030-Print.
Shows a link in the menu to print a FAQ in the its zoom view of the agent interface.
1.98. FAQ::Frontend::MenuModule###040-Link.

16
Shows a link in the menu that allows linking a FAQ with another object in the zoom view of
such FAQ of the agent interface.
1.99. FAQ::Frontend::MenuModule###050-Delete.
Shows a link in the menu that allows to delete a FAQ in its zoom view in the agent interface.
1.100. FAQ::Frontend::Overview###Small.
Group: FAQ, Subgroup: Frontend::Agent::FAQOverview.
Defines an overview module to show the small view of a FAQ list.
1.101. FAQ::Frontend::OverviewSmall###DynamicField.
Group: FAQ, Subgroup: Frontend::Agent::FAQOverview.
Dynamic fields shown in the FAQ small format overview screen of the agent interface. Possible
settings: 0 = Disabled, 1 = Enabled.
1.102. FAQ::Frontend::PublicFAQExplorer###Order::Default.
Group: FAQ, Subgroup: Frontend::Public::FAQ::ViewExplorer.
Defines the default FAQ order in the FAQ Explorer result of the public interface. Up: oldest
1.103. FAQ::Frontend::PublicFAQExplorer###SearchLimit.
Maximum number of FAQ articles to be displayed in the FAQ Explorer result of the public
interface.
1.104. FAQ::Frontend::PublicFAQExplorer###SearchPageShown.
Number of FAQ articles to be displayed in the FAQ Explorer of the public interface.
1.105. FAQ::Frontend::PublicFAQExplorer###SortBy::Default.
Defines the default FAQ attribute for FAQ sorting in the FAQ Explorer of the public interface.
1.106. FAQ::Frontend::PublicFAQOverview###DynamicField.
Group: FAQ, Subgroup: Frontend::Public::FAQOverview.
Dynamic fields shown in the FAQ overview screen of the public interface. Possible settings:
0 = Disabled, 1 = Enabled, 2 = Enabled and required.
1.107. FAQ::Frontend::PublicFAQPrint###DynamicField.
Group: FAQ, Subgroup: Frontend::Public::FAQ::ViewPrint.
Dynamic fields shown in the FAQ print screen of the public interface. Possible settings: 0 =

17
1.108. FAQ::Frontend::PublicFAQSearch###DynamicField.
Group: FAQ, Subgroup: Frontend::Public::FAQ::ViewSearch.
Dynamic fields shown in the FAQ search screen of the public interface. Possible settings: 0 =
Disabled, 1 = Enabled, 2 = Enabled and shown by default.
1.109. FAQ::Frontend::PublicFAQSearch###Order::Default.
Defines the default FAQ order of a search result in the public interface. Up: oldest on top.
1.110. FAQ::Frontend::PublicFAQSearch###SearchCSVDynamicField.
1.111. FAQ::Frontend::PublicFAQSearch###SearchLimit.
Maximum number of FAQ articles to be displayed in the result of a search in the public in-
terface.
1.112. FAQ::Frontend::PublicFAQSearch###SearchPageShown.
Group: FAQ, Subgroup: Frontend::Public::ViewFAQSearch.
Number of FAQ articles to be displayed on each page of a search result in the public interface.
1.113. FAQ::Frontend::PublicFAQSearch###SortBy::Default.
Defines the default FAQ attribute for FAQ sorting in a FAQ search of the public interface.
1.114. FAQ::Frontend::PublicFAQZoom###DynamicField.
Group: FAQ, Subgroup: Frontend::Public::FAQ::ViewZoom.
Dynamic fields shown in the FAQ zoom screen of the public interface. Possible settings: 0 =
1.115. FAQ::Item::Field1.
Group: FAQ, Subgroup: Core::Item.
Definition of FAQ item free text field.

18
1.121. FAQ::Item::HTML.
Show FAQ Article with HTML.
1.122. FAQ::Item::Voting::Rates.
Group: FAQ, Subgroup: Core::Item::Voting.
Rates for voting. Key must be in percent.
1.123. FAQ::Item::Voting::Show.
Group: FAQ, Subgroup: Core::Item::Voting.
Show voting in defined interfaces.
1.124. FAQ::MultiLanguage.
Enable multiple languages on FAQ module.
1.125. FAQ::Public::StateTypes.
List of state types which can be used in the public interface.
1.126. FAQ::TicketCompose###IncludeInternal.
Group: FAQ, Subgroup: Core::TicketCompose.
Include internal fields on a FAQ based Ticket.
1.127. FAQ::TicketCompose###InsertMethod.
Defines the information to be inserted in a FAQ based Ticket. "Full FAQ" includes text, attach-
ments and inline images.

19
1.128. FAQ::TicketCompose###ShowFieldNames.
Include the name of each field in a FAQ based Ticket.
1.129. FAQ::TicketCompose###ShowInsertLinkButton.
Show "Insert FAQ Link" Button in AgentFAQZoomSmall for public FAQ Articles.
1.130. FAQ::TicketCompose###ShowInsertTextAndLinkButton.
Show "Insert FAQ Text & Link" / "Insert Full FAQ & Link" Button in AgentFAQZoomSmall for
public FAQ Articles.
1.131. FAQ::TicketCompose###ShowInsertTextButton.
Show "Insert FAQ Text" / "Insert Full FAQ" Button in AgentFAQZoomSmall.
1.132. FAQ::TicketCompose###UpdateArticleSubject.
Define if the FAQ title should be concatenated to article subject.
1.133. FAQ::Voting.
Enable voting mechanism on FAQ module.
1.134. Frontend::HeaderMetaModule###3-FAQSearch.
Group: FAQ, Subgroup: Frontend::Agent::ModuleMetaHead.
Module to generate html OpenSearch profile for short faq search.
1.135. Frontend::Module###AgentFAQAdd.
Group: FAQ, Subgroup: Frontend::Agent::ModuleRegistration.
Frontend module registration for the agent interface.
1.136. Frontend::Module###AgentFAQCategory.
1.137. Frontend::Module###AgentFAQDelete.
1.138. Frontend::Module###AgentFAQEdit.

20
1.139. Frontend::Module###AgentFAQExplorer.
1.140. Frontend::Module###AgentFAQHistory.
1.141. Frontend::Module###AgentFAQJournal.
1.142. Frontend::Module###AgentFAQLanguage.
1.143. Frontend::Module###AgentFAQPrint.
1.144. Frontend::Module###AgentFAQRichText.
1.145. Frontend::Module###AgentFAQSearch.
1.146. Frontend::Module###AgentFAQSearchSmall.
1.147. Frontend::Module###AgentFAQZoom.
1.148. Frontend::Output::FilterElementPost###FAQ.
Group: FAQ, Subgroup: Frontend::Agent.
Defines where the 'Insert FAQ' link will be displayed. Note: AgentTicketActionCom-
mon includes AgentTicketNote, AgentTicketClose, AgentTicketFreeText, AgentTicketOwner,
AgentTicketPending, AgentTicketPriority and AgentTicketResponsible.

21
1.149. Frontend::Output::OutputFilterTextAutoLink###FAQ.
Group: Framework, Subgroup: Core::Web.
A filter for HTML output to add links behind a defined string. The element Image allows two
input kinds. First the name of an image (e.g. faq.png). In this case the OTRS image path will
be used. The second possibility is to insert the link to the image.
1.150. Frontend::Search###FAQ.
Group: FAQ, Subgroup: Frontend::Agent::SearchRouter.
FAQ search backend router of the agent interface.
1.151. Frontend::ToolBarModule###90-FAQ::AgentFAQAdd.
Group: FAQ, Subgroup: Frontend::Agent::ToolBarModule.
Toolbar Item for a shortcut.
1.152. GenericInterface::Operation::Module###FAQ::LanguageList.
Group: GenericInterface, Subgroup: GenericInterface::Operation::ModuleRegistration.
GenericInterface module registration for the operation layer.
1.153. GenericInterface::Operation::Module###FAQ::PublicCategoryList.
1.154. GenericInterface::Operation::Module###FAQ::PublicFAQGet.
1.155. GenericInterface::Operation::Module###FAQ::PublicFAQSearch.
1.156. LinkObject::PossibleLink###8301.
Group: Framework, Subgroup: Core::LinkObject.
This setting defines that a 'FAQ' object can be linked with other 'FAQ' objects using the 'Nor-
mal' link type.
This setting defines that a 'FAQ' object can be linked with other 'FAQ' objects using the 'Par-
entChild' link type.

22
This setting defines that a 'FAQ' object can be linked with other 'Ticket' objects using the
'Normal' link type.
This setting defines that a 'FAQ' object can be linked with other 'Ticket' objects using the
'ParentChild' link type.
1.160. Loader::Agent::CommonCSS###200-FAQ.
List of CSS files to always be loaded for the agent interface.
1.161. Loader::Agent::CommonJS###200-FAQ.
List of JS files to always be loaded for the agent interface.
1.162. PreferencesGroups###FAQJournalOverviewSmallPageShown.
Group: FAQ, Subgroup: Frontend::Agent::Preferences.
Parameters for the pages (in which the FAQ items are shown) of the small FAQ journal
overview.
1.163. PreferencesGroups###FAQOverviewSmallPageShown.
Group: FAQ, Subgroup: Frontend::Agent::Preferences.
Parameters for the pages (in which the FAQ items are shown) of the small FAQ overview.
1.164. PublicFrontend::CommonParam###Action.
Group: FAQ, Subgroup: Frontend::Public.
Default value for the Action parameter for the public frontend. The Action parameter is used
in the scripts of the system.
1.165. PublicFrontend::HeaderMetaModule###3-FAQSearch.
Group: FAQ, Subgroup: Frontend::Public::ModuleMetaHead.
Module to generate HTML OpenSearch profile for short FAQ search in the public interface.
1.166. PublicFrontend::Module###PublicFAQ.
Group: FAQ, Subgroup: Frontend::Public::ModuleRegistration.
Frontend module registration for the public interface.
1.167. PublicFrontend::Module###PublicFAQExplorer.
1.168. PublicFrontend::Module###PublicFAQPrint.

23
1.169. PublicFrontend::Module###PublicFAQRSS.
1.170. PublicFrontend::Module###PublicFAQSearch.
1.171. PublicFrontend::Module###PublicFAQZoom.
2. Approval function
The OTRS FAQ has an approval feature. If you activate the approval feature all newly created
FAQs also create a new ticket in a predefined queue. The persons who need to approve the
FAQ entries can then act on these tickets and approve the FAQ articles if they see fit. As long
as the article has not been approved the article will not be visible in the public interface.
You can activate the Approval function by setting the option FAQ::ApprovalRequired to Yes.
The approval message can be defined under FAQ::ApprovalTicketBody. You can modify the
text if you need, and you can also use variables that will be substituted with their actual
values when the approval note is generated. The list of the available variables is listed below.
Table 4.1. Variables for FAQ Approval message
Name Description
<OTRS_FAQ_CATEGORY> Category name of the FAQ article
<OTRS_FAQ_CATEGORYID> Category ID of the FAQ article
<OTRS_FAQ_LANGUAGE> Language of the FAQ article
<OTRS_FAQ_ITEMID> Item ID of the FAQ article
<OTRS_FAQ_NUMBER> FAQ Number of the FAQ article
<OTRS_FAQ_TITLE> Title
<OTRS_FAQ_AUTHOR> Author name
<OTRS_FAQ_STATE> State (visibility) of the FAQ article

24
Chapter 5. Usage
This package adds tree new groups to the system:
• faq.
Users in this group are able to:
• Use FAQ Explorer.
• Add, Edit, Delete, Zoom, Print and Link FAQ Articles.
• Use FAQ Journal.
• Use FAQ Search.
• faq_admin.
• Add, Edit and Delete FAQ Categories.
• Add, Edit and Delete FAQ Languages.
• faq_approval.
• Approve FAQ Articles.
Note
The group to approve FAQ Articles can be changed using SysConfig.
Users in "faq_admin" and "faq_approval" groups (or custom approval group) need also to be
in the "faq" group to perform the actions. Any change in the users groups will take effect on
FAQ after the user logout and login again.
Users that are members of the "faq" group will have a new menu called "FAQ" in the naviga-
tion bar that is in the top of the screen (after re-login), similar to the "Ticket" menu.
1. Create A New FAQ Article
This example shows how to create a new FAQ article.
Note
Be sure that the logged user is a member of "faq" group.
1. From the Navigation Bar, click on "FAQ" and then on "New" (from the opened FAQ menu
option).
2. Fill the required information.
There are tree possible FAQ states: "internal": only agents can see the FAQ article, "exter-
nal": agents and registered customer can see the FAQ article and "public": this FAQ articles
are accessible from the OTRS public interface.

25
By default the system has the Category "Misc" and the Languages "en" for English and
"de" for German. (more Categories and Languages can be added to the system).
On a clean system there are four multiple line fields (with other two more than can be
added if needed), their names an visibility can be changed in the SysConfig.
3. Click on the "Create" button.
This will create a new FAQ article that can be accessed from the FAQ Explorer
Note
By default the FAQ article does not need an approval procedure, if this functionality
is enabled and the user is also a member of the FAQ Approval group, a selection to
set the approval state is also shown in this screen.
2. Create a New Category
This example shows how to create a new FAQ category.
Note
Be sure that the logged user is a member of "faq" and "faq_admin" groups.
1. From FAQ menu click on "Category Management".
A list of available categories is shown (from there is also possible to edit or delete them)
2. Click on "Add Category" from the Actions side bar.
Notice that a category can be a sub item from a wider category, this is helpful to organize
FAQ articles in a hierarchical way (this hierarchies can be drilled drown from the FAQ Ex-
plorer).
4. Click on "Submit" button, and the new category will be ready to use.
3. Create a New Language
This example shows how to create a new FAQ language.
Note
Be sure that the logged user is a member of "faq" and "faq_admin" groups.
1. From FAQ menu click on "Language Management".
A list of available languages is shown (from there is also possible to edit or delete them)
2. Click on "Add Language" from the Actions side bar.
4. Click on "Submit" button, and the new language will be ready to use.

26
Chapter 6. File List
This list shows all included files and the referring permissions.
• (755) bin/otrs.FAQImport.pl
• (755) bin/cgi-bin/faq.pl
• (755) bin/fcgi-bin/faq.fpl
• (644) doc/faq-database.png
• (644) Kernel/Config/Files/FAQ.xml
• (644) Kernel/cpan-lib/XML/RSS/SimpleGen.pm
• (644) Kernel/Language/da_FAQ.pm
• (644) Kernel/Language/de_FAQ.pm
• (644) Kernel/Language/es_FAQ.pm
• (644) Kernel/Language/es_MX_FAQ.pm
• (644) Kernel/Language/fa_FAQ.pm
• (644) Kernel/Language/fi_FAQ.pm
• (644) Kernel/Language/fr_FAQ.pm
• (644) Kernel/Language/hu_FAQ.pm
• (644) Kernel/Language/it_FAQ.pm
• (644) Kernel/Language/ja_FAQ.pm
• (644) Kernel/Language/ms_FAQ.pm
• (644) Kernel/Language/nb_NO_FAQ.pm
• (644) Kernel/Language/nl_FAQ.pm
• (644) Kernel/Language/pl_FAQ.pm
• (644) Kernel/Language/pt_BR_FAQ.pm
• (644) Kernel/Language/pt_PT_FAQ.pm
• (644) Kernel/Language/ru_FAQ.pm
• (644) Kernel/Language/sr_Cyrl_FAQ.pm
• (644) Kernel/Language/sv_FAQ.pm
• (644) Kernel/Language/sw_FAQ.pm
• (644) Kernel/Language/uk_FAQ.pm

27
• (644) Kernel/Language/zh_CN_FAQ.pm
• (644) Kernel/Modules/AgentFAQAdd.pm
• (644) Kernel/Modules/AgentFAQCategory.pm
• (644) Kernel/Modules/AgentFAQDelete.pm
• (644) Kernel/Modules/AgentFAQEdit.pm
• (644) Kernel/Modules/AgentFAQExplorer.pm
• (644) Kernel/Modules/AgentFAQHistory.pm
• (644) Kernel/Modules/AgentFAQJournal.pm
• (644) Kernel/Modules/AgentFAQLanguage.pm
• (644) Kernel/Modules/AgentFAQPrint.pm
• (644) Kernel/Modules/AgentFAQRichText.pm
• (644) Kernel/Modules/AgentFAQSearch.pm
• (644) Kernel/Modules/AgentFAQSearchSmall.pm
• (644) Kernel/Modules/AgentFAQZoom.pm
• (644) Kernel/Modules/CustomerFAQExplorer.pm
• (644) Kernel/Modules/CustomerFAQPrint.pm
• (644) Kernel/Modules/CustomerFAQSearch.pm
• (644) Kernel/Modules/CustomerFAQZoom.pm
• (644) Kernel/Modules/PublicFAQ.pm
• (644) Kernel/Modules/PublicFAQExplorer.pm
• (644) Kernel/Modules/PublicFAQPrint.pm
• (644) Kernel/Modules/PublicFAQRSS.pm
• (644) Kernel/Modules/PublicFAQSearch.pm
• (644) Kernel/Modules/PublicFAQZoom.pm
• (644) Kernel/Output/HTML/CustomerHeaderMetaFAQSearch.pm
• (644) Kernel/Output/HTML/DashboardFAQ.pm
• (644) Kernel/Output/HTML/FAQJournalOverviewSmall.pm
• (644) Kernel/Output/HTML/FAQMenuGeneric.pm
• (644) Kernel/Output/HTML/FAQOverviewSmall.pm
• (644) Kernel/Output/HTML/HeaderMetaFAQSearch.pm

28
• (644) Kernel/Output/HTML/LayoutFAQ.pm
• (644) Kernel/Output/HTML/LinkObjectFAQ.pm
• (644) Kernel/Output/HTML/OutputFilterFAQ.pm
• (644) Kernel/Output/HTML/PublicHeaderMetaFAQSearch.pm
• (644) Kernel/Output/HTML/Standard/AAAFAQ.tt
• (644) Kernel/Output/HTML/Standard/AgentFAQAdd.tt
• (644) Kernel/Output/HTML/Standard/AgentDashboardFAQOverview.tt
• (644) Kernel/Output/HTML/Standard/AgentFAQCategory.tt
• (644) Kernel/Output/HTML/Standard/AgentFAQDelete.tt
• (644) Kernel/Output/HTML/Standard/AgentFAQEdit.tt
• (644) Kernel/Output/HTML/Standard/AgentFAQExplorer.tt
• (644) Kernel/Output/HTML/Standard/AgentFAQHistory.tt
• (644) Kernel/Output/HTML/Standard/AgentFAQJournalOverviewSmall.tt
• (644) Kernel/Output/HTML/Standard/AgentFAQLanguage.tt
• (644) Kernel/Output/HTML/Standard/AgentFAQLanguage.tt
• (644) Kernel/Output/HTML/Standard/AgentFAQOverviewNavBar.tt
• (644) Kernel/Output/HTML/Standard/AgentFAQOverviewSmall.tt
• (644) Kernel/Output/HTML/Standard/AgentFAQPrint.tt
• (644) Kernel/Output/HTML/Standard/AgentFAQSearch.tt
• (644) Kernel/Output/HTML/Stan-
dard/AgentFAQSearchOpenSearchDescriptionFAQNumber.tt
• (644) Kernel/Output/HTML/Standard/AgentFAQSearchOpenSearchDescriptionFulltext.tt
• (644) Kernel/Output/HTML/Standard/AgentFAQSearchResultPrint.tt
• (644) Kernel/Output/HTML/Standard/AgentFAQSearchSmall.tt
• (644) Kernel/Output/HTML/Standard/AgentFAQZoom.tt
• (644) Kernel/Output/HTML/Standard/AgentFAQZoomSmall.tt
• (644) Kernel/Output/HTML/Standard/CustomerFAQExplorer.tt
• (644) Kernel/Output/HTML/Standard/CustomerFAQPrint.tt
• (644) Kernel/Output/HTML/Standard/CustomerFAQSearch.tt
dard/CustomerFAQSearchOpenSearchDescriptionFAQNumber.tt

29
dard/CustomerFAQSearchOpenSearchDescriptionFullText.tt
• (644) Kernel/Output/HTML/Standard/CustomerFAQSearchResultPrint.tt
• (644) Kernel/Output/HTML/Standard/CustomerFAQSearchResultShort.tt
• (644) Kernel/Output/HTML/Standard/CustomerFAQZoom.tt
• (644) Kernel/Output/HTML/Standard/PublicFAQExplorer.tt
• (644) Kernel/Output/HTML/Standard/PublicFAQPrint.tt
• (644) Kernel/Output/HTML/Standard/PublicFAQSearch.tt
dard/PublicFAQSearchOpenSearchDescriptionFAQNumber.tt
• (644) Kernel/Output/HTML/Standard/PublicFAQSearchOpenSearchDescriptionFullText.tt
• (644) Kernel/Output/HTML/Standard/PublicFAQSearchResultPrint.tt
• (644) Kernel/Output/HTML/Standard/PublicFAQSearchResultShort.tt
• (644) Kernel/Output/HTML/Standard/PublicFAQZoom.tt
• (644) Kernel/System/DynamicField/ObjectType/FAQ.pm
• (644) Kernel/System/FAQ/Category.pm
• (644) Kernel/System/FAQ/Language.pm
• (644) Kernel/System/FAQ/State.pm
• (644) Kernel/System/FAQ/Vote.pm
• (644) Kernel/System/FAQ.pm
• (644) Kernel/System/FAQSearch.pm
• (644) Kernel/System/LinkObject/FAQ.pm
• (644) Kernel/System/Stats/Static/FAQAccess.pm
• (644) scripts/test/FAQ.t
• (644) scripts/test/FAQSearch.t
• (644) scripts/test/sample/FAQ-Test1.doc
• (644) scripts/test/sample/FAQ-Test1.pdf
• (644) var/httpd/htdocs/js/FAQ.Agent.ConfirmationDialog.js
• (644) var/httpd/htdocs/js/FAQ.Agent.FAQZoom.js
• (644) var/httpd/htdocs/js/FAQ.Agent.TicketCompose.js
• (644) var/httpd/htdocs/js/FAQ.Customer.FAQZoom.js

30
• (644) var/httpd/htdocs/skins/Agent/default/css/FAQ.Agent.Default.css
• (644) var/httpd/htdocs/skins/Agent/default/css/FAQ.Agent.Detail.css
• (644) var/httpd/htdocs/skins/Agent/default/img/help-small.png
• (644) var/httpd/htdocs/skins/Customer/default/css/FAQ.Customer.Default.css
• (644) var/httpd/htdocs/skins/Customer/default/css/FAQ.Customer.Detail.css
• (644) var/httpd/htdocs/skins/Customer/default/css/FAQ.Widget.css
• (644) var/httpd/htdocs/skins/Customer/default/css/FAQ.FAQZoom.css
• (644) var/packagesetup/FAQ.pm
• (644) var/stats/FAQ-FAQAccess.xml
• (644) Kernel/GenericInterface/Operation/FAQ/PublicCategoryList.pm
• (644) Kernel/GenericInterface/Operation/FAQ/LanguageList.pm
• (644) Kernel/GenericInterface/Operation/FAQ/PublicFAQSearch.pm
• (644) Kernel/GenericInterface/Operation/FAQ/PublicFAQGet.pm
• (644) scripts/webservices/GenericFAQConnector.yaml
• (644) scripts/test/GenericInterface/FAQConnector.t
• (644) scripts/test/sample/GenericInterface/FAQ/GI-FAQ-Test-utf8-1.bin
• (644) scripts/test/sample/GenericInterface/FAQ/GI-FAQ-Test-utf8-1.txt

31
Chapter 7. Tests
This module has been tested on the current state of the art in quality.
1. Test Cases
To test this package please follow the examples described in the Usage section, all the tests
cases should return the expected results defined at the beginning of each example.
2. Unit Tests
To ensure the quality of the module, several so-called unit tests were created, to test the
functionalities of this module. These unit tests can be run via command line.
ATTENTION: Please never run unit tests on a productive system, since the added test data to
the system will no longer be removed. Always use a test system.
Run the package specific unit tests
To run only the unit test which will be delivered with this package, use the following command
on the command line:
shell> perl bin/otrs.UnitTest.pl -n FAQ:FAQSearch:GenericInterface/FAQConnector
Run all available unit tests
To run all available unit tests, use the following command on the command line:
shell> perl bin/otrs.UnitTest.pl

32
Chapter 8. ChangeLog
4.0.1 / 2014-11-21 03:27:50
• Build for FAQ 4.
3.3.92 / 2014-11-14 02:25:22
• Build for FAQ 4 rc1.
3.3.91 / 2014-09-19 00:18:17
• Build for FAQ 4 beta1.

33
Appendix A. Generic Interface FAQ Connector
Configuration
1. Web Service configuration
In order to use the web service and the operations included on this package, you should first
of all install the web service on your system, using the Command line or taking advantage
of the Graphical User Interface (Admin Interface). Please note that the old configuration for
rpc.pl is not relevant for the Generic Interface and therefore not needed.
The following is an example of how to use Command line to install the web service in the
system using the provided YAML file (.yaml) included on this package.
shell> $OTRS_HOME/bin/otrs.WebserviceConfig.pl -a write -n GenericInterfaceFAQConnector -f
$OTRS_HOME/scripts/webservices/GenericInterfaceFAQConnector.yaml
Also you can install the web service importing the mentioned YAML file via web interface in
the next URL using the 'Import web service' button on the left side bar.
http://localhost/otrs/index.pl?Action=AdminGenericInterfaceWebservice;Subaction=Add
The content of the YAML file is shown below.
---
Debugger:
DebugThreshold: debug
TestMode: 0
Description: ''
Provider:
Operation:
LanguageList:
Description: List all availables languages
Type: FAQ::LanguageList
PublicCategoryList:
Description: List all public FAQ categories (with tree information)
Type: FAQ::PublicCategoryList
PublicFAQSearch:
Description: Search for public FAQs
Type: FAQ::PublicFAQSearch
PublicFAQGet:
Description: Retrieve public FAQ entries
Type: FAQ::PublicFAQGet
Transport:
Config:
Encoding: UTF-8
Endpoint: ''
MaxLength: 10000000
NameSpace: http://www.otrs.org/FAQConnector/
SOAPAction: ''
Type: HTTP::SOAP
RemoteSystem: ''
In order to use the web service you need to use an new interface in OTRS. As for agents
you use index.pl and for customers you use customer.pl, for web services you use "nph-
genericinterface.pl".

34
The default and suggested name for this web service is GenericFAQConnector. Since the
name of the web service can be changed is very important that you write down the current
name of your web service and update it in all locations that access to it.
When a web service is installed on the system it always has an associated ID number. You
can call the web service by name or by ID number. To get the list of "valid" web services and
they corresponding ID number you can use the following command:
shell> $OTRS_HOME/bin/otrs.WebserviceConfig.pl -a list
For this specific web service, using the default configuration you can call it as follows:
http://localhost/otrs/nph-genericinterface.pl/Webservice/GenericFAQConnector (by name,
recommended) or http://localhost/otrs/nph-genericinterface.pl/WebserviceID/1 (by ID).
Note
Both web service name and ID from the example above could be different in your
current environment.

35
Appendix B. Generic Interface FAQ Connector API
For the following examples uses SOAP XML data structures since HTTP::SOAP is the default
transport for Generic Interface Operations and can be used with otrs.SOAPRequest.pl.
otrs.SOAPRequest.pl is a simple Perl script to test the OTRS Generic Interface, the code can
be found in the OTRS administration manual.
1. LanguageList
For this operation is not necessary to send any special parameter to the server, you just need
to request the web service directly indicating the "LanguageList" operation. The operation
will return a list of languages including ID and the Name for each language on the system.
Request format:
<LanguageList/>
Response format:
<LanguageListResponse>

<Language>
<ID>?</ID>
<Name>?</Name>
</Language>
</LanguageListResponse>
Response example:
<LanguageListResponse>
<Language>
<ID>1</ID>
<Name>en</Name>
</Language>
<Language>
<ID>2</ID>
<Name>de</Name>
</Language>
<Language>
<ID>3</ID>
<Name>es</Name>
</Language>
</LanguageListResponse>
2. PubliCategoryList
For this operation is also not necessary any special parameter, just the simple call for re-
questing the web service with the operation name 'PublicCategoryList' as a response you will
receive a list of categories including the ID and the Name (long format) for each category.
Request format:

36
<PublicCategoryList/>
Response format:
<PublicCategoryListResponse>

<Category>
<ID>?</ID>
<Name>?</Name>
</Category>
</PublicCategoryListResponse>
Response example:
<PublicCategoryListResponse>
<Category>
<ID>2</ID>
<Name>Pulbic</Name>
</Category>
<Category>
<ID>5</ID>
<Name>Public::SubCategory A</Name>
</Category>
<Category>
<ID>8</ID>
<Name>Public::SubCategory B</Name>
</Category>
</PublicCategoryListResponse>
3. PublicFAQGet
To be able to get one or more FAQ entries, you should send the ItemID(s) as a parameter for
the FAQ entry you want to get. You will receive the entire FAQ record with all attachments
included. Note that attachment contents will be transferred as base64-encoded strings.
Setting GetAttachmentContents to 0 will prevent to fetch the content of the attachment this
will increase the performance of the operation when the attachment contents are not really
needed.
Request format:
<PublicFAQGet>
<ItemID>?</ItemID>

<GetAttachmentContents>?</GetAttachmentContents>
</PublicFAQGet>
Request example:

37
<PublicFAQGet>
<ItemID>6,7</ItemID>
</PublicFAQGet>
Response format:
<PublicFAQGetResponse>

<FAQItem>
<Approved>?</Approved>
<CategoryID>?</CategoryID>
<CategoryName>?</CategoryName>
<CategoryShortName>?</CategoryShortName>
<Changed>?</Changed>
<ChangedBy>?</ChangedBy>
<Created>?</Created>
<CreatedBy>?</CreatedBy>
<FAQID>?</FAQID>
<Field1>?</Field1>
<Field2>?</Field2>
<Field3>?</Field3>
<Field4>?</Field4>
<Field5>?</Field5>
<Field6>?</Field6>
<ID>?</ID>
<ItemID>?</ItemID>
<Keywords>?</Keywords>
<Language>?</Language>
<LanguageID>?</LanguageID>
<Name>?</Name>
<Number>?</Number>
<State>?</State>
<StateID>?</StateID>
<StateTypeID>?</StateTypeID>
<Title>?</Title>
<VoteResult>?</VoteResult>
<Votes>?</Votes>
<StateTypeName>?</StateTypeName>
<Attachment>
<Filename>?</Filename>
<Filesize>?</Filesize>
<ContentType>?</ContentType>
<Content>cid:1269416154096</Content>
</Attachment>
</FAQItem>
</PublicFAQGetResponse>
Response example:
<PublicFAQGetResponse>
<FAQItem>
<ID>6</ID>
<ItemID>6</ItemID>
<FAQID>6</FAQID>
<Number>10006</Number>
<CategoryID>2</CategoryID>
<CategoryName>Public</CategoryName>

38
<CategoryShortName>Public</CategoryShortName>
<LanguageID>1</LanguageID>
<Language>en</Language>
<Title>Public2</Title>
<Field1>The Symptoms</Field1>
<Field2>The Problem</Field2>
<Field3>The Solution</Field3>
<Field4/>
<Field5/>
<Field6>The Comments</Field6>
<Approved>1</Approved>
<Keywords>Keyword1 Keyword2 Keyword3</Keywords>
<Votes>1</Votes>
<VoteResult>75.00</VoteResult>
<StateID>3</StateID>
<State>public (all)</State>
<StateTypeID>3</StateTypeID>
<StateTypeName>public</StateTypeName>
<Created>2010-11-02 08:06:43</Created>
<CreatedBy>1</CreatedBy>
<Changed>2010-11-02 08:06:43</Changed>
<ChangedBy>1</ChangedBy>
<Name>1288706803-91.878184450707</Name>
<Attachment>
<Content>...==</Content>
<ContentType>text/plain</ContentType>
<Filename>Details.txt</Filename>
<Filesize>296</Filesize>
</Attachment>
<Attachment>
<Content>...==</Content>
<ContentType>text/plain</ContentType>
<Filename>Text.bin</Filename>
<Filesize>980</Filesize>
</Attachment>
</FAQItem>
<FAQItem>
<ID>7</ID>
<ItemID>7</ItemID>
<FAQID>7</FAQID>
<Number>10006</Number>
<CategoryID>2</CategoryID>
<CategoryName>Public</CategoryName>
<CategoryShortName>Public</CategoryShortName>
<LanguageID>1</LanguageID>
<Language>en</Language>
<Title>Public777</Title>
<Field1>The Symptoms</Field1>
<Field2>The Problem</Field2>
<Field3>The Solution</Field3>
<Field4/>
<Field5/>
<Field6>The Comments</Field6>
<Approved>1</Approved>
<Keywords>Keyword1 Keyword2 Keyword3</Keywords>
<Votes>1</Votes>
<VoteResult>75.00</VoteResult>
<StateID>3</StateID>
<State>public (all)</State>
<StateTypeID>3</StateTypeID>
<StateTypeName>public</StateTypeName>
<Created>2010-16-03 02:06:43</Created>
<CreatedBy>1</CreatedBy>
<Changed>2010-11-02 02:06:43</Changed>
<ChangedBy>1</ChangedBy>
<Name>1288706803-91.878184450707</Name>
</FAQItem>

39
</PublicFAQGetResponse>
4. PublicFAQSearch
For this operation you can specify the following optional parameters: Name, Title, What (full
text search), Keyword, LanguageIDs and CategoryIDs to narrow the search results. You may
also specify the order of the results by the following parameters: OrderBy and OrderByDi-
rection.
Send a request to the web service with the operation name 'PublicFAQSearch' as a response
you will receive a list of FAQ item IDs.
Note
The full FAQ item data can be retrieved for each ID by using 'PublicFAQGet' operation
separately.
Request format:
<PublicFAQSearch>

<Number>?</Number>

<Title>?</Title>

<What>?</What>

<Keyword>?</Keyword>
<LanguageIDs>?</LanguageIDs>
<CategoryIDs>?</CategoryIDs>
<SortBy>?</SortBy>

<OrderBy>?</OrderBy>

<OprderByDirection>?</OprderByDirection>
</PublicFAQSearch>
Request example:
<PublicFAQSearch>
<Number>*134*</Number>
<Title>*some title*</Title>
<What>*some text*</What>
<Keyword>*webserver*</Keyword/>
<LanguageIDs>1</LanguageIDs>
<CategoryIDs>2</CategoryIDs>
<OrderBy>FAQID</OrderBy>
<OrderByDirection>Up</OrderByDirection>
</PublicFAQSearch>
Response format:

40
<PublicFAQSearchResponse>
<ID>?</ID>
</PublicFAQSearchResponse>
Response example:
<PublicFAQSearchResponse>
<ID>20</ID>
<ID>19</ID>
<ID>18</ID>
<ID>17</ID>
<ID>16</ID>
<ID>15</ID>
<ID>14</ID>
<ID>13</ID>
<ID>11</ID>
<ID>6</ID>
<ID>5</ID>
</PublicFAQSearchResponse>

Doc en-faq

More Related Content

What's hot (17)

Similar to Doc en-faq (10)

Recently uploaded (20)

Doc en-faq