Routines for grp_dbbr.kb


CompletePartialGroup

File Name

grp_dbbr.kb

Syntax

function CompletePartialGroup(VAL w: WINDOW, REF group: GroupRecord, VAL field: STRING, VAL nextField: STRING, REF oldAK: STRING): INTEGER;

Parameters

w - current window handle

group - group record

field - field being auto-filled

nextField - field to move focus to upon completion of autofill

oldAK - old text field value

Returns

Integer

Side Effects

None

Description

This function retrieves the complete text value for a given group name and populates it into the appropriate text box.

Dialog Forms Called

None


GetCCBGroupType

File Name

grp_dbbr.kb

Syntax

GetCCBGroupType(VAL ccbName: STRING): STRING IS

Parameters

groupId and siteId - Id of the group to find the CCB type

Returns

Integer

Side Effects

None

Description

Finds the associated CCB type to set while viewing details of a CCB from the Approvals tab of the Change and Model dialog box.

Dialog Forms Called

None


GetGroupById

File Name

grp_dbbr.kb

Syntax

function GetGroupById(VAL id: STRING): GroupRecord;

Parameters

id - group ID

Returns

Group record

Side Effects

None

Description

This functions retrieves a group record based on the given ID.

Dialog Forms Called

None


GetGroupList

File Name

grp_dbbr.kb

Syntax

function GetGroupList(REF lst: LIST OF GroupRecord, VAL where: STRING): INTEGER;

Parameters

lst - list of group records

where - string used for retrieving group records

Returns

Integer

Side Effects

None

Description

This function retrieves a list of group records based on the where clause.

Dialog Forms Called

None


GetUserPrimaryGroup

File Name

grp_dbbr.kb

Syntax

FUNCTION GetUserPrimaryGroup(VAL user_id: STRING): STRING;

Parameters

user_id - the user ID used to look up the default group

Returns

Group ID

Side Effects

None

Description

This function will provide the user's primary group.

Dialog Forms Called

None


LoadAllGroups

File Name

grp_dbbr.kb

Syntax

PROCEDURE LoadAllGroups( REF groupList: List of String );

Parameters

groupList - destination group list

Returns

Nothing

Side Effect: None.

Side Effects

None

Description

This function will populate the LIST OF STRING reference parameter with all available groups active in the system.

Dialog Forms Called

None


LoadGroupMask

File Name

grp_dbbr.kb

Syntax

PROCEDURE LoadGroupMask ( VAL user_id: STRING, REF groupList: LIST OF STRING, REF mask: INTEGER );

Parameters

user_id - user ID used to search

groupList - destination list of groups of which the user

is a member.

mask - destination security mask for all rights

associated with the user.

Returns

Nothing

Side Effects

None

Description

This function will load the reference parameter groupList with all groups that the user_id is a member of as well as create the security mask based on each group's rights. The security mask will be a combination of security rights associated with all the groups that the user ID is a member of.

Dialog Forms Called

None


LoadLocalGroups

File Name

grp_dbbr.kb

Syntax

PROCEDURE LoadLocalGroups( REF groupList: List of String );

Parameters

groupList - destination group list

Returns

Nothing

Side Effects

None

Description

This function will populate the list of string reference parameter with all available groups active in the system.

Dialog Forms Called

None


LoadMembersForCCB

File Name

grp_dbbr.kb

Syntax

LoadMembersForCCB(REF thisCCB: CCB_MEMBER_REC, VAL Member_SQL_String: STRING): INTEGER IS

Parameters

thisCCB - CCB record to load members into

Member_SQL_String - search criteria for SQL select

Returns

Integer

Side Effects

None

Description

Loads the members belonging to the given CCB.

Dialog Forms Called

None


PartialGroup2PK

File Name

grp_dbbr.kb

Syntax

FUNCTION PartialGroup2PK(REF display: GroupRecord,VAL w: WINDOW, VAL where: STRING, VAL ak: STRING): INTEGER;

Parameters

display - display record for groups

w - parent window handle

where - value user entered in the field

Returns

A group record with completed group name.

Side Effects

None

Description

This routine performs the auto completion for a box when user tabs out. If one match is found, then the field is set and the match returned to the calling dialog box. If no matches are found, then the user is given a warning and the option to continue editing the current box or to tab to the next box. If many matches are found, then the user will be presented a list of the matches from which they can choose.

Dialog Forms Called

groups.dfc[available_groups]


QueryGroupsForUser

File Name

grp_dbbr.kb

Syntax

PROCEDURE QueryGroupsForUser ( VAL userId: STRING, REF GroupList: LIST OF STRING );

Parameters

userId - user ID to search for groups in which this ID

is a member

GroupList - list of groups in which this user is a

member

Returns

Nothing

Side Effects

None

Description

This function is used to load all groups in which the user ID is a member. It will populate the LIST OF STRING reference parameter with each group ID that the user ID parameter is a member of.

Dialog Forms Called

None