Entity

The Entity page is used to add, edit, and delete entities from the subscriber entity configuration (SEC). An entity is a type of subscriber data stored in XML format, such as quota, state, or profile of a subscriber.

Two types of entities can be defined: opaque and transparent. Opaque entity elements cannot be individually read or edited. Transparent entity elements and values inside those elements can be read and edited. (These values can be edited with SOAP/REST provisioning software.)

When defining a new transparent entity, the following must be defined (in the order listed) using options on the Transparent Entity menu before you can save the new entity:

1. Field set (if using): Adding a field set
2. Base field set: Adding a base field set
3. Definition: Adding a definition

Note that the system comes pre-configured with eight entities; each is pre-defined as either opaque or transparent:

• DynamicQuota (opaque)
• PoolDynamicQuota (opaque)
• PoolProfile (transparent)
• PoolQuota (transparent)
• PoolState (opaque)
• Profile (transparent)
• Quota (transparent)
• State (opaque)

These pre-defined entities come preloaded with default configuration and these can be customized if needed.

Additionally, an entity can be pooled with other entities for the purpose of pool processing. An entity that is not pooled applies to one subscriber; an entity that is pooled can be shared by multiple subscribers.

Note:

Once an entity is defined, at least one interface entity map entry must exist in order for the entity data to be accessed using provisioning or network interfaces. One interface entity map entry is required per interface.