Skip to content

Commit

Permalink
Make the need for trigger routers more obvious
Browse files Browse the repository at this point in the history
  • Loading branch information
mhanes committed Feb 7, 2013
1 parent 6816215 commit cb380e1
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 15 deletions.
19 changes: 13 additions & 6 deletions symmetric-assemble/src/docbook/configuration.xml
Expand Up @@ -435,7 +435,11 @@ values
</section>

<section id="configuration-triggers-and-routers">
<title>Triggers and Routers</title>
<title>Triggers, Routers, and Trigger / Routers Mappings</title>

<para>In order to synchronize data, you must define at least one trigger, at least one router,
and provide at least one link between the two (known as a trigger-router).
</para>

<section id="configuration-trigger">
<title>Trigger</title>
Expand Down Expand Up @@ -1057,9 +1061,12 @@ values
<section id="configuration-trigger-router">
<title>Trigger / Router Mappings</title>

<para>Trigger Routers, and the corresponding <xref
linkend="table_trigger_router" xrefstyle="table"/> identify which triggers apply to which routers. </para>

<para>The <xref
linkend="table_trigger_router" xrefstyle="table"/> table is used to define
which specific combinations of triggers and routers are needed for your configuration. The relationship between
triggers and routers is many-to-many, so this table serves as the join table to define which combinations are valid, as well
as to define settings available at the trigger-router level of granularity.
</para>
<para>Three important controls can be configured for a specific Trigger /
Router combination: Enabled, Initial Loads and Ping Back. The parameters for these
can be found in the Trigger / Router mapping table,<xref
Expand All @@ -1071,8 +1078,8 @@ values
<para>
Each individual trigger-router combination can be disabled or enabled if needed. By default, a trigger router is enabled,
but if you have a reason you wish to define a trigger router combination prior to it being active, you can set
the <literal>enabled</literal> flag to 0. This will cause the configuration to be sent to all nodes, but the trigger-router
combination will not be considered active or enabled for the purposes of routing.
the <literal>enabled</literal> flag to 0. This will cause the trigger-router mapping to be sent to all nodes, but the trigger-router
mapping will not be considered active or enabled for the purposes of capturing data changes or routing.
</para>
</section>
<section id="configuration-initial-load">
Expand Down
19 changes: 10 additions & 9 deletions symmetric-assemble/src/docbook/planning.xml
Expand Up @@ -219,9 +219,9 @@
remaining task prior to starting your implementation is to define and document what data changes are to be
captured (by defining SymmetricDS
<emphasis>Triggers</emphasis>
), and to decide to which node(s) the data changes are to be
), to decide to which node(s) the data changes are to be
<emphasis>routed</emphasis>
to and under what conditions. We will also, in this section, discuss the concept of an
to, and to decide which trigger applies to which router and under what conditions. We will also, in this section, discuss the concept of an
<emphasis>initial load</emphasis>
of data into a SymmetricDS node.
</para>
Expand Down Expand Up @@ -316,17 +316,18 @@
</listitem>
</itemizedlist>
</para>
<para> For each of your Triggers, decide which Router matches the behavior needed for that Trigger. These Trigger
Router combinations will be used to define a mapping between your Triggers and Routers when you implement
your design.
</para>

</section>
<section id="defining-data-changes-trigger-routers">
<title>Mapping Triggers to Routers</title>
<para>
The mapping between Triggers and Routers, found in the table

<para> For each of your Triggers (which specify when a data change should be captured),
you will need to decide which Router(s) to pair with the Trigger such that the change is routed
to the desired target nodes. This needed mapping between Triggers and Routers, found in the table
<xref linkend="table_trigger_router" xrefstyle="table" />
, defines configuration specific to a particular Trigger and Router combination.
, defines configuration specific to a particular Trigger and Router combination that you need.
In addition to defining which triggers map to which routers, the table also has several
settings present to define various behaviors, including initial loads and ping back.
</para>
<section id="defining-data-changes-trigger-routers-initial-load">
<title>Planning Initial Loads</title>
Expand Down

0 comments on commit cb380e1

Please sign in to comment.