Configuring the whiteboard collaboration layer
The whiteboard collaboration layer provides agents and visitors with a blank canvas. Conversation participants can draw diagrams as well as add text, shapes, and arrows. This is particularly useful if one of the participants has joined the conversation using a tablet.
Prerequisites
Before you start configuring the whiteboard in specific conversation templates, you must activate it. If you don’t, the settings for the whiteboard aren’t available in the settings of your conversation templates.
You can activate the whiteboard in the GLOBAL
(i.e. server) or ACCOUNT
scope with the configuration property com.unblu.conversation.feature.whiteboardEnabled.
General configuration options
For information on general configuration options, refer to the section General configuration options of the article Configuring and manipulating collaboration layers.
Whiteboard configuration properties
This is a preview feature. It may be subject to change or removal with no further notice.
To enable preview features, set com.unblu.platform.enablePreview to true
.
For more information on preview features, refer to the Unblu release policy.
The following configuration properties determine how conversation participants may launch whiteboard sessions:
-
com.unblu.messenger.startWithWhiteboardOptionEnabled: Make the whiteboard an option with which to start a conversation
-
com.unblu.visitor.ui.engagement.showRequestWhiteboardEngagementOption: Give visitors the possibility to launch a whiteboard from the Unblu welcome screen
You set the configuration properties listed above in the configuration cascades for visitors and agents. The properties only have an effect if the browser and operating system they’re using meet the technical requirements to launch a whiteboard session.
In conversation templates, the configuration properties for whiteboards are:
-
com.unblu.conversation.feature.whiteboardEnabled: Enable the whiteboard feature in the conversation template.
-
com.unblu.conversation.collaboration.approval.approveActivateWhiteboard: Specify whether visitors must approve a whiteboard session.
-
com.unblu.conversation.collaboration.action.allowMarkInWhiteboard: Participant types allowed to use mark mode.
-
com.unblu.conversation.collaboration.approval.approveMarkWhiteboard: The participants for whom the assigned agent must approve mark mode in the whiteboard. Assigned agents themselves never require approval.
-
com.unblu.conversation.collaboration.action.allowRemoteControlInWhiteboard: Participants allowed to use remote control in the whiteboard.
-
com.unblu.conversation.collaboration.approval.approveRemoteControlWhiteboard: The participants for whom the assigned agent must approve remote control in the whiteboard. Assigned agents themselves never require approval.
-
com.unblu.conversation.collaboration.action.allowStopWhiteboard: Participants allowed to stop the whiteboard session.
-
com.unblu.conversation.collaboration.action.showStopWhiteboardDialog: Display a confirmation dialog to the user who stops a whiteboard session.
Set the following configuration properties to change the appearance of the whiteboard UI elements in Unblu:
You can’t configure the actual whiteboard controls, such as the available shapes or styles.