Configuring the document co-browsing collaboration layer
This document describes version 7 of Unblu. If you’re using Unblu Spark 8, go to the latest version of the documentation. |
Document co-browsing lets conversation participants lets PDF files and other kinds of files together. Participants all see the same copy of the document, so when completing a PDF form, for example, all participants can see what’s entered in the form as it happens.
Prerequisites
Before you start configuring document co-browsing in specific conversation templates, you must activate it. If you don’t, the settings for document co-browsing aren’t available in the settings of your conversation templates.
You can activate document co-browsing in the GLOBAL
or ACCOUNT
scope with the configuration property com.unblu.messenger.documentCoBrowsingEnabled.
You must also enable file sharing with the configuration property com.unblu.messenger.fileSharingEnabled, or participants won’t be able to upload files for document co-browsing.
General configuration options
For information on general configuration options, refer to the section General configuration options of the article Configuring and manipulating collaboration layers.
Document co-browsing configuration properties
This section only deals with configuration properties that affect how users may leverage document co-browsing. For information on configuring the Rendering Service, refer to the article Configuring the Unblu Rendering Service. |
Review the following configuration properties in your conversation templates to configure document co-browsing according to your needs:
-
com.unblu.conversation.feature.documentCoBrowsingEnabled: Enable document co-browsing in the conversation template.
-
com.unblu.conversation.file.allowFileCobrowsing: Participant types allowed to launch a document co-browsing session from the menu that appears when they hover over a file uploaded in a chat. If a participant’s type isn’t listed, they can participate in document co-browsing sessions but not launch them for a particular document.
-
com.unblu.conversation.collaboration.approval.approveActivateDocument determines whether the context person must approve launching a document co-browsing layer.
-
com.unblu.conversation.collaboration.action.allowMarkInDocumentCobrowsing: Specify which participant types may use mark mode during document co-browsing.
-
com.unblu.conversation.collaboration.approval.approveMarkDocument: Types of participant whose use of mark mode requires the assigned agent’s approval.
-
com.unblu.conversation.collaboration.action.allowRemoteControlInDocumentCobrowsing: Participants types allowed to use remote control.
-
com.unblu.conversation.collaboration.approval.approveRemoteControlDocument: List of participant types for whom the assigned agent must approve the use of remote control.
-
com.unblu.conversation.collaboration.action.allowStopDocumentCobrowsing: The participant types who may stop a document co-browsing session.
Like universal co-browsing, document co-browsing takes place in a Chromium browser running in headless mode. Participants can thus co-browse files formats supported by Chromium, such as PDF files or images.
Using document co-browsing with files of a type other than PDF relies on third-party services and involves uploading the files to the servers of those third parties. For more information, refer to the data security section of the Rendering Service deployment documentation and the section on supported file types in the introduction to Collaboration layers. |
Document storage options
Most conversation data are stored in a relational database. Depending on how heavily you use document co-browsing, this may not be a suitable solution for you. Fortunately, you can configure Unblu to use Amazon S3 or a compatible service like min.io as a document storage. For more information, refer to Setting up a dedicated document storage.
See also
-
Document co-browsing depends on the Rendering Service. For information on configuring the Rendering Service, refer to Configuring the Rendering Service.
-
For information on setting up a document storage solution, refer to Setting up a dedicated document storage.*