Message Queue Types

 

tblMQS Table structure

 
Name
Data Type
 
Required
Description
[id]
[bigint]
IDENTITY(1,1) NOT NULL
Auto generated
Automatically generated when a row is inserted (identity)
[messageType]
[int]
NOT NULL
Compulsory
None / Note = 0
Direct Pager to TAP Gateway = 1
Direct SMS to TAP Gateway = 2 
Direct Email to SMTP = 3
CallScripter Report = 5
CallScripter Task Alert / Re-pop a script = 6
Repeat Actions in tblMQs = 10
 
[messagePriority]
[int]
NOT NULL
Compulsory
0 = normal
When the message queue service runs it will sort outstanding tasks to process by [messagePriority], and [queuedAt] columns 
 
[fromAddress]
[nvarchar](255)
NULL
Non Compulsory
Can contain an email address (type 3) or other text value for reference
 
[toAddresses]
[nvarchar](4000)
NOT NULL
Compulsory
Contains the destination address – either email address (type 3) or tel number (type 1,2) or DDI of script to re-pop (type 6)
 
Types 2 & 3 (SMS and Emails) can be sent to multiple addresses by separating the values with a comma or a semicolon. 
 
[subject]
[nvarchar](255)
NULL
Non Compulsory
Used for subject matter when sending a message type of email (3)
 
[messageText]
[nvarchar](4000)
NOT NULL
Compulsory
Used to contain the message text to be sent as part of the task - ignored when a report type (5) is sent and replaced by the contents of the report template.
 
[queuedAt]     
[datetime]
NOT NULL
Compulsory
Date / Time the task was inserted into the table, usually populated by getDate() SQL value (inserting current date and time) at point of insert
 
[sentAt]
[datetime]
NULL
Non Compulsory
Date / time the message was processed by the MQ service
 
[tryCount]     
[int]
NOT NULL
Compulsory
Amount of attempts the MQ service should try to send the message if errors occur during sending. 
 
[maxAttempts]
[int]
NOT NULL
Compulsory
Maximum amount of times the MQ service should attempt to send.  Default value should be 5.
 
[nextSendTime]
[datetime]
NULL
Non Compulsory
Date the task should be processed by the message queue service
 
[errorDetails]
[nvarchar](4000)
NULL
Non Compulsory
If the message queue service returns an error when processing this row / task it will be logged here 
 
[disabled]
[bit]
NOT NULL
 
Compulsory
The row / task can be disabled and will be ignored by the message queue service polling.
Active = 0, Disabled = 1
 
[reportID]
[int]
NOT NULL
Compulsory
A report ID can be specified in this column for Message Queue Type of '5' to run the report at the specified date and time, if no report is required then this should be set to a default of '0'
 
[sessionList]
[nvarchar](max)
NOT NULL
Compulsory
Should contain a comma separated list of session IDs when running message type of report (5). This will know which sessions to run the report on.
 
[reference]
[nvarchar](50)
NOT NULL
Compulsory
Must be populated with a reference for this row – usually the session ID of the call that inserted the task
 
[Notes]
[nvarchar](max)
NOT NULL
Compulsory
Purely used for information purposes when dealing with the message. Although it's compulsory it can be blank string.
[Status]
[nvarchar](50)
NULL
Non Compulsory
Used to pass information into the script pop to determine which page to jump to. Used in similar way to a fulfilment leg in workflows
 
[extraAttachments]
[nvarchar](4000)
NULL
Non Compulsory
Can be used to enter a file path location of extra attachments to be sent with reports, emails or faxes  (Message types 5, 4 or 3)
 
[GroupID]
[int]
NULL
Non Compulsory
Set the group id of agents that you wish to be able to see the outstanding alerts in the script that is linked to callQueueHandler DDI. All agents will still receive the alerts on the agent desktop
 
[SLA]
[int]
NULL
Non Compulsory
Used for message type of 6 (re-pop script). Enter the required SLA value in seconds, for the task to be reopened / actioned.  Will be calculated from SentAt column.