Difference between revisions of "SmartSimple System Logs"

From SmartWiki
Jump to: navigation, search
(major updates to the system logs available in the platform)
Line 1: Line 1:
−
The following table outlines all logging mechanisms within the SmartSimple Platform.
+
The following table outlines all logging mechanisms within the SmartSimple Platform. Logs can be viewed through the regular platform interface, by system administrators, while a subset of these logs may also be made available to non-administrator users as well. Some logs may also be made available to export through the use of Report Builder feature, as indicated by the Available to Export column. Certain logs are feature, or configuration dependent, and as such will not automatically be captured unless explicitly enabled, as indicated by the Requires Configuration to Enable column.
  
−
{| border="1"
+
{|class="wikitable"
−
! align="center" | Log Type ||  align="center" | Log ||  align="center" | Description ||  align="center" | Available in Interface ||  align="center" | Available in Reporting
+
!| Log Type
 +
!| Log
 +
!| Description
 +
!| Requires Configuration to Enable
 +
!| Available to Export
 
|-
 
|-
−
| System || Login History || Tracks login and logout date and time || No || Yes
+
|| Access
 +
|| Access Modification
 +
|| Changes to a user's access. Captures the following actions:
 +
* activation/deactivation of user.
 +
* change to user role.
 +
* password resets.
 +
||
 +
||  
 
|-
 
|-
−
| System || Locked Users || Tracks locked users || Yes || No
+
|| Access
 +
|| Failed Login
 +
|| Failed authentication attempts.
 +
||
 +
||  
 
|-
 
|-
−
| System || Locked User History || Tracks all locked users by month || Yes || No
+
|| Access
 +
|| Login Session
 +
|| Successful logins, and user sessions. Captures the following attributes:
 +
* session start time.
 +
* session end time.
 +
* user's originating IP address.
 +
* user's browser agent.
 +
||
 +
|| Yes
 
|-
 
|-
−
| System || Message Queue || All messages generated by all workflow requests across all applications. || Yes || No
+
|| Access
 +
|| Primary Authentication Controller Login
 +
|| User logins that originate from the Primary Authentication Controller feature, which allows users to authenticate between SmartSimple instances. The system will automatically capture these logs as long as the Primary Authentication Controller is configured, and used to authenticate between instances.
 +
||  
 +
|| Yes
 
|-
 
|-
−
| System || Contacts and Companies || Logs all deleted contacts and companies.  Records can be retrieved by System Administrator. || Yes || No
+
|| Access
 +
|| Usage History
 +
|| Each individual page request made during a user's active session.
 +
||  
 +
||  
 
|-
 
|-
−
| System || Custom Field Setting || Tracks history of changes made to custom field settings. Feature must be enabled for each custom field.  This function is not available for standard field outside the UTA. || Yes || No
+
|| System Configuration
 +
|| Field Deletion
 +
|| Custom fields that have been deleted. The previous states of each field are captured to allow you to restore the field if needed.
 +
||  
 +
||  
 
|-
 
|-
−
| System || Deleted Custom Fields || Logs all deleted custom fields. Fields can be retrieved by System Administrator. || Yes || No
+
|| System Configuration
 +
|| Field Modification
 +
|| Changes made to custom field configurations, from field formatting, to access permissions. The previous states of each field are captured to allow you to restore the field if needed.
 +
||  
 +
||  
 
|-
 
|-
−
| System || Field Value || Tracking change history of changes to fields’ values. || Yes || No
+
|| System Configuration
 +
|| General System Modification
 +
|| Changes made to various system areas. Captures changes to the following areas:
 +
* Reports.
 +
* Workflows.
 +
||  
 +
||  
 
|-
 
|-
−
| System || Geocoding || User requests to retrieve Latitude and longitude for company or contact. || No || No
+
|| System Configuration
 +
|| Security Matrix Modification
 +
|| Changes made to security matrix constructs that define the access control permission of user roles to UTA records, companies, and users.
 +
||  
 +
||  
 
|-
 
|-
−
| UTA || Reader Log || Tracking viewers for level 1, 2 and 3 objects.  Feature must be enabled in UTA. || Yes || No
+
|| Error
 +
|| System Error
 +
|| System errors occurring in the platform, as a result of the configuration and usage of your instance.
 +
||  
 +
||  
 
|-
 
|-
−
| UTA || Status Change || Tracks status changes for level 1, 2 and 3 objects. Feature must be enabled in the status field at the required level. || Yes || Yes
+
|| Operational
 +
|| API Usage - SmartConnect RESTful
 +
|| API calls made to the SmartConnect RESTful API receiver.
 +
||  
 +
||  
 
|-
 
|-
−
| UTA || Record Lock || Tracks locked record history for level 1, 2 and 3 objects. Feature must be enabled in UTA for the required level || No || No
+
|| Operational
 +
|| API Usage - SOAP Web Service
 +
|| API calls made to the SOAP Web Service API receiver.
 +
||  
 +
||  
 
|-
 
|-
−
| UTA || Package Exchange || Tracks the transfer of packages from one instance of SmartSimple to Another. || Yes || No
+
|| Operational
 +
|| Integration Usage - Data Exchange
 +
|| Activity related to the use of the Data Exchange feature, which is used to exchange records between instances.
 +
||  
 +
||  
 
|-
 
|-
−
| API Requests || Request History || Tracks all Pandora API requests including the developer ID, Request function and the date/time of the request || No || No
+
|| Operational
 +
|| Integration Usage - E-Signature
 +
|| Activity related to the use of E-Signature integration feature, which is used to send E-Signing requests to supported partner systems.
 +
||
 +
||
 
|-
 
|-
−
| External WebPages || Access History || History of access to all external pages via the Internet. These include signup pages (Applicant and standard) and external reporting pages || Yes || No
+
|| Operational
 +
|| Message Queue
 +
|| Email messages generated and sent from the system.
 +
||  
 +
||  
 
|-
 
|-
−
| OS Level || Apache Logs || A set of Apache logs is maintained.  This link provides further details: http://httpd.apache.org/docs/1.3/logs.html || No * || No *
+
|| Operational
 +
|| Privay and Security Policy Agreement
 +
|| User acceptance of system privacy and security policies.
 +
||  
 +
|| Yes
 
|-
 
|-
−
| OS Level || SSH Log || SSH Access log is maintained. This link provides further details: http://www.ssh.com/support/documentation/online/ssh/adminguide32/log_messages.html || No * || No *
+
|| Operational
 +
|| Record Deletion
 +
|| Deletions of records, from UTA records, to companies, to users.
 +
||
 +
||
 +
|-
 +
|| Operational
 +
|| Record Modification
 +
|| Changes made to records, from UTA records, to companies, to users. The track changes option must be enabled for each individual field that you wish to track the change history of. Captures changes to the following attributes:
 +
* standard field values, including status.
 +
* custom field values.
 +
|| Yes
 +
|| Yes
 +
|-
 +
|| Operational
 +
|| Record View
 +
|| Tracks each time UTA records are opened and accessed by users. The reader log option must be enabled within each UTA, and each UTA record level in order to track this.
 +
|| Yes
 +
|| Yes
 +
|-
 +
|| Operational
 +
|| Workflow Process
 +
|| Automated Workflow tasks that have been triggered and run against records.
 +
||  
 +
||  
 
|}
 
|}
−
<nowiki>*</nowiki> Logs that are not available in the interface or reporting system are still available though direct access to the OS.
 
  
 
[[Category:Security]]
 
[[Category:Security]]

Revision as of 20:00, 26 July 2021

The following table outlines all logging mechanisms within the SmartSimple Platform. Logs can be viewed through the regular platform interface, by system administrators, while a subset of these logs may also be made available to non-administrator users as well. Some logs may also be made available to export through the use of Report Builder feature, as indicated by the Available to Export column. Certain logs are feature, or configuration dependent, and as such will not automatically be captured unless explicitly enabled, as indicated by the Requires Configuration to Enable column.

Log Type Log Description Requires Configuration to Enable Available to Export
Access Access Modification Changes to a user's access. Captures the following actions:
  • activation/deactivation of user.
  • change to user role.
  • password resets.
Access Failed Login Failed authentication attempts.
Access Login Session Successful logins, and user sessions. Captures the following attributes:
  • session start time.
  • session end time.
  • user's originating IP address.
  • user's browser agent.
 Yes
Access Primary Authentication Controller Login User logins that originate from the Primary Authentication Controller feature, which allows users to authenticate between SmartSimple instances. The system will automatically capture these logs as long as the Primary Authentication Controller is configured, and used to authenticate between instances. Yes
Access Usage History Each individual page request made during a user's active session.
System Configuration Field Deletion Custom fields that have been deleted. The previous states of each field are captured to allow you to restore the field if needed.
System Configuration Field Modification Changes made to custom field configurations, from field formatting, to access permissions. The previous states of each field are captured to allow you to restore the field if needed.
System Configuration General System Modification Changes made to various system areas. Captures changes to the following areas:
  • Reports.
  • Workflows.
System Configuration Security Matrix Modification Changes made to security matrix constructs that define the access control permission of user roles to UTA records, companies, and users.
Error System Error System errors occurring in the platform, as a result of the configuration and usage of your instance.
Operational API Usage - SmartConnect RESTful API calls made to the SmartConnect RESTful API receiver.
Operational API Usage - SOAP Web Service API calls made to the SOAP Web Service API receiver.
Operational Integration Usage - Data Exchange Activity related to the use of the Data Exchange feature, which is used to exchange records between instances.
Operational Integration Usage - E-Signature Activity related to the use of E-Signature integration feature, which is used to send E-Signing requests to supported partner systems.
Operational Message Queue Email messages generated and sent from the system.
Operational Privay and Security Policy Agreement User acceptance of system privacy and security policies. Yes
Operational Record Deletion Deletions of records, from UTA records, to companies, to users.
Operational Record Modification Changes made to records, from UTA records, to companies, to users. The track changes option must be enabled for each individual field that you wish to track the change history of. Captures changes to the following attributes:
  • standard field values, including status.
  • custom field values.
 Yes Yes
Operational Record View Tracks each time UTA records are opened and accessed by users. The reader log option must be enabled within each UTA, and each UTA record level in order to track this. Yes Yes
Operational Workflow Process Automated Workflow tasks that have been triggered and run against records.
Retrieved from ‘https://wiki.smartsimple.com/index.php?title=SmartSimple_System_Logs&oldid=38848’