v11 Upgrade

1 Introduction
2 Errors
- 2.1 Unable to import CP from lower version to v11
- 2.2 Blank specimen edit page
3 Missing Buttons
- 3.1 Receive button
- 3.2 Process Aliquot
- 3.3 Rapid Data Entry
4 JSON Configuration
5 Deprecated Features

Introduction

This document aims to assist users in identifying and resolving common errors that may occur in v11 of OpenSpecimen. These issues often arise due to recent enhancements and updates to the software

Errors

After upgrading to version 11, you can expect the errors listed below. We have provided solutions to fix these.

Unable to import CP from lower version to v11

When you export a CP definition file from a version lower and try to import it on v11, you will get below error

Error message: Error: NullPointerException:Cannot invoke "java.util.List.iterator()" because "units" is null(COMMON_SERVER_ERROR)

Solution:

Add the code "units" : [ ] in Collection Protocol (JSON) file and import CP JSON.

Find the below JSON file for the reference,

Blank specimen edit page

This error ‘unexpected ‘=' at character 27:’ is displayed when there is a skip logic defined in the form. The equality check has changed from ‘=’ to '==’ in the version 11.0

Solution:

Please refer to the wiki page Skip Logic for fields in Form (v11) for the solution.

Missing Buttons

After upgrading to version 11, the buttons listed below will no longer be visible on the user interface. If you were utilizing these features prior to the upgrade, please contact us so that we can assist you with the necessary workflows.

Receive button

From v10.3 and higher, the receive feature is replaced by workflow. Users need to upload the correct receive workflow and connect it with the ‘Receive’ button. The workflow can be downloaded from thehttps://openspecimen.atlassian.net/wiki/spaces/CAT/pages/2481192988page. i) Standard Receive specimens ii) Receive Specimen and relabel.

Process Aliquot

From v11, the process aliquot feature is replaced by workflow. Users need to upload the process workflow. The workflow can be downloaded fromhttps://openspecimen.atlassian.net/wiki/spaces/CAT/pages/2481192988: i) Process Aliquots.

Rapid Data Entry

From v11, the RED feature is replaced by workflow. Users need to upload the correct RDE workflow and connect it with the 'Rapid Data Entry' button. The workflow can be downloaded fromhttps://openspecimen.atlassian.net/wiki/spaces/CAT/pages/2481192988: i) Register Participant and Collect Specimen.

If you can’t access the https://openspecimen.atlassian.net/wiki/spaces/CAT/pages/2481192988 page, you need to send an email to support@krishagni.com.

JSON Configuration

#1. From version 11 onward, certain JSON configurations are no longer supported. However, most of these functionalities can be accomplished through default or custom workflows. For the list of unsupported configurations, please refer to the wiki page Not-Supported Configuration List from V11.

#2. Users need to add a caption to the subform field in v11 onwards to display it on the add/edit/overview pages. Failure to include the caption will result in only the '+Add' sign being visible. Please refer to the subform examples no 24 and 25 Attribute Types Examples

#3. Collection Date & Time and Received Date & Time captions are incorrectly displayed as 'Collection Date & Time' and 'Received Date & Time' on the UI.

Reason: The symbol "&" poses a potential security risk that could lead to data compromise. As it originates from user-configured JSON, it is challenging to determine the innocence of this symbol. Therefore, it is escaped using HTML entity &

Solution: Users are required to include a caption using the 'and' symbol rather than the '&' symbol in the dictionary section of the JSON file. For instance, "Collection Date and Time" should be used instead of "Collection Date & Time."

Deprecated Features

From v11 below features are deprecated from OpenSpecimen Biospecimen Data entry pages: