How to modify the restapi.py file in order to increase the Rally API timeout limit.

Products

• Rally SaaS

Issue/Introduction

When I try to download these two objects, they fail on a non-specific error such as “Unable to retrieve AgileCentral data for entity: RevisionHistory, exception type: OperationalError” and no content is created in the SQL Server.  

Cause

The revisions endpoint is not designed to handle large amounts of data retrieval. Regardless of the integration used, the endpoint has its limitations.

As a workaround for timeouts, users can test by modifying the code to increase the timeout limit from 2 minutes to 4 minutes

Resolution

Please note that this modification is completely unsupported, which means that we cannot guarantee that it will work or that we can provide any further assistance beyond these instructions. 

To proceed with the modification, you will first need to locate your pyral installation location by running the following command in the terminal:
pip3 show pyral

Once you have located your pyral installation, you can proceed to modify the restapi.py file. On line 50 of the file, you need to change the following:
SERVICE_REQUEST_TIMEOUT = 120
to:
SERVICE_REQUEST_TIMEOUT = 240

Please note that 240 seconds (4 minutes) is the maximum API timeout limit, and going higher than that will not have any effect.

Lastly, please be aware that if you update pyral, any changes you have made to the restapi.py file will be overwritten and you will need to perform these modifications again.