broadcast.value-business-attribute
Section: interaction-workspace
Default Value:
Valid Values: A valid Business Attribute name.
Changes Take Effect: When the application is started or restarted.
A character string that specifies the name of the Business Attribute that contains the Attribute Values that are used as an enumerated value for custom attribute of message.
broadcast.toast-summary
Section: interaction-workspace
Default Value: Sender, Priority,Subject,FewWords
Valid Values: A comma-separated of valid object types from the following: Sender, Priority, Subject, FewWords, Topic, MessageType, any key of custom
Changes Take Effect: At the next message.
Determines the attributes display in the broadcast message notification.
broadcast.system-messages-auto-mark-read
Section: interaction-workspace
Default Value: true
Valid Values: boolean
Changes Take Effect: At next change of counter value.
Specifies that system messages are marked as "read" immediately after the interactive notification is displayed to prevent the Main Menu button from including them in the notification bullet counter.
broadcast.subscribed.topics
Section: interaction-workspace
Default Value: All,$Agent$,$AgentGroup$
Valid Values: A comma-separated list of string
Changes Take Effect: When the application is started or restarted.
Specifies the list of topics to which agents can be subscribed. The key $Agent$ defines the username of the agent. The key $AgentGroup$ defines all agent groups of which the agent is a member.
broadcast.sound.important-priority
Section: interaction-workspace
Default Value:
Valid Values: All special characters that are valid Windows file path, '|' separator and numeric values.
Changes Take Effect: At the next interaction.
Dependencies: application.secondary-audio-out-device
Related Options: application.secondary-audio-out-device
Specifies the sound-configuration string of a message of type important. For example: "Sounds\ImportantMessage.mp3|10|-1|primary" The value has four components that are separated by the character '|':
- The file name and folder relative to the application folder. In some virtual desktop environments, MP3 and other sound file formats cannot be rendered by Direct Show filters. In this scenario, use Direct Show compatible formats such as .wav.
- The priority -- The higher the integer the higher the priority.
-
The duration:
- -1 means play the whole sound and repeat the sound until the Interactive Notification is closed.
- 0 means play the whole sound one time.
- An integer > 0 means a time, in milliseconds, to play and repeat the sound.
-
Specify whether tones are played on the default audio device, a secondary audio device, or both. If no value is specified for this flag, the value |primary is used by default.
- primary—Play the sound on the default audio output device
- secondary—Play the sound on the secondary audio device, as defined by the application.secondary-audio-out-device configuration option
- both—Play the sound on the default and secondary (application.secondary-audio-out-device configuration option) audio devices
broadcast.sound.high-priority
Section: interaction-workspace
Default Value:
Valid Values: All special characters that are valid Windows file path, '|' separator and numeric values.
Changes Take Effect: At the next interaction.
Dependencies: application.secondary-audio-out-device
Related Options: application.secondary-audio-out-device
Specifies the sound configuration string of messages of type important. For example: "Sounds\HighMessage.mp3|10|-1|primary" The value has four components that are separated by the character '|':
- The file name and folder relative to the application folder. In some virtual desktop environments, MP3 and other sound file formats cannot be rendered by Direct Show filters. In this scenario, use Direct Show compatible formats such as .wav.
-
The priority -- The higher the integer the higher the priority.
- -1 means play the whole sound and repeat the sound until the Interactive Notification is closed.
- 0 means play the whole sound one time.
- An integer > 0 means a time, in milliseconds, to play and repeat the sound.
-
Specify whether tones are played on the default audio device, a secondary audio device, or both. If no value is specified for this flag, the value |primary is used by default.
- primary—Play the sound on the default audio output device
- secondary—Play the sound on the secondary audio device, as defined by the application.secondary-audio-out-device configuration option
- both—Play the sound on the default and secondary (application.secondary-audio-out-device configuration option) audio devices
broadcast.sound.normal-priority
Section: interaction-workspace
Default Value:
Valid Values: All special characters that are valid Windows file path, '|' separator and numeric values.
Changes Take Effect: At the next interaction.
Dependencies: application.secondary-audio-out-device
Related Options: application.secondary-audio-out-device
Specifies the sound configuration string of messages of type important. For example: "Sounds\NormalMessage.mp3|10|-1|primary" The value has four components that are separated by the character '|':
- The file name and folder relative to the application folder.The file name and folder relative to the application folder. In some virtual desktop environments, MP3 and other sound file formats cannot be rendered by Direct Show filters. In this scenario, use Direct Show compatible formats such as .wav.
- The priority -- The higher the integer the higher the priority.
-
The duration:
- -1 means play the whole sound and repeat the sound until the Interactive Notification is closed.
- 0 means play the whole sound one time.
- An integer > 0 means a time, in milliseconds, to play and repeat the sound.
-
Specify whether tones are played on the default audio device, a secondary audio device, or both. If no value is specified for this flag, the value |primary is used by default.
- primary—Play the sound on the default audio output device
- secondary—Play the sound on the secondary audio device, as defined by the application.secondary-audio-out-device configuration option
- both—Play the sound on the default and secondary (application.secondary-audio-out-device configuration option) audio devices
broadcast.sound.low-priority
Section: interaction-workspace
Default Value:
Valid Values: All special characters that are valid Windows file path, '|' separator and numeric values.
Changes Take Effect: At the next interaction.
Dependencies: application.secondary-audio-out-device
Related Options: application.secondary-audio-out-device
Specifies the sound configuration string of messages of type important. For example: "Sounds\LowMessage.mp3|10|-1|primary" The value has four components that are separated by the character '|':
- The file name and folder relative to the application folder. In some virtual desktop environments, MP3 and other sound file formats cannot be rendered by Direct Show filters. In this scenario, use Direct Show compatible formats such as .wav.
- The priority"The higher the integer the higher the priority.
-
The duration:
- -1 means play the whole sound and repeat the sound until the Interactive Notification is closed.
- 0 means play the whole sound one time.
- An integer > 0 means a time, in milliseconds, to play and repeat the sound.
-
Specify whether tones are played on the default audio device, a secondary audio device, or both. If no value is specified for this flag, the value |primary is used by default.
- primary—Play the sound on the default audio output device
- secondary—Play the sound on the secondary audio device, as defined by the application.secondary-audio-out-device configuration option
- both—Play the sound on the default and secondary (application.secondary-audio-out-device configuration option) audio devices
broadcast.sound.minimal-priority
Section: interaction-workspace
Default Value:
Valid Values: All special characters that are valid Windows file path, '|' separator and numeric values.
Changes Take Effect: At the next interaction.
Dependencies: application.secondary-audio-out-device
Related Options: application.secondary-audio-out-device
Specifies the sound configuration string of messages of type important. For example: "Sounds\MinimalMessage.mp3|10|-1|primary" The value has four components that are separated by the character '|':
- The file name and folder relative to the application folder. In some virtual desktop environments, MP3 and other sound file formats cannot be rendered by Direct Show filters. In this scenario, use Direct Show compatible formats such as .wav.
- The priority. The higher the integer, the higher the priority.
-
The duration:
- -1 means play the whole sound and repeat the sound until the Interactive Notification is closed.
- 0 means play the whole sound one time.
- An integer > 0 means a time, in milliseconds, to play and repeat the sound.
-
Specify whether tones are played on the default audio device, a secondary audio device, or both. If no value is specified for this flag, the value |primary is used by default.
- primary—Play the sound on the default audio output device
- secondary—Play the sound on the secondary audio device, as defined by the application.secondary-audio-out-device configuration option
- both—Play the sound on the default and secondary (application.secondary-audio-out-device configuration option) audio devices
broadcast.preview-timeout
Section: interaction-workspace
Default Value: 10
Valid Values: from 0 to MAXINT
Changes Take Effect: At the next message.
Defines the duration, in seconds, that the preview of the broadcast message is displayed in the Information area of the Main Window. The value 0 means the Preview is not displayed.
broadcast.message-content
Section: interaction-workspace
Default Value: Subject,
Valid Values: A comma-separated list of valid object types from the following: Subject, Sender, Priority, Date, Topic, Body, MessageType, Id, any key of custom data
Changes Take Effect: At the next message.
Specifies the attributes that are displayed in the Broadcast Message window and in the item tooltip of the MyMessages view.
broadcast.mark-read-timeout
Section: interaction-workspace
Default Value: 5
Valid Values: from 0 to MAXINT
Changes Take Effect: When the application is started or restarted.
Specifies the duration, in seconds, that the broadcast message tooltip is displayed before the message is marked as read. If the duration is 0, this feature is not applied; then, the message is not considered to be read until the agent selects it for reading.
broadcast.enable-removal-priority
Section: interaction-workspace
Default Value: Important
Valid Values: Select from the list Highest priority level enabled for removal
Changes Take Effect: At next access to a message.
Specifies the highest message priority level that an agent is allowed to delete from the Message View.
broadcast.enable-removal
Section: interaction-workspace
Default Value: all
Valid Values: A comma separated list of message types.
Changes Take Effect: At next access to a message.
Specifies a comma separated list of message types, including custom message types, that an Agent is allowed to delete from the Message View.
- There are three pre-defined types:
- system - internal system messages
- public - any type other than system messages
- all - all messages
broadcast.dn
Section: interaction-workspace
Default Value:
Valid Values: A comma-separated list of DN and switch names in the following format: dn_name@switch
Changes Take Effect: When the application is started or restarted.
Specifies the list of Communication DNs that are used for Broadcasting.
Workspace registers to the specified DNs when a corresponding TServer connection is configured in the application and then considers all messages sent on these connections.
broadcast.displayed-columns
Section: interaction-workspace
Default Value: MessageTypeIcon,
Valid Values: A comma-separated list of valid object types from the following: MessageTypeIcon, MessageType, Sender, Subject, Priority, Date, Topic, Id, any key of custom data
Changes Take Effect: When the application is started or restarted.
Specifies the names of the columns that are displayed in the MyMessage view.
broadcast.color.important-priority
Section: interaction-workspace
Default Value: #FFE81100
Valid Values: The hexadecimal Alpha (from '00' for fully transparent color to 'FF' for regular plain color) followed by the RGB hexadecimal color code (3 values in the '00'-'FF' range).
Changes Take Effect: Immediately.
Specifies the color of the border of the Message view frames for important priority messages. Examples: #FFFFBA00 for a Gold color, #FF6F7074 for a Silver color, #FFB8400B for a Bronze color.
broadcast.color.high-priority
Section: interaction-workspace
Default Value: #FF5E99FF
Valid Values: The hexadecimal Alpha (from '00' for fully transparent color to 'FF' for regular plain color) followed by the RGB hexadecimal color code (3 values in the '00'-'FF' range).
Changes Take Effect: Immediately.
Specifies the color of the border of the Message view frames for high priority messages. Examples: #FFFFBA00 for a Gold color, #FF6F7074 for a Silver color, #FFB8400B for a Bronze color.
broadcast.color.normal-priority
Section: interaction-workspace
Default Value: #FFC48C88
Valid Values: The hexadecimal Alpha (from '00' for fully transparent color to 'FF' for regular plain color) followed by the RGB hexadecimal color code (3 values in the '00'-'FF' range).
Changes Take Effect: Immediately.
Specifies the color of the border of the Message view frames for normal priority messages. Examples: #FFFFBA00 for a Gold color, #FF6F7074 for a Silver color, #FFB8400B for a Bronze color.
broadcast.color.low-priority
Section: interaction-workspace
Default Value: #FF7EC0C2
Valid Values: The hexadecimal Alpha (from '00' for fully transparent color to 'FF' for regular plain color) followed by the RGB hexadecimal color code (3 values in the '00'-'FF' range).
Changes Take Effect: Immediately.
Specifies the color of the border of the Message view frames for low priority messages. Examples: #FFFFBA00 for a Gold color, #FF6F7074 for a Silver color, #FFB8400B for a Bronze color.
broadcast.color.minimal-priority
Section: interaction-workspace
Default Value: #FFC7C7C7
Valid Values: The hexadecimal Alpha (from '00' for fully transparent color to 'FF' for regular plain color) followed by the RGB hexadecimal color code (3 values in the '00'-'FF' range).
Changes Take Effect: Immediately.
Specifies the color of the border of the Message view frames for minimal priority messages. Examples: #FFFFBA00 for a Gold color, #FF6F7074 for a Silver color, #FFB8400B for a Bronze color.
Broadcast options
- broadcast.color.minimal-priority
- broadcast.color.low-priority
- broadcast.color.normal-priority
- broadcast.color.high-priority
- broadcast.color.important-priority
- broadcast.displayed-columns
- broadcast.dn
- broadcast.enable-removal
- broadcast.enable-removal-priority
- broadcast.mark-read-timeout
- broadcast.message-content
- broadcast.preview-timeout
- broadcast.sound.minimal-priority
- broadcast.sound.low-priority
- broadcast.sound.normal-priority
- broadcast.sound.high-priority
- broadcast.sound.important-priority
- broadcast.subscribed.topics
- broadcast.system-messages-auto-mark-read
- broadcast.toast-summary
- broadcast.value-business-attribute
Related Resources
The following topics discuss the implementation of these options: