Elemec3 Portal User Manual
Elemec3 Portal User Manual
42004-485A
®
G AI - T R O N I C S C O R P O R AT I O N
A HUBBELL COMPANY
Elemec3 Portal
User Manual – Version 1.2
TABLE OF CONTENTS
Confidentiality Notice .....................................................................................................................1
Overview ..........................................................................................................................................1
Installing and Registering the Software.........................................................................................1
Installation Requirements ................................................................................................................. 1
Installation Procedure ....................................................................................................................... 1
Host Computer IP Address .............................................................................................................4
Running the Portal Application .....................................................................................................4
Connecting to an Elemec3 Controller ............................................................................................. 5
Elemec Portal Security....................................................................................................................7
Defining Users.................................................................................................................................... 7
User Levels ........................................................................................................................................................... 7
User Types ............................................................................................................................................................ 7
Editing Users...................................................................................................................................... 7
Administration Utility Screen .........................................................................................................8
Restart System Button ..................................................................................................................... 10
MSG Button ..................................................................................................................................... 11
System Messages ................................................................................................................................................ 11
Tick Tones Button ........................................................................................................................... 12
Options Button................................................................................................................................. 13
System................................................................................................................................................................. 13
Connection Settings ............................................................................................................................................ 14
Date / Time ......................................................................................................................................................... 14
Sound .................................................................................................................................................................. 14
System Snapshots ............................................................................................................................................... 14
Manage Users Button ...................................................................................................................... 15
User Management Screen ................................................................................................................................... 15
Manage Users Tab .............................................................................................................................................. 15
Manage Permissions Tab .................................................................................................................................... 16
System Snapshots Button ................................................................................................................ 17
System Snapshots ............................................................................................................................................... 17
Switch User ......................................................................................................................................................... 18
Disconnect .......................................................................................................................................................... 18
Administration Button .................................................................................................................... 19
Upload New Configuration ................................................................................................................................. 20
Elemec3 Portal
User Manual – Version 1.2
Confidentiality Notice
This manual is provided solely as an operational, installation, and maintenance guide and contains sensitive
business and technical information that is confidential and proprietary to GAI-Tronics. GAI-Tronics
retains all intellectual property, other rights in or to the information contained herein, and such information
may only be used in connection with the operation of your GAI-Tronics product or system. This manual
may not be disclosed in any form, in whole or in part, directly or indirectly, to any third party.
Overview
The Elemec3 (E3) Portal application runs on any PC connected to the same Ethernet network as the E3
Controller. This software package is used to upload and download system configuration files to/from the
E3 System Controller. The Portal application is not used to make changes to the system configuration.
Changes are made using the Elemec3 Console application. Refer to GAI-Tronics Pub. 42004-483 for
information on system programming.
The Portal application is also used to monitor system activity and status reporting of E3 system
components. System status is displayed in real time. Selection buttons are provided allowing the
operator to filter the information by equipment category or event types. Multiple PCs can run the E3
Portal application, providing more than one monitoring location.
NOTE: Only a single instance of the Portal application can be connected to one E3 Controller at a time,
and only a single instance of the Portal application can run on one PC at a time. In E3 systems containing
redundant controllers, the user must disconnect from Controller “A” before connecting to Controller “B”.
After installing Adobe AIR, the E3 Portal application can be installed as described below.
Installation Procedure
1. Insert the installation CD into the CD drive or insert a USB storage device containing the Elemec3
Portal application installation file.
2. Use Windows Explorer to navigate to the CD or other installation file location and double click on the
ElemecPortal file.
Figure 1.
4. Select the Installation Preferences using the check boxes as shown in Figure 2 and click the
CONTINUE button. The default installation location is displayed.
Figure 2.
Figure 3.
Depending on the network configuration, either static IP or DHCP can be used. If a DNS server is
available, connection can be made using the Elemec3 host name.
Consult with your network administrator for proper configuration of the host computer and Elemec3
system(s).
NOTE: The maximum number of simultaneous Portal connections to an E3 controller is 10. If 10 users
are connected to an E3 controller, subsequent connection requests will be rejected.
If no E3 controllers (or systems) are found, the Elemec Auto Discover FAILED screen as shown in Figure
6 will appear.
Enter the IP Address/Host Name of the E3 system when the screen shown in Figure 7 below appears, and
click the red CONNECT button.
.
Figure 7. Manual Connection screen
Upon successful auto discovery of E3 systems, the screen shown in the example in Figure 8 appears.
Each entry represents a different E3 Controller. The names that appear in the list are the names of the
configuration files that are currently running on an E3 Controller.
Select the desired controller from the list and click the red CONNECT button. The connected system is
referred to as the “local” system.
On any new system, a default Administrator-level user account is provided on the E3 controller with
access to create and configure the system’s other user accounts. The initial login is:
Default username: admin
Default password: password
To maintain the integrity of the E3 controller security, it is highly recommended that this account be
removed once all the necessary users have been set up by the on-site administrator.
Refer to the Manage Users screen on page 15 of this manual for more information.
Defining Users
User Levels
The five user levels listed from lowest to highest permission levels are:
Guest (no password required) – view-only access to system status information.
Viewer – Configurable permissions.
Operator – Configurable permissions.
Maintenance – Configurable permissions.
Administrator – Configurable permissions and can configure permissions for other levels (default).
User Types
In addition to the different user levels, there are two user types: Public and Private:
Public – cannot change their password. By default, passwords must be changed by an Administrator.
For example, maintenance users can be assigned a common username and password.
Private – can change their password. Private user types are recommended for higher access levels.
Editing Users
User permissions are edited through the User Management window shown in Figure 22 on page 15. The
current permissions are displayed upon opening. To edit any specific level, click EDIT at the top of the
column. Refer to the “Manage Users” section on page 15 for more information.
The function of the buttons indicated with “A” through “M” in the example in Figure 9 below are defined
in Table 1 and examples of their use are included in this manual.
Table 1. Elecmec3 System Administration Utility Screen Button Functions & Fault Notification Panel
Event Status Displays the Event Status screen. See the “Event Status Button”
Button section on page 26.
Fault Status Displays the Fault Status screen. See “Fault Status Button” section on
Button page 28 of this manual for details.
Amplifier Displays the Amplifier Status screen. See “Amplifier Status Button”
Status Button section of this manual on page 31 for details.
I/O Status Displays the I/O Status screen. See “I/O Status Button” section on page
Button 33 of this manual for details.
System Flags Displays the System Flag screen. See “System Flag Button” section on
Button page 35 of this manual for details.
Fault
The most recent unacknowledged fault will be displayed in the Fault
Notification
Notification Panel accompanied by an audible tone. Refer to page 28.
Panel
Clicking the RESTART SYSTEM button displays the Confirm Restart window shown in Figure 11.
Restart the System – Click to restart the E3 Controller. RESTART THE SYSTEM only restarts the Elemec
processes. When the system is restarted, all users will be logged off.
Reboot Option – When checked, clicking the RESTART THE SYSTEM button will cause an operating
system reboot in addition to the Elemec processes.
MSG Button
Click the MSG button to display the System Messages screen as shown in Figure 13. The number in
yellow on the button represents the number of unread messages.
Messages Received – Notifications that do not qualify as an event or a fault. They are time and date-
stamped and typically this window displays hardware that is installed but not defined in the system
configuration.
Clear Message Cache – Click to remove messages locally. NOTE: All messages will be removed upon
system startup.
Send Message – A Portal user may send messages to other connected Portal users by typing a message in
the Send Message box and clicking the SEND MESSAGE button.
The Send Tick Tones window allows you to play the Tick Tone to the selected zone and is generally used
for testing the speakers.
NOTE: The Tick Tone is specified using the Elemec3 Console application.
Clicking the green triangular ‘Play’ button broadcasts the Tick Tone to the selected zone.
Tick Tone Status – the zone is shown in red when the Tick Tone is being broadcast.
Options Button
Click the Options button to display the Options window shown in Figure 19 below.
System ID – Displays the system ID: Standalone, Primary (A), or Secondary (B).
Change – Changes which system is being displayed.
Connection Settings
Date / Time
Date/Time Format – Use drop down box to select U.S. or U.K. time format.
System Date/Time – Displays the current date and time in the current format.
Set – Click the red SET button to view the Set Elemec Controller Date/Time screen. Select the date from
the Set Date calendar and the time from the Set Time fields, and then click SET. This is not necessary if
an NTP Server is specified in the configuration.
NOTE: The system will automatically restart after setting the Date/Time.
Play Fault Notification – When checked, a notification tone will be played locally when a fault is
reported.
Play Desconnect Notification – When selected, a notification tone will be played when the connection to
the E3 controller is closed. The tone will continue to repeat at the interval specified by the Repeat
Interval. The tone will not play if the user has manually disconnected from the controller by clicking the
DISCONNECT button.
Repeat Interval – specifies the interval in minutes that the Fault Notification tone will be repeated.
System Snapshots
Clean Status Database on Snapshot – When checked, the database is cleaned to remove all records that
have been previously cleared and/or acknowledged. Each clean operation will create an entry in the
Admin Log identifying the initiator by user and IP address.
The User Management screen provides access to both the Manage Users and Manage Permissions tabs.
From the Manage Users tab, select a specific user from the list on the left to view that user’s details on the
right. The user’s type and level may be edited by selecting the EDIT USER button.
To edit the user’s password, click the red CHANGE PASSWORD button.
Figure 22. User Management screen (with Manage Users tab selected)
From the Manage Permissions tab, click the EDIT button to edit permissions for a specific user level, and
check the appropriate permissions.
The SYSTEM SNAPSHOTS button allows a user to download or to view system snapshots saved to the
local computer. Only users with permission to download configurations can take a snapshot of the
current system.
System Snapshots
A System Snapshot contains the available status at a specific point in time. Additionally, the snapshot
includes two log files: the Admin Log and the Sys Log.
Admin Log – The Admin Log contains all information pertaining to user interaction with the system.
Sys Log – The Sys Log contains operating system messages.
View Snapshot – clicking on VIEW SNAPSHOT displays an existing Snapshot stored on the local
computer.
Switch User
Click the SWITCH USER button, which is always located on the lower right of the Administration Utility
screen, to login as a different user without disconnecting from the system.
Click the DISCONNECT button, which is always located on the lower right of the Administration Utility
screen, to close the network connection to the E3 Controller.
Administration Button
Click the ADMINISTRATION button on the Administration Utility screen to display the Elemec System
Administration screen shown in Figure 29. The ADMINISTRATION button turns blue to indicate which
screen is currently selected.
This screen displays the choices among the configuration options available if the user has the appropriate
permissions. If the user does not have the appropriate permissions, the button is disabled.
Select a configuration from the Available Configurations list. When selected, the configuration is
identified at the Configuration to Upload field near the bottom of the screen.
Click the UPLOAD button, and the Confirm Configuration Upload screen is displayed as shown in Figure
31.
Click UPLOAD CONFIGURATION to continue. If desired, check the Set as Running Configuration and
Restart prior to clicking UPLOAD CONFIGURATION.
Set as Running Configuration and Restart – when checked, the configuration becomes the running
configuration and the system is restarted.
Upon successful upload of the configuration file, the screen shown in Figure 32 will be displayed.
Stored Configurations
The Stored Configurations Panel shown in Figure 33 lists the available configurations stored on the
connected E3 Controller. Configurations are created using the Elemec3 Console application.
Pending – a checkmark indicates a pending change to the running configuration that will take effect upon
System Restart.
Default – a checkmark indicates the failsafe configuration should the running configuration become
corrupt. The Default configuration is archived on the system to ensure configuration integrity.
Click the SET RUNNING CONFIGURATION button to continue. Until a System Restart, the selected
configuration will be shown as “Pending” in the Stored Configurations panel.
NOTE: It is good practice to set a copy of the running configuration as the default.
Remove Configuration
Highlight the desired configuration on the Stored Configurations Panel and click the REMOVE
CONFIGURATION button. The Confirm Configuration Removal screen as shown in Figure 36 will appear.
Click the REMOVE CONFIGURATION button to continue.
Download Configuration
To retrieve a stored configuration from the system controller, highlight the desired configuration from
Stored Configurations Panel and click the DOWNLOAD CONFIGURATION button. The Configuration
Download window as shown in Figure 37 will appear.
When a destination has been selected, click DOWNLOAD. The Confirm Configuration Download screen
as shown in Figure 38 appears. Click the red DOWNLOAD CONFIGURATION button.
Software Versions
Clicking the SOFTWARE VERSIONS button displays the System Build Information window as shown in
Figure 39. By default, the Software tab is displayed.
Update – For Administrator level users, the UPDATE button provides a way to update system software.
Click the red UPDATE button to browse to the specific location of the update file. Any software updates
must be provided by GAI-Tronics and they are identified by the description, version and time stamp.
Figure 40.
Each device in the running configuration and its reported firmware version is listed. The Firmware view
is for information only.
This screen displays the active Events in the system. Events are defined during the system configuration
process.
The system has two audio paths: Audio Mix 1 and Audio Mix 2. When an Audio Mix is in use, the
description of the active event(s) is shown.
Playback Event – If present, displays the description of the Playback Event as defined in the system
configuration.
Playback Attenuated? – When True, playback audio for this Audio Mix is attenuated.
Live Speech Event – If present, displays the description of the Live Speech Event as defined in the
system configuration.
Current Amps – Click the CURRENT AMPS button to display which amplifiers are receiving audio from
this Audio Mix.
Reported Events
Reported Events section lists active events in the system. Clicking the Details button (shown as “…”) for
a specific event displays the Event Details screen associated with that event with the available
information. An example showing a Tick Tone Event is shown in Figure 42.
Description – is the description of the Event Type as entered in the Elemec3 Console configuration.
Routing Status – indicates whether the audio is fully routed, partially routed, or not routed at all due to
audio resource allocation.
Zones Targeted – lists the intended zones for the event regardless of audio resource availability.
Outputs Targeted – lists the configured output activations for the event. Zone aware outputs listed may
not be active.
The Fault Notification Panel is located on the lower left side of the Administration Utility screen and is
shown in Figure 43 above. The panel will appear when a fault occurs and will display the most recent
unacknowledged fault on any system screen. It contains an ACKNOWLEDGE FAULT button.
The System Status LED indicator on the E3 Controller has four states indicating fault status.
Green – indicates there are no active faults in the system.
Orange – indicates there are active Normal faults and no active Urgent faults.
Flashing Red – indicates all active Urgent faults have been acknowledged.
Red – indicates there are unacknowledged Urgent faults in the system.
Scope
Figure 44. System Fault Status screen showing Scope Category Filter drop down box
Status Filter
In addition to the Scope filter, faults can be filtered by the Status Filter:
All – displays all Faults (active, acknowledged and unacknowledged) in the system.
Active Only – are Faults that have not been cleared from the system.
Unacknowledged Only – are active Faults that have not yet been acknowledged.
Shown below are the different Fault Categories and types as defined in the Elemec3 Console
application:
System Fault
Access Panel Fault
I/O Card Fault
Amplifier Fault
Software Fault
External Fault
The Fault Reporting Configuration screen shown in Figure 45 is from the Elemec3 Console and displays
the possible Fault Categories: NOTE: This screen is not available through the Elemec3 Portal
application.
Figure 45. Fault Reporting Configuration screen (from Elemec3 Console software)
Activate Amp Switchover – Click ACTIVATE AMP SWITCHOVER button to transfer control of local
amplifiers to the remote system. When the local system is in control of all amplifiers, the ACTIVATE AMP
SWITCHOVER button is disabled.
Deactivate Amp Switchover – Click DEACTIVATE AMP SWITCHOVER to return control of local
amplifiers to the local system.
The Amplifier Status list displays each amplifier and its current operating condition. Remote amplifiers
will be designated by the [R] prefix.
Fault status – indicates Normal or Faulted status.
Audio Status:
OFF – indicates amplifier is idle.
MIX 1/MIX 2 – indicates amplifier active audio source.
HOT STANDBY – indicates designation as a Hot Standby Amplifier.
Standby – if the amplifier channel is faulted, the configured Hot Standby amplifier description is
displayed.
Standby FOR – If a Hot Standby amplifier is currently in use, the description of the faulted amplifier
channel is displayed.
Status Filter
Scope
Link Status Filters – When checked, the Status Filter selection applies to both the Inputs and Outputs
panels.
Figure 48. System I/O Status screen (showing the I/O Controller selection drop down box)
System Input and Output Status panels display each I/O point in the selected scope and its current state:
ACTIVE
IDLE
FAULTED
INHIBITED
Status Filter
A Status Filter is available on both the Input and Output Status panels.
All – shows all Inputs/Outputs
Active/Faulted Only – Either panel can be filtered to show only the input or output points that are
active/faulted.
Link Status Filters – When checked, the Status Filter selection applies to both the System Flag and User
Flag panels.
The Flag Status panels display each logic flag in the system and its current status: ACTIVE or IDLE.
Active flags are noted with a green indicator.
Status Filter