The Watson Customer Experience Analytics (CXA) for Mobile Basic Edition SDK documentation is moving soon from the Knowledge Center to the Watson CXA for Mobile DevCenter on IBM developerWorks. The DevCenter is a one-stop shop that provides all the tools developers need to create, develop, and innovate with CXA Mobile. In the DevCenter, you will find step-by-step tutorials, APIs, documentation, community forums, and expert support.
Event attributes
Events are created based on a set of event attributes.
- Active: This status determines whether the event is active. Default is ON.
- Event name: The name of the event you are creating.
- Tags: Keywords to help you find this event in searches.
- Description: Description of the event.
- Trigger: Events can be triggered to start on sessions, hits, or
steps.
You can set the frequency by which Hit events, Step events, and Session events are evaluated, as follows:
- Hits
- First hit
The Event is evaluated when a new visitor's session begins.
- Every hit
This is the default.
The Event is evaluated before any part of a new hit is evaluated.
- After every hit
The Event is evaluated after all parts of a hit are evaluated.
- First hit
- StepsTo support step-based eventing, the you can specify the trigger frequency for steps:
- Every step
This is the default.
The Event is evaluated with other events in each step.
- After every step
The Event is evaluated after every step is evaluated.
- Every step
- Sessions
- At session end
The Event is evaluated when a visitor's session ends, either as defined by event or by a system timeout.
- At session end
- Hits
- Frequency: How often you want the event to trigger.
- Published at: When you want the events published, either immediately or
at the end of the session.
- Immediate: publish the event immediately with the dimension values as they are when the event fires. Data is extracted from the session data when an event is triggered. When an event fires, the values of the associated dimensions are published with the event value.
- Session end: publish the event at the end of the session. At the end of
the session, the last known value for each dimension is back-populated to the event occurrences
earlier in the session.
The event values that were detected at the time the event fired are recorded, but the publishing does not occur until the session is completed by the user, or session timeout. This method for event publishing enables the support of the capturing of the dimension values associated with the event from their last occurrence in the session.
For example, suppose you use a dimension to capture whether a purchase was made. Since that information is not known until the end of the session, you can delay the publishing of CX Overstat® on Cloud events and their related dimensions until the end of the session so the definitive answer (Yes or No) is captured in the dimension value.
- Mode: Create the event using Basic and Advanced modes.
- Basic mode allows the user to use existing data elements (Hit Attribute, Step Attribute, Events, Sessions Attributes, Dimensions) in a User Interface to create events.
- Advanced mode allows the user to manipulate the system names and JavaScript in the event engine. A user can build out an event and see the JavaScript equivalent by clicking on Advanced Mode. For example, If a user would like to build a report that concatenates a string of values, they can create an advanced event to do that.
- Conditions: Conditions that determine when an event fires.
- Reference value: This is a variable that is associated with the event when it fires. Create a custom value or chose an event object. You can choose to treat it as text or numeric.
- Store metrics: Method by which you want to store the metrics from your event. You can track the first occurrence, last occurrence, or all occurrences. If you chose to treat your reference value as numeric, you have the option of adding value metrics.
- Dimension groups: Dimension groups associated with this event. Geo analytics can be enabled for each dimension group in the event. Default is disabled.
- Dependencies: If there are
dependencies between the Event and other Events or Event objects (such as session attributes,
dimension/dimension group), as well as Alert or Report dependencies, they are listed in the
Dependencies section of an Event definition.
Dependencies, which are generated by the system, vary depending on defined Event.
In addition to the dependency itself, the owner of the dependency is listed. Before removing an Event definition, you might want to notify whoever owns the dependent objects, so that they can delete the dependencies.