Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary...

37
Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018-02-09 Abstract This Technical Reference provides a concise and detailed description of the database tables CIC uses to store and generate reports on Interaction Recorder data. This document assists you in understanding the structure and content of these tables.

Transcript of Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary...

Page 1: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

Interaction Quality Management Data Dictionary

Technical Reference

2018 R2

Last updated 2018-02-09

Abstract This Technical Reference provides a concise and detailed description of the database tables CIC uses to store and generate reports on Interaction Recorder data. This document assists you in understanding the structure and content of these tables.

Page 2: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference
Page 3: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

IQ Data DictionaryOptimizer Support Escalations

This Confluence page contains the data dictionaries for Quality Management products.

Table of Contents (main sections):

RecorderFeedback

Table of Contents (detailed):

RecorderIR_AccessControl Table

IndexesIR_ArchiveContent Table

IndexesIR_ArchiveVolumeDescriptor Table

IndexesIR_Audit Table

IndexesExplanation of AuditOperationDescription of Audit Comments

IR_CustomAttribute TableIndexes

IR_CustomAttributeName TableIndexes

IR_Event TableIndexesExplanation of EventType

IR_EventKeywordInfo TableIndexes

IR_Keyword TableIndexes

IR_KeywordSet TableIndexes

IR_QAnswer TableIndexes

IR_QDirectory TableIndexes

IR_QForm TableIndexesExplanation of ScoringStateExplanation of IsFailedExplanation of SignoffStateExplanation of UsingForCalibration

IR_QGroup TableIndexes

IR_QQuestion TableIndexesExplanation of QuestionTypeExplanation of QuestionPromptType

IR_QQuestionEnum TableIndexes

IR_Questionnaire TableIndexes

IR_RankDefn TableIndexes

IR_RankGroup TableIndexes

IR_RecordingMedia TableIndexesExplanation of MediaTypeExplanation of DirectionExplanation of CallTypeExplanation of RecordingType

IR_RecordingMediaSnippets TableIndexes

IR_RecordingWork TableIndexes

IR_SecurityPolicy Table

Page 4: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

IndexesIR_Tag Table

IndexesIR_TagMap Table

IndexesFeedback

Survey TableIndexesExplanation of Type

SurveyAnswer TableIndexesExplanation of FreeFormAnswerURI

SurveyDetail TableIndexesExplanation of EventCode and EventDetailExplanation of Origin

SurveyForm TableIndexes

SurveyObjectToSurveyPrompt TableIndexesExplanation of AppCode

SurveyPrompt TableIndexesExplanation of PromptType

SurveyQstnToQuestionCategory TableIndexes

SurveyQuestion TableIndexesExplanation of QuestionTypeExplanation of Options

SurveyQuestionBranching TableIndexesExplanation of OperatorType

SurveyQuestionCategory TableIndexesExplanation of ACSISemantics

SurveyQuestionEnum TableIndexes

SurveyRule TableIndexesExplanation of OperandExplanation of RuleTypeExplanation of Value Fields

SurveyConfigLog TableIndexesExplanation of ConfigChangeObjectTypeExplanation of ConfigChangeType

SurveyUserObjectSecurity TableIndexes

SurveyWork TableIndexes

RecorderThis is a Data Dictionary for Interaction Recorder and later.4.0

IR_AccessControl TableThe IR_AccessControl table contains security policies that apply to a given recording.

Column Name Type Null Description SU

RecordingId UniqueIdentifier No ID of the recording. GA

SecurityPolicyId UniqueIdentifier No ID of the security policy. GA

Indexes

Page 5: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

Primary Key: RecordingId + SecurityPolicyId RecordingIdForeign Keys:

Additional Indexes:

IR_ArchiveContent TableThe IR_ArchiveContent table contains the set of recordings that make up an archive volume.

Column Name Type Null Description SU

RecordingId UniqueIdentifier No ID of the recording. SU03

ArchiveId UniqueIdentifier No ID of the archive volume. SU03

ArchivedDate DateTime No Date that the recordingwas archived.

SU03

ArchivedDateOffset Integer No UTC offset of the archivedate.

SU03

Indexes

Primary Key: RecordingId + ArchiveId + ArchivedDate RecordingId, ArchiveIdForeign Keys:

Additional Indexes:

IR_ArchiveVolumeDescriptor TableThe IR_ArchiveVolumeDescriptor table contains the archive volumes.

Column Name Type Null Description SU

ArchiveId UniqueIdentifier No ID of the archive volume. SU03

VolumeName NVarChar(128) No Name of the volume. SU03

VolumeDT DateTime2(7) No Date that the volume wascreated.

SU03

VolumeDTOffset Integer No UTC offset of the volumecreated date.

SU03

ArchiveStartDT DateTime2(7) Yes Date that archivingstarted.

SU03

ArchiveEndDT DateTime2(7) Yes Date that archivingended.

SU03

MediaURI NVarChar(1024) Yes URI where the volumewas created.

SU03

Indexes

Primary Key: ArchiveIdForeign Keys:Additional Indexes:

IR_Audit TableThe IR_Audit table contains a history of audited events events in Interaction Recorder.

Column Name Type Null Description SU

AuditId UniqueIdentifier No ID of the audit record. GA

Id UniqueIdentifier No ID of the entity beingaudited.

GA

Page 6: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

AuditDate DateTime No Time that the auditedevent occured.

GA

AuditDateOffset Integer No UTC offset of the auditdate.

GA

AuditOperation SmallInt No Operation that occurred.(See below)

GA

IndivId Char(22) Yes Individual ID of the userwho performed theoperation.

GA

ICUID NVarChar(255) Yes The IC User ID of theuser who performed theoperation.

GA

AuditedName NVarChar(255) Yes Display name of the userwho performed theoperation.

GA

Comments NVarChar(1024) Yes Description of theoperation beingperformed.

GA

Version Integer No Version of the databaserow.

GA

Indexes

Primary Key: AuditId IndivId, IdForeign Keys:

Additional Indexes:

Explanation of AuditOperation

AuditOperation can be one the following values:

Value Description Release Has Comments

10 Played recording.    

11 Downloaded recording.    

12 Emailed recording.    

14 Modified recording.   yes

15 Deleted recording.    

16 Archived recording SU3  

50 Began scoring.    

52 Updated scorecard.    

53 Finished scoring.    

54 Deleted scorecard. SU5  

59 Created master key.    

60 Activated master key password. SU4  

61 Revoked master key password. SU4  

62 Changed master key password. SU4  

63 Added master key password. SU4  

64 Removed master key password. SU4  

Page 7: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

65 Interaction was monitoredthrough recorder

SU4  

70 Added a questionnaire SU6  

71 Updated a questionnaire SU6  

72 Deleted a questionnaire SU6  

80 Modify a policy 2015r1 yes

81 Re-eval all retention policies 2015r1  

82 Re-eval some retention policies 2015r1 yes

83 Re-eval all security policies 2015r1  

84 Re-eval some security policies 2015r1 yes

85 Re-eval all retention policies(legacy)

2015r1  

86 Re-eval some retention policies(legacy)

2015r1 yes

87 Re-eval policies started 2015r1  

88 Re-eval policies complete 2015r1  

89 Re-eval retention policies started CIC 2015 R4  

90 Re-eval retention policiescomplete

CIC 2015 R4  

91 Re-eval retention policiescanceled

CIC 2015 R4  

92 Re-eval security policies started CIC 2015 R4  

93 Re-eval security policiescomplete

CIC 2015 R4  

94 Re-eval security policiescanceled

CIC 2015 R4  

Description of Audit Comments

Code Example Definition

+T +T Agent The tag was added to the recording

-T -T Agent The tag was removed from the recording

+A +A Age=15 The attribute and value was added to therecording

=A =A Age=20 The attribute value was modified

-A -A Age The attribute was removed

=V =VOld00001 The recording was archived to the volume

=ScSS =ScSS Scorecard signature state changed

=ScSC =ScSC Scorecard signature comments modified

-MC -MC Monitored interaction was coaching

-MJ -MJ Monitored interaction was joined

-ML -ML Monitored interaction was listened to

-Sc -Sc Scorecard with audit event

Page 8: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

+RR +RR <20150101 04:00:00> <2015020103:59:59>

Retention policy re-evaluation range

+SR +SR <20150101 04:00:00> <2015020103:59:59>

Security policy re-evaluation range

+RA +RA <20150101> Retention re-evaluation after date

+P +P Record all calls Named policy was added

=P =P Record all calls Named policy was modified

-P -P Record all calls Named policy was deleted

=SPRC =SPRC x,y Security Policy re-evaluation completingwhere x = current policy and y = total numberof policies

+B +B <x>,<y>, [z] Bookmark was added to the recording where x= bookmark start time, y = bookmark endtime and z = bookmark text

=B =B <x>,<y>, [z]  Bookmark was modified on the recordingwhere x= bookmark start time, y       = bookmark

and zend time    = bookmark text

-B -B <x>,<y>, [z]  Bookmark was remove from the recordingwhere x= bookmark start time, y       = bookmark

and zend time    = bookmark text

 

IR_CustomAttribute TableThe IR_CustomAttribute table contains values for interaction attributes captured on recordings.

Column Name Type Null Description SU

RecordingId UniqueIdentifier No ID of the recording who'sinteraction had the value.

GA

CustomAttributeNameId Integer No ID of the name of thecustom attribute. Eachname is stored uniquelyin theIR_CustomAttributeNametable.

GA

Value NVarChar(255) No Value of the attribute. GA

Version Integer No Version of the databaserow.

GA

Indexes

Primary Key: RecordingId + CustomAttributeNameId RecordingId, CustomAttributeNameIdForeign Keys:

Additional Indexes:

IR_CustomAttributeName TableThe IR_CustomAttributeName table contains the names of custom attributes captured on recordings. These names can be referenced by manyrecordings.

Column Name Type Null Description SU

CustomAttributeNameId Integer No ID of the custom attributename.

GA

Page 9: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

Name NVarChar(255) No Name of the customattribute.

GA

Indexes

Primary Key: CustomAttributeNameIdForeign Keys:

NameAdditional Indexes:

IR_Event TableThe IR_Event table contains events that happened during the recording of the interaction.

Column Name Type Null Description SU

EventId Integer No ID of the event. GA

RecordingId UniqueIdentifier No ID of the recording wherethis event happened.

GA

EventType SmallInt No Type of event thathappened. (See below)

GA

EventDate DateTime2 No Time that the eventoccured.

GA

EventDateOffset Integer No UTC offset of the eventdate.

GA

Duration Integer Yes Duration of the event inmilliseconds.

GA

IndivId Char(22) Yes Individual ID of the userassociated with thisevent.

GA

IntxId Char(22) Yes ID of the interactionsegment associated withthis event.

GA

Intx_Part_Id Char(22) Yes ID of the participantassociated with thisevent.

GA

DisplayName NVarChar(255) Yes Display name of the userassociated with thisevent.

GA

IsInternalParticipant TinyInt No Is the associatedparticipant internal? Oneif true else zero.

GA

ConnValue NVarChar(255) Yes For the Connect andParty Added events. Theconnection value of theparticipant.

GA

Workgroup NVarChar(255) Yes Workgroup of the agenton who the recording wasinitiated.

GA

InitiatedFor TinyInt No For the Connect event, isthis the participant therecording was initiatedfor. One if true else zero.

GA

Version Integer No Version of the databaserow.

GA

Page 10: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

Notes NVarChar(1024) Yes Notes about the event.For annotations this is thetext body of theannotation.

GA

KeywordId Integer Yes For keyword spots. TheID of the keyword thatwas spotted. Each nameis stored uniquely in theIR_Keyword table.

GA

KeywordChannel TinyInt Yes For keyword spots. Thechannel on which thekeyword was spotted.

GA

KeywordScore SmallInt Yes For keyword spots. Thescore given to that spot.

SU03

KeywordUtterance VarChar(1024) Yes For keyword spots. Theutterance detected forthat spot

SU05

KeywordConfidence Numeric(19,15) Yes For keyword spots. Theconfidence level at whichthat spot was detected

SU05

Indexes

Primary Key: EventId RecordingId, IndivId, IntxId, Intx_Part_Id, KeywordIdForeign Keys:

EventDate,  IndivId, Intx_Part_Id, IntxId, KeywordId, (RecordingId, EventType, Duration), (EventType, RecordingID,Additional Indexes:EventId), (EventType, KeywordConfidence, RecordingID) 

Explanation of EventType

EventType can be one the following values:

Value Description SU Time Auth

0 Participant connected. GA IC

1 Call went on hold. GA IC

2 Bookmark on the recording.   IC

3 Keyword spot on the recording.   Media

4 Recording started on the mediaserver.

SU02 Media

5 Secure pause SU03 IC

6 Secure IVR SU03 IC

7 Wrapup Code SU04 IC

8 Transfer SU05 IC

9 Snippet Request 2016r3 IC

10 Park 2018r1 IC

IR_EventKeywordInfo Table

Column Name Type Null Description SU

EventId Integer No The EventId from thecorresponding IR_Eventrow entry

2015r4

Page 11: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

KeywordSetId Integer No The KeywordSetId fromthe correspondingIR_KeywordSet row entry

2015r4

Indexes

Primary Key: EventIdEventId, KeywordSetIdForeign Keys: 

KeywordSetIdAdditional Indexes: 

IR_Keyword TableThe IR_Keyword table contains the names of keywords that were spotted on the recording. These names can be referenced by many recordings.

Column Name Type Null Description SU

KeywordId Integer No ID of the keyword. GA

KeywordName NVarChar(128) No Name of the keyword. GA

Indexes

Primary Key: KeywordIdForeign Keys:Additional Indexes:

IR_KeywordSet Table

Column Name Type Null Description SU

KeywordSetId Integer No ID the keyword set entry. 2015r4

DisplayName NVarChar(128) No Display Name of thekeyword set

2015r4

Category NVarChar(128) Yes Category of the keywordset

2015r4

Indexes

Primary Key: KeywordSetIdForeign Keys:

DisplayName, CategoryAdditional Indexes:

IR_QAnswer TableThe IR_QAnswer table contains answers to a question on a questionnaire.

Column Name Type Null Description SU

QAnswerId UniqueIdentifier No ID of the answer. GA

QFormId UniqueIdentifier No ID of the form thatcontains this answer.

GA

QQuestionId UniqueIdentifier No ID of the question thatwas answered.

GA

Sequence Integer No Sequence number of theanswer within the form.

GA

Score Numeric(19,6) Yes Score given to theanswer.

GA

Page 12: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

RawAnswer NVarChar(1024) Yes Raw text input of theanswer.

GA

UserComments NVarChar(1024) Yes Comments provided withthe answer.

GA

IsMarkedNA TinyInt No Was the answer markedN/A? One if true elsezero.

GA

Version Integer No Version of the databaserow.

GA

Indexes

Primary Key: QAnswerId QFormId, QQuestionIdForeign Keys:

QFormId + QQuestionId + SequenceAdditional Indexes:

IR_QDirectory TableThe IR_QDirectory table contains questionnaires directories. Questionnaires are contained in these directories.

Column Name Type Null Description SU

QDirectoryId UniqueIdentifier No ID of the directory. GA

QDirectoryName NVarChar(255) Yes Name of the directory. GA

Note NVarChar(1024) Yes Notes about the directory. GA

IsTemplate TinyInt No Is the directory atemplate? One if true elsezero. (Reserved for lateruse)

GA

Version Integer No Version of the databaserow.

GA

Indexes

Primary Key: QDirectoryIdForeign Keys:Additional Indexes:

IR_QForm TableThe IR_QForm table contains saved and completed forms for a questionnaire.

Column Name Type Null Description SU

QFormId UniqueIdentifier No ID of the form. GA

QuestionnaireId UniqueIdentifier No ID of the questionnairethis form providesanswers to.

GA

RecordingId UniqueIdentifier Yes ID of the recording thatthis form refers to.

GA

ScoringIndivId Char(22) Yes Individual ID of the userwho is scoring therecording.

GA

TargetIndivId Char(22) Yes Individual ID of the userbeing scored.

GA

Page 13: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

TargetIntx_Part_Id Char(22) Yes Participant ID on theinteraction of the userbeing scored.

GA

ScoringState Integer No Scoring state of the form.(See below)

GA

Score Numeric(19,6) No Total score of the form. GA

RankName NVarChar(40) Yes Name of the rank given tothe form based on it'sscore.

GA

MaxScore Numeric(19,6) Yes Maximum score of allanswers scored for theform.

GA

MinScore Numeric(19,6) Yes Minimum score of allanswers scored for theform.

GA

ScoringDate DateTime Yes Time the form was lastscored and saved.

GA

ScoringDateOffset Integer Yes UTC offset of the scoringdate.

GA

AssignedDesc NVarChar(1024) Yes Name of the RecorderPolicy that caused theform to be assigned.

GA

NonCriticalMaxScore Numeric(19,6) Yes Total maximum score ofall non-critical questionsanswered for the form.

GA

NonCriticalMinScore Numeric(19,6) Yes Total minimum score ofall non-critical questionsanswered for the form.

GA

NonCriticalScore Numeric(19,6) Yes Total score of allnon-critical questionsanswered for the form.

GA

CriticalAccuracyScore Numeric(19,6) Yes Stores the criticalaccuracy percentage(0.00 – 100.00) ofpositively answeredcritical questions dividedby the total number ofcritical questionsanswered within ascorecard.

GA

NumAnsweredCriticalQstns

Integer Yes Number of criticalquestions answered.

GA

NumPosAnsweredCriticalQstns

Integer Yes Number of positivelyanswered criticalquestions.

GA

IsFailed TinyInt Yes Indicates whether thescorecard has beenmarked Pass or Fail.NULL for non-pass/failquestionnaires. (Seebelow)

GA

UsingForCalibration TinyInt No Was this form used forcalibration. (See tablebelow)

GA

SignoffState TinyInt Yes State of the sign-offprocess. (See below)

SU03

Page 14: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

SignoffComments NVarChar(2000) Yes Comments about thesign-off.

SU03

Version Integer No Version of the databaserow.

GA

Indexes

Primary Key: QFormId QuestionnaireId, RecordingId, ScoringIndivId, TargetIndivId, TargetIntx_Part_IdForeign Keys:

Additional Indexes:

Explanation of ScoringState

ScoringState can be one the following values:

Value Description

0 None. Scoring has not yet started.

1 Assigned. Questionnaire Scorecard has been assigned but notstarted.

2 Incomplete. Questionnaire Scorecard has been saved but notfinished.

3 Finished.

Explanation of IsFailed

IsFailed can be one the following values:

Value Description

NULL Not marked passed or failed. Either the questionnaire is not pass/failor the scorecard has not been finished.

0 Scorecard passed.

1 Scorecard failed.

Explanation of SignoffState

SignoffState can be one the following values:

Value Description

NULL Sign-off process has not yet started.

0 Sign-off process is in progress.

1 Sign-off process has completed.

Explanation of UsingForCalibration

UsingForCalibration can be one of the following values:

Value Description

0 Not marked for calibration.

1 Marked for calibration.

2 Required for calibration. Set via a policy or assigned via the recordermodule.

Note: 0=Not marked for calibration and >0=Marked for calibration.

Page 15: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

IR_QGroup TableThe IR_QGroup table contains groups that hold questionnaire questions. Questionnaires are composed of groups. Those groups containquestions.

Column Name Type Null Description SU

QGroupId UniqueIdentifier No ID of the group. GA

QuestionnaireId UniqueIdentifier Yes ID of the questionnairethat contains this group.

GA

GroupName NVarChar(255) No Name of the group. GA

Sequence Integer No Sequence number of thegroup within thequestionnaire.

GA

Note NVarChar(1024) Yes Notes for the group. GA

IsOptional TinyInt No Is the group optional?One if true else zero.

GA

IsTemplate TinyInt No Is the group a template?One if true else zero.(Reserved for later use)

GA

Version Integer No Version of the databaserow.

GA

Indexes

Primary Key: QGroupId QuestionnaireIdForeign Keys:

Additional Indexes:

IR_QQuestion TableThe IR_QQuestion table contains questions in a questionnaire. Questions belong to groups (IR_QGroup) who in turn belong to questionnaires.

Column Name Type Null Description SU

QQuestionId UniqueIdentifier No ID of the question. GA

QGroupId UniqueIdentifier No ID of the group thatcontains this question.

GA

QuestionText NVarChar(1024) No Question text. Thequestion beingasked/stated.

GA

QuestionType SmallInt No Type of question. (Seebelow)

GA

QuestionPromptType SmallInt No Specifies if the questionis required. (See below)

GA

HelpText NVarChar(1024) Yes Text to help clarify thequestion and how toanswer.

GA

Weight Numeric(19,6) No Weight placed on thequestion (-100.00 to100.00)

GA

Sequence Integer No Sequence number of thequestion within the group.

GA

MaxScore Numeric(19,6) No Maximum score aninteger/decimal questioncan have.

GA

Page 16: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

MinScore Numeric(19,6) No Minimum score aninteger/decimal questioncan have.

GA

MinAcceptableScore Numeric(19,6) No Minimum acceptablescore the question canhave. (Reserved for lateruse)

GA

Note NVarChar(1024) Yes Notes about the question. GA

IsTemplate TinyInt No Is the question atemplate? One if true elsezero. (Reserved for lateruse)

GA

HasCommentField TinyInt No Should a comment fieldbe displayed with thequestion? One if true elsezero.

GA

CanMarkNA TinyInt No Can the question bemarked N/A? One if trueelse zero.

GA

Version Integer No Version of the databaserow.

GA

Indexes

Primary Key: QQuestionId QGroupIdForeign Keys:

Additional Indexes:

Explanation of QuestionType

QuestionType can be one the following values:

Value Description

1 Free text question. (non-scoring)

2 Integer question.

3 Decimal question.

10 True / false question.

11 Multiple choice question.

Explanation of QuestionPromptType

QuestionPromptType can be one the following values:

Value Description

0 None.

1 Optional question.

2 Required question.

3 Critical question.

IR_QQuestionEnum TableThe IR_QQuestionEnum table contains enumerations for true/false and multiple choice questions. Also contains min/max values for numericquestions.

Page 17: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

Column Name Type Null Description SU

QQuestionId UniqueIdentifier No ID of the questionassociated with thisenumeration.

GA

Sequence Integer No Sequence number of theenumeration within thequestion.

GA

EnumText NVarChar(255) No Text displayed for theenumerated choice.

GA

HelpText NVarChar(1024) Yes Help text displayed withthe enumerated choice.

GA

Score Numeric(19,6) No Score given if theenumerated choice isselected.

GA

Version Integer No Version of the databaserow.

GA

Indexes

Primary Key: QQuestionId + SequenceForeign Keys:Additional Indexes:

IR_Questionnaire TableThe IR_Questionnaire table contains questionnaires used to score recordings for quality assurance purposes.

Column Name Type Null Description SU

QuestionnaireId UniqueIdentifier No ID of the questionnaire. GA

QDirectoryId UniqueIdentifier No ID of the directory thisquestionnaire belongs to.

GA

QuestionnaireName NVarChar(255) No Name of thequestionnaire.

GA

RankGroupId UniqueIdentifier Yes ID of the rank group usedto rank forms producedby this questionnaire.

GA

MaxScore Numeric(19,6) Yes Maximum score thequestionnaire can have.

GA

MinScore Numeric(19,6) Yes Minimum score thequestionnaire can have.

GA

MinAcceptableScore Numeric(19,6) Yes Minimum acceptablescore the questionnairecan have. (reserved forlater use)

GA

Note NVarChar(1024) Yes Notes for thequestionnaire.

GA

IsTemplate TinyInt No Is the questionnaire atemplate? One if true elsezero. (reserved for lateruse)

GA

Page 18: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

IsLocked TinyInt No Is the questionnairelocked? Called 'published'in the Recorder Client.Once a questionnaire ispublished it cannot beedited and can be usedfor scoring.

GA

ShowRankWhileScoring TinyInt No Should the rank bedisplayed while scoring?One if true else zero.

GA

TotalNumCriticalQuestions

Integer No Total number of criticalquestions in thequestionnaire.

GA

Version Integer No Version of the databaserow.

GA

IsActive TinyInt No Is the questionnaireactive? If thequestionnaire is notactive it is not editable orused for scoring. It is onlythere to be displayed withexiting forms. One if trueelse zero. (reserved forlater use)

GA

ShowPassFailWhileScoring

TinyInt No While scoring the form,displays the pass/failoption on a scorecard.One if true else zero.

GA

Indexes

Primary Key: QuestionnaireId QDirectoryId, RankGroupIdForeign Keys:

Additional Indexes:

IR_RankDefn TableThe IR_RankDefn table contains an individual rank within a rank group. If a questionnaire form's score is less than the rank's percentage butgreater than any other rank then the form is assigned this rank. Interaction Feedback surveys also use these ranks.

Column Name Type Null Description SU

RankId UniqueIdentifier No ID of the rank. GA

RankGroupId UniqueIdentifier No ID of the rank group thatcontains this rank.

GA

RankName NVarChar(40) No Name of the rank. GA

RankPct Numeric(19,6) No Maximum percentage tobe in this rank.

GA

Version Integer No Version of the databaserow.

GA

Indexes

Primary Key: RankId RankGroupIdForeign Keys:

Additional Indexes:

IR_RankGroup Table

Page 19: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

The IR_RankGroup table contains rank groups used to rank questionnaire forms. Rank groups contain individual ranks. Interaction Feedbacksurveys also use these rank groups.

Column Name Type Null Description SU

RankGroupId UniqueIdentifier No ID of the rank group. GA

GroupName NVarChar(60) No Name of the rank group. GA

Version Integer No Version of the databaserow.

GA

Indexes

Primary Key: RankGroupIdForeign Keys:Additional Indexes:

IR_RecordingMedia TableThe IR_RecordingMedia table is the primary table for a recording. There is one row for every recording managed by Interaction Recorder.

Column Name Type Null Description SU

RecordingId UniqueIdentifier No ID of the recording. GA

RelatedRecordingId UniqueIdentifier Yes ID of a related recording.Relates a recording of asegment to it's previoussegment or relates ascreen recording to it'sassociated interaction.More than one screenrecording can beassociated with aninteraction recording.

GA

MediaURI NVarChar(1024) Yes URI where the recordingis stored.

GA

MediaKey NVarChar(1024) Yes A key that when appliedwith the Master Key Filecan decrypt therecording. Seedocumentation onInteraction Recorder'ssecurity for more details.

GA

MediaType SmallInt No Type of media recorded.(See below)

GA

FileSize Integer Yes Size of the recording filein bytes.

GA

RecordingDate DateTime2 No Time the recording wasmade.

GA

RecordingDateOffset Integer No UTC offset of therecording date.

GA

ExpirationDate DateTime Yes Expiration date of therecording. When therecording expires it'sretention policies arere-evaluated.

GA

StartEventCode Integer No Reserved. GA

Duration Integer Yes Duration of the interactionin milliseconds.

GA

Page 20: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

ServerId NVarChar(64) Yes Reserved. GA, Removed in SU03

FromConnValue NVarChar(255) Yes Connection value of theinitiator of the interaction.

GA

ToConnValue NVarChar(255) Yes Connection value of thereceiver of the interaction.

GA

MediaStatus NVarChar(56) Yes Key that provideslicensed access to therecording. This is not forencryption. NULL if therecording is encumbered.

GA

Direction TinyInt Yes Direction the interactionwas going. (See below)

GA

QueueObjectIdKey VarChar(36) Yes ID of the interaction ofthis recording.

GA

InitiationPolicyName NVarChar(50) Yes Name of the initiationpolicy that initiated thisrecording.

GA

ScreenRecordedHostName

NVarChar(255) Yes If this is a screenrecording this is the nameof the computer wherethe recording was made.

GA

LineName NVarChar(50) Yes If this is a call recordingthen this is name of theline that the call tookplace on.

GA

NumAttachments SmallInt Yes If this is an emailrecording then this is thenumber of attachmentson that email.

GA

CallType TinyInt Yes For call recordings thetype of call. (See below)

GA

Version Integer No Version of the databaserow.

GA

KeywordCustomerScorePositive

Integer Yes Total score of the positivekeywords spotted on thecustomer's channel.

GA

KeywordCustomerScoreNegative

Integer Yes Total score of thenegative keywordsspotted on the customer'schannel.

GA

KeywordAgentScorePositive

Integer Yes Total score of the positivekeywords spotted on theagent's channel.

GA

KeywordAgentScoreNegative

Integer Yes Total score of thenegative keywordsspotted on the agent'schannel.

GA

IsArchived TinyInt No Has the recording beenarchived? One if true elsezero.

SU03

RecordingType SmallInt Yes The type of the recording(See "Explanation ofRecordingType" below)

2016r3

Indexes

Page 21: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

Primary Key: RecordingId RelatedRecordingIdForeign Keys:

ExpirationDate, KeywordAgentScorePositive, KeywordAgentScoreNegative, KeywordCustomerScorePositive,Additional Indexes:KeywordCustomerScoreNegative, QueueObjectIdKey, RecordingDate

Explanation of MediaType

MediaType can be one the following values:

Value Description

0 None.

1 Call.

2 Chat.

3 Email.

4 Fax.

5 Screen.

6 Chat Transcript

Explanation of Direction

Direction can be one the following values:

Value Description

0 Invalid.

1 Inbound.

2 Outbound.

3 Intercom.

4 Unknown.

Explanation of CallType

CallType can be one the following values:

Value Description

0 Unknown.

1 External, Inbound or Outbound.

2 Intercom.

3 Conference.

Explanation of RecordingType

RecordingType can be one the following values:

Value Description

NULL RecordingType not specified. IR_RecordingMedia rows that werecreated prior to 2016r3 will always have null entries for this columnsince the column didn't exist until 2016r3.

0 Policy-based recording.

1 Snippet recording.

Page 22: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

IR_RecordingMediaSnippets TableThe IR_RecordingMediaSnipppets table maps snippet recording IDs to corresponding policy recording IDs.  Note that an entry will only exist inthis table for a snippet recording if a policy recording of an interaction was done at the same time as a snippet recording of the same interaction.

Column Name Type Null Description SU

SnippetRecordingId UniqueIdentifier No ID of the snippetrecording.

2016r3

PolicyRecordingId UniqueIdentifier No ID of the policy-basedrecording.

2016r3

Indexes

Primary Key: SnippetRecordingId Foreign Keys: SnippetRecordingId, PolicyRecordingId

 Additional Indexes: PolicyRecordingId

IR_RecordingWork TableThe IR_RecordingWork table contains temporary data used when a search is performed.

Column Name Type Null Description SU

SessionId UniqueIdentifier No ID of the client's session. GA

RecordingId UniqueIdentifier No ID of the recording. GA

RecordingDate DateTime No Date the recording wasmade.

GA

FetchStatus TinyInt No Fetch status. GA

Indexes

Primary Key:Foreign Keys:

 RecordingDate, RecordingId, SessionIdAdditional Indexes:

IR_SecurityPolicy TableThe IR_SecurityPolicy table contains the SQL to be used for all the criteria test of each security policy. This is to be used while updatingIR_AccessControl table.

Column Name Type Null Description SU

SecurityPolicyId UniqueIdentifier No ID of the SecurityPolicy. 2016r1

ApplySql NVarChar(MAX) Yes SQL Select statement ofthe criteria selection forthis SecurityPolicy.

2016r1

Indexes

Primary Key: SecurityPolicyIdForeign Keys:

 Additional Indexes:

IR_Tag TableThe IR_Tag table contains names of tags. These names can be referenced by many recordings.

Column Name Type Null Description SU

Page 23: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

TagId Integer No ID of the tag. GA

TagName NVarChar(80) No Name of the tag. GA

Indexes

Primary Key: TagIdForeign Keys:

TagNameAdditional Indexes:

IR_TagMap TableThe IR_TagMap table contains entries for how tags are mapped to recordings. Tags can be mapped to recordings for search and other purposes.

Column Name Type Null Description SU

RecordingId UniqueIdentifier No ID of the recording thetag is mapped to.

GA

TagId Integer No ID of the tag that ismapped.

GA

KeywordSetName NVarChar(128) Yes If non-NULL, this tag isbeing added to thisrecording due toInteraction Analyzerspotting a keyword in thisset.

SU5

Indexes

Primary Key: RecordingId + TagId RecordingId, TagIdForeign Keys:

TagIdAdditional Indexes:

FeedbackThis is a Data Dictionary for Interaction Feedback 4.0.

Survey TableThe Survey table contains an entry for surveys or survey groups. Note the table is self-referential and embeds the parent-child relationship ofsurveys to survey groups.

Column Name Type Null Default Description

SurveyID 

Varchar(32) No   ID of the survey or surveygroup.

ParentSurveyId Varchar(32) Yes   ID of the parent survey orsurvey group.

SurveyName nVarchar(255) No   Name of the survey orsurvey group.

Note nVarchar(255) Yes   Notes about the survey orsurvey group.

Page 24: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

IsPublished Integer Yes   One if the survey ispublished else zero.Other values are notdefined. Survey groupsalways have a zero in thisfield.

IsTemplate Integer No   One if the survey is atemplate else zero. Othervalues are not defined.Template surveys arestored in the library andwon‘t have any surveyresults associated withthem.

MinAcceptableScore Numeric(19,6) Yes   Minimal acceptable scorefor the survey.

IsGroup Integer No   One if this entry is for asurvey group else zero.Other values are notdefined.

Priority Integer Yes   Priority of the survey. Nullfor survey groups.

RankGroupId UniqueIdentifier Yes   ID of the rank groupassociated with thesurvey. Null for surveygroups.

RecordCall Integer Yes   One if the surveyed callshould be recorded elsezero. Other values arenot defined. Null forsurvey groups.

Type Integer Yes   Type of Survey (See thefollowing Explanation ofType.)

Indexes

Primary Key: SurveyID (Clustered) ParentSurveyId (not indexed), RankGroupId (not indexed)Foreign Keys:

 SurveyNameAdditional Indexes:

Explanation of Type

Type Description

0 None.

1 Post-call survey.

2 Inbound survey.

SurveyAnswer TableThe SurveyAnswer table contains answers to questions, as the result of a survey.

Column Name Type Null Default Description

SurveyAnswerId Varchar(32) No   ID of the survey answer.

SurveyFormID UniqueIdentifier No   ID of the survey form thisanswer belongs to.

Page 25: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

SurveyQuestionId Varchar(32) No   ID of the question givenfor this answer.

NumericScore Numeric(19,6) Yes   Score given to thisanswer.

EnumSequence Integer Yes   For true/false or multiplechoice questions this isthe value ofEnumSequence in theSurveyQuestionEnumtable that contains thepossible answers to thequestion.

FreeFormAnswerURI Varchar(255) Yes   Path and filename of therecorded comment forfree-form questions. (Seethe following Explanationof FreeFormAnswerURI.)

Indexes

Primary Key: SurveyAnswerId (Clustered) SurveyFormID, SurveyQuestionIdForeign Keys:

   EnumSequenceAdditional Indexes:

Explanation of FreeFormAnswerURI

From Interaction Administrator, you can configure the base storage location of recorded comments. From there the recording is stored in a seriesof subfolders that are created based on the date of the recording. The FreeFormAnswerURI column only contains the date subfolders and thefilename of the recording. For example, if the base recording path is and the recording file name is andD:\FeedbackComments comment.wavwas recorded on 07/28/2011 at 19:18, then the value of this column would be "201107\2819\18\comment.wav".

To further elaborate on the value of FreeFormAnswerURI, the file name in our previous example was "comment.wav". This was an oversimplification. The actual file name of a recorded comment is generated from the following template:

_ _ .wavsurveysurveyId callId surveyQuestionId

where the italicized parts should be replaced with their values from the database. The call ID is only the 10 digit form of the call ID. For example ifthe survey ID is 1111, the call ID is 2001490800 and the survey question ID is 2222, then the file name would be "survey1111_2001490800_2222.wav".

SurveyDetail TableThe SurveyDetail table contains detailed information about the result of a survey. There is one row per survey offered.

Column Name Type Null Default Description

SurveyFormID UniqueIdentifier No   ID of the survey form.

EventCode Integer No   Event code for how thesurvey ended. (See thefollowing Explanation ofEventCode andEventDetail.)

EventDetail nVarchar(255) Yes   Textual representation ofthe EventCode column.

EventDate Datetime No   UTC Date and time ofwhen the survey wastaken.

CallIdKey Varchar(20) No   Full 18 digit call ID key ofthe interaction.

Origin Integer No   Origin of the survey (Seethe following Explanationof Origin)

Page 26: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

Indexes

Primary Key: SurveyFormID SurveyFormIDForeign Keys:

   EventDate (Clustered)Additional Indexes:

Explanation of EventCode and EventDetail

EventCode and EventDetail can be one of the following values:

EventCode EventDetail

0 None

1 Complete

2 Abandoned

3 Insufficient Resources

4 Opt-out

5 Error

6 NotAnswered

7 CallerDisconnect

Explanation of Origin

Origin Description

0 Post-call

1 External

2 Internal

3 Transfer

4 Outbound

 

SurveyForm TableThe SurveyForm table contains information about the result of a survey. There is one row per survey offered.

Column Name Type Null Default Description

SurveyFormId UniqueIdentifier No   ID of the survey form.

SurveyID Varchar(32) No   ID of the survey that wastaken.

CallIdKey Varchar(20) No   Full 18 digit call ID key ofthe interaction.

SurveyedIntxId Varchar(32) Yes   ID of the individual whotook this survey. Links tothe Individual table.

MaxScore Numeric(19,6) Yes   Maximum score thatcould be received whenthe survey was taken.

MinScore Numeric(19,6) Yes   Minimum score that couldbe received when thesurvey was taken.

Page 27: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

Score Numeric(19,6) Yes   Actual score received.

IsComplete Integer No   One (1) if the survey wascompleted, else zero (0).Other values are notdefined. SeeSurveyDetail.EventCodefor more informationabout why the survey wasnot completed.

RankName nVarchar(40) Yes   Name of the rank given tothis survey result.

Duration Integer Yes   Duration, in seconds, ofthe time it took tocomplete the survey.

Indexes

Primary Key: SurveyFormId (Clustered) SurveyIDForeign Keys:

   SurveyedIntxIdAdditional Indexes:

SurveyObjectToSurveyPrompt TableThis database table associates prompts that are assigned to a survey (Invitation, Opt-in, etc.) or a question. This is a many-to-many relationship.

Column Name Type Null Default Description

SurveyObjectID Varchar(32) No   ID of the survey orquestion.

SurveyPromptID Varchar(32) No   ID of the prompt beingassociated.

AppCode Integer No   When during the surveyor question the promptwill be played. (See thefollowing Explanation ofAppCode.)

Indexes

Primary Key: SurveyObjectID + SurveyPromptID + AppCode (Clustered) SurveyPromptIDForeign Keys:

 Additional Indexes:

Explanation of AppCode

AppCode can be one of the following values for surveys:

AppCode PromptUsage

0 Survey Invitation

1 Survey Opt-in

2 Survey Opt-Out

3 Survey Welcome

4 Survey Finish

5 Survey Help

6 Survey Bad Score

Or one of the following values for questions:

Page 28: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

AppCode Prompt Usage

7 Question Prompt

8 Question Help

9 Question No Input

10 Question No Match

11 Save Comment

12 Re-Record Comment

13 Re-Play Comment

SurveyPrompt TableThe SurveyPrompt table contains information about prompts available for use.

Column Name Type Null Default Description

SurveyPromptID Varchar(32) No   ID of the survey prompt.

PromptType Integer No   Type of prompt. (See thefollowing Explanation ofPromptType.)

PromptName nVarchar(255) Yes   Name of the prompt.

RecordingFile nVarchar(255) Yes   Filename of the recordedfile. All survey promptsare located at \I3\IC\Resources\SurveyProm

on the IC server.pts

PromptText nVarchar(1024) Yes   Text-to-speech that willplay if the prompt isunavailable.

Indexes

Primary Key: SurveyPromptID (Clustered)Foreign Keys: 

   Additional Indexes:

Explanation of PromptType

PromptType can be one of the following values:

PromptType Description

0 None.

1 File-based prompt.

2 Handler-based prompt.

3 TTS-based prompt.

SurveyQstnToQuestionCategory TableThe SurveyQstnToQuestionCategory maps questions to question categories. This is a many-to-many relationship.

Column Name Type Null Default Description

SurveyQuestionCategoryId

Varchar(32) No   ID of the survey questioncategory.

Page 29: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

SurveyQuestionId Varchar(32) No   ID of the survey question.

Indexes

Primary Key: SurveyQuestionCategoryId + SurveyQuestionId (Clustered) SurveyQuestionCategoryId, SurveyQuestionIdForeign Keys:

   Additional Indexes:

SurveyQuestion TableThe SurveyQuestion table contains the definition of questions in a survey or questions that are available to be added to a survey.

Column Name Type Null Default Description

SurveyQuestionID Varchar(32) No   ID of the survey question.

SurveyID Varchar(32) Yes   ID of the survey that thisquestion belongs to. Nullif this question does notbelong to a surveybecause it is in thelibrary.

QuestionParentId Varchar(32) Yes   ID of the parent question.

QuestionName nVarchar(255) No   Name of the question.

QuestionText nVarchar(255) Yes   Description of thequestion.

MinScore Numeric(19,6) No   Minimum score that canbe given to the question.

MaxScore Numeric(19,6) No   Maximum score that canbe given to the question.

IsOptional Integer No   One if the question isoptional else zero. Othervalues are not defined.

IsTemplate Integer No   One if the question is atemplate else zero. Othervalues are not defined.Template questions arestored in the library andwon‘t have any surveyassociated with them.

QuestionType Integer No   The type of question.(See the followingExplanation ofQuestionType.)

Weight Numeric(19,6) No   Weight given to thequestion when calculatinga survey‘s score.

Sequence Integer Yes   Sequence number of thequestion within thesurvey. Numbering startsat zero.

Timeout Integer Yes   Timeout, in seconds,when waiting for aresponse to the question.

Retries Integer Yes   Number of retries thecaller gets to answer thequestion.

Page 30: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

Options nVarchar(255) Yes   TUI options for recordingcomments. (See thefollowing Explanation ofOptions.)

MinAcceptableScore Numeric(19,6) No   The minimum score thata question can have andstill be consideredacceptable(implemented?)

FailSurveyScore Numeric(19,6) Yes   The score at which aquestion can cause anentire survey to fail(implemented?)

Indexes

Primary Key:  SurveyQuestionID (Clustered) SurveyIDForeign Keys:

   QuestionName, SequenceAdditional Indexes:

Explanation of QuestionType

QuestionType can be one of the following values:

QuestionType Description

0 None.

1 True / False

2 Multiple Choice

3 Numeric Range

4 Free-form (recording)

5 information

Explanation of Options

The Options field is a pipe delimited string for TUI options for a free form recording. The pipe delimited components are as follows:

Component Description

Terminate Keys A comma delimited set of keys to signify the end of a recording.

Escape Key Key to escape from making a recording.

Save Key Key to confirm the recording should be saved.

Re-Record Key Key to re-record the comment.

Replay Key Key to replay the recording just made.

Confirm Recording One to confirm the recording after it‘s been made. Zero to not confirmthe recording.

An example of an options string might be:

*,#,1,2,3,4,5,6,7,8,9,0|*|1|3|2|0

SurveyQuestionBranching TableThe SurveyQuestionBranching table contains the information for question branching.  There is one entry in this table for each configured branch.

Column Name Type Null Default Description

Page 31: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

SurveyQuestionBranchingID

UniqueIdentifier No   ID of the survey questionbranching entry

SurveyQuestionID Varchar(32) No   The ID of the question towhich this branchingentry corresponds

OperatorType Integer Yes   Operator type of thebranching condition (Seethe following Explanationof OperatorType)

Operand1Value Integer Yes   The operand1 of thebranching operator

Operand2Value Integer Yes   The operand2 of thebranching operator

TargetQuestionID Varchar(32) Yes   The question ID to jumpto if the condition is met

Sequence Integer Yes   The sequence of thebranching entry

Indexes

Primary Key:  SurveyQuestionBranchingID (Clustered) SurveyQuestionID (not indexed), TargetQuestionID (not indexed)Foreign Keys:

 Additional Indexes:

Explanation of OperatorType

OperatorType Description

0 Continue to Next

1 Less Than

2 Less Than Or Equal

3 Equal

4 Greater Than Or Equal

5 Greater Than

6 Between

7 Not Equal

8 Skip

SurveyQuestionCategory TableThe SurveyQuestionCategory table contains the definition of question categories.

Column Name Type Null Default Description

SurveyQuestionCategoryId

Varchar(32) No   ID of the survey questioncategory.

CategoryName nVarchar(255) No   Name of the category.

ACSISemantics Integer Yes   Meta data about thequestions in thiscategory. (See thefollowing Explanation ofACSISemantics.)

Indexes

Page 32: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

Primary Key: SurveyQuestionCategoryId Foreign Keys:

   ACSISemanticsAdditional Indexes:

Explanation of ACSISemantics

ACSISemantics can be one of the following values:

ACSISemantics Description

0 None.

1 Instructions.

100 Customer Satisfaction.

200 Future Behaviors.

300 Elements - IVR.

310 Elements - Representative Demeanor.

320 Elements - Representative Knowledge.

330 Elements - Communications.

340 Elements - Information Quality.

350 Elements - Timeliness.

360 Elements - Problem Resolution.

370 Elements - Images.

SurveyQuestionEnum TableThe SurveyQuestionEnum table contains enumerations for true/false and multiple choice questions. It also contains min/max values for numericquestions.

Column Name Type Null Default Description

SurveyQuestionEnumId Varchar(32) No   ID of the survey questionenumeration.

SurveyQuestionID Varchar(32) No   ID of the question theenumeration valuebelongs to.

EnumSequence Integer No   Sequence number of thevalue within theenumeration. Numberingstarts at zero.

EnumName nVarchar(255) No   Name of the enumerationvalue.

EnumText nVarchar(255) Yes   Description of theenumeration value.

EnumScore Numeric(19,6) Yes   Score given if thisenumeration value isselected.

Indexes

Primary Key: SurveyQuestionEnumId (Clustered) SurveyQuestionIDForeign Keys:

   EnumSequenceAdditional Indexes:

Page 33: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

SurveyRule TableThe SurveyRule table contains the rules that should be met in order to offer a survey.

Column Name Type Null Default Description

RuleID Varchar(32) No   ID of the survey rule.

SurveyID Varchar(32) No    ID of the survey the ruleapplies to.

AttributeId Varchar(50) Yes   Attribute name requiredby some rule types. (Seethe following Explanationof Value Fields.)

Operand Integer No   Operand to apply to thisrule. (See the followingExplanation of Operand.)

IntegerValue Integer Yes   Integer value required bysome rule types. (See thefollowing Explanation ofValue Fields.)

StringValue nVarchar(512) Yes   String value required bysome rule types. (See thefollowing Explanation ofValue Fields.)

DateValue Datetime Yes   Date value required bysome rule types. (See thefollowing Explanation ofValue Fields.)

RuleType Integer Yes   Type of rule that dictateswhich values apply. (Seethe following Explanationof RuleType.)

Indexes

Primary Key: RuleID (Clustered) SurveyIDForeign Keys:

   Additional Indexes:

Explanation of Operand

Operand can be one of the following values:

Operand Description

0 None.

1 Equals.

2 Less Than.

3 Greater Than.

4 Not Equal.

Explanation of RuleType

RuleType can be one of the following values:

RuleType Description

0 None.

1 Every Nth.

Page 34: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

2 Max Per Day.

3 Call Attribute

4 Call Attribute with Regular Expression.

5 Retry on Opt-Out.

6 DateTime.

Explanation of Value Fields

Rule Rule Type Operand AttributeId IntegerValue StringValue DateValue

Calls routed totheseworkgroups

3 (Call attribute) 1 (Equals) Eic_WorkgroupName

0 WorkgroupName

NULL

From thefollowing callers(ANI)

3 (Call attribute) 1 (Equals) Eic_RemoteTnRaw

0 Phone Number NULL

Calls to thesenumbers

3 (Call attribute) 1 (Equals) Eic_LocalTnRaw 0 Phone Number NULL

Every Nth Call 1 (Every nth) 0 (None) NULL Nth Call NULL NULL

Max number ofsurveys per day

2 (Max per day) 0 (None) NULL Max surveys NULL NULL

Between thesetimes

6 (DateTime) 0 (None) NULL 0 StartTime|EndTi||||||me

NULL

Between thesedates

6 (DateTime) 0 (None) NULL 0 || |StartDate EndD||||ate

NULL

During theseweekdays

6 (DateTime) 0 (None) NULL 0 |||| ||Weekdays NULL

During theseweek/ days of themonth

6 (DateTime) 0 (None) NULL 0 |||||| |DayWeek NULL

During thesedays of themonth

6 (DateTime) 0 (None) NULL 0 ||||| ||Days NULL

During thesemonths

6 (DateTime) 0 (None) NULL 0 |||||||Months NULL

The call hasAttribute set toValue

3 (Call attribute) 1 (Equals) Attribute Name 0 Attribute Value NULL

Note that the date values on some rules consist of a pipe delimited string. Each rule uses one or two fields of that pipe delimited list with therest of the values being empty. For reference, the following are all of the fields in that delimited string.

ST|ET|SD|ED|DA|DY|DW|MO

ST – Start Time

ET – End Time

SD – Start Date

ED – End Date

DA – Day of theWeek

DY – Day of the Month

DW – Day of the Week and Week of the Year

MO – Month of the Year

Page 35: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

For the rule 'Between these times' we use the Start and End Time fields. These fields should be in 24-hour time with no separator betweenthe hour and minute. For example, the value of a time range between 9:00 and 17:00 would be "0900|1700||||||".

For the rule 'Between these dates' we use the Start and End Date fields. These fields consist of the year followed by the month followed bythe day. For example, the value for a date range between 08/01/2011 and 08/31/2011 would be "||20110801|20110831||||".

For the rule 'During these weekdays' we use the Day of the Week field. This field consists of a three letter acronym for the day of the week.Multiple days are split by a semi-colon. For example, the value of the days of the week Monday through Friday would be"||||mon;tue;wed;thu;fri|||".

For the rule 'During these week/days of the month' we use the Day of the Week and Week of the Year field. This field consists of a threeletter abbreviation for the day of the week followed by a number that represents the week of the year. Multiple day/week values areseparated by a semi-colon. For example, the value of the first Monday and the third Friday would be "||||||mon1;fri3|".

For the rule 'During these days of the month' we use the Day of the Month field. This field consists of a numeric value for the day. Multipledays are separated by a semi-colon. For example, the value of the first and fifteenth of the month would be "|||||1;15||".

For the rule 'During these months' we use the Month of the Year field. This field consists of a three letter acronym for the month. Multiplemonths are split by a semi-colon. For example, the value of January through March would be "|||||||jan;feb;mar".

The following tables are for internal use only and are used in the internal workings for the Feedback Server.

SurveyConfigLog TableThe SurveyConfigLog table consists of changes made to surveys. It holds at most two years of data.

Column Name Type Null Default Description

ConfigChangeObjectType Integer No   The part of the surveythat was changed, e.g.question, prompt, rule(See the followingExplanation ofConfigChangeObjectType.)

ConfigChangeType Integer No   The type of change madeto a survey, e.g. Add,Update, Delete. (See thefollowing Explanation of

)ConfigChangeType.

ConfigTimeStampUTC Datetime No   UTC timestamp for theevent

Indexes

Primary Key: ConfigChangeObjectType + ConfigChangeType + ConfigTimeStampUTC (Clustered) Foreign Keys:

   Additional Indexes:

Explanation of ConfigChangeObjectType

Value Description

0 None

1 All

2 Survey

3 Question

4 Prompt

5 Ranking

6 Rule

Page 36: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

7 Survey Form

8 Question Category

9 Survey Result

10 Rule Condition

11 Survey Prompt

12 Survey Priority

13 Question Prompt

14 Question Enum

15 Branching Instruction

Explanation of ConfigChangeType

Value Description

0 None

1 Add

2 Update

3 Delete

SurveyUserObjectSecurity TableThe SurveyUserObjectSecurity table consists of a computed set of security rights for users currently logged into Interaction Center BusinessManager.

Column Name Type Null Default Description

IndivID Char(22)  No    

ObjectType Integer  No    

ObjectName nVarchar(255) Yes    

ObjectID Integer Yes    

ExtObjectID Varchar(32) Yes    

UserRight Integer No    

SiteIdentifier Integer Yes    

Indexes

Primary Key: IndivID + ObjectType + ExtObjectID + SiteIdentifier (Clustered) Foreign Keys:

   Additional Indexes:

SurveyWork TableThe SurveyWork table contains temporary data used when a search is performed from Interaction Center Business Manager.

Column Name Type Null Default Description

SessionID Varchar(32) Yes    

ItemID Varchar(32) Yes    

Data nVarchar(255) Yes    

Page 37: Interaction Quality Management Data Dictionary · Interaction Quality Management Data Dictionary Technical Reference 2018 R2 Last updated 2018 -02 09 Abstract This Technical Reference

Indexes

Primary Key: SessionID + ItemID (Clustered) Foreign Keys: Additional Indexes: ItemID