API Activity logs store information about transactions that take place between Eclipse and other systems outside our system, such as the Avalara tax calculation software. You can sort the logs, such as by times, transaction or partner type.
Note: You must have the companion product enabled to review the log for that companion's configuration.
To review the API activity log:
From the System > System Programming > API Maintenance menu, select API Activity Log to display the API Activity Logs window.
Use the header fields to filter the logs you want review:
|
Field |
Description |
|
Start Date |
Enter the date range for which you want to view current API activity logs. |
|
End Date |
|
|
Start Time |
Enter the time range for which you want to view current API activity logs. |
|
End Time |
|
|
Partner Type |
Select which kind of transaction you want limit the displayed logs to: Customer, Vendor, Trading Partner, or Service. |
|
Partner |
This field activates if you select Trading Partner in the Partner Type field. Enter the specific partner to which you want to limit the log viewing. |
|
Session Login Type |
Select which kind of login you want to limit the displays logs to: Eclipse User or Contact. |
|
Session Login |
This field activates after you make a selection in the Session Login Type field. Enter the specific login for which you want to limit the log viewing. |
|
Transaction |
Select a specific transaction type to limit the logs to. This list is hard coded in Eclipse. |
|
Record ID |
Enter a transaction number, such as a sales order number, to limit the activity logs to a specific record. |
|
Keyword |
Enter a keyword on which to display activity logs, such as Tax. |
|
Source |
Enter a source type on which to display activity logs, such as Internal. |
Click Update.
The system displays the following view-only information for the selected transactions:
|
Column |
Description |
|
Date |
The date the API transaction took place. |
|
Time |
The time the API transaction took place. |
|
Transaction |
The transaction type, such as Avalara Tax Lookup. |
|
Partner |
The partner to whom the transaction was sent or received. |
|
Session Login |
Indicates which user initiated the transaction. |
|
Source |
The source, such as Internal, that the transaction was initiated. |
|
Record ID |
The transaction ID, such as the sales order number. |
|
Response (ms) |
The response time of the transaction in milliseconds. |
|
Archive In |
The file size when the transaction was put in or taken out of archive. |
|
Archive Out |
Select the transaction you want to view.
From the Options menu, select View Archives.
The API Activity Archives for that transaction displays. You can review both inbound and outbound archive data to troubleshoot or verify information for the transaction. Use the tabs to review the following information:
General Header Info - Provides subroutine and login information on the specific transaction.
Inbound Data - Raw data that Eclipse receives from a third party, such as Avalara, for the transaction.
Outbound Data - Raw data that Eclipse send to a third party, such as Avalara, for the transaction.
Error Info - If the transaction failed, details regarding how or why the transaction could not be processed.
Exit the archives window.
Review additional transactions or exit the window.