Copyright (c) 1996, 2015, Oracle and/or its affiliates. All rights reserved.
This material is the confidential property of Oracle Corporation or its licensors and may be used, reproduced, stored or transmitted only in accordance with a valid Oracle license or sublicense agreement.

Field Index SQL Mapping

Class /event

Objects of the event class are created to record the various system-initated and user-initiated events. The events are either related to a specific service or to an account. The event includes generic information such as start and end times as well the various charges that are incurred by the account due to this event.

Notes

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

Links



Field Index

Type Field Name
poid PIN_FLD_POID
timestamp PIN_FLD_CREATED_T
timestamp PIN_FLD_MOD_T
string PIN_FLD_READ_ACCESS
string PIN_FLD_WRITE_ACCESS
string PIN_FLD_CREATE_ACCESS
poid PIN_FLD_ACCOUNT_OBJ
enum PIN_FLD_ARCHIVE_STATUS
array PIN_FLD_BAL_IMPACTS
poid
poid
decimal
decimal
decimal
decimal
int
string
enum
poid
decimal
poid
decimal
poid
string
int
int
string
string
poid
string
string
int
decimal
int PIN_FLD_CURRENCY
string PIN_FLD_DESCR
timestamp PIN_FLD_EFFECTIVE_T
timestamp PIN_FLD_END_T
timestamp PIN_FLD_EARNED_START_T
timestamp PIN_FLD_EARNED_END_T
int PIN_FLD_EARNED_TYPE
string PIN_FLD_EVENT_NO
int PIN_FLD_FLAGS
poid PIN_FLD_GROUP_OBJ
poid PIN_FLD_ITEM_OBJ
array PIN_FLD_MONITOR_IMPACTS
poid
poid
decimal
int
string PIN_FLD_NAME
string PIN_FLD_PROGRAM_NAME
string PIN_FLD_PROVIDER_DESCR
poid PIN_FLD_PROVIDER_ID
binstr PIN_FLD_PROVIDER_IPADDR
string PIN_FLD_RUM_NAME
enum PIN_FLD_UNIT
enum PIN_FLD_TOD_MODE
enum PIN_FLD_TIMEZONE_MODE
string PIN_FLD_TIMEZONE_ID
string PIN_FLD_RATED_TIMEZONE_ID
timestamp PIN_FLD_TIMEZONE_ADJ_START_T
timestamp PIN_FLD_TIMEZONE_ADJ_END_T
decimal PIN_FLD_MIN_QUANTITY
enum PIN_FLD_MIN_UNIT
decimal PIN_FLD_INCR_QUANTITY
enum PIN_FLD_INCR_UNIT
enum PIN_FLD_ROUNDING_MODE
decimal PIN_FLD_NET_QUANTITY
decimal PIN_FLD_UNRATED_QUANTITY
poid PIN_FLD_SERVICE_OBJ
poid PIN_FLD_SESSION_OBJ
poid PIN_FLD_RERATE_OBJ
timestamp PIN_FLD_START_T
string PIN_FLD_SYS_DESCR
array PIN_FLD_TAX_JURISDICTIONS
decimal
decimal
decimal
decimal
int
string
decimal
enum
string PIN_FLD_TAX_LOCALES
int PIN_FLD_TAX_SUPPLIER
poid PIN_FLD_USERID
string PIN_FLD_INVOICE_DATA
array PIN_FLD_RUM_MAP
string
decimal
decimal
array PIN_FLD_SUB_BAL_IMPACTS
poid
int
array
enum
decimal
timestamp
int
timestamp
int
string
int
poid
decimal
decimal
array PIN_FLD_MONITOR_SUB_BAL_IMPACTS
poid
int
array
enum
decimal
timestamp
int
timestamp
int
string
poid
poid PIN_FLD_LOADER_BATCH_OBJ
string PIN_FLD_BATCH_ID
string PIN_FLD_ORIGINAL_BATCH_ID
string PIN_FLD_USAGE_TYPE
string PIN_FLD_PROFILE_LABEL_LIST
string PIN_FLD_NAP_IP_ADDRESS
poid PIN_FLD_LINK_OBJ
string PIN_FLD_NETWORK_SESSION_ID


Field Details

poid PIN_FLD_POID

Object Identifier for an instance of this class. Portal object ids have four pieces of information: database number, class type, sequence id, revision.

Notes

  • System defined on object creation
  • Can be modified only by System

Links

timestamp PIN_FLD_CREATED_T

Time the object was created.

Notes

  • System defined on object creation
  • Can be modified only by System

Links

timestamp PIN_FLD_MOD_T

Time the object was last modified.

Notes

  • System defined on object creation
  • Can be modified only by System

Links

string PIN_FLD_READ_ACCESS

Read Access level for object. Valid values are S(Self), G(Global), L(BrandLineage), B(BrandGroup), A(Ancestral).

Notes

  • System defined on object creation
  • Can be modified only by System
  • Maximum length is 255 bytes

Links

string PIN_FLD_WRITE_ACCESS

Write Access level for object. Valid values are S(Self), G(Global), L(BrandLineage), B(BrandGroup), A(Ancestral).

Notes

  • System defined on object creation
  • Can be modified only by System
  • Maximum length is 255 bytes

Links

string PIN_FLD_CREATE_ACCESS

Create Access level for object. Valid values are O(BrandOwner), R(Root), N(Any).

Notes

  • System defined on object creation
  • Can be modified only by System
  • Maximum length is 255 bytes

Links

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

Links

enum PIN_FLD_ARCHIVE_STATUS

Archiving status for this event instance.

Notes

  • Can be specified on object creation
  • Can be modified

Links

array PIN_FLD_BAL_IMPACTS

Detail breakdown of balance impacts. Array element id is not significant.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_ACCOUNT_OBJ

Link to the account object whose balance is impacted as specified by AMOUNT field in this array element. If this balance is sponsored, then this field points to the sponsorer account.

Notes

Links

poid PIN_FLD_BAL_GRP_OBJ

Link to the balance_group object whose balance is impacted as specified by AMOUNT field in this array element. If this balance is sponsored, then this field points to the sponsorer's balance_group.

Notes

Links

decimal PIN_FLD_AMOUNT

The impact to the account balance. The value may be either positive or negative. The value is added to the PIN_FLD_CURRENT_BAL field of the PIN_FLD_BALANCES array in the /balance_group object specified by PIN_FLD_ACCOUNT_OBJ.

Notes

Links

decimal PIN_FLD_AMOUNT_DEFERRED

Tax-deferred amount. This is the amounton which tax will be calculated at the end ofbilling cycle or the time of Bill Now.The value will be zero when taxing immediatelyor when taxes do not apply. This field is setonly for currency resources.

Notes

Links

decimal PIN_FLD_AMOUNT_ORIG

This field reflect the secondary currency amount specified in a pre-rated incoming event. If not specified, the value is set to 0. Note that this is converted to the primary currency and the value is stored in PIN_FLD_AMOUNT.

Notes

Links

decimal PIN_FLD_DISCOUNT

The discount applied to this balance impact.

Notes

Links

int PIN_FLD_GL_ID

GLID associated with this balance impact. Don't care if 0.

Notes

Links

string PIN_FLD_IMPACT_CATEGORY

Name of the impact category that was used to generate this balance impact for the rated event.

Notes

Links

enum PIN_FLD_IMPACT_TYPE

Balance impact type - rated by Infranet rated-engine (0x1), pre-rated (0x2), taxed (0x4), Purchase Order (0x8), re-rated(0x20) and reverse_rated(0x40), discount(0x80), discount re-rated(0x100), integrate pre-rated(0x102), integrate re-rated(0x120), sharing(0x200), sharing re-rated(0x400), ECE re-rated(0x1000), ECE pre-rated(0x2000), ECE rated(0x4000).

Notes

Links

poid PIN_FLD_ITEM_OBJ

Link to the item object affected due to this event. Applies only to the balance array element that impact currency resources. Note that this may be different from the PIN_FLD_ITEM_OBJ field in the base /event class.

Notes

Links

decimal PIN_FLD_PERCENT

Proration percentage for cycle events. Tax percentage for tax balance impacts. 0 <= percent <= 1. See PIN_FLD_IMPACT_TYPE.

Notes

Links

poid PIN_FLD_PRODUCT_OBJ

Link to the product object used to generate this balance impact for rated event. For pre-rated events, this is set to NULL. The actual attributes of the product at the time of the event must be determined from the /event/price audit trail.

Notes

Links

decimal PIN_FLD_QUANTITY

Quantity applied - Number of units that were actually applied using this rate.

Notes

Links

poid PIN_FLD_RATE_OBJ

Link to the rate object that was used to generate this balance impact for rated events. For pre-rated and tax impacts, this is set to NULL. The actual attributes of the rate at the time of the event must be determined from the /event/price audit trail.

Notes

Links

string PIN_FLD_RATE_TAG

Description of the rate used. Same as the PIN_FLD_DESCR in /rate.

Notes

Links

int PIN_FLD_RESOURCE_ID

Numeric value of the resource that is impacted.

Notes

Links

int PIN_FLD_RESOURCE_ID_ORIG

Numeric value of the currency used to specify the amount in PIN_FLD_AMOUNT_ORIG field.

Notes

Links

string PIN_FLD_TAX_CODE

Tax code for the rate that was used. When taxes do not apply this field will be set to 0. See PIN_FLD_TAX_CODE in /config/glid.

Notes

Links

string PIN_FLD_TAX_EXEMPTION_CODE

The tax exemption code.

Notes

Links

poid PIN_FLD_OFFERING_OBJ

purchased_product or purchased_discount poid.

Notes

Links

string PIN_FLD_LINEAGE

Lineages of event fields if zonemap is used in rate plan selection. Has format (FieldName:Lineage|)* For example PIN_FLD_CALL.PIN_FLD_ANI:US;New York|

Notes

Links

string PIN_FLD_DISCOUNT_INFO

Discount related information from IntegRate.Loaded via IREL. Stored for informational purposes only.

Notes

Links

int PIN_FLD_RUM_ID

The id of the rum in the PIN_FLD_RUM_MAParray in the event structure.

Notes

Links

decimal PIN_FLD_OUTSTANDING_AMOUNT

This field represents the outstanding amount.

Notes

Links

int PIN_FLD_CURRENCY

Same as the currency of the account to which this event applies to. This is the same as the PIN_FLD_CURRENCY field of the account object which reflects the primary currency of the account.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_DESCR

User-defined description of the event.

Notes

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

Links

timestamp PIN_FLD_EFFECTIVE_T

Effective time of the event. If specified, this time will be used by the rating engine as the start and end time for rating the event.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_END_T

The time when event ended. This field is used to determine the billing cycle where the event should be included. For non-session events, this is the same as PIN_FLD_START_T. A value of 0 for session events implies a currently open session.

Notes

  • Required on object creation
  • Can be modified

Links

timestamp PIN_FLD_EARNED_START_T

Timestamp, when the event start earning. Value of Zero (default) indicate that the event start earning immediately.

Notes

  • Required on object creation
  • Can be modified

Links

timestamp PIN_FLD_EARNED_END_T

Timestamp, when the event is earned completely. Value of Zero (default) indicate that the event is earned immediately.

Notes

  • Required on object creation
  • Can be modified

Links

int PIN_FLD_EARNED_TYPE

Indicator for earnings type. Value of zero (default) indicates that the event is earned immediately. Value of 1 indicate that the event is earned over a period of time specified by PIN_FLD_EARNED_START_T and PIN_FLD_EARNED_END_T.

Notes

  • Can be specified on object creation
  • Cannot be modified

Links

string PIN_FLD_EVENT_NO

User-definable field for assigning event numbers.

Notes

  • Can be specified on object creation
  • Cannot be modified
  • Maximum length is 60 bytes

Links

int PIN_FLD_FLAGS

Reserved for future use.

Notes

  • Can be specified on object creation
  • Cannot be modified

Links

poid PIN_FLD_GROUP_OBJ

Link to the group object to which this event object is related to. Typically set when creating /event/group class events.

Notes

  • Can be specified on object creation
  • Cannot be modified

Links

poid PIN_FLD_ITEM_OBJ

Link to the item that this event belongs. Note that it is possible due to sponsorship billing, that some or all of the charges due to this event may affect items belonging to other accounts. See PIN_FLD_BAL_IMPACTS.

Notes

  • Can be specified on object creation
  • Can be modified

Links

array PIN_FLD_MONITOR_IMPACTS

Detail breakdown of monitor impacts. Array element id is not significant.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_ACCOUNT_OBJ

Link to the account object whose balance is impacted as specified by AMOUNT field in this array element. If this balance is sponsored, then this field points to the sponsorer account.

Notes

Links

poid PIN_FLD_BAL_GRP_OBJ

Link to the monitor balance group object whose balance is impacted as specified by AMOUNT field in this array element.

Notes

Links

decimal PIN_FLD_AMOUNT

The impact to the account balance. The value may be either positive or negative.

Notes

Links

int PIN_FLD_RESOURCE_ID

Numeric value of the resource that is impacted.

Notes

Links

string PIN_FLD_NAME

User-defined name of the event.

Notes

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

Links

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

Links

string PIN_FLD_PROVIDER_DESCR

When a part of the charges associated with this event needs to be remitted to another vendor, this field identifies the topic to which it relates to. The service provider (aka vendor) may be providing many topics. See /service/provider.

Notes

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

Links

poid PIN_FLD_PROVIDER_ID

When a part of the charges associated with this event needs to be remitted to another vendor, this field provides a link to the service provider object that represents the provider account.

Notes

  • Can be specified on object creation
  • Can be modified

Links

binstr PIN_FLD_PROVIDER_IPADDR

IP address of the service provider.

Notes

  • Can be specified on object creation
  • Cannot be modified
  • Maximum length is 160 bytes

Links

string PIN_FLD_RUM_NAME

Specifies which RUM was used to rate this event type. Must be a defined Candidate RUM for this event type.

Notes

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

Links

enum PIN_FLD_UNIT

Unit of the quantity applied.

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_TOD_MODE

TOD mode defines how TOD rates are applied to the event. Value can be START_TIME(0), END_TIME(1) or TIMED(2).

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_TIMEZONE_MODE

Timezone mode defines which timezone to use when apply TOD rates. Value can be EVENT(0), SERVER(1) or ACCOUNT(2).

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_TIMEZONE_ID

TimeZone ID of the event as String.

Notes

  • Can be specified on object creation
  • Can be modified
  • Maximum length is 64 bytes

Links

string PIN_FLD_RATED_TIMEZONE_ID

TimeZone ID actually used for rating.

Notes

  • Can be specified on object creation
  • Can be modified
  • Maximum length is 64 bytes

Links

timestamp PIN_FLD_TIMEZONE_ADJ_START_T

This timestamp is same as PIN_FLD_CREATED_T value

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_TIMEZONE_ADJ_END_T

This timestamp is same as PIN_FLD_CREATED_T value

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_MIN_QUANTITY

Minimum value that the RUM quantity is rounded to. Value smaller than min_quantity is rounded to min_quantity.

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_MIN_UNIT

Unit min_quantity is expressed in. Value can be NONE(0), SECOND(1), MINUTE(2), HOUR(3) or DAY(4).

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_INCR_QUANTITY

Incremental value to round RUM Quantity to. RUM Quantity is always rounded to an integral multiple of the Incr Quantity.

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_INCR_UNIT

Units that INCR_QUANTITY is specified in.

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_ROUNDING_MODE

Specifies how RUM quantity is rounded.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_NET_QUANTITY

Net quantity calculated after performing therounding.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_UNRATED_QUANTITY

Quantity which has not been rated.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_SERVICE_OBJ

Link to the service object for which the event is being logged. A NULL value means the event is not associated with any service.

Notes

  • Can be specified on object creation
  • Cannot be modified

Links

poid PIN_FLD_SESSION_OBJ

Link to the event object (/event/session) that represents the session within which this event occurred. NULL implies no session. This field is overloaded in certain situations. See /event/billing/adjustment and /event/billing/batch.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_RERATE_OBJ

Link to the event object if this event is re-rated NULL implies no re-rating. This field is overloaded in that a type-only poid means this event is a shadow event created for transfering sponsoree charges from one /item/sponsor to another.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_START_T

The time when the event started. For instantaneous events, the start and end times are identical. For session events, the start time indicates the time at which the session began.

Notes

  • Required on object creation
  • Cannot be modified

Links

string PIN_FLD_SYS_DESCR

System generated description - describes event programmatically. The actual value depends on the various event subtypes.

Notes

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

Links

array PIN_FLD_TAX_JURISDICTIONS

Array of tax details. Array element id is not significant. Each array element corresponds to a jurisdiction pair. If multiple rates were applicable in determining the event balance impacts, then it is possible to have many rows for the same jurisdiction.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_AMOUNT

This is the actual tax that is levied for this jurisdiction. For example, if the taxable amount is $900 (say, $100 was exempted from a gross $1000), then, this field would have a value of $90 if the tax rate is 10%.

Notes

Links

decimal PIN_FLD_AMOUNT_EXEMPT

Amount exempted from taxes. For example, if the purchase was for $1000 and the exemption for this jurisdiction was 10%, then this field would be $100.

Notes

Links

decimal PIN_FLD_AMOUNT_GROSS

Gross amount. Taxable after deducting exemptions.

Notes

Links

decimal PIN_FLD_AMOUNT_TAXED

Amount eligible for taxing. Same as gross less exemption unless when applying taxes on amounts that have been taxed already for a different jurisdiction. For ex, if gross is $1000, Fed tax is $100, with no exemptions, this field would be $1100.

Notes

Links

int PIN_FLD_ELEMENT_ID

Balance impact array element-id match.

Notes

Links

string PIN_FLD_NAME

The name of the jurisdiction. Includes jurisdiction names from top level upto this jurisdiction with semicolon separated pieces. For ex, for city tax, it would be 'US; CA; SANTA CLARA; SAN JOSE; 95123'.

Notes

Links

decimal PIN_FLD_PERCENT

Tax percent for the jurisdiction type. 0.0 <= percent <= 1.0. For example, for a 6% tax, the value stored will be 0.06.

Notes

Links

enum PIN_FLD_TYPE

Jurisdiction type. Federal (0), State (1), County (2), City (3), Secondary County (4), Secondary City (5), Territory (6), Secondary State (7), District (8), Secondary Federal (9), County District (10), City District (11) and Other (12).

Notes

Links

string PIN_FLD_TAX_LOCALES

Tax locales -- order origin;order accept;ship from;ship to. If the location of the company is available, it is appended to the above string. If a telephony event, then NPA/NXX or Geocode information is appended to the above string.

Notes

  • Can be specified on object creation
  • Can be modified
  • Maximum length is 1024 bytes

Links

int PIN_FLD_TAX_SUPPLIER

Record ID to the /config/tax_supplier object that is used to tax this event. NULL or 0 if there is no tax supplier specified and the default should be used.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_USERID

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

Notes

  • Can be specified on object creation
  • Cannot be modified

Links

string PIN_FLD_INVOICE_DATA

Cache the fields in /event that need to be handled in invoicing. This is to improve the performance in event search by moving some sub-table fields into this top level field.

Notes

  • Can be specified on object creation
  • Can be modified
  • Maximum length is 4000 bytes

Links

array PIN_FLD_RUM_MAP

This array will hold the information for the rums that have been used to rate the event. It is optional. The RUM_ID in the balance impacts array refers to the element id in this array.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_RUM_NAME

Specifies which RUM was used to rate this event. See /config/rum for details on rum.

Notes

Links

decimal PIN_FLD_NET_QUANTITY

Net quantity calculated after performing therounding.

Notes

Links

decimal PIN_FLD_UNRATED_QUANTITY

Quantity which has not been rated.

Notes

Links

array PIN_FLD_SUB_BAL_IMPACTS

Array to hold the sub_balances impacts for a particular balance group and its resource.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_BAL_GRP_OBJ

The balance group object these sub balance impact belongs to.

Notes

Links

int PIN_FLD_RESOURCE_ID

Numeric value of the resource that is impacted.

Notes

Links

array PIN_FLD_SUB_BALANCES

Array to hold the sub_balances impacts.

Notes

Links

enum PIN_FLD_SUBTYPE

This field represents the type of sub balance.Possible values are PIN_SUB_BAL_TYPE_DEFAULT(0), PIN_SUB_BAL_TYPE_LOAN(1).

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_AMOUNT

This field represents the amount impacted for this sub_balance entry.

Notes

  • Required on object creation
  • Can be modified

Links

timestamp PIN_FLD_VALID_FROM

The start date of this validity based balance, 0 indicate infinity.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_VALID_FROM_DETAILS

Detail of field PIN_FLD_VALID_FROM mode, offset and unit.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_VALID_TO

The end date of this validity based balance, 0 indicate infinity.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_VALID_TO_DETAILS

Detail of field PIN_FLD_VALID_TO mode, offset and unit.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_CONTRIBUTOR_STR

The contributor for this sub-balance counter.

Notes

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

Links

int PIN_FLD_ROLLOVER_DATA

Have rollover information stored, rollover type and rollover date.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_GRANTOR_OBJ

This field will contain the poid of /purchased_product or /purchased_discount or /product that was responsible creation of these sub-balances.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_CURRENT_BAL

This field represents the total available main balance for this resource.

Notes

Links

decimal PIN_FLD_AVAILABLE_LOAN_BALANCE

This field represents the loan balance available for this resource

Notes

Links

array PIN_FLD_MONITOR_SUB_BAL_IMPACTS

Array to hold the sub_balances impacts for a particular monitor balance group and its resource.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_BAL_GRP_OBJ

The Monitor balance group object these sub balance impact belongs to.

Notes

Links

int PIN_FLD_RESOURCE_ID

Numeric value of the resource that is impacted.

Notes

Links

array PIN_FLD_SUB_BALANCES

Array to hold the sub_balances impacts.

Notes

Links

enum PIN_FLD_SUBTYPE

This field represents the type of sub balance.Possible values are PIN_SUB_BAL_TYPE_DEFAULT(0), PIN_SUB_BAL_TYPE_LOAN(1).

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_AMOUNT

This field represents the amount impacted for this sub_balance entry.

Notes

  • Required on object creation
  • Can be modified

Links

timestamp PIN_FLD_VALID_FROM

The start date of this validity based balance, 0 indicate infinity.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_VALID_FROM_DETAILS

Detail of field PIN_FLD_VALID_FROM mode, offset and unit.

Notes

  • Can be specified on object creation
  • Can be modified

Links

timestamp PIN_FLD_VALID_TO

The end date of this validity based balance, 0 indicate infinity.

Notes

  • Can be specified on object creation
  • Can be modified

Links

int PIN_FLD_VALID_TO_DETAILS

Detail of field PIN_FLD_VALID_TO mode, offset and unit.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_CONTRIBUTOR_STR

The contributor for this sub-balance counter.

Notes

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

Links

poid PIN_FLD_GRANTOR_OBJ

This field will contain the poid of /purchased_product or /purchased_discount or /product that was responsible creation of these sub-balances.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_LOADER_BATCH_OBJ

The poid of the session which inserted this event.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_BATCH_ID

Batch Id this event belongs to.

Notes

  • Can be specified on object creation
  • Can be modified
  • Maximum length is 80 bytes

Links

string PIN_FLD_ORIGINAL_BATCH_ID

Mediation Batch Id this event belongs to.

Notes

  • Can be specified on object creation
  • Can be modified
  • Maximum length is 80 bytes

Links

string PIN_FLD_USAGE_TYPE

Type describes the specific customer related call scenario. E.g. Customer-to-customer call, birthdate call, closed-user-group calls, friends & family, etc.

Notes

  • Can be specified on object creation
  • Can be modified
  • Maximum length is 30 bytes

Links

string PIN_FLD_PROFILE_LABEL_LIST

This field contains list of ERA labels.

Notes

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

Links

string PIN_FLD_NAP_IP_ADDRESS

This field contains the IP Address of the client machine.

Notes

  • Can be specified on object creation
  • Cannot be modified
  • Maximum length is 80 bytes

Links

poid PIN_FLD_LINK_OBJ

The poid of the previous event

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_NETWORK_SESSION_ID

Field used by the system to record the session identifier for the event.

Notes

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

Links



SQL Mapping


Type Field Name Table Column Name
base-class /event event_t
poid PIN_FLD_POID poid*
timestamp PIN_FLD_CREATED_T created_t
timestamp PIN_FLD_MOD_T mod_t
string PIN_FLD_READ_ACCESS read_access
string PIN_FLD_WRITE_ACCESS wrtie_access
string PIN_FLD_CREATE_ACCESS create_access
poid PIN_FLD_ACCOUNT_OBJ account_obj*
enum PIN_FLD_ARCHIVE_STATUS archive_status
array PIN_FLD_BAL_IMPACTS event_bal_impacts_t
poid
PIN_FLD_ACCOUNT_OBJ
 		account_obj*
poid
PIN_FLD_BAL_GRP_OBJ
 		bal_grp_obj*
decimal
PIN_FLD_AMOUNT
 		amount
decimal
PIN_FLD_AMOUNT_DEFERRED
 		amount_deferred
decimal
PIN_FLD_AMOUNT_ORIG
 		amount_orig
decimal
PIN_FLD_DISCOUNT
 		discount
int
PIN_FLD_GL_ID
 		gl_id
string
PIN_FLD_IMPACT_CATEGORY
 		impact_category
enum
PIN_FLD_IMPACT_TYPE
 		impact_type
poid
PIN_FLD_ITEM_OBJ
 		item_obj*
decimal
PIN_FLD_PERCENT
 		percent
poid
PIN_FLD_PRODUCT_OBJ
 		product_obj*
decimal
PIN_FLD_QUANTITY
 		quantity
poid
PIN_FLD_RATE_OBJ
 		rate_obj*
string
PIN_FLD_RATE_TAG
 		rate_tag
int
PIN_FLD_RESOURCE_ID
 		resource_id
int
PIN_FLD_RESOURCE_ID_ORIG
 		resource_id_orig
string
PIN_FLD_TAX_CODE
 		tax_code
string
PIN_FLD_TAX_EXEMPTION_CODE
 		tax_exemption_code
poid
PIN_FLD_OFFERING_OBJ
 		offering_obj*
string
PIN_FLD_LINEAGE
 		lineage
string
PIN_FLD_DISCOUNT_INFO
 		discount_info
int
PIN_FLD_RUM_ID
 		rum_id
decimal
PIN_FLD_OUTSTANDING_AMOUNT
 		outstanding_amount
int PIN_FLD_CURRENCY currency
string PIN_FLD_DESCR descr
timestamp PIN_FLD_EFFECTIVE_T effective_t
timestamp PIN_FLD_END_T end_t
timestamp PIN_FLD_EARNED_START_T earned_start_t
timestamp PIN_FLD_EARNED_END_T earned_end_t
int PIN_FLD_EARNED_TYPE earned_type
string PIN_FLD_EVENT_NO event_no
int PIN_FLD_FLAGS flags
poid PIN_FLD_GROUP_OBJ group_obj*
poid PIN_FLD_ITEM_OBJ item_obj*
array PIN_FLD_MONITOR_IMPACTS event_monitor_impacts_t
poid
PIN_FLD_ACCOUNT_OBJ
 		account_obj*
poid
PIN_FLD_BAL_GRP_OBJ
 		bal_grp_obj*
decimal
PIN_FLD_AMOUNT
 		amount
int
PIN_FLD_RESOURCE_ID
 		resource_id
string PIN_FLD_NAME name
string PIN_FLD_PROGRAM_NAME program_name
string PIN_FLD_PROVIDER_DESCR provider_descr
poid PIN_FLD_PROVIDER_ID provider_id*
binstr PIN_FLD_PROVIDER_IPADDR provider_ipaddr
string PIN_FLD_RUM_NAME rum_name
enum PIN_FLD_UNIT unit
enum PIN_FLD_TOD_MODE tod_mode
enum PIN_FLD_TIMEZONE_MODE timezone_mode
string PIN_FLD_TIMEZONE_ID timezone_id
string PIN_FLD_RATED_TIMEZONE_ID rated_timezone_id
timestamp PIN_FLD_TIMEZONE_ADJ_START_T timezone_adj_start_t
timestamp PIN_FLD_TIMEZONE_ADJ_END_T timezone_adj_end_t
decimal PIN_FLD_MIN_QUANTITY min_quantity
enum PIN_FLD_MIN_UNIT min_unit
decimal PIN_FLD_INCR_QUANTITY incr_quantity
enum PIN_FLD_INCR_UNIT incr_unit
enum PIN_FLD_ROUNDING_MODE rounding_mode
decimal PIN_FLD_NET_QUANTITY net_quantity
decimal PIN_FLD_UNRATED_QUANTITY unrated_quantity
poid PIN_FLD_SERVICE_OBJ service_obj*
poid PIN_FLD_SESSION_OBJ session_obj*
poid PIN_FLD_RERATE_OBJ rerate_obj*
timestamp PIN_FLD_START_T start_t
string PIN_FLD_SYS_DESCR sys_descr
array PIN_FLD_TAX_JURISDICTIONS event_tax_jurisdictions_t
decimal
PIN_FLD_AMOUNT
 		amount
decimal
PIN_FLD_AMOUNT_EXEMPT
 		amount_exempt
decimal
PIN_FLD_AMOUNT_GROSS
 		amount_gross
decimal
PIN_FLD_AMOUNT_TAXED
 		amount_taxed
int
PIN_FLD_ELEMENT_ID
 		element_id
string
PIN_FLD_NAME
 		name
decimal
PIN_FLD_PERCENT
 		percent
enum
PIN_FLD_TYPE
 		type
string PIN_FLD_TAX_LOCALES tax_locales
int PIN_FLD_TAX_SUPPLIER tax_supplier
poid PIN_FLD_USERID userid*
string PIN_FLD_INVOICE_DATA invoice_data
array PIN_FLD_RUM_MAP event_rum_map_t
string
PIN_FLD_RUM_NAME
 		rum_name
decimal
PIN_FLD_NET_QUANTITY
 		net_quantity
decimal
PIN_FLD_UNRATED_QUANTITY
 		unrated_quantity
array PIN_FLD_SUB_BAL_IMPACTS event_sub_bal_imp_t
poid
PIN_FLD_BAL_GRP_OBJ
 		bal_grp_obj*
int
PIN_FLD_RESOURCE_ID
 		resource_id
array
PIN_FLD_SUB_BALANCES
 		event_sub_bals_t
enum
PIN_FLD_SUBTYPE
subtype
decimal
PIN_FLD_AMOUNT
amount
timestamp
PIN_FLD_VALID_FROM
valid_from
int
PIN_FLD_VALID_FROM_DETAILS
valid_from_details
timestamp
PIN_FLD_VALID_TO
valid_to
int
PIN_FLD_VALID_TO_DETAILS
valid_to_details
string
PIN_FLD_CONTRIBUTOR_STR
contributor
int
PIN_FLD_ROLLOVER_DATA
rollover_data
poid
PIN_FLD_GRANTOR_OBJ
grantor_obj*
decimal
PIN_FLD_CURRENT_BAL
 		current_bal
decimal
PIN_FLD_AVAILABLE_LOAN_BALANCE
 		available_loan_balance
array PIN_FLD_MONITOR_SUB_BAL_IMPACTS event_monitor_sub_bal_imp_t
poid
PIN_FLD_BAL_GRP_OBJ
 		bal_grp_obj*
int
PIN_FLD_RESOURCE_ID
 		resource_id
array
PIN_FLD_SUB_BALANCES
 		event_monitor_sub_bals_t
enum
PIN_FLD_SUBTYPE
subtype
decimal
PIN_FLD_AMOUNT
amount
timestamp
PIN_FLD_VALID_FROM
valid_from
int
PIN_FLD_VALID_FROM_DETAILS
valid_from_details
timestamp
PIN_FLD_VALID_TO
valid_to
int
PIN_FLD_VALID_TO_DETAILS
valid_to_details
string
PIN_FLD_CONTRIBUTOR_STR
contributor
poid
PIN_FLD_GRANTOR_OBJ
grantor_obj*
poid PIN_FLD_LOADER_BATCH_OBJ loader_batch_obj*
string PIN_FLD_BATCH_ID batch_id
string PIN_FLD_ORIGINAL_BATCH_ID original_batch_id
string PIN_FLD_USAGE_TYPE usage_type
string PIN_FLD_PROFILE_LABEL_LIST profile_label_list
string PIN_FLD_NAP_IP_ADDRESS cli_ipaddr
poid PIN_FLD_LINK_OBJ link_obj*
string PIN_FLD_NETWORK_SESSION_ID network_session_id
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