Import Survey Tokens #13191 (#13272)

cazacmarin · web-flow · commit 3e8297ac8556 · 2025-02-24T12:18:51.000+02:00
* Import Survey Tokens #13191
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 actionImportSurveyTokens = "actionImportSurveyTokens";
 	String actionLastModifiedByLabel = "actionLastModifiedByLabel";
 	String actionLeaveBulkEditMode = "actionLeaveBulkEditMode";
 	String actionLogout = "actionLogout";
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 headingImportSurveyTokens = "headingImportSurveyTokens";
 	String headingImportTravelEntries = "headingImportTravelEntries";
 	String headingIncorrectDateRange = "headingIncorrectDateRange";
 	String headingInformationSource = "headingInformationSource";
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
@@ -73,6 +73,8 @@ public interface ImportFacade {
 
 	void generateSelfReportImportTemplateFile(List<FeatureConfigurationDto> featureConfigurations) throws IOException, NoSuchFieldException;
 
+	void generateSurveyTokenImportTemplateFile(List<FeatureConfigurationDto> featureConfigurations) throws IOException, NoSuchFieldException;
+
 	String getCaseImportTemplateFileName();
 
 	String getCaseImportTemplateFilePath();
@@ -154,4 +156,6 @@ public interface ImportFacade {
 	String getSelfReportImportTemplateFilePath();
 
 	String getSelfReportImportTemplateFileName();
+
+	String getSurveyTokenImportTemplateFilePath();
 }
diff --git a/sormas-api/src/main/java/de/symeda/sormas/api/survey/SurveyTokenDto.java b/sormas-api/src/main/java/de/symeda/sormas/api/survey/SurveyTokenDto.java
@@ -63,6 +63,14 @@ public static SurveyTokenDto build() {
 		return token;
 	}
 
+	public static SurveyTokenDto build(SurveyDto survey) {
+		SurveyTokenDto token = new SurveyTokenDto();
+		token.setUuid(DataHelper.createUuid());
+		token.setSurvey(new SurveyReferenceDto(survey.getUuid(), survey.getName()));
+
+		return token;
+	}
+
 	public SurveyReferenceDto getSurvey() {
 		return survey;
 	}
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
@@ -34,4 +34,9 @@ public interface SurveyTokenFacade {
 	List<SurveyTokenIndexDto> getIndexList(SurveyTokenCriteria criteria, Integer first, Integer max, List<SortProperty> sortProperties);
 
 	void deletePermanent(String uuid);
+
+	String getSurveyTokensImportTemplateFilePath();
+
+	String getSurveyTokensImportTemplateFileName();
+
 }
diff --git a/sormas-api/src/main/resources/captions.properties b/sormas-api/src/main/resources/captions.properties
@@ -198,6 +198,7 @@ actionDone = Done
 actionConfirmAction = Confirm action
 actionAefiSelectPrimarySuspectVaccination = Select Suspect Vaccination
 actionAefiAssignNewReportingIdNumber = "Assign New AEFI ID"
+actionImportSurveyTokens = Import survey tokens
 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
@@ -290,7 +290,6 @@ entityContactVisits = Contact visits
 entityContacts=Contacts
 entityContinents=Continents
 entityCountries = Countries
-entityCustomizableEnumValues = Customizable enum values
 entityDataDictionary= Data dictionary
 entityDataProtectionDictionary= Data protection dictionary
 entityDiseaseClassifications = Disease classifications
@@ -344,10 +343,7 @@ entityUsers = Users
 entityVaccinations = Vaccinations
 entityVisits = Visits
 entityWeeklyReports = Weekly reports
-entityOutbreaks = Outbreaks
 entityCustomizableEnumValues = Customizable enum values
-entityCampaignFormMeta = Campaign form meta
-entityCampaignFormData = Campaign form data
 entityAdverseEvent = Adverse event
 entityAdverseEvents = Adverse events
 entityAdverseEventInvestigation = Adverse event investigation
@@ -913,6 +909,7 @@ headingAefiInvestigationSelectConcernedVaccine=Select concerned vaccine
 headingAefiInvestigationFormSubHeading=(Only for Serious Adverse Events Following Immunization ? Death / Disability / Hospitalization / Cluster)
 headingSurveySideComponent=Surveys
 headingCaseSurveyDetails=Survey details
+headingImportSurveyTokens = Import Survey Tokens
 
 # 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
@@ -1018,6 +1018,12 @@ private void createImportTemplateFiles(List<FeatureConfigurationDto> featureConf
 		} catch (IOException | NoSuchFieldException e) {
 			logger.error("Could not create self report import template .csv file.");
 		}
+
+		try {
+			importFacade.generateSurveyTokenImportTemplateFile(featureConfigurations);
+		} catch (IOException | NoSuchFieldException e) {
+			logger.error("Could not create survey token 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
@@ -74,6 +74,7 @@
 import javax.validation.Validator;
 import javax.validation.ValidatorFactory;
 
+import de.symeda.sormas.api.survey.SurveyTokenDto;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.text.WordUtils;
 import org.slf4j.Logger;
@@ -220,6 +221,7 @@ public class ImportFacadeEjb implements ImportFacade {
 	private static final String TRAVEL_ENTRY_IMPORT_TEMPLATE_FILE_NAME = "import_travel_entry_template.csv";
 	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 ALL_COUNTRIES_IMPORT_FILE_NAME = "sormas_import_all_countries.csv";
 	private static final String ALL_SUBCONTINENTS_IMPORT_FILE_NAME = "sormas_import_all_subcontinents.csv";
@@ -546,6 +548,30 @@ public void generateSelfReportImportTemplateFile(List<FeatureConfigurationDto> f
 		writeTemplate(Paths.get(getSelfReportImportTemplateFilePath()), importColumns, true);
 	}
 
+	@Override
+	public void generateSurveyTokenImportTemplateFile(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,
+				SurveyTokenDto.RESPONSE_RECEIVED);
+
+		writeTemplate(Paths.get(getSurveyTokenImportTemplateFilePath()), importColumns, false);
+	}
+
 	@Override
 	public String getCaseImportTemplateFileName() {
 		return getImportTemplateFileName(CASE_IMPORT_TEMPLATE_FILE_NAME);
@@ -913,6 +939,11 @@ public String getSelfReportImportTemplateFilePath() {
 		return getImportTemplateFilePath(SELF_REPORT_IMPORT_TEMPLATE_FILE_NAME);
 	}
 
+	@Override
+	public String getSurveyTokenImportTemplateFilePath() {
+		return getImportTemplateFilePath(SURVEY_TOKENS_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
@@ -17,6 +17,7 @@
 
 import static org.apache.commons.collections4.CollectionUtils.isNotEmpty;
 
+import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.stream.Collectors;
@@ -42,11 +43,13 @@
 import de.symeda.sormas.api.survey.SurveyTokenFacade;
 import de.symeda.sormas.api.survey.SurveyTokenIndexDto;
 import de.symeda.sormas.api.user.UserRight;
+import de.symeda.sormas.api.utils.DataHelper;
 import de.symeda.sormas.api.utils.SortProperty;
 import de.symeda.sormas.backend.FacadeHelper;
 import de.symeda.sormas.backend.caze.Case;
 import de.symeda.sormas.backend.caze.CaseFacadeEjb.CaseFacadeEjbLocal;
 import de.symeda.sormas.backend.caze.CaseService;
+import de.symeda.sormas.backend.common.ConfigFacadeEjb;
 import de.symeda.sormas.backend.common.CriteriaBuilderHelper;
 import de.symeda.sormas.backend.document.DocumentFacadeEjb;
 import de.symeda.sormas.backend.document.DocumentFacadeEjb.DocumentFacadeEjbLocal;
@@ -79,6 +82,10 @@ public class SurveyTokenFacadeEjb implements SurveyTokenFacade {
 	private CaseService caseService;
 	@EJB
 	private DocumentFacadeEjbLocal documentFacade;
+	@EJB
+	private ConfigFacadeEjb.ConfigFacadeEjbLocal configFacade;
+
+	private static final String SURVEY_TOKEN_IMPORT_TEMPLATE_FILE_NAME = "import_survey_tokens_template.csv";
 
 	@Override
 	@RightsAllowed({
@@ -156,6 +163,27 @@ public void deletePermanent(String uuid) {
 		surveyTokenService.deletePermanent(surveyTokenService.getByUuid(uuid));
 	}
 
+	@Override
+	public String getSurveyTokensImportTemplateFilePath() {
+		return getImportTemplateFilePath(SURVEY_TOKEN_IMPORT_TEMPLATE_FILE_NAME);
+	}
+
+	@Override
+	public String getSurveyTokensImportTemplateFileName() {
+		return getImportTemplateFileName(SURVEY_TOKEN_IMPORT_TEMPLATE_FILE_NAME);
+	}
+
+
+	private String getImportTemplateFilePath(String baseFilename) {
+		java.nio.file.Path exportDirectory = Paths.get(configFacade.getGeneratedFilesPath());
+		return exportDirectory.resolve(getImportTemplateFileName(baseFilename)).toString();
+	}
+
+	private String getImportTemplateFileName(String baseFilename) {
+		String instanceName = DataHelper.cleanStringForFileName(configFacade.getSormasInstanceName().toLowerCase());
+		return instanceName + "_" + baseFilename;
+	}
+
 	private List<Selection<?>> sortBy(List<SortProperty> sortProperties, Root<SurveyToken> root, CriteriaBuilder cb, CriteriaQuery<?> cq) {
 
 		List<Selection<?>> selections = new ArrayList<>();
diff --git a/sormas-backend/src/main/resources/sql/sormas_schema.sql b/sormas-backend/src/main/resources/sql/sormas_schema.sql
@@ -13817,4 +13817,10 @@ INSERT INTO userroles_userrights (userrole_id, userright) SELECT id, 'SURVEY_TOK
 INSERT INTO userroles_userrights (userrole_id, userright) SELECT id, 'SURVEY_TOKEN_IMPORT' FROM public.userroles WHERE userroles.linkeddefaultuserrole in ('ADMIN');
 
 INSERT INTO schema_version (version_number, comment) VALUES (558, 'Create Survey Tokens data structure #13250');
--- *** Insert new sql commands BEFORE this line. Remember to always consider _history tables. ***
+
+-- 2025-02-15 Import Survey Tokens #13191
+ALTER TABLE surveytokens ADD CONSTRAINT unique_token_for_survey UNIQUE (token, survey_id);
+
+INSERT INTO schema_version (version_number, comment) VALUES (559, 'Import Survey Tokens #13191');
+
+-- *** Insert new sql commands BEFORE this line. Remember to always consider _history tables. ***
diff --git a/sormas-ui/src/main/java/de/symeda/sormas/ui/configuration/infrastructure/ImportSurveyTokensLayout.java b/sormas-ui/src/main/java/de/symeda/sormas/ui/configuration/infrastructure/ImportSurveyTokensLayout.java
@@ -0,0 +1,68 @@
+/*
+ * SORMAS® - Surveillance Outbreak Response Management & Analysis System
+ * Copyright © 2016-2021 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 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 java.io.IOException;
+
+public class ImportSurveyTokensLayout extends AbstractImportLayout {
+
+
+	public ImportSurveyTokensLayout(SurveyDto survey) {
+		super();
+		SurveyTokenFacade surveyTokenFacade = FacadeProvider.getSurveyTokenFacade();
+		String templateFilePath = surveyTokenFacade.getSurveyTokensImportTemplateFilePath();
+		String templateFileName = surveyTokenFacade.getSurveyTokensImportTemplateFileName();
+		String fileNameAddition = "_survey_tokens_import_";
+
+		addDownloadResourcesComponent(1, new ClassResource("/SORMAS_Survey_Tokens_Import_Guide.pdf"));
+		addDownloadImportTemplateComponent(2, templateFilePath, templateFileName);
+
+		addImportCsvComponent(3, new ImportReceiver(fileNameAddition, file -> {
+			resetDownloadErrorReportButton();
+			try {
+				DataImporter importer = new SurveyTokenImporter(
+						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/DataImporter.java b/sormas-ui/src/main/java/de/symeda/sormas/ui/importer/DataImporter.java
@@ -135,20 +135,27 @@ public abstract class DataImporter {
 
 	private final EnumCaptionCache enumCaptionCache;
 
+	private final boolean singleColumnImport;
+
 	public DataImporter(File inputFile, boolean hasEntityClassRow, UserDto currentUser, ValueSeparator csvSeparator) throws IOException {
+		this(inputFile, hasEntityClassRow, currentUser, csvSeparator, false);
+	}
+
+	public DataImporter(File inputFile, boolean hasEntityClassRow, UserDto currentUser, ValueSeparator csvSeparator, boolean singleColumnImport) throws IOException {
 		this.inputFile = inputFile;
 		this.hasEntityClassRow = hasEntityClassRow;
 		this.currentUser = currentUser;
 		this.enumCaptionCache = new EnumCaptionCache(currentUser.getLanguage());
+		this.singleColumnImport = singleColumnImport;
 
 		Path exportDirectory = getErrorReportFolderPath();
 		if (!exportDirectory.toFile().exists() || !exportDirectory.toFile().canWrite()) {
 			logger.error(exportDirectory + " doesn't exist or cannot be accessed");
 			throw new FileNotFoundException("Temp directory doesn't exist or cannot be accessed");
 		}
 		Path errorReportFilePath = exportDirectory.resolve(
-			ImportExportUtils.TEMP_FILE_PREFIX + "_error_report_" + DataHelper.getShortUuid(currentUser.getUuid()) + "_"
-				+ DateHelper.formatDateForExport(new Date()) + ".csv");
+				ImportExportUtils.TEMP_FILE_PREFIX + "_error_report_" + DataHelper.getShortUuid(currentUser.getUuid()) + "_"
+						+ DateHelper.formatDateForExport(new Date()) + ".csv");
 		this.errorReportFilePath = errorReportFilePath.toString();
 
 		this.csvSeparator = ValueSeparator.getSeparator(csvSeparator, FacadeProvider.getConfigFacade().getCsvSeparator());
@@ -285,9 +292,13 @@ public ImportResult runImport() throws IOException, InvalidColumnException, Inte
 			errorReportCsvWriter.writeNext(columnNames);
 
 			// validate headers
-			if (entityClasses != null && entityClasses.length <= 1 || entityProperties.length <= 1) {
-				writeImportError(new String[0], I18nProperties.getValidationError(Validations.importProbablyInvalidSeparator));
-				return ImportResult.withStatus(ImportResultStatus.CANCELED_WITH_ERRORS, false);
+			if (!singleColumnImport) {
+				if (!columnNames[1].toLowerCase().contains("token".toLowerCase())) {
+					if (entityClasses != null && entityClasses.length <= 1 || entityProperties.length <= 1) {
+						writeImportError(new String[0], I18nProperties.getValidationError(Validations.importProbablyInvalidSeparator));
+						return ImportResult.withStatus(ImportResultStatus.CANCELED_WITH_ERRORS, false);
+					}
+				}
 			}
 
 			// Read and import all lines from the import file
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
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_Tokens_Import_Guide.docx b/sormas-ui/src/main/resources/SORMAS_Survey_Tokens_Import_Guide.docx
diff --git a/sormas-ui/src/main/resources/SORMAS_Survey_Tokens_Import_Guide.pdf b/sormas-ui/src/main/resources/SORMAS_Survey_Tokens_Import_Guide.pdf

Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,14 @@ public static SurveyTokenDto build() {`
`63`	`63`	`return token;`
`64`	`64`	`}`
`65`	`65`
	`66`	`+ public static SurveyTokenDto build(SurveyDto survey) {`
	`67`	`+ SurveyTokenDto token = new SurveyTokenDto();`
	`68`	`+ token.setUuid(DataHelper.createUuid());`
	`69`	`+ token.setSurvey(new SurveyReferenceDto(survey.getUuid(), survey.getName()));`
	`70`	`+`
	`71`	`+ return token;`
	`72`	`+ }`
	`73`	`+`
`66`	`74`	`public SurveyReferenceDto getSurvey() {`
`67`	`75`	`return survey;`
`68`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,4 +34,9 @@ public interface SurveyTokenFacade {`
`34`	`34`	`List<SurveyTokenIndexDto> getIndexList(SurveyTokenCriteria criteria, Integer first, Integer max, List<SortProperty> sortProperties);`
`35`	`35`
`36`	`36`	`void deletePermanent(String uuid);`
	`37`	`+`
	`38`	`+ String getSurveyTokensImportTemplateFilePath();`
	`39`	`+`
	`40`	`+ String getSurveyTokensImportTemplateFileName();`
	`41`	`+`
`37`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1018,6 +1018,12 @@ private void createImportTemplateFiles(List<FeatureConfigurationDto> featureConf`
`1018`	`1018`	`} catch (IOException \| NoSuchFieldException e) {`
`1019`	`1019`	`logger.error("Could not create self report import template .csv file.");`
`1020`	`1020`	`}`
	`1021`	`+`
	`1022`	`+ try {`
	`1023`	`+ importFacade.generateSurveyTokenImportTemplateFile(featureConfigurations);`
	`1024`	`+ } catch (IOException \| NoSuchFieldException e) {`
	`1025`	`+ logger.error("Could not create survey token import template .csv file.");`
	`1026`	`+ }`
`1021`	`1027`	`}`
`1022`	`1028`
`1023`	`1029`	`private void createMissingDiseaseConfigurations() {`