index

Package sb_mass_entry

This package provides the common business interface for the Mass Entry API (sb_mass_entry).
This has the PIDMs that were populated and processed for each mass entry session.The keys to the mass entry are the form name, user ID and date with timestamp initiated.The mass entry criteria include the search criteria used to build the population, along with the update criteria. Audit information is kept on the record for when processing was completed and the user ID that ran the update.

Program units
f_api_version   Returns the API version number.
f_exists   Checks if a record exists.
f_isequal   Compares two records for equality.
f_query_all   Selects all records for the entity.
f_query_one   Selects one record using the key.
f_query_by_rowid   Selects one record using the ROWID.
f_query_one_lock   Selects one record and locks it.
p_create   Creates a record.
p_delete   Deletes a record.
p_lock   Locks a record.
p_update   Updates a record.
p_remove_all_success   Delete all records.
p_update_all   Update all records.

Types
mass_entry_rec   Business Entity record type
mass_entry_ref   Entity cursor variable type
mass_entry_tab   Entity table type

Constants
M_ENTITY_NAME   Business Entity Name
M_BASE_TABLE_NAME   Base table name

M_ENTITY_NAME 

M_ENTITY_NAME        CONSTANT VARCHAR2(10) := 'MASS_ENTRY';

Business Entity Name

M_BASE_TABLE_NAME 

M_BASE_TABLE_NAME    CONSTANT VARCHAR2(7) := 'SORMAUD';

Base table name

mass_entry_rec 

TYPE mass_entry_rec IS RECORD (
  r_form_name               sormaud.sormaud_form_name%TYPE,
  r_add_user_id             sormaud.sormaud_add_user_id%TYPE,
  r_add_date                sormaud.sormaud_add_date%TYPE,
  r_pidm                    sormaud.sormaud_pidm%TYPE,
  r_seqno                   sormaud.sormaud_seqno%TYPE,
  r_manual_add_ind          sormaud.sormaud_manual_add_ind%TYPE,
  r_process_ind             sormaud.sormaud_process_ind%TYPE,
  r_update_cde              sormaud.sormaud_update_cde%TYPE,
  r_user_id                 sormaud.sormaud_user_id%TYPE,
  r_data_origin             sormaud.sormaud_data_origin%TYPE,
  r_term_code               sormaud.sormaud_term_code%TYPE,
  r_key_seqno               sormaud.sormaud_key_seqno%TYPE,
  r_key_text                sormaud.sormaud_key_text%TYPE,
  r_hold_cde                sormaud.sormaud_hold_cde%TYPE,
  r_msg                     sormaud.sormaud_msg%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

mass_entry_ref 

TYPE mass_entry_ref IS REF CURSOR RETURN mass_entry_rec;

Entity cursor variable type

mass_entry_tab 

TYPE mass_entry_tab IS TABLE OF mass_entry_rec INDEX BY BINARY_INTEGER;

Entity table type

f_api_version 

Function f_api_version RETURN PLS_INTEGER

Returns the API version number.

Returns
Version of the API signature. Changes only when the signature changes.

f_exists 

Function f_exists(p_form_name   sormaud.sormaud_form_name%TYPE,
                  p_add_user_id sormaud.sormaud_add_user_id%TYPE,
                  p_add_date    sormaud.sormaud_add_date%TYPE,
                  p_pidm        sormaud.sormaud_pidm%TYPE,
                  p_seqno       sormaud.sormaud_seqno%TYPE,
                  p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters
p_form_name   Mass entry form name. VARCHAR2(30) Required Key
p_add_user_id   ID of the user who initiated the mass entry. VARCHAR2(30) Required Key
p_add_date   Date and timestamp the mass entry was initiated. DATE Required Key
p_pidm   Unique identifier (PIDM) for the person selected or entered for the mass entry process. NUMBER(8) Required Key
p_seqno   A one up sequence number for each PIDM and mass entry form, add date and add user ID. NUMBER(2) Required Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

Returns
Y if found, otherwise N.

f_isequal 

Function f_isequal(rec_one mass_entry_rec, rec_two mass_entry_rec)
  RETURN VARCHAR2

Compares two records for equality.
Tests each field of rec_one against the corresponding field of rec_two. Two null values are considered equal.

Parameters
rec_one   The first record to compare. Type mass_entry_rec Required
rec_two   The second record to compare. Type mass_entry_rec Required

Returns
Y if all values in records are equal, otherwise N. Nulls match Nulls.

f_query_all 

Function f_query_all(p_form_name   sormaud.sormaud_form_name%TYPE,
                     p_add_user_id sormaud.sormaud_add_user_id%TYPE,
                     p_add_date    sormaud.sormaud_add_date%TYPE,
                     p_update_cde  sormaud.sormaud_update_cde%type,
                     p_process_ind sormaud.sormaud_process_ind%type)
  RETURN mass_entry_ref

Selects all records for the entity.

Parameters
p_form_name   Mass entry form name. VARCHAR2(30) Required Key
p_add_user_id   ID of the user who initiated the mass entry. VARCHAR2(30) Required Key
p_add_date   Date and timestamp the mass entry was initiated. DATE Required Key
p_update_cde   Value that indicates if the mass entry completed successfully (Y); partially successful (P); none of the updates were successful (F); or (N) for when the update process did not process the record. VARCHAR2(1) Required
p_process_ind   Y/N indicator for whether the record was selected to be process by the mass entry update procedure. VARCHAR2(1) Required

Returns
A cursor variable that will fetch a set of records.

f_query_one 

Function f_query_one(p_form_name   sormaud.sormaud_form_name%TYPE,
                     p_add_user_id sormaud.sormaud_add_user_id%TYPE,
                     p_add_date    sormaud.sormaud_add_date%TYPE,
                     p_pidm        sormaud.sormaud_pidm%TYPE,
                     p_seqno       sormaud.sormaud_seqno%TYPE)
  RETURN mass_entry_ref

Selects one record using the key.

Parameters
p_form_name   Mass entry form name. VARCHAR2(30) Required Key
p_add_user_id   ID of the user who initiated the mass entry. VARCHAR2(30) Required Key
p_add_date   Date and timestamp the mass entry was initiated. DATE Required Key
p_pidm   Unique identifier (PIDM) for the person selected or entered for the mass entry process. NUMBER(8) Required Key
p_seqno   A one up sequence number for each PIDM and mass entry form, add date and add user ID. NUMBER(2) Required Key

Returns
A cursor variable that will fetch exactly one record.

f_query_by_rowid 

Function f_query_by_rowid(p_rowid gb_common.internal_record_id_type)
  RETURN mass_entry_ref

Selects one record using the ROWID.

Parameters
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18) Required

Returns
A cursor variable that will fetch exactly one record.

f_query_one_lock 

Function f_query_one_lock(p_form_name   sormaud.sormaud_form_name%TYPE,
                          p_add_user_id sormaud.sormaud_add_user_id%TYPE,
                          p_add_date    sormaud.sormaud_add_date%TYPE,
                          p_pidm        sormaud.sormaud_pidm%TYPE,
                          p_seqno       sormaud.sormaud_seqno%TYPE,
                          p_rowid       gb_common.internal_record_id_type DEFAULT NULL)
  RETURN mass_entry_ref

Selects one record and locks it.

Parameters
p_form_name   Mass entry form name. VARCHAR2(30) Required Key
p_add_user_id   ID of the user who initiated the mass entry. VARCHAR2(30) Required Key
p_add_date   Date and timestamp the mass entry was initiated. DATE Required Key
p_pidm   Unique identifier (PIDM) for the person selected or entered for the mass entry process. NUMBER(8) Required Key
p_seqno   A one up sequence number for each PIDM and mass entry form, add date and add user ID. NUMBER(2) Required Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

Returns
A cursor variable for one record, locking the record.

p_create 

Procedure p_create(p_form_name      sormaud.sormaud_form_name%TYPE,
                   p_add_user_id    sormaud.sormaud_add_user_id%TYPE,
                   p_add_date       sormaud.sormaud_add_date%TYPE,
                   p_pidm           sormaud.sormaud_pidm%TYPE,
                   p_seqno          sormaud.sormaud_seqno%TYPE,
                   p_manual_add_ind sormaud.sormaud_manual_add_ind%TYPE,
                   p_process_ind    sormaud.sormaud_process_ind%TYPE,
                   p_update_cde     sormaud.sormaud_update_cde%TYPE,
                   p_user_id        sormaud.sormaud_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin    sormaud.sormaud_data_origin%TYPE,
                   p_term_code      sormaud.sormaud_term_code%TYPE DEFAULT NULL,
                   p_key_seqno      sormaud.sormaud_key_seqno%TYPE DEFAULT NULL,
                   p_key_text       sormaud.sormaud_key_text%TYPE DEFAULT NULL,
                   p_hold_cde       sormaud.sormaud_hold_cde%TYPE DEFAULT NULL,
                   p_msg            sormaud.sormaud_msg%TYPE DEFAULT NULL,
                   p_rowid_out      OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_form_name   Mass entry form name. VARCHAR2(30) Required Key
p_add_user_id   ID of the user who initiated the mass entry. VARCHAR2(30) Required Key
p_add_date   Date and timestamp the mass entry was initiated. DATE Required Key
p_pidm   Unique identifier (PIDM) for the person selected or entered for the mass entry process. NUMBER(8) Required Key
p_seqno   A one up sequence number for each PIDM and mass entry form, add date and add user ID. NUMBER(2) Required Key
p_manual_add_ind   Y/N indicator for whether the record was manually inserted on the mass entry form.  If the record was selected from the population selection process the value will be N for no. VARCHAR2(1) Required
p_process_ind   Y/N indicator for whether the record was selected to be process by the mass entry update procedure. VARCHAR2(1) Required
p_update_cde   Value that indicates if the mass entry completed successfully (Y); partially successful (P); none of the updates were successful (F); or (N) for when the update process did not process the record. VARCHAR2(1) Required
p_user_id   ID of the most recent user to create or update the record. VARCHAR2(30) Required
p_data_origin   Data origin of the insert or update to the record. VARCHAR2(30) Required
p_term_code   Term code for the mass entry host subject key. This  is the effective term for the learner, the admissions application term for the application, or blank for outcome records. VARCHAR2(6)
p_key_seqno   Key sequence number for the mass entry host subject key. This is the admissions application number for the application or the degree sequence number on the outcome records. NUMBER(2)
p_key_text   Key text value for the mass entry host subject key. This is the ceremony code for some of the graduation mass entry forms. VARCHAR2(30)
p_hold_cde   Y/N indicator for whether a hold exists for the person. VARCHAR2(1)
p_msg   Error messages returned from the mass entry processing. VARCHAR2(4000)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(p_form_name   sormaud.sormaud_form_name%TYPE,
                   p_add_user_id sormaud.sormaud_add_user_id%TYPE,
                   p_add_date    sormaud.sormaud_add_date%TYPE,
                   p_pidm        sormaud.sormaud_pidm%TYPE,
                   p_seqno       sormaud.sormaud_seqno%TYPE,
                   p_rowid       gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_form_name   Mass entry form name. VARCHAR2(30) Required Key
p_add_user_id   ID of the user who initiated the mass entry. VARCHAR2(30) Required Key
p_add_date   Date and timestamp the mass entry was initiated. DATE Required Key
p_pidm   Unique identifier (PIDM) for the person selected or entered for the mass entry process. NUMBER(8) Required Key
p_seqno   A one up sequence number for each PIDM and mass entry form, add date and add user ID. NUMBER(2) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(p_form_name   sormaud.sormaud_form_name%TYPE,
                 p_add_user_id sormaud.sormaud_add_user_id%TYPE,
                 p_add_date    sormaud.sormaud_add_date%TYPE,
                 p_pidm        sormaud.sormaud_pidm%TYPE,
                 p_seqno       sormaud.sormaud_seqno%TYPE,
                 p_rowid_inout IN OUT gb_common.internal_record_id_type)

Locks a record.
If the ROWID is not passed in, the record is located using the key values and the ROWID of the locked row is passed in p_rowid_inout.

Parameters
p_form_name   Mass entry form name. VARCHAR2(30) Required Key
p_add_user_id   ID of the user who initiated the mass entry. VARCHAR2(30) Required Key
p_add_date   Date and timestamp the mass entry was initiated. DATE Required Key
p_pidm   Unique identifier (PIDM) for the person selected or entered for the mass entry process. NUMBER(8) Required Key
p_seqno   A one up sequence number for each PIDM and mass entry form, add date and add user ID. NUMBER(2) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(p_form_name      sormaud.sormaud_form_name%TYPE,
                   p_add_user_id    sormaud.sormaud_add_user_id%TYPE,
                   p_add_date       sormaud.sormaud_add_date%TYPE,
                   p_pidm           sormaud.sormaud_pidm%TYPE,
                   p_seqno          sormaud.sormaud_seqno%TYPE,
                   p_manual_add_ind sormaud.sormaud_manual_add_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_process_ind    sormaud.sormaud_process_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_update_cde     sormaud.sormaud_update_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id        sormaud.sormaud_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_origin    sormaud.sormaud_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_term_code      sormaud.sormaud_term_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_key_seqno      sormaud.sormaud_key_seqno%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_key_text       sormaud.sormaud_key_text%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_hold_cde       sormaud.sormaud_hold_cde%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_msg            sormaud.sormaud_msg%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid          gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_form_name   Mass entry form name. VARCHAR2(30) Required Key
p_add_user_id   ID of the user who initiated the mass entry. VARCHAR2(30) Required Key
p_add_date   Date and timestamp the mass entry was initiated. DATE Required Key
p_pidm   Unique identifier (PIDM) for the person selected or entered for the mass entry process. NUMBER(8) Required Key
p_seqno   A one up sequence number for each PIDM and mass entry form, add date and add user ID. NUMBER(2) Required Key
p_manual_add_ind   Y/N indicator for whether the record was manually inserted on the mass entry form.  If the record was selected from the population selection process the value will be N for no. VARCHAR2(1) Required
p_process_ind   Y/N indicator for whether the record was selected to be process by the mass entry update procedure. VARCHAR2(1) Required
p_update_cde   Value that indicates if the mass entry completed successfully (Y); partially successful (P); none of the updates were successful (F); or (N) for when the update process did not process the record. VARCHAR2(1) Required
p_user_id   ID of the most recent user to create or update the record. VARCHAR2(30) Required
p_data_origin   Data origin of the insert or update to the record. VARCHAR2(30) Required
p_term_code   Term code for the mass entry host subject key. This  is the effective term for the learner, the admissions application term for the application, or blank for outcome records. VARCHAR2(6)
p_key_seqno   Key sequence number for the mass entry host subject key. This is the admissions application number for the application or the degree sequence number on the outcome records. NUMBER(2)
p_key_text   Key text value for the mass entry host subject key. This is the ceremony code for some of the graduation mass entry forms. VARCHAR2(30)
p_hold_cde   Y/N indicator for whether a hold exists for the person. VARCHAR2(1)
p_msg   Error messages returned from the mass entry processing. VARCHAR2(4000)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)

p_remove_all_success 

Procedure p_remove_all_success(p_form_name   sormaud.sormaud_form_name%TYPE,
                               p_add_user_id sormaud.sormaud_add_user_id%TYPE,
                               p_add_date    sormaud.sormaud_add_date%TYPE,
                               p_update_cde  sormaud.sormaud_update_cde%TYPE)

Delete all records.

Parameters
p_form_name   Mass entry form name. VARCHAR2(30) Required Key
p_add_user_id   ID of the user who initiated the mass entry. VARCHAR2(30) Required Key
p_add_date   Date and timestamp the mass entry was initiated. DATE Required Key
p_update_cde   Value that indicates if the mass entry completed successfully (Y); partially successful (P); none of the updates were successful (F); or (N) for when the update process did not process the record. VARCHAR2(1) Required

p_update_all 

Procedure p_update_all(p_form_name   sormaud.sormaud_form_name%TYPE,
                       p_add_user_id sormaud.sormaud_add_user_id%TYPE,
                       p_add_date    sormaud.sormaud_add_date%TYPE,
                       p_update_cde  sormaud.sormaud_update_cde%TYPE,
                       P_message     sormaud.sormaud_msg%TYPE,
                       p_user_id     sormaud.sormaud_user_id%TYPE,
                       P_data_origin sormaud.sormaud_data_origin%TYPE)

Update all records.

Parameters
p_form_name   Mass entry form name. VARCHAR2(30) Required Key
p_add_user_id   ID of the user who initiated the mass entry. VARCHAR2(30) Required Key
p_add_date   Date and timestamp the mass entry was initiated. DATE Required Key
p_update_cde   Value that indicates if the mass entry completed successfully (Y); partially successful (P); none of the updates were successful (F); or (N) for when the update process did not process the record. VARCHAR2(1) Required
p_msg   Error messages returned from the mass entry processing. VARCHAR2(4000)
p_user_id   ID of the most recent user to create or update the record. VARCHAR2(30) Required
p_data_origin   Data origin of the insert or update to the record. VARCHAR2(30) Required