File Name
Syntax
CleanupAttachmentPath(VAL path:STRING);
Parameters
path - current attachment path
Returns
The new path for saving attachment files
Side Effects
None
Description
This routine ensures that the attachment path is the correct format for a valid file path.
Dialog Forms Called
None
File Name
Syntax
CloseCommentFile(REF configData:ConfigDataRec);
Parameters
configData - configuration dialog box data structure
Returns
1 = success
Side Effects
None
Description
This routine closes the comment file.
Dialog Forms Called
None
File Name
Syntax
CommaStringToList( VAL str:STRING, REF strList:LIST OF STRING );
Parameters
str - input (comma) string
strlist - result list
Returns
Number of items in the new list (return value of ListLength)
Side Effects
None
Description
This function transforms a comma-delimited string into a list of strings.
Dialog Forms Called
None
File Name
Syntax
ConfigADLRefreshRate;
Parameters
None
Returns
A number between MIN_ and MAX_ADL_REFRESH_RATE
Side Effects
None
Description
This function retrieves the value of the Adaptive Learning Table refresh rate, set in the Configuration dialog box.
Dialog Forms Called
None
File Name
Syntax
ConfigAdminDeleteConfirm;
Parameters
None
Returns
TRUE or FALSE
Side Effects
None
Description
This function tests the state of the Delete confirmation flag.
Dialog Forms Called
None
File Name
Syntax
ConfigAdminModifyConfirm;
Parameters
None
Returns
TRUE or FALSE
Side Effects
None
Description
This function tests the state of the Modify confirmation flag.
Dialog Forms Called
None
File Name
Syntax
ConfigCommentCommandEnabled;
Parameters
None
Returns
TRUE or FALSE
Side Effects
None
Description
This function tests the enabled state of the Comment command.
Dialog Forms Called
None
File Name
Syntax
ConfigCommentWriteEntry(VAL str:STRING, VAL author:STRING);
Parameters
str - string to write to log(s)
author - author of comment
Returns
-1 = unable to write to file
1 = success
Side Effects
None
Description
This function writes a new comment entry to the comment file if file writing has been enabled. Otherwise, it does nothing. The entry includes the author, date, and time.
Dialog Forms Called
None
File Name
Syntax
ConfigCommentWriteLn(VAL str:STRING );
Parameters
str - string to write to log(s)
Returns
-1 = unable to write to file
1 = success
Side Effects
None
Description
This function writes the supplied string to the comment file if file writing has been enabled. Otherwise, it does nothing.
Dialog Forms Called
None
File Name
Syntax
ConfigCreateDialog(VAL parentwindow:WINDOW);
Parameters
parentWindow - window handle of the parent window for a new dialog box
Returns
2 = already up
1 = success
0 = failure
Side Effects
None
Description
This function creates a dialog box of type Config.
Dialog Forms Called
None
File Name
Syntax
ConfigCutoffAccount( VAL acctName:STRING );
Parameters
acctName - account name to search for
Returns
TRUE or FALSE
Side Effects
None
Description
This function tests the supplied account name against the list of account names to be deleted.
Dialog Forms Called
None
File Name
Syntax
ConfigDestroyDialog;
Parameters
None
Returns
1 = success
0 = failure
Side Effects
None
Description
This function destroys the dialog box of type Config.
Dialog Forms Called
None
File Name
Syntax
ConfigDiagnoseInquiryEnabled;
Parameters
None
Returns
TRUE or FALSE
Side Effects
None
Description
This function tests the enabled state of the setting of the "DIAGNOSE creates an Inquiry Record" flag.
Dialog Forms Called
None
File Name
Syntax
ConfigDlgRestoreData(REF configData:ConfigDataRec);
Parameters
configData - data return value
Returns
1 = success
0 = failure
Side Effects
None
Description
This function restores the dialog box data associated with this module from a file or database.
Dialog Forms Called
None
File Name
Syntax
ConfigEventHandler(REF configDlgData:ConfigDlgDataRec);
Parameters
configDlgData - instance data for this dialog box type
Returns
1 = success
0 = failure
Side Effects
None
Description
This routine provides event handling for the Configuration dialog box.
Dialog Forms Called
None
File Name
Syntax
ConfigGetData(REF configData:ConfigDataRec);
Parameters
configData - data return value
Returns
1 = success
0 = failure
Side Effects
None
Description
This function gets the dialog box data associated with this module.
Dialog Forms Called
None
File Name
Syntax
ConfigInitData;
Parameters
None
Returns
1 = success
0 = failure
Side Effects
None
Description
This function initializes the module data structure with information in the external data store.
Dialog Forms Called
None
File Name
Syntax
ConfigMaxMsgSize;
Parameters
None
Returns
A number, which is greater than or equal to MIN_MSG_SIZE
Side Effects
None
Description
This function retrieves the value of the TMG maximum outgoing message size in the Configuration dialog box.
Dialog Forms Called
None
File Name
Syntax
ConfigMaxMsgSizeType;
Parameters
None
Returns
STR_MSG_SIZE_TYPE_CHAR
STR_MSG_SIZE_TYPE_LINE
Side Effects
None
Description
This function retrieves the type of the TMG maximum outgoing message size in the Configuration dialog box.
Dialog Forms Called
None
File Name
Syntax
ConfigMaxSolsReturned;
Parameters
None
Returns
A number, which is greater than or equal to MIN_MSG_SIZE
Side Effects
None
Description
This function retrieves the value of the TMG maximum number of solutions returned in the Configuration dialog box.
Dialog Forms Called
None
File Name
Syntax
ConfigProblemAttachmentEnabled;
Parameters
None
Returns
TRUE or FALSE
Side Effects
None
Description
This function tests the enabled state of receiving attachments on a submit or update problem.
Dialog Forms Called
None
File Name
Syntax
ConfigSaveAttachments(VAL str:STRING, VAL author:STRING);
Parameters
str - string to write to log(s)
author - author of comment
Returns
-1 = unable to write to file
1 = success
Side Effects
None
Description
This function writes a new comment entry to the comment file if file writing has been enabled. Otherwise, it does nothing. The entry includes the author, date, and time.
Dialog Forms Called
None
File Name
Syntax
ConfigSetData(REF configData:ConfigDataRec);
Parameters
configData - data return value
Returns
1 = success
0 = failure
Side Effects
None
Description
This function sets the dialog box data associated with this module.
Dialog Forms Called
None
File Name
Syntax
ConfigShutDown(VAL callerStatus:INTEGER);
Parameters
callerStatus - caller's shutdown status
Returns
1 = success
0 = failure
Side Effects
None
Description
This function performs the final operations for this module in the expectation that the calling application is shutting down.
Dialog Forms Called
None
File Name
Syntax
ConfigStatsRefreshRate;
Parameters
None
Returns
A number between MIN_ and MAX_EMA_STATS_RATE
Side Effects
None
Description
This function retrieves the value of the TMG statistics update rate set in the Configuration dialog box.
Dialog Forms Called
None
File Name
Syntax
NewAttachFileName( VAL contact_ID:STRING, VAL oldFileName:STRING );
Parameters
contact_ID - the TPM contact ID
oldFileName - the original file name
Returns
The new file name
Side Effects
None
Description
This function generates a new file name based on the first four characters of the contact ID, followed by four digits. The original three character extension (if any) is retained.
Dialog Forms Called
None
File Name
Syntax
OpenCommentFile(REF configData:ConfigDataRec, VAL promptUserOnError:BOOLEAN, VAL closeCurrent:BOOLEAN );
Parameters
configData - configuration dialog box data structure
promptUserOnError - a flag to put up the msg box for errors
closeCurrent - a flag to indicate that if a file is open, close it
Returns
1 = success
0 = failure
-1 = see FOpen; operating system error code
-2 = bad file name
-3 = target file is full
Side Effects
None
Description
This routine opens or creates the comment file.
Dialog Forms Called
None
File Name
Syntax
PerformSelectAction(REF configDlgData:ConfigDlgDataRec, VAL dlgHandle:WINDOW, VAL controlName:STRING, VAL controlID:INTEGER);
Parameters
configDlgData - the instance data for this window
dlgHandle - window handle of the dialog box
controlName - name of the control selected
controlID - number ID of the control selected
$EventParm(3,T) - old value of the object
$EventParm(4,T) - new value of the object
Returns
1 = success
0 = failure
Side Effects
None
Description
This routine performs actions for controls in the Configuration dialog box.
Dialog Forms Called
None
File Name
Syntax
TransferAttribsToModuleRec(VAL configAttribList:LIST OF DBDialogAttribRec);
Parameters
configAttribList - structure containing data to be transferred to m_configData.dlgData record
Returns
1 = success
0 = failure
Side Effects
None
Description
This function transfers the database attributes list to the module data structure.
Dialog Forms Called
None
File Name
Syntax
TransferModuleRecToAttribs(VAL configAttribList:LIST OF DBDialogAttribRec);
Parameters
configAttribList - structure to receive data to be transferred to m_configData.dlgData record
Returns
1 = success
0 = failure
Side Effects
None
Description
This function transfers the module data structure contents database attributes list for transmission to the database.
Dialog Forms Called
None
File Name
Syntax
UpdateDialogFromData(REF configDlgData:ConfigDlgDataRec, VAL dlgHandle:WINDOW );
Parameters
configDlgData - the instance dialog data
dlgHandle - window handle of dialog box
Returns
1 = success
0 = failure
Side Effects
None
Description
This routine forces the GUI dialog box object state to conform to the values stored in the data fields.
Dialog Forms Called
None