📘

This feature requires the Immerse SDK Enterprise Edition

This is different to the free Immerse SDK. Contact [email protected] if you require access.

Understand the difference between the Free and Enterprise SDK

🚧

ImmerseSDK.PlatformServices.Reporting.Report is deprected

Please use the Reporting package to send statements instead. See Sending Statements

To report an event, a Session must first be joined. Once connected, it is as simple as calling a single static method ImmerseSDK.PlatformServices.Reporting.Report.Send

Example

ReportCollisions.cs is an example script that will send a reporting event each time a collision occurs with another GameObject.

using ImmerseSDK.PlatformServices.Reporting;
using UnityEngine;

/// <summary>
/// A Reporting example that captures every collision with a GameObject
/// </summary>
public class ReportCollisions : MonoBehaviour
{
    /// <summary>
    /// OnCollisionEnter is called when this collider/rigidbody has begun touching another rigidbody/collider
    /// </summary>
    private void OnCollisionEnter(Collision collision)
    {
        // Report the collision
        Report.Send("Collision", name, collision.gameObject.name);
    }
}

xAPI Data

Reporting messages can also be sent as xAPI Data , providing compatibility with common Learning Management Systems and Learning Record Stores. If completion statements are structured in xAPI format, they will be processed by the Immerse Platform and presented correctly on the Dashboard and other areas such as App overview pages.

using ImmerseSDK.PlatformServices.Reporting;

/// <summary>
/// Example on sending xAPI complete message with a successful value
/// </summary>
public void SendxApiCompleteMessage(bool successful, float score)
{
    if (Networking.Status == ConnectionStatus.Connected)
    {
        var xApi = new XApiData {Completion = true, Successful = successful, Score = score};

        // The first 3 parameters of this can be customized as you like 
        // e.g "UserID" can be replace with Networking.Client.Users.LocalUser.Id to send the local user's ID
        Report.Send("Complete", "User", "UserID", xApi);
    }
}

Review

To review reporting events, navigate to the Reporting foldout under Immerse SDK in Unity's Project Settings. A list of all recent sessions should now appear, with a unique ID and timestamp for each. Click 'Open' to see the report or 'Share...' to generate a shareable link.

📘

Shareable reporting links for your developer session will expire after 1 hour

Details on how your report will be displayed can be found here.