File Name
Syntax
EAAddProblemHistory(VAL problemID:STRING, VAL peopleID:INTEGER, VAL contactID:STRING, VAL EMAUserID:STRING, VAL histDescr:STRING, VAL confirmUser:BOOLEAN, REF userMessage:STRING, REF EAstatus:INTEGER, VAL sendNotification:BOOLEAN);
Parameters
problemID(I) - problem ID number
peopleID(I) - unique people identifier
EMAUserID(I) - TMG server TPM User ID (logged in)
histDescr(I) - text to insert in the history record
confirmUser(I) - flag that controls whether to check IDs
userMessage(O) - resulting text to send to user
EAstatus (O) - status integer
sendNotification(I) - flag that sends notification to the TPM user
Returns
1 = success
ERR_NONFATAL
ERR_FATAL
CLI_ERR_xxx
Side Effects
None
Description
This routine adds a problem history record to the indicated problem ID in the TPM database.
Dialog Forms Called
None
File Name
Syntax
EACreateInquiryRecord( VAL organizationID:STRING, VAL peopleID:INTEGER, VAL locationID:STRING, VAL contactID:STRING, VAL contactName:STRING, VAL phonenumber:STRING, VAL callCode:STRING, VAL severityCode:INTEGER, VAL system:STRING, VAL userID:STRING,
Parameters
description - user-provided description of problem
organizationID - end-user organization ID in TPM
peopleID - end-user people ID in TPM
locationID - end-user location ID in TPM
contactID - end-user contact ID in TPM
contactName - end-user contact name in TPM
phonenumber - end-user contact phone in TPM
callcode - call code for this problem
severityCode - numeric severity code for this call
system - system ID (in SCIM) in TPM
userID - TPM user ID
EAstatus - TPM status code
Returns
1 = success
ERR_NONFATAL - a non-fatal execution error occurred
ERR_FATAL - a fatal execution error occurred
Side Effects
None
Description
STRING, REF EAstatus:INTEGER); This routine creates an Inquiry call record in the TPM database.
Dialog Forms Called
None
File Name
Syntax
EACreateProblem( VAL organizationID:STRING, VAL peopleID:INTEGER, VAL locationID:STRING, VAL contactID:STRING, VAL contactName:STRING, VAL contactPhone:STRING, VAL callCode:STRING, VAL severityCode:INTEGER, VAL system:STRING, VAL assignee:STRING,
Parameters
organizationID - end-user organization ID in TPM
peopleID - end-user people ID in TPM
locationID - end-user location ID in TPM
contactID - end-user contact ID in TPM
contactName - end-user contact name in TPM
contactPhone - end-user contact phone in TPM
callcode - call code for this problem
severityCode - numeric severity code for this call
system - system ID (in SCIM) in TPM
assignee - TPM user to be assigned this problem
description - user provided description of problem
problemID - returned TPM problem ID code
userMessage - response to creator
EAstatus - TPM status code
Returns
1 = success
ERR_NONFATAL = failure
Side Effects
None
Description
STRING, REF problemID:STRING, REF userMessage:STRING, REF EAstatus:INTEGER); This routine creates a problem (and Call and Sesion) record in the TPM database.
Dialog Forms Called
None
File Name
Syntax
EAGetLists( REF severityList:LIST OF STRING, REF callcodeList:LIST OF STRING, REF systemList:LIST OF STRING,
Parameters
severityList - list of TPM severity values
callcodeList - list of TPM call code values
systemList - list of TPM system list
Returns
1 = success
Side Effects
None
Description
This routine loads or refreshes the lists used by the the TPM Defaults dialog box.
Dialog Forms Called
None
File Name
Syntax
EAGetProblemStatus( VAL problemID:STRING, VAL peopleID:INTEGER, VAL confirmUser:BOOLEAN, VAL withHistory:BOOLEAN, REF userMessage:STRING, REF problemCount:INTEGER, REF EAstatus:INTEGER );
Parameters
problemID(I) - problem ID number
peopleID(I) - unique people identifiers
confirmUser(I) - flag that controls whether to check IDs
withHistory(I) - flag that controls brief or full output
userMessage(O) - resulting text to send to user
EAstatus (O) - status integer
Returns
1 = success
ERR_NONFATAL
ERR_FATAL
CLI_ERR_xxx
Side Effects
None
Description
This routine gets a brief problem status from the database. If the request is 'full status', the routine gets a list of problem history records database and formats them into a response buffer. If no ID is supplied, this routine gives the 'brief status' of all problems submitted by this user.
Dialog Forms Called
None
File Name
Syntax
EALogin(VAL cmdLind:LIST OF STRING, REF userName:STRING);
Parameters
Returns
1 = success
0 = failure
Side Effects
None
Description
This routine performs TPM log in, as well as some other TPM initializations.
Dialog Forms Called
None
File Name
Syntax
EASelectAUser(VAL parentWindow: Window, REF userData: EMAUserDataRec);
Parameters
parentWindow - parent of the popup dialog box
userData - chosen contact (if any)
Returns
1 = success
0 = failure
Side Effects
None
Description
This routine queries the end-user (with a dialog box) for the identifier of a TPM user (help desk personnel) in the TPM database.
Dialog Forms Called
None
File Name
Syntax
EAUpdateContactRow(REF newRow: BindListRowRec, VAL oldRow: BindListRowRec);
Parameters
newRow - row with modified e-mail fields
oldRow - reference row for the new row to replace
Returns
1 = success
2 = the new row's email ID has already been used
-n = any SQLUpdate error code
Side Effects
None
Description
This routine updates the e-mail fields in a contact record in the TPM database.
Dialog Forms Called
None
File Name
Syntax
EAUpdateSolution( VAL solutionID:INTEGER,
Parameters
description - user's original problem description (must not be empty or $Unknown)
solutionID - ID of the solution used (must not be empty or $Unknown)
userMessage - buffer to recieve textual error message
EAstatus - integer database return code
Returns
1 = success
ERR_NONFATAL = a non-fatal execution error occurred
ERR_FATAL = a fatal execution error occurred
Side Effects
None
Description
STRING, REF userMessage:STRING, REF EAstatus:INTEGER); This routine updates a solution reference count using the Adaptive Learning Software.
Dialog Forms Called
None
File Name
Syntax
EAValidCallCode( VAL call_code:STRING);
Parameters
call_code - item to validate in the TPM tables
Returns
TRUE or FALSE
Side Effects
None
Description
This routine returns a BOOLEAN indicating whether the item is found in the TPM database.
Dialog Forms Called
None
File Name
Syntax
EAValidEAUser( VAL user_ID:STRING);
Parameters
user_ID - item to validate in the TPM tables
Returns
TRUE or FALSE
Side Effects
None
Description
This routine returns a BOOLEAN indicating whether the item is found in the TPM database.
Dialog Forms Called
None
File Name
Syntax
EAValidSeverityCode( VAL severity_code:STRING);
Parameters
severity_code - item to validate in the TPM tables
Returns
TRUE or FALSE
Side Effects
None
Description
This routine returns a BOOLEAN indicating whether the item is found in the TPM database.
Dialog Forms Called
None
File Name
Syntax
EAValidSystem( VAL system_ID:STRING);
Parameters
system_ID - item to validate in the TPM tables
Returns
TRUE or FALSE
Side Effects
None
Description
This routine returns a BOOLEAN indicating whether the item is found in the TPM database.
Dialog Forms Called
None
File Name
Syntax
SAIApplicationIsInstalled(VAL app_ID:INTEGER);
Parameters
app_ID - the application's integer ID
Returns
TRUE or FALSE
Side Effects
None
Description
This routine performs a BitAnd to determine if the bit for app_ID has been set in m_SAIApplicationMask, indicating that the specified application has been installed.
Dialog Forms Called
None
File Name
Syntax
SAIInitApplicationMask;
Parameters
None
Returns
1 = success
SQL Return Code
Side Effects
None
Description
This routine queries the SAI_APPLICATIONS table for all installed applications setting the associated bit in m_SAIApplicationMask.
Dialog Forms Called
None
File Name
Syntax
SAIRegisterApplication( REF appRec:SAIApplicationRec);
Parameters
appRec - record for SAI_APPLICATIONS table
Returns
TRUE or FALSE
Side Effects
None
Description
This routine queries the SAI_APPLICATIONS table for the existence of a TMG application record. If not found, a new record is inserted.
Dialog Forms Called
None
File Name
Syntax
UserSelectEventHandler(REF eventdata: UserEventRecord);
Parameters
eventdata - instance data for this dialog box type
Returns
1 = success
0 = failure
Side Effects
None
Description
This routine provides event handling for generic selections.
Dialog Forms Called
None