SDK Initialization and Configuration
The Usage Intelligence V5 SDK is built to support running Usage Intelligence in plug-in type environments. To accomplish this goal, applications must first create an instance of the Usage Intelligence SDK by creating a new Usage Intelligence SDK object and using that object in subsequent calls.
The call to ruiCreateInstance() must be paired with a call to ruiDestroyInstance() when the client application is done using the SDK. The call to ruiCreateInstance() does not configure the SDK, ruiCreateConfig(), nor start the SDK, ruiStartSDK().
A typical client will create only a single instance of the SDK. Creating more than one SDK instance is allowed and is used to support clients that are plug-ins or other scenarios whereby multiple independent clients may co-exist in the same executable. Multiple SDK instances perform independently of one another except when sharing a configuration file: ruiCreateConfig().
ruiCreateInstance() is a synchronous function, returning when all functionality is completed.
Before an application can start reporting usage to the Usage Intelligence SDK, it must first provide some basic information such as the Product ID and the CallHome URL.
You should always fill in as much accurate and specific detail as possible since this data will be used by the Usage Intelligence Analytics Server to generate the relevant reports. The more (optional) details you fill in about your product and its licensing state, the more filtering and reporting options will be available to you inside the Usage Intelligence dashboard.