Embedded Mode

Embedded Mode allows you to embed Symphony Messaging within your application to provide full collaboration capabilities to your users. Your users can collaborate with half a million people across thousands of institutions on the Symphony network without leaving your platform. This allows you to add Symphony Messaging's secure and compliant chat capabilities to your application, unlocking instant external connectivity and workflow efficiency.

Note: Embedded Mode is available as an add-on to the Symphony Services, and is subject to additional charges, terms, and Symphony review of your Embedded Mode use case. Prior to using Embedded Mode in your Symphony Messaging environment(s), you will need to enter into an Embedded Mode-specific contract. Please reach out to [email protected] to review your use case, discuss the offering, its pricing or for any further information.

Access this page to discover which workflows our Embedded Mode offering can unlock for you, or to contact Sales.

Features

Embedded Mode allows you to embed standalone Symphony Messaging chat modules inside your own websites or any of your solutions that support web views.

It also supports extensive customization and exposes APIs to create rooms or register for notifications.

Some of the advanced features are only available for specific plans.

Access the Resources section, which provides some examples on GitHub, watch our recorded webinar with a live coding session, and get access to a sandbox.

Embedded Mode replaces the previous Embedded Chat Module, which is now deprecated.

Supported browsers

The following browsers are supported:

Edge 90+
Chrome 90+

Focus and Collaboration modes

The Symphony Messaging Embedded Mode supports two modes:

Focus, where a single chat is displayed.

In Focus mode, you can still display several chats on the screen, but each one will be placed in its own module.

Collaboration, where the full list of chat conversations is displayed, allowing the user to switch chat conversations, create a room, search for users or rooms, view unread messages, etc.

When reduced to a width of less than 700px, the Collaboration mode window automatically enters Mini view for a better user experience. Some features, such as extension applications, signals and activity feed, are not available in Mini view mode.

Recommended minimum view size:

Focus mode: Width 312px , Height 348px
Collaboration mode: Width 350px , Height 500px

Configuration parameters

In addition to the Focus and Collaboration modes, it is also possible to configure other aspects of Embedded Mode. For more information, refer to the Configuration parameters.

How to load Embedded Mode

There are several ways to load Embedded Mode, depending on the technical constraints of your web app. For more information, refer to our Get started guide.

Embedded Mode APIs

Once Embedded Mode is loaded, it offers a number of capabilities:

Quickly open an existing chat or create one (more information here).
Send a message to an existing room or to a list of users (more information here).
Keep track of the chat activity, through a notification feed (more information here).
Be informed if the user is active or not (more information here).

Support for extension applications

It is possible to load extension applications in Embedded Mode (more information here).

Resources

Webinar

Watch our webinar that introduces Embedded Mode and shows a live coding session.

Examples

Get started by looking at few Embedded Mode examples in this GitHub repository. One of the examples, index-webinar-demo.html, is covered during the webinar and may be a very good starting point. The other examples assume you are familiar with the React framework.

The Cleverdeal examples are a set of advanced Embedded Mode integrations covering four use cases: Investment, Operations, Research and Wealth. Hopefully one of them will give you a good starting point on how to integrate Embedded Mode in your own portal.

Sandbox

You can access a sandbox version of Embedded Mode, where you can easily test the configuration parameters, the two modes (Focus or Collaboration), as well as initiate a new message. The sandbox is available at: https://{your_pod_url}.symphony.com/embed/sandbox.html

You can load a specific conversation by adding a streamId as a query parameter: https://{your_pod_url}.symphony.com/embed/sandbox.html?streamId=r2z0c14BJnF9bfsUbZRPN3///oP8vpocdA==

Note: You can update the configuration parameters using the settings wheel in the navigation bar.

Last updated 1 year ago

Was this helpful?