ARD: Keyclock Issues while sync users in ARD Hub

Products

• CA Agile Requirements Designer

Issue/Introduction

When trying to manually sync users from the ARD Hub Web UI, we are seeing the following error:

! General Keycloak client error from reason: RESTEASY004655: Unable to invoke request.

 

Environment

Release : 3.0

Component : CA Agile Requirements Designer

Cause

The customer is seeing the error only when they try manually sending the sync request from ARD Hub Web UI. They aren't seeing the problem when the sync is being preformed through Keycloak scheduling.

Upon further investigation, we noticed that the sync requests are actually being fulfilled, even when the error is received. In this scenario, ARD Hub, communicates to Keycloak, which in turns communicates to AD. It appears the error is happening because the Keycloak response back to ARD Hub is timing out.

Resolution

To resolve this we need to increase the timeout value for the Keycloak operation we need to do the following:

1. Find IMS service settings file in Tomcat webapps folder. By default, it looks like:
       C:\Program Files\Apache Software Foundation\Tomcat 9.0\webapps\ard#ims\WEB-INF\classes\application.properties
2. Open that file and go to line 36. You should see "ims.keycloak.timeout.read=35000"
3. Change value 90 seconds (ims.keycloak.timeout.read=90000)
4. To apply changes restart IMS application in Tomcat
5. Run "Sync users" from Hub Web UI

 

Note: If increased timeout does not help the operation to succeed, you will need to check how long the operation is taking, and adjust the ims.keycloak.timeout.read value to a greater amount of time. Such as, 3 to 5 minutes (180000 - 300000).