Transactions Log Viewer

The ADSS SAM Service keep record of every request and corresponding response made to the service in the transactions log for auditing purpose. Each item in the image is described below:

Each item in the screenshot is described below:

Items	Description
Clear Search	After a Search this window will only show the filtered records. The Clear Search button is used to view the full set of records.
Search	This opens a new window where search criteria can be entered based on each column of the transaction grid.
Customise Columns	This opens a new window to configure which column need to be shown in the grid and which column need to be hidden. See below for more details.
\|< < > >\|	These buttons are for navigating the different pages of the transaction log. Note: The number of records shown per page is configurable from within Global Settings.
Export Logs	This button is used to export the selected transactions log into a zipped CSV file in which each column is separated by literal '~&~'. The file can be viewed using Microsoft Excel. However, in order to view and analyze the contents of the file in detail (all the archived transactions etc.), the user needs to import the file into ADSS using the Import Archived option.
Verify Integrity	Verifies the integrity of the SAM service transaction log records. It detects tampered and deleted records and generates a report that can be exported to a physical drive. Note: When exporting HMAC verification reports, it is recommended to save the file with “.html” extension so that the report can be viewed in an internet browser.
Show Archived	This opens a new window where you can import and view previously archived file i.e. archived/exported transactions log.
Log ID	A unique serial number for the log record, it is system-defined and not part of the request/response messages.
Request Type	This element identifies the type of request that was received. The acceptable requests are: User Services Register User, Update User, Delete User, Get User, Get Users, Change Password, Authenticate User, Recover Password, Confirm Recover Password, Change User Email, Confirm Change User Email, Change User Mobile, Confirm Change User Mobile, Get User Device Settings. Certificate Services Generate Key Pair, Delete Key Pair, Get CSR, Import Certificate, Get User’s Certificate, Get User’s Certificates. Signing Services Create Authorisation Request, Sign Hash, Get Pending Authorisation Request, Cancel Authorisation Request. Device Services Register Device & Certificate, Get Registered Devices, Delete Device, Get Device Information. OTP Services Generate OTP, Verify OTP. System Information Get System Information. Profile Information Get System Information.
Response Status	This shows whether a “success”, “pending” or “failure” response was returned.
Request Time	Records the date/time when the request was received.
Response Time	Records the date/time when the response was sent.
Request/Response	Provides a link to view the request/response messages.
Client ID	This is the client’s ID as found in the request message. ADSS SAM Service verifies it is a legitimate Client ID as registered in the Client Manager module before granting access to the SAM service. For more details see the link Registering Business Applications.
IP Address	Records the IP address of the requester.
TLS Cert	Clicking on “View” link under this column displays the TLS client authentication certificate. The “View” link is only present when TLS client authentication was used to send requests to the SAM service.
Error Code	Hover your mouse over the "View" link to show the error message e.g. User ID or password is invalid, User ID does not exists, OTP is either invalid or expired etc.

The SAM Service transaction records can be sorted in either ascending or descending order by selecting a table column from the drop down list. From the drop down menu in above screen, click on the Import Archived option, it will show the following screen:

Each item in the screenshot is described below:

Items

Description

Import archived transaction file

Use this option to browse the archived log file in zip format from the user machine. By using this option the archived log file is uploaded on the ADSS Server. It can be an expensive operation if the file is of large size so the user is allowed to upload a file with maximum size up to 25 MB. Use the archived file path option for files bigger than 25 MB.

Archived transaction file path

Use this option if the file size is greater than 25 MB. This option does not upload the archived file to the server. Rather the server reads the file from given file path before importing which is faster than the above option. You can either specify the local file system path or a network path.

Note: Do specify the archived log file name in the file path.

The archived files were created in the CSV format till ADSS Server v4.7.5 but from v4.7.6 and onward the archived files are zipped to save the disk space when archiving. If you are importing the archived files created using a pre-v4.7.6 deployment to ADSS Server v4.7.6 or later then first zip them before importing otherwise ADSS Server will not recognise them as correct archived files.

As explained above, clicking on the Search button on SAM Transactions Log Viewer displays following screen:

This helps to locate a particular type of SAM service transaction. The transaction can be searched based on "Log ID", "User ID", "Client ID", "IP Address", "Request Type", "Response Status", "Request Time From", "Request Time To", "Response Time From" and "Response Time To". If a search is based on multiple values, then these will be combined together using the “AND” operand, and thus only records that meet all the criteria will be presented.

If "_" character is used in the search then it will act as wildcard.

Clicking on the Customise Columns button on SAM Transactions Log Viewer displays the following screen:

By default few columns are in the "Selected Columns" list. In order to hide a column move the required column to the "Available Columns" list

Each log record within the database is protected with a cryptographic HMAC checksum to detect any intentional or accidental modification of records. Clicking the Verify Integrity button verifies the log integrity by checking each checksum and generates a report as shown below:

Click on the Export logs button to export the request/response to a network file.

The transaction logs are not exported according to the applied filter/search, they are exported as a complete zip file.

Clicking the Fix HMAC Errors button will re-calculate the HMAC for tampered transaction logs records for this module.

Note: This option will not detect the unauthorized deleted records but it will only fix the unauthorized modifications and/or ambiguous records for which HMAC value is not present/incorrect.

Verify Integrity feature is available for the transactions log of all services within ADSS Server.

Clicking on the link for Log ID shows detail of the selected transaction as shown below:

Clicking on View link under the request/response column shows the JSON request and response for the selected SAM transaction in different tabs:

Clicking on the Response tab shows the JSON response as below:

You can export the request/response JSON files on to a physical drive by clicking the relevant Export Response button.