Routines for pc_svcs.kb


AddAllCallElements

File Name

pc_svcs.kb

Syntax

function AddAllCallElements(VAL ParentWindow: WINDOW, REF ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): BOOLEAN;

Parameters

ParentWindow - This is the window to which one wants to attach error messages.

ECI_Call_ErrorRecord- This is new call information one wants to add.

Returns

TRUE, if successful, FALSE otherwise.

Side Effects

Adds records to the database for the given call information.

Description

This function adds a new call to the database, adding records to ECI_Call, ECI_Status, and ECI_Comments.

Dialog Forms Called

None


AddECI_Call

File Name

pc_svcs.kb

Syntax

function AddECI_Call(VAL ParentWindow: WINDOW, REF ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): BOOLEAN;

Parameters

ParentWindow - This is the window to which message windows to the user

will be attached.

ECI_Call_ErrorRecord - This is the record containing the call to be added to ECI_Call.

Returns

TRUE, if the call is added, FALSE otherwise.

Side Effects

This function adds a tuple to the ECI_Call table.

Description

This function adds a call to the ECI_Call table..

Dialog Forms Called

None


AddECI_Comments

File Name

pc_svcs.kb

Syntax

function AddECI_Comments(VAL ParentWindow: WINDOW, REF ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): BOOLEAN;

Parameters

ParentWindow - This is the window to which message windows to the user

will be attached.

ECI_Call_ErrorRecord - This is the record containing the comments to be added to ECI_Comments.

Returns

TRUE, if the comments are added, FALSE otherwise.

Side Effects

This function adds a tuple in the ECI_Comments table.

Description

This function adds comments to the ECI_Comments table..

Dialog Forms Called

None


AddECI_Customer

File Name

pc_svcs.kb

Syntax

function AddECI_Customer(VAL ParentWindow: WINDOW, REF ECI_Call_ErrorRecord: ECI_CallErrorRecordType: BOOLEAN;

Parameters

ParentWindow - This is the window to which message windows to the user

will be attached.

ECI_Call_ErrorRecord - This is the record for the customer to be added to ECI_Customer.

Returns

TRUE, if a customer is added, FALSE otherwise.

Side Effects

This function adds a tuple to the ECI_Customer table.

Description

This function adds a new customer to the ECI_Customer table.

Dialog Forms Called

None


AddECI_Message

File Name

pc_svcs.kb

Syntax

function AddECI_Message(REF ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): BOOLEAN;

Parameters

ECI_Call_ErrorRecord - This is the record containing the message to be added to ECI_Message.

Returns

TRUE, if the call is added, FALSE otherwise.

Side Effects

This function adds a tuple to the ECI_Message table.

Description

This function adds a call to the ECI_Message table..

Dialog Forms Called

None


AddECI_Status

File Name

pc_svcs.kb

Syntax

function AddECI_Status(VAL ParentWindow: WINDOW, REF ECI_Call_ErorRecord: ECI_Call_ErrorRecordType): BOOLEAN;

Parameters

ParentWindow - This is the window to which message windows to the user

will be attached.

ECI_Call_ErrorRecord - This is the record containing the status to be added to ECI_Status.

Returns

TRUE, if the status is added, FALSE otherwise.

Side Effects

This function adds a tuple in the ECI_Status table.

Description

This function adds a status to the ECI_Status table.

Dialog Forms Called

None


AddProblemHistoryAndDisplayMessage

File Name

pc_svcs.kb

Syntax

procedure AddProblemHistoryAndDisplayMessage(VAL ParentWindow: WINDOW, VAL ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType);

Parameters

ParentWindow - The window to which to attach error messages.

ECI_Call_ErrorRecord - This is the record with call information to be enqueued.

Returns

Nothing

Side Effects

None

Description

This procedure adds entries to the TPM problem history and gives a confirming message for an ECI call that has been enqueued.

Dialog Forms Called

None


AddProblemHistoryForECI

File Name

pc_svcs.kb

Syntax

procedure AddProblemHistoryForECI(VAL Problem_ID: STRING,

Parameters

ParentWindow - The window to which to attach messages.

Problem_ID - This is the ID of the TPM Problem to which the problem

history record will be associated.

Entry_Type - This is a synopisis of the problem history description.

Description - This is a description of what has changed in problem history.

Returns

Nothing

Side Effects

None

Description

STRING, VAL Description: STRING); This procedure adds a new problem history record for a TPM problem history record. It DOES check whether Problem_ID is $Unknown.

Dialog Forms Called

None


AddProblemHistoryForECI_Call

File Name

pc_svcs.kb

Syntax

procedure AddProblemHistoryForECI_Call(VAL ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType);

Parameters

ParentWindow - The window to which to attach messages.

ECI_Call_ErrorRecord - This is the record for the call to which the history record is related.

Returns

Nothing

Side Effects

None

Description

This procedure adds a new problem history record for a TPM problem history record. It DOES check whether Problem_ID is $Unknown. It is specifically for problem history records related to ECI calls.

Dialog Forms Called

None


ArchiveECI

File Name

pc_svcs.kb

Syntax

function ArchiveECI: BOOLEAN;

Parameters

None

Returns

TRUE, if the archive was successful, FALSE otherwise.

Side Effects

None

Description

This function will archive ECI calls that have been closed or cancelled and are older than the conifgured hold time.

Dialog Forms Called

None


BuildWhereString

File Name

pc_svcs.kb

Syntax

FUNCTION BuildWhereString(REF ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): INTEGER;

Parameters

ECI_Call_ErrorRecord - This is the customer record in which the new where string

will be placed.

Returns

The return value of SQLCreateSearchString, e.g., 1 for successful completion..

Side Effects

None

Description

This function builds a string for use as a where clause for searching for ECI customers.

Dialog Forms Called

None


CloseConnection

File Name

pc_svcs.kb

Syntax

function CloseConnection: INTEGER;

Parameters

None

Returns

0, if the operation fails, 1 otherwise.

Side Effects

Closes the currently open ECI connection.

Description

This procedure closes the currently open ECI connection.

Dialog Forms Called

None


CloseQueue

File Name

pc_svcs.kb

Syntax

function CloseQueue: INTEGER;

Parameters

None

Returns

0, if the operation fails, 1 otherwise.

Side Effects

Closes the currently open ECI queue.

Description

This procedure closes the currently open ECI queue.

Dialog Forms Called

None


ConfirmECI_Customer

File Name

pc_svcs.kb

Syntax

function ConfirmECI_Customer(REF ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): INTEGER;

Parameters

ECI_Call_ErrorRecord - This record contains customer information to

- be confirmed.

Returns

TRUE if the record is found, FALSE otherwise.

Side Effects

None

Description

This function determines whether a given customer already exists in ECI_Customer by attempting to find the customer with information in the ECI_Call_ErrorRecord. If the record is present, the record's ID is put into the given record.

Dialog Forms Called

None


ConfirmOrAddECI_Customer

File Name

pc_svcs.kb

Syntax

function ConfirmOrAddECI_Customer(VAL PaerentWindow: WINDOW, REF ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): BOOLEAN;

Parameters

ParentWindow - This is the window to which to attach error messages.

ECI_Call_ErrorRecord - This record contains customer information to

- be confirmed or added.

Returns

TRUE, if the customer already exists or was added, FALSE otherwise.

Side Effects

None

Description

This function determines whether a given customer already exists in ECI_Customer. If they do not, the function attempts to add them. It changes the value of the Customer_ID component of the input record to either the existing customer's id or the new id created for the new customer.

Dialog Forms Called

None


ContructECIMessage

File Name

pc_svcs.kb

Syntax

function ConstructECIMessage(VAL RecordType: STRING, VAL ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): STRING;

Parameters

RecordType - This is the record type, a number from 001-4096 cast

- as a string. It MUST be 4 characters in length, e.g.,

- a Type 0001 record would have a RecordType of '0001'.

ECI_Call_ErrorRecord - This is the record containing the information

- to be put into an ECI message. The elements

- of the record, like the customer phone number,

- MUST already be in the proper format to be

- sent to ECI. In the example of the customer

- phone number, it must be a 10 digit number, with

- no parentheses or dashes. Also, all strings

- are assumed to be of the maximum appropriate

- length for the given field in an ECI record or

- less.

Returns

An ECI message.

Side Effects

None

Description

This function constructs an ECI message, which is a string, from local records. It assumes that RecordType is a member of the set {'0001', '0002', '0004'}.

Dialog Forms Called

None


CustomerInquiry

File Name

pc_svcs.kb

Syntax

FUNCTION CustomerInquiry(VAL ParentWindow: WINDOW, REF ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): BOOLEAN;

Parameters

ParentWindow - This is the parent window to which the inquiry window will be

attached.

ECI_Call_ErrorRecord - This is the record from which the initial values

- on the inquiry screen will be taken and into which changes

- from the user will be put.

Returns

TRUE if the dialog box was accepted without problems, FALSE otherwise, e.g., if

the operation was cancelled by the user.

Side Effects

None

Description

This function gets criteria for a search of ECI_Customer from the user.

Dialog Forms Called

eci_cust.dfc[eci_customer_inquiry]


DeleteECI_Call

File Name

pc_svcs.kb

Syntax

function DeleteECI_Call(VAL ParentWindow: WINDOW, VAL Originating_ID: STRING): BOOLEAN;

Parameters

ParentWindow - This is the window to which to attach error messages.

Originating_ID - This is the ID for the call information to be deleted.

Returns

TRUE, if everything is deleted, FALSE otherwise.

Side Effects

Delete tuples from ECI_Call, ECI_Status, and ECI_Comments.

Description

This procedure deletes a call, along with all of its associated status records and comments records. One should note that, unlike DeleteECI_Status and DeleteECI_Comments, this function assumes that it _always_ has a valid parent window.

Dialog Forms Called

None


DeleteECI_Comments

File Name

pc_svcs.kb

Syntax

function DeleteECI_Comments(VAL ParentWindow: WINDOW, VAL ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): BOOLEAN;

Parameters

ParentWindow - This is the window to which message windows to the user

will be attached.

ECI_Call_ErrorRecord - This is the record containing the comments to be deleted in ECI_Status.

Returns

TRUE, if the comments were deleted or were not found, FALSE otherwise.

Side Effects

This function deletes a tuple from the ECI_Comments table.

Description

This function deletes comments from the ECI_Comments table. One should note that it does NOT raise an error, and will return TRUE, if the comments are not found.

Dialog Forms Called

None


DeleteECI_Status

File Name

pc_svcs.kb

Syntax

function DeleteECI_Status(VAL ParentWindow: WINDOW, VAL ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): BOOLEAN;

Parameters

ParentWindow - This is the window to which message windows to the user

will be attached.

ECI_Call_ErrorRecord - This is the record containing the status to be deleted in ECI_Status.

Returns

TRUE, if the status is deleted or not found, FALSE otherwise.

Side Effects

This function deletes a tuple from the ECI_Status table.

Description

This function deletes a status from the ECI_Status table. One should note that it does NOT raise an error if the status is not found.

Dialog Forms Called

None


ECI_CallStatusInquiry

File Name

pc_svcs.kb

Syntax

function ECI_CallStatusInquiry(VAL ParentWindow: WINDOW, REF ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): BOOLEAN;

Parameters

ParentWindow - The window to which to attach error messages.

ECI_Call_ErrorRecord - This is the record to contain search criteria for ECI call status information.

Returns

TRUE, if successful, FALSE otherwise.

Side Effects

None

Description

This function gets criteria for a search of ECI_call information from the user.

Dialog Forms Called

eci_call.dfc[status_inquiry]


ECI_Out_QueueSize

File Name

pc_svcs.kb

Syntax

FUNCTION ECI_Out_QueueSize: INTEGER;

Parameters

None

Returns

The current number of entries in the ECI_Out_Queue table if the read is

successful, -1 otherwise.

Side Effects

None

Description

This function returns the current size of the ECI_Out_Queue table or, if there is an error, -1.

Dialog Forms Called

None


ECIDateToPrettyDate

File Name

pc_svcs.kb

Syntax

function ECIDateToPrettyDate(VAL ECIDate: STRING): STRING;

Parameters

ECIDate - This is a date in ECI's YYYYMMDD format.

Returns

A date string in the current date format.

Side Effects

None

Description

This function converts a string in ECI's YYYYMMDD date format into a string with the date in the current date format.

Dialog Forms Called

None


ECILogon

File Name

pc_svcs.kb

Syntax

function ECILogon(VAL ParentWindow: WINDOW, VAL UseMonitorScreen: BOOLEAN): BOOLEAN;

Parameters

ParentWindow - This is the window to which to attach message boxes or

- to which to post messages, depending on the value of

- UseMonitorScreen.

UseMonitorScreen - This tells the procedure whehter to send messages

to the monitor screen.

Returns

TRUE, if logon to ECI is successful, FALSE otherwise.

Side Effects

Adds records to the database related to ECI messages. Empties the table ECI_OUT_QUEUE. Removes messages from remote ECI queue and stores them in the database.

Description

This procedure makes a connection to ECI, sends messages from the database table eci_out_queue, gets messages, parses the new messages, and puts them in the database.

Dialog Forms Called

None


ECITimeToPrettyTime

File Name

pc_svcs.kb

Syntax

function ECITimeToPrettyTime(VAL ECITime: STRING): STRING;

Parameters

ECITime - This is a time in ECI's HHMMSS format.

Returns

A time string in the current time format.

Side Effects

None

Description

This function converts a string in ECI's HHMMSS time format into a string with the time in the current time format.

Dialog Forms Called

None


ECIToClosure

File Name

pc_svcs.kb

Syntax

function ECIToClosure(VAL ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): ClosureRecord;

Parameters

ECI_Call_ErrorRecord - This record contains the data to be translated and copied into a closure record.

Returns

A closure record with the information from the ECI_Call_ErrorRecord.

Side Effects

None

Description

This function translates and copies information from an ECI_Call_ErrorRecord into a closure record for all of the fields that are common to the three processes of creating a new call, creating a new problem, and resolving a problem.

Dialog Forms Called

None


EnqueueCall

File Name

pc_svcs.kb

Syntax

function EnqueueCall(VAL ParentWindow: WINDOW, REF ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType, VAL OldECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): BOOLEAN;

Parameters

ParentWindow - The window to which to attach error messages.

ECI_Call_ErrorRecord - This is the record with call information to be enqueued.

OldECI_Call_ErrorRecord - This is the record with call information

that resulted in an error.

Returns

TRUE, if successful, FALSE otherwise.

Side Effects

This function adds and deletes call records in the database. Also, it puts messages into ECI_OUT_QUEUE.

Description

This function adds a given call record in the database, possibly deletes an old call that was in error from the database, and adds the new call message to ECI_OUT_QUEUE for transmission to ECI.

Dialog Forms Called

None


EnqueueECI_Comments

File Name

pc_svcs.kb

Syntax

function EnqueueECI_Comments(VAL ParentWindow: WINDOW, REF ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType, VAL OldECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): BOOLEAN;

Parameters

ParentWindow - The window to which to attach error messages.

ECI_Call_ErrorRecord - This is the record with comments information to be enqueued.

OldECI_Call_ErrorRecord - This is the record with comments information

that resulted in an error.

$UNKNOWN

Returns

TRUE, if successful, FALSE otherwise.

Side Effects

This function adds and deletes comments records in the database. Also, it puts messages into ECI_OUT_QUEUE.

Description

This function adds a given comments record in the database, possibly deletes an old set of comments that were in error from the database, and adds the new comments message to ECI_OUT_QUEUE for transmission to ECI.

Dialog Forms Called

None


EnqueueECI_Status

File Name

pc_svcs.kb

Syntax

function EnqueueECI_Status(VAL ParentWindow: WINDOW, REF ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): BOOLEAN;

Parameters

ParentWindow - The window to which to attach error messages.

ECI_Call_ErrorRecord - This is the record containing information

- about the status to be enqueued.

Returns

TRUE, if successful, FALSE otherwise.

Side Effects

This function adds a record to ECI_OUT_QUEUE.

Description

This function adds a given status record to ECI_OUT_QUEUE for transmission to ECI.

Dialog Forms Called

None


EnqueueMessage

File Name

pc_svcs.kb

Syntax

function EnqueueMessage(VAL ParentWindow: WINDOW, VAL RecordType: STRING, VAL Message: STRING): BOOLEAN;

Parameters

ParentWindow - The window to which to attach an error message.

RecordType - This is the record type of the message to be enqueued.

Message - This is the message to be enqueued.

Returns

TRUE, if successful, FALSE otherwise.

Side Effects

This function adds a record to ECI_OUT_QUEUE.

Description

This function adds a record to ECI_OUT_QUEUE for transmission to ECI.

Dialog Forms Called

None


GetECIDate

File Name

pc_svcs.kb

Syntax

FUNCTION GetECIDate: STRING;

Parameters

None

Returns

The current date as a string in the format YYYYMMDD.

Side Effects

None

Description

This function returns the current date as a string in the format YYYYMMDD.

Dialog Forms Called

None


GetECITime

File Name

pc_svcs.kb

Syntax

FUNCTION GetECITime: String;

Parameters

None

Returns

The current time as a string in the format HHMMSS.

Side Effects

None

Description

This function returns the current time as a string in the format HHMMSS.

Dialog Forms Called

None


GetStatus_Desc

File Name

pc_svcs.kb

Syntax

function GetStaus_Desc(VAL Status_Code: STRING): STRING;

Parameters

Status_Code - The status code for which one wants a description.

Returns

The description of the given status code.

Side Effects

None

Description

This function returns the description of a given status code.

Dialog Forms Called

None


Left0Pad

File Name

pc_svcs.kb

Syntax

FUNCTION Left0Pad(VAL OldString: STRING, VAL Length: INTEGER): STRING;

Parameters

OldString - This is the string to be padded.

Length - The length of the newly padded string.

Returns

OldString left padded with 0s to the length of Length. If Length is

less than or equal to the length of the string already, the original

string is returned unaltered.

Side Effects

None

Description

This function left pads a string with zeroes out to a given length.

Dialog Forms Called

None


OpenConnection

File Name

pc_svcs.kb

Syntax

function OpenConnection(VAL QueueManager: STRING): INTEGER;

Parameters

QueueManager - This is the name of the queue manager to which one wants to

open a connection.

Returns

0, if the operation fails, 1 otherwise.

Side Effects

Establishes MQSeries connection to a given queue manager.

Description

This procedure opens an MQSeries connection with a given queue manager.

Dialog Forms Called

None


OpenQueueForGet

File Name

pc_svcs.kb

Syntax

function OpenQueueForGet(VAL QueueManager: STRING, VAL QueueName: STRING): INTEGER;

Parameters

QueueManager - This is the name of the queue manager that manages the given queue.

QueueName - This is the queue that one wants to open.

Returns

0, if the operation fails, 1 otherwise.

Side Effects

Opens a given queue through MQSeries.

Description

This procedure opens a given ECI queue for getting new ECI messages.

Dialog Forms Called

None


OpenQueueForPut

File Name

pc_svcs.kb

Syntax

function OpenQueueForPut(VAL QueueManager: STRING, VAL QueueName: STRING): INTEGER;

Parameters

QueueManager - This is the name of the queue manager that manages the given queue.

QueueName - This is the queue that one wants to open.

Returns

0, if the operation fails, 1 otherwise.

Side Effects

Opens a given queue through MQSeries.

Description

This procedure opens a given ECI queue for putting new ECI messages.

Dialog Forms Called

None


ParseAndAddMessage

File Name

pc_svcs.kb

Syntax

function ParseAndAddMessage(VAL Message: STRING): BOOLEAN;

Parameters

Message - This is the message to be parsed and added to the database.

Returns

TRUE, if successful, FALSE otherwise.

Side Effects

Adds records to or updates records in the database related to the given ECI message.

Description

This function parses a message and then adds or updates records as appropriate in the database.

Dialog Forms Called

None


ParseECIMessage

File Name

pc_svcs.kb

Syntax

function ParseECIMessage(VAL InputRecord: STRING, REF RecordType: STRING): ECI_Call_ErrorRecordType;

Parameters

InputRecord - This is the raw record from ECI.

RecordType - This is the four character string with the ECI record

- type.

Returns

An ECI_Call_ErrorRecord with the appropriate fields for the record

type filled in.

Side Effects

None

Description

This function parses an ECI message, which is a string, into local records. One should note that the dates and times coming out of ParseECIMessage will be in their original ECI formats, i.e., YYYYMMDD for dates and HHMMSS for times.

Dialog Forms Called

None


PrettyDateToECIDate

File Name

pc_svcs.kb

Syntax

FUNCTION PrettyDateToECIDate(VAL PrettyDate: STRING): STRING;

Parameters

PrettyDate - This is the date, in mm/dd/yyyy format, to be converted.

Returns

PrettyDate in YYYYMMDD format

Side Effects

None

Description

This function converts a date in mm/dd/yyyy format to YYYYMMDD format.

Dialog Forms Called

None


QueueGet

File Name

pc_svcs.kb

Syntax

function QueueGet(REF Message: STRING): INTEGER;

Parameters

Message - This is a new message from ECI.

Returns

0, if the operation fails, 1 otherwise.

Side Effects

Removes a message from the ECI queue.

Description

This procedure gets a message from the open ECI queue.

Dialog Forms Called

None


QueuePut

File Name

pc_svcs.kb

Syntax

function QueuePut(VAL Message: STRING): INTEGER;

Parameters

Message - This is a message to be put on the currently open ECI queue.

Returns

0, if the operation fails, 1 otherwise.

Side Effects

Puts a message on the ECI queue.

Description

This procedure puts a message on the open ECI queue.

Dialog Forms Called

None


Rejected

File Name

pc_svcs.kb

Syntax

function Rejected(VAL ErrorCode: STRING): BOOLEAN;

Parameters

ErrorCode - This is an ECI error code.

Returns

TRUE, if the error code implies rejection, FALSE otherwise.

Side Effects

None

Description

This function determines whether the given error code implies a rejection by ECI.

Dialog Forms Called

None


RemoveNonnumeric

File Name

pc_svcs.kb

Syntax

FUNCTION RemoveNonnumeric(VAL OldString: STRING): STRING;

Parameters

OldString - This is the string from which nonnumeric characters will be removed.

Returns

OldString with all nonnumeric characters removed.

Side Effects

None

Description

This function removes all nonnumeric characters from a given string.

Dialog Forms Called

None


ReplaceECI_Comments

File Name

pc_svcs.kb

Syntax

function ReplaceECI_Comments(VAL ParentWindow: WINDOW, REF ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType, VAL OldECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): BOOLEAN;

Parameters

ParentWindow - This is the window to which message windows to the user

will be attached.

ECI_Call_ErrorRecord - This is the record containing the comments to be added to ECI_Comments.

OldECI_Call_ErrorRecord - This is the record containg old comments to be replaced.

Returns

TRUE, if the comments are replaced, FALSE otherwise.

Side Effects

This function replaces a tuple in the ECI_Comments table.

Description

This function replaces comments in the ECI_Comments table.

Dialog Forms Called

None


ReplaceECI_Status

File Name

pc_svcs.kb

Syntax

function ReplaceECI_Status(VAL ParentWindow: WINDOW, REF ECI_StatusRecord: ECI_StatusRecordType): BOOLEAN;

Parameters

ParentWindow - The window to which to attach error messages.

ECI_StatusRecord - This is the status record to be replaced.

Returns

TRUE, if successful, FALSE otherwise.

Side Effects

This function replaces a given ECI status record with one with a new date and time in the database.

Description

This function replaces a given status record in the database.

Dialog Forms Called

None


RightSpacePad

File Name

pc_svcs.kb

Syntax

FUNCTION RightSpacePad(VAL OldString: STRING, VAL Length: INTEGER): STRING;

Parameters

OldString - This is the string to be padded.

Length - The length of the newly padded string.

Returns

OldString right padded with spaces to the length of Length. If Length is

less than or equal to the length of the string already, the original

string is returned unaltered.

Side Effects

None

Description

This function right pads a string with spaces out to a given length.

Dialog Forms Called

None


SelectCustomer

File Name

pc_svcs.kb

Syntax

FUNCTION SelectCustomer(VAL ParentWindow: WINDOW, REF ECI_Call_Error Record: ECI_Call_ErrorRecordType): INTEGER;

Parameters

ParentWindow - This is the parent window to which the WORK_WITH_ECI_CUSTOMERS

- window will be attached.

ECI_Call_ErrorRecord - This is the record with customer information used for inquiries, etc.

Returns

The return value of the WORK_WITH_ECI_CUSTOMERS dialog box, e.g., 1 for

successful completion, 0 for user abort. Also, 0 if the CustomerInquiry fails.

Side Effects

One can add records to, edit records in , and delete records from the the ECI_Customers table.

Description

This function allows the user to select a customer from ECI_Customer. In the process, the user can add, edit, and delete ECI_Customer records.

Dialog Forms Called

eci_cust.dfc[work_with_eci_customers]


UpdateAllCallElements

File Name

pc_svcs.kb

Syntax

function UpdateAllCallElements(VAL ParentWindow: WINDOW, VAL ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType, VAL OldECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): BOOLEAN;

Parameters

ParentWindow - This is the window to which message windows to the user

will be attached.

ECI_Call_ErrorRecord - This is the record containing the call elements to be updated in ECI_Comments.

OldECI_Call_ErrorRecord - This is the record containing previous information about the call elements

for checking passive concurrency.

Returns

TRUE, if the comments are updated, FALSE otherwise.

Side Effects

This function updates records related to an ECI call in the database.

Description

This function updates records related to an ECI call in the database.

Dialog Forms Called

None


UpdateECI_Call

File Name

pc_svcs.kb

Syntax

function UpdateECI_Call(VAL ParentWindow: WINDOW, VAL ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType, VAL OldECI_Call_ErrorRecord: OldECI_Call_ErrorRecordType): BOOLEAN;

Parameters

ParentWindow - This is the window to which message windows to the user

will be attached.

ECI_Call_ErrorRecord - This is the record containing the call to be updated in ECI_Call.

OldECI_Call_ErrorRecord - This is the record containing old call information

- for passive concurrency checking.

Returns

TRUE, if the call is updated, FALSE otherwise.

Side Effects

This function updates a tuple in the ECI_Call table.

Description

This function updates a call in the ECI_Call table.

Dialog Forms Called

None


UpdateECI_CommentsErrorCode

File Name

pc_svcs.kb

Syntax

function UpdateECI_CommentsErrorCode(VAL ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): BOOLEAN;

Parameters

ECI_Call_ErrorRecord - This is the record containing the comments to be updated.

OldECI_Call_ErrorRecord - This is the record containg old comments to be replaced.

Returns

TRUE, if the comments are updated, FALSE otherwise.

Side Effects

This function updates a tuple in the ECI_Comments table.

Description

This function updates the ERROR_CODE and REJECTED fields in the ECI_Comments table. One should note that this action is only done by the monitor, which is not supposed to have error messages popping up in windows. So, there is no error message window if the update fails.

Dialog Forms Called

None


UpdateForResolution

File Name

pc_svcs.kb

Syntax

function UpdateForResolution(VAL ECI_Call_ErrorRecord: ECI_Call_ErrorRecordType): BOOLEAN;

Parameters

ECI_Call_ErrorRecord - This is the record containing the resolution information.

Returns

TRUE, if the resolution information is updated, FALSE otherwise.

Side Effects

This function updates a tuple in the ECI_Call table.

Description

This function updates a record in the ECI_Call table with resolution information.

Dialog Forms Called

None


ValidatePhoneNum

File Name

pc_svcs.kb

Syntax

FUNCTION ValidatePhoneNum(VAL ph: String): Boolean;

Parameters

ph - This is the phone number to be validated.

Returns

TRUE, if ph contains a 10 digit numeric phone number, FALSE otherwise.

Side Effects

None

Description

This function determines whether a phone number (3-digit area code and 7-digit phone number) is valid by deleting all non-numeric chars and checking the length of the remaining string. If the length is < 10 then it must not be a valid phone num. If ph is $Unknown, it will return FALSE.

Dialog Forms Called

None