Set up DB Sync for server-side apps

Server-side apps and users must be registered in the DB Sync system.

Server-side applications connect directly to the central database to modifying SQL tables shared with DB Sync client apps.

Changes done by server-side apps must be registered in the DB Sync central change log, by using the DB Sync API for server-side apps provided by the dbsync_srvapp module.

When starting, a server-side app must identify itself with its app id, and indicate which user is running the application with the register_central_app_params() function.

Follow the steps below to define DB Sync server-side apps and the DB Sync users that will use these apps:

  1. Set up the environment:

    • Go to the DB Sync installation directory and run the DB client envdbsync script (envdbsync.bat on Windows)

  2. Make sure the GDC front-end is started, to display configuration and DB Sync client app forms.

  3. Start the dbsync_app_conf program to define your DB Sync server-side apps:
    dbsync_app_conf -c $DBSYNCDIR/conf/myconfig_library.json
    The main task here is to define the app name, description, and associate the SQL tables used by the app.

    Do not register the server-side app in the GAS/SSO/GIP: Server-side apps do not require a Client ID / Secret ID like remote DB Sync client apps.

    For more details, see Apps definition console.

  4. Create the DB Sync users with the dbsync_user_conf console, with the -x argument to be able to create/delete users:
    dbsync_user_conf -x -c $DBSYNCDIR/conf/myconfig_library.json

    After creating the user, you must associate the server-side apps to the user.

    For more details on user definitions, see Users definition console.