Geofence and Beacon Event Variables

Geofence and Beacon entry and exit events are location-based events you can manage in REI and use in Program. For each event, Oracle Responsys allows the app developer to pass up to 5 optional key-value pairs from the app using the event APIs. These key-value pairs help marketers and app developers extend the functionality of the standard out-of-the-box events. On the SDK side each key-value pair is passed as a string of up to 256 characters. Learn more about passing this optional data as part of the API calls here.

On the Responsys platform side, marketers must extend the REI event by adding additional custom variables with the desired attribute name and type. When an REI event is raised, the custom variables are available in Program as Program Event Variables.

Geofence Entry

Event Timestamp and Source

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_GEN_TIME Date/Time Time on the device when this event was triggered (UTC Time Zone)

Mandatory

RSYS_GEN_SOURCE Text (max length 256 characters) The source of the event. App developers can choose to use this attribute to include details like the name of the Geofence and Beacon SDK/solution that they have integrated with, or the name of the Beacon hardware. Optional

Zone

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_GEN_ZONE_ID Text (max length 256 characters) ID of the region / zone. A region or zone represents a logical boundary for a Region that a Marketer wants to monitor. Often in location based services products, Geofences and Beacons are included within Regions or Zones. Optional
RSYS_GEN_ZONE_NAME Text (max length 256 characters) Name of the Region / Zone. A region or zone represents a logical boundary for a Region that a Marketer wants to monitor. Often in location based services products, Geofences and Beacons are included within Regions or Zones. Optional

Geofence

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_GEN_FENCE_ID Text (max length 256 characters) ID for the Geofence Mandatory
RSYS_GEN_FENCE_NAME Text (max length 256 characters) Name of the Geofence Mandatory

Device Motion

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_GEN_DEVICE_SPEED Number Speed of the device when the Geofence transition was triggered. Units depend on the Geofence SDK / solution being used by the app. Optional
RSYS_GEN_DEVICE_BEARING Number Bearing / Direction of travel for the device when the Geofence transition was triggered. Bearing is usually the horizontal direction of travel and is measured in degrees. Optional

Geofence Exit

Event Timestamp and Source

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_GEX_TIME Date/Time Time on the device when this event was triggered (UTC Time Zone) Mandatory
RSYS_GEX_SOURCE Text (max length 256 characters) What was the source of the event. App developers can choose to use this attribute to include details like the name of the Geofence and Beacon SDK/solution that they have integrated with, or the name of the Beacon hardware. Optional

Zone

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_GEX_ZONE_ID Text (max length 256 characters) ID of the region / zone. A region or zone represents a logical boundary for a Region that a Marketer wants to monitor. Often in location based services products, Geofences and Beacons are included within Regions or Zones. Optional
RSYS_GEX_ZONE_NAME Text (max length 256 characters) Name of the Region / Zone.
A region or zone represents a logical boundary for a Region that a Marketer wants to monitor. Often in location based services products, Geofences and Beacons are included within Regions or Zones.
Optional

Geofence

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_GEX_FENCE_ID Text (max length 256 characters) ID for the Geofence Mandatory
RSYS_GEX_FENCE_NAME Text (max length 256 characters) Name of the Geofence Mandatory

Dwell Time

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_GEX_DWELL_TIME Integer Time spent inside the Geofence (in minutes / seconds). The units of the Dwell Time depend on the solution being used by the app. Optional

Beacon Entry

Event Timestamp and Source

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_BEN_TIME Date/Time Time on the device when this event was triggered (UTC Time Zone) Mandatory
RSYS_BEN_SOURCE Text (max length 256 characters) What was the source of the event. App developers can choose to use this attribute to include details like the name of the Geofence and Beacon SDK/solution that they have integrated with, or the name of the Beacon hardware. Optional

Zone

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_BEN_ZONE_ID Text (max length 256 characters) ID of the region / zone. A region or zone represents a logical boundary for a Region that a Marketer wants to monitor. Often in location based services products, Geofences and Beacons are included within Regions or Zones. Optional
RSYS_BEN_ZONE_NAME Text (max length 256 characters) Name of the Region / Zone.
A region or zone represents a logical boundary for a Region that a Marketer wants to monitor. Often in location based services products, Geofences and Beacons are included within Regions or Zones.
Optional

Beacon

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_BEN_BEACON_ID Text (max length 256 characters) ID for the Beacon Mandatory
RSYS_BEN_BEACON_NAME Text (max length 256 characters) Name of the Beacon Mandatory
RSYS_BEN_BEACON_TAG Text (max length 256 characters) Any tag to further categorize this Beacon Optional

iBeaconIdentifier

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_BEN_IBEACON_UUID Text (max length 256 characters) iBeacon UUID Optional
RSYS_BEN_IBEACON_MAJOR Integer iBeacon Major Optional
RSYS_BEN_IBEACON_MINOR Integer iBeacon Minor Optional

EddystoneIdentifier

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_BEN_EDDY_ID1 Text (max length 256 characters) Eddystone or other Protocol ID1 Optional
RSYS_BEN_EDDY_ID2 Text (max length 256 characters) Eddystone or other Protocol ID2 Optional

Proximity

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_BEN_PROXIMITY Text (max length 256 character) User's / Device's proximity from the Beacon. Possible values are: Immediate (I), Near (N), Far (F), Unknown (U) Optional

Beacon Exit

Event Timestamp and Source

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_BEX_TIME Date/Time Time on the Device when this Event was triggered (UTC Time Zone) Mandatory
RSYS_BEX_SOURCE Text What was the source of the event. App developers can choose to use this attribute to include details like the name of the Geofence and Beacon SDK/solution that they have integrated with, or the name of the Beacon hardware. Optional

Zone

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_BEX_ZONE_ID Text (max length 256 characters) ID of the region / zone. A region or zone represents a logical boundary for a Region that a Marketer wants to monitor. Often in location based services products, Geofences and Beacons are included within Regions or Zones. Optional
RSYS_BEX_ZONE_NAME Text (max length 256 characters) Name of the Region / Zone.
A region or zone represents a logical boundary for a Region that a Marketer wants to monitor. Often in location based services products, Geofences and Beacons are included within Regions or Zones.
Optional

Beacon

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_BEX_BEACON_ID Text (max length 256 characters) ID for the Beacon Mandatory
RSYS_BEX_BEACON_NAME Text (max length 256 characters) Name of the Beacon Mandatory
RSYS_BEX_BEACON_TAG Text (max length 256 characters) Any tag to further categorize this Beacon Optional

iBeaconIdentifier

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_BEX_IBEACON_UUID Text (max length 256 characters) iBeacon UUID Optional
RSYS_BEX_IBEACON_MAJOR Integer iBeacon Major Optional
RSYS_BEX_IBEACON_MINOR Integer iBeacon Minor Optional

EddystoneIdentifier

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_BEX_EDDY_ID1 Text (max length 256 characters) Eddystone or other Protocol ID1 Optional
RSYS_BEX_EDDY_ID2 Text (max length 256 characters) Eddystone or other Protocol ID2 Optional

Dwell Time

Program Event Variable Name Program Event Variable Data Type Description Mandatory Field
RSYS_BEX_DWELL_TIME Integer Time spent in proximity of the Beacon (in minutes / seconds). The units of the Dwell Time depend on the solution being used by the app. Optional

Related