Merge branch 'master' of ssh://git.eclipse.org:29418/openk-usermodules/org.eclipse.openk-usermodules.gridFailureInformation.documentation
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..b463994
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,39 @@
+HELP.md
+target/
+!.mvn/wrapper/maven-wrapper.jar
+!**/src/main/**
+!**/src/test/**
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### Logs ###
+/logs
+
+### Sonar ###
+/.scannerwork
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+*.log
+*.gz
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+build/
+
+### VS Code ###
+.vscode/
diff --git a/src/main/asciidoc/howto/howtoBuild.adoc b/src/main/asciidoc/howto/howtoBuild.adoc
index 688050c..193ce1b 100644
--- a/src/main/asciidoc/howto/howtoBuild.adoc
+++ b/src/main/asciidoc/howto/howtoBuild.adoc
@@ -1,10 +1,17 @@
-= openKonsequenz - How to build the module "grid-failure-information@openK"
-:Date: 2017-11-17
+= openKonsequenz - How to build the module "gridFailureInformation@openK"
+
+:Date: 2020-03-24
:Revision: 1
+
:icons:
:source-highlighter: highlightjs
:highlightjs-theme: solarized_dark
+:imagesdir: ../img
+:iconsdir: ../img/icons
+
+:lang: en
+:encoding: utf-8
<<<
IMPORTANT: Please be sure that you have first *Portal (Auth n Auth)* and *ContactBaseData* installed and configured!
@@ -53,5 +60,71 @@
TIP: Next Step -> Read the *grid-failure-information_howtoRun* file!
+== How to build the SIT-Web-FE (Map- and Table-Component)
+=== Prerequirements
+* Open a command line and make sure that nest-cli is installed:
++
+[source,command]
+----
+ $ nest -version
+----
+{blank}
+=> This should show the version number.
+* If you miss the version number or get an error then install the nest-cli with the following command:
++
+[source,command]
+----
+ $ npm install -g @nestjs/cli
+----
+{blank}
+
+=== Build and run the SIT-Web-Cache-Service
+
+* Open a command line and navigate to the folder of the service project
+(_grid-failure-information-web-cache_).
+
+* To build the service run the commands:
++
+[source,command]
+----
+ $ npm install
+ $ nest build
+----
+{blank}
+=> A folder named '_dist_' should be created in the project folder containing *.js and *.ts files.
+
+* Start the service with the following command for testing:
++
+[source,command]
+----
+ $ npm run start
+----
+{blank}
+=> After the nest service is started you can test the service within your browser by calling the following address: http://localhost:3000/public-sit. (You should replace _localhost_ with your own network address.)
+
+=== Build the SIT-Web-FE
+
+* Open a command line and navigate to the root folder of the project. +
+=> The project.json file should be in the same folder.
+
+* Install the required dependencies with the following command:
++
+[source,command]
+----
+ $ npm install
+----
+{blank}
+
+* Build the map and table component:
++
+[source,command]
+----
+ $ npm install
+ $ npm run build-comp-full
+----
+{blank}
+=> A folder named '_dist/grid-failure-information-web-comp_' should be created in the project root folder.
+
+TIP: Next Step -> Read the *howtoRun* file!
diff --git a/src/main/asciidoc/howto/howtoRun.adoc b/src/main/asciidoc/howto/howtoRun.adoc
index 6204fd4..b263301 100644
--- a/src/main/asciidoc/howto/howtoRun.adoc
+++ b/src/main/asciidoc/howto/howtoRun.adoc
@@ -1,10 +1,18 @@
= openKonsequenz - How to run the module "gridFailureInformation@openK"
-:Date: 2017-11-17
+
+:Date: 2020-03-24
:Revision: 1
+
:icons:
:source-highlighter: highlightjs
:highlightjs-theme: solarized_dark
+:imagesdir: ../img
+:iconsdir: ../img/icons
+
+:lang: en
+:encoding: utf-8
+
<<<
IMPORTANT: Please be sure that you have first *Portal (Auth n Auth)* and *ContactBaseData* installed and configured!
@@ -87,5 +95,100 @@
IMPORTANT: The reason you maybe don´t see the application running properly, is that you have not even logged in.
To do so, run first the Portal project, where you can log in and then open the elogbook.
+== How to run the SIT-Web-Cache-Service
+=== Prerequirements
+* SIT-Web-Cache-Service is built properly. Otherwise following the instructions in the *howtoBuild* file!
+* Your secured DMZ (demilitarized zone) can host the SIT-Web-Cache-Service.
+* SIT-Web-Cache-Service needs *nodejs* and *nestjs*. Both have to be installed as described in the *howtoBuild* file.
+* The SIT-Web-Cache-Service should be reachable from the SIT_BE.
+=== Run the service
+* Copy all files from the build output to the provided folder in the DMZ.
+* Open a command line and navigate to this folder.
+* Start the service with the following commands:
++
+[source,command]
+----
+ $ node dist/main
+----
+{blank}
+
+== How to run SIT-Web-FE (map- and table-component)
+=== Prerequirements
+* SIT-Web-FE is built properly. Otherwise following the instructions in the *howtoBuild* file!
+* SIT-Web-Cache-Service runs properly.
+* Your secured DMZ (demilitarized zone) can host the SIT-Web-FE.
+* The SIT-Web-FE have to communicate with the SIT-Web-Cache-Service and both parts should be in the same DMZ.
+* If you do not have a web server in your environment (e.g. in a development environment) you can use *http-server*. To install this free and lightweight http server run the following command in a command line:
++
+[source, command]
+----
+ $ npm install -g http-server
+----
+* If you want to run SIT-Web-FE with *http-server* you need *nodejs* which have to be installed as descrbed in the *howtoBuild* file.
+
+IMPORTANT: The description below use *http-server* as an http server. +
+In many cases you will have your own web server - like *tomcat*, *apache*, *IIS* etc. -
+and you have to configure proxy settings and the http communication between all SIT components within this web server.
+
+=== Run the map and/or table component (e.g. with http-server)
+* Copy all files from the build output ('_dist/grid-failure-information-web-comp_') to the provided folder in the DMZ.
+* Open a command line and navigate to this folder.
+* Start the service with the following commands:
++
+[source,command]
+----
+ $ http-server dist/grid-failure-information-map-app/ -P http://localhost:3003 -p 3001
+----
+{blank}
++
+CAUTION: Take care about this parameters: +
+*-P*: The proxy for requesting the SIT-Web-Cache-Service. +
+*-p*: TCP-Port of SIT-Web-FE
+
+* Open a browser and open the address to your SIT-Web-FE with the correct TCP-Port:
++
+[source,http]
+----
+ http://{SIT-Web-FE Adress}:3001
+----
+{blank}
++
+=> A map and a table with all grid failure appears in your browser.
+
+== How to use SIT-Web-FE
+
+To show all grid failure on a map or in a table inside your own web application you can run SIT-Web-FE beside your application.
+
+=== Prerequirements
+* To have an access to the failure information you have to had installed the cache service as well.
+
+=== Integrate the map/table component
+
+* Copy all files and the _assets_ folder from the build output (_/dist/grid-failure-information-web-comp_) to your own web application folder. ([lime]#*green boxes*# in the image below.)
+* Reference the *.js* and *.css* files in your web application ([yellow]#*yellow boxes*# in the image below).
+* Use the map/table like an html component with the following tags: +
+*<openk-grid-failure-information-map-comp></openk-grid-failure-information-map-comp>* +
+*<openk-grid-failure-information-table></openk-grid-failure-information-table>* +
+([red]#*red box*# in the image)
+
+.Neccessary files for map integration
+[options="header"]
+image::SIT_mapAppUsage.png[]
+
+=== Filter the shown grid failure information with postcode
+
+To Filter the shown information (table and/or map) you can set the postcode to the map/table component.
+
+The following example describes the usage in an example.
+
+.Neccessary files for map integration
+[options="header"]
+image::SIT_mapAppUsagexFilter.png[]
+
+The example has an text input box. Each change of this textbox will fire an event and within this event a javascript function is called with the entered value.
+Within this function we reference the map/table components and set the value to the *postcode* attributes.
+The filtering will be done immediatly.
+
+TIP: This attribute can also be bound to a data model in a javascript framework manner (e.g. angular).
diff --git a/src/main/asciidoc/img/SIT_mapAppUsage.png b/src/main/asciidoc/img/SIT_mapAppUsage.png
new file mode 100644
index 0000000..f1f8bf4
--- /dev/null
+++ b/src/main/asciidoc/img/SIT_mapAppUsage.png
Binary files differ
diff --git a/src/main/asciidoc/img/SIT_mapAppUsagexFilter.png b/src/main/asciidoc/img/SIT_mapAppUsagexFilter.png
new file mode 100644
index 0000000..d63932c
--- /dev/null
+++ b/src/main/asciidoc/img/SIT_mapAppUsagexFilter.png
Binary files differ
diff --git a/src/main/asciidoc/img/veroeffentlichung-Zuordnung.png b/src/main/asciidoc/img/veroeffentlichung-Zuordnung.png
new file mode 100644
index 0000000..bb75c8d
--- /dev/null
+++ b/src/main/asciidoc/img/veroeffentlichung-Zuordnung.png
Binary files differ
diff --git a/src/main/asciidoc/img/verteilergruppe-anlegen-2.png b/src/main/asciidoc/img/verteilergruppe-anlegen-2.png
index 26ae289..e69de29 100644
--- a/src/main/asciidoc/img/verteilergruppe-anlegen-2.png
+++ b/src/main/asciidoc/img/verteilergruppe-anlegen-2.png
Binary files differ
