arm dacustomer.alphatechnologies.eu/armada/userguide/... · alpha technologies s.a. avenue...

Alpha Technologies S.A.

Avenue Alexander Fleming 1

B-1348 Ottignies-Louvain-La-Neuve

Belgium

www.alphatechnologies.eu

ARM@DA

ARM@DA MANUAL

Your Power Solutions Partner

1




Belgium


TABLE OF CONTENTS

1 Overview of the Solution ........................... 4

1.1 Introduction ..................................................................................................................... 4

1.2 Architecture ..................................................................................................................... 4

1.3 Application main functions ............................................................................................. 6

1.4 User Interface .................................................................................................................. 8

1.5 Alarm management ......................................................................................................... 9

1.6 Massive Configuration Changes .................................................................................. 10

1.7 Data collection ............................................................................................................... 11

1.8 Backup monitoring configuration ................................................................................ 12

1.9 Web and mobile interface ............................................................................................. 13

1.10 Integration in TNM applications ................................................................................... 15

1.11 Case example: Armada installed in an Italian Telecom Network Operator ............... 16

2 End User License Agreement (EULA) ................. 18

3 Licensing ......................................... 20

4 Requirements ...................................... 22

4.1 Client Requirements ...................................................................................................... 22

4.2 Server Requirements .................................................................................................... 22

5 Administrator Guide ............................... 26

5.1 Server Installation / Upgrade ........................................................................................ 26 5.1.1 Server Service Installation ............................................................................................... 26 5.1.2 Server Service Upgrade .................................................................................................. 40

2




Belgium


5.1.3 Web Site ASP.NET Installation Procedure ...................................................................... 43 5.1.4 Installing the Maps locally on the server .......................................................................... 55 5.1.5 Configure the server as NTP server ................................................................................ 63 5.1.6 Install and configure Cassandra ...................................................................................... 67 5.1.7 Create and configure self signed SSL certificate ............................................................. 68

5.2 Armada .NET Client Installation ................................................................................... 77

5.3 Maintenance ................................................................................................................... 82

5.4 Working with other vendor controllers ........................................................................ 82 5.4.1 How does it work? ........................................................................................................... 83 5.4.2 Example: ......................................................................................................................... 84

5.5 Event Forwarder ............................................................................................................ 88 5.5.1 Example: ......................................................................................................................... 88

6 User Guide ........................................ 93

6.1 First steps in Arm@da .................................................................................................. 93 6.1.1 Main Screen .................................................................................................................... 93 6.1.2 Clusters, Tree-View and list of devices ............................................................................ 94 6.1.3 Cluster-related information .............................................................................................. 98 6.1.4 Tools ............................................................................................................................... 98 6.1.5 Other elements ................................................................................................................ 98

6.2 Cluster-related tabs ....................................................................................................... 99 6.2.1 Map View ...................................................................................................................... 100 6.2.2 View detail ..................................................................................................................... 102 6.2.3 Active alarms ................................................................................................................. 106 6.2.4 Last Events ................................................................................................................... 107 6.2.5 Reports .......................................................................................................................... 108 6.2.6 Data Collection ............................................................................................................. 109

6.3 Client Configuration .................................................................................................... 110 6.3.1 Change connection profile ............................................................................................. 110 6.3.2 Modify My User Profile .................................................................................................. 111 6.3.3 Cluster Tree-View Configuration .................................................................................... 111 6.3.4 Cluster filter ................................................................................................................... 113 6.3.5 Auto-refresh Cluster Treeview and Display activity ........................................................ 114

6.4 Monitoring Devices ..................................................................................................... 115 6.4.1 Add Monitoring Devices ................................................................................................. 116 6.4.2 Manage Monitoring Devices .......................................................................................... 118 6.4.3 Manage Site Locations .................................................................................................. 119

6.5 Operational Tools ........................................................................................................ 122 6.5.1 Multi-Site Modification Tool ............................................................................................ 122

3




Belgium


6.5.2 Upgrade software/firmware ............................................................................................ 127 6.5.3 Force refresh of selected monitoring devices ................................................................. 129 6.5.4 Server jobs status .......................................................................................................... 131 6.5.5 Configuration Template ................................................................................................. 131 6.5.6 Backup Monitoring Configuration ................................................................................... 133

6.6 Reporting Tools ........................................................................................................... 138 6.6.1 New table ...................................................................................................................... 138 6.6.2 Saved table / Configure automatic e-mail report ............................................................ 141 6.6.3 Data Reporting & Charts................................................................................................ 146 6.6.4 Export Cluster Tree-view to Excel .................................................................................. 152

6.7 File Tools ..................................................................................................................... 153 6.7.1 Add file .......................................................................................................................... 153 6.7.2 Link a file to a device ..................................................................................................... 154 6.7.3 View files ....................................................................................................................... 155

6.8 Map Tools..................................................................................................................... 157

6.9 Server Tools ................................................................................................................. 158 6.9.1 User Administration ....................................................................................................... 158 6.9.2 User Group Administration ............................................................................................ 161 6.9.3 Performance Indicators Live .......................................................................................... 167 6.9.4 Performance Indicators Records ................................................................................... 167 6.9.5 Http get jobs configuration ............................................................................................. 168 6.9.6 Powershell script ........................................................................................................... 171

7 Support .......................................... 174

4




Belgium


1 OVERVIEW OF THE

SOLUTION

1.1 Introduction

Arm@da is a network application based on the standard ES 202336. This means that the information of any equipment compliant with the standard will come automatically at the right place and can be used and consolidated without any expensive programming.

A particular benefit of the application is the extreme flexibility and ease to create different clusters of views in the same environment. For example one can create clusters of sites by geographical areas, type of equipment, operator, alarm severity…

Arm@da offers five major functions

Alarm management and easy customizable reporting including selected alarm forwarding to a NOC (Machine to Machine), Email, SMS. The communication of the alarm from the sites to Arm@da is spontaneous and initiated by the sites.

Arm@da allows to easily and remotely apply a software/firmware upgrade or a configuration change to a part or your entire Comp@s cards network.

All sites data recording: HTTP Get data sampling is user defined. The software includes wizard to define consolidation of data, reporting and graphs. All data can be further exported in CSV

Armada allows to backup, restore the configuration of each Comp@s cards of your network.

Document management. The application supports upload of any sort of document and attachment to a site or a cluster of sites

Main Arm@da variables can be translated in multiple languages and each user can select is languages

Arm@da can be interfaced with high level management software with customized engineering work.

1.2 Architecture

Arm@da is a server client application enabling multiple users to access information available on a server. It centralizes all information available on multiples devices into a unique point of contact. The supervision, analyses and remote control of all your company became easier.

5




Belgium


With our great application architecture (see below), each tier can be deployed on one physical server or divided on multiple physical servers. This allows us to support an excellent scalability for large business.

6




Belgium


1.3 Application main functions

Centralized and sophisticated alarms management Alarms and events are sent instantly by sites (comp@s) to Arm@da that centralizes and stores them in its database. Alarm processing can then be extremely sophisticated: from the simple generation of summary reports to clever alarm forwarding. The alarms can be forwarded to a NOC (e.g., IBM Tivoli), by email or SMS.

o Alarm forwarding can be easily customizable :

send sms for some type of alarms

send emails to a specific technicians team only if alarm occurs during a certain time slot (evenings or weekends) and region

…

Cutting edge data reporting : Armada saves historical data from multiple devices, sensors... over a long period. The frequency and sampling precision are configurable by the user. The user can then use its data from predefined reports or create itself its own reports by integrating graphics (wizard)... All saved data can also be exported in Excel.

7




Belgium


Network Manager:

o Massive change: Armada allows to easily updating remotely a part or the whole network of comp@s (software/ firmware update, configuration change).

o Chirurgical change: Arm@da allows you to connect remotely to the comp@s interfaces, address potential problems on a specific comp@s or specific equipment.

Arm@da allows backup and restoring remotely the configuration of each comp@s.

Document management. Arm@da allows to upload various kinds of documents (Word, PDF ...) and to associate them with a site or a cluster.

Fine User Management: Ability to define roles per user

o admin

o account manager

o region manager

o operator

o …

Customizable script : To meet specific demands, we offer Arm@da customers the ability to create and run custom scripts. These custom scripts are a series of commands written in a programming language (PowerShell) that allow interaction with the Arm@da database (detection of new events ...) and perform custom actions (send emails, sms, tweets ...).

8




Belgium


1.4 User Interface

The user interface is a very simple, easy to understand interface based on a matrix structure

In the left column, sites are listed by clusters. The user can easily create and organize clusters on any parameter of his choice and can create views as he likes.

For example in the first view one can decide to organize by geographic area, county, city. In a second view one can decide to have them classified by type of equipment i.e. DC systems, air conditioners, diesel generators. In a third view one can immediately access the sites by alarm level i.e. major, minor, no alarm.

In the horizontal axe, the following information is available:

Network map view: Maps are provided from open source like open street map. A dot is generated for each site based on its GPS coordinates. By selecting a cluster the application automatically includes all sites and only the sites belonging to the cluster. The automatic zoom enables to easily identify their geographic spread. It is obviously possible to zoom and move the map as one likes. Clusters enables direct views but are also used to ease data collection and computation.

When moving the mouse over the site its ID appears in a small pop-up as presented below:

9




Belgium


One can then for example select the site and access to the other functions:

Site description

Site alarm

Site event

Site data collection

Direct access to the Comp@s DGU

…

1.5 Alarm management

The screen is organized the same way than in the web browser of a single site. The example below shows the alarm table for the site 54.

10




Belgium


Providing that the user has the password for that specific function, he will be able to access the site online through the arm@da application. Remote control of levels or relays enable managers to save or delay the need to send a technician on site.

1.6 Massive Configuration Changes

Arm@da allows to easily and remotely apply a software/firmware upgrade or a configuration change to a part or your entire Comp@s cards network.

11




Belgium


1.7 Data collection

The reporting tools are by default applied to the selected cluster but can be applied of course to the entire network. The wizard enables multiple functions on variables such as sum, average, differential etc… As shown in the example below one can see the rectifiers’ output power of the network by province and by month.

12




Belgium


All data can also be transferred in excel files for further analysis.

1.8 Backup monitoring configuration

Arm@da is built to perform a backup/restore of the configuration for a group of monitoring devices.

13




Belgium


1.9 Web and mobile interface

To allow your technicians to monitor the health of your network everywhere, we provide a secure and mobile friendly interface:

14




Belgium


That modern interface will allow your team to have a remote and easy access to each site controllers of your network. Your team will be able to take remote actions to decrease unnecessary travel expenses.

15




Belgium


And of course, keep track of historical data with customizable chart and figures.

1.10 Integration in TNM applications

Am@da offers multiple opportunities of integration with other software.

Alarms can be forwarded by email or SMS (when connected to an appropriate server)

All data and information can be downloaded in CSV files

Arm@da can be synchronised with a higher level network management system. This enables power and environmental engineers to work with their own platform with detailed information while the NOC can continue to receive and treat most appropriate alarms. An example is sketched below.

16




Belgium


1.11 Case example: Armada installed in

an Italian Telecom Network

Operator

In collaboration with the operator, we perform the supply, the installation and the network management of more than 17000 remote sites using embedded Comp@s for remote powering and Arm@da. We setup the integration of Arm@da in the operator Network management platform including their IBM Tivoli NOC system.

17




Belgium


18




Belgium


2 END USER LICENSE

AGREEMENT (EULA)

Please read the following terms and conditions carefully before using the Armada software. Your use or installation of this copy of the "Armada” indicates your acceptance of this License.

Armada here means software, image files, all accompanying files, data and materials received with the “Armada". It comprises the Armada Server software, as well as the Client and the Web interface.

If you do not agree to any of the terms of this License, then do not install or use the Armada.

The Armada is protected by copyright laws and international copyright treaties, as well as other intellectual property laws and treaties. The Armada is licensed, not sold.

Grant of License and Rights

Installation and Use. You may install only one copy of Armada Server and use unlimited copies of the Armada Client.

Reproduction and Distribution. You cannot reproduce and redistribute the Armada. It is licensed for your company.

Description of other Rights and Limitations

Limitations on Reverse Engineering, Decompilation, and Disassembly. You may not reverse engineer, decompile, or disassemble Armada, except and only to the extent that such activity is expressly permitted by applicable law notwithstanding this limitation.

Software Transfer. You may permanently transfer all of your rights under this EULA, provided the recipient agrees to the terms of this EULA.

Termination. Without prejudice to any other rights, Alpha Technologies SA. may terminate this EULA if you fail to comply with the terms and conditions of this EULA. In such event, you must destroy all copies of the Armada and all of its component parts.

All title and copyrights in and to the Armada (including but not limited to any images, photographs, animations, video, audio, music and text incorporated into the Armada), the accompanying printed materials, and any copies of the Armada are owned by Alpha Technologies S.A. The Armada is protected by copyright laws and international treaty provisions. Therefore, you must treat the Armada like any other copyrighted material.

APPLICABLE LAWS. The rights and obligations of the parties under this agreement will not be governed by the United Nations Convention on Contracts for the International Sale of Goods. Instead, unless expressly prohibited by local law, the rights and obligations of the parties under this agreement will be governed by the Country of Belgium applicable therein. Licensee irrevocably submits to the exclusive jurisdiction of the courts of Belgium in any proceeding related to this agreement.

19




Belgium


NO WARRANTIES. Alpha Technologies S.A. expressly disclaims any warranty for the Armada. The Armada and any related documentation is provided "as is" without warranty of any kind, either express or implied, including, without limitation, the implied warranties or merchantability, fitness for a particular purpose, or noninfringement. The entire risk arising out of use or performance of the Armada remains with you.

NO LIABILITY FOR DAMAGES. In no event shall Alpha Technologies S.A. or its suppliers be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or any other pecuniary loss) arising out of the use of or inability to use this Alpha Technologies S.A. product, even if Alpha Technologies S.A. has been advised of the possibility of such damages.

ENTIRE AGREEMENT. Licensee agrees that this agreement is the complete and sole statement of the agreement between us and supersedes all representations, warranties and agreements (whether written or oral) relating to the Products, the services and the subject matter of this agreement. This agreement cannot be modified except in writing and with the approval of Alpha Technologies S.A.

PARTIAL ILLEGALITY. If any provisions of this agreement will be construed to be illegal or invalid, it will not affect the legality or validity of any other provision thereof, and the illegal or invalid provisions will be deemed stricken and deleted herefrom to the same extent and effect as if never incorporated herein, but all other provisions hereof will continue in full force and effect.

20




Belgium


3 LICENSING

Armada is licensed by number of site. Without a license key, the Arm@da .NET Server runs in demo mode and accepts to monitor and to control 5 sites and 20 remotely powered sites during 1 year.

Starting 2015, 3 Licenses options are available, described on the following schematic:

With the "Armada Basic" License, the Advanced Client can be be used by any number of users.

The Arm@da Web Interface has no limitation, you can use it on any host, any browser.

The Arm@da commercial license is linked to the server host hardware on which you want to use Arm@da .NET Server.

21




Belgium


To obtain a commercial license, you have to contact your reseller and provide the unique HardwareID of the host you plan to use with Arm@da .NET Server.

In the installation package, a software called “HID.exe” is provided to generate your unique HardwareID in case you want a commercial license.

22




Belgium


4 REQUIREMENTS

4.1 Client Requirements

Rich .NET Client (recommended)

The .Net rich client runs only on Microsoft Windows operating system with .NET 3.5 service pack 1 with all Microsoft updates.

Web Client (For read only features only)

Any modern web browser:

Internet Explorer > 7.0

Firefox > 15.0

Chrome > 20.0

4.2 Server Requirements

Windows prerequisites

Before installing Arm@da Platform, please consider the minimum requirements:

Server host with Windows OS ( 7, Server 2008 R2/2012)

Microsoft .NET Framework at least 4.0

Microsoft IIS 7

MYSQL (5.1 or higher - www.mysql.com), or MariaDB (10.0.2 or higher - https://mariadb.org/)

Static IP addresses (on host server and Comp@s cards, 1 for every site)

DC Systems with Alpha Technologies power solution equipped with Comp@s Card (regarding Comp@s license, the asset license is needed to provide GPS, description table equipments)

Hardware requirements

For a test server :

At least 2 cpu core

4Gb Ram or more

200 Gb for the Hard Drive

https://mariadb.org/

23




Belgium


For a production server:

RAID 1 controller card

2 x Hard Disk Drive 500 GB 15.000 RPM on RAID 1 (+1 hot spare is better)

Redundant Power Supply

Intel Xeon Quad Core

12 GB RAM

Gigabit network interface

Static IP address

MySQL Installation

You have to set up a database with a user who has full rights on this database. A convention is to use a database called "armada" and a user called "armada" with password "compas". For this purpose, open a command prompt and log you as root with the following command: "mysql –u root –p". You have to:

Create a database called armada: "create database armada;"

Create a user: if you plant to use the armada service host and the database on the same host, use "create user 'armada'@'localhost';" otherwise "create user 'armada'@'%';"

Give full rights on the database: if you plant to use the armada service host and the database on the same host, use the sql command : "grant all privileges on armada.* to 'armada'@'localhost' identified by 'compas' with grant option;" otherwise, use the sql command : "grant all privileges on armada.* to 'armada'@'%' identified by 'compas' with grant option;"

Edit your "C:\ProgramData\MySQL\MySQL Server 5.6\my.ini" file, add "max_allowed_packet=16M" under "[mysqld]" balise to allow mySQL server to store some files.

Edit your "C:\ProgramData\MySQL\MySQL Server 5.6\my.ini" file, add "innodb_buffer_pool_size = 4000M" under "[mysqld]" balise. Mysql uses a buffer pool to cache both indexes and row data. The bigger you set this the less disk I/O is needed to access data in tables. On a dedicated database server you may set this parameter up to 70% of the machine physical memory size. Do not set it too large, though, because competition of the physical memory may cause paging in the operating system. Note that on 32bit systems you might be limited to 2-3.5G of user level memory per process, so do not set it too high. If armada and the mysql server are on the same physical machine, we recommend to set this parameter to 50% of the machine physical memory size.

MariaDB Installation

You have to set up a database with a user who has full rights on this database. A convention is to use a database called "armada" and a user called "armada" with password

24




Belgium


"compas". For this purpose, open heidiSQL and log you as root. Open a new query tab in hediSQL to create the database with the user that has full rights on it. Find bellow the queries that will have to be executed:

Create a database called armada: "create database armada;"

Create a user: if you plant to use the armada service host and the database on the same host, use "create user 'armada'@'localhost';" otherwise "create user 'armada'@'%';"

Give full rights on the database: if you plant to use the armada service host and the database on the same host, use the sql command : "grant all privileges on armada.* to 'armada'@'localhost' identified by 'compas' with grant option;" otherwise, use the sql command : "grant all privileges on armada.* to 'armada'@'%' identified by 'compas' with grant option;"

Edit your "C:\Program Files\MariaDB 10.0\data\my.ini" file, add "max_allowed_packet=16M" under "[mysqld]" balise to allow mySQL server to store some files.

Edit your "C:\Program Files\MariaDB 10.0\data\my.ini" file, add "innodb_buffer_pool_size = 4000M" under "[mysqld]" balise. Mysql uses a buffer pool to cache both indexes and row data. The bigger you set this the less disk I/O is needed to access data in tables. On a dedicated database server you may set this parameter up to 70% of the machine physical memory size. Do not set it too large, though, because competition of the physical memory may cause paging in the operating system. Note that on 32bit systems you might be limited to 2-3.5G of user level memory per process, so do not set it too high. If armada and the mysql server are on the same physical machine, we recommend to set this parameter to 50% of the machine physical memory size.

Network Architecture and Configuration

If you plan to use the Arm@da Platform in a LAN only, there is no special network configuration to be done. If you want to use the Arm@da Platform on a LAN and WAN at the same time, you should keep in mind that you have to:

Set your public DNS name with your public IP (router/firewall)

Redirect the public port you would like to use to the local host (by default, Web Services use the port 80)

Set your local DNS, to point the DNS name to the host private IP

You have to check that the Arm@da .NET Server host is able to communicate with your Comp@s cards (simply check on the host server you can access the Comp@s Web Site by using the browser). You can notice on the following diagram that there's no real limitation for the network topology used with Arm@da Platform. Comp@s monitoring configuration

25




Belgium


In order to allow Arm@da to do clustering and reporting operations, you have to check that the following information is correctly filled in Comp@s web interface:

In description tab provide information such as :

o Street

o City

o Province

o Region

o Country

o GPS Position

In configuration tab at the site level, set XML Events Primary Post URL to the server xml listener (by default, http://the_armada_server/Armada/Post, "the_armada_server" being the IP address of the server you use for running Arm@da)

http://myhostname:7100/

26




Belgium


5 ADMINISTRATOR GUIDE

5.1 Server Installation / Upgrade

5.1.1 Server Service Installation

Installation of the Arm@da Server Service

Check that the server requirements are ok. (Windows operating system, mySQL server installed, empty database 'armada' create with 'armada' user.

Start the installation of "setup.exe".

27




Belgium


Follow the installation steps:

28




Belgium


29




Belgium


30




Belgium


Browse to the installation folder

Installation of a Licence

The license is a file, provided by your reseller, with the extension ".license". (armada.license - or similar, ending with license, 'armada_demo.license' on the previous screenshot)

Simply, copy/paste the license file in the Arm@da installation directory (by default: C:\Program Files(x86)\AlphaTechnologies\ArmadaServer\ )

Create database and configuration file

Execute C:\Program Files\AlphaTechnologies(x86)\ArmadaServer\ArmadaServer.exe (run as administrator)

This will create database

This will auto-create a "armada_configurations.xml" file that you will be able to edit.

31




Belgium


If you see red lines, that means that the Mysql server is not correctly setup or is not configured with default parameters. In that case, you can configure the file as following. Than, try to start again the application.

Configuring the core Arm@da Application

By default, the server application is installed in "C:\Program Files(x86)\AlphaTechnologies\ArmadaServer\".

The main configuration file is "armada_configurations.xml" and looks like:

Table 1 armada_configurations.xml

<?xml version="1.0" encoding="utf-8"?>

<ArmadaConfigurations>

<ArmadaConfiguration Id="1">

<Database Server="localhost"

Login="armada"

Password="compas"

Schema="armada"

Port="3306" />

<WebServer CompleteDnsHostname="localhost"

HttpPort="80"

HttpsPort="443"

32




Belgium


SubName="Armada" />

<SslCertificate CertificateIssuer="Armada Root Authority"

CertificateSubject="Armada Host"

CertificateStoreLocation="LocalMachine"

CertificateStoreName="My" />

<SmtpMailSender Server=""

Port="25"

Login=""

Password=""

SenderMail=""

SenderName="Armada Server"

UseSSL="False" />

<HttpTimeouts GetTimeout="10000"

PostTimeout="10000"

ReadWriteTimeout="10000" />

<AgentHttpGet MaxThread="10"

RetryDelayInSecond="60"

RetryCounterMax="5" />

<AgentHttpPost MaxThread="10"



<AgentFtpUpload MaxThread="10"



<LocalFileStorage FolderPath="" />

<PingAgent MaxThread="1" RefreshPeriod="3600" />

<AgentWriteHeartbeatToDatabase enabled="False" period="60000">

<query>

</query>

</AgentWriteHeartbeatToDatabase>

<Map UseLocalMap="False"

PathLocalMap=""

UseCacheOnClient="True"

Provider="OpenStreetMap" />

<PasswordPolicy UsePasswordPolicy="False" />

<Powershell Directory="" />

<Logo Path="" />

<Cleanup eventNumberToKeepByEquipment="1000" />

<ExecuteSQLQueryOnStart enabled="False">

<query>

</query>

</ExecuteSQLQueryOnStart>

<BackupMonitorings

Processor="Save -p

"c:\backup\<MonitoringId>" -f

"configuration_<DateTime>.xml""

BackupFilesToKeep="5" />

<PythonScript UsePythonScript="True"

33




Belgium


ScriptDirectory="PythonScript"

UseSnmpTrapListener="False" />

<EventForwarder EnableEventForwarder="True"

ScriptFile="EventForwarderScript\script.py"

ImportFile="EventForwarderScript\import.py"

EventType="cold start,alarm set,alarm clear"

EventSeverity="none,warning,minor,major,critical"

EventStartDate="2014-12-31" />

<Cassandra UseCassandra="True" Keyspace="armada"

Address="127.0.0.1" />

</ArmadaConfiguration>

</ArmadaConfigurations>

You have to set the following values:

Database: settings of your database server used by Arm@da

o your database host : if MySQL is installed on the same server, you can use "localhost".

o user : armada by default

o password : compas by default

o database name (schema) : armada by default

o port : the port used by the database server. - 3306 by default.

Webserver:

o CompleteDnsHostname : computer name of the web services server

o HttpPort : port used by web services

o Subname: subname used by web services

SslCertificate

o CertificateIssuer :name of the certificate authority that issued the certificate

o CertificateSubject :subject of the certificate. Should be the host name of the Armada server.

o CertificateStoreLocation : Specifies the location of the certificate store. Possibles values : "CurrentUser" or "LocalMachine"

o CertificateStoreName : Specifies the name of the certificate store. Possibles values : "My" or "Root" or "AuthRoot" or "CertificateAuthority" or "TrustedPeople" or "TrustedPublisher" or "AddressBook"

SmtpMailSender : settings of your smtp server used by Arm@da to send alarms notification and reports

o Server

34




Belgium


o Port

o Login

o Password

o SenderMail

o SenderName

o UseSSL

HttpTimeouts

o GetTimeout : the maximum waiting time (timeout) for a Get command. (time in milliseconds)

o PostTimeout : the maximum waiting time (timeout) for a Post command. (time in milliseconds)

o ReadWriteTimeout : the maximum waiting time (timeout) for a ReadWrite command. (time in milliseconds)

AgentHttpGet

o MaxThread : number of threads used to retrieve xml files of your Comp@s cards

o RetryDelayInSecond : if httpget fails, set the next execution time of the job

o RetryCounterMax : set the max number of job retries

AgentHttpPost

o MaxThread : number of threads used to post to your Comp@s cards

o RetryDelayInSecond : if httpPost fails, set the next execution time of the job


AgentFtpUpload

o MaxThread : number of threads used to upload files

o RetryDelayInSecond : if ftp upload fails, set the next execution time of the job


PingAgent: used to provide sites where connectivity is lost (depreciated)

Maxthread: number of threads used to ping Comp@s cards

Refresh_period: time period to ping one time again Comp@s cards

AgentWriteHeartbeatToDatabase: used to execute periodically sql query

o

enabled (True or False)

35




Belgium


period: time period in seconds

query : sql query to execute

Map :

By default the maps used by armada come from an internet connection. If your server or internal network doesn’t have an internet access, it’s possible to use maps located in the hard disk of the server. In that case, you will have to download the maps and setup the folder where the maps are located in your server. If you want to use maps located in your own server, please read that guide to learn how to download the maps.

o UseLocalMap : True if you want to use maps without a internet access

o PathLocalMap : the folder where the tiles are located in your server

o Provider : OpenStreetMap or OpenCycleTransportMap to have the ability to view map with transport layout.

PasswordPolicy: if UsePasswordPolicy = "True", Armada will check that the password has the following constraints: minimum 8 characters, one special character, one letter, one number. Armada will require too a password change at the first user connection.

Powershell: Directory is the path of the directory where we want to put PowerShell scripts. Those scripts will be executed by armada during his start. That will allow you PowerShell scripting for customization and automation.

Logo: Enter the path of a image (png or jpeg) to customize the logo displayed in the windows client.

Cleanup: eventNumberToKeepByEquipment allows you to configure the number of events to keep in the database, by equipment.

ExecuteSQLQueryOnStart: used to execute sql query on server start

o enabled: (True or False)

o query : sql query to execute

BackupMonitorings: used to configure the way the backup of the monitoring configuration is performed

o

Processor: That field allows us to configure the path where the configuration file of each monitoring will be stored. That field is set by default with the following value:

Save -p "c:\backup\<MonitoringId>" -f "configuration_<DateTime>.xml"

1. With that default value, the backup of each monitoring configuration will be saved on "c:\backup\<MonitoringId>"

The system will automatically replace <MonitoringId> by the monitoring id .

http://wavshare:8090/x/F4BJ

http://wavshare:8090/x/F4BJ

36




Belgium


So, the configuration file of the monitoring 1 will be saved in the directory : c:\backup\1

The configuration file of the monitoring 2 will be saved in the directory : c:\backup\2

2. With that default value, the monitoring configuration file will be renamed on the server using the following logic: "configuration_<DateTime>.xml"The system will remplace <DateTime> by the date with the time of the backup. So, if the backup is perform the 2014, July 31th at 15:55 41' the system will rename the backup file to "configuration_2014_07_31_1554_41_984.xml"

Note: The file armada_configuration.xml is a xml file and so the field "Processor" cannot contain the following special reserved character : < > & ' " We have to replace those special character using the following rules:

<should be replace with <

>should be replace with >

&should be replace with &

'should be replace with '

"should be replace with "

That is the reason why the field "Processor" is set with the value :

Processor="Save -p "c:\backup\<MonitoringId>" -f "configuration_<DateTime>.xml""

and not with the value :

Processor="Save -p "c:\backup\<MonitoringId>" -f "configuration_<DateTime>.xml""

Note : The field "Processor" can be easily changed using the tool "Backup Monitoring Configuration" in the Armada client menu.

PythonScript : Armada is able to manage other controllers than Compas. Please see the "Work with other controllers than Compas" chapter for more information.

o UsePythonScript : True or False depending on whether Armada will have to manage other controllers than Compas.

o ScriptDirectory: the folder where the Python scripts are located in your server. The path is relative to the ArmadaServer.exe file.

o UseSnmpTrapListener : True or False depending on whether Armada will listen snmp trap coming from other controllers than Compas.

EventForwarder: Armada allows us to forward events, alarms to another application, server. Please see the "Event Forwarder" chapter for more information.

37




Belgium


o EnableEventForwarder: True or False depending on whether Armada will have to forward events to another system using a custom Python script.

o ScriptFile: the file path of the Python script that will be used to forward each event, alarm. The path is relative to the ArmadaServer.exe file.

o ImportFile: the import file path that the Python script uses to import all the needed libraries. The path is relative to the ArmadaServer.exe file.

o EventType: All the event types separed by a comma that Armada will forward. "cold start,alarm set,alarm clear" by default.

o EventSeverity: All the event severity types separed by a comma that Armada will forward. "none,warning,minor,major,critical" by default.

o EventStartDate: The event date (formated yyyy-mm-dd) from when the event will be forwarded. "2014-12-31" by default.

Cassandra: To configure if Armada will work with Cassandra (NoSQL database)

o UseCassandra: True or False depending on whether Armada will work with Cassandra to handle data.

o Keyspace: Name of the database inside Cassandra (armada by default)

o Address: IP address of the Cassandra server (127.0.0.1 by default)

Install Armada Server as a service

When the application is able to start correctly. Close it, we have to install it as a windows service.

Start a console as Administrator and go to the installation folder.

Execute "InstallService.bat" and the following lines will appear.

Check that the service is installed and started (services.msc)

38




Belgium


We can now configure Windows to start the Armada Service automatically when the computer is rebooted. We have to right click on the "Armada Server Service", click on "Properties" and configure the Startup type as "Automatic (Delayed Start)".

39




Belgium


Finally, we will now configure Windows to restart the Armada Service automatically when a failure occurs.

40




Belgium


5.1.2 Server Service Upgrade

Stop the Armada Service if running

Run "services.msc"

41




Belgium


Stop the service "Armada Server Service" is started. (right click)

42




Belgium


Uninstall Armada.

Install Armada as described in previous chapter.

o There is no need to edit the armada_configurations.xml as it was not removed by the uninstaller.

o The license should also not be deleted (version > 0.2.1.10)

o Don't install the service, it is not uninstalled.

Test the installation by starting "ArmadaServer.exe" as administrator.

If OK, close it and start it as a service.

43




Belgium


5.1.3 Web Site ASP.NET Installation Procedure

Installation of the ASP.Net Application

1) Install IIS

Go to Windows Control Panel -> Programs -> "Turn Windows features on or off" and check boxes as shown on the following picture:

44




Belgium


45




Belgium


2) Register the framework .net 4.0 in IIS

While installing the .Net Framework 4.0 on your computer system it must already have IIS installed on it. If you have already installed IIS on your system then by default .Net Framework 4.0 will register the ASP.Net in IIS.

If you have installed the .Net Framework 4.0 before installing or configuring the IIS web server then it requires registration of ASP.Net in IIS. So you need to configure the ASP.Net using Aspnet_regiis.exe utility, the IIS Registration Tool.

A unique version of Aspnet_regiis.exe is included with each version of the .NET Framework. Since each version of the tool applies only to its associated version of the .NET Framework, be sure to use the version of the .NET Framework 4.0.

The tool for 32-bit systems in located in the Microsoft.NET directory inside the Windows folder; for example C:\Windows\Microsoft.NET\Framework\v4.0.30319 would contain the IIS Registration Tool.

The tool for 64-bit systems in located in the Framework64 directory of the Microsoft.NET directory inside the Windows folder; for example C:\Windows\Microsoft.NET\Framework64\v4.0.30319 would contain the IIS Registration Tool.

If you don't find the aspnet_regiis.exe file in the Framework\v4.0.30319 directory, you need to install the “full” version of the .NET Framework 4.0 that you will find in our package.

The below command will install and register the v4.0.30319 version of ASP.Net in Internet Information Services of your computer.

From start menu, open run dialog box.

Type cmd and press enter.

On the command prompt, type " C:\Windows\Microsoft.NET\Framework\v4.0.30319 " and press enter.

Type " aspnet_regiis.exe -i " and press enter.

46




Belgium


3) Extract Arm@da ASP.NET archive to the directory you want to use with IIS

4) Open IIS and convert the directory to an Asp.net application

To open IIS, go to Control Panel/Administrative Tools/Internet Information (IIS) Manager.

Or run InetMgr.exe from the the "Search Menu".

47




Belgium


Once IIS Manager is running, right click on the Armada Web Application folder and click on "Convert to Application".

48




Belgium


Select "ASP.NET v4.0" in the "Application pool" and click "Ok"

49




Belgium


5) Access and security of the configuration files.

In the windows explorer, navigate in the Armada Web Application folder.

Right click on the armada_configuration.xml file, go to Properties and there in the Security tab, give full control for the IIS_USRS

50




Belgium


51




Belgium


If you don't find the IIS_USRS, click on edit

and after on Add

52




Belgium


Click on Advanced

53




Belgium


In that form, select Location as your computer name and click on find, you will find the IIS_IUSRS

Do the same to give full control for the IIS_USRS on the armada_configurations.xml file

Once the access have been changed, we will run IIS to setup security on those files.

In IIS, select the armada web application and double click on "Request Filtering"

54




Belgium


In the "Hidden Segments" tab, click on "Add Hidden Segment..." and add "armada_configuration.xml" and "armada_configurations.xml"

55




Belgium


Configuring the ASP.Net Application

Edit the configuration file name armada_configuration.xml located in the directory in which you extracted the Arm@da ASP.NET archive.

Please see the section "Create database and configuration file" in the chapter "Server Service Installation" of the Administrator Guide to know how to define parameters

How to validate IIS Server Installation:

To test Arm@da ASP.NET application:

Go to Internet Information Services (IIS) Manager

Right click on Default Web Site à ArmadaWebApplication

On the right side of the window, click Browse web .80 (http)

5.1.4 Installing the Maps locally on the server

56




Belgium


Preliminary remark:

That guide is useful only if your server or your internal network doesn’t' have an internet access and that you want to host the maps on your own server.

5.1.4.1 How to download the maps?

1) Download Maperitive http://maperitive.net/download/Maperitive-latest.zip

Maperitive is a free desktop application for downloading maps based on OpenStreetMap.

2) Unzip where you want, and run Maperitive.exe.

http://maperitive.net/download/Maperitive-latest.zip

57




Belgium


3) Once the application is running, the first action to do is to set your map limits.

The easiest is to move the map to the area, zoom in our out appropriately to cover all the area you want, and then use the Map / Set Geometry Bounds menu function.

58




Belgium


4) Generating Map Tiles

This is done using the generate-tiles command. Enter the following command: generate-tiles minzoom=12 maxzoom=14

http://maperitive.net/docs/Commands/GenerateTiles.html

59




Belgium


For the sake of this tutorial we generated tiles just for three zoom levels (12, 13, 14).

The tiles have been stored in the Tiles subdirectory of your Maperitive installation

60




Belgium


Once all the needed maps have been downloaded, you can copy the Tiles directory on the armada server.

5.1.4.2 Recommendation

If you want to download the maps of a special country, we recommend following those specifics steps:

61




Belgium


1) Select the whole world and use the following command:

generate-tiles minzoom=1 maxzoom=7

2) Select the whole continent of the country and use the following command:


3)

Select the country and use the following command:


Custom Layout

The layout of the map ("OpenStreetMap", "Transport", "Bike", ... ) can be changed using mapiterative.

62




Belgium


63




Belgium


5.1.5 Configure the server as NTP server

5.1.5.1 Introduction

The Network Time Protocol (NTP) is a standard for synchronizing computer system clocks over networks.

It is usefull if you want the clock of each comp@s on you network synchronized with the clock of your armada server.

5.1.5.2 Setup procedure

1 ) Stop the "Windows Time" service

Go to Control Panel -> System and Security -> Administrative Tools -> Services.

mailto:comp@s

64




Belgium


2) Open the registry editor with Start -> Run -> regedit.

3) Search for the code "HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\W32Time\TimeProviders\NtpServer".

65




Belgium


4) Set the "Enabled" value to 1.

5) Search for the code "HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\W32Time\Config".

66




Belgium


6) Set the "AnnounceFlags" value to 5.

7) Start the "Windows Time" again and set the start type to "Automatic" if not already done.

8) If the firewall is enabled, it must be configured to permit external access to Port 123. This is necessary because the time server service expects external request messages.

67




Belgium


5.1.6 Install and configure Cassandra

5.1.6.1 Introduction

Armada has the ability to store and analyze massive volumes of data coming from in his equipments network. By default, Armada uses Mysql to handle those data, but when the Armada network become bigger, it is adviced to store those data using Cassandra.

Apache Cassandra is a NoSQL database platform that fits perfectly for these types of Big Data challenges. Cassandra is open-source, offers a elastic scalability (Cassandra cluster can be easily scaled-up or scaled-down), a high availability and fault tolerance. Above all, Cassandra offers brilliant performance under large sets of data..

We strongly advice to setup your Armada to work with Cassandra.

5.1.6.2 Setup procedure

1) Go to http://customer.alphatechnologies.eu/armada/ and download the last version of Java JRE and the last version of Cassandra (Datastax Community file).

2) Install Java JRE : Double-click the MSI file to execute it and the Windows Installer application launches. Follow the instructions in the Windows Installer window to install Java JRE.

3) Install Cassandra (Datastax Community file) : Double-click the MSI file to execute it and the Windows Installer application launches. Follow the instructions in the Windows Installer window to install Cassandra.

4) Configure Armada.

We can configure Armada to work with Cassandra using the file armada_configurations.xml that you will find in the Armada server directory (C:\Program Files (x86)\AlphaTechnologies\ArmadaServer).

Please check the chapter Server Service Installation.

5) Configure Cassandra

To configure cassandra, you have to use the program ArmadaAdminCassandra.exe that you will find in the Armada server directory (C:\Program Files (x86)\AlphaTechnologies\ArmadaServer).

Execute the program using administrator credential.

http://customer.alphatechnologies.eu/armada/

68




Belgium


The following window will appear:

if you have a fresh installation of armada, type a and then enter

if you upgrade a used installation of armada, type b and then enter. The program will create what is needed to run Armada with Cassandra and will retrieve your old saved data record to save them in Cassandra.

5.1.7 Create and configure self signed SSL certificate

5.1.7.1 Install OpenSSL

You will find bellow the url of the website that host the installation file of OpenSSL for Windows :

http://slproweb.com/products/Win32OpenSSL.html

http://slproweb.com/products/Win32OpenSSL.html

69




Belgium


Please download the setup file and follow the installation wizard using the default values.

5.1.7.2 Create self signed certificate

To create a self signed certificate, you can use the .bat files that you will find in the folder GenerateSelfSignedCertificate located in the Armada server installation directory.

Find bellow a description of those files:

a_GenerateKey.bat :

That command generates a 4096-bit long RSA key for our root CA and store it in file ca.key

b_GenerateSelfSignedCert_root_CA.bat :

70




Belgium


That command will create your self-signed root CA certificate ca.crt; you’ll need to provide an identity for your root CA.

CertificateIssuer in the ArmadaConfiguration.xml file should be set with the value of the Common Name.

c_GenerateSubordonate_CA.bat :

That command generates the key for our subordinate CA and store it in file ia.key

71




Belgium


d_GenerateCert_Subordonate_CA.bat :

That command requests a certificate for the subordinate CA

Make sure that the Common Name you enter here is different from the Common Name you entered previously for the root CA.

The Common Name should be the host name of the Armada server.

CertificateSubject in the ArmadaConfiguration.xml file should be set with the value of the Common Name.

e_Get_Cert_Subordonate_Signed_By_root_ca.bat :

72




Belgium


That command process the request for the subordinate CA certificate and get it signed by the root CA.

f_Pack.bat :

The command will package the keys and certs in a PKCS12 file

5.1.7.3 Install the certificate on the Armada server

Start certmgr.msc for computer account:

73




Belgium


1. Start → Run: mmc.exe

2. Menu: File → Add/Remove Snap-in…

3. Under Available snap-ins, select Certificates and press Add.

4. Select Computer Account for the certificates to manage. Press Next.

5. Select Local Computer and press Finish.

Press OK to return to the management console.

Right click on the Personal -> Certificates folder and then choose "All Tasks" and then "Import"

74




Belgium


Browse the path of the PKCS12 file you have created.

Click on "Next"

75




Belgium


Click on "Next"

76




Belgium


And then press "Finish".

77




Belgium


5.2 Armada .NET Client Installation

The .NET client is a standalone executable that do not require any installation. This is a major advantages for companies were it is not allowed to install easily specific application.

1. Browse to http://the_server_ip/Armada where "the_server_ip" is the server ip or the fully qualified hostname (like armada.mycompany.com).

http://the_server_ip/Armada

78




Belgium


a. The sub_url "/Armada" depends of the server configuration. The /Armada can be replaced by another name.

b. By default, the login and password is "admin" / "admin". When the system is configured, users need to use their own credentials to access the web page. (Defined by the administrator)

c. If the default HTTP port is not 80, for example 81, define the port in the url http://the_server_ip:81/Armada

d. The website is also accessible with https://the_server_ip/Armada if HTTPS is configured. (by default on port 443).

2. Create a folder on your hard disk. We recommend to create "c:\ArmadaClient". But any other folder where you have write permission is OK.

3. On the web site, right click on "Download ArmadaClient.exe" and save the file to the folder you created.

4. Save also the file "armada_client_configuration.xml" to the same folder. This is a pre-configured file allowing with the server information. (Url for the armada web services).



79




Belgium


Note that this previous web page is also accessible from the ASP.NET website:

Connect to Arm@da web site and click on "Download Installation Files".

80




Belgium


The main configuration file is "armada_client_configuration.xml" and looks like:

<?xml version="1.0" encoding="UTF-8"?>

<ConnectionProfiles Default="Armada BasicHttp">

81




Belgium


<ConnectionProfile

Name="Armada BasicHttp"

WebServiceUrl=

"http://armadaserver:81/Armada/wcf/basicHttpBinding"

Login="user"

Password="password"

WebProxyByPass="True"

WebProxyAdress=""

WebProxyPort="0"

NetworkCredentialName=""

NetworkCredentialPassword=""

NetworkCredentialDomain="" />

</ConnectionProfiles>

You can configure the following parameters:

Name: name of the connection profile

WebServiceUrl: url of the armada web services server

Login and Password are the armada credential

WebProxyByPass, WebProxyAdress, WebProxyPort, NetworkCredentialName, NetworkCredentialPassword and NetworkCredentialDomain are the parameters to set the network configuration that will be used by the armada client to retrieve map from internet (openstreetmap website).

You can by pass the default proxy of the system by setting the parameter WebProxyByPass to "True".

If needed, you can set a specific proxy by setting the parameters WebProxyAdress and WebProxyPort.

By default, Armada Client retrieve the network credentials from the user logged in the system. You can configure the network credentials manually by setting the parameters NetworkCredentialName, NetworkCredentialPassword and NetworkCredentialDomain.

82




Belgium


5.3 Maintenance

Configuring a backup of the files and of the configuration

The most important files of Arm@da Core Application are:

o armada_configurations.xml

o armada_log_configuration.xml (if you have modified it)

The important files of Arm@da ASP.NET Application are:

o armada_configurations.xml

o armada_log_configuration.xml (if you have modified it)

Configuring a backup of the MySQL Arm@da database

Open command prompt and create a database dump with the following command: "mysqldump –u root –p armada>myarmadabackupfile.sql"

Performance check

If you encounter some troubles with Armada Server Service, you can read more traces in armada_log.txt file (by default, C:\Program Files\Alpha Technologies\Armada Server Service\armada_log.txt).

5.4 Working with other vendor

controllers

Armada works natively with the Compas Controller and can also integrate controller from other vendors using the Armada API.

The Armada API allows administrator to write a Python script that will describe how the controller from another vendor will communicate with Armada.

With the Python script and the Armada API, we can use SNMP, Http request, mdobus, SQL... to get or set data from the controller and integrated the new controller and their connected devices in the Armada.

Administrator will be able to connect controller from another vendor that will be fully integrated in Armada, including events recording, data storing, alarms catching for the new controller and their connected devices.

With the documentation of your equipment, we can help you to write the scripts.

Here follows an illustration of the behavior with a Comp@s and with another vendor device controller.

83




Belgium


5.4.1 How does it work?

First it is necessary to enable the service by configuring the node "PythonScript " of the configuration file "armada_configurations.xml"

That xml node has two attributes:

UsePythonScript : True or False depending on whether Armada will have to manage other controllers than Compas.

ScriptDirectory: the folder where the Python scripts are located in your server. The path is relative to the ArmadaServer.exe file.

Please see the "Server Service Installation" chapter for more information.

Once the functionality enabled and the script directory configured, we can add Python script in the folder.

Each Python script will manage a new controller type.

84




Belgium


Once it's done, administrator will be able to add new controller from other vendors using the Armada Client.

Armada will automatically do its work and retrieve all the controller information, the devices connected, their status, configurations, events, alarms...

5.4.2 Example:

The node "PythonScript" of the configuration file "armada_configurations.xml" with the following settings means that the API is enabled and that the Python script that will allow to manage controllers from other vendors will be located in the folder "PythonScript" :

<PythonScript UsePythonScript="True" ScriptDirectory="PythonScript" />

In that directory, we put a script Pyhton called "CXCM1.py" that will manage the controller type CXCM1.

With that configuration, when we add a new monitoring, we can choose the monitoring type with the new controller type CXCM1.

85




Belgium


Once the monitoring added, Armada using the python script will retrieve all the descriptions, configurations, events, data, alarms of the controller and their connected devices.

The following screenshot shows us that all devices connected to the controller are automatically monitored in Armada.

86




Belgium


The alarms on those devices are now catched using Armada.

The events are also recorded by Armada.

87




Belgium


Data are collected and stored in the Armada database, users will be able to use them later to build reports, charts,...

88




Belgium


5.5 Event Forwarder

Armada has a functionality call "Event Forwader" that enable Armada to forward events, alarms coming from the Compas to another application (IBM Netcool, Nagios, Snmp Receiver,...), database (Mysql, MSSQL,...).

When that functionality is enabled, Armada will send events or alarms to a python script that will catch and forward them.

To enable that functionality, we have to edit the configuration file "armada_configurations.xml" and set the attribute "EnableEventForwarder" of the node "EventForwarder" to "True".

We will also have to set the file path of the Python script that will be used to forward each event, alarm ( the attribute "ScriptFile" of the node "EventForwarder") and the import file path that the Python script will use to import all the needed libraries ( the attribute "ImportFile" of the node "EventForwarder").

We can filter wich events are due to be forwarded by defining the attributes "EventType", "EventSeverity" and "EventStartDate" of the node "EventForwarder".

"EventType" describes all the event types separed by a comma that Armada will forward.

"EventSeverity" describes all the event severity types separed by a comma that Armada will forward.

"EventStartDate" describes the event date (formated yyyy-mm-dd) from when the event will be forwarded.

5.5.1 Example:

If we have set the node "EventForwarder " like :

<EventForwarder EnableEventForwarder="True" ScriptFile="EventForwarderScript\script.py" ImportFile="EventForwarderScript\import.py" EventType="alarm set,alarm clear" EventSeverity="major,critical" EventStartDate="2015-08-31" />

89




Belgium


That means that Armada will forward all the event where the type is "alarm set" or "alarm clear" and where the severity of the event is "major" or "critical" and where the event date is greater than "2015-08-31".

Each event that will come from a compas in Armada that fill these criteria will be send to the python script "EventForwarderScript\script.py".

That python script uses the dependencies describes in the file "EventForwarderScript\import.py".

Table 2 import.py

import sys

import clr

sys.path.append(r"C:\libarmada")

from ArmadaImports import *

from ArmadaAPI_1_0 import *

clr.AddReferenceToFile('MySql.Data.dll')

import MySql.Data

from System.Data import DataSet

Table 3 script.py

#####################################################################

#####################

#The following script will forward a event from Armada using SNMP.

#

#

#

#Script Input

#

#------------

#

#

#

# The script receives the following object from the armada server:

eventToBeFwd #

# That object will allow us to identify the event that have to be

forwarded. #

# eventToBeFwd has 3 properties :

#

# eventToBeFwd.EventDatetime

#

# eventToBeFwd.EventId

#

# eventToBeFwd.EquId

90




Belgium


#

#

#

#Script Output

#

#-------------

#

#

#

# After running that script, Armada server will check the variable

'resultPython' to #

# know if the event has been forwarded successfully

#

# If the variable 'resultPython' start with string "Success" then the

event will be #

# considered by Armada like forwarded

#

# Else the system will asume that the forward has failed and Armada

will try later. #

#####################################################################

#####################

resultPython = ""

try:

####################################################################

#We retrieve more information on the event from the armada database#

####################################################################

mySQLAdminUserName = 'armada'

mySQLAdminPassword = 'compas'

mySQLDatabase = 'armada'

mySQLHost = '127.0.0.1'

connection = MySql.Data.MySqlClient.MySqlConnection()

connection.ConnectionString = "server=" + mySQLHost +

";port=3306;uid=" + mySQLAdminUserName + ";pwd=" + mySQLAdminPassword

+ ";database=" +mySQLDatabase

connection.Open()

query = ("SELECT ev.text as event_text, ev.type as event_type,

ev.severity_type as event_severity_type "

" , equ.type as equ_type, equ.path as equ_path, equ.monitoring_id

as equ_monitoring_id "

" , sl.city as site_city, sl.name as site_name, sl.latitude as

site_latitude, sl.longitude as site_longitude "

"FROM equ_event as ev, equ_equipment as equ, site_location as sl "

"where sl.site_location_id = equ.site_location_id and equ.equ_id =

ev.equ_id "

"and ev.equ_id = " + eventToBeFwd.EquId.ToString() + " and

91




Belgium


ev.event_id = " + eventToBeFwd.EventId.ToString() + " and ev.datetime

= '" + eventToBeFwd.EventDatetime.ToString("yyyy-MM-dd HH:mm:ss") +

"'")

command = MySql.Data.MySqlClient.MySqlCommand(query, connection)

dataAdapter = MySql.Data.MySqlClient.MySqlDataAdapter(command)

dataSet = DataSet()

recordCount = dataAdapter.Fill(dataSet, "data")

if recordCount == 1:

eventTexte = dataSet.Tables[0].Rows[0]["event_text"]

eventSeverityType =

dataSet.Tables[0].Rows[0]["event_severity_type"]

eventType = dataSet.Tables[0].Rows[0]["event_type"]

equType = dataSet.Tables[0].Rows[0]["equ_type"]

equPath = dataSet.Tables[0].Rows[0]["equ_path"]

equMonitoringId = dataSet.Tables[0].Rows[0]["equ_monitoring_id"]

siteCity = dataSet.Tables[0].Rows[0]["site_city"]

siteName = dataSet.Tables[0].Rows[0]["site_name"]

siteLatitude = dataSet.Tables[0].Rows[0]["site_latitude"]

siteLongitude = dataSet.Tables[0].Rows[0]["site_longitude"]

else:

raise Exception("Event not found in the database : " +

eventToBeFwd.EquId.ToString() + " event date : " +

eventToBeFwd.EventDatetime.ToString("yyyy-MM-dd HH:mm:ss"))

connection.Close()

#########################################################

#We send SNMP trap with all the event's information #

#########################################################

receiverIp = "130.145.57.130"

receiverPort = 162

mainOid = ".1.3.6.1.6.3.1.1.5"

agent = TrapAgent()

col = VbCollection()

col.Add( Oid(mainOid + ".1"), Integer32(eventToBeFwd.EquId))

col.Add( Oid(mainOid + ".2"),

OctetString(eventToBeFwd.EventDatetime.ToString()))

col.Add( Oid(mainOid + ".3"), Integer32(eventToBeFwd.EventId))

col.Add( Oid(mainOid + ".4"), OctetString(eventTexte))

col.Add( Oid(mainOid + ".5"), OctetString(eventSeverityType))

col.Add( Oid(mainOid + ".6"), OctetString(eventType))

col.Add( Oid(mainOid + ".7"), OctetString(equType))

col.Add( Oid(mainOid + ".8"), OctetString(equPath))

col.Add( Oid(mainOid + ".9"), Integer32(equMonitoringId))

col.Add( Oid(mainOid + ".10"), OctetString(siteCity))

col.Add( Oid(mainOid + ".11"), OctetString(siteName))

92




Belgium



OctetString(siteLatitude.ToString("F6")))


OctetString(siteLongitude.ToString("F6")))

agent.SendV2Trap( IpAddress(receiverIp), receiverPort, "public",

upTime, Oid(mainOid), col);

#####################################################################

#

#We report to armada that the sript has been executed successfully

#

#####################################################################

#

resultPython = "Success from Python Event Fwd : " +

eventToBeFwd.EquId.ToString() + " event date : " +

eventToBeFwd.EventDatetime.ToString("yyyy-MM-dd HH:mm:ss")

except Exception as e:

resultPython = "Exception occurs : " + e.ToString()

93




Belgium


6 USER GUIDE

6.1 First steps in Arm@da

This chapter guides the user on how to comprehend the software. It describes the main screen and interactions and explains the basic procedure to observe in order to use the program properly. Before trying to click on tabs and opening windows, it is important to get familiar with the user interface and to understand just how to look at it.

Arm@da is an advanced software including many tools and screen. As the software is also a control tool that can directly interact with your network or equipment, carefully reading this user manual is highly recommended.

Key words: main screen, interface, map view, tree-view, cluster, elements list, general bar, equipment-related bar, tab, path, selection

6.1.1 Main Screen

When starting Arm@da, this is the main screen that will always be displayed :

Screenshot: Arm@da main screen

94




Belgium


Before starting to use the numerous tabs and tools, you should get familiar with the main screen. Main parts have been identified and boxed as shown on the screenshot below:

Each part shall be briefly explained. Please always refer to the above screenshot to identify the related part.

6.1.2 Clusters, Tree-View and list of devices

What is a cluster? A cluster is a way to group all sites and devices from a network in function of characteristics like:

Equipment type (site, energy system, DC system, rectifier, etc.)

Alarm severity type (devices in minor/major alarm or without alarm)

95




Belgium


Equipment status (in alarm or in normal state)

Country

Region

Province

City

Last connection status (succeeded or failed)

Alarm name

A cluster is thus a group of sites and devices and can be distributed into several other sub-levels of grouping.

In Arm@da, there are 2 possible ways of clustering sites (please see further).

Tree-View The Tree-View will display all sites, grouped in several levels of clusters. As long as you correctly added your sites or devices, you should be able to find all those in the Tree-View. All handlings in Arm@da start with the Tree-View. This is where you select the sites/devices you are going to work with. In other words, working in Arm@da always starts with the Tree-View.

Screenshot: Tree-View

96




Belgium


Four (4) Tree-Views are available at the same time. They all are user-configurable (Please see "Tree view configuration")

List of selected devices (list box) The list box lists up all devices within a selected cluster. Once you clicked on a cluster in the Tree-View, Arm@da will display the related components in the list box as well as on the map.

As shown on the above screenshot, selecting a cluster in the Tree-View (#1) will open the complete list of devices in the list box (#2) and show their location on the map.

By default, each item of this list is described by a complete "ETSI path". The "ETSI path" is a code that enables to identify a device, from the top of the hierarchy to the level of the device. For example, a rectifier will have an ETSI path like: Comp@s site → Energy System → DC System → Rectifier.

The exact "ETSI path" codification will be s[id]-es[id]-dc[id]-rect[id], as shown on the following screenshot:

97




Belgium


Screenshot: List of selected devices

This is how the devices and elements will be listed by default in the list box. You can also increase the size of the list box in order to display more criteria like site name, description, etc. It is then possible to rearrange the table by "dragging and dropping" the title of columns according to your preferences, as show on the following screenshot:

Screenshot: rearrange list box

98




Belgium


6.1.3 Cluster-related information

These tabs are directly related to the cluster or device you selected before. For each cluster or single device (site, energy system, DC system, rectifier, etc.), a general tab gives a first level of information:

'Map View' shows the exact geographical location of the sites/devices on a map.

'View Detail' gives access to the device-specific second level of tabs (see further). In order to have accurate information about one single device, you must select that site in the list box.

'Active Alarms' shows all alarms that are currently occurring while you are using Arm@da. If you select a cluster, all alarms of all sites will be listed. If you select one site/device from the list box, only site-related alarms will be displayed.

'Last Events' regroups all events including alarms set, alarm clear, system start, configuration change, that is to say all events and changes that happen to your sites. If you select a cluster, all events will be listed. If you select one site/equipment from the list box, only site-related alarms will be displayed.

'Reports' shows the results of all automatic reports. This feature will be explained in a dedicated chapter.

'Data Collection' allows collecting a specific piece of information, from simple description to variable record like ambient temperature, bus voltage, load current, load power, etc. This can be done for one site or a cluster. All retrieved data are 'live' data.

6.1.4 Tools

The tools tabs are dedicated to the administration and configuration of your network, as well as the administration of Arm@da. This is where you will add sites, build reports, modify configuration, etc. Unlike the cluster-related tab, the tools tab are not always dependant on the sites selected in the Tree-View or in the list box.

Please read the dedicated chapters in this manual before using the tools tab.

6.1.5 Other elements

Refresh

The refresh button helps you refreshing the Tree-View, list box and cluster-related tabs (incl. map

99




Belgium


view). When the software requires a refresh, the button will turn to red. Just click it to start refreshing the windows.

Server Status

This element gives the status of the connection to the server and indicates which profile you are currently using. A green colored stripe means the connection works fine. If you get disconnected from the server, the stripe will turn to red. If so, you can try to restore the connection by unlogging and logging again (via "Change connection profile" in "Client Configuration" tab).

Selected cluster info

This box gives you the details about the cluster you selected in the Tree-View. This reminds you what cluster or site you selected while you are working on it.

Quick buttons for Live Tools

This button is a shortcut for accessing the "File Tools" menu. Please see the dedicated chapter.

This button is intended for refreshing all 'live' data that are retrieved from all your sites and devices. This operation is done automatically over pre-defined periods of time (see chapter over "Server Tools") but can be done manually with this button. Depending on your server configuration and the number of sites you have, this operation might take quite some time and slow down Arm@da for a couple of minutes.

6.2 Cluster-related tabs

This chapter explains the use of the 6 cluster-related tabs. As mentioned before, what you will see in those tabs directly depends on the cluster you selected in the tree-view or the device you

100




Belgium


selected in the list box. The following screenshot shows the 6 cluster-related tabs on the main screen (boxed in orange):

Screenshot: cluster-related tabs

Key words: map, site-specific, alarm, event, data collection, data, record, configuration control, live web page

6.2.1 Map View

Bullets Once you selected a cluster in the treeview or a device in the list box, those will be displayed on the map as coloured bullets. The colour codes are meant to give the status of the device:

Green colour means the site/device is OK;

Orange colour means the site/device is in minor alarm;

101




Belgium


Red colour means the site/device is in major alarm;

Black means the connection with the site is lost. All data from that site are unavailable as long as the connection is not resumed.

You can bring the pointer on the bullets to display the device ID and status. Then, clicking on the bullet will lead you to the site-specific information ('View Detail' tab).

Screenshot: bullets on the map

Zoom and autozoom You can zoom and unzoom on the map either by using the scrolling button of the mouse or by using the dedicated zoom scale at the right side of the map. The autozoom button will center and zoom on the devices you selected. You can also move the map by keeping the right button of the mouse pushed and moving the mouse.

102




Belgium


6.2.2 View detail

Structure and functioning

This tab gives you access to a second level of tabs: site-specific tabs. In other words, these tabs relates to just one single site. In order to be able to use these properly, you must select one site or device from the list box. The composition of the site will then be displayed in a site-specific tree-view as shown on the following screenshot:

Screenshot: Site-specific tree-view

The functionning of the 'View Detail' and site-specific tabs is similar to the functionning of the cluster-related tabs: first, select one of the elements of the site-specific treeview, then click on one of the tabs. The information or data you will find in each tab relate to the element you selected. All data are retrieved from the Comp@s card.

Please refer to the next paragraphs for an explanation about each tab.

1. Description 'Description' will give you a general description of the site or one of its components (depending on

103




Belgium


the element you click on in the tree-view). This information is supposed to have been inserted when installing the site. You can select the parameters to be displayed in the table by right-clicking on any cell and clicking on 'Select Column'. You can also modify the content of the 'value' column by right-clicking on the cell and clicking on 'Modify Description Value'. That will lead you to the modification tool menu ('Operational Tools' tab, see dedicated chapter). You can also sort the rows by clicking on the title cell of one of the columns. Just as for the list box, it is possible to rearrange the table by "dragging and dropping" the title of columns according to your preferences. You can then save the layout of your choice (right-click and 'save columns layout').

You need to have the "read & write" rights in order to modify values or parameters.

2. Alarm 'Alarm' shows the complete list of alarms (standard and custom alarms if any) that can occur. The active alarms are highlighted in red for major alarms and yellow for minor alarm. Just as for the 'Description' tab, you can add or remove columns and save your selection by following the same process. You can also modify the severity level of the alarms by right-clicking on the cell and clicking on 'Change Severity'. That will lead you to the modification tool menu ('Operational Tools' tab, see dedicated chapter).


You can also acknowledge an alarm by right-clicking on the cell and clicking on 'acknowledge alarm'.

104




Belgium


3. Event 'Event' gives you an history of everything that happened in the system/site/device. That include alarms, control actions, changes in configuration or any other event that the system is able to record.

4. Data 'Data' shows all the "live data" (the last data retrieved) like for example output voltage, temperature, number of active rectifiers, etc. We can also use that screen to change the data configuration or ask armada to download delta records from compas by right-clicking on the cell.

If we click on "download delta records", Armada will retrieve all delta records from the compas for that specific data ("Tilt Y" in the screenshot bellow). If the button "download delta records" is disabled (in gray), that means that this data has not the delta recording enabled. You can configure and enable the delta recording by using the button "Change Data Configuration".

105




Belgium


5. Data record 'Data record' allows you to retrieve different types of data over different time resolution and to gather those in an Excel sheet or a generic chart. In order to collect the data you are looking for, you must first add data request to the selection list.

First, choose a time resolution between day, hour, minute and delta. ('Resolution')

Then select the recorded data you are looking for ('Data record'). Please note that the list of available data will depend on the element you selected in the site-specific tree-view.

Select the type of record from the list ('Data Record Type'):

o 'Average' is the average of all values recorded over each time period (minute, hour or day)

o 'Min' is the minimum value recorded over each time period

o 'Max' is the maximum value recorded over each time period

o 'Max (i) - Max (i-1)' is the subtraction of the maximum at time "i-1" from the maximum at time "i". This will be used for cumulative type of data, like energy consumption for example.

o 'Max - Min' is the subtraction of the minimum from the maximum. This can be used to analyze variations of the data over each time period.

o '(Max+Min)/2' is the addition of maximum and minimum from the same time period, then divided by 2.

Once all choices are made, click on 'Add'. The data request will be added in the selection list. You can then make other data request and add them to the list. Please note that you cannot retrieve data from different time resolution in the same selection list.

Finally, you can generate a spreadsheet in Excel or open a chart directly from Arm@da by pushing the dedicated buttons.

You can also delete a data request by selecting it from the list and clicking on 'Delete selected row'.

6. Configuration 'Configuration' lists up all configuration parameters and values. Again, the information you will find depends on the element you chose in the site-specific tree-view. All values are editable: select a cell and right-click on it. Then go to 'Modify Configuration Value'. That will lead you to the modification tool menu ('Operational Tools' tab, see dedicated chapter). Please remember that modifying configuration parameters might have consequences on the proper working of your site/device. This must be performed by qualified personnel only.


7. Control 'Control' allows you to remotely control, command or activate particular elements of your system, like for example start a battery test, open the door lock, close the LVD, add an event, etc. To do so, select one of the control actions from the table with the right-click, then go to 'Execute'. That will lead you to the operational tools menu. Please see the dedicated chapter of operational tools. Please remember that executing control actions might have consequences on the proper working

106




Belgium


of your site/device. This must be performed by qualified personnel only.


8. Live webpage The live web page is the direct link to the local monitoring software of your site or device. If you are using an Alpha Technologies energy system or controller, this will be the Comp@s software. There are 3 ways to access the live webpage: via direct IP address, via proxy connection (http) or via a secured proxy connection (https). All 3 ways can be selected from the drop-down list (see screenshot above). Depending on the configuration of your server, it is likely that only one out of 3 will work.

6.2.3 Active alarms

This tab lists all alarms that are currently active in the cluster or sites you selected. According to your own alarm configuration, the severity level of the alarms will be indicated with colours, as show on the screenshot below. You can leave the tab open and change your cluster selection (or sites selection in the list box), the contents will update instantaneously.

Three buttons are available:

Refresh: use it for refreshing the alarm list.

107




Belgium


Export to Excel: this will export the current alarm list to an Excel spreadsheet. You need to have Microsoft Excel installed on your computer to be able to use that feature.

Pop-up table: this will open a pop-up window, listing the current alarms and additoninal information.

View Sub Level Alarms There also is a checkbox called "View sub level alarms". Ticking that checkbox will add to the list all alarms from the devices and elements that are located at a lower level in the structure of the sites/systems. As major alarm notifications are pulled up to the highest level, typically the "site" level, it can happen that some elements are having an alarm status but no alarm listed. Just tick the checkbox in order to see the alarms rising from the sub elements and understand the alarm status of your device.

6.2.4 Last Events

This tab lists all events that recently happened in the cluster or sites you selected. Events include alarms, control actions, changes in configuration or any other event that the system is able to record. As for alarms, the severity level of events will be indicated with colours, as show on the screenshot below. You can leave the tab open and change your cluster selection (or sites selection in the list box), the contents will update instantaneously.

108




Belgium


Three buttons are available:

Refresh: use it for refreshing the "last events" list.

Export to Excel: this will export the current list to an Excel spreadsheet. You need to have Microsoft Excel installed on your computer to be able to use that feature.

Pop-up table: this will open a pop-up window, listing the last events.

View Sub Level Events There also is a checkbox called "View sub level events". Ticking that checkbox will add to the list all events coming from the devices and elements that are located at a lower level in the structure of the sites/systems.

6.2.5 Reports

109




Belgium


This tab gives you immediate access to the saved reports. Those reports are supposed to be previously configured via the dedicated reporting tools ("New table" and Saved table" - please see dedicated chapters). A drop-down list gathers all available reports. Just select one and it will be instantaneously displayed.

Just as for "Active Alarms" and "Last Events", you can open the report in an Excel spreadsheet or in a pop-up window.

The configuration of the report is fixed, but the figures are not. You can refresh the content of the report by clicking on "Refresh Report".

6.2.6 Data Collection

"Data Collection" allows collecting a specific piece of information, from simple description to data like ambiant temperature, bus voltage, load current, load power, etc. Again, Arm@da will retrieve the data related to the selection you made in the cluster or the list box. All retrieved data are the last data available on the Arm@da server.

Process Just select the type of information you would like to retrieve: use the drop-down list called "table" and choose between "description", "data" and "configuration". In function of the type of device you selected in the treeview or list box, the list of data available will pop up in the second drop-down list, called "Requested value". Just select one type of data among the whole list, Arm@da will then retrieve the requested value for all devices or elements.

The screenshot below shows the tab and its content:

110




Belgium


6.3 Client Configuration

Main functionality of this tab: change the personal settings of your Arm@da account/profile (client)

Key words: connection profile/account, user profile, cluster tree-view

6.3.1 Change connection profile

Clicking on "Change Connection Profile" will lead you to the same connection window you get when starting Arm@da.

If you saved several user profiles, you can choose one of those from the drop down list and enter you login and password. Then click on "Enter Arm@da" to start the software.

You can also delete a profile by selecting one from the list and clicking on the red cross.

You can also modify the server address by typing directly the address in the line 'Server'. To save your changes, click on the save button (floppy disk icon).

Remark: you cannot modify login and password from that window.

111




Belgium


6.3.2 Modify My User Profile

This window gathers all information about the user : first name, name, login, password, e-mail, phone number and language.

In case you modify one of those fields, you can save the changes by clicking on the 'save changes' button. If you close the window without clicking on the 'save changes' button, your changes will be lost.

This is also where you can change your password. For doing so, you must enter the new password twice: first in the field 'Password' and then in the field 'Confirm Password'

If you intend to use the automatic e-mail alert feature (see dedicated chapter, "Saved reports"), you must enter a working e-mail address in the dedicated field.

Access to that window might be limited, depending on the rights given by the administrator.

6.3.3 Cluster Tree-View Configuration

This window is intended to help you customize the tree-view.

112




Belgium


The tree-view can be organized by selecting items from the drop down lists, as explained in text and screenshot below (figures in below list match with figures on the screenshot)

1. View number: this is where you can choose the actual view you want to modify out of the 4 views available in the tree-view window.

2. View levels: you can organize the hierarchy of the tree-view by selecting the criteria of your choice, with up to 5 levels. If you do not want to use one or several levels, please select the blank field from the list as shown on the screenshots below.

3. Inherit view 1 from user: you can retrieve the first view from another user. If you don't want to use this option, leave it blank.

4. User: you can export the tree-view to another user account. Just select the user you would like to send the tree-view to. It will be automatically uploaded on his account. This option is available for administrator(s) only.

113




Belgium


When your selection is done, do not forget to save your configuration by clicking on the dedicated button.

6.3.4 Cluster filter

This feature is designed to help you filtering elements of your tree-views (all 4 - no separate filtering). You can choose to filter some elements according to a selection criterion (same as for cluster configuration). This might be helpful to have a better view on a definite part of your network if this one has many different devices or sites.

There are 2 types of filter: Personal filter and Restriction filter.

Personal filter: this filter can be used by any user for his/her own account. The filter will be assigned to the tree-view of the user. It can be canceled or changed at any time. The personal filter can also be used by the administrator to apply a filter to a user account. The user is then free to modify or cancel the filter.

Restriction filter: the restriction filter is available for the administrator only. It can be used to allow the users accessing only some elements of the tree-view (example: a region or an equipment type). In this case, the user will not be able to modify or cancel the filter.

Procedure (same for both types of filter): First, select a criteria (example: equipment type, alarm type, region, country, etc.) from the drop down list. Then, in the white field 'data', select one of the values you would like to restrict to (example: DC system). Save by clicking on the 'save' button. Please note that by configuring this filter, you actually tell the

114




Belgium


software what you want to see, and not what you want to hide. In the example of the screenshot below, the user 'admin' (Administrator) will see only DC systems.

As an administrator, you can select the user from the drop down list 'Apply to user'. If you would like to apply a filter for yourself, select 'Admin'.

6.3.5 Auto-refresh Cluster Treeview and Display activity

In the 'Client Configuration' tab, the 2 last rows can be activated just by clicking.

'Auto-refresh cluster tree-view' will ensure that the tree-views (and related site/devices status)

are refreshed periodically. When the feature is on, it will be marked with a "check" sign ( ).

'Display activity at bottom' will open a window in the main screen to display all background tasks executed by the software (see screenshot below). When the feature is on, it will be marked with a

"check" sign ( ).

115




Belgium


Screenshot: Display activity at bottom

6.4 Monitoring Devices

The second tab is dedicated to managing monitoring devices.

The main functionalities are:

Add monitoring devices (site or sub-site level);

Manage existing monitoring devices.

Key words: add monitoring devices, manage monitoring devices

116




Belgium


6.4.1 Add Monitoring Devices

Before adding a site/monitoring device in Arm@da

Before adding a monitoring device, please make sure that:

- The network configuration of the device is complete and correct. This configuration must be implemented on each Comp@s card in order to allow Arm@da to identify the card and therefore, the site/device. The network configuration is composed of 5 parameters:

DHCP Enabled

IP address if Static

Subnet Mask if Static

Default Gateway if Static

DNS if Static

- The XML Event Primary Post URL is configured and correct. This enables Arm@da to retrieve information from the Comp@s card.

- The GPS position of each site is filled in. This will enable displaying the site on the map.

Adding a site by using an IP address

In order to add a site/device, click on "Add Monitoring Devices” and select Comp@s in the menu. In the free space of the dedicated window (see screenshot below), just add the IP address of one or several Comp@s cards, one below the other (this IP must match the “IP address If Static” of the Network Configuration in Comp@s). Then click on “Add Monitoring Device” and refresh the page.

Your sites should now become visible on the Map View (first tab of the main right window). They can now be monitored and controlled from the Arm@da Client.

117




Belgium


Other parameters can be edited:

Web login: the user name used on web-based gui (administrator)

Web password: the password used in web-based gui (administrator)

Web login read only: the user name used on web-based gui (read only)

Web password read only: the password used in web-based gui (read only)

Web port: the port used to access Comp@s web server (usually 80 but could be different if you use routing)

FTP login: the login defined in Comp@s to provide identification to FTP service

FTP password: the password defined in Comp@s to give access to FTP service

FTP port: the port used to access Comp@s FTP service (usually 21 but could be different if you use routing)

Monitoring Type: By default, it's Compas but if the administrator has configured Armada to work with other monitoring type than Compas then we can associated the ip address with the

118




Belgium


controller of another vendor. Please see the "Work with other controllers than Compas" chapter for more information.

6.4.2 Manage Monitoring Devices

This tab is intended for modifying the connection-related data you entered when adding a new monitoring device.

The first window lists up all installed monitoring devices with their connection data. In order to modify one of those connections parameters, click on 'Modify Monitoring Device'.

Screenshot: Manage Monitoring Devices: list of all monitoring devices

When clicking on 'Modify Monitoring Device', you will get to a second window as shown on the following screenshot:

119




Belgium


Screenshot: Modify Monitoring

This is where you can modify all connection parameters like IP address, web port, etc. Once modifications are done, click on 'Save Changes'.

Changing connection parameters might have consequences on communication with the monitoring devices. This should be done by qualified personnel only.

6.4.3 Manage Site Locations

This tab will display the complete list of sites (or monitoring devices) and the location information.

As shown on the following screenshot, each row defines a monitoring devices and the geographical information: country, region, city, province, latitude and longitude.

This information is supposed to be previously filled in Comp@s. Consequently, Arm@da will display only what can be found on each Comp@s card. For security, the information that was added in Comp@s cannot be modified from this window and is highlighted in blue. If you want to modify the blue highlighted information, please use the 'Operational Tools' available in Arm@da (see further in this manual), or the Comp@s live webpage (depending on the rights you got from the administrator).

120




Belgium


Screenshot: Manage Site Locations (main window)

Please note that changing the information listed in this table might have consequences on the tree-view, the map view, or the data records and reports you might have configured so far, depending on how the geographical data are used in these.

The table also has 4 free columns that can be edited. They all are named Group# as displayed on the following screenshot:

121




Belgium


To edit one of those cells, just click on it and type the name of the group you would like to create:

It could be another geographical detail or any other piece of information. Those groups are available in the tree-view configurator and can be used for structuring the tree-view according to your needs.

122




Belgium


6.5 Operational Tools

This section is dedicated to control actions and modifications, either for one or for several sites.

Key words: control, action, modification, modify, configuration, alarm, template

6.5.1 Multi-Site Modification Tool

In the tab "Operational Tools", the first tool is intended for modifying parameters or values or executing control actions, for one site or several sites. The 5 tabs "Modify Configuration Element", "Modify Description Element", "Modify Alarm Element", "Modify Data Element", "Execute Control Element" are all parts of the multi-site modification tool:

Screenshot: tabs for operational tools

Devices selection First make sure you are working on the right sites or devices. By default, the tool will consider the cluster you selected in the tree-view or the device you selected in the list box, if you selected any. These sites will be listed in the left field under the checkbox "Use Arm@da main form selection". If you selected one element in the site-specific tree-view ('View Detail' tab) and you are about to work on that specific element, please check the box "Use Selection from View Detail". The ETSI path will then appear in the grey field below. If you intend to work on all sites (whole network), please check the box "Select all devices from all sites".

123




Belgium


Screenshot: multi-site modification tool

Add, preview and execute changes Once you selected the devices, choose from the drop-down list the element you want to modify. Please note that the elements/parameters that are available in the drop-down list depend on the cluster, site or device you selected previously. Then, enter the value in the white field "Change Value with". Depending on the parameter, you can type text and/or figures. Entering text for a parameter that requires figures will not have consequences. Once you have typed the new value in the dedicated field, click on "Add change". This change will be listed in the top dark grey field. You can repeat this and add other changes one by one.

Your changes have not been executed yet! You can first preview them: by pushing the "Preview changes" button, all changes will be displayed in the bottom dark grey field, with both former and new value (please see screenshot below). Preview changes is not mandatory but is highly recommended to make sure there is not any mistake. You can preview changes and then add new changes and preview them all again. This won't have consequences to the changes you have made before. Finally, when all changes are done, you can execute all changes by clicking "Execute Changes". If you want your changes to be effective but not overwrite previous configuration, please uncheck the box "Request monitoring to save changes". In this case, if the monitoring unit reboots, the changes will be lost.

124




Belgium


Screenshot: preview changes in multi-site modification tool

Please remember that modifying configuration parameters might have consequences on the proper working of your site/device. This must be performed by qualified personnel only.

Alarm element The menu for modifying alarms is slightly different. You can modify the severity type, the severity level, the clear and set delay of alarms. You can choose a severity level and type from the drop-down lists. You can change the clear and set delay by entering new value in the dedicated field (please, don't forget the check box). The rest of the process remains exactly the same.

125




Belgium


Screenshot: Alarm Element in Multi-Site Parameter Change tool

Control element The menu for control actions is different again. Some actions require you to type text, typically when adding events manually. When the action is just about executing the action, just leave the "control argument" value "1" and proceed (with "Add", "Preview" and "Execute")

126




Belgium


Screenshot: Control Element in Multi-Site Parameter Change tool

You can add, preview and execute all types of modification and control actions at the same time (see screenshot above).

Data element

The tab for data element allow you to configure how many records compas have to store. In the example bellow, compas will store 120 Second records, 120 Minute records, 48 Hour records and 366 Day records.

127




Belgium


Screenshot: Data Element in Multi-Site Parameter Change tool

If you want, we can ask compas to store Delta records. Delta recording means that compas will record only when a significant change occurs. To enable that kind of recording, we have to set the number of Delta records stored and the Delta record resolution. The Delta record resolution is the significant change that will trigger compas to record the new value.

6.5.2 Upgrade software/firmware

This form is intended to remotely upgrade the local software, like Comp@s for example, or the firmware of devices and modules. When opening the dedicated window, you will find 2 main parts: the left one for the selection of the device and the right one for the upload and upgrade of the files:

128




Belgium


Screenshot: Upgrade software/firmware

The selection of the device works just as in the multi-site modification tool. Either you select all sites ("Select all monitoring units") or just the ones you previously selected from the treeview (cluster) or from the list box (single site or device).

On the right part of the window, you find a list of all available files. This list of files is shared together with the files tools (see dedicated chapter). In order to upgrade your local software/firmware:

First make sure you selected the right device.

Then choose a file from the list by clicking on it (it must be highlighted in blue). Typically, software files should be .exe files and firmware files should be .txt files.

Then select the appropriate directory (the destination of your file), if you use Alpha Technologies devices with the Comp@s card, the directory of the software will typically be "/FlashDisk/user" whereas the directory of the firmware will typically be "/FlashDisk/user/firmware".

Once all these steps all completed, click on "Request server to start upgrading".

If the file is not available from the list, you can upload it by clicking on "Upload New File". This will lead you to the following window:

129




Belgium


Screenshot: upload new file

Just browse your documents and then click on "Upload to server". The other button ("Store link to file path only") is not useful in this process. Your file should now be available. If not, click on "Refresh File list".

The upgrade is now present in the flash memory but is not effective yet! The monitoring units still need to reboot. You can either do it manually, one site at a time via the live webpage of the site/device, or by using the control execution (multi-site modification tool) in operational tools (Please see dedicated chapter about "Multi-site modification tool").

This intervention should be done by qualified and authorized personnel only.

6.5.3 Force refresh of selected monitoring devices

The Arm@da server retrieves information and data from remote sites at regular user-configurable intervals (please see chapter about "Server tools"). This tab is intended to refresh data before the automatic refresh occurs (end of the interval). In the dedicated window, first select the sites or devices (left part of the window) and then chose the type of information you want to retrieve by checking or unchecking the dedicated boxes (Column "Information to retrieve"). When you are ready, click on "Request server to start processing", as shown on the following screenshot:

130




Belgium


Screenshot: Force refresh of selected monitoring devices

This intervention can take a few seconds or minutes, depending on the number of monitoring units.

You can also use the quick launch button "Force monitoring polling" that is located on the main screen. It will lead you to the same dedicated window where you can follow the process as described above.

131




Belgium


6.5.4 Server jobs status

This tab lists up the information exchanges between Arm@da (and its server) and the monitoring devices:

The "Get jobs" are all information and data sent to Arm@da from the monitoring unit.

The "Post jobs" are all information and control actions sent from Arm@da to the monitoring unit.

The "FTP upload jobs" are the upgrades of firmware and software that have been uploaded so far.

All 3 lists also give the status of the "jobs", the execution date, the related monitoring ID, etc. In other words, this is where you can see if your modifications and control actions were correctly executed. You can choose how many jobs you want to display by typing the number in the dedicated field.

Screenshot: server jobs status

6.5.5 Configuration Template

This tab is intended for defining a configuration template and applying that template to several sites at the same time. Furthermore, the template can be saved in order to be later applied to other sites. The dedicated window is made up of 3 main parts, as described on the following screenshot:

132




Belgium


Screenshot: Configuration template

Part 1 - The list of templates: this is where you can create your template or modify it. All available templates are listed in the table aside.

Part 2 - The selection of devices: like in many other windows of Arm@da, you can either select all devices of your network or the ones you previously chose in the list box or just the cluster you clicked in the tree-view.

Part 3 - The configuration: this is where you define the configuration you want to deploy. All configuration elements of the template are displayed in the table aside.

133




Belgium


Process 1. First create a template: just click on "Add template" and give it a name, then save it. To modify the name of your template click on "Modify template". 2. Select the devices to which you will apply the template (all sites, selected sites or clusters). 3. Define the configuration. For doing so, first select the configuration elements in the drop-down list and type the requested value in the dedicated field. Please note that the name of the configuration element always starts with the type of device it relates to. You can add as many elements as you need. Save them one by one by clicking on "Add". Your template is now ready. If you want to modify an element, just click on it (you know it is selected when it is highlighted in blue), type the new value and click on "Add". A pop-up window will ask you to confirm the changes. 4. In order to deploy the template, go back to the template list, select it and click on "Run template".

Later on, if you want to deploy a template to other sites, just choose one from the list (you know it is selected when it is highlighted in blue), select the devices and click on "Run template".

6.5.6 Backup Monitoring Configuration

6.5.6.1 Backup Monitoring Configuration

This window is intended for performing a backup of the configuration for a group of monitoring devices.

To perform the backup, first select the monitoring devices (left part of the window) and then fill the field "Processor" to choose where you want to save the backup files.

Finally, push on the button "Request Server To Start Processing" to perform the backup.

134




Belgium


Note:

The field "Processor" allows us to configure the path where the configuration file of each monitoring will be stored. That field is set by default with the following value:

Save -p "c:\backup\<MonitoringId>" -f "configuration_<DateTime>.xml"

1. With that default value, the backup of each monitoring configuration will be saved on "c:\backup\<MonitoringId>"

The system will automatically replace <MonitoringId> by the monitoring id .

So, the configuration file of the monitoring 1 will be saved in the directory : c:\backup\1

The configuration file of the monitoring 2 will be saved in the directory : c:\backup\2

2. With that default value, the monitoring configuration file will be renamed on the server using the following logic: "configuration_<DateTime>.xml"The system will remplace <DateTime> by the date with the time of the backup. So, if the backup is perform the 2014, July 31th at 15:55 41' the system will rename the backup file to "configuration_2014_07_31_1554_41_984.xml"

Note:

If you click on "Save as Default Backup Processor", the field "Processor" in the file armada_configurations.xml will be changed.

That will change the default backup settings for all the futures backup (even if the server restart).

135




Belgium


6.5.6.2 Restore Monitoring Configuration

To restore the configuration of one monitoring device, first select the monitoring, perform a right click and click on "Restore Monitoring Configuration From Backup"

The window "Restore Monitoring Configuration From Backup" will be show.

To restore the monitoring configuration, you can select a file in the following table and click on "Restore Monitoring Configuration from a above selected files".

136




Belgium


If you want, you can restore a monitoring configuration from a backup file located on your local hard drive or on your network.

You simply need to click on the button "Restore Monitoring Configuration from another source (local or network drive)" and select the backup file

137




Belgium


138




Belgium


6.6 Reporting Tools

This section is dedicated to (automatic) reporting of data, either via user-configurable tables (spreadsheet) or graphs. This also where you can configure automatic e-mail alerts.

Key-words: data report, table report, spreadsheet, e-mail alert, alarm alert, reporting

6.6.1 New table

This tab allows you to build up tables with the live data of your choice and save those tables so that they can be opened later again with up-to-date data.

After selecting the devices, sites or cluster in the dedicated window, you will get to the following window:

139




Belgium


Screenshot: configuration of table report

You have 4 options to build up your table:

One row per device: each device, whatever its type (rectifier, DC system, sensors, etc.), will have its own row in the table.

One row per site: depending on the cluster or devices you previously selected, Arm@da will issue a table in which each row is equivalent to a site. Even if you selected a cluster that is a mix of different type of devices, Arm@da will identify which sites the devices belong to and draw the table in function of those sites.

One row per active alarm: each row will identify an alarm that is active, whatever the device and its hierarchical level. In other words, all active alarms will be listed. If one site has several alarms at the same time, they all will be listed.

Custom query : You are able to create report using custom sql query.

140




Belgium


In order to choose one of those options, just click on one of the 4 dedicated tabs of this window.

Process

First choose the type of table between the 4 options (per device, per site, per active alarm, custom query - see above)

Some standard elements will be added by default to the table (first box of the window: "standard elements"). Each of those elements is the title of a column in your table. If you want some of those elements not to be used in your table, just uncheck the checkbox in front of the useless element.

You can add some more data elements like description elements, recorded data and configuration elements (second box of the window: "Add database elements"). For doing so, just select an element from the drop-down list and click on add. Adding a new element means adding a column to your table. All the elements you add will be listed up in the dedicated grey field below (third box of the window: "Selection").

You can now view the data table directly in a pop window ("View Table" button) or open it in an Excel spreadsheet ("Generate Excel Data). The first option is recommended for immediate reading, the second option is recommended for further data processing.

You can finally save your table report by giving it a name in the dedicated field and clicking on "Save report configuration". This will enable you to generate the table report with up-to-date data without redoing the same process.

Saved reports are available in the tab "View saved reports" (from "Reporting tools" - please see next subchapter), or in the cluster-related tab "Reports" on the main screen:

141




Belgium


Screenshot: saved reports

6.6.2 Saved table / Configure automatic e-mail report

This tab can be used for reading reports that you previously saved or for configuring automatic e-mail reports and alerts. The main window is divided in two parts, as shown on the following screenshot:

142




Belgium


Screenshot: Saved reports

The first part ("Saved Table Reports") listed up all table reports you have saved so far. You can read a report in real time in a pop-up window by clicking on 'View Table' or in an Excel spreadsheet by clicking on 'Generate Excel Data'. You will always get the latest recorded data. You can also send the table to yourself by pushing 'E-mail report'. This button actually sends the table to the user that pushed that button, as long as the user account is correctly configured with all information, including e-mail address. You can also delete a report by selecting it and clicking on 'Delete'.

The second part ("Related automatic e-mail reports") shows automatic e-mail reports linked to your saved report. When selecting a report in the above list, all automatic reports will be displayed in the list from below, if there are any. You can create a new automatic e-mail report by following the next process.

Creation of a new automatic e-mail report

1. Select one of the saved report in from the list (the one above).

143




Belgium


2. Click on "Create Automatic Email Report". This will open a new window in which you can configure the automatic e-mail report.

3. Select the user(s) that will receive the report in their mailbox. To select several users, just press the 'Ctrl' button of your keyboard while clicking on users' login. You can check in the users list that e-mail addresses are available. If not, you will have to edit them (see dedicated chapter about "Server Tools").

4. Configure the cron rule. The cron enables users to schedule jobs to run periodically at certain times or dates. In other words, you tell the system when exactly to send you the e-mail report. Each " * " in the dedicated field represent a predefined value over the considered time period. To configure your cron, just type the figures in the field while, according to the next values:

o Minute of the hour: 0 - 59 (0 being the beginning of the first minute of the hour).

o Hour of the day: 0 - 23 (0 being midnight)

144




Belgium


o Day of the month: 1 - 31

o Month of the year: 1 - 12

o Day of the week: 0 - 7 (0 and 7 being Sunday)

So, for example, selecting 10 in the field "Hour of the day" means that the system will send a report at every 10th hour of the day (10 AM). Not specifying a value and leaving the " * " in the dedicated field will lead the system to repeat the intervention at every period of time (minute, hour, etc.). You can now create combination of those cron rules to generate automatic reports at the time that suits you best. As a last example, please see the following screenshot:

145




Belgium


This cron rule means the system will make a report every first day of every month at 10.00 AM.

5. You can preview the cron rule by clicking on "Preview CRON". A pop-up window will list up all dates at which the system will send a report. For the example above, the preview will be:

Moreover, you can choose in which case you will get the automatic report: either according to your cron rule only, or when something has changed in your report compared to the previous one. In other words, the system will prepare your automatic report and compare it to the previous one, it will then send you an automatic report only if some value has changed. This can be particularly useful when you configured at table with active alarms: it will warn you of new alarms rising. This option can be selected in the drop-down list called "Notification". For receiving the report only in case of change in vales, select "Table changed". To normally receive a report according to your cron rule, select "None".

6. You can now save your configuration of the automatic e-mail report by clicking on the save button. This configuration is now displayed in the second grey field ("Related automatic e-mail report"). Once you want it to be effective, select it from the list and click on "Execute". You can configure several automatic e-mail report per saved report.

7. You can later modify or delete the automatic e-mail report by clicking on the dedicated buttons.

146




Belgium


6.6.3 Data Reporting & Charts

This feature will help you reporting and possibly aggregating the data records according to your needs in order to issue clear tables or graphs that you can use for further analysis or KPI. Note: unlike the table report function which extracts the last (live) data retrieved from the devices of your network, this part is aimed at processing the data records. In most cases, it will result in a function, of which the independent variable is the time.

Process This feature works like a wizard: it steps you through several setup screens where you have to select the options, depending on what report you would like to have in the end.

1. The selection of devices Like in many other feature of Arm@da, you first have to select the devices or sites you want to work with. By default, the software will select what you previously selected in the treeview and/or the listbox, as shown on the following screenshot:

2. Type of data, time and resolution This is where you select what data you want to extract. You have to make a selection in each of the drop down list:

o Record period: this is the time resolution of the data records. In other words, selecting "hour" means recording the value every hour. This will result in 24 recorded values a day and 720 values a month. Depending on the type of data and options you are about to choose in order to configure your report, the time resolution might be an important parameter.

o Data record name: this is where you can select the type of data to be recorded. The options available in the drop-down list depend on the devices you previously selected in

147




Belgium


the treeview or the list box. You have to select an element from the list for going further in the menus.

o Data record type: depending on the time resolution you chose previously, the Arm@da database will dispose of 6 different type of record:

'Average' is the average value recorded over each time period (minute, hour or day)

'Min' is the minimum value recorded over each time period

'Max' is the maximum value recorded over each time period

'Max (i) - Max (i-1)' is the subtraction of the maximum at time "i-1" from the maximum at time "i". This will be used for cumulative type of data, like energy consumption for example.

'Max - Min' is the subtraction of the minimum from the maximum. This can be used to analyze variations (Δ) of the data over each time period.

'(Max+Min)/2' is the addition of maximum and minimum from the same time period, then divided by 2

o Use records from dd/mm/yyyy to dd/mm/yyyy: just select the period of time you would like to work on.

3. Chart options This is where you choose how to process data and finally how to display it.

Group devices by: you can then decide to combine (or not to-) the values per group of devices. This is where you select the cluster of which you will combine values from separate devices.

Grouping method: you can then decide to combine (or not to-) the values per group of devices. Several options are available:

o Average: this will issue an average value for the group or cluster

o Sum: this will do the addition of values of all devices from the group or cluster

o Min: this will give you the minimum value among all values of all devices

o Max: this will give you the maximum value among all values of all devices

Display time axis by: you can display time axis according to several options: hour, day, month or year. This part of the setup goes together with the time-grouping method. For example, selecting "average" as a time-grouping method and "month" as a time resolution on the X axis will show you one average value for the whole month, from all values recorded over that month.

Time-grouping method: just as for the device-grouping method, you can decide to combine (or not to-) the values per period of time. Several options are available:

o Average: this will issue an average value for the period of time you chose

o Sum: this will do the addition of values of all devices over each period of time

148




Belgium


o Min: this will give you the minimum value among all values covered by the selected period of time

o Max: this will give you the maximum value among all values covered by the selected period of time

You cannot use a time resolution that is lower than the one you chose on the first screen for the time resolution of records. In other words, you cannot request daily records and select "hour" as a time resolution for the X axis of your chart. It will not work.

Chart type: there are many chart types available. Not all of them are useful for all types of data. The relevance of a type of chart will depend on the setup you have previously prepared. There several options:

o Line: the recorded values will be displayed as a function of time. You can use that chart for one or several groups or systems. You will then have several lines.

o Line - stacked: you should have selected several sites or several groups (in the case you previously grouped devices together) in order to use that chart type properly. Again, the recorded value will be displayed as a function of time. But in this case, each line will be the addition of the previous value (the value of the 1st group for example) and the considered value (the one of the second group for example). As a result, the top line will be equivalent to the addition of all values over time. The following screenshot shows the outlook of such a chart:

149




Belgium


o Bar - vertical: this chart type uses vertical rectangles to represent the value. This kind of chart should be used with cumulative data (like energy consumption for example). Grouping devices or grouping over time can help you having a more synthetic overview, particularly when there are many devices.

o Bar- stacked: just as for the regular "bar" chart, this type of chart uses vertical rectangles but places them one above another. The whole rectangle is then equivalent to the total value over the considered time unit. As a consequence, you are able to see the share of

150




Belgium


each group or devices. Again, you should have selected several sites or several groups in order to use that chart type. Using it for one device is pointless.

o Bar - overlay: just as for the other "bar" charts, this type of chart uses vertical rectangles but places them one behind another. The bar that has the greater value will be placed behind the other(s). The goal is to clearly show the difference between the sites or clusters you are reporting on the chart. Again, you should have selected several sites or several groups in order to use that chart type. Using it for one device is pointless. On the other hand, you should not have too many groups or sites on the same graph, because it is likely that the graph becomes unclear due to too many bars. In the screenshot below, the site 17 has a greater value than site 37. The total value of site 17 is equal to the value of site 37 (the brown bar) plus the visible part of the green bar. The green bar is actually partly "hidden" behind the brown bar. This allows easy comparison.

151




Belgium


o Pie: the "Pie" chart shows the shares of each group or device over the considered time period. This type of chart is particularly appropriate for comparing total amounts or cumulative data like energy consumption, load power, etc.

X axis is: the X axis can display either time or groups of devices. Displaying the groups of devices on the X axis requires that you selected the bar chart type. In that case, the bars will show the value over each period of time, typically per month. Please see the difference on the following screenshot:

152




Belgium


X axis: month X axis: group of device/cluster

4. Once all parameters are configured, just click on "Generate chart" to open the chart in a pop-up window. You can also generate the report on Excel. The spreadsheet will contain all figures resulting from your setup. You can then use them for further analysis or processing. Just select the type of report you want to have (excel or CSV) and click on "Generate Data report".

6.6.4 Export Cluster Tree-view to Excel

Pressing this tab will immediately open an Excel spreadsheet with 4 sheets, one for each view from the Tree-view. According to the structure of your clusters, the parent clusters will always be listed in the column A and the subsequent groups or elements in the next columns (the hierarchy is displayed from left to right).

Just like in a database, there are as many rows as elements of the last level of the hierarchy, as shown on the following drawing:

Treeview Excel sheet

The spreadsheet will be saved automatically in the same directory as your [email protected] client. You can also save it in the directory of your choice.

You must have Microsoft Office Excel® installed on your computer to be able to use this tab.

153




Belgium


6.7 File Tools

This part of Arm@da is intended to store documents of any kind and link those documents to clusters, sites and devices.

Key words: file, document, link, upload file, view file, link file

6.7.1 Add file

This is where you can upload the file or documents that you will link to sites or devices at the next stage.

Screenshot: Add file

First, click on browse and select the file you would like to upload. The file name will be displayed in the field "Display File Name". You can add a comment about the file in the dedicated field (not mandatory).

You can then choose between uploading the file on the server (button "Upload to server") or saving only the link to the file (button "Store like to file path only") - that is to say the content of the field called "File path". Your file will then be available in the list (see next paragraph about "View Files").

154




Belgium


6.7.2 Link a file to a device

You can link a file to an entire cluster, one single site or monitoring unit, or even one device like a rectifier or a sensor.

In order to do so, just right-click any cluster from the tree-view, any site from sites list or any element in the smaller tree-view from the "View Detail" tab. Among other options, Arm@da will suggest you to "link file to", as show on the screenshot:

You can then decide to what level of the site/device you would like to link the file. Just click the option of your choice to make the following window pop-up:

155




Belgium


In order to effectively link a file to the element of your choice, just select a file from the list (called "Files Selection"), then click on the button "Link Selected Files". Later on, when selecting a file from the list in the "View Files" tab, the link will be displayed in the box called "Related link" (see next section).

You still have the option to add a new file by clicking on the dedicated button. The procedure is then just the same as in the dedicated tab ("Add file" - please see previous section).

6.7.3 View files

This tab will help you seeing all files or documents you uploaded and to which sites or devices those are attached.

156




Belgium


Screenshot: View Files

4 boxes are available in this window: "File Selection", "Live criteria", "File list" and "Related link". Those 4 boxes are related to each other.

File selection: in "file selection", you can choose between seeing all files or seeing only the files attached to the sites/devices that match the live criteria (= the selection you previously made in the tree-view and the list of devices). Just tick the check box "All files" or "Matching Live Criteria" and click on "Refresh". In both cases, the list of files will be displayed in "Files list".

Live criteria: this is where you can see the selection you made in the tree-view and or the list of files. This selection will work as criteria for filtering the files available on the server. This way, you can see which files are attached to the sites you selected in the treeview. If you modify your selection in the treeview, click on the "Refresh" button to update the criteria and the other boxes.

File list: this is where all files are listed, according to the choice you made in "File Selection". When clicking on one file, you have several options:

o Opening the file, by clicking on the button "Open Selected File";

o Downloading the file on your computer, by clicking on the button "Save Selected File";

o Deleting the file, by clicking on the button "Delete Selected File"

You can also add a new file by clicking on "Add file". This will lead you to the dedicated window for adding files (see previous section "Add File").

157




Belgium


Related links: when selecting a file, this box will show to which site or monitoring unit the file is attached. As an example in the screenshot above, the selected file is linked to the monitoring unit with ID 26 and the site location with ID 20. You can delete a link by selecting that link and clicking on "Delete selected link".

6.8 Map Tools

Go to address You can locate any address on the map just by typing the address in the dedicated field (see screenshot below). Note: Arm@da will locate the address but will not automatically zoom, it will keep the zoom level as it is. In order to see your location precisely, we advise you to have the zoom at a quite high level, whatever the location, before typing the address.

Map Source The default map source is OpenStreetMap. Running OpenStreetMap requires an online internet connection.

The Map source "OpenStreetMap - Transport" shows public transport lanes like railways, buses and trams worldwide. Running "OpenStreetMap - Transport" requires an online internet connection.

If your private network does not allow you to connect to the web, the map can be uploaded on the Arm@da server. It will be called "Local Map". The local map has to be configured when installing the Arm@da server. Once installed, you can select "Local Map" as the source of your map . That setup will allow all the Armada users to see map without a internet connection. The layout of those maps ("OpenStreetMap", "Transport", "Bike", ... ) can be chosen using mapiterative (See the Armada server installation guide).

Map Prefetch This is an advanced function. By holding the ALT key of your keyboard and clicking on the map, you will be able to draw a blue square. The area inside your blue square will be saved in the "cache" memory of your computer. If you disconnect your internet, you will still be able to work offline and keep a high resolution of the map for the blue area.

Map Import This tab allows you to import a map that will be saved in your "cache" memory for offline use of

158




Belgium


Arm@da. A window will open where you can browse your documents and upload a map. Please note that only .gmdb file can be uploaded.

Map export You can save the map currently in use in order to upload it later for offline use of Arm@da. Everything that is in the "cache" memory will be saved, in the directory of your choice. You can then import it later when using Arm@da offline.

Save Map Screenshot Use this tab for saving a screenshot of the map in the directory of your choice.

6.9 Server Tools

This tab gives you access to the information about the server performance and logs. This is also where you can configure user accounts and groups of users, as well as the frequency of data retrieval.

Key words: user account, user group, administrator, operator, server logs, server performance, "Get Job" configuration

6.9.1 User Administration

This tab can be used by the administrator only.

This is where you can add new users, modify user account, modify the user's clustering and apply filters. Please see the screenshot below:

159




Belgium


Screenshot: user administration

This tab gives you the list of all user and administrator accounts. In other words, these are all the people that use Arm@da on your server. As an administrator, you are the person in charge of user accounts and configuration.

Add user

160




Belgium


For adding a user, you need to fill in all blank fields with correct information. First name, last name, login and password are mandatory field. E-mail and phone number are not mandatory, but might be very useful. If you plan to include the user in automatic e-mail reporting, you should then enter the user's e-mail address. This also where you assign the user to one of the user group: administrator, operator or any other user type you may have defined (please see next chapter on user group administration).

Modify User Tree-view As an administrator, you can decide how the tree-views of users should be configured. Just select a user from the list and click on "Modify user profile". You will get to the exact same window as for "Cluster Tree-view Configuration" (in the "Client configuration" tab). Please refer to the dedicated chapter for more information on how to configure the tree-view ("Cluster Tree-View Configuration").

Modify User Filter As an administrator, you can decide to apply filter to the tree-views of users. Just select a user from the list and click on "Modify user filter". You will get to the exact same window as for "Cluster filter" (in the "Client configuration" tab). Please refer to the dedicated chapter for more information on how to configure the filter ("Cluster Filter").

161




Belgium


Delete user You can delete a user by selecting it from the list and clicking on the button "Delete Selected User".

Deleting a user account means that user will not be able to log in Arm@da. The account will be deleted from the database.

6.9.2 User Group Administration

This tab can be used by the administrator only.

Groups, roles and rights This tab is dedicated to the administration of groups of users. When creating a new user account (see previous chapter "User Administration"), you must assign a group to the user. As the administrator may consider that all users should not have access to every kind of information in Arm@da, it is possible to assign precise rights to each group. In order to make the assignation of rights easier, the rights are gathered in roles. Those roles gives you access to the numerous features and data of Arm@da. According the group the user belongs to, he will have specific roles and as a result some limitations in what he can do or see in Arm@da. The administrator only has all rights (roles) in the software.

The different roles give the user access to specific rights in Arm@da. Those roles are described in the table below:

Role Right Related feature/tab

AccountManagerRead Read user roles assigned to each group

User group administration

See the user groups User group administration

See user accounts User administration

AccountManagerWrite Add or modify a user account User administration

Delete a user account User administration

Add a user group User group administration

Modify roles of a user group User group administration

Delete a user group User group administration

AdminRead See "http get jobs" configuration http Get Jobs configuration

162




Belgium


See list of emulated sites Monitoring emulation administration

See the last "get jobs" Server jobs status

See the last "post jobs" Server jobs status

See the last firmware upload Server jobs status

See all configuration templates Configuration template & deployment

See template settings Configuration template & deployment

Read server logs Server logs

AdminWrite Add a monitoring device Add a monitoring device

Modify "http get jobs" configuration

http Get Jobs configuration

Upload firmware Upgrade software/firmware

Add or modify emulated sites Monitoring emulation administration

Delete a monitoring unit and related devices

Manage monitoring devices

Modify the connection settings of a monitoring unit

Manage monitoring devices

Add or modify a configuration template

Configuration template & deployment

Delete a configuration template Configuration template & deployment

Add a configuration element to template


Delete configuration element from template


Force refresh for selected monitoring units

Force refresh for selected monitoring units

Common See user profile Modify my user profile/User administration

163




Belgium


See Treeview configuration Cluster Treeview configuration

See software license version About

See server version About

Read general information from monitoring unit

list box (column selection), View detail

Modify own user profile Modify my user profile

ElementRead See the configuration of devices View detail

See all active alarms of selected devices

Active alarms

Get records of server performance

Performance indicator records

See server performance (live) Performance indicator live

See devices grouped in a cluster List box

See GPS coordinates of sites Manage site location

See site location on the map Map/manage site locations

See last events for selected devices

Last events

See last events for selected devices and sub-elements

Last events

ElementWrite Modify location of sites

Configure Treeview Cluster Treeview configuration

Delete devices or sub-element Manage monitoring devices/list box

Set device to maintenance status

List box (>Set device in maintenance mode)

Preview changes Operational tools (description, alarm description, control)

Execute changes Operational tools (description, alarm description, control)

FileRead See files according to criteria View files

164




Belgium


See links to files View files

See list of files View files

Open uploaded files View files

FileWrite Add link to file List box (>link file to)

Add file Add file/view files

Delete file View files

Delete link to file View files

LiveWebPage Access Live webpage Live webpage tab

LocationRead See custom treeview Custom TreeView

LocationWrite Delete link to custom clustering node

List box (>Delete custom tree node link)

Delete multiple links to custom clustering node

List box (>Delete custom tree node link)

Add node in custom treeview Custom TreeView

Delete nodes from custom treeview

Custom TreeView

Add link to custom clustering node

Custom TreeView

ReportRead Generate data report based on records

New data record report

Create table reports New table report

Generate table based on saved report

Saved table report

Send e-mail report Saved table report

Execute automatic e-mail reporting

Saved table report

Generate graph based on records

New data record report

See list of saved reports Saved table report

165




Belgium


ReportWrite Delete saved report Saved table report

See list of automatic e-mail report

Saved table report

Delete automatic e-mail report Saved table report

Add or modify automatic e-mail report

Saved table report

Save table report New table report

The first column lists up all types of roles that you can assign (or not) to a user. The second column lists up all rights that match the role. The third column indicates the tab that refers to each right.

Creating a group of users In order to create a group of users, just type the name of the new group in the blank field, as described in the screenshot below, and click on "Add group". The new group will then be available from the drop down list. You can delete a group by selecting it from the list and clicking on "Delete selected group".

166




Belgium


Assigning roles When selecting a group from the drop down list, the roles that are assigned to that group will be displayed immediately in the list of roles. You can add or cancel roles by checking or unchecking the checkboxes. When you are done, click on "Apply" to save changes. By default, all roles are unchecked when creating a new group. Please see above the rights included into each role. Note: administrator(s) cannot cancel their own "AdminRead" and "AdminWrite" roles.

167




Belgium


6.9.3 Performance Indicators Live

You can see the "real-time" performances of your Arm@da server via 3 indicators: the network bandwidth, the usage of the CPU and the free memory. In the main window, just click on the dedicated tab of one of the 3 indicators. A graph will be display and a line will be drawn in real-time. The longer you wait, the better you can see the "behavior" of your server. You can then zoom and unzoom on the graph by using the scrolling button of the mouse.

6.9.4 Performance Indicators Records

It is also possible to see the records of the last 24 hours of the CPU usage, the free memory and the upload and download speed. As shown in the screenshot below, just tick the checkboxes of your choice and click on "refresh" for displaying the records on a graph.

168




Belgium


6.9.5 Http get jobs configuration

This form can be used by the administrator only.

This form is dedicated to the configuration of the "Get jobs". The "Get jobs" are the requests generated from the server in order to retrieve the data from each of the Comp@s cards. You can actually set the frequency of those "Get jobs" and define which data you want to get.

You can configure the "Get jobs", as shown on the screenshot:

169




Belgium


The first column is the id of the get job configuration. You don't need to change.

The second column "Download Job File" allows us to configure which data are retrieved. It is the request that armada will send to each connected monitoring.

By default, armada is set with these three "get job":

site.xml?notable=true this "get job" retrieves the site-specific treeviews (available in "View Detail") of all sites, including the alarm status of each element (rectifiers, sensors, DC system, etc.). By default, it runs every 60 minutes.

site.xml this "get job" retrieves all alarm status together with all information (about description, configuration, events etc.) and all live data. By default, it runs every 360 minutes (6 hours).

site.xml?data_record=true&control=true this "get job" retrieves all alarm status, information, live data and all data records. By default, it runs every 2880 minutes (2 days).

If needed, you can modify the "Download Job File" to have armada getting periodically other information from your comp@s .

mailto:comp@s

170




Belgium


For example:

To obtain periodically the last day records from the compas, please set the column "Download Job File" to :

site.xml?description=false&alarm=false&event=false&data=false&data_record=true&day=true&data_record_from=<data_record_last_day>&hour=false&minute=false&delta=false&config=false&control=false

To obtain periodically the last hour records from the compas, please set the column "Download Job File" to :

site.xml?description=false&alarm=false&event=false&data=false&data_record=true&day=false&hour=true&data_record_from=<data_record_last_hour>&minute=false&delta=false&config=false&control=false

To obtain periodically the last minutes records from the compas, please set the column "Download Job File" to :

site.xml?description=false&alarm=false&event=false&data=false&data_record=true&day=false&hour=false&minute=true&data_record_from=<data_record_last_minute>&delta=false&config=false&control=false

To obtain periodically the last delta records from the compas, please set the column "Download Job File" to :

site.xml?description=false&alarm=false&event=false&data=false&data_record=true&day=false&hour=false&minute=false&delta=true&data_record_from=<data_record_last_delta>

To obtain periodically the last description, alarm, event, config and control from the compas, please set the column "Download Job File" to :

site.xml?description=true&alarm=true&event=true&data=true&data_record=false&config=true&control=true

The third column shows the interval between each data retrieval for each type of "Get jobs". This interval is expressed in minutes.

Those intervals are saved by default in Arm@da. Even if they are user-settable, we recommend to use those default values. Too short intervals might reduce the performance of your server due to the very large amount of data to process, particularly if the number of devices is large.

171




Belgium


6.9.5.1

6.9.6 Powershell script

To meet specific requirements, we offer Armada customers the ability to create and run custom scripts.

These custom scripts are a serie of written in a programming language (PowerShell) that allow interaction with the database of Armada (detection of new events ....) and perform custom actions (send mails , sms, tweets, ...).

To enable the run of those scripts, we have to configure the Powershell parameter in the server configuration file "armada_configurations.xml" by entering the name of the directory where you will put the PowereShell scripts.

Please see the following example.

<?xml version="1.0" encoding="utf-8"?>

<ArmadaConfigurations>

<ArmadaConfiguration Id="1">

<Database Server="localhost" Login="armada" Password="compas"

Schema="armada" Port="3306" />

<WebServer CompleteDnsHostname="PCOMADANT764" HttpPort="81"

HttpsPort="444" SubName="Armada" />

<SslCertificate CertificateIssuer="Armada Root Authority"

CertificateSubject="Armada Root Authority" />

<SmtpMailSender Server="" Port="25" Login="" Password=""

SenderMail=""

SenderName="Armada Server" UseSSL="False" />

<HttpTimeouts GetTimeout="10000" PostTimeout="10000"

172




Belgium


ReadWriteTimeout="10000" />

<AgentHttpGet MaxThread="10" RetryDelayInSecond="60"


<AgentHttpPost MaxThread="10" RetryDelayInSecond="60"


<AgentFtpUpload MaxThread="10" RetryDelayInSecond="60"


<LocalFileStorage FolderPath="" />

<PingAgent MaxThread="1" RefreshPeriod="3600" />

<AgentWriteHeartbeatToDatabase enabled="False" period="60000">

<query> </query>

</AgentWriteHeartbeatToDatabase>

<Map UseLocalMap="False" PathLocalMap="" UseCacheOnClient="True"

Provider="OpenStreetMap" />

<PasswordPolicy UsePasswordPolicy="False" />

<Powershell Directory="PowershellDirectory" />

<Logo Path="" />

<Cleanup eventNumberToKeepByEquipment="1000" />

<ExecuteSQLQueryOnStart enabled="False">

<query> </query>

</ExecuteSQLQueryOnStart>

<BackupMonitorings

Processor="Save -p "c:\backup\<MonitoringId>" -f

"configuration_<DateTime>.xml""

/>

</ArmadaConfiguration>

</ArmadaConfigurations>

Here, we have set the PowerShell directory with the following value : "PowershellDirectory"

That means that all the scripts that are in the directory "C:\Program Files(x86)\AlphaTechnologies\ArmadaServer\PowershellDirectory". will be executed automatically when the armada server start.

If you want to change a script and enable the change without a restart of the armada server, you can ask armada server to reload the scripts using Armada Client.

You simply have to go on the "server Tools" menu, open the "PowerShell script" form and to click on the "Restart PowerShell agent" button.

173




Belgium


Alpha Technology gives you the ability to create the PowerShell scripts yourself. If you wish, we can also based on an quotation develop these scripts for you.

174




Belgium


7 SUPPORT

If you need support for installing, configuring or using Arm@da, you can:

Contact your reseller if you did not buy with direct sales channel

Open a ticket on the Alpha Technologies S.A. support center : http://support.alphatechnologies.eu/ (Please select "Software Support / Arm@da" as Help Topic)

Send a mail to [email protected]

Remote Access

In order to provide efficient support, we might need a remote access to your server. This access will be restricted to the duration of the intervention only.

Alpha Technologies can provide remote support via “LogMeIn” (remote desktop application).

For this purpose, we need:

server connectivity to the internet (HTTP protocol)

an administrator account of this host

We can also use TeamViewer or connect over Remote Desktop in your VPN.

http://support.alphatechnologies.eu/

mailto:[email protected]

arm dacustomer.alphatechnologies.eu/armada/userguide/... · alpha technologies s.a. avenue...

Documents