[GITFLOW]merging 'release-1.46.0' into 'master'

Author: jenkins

DEVELOPMENT_ENVIRONMENT.md

@@ -55,6 +55,7 @@
 	 ``<java-config classpath-suffix="" debug-enabled="true" debug-options="-agentlib:jdwp=transport=dt_socket,address=6009,server=n,suspend=y" ...``
 - Open the Ant window, click on the "+" icon and select the build.xml file from the sormas-base project
 - Execute the "install" and "deploy-serverlibs" scripts in this order
+- Set the default working directory for run configurations: Run -> Edit Configurations -> Templates -> Application -> set the value for *Working directory* to ``$MODULE_WORKING_DIR$``
 - Configure code formatting:
 	- install Eclipse Code Formatter for IntelliJ (https://plugins.jetbrains.com/plugin/6546-eclipse-code-formatter)
 	- open the plugin settings (Other Settings -> Eclipse Code Formatter) and select "Use the Eclipse Code Formatter"

GUIDE_ADD_NEW_FIELD.md

@@ -34,7 +34,8 @@ The SORMAS API is the heart of the data schema. Accordingly, this is where you h
    ```
    Symptoms.soreThroat = Sore throat/pharyngitis
    ```
-5. *Very important*: We have now officially made a change to the API which likely means that old versions are no longer fully compatible.
+5. When you made additions/changes on keys in ``captions.properties``, ``strings.properties`` or ``validations.properties`` you have to run ``I18nConstantGenerator`` (run as ... Java Application) to update the corresponding Constants classes.
+6. *Very important*: We have now officially made a change to the API which likely means that old versions are no longer fully compatible.
    When data with the new field is sent to a mobile device with an old version, it will not know about the field and the data is lost on the device.
    When the data is send back to the server the empty field may override any existing data and it's now also lost on the server itself.
    To avoid this the following has to be done:
@@ -81,7 +82,28 @@ Now we need to make sure data in the new field is exchanged between the backend
     ```
 	target.setSoreThroat(source.getSoreThroat());
     ```
+Now we need to make sure data in the new field is exported by the detailed export.
 
+11. Identify corresponding *ExportDto (e.g. CaseExportDto)
+12. Add the field as a private member of the dto class with a get- and set-method.
+13. Add the @Order annotation on the getter method of the new field
+    ```
+    @Order(33)
+    public SymptomState getSoreThroat() {
+        return soreThroat;
+    }
+    ```
+    > **NOTE**: The @Order numbers should be unique so please increase the order of the getters below if there are any.
+14. Initialize the new field in the constructor
+15. Add the new field in the selection list in the `getExportList` method of the *FacadeEJB
+    ```
+    cq.multiselect(
+        ...,
+        caseRoot.get(Case.SORE_THROAT),
+        ...
+    )
+    ``` 
+    > **NOTE**: Make sure the order of the fields in the selection list corresponds the order of arguments in the constructor of *ExportDto class  
 ### III. Adding the field to the SORMAS UI
 
 The SORMAS UI is the web application that is used by supervisors, laboratory users, national instances and others.

SERVER_CUSTOMIZATION.md

@@ -29,6 +29,8 @@ The following properties are currently configurable:
 * **Infrastructure sync threshold** *(infrastructuresyncthreshold)*: Synchronizing infrastructure data to mobile apps (e.g. regions or health facilities) is done in chunks to avoid connection timeouts. If you expect your users to have very bad internet connection, lowering this threshold could make it easier for them to synchronize this data.
 * **Archiving thresholds** *(daysAfterCaseGetsArchived and daysAfterEventGetsArchived)*: The number of days without any changes after which cases/events are automatically archived (i.e. they will no longer be displayed in the normal directories, but still count towards statistics or counts on the dashboard and can still be viewed by users with the respective user right).
 * **Rscript executable** *(rscript.executable)*: The location of the Rscript executable. If you've installed Rscript on your server and specify the path here (the default should work for Linux systems as long as you've used the default install path), network diagrams for transmission chains will be shown in the web app.
+* **Symptom journal interface**: Properties used to connect to an external symptom journal service. *interface.symptomjournal.url* is the URL to the website that SORMAS should connect to; *interface.symptomjournal.authurl* is the URL used to authenticate SORMAS at the external service; *interface.symptomjournal.clientid* and *interface.symptomjournal.secret* are the credentials used for the authentication process.
+* **Custom branding**: Properties used to apply a custom branding to SORMAS that overrides its name and default logo. Using these properties also alters the sidebar and adds another customizable area to it. If you want to use this feature, set *custombranding* to true. *custombranding.name* is the name that you want to use, *custombranding.logo.path* is the path to the logo that should be used.
 
 ## Importing Infrastructure Data
 When you start a SORMAS server for the first time, some default infrastructure data is generated to ensure that the server is usable and the default users can be created. It is recommended (and, unless you're working on a demo server, necessary) to archive this default data and import the official infrastructure data of the country or part of the country that you intend to use SORMAS in instead.

SERVER_SETUP.md

@@ -51,9 +51,15 @@
 
 * Get the latest SORMAS build by downloading the ZIP archive from the latest release on GitHub: https://github.com/hzi-braunschweig/SORMAS-Open/releases/latest 
 * **Linux**:
-  * Unzip the archive and copy/upload its contents to **/root/deploy/sormas/$(date +%F)**
-  * ``cd /root/deploy/sormas/$(date +%F)``
-  * Make the setup script executable with ``chmod +x server-setup.sh``
+  * Unzip the archive, copy/upload its contents to **/root/deploy/sormas/$(date +%F)** and make the setup script executable.
+        
+		cd /root/deploy/sormas
+		SORMAS_VERSION=1.y.z
+		wget https://github.com/hzi-braunschweig/SORMAS-Project/releases/download/v${SORMAS_VERSION}/sormas_${SORMAS_VERSION}.zip
+		unzip sormas_${SORMAS_VERSION}.zip
+		mv deploy/ $(date +%F)
+		rm sormas_${SORMAS_VERSION}.zip
+		chmod +x $(date +%F)/server-setup.sh
 * **Windows**:
   * Download & install Git for Windows. This will provide a bash emulation that you can use to run the setup script: https://gitforwindows.org/
   * Unzip the ZIP archive (e.g. into you download directory)

SERVER_UPDATE.md

@@ -6,7 +6,13 @@ Note: You can skip this step if you've just set up your SORMAS server and have a
 
 * Get the latest release files (deploy.zip) from https://github.com/hzi-braunschweig/SORMAS-Open/releases/latest
 * Unzip the archive and copy/upload its contents to **/root/deploy/sormas/$(date +%F)**
-
+        
+		cd /root/deploy/sormas
+		SORMAS_VERSION=1.y.z
+		wget https://github.com/hzi-braunschweig/SORMAS-Project/releases/download/v${SORMAS_VERSION}/sormas_${SORMAS_VERSION}.zip
+		unzip sormas_${SORMAS_VERSION}.zip
+		mv deploy/ $(date +%F)
+		rm sormas_${SORMAS_VERSION}.zip
 ## Automatic Server Update
 * Navigate to the  folder containing the unzipped deploy files:
 ``cd /root/deploy/sormas/$(date +%F)``

sormas-api/pom.xml

@@ -2,7 +2,7 @@
 	<parent>
 		<groupId>de.symeda.sormas</groupId>
 		<artifactId>sormas-base</artifactId>
-		<version>1.45.0</version>
+		<version>1.46.0</version>
 		<relativePath>../sormas-base</relativePath>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>

sormas-api/src/main/java/de/symeda/sormas/api/FacadeProvider.java

@@ -17,12 +17,10 @@
  *******************************************************************************/
 package de.symeda.sormas.api;
 
-import javax.naming.InitialContext;
-import javax.naming.NamingException;
-
+import de.symeda.sormas.api.action.ActionFacade;
 import de.symeda.sormas.api.campaign.CampaignFacade;
 import de.symeda.sormas.api.campaign.data.CampaignFormDataFacade;
-import de.symeda.sormas.api.campaign.form.CampaignFormFacade;
+import de.symeda.sormas.api.campaign.form.CampaignFormMetaFacade;
 import de.symeda.sormas.api.caze.CaseFacade;
 import de.symeda.sormas.api.caze.CaseStatisticsFacade;
 import de.symeda.sormas.api.caze.classification.CaseClassificationFacade;
@@ -66,6 +64,9 @@
 import de.symeda.sormas.api.visit.VisitFacade;
 import de.symeda.sormas.api.visualization.VisualizationFacade;
 
+import javax.naming.InitialContext;
+import javax.naming.NamingException;
+
 public class FacadeProvider {
 
 	private static final String JNDI_PREFIX = "java:global/sormas-ear/sormas-backend/";
@@ -122,6 +123,10 @@ public static TaskFacade getTaskFacade() {
 		return get().lookupEjbRemote(TaskFacade.class);
 	}
 
+	public static ActionFacade getActionFacade() {
+		return get().lookupEjbRemote(ActionFacade.class);
+	}
+
 	public static SampleFacade getSampleFacade() {
 		return get().lookupEjbRemote(SampleFacade.class);
 	}
@@ -262,8 +267,8 @@ public static CampaignFacade getCampaignFacade() {
 		return get().lookupEjbRemote(CampaignFacade.class);
 	}
 
-	public static CampaignFormFacade getCampaignFormFacade() {
-		return get().lookupEjbRemote(CampaignFormFacade.class);
+	public static CampaignFormMetaFacade getCampaignFormMetaFacade() {
+		return get().lookupEjbRemote(CampaignFormMetaFacade.class);
 	}
 
 	public static CampaignFormDataFacade getCampaignFormDataFacade() {

sormas-api/src/main/java/de/symeda/sormas/api/IntegerRange.java

@@ -57,7 +57,7 @@ public String toString() {
 		} else if (from != null && to == null) {
 			return String.valueOf(from) + "+";
 		} else {
-			return I18nProperties.getString(Strings.unknown);
+			return I18nProperties.getString(Strings.notSpecified);
 		}
 	}
 

sormas-api/src/main/java/de/symeda/sormas/api/action/ActionContext.java

@@ -0,0 +1,33 @@
+/*******************************************************************************
+ * SORMAS® - Surveillance Outbreak Response Management & Analysis System
+ * Copyright © 2016-2018 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.action;
+
+import de.symeda.sormas.api.i18n.I18nProperties;
+
+/**
+ * Context of an action.
+ */
+public enum ActionContext {
+
+	// XXX: add here new contexts (case, contact, …)
+	EVENT;
+
+	public String toString() {
+		return I18nProperties.getEnumCaption(this);
+	}
+}

sormas-api/src/main/java/de/symeda/sormas/api/action/ActionCriteria.java

@@ -0,0 +1,59 @@
+/*******************************************************************************
+ * SORMAS® - Surveillance Outbreak Response Management & Analysis System
+ * Copyright © 2016-2018 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.action;
+
+import java.io.Serializable;
+
+import de.symeda.sormas.api.BaseCriteria;
+import de.symeda.sormas.api.event.EventReferenceDto;
+import de.symeda.sormas.api.utils.IgnoreForUrl;
+
+public class ActionCriteria extends BaseCriteria implements Serializable {
+
+	private static final long serialVersionUID = -9174165215694877624L;
+
+	private ActionStatus actionStatus;
+	private EventReferenceDto event;
+
+	public ActionStatus getActionStatus() {
+		return actionStatus;
+	}
+
+	public void setActionStatus(ActionStatus actionStatus) {
+		this.actionStatus = actionStatus;
+	}
+
+	public ActionCriteria actionStatus(ActionStatus actionStatus) {
+		setActionStatus(actionStatus);
+		return this;
+	}
+
+	public ActionCriteria event(EventReferenceDto event) {
+		this.event = event;
+		return this;
+	}
+
+	@IgnoreForUrl
+	public EventReferenceDto getEvent() {
+		return event;
+	}
+
+	public boolean hasContextCriteria() {
+		return getEvent() != null;
+	}
+}