Immerse SDK
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage
  1. Immerse SDK Documentation
  2. /
  3. unreal-sdk
  4. /
  5. 1.0.0
  6. /
  7. Reporting

Reporting

Immerse reporting is built around the concept of a reporting tree. A hierarchy of activities that are expected to be completed by the user. For each of these activities, additional actions can also be reported for additional data.

Import Reporting Tree

Once you have create your reporting tree on the developer portal, it can be imported to the Unreal editor via the Immerse SDK window.

  1. Click the ‘Download Reporting Tree’ button
  2. Create/select a directory for the activity objects to be saved

Download Reporting Tree button

Download Reporting Tree button

Whenever you update/import your reporting tree, it is important to send an update to the platform so reporting results can be displayed correctly. It is also important to remember to link the correct Session Activity to your Start Immerse Session nodes.

Session activity dropdown and Update Project button

Session activity dropdown and Update Project button

Activities

To report an activity, simply create a Report Activity node and link the activity in which you want to generate a statement for. You can then optionally attach a result and score objects.

All fields in the result are optional, make sure select the fields you wish to send in the ‘Enabled Fields’ dropdown

Example: Send a statement for an activity with a raw score value of 0.5

Example: Send a statement for an activity with a raw score value of 0.5

Actions

The Report Action node allows you to send a statement, against an activity, that has not been predefined in your reporting tree.

Create a node, select the appropriate verb for your action and provide a name of the subject of the action. Finally select the parent activity, when sent, the report will display this action as a child of the selected ‘Parent’ activity.

Example: Send a action statement against an activity where the user Opened ‘Door A’

Example: Send a action statement against an activity where the user Opened ‘Door A’

Completion

Sending a completion statement for your session activity is the most important statement of all. Fortunately, setup is easy:

  1. Create a Report Activity node
  2. Select your session activity from the Activity dropdown
  3. Make a result with the ‘Completion’ and ‘Successful’ fields
  4. Link the result to the Report Activity node

Example: Send a completion statement for the session

Example: Send a completion statement for the session

The completion and successful values should reflect what your user achieved. These should be set by your application.