Chapter 3. Server-side configuration: User account registration and preferences

Table of Contents

3.1. Introduction
3.2. Account Registration
3.3. Overview of Workspaces, WorkspaceFiles, and Workspace Roots
3.4. Defining Workspace Roots
3.5. Overview of Hackystat Projects
3.6. Project Registration
3.7. Editing and Deleting Projects
3.8. Inviting, Confirming, and Declining Project membership
3.9. An example Project-based analysis: Daily Project Details
3.10. Hackystat Alerts

3.1. Introduction

As noted previously, Hackystat is a client-server system, where the "client" consists of your local development environment, and the "server" consists of the Hackystat web application which receives and stores the raw data generated your sensors and performs analyses on them. The purpose of this chapter is to explain how you can set up and configure your Hackystat account in order to best organize and interpret your sensor data and those with whom you collaborate.

Defining a Hackystat account involves using a browser to go to a Hackystat server and registering as a user. Upon successful registration, you will receive an email containing a 12 character "user key", which functions both as your account name and password for this server. You provide this key to HackyInstaller, which saves it into a file called sensor.properties. Your sensors read this file to find your user key and then include it when they send data to the Hackystat server. This is how the server knows what account in which to store each incoming packet of sensor data.

Once registered, you will want to configure your account by defining Workspace Roots and Projects. Workspace Roots enable the system to generate an abstract representation of the location of a file in a file system that helps support analyses on groups of developers working on multiple platforms. Projects provide a representation for a set of sensor data that should be analyzed together by specifying a set of developers, a set of Workspaces, and a time interval.

The next section of this chapter describes the account registration process. The following sections describe Workspaces and how to define Workspace Roots. The following sections describe Projects. The final section pulls it all together with some examples of how these concepts work together to provide useful analyses on your data.