Updated running Eiffel-Intelligence documentation. (#333)

Author: tobiasake

wiki/markdown/configuration.md

@@ -1,6 +1,6 @@
 # Configuration
 
-The configuration for RabbitMQ, MongoDB etc. can be set in the [application.properties](https://github.com/Ericsson/eiffel-intelligence/blob/master/src/main/resources/application.properties) file. You can also set them as system properties using the -D flags when starting Eiffel Intelligence.
+The configuration for RabbitMQ, MongoDB etc. can be set in the [application.properties](https://github.com/eiffel-community/eiffel-intelligence/blob/master/src/main/resources/application.properties) file. You can also set them as system properties using the -D flags when starting Eiffel Intelligence.
 
 ## Setting up multiple EI instances
 
@@ -26,13 +26,13 @@ This situation may be needed when the events throughput is very high. In this ca
 ## Configure Eiffel Intelligence with extraction rules for specific Eiffel protocol version
 
 Extraction rules for a specific Eiffel protocol versions is configured by
-setting "rules.path" property in [application.properties](https://github.com/Ericsson/eiffel-intelligence/blob/master/src/main/resources/application.properties)
+setting "rules.path" property in [application.properties](https://github.com/eiffel-community/eiffel-intelligence/blob/master/src/main/resources/application.properties)
 to point to the correct extraction rules json file.
 
 Eiffel Intelligence provides default extractions rules json files for
 different Eiffel protocol versions inside the war artifact file and in the
 source code repository. All default extraction rules json files can be
-found here: [extraction rules](https://github.com/Ericsson/eiffel-intelligence/blob/master/src/main/resources/rules)
+found here: [extraction rules](https://github.com/eiffel-community/eiffel-intelligence/blob/master/src/main/resources/rules)
 
 Example of setting "rules.path" property in application.properties using default extraction rules json files provided in eiffel-intelligence war file:
 - rules.path: /rules/ArtifactRules-Eiffel-Agen-Version.json

wiki/markdown/existing-rules-files.md

@@ -0,0 +1,25 @@
+# Existing rules
+
+We have created some rules that represent some use cases triggering the development of the Eiffel Intelligence. The files containing the rules can be found [**here.**](https://github.com/eiffel-community/eiffel-intelligence/tree/master/src/main/resources)
+
+We have also drawn the flows that the existing rules need to perform the aggregation. The drawings contain the events and how they are linked together.
+
+## Flow with the events required for Artifact object flow.
+
+
+<img src="images/ArtifactRules.png">
+</img>
+
+
+## Flow with the events required for SourceChange object flow.
+
+
+<img src="images/SourceChangeRules.png">
+</img>
+
+
+## Flow with the events required for TestExecution object flow.
+
+
+<img src="images/test-executionRules.png">
+</img>

wiki/markdown/history-rules.md

@@ -15,10 +15,10 @@ JSON object from "HistoryExtractionRules" in aggregated object, same as
 returned from ER. The path for merging history data will get as long as the
 depth of the tree where your historical event exists.
 
-A step by step example will be presented using [artifact aggregation rules](https://github.com/Ericsson/eiffel-intelligence/blob/master/src/main/resources/rules/ArtifactRules-Eiffel-Agen-Version.json).
+A step by step example will be presented using [artifact aggregation rules](https://github.com/eiffel-community/eiffel-intelligence/blob/master/src/main/resources/rules/ArtifactRules-Eiffel-Agen-Version.json).
 
 Assume that an EiffelArtifactCreatedEvent is received and the upstream response
-tree looks like [this](https://github.com/Ericsson/eiffel-intelligence/blob/master/src/test/resources/upStreamResultFile.json).
+tree looks like [this](https://github.com/eiffel-community/eiffel-intelligence/blob/master/src/test/resources/upStreamResultFile.json).
 
 The starting aggregated object is :
 

wiki/markdown/query.md

@@ -116,7 +116,7 @@ all aggregated objects from the database. The aggregated objects will be
 returned from specific collection (which name is defined by property
 aggregated.collection.name) that is stored in specific database (which name is
 defined by property spring.data.mongodb.database). Read more about the
-different properties in [application's properties](https://github.com/Ericsson/eiffel-intelligence/blob/master/src/main/resources/application.properties)
+different properties in [application's properties](https://github.com/eiffel-community/eiffel-intelligence/blob/master/src/main/resources/application.properties)
 or in the [documentation](https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/markdown/configuration.md).
 
 Example:

wiki/markdown/rules.md

@@ -90,7 +90,7 @@ StartEvent is "YES" then it will be the first processed event in the aggregation
 sequence. If StartEvent is "NO" then Eiffel event of this type will be used to
 append information to existing aggregated object. If no aggregated object exist
 then it will wait a certain time as defined by property
- _waitlist.collection.ttlValue_ in [application's properties](https://github.com/Ericsson/eiffel-intelligence/blob/master/src/main/resources/application.properties)
+ _waitlist.collection.ttlValue_ in [application's properties](https://github.com/eiffel-community/eiffel-intelligence/blob/master/src/main/resources/application.properties)
  until wanted aggregated object has been created. If no aggregated object is
  created in time then the event will no longer be processed and it will be
  removed from the wait list.

wiki/markdown/running-eiffel-intelligence.md

@@ -2,16 +2,19 @@
 
 ## _Prerequisites_
 
-Eiffel intelligence is Spring microservice distributed in a war file. To start
-the service download the war file from
-[jitpack.io](https://jitpack.io/#Ericsson/eiffel-intelligence) and look for the
+Eiffel Intelligence is a Spring microservice distributed in a war file.
+
+Eiffel Intelligence release war files can be downloaded from Jitpack:
+[jitpack.io](https://jitpack.io/#eiffel-community/eiffel-intelligence) and look for the
 latest version. Now replace the latest version in the link below:
 
-    https://jitpack.io/com/github/Ericsson/eiffel-intelligence/<version>/eiffel-intelligence-<version>.war
+    https://jitpack.io/com/github/eiffel-community/eiffel-intelligence/<version>/eiffel-intelligence-<version>.war
+
+## Running with Maven command
 
 If you want to test the latest code in github clone the project and compile it
 with:
-
+    
     mvn clean install
 
 append **_-DskipTests_** if you want to skip the tests since the latest on
@@ -26,23 +29,64 @@ With properties added to the maven command, e.g:
 
     mvn spring-boot:run -Dlogging.level.com.ericsson.ei=DEBUG -Dspring.data.mongodb.port=27019
 
-Or you can run the executable war file (located in target folder, if running from source code):
+ ## Running with Java command 
 
-    java -jar eiffel-intelligence-<version>.war
+Another option is to run the executable war file with java command.
+If running from source code, war file is generated and produced by maven command (mvn install command can be used as well):
+
+    mvn package -DskipTests
+
+ This command should produce an `eiffel-intelligence-<version>.war` file in target folder, `target/eiffel-intelligence-<version>.war`. 
 
-if you want to run with default configuration for local message buss and
-Mongo DB.
+The war file is executed by the following command and with default configuration:
+
+    java -jar eiffel-intelligence-<version>.war
 
 Own configuration can be provided with
 
-    java -jar eiffel-intelligence-<version>.war --spring.config.location=file:<path to own application.properties>
+    java -jar eiffel-intelligence-<version>.war --spring.config.location=<path to own application.properties>
 
 remember to keep the name of the properties file if you are a beginner to
 Spring. More advanced Spring user can look [here](https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html)
 for more information about using external configuration.
 
-If only few properties need to be overridden then use java opts, for example
+If a few properties need to be overridden, then use java opts, for example:
 
     java -jar eiffel-intelligence-<version>.war -Dspring.data.mongodb.port=27019
 
-All available Eiffel-Intelligence properties can be found in [application.properties](https://github.com/Ericsson/eiffel-intelligence/blob/master/src/main/resources/application.properties) example file.
+## Running in Tomcat instance
+
+To run Eiffel Intelligence in Tomcat, the war file must be put into the webapp folder in tomcat installation folder, also called catalina home folder:
+
+    (catalina home)/webapp/
+
+If Eiffel Intelligence should be run without any context-path in the url address, then overwrite ROOT.war file in webapp folder with `eiffel-intelligence-<version>.war`:
+
+    cp eiffel-intelligence-<version>.war (catalina home)/webapp/ROOT.war
+
+Remove "ROOT" folder in webapp folder:
+
+    rm -rf (catalina home)/webapp/ROOT/
+
+Create "config" folder in catalina home folder, if it doesn't exist. Spring and Eiffel Intelligence will look for the application.properties configuration file in config folder:
+
+    mkdir (catalina home)/config
+
+Copy the application.properties file into the newly created config folder:
+    
+    cp application.properties (catalina home)/config
+
+Start Tomcat and Eiffel Intelligence in background/daemon mode by executing command:
+
+    (catalina home)/bin/catalina.sh start
+
+To run Tomcat and Eiffel Intelligence with logs printed to console:
+    
+    (catalina home)/bin/catalina.sh run
+
+## Eiffel Intelligence configurations and properties
+
+All available Eiffel Intelligence properties can be found in [application.properties](https://github.com/eiffel-community/eiffel-intelligence/blob/master/src/main/resources/application.properties) example file.
+
+More documentation of each Eiffel Intelligence property and configurations can be found in [Configuration page](https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/markdown/configuration.md)
+

wiki/markdown/running-rules-on-objects.md

@@ -27,7 +27,7 @@ should be set to true:
 
     testaggregated.enabled: true
 
-A GUI is also implemented in [Eiffel Intelligence Frontend](https://github.com/Ericsson/eiffel-intelligence-frontend) but only visible when above property is set to true in the backend (this application).
+A GUI is also implemented in [Eiffel Intelligence Frontend](https://github.com/eiffel-community/eiffel-intelligence-frontend) but only visible when above property is set to true in the backend (this application).
 
 ## Check if testRules are enabled on the selected instance
 
@@ -151,4 +151,4 @@ Examples of this endpoint using curl
 
     curl -X POST -H "Content-type: application/json"  --data @body.json  http://localhost:8090/rules/rule-check/aggregation
 
-For demo you can use following list of [events](https://github.com/Ericsson/eiffel-intelligence/blob/master/src/test/resources/AggregateListEvents.json) and list of [rules](https://github.com/Ericsson/eiffel-intelligence/blob/master/src/test/resources/AggregateListRules.json). They can be used to create a json with the structure as above and when send as body to the endpoint you should get following [aggregation result](https://github.com/Ericsson/eiffel-intelligence/blob/master/src/test/resources/AggregateResultObject.json)
+For demo you can use following list of [events](https://github.com/eiffel-community/eiffel-intelligence/blob/master/src/test/resources/AggregateListEvents.json) and list of [rules](https://github.com/eiffel-community/eiffel-intelligence/blob/master/src/test/resources/AggregateListRules.json). They can be used to create a json with the structure as above and when send as body to the endpoint you should get following [aggregation result](https://github.com/eiffel-community/eiffel-intelligence/blob/master/src/test/resources/AggregateResultObject.json)

wiki/markdown/subscription-with-email-notification.md

@@ -7,7 +7,7 @@ _**OBS! Comments are only for documentation purposes and a subscription should
 not contain them. The subscription will be rejected at this moment if it
 contains comments like below.**_
 
-_**Subscription templates can be found [here](https://github.com/Ericsson/eiffel-intelligence/tree/master/src/main/resources/templates).**_
+_**Subscription templates can be found [here](https://github.com/eiffel-community/eiffel-intelligence/tree/master/src/main/resources/templates).**_
 
     {
         // The name of the subscription to make it easy to search for it.