Symphony Messaging Dev Docs
Developer CertificationREST API
  • Start Your Developer Journey
  • Bots
    • Building Bots
    • Planning Your Bot
      • Conversational Bot
      • Interactive Bot
      • Headless Bot
    • Getting Started
      • Getting Started with BDK
      • Creating a Service Account
      • Configuration
      • Truststores
    • Overview of REST API
      • REST API Architecture
      • Overview of Pod API
      • Overview of Key Manager API
      • Overview of Agent API
      • Bot Permissions
      • REST API Reference
    • Authentication
      • RSA Authentication Workflow
      • Certificate Authentication Workflow
    • Datafeed
      • Real-Time Events
      • Overview of Streams
    • Messages
      • MessageML
        • MessageML Basics
          • Content Grouping
          • Text formatting and semantics
          • Tables
          • Images
          • Tags and mentions
            • Enhanced tags notice
          • Style Attributes
          • Special Characters
          • Emojis
        • Elements Interactive Forms
          • Buttons
            • Icon set for Buttons
          • Text Field
          • Masked Text Field
          • Text Area
          • Checkbox
          • Radio Button
          • Dropdown Menu
          • Person Selector
          • Room Selector
          • Date Picker
          • Time Picker
          • Timezone Picker
          • Table Select
          • Regular Expressions - Regex
        • Extensibility UI Actions
          • OpenChat
          • Dialog
        • Entities
          • Standard Entities
          • Custom Entities
      • PresentationML
    • Bots Best Practices
    • Open Source Code Samples
  • Extension Apps
    • Building Extension Apps
    • Planning Your App
    • Getting Started
      • Getting Started with ADK
      • Application Manifest Bundle
      • Add an Extension App to a Symphony Pod
    • Overview of Extension API
      • Initialization
      • Register and Connect
      • Extension API Services
        • Service Interface
        • Register and Subscribe
        • Modules Service
        • Entity Service
          • Entity Advanced Templating
          • Message Format - ExtensionML
        • Applications-Nav Service
        • Share Service
        • Commerce Service
        • Dialogs Service
        • UI Service
          • Receiving Conversation and User Information
          • Filter Function
    • App Authentication
      • Circle of Trust Authentication
      • OBO Authentication
  • Developer Tools
    • Symphony Messaging Generator
    • Bot Developer Kit for Java
      • Build a Conversational Bot
      • Build an Interactive Bot
      • Build a Headless Bot
      • Integrate a Bot with an Identity Provider
    • Bot Developer Kit for Python
    • App Developer Kit
      • Build a Basic Extension App
      • Build an Extension App with App Views
        • Add Buttons and Handlers to an Extension App
        • Add BDK to an Extension App for Circle of Trust
      • Build an Extension App with Message Renderers
    • Postman
    • UI Style Guide
      • Colors
      • Form Elements
      • Buttons
  • Embedded Modules
    • Symphony Messaging URI
      • Symphony Messaging URI for Mobile (deprecated)
    • Desktop interoperability
      • FDC3 intents
        • Message format
      • Configuration guide
        • Configure Interop.io
        • Configure Here Core
        • Configure Finsemble
        • Configure with Embedded Mode
        • Troubleshooting
      • Change log
    • Embedded Mode
      • Get started
      • Configuration parameters
      • Open a chat
      • Send a message
      • Create a room
      • Pin a message
      • Notifications
      • Support for extension applications
      • Open an app
      • Embedded Mode with Sponsored Access
      • Pricing tiers
      • Logout
    • Universal Webhook
      • User guide
        • Example with Splunk
      • Installation guide
  • Symphony REST API
    • Messaging REST API
    • Federation
    • Sponsored Access API
    • Enhanced Directory API
  • Developer Certification
    • Developer Certification
  • Mobile Frameworks
    • Blackberry
    • MobileIron
  • Admin Guides
    • Change Logs
      • API Agent
        • Agent - 25.3 (LTS)
        • Agent - 24.12 (LTS)
        • Agent - 24.9 (LTS)
        • Agent - 24.6 (LTS)
        • Archives
          • Agent - 24.11
          • Agent - 24.10
          • Agent - 23.9 (LTS)
          • Agent - 24.8
          • Agent - 24.3 (LTS)
          • Agent - 24.2
          • Agent - 24.1
          • Agent - 23.12 (LTS)
          • Agent - 23.11
          • Agent - 23.10
          • Agent - 23.7
          • Agent - 23.6 (LTS)
          • Agent - 23.4
          • Agent - 23.3 (LTS)
          • Agent - 23.1
          • Agent - 22.12 (LTS)
          • Agent - 22.11
          • Agent - 22.10
          • Agent - 22.9 (LTS)
          • Agent - 22.8
          • Agent - 22.7
          • Agent - 22.6 (LTS)
          • Agent - 20.14
          • Agent - 20.13
          • Agent - 20.12
          • Agent - 20.10
          • Agent - 20.9 (2.62)
          • Agent - 20.7 (2.61)
          • Agent - 20.6 (2.60)
          • Agent - 20.5 (2.59)
          • Agent - 20.4 (2.58)
      • SBE (Pod API)
        • SBE - 24.1
        • SBE - 20.16
        • SBE - 20.15
        • Archives
          • SBE - 20.14
          • SBE - 20.13
          • SBE - 20.12
          • SBE - 20.10
          • SBE - 20.9 (1.62)
          • SBE - 20.7 (1.61)
          • SBE - 20.6 (1.60)
          • SBE - 20.5 (1.59)
          • SBE - 20.4 (1.58)
      • Client 2.0 APIs
        • Client 2.0 - 25.05
        • Client 2.0 - 25.03
        • Client 2.0 - 24.12
        • Client 2.0 - 24.05
        • Client 2.0 - 23.02
        • Client 2.0 - 22.11
        • Archives
          • Client 2.0 - 20.4
          • Client 2.0 - 20.5
          • Client 2.0 - 20.6
          • Client 2.0 - 20.7
          • Client 2.0 - 20.9
          • Client 2.0 - 20.10
          • Client 2.0 - 20.12
          • Client 2.0 - 22.8
          • Client 2.0 - 22.10
      • Universal Webhook
        • Univ Webhook - 2.6
        • Univ Webhook - 2.4
        • Univ Webhook - 2.2
        • Univ Webhook - 2.1
        • Univ Webhook - 2.0
    • API Change Management
    • Global Throttling
    • Agent Guide
      • Network Topology
      • Agent Download
      • Agent Installation
      • Agent Configuration Fields
      • Agent Server High Availability
      • Agent Performance Tuning
Powered by GitBook
On this page
  • What is Embedded Mode?
  • Configure your FDC3 platform
  • Modes
  • Get started quickly with Here core

Was this helpful?

Export as PDF
  1. Embedded Modules
  2. Desktop interoperability
  3. Configuration guide

Configure with Embedded Mode

What is Embedded Mode?

Symphony Messaging's Embedded Mode allows you to embed Symphony Messaging as a FDC3 enabled web component on your desktop platform.

Reminder: Embedded Mode is available as an add-on to the Symphony Services, and is subject to additional charges, terms, and Symphony review of your use case.

We recommend loading Embedded Mode automatically at startup and always keep it on. It may also be possible to configure your desktop platform so that if the user closes the Embedded Mode window, the web app gets hidden instead of closed.

Configure your FDC3 platform

Depending on your platform, the following steps will slightly differ. However the configuration will roughly consist in the following steps:

  • Create a new app, that you can name "Symphony Messaging".

  • The platform needs to provide the FDC3 API to Symphony Messaging using the window.fdc3 object. This option may be named Inject FDC3 depending on your platform.

  • Configure the FDC3 version: Symphony Messaging supports FDC3 API version 1.2 and 2.0.

  • Configure the load URL of Symphony Messaging. This URL depends on the mode that best suits your use case: Focus mode or Collaboration mode.

Modes

Two modes are supported.

  • The Focus mode, that displays a single view. The chat list is not visible. The Focus mode is very compact.

  • The Collaboration mode, which looks like a simplified version of the Symphony Messaging desktop app (SDA). The user has access to the usual chat list, can navigate, search, and perform most actions available in the desktop app.

Depending on what you want to do, one mode may be more adapted than the other.

Load URL for Focus mode

Configure the following load URL in your FDC3 platform:

https://{your_pod_url}.symphony.com/apps/embed?partnerId={partnerId}&container=true&mode=dark&condensed=true

In Focus mode, Symphony Messaging will not show the usual chat list. On startup, a landing page will be displayed instead.

Please note the presence of the container parameter and the absence of the streamId parameter.

Not all FDC3 intents may be available in Focus mode.

Load URL for Collaboration mode

In collaboration mode the user is able to navigate between his chats and can also start a new chat.

Configure the following load URL in your fdc3 platform:

https://{your_pod_url}.symphony.com/apps/client2?embed=true&partnerId={partnerId}&mode=dark&condensed=true

Once your configuration is complete, please have a look at our Troubleshooting guide to validate that everything is working.

Broadcasts from Action buttons are not supported in Embedded Mode.

Get started quickly with Here core

Last updated 1 month ago

Was this helpful?

To open a first chat or to navigate to another chat, you can raise a intent. Symphony Messaging will automatically display the specified chat conversation.

Loading Symphony Messaging in Embedded Mode requires apartnerId to be passed along in the load URL. More info on Partner Id is available .

If you are using the Here Core platform, you can see an example of how to setup Symphony Messaging Embedded Mode in Here Core (previously known as OpenFin Workspace) in the .

following GitHub page
ViewChat
here