Pre-Launch Checklist

If you are having issues with the SDK, please check the following items to ensure you have everything set-up correctly. If you are still stuck, please contact us immediately.

Pre-Upload

Account Setup

  • Do you have an account on the Cognitive3D dashboard?
  • Have you created a "Project" yet?
  • Have you generated your API keys?
  • Are the API keys correctly entered when you look at the Scene Setup window cognitive3D -> Scene Setup ?

Dynamic Objects

It is highly recommended to set these up before you do the Scene Setup Wizard:

  • Have you added the "Dynamic Object" component to all of the non-static objects you wish to track in your scene? (Gaze will be tracked across the entire scene as well, but it is important that you specifically tag objects)
  • Is "Track gaze on this object" selected for these objects? (It is on by default, but be sure to double check)
  • Are all Dynamic Objects named properly? (The name of the GameObject will be used as the name of the Dynamic Object.)
  • Do all Dynamic Objects have colliders attached? (Any Colliders on child GameObjects will be assumed belong to the parent Dynamic Object)
  • Are the colliders on your Dynamic Objects properly aligned with the mesh? (We capture gaze on these colliders, so they must be accurate to your meshes)
  • Do your Dynamic Objects have any parents with Colliders that might interfere, overlap, or block user gaze? (Tracking gaze on Dynamic Objects is done via Physics Raycasts. As such, gaze will NOT be captured if there are rogue colliders in between the user and a given Dynamic Object)

Post-Upload

Scene Setup

  • Is the Scene uploaded to the Dashboard?
  • Is the Scene accessible and loading on SceneExplorer?
  • Is the base geometry visible in SceneExplorer correct? (verify visually)

Dynamic Objects

  • Are all Dynamic Objects named properly? The name of the GameObject will be used as the name of the Dynamic Object.
  • Do all Dynamic Objects have colliders attached? (Colliders on child Game Objects is perfectly fine)
  • Are the colliders on your Dynamic Objects properly aligned with the mesh? (We capture gaze on these colliders, so they must be accurate to your meshes)
  • Do your Dynamic Objects have any parents with Colliders that might interfere, overlap, or block user gaze?
  • Have you uploaded all of your Dynamic Objects? There is no need to re-upload unless you change Dynamic Object names or meshes. Adjusting or adding colliders does NOT require a re-upload.

ExitPoll

If you do not wish to create any ExitPoll questions, skip this section.

  • Have you created any ExitPoll Hooks?
  • Have you implemented these Hooks properly in your project? The hook names in your app's code must match exactly with what you created on the dashboard.
  • Have you created any Question Sets?
  • Have you assigned your ExitPoll Hook(s) to the correct Question Set AND Question Set Version?
  • Have you seen your ExitPoll questions successfully appear inside your app?
  • For Voice Responses, have you successfully tested made a Voice Response AND played it back on the ExitPoll results page?

Verify Data

  • Open SceneExplorer. Are any sessions uploaded?
  • Can you see gaze coming through properly from your user sessions? (You can open the "Gaze" dropdown and select "Draw Line" to see the users' gaze line)
  • If you are using Eye Tracking, can you see the Users' gaze independent of the headset rotation?
  • If you are using Eye Tracking, does the calibration look correct in your tests sessions?
  • Are the Dynamic Objects in your scene receiving heatmaps / gaze? There will be NO heatmaps drawn on your objects unless gaze is successfully recorded on those objects.
  • On the "Objects" page, do your Dynamic Object names look correct?

Frequently Asked Questions

When should I upload a new version of my scene?

These are the cases when a new version of your scene is warranted:

You make a substantial change to the base geometry of your scene You want to make a new, clean separation of data for you scene. (For example, if you were doing test sessions but now want to launch a clean slate for production or deployment). You have substantially changed the Dynamic Objects in your scene. (For example, if you changed object names or removed them alltogether, you will see those old objects in the Object List despite removing them from your Unity or Unreal scene, since the data has already been sent.) If you simply forgot to add any Dynamic Object(s) and have now added it, you can skip the full scene upload and versioning, and just upload the Dynamic Objects.

If you simply moved a Dynamic Object in the scene, you do NOT need to re-upload anything.

I am getting an error when trying to upload my Scene or Dynamic Objects.

There are a few commons reasons for errors during the upload process:

Do you have both of the API key and Developer Key set properly? We do not store the Developer Key in Unity or Unreal project folders for security purposes, and this key may be lost when moving PCs or changing engine versions. You can simply get the Developer Key again from the Dashboard. In the Advanced Options panel, do you have "Custom Gateway" set to "data.cognitive3d.com" ?