KnowledgeBase

The KnowledgeBase is an area of HotH in which problems with their solutions, Frequently Asked Questions and their answers, and associated keywords can be stored.

The KnowledgeBase can therefore speed up problem resolution, as it is possible to search the KnowledgeBase when analysing issues to discover if the problem has been logged before, and if a solution or root cause has already been discovered.

Access the KnowledgeBase main window by selecting the icon seen below from the side-bar menu:knowledgebase icon

 

Click the links to the topics outlined below to learn more information:

Creating KnowledgeBase Articles

Referencing the KnowledgeBase

KnowledgeBase Forms

Importing KnowledgeBase Data

Exporting KnowledgeBase Data

 

Creating KnowledgeBase Articles

 

Creating Articles from the Knowledgebase Window

Clicking on the KnowledgeBase link in the side-bar menu displays the list of existing KnowledgeBase articles.knowledgebase iconKnowledgeBase entries can be viewed by double clicking on them, or new entries can be created from scratch by clicking the “Add add button” button.raise incident button

 

Creating Articles from a Ticket

It is possible to create a KnowledgeBase item directly from a HotH ticket. Selecting the Add to KnowledgeBase box transfers the user to the Knowledge Management Entry form, with keyword, problem and solution text copied directly across.add to knowledgebase selectorA KnowledgeBase entry is then generated, with Keywords automatically entered based upon the Subject of the ticket. These can be added to and edited.kbase entry form

 

KnowledgeBase Article Form

 

knowledgebase article form

The full functions of the KnowledgeBase Article form are described below:

FieldFunction
KeywordsEnter or amend the keywords of the problem. These are used to filter the KnowledgeBase records when they are shown on the Ticket form, KnowledgeBase tab. Records are displayed where there is a match between words in the Ticket subject and the KnowledgeBase keywords.
Topic/Sub-TopicUse these entries to classify the KnowledgeBase record so that it can be more easily selected later when using the Magnifying Glass Search tool. You may, for example, classify a record with a topic of ‘Hardware’ and a sub-topic of ‘Printer’.
Customer/Product dropdown iconSelect from the drop-down lists if you want to classify the entry to relate to a specific Product or Customer.
ProblemDescribe the problem here. This entry relates to the subject field on the Ticket. If you create a Knowledge Management record from the Ticket, the subject is substituted here. Similarly, if you create a Ticket from the Knowledge Management record, the problem is copied to the subject field.
SolutionDetail any advice or technical tip that is a solution to the problem. This field relates to the solution field on the Ticket record.
Archive checkbox iconTick if this KnowledgeBase record is no longer used.
Internal checkbox iconUn-tick if this KnowledgeBase record is to be visible via the WebServer to Customers.
FAQ checkbox iconTick if the problem and its solution is a Frequently Asked Question. Selecting this along with deselecting Internal will make the KnowledgeBase item to appear in the Customer portal.
Validated checkbox iconIf KnowledgeBase entries are added by Support agents, it will require a Supervisor login to tick Validate on the KnowledgeBase entry before it will appear in the list.
URLTo make direct links to other web sites; for example, www.houseonthehill.com. Click the URL label to access the site.
Folder dropdown iconSelect the folder where the entry is to be stored. This will indicate the type of ticket to which the item relates so it is displayed when relevant.
OKClick OK to Save/Exit.
MailClick Mail to email the KnowledgeBase article to an email address.

Back to Top

 

Referencing the KnowledgeBase

 

It is also possible to reference the KnowledgeBase when interrogating a Ticket.

Use the KnowledgeBase link within the Ticket window to list records that relate to the Ticket’s problem, or click the Search The Known Error DB button… search known error db buttonknowledgebase buttonThe KnowledgeBase will automatically filter based upon keywords entered in the Subject field, and match them to those in existing KnowledgeBase entries.knowledgebase search pageThe Solution can also be copied directly to the ticket using the Copy Solution button. The KnowledgeBase Solution is then copied directly across to the Solution field on the ticket.knowledgebase copy solution button

Back to Top

Importing KnowledgeBase Data

 

HotH has the ability to load external data files directly into the databases. You can therefore download data from any existing databases and populate the HotH databases.

In addition, HotH also has the ability to export your KnowledgeBase data from the HotH database to a CSV file, which you can learn more about on the Exporting KnowledgeBase Data Guide.

The files to be imported must be flat files of comma-separated values. Each line in the text file represents a HotH record of a particular type. The first characters in each line indicate the type of record to be loaded. You should also note that special rules apply to some fields, please take advice from Support before loading new data type.You can use Import to execute a SQL string, but again please take advice from Support before doing this.

How to Import the File

In the WebServer, go to Import CSV from Settings.import csv file pageSelect the file to import records and click Import. If there are errors they will be listed. The error log is listed to the file suppdesk.err. You need to review the errors. If there are no errors you can navigate away.

In the Windows interface the Import CSV option is on the Database ribbon tab/menu. You need to navigate to where the import file is located.

Import Format

Excel column headings are supplied below to assist. You do not need to supply data for every field, just enter those you need. (Though there are some validation rules, these are not documented here.)

Dates should be entered as DD/MM/YYYY for UK format and MM/DD/YYYY if US format is in use.

KnowledgeBase Record – Type KB

ACode“KB”
BKeywordsUp to 250 characters, mandatory
CProblemUp to 2000 Characters
DTopicUp to 32 Characters
ESub-TopicUp to 32 characters
FWeb LinkUp to 200 characters
GUserUp to 40 characters.
The User’s Tag, User must exist.
HFlagNumeric (set to 0)
ICreation Date10 characters. Default today’s date.
JSource Call RefUp to 16 characters. The Reference of the originating Ticket.
KSolutionUp to 10,000 characters
L-OFlagsLeave blank
PProd Ref16 Characters – must exist
QCust Ref16 Characters – must exist
RInternalNumeric
SUnvalidatedNumeric
TStatusNumeric
UIDNumeric
VSolutionUp to 128 characters
W Leave blank
XRelevanceNumeric
YScript IdNumeric
ZServiceUp to 40 characters
AAValueUp to 40 characters
ABCostNumeric
ACTypeUp to 40 characters
ADRoot CauseUp to 128 characters
AETierNumeric
AFRating noNumeric
AGRating AverageNumeric

Back to Top

 

Exporting KnowledgeBase Data

 

You can export the current KnowledgeBase databases into a named file. The output records have same layout as the corresponding Import records. This is useful if you want to create an import file; create a ‘dummy’ record, populating the required fields with discernible text, such as REF in a reference field. The exported data can then be used as a template for the import layout.

How to Export the KnowledgeBase

To export data, show the KnowledgeBase records in the summary and filter the list as required.

In the WebServer, navigate to KnowledgeBase in the side-bar menu, then use the Export option in the Summary Options navigation bar; this will then offer the option to View the output. Now, you can open or save the file.exporting tab on webserver

Additionally, you can navigate to Settings > Export CSV File, and then select KnowledgeBase to export:knowledgebase exportIn the Windows interface, you can export the records in the summary list using Export CSV on the File ribbon tab/Menu. Additionally, in the Windows version you can use the Export CSV option on the Database menu to export more KnowledgeBase records.windows knowledgebase export paneTick the KnowledgeBase box, click the OK button and then choose a location and file name for the export file. The default is export.txt on the HotH directory. If this file already exists, you must confirm to replace the existing file. On completion, you can view the export file before being returned to the main window.

Back to Top