Client configuration file

A DB Sync client configuration file is used by DB Sync client apps.

A DB Sync client configuration file contains protocols and URL definitions for user authentication and DB Sync Web Service source.

The DB Sync client app configuration file must be bundled with the client app program files. When using GMA, GMI or GWA, consider shipping the config file with .42m, .42f app program files.

A template for DB Sync client app configuration files is provided in $DBSYNCDIR/etc/app_dbsync_source.json.

The client-side configuration file can be edited with the [dbsync_setup client-config] tool.

For example, when using GAS/SSO/GIP:
{
    "app_id": "app_employees",
    "protocol": "http",
    "authority": {
        "host": "toro",
        "port": 6394 
    },
    "service_name": "dbsync_server",
    "use_gas": true,
    "gas": {
        "connector": "connector_1",
        "group": "dbsync"
    },
    "sso": {
        "idp_issuer": "http://toro:6394/ws/r/services/GeneroIdentityProvider", -- 
        "client_id" : "640F0E5E-...",
        "client_secret" : "ulB..."
    }
}
where:
  • app_id: Identifies the application in the DB Sync system - this must be an identifier.
  • protocol: Defines the http or https protocol to access the DB Sync RESTful service.
  • authority: Parameters to reach the DB Sync service:
    • host: Host name where the DB Sync service can be reached
    • port: TCP port where the DB Sync service can be reached
  • service_name: Defines the name of the REST service, the name of the XCF file.
  • use_gas: Set to true when using GAS/GIP, false for direct mode.
  • gas: Defines GAS URL options (optional):
    • connector: The connector in the GAS URL.
    • group: The group in the GAS URL.
  • sso: When use_gas=true, Single Sign-On parameters to reach the IDP.