File Name
Syntax
boolRet:= DoCallHistoryInquiry;
Parameters
None
Returns
Boolean - TRUE if the Call History inquiry window should be
displayed
Side Effects
None
Description
This function returns TRUE if the Call History Inquiry window should be displayed after Work with Call History has been selected.
Dialog Forms Called
None
File Name
Syntax
boolRet:= DoCallInquiry;
Parameters
None
Returns
Boolean - TRUE if the call inquiry window should be
displayed
Side Effects
None
Description
This function returns TRUE if the Call Inquiry window should be displayed after Work with Call has been selected.
Dialog Forms Called
None
File Name
Syntax
boolRet:= DoCRContactInquiry;
Parameters
None
Returns
Boolean - TRUE if the Contact inquiry window should
be displayed when the Contacts Button is
pressed from Call Registration
Side Effects
None
Description
This function returns TRUE if the Contact inquiry window should be displayed when the Contacts button is pressed from Call Registration.
Dialog Forms Called
None
File Name
Syntax
boolRet:= DoCRInventoryInquiry;
Parameters
None
Returns
Boolean - TRUE if the Inventory inquiry window should
be displayed when the Inventory Button is
pressed from Call Registration
Side Effects
None
Description
This function returns TRUE if the Inventory inquiry window should be displayed when the Inventory button is pressed from Call Registration.
Dialog Forms Called
None
File Name
Syntax
boolRet:= DoDispatchInquiry;
Parameters
None
Returns
Boolean - TRUE if the Dispatch inquiry window should be
displayed
Side Effects
None
Description
This function will return TRUE if the Dispatch Inquiry window should be displayed after Work with Dispatch has been selected.
Dialog Forms Called
None
File Name
Syntax
intRet:= DoTransfer ( whdl, call );
Parameters
Window - window on which to create dialog box
ResumeRecord - information relating to the transferred call.
Returns
Integer - DlgBox return value
Side Effects
None
Description
This function allows the user to enter the destination and notification information relating to a transferred call. The information that is entered is stored in the call reference parameter.
Dialog Forms Called
dispatch.dfc[newtransferform]
File Name
Syntax
boolRet:= DoWorkWithProblem;
Parameters
None
Returns
BOOLEAN - TRUE if the Work with Problem's dialog box should
be displayed during the Call Registration process
Side Effects
None
Description
This function returns TRUE if the Work with Problem dialog box should be displayed during the Call registration process, FALSE otherwise.
Dialog Forms Called
None
File Name
Syntax
stringRet:= GetDefaultTransferProbCode;
Parameters
None
Returns
String - Default transfer problem code
Side Effects
None
Description
This function returns the default transfer problem code that is currently active.
Dialog Forms Called
None
File Name
Syntax
intRet:= InquireCallHistories ( g_mainWindow, msgWindow, callHistRec, doInquiryProcess, allowSelect, doWorkWithProcess );
Parameters
g_main Window - the main window to receive system-wide messages
msg Window - message window or the direct parent to this
window.
CallHistoryRecord - the reference parameter that
accepts Call History information
Boolean - displays and processes the Call History Inquiry
screen
Boolean - allows a record to be selected from the Work
with process
Boolean - display and processes the Work with Call History
dialog box
Returns
Integer - last return value from the dialog box creation
process. If the Work with dialog box is displayed,
it returns the value from DlgCreate(). Otherwise,
it returns the value from Inquiry DlgBox().
Side Effects
None
Description
This function displays and processes the Call History Inquiry and Call History Work with dialog boxes. If the Inquiry flag is TRUE, it processes the inquiry and creates an SQL search string based on the values entered. If the Work With flag is TRUE, it displays the Work With screen with either all the Calls ( Inquiry flag = FALSE ) or a list of Calls that match the search criteria entered (Inquiry flag = TRUE ). If the user is allowed to select values, then the Call History Record is populated with the selected call information.
Dialog Forms Called
callhist.dfc[call_history_inquiry]
callhist.dfc[workwithcalls]
File Name
Syntax
intRet:= InquireDispatchCalls ( g_mainWindow, msgWindow, DispViewRec, doInquiryProcess, allowSelect, doWorkWithProcess );
Parameters
g-main Window - the main window to receive system-wide messages
msg Window - message window or the direct parent to this
window
DispatchViewRec - The reference parameter
accepts the Dispatch Call information
Boolean - displays and processes the Dispatch Call inquiry
screen
Boolean - allows a record to be selected from the Work
With process
Boolean - displays and processes the Work with Dispatch Call
dialog box
Returns
Integer - Last return value from the dialog box creation
process. If the Work with dialog box is displayed,
it returns the value from DlgCreate(). Otherwise it
returns the value from Inquiry DlgBox().
Side Effects
None
Description
This function is used to display and process the Call History Inquiry and Dispatch Call Work with dialog boxes. If the Inquiry flag is TRUE, it processes the Inquiry and creates an SQL search string based on the values entered. If the Work with flag is TRUE, it displays the Work with screen, with either all the Calls ( Inquiry flag = FALSE ) or a list of Calls matching the search criteria entered. ( Inquiry flag = TRUE ). If the user is allowed to select values, then the Dispatch View Record is populated with the Dispatch Call information selected.
Dialog Forms Called
dispatch.dfc[dispatch_inquiry]
dispatch.dfc[workwithdispatch]
File Name
Syntax
intRet:= QueryCallData ( call_ID, session_ID, callData );
Parameters
call_ID - call ID to search on
session_ID - session ID to search on
callDataRecord - reference paramater to store the call information
retrieved
Returns
Integer - SQL query return value
Side Effects
None
Description
This function is used to retrieve information relating to a specific call and session from the database. All information that is retrieved is stored in the parameter callData.
Dialog Forms Called
None
File Name
Syntax
RemoveDispatch ( dispatch_id );
Parameters
INTEGER - dispatch ID to delete
Returns
Nothing
Side Effects
None
Description
This function removes the dispatch record associated with the dispatch ID passed in.
Dialog Forms Called
None
File Name
Syntax
RequestCallDispatch ( whdl );
Parameters
Window - main window receiving system-wide messages
Returns
Nothing
Side Effects
None
Description
This function requests a call dispatch session.
Dialog Forms Called
None
File Name
Syntax
RequestCallRegister ( whdl );
Parameters
Window - main window receiving system-wide messages
Returns
Nothing
Side Effects
None
Description
This function requests a Call Registration session.
Dialog Forms Called
None
File Name
Syntax
RequestInquireCallHistory ( whdl );
Parameters
Window - main window in which system-wide messages are
handled
Returns
Nothing
Side Effects
None
Description
This function is used to request an Inquiry / Work with Call History session.
Dialog Forms Called
None
File Name
Syntax
RequestInquireDispatchCalls ( whdl );
Parameters
Window - Main window in which system-wide messages are
handled
Returns
Nothing
Side Effects
None
Description
This function is used to request an Inquiry / Work with Dispatch Calls session.
Dialog Forms Called
dispatch.dfc[dispatch_inquiry]
dispatch.dfc[workwithdispatch]
File Name
Syntax
intRet:= StartCall ( parent, processingMode );
Parameters
Window - parent Window
Integer - type of registration to take place
Returns
Integer - return value from WinCreate ()
Side Effects
None
Description
This function initiates a Call Registration session. Based on the value in the mode parameter, either a normal Registration or Dispatch Registration window is displayed.
Dialog Forms Called
calls.dfc[dispatchcall]
calls.dfc[call_registration]
File Name
Syntax
TransferCall ( whdl );
Parameters
Window - main window receiving system-wide messages.
Returns
Nothing
Side Effects
None
Description
This function requests that the current active call be transferred.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
DispatchViewRec
Returns
Nothing
Side Effects
None
Description
This function is used to select a Call Dispatch from the Work with Dispatch Calls dialog box. It pops up the Call Registration dialog box filled with the information from the selected dispatch call.
Dialog Forms Called
calls.dfc[call_registration]