Difference between revisions of "DES/Current/Designer/SdrRef"

From Genesys Documentation
Jump to: navigation, search
m (Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2")
(Published)
Line 8: Line 8:
 
|Role=Administrator
 
|Role=Administrator
 
|Application=Designer
 
|Application=Designer
|Prereq=
 
 
|Section={{Section
 
|Section={{Section
|sectionHeading=
 
|anchor=
 
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
+
|structuredtext=This page lists some of the most commonly used Session Detail Record (SDR) fields. It is not intended as a comprehensive list of all SDR fields used by Designer.
|image=
 
|structuredtext=In most cases, the most commonly used Session Detail Record (SDR) fields are automatically populated with {{Link-SomewhereInThisManual|topic=SdrRef|anchor=autopop|display text=system-generated values}}. But in some cases, the values are based on {{Link-SomewhereInThisManual|topic=SdrRef|anchor=manual|display text=information provided by the application developer}}, such as the name of the country and the language of the application.
 
  
The SDR fields are organized according to the block category (or classification) they are most typically associated with.
+
Each entry notes whether the value is set by '''Designer''' (i.e. system-generated) or provided by the application '''Developer'''.
  
{{NoteFormat|Not sure which category your field belongs to? Use the search function in your browser to see if it's listed on this page. For example, in Chrome, press '''CTRL + F''' to open the search tool.|2}}
+
The '''Category''' associates each field with the source of its value. For example, it indicates if the value was pulled from '''Session Information''' (captured during application runtime) or from certain types of blocks that were encountered, such as '''Routing''' or '''Business Controls'''.
|structuredtextwide=
 
|FAQHeading=
 
|Status=No
 
}}{{Section
 
|sectionHeading=Session Data
 
|anchor=SessionData
 
|alignment=Vertical
 
|Media=
 
|image=
 
|structuredtext=The following SDR fields contain values that are sourced from data collected during various phases of the application session. They are mostly used for generating reports on the {{Link-SomewhereInThisManual|topic=AnalyticsBar|anchor=dashboards|display text=Designer Dashboards}} but can also be used for troubleshooting.
 
  
{{AnchorDiv|autopop}}
+
You can use the column headers to sort the items.{{NoteFormat|To quickly check if a field is listed on this page, you can use the search function in your browser. For example, in Chrome, press '''CTRL + F''' to open the search tool.|2}}
===Values set by Designer===
 
{{{!}}
 
! width="" "25%"{{!}}'''Field'''
 
!'''Description'''
 
{{!}}-
 
{{!}}<tt>@endtime</tt>
 
{{!}}Timestamp of when the interaction ended.
 
Example: <tt>2017-03-08T01:56:26.085Z</tt>
 
{{!}}-
 
{{!}}<tt>@timestamp</tt>
 
{{!}}Timestamp of when the interaction started.
 
Example: <tt>2017-03-08T01:56:12.037Z</tt>
 
{{!}}-
 
{{!}}<tt>ANI</tt>
 
{{!}}The caller's phone number (or Caller ID).
 
{{!}}-
 
{{!}}<tt>asduration</tt>
 
{{!}}Length of time that the call was in the Assisted Service phase.
 
{{!}}-
 
{{!}}<tt>asend</tt>
 
{{!}}Timestamp of when the Assisted Service (or IVR) phase of the interaction ended. If the interaction was routed, this value represents the time that the session exited the Self Service phase.
 
Example: <tt>2017-03-08T01:56:20.937Z</tt>
 
{{!}}-
 
{{!}}<tt>asstart</tt>
 
{{!}}Timestamp of when the interaction entered the Assisted Service phase.
 
Example: <tt>2017-03-08T01:56:20.933Z</tt>
 
{{!}}-
 
{{!}}<tt>callEndReason</tt>
 
{{!}}Indicates why a call ended, such as whether it was terminated in Self Service, Assisted Service, or due to a System Error.
 
{{!}}-
 
{{!}}<tt>DNIS</tt>
 
{{!}}The phone number that the caller dialed.
 
{{!}}-
 
{{!}}<tt>duration</tt>
 
{{!}}Duration of the total session, in milliseconds (ms). '''Tip:''' To calculate the duration of blocks execution and exclude session wrap-up time, subtract the value of the <tt>operationalOverheadDuration</tt> field from this value.
 
{{!}}-
 
{{!}}<tt>operationalOverheadDuration</tt>
 
{{!}}Total time that the application was in an idle state (typically, this occurs just before the session finalizes).
 
{{!}}-
 
{{!}}<tt>finalDisposition</tt>
 
{{!}}Status of an interaction at the time it exited the application flow, such as whether it was routed to an agent or the caller hung up. (See {{Link-SomewhereInThisManual|topic=SummaryDash|anchor=Count_by_Disposition|display text=Count by Disposition}} for more information about dispositions.)
 
{{!}}-
 
{{!}}<tt>InteractionCategory</tt>
 
{{!}}Channel type used for the interaction (voice, chat, or email).
 
{{!}}-
 
{{!}}<tt>InteractionID</tt>
 
{{!}}Unique ID of the interaction. This ID can be used to track an interaction across multiple application sessions (or multiple instances of the ''same'' application).
 
{{!}}-
 
{{!}}<tt>ssduration</tt>
 
{{!}}Amount of time that the caller spent in the Self Service phase of the application (in milliseconds).
 
{{!}}-
 
{{!}}<tt>ssend</tt>
 
{{!}}Timestamp of when the Self Service (or IVR) portion of the interaction ended.
 
{{!}}-
 
{{!}}<tt>ssstart</tt>
 
{{!}}Timestamp of when the Self Service phase of the application started.
 
{{!}}-
 
{{!}}}
 
{{AnchorDiv|manual}}
 
===Values set by application developer===
 
These fields are populated with values that were provided by the application developer.
 
{{{!}}
 
! width="" &quot;25%&quot;{{!}}'''Field'''
 
!'''Description'''
 
{{!}}-
 
{{!}}<tt>activities</tt>
 
{{!}}List of activities encountered in the interaction. Activities are defined in an {{Link-SomewhereInThisManual|topic=Activity|anchor=top|display text=Activity block}} or automatically captured when an interaction enters or exits a {{Link-SomewhereInThisManual|topic=SharedModulesBar|anchor=top|display text=shared module}}.
 
{{!}}-
 
{{!}}<tt>activitycount</tt>
 
{{!}}Number of activities that were referenced in the interaction.
 
{{!}}-
 
{{!}}<tt>CountryName</tt>
 
{{!}}Name of the country.
 
{{!}}-
 
{{!}}<tt>LanguageName</tt>
 
{{!}}Language of the application.
 
{{!}}-
 
{{!}}}
 
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
|sectionHeading=Business Controls
+
|sectionHeading=List of Session Detail Record fields
|anchor=BusinessControls
+
|anchor=sdr
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
+
|structuredtext={{{!}} class="sortable"
|image=
+
!'''Field'''
|structuredtext=These fields contain values sourced from {{Link-SomewhereInThisManual|topic=BusinessCtrlBlocks|anchor=top|display text=Business Controls}} blocks.
 
{{{!}}  
 
! width="" &quot;25%&quot;{{!}}'''Field'''
 
 
!'''Description'''
 
!'''Description'''
{{!}}-  
+
!'''Category'''
{{!}}<tt>businesshourserrcount</tt>
+
!'''Set by'''
{{!}}Number of times a {{Link-SomewhereInThisManual|topic=BusinessHrs|anchor=top|display text=Business Hours block}} was accessed during the interaction.
+
{{!}}-
{{!}}-
+
{{!}}ANI
{{!}}<tt>businesshoursextcount</tt>
+
{{!}}The {{Glossaryterm|term=Automatic Number Identification|addlink=true}} is the customer's phone number (or Caller ID).
{{!}}Total number of external business hours checks that occurred within a session.
+
{{!}}Call Information
{{!}}-
+
{{!}}Designer
{{!}}<tt>businesshoursreqcount</tt>
+
{{!}}-
{{!}}Total number of requests for business hours checks  that occurred within a session.
+
{{!}}DNIS
{{!}}-
+
{{!}}The {{Glossaryterm|term=Dialed Number Identification Service|addlink=true}} is the phone number that the customer dialed.
{{!}}<tt>emergencieserrcount</tt>
+
{{!}}Call Information
{{!}}Total number of {{Link-SomewhereInThisManual|topic=EmergencyFlags|anchor=top|display text=emergency flag}} checks within a session.
+
{{!}}Designer
{{!}}-
+
{{!}}-
{{!}}<tt>emergenciesextcount</tt>
+
{{!}}applicationName
{{!}}Total number of external {{Link-SomewhereInThisManual|topic=EmergencyFlags|anchor=top|display text=emergency flag}} checks within a session.
+
{{!}}The name of the application, as provided by the application Developer when {{Link-SomewhereInThisVersion|manual=Designer|topic=ApplicationsBar|anchor=appcreate|display text=creating a new application}}.
{{!}}-
+
{{!}}Application Settings
{{!}}<tt>specialdayserrcount</tt>
+
{{!}}Developer
{{!}}Total number of special days checked within a session (all checks in a single {{Link-SomewhereInThisManual|topic=SpecialDay|anchor=top|display text=Special Day}} block count as one check).
+
{{!}}-
{{!}}-  
+
{{!}}applicationID
{{!}}<tt>specialdaysextcount</tt>
+
{{!}}The unique internal ID that Designer assigned to the application.
{{!}}Total number of special days checked externally within a session (all checks in a single {{Link-SomewhereInThisManual|topic=SpecialDay|anchor=top|display text=Special Day}} block count as one check).
+
 
{{!}}-
+
{{NoteFormat|You can quickly view an application ID by mousing over the application link on the {{Link-SomewhereInThisVersion|manual=Designer|topic=ApplicationsBar}} page and checking the target URL that appears in the browser window.
{{!}}<tt>specialdaysreqcount</tt>
+
 
{{!}}Total number of exceptions encountered when checking special days (all errors in a single {{Link-SomewhereInThisManual|topic=SpecialDay|anchor=top|display text=Special Day}} block count as one check).
+
[[File:des_sdr_ref_applicationID.png]].|2}}
{{!}}-
+
{{!}}Application Settings
{{!}}}
+
{{!}}Designer
|structuredtextwide=
+
{{!}}-
|FAQHeading=
+
{{!}}ApplicationType
|Status=No
+
{{!}}The application type, as selected by the application developer when the application was created (see {{Link-SomewhereInThisVersion|manual=Designer|topic=ApplicationsBar|anchor=appcreate|display text=creating a new application}}). The values are as follows:
}}{{Section
+
 
|sectionHeading=Routing Data
+
*application = Default
|anchor=RoutingData
+
*eservices = Digital
|alignment=Vertical
+
*callback = Callback
|Media=
+
{{!}}Application Settings
|image=
+
{{!}}Developer
|structuredtext=These fields contain values sourced from {{Link-SomewhereInThisManual|topic=RoutingBlocks|anchor=top|display text=Routing}} blocks.
+
{{!}}-
{{{!}}  
+
{{!}}applicationVersion
! width="" &quot;25%&quot;{{!}}'''Field'''
+
{{!}}Optional custom ''version'' of the application to use for reporting purposes, as specified by the application developer on the {{Link-SomewhereInThisVersion|manual=Designer|topic=ApplicationSettings|anchor=general|display text=General tab}} in the application settings.
!'''Description'''
+
{{!}}Application Settings
{{!}}-
+
{{!}}Developer
{{!}}<tt>routingBlockCount</tt>
+
{{!}}-
{{!}}Number of routing blocks that were hit within a session.
+
{{!}}ApplicationReportingTitle
{{!}}-
+
{{!}}Optional custom ''title'' of the application for reporting purposes, as specified by the application developer on the {{Link-SomewhereInThisVersion|manual=Designer|topic=ApplicationSettings|anchor=general|display text=General tab}} in the application settings.
{{!}}<tt>routingBlockTimeoutCount</tt>
+
{{!}}Application Settings
{{!}}Number of times that routing blocks timed out.
+
{{!}}Developer
{{NoteFormat|A high number here can indicate that customers are waiting too long in the queue for some reason. For example, skill levels might be set too high or there are not enough agents available.|2}}
+
{{!}}-
{{!}}-  
+
{{!}}SessionID
{{!}}<tt>routingCallHandlingType</tt>
+
{{!}}The unique internal ID that Designer assigned to the session.
{{!}}Indicates the type of routing used for the call (<tt>default</tt> or <tt>consult</tt>).
+
{{!}}Session Information
{{!}}-  
+
{{!}}Designer
{{!}}<tt>routingLCAAttempted</tt>
+
{{!}}-
{{!}}Indicates if '''Last Called Agent''' routing was attempted (this option can be enabled on the {{Link-SomewhereInThisManual|topic=RouteAgent|anchor=top|display text=Route Agent}} block).
+
{{!}}InteractionID
{{!}}-
+
{{!}}The unique internal ID that Designer assigned to the interaction.
{{!}}<tt>routingSkillRelaxationCount</tt>
+
{{!}}Session Information
{{!}}Number of routing blocks that used skill relaxation.
+
{{!}}Designer
{{!}}-
+
{{!}}-
{{!}}}
+
{{!}}InteractionCategory
|structuredtextwide=
+
{{!}}The channel type that was used for the interaction. For example: voice, chat, or email.
|FAQHeading=
+
{{!}}Session Information
|Status=No
+
{{!}}Designer
}}{{Section
+
{{!}}-
|sectionHeading=User Interaction
+
{{!}}ConnectionID
|anchor=UserInteraction
+
{{!}}The connection ID that Designer assigned to the interaction. For example: <tt>016202fe11099003</tt>
|alignment=Vertical
+
{{!}}Session Information
|Media=
+
{{!}}Designer
|image=
+
{{!}}-
|structuredtext=These fields contain values sourced from {{Link-SomewhereInThisManual|topic=UserIntBlocks|anchor=top|display text=User Interaction}} blocks.
+
{{!}}finalDisposition
{{{!}}  
+
{{!}}Disposition code indicating the status of the interaction at the time it exited the application flow. For example, this value can indicate if the interaction was routed to an agent or the customer disconnected from the call. Disposition codes can be enabled in the {{Link-SomewhereInThisVersion|manual=Designer|topic=ApplicationPhases|anchor=finalize|display text=Finalize}} phase. For more information, see {{Link-SomewhereInThisVersion|manual=Designer|topic=ApplicationPhases|display text=disposition codes}}.
! width="" &quot;25%&quot;{{!}}'''Field'''
+
{{!}}Session Information
!'''Description'''
+
{{!}}Designer
{{!}}-
+
{{!}}-
{{!}}<tt>inputcount</tt>
+
{{!}}LanguageName
{{!}}Total number of {{Link-SomewhereInThisManual|topic=UserInput|anchor=top|display text=User Input blocks}} executed during a session.
+
{{!}}The language that was set for the application at the time when the interaction ended.
{{!}}-
+
{{NoteFormat|Note that {{Link-SomewhereInThisVersion|manual=Designer|topic=ChangeLang}} blocks can be used to change the language at select points in an application flow. This value always reflects the ''last'' language that was set for the application when the interaction ended.|2}}
{{!}}<tt>nicount</tt>
+
{{!}}Session Information
{{!}}Total count of '''No Input''' instances that occurred for Input class blocks ({{Link-SomewhereInThisManual|topic=UserInput|anchor=top|display text=User Input}} and {{Link-SomewhereInThisManual|topic=Menu|anchor=top|display text=Menu}}).
+
{{!}}Developer
{{!}}-
+
{{!}}-
{{!}}<tt>nmcount</tt>
+
{{!}}@endtime
{{!}}Total count of '''No Match''' instances that occurred for Input class blocks ({{Link-SomewhereInThisManual|topic=UserInput|anchor=top|display text=User Input}} and {{Link-SomewhereInThisManual|topic=Menu|anchor=top|display text=Menu}}).
+
{{!}}Timestamp to indicate when the interaction ended. Example: <tt>2017-03-08T01:56:26.085Z</tt>
{{!}}-  
+
{{!}}Session Information
{{!}}<tt>strikeoutcount</tt>
+
{{!}}Designer
{{!}}Count of inputs where the maximum number of permitted attempts was exceeded.
+
{{!}}-
{{!}}-  
+
{{!}}@timestamp
{{!}}}
+
{{!}}Timestamp to indicate when the interaction started. Example: <tt>2017-03-08T01:56:12.037Z</tt>
|structuredtextwide=
+
{{!}}Session Information
|FAQHeading=
+
{{!}}Designer
|Status=No
+
{{!}}-
}}{{Section
+
{{!}}duration
|sectionHeading=External Requests
+
{{!}}Duration of the total session, in milliseconds (ms).  
|anchor=ExternalRequests
+
{{NoteFormat|To calculate the duration of blocks execution and exclude session wrap-up time, subtract the value of the {{Link-SomewhereInThisVersion|manual=Designer|topic=SdrRef|anchor=operationalOverheadDuration|display text=operationalOverheadDurationz}} field from this value.|2}}
|alignment=Vertical
+
{{!}}Session Information
|Media=
+
{{!}}Designer
|image=
+
{{!}}-
|structuredtext=These fields contain values sourced from {{Link-SomewhereInThisManual|topic=ExtServBlocks|anchor=top|display text=External Services}} blocks.
+
{{!}}{{AnchorDiv|operationalOverheadDuration}}operationalOverheadDuration
 +
{{!}}Total amount of time, in milliseconds (ms), that the application was in an idle state. Typically, this state occurs just before the session enters the {{Link-SomewhereInThisVersion|manual=Designer|topic=ApplicationPhases|anchor=finalize|display text=Finalize}} phase.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}ssduration
 +
{{!}}Amount of time (in milliseconds) that the customer spent in the {{Link-SomewhereInThisVersion|manual=Designer|topic=ApplicationPhases|anchor=selfservice|display text=Self Service}} phase of the application.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}ssstart
 +
{{!}}Timestamp to indicate when the {{Link-SomewhereInThisVersion|manual=Designer|topic=ApplicationPhases|anchor=selfservice|display text=Self Service}} phase of the application started.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}ssend
 +
{{!}}Timestamp to indicate when the {{Link-SomewhereInThisVersion|manual=Designer|topic=ApplicationPhases|anchor=selfservice|display text=Self Service}} phase of the interaction ended.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}asduration
 +
{{!}}Length of time (in milliseconds) that the customer spent in the {{Link-SomewhereInThisVersion|manual=Designer|topic=ApplicationPhases|anchor=assistedservice|display text=Assisted Service}} phase.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}asstart
 +
{{!}}Timestamp to indicate when the interaction entered the {{Link-SomewhereInThisVersion|manual=Designer|topic=ApplicationPhases|anchor=assistedservice|display text=Assisted Service}} phase. Example: <tt>2017-03-08T01:56:20.933Z</tt>
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}asend
 +
{{!}}Timestamp to indicate when the {{Link-SomewhereInThisVersion|manual=Designer|topic=ApplicationPhases|anchor=assistedservice|display text=Assisted Service}} of the interaction ended.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}variables
 +
{{!}}List of all user and system {{Link-SomewhereInThisVersion|manual=Designer|topic=Variables|display text=variables}} that contain values.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}survey
 +
{{!}}List of survey-related variables. For more information, see the '''survey_*''' variables listed in {{Link-SomewhereInThisVersion|manual=Designer|topic=Variables|anchor=SystemVariables|display text=system variables}} and the {{Link-SomewhereInThisVersion|manual=Designer|topic=Survey}} page.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}calldata
 +
{{!}}List of all call data Key-Value Pairs (KVPs) encountered by the application. For more information, see the {{Link-SomewhereInThisVersion|manual=Designer|topic=CallData|display text=Call Data}} block page.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}callAbandonedBlock
 +
{{!}}If the customer leaves the session (for example, hangs up), this field contains the ID of the block that was being processed when they left.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}callEndState
 +
{{!}}Indicates if the call ended in the {{Link-SomewhereInThisVersion|manual=Designer|topic=ApplicationPhases|anchor=assistedservice|display text=Assisted Service}} or {{Link-SomewhereInThisVersion|manual=Designer|topic=ApplicationPhases|anchor=selfservice|display text=Self Service}} phase.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}callEndParty
 +
{{!}}Indicates the party that ended the call, i.e. Application, Caller, or System.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}callEndReason
 +
{{!}}Indicates the reason that the call ended. For example, it might have been routed to an agent, abandoned, triggered a {{Link-SomewhereInThisVersion|manual=Designer|topic=BusinessObjectsBar|display text=Business Controls}} condition, such as an emergency flag, business hours, or special day exception, or the caller selected a menu option that ended the call.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}callEndType
 +
{{!}}Indicates the conditions under which the call was ended, i.e. Normal or Error.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}dtmfpath
 +
{{!}}The menu path (via the pressing of DTMF keys) that the customer took through the application.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}menucount
 +
{{!}}The number of {{Link-SomewhereInThisVersion|manual=Designer|topic=Menu|display text=Menu}} blocks the customer encountered during the session.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}inputcount
 +
{{!}}Total number of {{Link-SomewhereInThisVersion|manual=Designer|topic=UserInput|display text=User Input}} blocks the customer encountered during the session.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}blockpath
 +
{{!}}An ordered list of the names of all blocks that were encountered throughout the course of the interaction.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}blockidpath
 +
{{!}}An ordered list of IDs for all blocks that were encountered throughout the interaction. For more information about block IDs, see {{Link-SomewhereInThisVersion|manual=Designer|topic=Blocks|display text=Using the blocks}}.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}blocks*
 +
{{!}}List of detailed information about the individual blocks that were encountered, such as:
  
{{{!}}
+
*name of the block
! width="" &quot;25%&quot;{{!}}'''Field'''
+
*unique ID of the block
!'''Description'''
+
*type of block
{{!}}-
+
*duration of time that was spent inside the block
{{!}}<tt>extreqcount</tt>
+
*timestamps of when the application entered and exited the block
{{!}}Total number of {{Link-SomewhereInThisManual|topic=ExtServBlocks|anchor=top|display text=external requests}}.
+
{{!}}Session Information
{{!}}-
+
{{!}}Designer
{{!}}<tt>extreqerrorcount</tt>
+
{{!}}-
{{!}}Total number of failed {{Link-SomewhereInThisManual|topic=ExtServBlocks|anchor=top|display text=external requests}}.
+
{{!}}inputs*
{{!}}-
+
{{!}}List of detailed information about the various {{Link-SomewhereInThisVersion|manual=Designer|topic=UserInput|display text=User Input}} blocks that were encountered, such as:
{{!}}}
 
|structuredtextwide=
 
|FAQHeading=
 
|Status=No
 
}}{{Section
 
|sectionHeading=User Milestone
 
|anchor=UserMilestone
 
|alignment=Vertical
 
|Media=
 
|image=
 
|structuredtext=These fields contain values sourced from user-defined milestones (such as those defined in a {{Link-SomewhereInThisManual|topic=Milestone|anchor=top|display text=Milestone}} block or {{Link-SomewhereInThisManual|topic=Menu|anchor=top|display text=Menu}} block) and {{Link-SomewhereInThisManual|topic=SurveyBlocks|anchor=top|display text=Survey}} blocks.
 
  
{{{!}}  
+
*name of the block
! width="" &quot;25%&quot;{{!}}'''Field'''
+
*unique ID of the block
!'''Description'''
+
*timestamps of when the application entered and exited the block
{{!}}-  
+
{{!}}Session Information
{{!}}<tt>FinalUserMilestone</tt>
+
{{!}}Designer
{{!}}The last milestone in the {{Link-SomewhereInThisManual|topic=SdrRef|anchor=milestones|display text=milestones}} array at the end of the application session.
+
{{!}}-
{{!}}-
+
{{!}}externalrequests*
{{!}}<tt>LastMilestone</tt>
+
{{!}}List containing detailed information about {{Link-SomewhereInThisVersion|manual=Designer|topic=ExtServBlocks}} that were encountered.
{{!}}Tracks the most recent milestone encountered.
+
{{!}}Session Information
{{!}}-
+
{{!}}Designer
{{!}}<tt>milestones</tt>
+
{{!}}-
 +
{{!}}{{AnchorDiv|milestones}}milestones
 
{{!}}List containing the system milestones that were encountered. Milestones indicate special points or transitions in the application, such as phases starting, phases ending, or an application terminating.
 
{{!}}List containing the system milestones that were encountered. Milestones indicate special points or transitions in the application, such as phases starting, phases ending, or an application terminating.
'''Note:''' These values can be auto-populated by Designer or provided by the application developer.
+
{{!}}Session Information
{{!}}-  
+
{{!}}Designer and Developer
{{!}}<tt>userMilestones</tt>
+
{{!}}-
{{!}}Milestones that were defined in {{Link-SomewhereInThisManual|topic=Milestone|anchor=top|display text=Milestone blocks}} or set in other blocks, such as {{Link-SomewhereInThisManual|topic=Menu|anchor=top|display text=Menu}}.
+
{{!}}usermilestonecount
'''Note:''' These values can be auto-populated by Designer or provided by the application developer.
+
{{!}}Number of user-defined milestones that were hit. These are milestones that were defined in {{Link-SomewhereInThisVersion|manual=Designer|topic=Milestone|display text=Milestone}} blocks or set in other blocks, such as {{Link-SomewhereInThisVersion|manual=Designer|topic=Menu|display text=Menu}}.
{{!}}-  
+
{{!}}Session Information
{{!}}<tt>usermilestonecount</tt>
+
{{!}}Designer
{{!}}Number of user-defined milestones hit in the session.
+
{{!}}-
{{!}}-  
+
{{!}}userMilestones*
{{!}}<tt>userMilestonesPath</tt>
+
{{!}}Milestones that were defined in {{Link-SomewhereInThisVersion|manual=Designer|topic=Milestone|display text=Milestone}} blocks or set in other blocks, such as {{Link-SomewhereInThisVersion|manual=Designer|topic=Menu|display text=Menu}}.
{{!}}Names of all milestones hit during the call.
+
{{!}}Session Information
{{!}}-  
+
{{!}}Designer and Developer
{{!}}}
+
{{!}}-
|structuredtextwide=
+
{{!}}userMilestonesPath
|FAQHeading=
+
{{!}}Names of all milestones that were encountered by the application during the session.
|Status=No
+
{{!}}Session Information
}}{{Section
+
{{!}}Designer
|sectionHeading=Activity
+
{{!}}-
|anchor=Activity
+
{{!}}FinalUserMilestone
|alignment=Vertical
+
{{!}}The last user-defined milestone that was encountered during the application session (if the value of '''usermilestonecount''' is greater than 0).
|Media=
+
{{!}}Session Information
|image=
+
{{!}}Designer
|structuredtext=These fields contain values sourced from {{Link-SomewhereInThisManual|topic=Activity|anchor=top|display text=Activity}} blocks.
+
{{!}}-
 
+
{{!}}LastMilestone
{{{!}}  
+
{{!}}The most recent milestone that was encountered during the session.
! width="" &quot;25%&quot;{{!}}'''Field'''
+
{{!}}Session Information
!'''Description'''
+
{{!}}Designer
{{!}}-  
+
{{!}}-
{{!}}<tt>activities</tt>
+
{{!}}activities*
{{!}}List of activities encountered in the interaction. Activities are defined in an {{Link-SomewhereInThisManual|topic=Activity|anchor=top|display text=Activity block}} or automatically captured when an interaction enters or exits a {{Link-SomewhereInThisManual|topic=SharedModulesBar|anchor=top|display text=shared module}}.
+
{{!}}List of activities that were encountered during the session. Activities are defined in an {{Link-SomewhereInThisVersion|manual=Designer|topic=Activity|display text=Activity}} or automatically captured when an interaction enters or exits a {{Link-SomewhereInThisVersion|manual=Designer|topic=SharedModulesBar|display text=Shared Module}}.
{{!}}-  
+
{{!}}Session Information
{{!}}<tt>activitycount</tt>
+
{{!}}Developer
{{!}}Number of activities that were referenced in the interaction.
+
{{!}}-
{{!}}-
+
{{!}}activitycount
 +
{{!}}Total number of activities that were encountered during the session. Activities are defined in an {{Link-SomewhereInThisVersion|manual=Designer|topic=Activity|display text=Activity}} block or automatically captured when an interaction enters or exits a {{Link-SomewhereInThisVersion|manual=Designer|topic=SharedModulesBar|display text=Shared Module}}.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}utcstart
 +
{{!}}Starting time of the interaction in Universal Coordinated Time (UTC). Example: <tt>1454643744261</tt>
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}SessionType
 +
{{!}}The type of session. Example: '''inbound'''
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}CountryName
 +
{{!}}Name of the country.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}Region
 +
{{!}}Name of the region.
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}childIxns*
 +
{{!}}This field only applies to {{Link-SomewhereInThisVersion|manual=Designer|topic=ApplicationsBar|anchor=apptypes|display text=Digital }} type applications and contains a list of details about new child interactions that were created by the session. The details include information about the block that initiated the child interactions (i.e. blockid, blockname, and blocktype). It can also indicate if the child interaction was created by a busy treatment (isTreatment: Y).
 +
{{!}}Session Information
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}attributeslist
 +
{{!}}Object with each Key/Value pair (KVP) appearing as a property that is set to the KVP value.
 +
{{!}}Generic Attributes
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}businesshourserrcount
 +
{{!}}Number of times a {{Link-SomewhereInThisVersion|manual=Designer|topic=BusinessHrs|display text=Business Hours}} was accessed during the interaction.
 +
{{!}}Business Controls
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}businesshoursextcount
 +
{{!}}Total number of external {{Link-SomewhereInThisVersion|manual=Designer|topic=DesBusinessHours}} checks that occurred within a session, if you are controlling Business Hours from a web service (for example, via an {{Link-SomewhereInThisVersion|manual=Designer|topic=HTTPREST|display text=HTTP Rest}} block.)
 +
{{!}}Business Controls
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}businesshoursreqcount
 +
{{!}}Total number of requests for {{Link-SomewhereInThisVersion|manual=Designer|topic=DesBusinessHours}} checks that occurred within a session.
 +
{{!}}Business Controls
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}emergencieserrcount
 +
{{!}}Total number of {{Link-SomewhereInThisVersion|manual=Designer|topic=EmergencyFlags}} checks within a session.
 +
{{!}}Business Controls
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}emergenciesextcount
 +
{{!}}Total number of external {{Link-SomewhereInThisVersion|manual=Designer|topic=EmergencyFlags}} checks within a session, if you are controlling emergency modes from a web service (for example, via an {{Link-SomewhereInThisVersion|manual=Designer|topic=HTTPREST|display text=HTTP Rest}} block.)
 +
{{!}}Business Controls
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}specialdayserrcount
 +
{{!}}Total number of {{Link-SomewhereInThisVersion|manual=Designer|topic=SpecialDays|display text=Special Days}} checked within a session. All checks in a single {{Link-SomewhereInThisVersion|manual=Designer|topic=SpecialDay|display text=Special Day block}} count as one check.
 +
{{!}}Business Controls
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}specialdaysextcount
 +
{{!}}Total number of {{Link-SomewhereInThisVersion|manual=Designer|topic=SpecialDays|display text=Special Days}} checked externally within a session, if you are controlling these from a web service (for example, via an {{Link-SomewhereInThisVersion|manual=Designer|topic=HTTPREST|display text=HTTP Rest}} block). All checks in a single {{Link-SomewhereInThisVersion|manual=Designer|topic=SpecialDay|display text=Special Day block}} count as one check.
 +
{{!}}Business Controls
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}specialdaysreqcount
 +
{{!}}Total number of exceptions that were encountered when the application was performing Special Day checks. All errors encountered in a single {{Link-SomewhereInThisVersion|manual=Designer|topic=SpecialDay|display text=Special Day block}} count as one check.
 +
{{!}}Business Controls
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}routingBlockCount
 +
{{!}}Number of {{Link-SomewhereInThisVersion|manual=Designer|topic=RoutingBlocks|display text=Routing}} blocks that were encountered within a session.
 +
{{!}}Routing
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}routingBlockTimeoutCount
 +
{{!}}Number of times that routing blocks timed out.
 +
{{NoteFormat|A high number here can indicate that customers are waiting too long in the queue for some reason. For example, skill levels might be set too high or there are not enough agents available.|2}}
 +
{{!}}Routing
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}routingCallHandlingType
 +
{{!}}Indicates the type of routing used for the call. For example: '''default''' or '''consult'''
 +
{{!}}Routing
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}routingLCAAttempted
 +
{{!}}Indicates if '''Last Called Agent''' routing was attempted. This option can be enabled on the {{Link-SomewhereInThisVersion|manual=Designer|topic=RouteAgent|anchor=AgentRoutingtab|display text=Agent Routing tab}} of the {{Link-SomewhereInThisVersion|manual=Designer|topic=RouteAgent|display text=Route Agent}} block.
 +
{{!}}Routing
 +
{{!}}Designer
 +
{{!}}-
 +
{{!}}routingSkillRelaxationCount
 +
{{!}}Number of {{Link-SomewhereInThisVersion|manual=Designer|topic=RoutingBlocks|display text=Routing}} blocks that used skill relaxation as a routing option. The required skill level is gradually reduced until a specified minimum skill level is reached, which allows you to expand the group of agents that can receive this call if other agents are busy.
 +
{{!}}Routing
 +
{{!}}Designer
 
{{!}}}
 
{{!}}}
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Revision as of 17:31, March 30, 2021

This topic is part of the manual Designer User's Guide for version Current of Designer.

This page lists some of the most commonly used Session Detail Record (SDR) fields. It is not intended as a comprehensive list of all SDR fields used by Designer.

Related documentation:

This page lists some of the most commonly used Session Detail Record (SDR) fields. It is not intended as a comprehensive list of all SDR fields used by Designer.

Each entry notes whether the value is set by Designer (i.e. system-generated) or provided by the application Developer.

The Category associates each field with the source of its value. For example, it indicates if the value was pulled from Session Information (captured during application runtime) or from certain types of blocks that were encountered, such as Routing or Business Controls.

You can use the column headers to sort the items.
Tip
To quickly check if a field is listed on this page, you can use the search function in your browser. For example, in Chrome, press CTRL + F to open the search tool.

List of Session Detail Record fields

Field Description Category Set by
ANI The Automatic Number Identification is the customer's phone number (or Caller ID). Call Information Designer
DNIS The Dialed Number Identification Service is the phone number that the customer dialed. Call Information Designer
applicationName The name of the application, as provided by the application Developer when creating a new application. Application Settings Developer
applicationID The unique internal ID that Designer assigned to the application.
Tip
You can quickly view an application ID by mousing over the application link on the Applications page and checking the target URL that appears in the browser window. Des sdr ref applicationID.png.
Application Settings Designer
ApplicationType The application type, as selected by the application developer when the application was created (see creating a new application). The values are as follows:
  • application = Default
  • eservices = Digital
  • callback = Callback
Application Settings Developer
applicationVersion Optional custom version of the application to use for reporting purposes, as specified by the application developer on the General tab in the application settings. Application Settings Developer
ApplicationReportingTitle Optional custom title of the application for reporting purposes, as specified by the application developer on the General tab in the application settings. Application Settings Developer
SessionID The unique internal ID that Designer assigned to the session. Session Information Designer
InteractionID The unique internal ID that Designer assigned to the interaction. Session Information Designer
InteractionCategory The channel type that was used for the interaction. For example: voice, chat, or email. Session Information Designer
ConnectionID The connection ID that Designer assigned to the interaction. For example: 016202fe11099003 Session Information Designer
finalDisposition Disposition code indicating the status of the interaction at the time it exited the application flow. For example, this value can indicate if the interaction was routed to an agent or the customer disconnected from the call. Disposition codes can be enabled in the Finalize phase. For more information, see disposition codes. Session Information Designer
LanguageName The language that was set for the application at the time when the interaction ended.
Tip
Note that Change Language Block blocks can be used to change the language at select points in an application flow. This value always reflects the last language that was set for the application when the interaction ended.
Session Information Developer
@endtime Timestamp to indicate when the interaction ended. Example: 2017-03-08T01:56:26.085Z Session Information Designer
@timestamp Timestamp to indicate when the interaction started. Example: 2017-03-08T01:56:12.037Z Session Information Designer
duration Duration of the total session, in milliseconds (ms).
Tip
To calculate the duration of blocks execution and exclude session wrap-up time, subtract the value of the operationalOverheadDurationz field from this value.
Session Information Designer

operationalOverheadDuration

Total amount of time, in milliseconds (ms), that the application was in an idle state. Typically, this state occurs just before the session enters the Finalize phase. Session Information Designer
ssduration Amount of time (in milliseconds) that the customer spent in the Self Service phase of the application. Session Information Designer
ssstart Timestamp to indicate when the Self Service phase of the application started. Session Information Designer
ssend Timestamp to indicate when the Self Service phase of the interaction ended. Session Information Designer
asduration Length of time (in milliseconds) that the customer spent in the Assisted Service phase. Session Information Designer
asstart Timestamp to indicate when the interaction entered the Assisted Service phase. Example: 2017-03-08T01:56:20.933Z Session Information Designer
asend Timestamp to indicate when the Assisted Service of the interaction ended. Session Information Designer
variables List of all user and system variables that contain values. Session Information Designer
survey List of survey-related variables. For more information, see the survey_* variables listed in system variables and the Setup Survey Block page. Session Information Designer
calldata List of all call data Key-Value Pairs (KVPs) encountered by the application. For more information, see the Call Data block page. Session Information Designer
callAbandonedBlock If the customer leaves the session (for example, hangs up), this field contains the ID of the block that was being processed when they left. Session Information Designer
callEndState Indicates if the call ended in the Assisted Service or Self Service phase. Session Information Designer
callEndParty Indicates the party that ended the call, i.e. Application, Caller, or System. Session Information Designer
callEndReason Indicates the reason that the call ended. For example, it might have been routed to an agent, abandoned, triggered a Business Controls condition, such as an emergency flag, business hours, or special day exception, or the caller selected a menu option that ended the call. Session Information Designer
callEndType Indicates the conditions under which the call was ended, i.e. Normal or Error. Session Information Designer
dtmfpath The menu path (via the pressing of DTMF keys) that the customer took through the application. Session Information Designer
menucount The number of Menu blocks the customer encountered during the session. Session Information Designer
inputcount Total number of User Input blocks the customer encountered during the session. Session Information Designer
blockpath An ordered list of the names of all blocks that were encountered throughout the course of the interaction. Session Information Designer
blockidpath An ordered list of IDs for all blocks that were encountered throughout the interaction. For more information about block IDs, see Using the blocks. Session Information Designer
blocks* List of detailed information about the individual blocks that were encountered, such as:
  • name of the block
  • unique ID of the block
  • type of block
  • duration of time that was spent inside the block
  • timestamps of when the application entered and exited the block
Session Information Designer
inputs* List of detailed information about the various User Input blocks that were encountered, such as:
  • name of the block
  • unique ID of the block
  • timestamps of when the application entered and exited the block
Session Information Designer
externalrequests* List containing detailed information about External Services Blocks that were encountered. Session Information Designer

milestones

List containing the system milestones that were encountered. Milestones indicate special points or transitions in the application, such as phases starting, phases ending, or an application terminating. Session Information Designer and Developer
usermilestonecount Number of user-defined milestones that were hit. These are milestones that were defined in Milestone blocks or set in other blocks, such as Menu. Session Information Designer
userMilestones* Milestones that were defined in Milestone blocks or set in other blocks, such as Menu. Session Information Designer and Developer
userMilestonesPath Names of all milestones that were encountered by the application during the session. Session Information Designer
FinalUserMilestone The last user-defined milestone that was encountered during the application session (if the value of usermilestonecount is greater than 0). Session Information Designer
LastMilestone The most recent milestone that was encountered during the session. Session Information Designer
activities* List of activities that were encountered during the session. Activities are defined in an Activity or automatically captured when an interaction enters or exits a Shared Module. Session Information Developer
activitycount Total number of activities that were encountered during the session. Activities are defined in an Activity block or automatically captured when an interaction enters or exits a Shared Module. Session Information Designer
utcstart Starting time of the interaction in Universal Coordinated Time (UTC). Example: 1454643744261 Session Information Designer
SessionType The type of session. Example: inbound Session Information Designer
CountryName Name of the country. Session Information Designer
Region Name of the region. Session Information Designer
childIxns* This field only applies to Digital type applications and contains a list of details about new child interactions that were created by the session. The details include information about the block that initiated the child interactions (i.e. blockid, blockname, and blocktype). It can also indicate if the child interaction was created by a busy treatment (isTreatment: Y). Session Information Designer
attributeslist Object with each Key/Value pair (KVP) appearing as a property that is set to the KVP value. Generic Attributes Designer
businesshourserrcount Number of times a Business Hours was accessed during the interaction. Business Controls Designer
businesshoursextcount Total number of external Business Hours checks that occurred within a session, if you are controlling Business Hours from a web service (for example, via an HTTP Rest block.) Business Controls Designer
businesshoursreqcount Total number of requests for Business Hours checks that occurred within a session. Business Controls Designer
emergencieserrcount Total number of Emergency Flags checks within a session. Business Controls Designer
emergenciesextcount Total number of external Emergency Flags checks within a session, if you are controlling emergency modes from a web service (for example, via an HTTP Rest block.) Business Controls Designer
specialdayserrcount Total number of Special Days checked within a session. All checks in a single Special Day block count as one check. Business Controls Designer
specialdaysextcount Total number of Special Days checked externally within a session, if you are controlling these from a web service (for example, via an HTTP Rest block). All checks in a single Special Day block count as one check. Business Controls Designer
specialdaysreqcount Total number of exceptions that were encountered when the application was performing Special Day checks. All errors encountered in a single Special Day block count as one check. Business Controls Designer
routingBlockCount Number of Routing blocks that were encountered within a session. Routing Designer
routingBlockTimeoutCount Number of times that routing blocks timed out.
Tip
A high number here can indicate that customers are waiting too long in the queue for some reason. For example, skill levels might be set too high or there are not enough agents available.
Routing Designer
routingCallHandlingType Indicates the type of routing used for the call. For example: default or consult Routing Designer
routingLCAAttempted Indicates if Last Called Agent routing was attempted. This option can be enabled on the Agent Routing tab of the Route Agent block. Routing Designer
routingSkillRelaxationCount Number of Routing blocks that used skill relaxation as a routing option. The required skill level is gradually reduced until a specified minimum skill level is reached, which allows you to expand the group of agents that can receive this call if other agents are busy. Routing Designer
Retrieved from "https://all.docs.genesys.com/DES/Current/Designer/SdrRef (2024-11-09 08:45:58)"
Comments or questions about this documentation? Contact us for support!