Routines for ea_api.kb


APIRequestPullRemoteProblemBack

File Name

ea_api.kb

Syntax

FUNCTION APIRequestPullRemoteProblemBack( VAL mode: INTEGER, VAL current_site: STRING, VAL problem_id: STRING, VAL win: WINDOW ): BOOLEAN

Parameters

mode - the mode the requesting user is in (RESUME_RESUME_MODE, RESUME_MERGE_MODE)

current_site - the current site of the problem

problem_id - the problem ID to be requested

win - the window handle of the requesting user

Returns

Nothing

Side Effects

None

Description

This API calls RequestPullRemoteProblemBack to resume a problem at the local site

Dialog Forms Called

None


CreateCommonProblemForDefect

File Name

ea_api.kb

Syntax

FUNCTION CreateCommonProblemForDefect(VAL defect_id: INTEGER, VAL user: STRING, VAL system: STRING, VAL component: STRING, VAL item: STRING, VAL module: STRING, VAL severity: INTEGER, VAL solution_text: STRING, VAL title: STRING, VAL defect_descr: STRING, REF solution_id: INTEGER, VAL organization_id: STRING): BOOLEAN IS

Parameters

defect_id - the defect ID to update

user - the user ID of the person adding the common problem

system - the system to be used for the common problem

component - the component to be used for the common problem

item - the item to be used for the common problem

module - the module to be used for the common problem

severity - the severity to be used for the common problem

solution_text - the solution text to be used for the common problem

title - the title of the common problem

defect_descr - the description text of the defect

solution_id - the solution ID to be used for the common problem

organization_id - the organization ID to be used for the common problem

Returns

True or False

Side Effects

None

Description

This function creates a common problem record for a defect

Dialog Forms Called

None


EAInstalled

File Name

ea_api.kb

Syntax

FUNCTION EAInstalled: BOOLEAN

Parameters

None

Returns

True or False

Side Effects

None

Description

This function identifies if the problem management code is installed.

Dialog Forms Called

None


FillAssetProblemsListBox

File Name

ea_api.kb

Syntax

FillAssetProblemsListBox(VAL wHdl: WINDOW, VAL Ses_Inv_VwList: LIST OF Ses_Inv_VwRec)

Parameters

whdl - handle of calling event ( not used ) provided for system action calling compatability

ses_inv_vwlist - list of assets associated with a problem

Returns

Nothing

Side Effects

None

Description

This routine fills the problem list box for the inventory item on the asset dialog box problems tab, or fills the problem list box on the Associated Problems dialog box when this dialog box is invoked from the asset list

Dialog Forms Called

None


FillProblemsPage

File Name

ea_api.kb

Syntax

PROCEDURE FillProblemsPage (VAL wHdl:WINDOW, VAL where:STRING )

Parameters

wHdl - window handle of the calling event

where - where clause for selecting problems

Returns

Nothing

Side Effects

None

Description

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

Dialog Forms Called

None


GetAssociatedProblems

File Name

ea_api.kb

Syntax

PROCEDURE GetAssociatedProblems(REF Ses_Inv_VwList: LIST OF Ses_Inv_VwRec, VAL where, orderby: STRING)

Parameters

ses_inv_vwlist - list of assets associated with a problem

where - where clause to select from SES_INV_VW

orderby - orderby clause to select from SES_INV_VW

Returns

Nothing

Side Effects

None

Description

This routine gets the problems associated with an inventory item or list of items

Dialog Forms Called

None


GetProblems

File Name

ea_api.kb

Syntax

GetProblems( VAL where: STRING, REF Ses_Inv_VwList: LIST OF Ses_Inv_VwRec )

Parameters

where - WHERE clause of select statement

Ses_Inv_VwList - list of Ses_Inv_Vw records

Returns

A list of Ses_Inv_Vw records based on the WHERE clause.

Side Effects

None

Description

This procedure will return a list of problems associated with a list of asset tags.

Dialog Forms Called

None


InvokeProblemsDialog

File Name

ea_api.kb

Syntax

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

Parameters

wHdl - window handle of the calling event

where - where clause for selecting problems

viewType - the type of view that is being requested

Returns

Nothing

Side Effects

None

Description

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

Dialog Forms Called

i_asset.dfc[wwinvprb]


LaunchChangeFromProblemAPI

File Name

ea_api.kb

Syntax

function LaunchChangeFromProblemAPI( val whdl: window ): boolean

Parameters

whdl - handle of calling event ( not used )

provided for system action calling compatability

Returns

True or False

Side Effects

None

Description

This function calls the routine in probapi that causes a problem window to spawn a defect. This function may be invoked as a system action or called directly.

Dialog Forms Called

None


LaunchDefectFromProblemAPI

File Name

ea_api.kb

Syntax

function LaunchDefectFromProblemAPI( val whdl: window ): boolean

Parameters

whdl - handle of calling event (not used) provided for system action calling compatability

Returns

True or False

Side Effects

None

Description

This function calls the routine in probapi that causes a problem window to spawn a defect. This function may be invoked as a system action or called directly.

Dialog Forms Called

None


LoadProbCodes

File Name

ea_api.kb

Syntax

PROCEDURE LoadProbCodes( REF problemCodes: LIST OF STRING )

Parameters

REF problemCodes - list of string

Returns

REF problemCodes - list of string

Side Effects

None

Description

This function loads all available problem types from the database into a list of strings.

Dialog Forms Called

None


LoadProblem

File Name

ea_api.kb

Syntax

FUNCTION LoadProblem ( REF localprobView: ProblemView, VAL problem_id:STRING ): BOOLEAN

Parameters

localprobView - the problem view record to pass back to the requesting user

problem_id - the problem ID that is being requested for viewing

Returns

True or False

Side Effects

None

Description

This function loads the problem view record for the the problem that a user chooses to view.

Dialog Forms Called

None


LoadWWProblems

File Name

ea_api.kb

Syntax

LoadWWProblems( VAL wHdl: WINDOW, VAL Ses_Inv_VwList: LIST OF Ses_Inv_VwRec )

Parameters

wHdl - parent window handle

Ses_Inv_VwList - list of Ses_Inv_Vw records

Returns

Nothing

Side Effects

None

Description

This procedure will populate the Work With Problems dialog box with problems associated with specific asset tags.

Dialog Forms Called

i_asset.dfc[wwinvprb]


Problem_OkToPaste

File Name

ea_api.kb

Syntax

FUNCTION Problem_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 this references (location, inventory category, change category, connection)

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

child_org - organization ID that is currently assigned to the object

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

Returns

True or False

Side Effects

None

Description

This function checks whether to paste a node under another object, given the new object's organization ID. Disallows paste if it might violate rules in a multi-customer environment.

Dialog Forms Called

None


RequestDefaultCloseProbCode

File Name

ea_api.kb

Syntax

RequestDefaultCloseProbCode( default_close_code )

Parameters

default_close_code - string to return the problem code

Returns

The default closed problem code is returned via the parameter.

Side Effects

None

Description

This procedure returns the default close problem code from a parameter.

Dialog Forms Called

None


RequestDefaultOpenProbCode

File Name

ea_api.kb

Syntax

RequestDefaultOpenProbCode( default_open_code )

Parameters

default_open_code - string to return the problem code

Returns

The default open problem code is returned via the parameter

Side Effects

None

Description

This procedure returns the default open problem code from a parameter.

Dialog Forms Called

None


RequestIsCallTypeInquiry

File Name

ea_api.kb

Syntax

RequestIsCallTypeInquiry( Call_code, call_only )

Parameters

Call_code - the call code to be evaluated

call_only - string to return the result

Returns

True in call_only if the CallType is Inquiry

Side Effects

None

Description

This procedure determines if the call code is call only and returns the result from a parameter.

Dialog Forms Called

None


RequestLocalSiteID

File Name

ea_api.kb

Syntax

RequestLocalSiteID( Site_ID )

Parameters

Site_ID - used to return the resulting site ID

Returns

The local site ID is returned via the parameter.

Side Effects

None

Description

This procedure looks up the local site ID and returns the result via a parameter.

Dialog Forms Called

None


UpdateCommonProblemForDefect

File Name

ea_api.kb

Syntax

FUNCTION UpdateCommonProblemForDefect( VAL solution_id: INTEGER, VAL msg: STRING): BOOLEAN

Parameters

solution_id - the solution ID to be updated

msg - the message text to be added to the solution text

Returns

True or False

Side Effects

None

Description

This function updates a common problem record for a defect.

Dialog Forms Called

None


ViewProblemAPI

File Name

ea_api.kb

Syntax

PROCEDURE ViewProblemAPI(VAL w: WINDOW, VAL problem_ID: STRING)

Parameters

w - handle of calling event

problem_id - the problem ID that is being requested for viewing

Returns

Nothing

Side Effects

None

Description

This routine loads the specific problem that may be associated with an inventory item or defect that the user chooses to view. It then calls the TPM function (viewProblem) to display the Problem Status dialog box.

Dialog Forms Called

None


WWModProblemsEvent

File Name

ea_api.kb

Syntax

EVENT WWModProblemsEvent(REF Ses_Inv_VwList: LIST OF Ses_Inv_VwRec)

Parameters

ses_inv_vwlist - list of assets associated with a problem

Returns

Nothing

Side Effects

None

Description

This event handler is used to handle the events in the associated Problem List dialog box. This dialog is invoked when the user chooses to view problems from the Asset List dialog box. The resulting list of problems may be for the selected asset or for all assets in the list.

Dialog Forms Called

None