Revision as of 13:56, January 24, 2020 by Sbogard (talk | contribs)
Jump to: navigation, search

Release List

{
	"gws": true,
	"info": {
		"version": "9.0.000.65",
		"latest_release_version": "9.0.000.31",
		"intermediate": true,
		"published_docs": false,
		"intermediate_versions": [
			"9.0.000.50",
			"9.0.000.61"
		],
		"draft_documentation_version": "9.0.0DRAFT",
		"official_documentation_version": "9.0.0",
		"doc_product": "HTCC",
		"json_options_page": "Documentation:HTCC:Library:json-options:8.5Source",
		"history": "Documentation:Options:HTCC:ChangeHistory:Draft",
		"build_date": "2020-01-24T13:56:15.821Z",
		"build_started": true,
		"published": false
	},
	"options_desc": {
		"component": "Genesys_Web_Services",
		"compshort": "GWS",
		"prodshort": "HTCC"
	},
	"option_pages": [
		{
			"option": "expression.identify.phone-number",
			"page": "Options:Genesys_Web_Services:interaction-workspace:expression-identify-phone-number",
			"published": false,
			"description": "Specifies the regular expression that identifies a phone number in the chat or email transcript. This option can be overridden by a routing strategy as described in the Configuration Guide."
		},
		{
			"option": "expression.identify.email-address",
			"page": "Options:Genesys_Web_Services:interaction-workspace:expression-identify-email-address",
			"published": false,
			"description": "Specifies the regular expression that identifies an email address in a chat."
		},
		{
			"option": "email.print.print-content",
			"page": "Options:Genesys_Web_Services:interaction-workspace:email-print-print-content",
			"published": false,
			"description": "Specifies the list of fields to print for an email interaction. Supported fields are: From, To, Cc, Subject, Body, Date, Attachment, InteractionType, CaseData, Note."
		},
		{
			"option": "email.enable-email-address-validation",
			"page": "Options:Genesys_Web_Services:interaction-workspace:email-enable-email-address-validation",
			"published": false,
			"description": "Specifies that the To, Cc, and Bcc addresses are validated when completing sending and forwarding."
		},
		{
			"option": "privilege.email.can-print",
			"page": "Options:Genesys_Web_Services:interaction-workspace:privilege-email-can-print",
			"published": false,
			"description": "Allows agents to print email interactions from the My history and My Workbin views, and from the Contact History tabs of the Contact Directory, Interaction Search, and Interaction Detail views."
		},
		{
			"option": "outbound.timed-preview-auto-dial",
			"page": "Options:Genesys_Web_Services:interaction-workspace:outbound-timed-preview-auto-dial",
			"published": false,
			"description": "Specifies whether agents in Preview, Push preview, and Reschedule preview campaigns can manually dial a record, have the call auto-dialed as soon as the record is accepted, or have the call auto-dialed after a specified number of seconds. If set to 0, the interaction is dialed as soon as it is accepted. A value of -1 disables automatic dialing. This option can be overridden by a routing strategy as described in Configuration Guide."
		},
		{
			"option": "outbound.callback-types",
			"page": "Options:Genesys_Web_Services:interaction-workspace:outbound-callback-types",
			"published": false,
			"description": "Specifies the list of callback types (Personal,Campaign) from which an agent can select when rescheduling an outbound record. This option can be overridden by a routing strategy as described in Configuration Guide."
		},
		{
			"option": "screen-recording.client.server-url",
			"page": "Options:Genesys_Web_Services:interaction-workspace:screen-recording-client-server-url",
			"published": false,
			"description": "Defines the address of the RWS server to be used for communication by Screen Recording Client. The field code $GWS_URL$ is supported allowing to specify the usage of the same origin as WWE UI. If the option is empty, the WWE UI origin is used. A list of RWS/WWE UI pairs can be defined based on the pattern: <rws_origin_url>(<wwe_origin_url>). This list could be based on a single pair. In case of none matching, the default behavior is used."
		},
		{
			"option": "interaction-management.move-to-workbin.restrict-to-my-team",
			"page": "Options:Genesys_Web_Services:interaction-workspace:interaction-management-move-to-workbin-restrict-to-my-team",
			"published": false,
			"description": "Specifies if the search applied in Team Communicator for Move to Workbin action should be restricted to the workbins of the logged agent team."
		},
		{
			"option": "teamlead.myagents.available-page-sizes",
			"page": "Options:Genesys_Web_Services:interaction-workspace:teamlead-myagents-available-page-sizes",
			"published": false,
			"description": "Specifies the possible values for the number of rows per page in the My Agents view."
		},
		{
			"option": "login.show-change-account-link",
			"page": "Options:Genesys_Web_Services:interaction-workspace:login-show-change-account-link",
			"published": false,
			"description": "Show or Hide the change login account link on login error page and second step login page."
		},
		{
			"option": "contact.cache-timeout-delay",
			"page": "Options:Genesys_Web_Services:interaction-workspace:contact-cache-timeout-delay",
			"published": false,
			"description": "Specifies the delay, in seconds, before the cache of the result of a Universal Contact Server request is cleared."
		},
		{
			"option": "teamlead.myagents.pagination.limit",
			"page": "Options:Genesys_Web_Services:interaction-workspace:teamlead-myagents-pagination-limit",
			"published": false,
			"description": "Specifies the maximum number of agents displayed per page in the My Agents tab."
		},
		{
			"option": "webrtc.service-urn",
			"page": "Options:Genesys_Web_Services:interaction-workspace:webrtc-service-urn",
			"published": false,
			"description": "Specifies the URN that should be based on the following pattern: WEBRTCGATEWAY_SERVER:WEBRTCGATEWAY_PORT?sip-proxy-address=SIPPROXY_SERVER:SIPPROXY_PORT. Replace WEBRTCGATEWAY_SERVER with the hostname where the WebRTC Gateway is deployed, and PORT with the HTTPS port of the WebRTC Gateway. Also, replace SIPPROXY_SERVER and SIPPROXY_PORT (optional) with the connectivity parameters of the SIP Proxy that need to be contacted by the WebRTC Gateway to register this DN."
		},
		{
			"option": "privilege.teamlead.can-monitor-<media-type>",
			"page": "Options:Genesys_Web_Services:interaction-workspace:privilege-teamlead-can-monitor-zmedia-type-",
			"published": false,
			"description": "Enables a supervisor to monitor generic chat interactions."
		},
		{
			"option": "privilege.teamlead.can-coach-<media-type>",
			"page": "Options:Genesys_Web_Services:interaction-workspace:privilege-teamlead-can-coach-zmedia-type-",
			"published": false,
			"description": "Enables a supervisor to coach generic chat interactions."
		},
		{
			"option": "standard-response.field.<CustomFieldCode>",
			"page": "Options:Genesys_Web_Services:interaction-workspace:standard-response-field-zCustomFieldCode-",
			"published": false,
			"description": "In the name of the option, CustomFieldCode represents a field code that is called in a Standard Response object created in eServices Manager and stored in Universal Contact Server. Use this option to specify a custom field code such as a role, department, or other qualification. The value of the option is specific to the agent, agent group, tenant, or application. The value of this option represents the data that is used to populate the corresponding field codes when a Standard Response is inserted into an interaction. You can format CustomFieldCode to represent a custom agent attribute. Example: standard-response.field.Department = Sales"
		},
		{
			"option": "standard-response.field.Agent.<CustomFieldCode>",
			"page": "Options:Genesys_Web_Services:interaction-workspace:standard-response-field-Agent-zCustomFieldCode-",
			"published": false,
			"description": "In the name of the option, CustomFieldCode represents a field code that is called in a Standard Response object created in eServices Manager and stored in Universal Contact Server. Use this option to specify a custom field code such as an agent nickname, role, department, or other qualification. The value of the option is specific to the agent, agent group, tenant, or application. The value of this option represents the data that is used to populate the corresponding field codes when a Standard Response is inserted into an interaction. You can format CustomFieldCode to represent a custom agent attribute. Example: standard-response.field.Agent.Nickname = Lee"
		},
		{
			"option": "teamlead.myagents.default-page-size",
			"page": "Options:Genesys_Web_Services:interaction-workspace:teamlead-myagents-default-page-size",
			"published": false,
			"description": "Specifies the default value for the number of rows per page in the My Agents view. The value is added to the list defined by the option teamlead.myagents.available-page-sizes."
		},
		{
			"option": "editor.default-font",
			"page": "Options:Genesys_Web_Services:interaction-workspace:editor-default-font",
			"published": false,
			"description": "Specifies the default font in the Font menu of new and reply HTML format email  interactions. If this option is left empty, the last selected font is used for email interactions by default."
		},
		{
			"option": "standard-response.field.<[Agent.]CustomFieldCode>",
			"page": "Options:Genesys_Web_Services:interaction-workspace:standard-response-field-zzAgent-zCustomFieldCode-",
			"published": false,
			"description": "In the name of the option, CustomFieldCode represents a field code that is called in a Standard Response object created in Knowledge Manager and stored in Universal Contact Server. Use this option to specify a custom field code such as an agent nickname, role, department, or other qualification. The value of the option is specific to the agent, agent group, tenant, or application. Refer to Standard Responses Library for more information The value of this option represents the data that is used to populate the corresponding field codes when a Standard Response is inserted into an interaction. You can format CustomFieldCode to represent a custom agent attribute using the following pattern: Agent.<CustomAgentAttr>, or any custom attribute by dropping the agent modifier: <CustomFieldCode>."
		},
		{
			"option": "auth.session.invalidate-on-logout",
			"page": "Options:Genesys_Web_Services:interaction-workspace:auth-session-invalidate-on-logout",
			"published": false,
			"description": "Specifies whether or not the Auth SSO session is kept on logout.<br>If true, when Agent exits Workspace, both Workspace and Auth session are removed and Agent is redirected to Auth login page.<br>If false, when Agent exits Workspace, only Workspace session is removed and Agent is redirected to a Workspace session ended page."
		},
		{
			"option": "agent-status.enabled-actions-global",
			"page": "Options:Genesys_Web_Services:interaction-workspace:agent-status-enabled-actions-global",
			"published": false,
			"description": "Specifies the available agent states in the global Status menu. The agent state commands are displayed in the order in which they appear in the list."
		},
		{
			"option": "voice.notification.on-party-update.enabled",
			"page": "Options:Genesys_Web_Services:interaction-workspace:voice-notification-on-party-update-enabled",
			"published": false,
			"description": "Specifies whether the agent is notified when a participant leaves or joins an interaction they are handling."
		},
		{
			"option": "voice.notification.on-party-update.tooltip-history-ttl",
			"page": "Options:Genesys_Web_Services:interaction-workspace:voice-notification-on-party-update-tooltip-history-ttl",
			"published": false,
			"description": "Specifies the duration in microseconds that the participant status notification is displayed."
		},
		{
			"option": "voice.notification.on-party-update.blink-interaction",
			"page": "Options:Genesys_Web_Services:interaction-workspace:voice-notification-on-party-update-blink-interaction",
			"published": false,
			"description": "Specifies whether interactions that do not have the focus blink when the status of a participant changes."
		},
		{
			"option": "login.list-available-locales",
			"page": "Options:Genesys_Web_Services:interaction-workspace:login-list-available-locales",
			"published": false,
			"description": "Specifies the language that the agent can select at login time.<BR>Either, set this option empty to prevent the agent from selecting the language or set this option to $All$ to get all the languages available, or set this option to a list of languages (possible values are Brazilian (pt-BR), French (fr-FR), French Canadian (fr-CA), German (de-DE), Japanese (ja), Spanish (es), Korean(ko), Italian(it) and Dutch(nl)). English is the default language, and will always be available."
		},
		{
			"option": "chat.nickname",
			"page": "Options:Genesys_Web_Services:interaction-workspace:chat-nickname",
			"published": false,
			"description": "Specifies the agent's nickname that is used during chat sessions (displayed to the customer) by a string that can contain regular characters and field codes. This option can be overridden by a routing strategy as described in the Configuration Guide."
		},
		{
			"option": "outbound.call-result-is-mandatory",
			"page": "Options:Genesys_Web_Services:interaction-workspace:outbound-call-result-is-mandatory",
			"published": false,
			"description": "Specifies if it is mandatory to choose a call result other than 'Unknown' before marking the interaction as done"
		},
		{
			"option": "voice.restore-state-on-back-in-service.is-enabled",
			"page": "Options:Genesys_Web_Services:interaction-workspace:voice-restore-state-on-back-in-service-is-enabled",
			"published": false,
			"description": "If voice channel goes Out of Service, specifies if WWE should attempt to automatically set channel back to its previous state once it is back in service."
		},
		{
			"option": "voice.restore-state-on-back-in-service.time",
			"page": "Options:Genesys_Web_Services:interaction-workspace:voice-restore-state-on-back-in-service-time",
			"published": false,
			"description": "If voice channel goes Out of Service, specifies the amount of time (in second) to set channel back to its previous state once it is back in service when voice.restore-state-on-back-in-service.is-enabled is true."
		},
		{
			"option": "voice.dial-plan-rule-<rule-name>",
			"page": "Options:Genesys_Web_Services:interaction-workspace:voice-dial-plan-rule-zrule-name-",
			"published": false,
			"description": "Specifies the rules that are used to transform destination numbers into the requested format before being dialed"
		},
		{
			"option": "teamcommunicator.<media-type>.list-status-reachable",
			"page": "Options:Genesys_Web_Services:interaction-workspace:teamcommunicator-zmedia-type-zlist-status-reachable",
			"published": false,
			"description": "Specifies the list of unavailable statuses for which a target agent can be contacted for consultation, transfer, and conference requests. If the unavailable status of the target agent is not in the list of allowed statuses, the target agent will not be listed as available for consultation, transfer, and conference requests."
		},
		{
			"option": "teamcommunicator.voice.list-status-reachable",
			"page": "Options:Genesys_Web_Services:interaction-workspace:teamcommunicator-voice-list-status-reachable",
			"published": false,
			"description": "Specifies the list of unavailable statuses for which a target agent can be contacted for consultation, transfer, and conference requests. If the unavailable status of the target agent is not in the list of allowed statuses, the target agent will not be listed as available for consultation, transfer, and conference requests."
		},
		{
			"option": "teamcommunicator.email.list-status-reachable",
			"page": "Options:Genesys_Web_Services:interaction-workspace:teamcommunicator-email-list-status-reachable",
			"published": false,
			"description": "Specifies the list of unvailable statuses for which a target agent can be contacted for transfer requests. If the unvailable status of the target agent is not in the list of allowed statuses, the target agent will not be listed as available for transfer requests. Depends on 'Email - Can Use Email Channel' and 'TeamCommunicator - Evaluate Presence'."
		},
		{
			"option": "teamcommunicator.chat.list-status-reachable",
			"page": "Options:Genesys_Web_Services:interaction-workspace:teamcommunicator-chat-list-status-reachable",
			"published": false,
			"description": "Specifies the list of unvailable statuses for which a target agent can be contacted for consultation, transfer, and conference, requests. If the unvailable status of the target agent is not in the list of allowed statuses, the target agent will not be listed as available for consultation, transfer, and conference requests. Depends on 'Chat - Can Use Chat Channel' and 'TeamCommunicator - Evaluate Presence'."
		},
		{
			"option": "contact.lookup.voice.use-dialed-phone-number",
			"page": "Options:Genesys_Web_Services:interaction-workspace:contact-lookup-voice-use-dialed-phone-number",
			"published": false,
			"description": "If contact lookup is enabled, this option specifies that contact lookup is performed on the normalized phone number that was manually dialed by the agent rather than the number resulting from the application of dial plan rules, if any."
		},
		{
			"option": "interaction.voice.anonymous-contact.key-name",
			"page": "Options:Genesys_Web_Services:interaction-workspace:interaction-voice-anonymous-contact-key-name",
			"published": false,
			"description": "Specifies the name of the attached data key that specifies whether contact information is treated as anonymous in the interaction view, case information, and history. If the key value is 1, contact information is masked."
		},
		{
			"option": "workbin.bulk-operation.nb-interactions-perf-impact",
			"page": "Options:Genesys_Web_Services:interaction-workspace:workbin-bulk-operation-nb-interactions-perf-impact",
			"published": false,
			"description": "Specifies the number of interactions from which a bulk operation will impact performance."
		},
		{
			"option": "statistics.gadget-statistics.max-size",
			"page": "Options:Genesys_Web_Services:interaction-workspace:statistics-gadget-statistics-max-size",
			"published": false,
			"description": "Specifies the maximum number of statistics that are displayed in the Statistics Gadget. If more statistics are specified by the statistics.gadget-statistics option, only the first 'n' statistics are displayed."
		},
		{
			"option": "privilege.voice-history.can-click-to-dial",
			"page": "Options:Genesys_Web_Services:interaction-workspace:privilege-voice-history-can-click-to-dial",
			"published": false,
			"description": " Enables an agent to use Click-to-dial a voice call from the Details tab of the history of a voice interaction in any History view."
		},
		{
			"option": "privilege.voice-history.can-click-to-search",
			"page": "Options:Genesys_Web_Services:interaction-workspace:privilege-voice-history-can-click-to-search",
			"published": false,
			"description": "Enables an agent to use Click-to-search to open the Contact Directory by clicking a Contact name in the Details tab of the My History or Interaction Search views."
		},
		{
			"option": "editor.fonts",
			"page": "Options:Genesys_Web_Services:interaction-workspace:editor-fonts",
			"published": false,
			"description": "Specifies the list of available fonts in the Fonts menu of new and reply HTML format email interactions. The fonts are displayed in the order in which they appear in the list."
		},
		{
			"option": "workspace-toolkit.enable",
			"page": "Options:Genesys_Web_Services:interaction-workspace:workspace-toolkit-enable",
			"published": false,
			"description": "Specifies whether Workspace Toolkit use is authorized or not. This option must be set in the WS_Cluster application."
		},
		{
			"option": "disaster-recovery.enabled",
			"page": "Options:Genesys_Web_Services:interaction-workspace:disaster-recovery-enabled",
			"published": false,
			"description": "Specifies whether Business Continuity (Disaster Recovery) functionality is activated for SIP Server and Genesys Web Services."
		}
	],
	"additional_pages": []
}
Comments or questions about this documentation? Contact us for support!