Jump to: navigation, search

Broadcast options

broadcast.color.minimal-priority

  • Default Value: #FFC7C7C7
  • Valid Values: <hexadecimal color value>
  • Changes take effect: Immediately.
  • Description: The color of the Interactive Notification border that indicates that the message has the lowest (minimal) priority.

broadcast.color.low-priority

  • Default Value: #FF7EC0C2
  • Valid Values: <hexadecimal color value>
  • Changes take effect: Immediately.
  • Description: The color of the Interactive Notification border that indicates that the message has low priority.

broadcast.color.normal-priority

  • Default Value: #FFC48C88
  • Valid Values: <hexadecimal color value>
  • Changes take effect: Immediately.
  • Description: The color of the Interactive Notification border that indicates that the message has normal priority.

broadcast.color.high-priority

  • Default Value: #FF5E99FF
  • Valid Values: <hexadecimal color value>
  • Changes take effect: Immediately.
  • Description: The color of the Interactive Notification border that indicates that the message has high priority.

broadcast.color.important-priority

  • Default Value: #FFE81100
  • Valid Values: <hexadecimal color value>
  • Changes take effect: Immediately.
  • Description: The color of the Interactive Notification border that indicates that the message has highest priority.

broadcast.displayed-columns

  • Default Value: MessageTypeIcon,MessageType,Sender,Subject,Priority,Date,Topic
  • Valid Values: A comma-separated list of valid object types from the following list: MessageTypeIcon, MessageType, Sender, Subject, Priority, Date, Topic, Id, <any custom key>
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the names of the columns that are displayed, and the column, order in the My Messages view.

broadcast.dn

  • 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.
  • Description: Specifies the list of Communication​ DNs that are used for Broadcasting. Workspace registers to the specified DNs when a correspondin​g TServer connection is configured in the application and then considers all messages sent on these connections.

broadcast.enable-removal

  • Default Value: all
  • Valid Values: A comma separated list of message types
  • Changes take effect: At next access to a message.
  • Description: 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.enable-removal-priority

  • Default Value: Important
  • Valid Values: Minimal, Low, Normal, High, Important
  • Changes take effect: At next access to a message.
  • Description: Specifies the highest message priority level that an agent is allowed to delete from the Message View.

broadcast.mark-read-timeout

  • Default Value: 5
  • Valid Values: Any integer from 0 to MAXINT.
  • Changes take effect: When the application is started or restarted.
  • Description: 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.message-content

  • Default Value: Subject, Sender, Priority, Date, Topic, Body
  • Valid Values: A comma-separated list of valid object types from the following list: Subject, Sender, Priority, Date, Topic, Body, MessageType, Id, <any custom key>
  • Changes take effect: At the next message.
  • Description: Specifies the content of the message when the message window is displayed. This option also configures the content of the tooltip in the My Messages tab. Any property that is not listed is not displayed.

broadcast.preview-timeout

  • Default Value: 10
  • Valid Values: Any integer from 0 to MAXINT.
  • Changes take effect: At the next interaction.
  • Description: Specifies the duration, in seconds, that the broadcast message Interactive Notification is displayed if the agent does not click Show or Dismiss. The value 0 means that the Interactive Notification is not displayed.

broadcast.sound.minimal-priority

  • Default Value: ""
  • Valid Values: Letters A to Z and a to z. Numbers 0 through 9. All special characters that are valid Windows file names.
  • Changes take effect: At the next interaction.
  • Description: Specify sound that is played when the Interactive Notification is displayed if the priority of the message is minimal (lowest) priority using the new message configuration string -- for example: Sounds\minimal-bell.mp3|7|0|primary
    The value has four components that are separated by the character '|':
  1. 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.
  2. The priority. The higher the integer, the higher the priority.
  3. The duration:
    1. -1 means play the whole sound and repeat the sound until the Interactive Notification is closed.
    2. 0 means play the whole sound one time.
    3. An integer > 0 means a time, in milliseconds, to play and repeat the sound.
  4. 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.

broadcast.sound.low-priority

  • Default Value: ""
  • Valid Values: Letters A to Z and a to z. Numbers 0 through 9. All special characters that are valid Windows file names.
  • Changes take effect: At the next interaction.
  • Description: Specify sound that is played when the Interactive Notification is displayed if the priority of the message is low priority using the new message configuration string -- for example: Sounds\low-bell.mp3|7|0|primary
    The value has four components that are separated by the character '|':
  1. 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.
  2. The priority"The higher the integer the higher the priority.
  3. The duration:
    1. -1 means play the whole sound and repeat the sound until the Interactive Notification is closed.
    2. 0 means play the whole sound one time.
    3. An integer > 0 means a time, in milliseconds, to play and repeat the sound.
  4. 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.

broadcast.sound.normal-priority

  • Default Value: ""
  • Valid Values: Letters A to Z and a to z. Numbers 0 through 9. All special characters that are valid Windows file names.
  • Changes take effect: At the next interaction.
  • Description: Specify sound that is played when the Interactive Notification is displayed if the priority of the message is normal priority using the new message configuration string -- for example: Sounds\normal-bell.mp3|7|0|primary
    The value has four components that are separated by the character '|':
  1. 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.
  2. The priority -- The higher the integer the higher the priority.
  3. The duration:
    1. -1 means play the whole sound and repeat the sound until the Interactive Notification is closed.
    2. 0 means play the whole sound one time.
    3. An integer > 0 means a time, in milliseconds, to play and repeat the sound.
  4. 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.

broadcast.sound.high-priority

  • Default Value: ""
  • Valid Values: Letters A to Z and a to z. Numbers 0 through 9. All special characters that are valid Windows file names.
  • Changes take effect: At the next interaction.
  • Description: Specify sound that is played when the Interactive Notification is displayed if the priority of the message is high priority using the new message configuration string -- for example: Sounds\high-bell.mp3|7|0|primary
    The value has four components that are separated by the character '|':
  1. 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.
  2. The priority -- The higher the integer the higher the priority.
    1. -1 means play the whole sound and repeat the sound until the Interactive Notification is closed.
    2. 0 means play the whole sound one time.
    3. An integer > 0 means a time, in milliseconds, to play and repeat the sound.
  3. 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.

broadcast.sound.important-priority

  • Default Value: ""
  • Valid Values: Letters A to Z and a to z. Numbers 0 through 9. All special characters that are valid Windows file names.
  • Changes take effect: At the next interaction.
  • Description: Specify sound that is played when the Interactive Notification is displayed if the priority of the message is important (highest) priority using the new message configuration string -- for example: Sounds\important-bell.mp3|7|0|primary
    The value has four components that are separated by the character '|':
  1. 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.
  2. The priority -- The higher the integer the higher the priority.
  3. The duration:
    1. -1 means play the whole sound and repeat the sound until the Interactive Notification is closed.
    2. 0 means play the whole sound one time.
    3. An integer > 0 means a time, in milliseconds, to play and repeat the sound.
  4. 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.

broadcast.subscribed.topics

  • Default Value: All,$Agent$,$AgentGroup$
  • Valid Values: A comma-separated list of valid message topics.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the list of topics to which agents can be subscribed. $Agent$ defines the username of the agent; $AgentGroup$ defines all agent groups that contain the agent.

broadcast.system-messages-auto-mark-read

  • Default Value: true
  • Valid Values: true, false
  • Changes take effect: At next change of counter value.
  • Description: 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.toast-summary

  • Default Value: Sender,Priority,Subject,FewWords
  • Valid Values: A comma-separated of valid object types from the following list: Sender, Priority, Subject, FewWords, Topic, MessageType, <any key of custom data>
  • Changes take effect: At the next message.
  • Description: Specifies the content of the Interactive Notification. Items are displayed in the Interactive Notification in the order that is specified. Any item that is not specified is not displayed.

broadcast.value-business-attribute

  • Default Value: ""
  • Valid Values: A valid name of a Business Attribute.
  • Changes take effect: When the application is started or restarted.
  • Description: Specifies the name of the Business Attribute that contains the attribute values that are used for the custom attribute of the message

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on October 26, 2018, at 06:33.