This section describes the schema that supports the implementation of the IUA/ASA iBeacon feature set.
B2CStore.Mobile (location_ddl.xml)
The iBeacon item-descriptor contains meta-data about the physical iBeacons in the store. While it is possible for one iBeacon item to represent one or more physical iBeacons that match the UUID, major and minor property values but in most cases, there will be a one-to-one relationship between a physical iBeacon and an iBeacon item.
Item-descriptor
ibeacon
Repository
/atg/commerce/location/LocationRepository
Table
crs_ibeacon
Name | Type | Required? | Description |
---|---|---|---|
| String | Yes | The display-name property. |
| String | Yes | The iBeacon UUID. This is a 128-bit ID that gives each beacon a unique identity. For example: |
| String | No | The iBeacon major value, which usually maps to a company’s store. |
| String | No | The iBeacon minor value which usually maps to a department or location within a store. |
| String | No | The iBeacon identifier value. |
| Repository Item (store) | Yes | The ATG store associated with this iBeacon. |
| List | No | The list of |
| List | No | The list of ibeaconAlert items when the device exited the iBeacon’s range |
ibeaconAlert
The ibeaconAlert
item descriptor describes the alerts (also called notifications) that can be associated with one or more iBeacons. An alert is a message displayed to the IUA shopper and may contain a l ink to an optional URL. An alert can be displayed immediately on the client or as a push notification using the Apple Push Notification service (APNS).
Repository
/atg/commerce/location/LocationRepository
Table
crs_ibeacon_alert
Name | Type | Required? | Description |
---|---|---|---|
| String | Yes | The display-name property. |
| String | No | The iBeacon UUID data which is usually unique to a company’s set of iBeacon transmitters |
| String | No | The iBeacon major value which usually maps to a company’s store. |
| String | No | The iBeacon minor value which usually maps to a department or location within a store. |
| Boolean | Yes | If true, the client should not display the associated text and optional |
In Mobile.International
the iBeaconAlert
item descriptor has the following overrides and additions described in the following table.
Name | Type | Required? | Description |
---|---|---|---|
| String | No | Derived property that looks up the translated text from the translations map via the locale. |
| String | No | The default text string |
| Map : Ibeacon Alert Translation | No | The iBeacon minor value which usually maps to a department or location within a store. |
The item-descriptor ibeaconAlertTranslation
follows the CRS internationalization pattern with a single property ‘text’ of type string and a locale
property for keying the string into the translations map on the ibeaconAlert
item-descriptor.
When the client displays an alert, the text properties take precedence over the textKey
property. The textKey
property is available if customers desire not to use the repository to store alert text.