Skip to content
CARP Documentation

deployment

Deployments: turning a study protocol into what runs on each device.

A StudyDeployment maps a StudyProtocol to runtime configurations (PrimaryDeviceDeployment) used by the client subsystem, and lets researchers monitor its state (StudyDeploymentStatus). To start collecting data, participants are invited, devices are registered, and participant data (e.g., consent) is collected.

Main types: DeploymentService, ParticipationService, StudyDeployment, StudyDeploymentStatus, PrimaryDeviceDeployment and ParticipantData.

See the carp.deployments definition in Kotlin.

Classes

  • ActiveParticipationInvitation — An invitation to participate in an active study deployment using the assignedDevices.
  • AssignedPrimaryDevice — Primary device and its current registration assigned to participants as part of a participant group.
  • CreateStudyDeployment — A request for creating a deployment based on the protocol.
  • DeploymentService — Application service which deploys study protocols to participants and hands out the PrimaryDeviceDeployment for each primary device.
  • DeploymentServiceRequest — A DeploymentServiceRequest and all its sub-classes contain the data for sending an RPC request to a DeploymentService on the CARP web service.
  • DeviceDeployed — A request for reporting a device deployment as successful.
  • DeviceDeploymentStatus — The status of one device in a study deployment.
  • GetActiveParticipationInvitations — A request for getting the deployment invitations for an account id.
  • GetDeviceDeploymentFor — A request for getting the deployment for a primary device.
  • GetParticipantData — A request for getting the participant data of a study deployment.
  • GetParticipantDataList — A request for getting the participant data for a list of studyDeploymentIds.
  • GetStudyDeploymentStatus — A request for getting the status of a study deployment.
  • GetStudyDeploymentStatusList — A request for getting the status of a list of study deployments.
  • ParticipantData — Participant data for all participants in a study deployment with studyDeploymentId.
  • ParticipantInvitation — The information which needs to be provided when inviting a participant to a deployment.
  • ParticipantStatus — The status of a participant in a study deployment.
  • Participation — Uniquely identifies the participation of an account in a study deployment.
  • ParticipationService — Application service which allows inviting participants, retrieving participation invitations for study deployments, and managing data related to participants which is input by users.
  • ParticipationServiceRequest — A ParticipationServiceRequest and its sub-classes contain the data for sending a request to a ParticipationService on the CARP web service.
  • PrimaryDeviceDeployment — Everything a single primary device needs to run its part of a study.
  • RegisterDevice — A request for registering a device in a study deployment.
  • RoleData — Participant data for all participants with a specific roleName.
  • SetParticipantData — A request for setting participant data in a study deployment.
  • Stop — A request for permanently stopping a study deployment.
  • StudyDeployment — A single instantiation of a StudyProtocol, taking care of common concerns related to devices when 'running' a study.
  • StudyDeploymentStatus — The status of a study deployment and of its devices and participants.
  • StudyInvitation — A description of a study, shared with participants once they are invited to a study.
  • UnregisterDevice — A request for unregistering a device from a study deployment.

Enums