Routines for closure.kb


AddSolution

File Name

closure.kb

Syntax

AddSolution ( soltionRec );

Parameters

SolutionsRecord - record that holds the solution information

window

Returns

Integer - result code of the SQL insert.

Side Effects

None

Description

This function inserts a record into the SOLUTIONS table.

Dialog Forms Called

None


CallOnlyRegister

File Name

closure.kb

Syntax

CallOnlyRegister( context );

Parameters

context - all data gathered from user for this call

Returns

TRUE - if the transfer was completed.

FALSE - if the transfer failed.

Side Effects

None

Description

This function is used to register a "call only" call code from the Call Registration dialog box.

Dialog Forms Called

None


ClosureViewerEvent

File Name

closure.kb

Syntax

None

Parameters

i - only passed because it is required for an event.

Returns

None

Side Effects

None

Description

This event is the main handler for the stand-alone closure monitor.

Dialog Forms Called

None


CollectProbTransferInfo

File Name

closure.kb

Syntax

intRet:= CollectProbTransferInfo ( whdl, ProbTransferInfo );

Parameters

Window - window on which to create dialog box

ProblemTransferRecord - destination record to hold

transfer information

Returns

INTEGER - Return value from DlgBox statement

Side Effects

None

Description

This function collects transfer problem information from the user. The information that is collected is stored in the reference parameter probTrans.

Dialog Forms Called

problems.dfc[transferform]


CollectProbTransferInfo

File Name

closure.kb

Syntax

intRet:= CollectProbTransferInfo ( whdl, ProbTransferInfo );

Parameters

Window - window on which to create dialog box

ProblemTransferRecord - destination record to hold

transfer information

Returns

Integer - Return value from DlgBox statement

Side Effects

None

Description

This function collects transfer problem information from the user. The information that is collected is stored in the reference parameter probTrans.

Dialog Forms Called

problems.dfc[transferform]


EA_CreateProblemTicket

File Name

closure.kb

Syntax

None

Parameters

Returns

None

Side Effects

None

Description

Populates the callData.location_id field.

Dialog Forms Called

None


EndPerformFreezeProblem

File Name

closure.kb

Syntax

boolRet:= EndPerformFreezeProblem ( ClosureRecord );

Parameters

ClosureData - closure record holding information about

the current call / problem.

Returns

Boolean

Side Effects

None

Description

This function freezes the currently active problem.

Dialog Forms Called

None


EndPerformTransferCall

File Name

closure.kb

Syntax

INTRET:= PerformTransferCall( closureData );

Parameters

closureData - the current closure record being processed

Returns

1 if the transfer was completed

-err if the transfer SQL failed

Side Effects

None

Description

This function performs all the database-related work when transferring a call. The data is gathered by the client and passed to the server with a closure record. The client side functionality is InitialPerformTransferCall.

Dialog Forms Called

None


EndSaveProblemState

File Name

closure.kb

Syntax

intRet:= EndSaveProblemState ( ClosureRecord )

Parameters

ClosureRecord

Returns

Boolean, TRUE = successfull processing, FALSE = failure

Side Effects

None

Description

This procedure creates a new problem or updates an existing one as apropriate. It is called by the freeze and transfer functionality of Tivoli Problem Management.

Dialog Forms Called

None


InitializeClosureServer

File Name

closure.kb

Syntax

None

Parameters

None

Returns

None

Side Effects

None

Description

This procedure is called on system startup to load all apropriate configuration data.

Dialog Forms Called

None


InitialPerformFreezeProblem

File Name

closure.kb

Syntax

boolRet:= InitialPerformFreezeProblem ( context );

Parameters

context - resume record holding information about

the current active call / problem.

Returns

Boolean

Side Effects

None

Description

This function freezes the currently active problem.

Dialog Forms Called

None


InitialPerformTransferCall

File Name

closure.kb

Syntax

BOOLRET:= PerformTransferCall( context );

Parameters

context - all data gathered from a user for this call

Returns

TRUE if the transfer was completed and

FALSE if the transfer failed.

Side Effects

None

Description

This function transfers a call from the Call Registration dialog box. There is no difference between transferring a call and dispatching a call. Calls can only be transferred from Call Registration. This client side opperation bundles the data gathered into a closure record and then passes that record to the application server.

Dialog Forms Called

None


InitialSaveProblemState

File Name

closure.kb

Syntax

boolRet:= InitialSaveProblemState ( ResumeRecord )

Parameters

ResumeRecord

Returns

Boolean, TRUE = successfull processing, FALSE = failure

Side Effects

None

Description

This procedure creates a new problem or updates an existing one as apropriate. It is called by the freeze and transfer functionality of Tivoli Problem Management.

Dialog Forms Called

None


LoginEvent

File Name

closure.kb

Syntax

None

Parameters

login record

Returns

None

Side Effects

None

Description

This is the event handler for the stand-alone closure monitor.

Dialog Forms Called

None


Main

File Name

closure.kb

Syntax

None

Parameters

args - command line arguments

Returns

None

Side Effects

None

Description

This is the main startup procedure for the stand-alone closure monitor.

Dialog Forms Called

tivint.dfc[frm_tiv_swdist]

tivint.dfc[frm_tiv_rc]

tivint.dfc[frm_tiv_password]

tivint.dfc[frm_tiv_rc_admin]


PerformSolveWith

File Name

closure.kb

Syntax

boolRet:= PerformSolveWith( ClosureRecord )

Parameters

ClosureRecord - closure record that holds information about the

current call / problem. Specificaly the solution method

field must be set to indicate the type of solution

being used.

Options are: SOLVE_WITH_SOLUTION

SOLVE_WITH_AID

SOLVE_WITH_DIAGNOSTIC

Returns

Boolean

Side Effects

None

Description

This procedure replaces PerformSolveWithAid, PerformSolveWithDiagnostic, and PerformSolveWithSolution. It applies existing solutions to problems that have passed the Call Registration dialog box.

Dialog Forms Called

None


ProcessASingleClosure

File Name

closure.kb

Syntax

None

Parameters

ClosureData - closure record holding the entire record

to be processed

Returns

None

Side Effects

None

Description

This procedure takes a closure record and dispatches it to the apropriate process based upon the TransactionType field within the record. Possible values are: CP_FREEZE_PROBLEM CP_TRANSFER_PROBLEM CP_TRANSFER_CALL CP_TRANSFER_DISPATCH CP_QUICK_SOLUTION CP_SOLVE_WITH. These are defined in closeapi.kb and are set by TRANS.KB when a closure record is written.

Dialog Forms Called

None


ProcessAssignedRecord

File Name

closure.kb

Syntax

None

Parameters

Closure_ID - ID of the closure record to be read and processed

Returns

None

Side Effects

None

Description

This procedure reads the PROBLEM_CLOSURE record that has been assigned and processes it.

Dialog Forms Called

None


ProcessClosureCompleted

File Name

closure.kb

Syntax

ProcessClosureCompleted(RetReq: SERVER_REQUEST)

Parameters

RetReq - return data from the application server

Returns

None

Side Effects

None

Description

This function is called when a request for a problem closure is returned from the application server as invoked from TSDSendClosureToServer. Any processing that needs to take place as a result of a closure record being completed should be done here.

Dialog Forms Called

None


ProcessClosureRecord

File Name

closure.kb

Syntax

None

Parameters

closure_id - the ID of the specific record to process

Returns

None

Side Effects

None

Description

This procedure is the main external interface to the closure.kb module. The application server can call this procedure and pass a distinct closure_id as ordered by a single client. That record is processed and then any missed records are picked up. The procedure can also be called with an $Unknown closure_id and all missed records will be searched.

Dialog Forms Called

None


ProcessMissedClosureRecords

File Name

closure.kb

Syntax

None

Parameters

None

Returns

None

Side Effects

None

Description

This procedure searches the PROBLEM_CLOSURE table for old records and attempts to process them. Records are marked with the current time when they are first picked up. If a record is old, it is assumed that the process that picked it up is no longer valid. The adminstrator can configure the amount of time that a record is allowed to age before it is picked up. The value is read from the softart.ini file into Missed_Record_Age.

Dialog Forms Called

None


TSDSendClosureToServer

File Name

closure.kb

Syntax

TSDSendClosureToServer(Closure: ClosureRecord)

Parameters

Closure - data for closure request

Returns

INTEGER - 1 if closure successfully sent

Side Effects

None

Description

This function is responsible for getting a closure to the application server. The current model makes this happen from the TSD client. It first writes the closure record to the database. Then, a message is sent to the application server that forces it to process that record.

Dialog Forms Called

None


UseSolution

File Name

closure.kb

Syntax

UseSolution ( solution_id );

Parameters

INTEGER - solution ID of the solution that has been applied to a problem

Returns

Nothing

Side Effects

None

Description

This function increments the solution count for the solution record based on the ID that is passed in.

Dialog Forms Called

None