index

Package gp_udc_user_provisioning

Provides the Common Business interface for the UDC IDENTIFICATION API (gp_udc_user_provisioning).

Person records may be created or modified using this API.
Please refer to each individual function and procedure for more information.


Program units
f_check_matches   Function to perform common matching using XML input.
f_check_matches   Function to perform common matching using OOT input.
p_check_matches   Procedure to perform common matching using XML input to return a count of matches and ref cursor for the PIDMs returned from common matching.
p_check_matches   Procedure to perform common matching using OOT input to return a count of matches and ref cursor for the PIDMs returned from common matching.
f_query_cm_pidms   Function to return a ref cursor for the PIDMs returned from common matching.
f_create_user   Function to create a Banner person and optional Oracle ID using XML.
f_create_user   Function to create a Banner person and optional Oracle ID using OOT.
f_lookup_user   Function to look up a Banner person returning XML.
p_modify_user   Procedure to modify a Banner person using XML.
p_modify_user   Procedure to modify a Banner person using OOT.

Types
cm_pidm_rec   Entity record type for PIDMs found during common matching
cm_pidm_ref   Entity cursor variable type for returning PIDMs during common matching

cm_pidm_rec 

TYPE cm_pidm_rec IS RECORD (
  r_pidm  gotcmrt.gotcmrt_pidm%TYPE);

Entity record type for PIDMs found during common matching

cm_pidm_ref 

TYPE cm_pidm_ref IS REF CURSOR
  RETURN cm_pidm_rec;

Entity cursor variable type for returning PIDMs during common matching

f_check_matches 

FUNCTION f_check_matches(p_user IN xmltype) RETURN INTEGER

Function to perform common matching using XML input.

Parameters
p_user   Request message. XMLTYPE.

Returns
number of matches. INTEGER.

f_check_matches 

FUNCTION f_check_matches(p_user IN udc_identity_type) RETURN INTEGER

Function to perform common matching using OOT input.

Parameters
p_user   Request message. OOT.

Returns
number of matches. INTEGER.

p_check_matches 

PROCEDURE p_check_matches(p_user  IN xmltype,
                          p_count OUT INTEGER,
                          p_ref   OUT cm_pidm_ref)

Procedure to perform common matching using XML input to return a count of matches and ref cursor for the PIDMs returned from common matching.

Parameters
p_user   Request message. XMLTYPE.
p_count   Number of matches. INTEGER.
p_ref   Reference cursor of matching PIDMS.

p_check_matches 

PROCEDURE p_check_matches(p_user  IN udc_identity_type,
                          p_count OUT INTEGER,
                          p_ref   OUT cm_pidm_ref)

Procedure to perform common matching using OOT input to return a count of matches and ref cursor for the PIDMs returned from common matching.

Parameters
p_user   Request message. OOT.
p_count   Number of matches. INTEGER.
p_ref   Reference cursor of matching PIDMS.

f_query_cm_pidms 

FUNCTION f_query_cm_pidms RETURN cm_pidm_ref

Function to return a ref cursor for the PIDMs returned from common matching.

Returns
A cursor variable for the matching PIDMs

f_create_user 

FUNCTION f_create_user(p_user IN xmltype) RETURN spriden.spriden_pidm%TYPE

Function to create a Banner person and optional Oracle ID using XML.

Parameters
p_user   Request message. XMLTYPE.

Returns
PIDM. spriden.spriden_pidm%type.

f_create_user 

FUNCTION f_create_user(p_user IN udc_identity_type)
  RETURN spriden.spriden_pidm%TYPE

Function to create a Banner person and optional Oracle ID using OOT.

Parameters
p_user   Request message. OOT.

Returns
PIDM. spriden.spriden_pidm%type.

f_lookup_user 

FUNCTION f_lookup_user(p_udcid IN VARCHAR2) RETURN CLOB

Function to look up a Banner person returning XML.

Parameters
p_udcID   UDC Identifier. VARCHAR2

Returns
CLOB.

p_modify_user 

PROCEDURE p_modify_user(p_user IN xmltype)

Procedure to modify a Banner person using XML.

Parameters
p_user   Request message. XMLTYPE.

p_modify_user 

PROCEDURE p_modify_user(p_user IN udc_identity_type)

Procedure to modify a Banner person using OOT.

Parameters
p_user   Request message. OOT.