index

Package sb_edi_doc_header_rules

This package provides the support subprograms for the EDI Document Header API (sb_edi_doc_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         shrhdr4.shrhdr4_dcmt_seqno%TYPE,
                            p_enty_code          shrhdr4.shrhdr4_enty_code%TYPE,
                            p_enty_name_1        shrhdr4.shrhdr4_enty_name_1%TYPE,
                            p_inql_code          shrhdr4.shrhdr4_inql_code%TYPE,
                            p_inst_code          shrhdr4.shrhdr4_inst_code%TYPE,
                            p_enty_name_2        shrhdr4.shrhdr4_enty_name_2%TYPE,
                            p_enty_name_3        shrhdr4.shrhdr4_enty_name_3%TYPE,
                            p_street_line1       shrhdr4.shrhdr4_street_line1%TYPE,
                            p_street_line2       shrhdr4.shrhdr4_street_line2%TYPE,
                            p_city               shrhdr4.shrhdr4_city%TYPE,
                            p_stat_code          shrhdr4.shrhdr4_stat_code%TYPE,
                            p_zip                shrhdr4.shrhdr4_zip%TYPE,
                            p_natn_code          shrhdr4.shrhdr4_natn_code%TYPE,
                            p_ctfn_code          shrhdr4.shrhdr4_ctfn_code%TYPE,
                            p_contact_name       shrhdr4.shrhdr4_contact_name%TYPE,
                            p_coql_code          shrhdr4.shrhdr4_coql_code%TYPE,
                            p_comm_no            shrhdr4.shrhdr4_comm_no%TYPE,
                            p_domestic_addr_ind  shrhdr4.shrhdr4_domestic_addr_ind%TYPE,
                            p_street_line3       shrhdr4.shrhdr4_street_line3%TYPE,
                            p_stateprovince      shrhdr4.shrhdr4_stateprovince%TYPE,
                            p_data_origin        shrhdr4.shrhdr4_data_origin%TYPE,
                            p_user_id            shrhdr4.shrhdr4_user_id%TYPE DEFAULT gb_common.f_sct_user,
                            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_enty_code   EDI-specific organizational entity. VARCHAR2(2) Required Key..
p_enty_name_1   EDI institutional/agency name. VARCHAR2(35).
p_inql_code   EDI institutional code qualifier. VARCHAR2(2).
p_inst_code   EDI institutional code. VARCHAR2(20).
p_enty_name_2   EDI continuation of name. VARCHAR2(35).
p_enty_name_3   EDI continuation of name. VARCHAR2(35).
p_street_line1   EDI institution address. VARCHAR2(35).
p_street_line2   EDI institution address. VARCHAR2(35).
p_city   EDI institution address. VARCHAR2(30).
p_stat_code   EDI institution address. VARCHAR2(2).
p_zip   EDI institution address. VARCHAR2(9).
p_natn_code   EDI institution address. VARCHAR2(3).
p_ctfn_code   EDI contact Function code. VARCHAR2(2).
p_contact_name   EDI contact name. VARCHAR2(35).
p_coql_code   EDI communication Number qualifier. VARCHAR2(2).
p_comm_no   EDI communication number. VARCHAR2(80).
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 row. VARCHAR2(30).
p_user_id   Oracle ID of the user who changed the record. VARCHAR2(30).
p_internal_record_id   Database ROWID. VARCHAR2(18) Required.

p_validate 

PROCEDURE p_validate(p_dcmt_seqno        shrhdr4.shrhdr4_dcmt_seqno%TYPE,
                     p_enty_code         shrhdr4.shrhdr4_enty_code%TYPE,
                     p_enty_name_1       shrhdr4.shrhdr4_enty_name_1%TYPE DEFAULT NULL,
                     p_inql_code         shrhdr4.shrhdr4_inql_code%TYPE DEFAULT NULL,
                     p_inst_code         shrhdr4.shrhdr4_inst_code%TYPE DEFAULT NULL,
                     p_enty_name_2       shrhdr4.shrhdr4_enty_name_2%TYPE DEFAULT NULL,
                     p_enty_name_3       shrhdr4.shrhdr4_enty_name_3%TYPE DEFAULT NULL,
                     p_street_line1      shrhdr4.shrhdr4_street_line1%TYPE DEFAULT NULL,
                     p_street_line2      shrhdr4.shrhdr4_street_line2%TYPE DEFAULT NULL,
                     p_city              shrhdr4.shrhdr4_city%TYPE DEFAULT NULL,
                     p_stat_code         shrhdr4.shrhdr4_stat_code%TYPE DEFAULT NULL,
                     p_zip               shrhdr4.shrhdr4_zip%TYPE DEFAULT NULL,
                     p_natn_code         shrhdr4.shrhdr4_natn_code%TYPE DEFAULT NULL,
                     p_ctfn_code         shrhdr4.shrhdr4_ctfn_code%TYPE DEFAULT NULL,
                     p_contact_name      shrhdr4.shrhdr4_contact_name%TYPE DEFAULT NULL,
                     p_coql_code         shrhdr4.shrhdr4_coql_code%TYPE DEFAULT NULL,
                     p_comm_no           shrhdr4.shrhdr4_comm_no%TYPE DEFAULT NULL,
                     p_domestic_addr_ind shrhdr4.shrhdr4_domestic_addr_ind%TYPE DEFAULT NULL,
                     p_street_line3      shrhdr4.shrhdr4_street_line3%TYPE DEFAULT NULL,
                     p_stateprovince     shrhdr4.shrhdr4_stateprovince%TYPE DEFAULT NULL,
                     p_data_origin       shrhdr4.shrhdr4_data_origin%TYPE DEFAULT NULL,
                     p_user_id           shrhdr4.shrhdr4_user_id%TYPE DEFAULT gb_common.f_sct_user);

Validates all the data in the record.

Parameters
p_dcmt_seqno   EDI document ID number. NUMBER(8) Required Key..
p_enty_code   EDI-specific organizational entity. VARCHAR2(2) Required Key..
p_enty_name_1   EDI institutional/agency name. VARCHAR2(35).
p_inql_code   EDI institutional code qualifier. VARCHAR2(2).
p_inst_code   EDI institutional code. VARCHAR2(20).
p_enty_name_2   EDI continuation of name. VARCHAR2(35).
p_enty_name_3   EDI continuation of name. VARCHAR2(35).
p_street_line1   EDI institution address. VARCHAR2(35).
p_street_line2   EDI institution address. VARCHAR2(35).
p_city   EDI institution address. VARCHAR2(30).
p_stat_code   EDI institution address. VARCHAR2(2).
p_zip   EDI institution address. VARCHAR2(9).
p_natn_code   EDI institution address. VARCHAR2(3).
p_ctfn_code   EDI contact Function code. VARCHAR2(2).
p_contact_name   EDI contact name. VARCHAR2(35).
p_coql_code   EDI communication number qualifier. VARCHAR2(2).
p_comm_no   EDI communication number. VARCHAR2(80).
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 row. VARCHAR2(30).
p_user_id   Oracle ID of the user who changed the record. VARCHAR2(30).