Routines for peo_dbbr.kb


AddToSelect

File Name

peo_dbbr.kb

Syntax

AddToSelect(REF finalselect: STRING, VAL select: STRING)

Parameters

finalselect - complete select statement

select - current select string (combination of org select,

location select, group select )

Returns

Nothing

Side Effects

None

Description

This procedure adds another statement to the current select statement.

Dialog Forms Called

None


BuildEmailSelect

File Name

peo_dbbr.kb

Syntax

BuildEmailSelect(REF email_name: STRING, REF emailsearch: STRING)

Parameters

email_name - e-mail address

emailsearch - e-mail search string

Returns

Nothing

Side Effects

None

Description

This procedure returns a select string based on email_name.

Dialog Forms Called

None


BuildGrpSelect

File Name

peo_dbbr.kb

Syntax

BuildGrpSelect(REF grp_name: STRING, REF grpsearch: STRING)

Parameters

grp_name - group name

grpsearch - group search string

Returns

Nothing

Side Effects

None

Description

This procedure returns a select string based on the group membership.

Dialog Forms Called

None


BuildLocIDSelect

File Name

peo_dbbr.kb

Syntax

BuildLocIDSelect(REF loc_id: STRING, REF locsearch: STRING)

Parameters

loc_id - location ID

locsearch - location search string

Returns

Nothing

Side Effects

None

Description

This procedure returns a select string based on the location.

Dialog Forms Called

None


BuildOrgIDSelect

File Name

peo_dbbr.kb

Syntax

BuildOrgIDSelect(REF org_id: STRING, REF orgsearch: STRING)

Parameters

org_id - organization ID

orgsearch - organization search string

Returns

Nothing

Side Effects

None

Description

This procedure returns a select string based on the organization.

Dialog Forms Called

None


BuildSelect

File Name

peo_dbbr.kb

Syntax

BuildSelect(REF peosearch: STRING, REF usersearch: STRING, REF emailsearch: STRING, REF locsearch: STRING, REF orgsearch: STRING, REF grpsearch: STRING, REF finalselect: STRING)

Parameters

peosearch - people select statement

usersearch - user select statement

emailsearch - e-mail select statement

locsearch - location select statement

orgsearch - organization select statement

grpsearch - group select statement

finalselect - final select statement

Returns

Nothing

Side Effects

None

Description

This procedure combines the people, user, email , location, organization, and group search into one complete select statement.

Dialog Forms Called

None


BuildSupportOrgSelect

File Name

peo_dbbr.kb

Syntax

BuildSupportOrgSelect(VAL org_id: STRING, REF supportorgsearch: STRING, VAL includeparents: BOOLEAN)

Parameters

org_id - organization ID

orgsearch - supported organization search string

includeparents - indicates whether to include the parents of the support organization specified

Returns

Nothing

Side Effects

None

Description

This procedure returns a select string based on the supported organization.

Dialog Forms Called

None


CreateDisplayAllSelect

File Name

peo_dbbr.kb

Syntax

CreateDisplayAllSelect(REF displayselect: STRING, REF viewpeople: BrowsePeopleListRec, REF peotype: STRING)

Parameters

displayselect - select string of people to be displayed

viewpeople - used to determine formtype

peotype - people type selected

Returns

Nothing

Side Effects

None

Description

This procedure creates a select statement if the user chooses to display all records.

Dialog Forms Called

None


CreateDisplaySelect

File Name

peo_dbbr.kb

Syntax

CreateDisplaySelect(REF peoidlist: LIST OF INTEGER, REF displayselect: STRING, REF viewpeople: BrowsePeopleListRec)

Parameters

peoidlist - list of people ids

displayselect - select string for displaying people

viewpeople - record which contains people to be displayed in the MCLB

Returns

Nothing

Side Effects

None

Description

This procedure builds a list of people IDs from which to select.

Dialog Forms Called

None


DoesGroupMemberIDExist

File Name

peo_dbbr.kb

Syntax

DoesGroupMemberIDExist( VAL groupId: STRING, VAL userId: STRING )

Parameters

groupId - group ID

userId - user ID

Returns

TRUE if member_of record exists

FALSE if member_of record does not exist

Side Effects

None

Description

This function checks to see if a member_of record exists for the user and group.

Dialog Forms Called

None


DoesOrgMemberIDExist

File Name

peo_dbbr.kb

Syntax

DoesOrgMemberIDExist( VAL organization_id: STRING, VAL people_id: INTEGER )

Parameters

organization_id - organization ID

people_id - people ID

Returns

TRUE if org_membership record exists,

FALSE if org_membership record does not exist

Side Effects

None

Description

This function checks to see if a org_membership record exists for the person and organization.

Dialog Forms Called

None


DoesPeopleLocationRecExist

File Name

peo_dbbr.kb

Syntax

DoesPeopleLocationRecExist( VAL people_id: INTEGER, VAL location_id: STRING )

Parameters

location_id - location ID

people_id - people ID

Returns

TRUE if people_location record exists

FALSE if people_location record does not exist

Side Effects

None

Description

This function checks to see if a people_location record exists for the person and location.

Dialog Forms Called

None


FillBrowsePeopleInstRec

File Name

peo_dbbr.kb

Syntax

FillBrowsePeopleInstRec(REF person_id: INTEGER, REF mode: STRING)

Parameters

person_id - ID of selected person

mode - current mode of People dialog box (Add, Edit, View)

Returns

instance data for browse people event handler

Side Effects

None

Description

This function returns the instance data for the browse people event handler based on the ID.

Dialog Forms Called

None


FillQuickContactRec

File Name

peo_dbbr.kb

Syntax

FillQuickContactRec(REF qcontact: QuickContactRec)

Parameters

qcontact - record with quick contact information

Returns

Nothing

Side Effects

None

Description

This procedure will populate a quick contact record.

Dialog Forms Called

None


FillSearchFields

File Name

peo_dbbr.kb

Syntax

FillSearchFields(VAL w: WINDOW, REF viewpeople: BrowsePeopleListRec)

Parameters

w - parent window handle

viewpeople - record which contains people to be displayed in the MCLB

Returns

Nothing

Side Effects

None

Description

This procedure fills the organization name and location name on the People dialog box search boxes.

Dialog Forms Called

None


GetDefaultNtfyAddressForPerson

File Name

peo_dbbr.kb

Syntax

GetDefaultNtfyAddressForPerson( VAL People_ID: INTEGER)

Parameters

people_id - person ID

Returns

Default notification address

Side Effects

None

Description

This function is used to get the default notification address for the person.

Dialog Forms Called

None


GetGroupName

File Name

peo_dbbr.kb

Syntax

GetGroupName(VAL groupid: STRING)

Parameters

groupid - group ID

Returns

String

Side Effects

None

Description

This function returns the group name for a selected group ID.

Dialog Forms Called

None


GetInvPeopleRec

File Name

peo_dbbr.kb

Syntax

GetInvPeopleRec(VAL where: STRING, REF inv_peopleList: LIST OF Inv_PeopleRec)

Parameters

where - where clause of select statement

inv_peoplelist - list of people linked to assets

Returns

SQLSelect return result

Side Effects

None

Description

This function returns a list of inv_people records based on the where clause.

Dialog Forms Called

None


GetLocationsForPerson

File Name

peo_dbbr.kb

Syntax

GetLocationsForPerson (VAL people_id: INTEGER, REF locationList: LIST OF WWPeopleLocationRec)

Parameters

people_id - person ID

locationList - list of people location records

Returns

SQLSelect return result

Side Effects

None

Description

This function gets the list of locations for a person. A person only has locations if they are a contact.

Dialog Forms Called

None


GetNotificationList

File Name

peo_dbbr.kb

Syntax

GetNotificationList ( VAL People_ID: INTEGER )

Parameters

people_id - person ID

Returns

String

Side Effects

None

Description

This function is used to get a list of notification types for a person.

Dialog Forms Called

None


GetPeopleDisplayList

File Name

peo_dbbr.kb

Syntax

GetPeopleDisplayList(VAL w: WINDOW, REF peoidlist: LIST OF INTEGER, REF displayselect: STRING)

Parameters

w - parent window handle

peoidlist - list of people IDs

displayselect - select string of people to be displayed

Returns

Nothing

Side Effects

None

Description

This procedure inserts a list of people into the MCLB.

Dialog Forms Called

None


GetPeopleID

File Name

peo_dbbr.kb

Syntax

GetPeopleID( VAL pRec: PeopleRec )

Parameters

pRec - people record

Returns

String

Side Effects

None

Description

This function retrieves a people ID based on the person information passed in.

Dialog Forms Called

None


GetPeopleID_FromUserID

File Name

peo_dbbr.kb

Syntax

GetPeopleID_FromUserID( VAL id: INTEGER )

Parameters

id - user ID

Returns

Integer

Side Effects

None

Description

This function retrieves a people ID based on the user ID passed in.

Dialog Forms Called

None


GetPeopleIDList

File Name

peo_dbbr.kb

Syntax

GetPeopleIDList(REF peoidselect: STRING, VAL parentw: WINDOW)

Parameters

peoidselect - people ID select statement

parentw - parent window handle

Returns

Nothing

Side Effects

None

Description

This procedure builds a list of people IDs from which to select.

Dialog Forms Called

None


GetPeopleLocationList

File Name

peo_dbbr.kb

Syntax

GetPeopleLocationList ( VAL People_ID: INTEGER )

Parameters

people_id - person ID

Returns

Integer

Side Effects

None

Description

This function is used to get a list of locations for a person.

Dialog Forms Called

None


GetPeoplePartialList

File Name

peo_dbbr.kb

Syntax

GetPeoplePartialList(REF lst: LIST OF BrowsePeopleListRec,VAL where: STRING)

Parameters

lst - list of people records returned

where - where clause of select statement

Returns

String

Side Effects

None

Description

This function returns a partial list of people records based on the where clause.

Dialog Forms Called

None


GetPeoplePartialPeopleRec

File Name

peo_dbbr.kb

Syntax

GetPeoplePartialPeopleRec( REF lst: LIST OF PeopleRec, VAL where: STRING)

Parameters

lst - list of people records

where - where clause of select statement

Returns

String

Side Effects

None

Description

This function returns a partial list of people records based on the where clause.

Dialog Forms Called

None


GetPerson

File Name

peo_dbbr.kb

Syntax

GetPerson(VAL id: INTEGER)

Parameters

id - people ID

Returns

People record with people ID.

Side Effects

None

Description

This function returns a people record based on the people ID passed in.

Dialog Forms Called

None


GetPersonByUserID

File Name

peo_dbbr.kb

Syntax

GetPersonByUserID( VAL id: STRING )

Parameters

id - user ID

Returns

String

Side Effects

None

Description

This function retrieves a person based on the user ID.

Dialog Forms Called

None


GetProfileID

File Name

peo_dbbr.kb

Syntax

GetProfileID( REF profile_name: STRING)

Parameters

profile_name - name of selected profile

Returns

SQLSelectInto return result

Side Effects

None

Description

This function will return a profile id for the specified profile name.

Dialog Forms Called

None


GetUserID_FromPeopleID

File Name

peo_dbbr.kb

Syntax

GetUserID_FromPeopleID( VAL id: INTEGER )

Parameters

id - people ID

Returns

Integer

Side Effects

None

Description

This function retrieves a user ID based on the people ID passed in.

Dialog Forms Called

None


SelectAllPeople

File Name

peo_dbbr.kb

Syntax

SelectAllPeople(VAL w: WINDOW, REF displayselect: STRING, REF peotype: STRING, REF viewpeople: BrowsePeopleListRec )

Parameters

w - parent window handle

displayselect - select statement for displaying all people

peotype - people type selected

viewpeople - person record returned by displayselect statement

Returns

Nothing

Side Effects

None

Description

This procedure selects all people based on the display select statement.

Dialog Forms Called

None