Copyright © 2024, Oracle and/or its affiliates.
Field Index SQL Mapping

Class /plan

A plan packages what you are offering the customer (the service) with how you are charging them for it (the deal). The charge details are themselves defined in the products. It serves as a template for new or existing customer accounts. For example, you might offer one service with two different ways of charging for it, each defined in a separate deal. When you create the plan, you choose which of the deals to include in the plan. In almost all cases, plans include services. By including services in plans, the customer creates their service login name and password when they register. The only time you might not include a service in a plan is if the plan contains only account-level products and deals. Plans further simplify the choices presented to customers. Typically, plans are used to register new customers. However, they can also be used to add services and deals to existing accounts.

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.

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
poid PIN_FLD_DEAL_OBJ
string PIN_FLD_DESCR
int PIN_FLD_FLAGS
array PIN_FLD_RULES
enum
array PIN_FLD_LIMIT
decimal
int
decimal
int
int
string
int
string
array PIN_FLD_BAL_INFO
string
array
enum
array
decimal
int
decimal
int
int
string
int
string
string PIN_FLD_NAME
string PIN_FLD_CODE
array PIN_FLD_SERVICES
poid
poid
int
int
string
array
poid
enum
poid PIN_FLD_SUBSCRIPTION_TERMS_OBJ
poid PIN_FLD_ATTRIBUTE_OBJ


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 account object for which this object was created.

Notes

  • Required on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

poid PIN_FLD_DEAL_OBJ

Link to the deal object with 'account only, no services' purchase level to set-up account level products. See PIN_FLD_PERMITTED in /deal. Note that there can be only one account-level deal offered in a single plan.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

string PIN_FLD_DESCR

Plan description.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.
  • Maximum length is 1023 bytes

Links

int PIN_FLD_FLAGS

Bitwise-ORed flags. Currently, used to force creation of the on-demand bill at the time of the account creation. Can be set by the CSR in the Pricing tool. See pin_price.h.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

array PIN_FLD_RULES

Array of consumption rules. The resource for which the consumption rule is to be assigned is used as the array element id.

Notes

  • Can be specified on object creation
  • Can be modified

Links

enum PIN_FLD_CONSUMPTION_RULE

Consumption rule to be applied on the resource. Possible values are EST(1), LST(2), EET(3), LET(4), ESTLET(5), ESTEET(6), LSTEET(7), LSTLET(8), EETEST(9), EETLST(10), LETEST(11), LETLST(12).

Notes

Links

array PIN_FLD_LIMIT

Array of credit limits to be set-up as part of this plan when creating accounts. The resource for which the credit limit is to be assigned is used as the array element id.

Notes

  • Can be specified on object creation
  • Can be modified

Links

decimal PIN_FLD_CREDIT_FLOOR

Baseline for calculating percentage for threshold triggers. See PIN_FLD_CREDIT_FLOOR in the PIN_FLD_PROFILES of /config/credit_profile.

Notes

Links

int PIN_FLD_DYNAMIC_CREDIT_FLOOR

When this flag is set to 0, existing CREDIT FLOOR will be permitted for threshold check. When this flag is set to 1, dynamically update credit floor for a given period of time.

Notes

Links

decimal PIN_FLD_CREDIT_LIMIT

The maximum amount of this resource that a customer can owe. By default, the limit is set to 0. If you don't want a limit for the resource, but you want to use the resource, set a credit limit that can't be reached, for example, 1000000.

Notes

Links

int PIN_FLD_OVERRIDE_CREDIT_LIMIT

Flag to determine to either consider or not consider the credit limit. If flag is 0 (which is default), then credit limit will be set based on rating modes. If the flag is 0x01 (PIN_RATE_FLG_OVERRIDE_CREDIT_LIMIT), then credit limit will be overriden.

Notes

Links

int PIN_FLD_CREDIT_THRESHOLDS

Percentage threshold value. Bit flags for triggering when resource balance crosses a boundary when increasing in value. See PIN_FLD_CREDIT_THRESHOLDS in the PIN_FLD_PROFILES of /config/credit_profile.

Notes

Links

string PIN_FLD_CREDIT_THRESHOLDS_FIXED

Fixed threshold value when resource balance crosses a boundary when increasing in value. See PIN_FLD_CREDIT_THRESHOLDS_FIXED in the PIN_FLD_PROFILES of /config/credit_profile.

Notes

Links

int PIN_FLD_LOAN_THRESHOLDS

Percentage threshold value.See PIN_FLD_LOAN_THRESHOLDS in the PIN_FLD_PROFILES of /config/credit_profile.

Notes

Links

string PIN_FLD_LOAN_THRESHOLDS_FIXED

Fixed threshold value when resource balance crosses a boundary when increasing in value. See PIN_FLD_LOAN_THRESHOLDS_FIXED in the PIN_FLD_PROFILES of /config/credit_profile.

Notes

Links

array PIN_FLD_BAL_INFO

Array of balance group info set-up as part of this plan when creating accounts. The resource limits will be specified using the PIN_FLD_LIMIT array.

Notes

  • Can be specified on object creation
  • Can be modified

Links

string PIN_FLD_NAME

Label for the balance group.

Notes

Links

array PIN_FLD_RULES

Array of consumption rules. The resource for which the consumption rule is to be assigned is used as the array element id.

Notes

Links

enum PIN_FLD_CONSUMPTION_RULE

Consumption rule to be applied on the resource. Possible values are EST(1), LST(2), EET(3), LET(4), ESTLET(5), ESTEET(6), LSTEET(7), LSTLET(8), EETEST(9), EETLST(10), LETEST(11), LETLST(12).

Notes

  • Required on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

array PIN_FLD_LIMIT

Array of credit limits to be set-up as part of this plan when creating accounts. The resource for which the credit limit is to be assigned is used as the array element id.

Notes

Links

decimal PIN_FLD_CREDIT_FLOOR

Baseline for calculating percentage for threshold triggers. See PIN_FLD_CREDIT_FLOOR in the PIN_FLD_PROFILES of /config/credit_profile.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

int PIN_FLD_DYNAMIC_CREDIT_FLOOR

When this flag is set to 0, existing CREDIT FLOOR will be permitted for threshold check. When this flag is set to 1, dynamically update credit floor for a given period of time.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

decimal PIN_FLD_CREDIT_LIMIT

The maximum amount of this resource that a customer can owe. By default, the limit is set to 0. If you don't want a limit for the resource, but you want to use the resource, set a credit limit that can't be reached, for example, 1000000.

Notes

  • Required on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

int PIN_FLD_OVERRIDE_CREDIT_LIMIT

Flag to determine to either consider or not consider the credit limit. If flag is 0 (which is default), then credit limit will be set based on rating modes. If the flag is 0x01 (PIN_RATE_FLG_OVERRIDE_CREDIT_LIMIT), then credit limit will be overriden.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

int PIN_FLD_CREDIT_THRESHOLDS

Percentage threshold value.Bit flags for triggering when resource balance crosses a boundary when increasing in value. See PIN_FLD_CREDIT_THRESHOLDS in the PIN_FLD_PROFILES of /config/credit_profile.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

string PIN_FLD_CREDIT_THRESHOLDS_FIXED

Fixed threshold value when resource balance crosses a boundary when increasing in value. See PIN_FLD_CREDIT_THRESHOLDS_FIXED in the PIN_FLD_PROFILES of /config/credit_profile.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.
  • Maximum length is 255 bytes

Links

int PIN_FLD_LOAN_THRESHOLDS

Percentage threshold value.See PIN_FLD_LOAN_THRESHOLDS in the PIN_FLD_PROFILES of /config/credit_profile.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

string PIN_FLD_LOAN_THRESHOLDS_FIXED

Fixed threshold value when resource balance crosses a boundary when increasing in value. See PIN_FLD_LOAN_THRESHOLDS_FIXED in the PIN_FLD_PROFILES of /config/credit_profile.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.
  • Maximum length is 255 bytes

Links

string PIN_FLD_NAME

Name of the plan object. Assumed to be unique across all plans by the Pricing Tool.

Notes

  • Required on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.
  • Maximum length is 255 bytes

Links

string PIN_FLD_CODE

Code of the plan object. Assumed to be unique across all plans by the Pricing Tool. Relevant if PDC is enabled

Notes

  • Required on object creation
  • Cannot be modified
  • Audit trail is created automatically when this field is modified.
  • Maximum length is 255 bytes

Links

array PIN_FLD_SERVICES

Array of service specific information.These services need to be set up when the plan is purchased. There may be multiple elements for each service if many deals related to that service are being packaged together. Array element id is not significant.

Notes

  • Can be specified on object creation
  • Can be modified

Links

poid PIN_FLD_DEAL_OBJ

Link to the service-level deal object to be purchased.

Notes

Links

poid PIN_FLD_SERVICE_OBJ

Partial poid of service object to create. The 'type' and 'database' sub-fields are used in the creation.

Notes

Links

int PIN_FLD_BAL_INFO_INDEX

The index of the balance group which is to be assigned to the service. A value of 0 in this field indicates that the service is assigned the default balance group for the account. Other values will point to an array element in the PIN_FLD_BAL_INFO array indicating that a new balance group will be created for this service. If one or more services point to the same array index, it means that these services are to share the same balance group.

Notes

Links

int PIN_FLD_SUBSCRIPTION_INDEX

The index of the subscription service which is to be assigned to the service. This index will point to an array element in the PIN_FLD_SERVICES array. The current service will then become the member service of the subscription service. If one or more services point to the same array index, it means that these services are the member services of the same subscription service. If this field is ommited then this service is not a member service. Any subscription service can not be a member service of other subscription service.

Notes

Links

string PIN_FLD_SERVICE_ID

User defined name for the service. The Pricing Tool relies on this name being unique across all services defined in the plan.

Notes

Links

array PIN_FLD_DEALS

List of optional/required deals for each service type.

Notes

Links

poid PIN_FLD_DEAL_OBJ

Member of the deal set for a particular service.

Notes

  • Required on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

enum PIN_FLD_TYPE

Denotes if the deal is optional or required.1 = Required,0 = Optional.

Notes

  • Required on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

poid PIN_FLD_SUBSCRIPTION_TERMS_OBJ

Link to the subscription_terms object.

Notes

  • Can be specified on object creation
  • Can be modified
  • Audit trail is created automatically when this field is modified.

Links

poid PIN_FLD_ATTRIBUTE_OBJ

POID of the offer attribute group object.

Notes

  • Can be specified on object creation
  • Can be modified

Links



SQL Mapping


Type Field Name Table Column Name
base-class /plan plan_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*
poid PIN_FLD_DEAL_OBJ deal_obj*
string PIN_FLD_DESCR descr
int PIN_FLD_FLAGS flags
array PIN_FLD_RULES plan_consumption_rules_t
enum
PIN_FLD_CONSUMPTION_RULE
 		consumption_rule
array PIN_FLD_LIMIT plan_limit_t
decimal
PIN_FLD_CREDIT_FLOOR
 		credit_floor
int
PIN_FLD_DYNAMIC_CREDIT_FLOOR
 		dynamic_credit_floor
decimal
PIN_FLD_CREDIT_LIMIT
 		credit_limit
int
PIN_FLD_OVERRIDE_CREDIT_LIMIT
 		override_credit_limit
int
PIN_FLD_CREDIT_THRESHOLDS
 		credit_thresholds
string
PIN_FLD_CREDIT_THRESHOLDS_FIXED
 		credit_thresholds_fixed
int
PIN_FLD_LOAN_THRESHOLDS
 		loan_thresholds
string
PIN_FLD_LOAN_THRESHOLDS_FIXED
 		loan_thresholds_fixed
array PIN_FLD_BAL_INFO bal_info_t
string
PIN_FLD_NAME
 		name
array
PIN_FLD_RULES
 		bal_info_consumption_rules_t
enum
PIN_FLD_CONSUMPTION_RULE
consumption_rule
array
PIN_FLD_LIMIT
 		bal_info_limit_t
decimal
PIN_FLD_CREDIT_FLOOR
credit_floor
int
PIN_FLD_DYNAMIC_CREDIT_FLOOR
dynamic_credit_floor
decimal
PIN_FLD_CREDIT_LIMIT
credit_limit
int
PIN_FLD_OVERRIDE_CREDIT_LIMIT
override_credit_limit
int
PIN_FLD_CREDIT_THRESHOLDS
credit_thresholds
string
PIN_FLD_CREDIT_THRESHOLDS_FIXED
credit_thresholds_fixed
int
PIN_FLD_LOAN_THRESHOLDS
loan_thresholds
string
PIN_FLD_LOAN_THRESHOLDS_FIXED
loan_thresholds_fixed
string PIN_FLD_NAME name
string PIN_FLD_CODE code
array PIN_FLD_SERVICES plan_services_t
poid
PIN_FLD_DEAL_OBJ
 		deal_obj*
poid
PIN_FLD_SERVICE_OBJ
 		service_obj*
int
PIN_FLD_BAL_INFO_INDEX
 		bal_info_index
int
PIN_FLD_SUBSCRIPTION_INDEX
 		subscription_index
string
PIN_FLD_SERVICE_ID
 		service_id
array
PIN_FLD_DEALS
 		plan_services_deals_t
poid
PIN_FLD_DEAL_OBJ
deal_obj*
enum
PIN_FLD_TYPE
type
poid PIN_FLD_SUBSCRIPTION_TERMS_OBJ subscription_terms_obj*
poid PIN_FLD_ATTRIBUTE_OBJ attribute_obj*
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