Component Definitions

This page documents the entities represented in the Server GUI.

Layout

• Left (sidebar) menu items
  • each represents an existing protocol
  • each navigates to a workspace
• Main workspace
  • Dashboard
  • Data export
  • Workspace-specific settings
• Top bar
  • Displays paired device count

Workspaces

A Workspace has a 1:1 relationship to a protocol, and encapsulates all information, data, and settings for that protocol.

Protocols

A protocol has one or many versions.

A protocol version:

• has a single file, which contains a protocol.json definition
• Is uniquely identified by its protocol's ID + the Version ID (specified in the protocol.json)
• defines the content and format of an interview.
• has many data documents (user responses, analytics sources, etc.)

The filename associated with a protocol version may be changed internally. Files may be edited and replaced by the user.

Devices

A device is associated with a server once it has completed a pairing process. It has access to any and all protocols available on the Server. It has no direct relationship to workspaces.