Skip to content

About Users, Classes and Campaigns

joshuaselsky edited this page Mar 16, 2012 · 25 revisions

Users, campaigns and classes are the central entities that control access to ohmage.

The proverbial user is the person who can authenticate with the system and perform certain actions.

The actions a user can perform are defined by

  1. bit attributes on the user table
  2. the user's class role
  3. the user's campaign role

Creating Users

The admin role is the only role in ohmage that is allowed to create other users in the system. ohmage ships with a default admin account.

When a user is created, the following properties must be set:

  • username - must be between 4 and 25 characters and must contain at least one alphanumeric character; it may also include . _ @ + -
  • password - must be between 8 and 16 characters; must contain at least one lowercase character; must contain at least one uppercase character; must contain at least one digit; and must contain at least one of the following: , . > < [ ] ! @ # $ % ^ & * + - { } | :

When a user is created, the following properties may be set:

  • enabled - the default is true; if this is set to false, the user will not be able to login
  • can create campaigns - the default is false
  • make admin - the default is false
  • require password change on first login - the default is true

Note: we are currently implementing self-registration for our 2.11 release (ETA mid April 2012).

Creating Classes

The admin role is the only role in the system that may create classes. Classes represent a named group of users.

When creating a class, the following properties must be set:

  • class URN - a URN that must be unique to the ohmage instance; the typical syntax is urn:class:..., but any URN is allowed
  • class name - a descriptive name of the class, e.g., 'ADHD Pilot'

When creating a class, the following properties may be set:

  • description - a class description, e.g., 'The ADHD Pilot Class. Users will be periodically asked to play a 'focus game' on their mobiles and the results will be collated to quantify ADHD symptoms'.