Package gb_displaymask

This package provides the Common Business interface for the Display Mask API, gb_displaymask.

GORDMSK: (Display Mask Column Rules)

The Display Mask Column Rules define the display masks and the users they apply to for items on forms. This is to support the protection of sensitive and personally identifiable information (PII), such as ID and birthdate. The rules permit items (data elements) in specific blocks in forms to be completely hidden (not visible) or to have portions of the data display concealed by specifying format masks that control data display. Display mask rules can be applied to all users, users assigned to a specific business profile or an individual user ID. Multiple rules for the same object (form), block and column (item) have unique sequence numbers. Display rules are first applied to those marked as applying to all users, followed by those that apply to business profiles where the user is a member and last to rules specific to an individual user.

If the visibility indicator is checked (value of 'Y'), the item will not display on the page.
If the conceal indicator is checked (value of 'Y'), the data in the item will display as all asterisks. In this case, the data will be protected from enter query and will not be updateable. A format mask is applied if the item is visible on the page and not concealed. The item will be protected from enter query and update if a format mask is applied.

Format masks affect only how the data is displayed, not how it is stored. Various format masks can be applied to date items and numeric items for partial concealment. For example, a format mask rule of DD-MON can be applied to a birthdate field. This will prevent users that the rule applies to from viewing a person's birth year.

Format masks for character data require special coding inside the form and may not be available on all forms. Please refer to GORDMCL system required data for a list of character type items that support partial concealment.

Program units

f_api_version	Returns the API version number.
f_exists	Checks to see if a display mask record exists.
f_isequal	Compares two records for equality.
f_query_all	Selects all display mask 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.
F_SSB_FORMAT_NAME	Returns Y or N depending on whether F_FORMAT_NAME SHOULD display the surname prefix.
p_create	Creates a display mask record.
p_delete	Deletes a display mask record.
p_lock	Locks a record.
p_update	Updates a record.

Types

displaymask_rec	Entity record type.
displaymask_ref	Entity cursor variable type.
displaymask_tab	Entity table type.

Constants

M_ENTITY_NAME

Business Entity name.

M_ENTITY_NAME

M_ENTITY_NAME    CONSTANT VARCHAR2(11) := 'DISPLAYMASK';

Business Entity name.

displaymask_rec

TYPE displaymask_rec IS RECORD (
   r_objs_code               gordmsk.gordmsk_objs_code%TYPE,
   r_block_name              gordmsk.gordmsk_block_name%TYPE,
   r_column_name             gordmsk.gordmsk_column_name%TYPE,
   r_seqno                   gordmsk.gordmsk_seqno%TYPE,
   r_display_ind             gordmsk.gordmsk_display_ind%TYPE,
   r_conceal_ind             gordmsk.gordmsk_conceal_ind%TYPE,
   r_all_user_ind            gordmsk.gordmsk_all_user_ind%TYPE,
   r_user_id                 gordmsk.gordmsk_user_id%TYPE,
   r_data_mask               gordmsk.gordmsk_data_mask%TYPE,
   r_fgac_user_id            gordmsk.gordmsk_fgac_user_id%TYPE,
   r_fbpr_code               gordmsk.gordmsk_fbpr_code%TYPE,
   r_mask_direction          gordmsk.gordmsk_mask_direction%TYPE,
   r_mask_length             gordmsk.gordmsk_mask_length%TYPE,
   r_internal_record_id      gb_common.internal_record_id_type);

Entity record type.

displaymask_ref

TYPE displaymask_ref IS REF CURSOR RETURN displaymask_rec;

Entity cursor variable type.

displaymask_tab

TYPE displaymask_tab IS TABLE OF displaymask_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_objs_code   gordmsk.gordmsk_objs_code%TYPE,
                  p_block_name  gordmsk.gordmsk_block_name%TYPE,
                  p_column_name gordmsk.gordmsk_column_name%TYPE,
                  p_seqno       gordmsk.gordmsk_seqno%TYPE DEFAULT NULL,
                  p_rowid       VARCHAR2 DEFAULT NULL) RETURN VARCHAR2

Checks to see if a display mask record exists.

Parameters

	p_objs_code	Object which the display rules will be applied to. VARCHAR2(30). Required Key
	p_block_name	Block Name. VARCHAR2(30). Required Key
	p_column_name	Column Name. VARCHAR2(30). Required Key
	p_seqno	Sequence number to make a unique key. NUMBER(8). Optional
	p_rowid	Database ROWID of the record to be selected. VARCHAR(18). Optional

Returns

Y if found, otherwise N.

f_isequal

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

Returns

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

f_query_all

FUNCTION f_query_all(p_objs_code   gordmsk.gordmsk_objs_code%TYPE,
                     p_block_name  gordmsk.gordmsk_block_name%TYPE,
                     p_column_name gordmsk.gordmsk_column_name%TYPE,
                     p_seqno       gordmsk.gordmsk_seqno%TYPE)
  RETURN displaymask_ref

Selects all display mask records for the entity.

Parameters

	p_objs_code	Object which the display rules will be applied to. VARCHAR2(30). Required Key
	p_block_name	Block Name. VARCHAR2(30). Required Key
	p_column_name	Column Name. VARCHAR2(30). Required Key
	p_seqno	Sequence number to make a unique key. NUMBER(8). Required Key

Returns

A cursor variable that will fetch the set of records.

f_query_one

FUNCTION f_query_one(p_objs_code   gordmsk.gordmsk_objs_code%TYPE,
                     p_block_name  gordmsk.gordmsk_block_name%TYPE,
                     p_column_name gordmsk.gordmsk_column_name%TYPE,
                     p_seqno       gordmsk.gordmsk_seqno%TYPE)
  RETURN displaymask_ref

Selects one record using the key.

Parameters

	p_objs_code	Object which the display rules will be applied to. VARCHAR2(30). Required Key
	p_block_name	Block Name. VARCHAR2(30). Required Key
	p_column_name	Column Name. VARCHAR2(30). Required Key
	p_seqno	Sequence number to make a unique key. NUMBER(8). 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 displaymask_ref

Selects one record using the ROWID.

Parameters

p_rowid

Database ROWID of the record to be selected. VARCHAR(18). Required

Returns

A cursor variable that will fetch exactly one record.

f_query_one_lock

FUNCTION f_query_one_lock(p_objs_code   gordmsk.gordmsk_objs_code%TYPE,
                          p_block_name  gordmsk.gordmsk_block_name%TYPE,
                          p_column_name gordmsk.gordmsk_column_name%TYPE,
                          p_seqno       gordmsk.gordmsk_seqno%TYPE,
                          p_rowid       VARCHAR2 DEFAULT NULL)
  RETURN displaymask_ref

Selects one record and locks it.

Parameters

	p_objs_code	Object which the display rules will be applied to. VARCHAR2(30). Required Key
	p_block_name	Block Name. VARCHAR2(30). Required Key
	p_column_name	Column Name. VARCHAR2(30). Required Key
	p_seqno	Sequence number to make a unique key. NUMBER(8). Required Key
	p_rowid	Database ROWID of the record to be selected. VARCHAR(18). Optional

Returns

A cursor variable for one record, locking the record.

F_SSB_FORMAT_NAME

FUNCTION f_ssb_format_name RETURN VARCHAR2

Returns Y or N depending on whether F_FORMAT_NAME SHOULD display the surname prefix.

Returns

Returns Y or N depending on whether F_FORMAT_NAME SHOULD display the surname prefix.

p_create

PROCEDURE p_create(p_objs_code      gordmsk.gordmsk_objs_code%TYPE,
                   p_block_name     gordmsk.gordmsk_block_name%TYPE,
                   p_column_name    gordmsk.gordmsk_column_name%TYPE,
                   p_seqno_out      IN OUT gordmsk.gordmsk_seqno%TYPE,
                   p_display_ind    gordmsk.gordmsk_display_ind%TYPE,
                   p_conceal_ind    gordmsk.gordmsk_conceal_ind%TYPE,
                   p_all_user_ind   gordmsk.gordmsk_all_user_ind%TYPE,
                   p_user_id        gordmsk.gordmsk_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_mask      gordmsk.gordmsk_data_mask%TYPE DEFAULT NULL,
                   p_fgac_user_id   gordmsk.gordmsk_fgac_user_id%TYPE DEFAULT NULL,
                   p_fbpr_code      gordmsk.gordmsk_fbpr_code%TYPE DEFAULT NULL,
                   p_mask_direction gordmsk.gordmsk_mask_direction%TYPE DEFAULT NULL,
                   p_mask_length    gordmsk.gordmsk_mask_length%TYPE DEFAULT NULL,
                   p_rowid_out      OUT VARCHAR2)

Creates a display mask record.

Parameters

p_objs_code

Object which the display rules will be applied to. VARCHAR2(30). Required Key

p_block_name

Block Name. VARCHAR2(30). Required Key

p_column_name

Column Name. VARCHAR2(30). Required Key

p_seqno_out

Sequence number to make a unique key. NUMBER(8). Required Key

p_display_ind

Indicates if the column should be displayed on the form. Default value is N. VARCHAR2(1). Required

	Y	Display on the form
	N	Do not display on the form

p_conceal_ind

Indicates if the column should be displayed, yet the value concealed on the form. Default value is N. VARCHAR2(1). Required

	Y	Display on the form
	N	Do not display on the form

p_all_user_ind

Indicates if the masking applies to all users of the system. Default value is Y. VARCHAR2(1). Required

	Y	Mask applies to all users of the system
	N	Mask does not apply to all users of the system

p_user_id

Oracle ID of the user who creates or last updated the record. VARCHAR2(30). Required

p_data_mask

Display format for the string text. Use S to display the value, and * as the substitute character to hide it. VARCHAR2(60). Optional

p_fgac_user_id

Oracle ID the masking applies to. Must be blank if All Users is checked. VARCHAR2(30). Optional

p_fbpr_code

Business Profile list the masking applies to. Must be blank if All Users is checked. VARCHAR2(30). Optional

p_mask_direction

Partial character mask direction: Left(L) or right(R) direction that a partial character mask is applied to a field. Is null if not a character type field. VARCHAR2(1). Optional

p_mask_length

Partial character mask length: indicates the length of characters that have the mask applied. NUMBER(4). Optional

p_rowid_out

Database ROWID of the record to be created. VARCHAR(18). Required

p_delete

PROCEDURE p_delete(p_objs_code   gordmsk.gordmsk_objs_code%TYPE,
                   p_block_name  gordmsk.gordmsk_block_name%TYPE,
                   p_column_name gordmsk.gordmsk_column_name%TYPE,
                   p_seqno       gordmsk.gordmsk_seqno%TYPE,
                   p_rowid       VARCHAR2 DEFAULT NULL)

Deletes a display mask record.

Parameters

	p_objs_code	Object which the display rules will be applied to. VARCHAR2(30). Required Key
	p_block_name	Block Name. VARCHAR2(30). Required Key
	p_column_name	Column Name. VARCHAR2(30). Required Key
	p_seqno	Sequence number to make a unique key. NUMBER(8). Required Key
	p_rowid	Database ROWID of the record to be deleted. VARCHAR(18). Optional

p_lock

PROCEDURE p_lock(p_objs_code   gordmsk.gordmsk_objs_code%TYPE,
                 p_block_name  gordmsk.gordmsk_block_name%TYPE,
                 p_column_name gordmsk.gordmsk_column_name%TYPE,
                 p_seqno       gordmsk.gordmsk_seqno%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_objs_code	Object which the display rules will be applied to. VARCHAR2(30). Required Key
	p_block_name	Block Name. VARCHAR2(30). Required Key
	p_column_name	Column Name. VARCHAR2(30). Required Key
	p_seqno	Sequence number to make a unique key. NUMBER(8). Required Key
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR(18). Required

p_update

PROCEDURE p_update(p_objs_code      gordmsk.gordmsk_objs_code%TYPE,
                   p_block_name     gordmsk.gordmsk_block_name%TYPE,
                   p_column_name    gordmsk.gordmsk_column_name%TYPE,
                   p_seqno          gordmsk.gordmsk_seqno%TYPE,
                   p_display_ind    gordmsk.gordmsk_display_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_conceal_ind    gordmsk.gordmsk_conceal_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_all_user_ind   gordmsk.gordmsk_all_user_ind%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_user_id        gordmsk.gordmsk_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_data_mask      gordmsk.gordmsk_data_mask%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_fgac_user_id   gordmsk.gordmsk_fgac_user_id%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_fbpr_code      gordmsk.gordmsk_fbpr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_mask_direction gordmsk.gordmsk_mask_direction%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_mask_length    gordmsk.gordmsk_mask_length%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_rowid          VARCHAR2 DEFAULT NULL)

Updates a record.

Parameters

p_objs_code

Object which the display rules will be applied to. VARCHAR2(30). Required Key

p_block_name

Block Name. VARCHAR2(30). Required Key

p_column_name

Column Name. VARCHAR2(30). Required Key

p_seqno

Sequence number to make a unique key. NUMBER(8). Required Key

p_display_ind

Indicates if the column should be displayed on the form. Default value is N. VARCHAR2(1). Optional

	Y	Display on the form
	N	Do not display on the form

p_conceal_ind

Indicates if the column should be displayed, yet the value concealed on the form. Default value is N. VARCHAR2(1). Optional

	Y	Display on the form
	N	Do not display on the form

p_all_user_ind

Indicates that the masking applies to all users of the system. Default value is Y. VARCHAR2(1). Optional

	Y	Mask applies to all users of the system
	N	Mask does not apply to all users of the system

p_user_id

Oracle ID of the user who created or last updated the record. VARCHAR2(30). Optional

p_data_mask

Display format for string text. Use S to display the value, and * as the substitute character to hide it. VARCHAR2(60). Optional

p_fgac_user_id

User ID the masking applies to. Must be blank if All Users is checked. VARCHAR2(30). Optional

p_fbpr_code

Business Profile list the masking applies to. Must be blank if All Users is checked. VARCHAR2(30). Optional

p_mask_direction

Partial character mask direction: Left(L) or right(R) direction that a partial character mask is applied to a field. Is null if not a character type field. VARCHAR2(1). Optional

p_mask_length

Partial character mask length: indicates the length of characters that have the mask applied. NUMBER(4). Optional

p_rowid

Database ROWID of the record to be updated. VARCHAR(18). Optional