Mircom TX3 Series MiConnect Administrator Manual

Table of Contents

• 1. Introduction
• 1.1 MiConnect
• 1.2 MiEntry
• 1.3 Mircom SIP Service
• 1.4 Additional Documentation
• 1.5 Terms
• 2. Administrators
• 2.1 Dashboard
• 2.2 Account(s)
• 2.3 Child Accounts
• 2.4 Locations
• 2.5 Devices
• 2.6 Residents
• 2.7 Inventory
• 2.8 Reporting
• 2.9 Configuration
• 3. Warranty and Warning Information

Introduction

This manual explains how to use Mircom's MiConnect portal.

For warranty and special notices, see section 3.

This chapter explains:

• MiConnect
• MiEntry
• Mircom SIP Service
• Additional Documentation
• Terms

1.1 MiConnect

The MiConnect portal is Mircom's online center for the management, monitoring, and configuration of its online services. The portal is for Mircom dealers and their customers, such as building managers and resellers.

1.2 MiEntry

Mircom's MiEntry is an app for Android and iOS that provides SIP voice and video calling with TX3 voice entry products. MiEntry allows residents to verify the identity of their guests with live video and audio. The app requires the Mircom SIP Service to receive calls from the lobby panels.

1.3 Mircom SIP Service

The Mircom SIP Service supports audio calls, video calls, and push notifications. Mircom has two SIP services for two different applications: MiVoIP and MiEntry SIP service.

1.3.1 MiVoIP

Telephone Entry Systems can be fitted with a VoIP adapter (ATA) to provide the voice communications from the telephone entry panel to any cellular, home, or business phone. The VoIP adapter is a simple plug-and-play device that automatically makes all the required connections. A Mircom SIP Service subscription is required for activation.

1.3.2 MiEntry SIP service

MiEntry SIP service is the most reliable SIP service for the MiEntry application. It supports both audio and video communication as well as push notifications. All usage can be monitored using the MiConnect portal. The MiConnect portal also allows creation, cancellations, and suspension of the MiEntry users.

1.4 Additional Documentation

These documents are available on http://www.mircom.com:

• LT-6638 TX3 MiEntry Manual
• LT-6679 MiVision Manual
• LT-6673 SPA112 Installation Guide
• LT-1194 TX3 Nano Configuration Manual
• LT-600213 IP Telephony Guide
• LT-995 TX3 System Configuration and Administration Manual
• LT-6637 TX3 Nano Installation Manual
• LT-600212 TX3-NANO-BB Installation Instructions
• LT-969 TX3 Telephone Access System Installation and Operation Manual
• LT-6906 UL TX3-CX Card Access System Manual
• LT-6082 Unified Building Solution Administration Guide

1.5 Terms

Analog telephone adapter (ATA): An ATA is a device that connects a traditional analog device, such as a telephone line, to a TCP/IP network.

Local Area Network (LAN): An IP network in a limited area, such as a building, that all the devices are connected to.

Registered: All devices that use SIP must be registered with the same SIP server.

SIP (Session Initiation Protocol): A protocol for controlling voice and video communication over an IP network.

SIP account details: A SIP username, SIP password, and address of the SIP server.

SIP Client: SIP clients are devices that communicate with each other using SIP.

SIP Server: A computer or program that monitors and establishes the call between SIP clients.

SIP Trunk: A method of connecting SIP clients to the PSTN or cellular network.

SIP Username: Every SIP client has a unique SIP username.

SIP Password: Every SIP client has a password for registering with the SIP server.

TCP/IP: The group of protocols that specify how computers communicate with each other over the Internet.

VOIP: Voice over IP.

Administrators

This portion of the site is only for users who have administrator access.

This chapter explains the following features:

• Dashboard
• Account(s)
• Child Accounts
• Locations
• Devices
• Residents
• Inventory
• Reporting
• Configuration

Note: Access to the options listed above varies based on the user account type. Different user roles (for example dealers, building managers, resellers) may have different permissions.

2.1 Dashboard

The dashboard has a top menu option panel and quick action blocks. The quick action blocks have numbers for reference. For example, the number 49 in the Accounts block means that there are 49 accounts.

Figure 1: Dashboard (Administrators) displays an overview of accounts, phone adapters, devices, and locations.

2.2 Account(s)

An account represents an organization. An account can have several users associated with it.

2.2.1 Add New Account

To add a new account:

1. Click Account(s) in the top panel, then click Add New Account.
2. The Account window appears.
3. Fill out the required fields, including Company Name, Account Type, Status, Account Level, and Profile information (First Name, Last Name, Phone, Email, Address, etc.). Fields marked with an asterisk (*) are mandatory.
4. Click the Save Changes button to save the account.

After saving, an email confirmation is sent to the account's email address for verification. The user must verify their email address. If not received, a 'Resend Email Confirmation' button is available.

Once saved, you can access tabs for Users, Locations, Devices, Residents, Delegates, and Child Accounts.

2.2.2 Add New User

To add a user to an account:

1. On the Users tab, click the Add New User button.
2. Fill out the required fields, including Account, User Name/Login, First Name, Last Name, Email Address, and select System Roles. Fields marked with an asterisk (*) are mandatory.
3. Click the Save Changes button to add the user.

An email confirmation is sent to the user for verification and password creation.

2.2.3 Edit Existing Account

To edit an existing account:

1. Click Accounts > Existing Accounts from the top menu panel.
2. The list of existing accounts appears. Filter by location using the Provinces/States menu if needed.
3. Click an account to edit it.
4. Edit the account profile following the instructions in section 2.2.1.
5. To edit or add users, locations, devices, residents, delegates, and child accounts, use the corresponding tabs.
6. Click the Save Changes button when done.

2.2.4 Users

To manage users for an account:

1. Click the Users tab to view and add new users.
2. To edit a user, click the user and follow instructions in section 2.2.2.
3. To add a user, click Add New User and follow instructions in section 2.2.2.

2.2.5 Locations

To manage locations for an account:

1. Click the Locations tab to view and add new locations.
2. To edit a location, click it and follow instructions in section 2.4.1.
3. To add a location, click Add New Location and follow instructions in section 2.4.1.

2.2.6 Devices

To manage devices for an account:

1. Click the Devices tab to view and add new devices.
2. To edit a device, click it and follow instructions in section 2.5.1.
3. To add a device, click Add New Device and follow instructions in section 2.5.1.

2.2.7 Residents

To manage residents for an account:

1. Click the Residents tab to view and add new residents.
2. To edit a resident, click it and follow instructions in section 2.6.1.

2.2.8 Delegates

Delegates can be granted permission to add or remove residents for buildings without transferring ownership. To manage delegates:

1. Click the Delegates tab.
2. To edit a delegate, click the Edit button.

2.3 Child Accounts

A child account is a subdivision of an organization or a related organization with its own users and locations. It inherits permissions from the parent account.

1. In the Accounts screen, click the Child Accounts tab.
2. To edit a child account, click the desired child account.

The Edit Child Account screen allows editing of Company Name, Company Number, Dealer Number, Account Type, Status, Account Level, Parent Account, MiEntry Provider, PSTN Provider, and Approved status. Click Save Changes to apply modifications.

2.3.1 Child account profile

Edit the child account's profile by clicking the Profile tab and filling in details such as First Name, Last Name, Phone, Email Address, and Address.

2.3.2 Child account users

To manage users for a child account:

1. Click the Users tab.
2. To edit a user, click the user. The Edit User screen allows modification of Account, Password, First Name, Last Name, Position, Email Address, and System Roles.
3. Click Save Changes.
4. To remove a user, click the Remove User button and confirm.
5. To add a user, click Add New User and fill in the required details.

2.3.3 Child account locations

Manage locations for a child account by clicking the Locations tab, then editing or adding locations as per section 2.4.1.

2.3.4 Child account devices

Manage devices for a child account by clicking the Devices tab, then editing or adding devices as per section 2.5.3 and 2.5.1 respectively.

2.3.5 Child account residents

Manage residents for a child account by clicking the Residents tab, then editing or adding residents as per section 2.6.1.

2.3.6 Child account delegates

Manage delegates for a child account by clicking the Delegates tab and editing as per section 2.2.8.

2.3.7 Remove a child account

In the Edit Child Account screen, click the Remove Account button and confirm by clicking OK.

2.4 Locations

A location represents a building. Locations can be added to an account.

2.4.1 Add New Location

To add a new location:

1. Click Location > Add New Location from the top menu panel.
2. Fill out the Location: New Location form, including Location Name/Designation and Owner. Fields marked with an asterisk (*) are mandatory.
3. In the Physical Address tab, fill in Street Number, Street Name, Unit No, Country, City, Province / State, and Postal Code.
4. Navigate to the Installed Devices tab to edit devices (section 2.5.3) or add new devices (section 2.5.1).
5. Navigate to the Residents tab to add new residents as per section 2.6.1.
6. In the Prices tab, enter the reseller's price per user.
7. In the MiVision Licenses tab, create a site license if needed. A license key is required for MiVision to communicate with the site. Select Enabled or Disabled for the status.

2.4.2 Edit Existing Location

To edit an existing location:

1. Click Locations > Existing Locations from the top menu panel.
2. The list of existing locations appears. Filter by account using the Accounts menu.
3. Click a location to edit it. The procedure is the same as adding a location (section 2.4.1).

2.5 Devices

Devices can be added to an account and a location to track installations.

2.5.1 Add New Device

To add a new device:

1. Click Device > Add New Device from the top menu panel.
2. Fill out the Device: New Device form, including Device Type, Serial Number, MAC Address (if applicable), Account, Warranty, Installed Location, Label, Status, and Ownership. Fields marked with an asterisk (*) are mandatory.
3. Click the Save Changes button to save the device.

2.5.2 Register Multiple New Devices

To add multiple devices of the same type:

1. Click Devices in the top panel, then click Bulk Add Devices.
2. Fill out the Register Multiple New Devices form, including Device Type, Number of Devices, Warranty, and Serial Number and MAC Address for each device.
3. Click Save Changes.

2.5.3 Edit Existing Device

To edit an existing device:

1. Click Devices > Existing Devices from the top menu panel.
2. The list of existing devices appears. Filter by Account, Type, Location, or MAC / Serial.
3. Click a device to edit it. The procedure is the same as adding a device (section 2.5.1).

Table 1: Cisco SPA112 and Grandstream HT801/HT802 Device Details provides information on Device Type, Serial Number, MAC Address, Account, Warranty, Installed Location, Label, PSTN Provider, DID Number, Display Name, Provisioning Status, Last Communication, Timezone, Device Lock, Status, Ownership, Device Expiration, Device Activated, Hardware, Firmware, Last Reboot, IPv4, IPv6, Load Device Information, Date Sold, Date Leased, and Notes.

Table 2: TX3 Device Details provides information on Device Type, Serial Number, Account, Warranty, Installed Location, Label, MiEntry Provider, MAC Address, SIP Username, Auth Username, SIP Password, SIP Domain, and SIP Proxy Domain.

2.6 Residents

Residents can be added to an account.

2.6.1 Add New Resident

To add a new resident:

1. Click Residents in the top panel, then click Add New Resident.
2. Fill out the Resident: New Resident form, including Account, First Name(s), Last Name(s), Phone, Mobile, and Email. Fields marked with an asterisk (*) are mandatory.
3. Click the Save Changes button to save the resident.
4. When the resident is saved, the Residency and MiEntry Accounts tabs appear. Click the Residency tab, then click Add Resident to Building.
5. Fill in Building, Unit, and Primary Residence details.
6. Click the Add Residency button.
7. Click the MiEntry Accounts tab. If the resident does not have a MiEntry account, click Add MiEntry Account.

2.6.2 Edit Existing Resident

To edit an existing resident:

1. Click Residents > Existing Residents from the top menu panel.
2. The list of existing residents appears. Filter by account using the All Accounts menu.
3. Click a resident to edit it. The procedure is the same as adding a resident (section 2.6.1).

2.7 Inventory

Inventory lists devices and vendors.

2.7.1 Inventory

Refer to section 2.5.3 for device management.

2.7.2 Vendors

To manage vendors:

1. Click Inventory in the top panel, then click Vendors.
2. The list of existing vendors appears.
3. Click Add a Vendor to add a new vendor.
4. Fill out the My Vendor: New form, including Vendor Name, Account #, Phone, Fax, Email, Website, Billing Information, and Shipping Information. Only Vendor Name is mandatory.
5. Click Add a Contact to add a contact to the vendor, then click Save.
6. In the Invoices section, add an invoice by entering the Invoice Number, selecting the Invoice Date, and choosing a file to upload.
7. Click the Save button to save the vendor.

To edit an existing vendor, click the vendor in the My Vendors list. The procedure is the same as adding a vendor (page 31).

2.8 Reporting

The Reporting feature allows downloading event logs and billing logs.

2.8.1 View Event Log

To view the event log:

1. Click Reporting > View Event Log from the top menu panel.
2. Select a From date and a To date, then click Generate Report to download the report as a CSV file.

2.8.2 View Billing Log

This feature is not used.

2.8.3 View Billing Log V2

To view Billing Log V2:

1. Click Reporting > View Billing Log V2 from the top menu panel.
2. Select a date, then click Load Report.

2.8.4 DID Report

The DID report shows active DIDs (direct inward dialing numbers) assigned to SPA112 and HT801/HT802 devices.

1. Click Generate PDF or Generate CSV to download the report.

2.9 Configuration

2.9.1 Add New Users

This feature is the same as section 2.2.2.

2.9.2 Existing Users

To manage existing users:

1. Click Configuration > Existing Users from the top menu panel.
2. The screen displays existing users. To edit a user, click the user and follow instructions in section 2.2.2. This screen also allows resending user email verification.

2.9.3 Manage Roles and Permissions

There are eight roles:

• Super Administrator
• Administrator
• Installer
• Property Manager
• Reseller
• Tech Support
• Outside Tech (View Only)
• API Access

Click a role to change its permissions or click Add New Role to create a new role. Type a Role Name and Description, then select the permission for the role. Click Save Changes.

2.9.4 Manage Account Types

This feature is not used.

2.9.5 Manage Help Tooltips

This feature is not used.

Warranty and Warning Information

WARNING!

Please read this document CAREFULLY, as it contains important warnings, life-safety, and practical information about all products manufactured by the Mircom Group of Companies, including Mircom and Secutron branded products, which shall include without limitation all fire alarm, nurse call, building automation and access control and card access products (hereinafter individually or collectively, as applicable, referred to as “Mircom System”).

NOTE TO ALL READERS:

1. Nature of Warnings: The warnings are communicated out of caution and create no legal obligation for Mircom Group of Companies. This document shall NOT be construed as altering the rights and obligations of the parties.
2. Application: The warnings apply to all Mircom Systems and should be read in conjunction with the product manual, legal documents for purchase and sale, and other relevant information.
3. Security and Insurance: No Mircom System is a substitute for property or life insurance. Building automation systems are not to be used as fire, alarm, or life-safety systems.

NOTE TO INSTALLERS:

Mircom Systems are designed to be effective but may not provide protection in all circumstances. Installers must inform customers of potential failure modes.

1. Inadequate Installation: Systems must be installed according to applicable codes and standards, requiring inspection and approval by the local authority having jurisdiction.
2. Inadequate Testing: Regular testing and maintenance are crucial. The complete system should be tested after events like fires, storms, or construction.

NOTE TO USERS:

Mircom Systems are designed to be effective but may not provide protection in all circumstances. Users can minimize risks through proper training, testing, and maintenance.

1. Inadequate Testing and Maintenance: Systems require periodic testing and preventative maintenance as per best practices, local codes, and regulations.
2. Improper Operation: Users must be trained in correct operation and alarm response procedures.
3. Insufficient Time: Occupants may not be protected if they cannot respond to warnings in a timely manner.
4. Carelessness or Safety Hazards: Detectors may not provide timely warnings for fires caused by carelessness or specific hazards.
5. Power Failure: Some components require AC power. Interruptions can render devices inoperative and may cause damage. A system test is required after power restoration.
6. Battery Failure: Batteries must be charged, in good condition, and installed correctly. Replaceable batteries have a limited lifespan affected by environment and usage. Regular testing and replacement are vital.
7. Physical Obstructions: Motion sensors must be kept clear of obstacles. Signal communication can be affected by physical items or interference.
8. Wireless Devices Placement Proximity: Wireless devices require specific placement relative to metal objects and other devices, consulting the system manual for guidelines.
9. Failure to Trigger Sensors: Systems may fail if sensors are not triggered by events like fire or movement, especially if they occur out of sensor range or behind obstructions.
10. Interference with Audible Notification Appliances: Other noise sources may interfere with audible alarms. Alarms may not be heard by hearing-impaired individuals.
11. Other Impairments: Walls or doors may obstruct alarm notification appliances. Alarms may not be heard on different levels.
12. Software Malfunction: No warranties are provided for software components. Refer to standard Terms and Conditions for details.
13. Telephone Line/Network Malfunction: System failure can occur if telephone lines/networks are unreliable, compromised, or unavailable.
14. Component Failure: Systems may fail due to component failure despite efforts for reliability.
15. Integrated Products: Mircom Systems may not function as intended if connected to non-compatible products. A list of compatible products is available.
16. Auto Configuration: The Auto Configuration feature provides an initial setup. End users are responsible for reviewing and customizing the configuration to meet site-specific requirements. Mircom disclaims liability for issues arising from failure to customize.

Warranty

Purchase of all Mircom products is governed by:

• https://www.mircom.com/product-warranty
• https://www.mircom.com/purchase-terms-and-conditions
• https://www.mircom.com/software-license-terms-and-conditions