#13195 Create a Survey request document to a case Person's (#13268)

* #13195 Create a Survey request document to a case Person's

* #13193 Send a survey request email to a case person's email

* #13193 Send a survey request email to a case person's email - fix code formatting

* #13193 Send a survey request email to a case person's email - fixed arch tests

* #13193 Send a survey request email to a case person's email - fix merge issues

* #13193 Send a survey request email to a case person's email - add token into the generated document

* #13193 Send a survey request email to a case person's email - fixes after review

---------

Co-authored-by: Levente Gal <levente.gal.ext@vitagroup.ag>

Author: leventegal-she

sormas-api/src/main/java/de/symeda/sormas/api/externalemail/ExternalEmailOptionsWithAttachmentsDto.java

@@ -40,7 +40,7 @@ public class ExternalEmailOptionsWithAttachmentsDto implements Serializable {
 
 	public static final String I18N_PREFIX = "ExternalEmailOptionsWithAttachments";
 
-	public static final String TEMPLATE_NAME = "template";
+	public static final String TEMPLATE = "template";
 	public static final String RECIPIENT_EMAIL = "recipientEmail";
 	public static final String ATTACHED_DOCUMENTS = "attachedDocuments";
 

sormas-api/src/main/java/de/symeda/sormas/api/i18n/Captions.java

@@ -2692,6 +2692,7 @@ public interface Captions {
 	String SurveillanceReport_uuid = "SurveillanceReport.uuid";
 	String surveillanceReportNewReport = "surveillanceReportNewReport";
 	String surveillanceReportNoReportsForCase = "surveillanceReportNoReportsForCase";
+	String SurveyDocumentOptions_survey = "SurveyDocumentOptions.survey";
 	String surveyGenerate = "surveyGenerate";
 	String surveyNew = "surveyNew";
 	String surveyNewSurvey = "surveyNewSurvey";

sormas-api/src/main/java/de/symeda/sormas/api/i18n/Strings.java

@@ -390,7 +390,10 @@ public interface Strings {
 	String errorSormasToSormasShareContactWithUnsharedSourceCase = "errorSormasToSormasShareContactWithUnsharedSourceCase";
 	String errorSormasToSormasSharequestNotFound = "errorSormasToSormasSharequestNotFound";
 	String errorSurveillanceReportNotEditable = "errorSurveillanceReportNotEditable";
+	String errorSurveyTokenNotAvailable = "errorSurveyTokenNotAvailable";
 	String errorTemplateFileCorrupt = "errorTemplateFileCorrupt";
+	String errorUploadGeneratedDocument = "errorUploadGeneratedDocument";
+	String errorUploadGeneratedDocumentExceedsFileSizeLimit = "errorUploadGeneratedDocumentExceedsFileSizeLimit";
 	String errorViewNotFound = "errorViewNotFound";
 	String errorWasReported = "errorWasReported";
 	String errorWritingTemplate = "errorWritingTemplate";
@@ -631,6 +634,7 @@ public interface Strings {
 	String headingEpiCurve = "headingEpiCurve";
 	String headingEpiDataSourceCaseContacts = "headingEpiDataSourceCaseContacts";
 	String headingErrorReportNotAvailable = "headingErrorReportNotAvailable";
+	String headingErrorSendingExternalEmail = "headingErrorSendingExternalEmail";
 	String headingEventData = "headingEventData";
 	String headingEventGroupData = "headingEventGroupData";
 	String headingEventGroupLinkEventIssue = "headingEventGroupLinkEventIssue";
@@ -856,6 +860,8 @@ public interface Strings {
 	String headingSpecailCaseAccess = "headingSpecailCaseAccess";
 	String headingStoppedFollowUp = "headingStoppedFollowUp";
 	String headingSurveillanceReports = "headingSurveillanceReports";
+	String headingSurveyGenerateDocument = "headingSurveyGenerateDocument";
+	String headingSurveySendDocument = "headingSurveySendDocument";
 	String headingSurveySideComponent = "headingSurveySideComponent";
 	String headingSymptomJournalAccountCreation = "headingSymptomJournalAccountCreation";
 	String headingSyncUsers = "headingSyncUsers";
@@ -1548,6 +1554,9 @@ public interface Strings {
 	String messageSubcontinentsArchived = "messageSubcontinentsArchived";
 	String messageSubcontinentsDearchived = "messageSubcontinentsDearchived";
 	String messageSurveyCreated = "messageSurveyCreated";
+	String messageSurveyNoDocumentTemplate = "messageSurveyNoDocumentTemplate";
+	String messageSurveyNoEmailTemplate = "messageSurveyNoEmailTemplate";
+	String messageSurveyNoTokens = "messageSurveyNoTokens";
 	String messageSurveySaved = "messageSurveySaved";
 	String messageSymptomsHint = "messageSymptomsHint";
 	String messageSymptomsVisitHint = "messageSymptomsVisitHint";

sormas-api/src/main/java/de/symeda/sormas/api/i18n/Validations.java

@@ -261,6 +261,7 @@ public interface Validations {
 	String specifyYear = "specifyYear";
 	String statisticsIncidenceOnlyNumbersAllowed = "statisticsIncidenceOnlyNumbersAllowed";
 	String surveyDocumentTemplateMissingTokenVariable = "surveyDocumentTemplateMissingTokenVariable";
+	String surveyOnlyCasesSupported = "surveyOnlyCasesSupported";
 	String taskMissingCaseLink = "taskMissingCaseLink";
 	String taskMissingContactLink = "taskMissingContactLink";
 	String taskMissingEventLink = "taskMissingEventLink";

sormas-api/src/main/java/de/symeda/sormas/api/survey/SurveyDocumentOptionsDto.java

@@ -0,0 +1,77 @@
+/*
+ * 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.api.survey;
+
+import java.io.Serializable;
+import java.util.Properties;
+
+import de.symeda.sormas.api.ReferenceDto;
+import de.symeda.sormas.api.audit.AuditedClass;
+import de.symeda.sormas.api.docgeneneration.RootEntityType;
+
+@AuditedClass
+public class SurveyDocumentOptionsDto implements Serializable {
+
+	private static final long serialVersionUID = 2850464241974703991L;
+
+	public static final String I18N_PREFIX = "SurveyDocumentOptions";
+
+	public static final String SURVEY = "survey";
+	public static final String RECIPIENT_EMAIL = "recipientEmail";
+
+	private final RootEntityType rootEntityType;
+	private final ReferenceDto rootEntityReference;
+	private SurveyReferenceDto survey;
+	private Properties templateProperties;
+	private String recipientEmail;
+
+	public RootEntityType getRootEntityType() {
+		return rootEntityType;
+	}
+
+	public ReferenceDto getRootEntityReference() {
+		return rootEntityReference;
+	}
+
+	public SurveyDocumentOptionsDto(RootEntityType rootEntityType, ReferenceDto rootEntityReference) {
+		this.rootEntityType = rootEntityType;
+		this.rootEntityReference = rootEntityReference;
+	}
+
+	public SurveyReferenceDto getSurvey() {
+		return survey;
+	}
+
+	public void setSurvey(SurveyReferenceDto survey) {
+		this.survey = survey;
+	}
+
+	public Properties getTemplateProperties() {
+		return templateProperties;
+	}
+
+	public void setTemplateProperties(Properties templateProperties) {
+		this.templateProperties = templateProperties;
+	}
+
+	public String getRecipientEmail() {
+		return recipientEmail;
+	}
+
+	public void setRecipientEmail(String recipientEmail) {
+		this.recipientEmail = recipientEmail;
+	}
+}

sormas-api/src/main/java/de/symeda/sormas/api/survey/SurveyDto.java

@@ -38,6 +38,8 @@ public class SurveyDto extends EntityDto {
 	public static final String DISEASE = "disease";
 	public static final String SURVEY_NAME = "name";
 
+	public static final String NAME = "name";
+
 	@NotBlank(message = Validations.requiredField)
 	@Size(max = FieldConstraints.CHARACTER_LIMIT_SMALL, message = Validations.textTooLong)
 	private String name;
@@ -85,7 +87,7 @@ public void setEmailTemplate(DocumentTemplateReferenceDto emailTemplate) {
 		this.emailTemplate = emailTemplate;
 	}
 
-	public SurveyReferenceDto toReferenceDto() {
-		return new SurveyReferenceDto(this.getUuid(), this.getName());
-	};
+	public SurveyReferenceDto toReference() {
+		return new SurveyReferenceDto(getUuid(), getName());
+	}
 }

sormas-api/src/main/java/de/symeda/sormas/api/survey/SurveyFacade.java

@@ -15,15 +15,21 @@
 
 package de.symeda.sormas.api.survey;
 
+import java.io.IOException;
 import java.util.List;
 
 import javax.ejb.Remote;
 import javax.validation.Valid;
 import javax.validation.constraints.NotNull;
 
+import de.symeda.sormas.api.Disease;
 import de.symeda.sormas.api.docgeneneration.DocumentTemplateDto;
 import de.symeda.sormas.api.docgeneneration.DocumentTemplateException;
+import de.symeda.sormas.api.docgeneneration.DocumentVariables;
+import de.symeda.sormas.api.externalemail.AttachmentException;
+import de.symeda.sormas.api.externalemail.ExternalEmailException;
 import de.symeda.sormas.api.utils.SortProperty;
+import de.symeda.sormas.api.utils.ValidationException;
 
 @Remote
 public interface SurveyFacade {
@@ -49,4 +55,14 @@ void uploadDocumentTemplate(@NotNull SurveyReferenceDto surveyRef, DocumentTempl
 
 	void uploadEmailTemplate(@NotNull SurveyReferenceDto surveyReference, DocumentTemplateDto uploadedDocumentTemplateDto, byte[] fileContent)
 		throws DocumentTemplateException;
+
+    List<SurveyDto> getAllByDisease(Disease disease);
+
+    void generateDocument(SurveyDocumentOptionsDto surveyOptions) throws DocumentTemplateException, ValidationException;
+
+    void sendDocument(SurveyDocumentOptionsDto surveyOptions) throws DocumentTemplateException, ValidationException, AttachmentException, IOException, ExternalEmailException;
+
+    boolean hasUnassignedTokens(SurveyReferenceDto survey);
+
+    DocumentVariables getDocumentVariables(SurveyReferenceDto surveyRef) throws DocumentTemplateException;
 }

sormas-api/src/main/java/de/symeda/sormas/api/survey/SurveyTokenIndexDto.java

@@ -31,6 +31,9 @@ public class SurveyTokenIndexDto extends PseudonymizableIndexDto {
 	private final Date assignmentDate;
 	private final String recipientEmail;
 	private final Boolean responseReceived;
+	private final String generatedDocumentUuid;
+	private final String generatedDocumentName;
+	private final String generatedDocumentMimeType;
 
 	public SurveyTokenIndexDto(
             String uuid,
@@ -39,7 +42,7 @@ public SurveyTokenIndexDto(
             String token,
             CaseReferenceDto caseAssignedTo,
             Date assignmentDate,
-            String recipientEmail, Boolean responseReceived) {
+            String recipientEmail, Boolean responseReceived, String generatedDocumentUuid, String generatedDocumentName, String generatedDocumentMimeType) {
 		super(uuid);
 		this.surveyUuid = surveyUuid;
 		this.surveyName = surveyName;
@@ -48,6 +51,9 @@ public SurveyTokenIndexDto(
 		this.assignmentDate = assignmentDate;
 		this.recipientEmail = recipientEmail;
         this.responseReceived = responseReceived;
+        this.generatedDocumentUuid = generatedDocumentUuid;
+        this.generatedDocumentName = generatedDocumentName;
+        this.generatedDocumentMimeType = generatedDocumentMimeType;
     }
 
 	public String getSurveyUuid() {
@@ -81,4 +87,16 @@ public Boolean getResponseReceived() {
 	public SurveyTokenReferenceDto toReference() {
 		return new SurveyTokenReferenceDto(getUuid(), getSurveyName());
 	}
+
+	public String getGeneratedDocumentUuid() {
+		return generatedDocumentUuid;
+	}
+
+	public String getGeneratedDocumentName() {
+		return generatedDocumentName;
+	}
+
+	public String getGeneratedDocumentMimeType() {
+		return generatedDocumentMimeType;
+	}
 }

sormas-api/src/main/resources/captions.properties

@@ -3419,3 +3419,5 @@ SurveyToken.assignmentDate = Assignment date
 SurveyToken.recipientEmail = Recipient email
 SurveyToken.generatedDocument = Generated document
 SurveyToken.responseReceived = Response received
+
+SurveyDocumentOptions.survey = Survey

sormas-api/src/main/resources/strings.properties

@@ -400,6 +400,8 @@ errorFileNotFound = File '%s' not found
 errorReadingTemplate = Error reading template '%s'
 errorReadingDocument = Error reading document '%s'
 errorProcessingTemplate = Error processing template.
+errorUploadGeneratedDocument=Could not upload the generated document.
+errorUploadGeneratedDocumentExceedsFileSizeLimit=Cannot upload the generated document because it exceeds the file size limit configured in the system.
 errorTemplateFileCorrupt = The template file is corrupt.
 errorWritingTemplate = Could not write template file.
 errorCampaignDiagramTotalsCalculationError=At least part of the percentage values for the diagram '%s' could not be calculated. Please check the diagram definitions for errors.
@@ -439,6 +441,7 @@ errorAdverseEventNotEditable = This adverse event is not editable anymore
 errorAdverseEventInvestigationNotEditable = This adverse event investigation is not editable anymore
 errorExternalEmailMissingPersonEmailAddress=This person does not have an email address
 errorDocumentTemplateWorkflowChangeNotAllowed=The workflow of this document template cannot be changed.
+errorSurveyTokenNotAvailable=There is no available survey token for this survey.
 
 # headings
 headingAccessDenied = Access denied
@@ -909,6 +912,9 @@ headingAefiInvestigationSelectConcernedVaccine=Select concerned vaccine
 headingAefiInvestigationFormSubHeading=(Only for Serious Adverse Events Following Immunization ? Death / Disability / Hospitalization / Cluster)
 headingSurveySideComponent=Surveys
 headingCaseSurveyDetails=Survey details
+headingSurveyGenerateDocument=Generate document
+headingSurveySendDocument=Send document
+headingErrorSendingExternalEmail=Error sending email
 headingImportSurveyTokens = Import Survey Tokens
 
 # Info texts
@@ -1449,6 +1455,9 @@ messageSubcontinentsArchived = All selected subcontinents have been archived
 messageSubcontinentsDearchived = All selected subcontinents have been de-archived
 messageSurveySaved = Survey saved
 messageSurveyCreated = Survey created
+messageSurveyNoDocumentTemplate = No document template has been set for this survey
+messageSurveyNoEmailTemplate = No email template has been set for this survey
+messageSurveyNoTokens = No unassigned tokens have been found for this survey
 messageCountriesArchived = All selected countries have been archived
 messageCountriesDearchived = All selected regions have been de-archived
 messageRegionsArchived = All selected regions have been archived