Troubleshooting Steps for Entity Model (iRecommend Components)

Troubleshooting Steps for Entity Model (iRecommend Components)

EntityModel is an iRecommend component used to identify entities by leveraging domain-specific knowledge. It is used to increase weightage for specific entities that may seem to be of less weightage in general scenarios. It is a component developed in python and is hosted on Apache Web Server as a service by the name HCL.iAutomate.EntityModel.

HCL.iAutomate.EntityModel service is not starting

Table 1. Table 75 - iRecommend Components: Scenario 1
Issue Description HCL.iAutomate.EntityModel service is not starting
Modules Impacted EntityModel
Probable Root Cause
  • Service created through Local account
  • Invalid “Entity.conf” file content

Steps to resolve

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

<VirtualHost *>

WSGIScriptAlias /iKnowledge C:/HCL.iAutomate.iRecommend/entityservice.wsgi

SSLVerifyClient require

SSLVerifyDepth 10

<Directory C:/HCL.iAutomate.iRecommend>

WSGIApplicationGroup %{GLOBAL}

Require all granted

</Directory>

</VirtualHost>

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

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

Service returns Internal Server Error - status code 500

Table 2. Table 76 - iRecommend Components: Scenario 2
Issue Description Service is reachable but returns Internal Server Error with status code 500.
Modules Impacted EntityModel
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 library, 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 commend:

pip install package_name.whl

If the issue pertains due to problem in the code, contact the System Administrator.

‘404 Resource Not Found’

Table 3. Table 77 - iRecommend Components: Scenario 3
Issue Description Error message ‘404 Resource Not Found’ when EntityModel is hit
Modules Impacted EntityModel
Probable Root Cause
  • Paths are not correct in Entity.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 75 - iRecommend Components: Scenario 1 .
  1. Also, check if correct port is being used. To identify the correct port, perform the following steps:
  • Open Entity.conf
  • Search for Listen xxxx
  • e.g. – Here the image below shows the port set for EntityModel component is 9000.

#

Listen 9000

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

# directive

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

‘Could not get any response’

Table 4. Table 78 - iRecommend Components: Scenario 4
Issue Description Error message ‘Could not get any response’ appears when EntityModel is being hit.
Modules Impacted EntityModel
Probable Root Cause Service is not running

Steps to resolve

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