Skip to content

Commit

Permalink
0003137: Updates to SymmetricDS tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
klementinastojanovska committed Jun 2, 2017
1 parent 3bbb958 commit d81aa82
Show file tree
Hide file tree
Showing 9 changed files with 134 additions and 19 deletions.
1 change: 1 addition & 0 deletions .gitignore
@@ -1 +1,2 @@
/.DS_Store
/.project
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions symmetric-assemble/src/asciidoc/installation.ad
Expand Up @@ -127,6 +127,8 @@ Select the _Run server after installing_ checkbox to also run SymmetricDS after

After selecting options, click *Next*.

NOTE: We do not currently support the automatic run on Mac Operating Systems.

--

[.float-group]
Expand Down
19 changes: 13 additions & 6 deletions symmetric-assemble/src/asciidoc/tutorials/demo.ad
Expand Up @@ -111,12 +111,18 @@ Please verify the databases by navigating to the Explore tab and using the datab
endif::pro[]

ifndef::pro[]
Please verify the databases by logging in and listing the tables. You can
Please verify the databases by logging in and listing the tables. You can verify using the following command:

[source, cli]
----
bin/dbsql --engine corp-000
----

From here, you can:
endif::pro[]

* Find the item tables that sync from root to client (that is, from corp to store): item and item_selling_price.
* Find the sales tables that sync from store to corp: sale_transaction and sale_return_line_item.
* Find the SymmetricDS system tables, which have a prefix of "sym_", such as sym_channel, sym_trigger, sym_router, and sym_trigger_router.
* Validate the corp item tables have sample data.

=== Pulling Data
Expand Down Expand Up @@ -155,7 +161,7 @@ endif::pro[]

ifdef::pro[]
.Verify the outgoing batches were created and sent (status of `OK`).
image::tutorials/demo-pull-verify-batch.png[]
image::tutorials/demo-pull-verify-outgoing-batch.png[]
endif::pro[]

ifndef::pro[]
Expand All @@ -172,7 +178,8 @@ endif::pro[]

ifdef::pro[]
.Verify the incoming batches were received (status of `OK`).
image::tutorials/demo-pull-verify-batch.png[]
image::tutorials/demo-pull-verify-incoming-batch.png[]

endif::pro[]

ifndef::pro[]
Expand Down Expand Up @@ -238,7 +245,7 @@ endif::pro[]

ifdef::pro[]
.Verify the outgoing batches were created and sent (status of `OK`).
image::tutorials/demo-push-verify-batch.png[]
image::tutorials/demo-push-verify-outgoing-batch.png[]
endif::pro[]

ifndef::pro[]
Expand All @@ -254,7 +261,7 @@ endif::pro[]
==== Verify Incoming Batches
ifdef::pro[]
.Verify the incoming batches were received (status of `OK`).
image::tutorials/demo-push-verify-batch.png[]
image::tutorials/demo-push-verify-incoming-batch.png[]
endif::pro[]

ifndef::pro[]
Expand Down
128 changes: 117 additions & 11 deletions symmetric-assemble/src/asciidoc/tutorials/quick-start.ad
Expand Up @@ -25,13 +25,15 @@ endif::pro[]
=== Install
ifndef::pro[]
Download and install SymmetricDS from the http://www.symmetricds.org/download[SymmetricDS.org] website.

TIP: For complete installation instructions click link:user-guide.html#_installation[here,window="_tutorials"]
endif::pro[]

ifdef::pro[]
Download and install SymmetricDS from the http://www.jumpmind.com/products/symmetricds/download[JumpMind] website.
endif::pro[]

TIP: For complete installation instructions click link:user-guide.html#_installation[here,window="_tutorials"]
TIP: For complete installation instructions click link:../user-guide.html#_installation[here,window="_tutorials"]
endif::pro[]



Expand All @@ -52,18 +54,121 @@ endif::pro[]
ifndef::pro[]
Create a property file named `xxxxx.properties` in the engines folder of your SymmetricDS installation. Replace the `xxxxx` with a name for your node (homeoffice, central, server, etc).

TIP: A sample database is needed for each corresponding node that is created.

.Properties
. engine.name={an arbitrary name for the node}
. group.id={this must match the name of a group inserted in step 3, ex: corp}
. external.id={id for the node, ex: 000 }
. sync.url=http://{hostname}:{port}/{webcontext}/sync/{engine.name}

Example: engine.name=centralNode

. group.id={this must match the name of a group inserted in step 3}

Example: group.id=corp

. external.id={id for the node}

Example: external.id=000

. sync.url=http://{hostname}:{port}/sync/{engine.name}

Example: sync.url=http://localhost:31415/sync/centralNode

. registration.url={leave this blank for the source node}
. db.driver={JDBC driver class}
. db.driver={JDBC driver class}

[cols="2*", options="header"]
|===
|Database
|Example Driver Classes

|h2
|org.h2.Driver

|mySQL
|com.mysql.jdbc.Driver

|Oracle
|oracle.jdbc.driver.OracleDriver

|PostgreSQL
|org.postgresql.Driver

|Apache
|org.apache.derby.jdbc.EmbeddedDriver

|HyperSQL
|org.hsqldb.jdbcDriver

|SourceForge
|net.sourceforge.jtds.jdbc.Driver

|IBM
|com.ibm.db2.jcc.DB2Driver

|SQLite
|org.sqlite.JDBC

|Firebird
|org.firebirdsql.jdbc.FBDriver

|Sybase
|com.sybase.jdbc4.jdbc.SybDriver
|===

[start=7]
. db.url={JDBC url for your source database}

[cols="2*", options="header"]
|===
|Database
|Example JDBC Urls

|h2
|jdbc:h2:file:target/h2/client

|mySQL
|jdbc:mysql://localhost/sampleroot?tinyInt1isBit=false&zeroDateTimeBehavior=convertToNull

|Oracle
|jdbc:oracle:thin:@127.0.0.1:1521:sampleroot

|PostgreSQL
|jdbc:postgresql://localhost/sampleroot

|Apache
|jdbc:derby:sampleroot;create=true

|HyperSQL
|jdbc:hsqldb:file:sampleroot;shutdown=true

|SourceForge
|jdbc:jtds:sqlserver://localhost:1433;sendStringParametersAsUnicode=false;
useCursors=true;bufferMaxMemory=10240;lobBuffer=5242880

|IBM
|jdbc:db2://localhost/samproot

|SQLite
|jdbc:sqlite:target/sqlite/client

|Firebird
|jdbc:firebirdsql://host[:port]/client

|Sybase
|jdbc:sybase:Tds:localhost:5000/client
|===

[start=8]
. db.user={JDBC username}

Example: db.user=root

. db.password={JDBC password}

TIP: For complete instructions creating the master node click link:/user-guide.html#_node_properties_file[here,window="_tutorials"]
Example: db.password=xxxxxx

TIP: For complete instructions creating the master node click link:user-guide.html#_master_node_setup[here,window="_tutorials"]

endif::pro[]

ifdef::pro[]
Expand All @@ -76,7 +181,8 @@ image::wizard-node-setup.png[]
. Provide a password for the web console, hit next
. Finish

TIP: For complete instructions creating the master node click link:/user-guide.html#_master_node_setup[here,window="_tutorials"]
TIP: For complete instructions creating the master node click link:../user-guide.html#_master_node_setup[here,window="_tutorials"]

endif::pro[]

ifndef::pro[]
Expand Down Expand Up @@ -162,7 +268,7 @@ image::wizard-config/wizard-config-client-server.png[]
. Select tables you wish to sync from server to client, hit next
. Verify the summary, hit finish

TIP: For complete instructions for the quick config wizard click link:/user-guide.html#_quick_config_wizard[here,window="_tutorials"]
TIP: For complete instructions for the quick config wizard click link:../user-guide.html#_quick_config_wizard[here,window="_tutorials"]
endif::pro[]


Expand All @@ -182,7 +288,7 @@ Create a property file named `xxxxx.properties` in the engines folder of your Sy
. db.user={JDBC username}
. db.password={JDBC password}

TIP: For complete instructions creating the target node click link:/user-guide.html#_node_properties_file[here,window="_tutorials"]
TIP: For complete instructions creating the target node click link:user-guide.html#_node_properties_file[here,window="_tutorials"]
endif::pro[]

ifdef::pro[]
Expand All @@ -199,7 +305,7 @@ image::wizard-connect/wizard-connect-menu.png[]
. Choose appropriate options here depending if your target tables already exist and if they should be initially loaded with data from the source. Hit next
. Hit finish

TIP: For complete instructions to setup the target database click link:/user-guide.html#_add_node[here,window="_tutorials"]
TIP: For complete instructions to setup the target database click link:../user-guide.html#_add_node[here,window="_tutorials"]

endif::pro[]

Expand Down
3 changes: 1 addition & 2 deletions symmetric-assemble/src/asciidoc/tutorials/tutorials.ad
Expand Up @@ -25,7 +25,6 @@ _Permission to use, copy, modify, and distribute this SymmetricDS Tutorials Guid
for any purpose and without fee is hereby granted in perpetuity, provided that
the above copyright notice and this paragraph appear in all copies._

include::demo.ad[]

include::quick-start.ad[]

include::demo.ad[]

0 comments on commit d81aa82

Please sign in to comment.