Troubleshooting Steps for iKnowledgeIndexer (Advanced Knowledge component)

Troubleshooting steps for iKnowledgeIndexer (Advanced Knowledge component) including resolving issues related to service not starting, internal server errors, "could not get any response" errors, "404 Resource Not Found" errors, data not getting indexed, and "Solr task failed" errors.

iKnowledgeIndexer is an AdvancediKnowledge component that performs indexing over the data crawled by iCrawler and stores the indexed data in the database. It is a component developed using python and is hosted on Apache Web Server as a service under the name HCL.iAutomate.iKnowledgeIndexer.

HCL.iAutomate.iKnowledgeIndexer service is not starting

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

Steps to resolve

  1. Check for existence of the file iKnowledgeIndexer.conf at location <Apache_Root_Folder_Path>/conf.
  1. For e.g. - “C:/Apache24/conf” has <Apache_Root_Folder_Path> as “C:/Apache24”
  2. Verify the contents of file iKnowledgeIndexer.conf by checking the snippet with paths to << iKnowledgeIndexer_Directory>>. Verify and change the <VirtualHost *> tag with correct path entries to << iKnowledgeIndexer_Directory>> as shown below. Where << iKnowledgeIndexer_Directory>> is “C:/HCL.iAutomate.AdvancediKnowledge/iKnowledge_Indexer” in the snippet from iKnowledgeIndexer.conf.

<VirtualHost *>

WSGIScriptAlias /iAutomate C:/iAutomate/Comp/HCL.iAutomate.iParse /IParse/iparse/app.wsgi

SSLVerifyClient require

SSLVerifyDepth 10

<Directory C:/iAutomate/Comp/HCL.iAutomate.iParse/IParse/iparse>

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 148 - HCL.iAutomate.iKnowledgeIndexer
  1. If not, open Windows Command Prompt in Administrator mode and run the below command:

sc config HCL.iAutomate.iKnowledgeIndexer 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.iKnowledgeIndexer should be changed to ‘Service Account’. Click Start to start the service.

Service returns Internal Server Error - status code 500

Table 2. Table 105 - iKnowledgeIndexer: Scenario 2
Issue Description Service is reachable but returns Internal Server Error with status code 500
Modules Impacted iKnowledgeIndexer
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:
  1. Open Windows Command Prompt in Administrative mode in Apache_Root_Folder_Path:.
  1. If open internet access is available, run the below command:

pip install package_name

  1. 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

‘Could not get any response’

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

Steps to resolve

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

‘404 Resource Not Found’

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

Steps to resolve

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

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

#

Listen 9000

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

# directive

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

Data not getting indexed

Table 5. Table 108 - iKnowledgeIndexer: Scenario 5
Issue Description Data is not getting indexed
Modules Impacted iKnowledge
Probable Root Cause Python package is not available or having different version

Steps to resolve

  1. Check the Apache error log at <Apache_Root_Folder_Path>/logs/error.log.
  2. If the error comes because of the spacy package, perform the following steps:
  • Check the spacy version in this path C:/Python36/Lib/site-packages. If the version is mismatched as mentioned in pre-requisite or more than one version of same package present in this path. Then follow the below steps.
  • First uninstall python and follow the installation steps again as mentioned in pre-requisite document and ensure that spacy folder is placed in desired location.

“Solr task failed”

Table 6. Table 109 - iKnowledgeIndexer: Scenario 6
Issue Description Error message “Solr task failed” comes, when iKnowledgeIndexer is hit
Modules Impacted iKnowledge
Probable Root Cause This might be an issue related to Solr username and password are not configured correct.
Steps to resolve
  1. Check the Solr username and password in the database and change it with correct one.