Transaction Log
ClaySys AppForms offers a dedicated setting that enables users to examine every request and response exchanged with a third-party web service or APIs. This functionality is particularly valuable for confirming that the system is sending the correct requests and receiving accurate responses from the server. This powerful feature ensures visibility into the communication flow, allowing users to verify the accuracy of data exchanged between the application and external servers.
Let’s explore how to check transaction logs. Click on the Transaction log link from the left navigation panel as shown in the image below.
When the user clicks on the Transaction Log link, they will be redirected to the transaction log page, as illustrated in the image below.
The transaction log page contains two tabs:
- API Log
- Form as API Log
1. API Log
API Log provides a comprehensive record of all requests and responses exchanged with external web services. By examining this log, users can analyze every request and response sent to an external web service.
Users can filter records using a variety of criteria, including username, form name, data source name, status, and page size. They also have the option to view all records or filter them by specific time intervals, such as the last 1 minute, 10 minutes, or 1 hour. For more detailed filtering, a custom date range can be set by entering a start and end date. These filtering options are accessible via the “Show Records For” combo box. Once the desired filters are selected, clicking the Search button will display the results in the grid based on the applied criteria. A Clear button is also provided to reset all applied filters.
There is an option to view details of request and response as shown in the image below.
By clicking the “Details” button within the grid, users can examine the requests and responses associated with a specific transaction.
The request and response page appears as shown in the image below.
Additionally, the “Download” button, shown in the image below, allows users to directly download the request and response details for a specific transaction from the page.
When the download button is clicked, the request and response data will be saved to the user’s system.
To support efficient log management, the Clear Transaction Log button enables users to selectively delete logs. When clicked, a dialog appears allowing users to specify the retention period in days for keeping recent transaction records as shown in the image below.
Finally, clicking the Clear button completes the process by retaining only the transactions within the specified retention period and removing the rest from the database. This streamlined feature helps ensure efficient monitoring and maintenance of transaction logs within the ClaySys AppForms environment.
The correlation ID of each log will be added corresponding to the log as demonstrated in the image below. The CorrelationID helps track and connect related transactions in the log.
2. Forms as API Log
The FormAsAPI Log provides a comprehensive record of all requests and responses related to using a form as an API. It enables users to review and analyze the logged data for a clearer understanding of the information being exchanged. FormasAPI log has the same filters, grid structure, details and download option as API Log page.
The Forms as API Log page appears as shown in the image below.
User access Log:
When the Trace User Access option is enabled in beta version of tenant settings, User access log tab appears in Transaction log page as shown in the image below.
The User Access Log tracks all users who have accessed the system. It includes filter options such as user, message, start date, and end date. After setting the desired filters, clicking the Search button displays the results in a grid based on the selected criteria. The Clear button resets all filters.
Additionally, the Details option provides users with in-depth information about a specific entry, including the user, message, form ID, form path, and more, as illustrated in the image below.
