DES/Current/Designer/Variables - Revision history

WikiSysop at 19:32, February 26, 2023

2023-02-26T19:32:59Z

WikiSysop at 15:15, September 21, 2022

2022-09-21T15:15:39Z

Show changes

WikiSysop at 18:45, August 25, 2022

2022-08-25T18:45:52Z

WikiSysop at 13:45, August 16, 2022

2022-08-16T13:45:53Z

WikiSysop at 18:30, May 2, 2022

2022-05-02T18:30:24Z

WikiSysop at 19:46, March 30, 2022

2022-03-30T19:46:08Z

Brian.marshall@genesys.com: Published

2021-10-14T17:17:19Z

Published

Brian.marshall@genesys.com: Published

2021-09-14T14:33:27Z

Published

Brian.marshall@genesys.com: Published

2021-09-10T20:30:15Z

Published

Brian.marshall@genesys.com: Published

2021-06-02T23:34:25Z

Published

@@ Line 326: / Line 326: @@
 {{!}}removeSSMLInChat
 {{!}}Set as <code>true</code> to remove SSML tags from chat messages if an omnichannel application is using the same messages for both voice and chat channels. For more information, see {{Link-SomewhereInThisVersion|manual=Designer|topic=MediaResources|anchor=ssml|display text=Speech Synthesis Markup Language}}.
 {{!}}}
 {{AnchorDiv|MaxTime}}

@@ Line 305: / Line 305: @@
 *If set to <code>true</code>, the interaction is automatically terminated just before the application session wraps up.
 *When set to <code>auto</code> (default), the application decides whether to stop the interaction or not based on the interaction media type.
 {{!}}-
 {{!}}ChatOfferVQ
@@ Line 315: / Line 313: @@
 {{!}}-
 {{!}}ExpirationTime
-{{!}}Maximum time (in minutes) from when the interaction was first processed to keep the interaction alive. For more information, see [link].
+{{!}}Maximum time (in minutes) from when the interaction was first processed to keep the interaction alive.
 {{!}}-
 {{!}}isResumedFromParking

@@ Line 293: / Line 293: @@
 {{!}}-
 {{!}}Contact
-{{!}}Details about the customer contact, e.g. email address, last name, etc.
+{{!}}Details about the customer contact (name, phone number, email address), stored as a JSON object.  For example:
 {{!}}-
 {{!}}DefaultPartition

@@ Line 89: / Line 89: @@
 ===List of System Variables===
-{{{!}} class="wikitable"
+{{{!}} class="wikitable sortable"
 !'''Variable Name'''
 !'''Description'''
@@ Line 187: / Line 187: @@
 {{!}}-
 {{!}}PositionInQueue
-{{!}}The interaction's position in queue while waiting to be routed to an agent.
+{{!}}The interaction's position in queue while waiting to be routed to an agent. This variable is initialized when the application enters a Route Call block. The value is then updated periodically (every <i>x</i> seconds) for as long as the interaction is queued for a target inside the block. The updates stop when the application exits the routing block.
 {{!}}-
 {{!}}AgentsTotalSize
@@ Line 299: / Line 299: @@
 {{!}}-
 {{!}}AutoStopInteraction
-{{!}}(Digital only) Specifies whether or not the interaction is to be automatically terminated when the session ends. The default value is <tt>auto</tt> (to automatically terminate a ''chat'' interaction if it exceeds 20 application runs or exceeds the specified expiration time); other valid settings are <tt>true</tt> or <tt>false</tt>.
+{{!}}(Digital only) Specifies whether or not the interaction is to be automatically terminated when the session ends.
 {{!}}-
 {{!}}ChatOfferVQ
@@ Line 308: / Line 313: @@
 {{!}}-
 {{!}}ExpirationTime
-{{!}}Maximum time (in minutes) from when the interaction was first processed to keep the interaction alive.
+{{!}}Maximum time (in minutes) from when the interaction was first processed to keep the interaction alive. For more information, see [link].
 {{!}}-
 {{!}}isResumedFromParking

@@ Line 82: / Line 82: @@
 |structuredtext=The '''Initialize''' phase has a second tab that lists system variables &mdash; these variables are created with the application and cannot be deleted.
-Most system variables are initialized when the application starts and can be used throughout the application, such as the '''Last Milestone''' variable. When your application starts, the initial value of '''Last Milestone''' is an empty string. While your application runs, the '''Last Milestone''' value is set to the last milestone that your application reaches.
+Most system variables are initialized with appropriate values when the application session starts and can be used throughout the application, such as the '''ANI''' and '''DNIS'''. Other system variables, such as '''Last Milestone''', are populated as the application session progresses. For example, when the application starts, the initial value of '''Last Milestone''' is an empty string. While the application runs, the '''Last Milestone''' value is set to the last milestone that the application reached.
 {{NoteFormat|Do not update system variables in the Assisted Service phase while an asynchronous {{Link-SomewhereInThisVersion|manual=Designer|topic=StartTreatment|display text=Start Treatment}} is running. Instead, update system variables ''before'' the Start Treatment starts or within the Self Service treatment itself.|}}
-The following system variables are available:
+===List of System Variables===
 {{{!}} class="wikitable"
 !'''Variable Name'''
@@ Line 320: / Line 321: @@
 {{!}}removeSSMLInChat
 {{!}}Set as <tt>true</tt> to remove SSML tags from chat messages if an omnichannel application is using the same messages for both voice and chat channels. For more information, see {{Link-SomewhereInThisVersion|manual=Designer|topic=MediaResources|anchor=ssml|display text=Speech Synthesis Markup Language}}.
 {{!}}}
 ===VAR Metrics===
 {{NoteFormat|VAR action IDs are stripped of spaces and pipe characters (<tt>&#124;</tt>). This includes implicit actions that are generated when a caller enters a {{Link-SomewhereInThisVersion|manual=Designer|topic=SharedModulesBar|display text=shared module}}.}}

@@ Line 65: / Line 65: @@
 * '''DO NOT''' attach sensitive data, such as personally identifiable information (PII) or secure variables, to userdata in the {{Link-SomewhereInThisManual|topic=CallData|anchor=top|display text=Call Data}} block. Otherwise, this information is captured by platform logs and reported in Designer Analytics.
 * Designer normally hides secure variables to prevent them from being selected in blocks that capture reporting information. However, if you secure a variable that was previously selected in a block as a non-secure variable, Designer cannot remove the variable from the block or prevent its value from being exposed. To protect those values, you must create a new secure variable and re-publish your application.|3}}
 |Status=No
 }}{{Section

@@ Line 78: / Line 78: @@
 The following system variables are available:
-{{{!}}
+{{{!}} class="wikitable"
 !'''Variable Name'''
 !'''Description'''
 {{!}}-
 {{!}}DNIS
 {{!}}Specifies the dialed number.
@@ Line 110: / Line 113: @@
 {{!}}-
 {{!}}EstimatedWaitTime
-{{!}}The estimated wait time for the call to be routed to an agent.
+{{!}}The estimated wait time for the interaction to be routed to an agent.
 {{!}}-
 {{!}}IVRProfileName
-{{!}}This application's calls will be associated with the given IVRProfile for VAR reporting.
+{{!}}This application's interactions will be associated with the given IVRProfile for VAR reporting.
 {{!}}-
 {{!}}GVPTenantID
-{{!}}This application's calls will be associated with the given tenant for VAR reporting.
+{{!}}This application's interactions will be associated with the given tenant for VAR reporting.
 {{!}}-
 {{!}}SelectedTarget
@@ Line 164: / Line 170: @@
 {{!}}-
 {{!}}EnableSSRecording
-{{!}}Enable call recording in the '''Self Service''' phase.
+{{!}}Enable interaction recording in the '''Self Service''' phase.
 {{!}}-
 {{!}}CallbackReporting
@@ Line 170: / Line 176: @@
 {{!}}-
 {{!}}PositionInQueue
-{{!}}The call's position in queue while waiting to be routed to an agent.
+{{!}}The interaction's position in queue while waiting to be routed to an agent.
 {{!}}-
 {{!}}AppCountry
-{{!}}The country code for this call (can be specified by the application).
+{{!}}The country code for this interaction (can be specified by the application).
 {{!}}-
 {{!}}AppRegion
-{{!}}The region for this call (can be specified by the application).
+{{!}}The region for this interaction (can be specified by the application).
 {{!}}-
 {{!}}AppCallType
-{{!}}The type of call (can be specified by the application).
+{{!}}The type of interaction (can be specified by the application).
 {{!}}-
 {{!}}AppUserDisposition
@@ Line 251: / Line 266: @@
 {{!}}The absolute path to the application.
 {{!}}-
 {{!}}DefaultPartition
 {{!}}The default partition used to provide access control in GIR. This variable can be overridden by settings in the '''Record''' block.
@@ Line 257: / Line 290: @@
 {{!}}(Digital only) Specifies whether or not the interaction is to be automatically terminated when the session ends. The default value is <tt>auto</tt> (to automatically terminate a ''chat'' interaction if it exceeds 20 application runs or exceeds the specified expiration time); other valid settings are <tt>true</tt> or <tt>false</tt>.
 {{!}}-
-{{!}}ChatEntryPoint
+{{!}}ChatOfferVQ
-{{!}}(Digital only) Holds the point of entry for a chat interaction. Can be used in application logic at runtime to provide alternative processing or to facilitate the use of parallel testing environments.
+{{!}}The virtual queue that was queried for an Estimated Wait Time (EWT) to determine if chat is to be offered.
 {{!}}-
-{{!}}TreatmentIterationCount
+{{!}}FlowEntryCount
-{{!}}Keeps track of how many times a treatment has been executed.
+{{!}}Total number of times (including this run) that the Designer application ran to process this interaction.
 {{!}}-
-{{!}}AgentsTotalSize
+{{!}}ExpirationTime
-{{!}}The total number of agents that are possibly available. For example, the total number of agents in a specified Agent Group.
+{{!}}Maximum time (in minutes) from when the interaction was first processed to keep the interaction alive.
 {{!}}-
 {{!}}isResumedFromParking
@@ Line 273: / Line 303: @@
 {{!}}-
 {{!}}LanguageForBots
-{{!}}The default language to be used for bots. (Typically, this matches the language set in the '''Language''' system variable.)
+{{!}}The default language to be used for bots.
 {{!}}-
 {{!}}enableSSML

@@ Line 100: / Line 100: @@
 {{!}}The name of the default language for this application that is used for announcements.
 {{!}}-
 {{!}}RoutingSkills
 {{!}}A set of skills that might be specified in some blocks, such as '''Menu Option''' child blocks, that determine how the call is routed. For example, if you select a Skill in the '''Call Handling''' tab of a '''Menu Option''' block, this selection is stored in the '''RoutingSkills''' variable. Then, in a subsequent '''Route Call''' block, you can enable the '''Use system variables RoutingSkills and RoutingVirtualQueue set already in Menu Options''' check box to use the value of the '''RoutingSkills''' variable.
@@ Line 265: / Line 268: @@
 {{!}}AgentsLoginSize
 {{!}}The number of agents that are actually logged in.
 {{!}}-
 {{!}}enableSSML