Skip to main content

First-Time Setup

Back to Mirasys Overview

This guide will walk you through the initial configuration of the eConnect plugin within the Mirasys System Manager Application. Please ensure you have the necessary administrative privileges and eConnect server details before proceeding.


Prerequisites

Before configuration, confirm you have:

  1. System Requirements:

    • eConnect Server: Version 10.2 or higher
    • Mirasys VMS: Version 9.8 or higher
    • Operating System: Windows 64-bit
  2. Administrative Access:

    • Administrative privileges to the Mirasys System Manager Application.
    • Access to modify Service Profile configurations.
  3. eConnect Server Details:

    • The DNS name or IP address of the eConnect server.
    • Network connectivity between Mirasys and the eConnect server.
  4. Required Files:

    • eConnect Spotter Plugin License File: Obtained from Mirasys
    • eConnect.Mirasys.Spotter.Plugin.spi: The client plugin installation file
  5. Licensing Requirements:

    • The eConnect plugin must be purchased from eConnect for use in Mirasys. Contact your eConnect account representative to get this added to your account.
    • A valid Mirasys license for the eConnect Spotter Plugin is required. Contact Mirasys to obtain this license if you don't already have it.

Configuration Steps

Step 1: Install Mirasys License for eConnect Spotter Plugin

License Location

Before configuring the plugin, you must install the proper license from Mirasys:

  1. Obtain License: If you don't have a license for the eConnect Spotter Plugin, contact Mirasys to request one.

  2. Open System Manager Application:

    • Launch the Mirasys System Manager Application
    • Log in with administrative credentials
  3. Access License Management:

    • Navigate to the Licenses section
    • Double-click on the Master License
  4. Import License:

    • Obtain the updated license file from Mirasys (or copy the license text to your clipboard)
    • Click "Import license from clipboard or file"
    • Import your license file or paste from clipboard
    • Verify that "eConnect Spotter Connector" appears in the license list

Step 2: Install eConnect Client Plugin

After the license is applied, install the client plugin:

Install Plugin

  1. Access Add-ins:

    • In System Manager, navigate to "Add-ins"
    • Select "Install Client Plugin"
  2. Install Plugin File:

    • Click the "Add" button
    • Browse and select the "eConnect.Mirasys.Spotter.Plugin.spi" file
    • This will import the eConnect plugin into the Mirasys application
  3. Verify Installation:

    • Confirm the plugin appears in the available add-ins list
    • The eConnect plugin should now be available for profile configuration

Step 3: Open System Manager Application

  1. If not already open, launch the Mirasys System Manager Application.
  2. Log in with administrative credentials.

Step 4: Access Profile Configuration

  1. Navigate to the Profile you want the eConnect plugin to be available for.
  2. This could be your main operational profile or a specific user group profile.

Step 5: Add Plugin to Service Profile Tree

  1. In the Service Profile Tree, locate the plugins section.
  2. Add the eConnect Plugin to the Service Profile Tree.
  3. The plugin should now appear in the available services for this profile.

Step 6: Configure eConnect Server Address

  1. Select the newly added eConnect plugin in the Service Profile Tree.
  2. In the configuration panel, locate the Server Address field.
  3. Enter the eConnect Server Address:
    • Use the hostname or IP address only
    • Do not include http:// or https:// prefixes
    • Example: econnect.yourcompany.com or 192.168.1.100

System Manager Profile Plugin Config

Step 7: Save Configuration

  1. Save the profile configuration.
  2. The eConnect plugin is now configured and ready for use.
  3. Users assigned to this profile will have access to eConnect features.

Verification

To verify the configuration is successful:

  1. Log into the Mirasys client with a user assigned to the configured profile.
  2. Check that the eConnect icon appears in the profile menu.

Profile Tools Icon


Troubleshooting

License import issues:

  • Verify you have administrative privileges in System Manager
  • Ensure the license file is valid and obtained from Mirasys
  • Contact Mirasys support if the license doesn't contain the eConnect Spotter Connector

Plugin installation issues:

  • Verify the eConnect.Mirasys.Spotter.Plugin.spi file is not corrupted
  • Ensure you have administrative privileges to install add-ins
  • Check that the Mirasys license includes the eConnect Spotter Connector before installing the plugin

Plugin not appearing in Service Profile Tree:

  • Verify the eConnect plugin is properly installed in Add-ins
  • Check that you have administrative privileges
  • Restart the System Manager Application if necessary
  • Ensure the license was properly imported before installing the plugin

Cannot connect to eConnect server:

  • Verify the server address is correct (no http/https prefixes)
  • Check network connectivity between Mirasys and eConnect server
  • Ensure firewall rules allow communication on required ports

Users cannot see eConnect features:

  • Verify users are assigned to the correct profile
  • Check that the profile configuration was saved properly
  • Users may need to log out and back in to see new features