Oracle.json

Below is a sample of the oracle.json file. For all configuration parameters used by Core module, please refer here.

For all configuration parameters used by Infinity module, please refer here.

Download a sample oracle.json here.

Sample oracle.json with infinity module

{
"config_version": "1.0",
    "ORACORE": {
        "ora_dc_end_point_config": [{
            "ora_dc_collection_url": "https://dc.oracleinfinity.io/v3/",
            "ora_dc_account_guid": "your_account_guid",
            "ora_dc_retry_count": "2"
        }],
        "ora_dc_modules": [
            "infy"
        ],
        "ora_dc_send_interval_millis": "10000",
        "ora_dc_app_start_auto_enabled": "true"
    },
    "ORAINFINITY": {
        "ora_dc_video_load_auto_enabled": "true",
        "ora_dc_video_load_meta_auto_enabled": "true"
    }
}

Sample oracle.json with infinity & Responsys module

{
    "config_version": "1.0",
    "ORACORE": {
        "ora_dc_end_point_config": [{
            "ora_dc_collection_url": "https://dc.oracleinfinity.io/v3/",
            "ora_dc_account_guid": "your_account_guid",
            "ora_dc_retry_count": "2"
        }],
        "ora_dc_modules": [
            "infy",
            "rsys"
        ],
        "ora_dc_send_interval_millis": "10000",
        "ora_dc_app_start_auto_enabled": "true"
    },
    "ORAINFINITY": {
        "ora_dc_video_load_auto_enabled": "true",
        "ora_dc_video_load_meta_auto_enabled": "true"
    }
}

Sample oracle.json with Responsys module

{
    "config_version": "1.0",
    "ORACORE": {
        "ora_dc_end_point_config": [{
            "ora_dc_collection_url": "https://dc.oracleinfinity.io/v3/",
            "ora_dc_account_guid": "your_account_guid",
            "ora_dc_retry_count": "2"
        }],
        "ora_dc_modules": [
            "rsys"
        ],
        "ora_dc_send_interval_millis": "10000",
        "ora_dc_app_start_auto_enabled": "true"
    }
}

Note: If a module is added to the mobile application project and if the module key (“infy” or “rsys”) is not added to the ora_dc_modules object, the SDK will log an error and data originating from the module whose key is not added will not be sent.

For example, if a mobile application contains the Core, Infinity & Responsys modules, but the oracle.json file contains only “infy” key, parameters set by the Responsys module will not be transmitted. For the steps to validate data collected by the SDK, click here.

Note: The first entry in the oracle.json file should be config_version. The json must contain this key. Without this key, core module will not be able to send events to Infinity Data Collection server. The value for this is a decimal number in x.y format. The config_version value plays an important role while updating/modifying the oracle.json key/values. When you update the oracle.json, the config_version key to be incremented. Otherwise, Core module can’t load the updated configurations.

For example if the value for config_version is 1.0, and the value for ora_dc_send_interval_millis is "10000". If you want to change the ora_dc_send_interval_millis value to "20000", you also need to change the config_version to 1.1. If the config_version is not incremented, the new config value will not be stored.

The table below outlines the parameters used to configure the file.

Data Object	Parameter	Required/Optional	Example	Description	Notes
`ora_dc_end_point_config`		Required		Array of endpoint details that outlines where data collected is sent.	You can configure any number of endpoints. The same payload can be sent to multiple endpoints for downstream processing.
	`ora_dc_collection_url`	Required	https://dc.oracleinfinity.io/v3/	Destination URL where data is sent.
	`ora_dc_account_guid`	Required	johndoe (a username)	Unique identifier for the customer on Infinity systems
	`ora_dc_retry_count`	Optional	2	Number of attempts for POSTing data to the endpoints in the event of a failure
`ora_dc_send_interval_millis`		Optional	5000
`ora_dc_enabled`		Required	true
`ORAINFINITY`	Refer list here.	Optional	video_auto_load_enabled: true	This object is used to configure the parameters pertaining to the Infinity module
`ora_dc_modules`		Required	infy	Array of modules in the CX Mobile SDK	You need to add the key for each module in the CX Mobile SDK Infinity – “infy” Responsys – “rsys” If only Core module is used in the mobile application without any other module, then ora_dc_modules must be set as an empty array. “ora_dc_modules”: []