index

Package sb_edi_header_rules

This package provides the support subprograms for the EDI Header API (sb_edi_header).
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         shbhead.shbhead_dcmt_seqno%TYPE,
                            p_id_date_key        shbhead.shbhead_id_date_key%TYPE,
                            p_id_doc_key         shbhead.shbhead_id_doc_key%TYPE,
                            p_id_edi_key         shbhead.shbhead_id_edi_key%TYPE,
                            p_id_tporg           shbhead.shbhead_id_tporg%TYPE,
                            p_pidm               shbhead.shbhead_pidm%TYPE,
                            p_xset_code          shbhead.shbhead_xset_code%TYPE,
                            p_ackkey_t           shbhead.shbhead_ackkey_t%TYPE,
                            p_send_date          shbhead.shbhead_send_date%TYPE,
                            p_send_time          shbhead.shbhead_send_time%TYPE,
                            p_stim_code          shbhead.shbhead_stim_code%TYPE,
                            p_xprp_code          shbhead.shbhead_xprp_code%TYPE,
                            p_xrsn_code          shbhead.shbhead_xrsn_code%TYPE,
                            p_sid_ssnum          shbhead.shbhead_sid_ssnum%TYPE,
                            p_sid_agency_num     shbhead.shbhead_sid_agency_num%TYPE,
                            p_sid_agency_desc    shbhead.shbhead_sid_agency_desc%TYPE,
                            p_dob_qual           shbhead.shbhead_dob_qual%TYPE,
                            p_dob_date_code      shbhead.shbhead_dob_date_code%TYPE,
                            p_gender             shbhead.shbhead_gender%TYPE,
                            p_marital            shbhead.shbhead_marital%TYPE,
                            p_ethnic             shbhead.shbhead_ethnic%TYPE,
                            p_citizen            shbhead.shbhead_citizen%TYPE,
                            p_home_cntry         shbhead.shbhead_home_cntry%TYPE,
                            p_dcmt_image         shbhead.shbhead_dcmt_image%TYPE,
                            p_xml_transcript     shbhead.shbhead_xml_transcript%TYPE,
                            p_user_id            shbhead.shbhead_user_id%TYPE DEFAULT gb_common.f_sct_user,
                            p_data_origin        shbhead.shbhead_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 the parameters.

Parameters
p_operation_type   Type of DML operation: create, update, delete. NUMBER Required.
p_dcmt_seqno   EDI document ID number. NUMBER(8) Required Key.
p_id_date_key   EDI document date code. NUMBER(6) Required.
p_id_doc_key   EDI document type code. NUMBER(3) Required.
p_id_edi_key   EDI document key. VARCHAR2(35) Required.
p_id_tporg   EDI document key item. VARCHAR2(8) Required.
p_pidm   EDI document association. NUMBER(8).
p_xset_code   EDI transaction Set code. VARCHAR2(2).
p_ackkey_t   EDI acknowledgement key. VARCHAR2(9).
p_send_date   EDI send date. VARCHAR2(6).
p_send_time   EDI send time. VARCHAR2(6).
p_stim_code   EDI time code. VARCHAR2(2).
p_xprp_code   EDI transcript purpose code. VARCHAR2(2).
p_xrsn_code   EDI reason for sending transcript. VARCHAR2(3).
p_sid_ssnum   EDI student ID (SSN). VARCHAR2(9).
p_sid_agency_num   EDI student ID (agency number). VARCHAR2(30).
p_sid_agency_desc   EDI description of student ID. VARCHAR2(80).
p_dob_qual   EDI date of birth qualifier. VARCHAR2(3).
p_dob_date_code   EDI date of birth. VARCHAR2(8).
p_gender   EDI gender or sex. VARCHAR2(1).
p_marital   EDI marital status code. VARCHAR2(1).
p_ethnic   EDI ethnic code. VARCHAR2(1).
p_citizen   EDI citizenship status. VARCHAR2(2).
p_home_cntry   EDI home country code. VARCHAR2(3).
p_dcmt_image   Text image of transcript. LONG.
p_xml_transcript   XML transcript as sent by the institution. CLOB.
p_user_id   Oracle ID of the user who changed the record. VARCHAR2(30).
p_data_origin   Source system that created or updated the row. VARCHAR2(30).
p_internal_record_id   Database ROWID. VARCHAR2(18) Required.

p_validate 

PROCEDURE p_validate(p_dcmt_seqno      shbhead.shbhead_dcmt_seqno%TYPE,
                     p_id_date_key     shbhead.shbhead_id_date_key%TYPE,
                     p_id_doc_key      shbhead.shbhead_id_doc_key%TYPE,
                     p_id_edi_key      shbhead.shbhead_id_edi_key%TYPE,
                     p_id_tporg        shbhead.shbhead_id_tporg%TYPE,
                     p_pidm            shbhead.shbhead_pidm%TYPE DEFAULT NULL,
                     p_xset_code       shbhead.shbhead_xset_code%TYPE DEFAULT NULL,
                     p_ackkey_t        shbhead.shbhead_ackkey_t%TYPE DEFAULT NULL,
                     p_send_date       shbhead.shbhead_send_date%TYPE DEFAULT NULL,
                     p_send_time       shbhead.shbhead_send_time%TYPE DEFAULT NULL,
                     p_stim_code       shbhead.shbhead_stim_code%TYPE DEFAULT NULL,
                     p_xprp_code       shbhead.shbhead_xprp_code%TYPE DEFAULT NULL,
                     p_xrsn_code       shbhead.shbhead_xrsn_code%TYPE DEFAULT NULL,
                     p_sid_ssnum       shbhead.shbhead_sid_ssnum%TYPE DEFAULT NULL,
                     p_sid_agency_num  shbhead.shbhead_sid_agency_num%TYPE DEFAULT NULL,
                     p_sid_agency_desc shbhead.shbhead_sid_agency_desc%TYPE DEFAULT NULL,
                     p_dob_qual        shbhead.shbhead_dob_qual%TYPE DEFAULT NULL,
                     p_dob_date_code   shbhead.shbhead_dob_date_code%TYPE DEFAULT NULL,
                     p_gender          shbhead.shbhead_gender%TYPE DEFAULT NULL,
                     p_marital         shbhead.shbhead_marital%TYPE DEFAULT NULL,
                     p_ethnic          shbhead.shbhead_ethnic%TYPE DEFAULT NULL,
                     p_citizen         shbhead.shbhead_citizen%TYPE DEFAULT NULL,
                     p_home_cntry      shbhead.shbhead_home_cntry%TYPE DEFAULT NULL,
                     p_dcmt_image      shbhead.shbhead_dcmt_image%TYPE DEFAULT NULL,
                     p_xml_transcript  shbhead.shbhead_xml_transcript%TYPE DEFAULT NULL,
                     p_user_id         shbhead.shbhead_user_id%TYPE DEFAULT gb_common.f_sct_user,
                     p_data_origin     shbhead.shbhead_data_origin%TYPE DEFAULT NULL);

Validates all the data in the record.

Parameters
p_dcmt_seqno   EDI document ID number. NUMBER(8) Required Key.
p_id_date_key   EDI document date code. NUMBER(6) Required.
p_id_doc_key   EDI document type code. NUMBER(3) Required.
p_id_edi_key   EDI document key. VARCHAR2(35) Required.
p_id_tporg   EDI document key item. VARCHAR2(8) Required.
p_pidm   EDI document association. NUMBER(8).
p_xset_code   EDI transaction set code. VARCHAR2(2).
p_ackkey_t   EDI acknowledgement key. VARCHAR2(9).
p_send_date   EDI send date. VARCHAR2(6).
p_send_time   EDI send time. VARCHAR2(6).
p_stim_code   EDI time code. VARCHAR2(2).
p_xprp_code   EDI transcript purpose code. VARCHAR2(2).
p_xrsn_code   EDI reason for sending transcript. VARCHAR2(3).
p_sid_ssnum   EDI student ID (SSN). VARCHAR2(9).
p_sid_agency_num   EDI student ID (agency number). VARCHAR2(30).
p_sid_agency_desc   EDI description of student ID. VARCHAR2(80).
p_dob_qual   EDI date of birth qualifier. VARCHAR2(3).
p_dob_date_code   EDI date of birth. VARCHAR2(8).
p_gender   EDI gender or sex. VARCHAR2(1).
p_marital   EDI marital status code. VARCHAR2(1).
p_ethnic   EDI ethnic code. VARCHAR2(1).
p_citizen   EDI citizenship status. VARCHAR2(2).
p_home_cntry   EDI home country code. VARCHAR2(3).
p_dcmt_image   Text image of transcript. LONG.
p_xml_transcript   XML transcript as sent by the institution. CLOB.
p_user_id   Oracle ID of the user who changed the record. VARCHAR2(30).
p_data_origin   Source system that created or updated the row. VARCHAR2(30).