Announcements
This table contains one record for each announcement.
AnnouncementID
int
Identity column to uniquely identify an announcement.
AnnouncementTitle
nvarchar(255)
AnnouncementText
ntext
Sunrise
datetime
The earliest date to show the announcement.
Sunset
datetime
The latest date to show the announcement.
Cases
This table contains one record for each case.
CaseID
int
Identity column to uniquely identify a case.
CaseName
nvarchar(255)
CaseDescription
ntext
Created
datetime
Modified
datetime
StatusID
int
This field has a specific set of allowable values.
1 - Open
2 - Closed
PriorityID
int
A reference to the priority assigned to this case.
Set to zero if no priority assigned.
Text1
nvarchar(255)
Text2
nvarchar(255)
Text3
nvarchar(255)
Entry1
int
A reference to the entry for list 1 assigned to this case.
Set to zero if no entry assigned.
Entry2
int
A reference to the entry for list 2 assigned to this case.
Set to zero if no entry assigned.
Entry3
int
A reference to the entry for list 3 assigned to this case.
Set to zero if no entry assigned.
InternalContactID
int
A reference to the internal contact associated with this case.
Set to zero if no internal contact associated.
CustomerContactID
int
A reference to the customer contact associated with this case.
Set to zero if no customer contact associated.
SupplierContactID
int
A reference to the supplier contact associated with this case.
Set to zero if no supplier contact associated.
DiscussionEvents
This table contains one record for each discussion email sent.
OutgoingRequestID
int
A reference to the outgoing request that triggered this discussion event.
DiscussionPostID
int
A reference to the discussion post that this discussion event belongs to.
EmailBody
ntext
FromEmailAddress
nvarchar(255)
FromEmailName
nvarchar(255)
Sent
datetime
DiscussionPosts
This table contains one record for each discussion post.
DiscussionPostID
int
Identity column to uniquely identify a discussion post.
DiscussionTopicID
int
A reference to the discussion topic that this discussion post belongs to.
Created
datetime
PostText
ntext
PostAuthoredBy
nvarchar(255)
EmailAddress
nvarchar(255)
PersonalWebAddress
nvarchar(255)
BusinessWebAddress
nvarchar(255)
Discussions
This table contains one record for each discussion.
DiscussionID
int
Identity column to uniquely identify a discussion.
DiscussionName
nvarchar(25)
DiscussionDescription
nvarchar(255)
CurrentDisplayControl
int
This field has a different meaning depending on whether it is positive or negative.
Positive - Maximum number of Topics
Negative - Maximum number of Days
HistoryDisplayControl
int
This field has a different meaning depending on whether it is positive or negative.
Positive - Maximum number of Months
Negative - Maximum number of Years
DiscussionTopics
This table contains one record for each discussion topic.
DiscussionTopicID
int
Identity column to uniquely identify a discussion topic.
DiscussionID
int
A reference to the discussion that this discussion topic belongs to.
ArchiveYear
int
The year when this discussion topic was created.
ArchiveMonth
int
The month within year when this discussion topic was created.
ArchiveDay
int
The day within month when this discussion topic was created.
TopicPostCount
int
TopicName
nvarchar(255)
TopicStartedBy
nvarchar(255)
Entries
This table contains one record for each list entry.
EntryID
int
Identity column to uniquely identify an entry.
ListID
int
A reference to the list that this entry belongs to.
EntryName
nvarchar(255)
EntryDescription
nvarchar(255)
Events
This table contains one record for each case event.
EventID
int
Identity column to uniquely identify an event.
CaseID
int
A reference to the case that this event belongs to.
Created
datetime
EventDescription
nvarchar(255)
EventComment
ntext
UserContactID
int
A reference to the user contact that created this event.
If this event was not created by a user contact then set to zero.
KnowledgeBases
This table contains one record for each knowledge base.
KnowledgeBaseID
int
Identity column to uniquely identify a knowledge base.
KnowledgeBaseParentID
int
A reference to the parent knowledge base record.
Set to zero if this record is a top level record with no parent.
KnowledgeBaseName
nvarchar(25)
KnowledgeBaseDescription
nvarchar(255)
KnowledgeTopics
This table contains one record for each knowledge topic.
KnowledgeTopicID
int
Identity column to uniquely identify a knowledge topic.
KnowledgeBaseID
int
A reference to the knowledge base that this knowledge topic belongs to.
KnowledgeTopicTitle
nvarchar(255)
KnowledgeTopicText
ntext
Lists
This table contains one record for each list.
ListID
int
Identity column to uniquely identify a list.
ListName
nvarchar(255)
NewsletterEditions
This table contains one record for each newsletter edition.
NewsletterEditionID
int
Identity column to uniquely identify a newsletter edition.
NewsletterID
int
A reference to the newsletter that this newsletter edition belongs to.
NewsletterEditionName
nvarchar(255)
NewsletterEditionContent
ntext
NewsletterEditionFormat
int
This field has a specific set of allowable values.
1 - HTML
2 - Plain Text
Queued
datetime
Sent
datetime
NewsletterEvents
This table contains one record for each newsletter email sent.
OutgoingRequestID
int
A reference to the outgoing request that triggered this newsletter event.
SubscriberID
int
A reference to the subscriber that this newsletter event belongs to.
NewsletterEditionID
int
A reference to the newsletter edition that this newsletter event belongs to.
Sent
datetime
Newsletters
This table contains one record for each newsletter.
NewsletterID
int
Identity column to uniquely identify a newsletter.
NewsletterName
nvarchar(255)
NewsletterDescription
nvarchar(255)
NewsletterFormat
int
This field has a specific set of allowable values.
1 - HTML
2 - Plain Text
NewsletterType
int
This field has a specific set of allowable values.
1 - Private
2 - Public
NewsletterSubscribers
This table contains one record for each newsletter subscriber combination.
NewsletterID
int
A reference to the newsletter that this newsletter subscriber belongs to.
SubscriberID
int
A reference to the subscriber that this newsletter subscriber belongs to.
Organisations
This table contains one record for each organisation.
OrganisationID
int
Identity column to uniquely identify an organisation.
OrganisationType
int
This field has a specific set of allowable values.
1 - Internal
2 - Customer
3 - Supplier
ShortName
nvarchar(255)
FullName
nvarchar(255)
OutgoingRequests
This table contains one record for each outgoing request, while it remains unsent.
OutgoingRequestID
int
Identity column to uniquely identify an outgoing request.
OutgoingRequestType
int
This field has a specific set of allowable values.
1 - Email
2 - Newsletter
3 - Alert
4 - Discussion
ReferenceID
int
The interpretation of this field depends on the OutgoingRequestType.
Zero for emails
NewsletterEditionID for newsletters
CaseID for alerts
DiscussionPostID for discussions
EmailFormat
int
This field has a specific set of allowable values.
1 - HTML
2 - Plain Text
EmailPriority
int
This field has a specific set of allowable values.
1 - Low
2 - Normal
3 - High
EmailSubject
nvarchar(255)
EmailBody
ntext
FromEmailAddress
nvarchar(255)
FromEmailName
nvarchar(255)
ToEmailAddress
nvarchar(255)
ToEmailName
nvarchar(255)
OutgoingSends
This table contains one record for each newsletter email sent for the current outgoing request,
while the outgoing request is being processed.
OutgoingRequestID
int
A reference to the outgoing request that this outgoing send belongs to.
ReferenceID
int
SubscriberID for newsletters
Priorities
This table contains one record for each priority.
PriorityID
int
Identity column to uniquely identify a priority.
PriorityName
nvarchar(255)
Subscribers
This table contains one record for each subscriber.
SubscriberID
int
Identity column to uniquely identify a subscriber.
EmailAddress
nvarchar(255)
FullName
nvarchar(255)
FileAs
nvarchar(255)
SystemSettings
This table contains one record for each system setting.
SessionSettingID
nvarchar(255)
Column to uniquely identify a system setting.
Valueint
int
An integer system setting.
Valuenvarchar
nvarchar(255)
A character string system setting.
Valuentext
ntext
A text string system setting.
UserContacts
This table contains one record for each user contact.
UserContactID
int
Identity column to uniquely identify a user contact.
ContactType
int
This field has a specific set of allowable values.
1 - Internal
2 - Customer
3 - Supplier
UserName
nvarchar(255)
OrganisationID
int
A reference to the organisation that this user contact belongs to.
EmailAddress
nvarchar(255)
FullName
nvarchar(255)
FileAs
nvarchar(255)
BusinessPhone
nvarchar(255)
HomePhone
nvarchar(255)
MobilePhone
nvarchar(255)
DeleteAnnouncement
This stored procedure deletes an announcement record for a specified AnnouncementID.
DeleteAnnouncements
This stored procedure deletes all announcement records with a Sunset date prior to a specified Sunset date.
DeleteCase
This stored procedure deletes a case record for a specified CaseID.
DeleteDiscussion
This stored procedure deletes a discussion record for a specified DiscussionID.
DeleteDiscussionPost
This stored procedure deletes a discussion post record for a specified DiscussionPostID.
DeleteDiscussionTopic
This stored procedure deletes a discussion topic record for a specified DiscussionTopicID.
DeleteEntry
This stored procedure deletes an entry record for a specified EntryID.
DeleteKnowledgeBase
This stored procedure deletes a knowledge base record for a specified KnowledgeBaseID.
DeleteKnowledgeTopic
This stored procedure deletes a knowledge topic record for a specified KnowledgeTopicID.
DeleteNewsletter
This stored procedure deletes a newsletter record for a specified NewsletterID.
DeleteNewsletterEdition
This stored procedure deletes a newsletter edition record for a specified NewsletterEditionID.
DeleteNewsletterSubscriber
This stored procedure deletes a newsletter subscriber record for a specified NewsletterID and SubscriberID combination.
DeleteOrganisation
This stored procedure deletes an organisation record for a specified OrganisationID.
DeleteOutgoingRequest
This stored procedure deletes an outgoing request record for a specified OutgoingRequestID.
DeleteSubscriber
This stored procedure deletes a subscriber record for a specified SubscriberID.
DeleteSystemSetting
This stored procedure deletes a system setting record for a specified SystemSettingID.
DeleteUserContact
This stored procedure deletes a user contact record for a specified UserContactID.
InsertAnnouncement
This stored procedure inserts an announcement record.
InsertCase
This stored procedure inserts a case record and returns the CaseID of the inserted record.
InsertDiscussion
This stored procedure inserts a discussion record.
InsertDiscussionEvent
This stored procedure inserts a discussion event record.
InsertDiscussionPost
This stored procedure inserts a discussion post record.
InsertDiscussionTopic
This stored procedure inserts a discussion topic record and returns the DiscussionTopicID of the inserted record.
InsertEntry
This stored procedure inserts an entry record.
InsertEvent
This stored procedure inserts an event record.
InsertKnowledgeBase
This stored procedure inserts a knowledge base record.
InsertKnowledgeTopic
This stored procedure inserts a knowledge topic record.
InsertNewsletter
This stored procedure inserts a newsletter record.
InsertNewsletterEdition
This stored procedure inserts a newsletter edition record.
InsertNewsletterEvent
This stored procedure inserts a newsletter event record.
InsertNewsletterSubscriber
This stored procedure inserts a newsletter subscriber record.
InsertOrganisation
This stored procedure inserts an organisation record.
InsertOutgoingRequest
This stored procedure inserts an outgoing request record.
InsertOutgoingSend
This stored procedure inserts an outgoing send record.
InsertSubscriber
This stored procedure inserts a subscriber record.
InsertSystemSetting
This stored procedure inserts a system setting record.
InsertUserContact
This stored procedure inserts a user contact record.
SelectAnnouncement
This stored procedure selects an announcement record for a specified AnnouncementID.
SelectAnnouncements
This stored procedure selects a series of announcement records within a range between a specified Sunrise date and a specified Sunset date.
The records are returned in descending Sunrise and descending AnnouncementID sequence.
SelectCase
This stored procedure selects a case record for a specified CaseID.
SelectCases
This stored procedure selects a filtered series of case records ordered by CaseID.
If an input parameter is zero then the parameter doesn't act as a filter.
If an input parameter is not zero then it acts as a filter to only include those case records matching the input parameter value.
SelectDiscussion
This stored procedure selects a discussion record for a specified DiscussionID.
SelectDiscussionArchivesList
This stored procedure selects a series of records for a specified DiscussionID depending on the value of the HistoryDisplayControl parameter.
If HistoryDisplayControl is positive then the records consist of archive year month records with a count of the number of discussion topics in each archive year month combination.
Records are selected back to a specified year and month.
The records are returned in descending year month combination sequence.
If HistoryDisplayControl is negative then the records consist of archive year records with a count of the number of discussion topics in each archive year.
Records are selected back to a specified year.
The records are returned in descending year sequence.
SelectDiscussionPost
This stored procedure selects a discussion post record for a specified DiscussionPostID.
SelectDiscussionPosts
This stored procedure selects all discussion post records for a specified DiscussionTopicID ordered by DiscussionPostID.
SelectDiscussions
This stored procedure selects all discussion records in ascending DiscussionName sequence.
SelectDiscussionTopic
This stored procedure selects a discussion topic record for a specified DiscussionTopicID.
SelectDiscussionTopicsList
This stored procedure selects a series of discussion topic records for a specified DiscussionID depending on the value of the CurrentDisplayControl parameter.
If CurrentDisplayControl is positive then records are returned in descending DiscussionTopicID sequence up to the maximum number specified by CurrentDisplayControl.
If CurrentDisplayControl is negative then records are returned in descending DiscussionTopicID sequence back to a specified year, month and day.
If CurrentDisplayControl is zero and the Month parameter is zero then records are returned in descending DiscussionTopicID sequence for the specified year.
If CurrentDisplayControl is zero and the Month parameter is not zero then records are returned in descending DiscussionTopicID sequence for the specified year and month.
SelectEntries
This stored procedure selects all entry records for a specified ListID ordered by EntryName.
SelectEntry
This stored procedure selects an entry record for a specified EntryID.
SelectEvents
This stored procedure selects all event records for a specified CaseID ordered by EventID.
SelectKnowledgeBase
This stored procedure selects a knowledge base record for a specified KnowledgeBaseID.
SelectKnowledgeBases
This stored procedure selects all knowledge base records in ascending KnowledgeBaseName sequence.
SelectKnowledgeTopic
This stored procedure selects a knowledge topic record for a specified KnowledgeTopicID.
SelectKnowledgeTopics
This stored procedure selects all knowledge topic records for a specified KnowledgeBaseID ordered by KnowledgeTopicTitle.
SelectList
This stored procedure selects a list record for a specified ListID.
SelectLists
This stored procedure selects all list records in ascending ListID sequence.
SelectNewsletter
This stored procedure selects a newsletter record for a specified NewsletterID.
SelectNewsletterEdition
This stored procedure selects a newsletter edition record for a specified NewsletterEditionID.
SelectNewsletterEditions
This stored procedure selects all newsletter edition records for a specified NewsletterID ordered by NewsletterEditionName.
SelectNewsletters
This stored procedure selects all newsletter records in ascending NewsletterName sequence.
If SubscriberID is zero then each record includes a count of the number of subscribers associated with the newsletter.
If SubscriberID is not zero then each record includes an indicator (0 or 1) of whether the specified subscriber is associated with the newsletter.
SelectNewsletterSubscribers
This stored procedure selects all subscriber records for a specified NewsletterID ordered by FileAs.
SelectOpenCases
This stored procedure selects a filtered series of all open cases ordered by CaseID.
If an input parameter is zero then the parameter doesn't act as a filter.
If an input parameter is not zero then it acts as a filter to only include those case records matching the input parameter value.
SelectOrganisation
This stored procedure selects an organisation record for a specified OrganisationID.
If OrganisationID is zero then the internal organisation record (the single record with an OrganisationType set to the internal organisation type) is selected.
SelectOrganisations
This stored procedure selects a filtered series of organisation records in ascending ShortName sequence.
If OrganisationType is zero then no filter is applied.
If OrganisationType is not zero then it acts as a filter to only include those organisation records matching the organisation type.
SelectOutgoingRequest
This stored procedure selects the first outgoing request record in ascending OutgoingRequestID sequence.
SelectOutgoingSend
This stored procedure selects an outgoing send record for a specified OutgoingRequestID and ReferenceID combination.
SelectPeriodCases
This stored procedure selects a filtered series of relevant cases between a specified start date and end date ordered by CaseID.
Open cases are regarded as relevant if they were created before the end date.
Closed cases are regarded as relevant if they were created before the end date and closed on or after the start date.
If an input parameter is zero then the parameter doesn't act as a filter.
If an input parameter is not zero then it acts as a filter to only include those case records matching the input parameter value.
SelectPriorities
This stored procedure selects a series of priority records in ascending PriorityID sequence depending on the value of the Variant parameter.
If Variant is 0 then all records are returned.
If Variant is 1 then only records with a non-blank PriorityName are returned.
SelectPriority
This stored procedure selects a priority record for a specified PriorityID.
SelectSubscriber
This stored procedure selects a subscriber record for a specified SubscriberID.
SelectSubscribers
This stored procedure selects all subscriber records in ascending FileAs sequence.
If NewsletterID is zero then each record includes a count of the number of newsletters associated with the subscriber.
If NewsletterID is not zero then each record includes an indicator (0 or 1) of whether the specified newsletter is associated with the subscriber.
SelectSystemSetting
This stored procedure selects a system setting record for a specified SystemSettingID.
SelectUserContact
This stored procedure selects a user contact record.
If UserName is not blank then the stored procedure selects a user contact record for the specified UserName.
If UserName is blank and UserContactID is not 0 then the stored procedure selects a user contact record for the specified UserContactID.
If UserName is blank and UserContactID is 0 then the stored procedure selects a user contact record for the specified EmailAddress.
SelectUserContacts
This stored procedure selects a series of user contact records in ascending FileAs sequence depending on the value of the Variant parameter.
If Variant is 0 or 2 then the records are filtered by the specified ContactType.
The records are also filtered by OrganisationID if OrganisationID is not zero.
If Variant is 1 then all records are returned.
SelectUsers
This stored procedure selects all user records in ascending UserName sequence.
UpdateAnnouncement
This stored procedure updates an announcement record for a specified AnnouncementID.
UpdateCase
This stored procedure updates a case record for a specified CaseID.
UpdateDiscussion
This stored procedure updates a discussion record for a specified DiscussionID.
UpdateDiscussionPost
This stored procedure updates a discussion post record for a specified DiscussionPostID.
UpdateDiscussionTopic
This stored procedure updates a discussion topic record for a specified DiscussionTopicID.
If the TopicName is blank then the TopicPostCount field is incremented by 1 and no other fields are updated.
If the TopicName is not blank then the TopicPostCount field is not incremented and all fields are updated.
UpdateEntry
This stored procedure updates an entry record for a specified EntryID.
UpdateKnowledgeBase
This stored procedure updates a knowledge base record for a specified KnowledgeBaseID.
UpdateKnowledgeTopic
This stored procedure updates a knowledge topic record for a specified KnowledgeTopicID.
UpdateList
This stored procedure updates a list record for a specified ListID.
UpdateNewsletter
This stored procedure updates a newsletter record for a specified NewsletterID.
UpdateNewsletterEdition
This stored procedure updates a newsletter edition record for a specified NewsletterEditionID.
UpdateNewsletterEditionQueued
This stored procedure updates the queued field of a newsletter edition record for a specified NewsletterEditionID.
UpdateNewsletterEditionSent
This stored procedure updates the sent field of a newsletter edition record for a specified NewsletterEditionID.
UpdateOrganisation
This stored procedure updates an organisation record for a specified OrganisationID.
UpdatePriority
This stored procedure updates a priority record for a specified PriorityID.
UpdateSubscriber
This stored procedure updates a subscriber record for a specified SubscriberID.
UpdateSystemSetting
This stored procedure updates a system setting record for a specified SystemSettingID.
UpdateUserBinding
This stored procedure updates the user contacts table to bind or unbind a user contact record to a user record in the users table.
If the UserContactID is zero then any previously bound user contact is unbound from the specified UserName (the user contact record has its username set to blank to break any previous binding).
If the UserContactID is not zero then any previously bound user contact is unbound from the specified UserName (the user contact record has its username set to blank to break any previous binding) and then the specified UserContactID is bound to the specified UserName (the user contact record has its username set to the UserName).
UpdateUserContact
This stored procedure updates a user contact record for a specified UserContactID.