index

Package sb_edi_acad_session_rules

This package provides the support subprograms for the EDI Academic Session API (sb_edi_acad_session).
For use with internal processing to produce the XML transcript.


Program units
p_register_entity   Registers the attribute value pairs to the message cache for delete operations.
p_register_entity   Registers the attribute/value pairs to the message cache for create and update operations.
p_validate   Validates all the data in the record.


p_register_entity

PROCEDURE p_register_entity(p_operation_type     NUMBER,
                            p_internal_record_id gb_common.internal_record_id_type);

Registers the attribute value pairs to the message cache for delete operations.
This signature uses the ROWID only for the delete operations.

Parameters
p_operation_type   Type of DML operation: create, update, delete. NUMBER Required.
p_internal_record_id   Database ROWID. VARCHAR2(18) Required.


p_register_entity

PROCEDURE p_register_entity(p_operation_type     NUMBER,
                            p_dcmt_seqno         shrases.shrases_dcmt_seqno%TYPE,
                            p_seqno              shrases.shrases_seqno%TYPE,
                            p_start_date         shrases.shrases_start_date%TYPE,
                            p_sess_no            shrases.shrases_sess_no%TYPE,
                            p_school_year        shrases.shrases_school_year%TYPE,
                            p_sntp_code          shrases.shrases_sntp_code%TYPE,
                            p_sess_name          shrases.shrases_sess_name%TYPE,
                            p_sbql_code          shrases.shrases_sbql_code%TYPE,
                            p_begin_date         shrases.shrases_begin_date%TYPE,
                            p_seql_code          shrases.shrases_seql_code%TYPE,
                            p_end_date           shrases.shrases_end_date%TYPE,
                            p_slvl_code          shrases.shrases_slvl_code%TYPE,
                            p_crql_code          shrases.shrases_crql_code%TYPE,
                            p_curr_code          shrases.shrases_curr_code%TYPE,
                            p_curr_name          shrases.shrases_curr_name%TYPE,
                            p_honr_code          shrases.shrases_honr_code%TYPE,
                            p_ovrd_code          shrases.shrases_ovrd_code%TYPE,
                            p_inst_name_ovrd     shrases.shrases_inst_name_ovrd%TYPE,
                            p_inql_code_ovrd     shrases.shrases_inql_code_ovrd%TYPE,
                            p_inst_code_ovrd     shrases.shrases_inst_code_ovrd%TYPE,
                            p_street_line1_ovrd  shrases.shrases_street_line1_ovrd%TYPE,
                            p_street_line2_ovrd  shrases.shrases_street_line2_ovrd%TYPE,
                            p_city_ovrd          shrases.shrases_city_ovrd%TYPE,
                            p_stat_code_ovrd     shrases.shrases_stat_code_ovrd%TYPE,
                            p_zip_ovrd           shrases.shrases_zip_ovrd%TYPE,
                            p_natn_code_ovrd     shrases.shrases_natn_code_ovrd%TYPE,
                            p_domestic_addr_ind  shrases.shrases_domestic_addr_ind%TYPE,
                            p_street_line3       shrases.shrases_street_line3%TYPE,
                            p_stateprovince      shrases.shrases_stateprovince%TYPE,
                            p_data_origin        shrases.shrases_data_origin%TYPE,
                            p_internal_record_id gb_common.internal_record_id_type);

Registers the attribute/value pairs to the message cache for create and update operations.
 
This signature registers all parameters.

Parameters
p_operation_type   Type of DML operation: create, update, delete. NUMBER Required.
p_dcmt_seqno   EDI document sequence number. NUMBER(8) Required Key.
p_seqno   EDI academic session sequence number. NUMBER(4) Required Key.
p_start_date   EDI session start month/year. VARCHAR2(6).
p_sess_no   EDI specific session number. NUMBER(3).
p_school_year   EDI K-12 school year. VARCHAR2(35).
p_sntp_code   EDI type of session. VARCHAR2(1).
p_sess_name   EDI name of session. VARCHAR2(35).
p_sbql_code   EDI format for date session began. VARCHAR2(3).
p_begin_date   EDI starting date. VARCHAR2(8).
p_seql_code   EDI format of ending date. VARCHAR2(3).
p_end_date   EDI ending date. VARCHAR2(8).
p_slvl_code   EDI student grade level. VARCHAR2(2).
p_crql_code   EDI curriculum code qualifier. VARCHAR2(2).
p_curr_code   EDI curriculum code. VARCHAR2(20).
p_curr_name   EDI name of curriculum. VARCHAR2(35).
p_honr_code   EDI honors or delinquency code. VARCHAR2(3).
p_ovrd_code   EDI override institution code. VARCHAR2(2).
p_inst_name_ovrd   EDI institution/agency. VARCHAR2(35).
p_inql_code_ovrd   EDI institution code qualifier. VARCHAR2(2).
p_inst_code_ovrd   EDI institution code. VARCHAR2(20).
p_street_line1_ovrd   EDI override institution address 1. VARCHAR2(35).
p_street_line2_ovrd   EDI override institution address 2. VARCHAR2(35).
p_city_ovrd   EDI override institution city. VARCHAR2(30).
p_stat_code_ovrd   EDI override institution state. VARCHAR2(2).
p_zip_ovrd   EDI override institution ZIP or postal code. VARCHAR2(9).
p_natn_code_ovrd   EDI override institution nation code. VARCHAR2(3).
p_domestic_addr_ind   Y if address is domestic. For PESCXML. VARCHAR2(1).
p_street_line3   Third address line. For PESCXML. VARCHAR2(35).
p_stateprovince   State or province name for an international address. For PESCXML. VARCHAR2(60).
p_data_origin   Source system that created or updated the data. VARCHAR2(30).
p_internal_record_id   Database ROWID. VARCHAR2(18) Required.


p_validate

PROCEDURE p_validate(p_dcmt_seqno        shrases.shrases_dcmt_seqno%TYPE,
                     p_seqno             shrases.shrases_seqno%TYPE,
                     p_start_date        shrases.shrases_start_date%TYPE DEFAULT NULL,
                     p_sess_no           shrases.shrases_sess_no%TYPE DEFAULT NULL,
                     p_school_year       shrases.shrases_school_year%TYPE DEFAULT NULL,
                     p_sntp_code         shrases.shrases_sntp_code%TYPE DEFAULT NULL,
                     p_sess_name         shrases.shrases_sess_name%TYPE DEFAULT NULL,
                     p_sbql_code         shrases.shrases_sbql_code%TYPE DEFAULT NULL,
                     p_begin_date        shrases.shrases_begin_date%TYPE DEFAULT NULL,
                     p_seql_code         shrases.shrases_seql_code%TYPE DEFAULT NULL,
                     p_end_date          shrases.shrases_end_date%TYPE DEFAULT NULL,
                     p_slvl_code         shrases.shrases_slvl_code%TYPE DEFAULT NULL,
                     p_crql_code         shrases.shrases_crql_code%TYPE DEFAULT NULL,
                     p_curr_code         shrases.shrases_curr_code%TYPE DEFAULT NULL,
                     p_curr_name         shrases.shrases_curr_name%TYPE DEFAULT NULL,
                     p_honr_code         shrases.shrases_honr_code%TYPE DEFAULT NULL,
                     p_ovrd_code         shrases.shrases_ovrd_code%TYPE DEFAULT NULL,
                     p_inst_name_ovrd    shrases.shrases_inst_name_ovrd%TYPE DEFAULT NULL,
                     p_inql_code_ovrd    shrases.shrases_inql_code_ovrd%TYPE DEFAULT NULL,
                     p_inst_code_ovrd    shrases.shrases_inst_code_ovrd%TYPE DEFAULT NULL,
                     p_street_line1_ovrd shrases.shrases_street_line1_ovrd%TYPE DEFAULT NULL,
                     p_street_line2_ovrd shrases.shrases_street_line2_ovrd%TYPE DEFAULT NULL,
                     p_city_ovrd         shrases.shrases_city_ovrd%TYPE DEFAULT NULL,
                     p_stat_code_ovrd    shrases.shrases_stat_code_ovrd%TYPE DEFAULT NULL,
                     p_zip_ovrd          shrases.shrases_zip_ovrd%TYPE DEFAULT NULL,
                     p_natn_code_ovrd    shrases.shrases_natn_code_ovrd%TYPE DEFAULT NULL,
                     p_domestic_addr_ind shrases.shrases_domestic_addr_ind%TYPE DEFAULT NULL,
                     p_street_line3      shrases.shrases_street_line3%TYPE DEFAULT NULL,
                     p_stateprovince     shrases.shrases_stateprovince%TYPE DEFAULT NULL,
                     p_data_origin       shrases.shrases_data_origin%TYPE DEFAULT NULL);

Validates all the data in the record.

Parameters
p_dcmt_seqno   EDI document sequence number. NUMBER(8) Required Key.
p_seqno   EDI academic session sequence number. NUMBER(4) Required Key.
p_start_date   EDI session start month/year. VARCHAR2(6).
p_sess_no   EDI specific session number. NUMBER(3).
p_school_year   EDI K-12 school year. VARCHAR2(35).
p_sntp_code   EDI type of session. VARCHAR2(1).
p_sess_name   EDI name of session. VARCHAR2(35).
p_sbql_code   EDI format for date session began. VARCHAR2(3).
p_begin_date   EDI starting date. VARCHAR2(8).
p_seql_code   EDI format of ending date. VARCHAR2(3).
p_end_date   EDI ending date. VARCHAR2(8).
p_slvl_code   EDI student grade level. VARCHAR2(2).
p_crql_code   EDI curriculum code qualifier. VARCHAR2(2).
p_curr_code   EDI curriculum code. VARCHAR2(20).
p_curr_name   EDI name of curriculum. VARCHAR2(35).
p_honr_code   EDI honors or delinquency code. VARCHAR2(3).
p_ovrd_code   EDI override institution code. VARCHAR2(2).
p_inst_name_ovrd   EDI institution/agency. VARCHAR2(35).
p_inql_code_ovrd   EDI institution code qualifier. VARCHAR2(2).
p_inst_code_ovrd   EDI institution code. VARCHAR2(20) Optional Key.
p_street_line1_ovrd   EDI override institution address 1. VARCHAR2(35).
p_street_line2_ovrd   EDI override institution address 2. VARCHAR2(35).
p_city_ovrd   EDI override institution city. VARCHAR2(30).
p_stat_code_ovrd   EDI override institution state. VARCHAR2(2).
p_zip_ovrd   EDI override institution ZIP or postal code. VARCHAR2(9).
p_natn_code_ovrd   EDI override institution nation code. VARCHAR2(3).
p_domestic_addr_ind   Y if address is domestic. For PESCXML. VARCHAR2(1).
p_street_line3   Third address line. For PESCXML. VARCHAR2(35).
p_stateprovince   State or province name for an international address. For PESCXML. VARCHAR2(60).
p_data_origin   Source system that created or updated the data. VARCHAR2(30).