Merge pull request #28 from openwms/20_Consider_UOMRelation_and_Label

README.md

@@ -1,7 +1,7 @@
 # Purpose
-This service is responsible to handle incoming orders, so called receiving orders, aka expected receipts or receiving notices. Before a
-pallet or box enters a warehouse it must be announced beforehand. The box must be registered in the system with an identifier, and some
-other characteristics that may differ between projects.
+The purpose of the Receiving service is to handle goods receipts. It offers an API to create incoming orders, so called Receiving Orders
+(expected receipts). These kind of receipts are announced before goods are received. In contrast, blind receipts are also supported. Those
+don't require any announcements and allow to capture goods that are not expected to receive. 
 
 # Resources
 [![Build status](https://github.com/openwms/org.openwms.wms.receiving/actions/workflows/master-build.yml/badge.svg)](https://github.com/openwms/org.openwms.wms.receiving/actions/workflows/master-build.yml)
@@ -14,7 +14,7 @@ other characteristics that may differ between projects.
 **Find further Documentation on [Microservice Website](https://openwms.github.io/org.openwms.wms.receiving)**
 
 # Build
-The service can be built and run locally without any other services.
+The service can be built and started locally without any other services.
 
 Build the code: 
 ```

src/main/resources/bootstrap.yml

@@ -164,27 +164,6 @@ spring:
         hbm2ddl:
           import_files: import-DEMO.sql
 
----
-spring:
-  config:
-    activate:
-      on-profile: HEROKU
-  main:
-    banner-mode: "OFF"
-
-owms:
-  srv:
-    protocol: https
-    hostname: openwms-wms-receiving.herokuapp.com
-
-eureka:
-  instance:
-    secure-port-enabled: true
-    non-secure-port-enabled: false
-    statusPageUrl: ${owms.srv.protocol}://${owms.srv.hostname}:${server.port}/actuator/info
-    healthCheckUrl: ${owms.srv.protocol}://${owms.srv.hostname}:${server.port}/actuator/health
-    homePageUrl: ${owms.srv.protocol}://${owms.srv.hostname}:${server.port}/actuator/
-
 ---
 spring:
   config:

src/site/markdown/configuration.md

@@ -0,0 +1,26 @@
+## Configuration
+OpenWMS.org defines additional configuration parameters beside the standard Spring Framework ones. All custom parameters are children of the
+`owms` property namespace.
+
+|Parameter|Type|Default profile value|Description|
+|---------|----|-----------|
+|owms.eureka.url|string|http://user:sa@localhost:8761|The base URL of the running Eureka service discovery server, inclusive schema and port|
+|owms.eureka.zone|string|http://user:sa@localhost:8761/eureka/|The full Eureka registration endpoint URL|
+|owms.service.protocol|string|http|The protocol the service' is accessible from Eureka clients|  
+|owms.service.hostname|string|localhost|The hostname the service' is accessible from Eureka clients|
+|owms.dead-letter.exchange-name|string|dle.common|Exchange for the poison message forwarding|
+|owms.dead-letter.queue-name|string|common-dle-common|Queue for poison messages bound to the dead-letter exchange|
+|owms.commands.common.tu.exchange-name|string|common.tu.commands|Exchange to send out TU requests|
+|owms.commands.inventory.pu.exchange-name|string|inventory.commands|Exchange to send out PU requests|
+|owms.commands.inventory.pu.routing-key|string|pu.command.create|Routing key for commands to create PU|
+|owms.events.receiving.exchange-name|string|receiving|Exchange to send out events on ReceivingOrders|
+|owms.events.inventory.exchange-name|string|inventory|Exchange to listen on Inventory events|
+|owms.events.inventory.products.queue-name|string|receiving-products-queue|Queue to receive Product events|
+|owms.events.inventory.products.routing-key|string|product.event.#|Routing key to listen on Product events|
+|owms.events.common.tu.exchange-name|string|common.tu|Exchange to listen on Common events|
+|owms.events.common.tu.routing-key|string|tu.event.#|Routing key to listen on TransportUnit events|
+|owms.events.common.tu.queue-name|string|receiving-tu-queue|Queue to receive TransportUnit events|
+|owms.receiving.serialization|string|json|The AMQP message exchange format, either `json` or `binary`|
+|owms.receiving.create-tu-on-expected-tu-receipt|boolean|true|A TransportUnit with the expected BK is created when captured|
+|owms.receiving.initial-location-id|string|EXTERN|The ERP code of the Location where the expected TransportUnit is created on|
+|owms.receiving.blind-receipts.allowed|boolean|true|Whether blind receipts are allowed|

src/site/markdown/index.md

@@ -1,6 +1,7 @@
-The Receiving service is responsible to handle incoming orders, so called receiving orders, aka expected receipts or receiving notices.
-Before a pallet or box enters a warehouse it must be announced beforehand. The box must be registered in the system with an identifier, and
-some other characteristics that may differ between projects.
+# Purpose
+The purpose of the Receiving service is to handle goods receipts. It offers an API to create incoming orders, so called Receiving Orders
+(expected receipts). These kind of receipts are announced before goods are received. In contrast, blind receipts are also supported. Those
+don't require any announcements and allow to capture goods that are not expected to receive.
 
 # Resources
 [![Build status](https://github.com/openwms/org.openwms.wms.receiving/actions/workflows/master-build.yml/badge.svg)](https://github.com/openwms/org.openwms.wms.receiving/actions/workflows/master-build.yml)

src/site/site.xml

@@ -32,7 +32,8 @@
         <menu name="Documentation">
             <item name="Home" href="index.html" />
             <item name="REST API Documentation" href="rest/${project.version}/api.html" />
-            <item name="Confluence Wiki" href="https://openwms.atlassian.net/l/c/d11p3GgQ" />
+            <item name="Wiki" href="https://wiki.butan092.startdedicated.de/projects/wms-receiving-service/wiki" />
+            <item name="Configuration" href="configuration.html" />
             <item name="Database Schema" href="${project.version}/schemaspy/relationships.html" />
             <item name="Sonarcloud" href="https://sonarcloud.io/dashboard?id=org.openwms:org.openwms.wms.receiving" />
         </menu>