Field Index

SQL Mapping

create

This notification event is generated when a new balance group is created.

Notes

This object can be read by the owner or any billing group leader who is an ancestor of the owner.
This object can be modified only by the owner.
This object can be created by anyone.

Field Index

Type	Field Name
string	PIN_FLD_NAME
poid	PIN_FLD_USERID
poid	PIN_FLD_SESSION_OBJ
poid	PIN_FLD_ACCOUNT_OBJ
string	PIN_FLD_PROGRAM_NAME
timestamp	PIN_FLD_END_T
timestamp	PIN_FLD_START_T
poid	PIN_FLD_BILLINFO_OBJ
poid	PIN_FLD_SERVICE_OBJ
string	PIN_FLD_SYS_DESCR
array	PIN_FLD_BAL_INFO
poid	PIN_FLD_POID
poid	PIN_FLD_BAL_GRP_OBJ
poid	PIN_FLD_BILLINFO_OBJ
array	PIN_FLD_SUB_BAL_IMPACTS
poid	PIN_FLD_BAL_GRP_OBJ
int	PIN_FLD_RESOURCE_ID
enum	PIN_FLD_CONSUMPTION_RULE

Field Details

string PIN_FLD_NAME

User-defined name of the event.

Notes

Required on object creation
Can be modified
Maximum length is 255 bytes

poid PIN_FLD_USERID

The unique ID of the user who is running the program that started the event.

Notes

Can be specified on object creation
Cannot be modified

poid PIN_FLD_SESSION_OBJ

Link to the event object (/event/session) that represents the session within which this event occurred.

Notes

Can be specified on object creation
Cannot be modified

poid PIN_FLD_ACCOUNT_OBJ

Link to the /account object which is responsible for creating this event.

Notes

Required on object creation
Cannot be modified

string PIN_FLD_PROGRAM_NAME

The name of the program that generated the event.

Notes

Required on object creation
Cannot be modified
Maximum length is 60 bytes

timestamp PIN_FLD_END_T

The time when the event ended.

Notes

Required on object creation
Can be modified

timestamp PIN_FLD_START_T

The time when the event started.

Notes

Required on object creation
Cannot be modified

poid PIN_FLD_BILLINFO_OBJ

Link to the /billinfo object, to which the new balance group created, is associated with.

Notes

Required on object creation
Cannot be modified

poid PIN_FLD_SERVICE_OBJ

POID of the service object.

Notes

Required on object creation
Cannot be modified

string PIN_FLD_SYS_DESCR

System generated description. This describes the event programmatically.

Notes

Can be specified on object creation
Can be modified
Maximum length is 255 bytes

array PIN_FLD_BAL_INFO

Array that contains the information about the new balance group

Notes

Can be specified on object creation
Can be modified

poid PIN_FLD_POID

Type only poid of the balance_group

Notes

System defined on object creation
Can be modified only by System

poid PIN_FLD_BAL_GRP_OBJ

POID of the new balance_group created

Notes

System defined on object creation
Can be modified only by System

poid PIN_FLD_BILLINFO_OBJ

POID of the billinfo, to which the new balance group created, is associated with.

Notes

Can be specified on object creation
Can be modified

array PIN_FLD_SUB_BAL_IMPACTS

Array to hold the sub balance impacts for a particular balance group and its resources.

Notes

Can be specified on object creation
Can be modified

poid PIN_FLD_BAL_GRP_OBJ

The balance group object this sub balance impact belongs to

Notes

Required on object creation
Can be modified

int PIN_FLD_RESOURCE_ID

Numeric value of the resource that is impacted.

Notes

Required on object creation
Can be modified

Consumption rule associated with the resource. The possible values are: (1) EST, (2) LST, (3) EET, (4) LET, (5) ESTLET, (6) ESTEET, (7) LSTEET, (8) LSTLET, (9) EETEST, (10) EETLST, (11) LETEST, and (12) LETLST.

Notes

Can be specified on object creation
Can be modified

SQL Mapping

Links

/event/notification/bal_grp SQL Mapping

Type	Field Name	Table	Column Name
derived-class	/event/notification/bal_grp/create
string	PIN_FLD_NAME
poid	PIN_FLD_USERID
poid	PIN_FLD_SESSION_OBJ
poid	PIN_FLD_ACCOUNT_OBJ
string	PIN_FLD_PROGRAM_NAME
timestamp	PIN_FLD_END_T
timestamp	PIN_FLD_START_T
poid	PIN_FLD_BILLINFO_OBJ
poid	PIN_FLD_SERVICE_OBJ
string	PIN_FLD_SYS_DESCR
array	PIN_FLD_BAL_INFO
poid	PIN_FLD_POID
poid	PIN_FLD_BAL_GRP_OBJ
poid	PIN_FLD_BILLINFO_OBJ
array	PIN_FLD_SUB_BAL_IMPACTS
poid	PIN_FLD_BAL_GRP_OBJ
int	PIN_FLD_RESOURCE_ID
enum	PIN_FLD_CONSUMPTION_RULE
Column names marked with * are actually column prefixes. For poid type fields, the column prefix is used to create the columns poid_id0, poid_db and poid_type if the prefix is "poid". For PIN_FLD_POID in the base table, an additional column named poid_rev is created to hold the poid revision. For buffer fields, two columns are created - one in the containing table and one in the buffer table. For example if the prefix is "buf", then the column name in the buffer table is buffer_buf and the column name in the containing table is buffer_size.

Field Index

This Class