index

Package sb_datafile_delimiter

Common Business interface for the Datafile Delimiter API (sb_datafile_delimiter).
Banner performs many data loads using files that contain fixed length data fields.
In order to also load data files that are delimited, the SORDLIM table and API have been created. A record will be inserted into the table to allow a user to specify what delimiter is being used on a given tape. In addition, a 'marker' can be identified for each tape code as well. The marker is a special code used to demark a field where that field contains a character that matches the delimiter but which is not being used as a delimiter in that case.

Program units
f_api_version  
f_exists  
f_sys_req  
f_isequal  
f_query_all  
f_query_one  
f_query_by_rowid  
f_query_one_lock  
p_create  
p_delete  
p_lock  
p_update  

Types
datafile_delimiter_rec  
datafile_delimiter_ref  
datafile_delimiter_tab  

Constants
M_ENTITY_NAME  

M_ENTITY_NAME 

M_ENTITY_NAME    CONSTANT VARCHAR2(18) := 'DATAFILE_DELIMITER';

Business Entity Name

datafile_delimiter_rec 

TYPE datafile_delimiter_rec IS RECORD (
  r_tape_code               sordlim.sordlim_tape_code%TYPE,
  r_delimiter               sordlim.sordlim_delimiter%TYPE,
  r_user_id                 sordlim.sordlim_user_id%TYPE,
  r_sys_req_ind             sordlim.sordlim_sys_req_ind%TYPE,
  r_marker                  sordlim.sordlim_marker%TYPE,
  r_data_origin             sordlim.sordlim_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

datafile_delimiter_ref 

TYPE datafile_delimiter_ref IS REF CURSOR RETURN datafile_delimiter_rec;

Entity cursor variable type

datafile_delimiter_tab 

TYPE datafile_delimiter_tab IS TABLE OF datafile_delimiter_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_tape_code                 sordlim.sordlim_tape_code%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_tape_code   Tape Code for which the delimiter will be used. VARCHAR2(10) Required Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

Returns
Y if found, otherwise N.

f_sys_req 

Function f_sys_req(
    p_tape_code                 sordlim.sordlim_tape_code%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL) RETURN VARCHAR2

Checks to see if a record is system required.

Parameters
p_tape_code   Tape Code for which the delimiter will be used. VARCHAR2(10) Required Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

Returns
Y if required, otherwise N.

f_isequal 

Function f_isequal(
    rec_one                     datafile_delimiter_rec,
    rec_two                     datafile_delimiter_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 datafile_delimiter_rec Required
rec_two   The second record to compare. Type datafile_delimiter_rec Required

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

f_query_all 

Function f_query_all(
    p_tape_code                 sordlim.sordlim_tape_code%TYPE) RETURN datafile_delimiter_ref

Selects all records for the entity.

Parameters
p_tape_code   Tape Code for which the delimiter will be used. VARCHAR2(10) Required Key

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

f_query_one 

Function f_query_one(
    p_tape_code                 sordlim.sordlim_tape_code%TYPE) RETURN datafile_delimiter_ref

Selects one record using the key.

Parameters
p_tape_code   Tape Code for which the delimiter will be used. VARCHAR2(10) 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 datafile_delimiter_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_tape_code                 sordlim.sordlim_tape_code%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL) RETURN datafile_delimiter_ref

Selects one record and locks it.

Parameters
p_tape_code   Tape Code for which the delimiter will be used. VARCHAR2(10) 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_tape_code                 sordlim.sordlim_tape_code%TYPE,
    p_delimiter                 sordlim.sordlim_delimiter%TYPE,
    p_user_id                   sordlim.sordlim_user_id%TYPE DEFAULT gb_common.f_sct_user,
    p_sys_req_ind               sordlim.sordlim_sys_req_ind%TYPE,
    p_marker                    sordlim.sordlim_marker%TYPE DEFAULT NULL,
    p_data_origin               sordlim.sordlim_data_origin%TYPE DEFAULT NULL,
    p_rowid_out             OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_tape_code   Tape Code for which the delimiter will be used. VARCHAR2(10) Required Key
p_delimiter   Delimiter used to indicate a new field on the tape. VARCHAR2(1) Required
p_user_id   Unique identification of the user. VARCHAR2(30) Required
p_sys_req_ind   This field indicates that a record is delivered by SunGard and is required by the system. VARCHAR2(1) Required
p_marker   This field indicates a marker value used besides the delimiter to enclose field data. VARCHAR2(1)
p_data_origin   Source system that created or updated the row. VARCHAR2(30)
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

Procedure p_delete(
    p_tape_code                 sordlim.sordlim_tape_code%TYPE,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_tape_code   Tape Code for which the delimiter will be used. VARCHAR2(10) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

Procedure p_lock(
    p_tape_code                 sordlim.sordlim_tape_code%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_tape_code   Tape Code for which the delimiter will be used. VARCHAR2(10) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

Procedure p_update(
    p_tape_code                 sordlim.sordlim_tape_code%TYPE,
    p_delimiter                 sordlim.sordlim_delimiter%TYPE DEFAULT dml_common.f_unspecified_string,
    p_user_id                   sordlim.sordlim_user_id%TYPE DEFAULT gb_common.f_sct_user,
    p_sys_req_ind               sordlim.sordlim_sys_req_ind%TYPE DEFAULT dml_common.f_unspecified_string,
    p_marker                    sordlim.sordlim_marker%TYPE DEFAULT dml_common.f_unspecified_string,
    p_data_origin               sordlim.sordlim_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
    p_rowid                     gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_tape_code   Tape Code for which the delimiter will be used. VARCHAR2(10) Required Key
p_delimiter   Delimiter used to indicate a new field on the tape. VARCHAR2(1) Required
p_user_id   Unique identification of the user. VARCHAR2(30) Required
p_sys_req_ind   This field indicates that a record is delivered by SunGard and is required by the system. VARCHAR2(1) Required
p_marker   This field indicates a marker value used besides the delimiter to enclose field data. VARCHAR2(1)
p_data_origin   Source system that created or updated the row. VARCHAR2(30)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)