File Name
Syntax
R_ApprovalRecordDatabase(VAL InTran: BOOLEAN, VAL this_Approval: R_APPROVAL_REC, VAL old_Approval: R_APPROVAL_REC ): INTEGER IS
Parameters
InTran - Flag to determine whether in a transaction
this_Approval - Current approval record
old_Approval - Old record for database concurrency
Returns
Integer
Side Effects
None
Description
This routine handles addition, modification, and removal of approvals.
Dialog Forms Called
None
File Name
Syntax
R_AssocChangesAreClosed( VAL w: WINDOW, VAL problem_id: STRING, VAL curr_change_id: INTEGER ): BOOLEAN IS
Parameters
problem_id - Current problem ID
change_id - Current change ID
Returns
Boolean
Side Effects
None
Description
This routine determines if all changes associated with a given problem ID have are marked as "Closed". If they are all closed, then a value of TRUE is returned; otherwise, FALSE is returned. This supports the notion that all associated change requests must be marked as "Completed" prior to closing the related problem ticket.
Dialog Forms Called
None
File Name
Syntax
R_AssociatedProblemsRecordDatabase(VAL InTran: BOOLEAN, VAL this_AssocProb: R_ASSOC_PROB_REC, VAL old_AssocProb: R_ASSOC_PROB_REC ): INTEGER IS
Parameters
InTran - Flag to determine whether in a transaction
this_AssocProb - Current associated problem record
old_AssocProb - Old record for database concurrency
Returns
Integer
Side Effects
None
Description
This routine handles addition, modification, and removal of associated problems.
Dialog Forms Called
None
File Name
Syntax
R_AttachmentRecordDatabase(VAL InTran: BOOLEAN, VAL this: R_CHANGE_ATTACHMENT_REC, VAL old: R_CHANGE_ATTACHMENT_REC): INTEGER IS
Parameters
InTran - Flag to determine whether in a transaction
this - Current change attachment record
old - Old record for database concurrency
Returns
Integer
Side Effects
None
Description
This routine handles addition, modification, and removal of attachments.
Dialog Forms Called
None
File Name
Syntax
R_AutoFillCategoryNameForModel(VAL thisModelName: STRING): STRING IS
Parameters
thisModelName - Model Name
Returns
String
Side Effects
None
Description
This routine retrieves a category ID for a given Model Name.
Dialog Forms Called
None
File Name
Syntax
R_ChangeRecordDatabase(VAL InTran: BOOLEAN): INTEGER IS
Parameters
InTran - Flag to determine whether in a transaction
Returns
Integer
Side Effects
None
Description
This routine handles addition, modification, and removal of change records.
Dialog Forms Called
None
File Name
Syntax
R_ChangeTextRecordDatabase(VAL InTran: BOOLEAN, VAL this_ChangeText: R_CHANGE_TEXT_REC, VAL old_ChangeText: R_CHANGE_TEXT_REC ): INTEGER IS
Parameters
InTran - Flag to determine whether in a transaction
this_ChangeText - Current change text record
old_ChangeText - Old record for database concurrency
Returns
Integer
Side Effects
None
Description
This routine handles addition, modification, and removal of change text.
Dialog Forms Called
None
File Name
Syntax
R_CheckForActivity:INTEGER IS
Parameters
this_Request - Current change record
Returns
Integer
Side Effects
None
Description
This routine checks to see if a change is already an activity. A parent change ID is returned if one exists.
Dialog Forms Called
None
File Name
Syntax
R_CheckForAlterations: BOOLEAN IS
Parameters
None
Returns
Boolean
Side Effects
None
Description
This routine verifies if a change has been modified.
Dialog Forms Called
None
File Name
Syntax
R_CheckForESCRules IS
Parameters
None
Returns
Nothing
Side Effects
None
Description
This routine checks to see if there are any escalation rules. If so, it sets a global variable R_G_EscRules to inform TCM not to do escalation processing.
Dialog Forms Called
None
File Name
Syntax
R_CheckForPreviousUpdate(REF lstInvEffect: LIST OF R_MassDefRec, REF lstInvLst: LIST OF IS_InventoryRec) IS
Parameters
lstInvEffect - List of R_MassDefRec records
lstInvLst - List of IS_InventoryRec records
Returns
Nothing
Side Effects
None
Description
This routine validates that the action to be taken on an inventory effect has not already been performed.
Dialog Forms Called
None
File Name
Syntax
R_CheckForValidWord(VAL w: WINDOW, VAL impKeyWord: STRING): BOOLEAN IS
Parameters
w - handle to window
impKeyWord - the word the user is trying to add
Returns
Boolean
Side Effects
None
Description
This routine validates that the key word about to be added is currently in the dictionary
Dialog Forms Called
None
File Name
Syntax
R_CreateEscalationLog(VAL escType: INTEGER, VAL Category: String, VAL primaryRef: INTEGER, VAL SecRef: STRING) IS
Parameters
escType - Escalation type
Category - Category the escalation will match
primaryRef - Reference ID
SecRef - Secondary reference; does not need to be known
Returns
Nothing
Side Effects
None
Description
This routine creates an escalation log.
Dialog Forms Called
None
File Name
Syntax
R_CreateSolutionFromChange(VAL ID: INTEGER): INTEGER IS
Parameters
id - change request ID
Returns
Integer
Side Effects
None
Description
This routine creates a solution from the change description when the change is marked as completed.
Dialog Forms Called
None
File Name
Syntax
FUNCTION R_CTreeRecordDatabase(VAL InTran: BOOLEAN, VAL this_CTree: R_CTREE_REC, VAL old_CTree: R_CTREE_REC): INTEGER IS
Parameters
InTran - Flag to determine whether in a transaction
this_CTree - Current tree record
old_CTree - Old record for database concurrency
Returns
Integer
Side Effects
None
Description
This routine handles addition, modification, and removal of trees.
Dialog Forms Called
None
File Name
Syntax
R_DeleteChangeFromProblemID(VAL prob_id: STRING) IS
Parameters
prob_id - Problem ID
Returns
Nothing
Side Effects
None
Description
This routine deletes all changes that are associated with a problem. This procedure should only be called by TPM when the problem is cancelled by the user. The only changes that should be affected are those associated with the passed-in problem ID.
Dialog Forms Called
None
File Name
Syntax
R_DependencyRecordDatabase(VAL InTran: BOOLEAN, VAL this_Dependency: R_DEPENDENCY_REC, VAL old_Dependency: R_DEPENDENCY_REC ): INTEGER IS
Parameters
InTran - Flag to determine whether in a transaction
this_Dependency - Current scheduled task dependency record
old_Dependency - Old record for database concurrency
Returns
Nothing
Side Effects
None
Description
This routine handles addition, modification, and removal of dependencies.
Dialog Forms Called
None
File Name
Syntax
R_DetermineTheRootChange(VAL PassedIn_Change_ID: INTEGER, REF root_change_id: INTEGER, REF approval_method: STRING);
Parameters
PassedIn_Change_ID - The change ID of the current request node
root_change_id - The root change ID to be returned
approval_method - The root approval method to be returned
Returns
None
Side Effects
None
Description
Given a change_id, this procedure discovers the high-level change ID and its approval method. It supports the business rule that all activities have the same approval method as their high level change parent.
Dialog Forms Called
None
File Name
Syntax
R_DisplayCategoryDesc(VAL Code: STRING): STRING
Parameters
Code - Current Category code
Returns
String
Side Effects
None
Description
This function returns the description of a category, given its code.
Dialog Forms Called
None
File Name
Syntax
R_ExitProblemField(VAL w: WINDOW, VAL FieldName: STRING):INTEGER IS
Parameters
w - Current window
FieldName - Field name to be autofilled
Returns
Integer
Side Effects
None
Description
This function performs an autofill check on the Find Change dialog box for a given problem_id.
Dialog Forms Called
None
File Name
Syntax
R_FindChangesFromInventory(VAL Asset_Tag: STRING): LIST of INTEGER IS
Parameters
Asset_Tag - TAM asset tag
Returns
List of Integer
Side Effects
None
Description
This routine finds all changes associated with a given inventory.
Dialog Forms Called
None
File Name
Syntax
R_FindChangesFromProblems(VAL ProbId: STRING): LIST of INTEGER IS
Parameters
ProbID - Problem ID
Returns
List of Integer
Side Effects
None
Description
This routine finds all changes associated with a given problem.
Dialog Forms Called
None
File Name
Syntax
R_FindImpactInList(VAL old_Impact: R_IMPACT_REC, VAL ImpactList: LIST OF R_IMPACT_REC ): R_IMPACT_REC IS
Parameters
old_Impact - Old impact record
ImpactList - List of impact records to search
Returns
R_IMPACT_REC
Side Effects
None
Description
This routine retrieves the impacts for a specified record.
Dialog Forms Called
None
File Name
Syntax
R_FindPreFreezeStatusID(REF statusID: STRING ) IS
Parameters
statusID - status ID
Returns
Nothing
Side Effects
None
Description
This routine parses out the pre-freeze status ID from the history records. Note that it is stored here as opposed to storing it in a separtate column on the Change table.
Dialog Forms Called
None
File Name
Syntax
R_FindStatusId(REF change_id: INTEGER): STRING IS
Parameters
change_id - change request ID.
Returns
String
Side Effects
None
Description
This routine finds the current status ID of a change.
Dialog Forms Called
None
File Name
Syntax
R_GetChanges_Assoc_With_Inv(REF Chng_Inv_VwList: LIST OF Chng_Inv_VwRec, VAL where, orderby: STRING) IS
Parameters
Chng_Inv_VwList - list of Chng_Inv_VwRec that is returned
where - SQL string
orderby - SQL string
Returns
Nothing
Side Effects
None
Description
This routine gets the changes associated with an inventory item or list of items.
Dialog Forms Called
None
File Name
Syntax
R_GetModelNameList(REF modelNameList: LIST OF STRING, VAL thisCategory: STRING): INTEGER IS
Parameters
modelNameList - empty list of matching model names
thisCategory - the current category name
Returns
Integer
Side Effects
None
Description
This routine retrieves a list of models that relate to the current Change Category.
Dialog Forms Called
None
File Name
Syntax
R_HasChangeImpactedMyParent IS
Parameters
None
Returns
Nothing
Side Effects
None
Description
If the change family to which this change belongs (currently at the top of R_G_SChange.CSTACK) has an approval method of "Depends On Activities," then the following business rule is enforced. When "Depends On Activities," all subordinate activites for a given change must be approved before the said change may begin its own approval process. Also, if it is an "activity" and has an approval method of "Depends On Activities," then re-evaluate the eligibility of this activity's parent approval requirements. This must occur because we are supporting the notion that approvers may or may not be "Eligible" (See routine R_DetermineapprovalEligibility). Procedure R_HasChangeImpactedMyParent answers the question, "Is this actually an activity of another change request and what is the approval method?"
Dialog Forms Called
None
File Name
Syntax
R_HistoryRecordDatabase(VAL InTran: BOOLEAN, VAL this_History: R_HISTORY_REC, VAL old_History: R_HISTORY_REC): INTEGER IS
Parameters
InTran - Flag to determine whether in a transaction
this_History - Current history record
old_History - Old record for database concurrency
Returns
Integer
Side Effects
None
Description
This routine handles addition, modification, and removal of change history.
Dialog Forms Called
None
File Name
Syntax
R_ImpactInventoryRecordDatabase(VAL InTran: BOOLEAN, VAL this_AffInv: R_IMP_INV_REC, VAL old_AffInv: R_IMP_INV_REC ): INTEGER IS
Parameters
InTran - Flag to determine whether in a transaction
this_AffInv - Current impact inventory record
old_AffInv - Old record for database concurrency
Returns
Integer
Side Effects
None
Description
This routine handles the addition, modification, and removal of impact inventory.
Dialog Forms Called
None
File Name
Syntax
R_ImpactItemsRecordDatabase(VAL InTran: BOOLEAN, VAL this_ImpItem: R_IMP_ITEM_REC, VAL old_ImpItem: R_IMP_ITEM_REC ): INTEGER IS
Parameters
InTran - Flag to determine whether in a transaction
this_ImpItem - Current impact item record
old_ImpItem - Old record for database concurrency
Returns
Integer
Side Effects
None
Description
This routine handles addition, modification, and removal of impact items.
Dialog Forms Called
None
File Name
Syntax
R_ImpactKeywordsRecordDatabase(VAL InTran: BOOLEAN, VAL this_ImpKeyword: R_IMP_KEYWORD_REC, VAL old_ImpKeyword: R_IMP_KEYWORD_REC ): INTEGER IS
Parameters
InTran - Flag to determine whether in a transaction
this_ImpKeyword - Current impact keyword record
old_ImpKeyword - Old record for database concurrency
Returns
Integer
Side Effects
None
Description
This routine handles addition, modification, and removal of impact keywords.
Dialog Forms Called
None
File Name
Syntax
R_ImpactRecordDatabase(VAL InTran: BOOLEAN, VAL this_Impact: R_IMPACT_REC, VAL old_Impact: R_IMPACT_REC): INTEGER IS
Parameters
InTran - Flag to determine whether in a transaction
this_Impact - Current impact record
old_Impact - Old record for database concurrency
Returns
Integer
Side Effects
None
Description
This routine handles addition, modification, and removal of impacts.
Dialog Forms Called
None
File Name
Syntax
R_InsertHistoryForInvEffectOn IS
Parameters
None
Returns
Nothing
Side Effects
None
Description
This routine handles addition, modification, and removal of Inventory Effect connections history records.
Dialog Forms Called
None
File Name
Syntax
R_InvEffectAtrRecordDatabase(VAL InTran: BOOLEAN, VAL this: R_INV_EFFECT_ATR_REC, VAL old: R_INV_EFFECT_ATR_REC): INTEGER
Parameters
InTran - Flag to determine whether in a transaction
this - Current Atr record
old - Old record for database concurrency
Returns
Integer
Side Effects
None
Description
This routine handles addition, modification, and removal of inventory effect attributes.
Dialog Forms Called
None
File Name
Syntax
R_InvEffectConRecordDatabase(VAL InTran: BOOLEAN, VAL this: R_INV_EFFECT_CON_REC, VAL old: R_INV_EFFECT_CON_REC): INTEGER
Parameters
InTran - Flag to determine whether in a transaction
this - Current contract record
old - Old record for database concurrency
Returns
Integer
Side Effects
None
Description
This routine handles addition, modification, and removal of inventory effect contracts.
Dialog Forms Called
None
File Name
Syntax
R_InvEffectHstRecordDatabase(VAL InTran: BOOLEAN, VAL this: R_INV_EFFECT_HST_REC, VAL old: R_INV_EFFECT_HST_REC): INTEGER
Parameters
InTran - Flag to determine whether in a transaction
this - Current hst record
old - Old record for database concurrency
Returns
Integer
Side Effects
None
Description
This routine handles addition, modification, and removal of inventory effect history records.
Dialog Forms Called
None
File Name
Syntax
R_InvEffectOnRecordDatabase(VAL InTran: BOOLEAN, VAL this: R_INV_EFFECT_ON_REC, VAL old: R_INV_EFFECT_ON_REC): INTEGER IS
Parameters
InTran - Flag to determine whether in a transaction
this - Current on record
old - Old record for database concurrency
Returns
Boolean
Side Effects
None
Description
This routine handles addition, modification, and removal of inventory effect "connections".
Dialog Forms Called
None
File Name
Syntax
R_InvEffectRecordDatabase(VAL InTran: BOOLEAN, VAL this: R_INV_EFFECT_REC, VAL old: R_INV_EFFECT_REC): INTEGER IS
Parameters
InTran - Flag to determine whether in a transaction
this - Current inventory effect record
old - Old record for database concurrency
Returns
Nothing
Side Effects
None
Description
This routine handles addition, modification, and removal of inventory effects.
Dialog Forms Called
None
File Name
Syntax
R_LoadActivitiesForChange: INTEGER IS
Parameters
None
Returns
Integer
Side Effects
None
Description
This routine retrieves activities from the database for a change.
Dialog Forms Called
None
File Name
Syntax
R_LoadAllChangeTrees(REF treeList: LIST OF R_CTREE_REC): INTEGER IS
Parameters
treeList - List of trees retrieved
Returns
Integer
Side Effects
None
Description
This routine retrieves all trees from the database.
Dialog Forms Called
None
File Name
Syntax
R_LoadAttachedFilesForChange: INTEGER;
Parameters
None
Returns
Integer
Side Effects
None
Description
This routine retrieves all file attachments for a change.
Dialog Forms Called
None
File Name
Syntax
R_LoadChangeByID(REF this_Change: R_CHANGE_REC): INTEGER IS
Parameters
change_ID - ID of change to retrieve
Returns
Integer
Side Effects
None
Description
This routine retrieves a change from the database for the specified ID.
Dialog Forms Called
None
File Name
Syntax
R_LoadChangeTrees(REF treeList: LIST OF R_CTREE_REC): INTEGER IS
Parameters
treeList - List of trees retrieved
Returns
Integer
Side Effects
None
Description
This routine retrieves change trees from the database.
Dialog Forms Called
None
File Name
Syntax
R_LoadChangeTreesByChild(REF treeList: LIST OF R_CTREE_REC, VAL ID: INTEGER): INTEGER IS
Parameters
treeList - List of trees retrieved
Returns
Integer
Side Effects
None
Description
This routine retrieves change trees from the database by a child.
Dialog Forms Called
None
File Name
Syntax
R_LoadChangeTreesByParent(REF treeList: LIST OF R_CTREE_REC, VAL ID: INTEGER): INTEGER IS
Parameters
treeList - List of trees retrieved
Returns
Integer
Side Effects
None
Description
This routine retrieves change trees from the database by a parent.
Dialog Forms Called
None
File Name
Syntax
R_LoadCodesIntoComboBox(VAL w: WINDOW, VAL field_Name: STR VAL type: INTEGER, VAL all_Flag: STRING):INTEGER IS
Parameters
w - Current windoww
field_Name - Name of the combo box
type - Type of codes to display
all_Flag - Flag to determine if ALL should be displayed
Returns
Integer
Side Effects
None
Description
This routine loads appropriate codes into the specified combo box.
Dialog Forms Called
None
File Name
Syntax
R_LoadEntireChange: INTEGER IS
Parameters
None
Returns
Integer
Side Effects
None
Description
This routine retrieves an entire change record from the database.
Dialog Forms Called
None
File Name
Syntax
R_LoadImpactByCategory(REF this_Impact: R_IMPACT_REC): INTEGER IS
Parameters
this_Impact - impact record structure
Returns
Integer
Side Effects
None
Description
This routine retrieves impact from the database for an impact.
Dialog Forms Called
None
File Name
Syntax
R_LoadSchedulesFor_AChange: INTEGER IS
Parameters
None
Returns
Integer
Side Effects
None
Description
This routine retrieves scheduled tasks from the database for a change on the AChange stack verses the CStack stack.
Dialog Forms Called
None
File Name
Syntax
R_LoadTextForChangeComponent(VAL Type: INTEGER): INTEGER IS
Parameters
Type - the type of text to be returned
Returns
Integer
Side Effects
None
Description
This routine retrieves extended text from the database for a change field.
Dialog Forms Called
None
File Name
Syntax
R_PerformCategoryRI(VAL child: STRING): BOOLEAN IS
Parameters
child - category
Returns
Boolean
Side Effects
None
Description
When deleting a category, this routine insures that all child categories are not also a part of a change. NOTE: This is used only when deleting a category. The category is removed from R_G_Category_Codes at this point.
Dialog Forms Called
None
File Name
Syntax
R_QueryFindAsset (VAL w: WINDOW) IS
Parameters
w - Current window
Returns
Nothing
Side Effects
None
Description
This routine finds an asset.
Dialog Forms Called
None
File Name
Syntax
R_QueryProblemIds(VAL w: WINDOW) IS
Parameters
w - Current window
Returns
Nothing
Side Effects
None
Description
This routine queries problem IDs.
Dialog Forms Called
None
File Name
Syntax
R_RefreshMCLB(VAL w: Window, VAL this_Task: R_TASK_REC, VAL this_Request: R_CHANGE_REC, VAL updt_Percent: BOOLEAN) IS
Parameters
w - Current window
this_Task - Current task
this_Request - Current change request
updt_Percent - Boolean, update percent
Returns
Nothing
Side Effects
None
Description
After a user makes a change under "My Tasks," the system refreshes the MCLB to reflect them.
Dialog Forms Called
None
File Name
Syntax
R_ResourceRecordDatabase(VAL InTran: BOOLEAN, VAL this_Resource: R_RESOURCE_REC, VAL old_Resource: R_RESOURCE_REC
Parameters
InTran - Flag to determine whether in a transaction
this_Resource - Current schedule resource record
old_Resource - Old record for database concurrency
Returns
Nothing
Side Effects
None
Description
This routine handles addition, modification, and removal of resources.
Dialog Forms Called
None
File Name
Syntax
R_SchedCommandRecordDatabase(VAL InTran: BOOLEAN, VAL this_SchedCommand: R_SCHED_COMMANDS_REC, VAL old_SchedCommand: R_SCHED_COMMANDS_REC ): INTEGER IS
Parameters
InTran - Flag to determine whether in a transaction
this_SchedCommand - Current schedule command record
old_SchedCommand - Old record for database concurrency
Returns
Integer
Side Effects
None
Description
This routine handles addition, modification, and removal of schedule commands.
Dialog Forms Called
None
File Name
Syntax
R_SchedInvRecordDatabase(VAL InTran: BOOLEAN, VAL this_SchedInv: R_TASK_INV_REC, VAL old_SchedInv: R_TASK_INV_REC): INTEGER IS
Parameters
InTran - Flag to determine whether in a transaction
this_SchedInv - Current schedule inventory record
old_SchedInv - Old record for database concurrency
Returns
Integer
Side Effects
None
Description
This routine handles addition, modification, and removal of schedule inventory.
Dialog Forms Called
None
File Name
Syntax
R_ScheduleRecordDatabase(VAL InTran: BOOLEAN, VAL this_Task: R_TASK_REC, VAL old_Schedule: R_TASK_REC ): INTEGER IS
Parameters
InTran - Flag to determine whether in a transaction
this_Task - Current scheduled task record
old_Schedule - Old record for database concurrency
Returns
Integer
Side Effects
None
Description
This routine handles addition, modification, and removal of scheduled tasks.
Dialog Forms Called
None
File Name
Syntax
R_UpdateEscalationStatus(VAL Change_ID: INTEGER, VAL oldStatus_ID: STRING, VAL Alter_Flag: INTEGER, VAL Approver_ID: LIST OF STRING, VAL Approval_Alter_Flag: LIST OF INTEGER, VAL Approval_Disposition:LIST OF INTEGER, VAL Schedule_Change_ID: LIST OF INTEGER, VAL Schedule_Name: LIST OF STRING, VAL Status_ID: STRING, VAL Category: STRING) IS
Parameters
Change_ID - Change ID
oldStatus_ID - Status ID from Achanges
Alter_Flag - Alter flag
Approver_ID - List of approver IDs from the approvals record
Approval_Alter_Flag - List of approval alter flag state
Approval_Disposition - LISt of approval disposition
Schedule_Change_ID - List of chnage IDs from the schedule record
Schedule_Name - List of schedule names from the schedule record
Status_ID - Status_id of the current change
Category - Category from the current change
Returns
Nothing
Side Effects
None
Description
This routine updates an escalation status.
Dialog Forms Called
None
File Name
Syntax
R_UpdateTaskEscalationLogEntry IS
Parameters
None
Returns
Nothing
Side Effects
None
Description
This routine updates a task escalation log entry.
Dialog Forms Called
None
File Name
Syntax
R_UserChangesSQL: STRING IS
Parameters
None
Returns
String
Side Effects
None
Description
This routine creates a SQL query to fetch changes that belong to the current user.
Dialog Forms Called
None