File Name
Syntax
AddProblemHist( VAL PHist ProblemHistoryRecord, REF SQLErr: INTEGER);
Parameters
phist - problem history record
sqlerr - SQL error code
Returns
1 = success
-1 = failure
Side Effects
None
Description
This function sends a request to the application server to update a problem that has previously been created.
Dialog Forms Called
None
File Name
Syntax
GetADL( VAL description:STRING, REF adlmsg:STRING, REF ii:INTEGER );
Parameters
description - the text found in the body of the messages sent by the TMG user
(it contains a description of the problem the user is having)
adlmsg - text that is added to the body of the messages sent back to the TMG user
(this is determined by the response received from the app server)
ii - an integer used to keep track of the number of possible solutions found
Returns
adlmsg
Side Effects
None
Description
This function is called when a TMG user sends a Diagnose Problem command. A request is sent to the application server to retrieve possible solutions to the user's problem.
Dialog Forms Called
None
File Name
Syntax
SubmitProblem( VAL Closure: ClosureRecord, REF SQLErr: INTEGER, REF Problem_ID: STRING );
Parameters
closure - closure record containing problem info
sqlerr - SQL error code
problem_id - the unique problem identifier assigned by the application server
Returns
1 = success
-1 = failure
Side Effects
None
Description
This function sends a request to the application server to submit a problem.
Dialog Forms Called
None
File Name
Syntax
UseSolution( VAL solutionID:STRING,
Parameters
solutionID - the unique indentifier of the solution that was used
description - the text found in the body of the messages sent by the TMG user
(it contains a summary of the problem that this solutionID solved)
SQLerr - SQL error code
Returns
1 = success
-1 = failure
Side Effects
None
Description
STRING, REF SQLErr:INTEGER ); This function is called when a TMG user sends a Use Solution command. A request is sent to the application server to help improve the solution/description matching.
Dialog Forms Called
None
File Name
Syntax
ViewProblem( VAL ProbRec:ProblemRecord, REF usermsg:STRING );
Parameters
probrec - problem record containing the problem_id of the problem the user requested to view
usermsg - text that is added to the body of the message sent back to the TMG user
Returns
1 = success
-1 = failure
Side Effects
None
Description
This function sends a request to the application server to view a problem. In this case, the TMG user has provided a specific problem_ID so only the specified problem is retrieved.
Dialog Forms Called
None
File Name
Syntax
ViewProbNoID( VAL People_ID:INTEGER, REF aline:STRING );
Parameters
people_id - unique identifier of the person whose e-mail address is the one which submitted the command
aline - text that is added to the body of the message sent back to the TMG user
Returns
1 = success
-1 = failure
Side Effects
None
Description
This function sends a request to the application server to view a problem. In this case, the TMG user has not provided a specific problem_ID, so all problems created by this person are retrieved.
Dialog Forms Called
None
File Name
Syntax
WithHist( VAL problem_ID:STRING, REF probHistList:List of ProblemHistoryRecord, REF usermsg:STRING );
Parameters
problem_ID - the unique identifier of the problem the TMG user wishes to view
probHistList - list of problemhistoryrecord to allow the history entries of the problem to be retrieved
usermsg - text that is added to the body of the message sent back to the TMG user
Returns
1 = success
-1 = failure
Side Effects
None
Description
This function is called when a TMG user sends a View Problem With History command. It sends a request to the application server to retrieve the history entries for the specified problem.
Dialog Forms Called
None