ImisDevelopers
diff --git a/‎CONTRIBUTING.md‎
Lines changed: 22 additions & 5 deletions b/‎CONTRIBUTING.md‎
Lines changed: 22 additions & 5 deletions
diff --git a/‎DEVELOPMENT_ENVIRONMENT.md‎
Lines changed: 3 additions & 2 deletions b/‎DEVELOPMENT_ENVIRONMENT.md‎
Lines changed: 3 additions & 2 deletions
diff --git a/‎GUIDE_SORMAS2SORMAS_CERTIFICATE.md‎
Lines changed: 62 additions & 33 deletions b/‎GUIDE_SORMAS2SORMAS_CERTIFICATE.md‎
Lines changed: 62 additions & 33 deletions
diff --git a/‎README.md‎
Lines changed: 1 addition & 1 deletion b/‎README.md‎
Lines changed: 1 addition & 1 deletion
@@ -79,19 +79,36 @@ If you're interested in participating in the development of SORMAS, you can use
    > #61 - added model to define classification, apply automatic case classification whenever a field value changes
 6. Each pull request should be related to a single issue (if possible). 
 
-### SORMAS Sprint Board
+### SORMAS Product Backlog
 
-The SORMAS sprint board is segmented into the following categories:
+The board **Product Backlog** is used to plan, refine and prioritize the tickets for the upcoming sprints. 
+The sorting from top to bottom in every column reflects the priority for the product. The Product Owner is responsible to put tickets into the Backlog and keep the ticket information updated.
 
-* **Backlog:** Issues that have been selected to be done in the current sprint, but for which work has not yet started.
+The Product Backlog contains the following columns:
+* **Backlog:** Issues that have been identified by the Product Owner to be done in the next sprints. There can be a column for each Scrum Team if it fits the need.
+* **Sprint n:** Contain tickets picked by the Product Owner to be done in the named sprint. Text notes or separate columns are used to separate issues between Scrum Teams. It gives a forecast what might come in the upcoming sprint and it is the starting point for the Sprint Planning. Every ticket the Development Team do not pick into their Sprint Backlog needs to be moved back to the Backlog column or one sprint further.
+* **Done:** Tickets that are closed (usually resolved within the running sprint) are moved here **automatically**. The sorting does not represent the priority here any more.
+
+
+### SORMAS Sprint Backlog
+
+The board **Sprint Backlog** exists for each Scrum Team and is segmented into the following categories:
+
+* **Backlog:** Issues that have been selected by the Development Team to be done in the current sprint, but for which work has not yet started. The sorting top to bottom on this column reflects the priority given by the Product Owner at the time of the Sprint Planning.
 * **In Progress:** Issues that have been assigned to a contributor and for which work has started.
 * **Waiting:** Issues for which work has started and that have been put on hold, e.g. because action or feedback by an external contributor is required.
 * **Review:** Issues that have been resolved, but not been reviewed by another contributor yet. The ticket status is usually **Open**, but **Closed** is also allowed if no code change or merge is needed.
+* **Testing:** Issues that have been reviewed and merged to **development** branch to be tested and verified on a central TEST instance. The ticket status is supposed to be **Closed**.
 * **Done:** Issues that have been resolved, reviewed and satisfy the Definition of Done. The ticket status is supposed to be **Closed**.
 
-The general workflow is that whenever a contributor starts working on an issue, they **assign** themselves to it and manually **move the issue** from **Backlog** to **In Progress**.
+The general workflow is that whenever a contributor starts working on an issue, they **assign** themselves to it and manually **move the issue** from **Backlog** to **In Progress**. 
+Transitions to **Waiting** and **Review** also need to be done manually. When the developer is done with all work (no code changes or merges needed, milestone is set), the ticket is supposed to be closed to go automatically to **Testing**.
+Approved tickets are supposed to be moved manually from **Testing** to **Done*.
+
+The GitHub project has been configured to **automatically** move issues that are closed to **Testing** and issues that are reopened back to **In Progress**.
+
+The Development Team is responsible to keep the tickets up to date on this board and to assign the appropriate milestone in which the work is going to be released.
 
-The GitHub project has been configured to **automatically** move issues that are closed to **Done** and issues that are reopened back to **In Progress**.
 
 ### Eclipse Troubleshooting
 
 
@@ -68,14 +68,15 @@
 - 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:
+- **Configure code formatting:**
+	- disable "Optimize imports on the fly" (Editor -> General -> Auto Import)
 	- 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"
 	- under "Eclipse Formatter config file", select ``sormas-base/java-formatter-profile.xml``
 	- check optimize imports and, for "Import order", select ``sormas-base/java-importorder-profile.importorder``
 	- **Important:** select "Do not format other file types by IntelliJ formatter"
 	- go to Preferences -> Editor -> Code style -> Java -> Imports: set class and static names counts for import with * to 99
-	- for IntelliJ, code formatting is usually done with Ctrl+Alt+L. For automatic formatting, it's recommended to use the plugin Save Actions (https://plugins.jetbrains.com/plugin/7642-save-actions)
+	- for IntelliJ, code formatting is usually done with Ctrl+Alt+L. For automatic formatting, it's recommended to use the plugin Save Actions and check the first three checkboxes in "General" and the first two checkboxes in "Formatting Actions" (https://plugins.jetbrains.com/plugin/7642-save-actions)
 
 ## Android Studio
 **Note: This is only needed for development of the SORMAS Android app
 
@@ -5,6 +5,7 @@ This guide explains how to:
  * set up the server address list file
  * add certificates of other SORMAS instances to the local truststore
  * add other servers to the local server list
+ * handling self-signed ssl certificates on test systems
 
 ### Prerequisites
 
@@ -13,32 +14,41 @@ See [Installing Java](SERVER_SETUP.md#java-11)
 
 ### Using the certificate generation script
 
-1. Run ``bash ./generate-cert.sh``
-2. If the ``sormas2sormas`` directory is not found, you will be prompted to provide its path.
-3. If the ``SORMAS_PROPERTIES`` environment variable is not available, the script will search for the ``sormas.properties`` 
-file in ``/opt/domains/sormas/sormas.properties`` by default. If it is not found there, you will be prompted to provide 
-the path to the ``sormas.properties`` file.
-4. For the generation of the certificate, the following data is needed: a password, a *Common Name* (CN) 
-    and an *Organization* (O). These may be set in environment variables (recommended), or provided 
-    manually as the script executes.
-    * The password environment variable should be named ``SORMAS_S2S_CERT_PASS``. Please note that the password has to be 
-    at least 6 characters, or you will be prompted for a new one.
-    * the *Common Name* environment variable should be named ``SORMAS_S2S_CERT_CN``.<br/>
-    **Important**: for Germany, this value should be the SurvNet Code Site. <br/>
-    E.g. *2.03.1.01.*
-    * the *Organization* (O) environment variable should be named ``SORMAS_S2S_CERT_ORG``.<br/>
+1. Run ``bash ./s2s-generate-cert.sh``
+2. If the ``SORMAS2SORMAS_DIR`` environment variable is not available, the script will search for ``/opt/sormas2sormas`` by default. 
+If it is not found there, you will be prompted to provide the pat to the *sormas2sormas* directory.
+3. If the ``SORMAS_DOMAIN_DIR`` environment variable is not available, the script will search for ``/opt/domains/sormas`` by default.<br>
+   If it is not found there, you will be prompted to provide the path to the *sormas domain directory*.
+   >If you don't have a local sormas installation, for example you are using the docker environment, 
+   >you can specify any existing directory and after the script finishes you will find a ``sormas.properties`` file there
+   >that contains the necessary configuration that must be added to the ``sormas.properties`` file of your installation
+4. For the generation of the certificate, the following data is needed:
+   an identifier of the *Organization*, the name of the *Organization*, the host name of the SORMAS server, the **https** port of the server,
+   a password for the certificate keystore and a password for the REST user to be used when sharing data through the REST api.
+   These may be set in environment variables (recommended), or provided manually as the script executes.
+
+    * the identifier of the *Organization* environment variable should be named ``SORMAS_ORG_ID``. 
+    This variable is also used as *Common Name* (CN) of the certificate<br/>
+    **Important**: for Germany, this value should be the SORMAS SurvNet Code Site (e.g. 2.99.1.01. if the regular Code Site was 1.99.1.01.). <br/>
+    * the name of the organization *Organization* (O) environment variable should be named ``SORMAS_ORG_NAME``.<br/>
     **Important**: for Germany, this value should be the name of the Health Department (Gesundheitsamt) 
     to which the SORMAS instance will be assigned. <br/>
-    E.g. *GA Braunschweig*
+    E.g. *GA Musterhausen*
+    * the host name variable should be named ``SORMAS_HOST_NAME``. <br/>
+    E.g. *sormas.gesundheitsamt-musterhausen.de* 
+    * the https port environment variable should be named ``SORMAS_HTTPS_PORT``. If it is not found, you will be prompted to provide it. 
+    If you press enter without typing a port number the default 443 will be used.
+    * The password environment variable should be named ``SORMAS_S2S_CERT_PASS``. Please note that the password has to be 
+    at least 6 characters, or you will be prompted for a new one.
+    * the REST user password environment variable should be named ``SORMAS_S2S_REST_PASSWORD``.
+    Please note that the password has to be at least 12 characters, or you will be prompted for a new one.
+    
 5. After providing the requested data, the certificate files will be generated. <br/>
    The generated certificate has a validity of 3 years. 
    The certificate files will be available in the root SORMAS directory, in the folder ``/sormas2sormas``.
 6. A CSV file containing the access data for this instance will also be generated in the folder ``/sormas2sormas``.
-   It will be named ``server-access-data.csv``.
-   The file will contain on the first two columns of the first row the Common Name and the Organization, as provided
-   when creating the certificate. <br/>
-   **Please fill in on the third column the full URL of the server.** <br/>
-   You will also have to set up a user for communicating with other SORMAS instances.
+   It will be named ``{host name}-server-access-data.csv``.
+   The file will contain the organization identifier, organization name, host name and the REST user password.<br/>
 7. The generated ``.p12`` file should not be shared with third parties. <br/>
    The generated ``.crt`` file will be verified and shared with other SORMAS instances, from which this instance
    will be able to request data. Conversely, in order to enable other SORMAS instances to request data from this 
@@ -52,24 +62,43 @@ the path to the ``sormas.properties`` file.
 To enable other SORMAS instances to send and receive data from this instance, their certificate must be added to the 
 truststore of this instance. Furthermore, the access data of other instances must be added to the local server
 list. To complete this setup, please follow the next steps:
-1. Run ``bash ./import-to-truststore.sh``
-2. If the ``sormas2sormas`` directory is not found, you will be prompted to provide its path.
-3. If the ``SORMAS_PROPERTIES`` environment variable is not available, the script will search for the ``sormas.properties`` 
-   file in ``/opt/domains/sormas/sormas.properties`` by default. If it is not found there, you will be prompted to provide 
-   the path to the ``sormas.properties`` file.
+1. Run ``bash ./s2s-import-to-truststore.sh``
+2. If the ``SORMAS2SORMAS_DIR`` environment variable is not available, the script will search for ``/opt/sormas2sormas`` by default. 
+If it is not found there, you will be prompted to provide the path to the *sormas2sormas* directory.
+3. If the ``SORMAS_DOMAIN_DIR`` environment variable is not available, the script will search for ``/opt/domains/sormas`` by default.
+   If it is not found there, you will be prompted to provide the path to the *sormas domain directory*.
+   >If you don't have a local sormas installation, for example you are using the docker environment, 
+   >you can specify any existing directory and after the script finishes you will find a ``sormas.properties`` file there
+   >that contains the necessary configuration that must be added to the ``sormas.properties`` file of your installation
+ 
 4. If ``sormas2sormas.truststore.p12`` is not found in the folder ``/sormas2sormas``, it will be created. 
     The truststore password may be provided in an environment variable ``SORMAS_S2S_TRUSTSTORE_PASS``.
     * If the aforementioned environment variable is not available, the truststore password will be searched in the 
     ``sormas.properties`` file.
     * If it is not found there, you will be prompted to provide the truststore password.
     * The relevant properties will be automatically set by the script in the ``sormas.properties`` file.
 5. If the server address list file ``server-list.csv`` is not found in the folder ``/sormas2sormas``, it will also be created.
-6. You will be prompted to provide the file name of the certificate to be imported. This certificate should be located
-in the ``/sormas2sormas`` folder. Please provide the name including the extension. E.g ``mycert.crt``
+6. You will be prompted to provide the *host name* of the organization that's certificate is being imported. 
+   If the certificate was generated with the `s2s-generate-cert.sh` script, the identifier can be found at the beginning of the file.
+   This certificate should be located in the ``/sormas2sormas`` folder. 
 7. After providing the requested data, the certificate will be imported to the truststore.
-8. You should have also received a CSV file with the server access data. From this file, copy the line corresponding to the
-    instance you would like to communicate with and add it to the local server address list file. This file is named
-    ``server-list.csv`` and is located in the ``/sormas2sormas`` folder. <br/>
-    *Note*: You may check that the Common Name and the Organization of the certificate match the ones corresponding to 
-    the server in the CSV file.
-9. You may now delete the ``.crt`` file.
+8. The content of the ``server-access-data.csv`` provided together with the certificate will be copied to the ``server-list.csv`` file.  
+9. You may now delete the ``.crt`` and ``server-access-data.csv`` files.
+
+10. *Optional for test systems and other systems with self-signed ssl certificates* <br>
+    You must import the SSL certificate of the other server into the ``cacerts.jks`` of your sormas domain.
+    * For getting the SSL certificate you can use ``openssl`` <br>
+        e.g.
+        ```shell script
+        openssl s_client -showcerts -servername sormas.gesundheitsamt-musterhausen.de -connect sormas.gesundheitsamt-musterhausen.de:443 </dev/null | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > certificate.cer        
+        ```
+    * To import the SSL certificate you can use ``keytool`` <br>
+        e.g.
+        ```shell script
+        keytool -importcert -trustcacerts -noprompt -keystore /opt/domains/sormas/config/cacerts.jks -alias sormas_dev -storepass changeit -file certificate.cer
+        ```
+        Note that the alias can be used only once.
+        
+After the certificate is generated and at least one other certificate is imported, 
+on some pages of the application you will see a new box with a *Share* button and information about sharing.
+  
@@ -17,7 +17,7 @@
 You can give SORMAS a try on our play server at https://sormas.helmholtz-hzi.de!
 
 #### How Can I Get Involved?
-Have a look at our [*Contributing Readme*](CONTRIBUTING.md) and contact us at [email protected] or join our [developer chat on Gitter](https://gitter.im/SORMAS-Project) to learn how you can help to drive the development of SORMAS forward and to get development support from our core developers. SORMAS is a community-driven project, and we'd love to have you on board!
+Read through our [*Contributing Readme*](CONTRIBUTING.md) and contact us at [email protected] or join our [developer chat on Gitter](https://gitter.im/SORMAS-Project) to learn how you can help to drive the development of SORMAS forward and to get development support from our core developers. SORMAS is a community-driven project, and we'd love to have you on board! If you want to contribute to the code, please strictly adhere to the [*Development Environment*](DEVELOPMENT_ENVIRONMENT.md) guide to ensure that everything is set up correctly. Please also make sure that you've read the [*Development Contributing Guidelines*](CONTRIBUTING.md#development-contributing-guidelines) before you start to develop.
 
 #### How Can I Report a Bug or Request a Feature?
 Please [create a new issue](https://github.com/hzi-braunschweig/SORMAS-Project/issues/new/choose) and read the [*Submitting an Issue*](CONTRIBUTING.md#submitting-an-issue) guide for more detailed instructions. We appreciate your help!