Troubleshooting
Troubleshooting TruckMate API
Overview
Performance
- What version of the ART.exe is running?
- Performance improvements have been made to newer versions
- Is it a DB issue?
- Run Runstats\Rebinds
- Check ART service log, look for slow calls
- Run the same SQL found from the ART log in SQL Execute, check the performance
- for the Orders API run the database procedure TMS_ORDERS, there was a performance improvement made with TM-154335
- If the SQL related to a table or view with the same lag, the issue is on DB side.
- When was the last time the server was rebooted?
- It is recommended to reboot every 30 days
- Network
- Firewall
- Make use of API paging and query only the data you need
- For example, entering the following query will return a larger payload: /tm4web/orders?expand=contacts,details,traceNumbers
- Whereas passing the resource id or adding a limit within the querystring will keep the criteria narrowed and return a smaller payload: /tm4web/orders?limit=5
- All GET requests default to a limit of 20 records
Connection Problems
There maybe connection problems from the client app to the ART Server. Here are some of the items to check for.
- Check the ART Server is not conflicting with another TCP port. For example a common web port is 80. But another service like Apache or IIS may already be using that port. ART Server will need to be configured to listen on a different port.
- Check the firewall. The client application maybe going through the internet and then the firewall to connect to the Art Server. Make sure the firewall is configured to redirect the web requests to the specific IP address running the ART Server. Some firewalls use NAT to redirect the web requests to the ART Server.
- Check for virus scanner software. Virus scanners today are more than just checking files on the computer for viruses. They also check the internet traffic to see if there is any kind of hacking activity. Try temporarily disabling the virus scanner and retry the web requests.
To check if the ART server is running navigate to the /version endpoint. To check the that the ART Server is connected to the DB2 database, navigate to the /whoami endpoint. For a successful response pass a valid API Key Bearer Token in the request header.