diff --git a/symmetric/src/docbook/user-guide/ch05-basic-configuration.xml b/symmetric/src/docbook/user-guide/ch05-basic-configuration.xml
index 8668013539..6234c8f9ad 100644
--- a/symmetric/src/docbook/user-guide/ch05-basic-configuration.xml
+++ b/symmetric/src/docbook/user-guide/ch05-basic-configuration.xml
@@ -4,6 +4,34 @@
xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns="http://docbook.org/ns/docbook"
xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:html="http://www.w3.org/1999/xhtml">
Basic Configuration
+
+ To get an instance of SymmetricDS running, it needs to be given an identity and know how
+ to connect to the database it will manage. A basic way to specify this is to place properties
+ in the symmetric.properties file. After connecting to the database, the Node reads its
+ configuration and current status. If the configuration tables are missing, they are created
+ automatically, unless that feature is disabled. A basic configuration describes the
+ following:
+
+
+ Node Groups - each Node belongs to a group
+
+
+ Node Group Links - two Nodes Groups are linked together for synchronization
+
+
+ Nodes - each instance of Symmetric has an identity
+
+
+ Channels - data is categorized to synchronize independently
+
+
+ Triggers - specify which changes in the database are captured
+
+
+ During initialization, the Triggers are verified against the database, and database triggers
+ are installed on tables that require data changes to be captured. The PullJob and PushJob
+ begin running as required to synchronize changes with other Nodes.
+
Setting Startup Properties
@@ -26,12 +54,12 @@
- default-symmetric.properties
+ symmetric-default.properties
Y
Packaged inside symmetric-ds.jar file. This file has all the default
- settings and along with descriptions.
+ settings along with descriptions.
@@ -93,13 +121,16 @@
+
+ Also see the appendix on Startup Properties to see all the possible
+ properties and their defaults.
Basic Properties
- Each Node requires properties that will register it with the network and connect it to
- the database. To give a Node its identity, the following properties are used:
+ Each Node requires properties that will connect it to the database and register
+ it with a parent Node. To give a Node its identity, the following properties are used:
@@ -217,8 +248,64 @@
+
+ Node Groups
+
+ Each Node must belong to a Node Group, a collection of one or more Nodes.
+ A common use of Node Groups is to describe a level in a hierarchy of data synchronization.
+ For example, at a retail store chain, there might be a few Nodes that belong to "corp", which
+ sync with hundreds of Nodes that belong to "store", which sync with thousands of Nodes that
+ belong to "register".
+
+
+ The following SQL statements would create Node Groups for "corp" and "store".
+
+
+
+
+
+
+ Node Group Links
+
+ To establish synchronization between Nodes, two Node Groups are linked together. The direction
+ of synchronization is determined by specifying a source and target Node Group.
+ If synchronization should occur in both directions, then two links can be created in opposite
+ directions. The target Node Group can receive data changes by either push or pull methods.
+ A push method causes the source Node Group to connect to the target, while a pull method
+ causes it to wait for the target to connect to it.
+
+
+ The following SQL statements links the "corp" and "store" Node Groups for synchronization.
+ It configures the "store" Nodes to push their data changes to the "corp" Nodes,
+ and the "corp" Nodes to send changes to "store" Nodes by waiting for a pull.
+
+
+
+
+
+
+