File Name
Syntax
function AddProblemHistoryRecord( REF pHist: ProblemHistoryRecord ): integer;
Parameters
ProblemHistoryRecord - Problem History record to insert.
Returns
Nothing
Side Effects
None
Description
This function is used to add a Problem History ( Audit Trail ) record to the database.
Dialog Forms Called
None
File Name
Syntax
booleanRet:= AllowAnonymousCallers;
Parameters
None
Returns
BOOLEAN: allow_anonymous
Side Effects
None
Description
This function returns true if the system is configured to allow anonymous callers from the call registration screen.
Dialog Forms Called
None
File Name
Syntax
booleanRet:= AllowAllowMultipleCallReg;
Parameters
None
Returns
BOOLEAN: allow_mutliple_callreg
Side Effects
None
Description
This function returns true if the system is configured to allow multiple call registration screens to be open at one time.
Dialog Forms Called
None
File Name
Syntax
FUNCTION AssociateProbWithCall ( VAL call_ID: String, VAL session_ID: Integer, VAL problem_ID: String ): Integer;
Parameters
STRING - Current Call ID
STRING - Current Session ID
STRING - Current Problem ID
Returns
INTEGER - SQLUpdate return value
Side Effects
None
Description
This function is used to associate a problem with a call. Since a call can be created well before a problem, this functions relates the created or selected problem with the Call ID passed in.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
problemID -- The problem to check for local ownership.
Returns
1 -- If the problem is currently owned by this site.
0 -- If the problem is owned by another site.
<0 -- If a database error occured.
Side Effects
None
Description
Checks whether a particular problem is currently owned by the local site.
Dialog Forms Called
None
File Name
Syntax
booleanRet:= ConfirmEnd;
Parameters
None
Returns
BOOLEAN: confirm_end
Side Effects
None
Description
This function returns true if the system is configured to prompt the user before freezing.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
ProblemData - The problem data that will be broadcast to other sites
rw_id - Populated with the newly created remote work ID.
Returns
None
Side Effects
None
Description
This function creates a remote work record and the appropriate remote task records for the broadcast of a problem change. It is called from RTSRVOUT and RTCLTOUT because problems are updated on the client as well as by the closure agent.
Dialog Forms Called
None
File Name
Syntax
CreateInfoWork ( VAL TransactionType: INTEGER, VAL Table : STRING, VAL where : STRING, VAL site_id : STRING )
Parameters
TransactionType: INTEGER (TYPE OF INFO TRANSACTION)
id: STRING (ID OF PROBLEM, SOLUTION, USER, OR CHANGE)
Returns
Nothing
Side Effects
None
Description
This procedure creates a remote work record for an INFO transfer.
Dialog Forms Called
None
File Name
Syntax
stringRet:= DefaultCallCode;
Parameters
None
Returns
STRING: Default call code
Side Effects
None
Description
This function returns the value of the user configured default call code.
Dialog Forms Called
None
File Name
Syntax
integerRet:= DefaultSeverity;
Parameters
None
Returns
INTEGER: numeric severity code
Side Effects
None
Description
This function returns the value of the user configured default severity code.
Dialog Forms Called
None
File Name
Syntax
boolRet:= DoMultipleSessions ();
Parameters
None
Returns
BOOLEAN - TRUE if the multiple sessions flag has been set
Side Effects
None
Description
This function returns the Multiple sessions flag indicating whether the current user can start multiple problems per call.
Dialog Forms Called
None
File Name
Syntax
PROCEDURE EquipAPIInit;
Parameters
None
Returns
Nothing
Side Effects
None
Description
This function initializes the EQUIPAPI module by loading all available system into a global list.
Dialog Forms Called
None
File Name
Syntax
FUNCTION GetAidDialogFileName ( VAL aid: AidRecord ): STRING;
Parameters
aid - The Diagnostic Aid to base the form name off
of.
Returns
The name of the specific dialog form to
use when displaying the Work with or Add/Edit/View
dialogs.
Side Effects
None
Description
This function will return the specific dialog form to use based on the type of Diagnostic Aid the user is requesting to Work with. The form is based directly on the type that is stored in the AidRecord.
Dialog Forms Called
None
File Name
Syntax
FUNCTION GetDefaultCloseProbCode: STRING;
Parameters
None
Returns
STRING - Default Close Problem Code
Side Effects
None
Description
This function returns the default Close problem code that is currently active.
Dialog Forms Called
None
File Name
Syntax
FUNCTION GetDefaultOpenProbCode: STRING;
Parameters
None
Returns
STRING - Default Open Problem Code
Side Effects
None
Description
This function returns the default open problem code that is currently active.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
Returns
None
Side Effects
None
Description
None
Dialog Forms Called
None
File Name
Syntax
None
Parameters
Returns
None
Side Effects
None
Description
None
Dialog Forms Called
None
File Name
Syntax
GetProblemRTSites( VAL ProbID: STRING )
Parameters
ProblemData - The problem data that will be broadcast to other sites
rw_id - Populated with the newly created remote work ID.
Returns
LIST OF STRING (List of Sites for Problem)
Side Effects
None
Description
This function determines which sites have seen a problem and returns that list.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
colum -- The name of the column to search.
colValue -- The value in column to search for.
transactionTypes -- Used to return the transactions found
in the remote_work table.
Returns
1 on success, DB error otherwise.
Side Effects
None
Description
Searches the remote_work table for any work for the specified column and its value. Fills the TransactionTypes list with corresponding transaction types. Note: This function is only designed to work for columns of type STRING;
Dialog Forms Called
None
File Name
Syntax
InitializeTPM ();
Parameters
None
Returns
Nothing
Side Effects
None
Description
This function initializes the CallAPI module by loading the SYSTEM_PROFILE record into memory as well as severity levels and call codes.
Dialog Forms Called
None
File Name
Syntax
IsRemoteTransferViable( VAL win: WINDOW, REF userGroupNameIn: STRING, VAL ddmProblemCallID: STRING, VAL readProblemTable: BOOLEAN ): BOOLEAN
Parameters
Returns
TRUE if problem does not have a current site and the receiving
user IS located at the local site
FALSE if problem does not have a current site and the receiving
user IS NOT located at the local site
Side Effects
None
Description
This function looks to see if the problem_id is prepended with a site id, if so then the function will return true, else it will return false.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
Returns
None
Side Effects
None
Description
None
Dialog Forms Called
None
File Name
Syntax
None
Parameters
Returns
None
Side Effects
None. Globals Changed: None
Description
Checks to see if a diagnostic is in the process of activating a solution. Displays an error message if one is.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
Returns
TRUE if problem does not have a current site and the receiving
user IS located at the local site
FALSE if problem does not have a current site and the receiving
user IS NOT located at the local site
Side Effects
None
Description
This function looks to see if the problem_id is prepended with a site id, if so then the function will return true, else it will return false.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
A string to which the local site ID will be prepended.
Returns
The passed string with the local site ID prepended.
Side Effects
None
Description
Prepends the local site ID to the passed in string with a hyphen separator.
Dialog Forms Called
None
File Name
Syntax
ProblemTrans ( VAL Problem_ID: STRING, VAL rcv_user_id: STRING, VAL rcv_site_id: STRING, VAL snd_user_id: STRING ): INTEGER
Parameters
Problem_ID: STRING (Problem_ID to send)
rcv_user_id: STRING (user to recieve the problem transfer)
rcv_site_id: STRING (site to recieve the problem transfer)
snd_user_id: STRING (user sending the problem transfer)
Returns
The SQL error code of the Remote Work, Remote Task insert.
Side Effects
None
Description
This procedure creates a remote work record and initiates a problem transfer.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
None
Returns
list of String: list of call codes
Side Effects
None
Description
This function returns the list of call codes from the call_codes table.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
None
Returns
List of String: list of causes
Side Effects
None
Description
This function returns the list of cause ids from the cause table.
Dialog Forms Called
None
File Name
Syntax
RemoveRemoteWorkTask( REF rw_id:INTEGER, REF site_id:STRING ):BOOLEAN
Parameters
rw_id:INTEGER (remote work id)
site_id: STRING (site id of remote task)
Returns
True if successful.
Side Effects
None
Description
This procedure removes remote tasks.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
Returns
None
Side Effects
None
Description
Selects the problem history record looking for the modify_datetime value. will write a remote work record, create a remote task record, create a problemhistory record and call ea net to process the client request.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
Returns
None
Side Effects
None
Description
None
Dialog Forms Called
None
File Name
Syntax
function TextIsEnabled: BOOLEAN;
Parameters
None
Returns
TRUE if the FULCRUM text indexes are currently
enabled.
Side Effects
None
Description
This function indicates whether the fulcrum text indexes are currently enabled. It will return FALSE if TextIsInstalled is FALSE.
Dialog Forms Called
None
File Name
Syntax
function TextIsInstalled: BOOLEAN;
Parameters
None
Returns
TRUE if the connection has a TEXT_INDEX_SOURCE
defined for it.
Side Effects
None
Description
This function indicates whether the database has a TEXT_INDEX_SOURCE defined for it.
Dialog Forms Called
None
File Name
Syntax
BooleanRet:= UpdateUserOnTransfer;
Parameters
None
Returns
BOOLEAN - TRUE if we are to change owner at transfer time.
FALSE if we are to change owner at resume time.
Side Effects
None
Description
This function returns true if the owner of a problem should be changed to the target of a transfer when it is transferred and false if the owner should be changed only when the problem has been received by the target.
Dialog Forms Called
None
File Name
Syntax
booleanRet:= UseDescriptionAsStatus;
Parameters
None
Returns
BOOLEAN: use_desc_as_stat
Side Effects
None
Description
This function returns true if the system is configured to use the orriginal call description as the first problem status.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
Returns
TRUE if call record is found in table and was created by EA
FALSE if call record is found and call was not created by EA
EA or if a database error occured.
Side Effects
None
Description
This function looks for the call in the call table. DDM requires that the call be created by EA in order for it to be trasferred (with initial release of DDM). To determine if EA was the creating application, CREATOR_APP_ID is looked at and if it equals EA, then the record will be allowed to be transferred remotely.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
Returns
TRUE if problem record is not found in table or if problem
exists and problem was create by EA
FALSE if problem record is found and problem was not created by
EA or if a database error occured.
Side Effects
None
Description
This function looks for the problem in the problems table. DDM requires that the problem be created by EA in order for it to be trasferred (with initial release of DDM). To determine if EA was the creating application, CREATOR_APP_ID is looked at and if it equals EA, then the record will be allowed to be transferred remotely. Additionally, if the record is not found, then it can be determined that this is a new problem and may be transferred remotely as well.
Dialog Forms Called
None