Skip to content

v3.32.0

Latest
Latest
Compare
Choose a tag to compare
@esurface esurface released this 24 Jan 17:00
v3.32.0
82a7f80

Tangerine v3.32.0 contains a major update to the deployment and fuctionality of Online Surveys including the introduction of authentication and case association.

Online Survey Authentication

Online Surveys can now be released for public access or require authentication. When authentication is required, data collectors will be required to provide a device user Access Code to access the survey. The survey will be associated with the device user who provided the short code.

To deploy an Online Survey and require authentication:

  1. Create the form
  2. Add the "requireAccessCode": true property to the app-config.json file
  3. Navigate to Deploy > Release Online Survey for the group
  4. In the Unpublished Surveys list, click the icon to deploy a survey and require an access code.

Custom Markdown for Online Survey Login Page

Custom styling (text, logos, formatting etc.) can be added to the login page for Online Surveys. In the content set repository, create a file called client/custom-login-markup.html. The file can contain any valid html. Any images can be added to the media folder and used in the html. Example Custom Login Markup.

Online Survey Case Form Authentication

Online Surveys with authentication can also be configured when using the Case Module. This is useful for studies who want to deploy secure forms without needing to install a full PWA or APK for one form associated with the case. For example, a mother-child cohort study deploys Tangerine to track the health of the mother and child after birth. Labs are collected in the field and sent for analysis. Instead of requiring the lab to install a tablet or PWA with the Tangerine app, the lab forms can be deployed online to simplify the completion process.

To configure forms for secure deployment online in Case, add the "allowOnline": true property to the eventFormDefinitions section in the case definition file. See the form definition for form-allowed-online-survey in case-type-1.

Online Survey Help Link

A help link can be added to the web pages for Online Surveys and will appear with the icon in the header. Define the link url by adding the "helpLink": "https://www.tangerinecentral.org" property to the app-config.json file. When clicked, the link will open in a new browser window.

Tangerine Case APIs

  • /userProfile/createUserProfile/:groupId
    • Creates a user-profile document in the group
    • Additional body data in json format will add properties to the user-profile: { "age": "7", "dob": "1/1/2018"}
  • /case/createCase/:groupId/:caseDefinitionId
    • Creates a case in the group with the case type defined by the case definition id
    • Additional body data in json format will add properties to the case: { "age": "7", "dob": "1/1/2018"}
  • /case/readCase/:groupId/:caseId
    • Read a case from the group with the case id
  • /case/createCaseEvent/:groupId/:caseId/:caseDefinitionId/:caseEventDefinitionId
    • Creates an event with the event type as defined in the case definition
  • /case/createParticipant/:groupId/:caseId/:caseDefinitionId/:caseRoleId
    • Creates a participant with the case role as defined in the case definition
  • /case/getCaseEventFormSurveyLinks/:groupId/:caseId/
    Returns a JSON document with the urls for all case forms with active online surveys in the format: 
    {
  "eventDefinitionId": event.caseEventDefinitionId,
  "eventFormDefinitionId": eventForm.eventFormDefinitionId,
  "formId": formId,
  "url": url
}

Server upgrade instructions

See the Server Upgrade Instructions.

Special Instructions for this release: N/A

Assets 2
Loading