Jump to: navigation, search
(Update with the copy of version: 8.5.2DRAFT)
(Update with the copy of version: 8.5.2DRAFT)
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
= New and updated configuration options and API operations=
 
  
 +
=New and updated configuration options and API operations=
 
After migrating your Web Services and Applications deployment, review the list of added or updated configuration and API options to decide if you want to maintain the default state of the options or modify them to match your deployment requirements.
 
After migrating your Web Services and Applications deployment, review the list of added or updated configuration and API options to decide if you want to maintain the default state of the options or modify them to match your deployment requirements.
  
Line 16: Line 16:
  
 
==Workspace Web Edition configuration option updates==
 
==Workspace Web Edition configuration option updates==
 +
 +
The following configuration options have been added or updated in Web Services and Applications version 8.5.202.XX:
 +
{{Chgbar_open}}
 +
* [[Options:Web_Services_and_Applications:interaction-workspace:privilege-teamlead-can-monitor-routing-point|privilege.teamlead.can-monitor-routing-point]]
 +
* [[Options:Web_Services_and_Applications:interaction-workspace:teamlead-monitorable-routing-points|teamlead.monitorable-routing-points]]
 +
* [[Options:Web_Services_and_Applications:interaction-workspace:voice-caller-id-key-name|voice.caller-id.key-name]]
 +
{{Chgbar_close}}
 +
The following configuration options have been added or updated in Web Services and Applications version 8.5.202.23:
 +
* [[Options:Web_Services_and_Applications:interaction-workspace:permissions-agent-group-exclude|permissions-agent-group-exclude]]
 +
* [[Options:Web_Services_and_Applications:interaction-workspace:permissions-agent-group-restrict|permissions-agent-group-restrict]]
 +
* [[Options:Web_Services_and_Applications:interaction-workspace:privilege-SRL-can-quick-search|privilege-SRL-can-quick-search]]
 +
* [[Options:Web_Services_and_Applications:interaction-workspace:service-client-api-block-markdone-timeout|service-client-api-block-markdone-timeout]]
 +
* [[Options:Web_Services_and_Applications:interaction-workspace:statistics-gadget-statistics|statistics-gadget-statistics]]
 +
* [[Options:Web_Services_and_Applications:interaction-workspace:statistics-gadget-statistics-max-size|statistics-gadget-statistics-max-size]]
 +
 +
The following configuration options have been added or updated in Web Services and Applications version 8.5.202.04:
 +
* [[Documentation:HTCC:IWWDep:Voice#privilege.voice.can-answer-call|privilege.voice.can-answer-call]]
 +
* [[Documentation:HTCC:IWWDep:Voice#voice.use-caller-id-display-name|voice.use-caller-id-display-name]]
 +
* [[Documentation:HTCC:IWWDep:AgentStatus#privilege.mychannels.pending-state.can-use|privilege.mychannels.pending-state.can-use]]
 +
* [[Documentation:HTCC:IWWDep:Email#email.inline-forward-header|email.inline-forward-header]]
 +
* [[Documentation:HTCC:IWWDep:Email#email.inline-forward-prefix|email.inline-forward-prefix]]
 +
* [[Documentation:HTCC:IWWDep:Email#email.inline-forward-queue|email.inline-forward-queue]]
 +
* [[Documentation:HTCC:IWWDep:Email#email.quote-header|email.quote-header]]
 +
* [[Documentation:HTCC:IWWDep:Email#privilege.email.can-inline-forward|privilege.email.can-inline-forward]]
 +
* [[Documentation:HTCC:IWWDep:Contact#privilege.contact.can-inline-forward.email.from-history|privilege.contact.can-inline-forward.email.from-history]]
 +
* [[Documentation:HTCC:IWWDep:TeamCommunicator#teamcommunicator.permissions.agent-group.exclude|teamcommunicator.permissions.agent-group.exclude]]
 +
* [[Documentation:HTCC:IWWDep:TeamCommunicator#teamcommunicator.permissions.agent.exclude-from-agent-groups|teamcommunicator.permissions.agent.exclude-from-agent-groups]]
 +
* [[Documentation:HTCC:IWWDep:TeamCommunicator#teamcommunicator.permissions.agent.restrict-to-agent-groups|teamcommunicator.permissions.agent.restrict-to-agent-groups]]
 +
* [[Documentation:HTCC:IWWDep:LoginVoice#login.voice.nb-dn-less-phone-number-stored|login.voice.nb-dn-less-phone-number-stored]]
 +
* [[Documentation:HTCC:IWWDep:LoginVoice#login.voice.prompt-dn-less-phone-number.enable-dynamic-dn|login.voice.prompt-dn-less-phone-number.enable-dynamic-dn]]
 +
 
The following configuration options have been added or updated in Web Services and Applications version 8.5.201.92:
 
The following configuration options have been added or updated in Web Services and Applications version 8.5.201.92:
 
* [[Documentation:HTCC:IWWDep:Outbound#privilege.outbound.push-preview.can-use|privilege.outbound.push-preview.can-use]]
 
* [[Documentation:HTCC:IWWDep:Outbound#privilege.outbound.push-preview.can-use|privilege.outbound.push-preview.can-use]]
Line 50: Line 81:
 
* [[Documentation:HTCC:IWWDep:SIPEndpoint#sipendpoint.max-failed-ping|sipendpoint.max-failed-ping]]
 
* [[Documentation:HTCC:IWWDep:SIPEndpoint#sipendpoint.max-failed-ping|sipendpoint.max-failed-ping]]
 
* [[Documentation:HTCC:IWWDep:SIPEndpoint#sipendpoint.transport-protocol|sipendpoint.transport-protocol]]
 
* [[Documentation:HTCC:IWWDep:SIPEndpoint#sipendpoint.transport-protocol|sipendpoint.transport-protocol]]
* [[Documentation:HTCC:IWWDep:StandardResponse:{{PONYDOCSVERSION}}#SRcustomFieldCode|standard-response.field.<[Agent.]CustomFieldCode>]]
+
* [[Documentation:HTCC:IWWDep:StandardResponse:{{PONYDOCSVERSION}}#SRcustomFieldCode|">standard-response.field.<[Agent.]CustomFieldCode>]]
 
* [[Documentation:HTCC:IWWDep:Voice#voice.hold-active-call-on-make-call|voice.hold-active-call-on-make-call]]
 
* [[Documentation:HTCC:IWWDep:Voice#voice.hold-active-call-on-make-call|voice.hold-active-call-on-make-call]]
  
Line 56: Line 87:
  
 
* [[Documentation:HTCC:IWWDep:Accessibility#accessibility.focus-on-interaction-toast|accessibility.focus-on-interaction-toast]]
 
* [[Documentation:HTCC:IWWDep:Accessibility#accessibility.focus-on-interaction-toast|accessibility.focus-on-interaction-toast]]
* [[Documentation:HTCC:IWWDep:Accessibility#accessibility.media-type.focus-on-interaction-toast|accessibility.<media-type>.focus-on-interaction-toast]]
+
* [[Documentation:HTCC:IWWDep:Accessibility#accessibility.media-type.focus-on-interaction-toast|.focus-on-interaction-toast">accessibility.<media-type>.focus-on-interaction-toast</media-type>]]
 
* [[Documentation:HTCC:IWWDep:Contact#contact.history-default-time-filter-main|contact.history-default-time-filter-main]]
 
* [[Documentation:HTCC:IWWDep:Contact#contact.history-default-time-filter-main|contact.history-default-time-filter-main]]
 
* [[Documentation:HTCC:IWWDep:Contact#contact.myhistory-default-time-filter-main|contact.myhistory-default-time-filter-main]]
 
* [[Documentation:HTCC:IWWDep:Contact#contact.myhistory-default-time-filter-main|contact.myhistory-default-time-filter-main]]
* [[Documentation:HTCC:IWWDep:Contact#contact.ucs-interaction.media-type.enable-create|contact.ucs-interaction.<media-type>.enable-create]]
+
* [[Documentation:HTCC:IWWDep:Contact#contact.ucs-interaction.media-type.enable-create|.enable-create">contact.ucs-interaction.<media-type>.enable-create</media-type>]]
 
* [[Documentation:HTCC:IWWDep:Contact#privilege.contact.can-open.email.from-history|privilege.contact.can-open.email.from-history]]
 
* [[Documentation:HTCC:IWWDep:Contact#privilege.contact.can-open.email.from-history|privilege.contact.can-open.email.from-history]]
* [[Documentation:HTCC:IWWDep:Contact#privilege.contact.can-open.media-type.from-history|privilege.contact.can-open.<media-type>.from-history]]
+
* [[Documentation:HTCC:IWWDep:Contact#privilege.contact.can-open.media-type.from-history|.from-history">privilege.contact.can-open.<media-type>.from-history</media-type>]]
 
* [[Documentation:HTCC:IWWDep:ContactCenterStatistics#statistics.routing-points|statistics.routing-points]]
 
* [[Documentation:HTCC:IWWDep:ContactCenterStatistics#statistics.routing-points|statistics.routing-points]]
 
* [[Documentation:HTCC:IWWDep:Email#privilege.email.can-decline|privilege.email.can-decline]]
 
* [[Documentation:HTCC:IWWDep:Email#privilege.email.can-decline|privilege.email.can-decline]]
Line 69: Line 100:
 
* [[Documentation:HTCC:IWWDep:ConfigurationOptionsForGWE#webme.useSecuredHistoryAPI|webme.useSecuredHistoryAPI]]
 
* [[Documentation:HTCC:IWWDep:ConfigurationOptionsForGWE#webme.useSecuredHistoryAPI|webme.useSecuredHistoryAPI]]
 
* [[Documentation:HTCC:IWWDep:Workitem#privilege.workitem-channels.can-use|privilege.workitem-channels.can-use]]
 
* [[Documentation:HTCC:IWWDep:Workitem#privilege.workitem-channels.can-use|privilege.workitem-channels.can-use]]
* [[Documentation:HTCC:IWWDep:Workitem#CanDecline|privilege.<media-type>.can-decline]]
+
* [[Documentation:HTCC:IWWDep:Workitem#CanDecline|.can-decline">privilege.<media-type>.can-decline</media-type>]]
* [[Documentation:HTCC:IWWDep:Workitem#CanMarkDone|privilege.<media-type>.can-mark-done]]
+
* [[Documentation:HTCC:IWWDep:Workitem#CanMarkDone|.can-mark-done">privilege.<media-type>.can-mark-done</media-type>]]
* [[Documentation:HTCC:IWWDep:Workitem#CanMoveToWorkbin|privilege.<media-type>.can-move-to-workbin]]
+
* [[Documentation:HTCC:IWWDep:Workitem#CanMoveToWorkbin|.can-move-to-workbin">privilege.<media-type>.can-move-to-workbin</media-type>]]
* [[Documentation:HTCC:IWWDep:Workitem#CanOneStepTransfer|privilege.<media-type>.can-one-step-transfer]]
+
* [[Documentation:HTCC:IWWDep:Workitem#CanOneStepTransfer|.can-one-step-transfer">privilege.<media-type>.can-one-step-transfer</media-type>]]
* [[Documentation:HTCC:IWWDep:Workitem#CanSetDisp|privilege.<media-type>.can-set-interaction-disposition]]
+
* [[Documentation:HTCC:IWWDep:Workitem#CanSetDisp|.can-set-interaction-disposition">privilege.<media-type>.can-set-interaction-disposition</media-type>]]
 
* [[Documentation:HTCC:IWWDep:Workitem#openmedia.workitem-channels|openmedia.workitem-channels]]
 
* [[Documentation:HTCC:IWWDep:Workitem#openmedia.workitem-channels|openmedia.workitem-channels]]
* [[Documentation:HTCC:IWWDep:Workitem#AutoAnswer|<media-type>.auto-answer]]
+
* [[Documentation:HTCC:IWWDep:Workitem#AutoAnswer|.auto-answer"><media-type>.auto-answer</media-type>]]
* [[Documentation:HTCC:IWWDep:Workitem#PromptForDone|<media-type>.prompt-for-done]]
+
* [[Documentation:HTCC:IWWDep:Workitem#PromptForDone|.prompt-for-done"><media-type>.prompt-for-done</media-type>]]
* [[Documentation:HTCC:IWWDep:Workitem#RingingBell|<media-type>.ringing-bell]]
+
* [[Documentation:HTCC:IWWDep:Workitem#RingingBell|.ringing-bell"><media-type>.ringing-bell</media-type>]]
* [[Documentation:HTCC:IWWDep:Workitem#Queue|intercommunication.<media-type>.queue]]
+
* [[Documentation:HTCC:IWWDep:Workitem#Queue|.queue">intercommunication.<media-type>.queue</media-type>]]
* [[Documentation:HTCC:IWWDep:Workitem#RoutingBasedActions|intercommunication.<media-type>.routing-based-actions]]
+
* [[Documentation:HTCC:IWWDep:Workitem#RoutingBasedActions|.routing-based-actions">intercommunication.<media-type>.routing-based-actions</media-type>]]
* [[Documentation:HTCC:IWWDep:Workitem#RoutingBasedTargets|intercommunication.<media-type>.routing-based-targets]]
+
* [[Documentation:HTCC:IWWDep:Workitem#RoutingBasedTargets|.routing-based-targets">intercommunication.<media-type>.routing-based-targets</media-type>]]
* [[Documentation:HTCC:IWWDep:Workitem#InProgress|workbin.<media-type>.in-progress]]
+
* [[Documentation:HTCC:IWWDep:Workitem#InProgress|.in-progress">workbin.<media-type>.in-progress</media-type>]]
* [[Documentation:HTCC:IWWDep:Workitem#InProgDisplayedColumns|workbin.<media-type>.in-progress.displayed-columns]]
+
* [[Documentation:HTCC:IWWDep:Workitem#InProgDisplayedColumns|.in-progress.displayed-columns">workbin.<media-type>.in-progress.displayed-columns</media-type>]]
  
 
The following configuration options have been added or updated in Web Services and Applications version 8.5.201.50:
 
The following configuration options have been added or updated in Web Services and Applications version 8.5.201.50:
Line 113: Line 144:
 
* [[Documentation:HTCC:IWWDep:Accessibility#accessibility.visual-impairment-profile|accessibility.visual-impairment-profile]]  
 
* [[Documentation:HTCC:IWWDep:Accessibility#accessibility.visual-impairment-profile|accessibility.visual-impairment-profile]]  
 
* [[Documentation:HTCC:IWWDep:ContactCenterStatistics#statistics.refresh-time|statistics.refresh-time]]  
 
* [[Documentation:HTCC:IWWDep:ContactCenterStatistics#statistics.refresh-time|statistics.refresh-time]]  
*[[Documentation:HTCC:IWWDep:Accessibility#keyboard.shortcut.interaction.next|keyboard.shortcut.interaction.next]]  
+
* [[Documentation:HTCC:IWWDep:Accessibility#keyboard.shortcut.interaction.next|keyboard.shortcut.interaction.next]]  
 
* [[Documentation:HTCC:IWWDep:Accessibility#shortcutPrevious|keyboard.shortcut.interaction.previous]]  
 
* [[Documentation:HTCC:IWWDep:Accessibility#shortcutPrevious|keyboard.shortcut.interaction.previous]]  
 
* [[Documentation:HTCC:IWWDep:Accessibility#shortcutLastError|keyboard.shortcut.jump-to-last-error ]]  
 
* [[Documentation:HTCC:IWWDep:Accessibility#shortcutLastError|keyboard.shortcut.jump-to-last-error ]]  
Line 145: Line 176:
  
 
==Gplus Adapters configuration option updates==
 
==Gplus Adapters configuration option updates==
 +
The following configuration options have been added or updated in Web Services and Applications version 8.5.202.XX:
 +
{{Chgbar_open}}
 +
* [[Documentation:HTCC:IWWDep:GPAConfig#screenpop.openmedia.on-invite|screenpop.openmedia.on-invite]]
 +
* [[Documentation:HTCC:IWWDep:GPAConfig#salesforce.keep-session-alive|salesforce.keep-session-alive]]
 +
* [[Documentation:HTCC:IWWDep:GPAConfig#salesforce.chat.transcript-custom-field-name|salesforce.chat.transcript-custom-field-name]]
 +
 +
{{Chgbar_close}}
 +
 +
The following configuration options have been added or updated in Web Services and Applications version 8.5.202.23:
 +
* [[Documentation:HTCC:IWWDep:GPAConfig#screenpop.enable-for-consult|screenpop.enable-for-consult]]
 +
 +
The following configuration options have been added or updated in Web Services and Applications version 8.5.202.04:
 +
* [[Documentation:HTCC:IWWDep:GPAConfig#screenpop.email.on-invite|screenpop.email.on-invite]]
 +
* [[Documentation:HTCC:IWWDep:GPAConfig#statistics.badge-resource|statistics.badge-resource]]
 +
* [[Documentation:HTCC:IWWDep:GPAConfig#statistics.badge-statistic|statistics.badge-statistic]]
  
 
The following configuration option has been updated in Web Services and Applications version 8.5.201.92:
 
The following configuration option has been updated in Web Services and Applications version 8.5.201.92:
Line 169: Line 215:
 
The following configuration options have been added or updated in Web Services and Applications version 8.5.201.29:
 
The following configuration options have been added or updated in Web Services and Applications version 8.5.201.29:
 
* [[Documentation:HTCC:IWWDep:GPAConfig#feedback.submit-after-disconnect|feedback.submit-after-disconnect]]
 
* [[Documentation:HTCC:IWWDep:GPAConfig#feedback.submit-after-disconnect|feedback.submit-after-disconnect]]
* [[Documentation:HTCC:IWWDep:GPAConfig#templatesSalesforceOption|templates.salesforce.<interaction type>.<salesforce argument>]]
+
* [[Documentation:HTCC:IWWDep:GPAConfig#templatesSalesforceOption|.<salesforce%20argument>">templates.salesforce.<interaction type="">.<salesforce argument=""></salesforce></interaction>]]
 
* [[Documentation:HTCC:IWWDep:GPAConfig#VoiceNoteKeyName|voice-note.key-name]]
 
* [[Documentation:HTCC:IWWDep:GPAConfig#VoiceNoteKeyName|voice-note.key-name]]
  
Line 178: Line 224:
  
 
==Web Services API updates==
 
==Web Services API updates==
 +
The following updates have been made in Web Services and Applications version 8.5.202.XX:
 +
{{Chgbar_open}}
 +
* '''ServiceAPI'''
 +
** [[Documentation:HTCC:API:ServiceConfigurations|Configuration]]
 +
* '''Voice API'''
 +
** [[Documentation:HTCC:API:CallsDeviceResource:{{PONYDOCSVERSION}}|Device Resource]]
 +
** [[Documentation:HTCC:API:SupervisorListenIn|SupervisorListenIn]]
 +
** [[Documentation:HTCC:API:SupervisorCoach|SupervisorCoach]]
 +
** [[Documentation:HTCC:API:SupervisorBargeIn|SupervisorBargeIn]]
 +
* Configuration Options
 +
** '''[[Documentation:HTCC:Dep:HTCCConfigurationOptionsReference#enableRPMonitoring|enableRPMonitoring]]''' option
 +
** '''[[Documentation:HTCC:Dep:HTCCConfigurationOptionsReference#useEmployeeIdAsAgentLoginForSIPCluster|useEmployeeIdAsAgentLoginForSIPCluster]]''' option
 +
{{Chgbar_close}}
 +
 +
 +
The following updates have been made in Web Services and Applications version 8.5.202.23:
 +
* '''Contacts API'''
 +
** [[Documentation:HTCC:API:ContactsGetContacts|Get contacts]]
 +
 +
* '''ServiceAPI'''
 +
** [[Documentation:HTCC:API:ServiceRuntime|Runtime]]
 +
 +
The following updates have been made in Web Services and Applications version 8.5.202.04:
 +
* '''Voice API'''
 +
** [[Documentation:HTCC:API:StartContactCenterSession|StartContactCenterSession]]
 +
 +
* '''Chat API'''
 +
** [[Documentation:HTCC:API:ChatRemoveParticipantFromConference|RemoveParticipantFromConference]]
 +
 +
* '''Workbin API'''
 +
** [[Documentation:HTCC:API:WorkbinRequestStats|WorkbinRequestStats]]
 +
** [[Documentation:HTCC:API:WorkbinRequestAgentStats|WorkbinRequestAgentStats]]
  
 
No updates have been made in Web Services and Applications version 8.5.201.92.
 
No updates have been made in Web Services and Applications version 8.5.201.92.

Latest revision as of 18:18, April 27, 2018

New and updated configuration options and API operations

After migrating your Web Services and Applications deployment, review the list of added or updated configuration and API options to decide if you want to maintain the default state of the options or modify them to match your deployment requirements.

Web Services and Applications deployment update

Web Services and Applications version 8.5.201.41 introduces an important update to the serverSettings section of the application.yaml file. The updateOnStartup section is introduced. This update changes the previous behavior where settings were automatically updated on startup. To ensure that your deployment's configuration settings are automatically updated on startup, change the updateOnStartup settings on each Web Services and Applications node as follows:

updateOnStartup:
        statistics: true
        opsCredentials: true
        features: true

For more information, see Server settings.

Workspace Web Edition configuration option updates

The following configuration options have been added or updated in Web Services and Applications version 8.5.202.XX:

The following configuration options have been added or updated in Web Services and Applications version 8.5.202.23:

The following configuration options have been added or updated in Web Services and Applications version 8.5.202.04:

The following configuration options have been added or updated in Web Services and Applications version 8.5.201.92:

The following configuration options have been added or updated in Web Services and Applications version 8.5.201.84:

The following configuration options have been added or updated in Web Services and Applications version 8.5.201.76:

The following configuration options have been added or updated in Web Services and Applications version 8.5.201.68:

The following configuration options have been added or updated in Web Services and Applications version 8.5.201.61:

The following configuration options have been added or updated in Web Services and Applications version 8.5.201.50:

The following configuration options have been added or updated in Web Services and Applications version 8.5.201.41:

The following configuration options have been added or updated in Web Services and Applications version 8.5.201.29:

The following configuration options have been added or updated in Web Services and Applications version 8.5.201.18:

Gplus Adapters configuration option updates

The following configuration options have been added or updated in Web Services and Applications version 8.5.202.XX:

The following configuration options have been added or updated in Web Services and Applications version 8.5.202.23:

The following configuration options have been added or updated in Web Services and Applications version 8.5.202.04:

The following configuration option has been updated in Web Services and Applications version 8.5.201.92:

The following configuration options have been updated in Web Services and Applications version 8.5.201.84:

The following configuration option has been updated in Web Services and Applications version 8.5.201.76:

The following configuration options have been updated in Web Services and Applications version 8.5.201.68:

No configuration options have been added or updated in Web Services and Applications version 8.5.201.61.

No configuration options have been added or updated in Web Services and Applications version 8.5.201.50.

The following configuration option has been added or updated in Web Services and Applications version 8.5.201.41:

The following configuration options have been added or updated in Web Services and Applications version 8.5.201.29:

The following configuration options have been added or updated in Web Services and Applications version 8.5.201.18:

Web Services API updates

The following updates have been made in Web Services and Applications version 8.5.202.XX:


The following updates have been made in Web Services and Applications version 8.5.202.23:

The following updates have been made in Web Services and Applications version 8.5.202.04:

No updates have been made in Web Services and Applications version 8.5.201.92.

No updates have been made in Web Services and Applications version 8.5.201.84.

The following updates have been made in Web Services and Applications version 8.5.201.76:

The following updates have been made in Web Services and Applications version 8.5.201.68:

The following updates have been made in Web Services and Applications version 8.5.201.61:

The following updates have been made in Web Services and Applications version 8.5.201.50:

The following updates have been made in Web Services and Applications version 8.5.201.41:

The following updates have been made in Web Services and Applications version 8.5.201.29:

The following updates have been made in Web Services and Applications version 8.5.201.18:

This page was last edited on April 27, 2018, at 18:18.
Comments or questions about this documentation? Contact us for support!