Results for “vs_ca_month”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

IGS_FI_PP_INSTLMNTS_V is an Oracle E-Business Suite view owned by the APPS schema and defined in the Student Systems (IGS) product family, specifically within the Financials module. It presents installment-level detail for student payment plans. Each row in the view corresponds to a single installment on a student's payment plan, exposing the schedule day, month, year, due date, installment amount, due amount, and penalty indicator alongside standard Oracle who-columns and concurrent program audit columns.

The view's principal functional contribution is the resolution of the DUE_MONTH_CODE into its descriptive meaning. Rather than returning a raw lookup code, the view joins to the lookup values table so that consumers receive a human-readable month description. This makes the view suitable for operational reporting, disbursement or receivables reconciliation, and interfaces where a decoded month is required without a further lookup call. Because it joins a transactional installment table to a lookup table, the view behaves as a read-only projection over the payment plan schedule and should not be treated as an updatable entity.

Underlying Base Objects

The view is defined over two base objects:

• IGS_FI_PP_INSTLMNTS PPIN — the primary installment table holding the payment plan schedule rows, including the installment identifier, the parent student plan identifier, line numbering, the due day/month code/year, the computed due date, amount fields, and the penalty flag.
• IGS_LOOKUP_VALUES LKP — the lookup values table, filtered to LOOKUP_TYPE = 'VS_CA_MONTH', which supplies the decoded month meaning for the due month code. This lookup type is the origin of the vs_ca_month search term that surfaced this object.

The view is joined on PPIN.DUE_MONTH_CODE = LKP.LOOKUP_CODE, with the lookup set restricted to the VS_CA_MONTH lookup type. The relationship between the two is therefore a lookup validation relationship: every installment whose due month code has a matching enabled lookup value in VS_CA_MONTH is returned with its meaning. Rows whose due month code is null, or whose code has no matching lookup value, are excluded by the inner join semantics.

Key Columns

• ROWID — the unique row identifier for the underlying installment row; retained in the view definition to support direct row addressing.
• INSTALLMENT_ID — primary identifier of the installment line.
• STUDENT_PLAN_ID — identifier of the parent student payment plan, used to group installments under a single plan.
• INSTALLMENT_LINE_NUM — sequence number of the installment within the plan schedule.
• DUE_DAY, DUE_MONTH_CODE, DUE_YEAR — the decomposed due date components stored on the installment.
• MEANING — the decoded description of DUE_MONTH_CODE obtained from IGS_LOOKUP_VALUES for lookup type VS_CA_MONTH. This is the view's distinguishing column, driven by the vs_ca_month lookup type.
• DUE_DATE — the actual due date for the installment, most directly used in aging and collection logic.
• INSTALLMENT_AMT — the scheduled amount for the installment.
• DUE_AMT — the amount currently due.
• PENALTY_FLAG — indicates whether penalty processing applies to the installment.
• CREATED_BY, CREATION_DATE, LAST_UPDATE_DATE, LAST_UPDATED_BY, LAST_UPDATE_LOGIN — standard Oracle audit who-columns.
• REQUEST_ID, PROGRAM_APPLICATION_ID, PROGRAM_ID, PROGRAM_UPDATE_DATE — concurrent program audit columns identifying the process that created or last updated the row.

Common Use Cases and Queries

Typical uses include reporting the installment schedule for an individual student plan, reconciling scheduled versus due amounts, and extracting decoded monthly due information for downstream interfaces. Because the view decodes the month via lookup, it removes a manual join in reporting tools.

Retrieve the full schedule for a given student plan, ordered by line number:

SELECT installment_id, student_plan_id, installment_line_num, due_day, meaning, due_year, due_date, installment_amt, due_amt, penalty_flag FROM apps.igs_fi_pp_instlmnts_v WHERE student_plan_id = :plan_id ORDER BY installment_line_num;

List installments due within a period, filtered by the decoded month:

SELECT student_plan_id, installment_line_num, meaning, due_date, due_amt FROM apps.igs_fi_pp_instlmnts_v WHERE due_date BETWEEN :start_date AND :end_date AND penalty_flag = 'Y';

Verify that every due month code is properly set up in the VS_CA_MONTH lookup type. Because the view uses an inner join, an installment with an unmapped or null month code will not appear; the underlying table must be queried to detect such gaps. As the view is read-only and populated with concurrent program audit columns, it is best consumed through BI Publisher, Oracle Reports, or ad hoc SQL rather than as a data-entry surface.