Installation of the attachment indexation modules

KnowledgeBase Manager Pro is able to run indexation of files attached to knowledge base in order to make them searchable. Some documents can be searched without any additional tools, others need PHP modules enabled or third party tools installed. All modules and tools are free.

• The list of supported file types
• Installation of plugins and modules for search indexation on Windows server
• Installation of plugins and modules for search indexation on UNIX-like server

The list of supported file types

• MS Office 2003 Word Documents  = Supported formats: .doc, .dot. AntiWord (free) is required.
• MS Office 2003 Excel Workbooks = Supported formats: .xls, .xlt. Indexation tools are already built-in.
• MS Office 2003 PowerPoint Presentations = Supported formats: .ppt, .pot. ppthtml (free) is required.
• MS Office 2007 Word Documents = Supported formats: .docx, .docm, .dotx, .dotm. PHP ZIP library (free) is required.
  
• MS Office 2007 Excel Workbooks = Supported formats: .xlsx, .xlsm, .xltx, .xltm. PHP ZIP library is required.
• MS Office 2007 PowerPoint Presentations = Supported formats: .pptx, .pptm, .potx, .potm. PHP ZIP library is required.
• MS Office 2007 Visio Drawing = Supported format: .vdx. Indexation tools are already built-in.
• Adobe PDF Documents = Supported format: .pdf. pdftohtml (free) is required.
• RTF Documents = Supported format: .rtf. unrtf (free) is required.
• Plain-text Documents = Supported formats: .txt, .htm, .html, .shtml, .shtm, .txt, .php, .asp, .cfm, .cfml, .pl, .cgi, .aspx, .jsp.  Indexation tools are already built-in.
• Images = Supported formats: .jpg, .jpeg, .tiff, .tif. Meta data is indexed, not images by themselves. PHP's EXIF library (free) is required.

Installation of plugins and modules for search indexation on Windows server

You also need to enable several PHP modules in order to use search indexation of MS Office 2007 documents and images metadata.

1. Find the "ext" subdirectory of your PHP installation (it is C:\PHP\ext\ by default).
2. Check if the following files exist in that folder: php_exif.dll, php_mbstring.dll, php_zip.dll.
1. If any of these files do not exist, you should run PHP installation and install appropriate module (Exif, Mbstring, or PHP ZIP respectively).
3. Open the php.ini configuration file of your PHP engine.
4. Search for the "extension=" (without quotes).
5. You'll find the section with the list of PHP extensions. Some of them are commented with # symbol.
6. You should enable these modules by removing comment symbol (#). Be sure to move the php_mbstring.dll entry before the php_exif.dll. It won't work otherwise.
   
   extension=php_mbstring.dll
   extension=php_exif.dll
   
7. Restart the web server.

Indexation plugins

We strongly recommend you to use the latest version of PHP. These plugins work under PHP v5.3+ correctly. Earlier versions of PHP have bugs and may freeze when launch external programs (e.g. attachment indexation plugins) using Windows command line.

Download the latest PHP package for Windows (VC9 x86 Non Thread Safe is recommended).

PHP v5.3 doesn't support ISAPI anymore. So you need to use FastCGI instead.

Check guide for your version of IIS for installation of the latest PHP and FastCGI:

• PHP and FastCGI for IIS6
• PHP and FastCGI for IIS7
  

1. Download the indexation-plugins.zip and antiword.zip attachments below.
2. Open properties for each zip file and check if they are not blocked by Windows "for security reasons". If yes, unblock them.
   
   
3. Extract the contents of the indexation-plugins.zip to the \admin\application\libraries\search\plugins folder of your KMP installation.
4. Add read and execute permissions for the web-server to the \admin\application\libraries\search\plugins folder and its contents. If your server runs under IIS, you should grant the Internet Guest Account with the read and execute permissions to that folder. If it is Apache server, you should check which user runs the Apache process and grant read and execute permissions for that user.
   
5. Extract the contents of the antiword.zip to the C:\Antiword\ directory.
6. Add read and execute permissions to this folder and its contents as well.
7. Add read and execute permissions to the %windir%\system32\cmd.exe file (c:\windows\system32\cmd.exe by default). Typically you need to add read and write permissions to that file for the Internet Guest User (IUSER_SERVERNAME or IIS_IUSRS), but this may differ on your IIS installation. If you can not change cmd.exe attributes due to company policy or lack of permissions, you can copy this file to any directory listed in system PATH environment variable and set read and execute permissions permissions to it there.
   

After installation of modules and plugins

1. Go to the KMP control panel.
2. Go to the Administration > General Settings > Search.
3. Set checkbox on the "Enable Attachments Indexation" and on each document type entry and click "Save".

Now you can upload attachments and they will be automatically indexed for search. You can also run indexation for existing attachments. You need to install cron script to do that.

Installation of plugins and modules for search indexation on UNIX-like server

Indexation plugins

Run following command to install necessary modules on a system that has APT library (e.g. Ubuntu, Debian):

Or if your system supports Yum package manager you can run this command instead to install necessary modules:

Please note that if you're installing unRTF from tar.gz package, you should use version 0.19.3 (unrtf-0.19.3.tar.gz file). This is the correctly working version - newer versions doesn't work properly and hang the indexation process.

PHP modules

1. Open the php.ini configuration file.
2. Find the "extension_dir" parameter. It indicates the path to PHP extensions directory. Go to that directory and check that exif.so and zip.so files do exist there.
   
3. Add reference for the Exif and PHP ZIP extensions to the php.ini:
   
   extension=exif.so
   extension=zip.so
   
4. Restart the web server.
   

After installation modules and plugins

1. Go to the KMP control panel.
2. Go to the Administration > General Settings > Search.
3. Set checkbox on the "Enable Attachments Indexation" and on each document type entry and click "Save".

Now you can upload attachments and they will be automatically indexed for search. You can also run indexation for existing attachments. You need to install cron script to do that.