Main
Developer Certification REST API

Embedded Collaboration Platform

Embedded Collaboration Platform (ECP) allows you to embed Symphony 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's secure and compliant chat capabilities to your application, unlocking instant external connectivity and workflow efficiency.

Note: The Embedded Collaboration Platform (ECP) functionality is available as an add-on to the Symphony Services, and is subject to additional charges, terms, and Symphony review of your ECP use case. Prior to using ECP in your Symphony environment(s), you will need to enter into an ECP-specific contract. Please reach out to sales@symphony.com to review your use case, discuss the offering, its pricing or for any further information.

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

Features

Symphony Embedded Collaboration Platform (ECP) allows you to embed standalone Symphony chat modules inside your own websites or any of your solutions that support web views.

ECP 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.

The Embedded Collaboration Platform (ECP) 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

Symphony ECP supports two modes:

  • Focus, where a single chat is displayed.

  • 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.

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

Recommended minimum view size:

  • Focus mode: Width 312px , Height 348px

  • Collaboration mode: Width 600px , Height 600px

Configuration parameters

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

How to load ECP

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

ECP APIs

Once ECP 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 ECP (more information here).

Resources

Webinar

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

Examples

Get started by looking at few ECP 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 ECP 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 ECP in your own portal.

Sandbox

You can access a sandbox version of ECP, 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