index

Package gb_displaymask_rules

This package provides support subprograms 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 lastly 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_parent_exists   Checks to see if a parent record exists.
f_seqno   Selects max seqno for OBJECT, BLOCK, and COLUMN.
p_register_entity   Registers the attribute/value pairs to the message cache.
p_register_entity   Registers the attribute/value pairs to the message cache.
p_validate   Validates all the data in the record.

f_parent_exists 

FUNCTION f_parent_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)
  RETURN VARCHAR2

Checks to see if a parent record exists.

f_seqno 

FUNCTION f_seqno(p_objs_code   gordmsk.gordmsk_objs_code%TYPE,
                 p_block_name  gordmsk.gordmsk_block_name%TYPE,
                 p_column_name gordmsk.gordmsk_column_name%TYPE)
  RETURN NUMBER

Selects max seqno for OBJECT, BLOCK, and COLUMN.

Parameters
p_objs_code   Object which thedisplay 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

Returns
Maximum sequence number used for OBJECT, BLOCK, and COLUMN, plus 1.

p_register_entity 

PROCEDURE p_register_entity(p_operation_type     NUMBER,
                            p_internal_record_id VARCHAR2)

Registers the attribute/value pairs to the message cache.
This signature uses the ROWID only for the delete operations.

Parameters
p_operation_type   Type of DML operation, either create, update, or delete. NUMBER. Required
p_internal_record_id   Database ROWID. Required

p_register_entity 

PROCEDURE p_register_entity(p_operation_type     NUMBER,
                            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,
                            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,
                            p_fgac_user_id       gordmsk.gordmsk_fgac_user_id%TYPE,
                            p_fbpr_code          gordmsk.gordmsk_fbpr_code%TYPE,
                            p_mask_direction     gordmsk.gordmsk_mask_direction%TYPE,
                            p_mask_length        gordmsk.gordmsk_mask_length%TYPE,
                            p_internal_record_id VARCHAR2)

Registers the attribute/value pairs to the message cache.
This signature registers all parameters.

Parameters
p_operation_type   Type of DML operation, either create, update, or delete. NUMBER. Required
p_objs_code   Object to which the display rules will be applied. 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   Display indicator. Default value is N. VARCHAR2(1). Required
Y   Column should be displayed
N   Column should not be displayed

p_conceal_ind   Conceal Indicator. Default value is N. VARCHAR2(1). Required
Y   Column should be displayed with value concealed
N   Column should not be concealed

p_all_user_ind   All Users Indicator. Default value is Y. VARCHAR2(1). Required
Y   Masking applies to all users of the system
N   Masking 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 appled. NUMBER(4). Optional
p_internal_record_id   Database ROWID. Optional

p_validate 

PROCEDURE p_validate(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,
                     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)

Validates all the data in the record.

Parameters
p_objs_code   Object which thedisplay 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   Display indicator. Default value is N. VARCHAR2(1). Required
Y   Column should be displayed
N   Column should not be displayed

p_conceal_ind   Conceal Indicator.  Default value is N. VARCHAR2(1). Required
Y   Column should be displayed with value concealed
N   Column should not be concealed

p_all_user_ind   All Users Indicator.  Default value is Y. VARCHAR2(1). Required
Y   Masking applies to all users of the system
N   Masking 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). Required
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 appled. NUMBER(4). Optional