Create DB Sync client apps

DB Sync client apps must be created from the DB Sync client app console and registered in the GIP system.

Tip:

In the context of GAS upgrade, these steps can be skipped, as long as the GIP configuration files and databases (.genero-sso) are kept.

To create apps that implement database synchronization:
  1. Open the demos.html starter page in a browser:
    http[s]://host:port/demos.html
    For example:
    http://toro:6394/demos.html

  2. Start the Console application program.

  3. Connect as GIP administrator user.

  4. Create a security role for the new DB Sync client app.
    • Security > Authorization
    • + Create
      • Enter a role name (for example: "Role.app_library")
      • Enter a description
      • Accept input with OK
  5. Open the dbsync.html starter page in a browser: 
    http[s]://host:port/ua/web/dbsync_setup_server_config/dbsync.html
    For example:
    http://toro:6394/ua/web/dbsync_setup_server_config/dbsync.html

  6. Start the Apps configuration program.

  7. Connect as dbsync_admin user.

  8. Create a new DB Sync client app with the New app option:
    • Enter the app name (for example: "app_library")
    • Enter a description
    • Validate input with Accept

  9. Assign SQL tables to the app with the Tables option.

  10. Register the app in the GIP with the Register option:

  11. Select the Authorization role (ex: "Role.app_library") for this app, Accept.

  12. A warning message is displayed to indicated that your app is now registered in the GIP system, OK.

  13. A new form opens to enter configuration file options for the DB Sync client app. This will produce a JSON record to fill the dbsync_source record that must be passed to the dbsync_app.register_dbsync_source(dbsync_source) function.
    • In dev/test mode, if you are not using HTTPS, make sure to use the http protocols instead of https for the DB Sync Protocol and the IdP issuer parameters.
    • Edit the IdP issuer parameter which holds by default the URL for the Genero IDP provider, with <host> and <port> placeholders which need to be specified.
    • Accept the input and close the form with OK.
  14. A new form displays, with the JSON record for the DB Sync client app configuration file.
    • Copy all or some parts of the JSON data to create/edit you DB Sync client app configuration file manually, or skip to the next step to download the JSON file.
    • Close the form with OK.
  15. A new dialog box offers you to download the DB Sync client app configuration file.
    • Select Yes to download the file or No to skip the download.

  16. If needed, you can re-edit the DB Sync client app configuration the with the Config toolbar option. However, for security reasons, the Client Secret is not saved into the DB Sync system table for apps: The Client Secret is only available in memory just after registering the app into GIP. If you close the DB Sync client app console and reopen it, and the JSON record was not saved into a file, the Client Secret is lost. In such case, unregister and register again the app to get a new Client ID and Client Secret.