============================================================================================
			EMCLI Launcher version R18A39 (CXC1737124/3 R523A01)
============================================================================================

The Element Management Command Line Interface (EMCLI) is a terminal-based CLI tool that allows the user to monitor and manage the Managed Element (ME) for Baseband Radio Node. The EMCLI Launcher is a tool that is used to start EMCLI on Windows. 

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

1. Package contents

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

The package consists of EMCLI installation wizard that is used to install the following EMCLI components on Windows-based PC:

1. EMCLI Launcher

2. Cygwin for EMCLI

The EMCLI Launcher may be installed and used in parallel to other Element Management applications used for other node types.

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

2. Usage

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

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

2.1 Prerequisites

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

- Java Runtime Environment version 7 or later (may be downloaded from http://java.com/download).

- Internet connection required for Cygwin installation.

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

2.2 Installation

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

- Run emcli_install.exe to install EMCLI components on the PC. 

- Select either Quick installation or Custom installation and follow instructions on screen.

- After completed installation, EMCLI is available by starting EMCLI Launcher from the Windows Start menu or a desktop short-cut.

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

2.3 Notes for Cygwin

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

- Cygwin is always installed under C:\cygwin. Any Cygwin installation already existing in that directory will be updated.

- Backup of the existing Cygwin user home directory is performed automatically during installation. The files are copied to C:\Users\[USER_NAME]\Ericsson\EMCLI_Launcher\cygwin_backup directory.

- Cygwin installation may be skipped in the EMCLI wizard, in case it has already been installed before or is going to be installed at a later time.

- Cygwin may also be installed manually, by following instructions from chapter 4.1.

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

2.4 Re-installation

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

If re-installing the EM installation, please run uninstall first.

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

3. Limitations

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

Note that the following limitations apply for EMCLI Launcher:

- The installation wizard works only under Windows, other operating systems are not supported. 

- Cygwin installation is not supported when Internet connection is unavailable (but you may still install EMCLI Launcher).

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

4. Troubleshooting

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

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

4.1 Cygwin - manual installation

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

The EMCLI tool needs a Cygwin installation as execution environment to run on Windows. Moreover, the Cygwin installation needs to comply with the package specification below.	By default Cygwin is installed automatically by the EMCLI Launcher. If for some reason you need to install it manually, please follow these instructions to install Cygwin (at least Cygwin version 2.7.0) for EMCLI on Windows.

1) Download the Cygwin Installer from the official Cygwin web site. Select the 32-bit version.

2) Execute the setup-X86.exe file (32-bit installation).

3) Choose the "Install from internet" option, then click Next.

4) Root Directory "C:\cygwin" (It is not allowed to choose a different directory, especially if it contains spaces). If prompted for "Default Text File Type", choose UNIX (not DOS). Then click Next.

5) Do various applicable selections and click Next repeatedly.

6) When Select Packages page appears, select View by Category and add the following packages:

	- under "Archive", select "zip" and "unzip"

	- under "Net", select "curl", "inetutils", "openssh", "openssl"

	- under "Perl", select "perl", "perl-XML-Simple", and "perl-IO-Tty"

	- under "Libs", select "liblzma5", "libglib2.0_0", "libuuid1", "libpopt0", "libxml2" and "libssp0"

	- under "Tcl", select "expect"

	- under "Shells", select "rxvt VT102"

	- under "Database", select "postgresql"

	- under "Graphics", select "gnuplot"

	- under "Python", select "python2" and "python3"
	- under "Editors" select "vim" (optional)

7) Click Next and installation of Cygwin will start. Wait for the installation to complete.

8) Open a Cygwin terminal window by double-clicking on the Cygwin icon in the start menu or on the file C:\cygwin\cygwin.bat. The window should be black with white text and the prompt should like this: [~]$ If not, then go through all the steps again and make sure you haven't missed out anything. The Cygwin terminal window can then be closed.

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

4.2 EMCLI Logging Instructions

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

As an aid to help troubleshooting issues with the EMCLI tool itself, a log tracing the EMCLI execution is needed.

The following log files are created automatically and stored under C:\Users\[USER_NAME]\Ericsson\EMCLI_Launcher\logs directory:

- cygwin_setup.log

- emcli_install.txt

- emcli_launcher.txt

- emcli_java0.log

When reporting a problem with EMCLI, please include all the logs listed above in the report.

============================================================================================

THIRD PARTY SOFTWARE

============================================================================================

This software is based on the following third party open source software components: Inno Setup, Copyright © Jordan Russell and Martijn Laan, and Inno Download Plugin, Copyright © Mitrich Software.

InstallAnywhere is a registered trademark of Flexera Software 

Java is a trademark of Oracle 

Windows	is a registered trademark of Microsoft Corporation. 

The Cygwin DLL and utilities are Copyright © Cygwin authors. Other packages have other copyrights. 

All other marks are properties of their	respective owners.
