Ascii Documentation in Product, Offer and Contract

entity/Offer_entity/Offer_entity.aod

@@ -3,6 +3,7 @@
   <name>Offer_entity</name>
   <title>Offer</title>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/entity/Offer_entity/documentation.adoc</documentation>
   <grantUpdateProcess>%aditoprj%/entity/Offer_entity/grantUpdateProcess.js</grantUpdateProcess>
   <grantDeleteProcess>%aditoprj%/entity/Offer_entity/grantDeleteProcess.js</grantDeleteProcess>
   <recordContainerType>DB</recordContainerType>
@@ -37,6 +38,7 @@
     </entityField>
     <entityField>
       <name>OFFERCODE</name>
+      <documentation>%aditoprj%/entity/Offer_entity/entityfields/offercode/documentation.adoc</documentation>
       <title>Offer number</title>
       <tableName>OFFER</tableName>
       <columnName>OFFERCODE</columnName>
@@ -69,6 +71,7 @@
     </entityField>
     <entityField>
       <name>RELATION_ID</name>
+      <documentation>%aditoprj%/entity/Offer_entity/entityfields/relation_id/documentation.adoc</documentation>
       <title>Contact / Company</title>
       <tableName>OFFER</tableName>
       <columnName>RELATION_ID</columnName>
@@ -182,6 +185,7 @@
     </entityField>
     <entityField>
       <name>TotalGross</name>
+      <documentation>%aditoprj%/entity/Offer_entity/entityfields/totalgross/documentation.adoc</documentation>
       <title>Total gross</title>
       <state>READONLY</state>
       <valueProcess>%aditoprj%/entity/Offer_entity/entityfields/totalgross/valueProcess.js</valueProcess>
@@ -222,6 +226,7 @@
     </entityActionField>
     <entityField>
       <name>VERSNR</name>
+      <documentation>%aditoprj%/entity/Offer_entity/entityfields/versnr/documentation.adoc</documentation>
       <title>Vers. no.</title>
       <tableName>OFFER</tableName>
       <columnName>VERSNR</columnName>
@@ -230,6 +235,7 @@
     </entityField>
     <entityField>
       <name>OFFER_ID</name>
+      <documentation>%aditoprj%/entity/Offer_entity/entityfields/offer_id/documentation.adoc</documentation>
     </entityField>
     <entityFieldGroup>
       <name>OfferCode_VersNr</name>

entity/Offer_entity/documentation.adoc

+= OFFER
+
+:hardbreaks:
+
+Entity contains meta data of the Offer module.
+It provides data from database table _OFFER_.
+
+== Actions
+
+* _Copy offer_: All values, offeritems included, are copyed and inserted in a new offer (new offer code, versnr. _1_).
+* _New offer version_: All values, offeritems included, are copyed and inserted in a **new offer version** (versnr. + _1_).
+
+== Submodules
+
+* Offeritem
\ No newline at end of file

entity/Offer_entity/entityfields/offer_id/documentation.adoc

+= OFFER_ID
+:hardbreaks:
+
+This field contains link information to previous offer version.
\ No newline at end of file

entity/Offer_entity/entityfields/offercode/documentation.adoc

+= OFFERCODE
+:hardbreaks:
+
+Unique identification number of the offer.
+It's automatically generated from the starting number _1000_.
\ No newline at end of file

entity/Offer_entity/entityfields/relation_id/documentation.adoc

+= RELATION_ID
+:hardbreaks:
+
+Over this field the company or contact person of customer is linked.
+
+== onValueChange
+
+If set in the selected company or contact person, the following field value are taken over:
+
+* LANGUAGE
\ No newline at end of file

entity/Offer_entity/entityfields/totalgross/documentation.adoc

+= TotalGross
+:hardbreaks:
+
+Contains the total gross of the offer (net).
+This is calculated as follows: _NET_ + _VAT_.
+Both are calculated in *_Offeritem_entity_* at _onDBInsert_, _onDBUpdate_ and _onDBDelete_.
\ No newline at end of file

entity/Offer_entity/entityfields/versnr/documentation.adoc

+= VERSNR
+:hardbreaks:
+
+Additional to the offercode there's a version number.
+By default it contains the value _1_.
+
+A new offer version can be created over the action _newOfferVersion_.
+Then the new value is the old one incremented by _1_.
\ No newline at end of file

entity/Offeritem_entity/Offeritem_entity.aod

@@ -3,6 +3,7 @@
   <name>Offeritem_entity</name>
   <title>Offeritem</title>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/entity/Offeritem_entity/documentation.adoc</documentation>
   <grantCreateProcess>%aditoprj%/entity/Offeritem_entity/grantCreateProcess.js</grantCreateProcess>
   <grantUpdateProcess>%aditoprj%/entity/Offeritem_entity/grantUpdateProcess.js</grantUpdateProcess>
   <grantDeleteProcess>%aditoprj%/entity/Offeritem_entity/grantDeleteProcess.js</grantDeleteProcess>
@@ -117,15 +118,16 @@
     </entityField>
     <entityField>
       <name>PRODUCT_ID</name>
+      <documentation>%aditoprj%/entity/Offeritem_entity/entityfields/product_id/documentation.adoc</documentation>
       <title>Article</title>
       <tableName>OFFERITEM</tableName>
       <columnName>PRODUCT_ID</columnName>
       <possibleItemsProcess>%aditoprj%/entity/Offeritem_entity/entityfields/product_id/possibleItemsProcess.js</possibleItemsProcess>
-      <onValidation>%aditoprj%/entity/Offeritem_entity/entityfields/product_id/onValidation.js</onValidation>
       <onValueChange>%aditoprj%/entity/Offeritem_entity/entityfields/product_id/onValueChange.js</onValueChange>
     </entityField>
     <entityField>
       <name>QUANTITY</name>
+      <documentation>%aditoprj%/entity/Offeritem_entity/entityfields/quantity/documentation.adoc</documentation>
       <title>Quantity</title>
       <tableName>OFFERITEM</tableName>
       <columnName>QUANTITY</columnName>
@@ -180,6 +182,7 @@
     </entityParameter>
     <entityField>
       <name>TotalPrice</name>
+      <documentation>%aditoprj%/entity/Offeritem_entity/entityfields/totalprice/documentation.adoc</documentation>
       <title>Sum</title>
       <contentType>NUMBER</contentType>
       <outputFormat>#,##0.00</outputFormat>

entity/Offeritem_entity/documentation.adoc

+= OFFERITEM
+:hardbreaks:
+
+Entity contains products that belong to the linked offer.
+It provides data from database table _OFFERITEM_ by a JDito record container.
+
+== onDBInsert
+
+If a new offer item is to be added, the parts list of the corresponding product 
+is inserted at the same time. A new item is created for each product.
+The net sum in the linked offer is updated.
+
+== onDBUpdate
+
+The net sum in the linked offer is updated.
+
+
+== onDBDelete
+
+Before deletion of an item, its subordinated items are also deleted.
+The net sum in the linked offer is updated.
\ No newline at end of file

entity/Offeritem_entity/entityfields/product_id/documentation.adoc

+= PRODUCT_ID
+:hardbreaks:
+
+Contains link to selected product for this item.
+
+== onValueChange
+
+The following field are set with the values from the selected product:
+
+* GROUPCODEID
+* UNIT
+* ITEMNAME
+* PRICE & VAT: Values from the current valid price list defined to this product. 
+  For futher informations see the comments in method __getPriceListToUse_ in _Product_lib_.
\ No newline at end of file

entity/Offeritem_entity/entityfields/quantity/documentation.adoc

+= QUANTITY
+:hardbreaks:
+
+Quantity of selected product in this item.
+
+== onValueChange
+
+The fields PRICE & VAT are set by changing quantity when a product has already been selected.
+The reason for this is that you can define a quantity as of which price lists are valid.
\ No newline at end of file

entity/Offeritem_entity/entityfields/totalprice/documentation.adoc

+= TotalPrice
+:hardbreaks:
+
+Contains the total price of the item.
+This is calculated as follows: _QUANTITY_ * _PRICE_ * (100 - _DISCOUNT_) / 100
\ No newline at end of file

entity/Prod2prod_entity/Prod2prod_entity.aod

@@ -2,6 +2,7 @@
 <entity xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.0.5" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/entity/1.0.5">
   <name>Prod2prod_entity</name>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/entity/Prod2prod_entity/documentation.adoc</documentation>
   <externalOpenAction>%aditoprj%/entity/Prod2prod_entity/externalOpenAction.js</externalOpenAction>
   <recordContainerType>JDITO</recordContainerType>
   <alias>Data_alias</alias>
@@ -49,6 +50,7 @@
     </entityField>
     <entityField>
       <name>DEST_ID</name>
+      <documentation>%aditoprj%/entity/Prod2prod_entity/entityfields/dest_id/documentation.adoc</documentation>
       <tableName></tableName>
       <columnName></columnName>
       <fieldName>DEST_ID</fieldName>
@@ -81,6 +83,7 @@
     </entityField>
     <entityField>
       <name>SOURCE_ID</name>
+      <documentation>%aditoprj%/entity/Prod2prod_entity/entityfields/source_id/documentation.adoc</documentation>
       <title>Product</title>
       <tableName></tableName>
       <columnName></columnName>
@@ -90,6 +93,7 @@
     </entityField>
     <entityField>
       <name>TAKEPRICE</name>
+      <documentation>%aditoprj%/entity/Prod2prod_entity/entityfields/takeprice/documentation.adoc</documentation>
       <title>Price</title>
       <tableName></tableName>
       <columnName></columnName>

entity/Prod2prod_entity/entityfields/dest_id/documentation.adoc

+= DEST_ID
+:hardbreaks:
+
+This column contains link information (foreign key) to the product to which it is a part of (parent).
+
+== Preset New
+The system defaults to the passed value of the parameter _ProductId_param_.
\ No newline at end of file

entity/Prod2prod_entity/entityfields/optional/documentation.adoc

+= OPTIONAL
+:hardbreaks:
+
+Flag for offer / order. The value is taken over in offer / order.
\ No newline at end of file

entity/Prod2prod_entity/entityfields/source_id/documentation.adoc

+= SOURCE_ID
+:hardbreaks:
+
+This column contains link information (foreign key) to the partial product. (child)
+ 
+== value list
+Listed are all products which are **not already part of** parts list.
+This means each product recursively appears in _DEST_ID_ or _SOURCE_ID_ of the current product passed by parameter _ProductId_param_ **is excluded**.
\ No newline at end of file

entity/Prod2prod_entity/entityfields/takeprice/documentation.adoc

+= TAKEPRICE
+:hardbreaks:
+
+Flag for offer / order. If set the current valid price list to this product is taken over in offer / order.
\ No newline at end of file

entity/Product_entity/Product_entity.aod

@@ -3,6 +3,7 @@
   <name>Product_entity</name>
   <title>Product</title>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/entity/Product_entity/documentation.adoc</documentation>
   <recordContainerType>DB</recordContainerType>
   <iconId>VAADIN:HAMMER</iconId>
   <alias>Data_alias</alias>
@@ -60,6 +61,7 @@
     </entityField>
     <entityField>
       <name>PRODUCTCODE</name>
+      <documentation>%aditoprj%/entity/Product_entity/entityfields/productcode/documentation.adoc</documentation>
       <title>Product number</title>
       <tableName>PRODUCT</tableName>
       <columnName>PRODUCTCODE</columnName>