Getting Started with Custom Objects

Overview

Custom Objects are a special type of table in the Loyalty database, designed to extend the Member Profile with object types specific to the client's business. Custom Objects contain their own unique set of Attributes, and can be used for segmentation, personalization, and analytics. The intended use of Custom Objects is to store information that doesn't otherwise fit into other Loyalty concepts, such as hotel reservations or subscriptions, for example.

Note: Custom Objects are an optional feature that must be enabled in your Loyalty account. Speak with your Zeta representative for details on enabling this feature.

Every Custom Object table must have its own Primary Key that uniquely identifies a record on that table. Custom Objects join to the Member table using a one-to-many relationship, meaning that a single Member can have one or more Custom Objects associated with them. For example, a single Member could make multiple hotel reservations, or purchase multiple flights, or hold multiple subscriptions. A Custom Object record can't exist by itself; it must be joined to a record on the Member table.

Related Concepts

Activities

A Custom Object record can have Activity data associated with it, but Custom Objects and Activities serve two different purposes. Activities capture discrete actions taken by a Member, and function primarily as an historical record. Custom Objects store the detailed, structured data related to those Member actions, and can store information that may change over time.

For example, let's say you're using Custom Objects to store hotel reservations. The action take by the Member (making the reservation) is captured as an Activity, but the information about the reservation itself (date, price, status, special requests, and so forth) is stored on the Custom Object table. Activities don't provide the necessary functionality to adequately capture this information, because Activities are intended to provide a historical log of Member actions, not to track ongoing, changeable details, like "status."

Feature Editable Purpose Example
Custom Objects Yes Ongoing data storage Reservation status and details
Activities No Event history Member books a hotel room

Lookups

Custom Objects differ from Lookup tables in that a Custom Object is joined to a Member, and is part of the Member Profile. Conversely, Lookup tables are best suited for non-person related reference data, like store locations, products, etc.

Feature Tied to Member Profile Purpose Example
Custom Objects Yes Member-specific data Reservation status and details
Lookups No Reference data Stores, products

Custom Object Family

The Custom Object Family indicates how you intend to use the data in the Custom Object. The platform supports the following Custom Object Families:

  • Batch: Intended for use cases where Custom Object data is imported into the system as a file, such as a daily batch import, for example.

  • Streaming: Intended for use cases where Custom Object records are flowing into the platform as a stream of events via API calls.

  • Synthesized: Intended for use cases where multiple data sources are combined and processed into a more useful view of a Member or their behavior.

Sub Objects

The platform allows you to create a table hierarchy by defining one or more "child" Sub Objects beneath a "parent' Custom Object. Continuing the above example for hotel reservations, you could use a Sub Object to store room details. A single reservation (joined up to a Member Profile) could have one or more rooms included as part of the reservation. For more information, see Working with Sub Objects.

Imports

Loyalty supports only Advanced Imports for importing data into a Custom Object. For more information, see Configure a Custom Object Import Definition.

Exports

Loyalty supports only Advanced Exports for exporting data from a Custom Object. For more information, see Configure a Custom Object Export Definition.

Access

The Custom Objects screen is used to view, create, and manage the Custom Objects in your loyalty program. To access the Custom Objects screen, select Program from the top navigation bar, then select Custom Objects from the side navigation menu.

For more information on the search options available on the Custom Objects screen, see Search for a Custom Object.

  Create a Custom Object View a Custom Object Define the Primary Key