Troubleshooting Steps for iKnowledgeRating

These troubleshooting steps provide solutions for various issues related to the iKnowledgeRating component, including service not starting, internal server error, resource not found, and could not get any response errors. The steps include checking configuration files, verifying service accounts, installing missing packages, and starting necessary services.

iKnowledgeRating is an AdvancediKnowledge component that helps in storing the document rating given by the users for a knowledge article on the GUI, in a database. It is a component developed using python and is hosted on Apache Web Server as a service under the name HCL.iAutomate.RatingMongo.

HCL.iAutomate.RatingMongo service is not starting

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

Steps to resolve

  1. Check for existence of the file RatingMongo.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 RatingMongo.conf by checking the snippet with paths to << iKnowledgeRating_Directory>>. Verify and change the <VirtualHost *> tag with correct path entries to << iKnowledgeRating_Directory>> as shown below. Where << iKnowledgeRating_Directory>> is “C:/HCL.iAutomate.iKnowledgeRating” in the snippet from RatingMongo.conf.

<VirtualHost *>

WSGIScriptAlias /iKnowledge C:/HCL.iAutomate.iKnowledgeRating/iKnowledge_Rating/app.wsgi

SSLVerifyClient require

SSLVerifyDepth 10

<Directory C:/HCL.iAutomate.iKnowledgeRating/iKnowledge_Rating >

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

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

Service returns Internal Server Error - status code 500

Table 2. Table 119 - iKnowledgeRating: Scenario 2
Issue Description Service is reachable but returns Internal Server Error with status code 500.
Modules Impacted iKnowledgeRating
Probable Root Cause Library is missing

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 120 - iKnowledgeRating: Scenario 3
Issue Description Error message ‘404 Resource Not Found’ when iKnowledgeRating API is hit
Modules Impacted iKnowledgeRating
Probable Root Cause

Paths are not correct in RatingMongo.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 118 - iKnowledgeRating: Scenario 1
  1. Also, check if correct port is being used. To identify the correct port, perform the following steps:
  • Open RatingMongo.conf
  • Search for Listen xxxx
  • e.g. – Here the image below shows the port set for iKnowledgeRating component is 9000.

#

Listen 9000

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

# directive

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

‘Could not get any response’

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

Steps to resolve

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