How to troubleshoot NavSherpa synchronization errors
How to handle SharePoint connection errors
NavSherpa is connecting to an external SharePoint API, which means, that some requests are bound to fail due to some temporary errors on SharePoint. If this happens, NavSherpa synchronization will throw an error like:
-
The operation has timed out
-
An existing connection was forcibly closed by the remote host
-
The remote server returned an error: (503) Server Unavailable
If NavSherpa runs on
Application Server (C/AL version only), these errors will be visible in the notifications list, but can be safely ignored. Synchronization job will resume after the delay set in field
Auto Update Interval for NAS (s) and try to do the job once more, until successful connection is established.
If NavSherpa runs in Job Queue, then you will see this kind of errors in Job Queue Entries Error Messsage field. It is recommended to set the field Maximum No. of Attempts to Run in the Job Queue Entry setup to a value greater than 1:
This means, that when NavSherpa encounters SharePoint server error, it will try again 5 times with 60 seconds delay. If the error is resolved in the meantime, job will continue to run in spite of SharePoint errors.
How to handle synchronization errors
NavSherpa synchronization is working with
timestamps. On each synchronized
List Setup Card there is a date and time of
last check, last synchronization
to SharePoint and last synchronization
to NAV/BC (is applicable):
When an error appears during the synchronization, these timestamps will not update and the synchronization will stop on the first error. With the next run NavSherpa will try to synchronize the same records plus all new records – which means, that until you fix the error, synchronization is effectively stopped (for C/AL version this applies per List Setup).
Tip: When fixing NavSherpa synchronization errors you can use the list of Record / Document Mappings:
NavSherpa runs in Job Queue
The errors from NavSherpa synchronization can be found in Job Queue Entries, job NSP Synchronization:
-
If the job has an
Error Status, it must be restarted with
Set Status to Ready action.
-
You can view the last error with
Show Error or history of errors with
Log Entries.
Example of a synchronization error:
-
NavSherpa shows exact document and library, where the error appeared.
-
In this case there is a bad invoice number in the document metadata on SharePoint – NavSherpa does not know, which invoice should be the document attached to.
-
A fix in this case is easy: Either delete the document on SharePoint, or provide valid invoice number in the metadata.
NavSherpa runs on Application Server (C/AL version only)
If NavSherpa runs on an Application Server, you have to do some additional settings to see the issues and errors with NavSherpa synchronization. Go to
NavSherpa Users and check
Notify Errors from NAS in the line with user, which should get error notifications:
Please note, that if you are running NavSherpa with Job Queue and you check this checkbox, you will stop seeing the errors in Job Queue Entries. Use Role Center Notifications instead.
Selected user will see NavSherpa synchronization errors in his Role Center Notifications:
Each error message is posted here daily and only once – even if the synchronization is repeatedly failing on the same document, you will see only one error message per day.
After fixing the error, delete the notification with Remove Notification action. If no error appears after next NavSherpa synchronization run, you are good to go.
