CTrans

Enumerated Constant

hdDOMAINS

Description
These constants indicate which domain a function should work on.

Syntax
x=CTrans.hdDOMAINS.aValue

Value[s]
icAUDIT_TYPE = 0
icLOCATION = 1
icSKILL = 2
icPRIORITY = 3
icREQ_STATUS = 4
icREQ_DET_TYPE = 5

hdTECHS

Description
These constants indicate whether a function should work on all technicians or only the currently logged on technician.

Syntax
x=CTrans.hdTECHS.aValue

Value[s]
icALL_TECHS = 0
icWORKING_TECHS = 1

hdSNAPSHOT

Description
These constants determine which boundary of the current snapshot data will be returned.

Syntax
x=CTrans.hdSNAPSHOT.aValue

Value[s]
icFIRST_DATE = 1
icLAST_DATE = 2

Functions

ClaimRequest

Description
Updates the status of a request to show that a particular technician has claimed this request.

Syntax
x = CTrans.ClaimRequest (ByVal lReqId As Long, ByVal lTechId As Long)

Parameters
ByVal lReqId as Long
ByVal lTechId as Long

Return type
Boolean

ConfirmResolution

Description
Updates the status of a request to show that a confirmation is pending from the original requester.

Syntax
x = CTrans.ConfirmResolution (ByVal lReqId As Long)

Parameters
ByVal lReqId as Long

Return type
Boolean

DeleteDomainMember

Description
Deletes a given domain record from the specified domain table.

Syntax
x = CTrans.DeleteDomainMember (ByVal icDomain As hdDOMAINS, ByVal sCode As String)

Parameters
ByVal icDomain as hdDOMAINS
ByVal sCode as String

Return type
Boolean

Remarks
Please note that if this function fails, it is because the built-in referential integrity of SQL Server will not allow the deletion. In order to delete the specified record, all other HelpDesk records that refer to this record must be deleted first. See the appendix of "The HelpDesk Sample: Overview of an Automated Solution." for more detail on this issue.

DeleteTechnician

Description
Deletes a given technician record from the technician table.

Syntax
x = CTrans.DeleteTechnician (ByVal sEAlias As String)

Parameters
ByVal sEAlias as String

Return type
Boolean

Remarks
Please note that if this function fails, it is because the built-in referential integrity of SQL Server will not allow the deletion. In order to delete the specified record, all other HelpDesk records that refer to this record must be deleted first. See the appendix of "The HelpDesk Sample: Overview of an Automated Solution." for more detail on this issue.

DenyResolution

Description
Reverts the status of a request from Confirmed back to Pending.

Syntax
x = CTrans.DenyResolution (ByVal lReqId As Long)

Parameters
ByVal lReqId as Long

Return type
Boolean

GetDomain

Description
Returns a string array filled in with the contents of a given domain.

Syntax
x = CTrans.GetDomain (ByVal iDomain As hdDOMAINS, sData() As String)

Parameters
ByVal iDomain as hdDOMAINS
sData() As String

Return type
Boolean

GetReqDetail

Description
Returns a string array filled in with the contents of a particular request, specified by the request detail ID.

Syntax
x = CTrans.GetReqDetail (ByVal lReqDetId As Long, sData() As String)

Parameters
ByVal lReqDetId as Long
sData() As String

Return type
Boolean

GetReqDetails

Description
Returns a string array filled in with all of the detail records of a particular request, specified by the request ID.

Syntax
x = CTrans.GetReqDetails (ByVal lReqId As Long, sData() As String)

Parameters
ByVal lReqId as Long
sData() As String

Return type
Boolean

GetRequest

Description
Returns an array filled in with the data from a particular request, specified by its request or tracking id.

Syntax
x = CTrans.GetRequest (sData() As String, Optional ByVal lReqId As Long, Optional ByVal lTrackNo As Long)

Parameters
sData() As String
Optional ByVal lReqId As Long
Optional ByVal lTrackNo As Long

Return type
Boolean

GetRequests

Description
Returns an array filled in with the data from all of the requests for a given technician.

Syntax
x = CTrans.GetRequests (ByVal lTechId As Long, sData() As String)

Parameters
ByVal lTechId as Long
sData() As String

Return type
Boolean

GetStdTextResponses

Description
Returns an array that contains all of the standard text responses.

Syntax
x = CTrans.GetStdTextResponses (sData() As String)

Parameters
sData() As String

Return type
Boolean

GetSysParms

Description
Returns an array filled in with all of the system parameter values.

Syntax
x = CTrans.GetSysParms (sData() As String)

Parameters
sData() As String

Return type
Boolean

GetTech

Description
Returns an array containing all of the technician data for a specified technician ID.

Syntax
x = CTrans.GetTech (ByVal lTechId As Long, sData() As String)

Parameters
ByVal lTechId as Long
sData() As String

Return type
Boolean

GetTechs

Description
Returns an array containing all of the technician data for all technicians who fit a given skill and location.

Syntax
x = CTrans.GetTechs (ByVal iAvail As hdTECHS, sData() As String, Optional ByVal lSkillId As Long, Optional ByVal lLocId As Long) As Boolean

Parameters
ByVal iAvail As hdTECHS
sData() As String
Optional ByVal lSkillId As Long
Optional ByVal lLocId As Long

Return type
Boolean

GetUserRequests

Description
Returns an array filled in with all of the data from a given user's requests.

Syntax
x = CTrans.GetUserRequests (ByVal sUserAlias As String, sData() As String)

Parameters
ByVal sUserAlias as String
sData() As String

Return type
Boolean

InsertDomainMember

Description
Creates a new domain record for the specified domain, using the specified code and description.

Syntax
x = CTrans.InsertDomainMember (ByVal icDomain As hdDOMAINS, ByVal sCode As String, ByVal sDesc As String)

Parameters
ByVal icDomain as hdDOMAINS
ByVal sCode as String
ByVal sDesc as String

Return type
Boolean

InsertRequest

Description
Creates a new request record from the supplied parameters.

Syntax
x = CTrans.InsertRequest (ByVal lLocId As Long, ByVal lPriorityId As Long, ByVal lSkillId As Long, ByVal sEAlias As String, ByVal sDesc As String, lTrackNo As Long)

Parameters
ByVal lLocId as Long
ByVal lPriorityId as Long
ByVal lSkillId as Long
ByVal sEAlias as String
ByVal sDesc as String
lTrackNo as Long

InsertTechnician

Description
Creates a technician record and fills it in with the parameter data.

Syntax
x = CTrans.InsertTechnician (ByVal sEAlias As String, ByVal lLocId As Long, ByVal lSkillId As Long)

Parameters
ByVal sEAlias as String
ByVal lLocId as Long
ByVal lSkillId as Long

Return type
Boolean

LogoffTech

Description
Changes the specified technician's status from Logged off to Logged on.

Syntax
x = CTrans.LogoffTech (ByVal lTechId As Long)

Parameters
ByVal lTechId as Long

Return type
Boolean

Remarks
At present, the end-user clients rely on Windows NT authentication to validate the user. This method could be used to supply your own authentication.

LogonTech

Description
Changes the specified technician's status from Logged on to Logged off.

Syntax
x = CTrans.LogonTech (ByVal lTechId As Long)

Parameters
ByVal lTechId as Long

Return type
Boolean

Remarks
At present the end-user clients rely on Windows NT authentication to validate the user. This method could be used to supply your own authentication.

ReAssignReq

Description
Allows a previously assigned request to be reassigned to another technician.

Syntax
x = CTrans.ReAssignReq (ByVal lReqId As Long, ByVal lFrTechId As Long, ByVal lToTechId As Long)

Parameters
ByVal lReqId as Long
ByVal lFrTechId as Long
ByVal lToTechId as Long

Return type
Boolean

SendStdTextResponse

Description
Sends a preformatted standard response to the user who made a specified request.

Syntax
x = CTrans.SendStdTextResponse (ByVal lReqId As Long, ByVal lTechId As Long, ByVal lRespId As Long)

Parameters
ByVal lReqId as Long
ByVal lTechId as Long
ByVal lRespId as Long

Return type
Boolean

SendTextRequest

Description
Sends a text response to the technician who has claimed a specified request.

Syntax
x = CTrans.SendTextRequest (ByVal lReqId As Long, ByVal sMsgText As String)

Parameters
ByVal lReqId as Long
ByVal sMsgText as String

Return type
Boolean

SendTextResponse

Description
Sends a text response to the user who made the specified request.

Syntax
x = CTrans.SendTextResponse (ByVal lReqId As Long, ByVal lTechId As Long, ByVal sMsgText As String)

Parameters
ByVal lReqId as Long
ByVal lTechId as Long
ByVal sMsgText as String

Return type
Boolean

SubmitRequest

Description
Changes the specified request's status from In progress to Resolution pending.

Syntax
x = CTrans.SubmitRequest (ByVal lReqId As Long, ByVal lTechId As Long)

Parameters
ByVal lReqId as Long

ByVal lTechId as Long

Return type
Boolean

Remarks
The technician should next send a confirmation request to the user.

UnclaimRequest

Description
Reverts a request's status from Claimed back to Unclaimed, at which point the request could be reshuffled to another technician.

Syntax
x = CTrans.UnclaimRequest (ByVal lReqId As Long, ByVal lTechId As Long)

Parameters
ByVal lReqId as Long
ByVal lTechId as Long

Return type
Boolean

UpdateDomainMember

Description
Updates a domain record in the specified domain using the existing code and a new description.

Syntax
x = CTrans.UpdateDomainMember (ByVal icDomain As hdDOMAINS, ByVal sCode As String, ByVal sDesc As String)

Parameters
ByVal icDomain as hdDOMAINS
ByVal sCode as String
ByVal sDesc as String

Return type
Boolean

UpdateTechnician

Description
Updates the specified technician record with new parameter data.

Syntax
x = CTrans.UpdateTechnician (ByVal lTechId As Long, ByVal sEAlias As String, ByVal lLocId As Long, ByVal lSkillId As Long)

Parameters
ByVal lTechId as Long
ByVal sEAlias as String
ByVal lLocId as Long
ByVal lSkillId as Long

Return type
Boolean

WorkRequest

Description
Changes the specified request's status from Claimed to In progress.

Syntax
x = CTrans.WorkRequest (ByVal lReqId As Long, ByVal lTechId As Long)

Parameters
ByVal lReqId as Long
ByVal lTechId as Long

Return type
Boolean