Routines for rmspj_bf.kb


R_AssignRelation

File Name

rmspj_bf.kb

Syntax

R_AssignRelation(VAL relation: INTEGER, VAL relationship: STRING, REF Schedule: R_TASK_REC) IS

Parameters

relation - Relation

relationship - Dependency Relationship

Schedule - R_TASK_REC

Returns

Nothing

Side Effects

None

Description

This routine assigns a dependency relationship.

Dialog Forms Called

None


R_BuildTopicFromChangeID

File Name

rmspj_bf.kb

Syntax

R_BuildTopicFromChangeID(VAL ID: INTEGER): STRING

Parameters

ID - Current change ID

Returns

String - Returns anticipated path of this change's

MS Project file for DDE.

Side Effects

None

Description

This routine constructs full topic path from a given change ID.

Dialog Forms Called

None


R_ConvertDDEPercentToReal

File Name

rmspj_bf.kb

Syntax

R_ConvertDDEPercentToReal(VAL strPercent: STRING): REAL IS

Parameters

strPercent - percent value to convert

Returns

Real

Side Effects

None

Description

This routine converts string percent value from MS Project into a data type of REAL.

Dialog Forms Called

None


R_CountDDEFields

File Name

rmspj_bf.kb

Syntax

R_CountDDEFields(VAL source: STRING): INTEGER IS

Parameters

source - DDE Data

Returns

Integer Number of elements in the DDE Data

Side Effects

None

Description

This routine counts DDE fields.

Dialog Forms Called

None


R_CreateDDEWindow

File Name

rmspj_bf.kb

Syntax

R_CreateDDEWindow

Parameters

None

Returns

Window Handler

Side Effects

None

Description

Creates an invisible window that handle DDE commications.

Dialog Forms Called

None


R_CreateDDEWindowEvent

File Name

rmspj_bf.kb

Syntax

R_CreateDDEWindowEvent

Parameters

None

Returns

Nothing

Side Effects

None

Description

Event Handler for CreateDDEWindow

Dialog Forms Called

None


R_CreateMSProjFile

File Name

rmspj_bf.kb

Syntax

R_CreateMSProjFile: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine creates and loads an MS Project file.

Dialog Forms Called

None


R_DDESetAlterFlag

File Name

rmspj_bf.kb

Syntax

R_DDESetAlterFlag(REF aFlag: INTEGER) IS

Parameters

aFlag - Alter Flag to set

Returns

Nothing

Side Effects

None

Description

This routine sets the alter flag for DDE info update.

Dialog Forms Called

None


R_DDEStatusMessage

File Name

rmspj_bf.kb

Syntax

R_DDEStatusMessage(VAL title: STRING, VAL message1: STRING, VAL message2: STRING, VAL warn: BOOLEAN) IS

Parameters

title - Title of Message Box

message1 - Message to Display

message2 - Message to Display

warn - Flag to display warning status dialog

Returns

Nothing

Side Effects

None

Description

This routine displays a DDE status message box.

Dialog Forms Called

rchg.dfc[ddestatus_warn]

rchg.dfc[ddestatus]


R_DDEStatusMsgEvent

File Name

rmspj_bf.kb

Syntax

R_DDEStatusMsgEvent(REF msgList: LIST OF STRING) IS

Parameters

msgList - List of Length 3, title and message1, message2

Returns

Nothing

Side Effects

None

Description

This is the event for the DDE status dialog. It initializes display messages.

Dialog Forms Called

None


R_DDEUpdateTaskDependency

File Name

rmspj_bf.kb

Syntax

R_DDEUpdateTaskDependency(VAL sList: LIST OF R_TASK_REC, VAL pList: LIST OF R_DDE_PRED_REC) IS

Parameters

sList - List of Schedules from MS Project

pList - List of Predecessor rec from MS Project

Returns

Nothing

Side Effects

None

Description

This routine updates relationships for each task.

Dialog Forms Called

None


R_DeleteDDETask

File Name

rmspj_bf.kb

Syntax

R_DeleteDDETask(VAL Schedule: R_TASK_REC) IS

Parameters

Schedule - Task record to be processed

Returns

Nothing

Side Effects

None

Description

This routine deletes a DDE task record.

Dialog Forms Called

None


R_DeleteMissingTasks

File Name

rmspj_bf.kb

Syntax

R_DeleteMissingTasks(VAL SchedList: LIST OF R_TASK_REC) IS

Parameters

SchedList - List of Schedules received from MS Project

Returns

Nothing

Side Effects

None

Description

This routine deletes those tasks from the change record that are not in the passed-in "SchedList".

Dialog Forms Called

None


R_ExtractChangeIDFromProject

File Name

rmspj_bf.kb

Syntax

R_ExtractChangeIDFromProject(VAL project: STRING): INTEGER IS

Parameters

project - MS Project Name

Returns

Integer

Side Effects

None

Description

This routine returns the Change ID from a MS Project Name.

Dialog Forms Called

None


R_FilterMyTasks

File Name

rmspj_bf.kb

Syntax

R_FilterMyTasks IS

Parameters

None

Returns

Nothing

Side Effects

None

Description

This routine filters "My Task" information.

Dialog Forms Called

None


R_FindSchedName

File Name

rmspj_bf.kb

Syntax

R_FindSchedName(VAL TaskID: INTEGER): STRING IS

Parameters

TaskID - Task ID to match to schedule name

Returns

String

Side Effects

None

Description

This routine returns the schedule name for a TaskID.

Dialog Forms Called

None


R_FindSuccsr

File Name

rmspj_bf.kb

Syntax

R_FindSuccsr(VAL TaskName: STRING): INTEGER IS

Parameters

TaskName - Task Name

Returns

Integer

Side Effects

None

Description

This routie finds a task successor.

Dialog Forms Called

None


R_GetCurrentDDEProjectIndex

File Name

rmspj_bf.kb

Syntax

R_GetCurrentDDEProjectIndex

Parameters

None

Returns

Integer - Returns current index of DDE Topic List

Side Effects

None

Description

This routine returns the current index of a DDE Topic List.

Dialog Forms Called

None


R_GetDDETopicListIndex

File Name

rmspj_bf.kb

Syntax

R_GetDDETopicListIndex(VAL projName: STRING): INTEGER IS

Parameters

projName - project Name, may have full path

Returns

Integer

Side Effects

None

Description

This routine matches the projName with one in G_DDETopicList and returns the index.

Dialog Forms Called

None


R_GetPredIndexForSchedule

File Name

rmspj_bf.kb

Syntax

R_GetPredIndexForSchedule(VAL sName: STRING, VAL pList: LIST OF R_DDE_PRED_REC): INTEGER IS

Parameters

sName - Schedule Name to match

pList - List of Predecessor records

Returns

Integer

Side Effects

None

Description

This routine returns an index of predecessor matching "sName".

Dialog Forms Called

None


R_GetProjectStartDate

File Name

rmspj_bf.kb

Syntax

R_GetProjectStartDate: DATE IS

Parameters

None

Returns

DATE

Side Effects

None

Description

This routine retrieves the projected start Date.

Dialog Forms Called

None


R_GetResourceName

File Name

rmspj_bf.kb

Syntax

R_GetResourceName(VAL ProjectID: INTEGER): STRING IS

Parameters

ProjectID - Project ID to match to Resource Name

Returns

String

Side Effects

None

Description

This routine returns a matching resource for a given project ID.

Dialog Forms Called

None


R_GetSchedDate

File Name

rmspj_bf.kb

Syntax

R_GetSchedDate(VAL Change: R_CHANGE_REC, VAL type: INTEGER): DATE IS

Parameters

Change - R_Change_REC

Type - Schedule Type

Returns

Integer

Side Effects

None

Description

This routine retrieves the "Schedule Date".

Dialog Forms Called

None


R_GetSchedIndex

File Name

rmspj_bf.kb

Syntax

R_GetSchedIndex(VAL SchedName: STRING): INTEGER IS

Parameters

SchedName - Schedule Name

Returns

Integer

Side Effects

None

Description

This routine returns an index for the matching schedule.

Dialog Forms Called

None


R_GetTaskID

File Name

rmspj_bf.kb

Syntax

R_GetTaskID(VAL Sched_Name: STRING): INTEGER IS

Parameters

Sched_Name - Current schedule name

Returns

Integer

Side Effects

None

Description

This routine returns the task ID for a given schedule name.

Dialog Forms Called

None


R_InitializeMasterSchedDDE

File Name

rmspj_bf.kb

Syntax

R_InitializeMasterSchedDDE(VAL msgHdl: WINDOW): INTEGER IS

Parameters

msgHdl - Window handle to DDE Status Window

Returns

Integer

Side Effects

None

Description

This routine sends "Master Schedule" information to MS Project.

Dialog Forms Called

None


R_InitializeMSProject

File Name

rmspj_bf.kb

Syntax

R_InitializeMSProject(VAL w: WINDOW) IS

Parameters

w - Current window

Returns

Nothing

Side Effects

None

Description

This routine initiates a DDE link with MSProject.

Dialog Forms Called

None


R_InitializeProjectSchedulerDDE

File Name

rmspj_bf.kb

Syntax

R_InitializeProjectSchedulerDDE(VAL msgHdl: WINDOW): INTEGER IS

Parameters

msgHdl - Current window Handler

Returns

Integer

Side Effects

None

Description

This routine initializes the DDE link with MS-Project.

Dialog Forms Called

None


R_IsDuplicateResource

File Name

rmspj_bf.kb

Syntax

R_IsDuplicateResource(VAL ResourceID: INTEGER, VAL ResourceType: STRING): BOOLEAN IS

Parameters

ResourceID - ID of resource to check

ResourceType - Resource type

Returns

Boolean

Side Effects

None

Description

This routine determines if resource is a valid resource for assignment.

Dialog Forms Called

None


R_IsResourceassigned

File Name

rmspj_bf.kb

Syntax

R_IsResourceassigned(VAL ResourceID: STRING, VAL TaskID: INTEGER): BOOLEAN IS

Parameters

ResourceID - Current Resource

TaskID - Current Task

Returns

Boolean

Side Effects

None

Description

This routine uses ResourceID and TaskID to determine if a resource is assigned to a task.

Dialog Forms Called

None


R_MPX_Numeric_Task_Def

File Name

rmspj_bf.kb

Syntax

R_MPX_Numeric_Task_Def(VAL MPXFile: FILE): INTEGER IS

Parameters

MPXFile - File handler

Returns

Integer

Side Effects

None

Description

This routine writes task definitions to a MPX File.

Dialog Forms Called

None


R_MPX_ProjHdr

File Name

rmspj_bf.kb

Syntax

R_MPX_ProjHdr(VAL MPXFile: FILE, VAL schedule: R_TASK_REC) IS

Parameters

MPXFile - File handler

Schedule - R_TASK_REC Schedule records

Returns

Nothing

Side Effects

None

Description

This routine writes the header for a MPX File.

Dialog Forms Called

None


R_MPX_RescDef

File Name

rmspj_bf.kb

Syntax

R_MPX_RescDef(VAL MPXFile: FILE): INTEGER IS

Parameters

MPXFile - File handler

Returns

Integer

Side Effects

None

Description

This routine writes a resource definition for a MPX File.

Dialog Forms Called

None


R_MPX_Resource

File Name

rmspj_bf.kb

Syntax

R_MPX_Resource(VAL MPXFile: FILE, VAL thisId: STRING, VAL rscType: STRING, VAL rscId: INTEGER): INTEGER IS

Parameters

MPXFile - File handler

thisId - People ID

rscType - Resource Type

rscId - Resource ID

Returns

Integer

Side Effects

None

Description

This routine writes a resource to a MPX File.

Dialog Forms Called

None


R_MPX_ResrcCal

File Name

rmspj_bf.kb

Syntax

R_MPX_ResrcCal(VAL MPXFile: FILE): INTEGER IS

Parameters

MPXFile - File handler

Returns

Integer

Side Effects

None

Description

This routine writes resource calculations to a MPX File.

Dialog Forms Called

None


R_MPX_Settings

File Name

rmspj_bf.kb

Syntax

R_MPX_Settings(VAL MPXFile: FILE) IS

Parameters

MPXFile - File handler

Returns

Nothing

Side Effects

None

Description

This routine writes standard settings to an MPX File.

Dialog Forms Called

None


R_MPX_Task_Res

File Name

rmspj_bf.kb

Syntax

R_MPX_Task_Res(VAL MPXFile: FILE, VAL thisResource: R_RESOURCE_REC, VAL rscId: INTEGER): INTEGER IS

Parameters

MPXFile - File Handler

thisResource - R_RESOURCE_REC

rscId - Resource ID

Returns

Integer

Side Effects

None

Description

This routine writes a task resource to a MPX File.

Dialog Forms Called

None


R_MPX_Tasks

File Name

rmspj_bf.kb

Syntax

R_MPX_Tasks(VAL MPXFile: FILE, VAL thisSchedule: R_TASK_REC,VAL id: INTEGER): INTEGER IS

Parameters

MPXFile - File handler

thisSchedule - Current Schedule

id - Schedule ID

Returns

Integer

Side Effects

None

Description

This routine writes tasks to a MPX File.

Dialog Forms Called

None


R_MPX_WriteFile

File Name

rmspj_bf.kb

Syntax

R_MPX_WriteFile(VAL Schedules: LIST OF R_TASK_REC, VAL id: INTEGER): INTEGER IS

Parameters

Schedules - List of R_TASK_REC

id - Schedule ID

Returns

Nothing

Side Effects

None

Description

This routine writes schedule information to an MPX File.

Dialog Forms Called

None


R_ParseassignmentInfoFromDDE

File Name

rmspj_bf.kb

Syntax

R_ParseassignmentInfoFromDDE(VAL this_DDEData: STRING) IS

Parameters

this_DDEData - DDE Data

Returns

Nothing

Side Effects

None

Description

This routine parses assignment information from DDE Source.

Dialog Forms Called

None


R_ParseDDEString

File Name

rmspj_bf.kb

Syntax

R_ParseDDEString(REF source: STRING, VAL delimiters: STRING): STRING IS

Parameters

source - DDE Data

delimiters - Delimited with

Returns

String DDE Data

Side Effects

None

Description

This routine parses DDE Data.

Dialog Forms Called

None


R_ParseResourceInfoFromDDE

File Name

rmspj_bf.kb

Syntax

R_ParseResourceInfoFromDDE(VAL this_DDEData: STRING) IS

Parameters

this_DDEData - DDE Data

Returns

Nothing

Side Effects

None

Description

This routine parses resource information from a DDE Source.

Dialog Forms Called

None


R_ParseSingleRelation

File Name

rmspj_bf.kb

Syntax

R_ParseSingleRelation(VAL token: STRING, REF Schedule: R_TASK_REC) IS

Parameters

token - Relationship Token

Schedule - R_TASK_REC

Returns

Nothing

Side Effects

None

Description

This routine parses a single task relation.

Dialog Forms Called

None


R_ParseTaskInfoFromDDE

File Name

rmspj_bf.kb

Syntax

R_ParseTaskInfoFromDDE(VAL this_DDEData: STRING) IS

Parameters

this_DDEData - DDE Data

Returns

Nothing

Side Effects

None

Description

This routine parses task data from DDE.

Dialog Forms Called

None


R_ParseTaskRelation

File Name

rmspj_bf.kb

Syntax

R_ParseTaskRelation(VAL token: STRING, REF Schedule: R_TASK_REC) IS

Parameters

token - MS Project relation string

Schedule - Schedule received from MS Project

Returns

Nothing

Side Effects

None

Description

This routine parses a task relation from MS Project and makes the equivalent TCM relation assignments.

Dialog Forms Called

None


R_ProcessDDEDataIntoChange

File Name

rmspj_bf.kb

Syntax

R_ProcessDDEDataIntoChange(VAL this_DDEData: STRING) IS

Parameters

this_DDEData - Current DDE data record

Returns

Nothing

Side Effects

None

Description

This routine translates information from MS-Project into the change.

Dialog Forms Called

None


R_ProcessMasterSchedDDE

File Name

rmspj_bf.kb

Syntax

R_ProcessMasterSchedDDE: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine processes the Master Schedules for DDE Processing.

Dialog Forms Called

None


R_ProcessSchedulerDDE

File Name

rmspj_bf.kb

Syntax

R_ProcessSchedulerDDE(VAL isActivity: BOOLEAN): INTEGER IS

Parameters

isActivity - Activity Status

Returns

Integer

Side Effects

None

Description

This routine processes scheduler information for MS-Project.

Dialog Forms Called

None


R_SendProjDDECmd

File Name

rmspj_bf.kb

Syntax

R_SendProjDDECmd(VAL VBCmd: STRING) IS

Parameters

VBCmd - Microsoft DDE Command

Returns

Nothing

Side Effects

None

Description

This routine sends MS Project a DDE Command.

Dialog Forms Called

None


R_SendProjDDECmd

File Name

rmspj_bf.kb

Syntax

R_SendProjDDECmd(VAL VBCmd: STRING) IS

Parameters

VBCmd - Visual Basic Command

Returns

Nothing

Side Effects

None

Description

This routine sends a MS Project command.

Dialog Forms Called

None


R_SendProjDDETask

File Name

rmspj_bf.kb

Syntax

R_SendProjDDETask(VAL Schedule: R_TASK_REC) IS

Parameters

Schedule - Task record to be processed

Returns

Nothing

Side Effects

None

Description

This routine sends MS Project a new or modified Task.

Dialog Forms Called

None


R_SendSingleChange

File Name

rmspj_bf.kb

Syntax

R_SendSingleChange(VAL msgHdl: WINDOW, VAL isActivity: BOOLEAN): INTEGER IS

Parameters

msgHdl - Window handler

isActivity - Activity Status

Returns

Integer

Side Effects

None

Description

This routine sends a single change to MS Project.

Dialog Forms Called

None


R_SetDDEProjectActiveFlag

File Name

rmspj_bf.kb

Syntax

R_SetDDEProjectActiveFlag(VAL Topic: STRING) IS

Parameters

Topic - DDE topic to have activity flag set to true

Returns

Nothing

Side Effects

None

Description

This routine sets the activity flag of each topic in the G_DDETopicList. If no topic is given then all topics become active.

Dialog Forms Called

None


R_StartDDETimer

File Name

rmspj_bf.kb

Syntax

R_StartDDETimer: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine starts the DDE Timer.

Dialog Forms Called

None


R_StopDDETimer

File Name

rmspj_bf.kb

Syntax

R_StopDDETimer: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine stops the DDE Timer.

Dialog Forms Called

None


R_TotalActCost

File Name

rmspj_bf.kb

Syntax

R_TotalActCost(VAL Act_Cost: STRING, REF Total_Cost: REAL) IS

Parameters

Act_Cost - Actual Cost

Total_Cost - Total Cost

Returns

Nothing

Side Effects

None

Description

This routine calculates "Total Cost".

Dialog Forms Called

None


R_UpdateDDEScheduleInfo

File Name

rmspj_bf.kb

Syntax

R_UpdateDDEScheduleInfo(VAL this_Task: R_TASK_REC) IS

Parameters

this_Task - Current task record

Returns

Nothing

Side Effects

None

Description

This routine updates MS Project information from a change.

Dialog Forms Called

None


R_VerifyCurrentTOS

File Name

rmspj_bf.kb

Syntax

R_VerifyCurrentTOS(VAL project: STRING): BOOLEAN IS

Parameters

project - Change to load to TOS

Returns

Boolean

Side Effects

None

Description

This routine checks if the MSProject change ID matches that of what is on the top of the change CStack. If it is not, then it walks through the cached changes on the Activities stack to try to find it. If found here, the record is pushed onto the CStack.

Dialog Forms Called

None