Configuring Unblu Branch

Basic configuration

To enable Unblu Branch, set com.unblu.messenger.branchEnabled to true.

This lets you configure Unblu Branch in the scope or scopes you want. It also lets you configure conversation templates for Unblu Branch.

Specify which conversation template to use for Branch client requests in com.unblu.conversation.template.branchClientRequestTemplateId.

Branch client configuration

A Branch client is a device in a branch office that visitors use to access Unblu.

You can specify which languages Branch clients are available in with the configuration property com.unblu.branchclient.serviceinformation.availableLanguages. If you don’t set the property, visitors can select any of the Unblu account’s languages.

Changes to the property are reflected in the frontend in real time.
The configuration property com.unblu.branchclient.serviceinformation.availableNamedAreaIds lists the named areas that can be selected in the Branch client frontend before a visitor starts a conversation.

Changes to the property are reflected in the frontend in real time.
By default, Unblu displays notifications for new messages in the Unblu UI on the Branch client. To disable these notifications, set com.unblu.si.branchclient.ui.enableNotificationUi to false.
To display the action bar in the Branch client set com.unblu.si.branchclient.ui.displayActionBar to true.
You can allow agents to access a Branch client without taking part in an ongoing conversation on the device in question. This can be useful if, for example, the agent is going to transfer a conversation to another Branch client and wants to be certain there’s nobody in the room where the device is located.

To enable the Branch client preview feature, set com.unblu.branch.allowPreviewOfEmptyBranchClients to true.

Branch UI

The properties below specify how Unblu Branch should appear in various Unblu UIs.

The order of branch address elements such as street, town, and postal code is defined in com.unblu.conversation.branch.branchAddressOrder. Address elements that don’t exist for a branch are skipped.
com.unblu.queue.ui.branchClientIconBackground Item icon background color for branch client requests
com.unblu.desk.ui.branchClientIconBackground Background color of branch client conversation tab icon

Lower third

The lower third is available in Unblu Branch to display additional information about the person visitors are speaking with. For further information, refer to Lower third in Configuring audio and video calls.

Technical configuration properties

To configure Unblu Branch clients, a Branch technician must access the device, either in person or by some means of remote access.

Branch technicians are users with the WEB_USER role. If they weren’t, they wouldn’t be able to access the Collaboration Server from a public network endpoint. As a result, you must set com.unblu.branch.makeVisitorBranchClientTechnician to true for them so they can access the Branch client setup page.

Only set this configuration property for users who should be able to access the Branch client setup page.

com.unblu.branch.client.setup.defaultBranchClientBaseUrl: If your Branch clients all use the same base URL, prefilling the Base URL input field on the Branch client setup page makes the Branch technician’s job just that little bit simpler and less error-prone.
To allow participant types to transfer a conversation from one Branch client to another, add them to com.unblu.conversation.branch.transferToBranchClient.

The configuration property is in the CONVERSATION_TEMPLATE scope.
The name of the cookie for the Branch client person source ID is defined in com.unblu.branchclientsession.personSourceId.cookieName.
com.unblu.si.branchclient.ui.keyEventPropagationMode defines whether to propagate keyup, keydown, and keypress events from the Unblu Embedded Visitor UI component to elements further up the DOM tree.