Add an import feature at cases to update the survey token responses #13199

Marin · Marin · commit 725d2a50df9d · 2025-02-25T09:13:07.000+02:00
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/i18n/Captions.java b/sormas-api/src/main/java/de/symeda/sormas/api/i18n/Captions.java
@@ -85,6 +85,7 @@ public interface Captions {
 	String actionImportAllContinents = "actionImportAllContinents";
 	String actionImportAllCountries = "actionImportAllCountries";
 	String actionImportAllSubcontinents = "actionImportAllSubcontinents";
+	String actionImportSurveyTokenResponses = "actionImportSurveyTokenResponses";
 	String actionImportSurveyTokens = "actionImportSurveyTokens";
 	String actionLastModifiedByLabel = "actionLastModifiedByLabel";
 	String actionLeaveBulkEditMode = "actionLeaveBulkEditMode";
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/i18n/Strings.java b/sormas-api/src/main/java/de/symeda/sormas/api/i18n/Strings.java
@@ -706,6 +706,7 @@ public interface Strings {
 	String headingImportRegions = "headingImportRegions";
 	String headingImportSelfReports = "headingImportSelfReports";
 	String headingImportSubcontinents = "headingImportSubcontinents";
+	String headingImportSurveyTokenResponses = "headingImportSurveyTokenResponses";
 	String headingImportSurveyTokens = "headingImportSurveyTokens";
 	String headingImportTravelEntries = "headingImportTravelEntries";
 	String headingIncorrectDateRange = "headingIncorrectDateRange";
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/importexport/ImportFacade.java b/sormas-api/src/main/java/de/symeda/sormas/api/importexport/ImportFacade.java
@@ -75,6 +75,8 @@ public interface ImportFacade {
 
 	void generateSurveyTokenImportTemplateFile(List<FeatureConfigurationDto> featureConfigurations) throws IOException, NoSuchFieldException;
 
+	void generateSurveyTokenResponsesImportTemplateFile(List<FeatureConfigurationDto> featureConfigurations) throws IOException, NoSuchFieldException;
+
 	String getCaseImportTemplateFileName();
 
 	String getCaseImportTemplateFilePath();
@@ -158,4 +160,6 @@ public interface ImportFacade {
 	String getSelfReportImportTemplateFileName();
 
 	String getSurveyTokenImportTemplateFilePath();
+
+	String getSurveyTokenResponsesImportTemplateFilePath();
 }
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/survey/SurveyTokenCriteria.java b/sormas-api/src/main/java/de/symeda/sormas/api/survey/SurveyTokenCriteria.java
@@ -24,6 +24,7 @@ public class SurveyTokenCriteria extends BaseCriteria {
 
 	private SurveyReferenceDto survey;
 	private String tokenLike;
+	private String token;
 	private CaseReferenceDto caseAssignedTo;
 
 	public SurveyReferenceDto getSurvey() {
@@ -47,6 +48,14 @@ public void setTokenLike(String tokenLike) {
 		this.tokenLike = tokenLike;
 	}
 
+	public String getToken() {
+		return token;
+	}
+
+	public void setToken(String token) {
+		this.token = token;
+	}
+
 	public SurveyTokenCriteria tokenLike(String tokenLike) {
 		setTokenLike(tokenLike);
 		return this;
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/survey/SurveyTokenFacade.java b/sormas-api/src/main/java/de/symeda/sormas/api/survey/SurveyTokenFacade.java
@@ -39,4 +39,8 @@ public interface SurveyTokenFacade {
 
 	String getSurveyTokensImportTemplateFileName();
 
+	String getSurveyTokenResponsesImportTemplateFilePath();
+
+	String getSurveyTokenResponsesImportTemplateFileName();
+
 }
diff --git a/sormas-api/src/main/resources/captions.properties b/sormas-api/src/main/resources/captions.properties
@@ -199,6 +199,7 @@ actionConfirmAction = Confirm action
 actionAefiSelectPrimarySuspectVaccination = Select Suspect Vaccination
 actionAefiAssignNewReportingIdNumber = "Assign New AEFI ID"
 actionImportSurveyTokens = Import survey tokens
+actionImportSurveyTokenResponses = Import survey token responses
 activityAsCaseFlightNumber=Flight number
 ActivityAsCase=Activity as case
 ActivityAsCase.startDate=Start of activity
diff --git a/sormas-api/src/main/resources/strings.properties b/sormas-api/src/main/resources/strings.properties
@@ -910,6 +910,7 @@ headingAefiInvestigationFormSubHeading=(Only for Serious Adverse Events Followin
 headingSurveySideComponent=Surveys
 headingCaseSurveyDetails=Survey details
 headingImportSurveyTokens = Import Survey Tokens
+headingImportSurveyTokenResponses = Import Survey Token Responses
 
 # Info texts
 infoActivityAsCaseInvestigation = <i>Please document ALL relevant activities after infection:</i>
diff --git a/sormas-backend/src/main/java/de/symeda/sormas/backend/common/StartupShutdownService.java b/sormas-backend/src/main/java/de/symeda/sormas/backend/common/StartupShutdownService.java
@@ -1024,6 +1024,12 @@ private void createImportTemplateFiles(List<FeatureConfigurationDto> featureConf
 		} catch (IOException | NoSuchFieldException e) {
 			logger.error("Could not create survey token import template .csv file.");
 		}
+
+		try {
+			importFacade.generateSurveyTokenResponsesImportTemplateFile(featureConfigurations);
+		} catch (IOException | NoSuchFieldException e) {
+			logger.error("Could not create survey token responses import template .csv file.");
+		}
 	}
 
 	private void createMissingDiseaseConfigurations() {
diff --git a/sormas-backend/src/main/java/de/symeda/sormas/backend/importexport/ImportFacadeEjb.java b/sormas-backend/src/main/java/de/symeda/sormas/backend/importexport/ImportFacadeEjb.java
@@ -222,6 +222,7 @@ public class ImportFacadeEjb implements ImportFacade {
 	private static final String ENVIRONMENT_IMPORT_TEMPLATE_FILE_NAME = "import_environment_template.csv";
 	private static final String SELF_REPORT_IMPORT_TEMPLATE_FILE_NAME = "import_self_report_template.csv";
 	private static final String SURVEY_TOKENS_IMPORT_TEMPLATE_FILE_NAME = "import_survey_tokens_template.csv";
+	private static final String SURVEY_TOKEN_RESPONSES_IMPORT_TEMPLATE_FILE_NAME = "import_survey_token_responses_template.csv";
 
 	private static final String ALL_COUNTRIES_IMPORT_FILE_NAME = "sormas_import_all_countries.csv";
 	private static final String ALL_SUBCONTINENTS_IMPORT_FILE_NAME = "sormas_import_all_subcontinents.csv";
@@ -572,6 +573,30 @@ public void generateSurveyTokenImportTemplateFile(List<FeatureConfigurationDto>
 		writeTemplate(Paths.get(getSurveyTokenImportTemplateFilePath()), importColumns, false);
 	}
 
+	@Override
+	public void generateSurveyTokenResponsesImportTemplateFile(List<FeatureConfigurationDto> featureConfigurations) throws IOException, NoSuchFieldException {
+
+		createExportDirectoryIfNecessary();
+
+		char separator = configFacade.getCsvSeparator();
+		List<ImportColumn> importColumns = new ArrayList<>();
+
+		appendListOfFields(
+				importColumns,
+				SurveyTokenDto.class,
+				"",
+				separator,
+				featureConfigurations,
+				SurveyTokenDto.SURVEY,
+				SurveyTokenDto.ASSIGNMENT_DATE,
+				SurveyTokenDto.CASE_ASSIGNED_TO,
+				SurveyTokenDto.GENERATED_DOCUMENT,
+				SurveyTokenDto.RECIPIENT_EMAIL);
+
+		writeTemplate(Paths.get(getSurveyTokenResponsesImportTemplateFilePath()), importColumns, false);
+
+	}
+
 	@Override
 	public String getCaseImportTemplateFileName() {
 		return getImportTemplateFileName(CASE_IMPORT_TEMPLATE_FILE_NAME);
@@ -944,6 +969,11 @@ public String getSurveyTokenImportTemplateFilePath() {
 		return getImportTemplateFilePath(SURVEY_TOKENS_IMPORT_TEMPLATE_FILE_NAME);
 	}
 
+	@Override
+	public String getSurveyTokenResponsesImportTemplateFilePath() {
+		return getImportTemplateFilePath(SURVEY_TOKEN_RESPONSES_IMPORT_TEMPLATE_FILE_NAME);
+	}
+
 	@Override
 	public String getSelfReportImportTemplateFileName() {
 		return getImportTemplateFileName(SELF_REPORT_IMPORT_TEMPLATE_FILE_NAME);
diff --git a/sormas-backend/src/main/java/de/symeda/sormas/backend/survey/SurveyTokenFacadeEjb.java b/sormas-backend/src/main/java/de/symeda/sormas/backend/survey/SurveyTokenFacadeEjb.java
@@ -87,6 +87,8 @@ public class SurveyTokenFacadeEjb implements SurveyTokenFacade {
 
 	private static final String SURVEY_TOKEN_IMPORT_TEMPLATE_FILE_NAME = "import_survey_tokens_template.csv";
 
+	private static final String SURVEY_TOKEN_RESPONSES_IMPORT_TEMPLATE_FILE_NAME = "import_survey_token_responses_template.csv";
+
 	@Override
 	@RightsAllowed({
 		UserRight._SURVEY_TOKEN_CREATE,
@@ -173,6 +175,16 @@ public String getSurveyTokensImportTemplateFileName() {
 		return getImportTemplateFileName(SURVEY_TOKEN_IMPORT_TEMPLATE_FILE_NAME);
 	}
 
+	@Override
+	public String getSurveyTokenResponsesImportTemplateFilePath() {
+		return getImportTemplateFilePath(SURVEY_TOKEN_RESPONSES_IMPORT_TEMPLATE_FILE_NAME);
+	}
+
+	@Override
+	public String getSurveyTokenResponsesImportTemplateFileName() {
+		return getImportTemplateFileName(SURVEY_TOKEN_RESPONSES_IMPORT_TEMPLATE_FILE_NAME);
+	}
+
 
 	private String getImportTemplateFilePath(String baseFilename) {
 		java.nio.file.Path exportDirectory = Paths.get(configFacade.getGeneratedFilesPath());
diff --git a/sormas-backend/src/main/java/de/symeda/sormas/backend/survey/SurveyTokenService.java b/sormas-backend/src/main/java/de/symeda/sormas/backend/survey/SurveyTokenService.java
@@ -44,6 +44,10 @@ public Predicate buildCriteriaFilter(SurveyTokenCriteria criteria, CriteriaBuild
 			filter = CriteriaBuilderHelper.and(cb, filter, CriteriaBuilderHelper.ilike(cb, root.get(SurveyToken.TOKEN), criteria.getTokenLike()));
 		}
 
+		if (criteria.getToken() != null) {
+			filter = CriteriaBuilderHelper.and(cb, filter, CriteriaBuilderHelper.ilikePrecise(cb, root.get(SurveyToken.TOKEN), criteria.getToken()));
+		}
+
 		if (criteria.getCaseAssignedTo() != null) {
 			filter = CriteriaBuilderHelper.and(cb, filter, cb.equal(joins.getCaseAssignedTo().get(Case.UUID), criteria.getCaseAssignedTo().getUuid()));
 		}
diff --git a/sormas-ui/src/main/java/de/symeda/sormas/ui/configuration/infrastructure/ImportSurveyTokenResponsesLayout.java b/sormas-ui/src/main/java/de/symeda/sormas/ui/configuration/infrastructure/ImportSurveyTokenResponsesLayout.java
@@ -0,0 +1,70 @@
+/*
+ * SORMAS® - Surveillance Outbreak Response Management & Analysis System
+ * Copyright © 2016-2025 Helmholtz-Zentrum für Infektionsforschung GmbH (HZI)
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package de.symeda.sormas.ui.configuration.infrastructure;
+
+import java.io.IOException;
+
+import com.opencsv.exceptions.CsvValidationException;
+import com.vaadin.server.ClassResource;
+import com.vaadin.server.Page;
+import com.vaadin.ui.Notification;
+
+import de.symeda.sormas.api.FacadeProvider;
+import de.symeda.sormas.api.i18n.I18nProperties;
+import de.symeda.sormas.api.i18n.Strings;
+import de.symeda.sormas.api.importexport.ValueSeparator;
+import de.symeda.sormas.api.survey.SurveyDto;
+import de.symeda.sormas.api.survey.SurveyTokenFacade;
+import de.symeda.sormas.ui.importer.AbstractImportLayout;
+import de.symeda.sormas.ui.importer.DataImporter;
+import de.symeda.sormas.ui.importer.ImportReceiver;
+import de.symeda.sormas.ui.importer.SurveyTokenImporter;
+import de.symeda.sormas.ui.importer.SurveyTokenResponsesImporter;
+
+public class ImportSurveyTokenResponsesLayout extends AbstractImportLayout {
+
+
+	public ImportSurveyTokenResponsesLayout(SurveyDto survey) {
+		super();
+		SurveyTokenFacade surveyTokenFacade = FacadeProvider.getSurveyTokenFacade();
+		String templateFilePath = surveyTokenFacade.getSurveyTokenResponsesImportTemplateFilePath();
+		String templateFileName = surveyTokenFacade.getSurveyTokenResponsesImportTemplateFileName();
+		String fileNameAddition = "_survey_token_responses_import_";
+
+		addDownloadResourcesComponent(1, new ClassResource("/SORMAS_Survey_Token_Responses_Import_Guide.pdf"));
+		addDownloadImportTemplateComponent(2, templateFilePath, templateFileName);
+
+		addImportCsvComponent(3, new ImportReceiver(fileNameAddition, file -> {
+			resetDownloadErrorReportButton();
+			try {
+				DataImporter importer = new SurveyTokenResponsesImporter(
+						file,
+						currentUser,
+						survey,
+						(ValueSeparator) separator.getValue());
+				importer.startImport(this::extendDownloadErrorReportButton, currentUI, false);
+			} catch (IOException | CsvValidationException e) {
+				new Notification(
+						I18nProperties.getString(Strings.headingImportFailed),
+						I18nProperties.getString(Strings.messageImportFailed),
+						Notification.Type.ERROR_MESSAGE,
+						false).show(Page.getCurrent());
+			}
+		}));
+		addDownloadErrorReportComponent(4);
+	}
+
+}
diff --git a/sormas-ui/src/main/java/de/symeda/sormas/ui/importer/SurveyTokenImporter.java b/sormas-ui/src/main/java/de/symeda/sormas/ui/importer/SurveyTokenImporter.java
@@ -51,7 +51,7 @@ protected ImportLineResult importDataFromCsvLine(
 
 		boolean hasImportError = insertRowIntoData(values, entityClasses, entityPropertyPaths, false, (cellData) -> {
 			try {
-				// If the cell entry is not empty, try to insert it into the current infrastructure object
+				// If the cell entry is not empty, try to insert it into the current object
 				if (!StringUtils.isEmpty(cellData.getValue())) {
 					insertColumnEntryIntoData(newEntityDto, cellData.getValue(), cellData.getEntityPropertyPath());
 				}
diff --git a/sormas-ui/src/main/java/de/symeda/sormas/ui/importer/SurveyTokenResponsesImporter.java b/sormas-ui/src/main/java/de/symeda/sormas/ui/importer/SurveyTokenResponsesImporter.java
@@ -0,0 +1,134 @@
+package de.symeda.sormas.ui.importer;
+
+import java.beans.PropertyDescriptor;
+import java.io.File;
+import java.io.IOException;
+import java.util.Date;
+import java.util.List;
+
+import de.symeda.sormas.api.survey.SurveyTokenCriteria;
+import de.symeda.sormas.api.survey.SurveyTokenIndexDto;
+import org.apache.commons.lang3.StringUtils;
+
+import de.symeda.sormas.api.EntityDto;
+import de.symeda.sormas.api.FacadeProvider;
+import de.symeda.sormas.api.i18n.I18nProperties;
+import de.symeda.sormas.api.i18n.Validations;
+import de.symeda.sormas.api.importexport.ImportErrorException;
+import de.symeda.sormas.api.importexport.ImportLineResultDto;
+import de.symeda.sormas.api.importexport.InvalidColumnException;
+import de.symeda.sormas.api.importexport.ValueSeparator;
+import de.symeda.sormas.api.survey.SurveyDto;
+import de.symeda.sormas.api.survey.SurveyTokenDto;
+import de.symeda.sormas.api.user.UserDto;
+import de.symeda.sormas.api.utils.ValidationRuntimeException;
+
+/**
+ * Data importer that is used to import survey token responses.
+ */
+public class SurveyTokenResponsesImporter extends DataImporter {
+
+	private final SurveyDto survey;
+
+	public SurveyTokenResponsesImporter(File inputFile, UserDto currentUser, SurveyDto survey, ValueSeparator csvSeparator)
+		throws IOException {
+		super(inputFile, false, currentUser, csvSeparator);
+		this.survey = survey;
+	}
+
+	@Override
+	protected ImportLineResult importDataFromCsvLine(
+		String[] values,
+		String[] entityClasses,
+		String[] entityProperties,
+		String[][] entityPropertyPaths,
+		boolean firstLine)
+		throws IOException, InvalidColumnException {
+
+		// Check whether the new line has the same length as the header line
+		if (values.length > entityProperties.length) {
+			writeImportError(values, I18nProperties.getValidationError(Validations.importLineTooLong));
+			return ImportLineResult.ERROR;
+		}
+
+		EntityDto newEntityDto = SurveyTokenDto.build(survey);
+
+		SurveyTokenCriteria criteria = new SurveyTokenCriteria();
+		criteria.setSurvey(survey.toReferenceDto());
+		criteria.setToken(values[0]);
+		List<SurveyTokenIndexDto> list = FacadeProvider.getSurveyTokenFacade().getIndexList(criteria, 1, 1, null);
+		if(list.size() == 1){
+			newEntityDto.setUuid(list.get(0).getUuid());
+			newEntityDto.setChangeDate(new Date());
+		} else {
+			writeImportError(values, String.format("UUID %s was not found  for current survey: %s", values[0], survey.getName()));
+			return ImportLineResult.SKIPPED;
+		}
+		boolean hasImportError = insertRowIntoData(values, entityClasses, entityPropertyPaths, false, (cellData) -> {
+			try {
+				// If the cell entry is not empty, try to insert it into the current object
+				if (!StringUtils.isEmpty(cellData.getValue())) {
+					insertColumnEntryIntoData(newEntityDto, cellData.getValue(), cellData.getEntityPropertyPath());
+				}
+			} catch (ImportErrorException | InvalidColumnException e) {
+				return e;
+			}
+			return null;
+		});
+
+		if (!hasImportError) {
+			ImportLineResultDto<EntityDto> constraintErrors = validateConstraints(newEntityDto);
+			if (constraintErrors.isError()) {
+				writeImportError(values, constraintErrors.getMessage());
+				hasImportError = true;
+			}
+		}
+
+		// Save the survey token response object into the database if the import has no errors or log a skipped record
+		// if there is already an survey token response object with this name in the database
+		if (!hasImportError) {
+			try {
+				FacadeProvider.getSurveyTokenFacade().save((SurveyTokenDto) newEntityDto);
+				return ImportLineResult.SUCCESS;
+			} catch (ValidationRuntimeException e) {
+				writeImportError(values, e.getMessage());
+				return ImportLineResult.ERROR;
+			}
+		} else {
+			return ImportLineResult.ERROR;
+		}
+	}
+
+	/**
+	 * Inserts the entry of a single cell into the survey token response object.
+	 */
+	private void insertColumnEntryIntoData(EntityDto newEntityDto, String value, String[] entityPropertyPath)
+			throws InvalidColumnException, ImportErrorException {
+
+		Object currentElement = newEntityDto;
+		for (int i = 0; i < entityPropertyPath.length; i++) {
+			String headerPathElementName = entityPropertyPath[i];
+
+			try {
+				if (i != entityPropertyPath.length - 1) {
+					currentElement = new PropertyDescriptor(headerPathElementName, currentElement.getClass()).getReadMethod().invoke(currentElement);
+				} else {
+					PropertyDescriptor pd = new PropertyDescriptor(headerPathElementName, currentElement.getClass());
+					Class<?> propertyType = pd.getPropertyType();
+
+					// Execute the default invokes specified in the data importer; if none of those were triggered, execute additional invokes
+					// according to the types of the survey token response object's fields; additionally, throw an error if survey token response data that
+					// is referenced in the imported object does not exist in the database
+					if (!executeDefaultInvoke(pd, currentElement, value, entityPropertyPath)) {
+						throw new UnsupportedOperationException(
+							I18nProperties.getValidationError(Validations.importPropertyTypeNotAllowed, propertyType.getName()));
+						}
+					}
+				} catch (Exception e) {
+					logger.error("Unexpected error when trying to import survey token data: " + e.getMessage());
+					throw new ImportErrorException(I18nProperties.getValidationError(Validations.importUnexpectedError));
+				}
+		}
+	}
+
+}
diff --git a/sormas-ui/src/main/java/de/symeda/sormas/ui/survey/SurveyDataView.java b/sormas-ui/src/main/java/de/symeda/sormas/ui/survey/SurveyDataView.java
diff --git a/sormas-ui/src/main/resources/SORMAS_Survey_Token_Responses_Import_Guide.docx b/sormas-ui/src/main/resources/SORMAS_Survey_Token_Responses_Import_Guide.docx
diff --git a/sormas-ui/src/main/resources/SORMAS_Survey_Token_Responses_Import_Guide.pdf b/sormas-ui/src/main/resources/SORMAS_Survey_Token_Responses_Import_Guide.pdf

Original file line number	Diff line number	Diff line change
`@@ -39,4 +39,8 @@ public interface SurveyTokenFacade {`
`39`	`39`
`40`	`40`	`String getSurveyTokensImportTemplateFileName();`
`41`	`41`
	`42`	`+ String getSurveyTokenResponsesImportTemplateFilePath();`
	`43`	`+`
	`44`	`+ String getSurveyTokenResponsesImportTemplateFileName();`
	`45`	`+`
`42`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1024,6 +1024,12 @@ private void createImportTemplateFiles(List<FeatureConfigurationDto> featureConf`
`1024`	`1024`	`} catch (IOException \| NoSuchFieldException e) {`
`1025`	`1025`	`logger.error("Could not create survey token import template .csv file.");`
`1026`	`1026`	`}`
	`1027`	`+`
	`1028`	`+ try {`
	`1029`	`+ importFacade.generateSurveyTokenResponsesImportTemplateFile(featureConfigurations);`
	`1030`	`+ } catch (IOException \| NoSuchFieldException e) {`
	`1031`	`+ logger.error("Could not create survey token responses import template .csv file.");`
	`1032`	`+ }`
`1027`	`1033`	`}`
`1028`	`1034`
`1029`	`1035`	`private void createMissingDiseaseConfigurations() {`