Setup and Validate Events

When you have created the API Keys in Omniata and selected your integration method, you can test the panel integration. This is a critical phase: integrating the standard Omniata Event Types properly, designing your custom Event Types with care, and ensuring that the event flow is correct during the user’s session are vital part of ensuring high data quality.

Omniata has tools for selecting a user profile and monitoring the event data sent in real time. This section will guide trough the common scenarios of data validation and the usage of the Event panel.

To access the event panel navigate to Model -> Events.


Event Console

The Event Console shows incoming events in real-time. The Event Console can be accessed by going to Model -> Events -> Event Console. The Event Console tracks one combination of UID and API key at a time, which makes examining the event flow easy.

The UID and API Key combination is referred to as User Profile, the event scan page acts as an event listener picking up any event showing the user profile. From this screen you will see the message “Waiting for Events” and a single REST example to test the functionality of the Event Console.

If you want to test the use of the Event Console manually before starting the actual integration, you can use the REST sample code. Copy-paste it into the address bar of web browser and press enter, and the corresponding event will be shown in the Event Console.

Event Console Checks

The event console checks event parameters according to the metadata found in Event Types. The console is a passive checker, meaning that it will inform if a particular event is new or contains new or missing parameters but will not reject data on any circumstances.

In case an event received in real-time differs in definition from what is found in the Event Types definitions options will be shown to synchronize metadata. For example, for new found parameters an option will show to add them to the event definition. In case of missing parameters, an alert will show indicating this incidence.

Event Console Display

The event console show data in JSON format, however data is stored as a REST request. The JSON display format is made to facilitate readability. The log of events is local to the profile, and can be cleared out if needed.

Event Types

The Event Types panel allows you to create new Events definitions, these definitions act as metadata to create fields and to make the event parameters available for drag-and-drop reports. On this panel you can also edit the definition of any already available event to include or exclude parameters.

From here you can also track, for a selected User Profile, the incidence of any event. This is helpful when checking that the implemented event flow is correctly triggered for all intended actions in the App.

When the F2P Package has been installed, a set of predefined event types will show. These event types cover the Standard Event Types that can be used as base for any type of free to play game. Omniata does not require that all events are marked as tracked for any given profile, the tracking is passive and informative in nature.

You also get sample code for the Event Types defined. The code contains the specified user ID and API key of the selected user profile, so you can test the integration by using the sample code in the browser or clicking in Actions -> Test Event.

Adding New Events

You can add events manually or automatically. Events in the panel are metadata of the data received by Omniata. This means that this panel is a passive descriptor of the data available and the panel definitions are not enforced during data collection. Event metadata is necessary to allow the panel to expose parameters as data fields from which you can create reusable tables and charts.

To add new events manually start by going to Event Types -> New Event Type. There will be 3 mandatory parameters already added for any new event type. The event name corresponds to the value sent in the om_event_type parameter.

To add new events automatically enable the check box “Automatically Add New Event Types …”. This will ask Omniata to scan the data received and synchronize the metadata each night.

Event Properties

The Event Properties panel manages all field operators derived from event properties. From here you can see which parameters are shared across events, or which parameters are mapped to a single event property. In Omniata properties are defines as field operators that use event parameters as source of data.

These operations can have different applications, to know more about these check out the Data Fields guide.

Adding New Event Properties

As with event types, you can add event properties manually or automatically. Adding event properties automatically is the recommended approach during integration. As the use cases become more complex they may require some preprocessing by Omniata. For this you will require to add event properties manually.

To add a new event property navigate to Model -> Events -> Event Properties -> New Event Property. Some use cases for adding event properties include:

  • Mapping two or more parameters with different name to a single field.
  • Creating a counter of incidence of an event or parameter value.
  • Adding a preprocessing formula for a parameter.
  • Extract metadata of the event.
  • Create a lookup of a parameter value.

Event Scan

Event Scan shows all Event Types which have been received by Omniata and the included parameters. The Event Scanner can be accessed by going to Model -> Event Scans -> Detect Events. The scanner can be used in almost real-time, with a 5-minute delay due to event processing.

The Event Scanner can also automatically detect new found event types and event parameters, as well as create Event Fields for them.

You have also an option to set that all new event and parameters are automatically updated on daily basis as described in the Event Types page as well. Try as much as possible to make sure that the data stream is clean before selecting this option.

Scan Jobs

The Event Scan Job will scan the events for the period of time selected. The scan results indicate which events and parameters have not been added to the Project, and provide an option to add them.

Under ‘Scan’ you can define the length of the period to be scanned, the environment, and the number of users. The results page provides you with options to add events and parameters to the Application. The results of each scan will by default list only newly found information, nevertheless you can also toggle this option to list all found events and parameters.

This article was last updated on April 27, 2017 13:30. If you didn't find your answer here, search for another article or contact our support to get in touch.