Knowledgebase
Revulytics > Revulytics - Support Help Desk > Knowledgebase

Search help:


What files are created by the Revulytics Usage Intelligence SDK and what is the folder location?

Solution

When your software is first run, the Revulytics Usage Intelligence SDK creates the following files on disk:

  • ruiconfig*.cfg
  • ruilog*.log

NOTE: The SDK may create multiple ruilog*.log files at any given time.

Every time your application is run, the SDK will attempt to search for these files which are used to store config data as well as tracking/usage logs. If the files are not found in the specified location, the SDK will recreate these files, generate the client fingerprint again and registers itself with the Revulytics server.

WARNING: The configuration and log files are unique for every installation and should not be copied between installations and users, both on the same or different computers. Doing so will cause the client fingerprint verification to fail and the Revulytics server will not track usage statistics for that client. You should always allow the Usage Intelligence API to create the config and log files for new installations.

The location of the folder where the files are created is set through the ruiCreateConfig() function in the Usage Intelligence SDK. You must make sure that your application has write permissions to the folder you specify. Ideally you set this path to the same location where your application stores data/config/settings.

Keep in mind that on some machine configurations (especially Microsoft Windows Vista or higher with UAC enabled), if the user does not have administrator privileges, your application will be denied access to the ‘Program Files’ directory. Therefore you want to avoid using the default path if your application runs from the Program Files directory.

If your application supports running multiple instances concurrently, then the same location (and log files) can be shared between the multiple instances, however it is very important that you set the Usage Intelligence SDK to use multi-session mode (see API documentation for details). This will allow you to track each runtime session independently without file-access conflicts.

If your application supports multiple user profiles and you want to track statistics from each user separately, then when calling the ruiCreateConfig() method you need to specify a unique folder for every user. This can either be a folder within the the user's Windows profile or else a manual folder created inside your application data directory where the folder name would include a unique username/ID/hash identifying that user. Using independent folders for every user would allow Usage Intelligence to generate a unique fingerprint for every user and therefore track them as independent installations.

Related Articles:

 
Was this article helpful? yes / no
Related articles Dealing with UAC and file-access permissions for non-administrators accounts
How does Revulytics Usage Intelligence identify unique users/installations? What happens when a user uninstalls, reinstalls or formats?
What happens if the user deletes the Revulytics Usage Intelligence config or log files?
What happens if the user changes the contents of the Revulytics Usage Intelligence config or log files?
Why is data not showing up inside the dashboard or reports?
Article details
Article ID: 39
Category: SDK integration and Technical queries
Date added: 2014-02-14 16:55:27 UTC
Views: 698
Rating (Votes): Article rated 3.3/5.0 (7)

 
« Go back

Privacy Policy Terms of Use