index

Package gb_cm_user_setup

This package provides the Common Business interface for Common Matching User Setup.
A user who would run Common Matching would need to be set up using the p_create.  The user can be updated using p_update.
The user needs to be previously set up on GURTPRF.  This happens automatically for all Banner users.
This API will enable the user to be set up with a default Common Matching Source code and to indicate whether the user may select different source codes for online processing.  The user may be marked to be excluded from executing the Common Matching process online.

Program units
f_api_version   This function retrieves the API version number.
f_exists   Checks to see if a record exists for the input criteria - either the common matching user or the ROWID in the database.
f_isequal   Compares two records for equality.
f_query_all   Selects all records from the Common Matching User Setup Table.
f_query_one   Selects one record using key.
f_query_by_rowid   Selects one record using ROWID.
f_query_one_lock   Selects one record and locks it.
p_create   Creates a record Common Matching user id, the source option indicator and exclude indicator are required.
p_delete   Deletes a record.
p_lock   Locks a record.
p_update   Updates a record.

Types
cm_user_setup_rec   Entity record type
cm_user_setup_ref   Entity reference cursor type
cm_user_setup_tab   Entity table type

Constants
M_ENTITY_NAME   Business Entity name

M_ENTITY_NAME 

M_ENTITY_NAME    CONSTANT VARCHAR2(13) := 'CM_USER_SETUP';

Business Entity name

cm_user_setup_rec 

TYPE cm_user_setup_rec IS RECORD (
   r_cm_user_id              gobcmus.gobcmus_cm_user_id%TYPE,
   r_cmsc_option_ind         gobcmus.gobcmus_cmsc_option_ind%TYPE,
   r_exclude_ind             gobcmus.gobcmus_exclude_ind%TYPE,
   r_user_id                 gobcmus.gobcmus_user_id%TYPE,
   r_cmsc_code               gobcmus.gobcmus_cmsc_code%TYPE,
   r_data_origin             gobcmus.gobcmus_data_origin%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

Entity record type

cm_user_setup_ref 

TYPE cm_user_setup_ref IS REF CURSOR RETURN cm_user_setup_rec;

Entity reference cursor type

cm_user_setup_tab 

TYPE cm_user_setup_tab IS TABLE OF cm_user_setup_rec INDEX BY BINARY_INTEGER;

Entity table type

f_api_version 

FUNCTION f_api_version RETURN PLS_INTEGER

This function retrieves the API version number.

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

f_exists 

FUNCTION f_exists(p_cm_user_id gobcmus.gobcmus_cm_user_id%TYPE,
                  p_rowid      VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists for the input criteria - either the common matching user or the ROWID in the database.

Parameters
p_cm_user_id   User ID associated with these rules for Common Matching process when creating a new person or non-person record from a form. VARCHAR2(30) Required Key
p_rowid   Database ROWID of record to select. VARCHAR2(18)

Returns
Y if found, otherwise N.

f_isequal 

FUNCTION f_isequal(rec_one cm_user_setup_rec,
                   rec_two cm_user_setup_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 cm_user_setup_rec Required
rec_two   The second record to compare. Type cm_user_setup_rec Required

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

f_query_all 

FUNCTION f_query_all RETURN cm_user_setup_ref

Selects all records from the Common Matching User Setup Table.

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

f_query_one 

FUNCTION f_query_one(p_cm_user_id gobcmus.gobcmus_cm_user_id%TYPE)
  RETURN cm_user_setup_ref

Selects one record using key.

Parameters
p_cm_user_id   User ID associated with these rules for Common Matching process when creating a new person or non-person record from a form. VARCHAR2(30) Required Key

Returns
A cursor variable that will fetch exactly one record.

f_query_by_rowid 

FUNCTION f_query_by_rowid(p_rowid VARCHAR2) RETURN cm_user_setup_ref

Selects one record using ROWID.

Parameters
p_rowid   Database ROWID of record to select. VARCHAR2(18) Required

Returns
A cursor variable that will fetch exactly one record.

f_query_one_lock 

FUNCTION f_query_one_lock(p_cm_user_id gobcmus.gobcmus_cm_user_id%TYPE,
                          p_rowid      VARCHAR2 DEFAULT NULL)
  RETURN cm_user_setup_ref

Selects one record and locks it.

Parameters
p_cm_user_id   User ID associated with these rules for Common Matching process when creating a new person or non-person record from a form. VARCHAR2(30) Required Key
p_rowid   Database ROWID of record to select. VARCHAR2(18)

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

p_create 

PROCEDURE p_create(p_cm_user_id      gobcmus.gobcmus_cm_user_id%TYPE,
                   p_cmsc_option_ind gobcmus.gobcmus_cmsc_option_ind%TYPE DEFAULT 'N',
                   p_exclude_ind     gobcmus.gobcmus_exclude_ind%TYPE DEFAULT 'N',
                   p_user_id         gobcmus.gobcmus_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_cmsc_code       gobcmus.gobcmus_cmsc_code%TYPE DEFAULT NULL,
                   p_data_origin     gobcmus.gobcmus_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out       OUT VARCHAR2)

Creates a record Common Matching user id, the source option indicator and exclude indicator are required.
The common matching source code should exist on GORCMSC with the online idicator to be 'Y'.  If the common matching source option indicator is 'N', then the common matching source code is required.

Parameters
p_cm_user_id   User ID associated with these rules for Common Matching process when creating a new person or non-person record from a form. VARCHAR2(30) Required Key
p_cmsc_option_ind   Common Matching option indicator. Controls whether user ID may select different Common Matching Source codes for on-line processing. VARCHAR2(1) Required
Y   The user may select different codes.
N   The user may not select different codes.

p_exclude_ind   Exclude indicator. Controls whether the user ID has been excluded from the Common Matching process on-line.  VARCHAR2(1) Required
Y   The user ID has been excluded.
N   The user ID has not been excluded.

p_user_id   User ID of the User who created or last updated the record. VARCHAR2(30) Required
p_cmsc_code   Source code and associated rules to use as preference for user ID when Common Matching is run on-line from a form. VARCHAR2(20)
p_data_origin   Source system that created or updated the row. VARCHAR2(30)
p_rowid_out   Database ROWID of record created. VARCHAR2(18) Required

p_delete 

PROCEDURE p_delete(p_cm_user_id gobcmus.gobcmus_cm_user_id%TYPE,
                   p_rowid      VARCHAR2 DEFAULT NULL)

Deletes a record.

Parameters
p_cm_user_id   User ID associated with these rules for Common Matching process when creating a new person or non-person record from a form. VARCHAR2(30) Required Key
p_rowid   Database ROWID of record to delete. VARCHAR2(18)

p_lock 

PROCEDURE p_lock(p_cm_user_id  gobcmus.gobcmus_cm_user_id%TYPE,
                 p_rowid_inout IN OUT VARCHAR2)

Locks a record.
If 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_cm_user_id   User ID associated with these rules for Common Matching process when creating a new person or non-person record from a form. VARCHAR2(30) Required Key
p_rowid_inout   Database ROWID of record to lock. VARCHAR2(18) Required

p_update 

PROCEDURE p_update(p_cm_user_id      gobcmus.gobcmus_cm_user_id%TYPE,
                   p_cmsc_option_ind gobcmus.gobcmus_cmsc_option_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_exclude_ind     gobcmus.gobcmus_exclude_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id         gobcmus.gobcmus_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_cmsc_code       gobcmus.gobcmus_cmsc_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin     gobcmus.gobcmus_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid           VARCHAR2 DEFAULT NULL)

Updates a record.
Common Matching user id is required.
The common matching source code should exist on GORCMSC with the online idicator to be 'Y'.  If the common matching source option indicator is 'N', then the common matching source code is required.

Parameters
p_cm_user_id   User ID associated with these rules for Common Matching process when creating a new person or non-person record from a form. VARCHAR2(30) Required Key
p_cmsc_option_ind   Common Matching option indicator. Controls whether user ID may select different Common Matching Source codes for on-line processing. VARCHAR2(1) Required
Y   The user may select different codes.
N   The user may not select different codes.

p_exclude_ind   Exclude indicator. Controls whether the user ID has been excluded from the Common Matching process on-line.  VARCHAR2(1) Required
Y   The user ID has been excluded.
N   The user ID has not been excluded.

p_user_id   User ID of the User who created or last updated the record. VARCHAR2(30) Required
p_cmsc_code   Source code and associated rules to use as preference for user ID when Common Matching is run on-line from a form. VARCHAR2(20)
p_data_origin   Source system that created or updated the row. VARCHAR2(30)
p_rowid   Database ROWID of record to update. VARCHAR2(18)