Troubleshooting Steps for iKnowledgeSearch (Advanced Knowledge component)

Troubleshooting steps for resolving common issues with iKnowledgeSearch, including starting the service, resolving invalid configuration file content, resolving missing Python packages, correcting incorrect paths and ports, and ensuring the iKnowledgeSearch service is running.

iKnowledgeSearch is an Advanced iKnowledge component that enables a user to perform document search based on search query. It is a component developed using python and is hosted on Apache Web Service as a service under the name HCL.iAutomate.iKnowledgeSearch.

HCL.iAutomate.iKnowledgeSearch service is not starting

Table 1. Table 110 - iKnowledgeSearch: Scenario 1
Issue Description HCL.iAutomate.iKnowledgeSearch service is not starting
Modules Impacted iKnowledgeSearch
Probable Root Cause Invalid “iKnowledgeSearch.conf” file content

Steps to resolve

  1. Check for existence of the file iKnowledgeSearch.conf at location <Apache_Root_Folder_Path>/conf.

For e.g. - “C:/Apache24/conf” has <Apache_Root_Folder_Path> as “C:/Apache24”

  1. Verify the contents of file iKnowledgeSearch.conf by checking the snippet with paths to << iKnowledgeSearch_Directory>>. Verify and change the <VirtualHost *> tag with correct path entries to << iKnowledgeSearch_Directory>> as shown below. Where << iKnowledgeSearch_Directory>> is “C:/HCL.iAutomate.AdvancediKnowledge/iKnowledge_Search” in the snippet from iKnowledgeSearch.conf.

<VirtualHost *>

WSGIScriptAlias /iKnowledge C:/HCL.iAutomate.AdvancediKnowledge/iKnowldege_Search/search_main.wsgi

SSLVerifyClient require

SSLVerifyDepth 10

<Directory C:/HCL.iAutomate.AdvancediKnowledge/iKnowledge_Search>

WSGIApplicationGroup %{GLOBAL}

Require all granted

</Directory>

</VirtualHost>

  1. Ensure that service was created through Service Account and not through Local account. Refer to below figure to check the status.
Figure 1. Figure 151 - HCL.iAutomate.iKnowledgeSearch
1
  1. If not, open Windows Command Prompt in Administrator mode and run the below command:

sc config HCL.iAutomate.iKnowledgeSearch obj= “ID” password= “PSWD”

where ID is the [Domain\SA ID] and PSWD is the [Password of SA] and SA is

[Service Account].

Log On As’ field corresponding to the service HCL.iAutomate.iKnowledgeSearch should be changed to ‘Service Account’. Click Start to start the service.

Service returns Internal Server Error - status code 500

Table 2. Table 111 - iKnowledgeSearch: Scenario 2
Issue Description Service is reachable but returns Internal Server Error with status code 500.
Modules Impacted iScript
Probable Root Cause Python package not available

Steps to resolve

  1. Check the Apache error log at <Apache_Root_Folder_Path>/logs/error.log.
  1. If the error is because of the missing package, perform the following steps:
  • Open Windows Command Prompt in Administrative mode in Apache_Root_Folder_Path.
  • If open internet access is available, run the below command:

pip install package_name

  • If open internet access is not available, download wheel file for package from where user has internet connectivity and move onto server at same location where it needs to be installed. E.g. https://pypi.org has a repository of most used wheel files, else other sources are available as well. Subsequently, run the below command:

pip install package_name.whl

‘404 Resource Not Found’

Table 3. Table 112 - iKnowledgeSearch: Scenario 3
Issue Description Error message ‘404 Resource Not Found’ when iKnowledgeSearch is hit
Modules Impacted iKnowledgeSearch
Probable Root Cause
  • Paths are not correct in iKnowledgeSearch.conf
  • Port is not correct

Steps to resolve

  1. If the issue is due to the incorrect paths, refer to resolution steps mentioned in Table 110 - iKnowledgeSearch: Scenario 1
  1. Also, check if correct port is being used. To identify the correct port, perform the following steps:
  • Open iKnowledgeSearch.conf
  • Search for Listen xxxx

e.g. – Here the image below shows the port set for iKnowledgeSearch component is 9000.

#

Listen 9000

# ports, instead of the default. See also the <VirtualHost>

# directive

  1. The set port is one where iKnowledgeSearch is deployed.

‘Could not get any response’

Table 4. Table 113 - iKnowledgeSearch: Scenario 4
Issue Description Error message ‘Could not get any response’ appears when iKnowledgeSearch is being hit.
Modules Impacted iKnowledgeSearch
Probable Root Cause HCL.iAutomate. iKnowledgeSearch service is not running

Steps to resolve

  1. Press Win+R, type services.msc and press Enter to open Windows Services.
Figure 2. Figure 152 - HCL.iAutomate. iKnowledgeSearch
  1. Find service HCL.iAutomate.iKnowledgeSearch and select it.
  2. Click Start to start the service, if it’s not running already.
Figure 3. Figure 153 - HCL.iAutomate. iKnowledgeSearch (cont.)