Installation Guide

This guide provides step-by-step instructions for installing MiraBridge Phone in a supported CRM environment.

It covers how to prepare your Genesys Cloud environment, construct the widget URL, and configure the CRM to embed the widget.

You will complete the following:

• Prepare your Genesys Cloud environment for embedded softphone usage
• Construct a widget URL using deployment-specific parameters
• Configure the CRM platform to embed the widget

Each step is documented in the sections below.

Prerequisites

Before you begin, ensure you have access to the following:

• Genesys Cloud Admin Account
  Required to configure the Genesys Embeddable Framework.

• CRM Admin Access
  Required to embed the widget into your CRM platform (e.g., CIF, Utility Bar, iframe).

• Deployment Parameters from MiraBridge
  You will receive:
  • deploymentId

  You must also specify:

  • region — based on your Genesys Cloud organization’s region
• Supported Browser
  See the Requirements page for supported browsers.

---

Genesys Setup

Follow these steps to configure the Genesys Cloud environment:

• Install the Embeddable Framework
  Add the Genesys Cloud Embeddable Framework integration and upload the framework.js file.

• Assign Agent Permissions
  Create a custom role and grant necessary permissions to agents.

• Create an OAuth Client
  Register an OAuth client to enable MiraBridge to authenticate securely with Genesys Cloud APIs.

---

Widget URL

• Construct the Widget URL
  Use the provided deploymentId, clientId, and Genesys region to build the URL that loads MiraBridge Phone.

---

Widget Integration

• Embed the Widget in your CRM
  Learn how to load the widget into supported platforms like Dynamics or Salesforce.

---

Best Practices for Installation

Pre-Installation Checklist

Before beginning the installation process:

• Verify all prerequisites are met
• Obtain all required parameters from MiraBridge team
• Schedule installation during low-usage periods
• Have test user accounts ready for validation
• Ensure network connectivity to required domains

Installation Best Practices

• Start with a pilot group: Deploy to 5-10 users initially
• Enable debugging: Use enableDebug=true during setup
• Test thoroughly: Validate all critical workflows before broader rollout
• Document configuration: Keep records of all deployment parameters
• Plan rollback: Have a rollback plan in case issues arise

Post-Installation Validation

After installation, verify:

1. Widget Loading: Confirm the widget appears in the CRM
2. Authentication: Test Genesys Cloud login functionality
3. Basic Features: Validate core telephony features
4. CRM Integration: Test screen pops and data synchronization
5. License Consumption: Monitor license usage patterns

Common Pitfalls to Avoid

• Incorrect OAuth Redirect URIs: Double-check all redirect URIs match exactly
• Wrong Genesys Region: Ensure the region parameter matches your Genesys Cloud organization
• Missing Permissions: Verify all required Genesys Cloud permissions are assigned
• Network Restrictions: Check firewall and proxy settings for required domains
• Browser Compatibility: Ensure all users have supported browsers

---

Getting Help

If you encounter issues during installation:

1. Review our documentation: Check the Troubleshooting Guide
2. Enable debug logging: Add enableDebug=true to your widget URL
3. Collect information: Gather browser console logs and session IDs
4. Contact support: Reach out to MiraBridge support with detailed information

For additional guidance, see our FAQ section which covers common installation questions.