Skip to content
This repository has been archived by the owner. It is now read-only.
Permalink
Browse files
updated README
  • Loading branch information
dvreed77 committed Jul 11, 2014
1 parent 87a9f36 commit 4982dbc9f57986554917893b3498ca4b155dfbde
Showing 1 changed file with 44 additions and 0 deletions.
@@ -0,0 +1,44 @@
#User-ALE

##Background

The User Activity Logging Engine, or User-ALE, is a logging mechanism used to quantitatively assess the behavioural and cognitive state of a data analyst while interacting with Big Data Exploitation Systems (BDES).

To accurately measure the cognitive state of the user, tool developers associate model based workflow states with each user action. Did a user pan a map? Then they are exploring. Did a user click a search button? Then they are getting new data. These model based activities can then be processed to measure hidden empirical states that describe more accurately the user's workflow and behaviour.

##Who is the package for?

This package is for developers creating User facing tools, and who would like to log the users interaction with this tool, in order to gain an insight into the behavioural and cognitive state of the user.

##JavaScript Quickstart
Download both the latest logging library and the latest worker library from Github.

###Instantiate the JavaScript Logger
```javascript
// web worker url
var worker = 'js/draper.activity_worker-2.1.1.js'
var ac = new activityLogger(worker);
.testing(true) // simulate POST, won't send log
.echo(true) // log to console
.mute(['SYS']); // don't log SYSTEM actions
```

###Register the logger
```javascript
ac.registerActivityLogger(
"http://xd-draper.xdata.data-tactics-corp.com:1337",
"my-component",
"v0.1"
);
```

###Log a User Action
```javascript
$('#button').mouseenter(function() {
ac.logUserActivity(
'User hovered over element to read popup', // description
'hover_start', // activity_code
ac.WF_EXPLORE // workflow State
);
})
```

0 comments on commit 4982dbc

Please sign in to comment.