svn commit: r1830972 - in /ofbiz/ofbiz-framework/trunk/framework/entityext/src/doc: ./ asciidoc/ asciidoc/EntitySync-manual.adoc

Author: jleroux
Date: Sat May  5 13:13:58 2018
New Revision: 1830972

URL: http://svn.apache.org/viewvc?rev=1830972&view=rev
Log:
Documented: New documentation for EntitySync
(OFBIZ-10390)

The current EntitySync documentation in wiki is POS oriented so somehow
deprecated.
I have recently worked on a project with EntitySync and collected as much
possible information.
I also got David E. Jones's agreement to reuse the part on EntitySync in his
2006 "Apache OFBiz Advanced Framework - Training Video Transcription" document.

So this is a new replacing asciidoc document, it's a WIP...

Thanks: David for agreement on reusing his doc.

Added:
    ofbiz/ofbiz-framework/trunk/framework/entityext/src/doc/
    ofbiz/ofbiz-framework/trunk/framework/entityext/src/doc/asciidoc/
    ofbiz/ofbiz-framework/trunk/framework/entityext/src/doc/asciidoc/EntitySync-manual.adoc

Added: ofbiz/ofbiz-framework/trunk/framework/entityext/src/doc/asciidoc/EntitySync-manual.adoc
URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/framework/entityext/src/doc/asciidoc/EntitySync-manual.adoc?rev=1830972&view=auto
==============================================================================
--- ofbiz/ofbiz-framework/trunk/framework/entityext/src/doc/asciidoc/EntitySync-manual.adoc (added)
+++ ofbiz/ofbiz-framework/trunk/framework/entityext/src/doc/asciidoc/EntitySync-manual.adoc Sat May  5 13:13:58 2018
@@ -0,0 +1,39 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+
+= What is Entity Synchronization (EntitySync) and how to use it?
+
+== Introduction to Entity Synchronization
+
+The general idea behind the Entity Sync stuff is to re-create transactions from a central database into one or
+more other databases, each represented by a set of record in the EntitySync and related entities.
+
+Though the Entity Sync mechanism can be used without the now deprecated POS, it was mostly destined to it.
+It works well on a reliable network (LAN), it's a bit harder on Internet (WAN) but nothing impossible...
+
+The four fields (lastUpdatedStamp, lastUpdatedTxStamp, createdStamp, createdTxStamp) are added to each entity and
+automatically populated so that queries can be done on each entity to get all records created, updated,
+or removed in a certain transaction, and so that in time order those transactions can be reproduced remotely
+to get the data into the remote database in the proper order.
+
+The no-auto-stamp attribute is used to tell the Entity Engine not to automatically add these stamp fields,
+and not to automatically set the stamps when creating and updating the entities. It's false by default.
+So by default these values will be automatically set, and when records are removed the primary key will be saved
+in the EntitySyncRemove entity's table so that the record can be removed in the remote database.
+