E5 ECF INSTALL Client 2013-05-01

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 20

European Co-ordination Centre

for Accident and Incident Reporting Systems

ECCAIRS 5 Reporting System

CLIENT
I N S T A L L A T I O N MANUAL
ECCAIRS LICENSE AGREEMENT
Copyright © 1995–2013 Joint Research Centre of the European Commission.
ECCAIRS, the ECCAIRS logo, and the ECCAIRS products refer to a series of Software applications developed by
European Commission in the context of the European Coordination Centre for Accident and Incident Reporting
Systems (ECCAIRS). All other trademarks are property of their respective owners. Information contained herein is
subject to change without notice. All rights reserved.
END-USER LICENSE AGREEMENT
Except where otherwise noted, all of the documentation and software included in the Setup package is copyrighted
by the Joint Research Centre of the European Commission.
IMPORTANT- READ CAREFULLY
As used in this Agreement, "JRC" shall mean "The Joint Research Centre of the European Commission".
"Software" shall mean "the software package, which is part of the ECCAIRS software suite and which may include
associated software components, media, printed materials and electronic documentation".
This License Agreement is a legal agreement between you (either an individual or a single entity) and JRC related
to the usage of the Software. By installing, copying, or otherwise using the Software, you agree to be bound by the
terms of this Agreement. If you do not agree to the terms of this Agreement, do not install or use the Software.
SOFTWARE LICENSE
The ECCAIRS suite of products is being distributed by JRC to competent authorities (Civil Aviation Authorities and
Accident Investigation Bureaus) of EU Member States who are entitled to use the software for implementing EU
Directive 2003/42/EC on Occurrence Reporting in Civil Aviation.
An ECCAIRS National Point of Contact (see Directive 2003/42/EC) can provide the ECCAIRS products to
operators and service providers under specific conditions:
 A National Point of Contact shall provide the Software only to operators and service providers placed under
their responsibility.
 Usage shall be limited to those situations where it will enable a more efficient circulation of occurrences
information between reporting bodies and national regulators/investigators in the scope of Directive
2003/42/EC on Occurrence Reporting in Civil Aviation.
 In accordance with the rules governing the dissemination of information related to occurrence reporting,
these operators and service providers will not be allowed to have direct access to the central repository of
ECCAIRS.
 Each National Point of Contact shall ensure the necessary technical support to operators and service
providers to which the Software has been provided.
 Each National Point of Contact shall inform the Commission on operators and service providers to which
the ECCAIRS Software is given.
 National Points of Contact are not allowed to make a charge for distributing this Software to operators and
service providers.
By using this Software, you agree to these terms and the terms of the Disclaimer:
DISCLAIMER
This Software and any support from JRC are provided "AS IS" and without warranty, express or implied. JRC
specifically disclaims any implied warranties of merchantability and fitness for a particular purpose. In no event will
JRC be liable for any damages, including but not limited to any lost profits, lost savings or any incidental or
consequential damages, whether resulting from impaired or lost data, software or computer failure or any other
cause, or for any other claim by the User or for any third party claim.

Internet: http://eccairsportal.jrc.ec.europa.eu
ECCAIRS CLIENT INSTALLATION MANUAL CONTENTS

CONTENTS

Contents ..................................................................................................................................................... 1

1. Overview............................................................................................................................................. 3
1.1. Manual Overview ........................................................................................................................ 3
1.2. How to use this Manual............................................................................................................... 3
1.3. Client installation......................................................................................................................... 4

2. Install the Software ............................................................................................................................. 5


2.1. Remove already installed ECF, if any......................................................................................... 5
2.2. Install the Software ..................................................................................................................... 6

3. Connect to an ECCAIRS Server......................................................................................................... 9


3.1. Add a Repository connection ...................................................................................................... 9
3.2. Set a Repository Alias............................................................................................................... 12

4. Forms to print and fill ........................................................................................................................ 15


4.1. How to use these forms ............................................................................................................ 15
4.2. Requirements............................................................................................................................ 16
4.3. Configuration............................................................................................................................. 17

1
ECCAIRS CLIENT INSTALLATION MANUAL CONTENTS

THIS PAGE IS LEFT INTENTIONALLY BLANK

2
OVERVIEW MANUAL OVERVIEW

1. OVERVIEW

1.1. MANUAL OVERVIEW


This Manual describes how to install and configure the ECF 5 (ECCAIRS Common Framework 5) Client
Software with the most commonly used configuration options, which are listed in Chapter 2.
In the rest of this Manual we use the term ECCAIRS in place of ECF 5.
There are three ECCAIRS Software installation types: Client, Server, and Web Server, that are shortly
described in the rest of this Chapter. The Client Software is also automatically installed when you
perform an ECF 5 Server or Web Server type of installation.
There are specific installation manuals for ECCAIRS Server and Web Server installation, with the most
commonly used configuration options.
There is also a comprehensive manual with all installation types and all the available options, even the
less common ones: the "ECCAIRS 5 Software Installation and Configuration Manual".

1.2. HOW TO USE THIS MANUAL


To install and configure the Software just follow each Chapter one after the other.
For your convenience, at the end of this Manual you find a Chapter with:
 Requirement Form - to verify the hardware and software requirements.
Check this form before starting the installation.
 Configuration Form - to write down the configuration parameters that you set in your specific
installation. Several parts of this Manual refer to previously set configuration parameters that you
noted in that form, so it very important that you fill it in while you are setting up the system.

3
OVERVIEW CLIENT INSTALLATION

1.3. CLIENT INSTALLATION


The Client type of installation provides all the standard ECCAIRS applications (Browser, Grapher, Data
Manager, etc) that can access data provided by one or more ECCAIRS Servers on different Computers
over the network. A Client Installation installs all the core ECCAIRS Software components and the
standard ECCAIRS applications. It does not allow to create and manage Repositories on ECCAIRS
Servers or configure any option on ECCAIRS Web Servers.

ECCAIRS 5
REPOSITORY 1
REPOSITORY 2 REPOSITORY
MANAGER

REPOSITORY N
ECCAIRS 5

BROWSER
SERVER 1
GRAPHER

DATA
MANAGER

PC CLIENT ECCAIRS 5
REPOSITORY 1
REPOSITORY 2 REPOSITORY
MANAGER

CLIENT REPOSITORY N
INSTALLATION

SERVER n

4
INSTALL THE SOFTWARE REMOVE ALREADY INSTALLED ECF, IF ANY

2. INSTALL THE SOFTWARE

2.1. REMOVE ALREADY INSTALLED ECF, IF ANY


Before installing any ECF 5 Software, you have to remove any previously installed release, either Client,
Server or Web Server.
If you already have a Client installed that you are about to remove then you may want to backup some
configuration before.

Backup Repository links


Both for Client and Web Server/Server installations you may also want to backup the Repository links
used to login on ECCAIRS Servers from any Client application.
Select "START > All Applications > Eccairs 5 > Browser".

In the "Login" dialog click "More" to get extended version of the dialog, and click "Export" there. In the
"Export Repositories connections" dialog that shows up you can select which Repository connection to
backup.
When you have installed the new ECCAIRS Software, start the "Browser" again and in the "Login" dialog
click "More" and then "Import" to restore the Repositories connections.

5
INSTALL THE SOFTWARE INSTALL THE SOFTWARE

2.2. INSTALL THE SOFTWARE


The ECCAIRS distributable setup Software is a single executable file, available as a download from the
ECCAIRS portal.
To install the ECCAIRS Client Software proceed as follows:
1. Execute the distributable setup file, for instance E5ECFDistributionV5161.exe, to extract
the actual setup files.
You have to specify a folder where the setup files will be put or accept the default.

2. Open the folder where the files have been extracted and read the Release Notes document that
provides important release-specific information on installation and configuration.

6
INSTALL THE SOFTWARE INSTALL THE SOFTWARE

3. From the same folder execute the setup program named "E5ECFSetupV5nnn.exe", where nnn
are 3 digits that qualify the specific release you are installing. The installation wizard is displayed.

4. Click "Next" to get to the "Welcome" step and then again "Next" to get to the "Accept License"
step. You have to choose explicitly the "I Accept the terms of the license agreement" option
and then click "Next" to continue.
5. In the "Customer Information" step keep the default option choice to "Anyone who uses this
computer (all users)". Click "Next" to continue.
6. In the subsequent "Select Installation Folder" step specify the installation folder for the application
and click "Next"
If possible, keep the default installation folder proposed:
C:\Program Files\ECCAIRS5 (in 32 bit systems)
C:\Program Files (x86)\ECCAIRS5 (in 64 bit systems).
If you decide to change the installation folder, write down its full path in the "Configuration Form".
7. Select "Client" in the "Setup Type" step and click "Next" to continue.

8. Click "Next". In the "Ready to install the Program" step click "Install".
Before this step you can always click "Back" to revise the previous steps or "Cancel" to abort the
installation.

7
INSTALL THE SOFTWARE INSTALL THE SOFTWARE

9. Once installation is over, click "Finish" to exit the installation wizard.


10. On exiting the ECCAIRS setup the "Test ECCAIRS 5 Installation" tool is automatically started
and shows the result of an automatic check performed on all the Software components installed.
All the items in the "Summary" tab should be ticked and marked in green.

If any item is not marked in green, contact the JRC ECCAIRS Coordination and Development for
support and/or refer to the "Test ECCAIRS 5 Installation" tool's own help and documentation.
A blue item also means that the test is passed, but it has generated some warning. For instance
a configuration file may have been modified by the User. This may happen when you run the
"Test ECCAIRS 5 Installation" tool after customisation and configuration. It should not happen
when you are installing the Software at this step. Contact the JRC ECCAIRS Coordination and
Development for support.

8
CONNECT TO AN ECCAIRS SERVER ADD A REPOSITORY CONNECTION

3. CONNECT TO AN ECCAIRS SERVER

All the ECCAIRS Client applications installed need to log on to Repositories on one or more ECCAIRS
Servers. To be able to do that, you first have to configure a link to the ECCAIRS Server Repository you
will log on to, using a specific network connection protocol. The Client-Server communication protocols
available are:

 Web Services: including Net.TCP, Basic HTTP, Ws HTTP.


The Web Services access protocols needs to be installed on the Server you are connecting to.
On the client side, the main advantage in using Web Services protocols is to allow ECCAIRS
Client-Server connection both over LAN and over WAN. This allows to use ECCAIRS over
Intranet, VPN and Proxy.
 DCOM (legacy solution)
DCOM is commonly configured and made available in all network-accessible ECCAIRS 5
Servers, and is the same and only protocol used in the previous release, ECCAIRS 4.

Secure connections (advanced option not described in this manual)


 Secure Web Services: including Net.TCP, Basic HTTPS, Ws HTTPS.
ECCAIRS There are also secure versions of the Web Services: Basic HTTPS, Ws HTTPS.
These provide a reasonable guarantee that one is communicating with precisely the web site that
one intended to communicate with (as opposed to an imposter), as well as ensuring that the
contents of communications between the user and site cannot be read or forged by any third
party.
The Server you are connecting to must be especially configured for this type of protocol.
In addition, on the computer where you are installing the client Software, you also have to install
a Security Certificate to identify the Server.
To set up both the ECCAIRS Clients and Servers for Secure Web Services connections refer to
the comprehensive "ECCAIRS 5 Software Installation and Configuration Manual".

3.1. ADD A REPOSITORY CONNECTION


Whatever the specific communication mode that the client ECCAIRS application will use to connect to a
Repository on an ECCAIRS Server, you have to perform the following preliminary steps:
1. Launch the "ECCAIRS Browser" application (or any other Client application).
The "Login" dialog shows up.
The drop-down list next to Repository is initially empty, In any case, even when already
populated, let us say that the Repository we want to link is not yet in the drop-down list.

9
CONNECT TO AN ECCAIRS SERVER ADD A REPOSITORY CONNECTION

2. Click "More" to display more options in the "Login" dialog.

3. Click "Add" to display the "Add Repository" dialog.

4. Use the "Protocol Type" drop-down list to select the Protocol type among:
o DCOM
o Web service
In the figures below you see examples of the different options for the various protocol choices.

10
CONNECT TO AN ECCAIRS SERVER ADD A REPOSITORY CONNECTION

The dialog displays different parameters to set, according to the specific protocol chosen.
Ask your ECCAIRS System Administrator for the protocol and parameters to enter to connect to
a specific ECCAIRS Server. For more information refer to the comprehensive "ECCAIRS 5
Software Installation and Configuration Manual".

5. Once you have specified the protocol and its options, click "List" to display the list of the
Repositories defined on that Server.
6. Select the Repository among those listed in the box.
7. Click "OK" to close the "Add repository" dialog.

8. Now the "Repository" drop-down list shows the newly added Repository.

11
CONNECT TO AN ECCAIRS SERVER SET A REPOSITORY ALIAS

3.2. SET A REPOSITORY ALIAS


The name of Repositories is set within the ECCAIRS Server, when defining a new Repository.
In addition you can define an "Alias" that can be used by the Client applications to display a more
meaningful Repository name in the "login" dialog.
The use of an Alias becomes mandatory if you are referencing a Repository on a Server, but you already
have a reference to a Repository with the same name hosted on another Server.
For instance, you have a Repository called ‘REP1’ on a Server called ‘SRV1’, and you are connecting to
a Server called ‘SRV2’ where a Repository called ‘REP1’ is also available.
Because of the fact that ECCAIRS uses the Repository’s name for associating the target Server, then
‘REP1’ is not sufficient for uniquely identifying the correct Server.
The Repository Alias bypasses this limitation, because it allows defining a free format unique identifier
for the Repository. In the example, a valid Alias could be ‘REP1 on SRV2’. ‘REP1’ would continue to
reference the ‘SRV1’ Server.
To create an Alias perform the following steps:
1. Launch the "ECCAIRS Browser" application (or any other Client application).
The "Login" dialog shows up.

B
2. Select the Repository that you want to assign an "Alias" in the "Repository" drop-down list.
3. Click the "More" button.

12
CONNECT TO AN ECCAIRS SERVER SET A REPOSITORY ALIAS

4. Click the "Edit" button to display the "Add Repository" dialog.

5. Enter the "Alias" name in the corresponding field at the bottom.


6. Click "OK" to confirm.

7. Now the "Repository" drop-down list also shows the Repository with its "Alias" displayed in
parentheses.

13
CONNECT TO AN ECCAIRS SERVER SET A REPOSITORY ALIAS

THIS PAGE IS LEFT INTENTIONALLY BLANK

14
FORMS TO PRINT AND FILL HOW TO USE THESE FORMS

4. FORMS TO PRINT AND FILL

4.1. HOW TO USE THESE FORMS


Print the following forms to:
 check the requirements met, and note down related details
 check the options you have installed and specify the corresponding settings used.
This data may be useful both to document the installations made and as information to provide for
system support.

15
FORMS TO PRINT AND FILL REQUIREMENTS

4.2. REQUIREMENTS
COMPUTER NAME______________________________________________________________
COMPUTER LOCATION _________________________________________________________
Tick the requirements met and specify details for your specific installation. These may be useful both to
replicate the installation and for system support.

Hardware Requirements
 H/W REQUIREMENTS (TICK WHEN ARE ALL MET)

 CPU: AS FOR ANY OFFICE CLIENT PC CPU .............................................


DETAILS ......................................

 RAM: AT LEAST 2 GB RAM .............................................


DETAILS ......................................

 HD: 100 MB FREE SPACE HD FREE SPACE ........................


TOTAL HD SIZE ..........................

Software Requirements
 S/W REQUIREMENTS (TICK WHEN ARE ALL MET)

OS - Any of:  32 bit


 Windows 7  64 bit
 Vista SERVICE PACK .........................
 Windows XP SP3
NOTES ........................................
 Windows Server 2008 R2 .....................................................
 Windows Server 2003 .....................................................

 .NET 4.0 FULL INSTALLED VERSION ....................................

16
FORMS TO PRINT AND FILL CONFIGURATION

4.3. CONFIGURATION

COMPUTER NAME______________________________________________________________
COMPUTER LOCATION _________________________________________________________

 REPOSITORY NAME ..................................................................................................................


 REPOSITORY ALIAS (if any) .......................................................................................................
 ECCAIRS 5 SERVER COMPUTER .............................................................................................

PROTOCOL TYPE:  DOMAIN/SERVER NAME.............................................


 DCOM  NETWORK PASSWORD ..............................................
(only for connection to a remote ECCAIRS 5 Server)

PROTOCOL TYPE:  SERVICE ADDRESS ....................................................


......................................................................................
 Net.TCP
 NOTES .........................................................................
 Basic HTTP
......................................................................................
 WS HTTP

 REPOSITORY NAME ..................................................................................................................


 REPOSITORY ALIAS (if any) .......................................................................................................
 ECCAIRS 5 SERVER COMPUTER .............................................................................................

PROTOCOL TYPE:  DOMAIN/SERVER NAME.............................................


 DCOM  NETWORK PASSWORD ..............................................
(only for connection to a remote ECCAIRS 5 Server)

PROTOCOL TYPE:  SERVICE ADDRESS ....................................................


......................................................................................
 Net.TCP
 NOTES .........................................................................
 Basic HTTP
......................................................................................
 WS HTTP

17

You might also like