Setup tests

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

To get to the screen:

• Log on as an admin user
• Click Home menu
• Click on the Setup Tests tab

The Setup Tests tab

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

1. Run Tests. This is the button that starts it all.
2. The Files directory is where files are stored. If this is passed, it means that the folder exists and can be written to. If you need to check the name of the directory, click on Setting.
   
3. The Cache directory is where cached files are stored. This is defined in the php config file. You normally would not change this. Again, passed means that the directory exists.
4. The HTML editor file directory is where images are stored. If this is passed it means that the directory exists and can be written to. If you need to check or update the name of the directory, click on Setting.
5. XPDF allows you to search PDF files.
   If this setting is disabled, then XPDF has not been installed. If this is failed or error details of the error will be provided.
   If it is passed, your knowledgebase should be able to search PDF documents.
   To install XPDF, see Enable Searching in Files.
6. Catdoc allows you to search Word 2003 files.
   If this setting is disabled, then Catdoc has not been installed. If this is failed ir 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
   
7. PHP Zip extension allows you to search Word 2007/2010 files and Excel 2007/2010 files and from OpenOffice documents.
   If this setting 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 it is passed, then you knowledgebase should be able to search docx, xlsx, and .odt files.
   To install Zip extension, see this link
   
8. Htmldoc allows you to produce user manuals of your knowledgebase. You can purchase this as a plugin.
   If this is disabled, it means that it hasn't been installed. If this is failed or error, details of the error will be provided.
   If this is passed then you should be able to export your kb to PDF and/or HTML.
   See enable exporting to PDF for setup and requirements. 
9. Scheduled tasks tells you if your cron jobs are set up properly.
   If this 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 this 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 this is passed then your cron jobs have been set up properly and scheduled tasks should run.

Note:

• This test is also run as a regular scheduled task.  If there is an error, the knowledgebase administrator is notified by email.

---------------------------------------------------------
This functionality works in version 4.0 only