Developer Zone

Quick-Start Guide

System Requirements

The Trackerbird .NET SDK can be used with .NET Framework versions 2.0, 3.0, 3.5, 4.0 and 4.5 including Client Profile editions.

Registering Your Product

Before you can use the Trackerbird Software Analytics service or integrate the Trackerbird SDK with your software, you must first register an account by visiting: http://register.trackerbird.com. Once you register a username and create a new product account for tracking your application, you can get your Product ID and callhome URL from the Developer Zone (within the login area). From here you can also download the latest version of the SDK.

API Overview

When using the Trackerbird API, there are two main classes which you will have to integrate with. One is Trackerbird.Tracker.TBConfig which is a dynamic class used for holding the configuration elements used by the SDK. The other class is Trackerbird.Tracker.App which contains all the methods used for controlling and using all the features provided by Trackerbird. All the methods inside this class are declared static so creating an instance of the class is NOT required.

In order to download the Trackerbird SDK, you may visit this page.

Importing the SDK Files

Upon downloading the .NET SDK, you find 3 DLL files and an XML file as follows:

  • Trackerbird.Tracker.dll - The .NET DLL that should be imported in your project
  • Trackerbird.x64.dll - Native 64-bit DLL imported automatically by the .NET DLL
  • Trackerbird.x86.dll - Native 32-bit DLL imported automatically by the .NET DLL
  • Trackerbird.Tracker.XML - XML documentation file used by Visual Studio IntelliSense

You do not need to worry if your application will run on x86 or x64 platforms. If you do not target any specific platform, you should include both x64 and x86 DLLs with your application, and the Trackerbird .NET DLL will import the correct one automatically. If, however, you choose to target a specific platform, you may include only the corresponding native DLL in order to make the installation size smaller.

Basic Integration Steps

The most basic Trackerbird integration can be accomplished by following the steps below. It is however recommended to read the more advanced documentation as Trackerbird can do much more than the basic functionality that can be achieved by following these steps.

  1. Download the latest SDK and extract it to your preferred project location.

  2. Add a reference to TrackerBird.Tracker.dll in your project.

  3. Add the directive using Trackerbird.Tracker to the source files where you will be calling the Trackebird SDK.

  4. Initialize the SDK configuration similar to the below example. Your callhome URL and product ID can be retrieved from the Trackerbird Developer Zone (inside your login area). “Multiple Sessions Enabled” (multiSessionsEnabled parameter) is a boolean value where you specify whether your application can have multiple user sessions per runtime session. This is normally false for desktop applications. For further details, refer to Single vs. Multiple session modes.

    TBConfig.CreateConfig("<Callhome URL>", "<Product ID>", "<Your product's version>",
                          "<Your product's build number>", <Multiple Sessions Enabled>);
    
  5. Call the static method :cs:func:`TBApp.Start`. You must call this method first, before making any other Trackerbird API calls. It is recommended that you place this call at the entry point of your application so the Trackerbird SDK knows exactly at what time your application runtime session was started. If using multi-session mode, you also need to call :cs:func:`TBApp.SessionStart` when a user session is started, and also provide a unique user session ID which you will then also use for closing the session or for Feature / Event Tracking.

  6. Call :cs:func:`TBApp.Stop` in the closing event of your application so the Trackerbird SDK knows when your application runtime session has been closed. If using multi-session mode, when user sessions are closed, you should call :cs:func:`TBApp.SessionStop` and send the ID of the session that is being closed as a parameter.

  7. All of the public methods inside the App class are static and can be called at any point in your application as long as the Trackerbird.Tracker library was initialized through :cs:func:`TBApp.Start`.

  8. Before running your application, copy the DLL files Trackerbird.x64.dll and Trackerbird.x86.dll inside the BinDebug path (or BinRelease if you are compiling for release). These files are required by the Trackerbird SDK and must be included with your application. If you are building specifically for x64 or x86, you may then choose to include only the corresponding DLL file.

The following is an example of the basic integration outlined below. This example uses single-session mode.

public Form1()
{
    //Initialize the configuration
    TBConfig.CreateConfig("http://INSERT-YOUR-URL", "INSERT-YOUR-PROD-ID", "1.0.0.1", "10", false);

    //Inform Trackerbird that the application has been started.
    TBApp.Start();

    //Your program logic...
}

private void Form1_FormClosing(object sender, FormClosingEventArgs e)
{
    //Inform Trackerbird that this runtime session is closing down.
    TBApp.Stop();

    //Your program logic...
}

Next Steps

In the above section, we covered the basic integration steps. While these steps would work for most software products, it is recommended to do some further reading in order to get the most of what Trackerbird has to offer. It is recommended to go into more detail by reading the pages SDK Configuration and Basic SDK Control. Once you are familiar with the SDK, you may look at the advanced features.

Advanced Features

By following the Basic Integration Steps above, the Trackerbird SDK will be able to collect information about how often users run your product, how long they are engaged with your software as well as which versions and builds they are running. The SDK also collects information on what platforms and architectures your software is being run (i.e. OS versions, language, screen resolution, etc.). Once you have implemented the basic features, you may choose to use Trackerbird for more advanced features which include: