File Name
Syntax
intRet:= CreateRTConfigDialog ( g_mainWindow, msgWindow, remTransRec );
Parameters
WINDOW - The main window to receive system-wide messages
WINDOW - Message Window or the direct parent to this
window.
Returns
INTEGER - Last return value from the dialog creation
process.
Side Effects
None
Description
This funciton is used to get the parameter values from the SAI_APP_PARAMS table and to pass them to RTCFG.KB for use in dialog creation.
Dialog Forms Called
rtcfg.dfc[remtrans_options]
File Name
Syntax
boolRet:= DoSiteInquiry;
Parameters
None
Returns
BOOLEAN - The configuration flag for User Inquiry.
Side Effects
None
Description
This function will return TRUE if the configuration flag for Site Inquiry contained on the Inquiry page of the Base configuration notebook is set. Otherwise it will return FALSE.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
String - Token to be expanded
String - Expanded problem ID.
Returns
1 - If the token was successfully expanded to a valid problem ID.
-100 - If the problem does not exist
<0 - If a database error occured.
Side Effects
None
Description
Accepts a Problem ID token of the form <SITEID->ID where SITEID- is optional. If <SITEID-> is not supplied, the problem is assumed to have originated at the local site. This function will determine whether the ID has the local SITEID prefix or not. The ID will also be padded with the appropriate number of zeros. This API is primarily used by EMA. For Example: At the site SPRFLD... BDRCK-5 yields BDRCK-00000005 5 yields SPRFLD-00000005 If the problem was created after DDM was installed, or 00000005 If the problem was created before DDM was installed.
Dialog Forms Called
None
File Name
Syntax
intRet:= InquireSites ( g_mainWindow, msgWindow, siteRec, doInquiryProcess, allowSelect, doWorkWithProcess );
Parameters
WINDOW - The main window to receive system-wide messages
WINDOW - Message Window or the direct parent to this
window.
BOOLEAN - Display and process the Site Inquiry screen
BOOLEAN - Allow a record to be selected from the Work
with process
BOOLEAN - Display and process the Sites Work with
Screen
Returns
INTEGER - Last return value from the dialog creation
process. It the Work with screen is displayed
will return the value from the DlgCreate() else
will return the value from the Inquiry
DlgBox().
Side Effects
None
Description
This function is used to display and process the Site Inquiry and Site Work with screens. If the Inquiry flag is TRUE will process the Inquiry and create a SQL search string based on the values entered. If the Work with flag is TRUE will display the Work with screen with either all the Sites ( Inquiry flag = FALSE ) or a list of Sites matching the search criteria entered in the Inquiry screen ( Inquiry flag = TRUE ). If the user is allowed to select values then the SiteRecord will be populated with the Group information selected by the user.
Dialog Forms Called
rtsites.dfc[rt_site_inquiry]
rtsites.dfc[rt_sites_nb]
File Name
Syntax
None
Parameters
String - Id of Problem in question.
Returns
1 - If the problem is currently owned by this site
0 - If the problem is owned by another site or queued to
be transferred to a remote site.
<0 - If a database error occured.
Side Effects
None
Description
Determines whether a problem is owned by the local site or a remote site.
Dialog Forms Called
None
File Name
Syntax
RequestInquireSites ( whdl );
Parameters
WINDOW - Main window in which system-wide messages are
handled.
Returns
Nothing
Side Effects
None
Description
This function is designed to be called as a system action. It is used to request an Inquiry / Work with Sites session.
Dialog Forms Called
rtsites.dfc[rt_site_inquiry]
rtsites.dfc[rt_sites_nb]
File Name
Syntax
RequestRemTransConfig ( whdl );
Parameters
WINDOW - Main window in which system-wide messages are
handled.
Returns
Nothing
Side Effects
None
Description
This function is designed to be called as a system action. It is used to request a Remote Transfer Configuration dialog.
Dialog Forms Called
None
File Name
Syntax
None
Parameters
NONE - calling function should have a string set equal to
the result of this function and evaluate the return of this function
for error handling. i.e...
USES RTAPI;
tempString: STRING;
tempString:= RetrieveLocalSiteID;
IF KNOWN( tempString ) THEN
do_something;
ELSE
handle_the_unknown;
END;
Returns
g_remTrans.site_id (DDM local site id)
Side Effects
None
Description
Function called to retrieve the Local Site ID.
Dialog Forms Called
None
File Name
Syntax
RTAPIInit (); Requirement: Must be called prior to calling other RTAPI functions (i.e. RetrieveLocalSiteId)
Parameters
USES RTAPI, must be declared in calling knowledgebase
Returns
Nothing
Side Effects
None
Description
This function initializes the DDM global SITE_ID variable from the SITES table for the local site.
Dialog Forms Called
None