The default settings for the FairCom jsonAction APIs and browser-based applications are specified in the services.json file in the "jsonActionApiDefaults" property.
Note Use the Google Chrome browser for FairCom browser-based tools. Other browsers may cause unexpected behavior.
Data type: object
Limits:
"defaultApi"
"defaultBinaryFormat"
"defaultDatabaseName"
"defaultDebug"
"defaultOwnerName"
"defaultResponseOptions"
"defaultRetentionPeriod"
"defaultRetentionPolicy"
"defaultRetentionUnit"
"defaultVariantFormat"
"enablePermanentJsonApiSessions"
"idleConnectionTimeoutSeconds"
"idleCursorTimeoutSeconds"
"maxJsonApiSessions"
"maxJsonApiSessionsPerIpAddress"
"maxJsonApiSessionsPerUsername"
Default settings for jsonAction APIs
"jsonActionApiDefaults": {
"defaultApi": "db",
"defaultBinaryFormat": "hex",
"defaultVariantFormat": "json",
"defaultDatabaseName": "faircom",
"defaultDebug": "max",
"defaultOwnerName": "admin",
"defaultResponseOptions":
{
"binaryFormat": "hex",
"variantFormat": "json",
"dataFormat": "objects",
"numberFormat": "number"
},
"idleConnectionTimeoutSeconds": 3600,
"idleCursorTimeoutSeconds": 600,
"defaultRetentionPolicy":"autoPurge",
"defaultRetentionPeriod":"4",
"defaultRetentionUnit":"week"
}
The property names and values in "jsonActionApiDefaults" are identical to those in the "params" property of "createSession", "alterSession", and "describeSessions". Each FairCom product ships with different default settings that make sense for that product — for example, in FairCom DB, the "defaultAPI" property is set to "db", in FairCom MQ it is set to "mq", and in FairCom Edge it is set to "hub".
You can change the values of the properties in services.json, and all jsonAction APIs and browser-based user interfaces will use these properties as their default. If any of the properties in "jsonActionApiDefaults" are omitted from services.json, the property values may vary depending on the JSON action performed.
Note FairCom's core configuration file,
ctsrvr.cfg, contains aSQL_DATABASEsetting. You can setSQL_DATABASEto the name of a database and when the FairCom server starts, it creates a database with that name if it does not already exist.By default,
ctsrvr.cfgsetsSQL_DATABASEto"ctreeSQL". If you changeSQL_DATABASEto use another database name, it is a good practice to put the same name in the"defaultDatabaseName"property inservices.json. This makes your newly created database the default database in all of FairCom's jsonActionAPIs and browser-based applications.
Keeping SQL_DATABASE and "jsonActionApiDefaults" in sync
ctsrvr.cfg
SQL_DATABASE my_new_database
services.json
"": {
"defaultApi": "db",
"defaultBinaryFormat": "hex",
"defaultDatabaseName": "my_new_database",
"defaultDebug": "max",
"defaultOwnerName": "admin",
"defaultResponseOptions":
{
"binaryFormat": "hex",
"dataFormat": "objects",
"numberFormat": "number"
},
"idleConnectionTimeoutSeconds": 3600,
"idleCursorTimeoutSeconds": 600,
"defaultRetentionPolicy":"autoPurge",
"defaultRetentionPeriod":"4",
"defaultRetentionUnit":"week"
}