System Usage Log

How Can We Help?

< Back
This new feature will require App 2.2.4 or later, as well as API 6.6.0.2 or later

In version 2.2.4 of XMPro Act, we’ve introduced a way to keep track of user’s activities. This includes both who is using the app, and what activities are being used. The actions that are logged are:

  • Users signing in
  • Syncing (daily, partial and full syncs are logged separately)
  • Opening first activities
  • Submitting activities (both first and pending activities)

If opening or submitting an activity fails, the action will still be logged, and the error message will be included.

The information logged with these actions are:

  • The user’s name
  • The action they took
  • Any identifiers for the action (e.g. the name of the activity that was opened)
  • Any description for the event (e.g. any errors that occurred, sync times)
  • Whether it was done from the Task Queue
  • Whether it was done on Mobile or Workspace
  • What time and date the action was done

Actions are logged in the SystemUsageLog table in the Internal database. The table is set up as such:

Column Name Data Type Allows Nulls
id int False
Username varchar(250) False
EventName varchar(50) False
Identifier int True
Description varchar(1000) True
FromQueue bit True
IsMoblie bit False
EventDate datetime false
Sample Data below:

Please note that currently actions in Workspace aren’t logged, so the IsMobile column will always be true.

The System Usage Log table creation is found in ViewCreationScript.sql in the API (found in the root folder of the API). System Usage Logging is not required for the API to function, so if logging is not wanted, the System Administrator can comment the creation out before installation. Comment out this section:

If you would like to disable System Usage Logging after installation, the System Administrator will need to drop the SystemUsageLog table. You can reenable it by running the above script again.

 

Comments are closed.

This is the legacy version of the XMPro Documentation site. For the latest XMPro documentation, please visit documentation.xmpro.com

X