EchoByte Knowledge Base

INTRODUCTION

ECHOBYTE-KB (Knowledge Base) is completely database-driven FAQ system. It stores a lots of data in its database. Real time search support with Elastic search, flexible multi-user support with user, group and section based permissions on categories and records, a news system, user-tracking, many supported languages, enhanced automatic content negotiation. It also supports pdf a backup-system. It can easy run on every web host. Most importantly it is fully safe and secure, and anti-spam.

SECTION ADMINISTRATION

Sections in ECHOBYTEKB are unique.  A section could be a helpful and secure part and backup.

CATEGORY ADMINISTRATION

ECHOBYTES-KB helps you create different categories and nested sub-categories for your FAQs. You can also re-arrange your categories in a different order. You ca easily use various languages per category, too; even you can get ease with frontend to view all translated categories. For accessibility reasons you should add a small description for every category. You can add an image for every category.if you add a new category you can set the permissions for users and groups and you can bond an administrator to that category.

FAQ ADMINISTRATION

Created entries are NOT published by default. All available FAQs are listed on the page “Edit FAQs”. By clicking on them the same interface that lets you create records will open up, this time with all the relevant data of the specific entry. The meaning of the fields is as follows:

Category

In the admin area you can add entries. Entry will be published depends on these settings. You can choose more than one categories where to store the entry. If you want to add a FAQ record to more than one category press the CLRT Key and mouse to select categories.

Question

This is the question or headline of your entry.

Solutions (Answers)

The content is the solution of the problems. The content can be edited with the included WYSIWYG (What You See Is What You Get) editor when JavaScript is enabled. You can place images where you want with the integrated image manager. The Editor can be disabled in the configuration if you want.

Language

Language can be easily change. By default the selected language saved in the configuration will be chosen. You can create entries in multiple languages like this: Write an article in English (or any other language) and save it. Now choose Edit FAQs and edit your English FAQ record. Change the question, answer and keywords and change language to, let’s say Brazilian Portuguese. Save the FAQ record. Now you can, when you click edit records, see both FAQs in your list, having the same id, yet different languages.

Attachments

PDFs attachments can be add or any other binary data using the Add attachment button. If you click on the button, a popup opens and you can upload an attachment. Please keep in mind that the PHP configuration about upload size will be checked.

Keywords

Keywords are relevant for searching through the database. You have to enter the specific keyword to search otherwise related result will be appears to the keyword you entered or if not even related no result will come.

Tags

You can add some tags about the current FAQ here. Auto-completion method you in easily typing.

Author

It is possible to specify an author for your FAQ.

Email

It is possible to specify the author’s email for your FAQ, but the email address won’t be shown in the frontend.

Solution ID

Every FAQ generates automatically a so-called solution ID. All records can be accessed directly by putting this ID into the search box.

Active?

If a FAQ is “active” it is visible in the public area and will be included in searches. Is it “deactivated” it will be invisible. Suggested FAQs are deactivated by default to prevent any abuse.

Sticky?

If a FAQ is “sticky” it is a very important FAQ record and will be shown always on all pages on the right column. You should mark records as sticky if they are very important for your whole FAQ. Sticky records also appear at the top positions of the lists of FAQ entries.

Comments?

If you do not want to allow public comments for this FAQ you can disable the feature here.

Date

You have three options for the FAQ creation date. You can choose to refresh the date of the FAQ entry for every update, or you can keep the date, or you can set an individual date for the FAQ entry.

Permissions

If you add or edit a new entry, you can set the permissions for users and groups. Please note that the permissions of the chosen category override the permissions of the FAQ itself.

Record expiration time window

If you need to you can set a time frame from one date to a second date when the FAQ entry should be valid and visible. Before and after this time frame the entry isn’t visible and cannot be accessed.

Date

Date of the last edit.

Changed/ edit?

This field is reserved for comments that can reflect what changes have been applied to a certain entry. This helps multiple admins to keep track of what happened to the entry over time. Any information entered here will remain invisible in the public area.

Changelog

The changelog lists all previous changes, including user and date of change.

You can edit and delete all records as well. Please note that old revisions won’t be deleted until the whole FAQ is deleted.

Comment Administration

Comments posted in FAQs can be seen easily in frontend. You cannot edit comments but you can delete them with one easy click.


Glossary

A glossary is a list of terms in a particular domain of knowledge with the definitions for those terms. You can add, edit and delete glossary items here. which are displayed in frontend in tags

News Administration and NEWS

ECHOBYTE-KB offers the ability to post news on the starting page of your FAQ. In the administration area you can create new items, edit existing news or delete them.

Attachment Administration

In the attachment administration you can see an overview of all attachments with their filename, file size, language and MIME type. You can delete them, too.


Statistics / Rating

Below every entry visitors have the chance to rate the overall quality of a FAQ by giving ratings from 1 to 5 (whereas 1 is the worst, 5 the best rating). In the statistics the average rating and number of votes becomes visible for every rated entry. To give you a quick overview entries with an average rating of 2 or worse are displayed in red, an average above 4 results in a green number.

View Sessions 

This function lets you keep track of your visitors. Every visitor is assigned an ID when coming to your starting page,that identifies him during his whole visit. Using the information gathered here you could reconstruct the way visitors use your FAQ and make necessary adjustments to your categories, content or keywords.

View Admin log

 The admin log allows you to track any actions taken by users in the admin area of ECHOBYTE-KB If you feel you have an intruder in the system you can find out for sure by checking the admin log.

Search statistics

 On the search statistics page you’ll get a report about which keywords and how often your users are searching. This information is split into keywords, the number of searches for this term, the language and the overall percentage.

Reports 

On the reports page you can select various data columns to generate a report about content and usage of your FAQ installation. You can export the report then a CSV file.


Exports

You can export your contents of your whole FAQ or just some selected categories into four formats:

  • a JSON file
  • a XML file
  • a plain HTML5 file
  • a PDF file with a table of contents

 Frontend

The public ECHOBYTES frontend has a simple and , HTML5/CCS3 based default layout based on Bootstrap v4.Instant response,

Add FAQs

Add questions

Open questions

Sitemap

Contact

On the left side you only see the main categories. 

Advanced search

On the page with the advanced search you have more possibilities to find an entry. You can search over all language if you want to. It’s also possible to search only in one selected category.


 Instant Response

The Instant Response is directly built into the main search bar in the top of the FAQ with direct access to the whole FAQ database and the page will return results while you’re typing into the input form. For performance reasons only the first 10 results will be suggested.


Add new FAQ

On adding the new FAQ the new user record will save.The users have to add a FAQ question, select a category, add an answer, and they have to insert New FAQ entries won’t be displayed and have to be activated by an administrator.

If a user is logged in, the name it also give the protection form spam with the help of captcha and e-mail address are filled automatically.


Add questions

On the Add question page it’s possible for all users to add a new question without an   answer. If the question is submitted, checks the words for the question and will do a full text search on the database with the existing FAQs. If we found some matches the user will get some recommendations depending on the question he submitted.

Open questions

All user add their question and can get their answer through this feature and it is fully safe and secure because of captcha code is used before using it.