Routines for r_api.kb


Change_OkToPaste

File Name

r_api.kb

Syntax

FUNCTION Change_OkToPaste(VAL wHdl: WINDOW, VAL table: STRING, VAL ID: STRING, VAL child_org: STRING, VAL parent_org: STRING): BOOLEAN

Parameters

wHdl - window handle of the calling dialog box

table - object for which this is a reference (for instance,location, inventory category, change category, connection)

ID - primary key ID for the table (for instance, location_id, h_object_id, category, connection_id)

child_org - organization ID that is currently assigned to the object

parent_org - organization ID of the node under which the object is being pasted

Returns

Boolean

Side Effects

None

Description

This function checks whether to paste a node under another object, given the new object's organization_id. Disallows from paste if it might violate rules in a multi-customer environment. Currently, TCM always returns a TRUE value.

Dialog Forms Called

None


CreateChangeFromCallRegistration

File Name

r_api.kb

Syntax

CreateChangeFromCallRegistration(VAL people_id: INTEGER, VAL location_id: STRING, VAL organization_id: STRING, VAL problem_id: STRING, VAL system: STRING, VAL component: STRING, VAL item: STRING, VAL module: STRING, VAL description: STRING, VAL severity: INTEGER, VAL inventory_id: STRING, VAL first_contact_id: STRING ) IS

Parameters

people_id - people ID of the caller / contact

location_id - location ID of the contact

organization_id - organization ID of the contact

problem_id - problem ID for the problem record

system - TPM system (Not used yet)

component - TPM component (Not used yet)

item - TPM item (Not used yet)

module - TPM module (Not used yet)

description - problem description

severity - TPM severity (Not used yet)

inventory_id - inventory ID if there is associated inventory

first_contact_id - first contact ID from the call registration dialog box

Returns

Nothing

Side Effects

Creates a change request.

Description

This procedure creates a new change request for a probem from the Call Registration dialog box in TPM. The data passed in is converted to a record of type ProblemRec and then passed off to R_EditChangesForProblem where TCM picks the record up and generates the change request.

Dialog Forms Called

None


DeleteChangeFromProblemID_API

File Name

r_api.kb

Syntax

DeleteChangeFromProblemID_API(VAL prob_id: STRING) IS

Parameters

prob_id - problem ID

Returns

Nothing

Side Effects

None

Description

This routine is a wrapper routine which enables TPM to delete all changes that are associated with a problem. This procedure should only be called by TPM when the problem has been cancelled by the user. The only changes that should be affected are those created from the New Change From Problem menu item.

Dialog Forms Called

None


DisplayChangesDialog

File Name

r_api.kb

Syntax

DisplayChangesDialog(Val wHdl: WINDOW, VAL Chng_Inv_VwList: LIST OF Chng_Inv_VwRec)

Parameters

wHdl - parent window handle

Chng_Inv_VwList - list of Chng_Inv_Vw records

Returns

list of Chng_Inv_Vw records

Side Effects

None

Description

This procedure populates the associated changes and invokes the change dialog box.

Dialog Forms Called

None


Do_TCM_Purge

File Name

r_api.kb

Syntax

Do_TCM_Purge(VAL PurgeWhdl: WINDOW, VAL Orgs: LIST OF STRING): INTEGER IS

Parameters

PurgeWhdl - window handle of the calling dialog

Orgs - organiztion ID of the organization being purged

Returns

Integer indicating success or failure

Side Effects

None

Description

This is a generic routine that can be called to invoke the purge action for TCM.

Dialog Forms Called

None


EditChangesForProblem

File Name

r_api.kb

Syntax

EditChangesForProblem( VAL Problem: ProblemRecord) IS

Parameters

Problem - the problem to which to restrict displayed changes

Returns

Nothing

Side Effects

None

Description

This procedure is a wrapper for R_EditChangesForProblem.

Dialog Forms Called

None


EEInstalled

File Name

r_api.kb

Syntax

EEInstalled: BOOLEAN IS

Parameters

None

Returns

Nothing

Side Effects

None

Description

This function returns a Boolean 'True' value indicating that Tivoli Change Management is installed.

Dialog Forms Called

None


FillChangesPage

File Name

r_api.kb

Syntax

FillChangesPage (VAL wHdl:WINDOW, VAL where:STRING) IS

Parameters

wHdl - current window handle

where - current where clause for SQL Select

Returns

Nothing

Side Effects

None

Description

This routine gets the list of associated changes and then calls the function to fill the change list box.

Dialog Forms Called

None


GetChangesForAssetList

File Name

r_api.kb

Syntax

GetChangesForAssetList (VAL wHdl: WINDOW, VAL AssetList: LIST OF INTEGER) IS

Parameters

wHdl - current window handle

AssetList - current asset list

Returns

Nothing

Side Effects

None

Description

This wrapper routine returns a list of changes for a given list of assets.

Dialog Forms Called

None


GetChangesForAssets

File Name

r_api.kb

Syntax

GetChangesForAssets( REF Chng_Inv_VwList: LIST OF Chng_Inv_VwRec, VAL where: STRING ,VAL orderby: STRING )

Parameters

Chng_Inv_VwList - list of Chng_Inv_Vw records

where - WHERE clause of select statement

orderby - ORDER BY condition for SQL Select

Returns

list of Chng_Inv_Vw records

Side Effects

None

Description

This procedure gets a list of changes associated with specific assets.

Dialog Forms Called

None


InvokeChangesDialog

File Name

r_api.kb

Syntax

InvokeChangesDialog(Val wHdl: WINDOW, VAL where: STRING, VAL viewType: INTEGER) IS

Parameters

wHdl - current window handle

where - current where clause for SQL Select

viewType - view or edit

Returns

Nothing

Side Effects

None

Description

This function is called when the user chooses to view changes from the asset list. It calls the function to get the associated changes, and then displays a warning message if no changes are found or invokes the Associated Changes dialog box with InvChangesEvent.

Dialog Forms Called

None


RW_UpdateEscalationStatus

File Name

r_api.kb

Syntax

RW_UpdateEscalationStatus(VAL Command: LIST OF STRING, VAL Args: LIST OF STRING) IS

Parameters

Command - command string

Args - values for command string

Returns

Nothing

Side Effects

None

Description

This wrapper routine updates change escalations.

Dialog Forms Called

None


ViewChange

File Name

r_api.kb

Syntax

ViewChange(Val ChangeID: INTEGER, REF Result: INTEGER ) IS

Parameters

ChangeID - change ID

Result - result of the change (0 = fails, 1= succeeds)

Returns

Nothing

Side Effects

The ChangeID must be a valid change ID.

Description

This wrapper routine will open the change notebook in view mode.

Dialog Forms Called

None