Web Integration Logs
This feature requires additional licensing. Please contact AcctVantage Sales for a quote.
In the Administration module, you can view the Web Integrations Logs which detail the communication between AcctVantage and enabled web integrations.
There are two different formats where you can see this data:
- Administration ➤ AV Server Status Window -> Web Integrations tab
- This is a real-time view of the logs which can be helpful when you need to monitor ongoing communications with a web integration.
- Administration ➤ Web Integrations Log
- This is a list-view screen that presents a historical capture of the communications with your web integrations. Here you can use all of the regular search tools to find specific logs.
Overview
In both of these areas, you will see communication logs between AcctVantage and enabled web integrations, including (but not limited to):
- Started Order Import Task
- Found new orders to import
- Order status changed
- Shipment created
- Successfully updated product
- Successfully updated customer
You may also see error messages including (but not limited to):
- Error: Status update for webstore order failed
- Error: Shipment not created for Web Order ID
- Error updating customer
- Error updating product
1. AV Server Status window
Go to Administration ➤ AV Server Status to open the window.
Select Web Integrations from the drop-down menu. Here you will see a "live" view of the logs as they occur. You can double-click into these records to see the detail of each log.
2. Web Integrations Log list view
Go to Administration ➤ Web Integrations Log to open the list-view.
Click Show All to see all Logs or use the existing search tools such as Quick Search or Power Search to find specific logs. You can double-click into these records to see the detail of each log.
Web Integrations Log detail view
Double-click into one of the log records above to see the detail. Below you will find definitions for each field. Different types of logs contain different info -- some fields are not always populated.
These fields should always be populated:
- Web Integration Name (ID): The name and ID of the web integration as entered in System Setup.
- Log Type: The type of record that is being imported or updated.
- Log Sub-Type: The specific action that is being taken on the record.
- Log Date (UTC): This is a date & time stamp for the log. UTC does not change for seasonal adjustments (e.g. daylight savings time).
- The conversion to Eastern Time in the US is:
- Subtract 5 hours during EST (standard time, during winter)
- Subtract 4 hours during EDT (daylight savings time, during summer)
- Subtract an additional hour for each additional time zone to the west.
- The conversion to Eastern Time in the US is:
- Result: The result of the action being processed -- either "Success" or "Error".
- External Log File Name: The name of the text file stored on the server.
- External Log UUID: This is used to find a specific entry in the text log. See External Logs below for more info.
- Log Text Short: This will contain the first 250 characters of the API response. The complete log text can be found in the text file stored on the server for these integrations. See External Logs below for more info.
- Shopify
- BigCommerce
- WooCommerce
- Log Text: The entire log text will appear in this field for these integrations.
- Easypost
- Tax API
- Payment Gateway
-----------------------
Some fields will only be populated when relevant to the type of log you're viewing. For example, you won't always see the Record ID because this ID only exists after a record has been created. If the log is an "Result = Error" log, then no record was created in AcctVantage so there won't be a Record ID.
- Table Name: The name of the table where the record is being imported or updated.
- Record ID: The record ID in AcctVantage. Combine this with the table name to find the record in question.
- Per the screenshot below, [Sales_Document]ID = 77 was successfully imported.
- WI Resource Name: This is the web integration's table name.
- WI Record ID: This is the web integration's record ID.
How to find an entry in the external log
For certain web integrations, the full log text is stored as an entry in a text file on the server at this file path: <live data folder>/Logs/AcctVantage Logs
Use the External Log File Name to find the corresponding external log file within this folder.
Use the External Log UUID to find the corresponding entry within the text file. Each log entry will appear as a single line in the log file.
Each log text entry can be copied and pasted into an external "JSON viewer" application to format it for better readability.
3. System Configuration settings
These settings determine how many days each type of log will be stored in AcctVantage and how many days each external log will be saved on the server. We advise to keep these settings at their default value unless otherwise directed by AV Support.
When it's time for the system to delete logs, the system will automatically delete them as part of the Once Daily Update which runs overnight.
