Setup tests

The Setup Tests screen is available as a tab from the Settings menu. It allows you to check that your knowledgebase has been set up properly.

To get to the screen:

• Log in as an admin user
• Click Settings -> Admin 
• Click the Setup Tests tab

The Setup Tests tab

When you first install KBPublisher the Setup Tests tab doesn't show much. Click Run Test to get some results.

• The Files directory is where files are stored. If this test's status is passed, it means that the folder exists and can be written to. If you need to check the name of the directory, click Setting.
• The Cache directory is where cached files are stored. This is defined in the php config file. You normally would not change this. Passed means that the directory exists.
• The HTML editor file directory is where images are stored. If the status is passed it means that the directory exists and you can save images to it. If you need to check or update the name of the directory, click Setting.
• XPDF allows you to search PDF files.
  If this setting is disabled, then XPDF has not been installed. If the status is failed or error, details of the error will be provided.
  If the status is passed, your knowledgebase should be able to search PDF documents.
  To install XPDF, see Enable Searching in Files.
• Catdoc allows you to search Word 2003 files.
  If this setting is disabled, then Catdoc has not been installed. If the status is failed or error, details of the error will be provided.
  If it is passed, your knowledgebase should be able to search .doc documents.
  To install catdoc, see Enable Searching in Files.
• PHP Zip extension allows you to search Word 2007/2010 files and Excel 2007/2010 files and from OpenOffice documents.
  If the status is failed or error, then PHP Zip extension has either not been installed or is not installed properly; details of the error will be provided.
  If the status is passed, then your knowledgebase should be able to search docx, xlsx, and .odt files.
  To install PHP Zip extension, see this link.
• Spell Suggest helps your knowledgebase users when they search for documents or files, by suggesting the correct spellings of the words the users are entering as search terms.
  If the status is passed, then Spell Suggest is installed and end users should see helpful spelling hints. If the status is failed or error, details of the error will be supplied.
• Htmldoc allows you to export KB to PDF, it is required for PDF Export plugin.
  If the status is disabled, Htmldoc hasn't been installed. If the status is failed or error, details of the error will be provided.
  If this is passed then you should be able to export your knowledgebase as a PDF document and/or as HTML.
  See enable exporting to PDF for setup and requirements. 
• Wkhtmltopdf allows you to export KB to PDF, it is required for PDF Export plugin.
  If the status is disabled, Wkhtmltopdf hasn't been installed. If the status is failed or error, details of the error will be provided.
  If this is passed then you should be able to export your knowledgebase as a PDF document and/or as HTML.
  See enable exporting to PDF for setup and requirements. 
• Scheduled tasks tells you if your cron jobs are set up properly.
  If the status is disabled, then you will not be able to schedule tasks or run reports, and users will not be notified of changes they have subscribed to. Some admin tasks will also not run.
  Cron jobs are set up on the server. Click here for how to set them up.
  If the status is error, then there is a problem in your setup and some tasks could not execute. Information about the problem will be listed with the error. 
  If the status is passed then your cron jobs have been set up properly and scheduled tasks should run.
• Sphinx 
  Sphinx Search Server allows you to enable fast full-text search capability.
  Click here for how to set them up.

Note:

• This set of tests runs as a regularly scheduled task. If there is an error, the knowledgebase administrator is notified by email.

----------------------------------------------------------------------
This functionality works in version 4.0 and above