Routines for r_dbsvcs.kb


LoadColumnNames

File Name

r_dbsvcs.kb

Syntax

LoadColumnNames(VAL tableName: STRING, REF codes: LIST OF STRING): INTEGER IS

Parameters

tableName - Table name for which to get rows

codes - List of columns found

Returns

Integer

Side Effects

None

Description

This routine loads column names for the given table.

Dialog Forms Called

None


ModelAK2PKList

File Name

r_dbsvcs.kb

Syntax

ModelAK2PKList(REF lst: LIST OF R_MODEL_REC, VAL table: STRING, VAL ak: STRING, VAL wHdl: WINDOW): INTEGER IS

Parameters

lst - List of records matching partial key

table - Table name for the object (for instance H_OBJECT)

ak - Partial key

wHdl - Current window handler

Returns

lst - List of nodes that match the partial key

Side Effects

None

Description

This routine accepts the partial key (ak) and returns the list of nodes that match that partial description

Dialog Forms Called

None


R_AddUpdateEntry

File Name

r_dbsvcs.kb

Syntax

R_AddUpdateEntry(VAL updateEntryID:INTEGER, VAL entry:R_ScheduleEntry):INTEGER IS

Parameters

updateEntryID - The ID of the entry to update

Returns

Integer

Side Effects

None

Description

This routine inserts or updates a schedule entry. If the given updateEntryID is known and found in the schedule table, then the entry is updated. Otherwise, a new entry ID is generated and the given entry record is inserted into the schedule table.

Dialog Forms Called

None


R_CheckForDuplicateapprovers

File Name

r_dbsvcs.kb

Syntax

R_CheckForDuplicateapprovers(VAL this_Approval: R_APPROVAL_REC ): BOOLEAN IS

Parameters

this_Approval - Current approval record

Returns

Boolean

Side Effects

None

Description

This routine checks for duplicate approvers. TRUE is returned if a duplicate is found. FALSE is returned if no duplicate is found.

Dialog Forms Called

None


R_CountModelsForCategory

File Name

r_dbsvcs.kb

Syntax

R_CountModelsForCategory( VAL w: WINDOW, VAL categoryId: STRING): INTEGER IS

Parameters

categoryId - The Category name to look at

Returns

Integer

Side Effects

None

Description

This routine retrieves the number of live, defined models for the input category name.

Dialog Forms Called

None


R_GetActivityChildListFromDatabase

File Name

r_dbsvcs.kb

Syntax

R_GetActivityChildListFromDatabase(REF activityList: LIST OF INTEGER, VAL Change_ID: INTEGER) IS

Parameters

activityList - list of activity IDs

Change_ID - change ID

Returns

Nothing

Side Effects

None

Description

This routine returns a list of activity IDs which are children of the passed-in Change_id.

Dialog Forms Called

None


R_GetActivityListFromActivities

File Name

r_dbsvcs.kb

Syntax

R_GetActivityListFromActivities(REF activityList: LIST OF INTEGER)

Parameters

activityList - list of change IDs

Returns

Nothing

Side Effects

None

Description

This routine walks through the R_G_SChange.Activities stack and returns a list of all present activity IDs which are not marked as deleted.

Dialog Forms Called

None


R_GetActivityListFromDatabase

File Name

r_dbsvcs.kb

Syntax

R_GetActivityListFromDatabase(REF activityList: LIST OF INTEGER) IS

Parameters

activityList - list of activity IDs

Returns

Nothing

Side Effects

None

Description

This routine retrieves a list of activity IDs from the database.

Dialog Forms Called

None


R_GetActivityParentListFromDatabase

File Name

r_dbsvcs.kb

Syntax

R_GetActivityParentListFromDatabase(REF activityList: LIST OF INTEGER, VAL Change_ID: INTEGER) IS

Parameters

activityList - list of activity IDs

Change_ID - change ID

Returns

Nothing

Side Effects

None

Description

This routine gets a list of parent activity IDs from the database.

Dialog Forms Called

None


R_GetActivityStringForChange

File Name

r_dbsvcs.kb

Syntax

R_GetActivityStringForChange(REF AString: STRING) IS

Parameters

this_Change - Current change record

Returns

Nothing

Side Effects

None

Description

This routine retrieves the list of changes which are already activities.

Dialog Forms Called

None


R_GetGroupIDsForUser

File Name

r_dbsvcs.kb

Syntax

R_GetGroupIDsForUser(VAL user_id: STRING): INTEGER IS

Parameters

user_id - The person's user ID with which to search.

Returns

Nothing

Side Effects

None

Description

This routine gets all of the groups of which a person is a member.

Dialog Forms Called

None


R_GetInv

File Name

r_dbsvcs.kb

Syntax

R_GetInv(VAL id: INTEGER): IS_InventoryRec IS

Parameters

id - Inventory ID

Returns

IS_InventoryRec

Side Effects

None

Description

This routine retrieves inventory based upon column IS_INVENTORY_ID from table IS_INVENTORY.

Dialog Forms Called

None


R_GetInvFromPM

File Name

r_dbsvcs.kb

Syntax

R_GetInvFromPM(VAL id: STRING): IS_InventoryRec IS

Parameters

id - Object ID

Returns

IS_InventoryRec

Side Effects

None

Description

This routine retrieves inventory based upon column PM_OBJECT_ID from table IS_INVENTORY.

Dialog Forms Called

None


R_GetOrgMemberUserIds

File Name

r_dbsvcs.kb

Syntax

R_GetOrgMemberUserIds(VAL id: STRING): LIST OF STRING IS

Parameters

id - Organization ID

Returns

List of String

Side Effects

None

Description

This routine gets the members of an organization for notification.

Dialog Forms Called

None


R_GetOrgTitleHolders

File Name

r_dbsvcs.kb

Syntax

R_GetOrgTitleHolders(VAL id: STRING): LIST OF STRING IS

Parameters

id - Organization ID

Returns

List of String

Side Effects

None

Description

This routine gets the title holders of an organization for notification.

Dialog Forms Called

None


R_GetRightsList

File Name

r_dbsvcs.kb

Syntax

R_GetRightsList(REF ktypeList: LIST OF RightsRecord): INTEGER IS

Parameters

ktypeList - list of rights records

Returns

Integer

Side Effects

None

Description

This routine returns list of rights.

Dialog Forms Called

None


R_GetSomePeopleList

File Name

r_dbsvcs.kb

Syntax

R_GetSomePeopleList(REF lst: LIST OF BrowsePeopleListRec, VAL where: STRING): INTEGER IS

Parameters

lst - List of people records

where - SQL WHERE clause

Returns

Integer

Side Effects

None

Description

This routine retrieves a list of people records.

Dialog Forms Called

None


R_GetUserID_FromGroupID

File Name

r_dbsvcs.kb

Syntax

R_GetUserID_FromGroupID( VAL group_id: STRING, VAL site_id: STRING ): LIST OF STRING IS

Parameters

group_id - The current CCB name

site_id - The current site ID

Returns

List of String

Side Effects

None

Description

This routine returns a list of group members from a group ID.

Dialog Forms Called

None


R_Initialize

File Name

r_dbsvcs.kb

Syntax

R_Initialize IS

Parameters

None

Returns

Nothing

Side Effects

None

Description

This procedure is used to initialize TCM.

Dialog Forms Called

None


R_Initialize_DB_G_Constance

File Name

r_dbsvcs.kb

Syntax

R_Initialize_DB_G_Constance IS

Parameters

None

Returns

Nothing

Side Effects

None

Description

This procedure is used to load all TCM global records.

Dialog Forms Called

None


R_IsEnabled

File Name

r_dbsvcs.kb

Syntax

R_IsEnabled(VAL entryID:INTEGER):BOOLEAN IS

Parameters

entryID - The ID for the desired entry

Returns

Boolean

Side Effects

None

Description

This routine determines if the entry designated by entryID is enabled. "Enabled" refers to the active schedule.

Dialog Forms Called

None


R_LoadApprovalsForChange

File Name

r_dbsvcs.kb

Syntax

R_LoadApprovalsForChange: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves a change's approvals from the database.

Dialog Forms Called

None


R_LoadAssocProblemsForChange

File Name

r_dbsvcs.kb

Syntax

R_LoadAssocProblemsForChange: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves a change's associated problems from the database.

Dialog Forms Called

None


R_LoadAtrsForInvEffect

File Name

r_dbsvcs.kb

Syntax

R_LoadAtrsForInvEffect: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves inventory effect attributes from the database.

Dialog Forms Called

None


R_LoadCategoryCodes

File Name

r_dbsvcs.kb

Syntax

R_LoadCategoryCodes(REF codes: LIST OF R_CATEGORY_REC): INTEGER IS

Parameters

codes - List of codes found

Returns

Integer

Side Effects

None

Description

This routine loads the current list of TCM category codes.

Dialog Forms Called

None


R_LoadChanges

File Name

r_dbsvcs.kb

Syntax

R_LoadChanges(VAL Find_SQL_String: STRING): INTEGER IS

Parameters

Find_SQL_String - Selection criteria

Returns

Integer

Side Effects

None

Description

This routine retrieves changes from the database based on the passed-in criteria.

Dialog Forms Called

None


R_LoadCommandsForTask

File Name

r_dbsvcs.kb

Syntax

R_LoadCommandsForTask: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves scheduled task commands from the database.

Dialog Forms Called

None


R_LoadConsForInvEffect

File Name

r_dbsvcs.kb

Syntax

R_LoadConsForInvEffect: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves inventory effect contracts from the database.

Dialog Forms Called

None


R_LoadDependenciesForTask

File Name

r_dbsvcs.kb

Syntax

R_LoadDependenciesForTask: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves scheduled task dependencies from the database.

Dialog Forms Called

None


R_LoadExitCommands

File Name

r_dbsvcs.kb

Syntax

R_LoadExitCommands(REF commands: LIST OF R_COMMANDS_REC): INTEGER IS

Parameters

commands - List of available commands

Returns

Integer

Side Effects

None

Description

This routine loads a list of available commands.

Dialog Forms Called

None


R_LoadHistoryForChange

File Name

r_dbsvcs.kb

Syntax

R_LoadHistoryForChange: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves a change request's history from the database.

Dialog Forms Called

None


R_LoadHstsForInvEffect

File Name

r_dbsvcs.kb

Syntax

R_LoadHstsForInvEffect: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves inventory effect history from the database.

Dialog Forms Called

None


R_LoadImpactImpInvForImpact

File Name

r_dbsvcs.kb

Syntax

R_LoadImpactImpInvForImpact: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves impact inventory from the database.

Dialog Forms Called

None


R_LoadImpactItemsForImpact

File Name

r_dbsvcs.kb

Syntax

R_LoadImpactItemsForImpact: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves impact items from the database.

Dialog Forms Called

None


R_LoadImpactKeywordsForImpact

File Name

r_dbsvcs.kb

Syntax

R_LoadImpactKeywordsForImpact: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves keywords from the database for an impact.

Dialog Forms Called

None


R_LoadImpactsForChange

File Name

r_dbsvcs.kb

Syntax

R_LoadImpactsForChange: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves impacts from the database for a change request.

Dialog Forms Called

None


R_LoadImpCategoryCodes

File Name

r_dbsvcs.kb

Syntax

R_LoadImpCategoryCodes(REF codes: LIST OF R_IMP_CAT_REC): INTEGER IS

Parameters

codes - List of available impact codes

Returns

Integer

Side Effects

None

Description

This routine loads available impact codes.

Dialog Forms Called

None


R_LoadInvEffectsForChange

File Name

r_dbsvcs.kb

Syntax

R_LoadInvEffectsForChange: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves inventory effects from the database.

Dialog Forms Called

None


R_LoadOnsForInvEffect

File Name

r_dbsvcs.kb

Syntax

R_LoadOnsForInvEffect: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves inventory effect connections from the database.

Dialog Forms Called

None


R_LoadParametersForCommand

File Name

r_dbsvcs.kb

Syntax

R_LoadParametersForCommand(REF this_Command: R_COMMANDS_REC ): INTEGER IS

Parameters

this_Command - Command record to be updated with parameters

Returns

Integer

Side Effects

None

Description

This routine loads the list of parameters for a given command.

Dialog Forms Called

None


R_LoadPreferences

File Name

r_dbsvcs.kb

Syntax

R_LoadPreferences IS

Parameters

None

Returns

Nothing

Side Effects

None

Description

This routine loads preference settings for TCM.

Dialog Forms Called

None


R_LoadRiskCodes

File Name

r_dbsvcs.kb

Syntax

R_LoadRiskCodes(REF codes: LIST OF R_RISK_REC): INTEGER IS

Parameters

codes - List of available risk codes

Returns

Integer

Side Effects

None

Description

This routine returns a list of available risk codes.

Dialog Forms Called

None


R_LoadSchedInvForTask

File Name

r_dbsvcs.kb

Syntax

R_LoadSchedInvForTask: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves inventory from the database for a scheduled task.

Dialog Forms Called

None


R_LoadStatusCodes

File Name

r_dbsvcs.kb

Syntax

R_LoadStatusCodes(REF codes: LIST OF R_STATUS_REC): INTEGER IS

Parameters

codes - List of status codes found

Returns

Integer

Side Effects

None

Description

This routine loads the current list of TCM status codes.

Dialog Forms Called

None


R_LoadTableNames

File Name

r_dbsvcs.kb

Syntax

R_LoadTableNames(REF R_TABLE_LIST: LIST OF STRING) IS

Parameters

R_TABLE_LIST - List of tables found

Returns

Nothing

Side Effects

None

Description

This routine loads system table names.

Dialog Forms Called

None


R_LoadTaskByName

File Name

r_dbsvcs.kb

Syntax

R_LoadTaskByName(REF this_Task: R_TASK_REC): INTEGER IS

Parameters

this_Task - Task to be retrieved

Returns

Integer

Side Effects

None

Description

This routine retrieves scheduled tasks from the database.

Dialog Forms Called

None


R_LoadTasksForChange

File Name

r_dbsvcs.kb

Syntax

R_LoadTasksForChange(VAL type: INTEGER): INTEGER IS

Parameters

type - Types of tasks to return

Returns

Integer

Side Effects

None

Description

This routine retrieves scheduled tasks from the database for a change.

Dialog Forms Called

None


R_PersonAK2PKList

File Name

r_dbsvcs.kb

Syntax

R_PersonAK2PKList(REF lst: LIST OF BrowsePeopleListRec, VAL ak: STRING): INTEGER IS

Parameters

lst - List of people records

ak - User name

Returns

Integer

Side Effects

None

Description

This routine returns a person or list of people that matches or has a name like that which is passed-in with parameter 'ak'.

Dialog Forms Called

None


R_ReturnChangesForCategory

File Name

r_dbsvcs.kb

Syntax

R_ReturnChangesForCategory( VAL w: WINDOW, VAL current_mclb: STRING, VAL category: STRING ): INTEGER IS

Parameters

w - Current window

current_mclb - Current MCLB

category - Current organization

Returns

Integer

Side Effects

None

Description

This routine retrieves list of change requests from the database.

Dialog Forms Called

None


R_ReturnChangesForOrganization

File Name

r_dbsvcs.kb

Syntax

R_ReturnChangesForOrganization( VAL w: WINDOW, VAL current_mclb: STRING, VAL org_id: STRING ): INTEGER IS

Parameters

w - Current window

current_mclb - Current MCLB

org_id - Current organization

Returns

Integer

Side Effects

None

Description

This routine retrieves list of change requests from the database given an organization ID. Note this routine is called both by rules for rule testing and changes for joining other changes as activities. Eligible change requests for joining are root-level changes having the same approval method.

Dialog Forms Called

None


R_SecurityInit

File Name

r_dbsvcs.kb

Syntax

R_SecurityInit: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine initializes R_G_Current_User, R_G_Current_User_Name, and then loads this user's rights.

Dialog Forms Called

None


R_UserTasksSQL

File Name

r_dbsvcs.kb

Syntax

R_UserTasksSQL: STRING IS

Parameters

None

Returns

String

Side Effects

None

Description

This routine retrieves outstanding task information for the current user.

Dialog Forms Called

None


Return_Model_ID_For_Model

File Name

r_dbsvcs.kb

Syntax

Return_Model_ID_For_Model( VAL SQLStr: STRING ): INTEGER IS

Parameters

SQLSt - SQL select statement

Returns

Integer

Side Effects

None

Description

This routine retrieves the model ID for a given model.

Dialog Forms Called

None