02 Setup

Setup Overview Page 1 of 38
Setup
This chapter describes how to install ETAP for stand-alone systems and network licenses. It contains the following sections:
l System Requirements for ETAP include minimum and recommended settings.
l ETAP Installation provides a step-by-step procedure for installing ETAP and the License Manager.
l ETAP User Guide Installation provides a step-by-step procedure for installing the ETAP User Guide.
l ODBC Configuration provides detailed instructions on the successful installation of SQL Server. SQL server requires an advanced knowledge of Windows
networking, application installation, and a licensed copy of SQL Server.
Note: ETAP 11.1 and higher no longer support Oracle Database.
l ETAP Startup illustrates how to start the program after successful installation.
l ETAP Licensing describes security hardware keys and different ETAP licensing configurations, where they are applied, how they work, and which operating
systems are required.
l License Manager Server describes how the License Manager is used.
l License Manager Installation describes the installation of the ETAP License Manager for network licensing of ETAP.
l License Manager Verification shows how to verify the ETAP License Manager installation.
l Installation Maintenance (Uninstall) describes how to remove or modify the currently installed version of ETAP.
l User Guide Removal describes how to uninstall the ETAP User Guide.
l License Manager Removal describes how to uninstall the ETAP License Manager.
l System Optimization describes the computer hardware, virtual memory file size, and ODBC DSN buffer size requirements to increase the speed of ETAP
operation.
l DataX Manager Installation provides a step-by-step procedure for installing ETAP DataX Manager.
Return to Setup Overview
System Requirements
Operating System (64-bit)
l Microsoft® Windows® 10 (Home Premium, Professional, Enterprise)

l Microsoft Windows 8 & 8.1 (Standard, Professional)
l Microsoft Windows 7 (SP1) (Home Premium, Professional, Ultimate, Enterprise)
l Microsoft Server 2016 (Standard), Server 2019 (Standard)
l Microsoft Server 2012 & 2012 R2 (Standard)
Software Prerequisites
Internet Explorer® 10 or higher (or minimum version level specified by the Operating System) ETAP automatically installs the following:
l Microsoft .NET Framework v3.5 (SP1)

l Microsoft .NET Framework v4.7.1
l Microsoft Visual C++ 2005
l Microsoft SQL Server Compact 4.0 SP1 x64
l Microsoft Windows Update (KB2670838)
l Microsoft SQL Server 2012 Express LocalDB (x64) SP4
l Microsoft SQL Server 2012 Native Client (x64)
l Intel® Visual Fortran Redistributable on Intel® 64 Setup 2016.4.246
l Intel® Visual Fortran Redistributable for Windows® on Intel® 64 11.1.072
Other Third-Party Software
l DB Browser for SQLite

l Python 3.8.4
l Microsoft SQL Management Studio 2012 (x64)
l MongoDB 4.2.3 2008R2Plus SSL (64 bit)
l SAP Crystal Reports runtime engine for .NET Framework (32-bit)
l Sqliteodbc 0.9995
PC Configuration Requirements
l 64-bit hardware
l USB port for security key
l Ethernet port w/ network access (if network licensing required)
l DVD Drive, 10 to 80 GB hard disk space (based on project size, number of buses)
l Recommended Display
¡ 21" monitors or higher
¡ Dual monitors highly recommended
file:///C:/Users/JOHN%20RESTREPO/AppData/Local/Temp/~hh30B.htm 15/01/2023
¡ Resolution – 1920x1080
¡ Font size – 100% - 125%
Recommended Hardware
100 Bus Projects 1,000 Bus Projects

Intel Core i5 or better – 2.4 GHz or better Intel Core i7 or better – 3.0 GHz or better
8 GB of RAM 16 GB of RAM (high-speed)
500 Bus Projects 10,000 Bus Projects and Higher

Intel Core i5 or better – 3.0 GHz or better Intel Core i7 or better – 3.0 GHz or better
8 GB of RAM 32 GB RAM - (high-speed)
ETAP Installation
This section describes the ETAP installation procedure. ETAP provides all the necessary tools to build and maintain the Microsoft SQL databases used for your ETAP
projects. Other database formats such as Microsoft SQL Server require a separate license from the appropriate software developer/distributor.
Uninstalling Previous Versions of ETAP

The latest ETAP installation can coexist with earlier releases of ETAP. Removing older versions of ETAP is not necessary to run the latest version.
If you would like to uninstall earlier versions of ETAP, go to the Control Panel and select Add or Remove Programs. Then select and uninstall any earlier ETAP
installations. Any user-created files, as well as the ETAPS.INI file and the ETAPLIBX.LIB file (where X is 6, 7, 11, 12, 14, 16, 18, and 19 depending on the version) will not
be removed by the uninstall procedure.
ETAP Setup uses the uninstaller of the previous versions to uninstall them.
Installing ETAP
This section provides a step-by-step installation procedure for:
1. ETAP Software including libraries, example projects, help file, and more
2. ETAP User Guide
3. ETAP License Manager required for all stand-alone and network licenses
Installation Options
Online
To download the new ETAP release, login to ETAP Help Desk, using your valid Help Desk account.
1. Visit support.etap.com and log into your ETAP Help Desk account
2. From the FAQ tab, click “Download ETAP” and continue as prompted
3. Once the download is complete, extract the files and run ETAPINSTALLER.exe
DVD
Insert ETAP DVD and run ETAPINSTALLER.exe
Before Installing
l You must have administrator rights to your computer

l Turn off User Account Control (UAC) and Windows Firewall
l Close all other applications
Note: ETAP installation will automatically include the engineering device library (.lib) and main program executable (etaps64.exe) into Windows Defender Exclusion
List. This is to prevent Windows Defender from scanning the engineering library when linked to a project file.
Language Settings
Verify the correct language package settings are installed with an English Operating System to properly view the translated output reports. The settings for each
operating system are provided below:
Operating System Language Package Settings

1. Control Panel / Windows Update / Restore hidden Updates
Windows 7 Ultimate & Enterprise
2. Select the language
1. Control Panel / Clock, Language, and Region / Language
Windows 8
1. Start Menu / Settings / Time & Language / Region & Language
Windows 10
Note: The operating systems listed above are required to properly view Japanese and Chinese Output Reports with an English operating system.
For more information on Windows Language Package Settings, view Microsoft Technical Support for Language Package Settings.
Activation Code
As needed, ETAP will prompt you for a software Activation Code which is located on the ETAP DVD sleeve or provided to your IT contact via email.
Software Prerequisites
ETAP automatically installs prerequisites as needed. For a complete list of prerequisites, refer to the System Requirements section of this installation guide.
In this installation procedure, your DVD drive is designated as the D: drive. If this is not the case, replace the letter D with the correct designation of your DVD drive.
The same installation procedure is used to install ETAP regardless of the licensing method (stand-alone system or network).
1. ETAP Installation Manager
Stand-Alone License
ETAP and ETAP License Manager will be automatically installed on the same computer. The ETAP Security Key must be located on this computer.
Network License
Install the ETAP License Manager on a computer designated as the ETAP License Manager Server. In this configuration, the ETAP Security Key must be located at the
ETAP License Manager Server.
2. License Agreement. (Note: If the installation option “Software & License Manager” was selected, then the ETAP License Manager will automatically be installed
before ETAP. Details of this process are described in later section License Manager Installation)
3. Welcome.
4. System Requirements
5. Previous Version Reports
Note: All previous version ETAP reports will also be available on ETAP Help Desk for download.
6. Installation Path Selection
7. The installer displays the Setup Status screen and starts copying files to your installation of ETAP. The installer also adds an ETAP shortcut to the program folder.
By default, the Setup program will create a program folder named ETAP XXXX (where XXXX represents the ETAP version installed).
Billboards will be shown during the file transfer period. These billboards highlight some of the latest features and technologies of ETAP.
The following is an example of typical folders created by ETAP:
8. Installation Complete
9. Click Verify to run the installation verification tool.
10. Click Finish to close the setup wizard. Depending on your operation system and your system configuration, the installer might display the ETAP Installation
Complete screen and ask you to restart the machine. Select to restart the machine so that any configuration changes that were made can take effect.
Installing the ETAP Library File

If the installation folder chosen during the ETAP installation contains an ETAP library with the name etaplib2000.lib, the installation program will preserve the existing
ETAP library.
The installation program renames the existing ETAP library to oldetaplib2000.lib before installing the new library etaplib2000.lib. If an oldetaplib2000.lib already exists
on the target computer, the installation program directs you to make a backup copy of the old file or move the old file into a different subfolder. Otherwise, the
installation program will overwrite the current oldetaplib2000.lib with a copy of the existing etaplib2000.lib.
Registering Data Source Name

The installation program automatically sets up and registers the ODBC Data Source Names (DSNs) and otireportsql. Additional DSNs, otisql, otilocaldb, and
otireportsldb (required for reporting), can be added by the user to support SQL and LocalDB, respectively.
Completing the ETAP Installation

When the ETAP installation is completed, an ETAP program shortcut is automatically placed on your desktop. The Setup program also creates an ETAP program
shortcut in the Start menu under All Programs.
ODBC Configuration
A System Data Source Name (DSN), versus a User DSN, gives any user logged into the computer access to this driver. By default, the ETAP Setup program will configure
and register system DSNs necessary to run ETAP with Microsoft SQL Server (otisql, otireportsql, otilocaldb, and otireportldb (required for reporting), can be added by
the user to support SQL and LocalDB.
SQL Server Database

SQL Server requires a custom installation with information specific to your network and the SQL Server setup. ETAP requires you to already have SQL Server 6.5 or
higher installed on your network.
1. In the Control Panel, open Administrative Tools, and then open Data Sources (ODBC) or (ODBC 32-bit Administrator). Windows displays the ODBC Data Source
Administrator dialog box.
2. Click the System DSN page, and then click the Add button.
3. Select the latest SQL Server entry (Ex: ODBC Driver 17 for SQL Server) in the Name column. Click Finish.
4. In the Name text box, enter otisql.
5. In the Description text box, type a description of this data source that you will recognize.
6. In the Server text box, type the name of the server you will be using. Consult your network administrator or SQL Server administrator for this information.
7. Click Next twice, and then make sure the following options are selected (ETAP runs at least four times faster if selected):
Note: The SQL Server may require some system-dependent installation procedures. Contact your network administrator or Operation Technology, Inc. for technical
assistance.
Local SQL Database

Local SQL is defined as any SQL Server in which the ETAP User is assigned as the Sys Admin Server Role on the SQL Server. This allows the user to have sufficient SQL
Server rights to automatically perform actions on the SQL Server that allow the database to be added, attached, detached, and destroyed without IT (or other)
intervention.
3. Select the SQL Server entry in the Name column. Click Finish.
4. In the Name text box, enter otilocalsql
6. In the Server text box, type the name of the server you will be using.
SQL Reporting
In order to support Crystal Reports with SQL and Local SQL, an additional DSN must be included with the otisql or otilocalsql dsn for projects. The same SQL Server used
when setting up otisql or otilocalsql is used for this dsn.
3. Select the SQL Server entry in the Name column. Click Finish.
4. In the Name text box, enter otireportsql
6. In the Server text box, type the name of the server you will be using.
ETAP Licensing
Security Hardware Keys
Starting with ETAP 11.0.0, ETAP will utilize the following type of security hardware key to license the use of the software:
Stand-Alone Hardware Key Placed and resides on the back of your computer
Network Hardware Key Placed and resides on a License Manager Server
*A Network Hardware Key is required for Borrowing Licenses
ETAP will provide an ETAP key for USB ports.
ETAP-OTI 1600
The driver for the ETAP-OTI-1600 key is located in the following path:
64-bit machines:
C:\Program Files\Operation Technology Inc\ETAP License Manager\haspdInst.exe
Please contact sales at sales@etap.com or 949-900-1000 for any key replacement.
Note: ETAP will no longer support the black parallel keys and the blue USB-1410 keys.
Stand-Alone System Version of ETAP Licensing

A stand-alone system hardware key is placed directly on the USB or parallel port of the computer that will be running the software. Starting from ETAP 6.0.0, the ETAP
License Manager will be automatically installed for the stand-alone systems. The ETAP License Manager program and the stand-alone key provide authorization for
ETAP operation.
Network Version of ETAP Licensing

A network security hardware key requires a Windows 7 (or higher), or Server 2012/2016/2019 workstation or server. Place the network hardware key on the back of
the computer/server designated to license ETAP. This will be the permanent location of the key – do not remove it once it is operational.
Installation on Windows must be performed by a user account with Windows Administrative privileges. The network installation can be done with the License Manager
Setup program provided on the ETAP DVD, started from the ETAP Installer program, or installed manually. Regardless of how the network installation is done, the steps
to be performed are the same.
ETAP License Checkout/Borrowing

ETAP License Borrowing (License Check-Out) is a licensing feature that permits clients with a multi-user network key to generate ETAP license activation codes that can
be used as stand-alone licenses on independent computers without the need to be connected to the company network License Manager. A Borrow Code may be
generated to be used on one specific computer; once the Borrow Code is activated, that license will be subtracted from the overall network key total and will be
automatically available again only after the expiration period.
Requirements:
l Network license - LAN, Regional WAN or WAN (does not apply to Stand-Alone licenses)
l License borrowing option requires ETAP Hardware Key (Version 3 - Green key) to be connected at LM Server computer at time of Borrow Code activation
Capabilities:
l License borrowing option can be set up through the ETAP LM Configuration console.
l Borrowed license can run with the computer disconnected from the network until the borrowing period ends.
l Borrowed duration is determined per user account.
l When the borrowing period expires, the borrowed license is automatically returned to the LM Server.
l LM tracks and keeps count of remaining / available licenses for checkout
l Borrowed license cannot be returned / terminated before the expiration date
l Borrowed license durations can be configured from 1 day up to 120 days
l Borrowed licenses are linked to the computers used during Borrow Code activation
It is recommended that network administrators limit network license borrowing to those users who specifically need to take licenses on the road. It is recommended
that administrators set the maximum borrow period to an amount of time that corresponds with how long these users will be away from the license manager. These
settings are controlled using LM Configuration console.
Borrowing Code Generation

The following process is executed from the computer where the Network License Manager is installed. The borrowing user does not need to be connected at this
point.
1. From the START menu, go to All Programs > ETAP License Manager. Right-click on Configuration Console and select to Run as administrator.
The ETAP License Manager Configuration console will open and display the License Manager status and Network Key configuration.
2. “Start” ETAP LM Configuration. By default the ETAP LM Configuration will be running, but if previously stopped press “Start” to run.
3. Go to “Borrow” tab.
1.
¡ Local Server: Network License Manager host identification
¡ Duration: Duration of Borrow Code; cannot be changed or canceled until set expiration. Borrow period can range from 1 to 120 days. Borrowed license
will automatically become available after expiration.
¡ Generate Code: Generates unique code that can only be used one time by one single user. Code will be tied to Duration and computer that activates ETAP
using each unique code. Codes will not count against Network Key available users if discarded and never activated on a computer.
¡ Send: When Outlook is available, ETAP LM Configuration will automatically generate an email that includes the Borrow Code information. If Outlook is not
available, ETAP LM Configuration will generate a Notepad file that can be emailed to user independently.
¡ Expiration Date: The Borrow Code expiration date and time are automatically generated and displayed from the time of code generation and selected
duration.
1.
1. Specify “Duration” and generate Borrow Code by clicking “Generate Code”. Note: Expiration Data is automatically displayed.
1.
2. After the Borrow Code is generated, email code information to end user by clicking “Send”
If Outlook is available, an email with the Borrow code information will be automatically generated when clicking “Send”.
If Outlook is not available, a Notepad file will be generated when clicking “Send”.
Send this file to the PC the license will be checked out to.
Borrowing Code Activation

The following process is executed by end user who must be connected to the company Network during activation. Note that the end user must contain the Borrowing
License information including Remote Server, Borrow Code and Expiration Date information, from the Network Key’s ETAP License Manager administrator and must
also have the ETAP License Manager, version 12.0 or higher, installed in the computer used at time of activation. See the following section for help with License
Manager Installation.
1. From the START menu, go to All Programs > ETAP License Manager. Right-click on Configuration Console and select to Run as administrator.
2. “STOP” ETAP LM Configuration Console
3. Go to “Activation” tab
1.
¡ Local Server: Computer name of machine being used.
¡ Remote Server: Server hosting the ETAP License Manager. Server that generated the Borrowing Code.
¡ Borrow Code: Code received from Remote Server and used to identify and link the computer hardware to the license being borrowed. Each borrow code is
unique.
1. Input Remote Server Information and Borrow Code information received from ETAP’s Network Key License Manager Administrator. Borrow Code is case
sensitive; it is recommended to copy and paste the Borrow Code information from email received.
1.
2. Click on “Verify Code” to verify Borrow Code validation. Code expiration details will be automatically generated.
Note: Once the license is activated, it cannot be returned or terminated until the expiration date.
Click on “Activation License” to finalize activation of verified code.
The following message will be generated when activation is successful: “Borrow successful! Please restart local License Manager Service!”
4. Go to “LM Service” tab and click “Start”.
ETAP License Manager will automatically display updated “Local Configuration” details.
Local Borrowing License has been successfully activated and ready to use. At this point it is no longer necessary to be connected to Company’s Network Server.
Launch the ETAP program as normal. ETAP version must be 12.0 or higher. ETAP will prompt end user to enter Activation Code.
Note: Activation Code is different from Borrow Code. The Activation Code must also be provided by ETAP’s Network Key License Manager Administrator. The
Activation Code is the code used for the Network Key itself and is provided by ETAP at the time of purchase.
License Termination
Please note that the Borrowing License cannot be terminated under any condition. The Borrowing License will automatically terminate at the time and date of
expiration provided at the time of Borrow Code generation and confirmed at activation. Only users connected to Network Key license can be terminated.
1. From the START menu, go to All Programs/ETAP 19.0.0 and right-click on License Manager Console and select to “Run as administrator”.
2. Go to “License” tab.
1. From ETAP’s Network Key Administrator’s view:
¡ The “License” tab lists all ETAP Licenses being used from the same Network Key
¡ Users connected to Network Key do not display Check Out or Expiration information
¡ Users using a Borrowing License will display a Check Out (Borrow) Code and Expiration information
¡ Key Type is noted as Hardware Key for the main Network Key
¡ “Terminate” button only allows users connected through Network Key to be terminated
¡ “Terminate” button will not end Borrowing License sessions
¡ “Refresh” button can be clicked to refresh the list of licenses in use
ETAP Startup
After ETAP is installed and ODBC is installed and configured, you are ready to start ETAP. Place the OTI parallel printer port module (ETAP security hardware key)
directly onto your printer port if you are using stand-alone system licensing. If you have a printer, connect your printer cable to the other side of the module.
After you install ETAP, you must restart your computer prior to starting ETAP. The restart is necessary so Windows can load the drivers associated with the printer port
module provided with ETAP. If the computer is not restarted, ETAP will not be able to read your printer port module on the back of the computer or server.
If you are using a security hardware key (one printer port module for your entire local area network), see License Manager Server, which describes the ETAP License
Manager setup procedure.
1. To start ETAP, click the Start button, and then click Programs.
2. Click the ETAP folder, and then click ETAP ##.#.#. The ETAP program starts.
Note: The first time you start ETAP, you must type the Activation Code (in XXXX-XXXX-XXXX-XXXX-XXXX-XXXX format) that came with your ETAP DVD (ETAP version
5.0.0 and higher). However, if you received an Activation Code in an e-mail from ETAP, you can copy and paste the Activation Code from the e-mail into the Activation
Code field.
Installation Maintenance
You can repair or remove your ETAP installation as required. To access these options, do the following:
1. In the Control Panel, double-click the Add or Remove Programs icon.
2. Select ETAP in the list of currently installed programs.
3. Click the Change/Remove button. ETAP Setup displays the ETAP Modify Setup Wizard.
Select the type of modification you want, and then click the Next button. Each option is discussed below. Note that the Repair option will require that you insert the
ETAP DVD during the process.
Repair
The Repair option reinstalls any program files that are missing from your original installation. ETAP Setup displays the Setup Status while it makes the changes.
Uninstall
This option lets you remove all ETAP files you have installed onto your computer. Select OK when asked whether you want to remove ETAP completely.
Note: During the uninstall process you may be asked to remove files installed as shared files. Generally, you should not remove these files to avoid disruption of other
programs.
Click Finish after modification, repair, or uninstall is complete.
Note: Depending on the modifications to your ETAP installation, you may be prompted to restart your computer for the changes to take effect.
System Optimization
If ETAP takes a long time to load or save a project file (more than several minutes), you can modify your system settings to optimize program speed. There are several
system attributes that control the speed at which ETAP loads and processes a project database, including the following:
l Computer CPU speed

l Computer RAM Size
l Operating System Virtual Memory File Size
l ODBC DSN Buffer Size
l ODBC DSN Page Timeout
Computer CPU Speed

We recommend Intel Core i5 or faster processors.
Computer RAM Size

We recommend a minimum of 4 GB of RAM. For very large network databases within ETAP, 8 GB of RAM is recommended.
Operating System Virtual Memory File Size

This can be changed through the System icon in the Control Panel. Note that your Virtual Memory file is stored on your hard disk. Therefore, if you increase the size of
this file, it will use a proportional amount of space on your hard disk. You should consult your system administrator before changing this setting.
1. In the Control Panel, double-click the System icon. Windows displays the System Properties dialog box.
2. Click the Advanced tab, and then click the Settings button in the Performance group. Windows displays the Performance Options dialog box.
3. Click the Advanced tab.
4. In the Virtual Memory group, click the Change button.
5. Make sure you have at least 200MB of disk space free, and then change the Initial Size and Maximum Size to at least 200 MB.
6. Click OK. Windows returns you to the Performance Options dialog box.
7. Click OK, and restart your computer when prompted. Once your computer restarts, the virtual memory will be changed.
ODBC DSN Buffer Size

The Data Source Name (DSN) buffer size is the internal buffer, in kilobytes, that is used to transfer data to and from ETAP to the associated project database. The
Microsoft Local SQL DB default is 16384.
1. In the Control Panel, double-click the Administrative Tools icon. Windows displays the Administrative Tools window.
2. Double-click the Data Sources (ODBC) icon. Windows displays ODBC Data Source Administrator dialog box.
3. Click the System DSN tab.
4. Select otilocalldb, and then click the Configure button.
Note: If the entry otilocaldb is not present, run ETAP once and it will place it there. If otilocaldb is still not present after running ETAP, then add it in manually.
5. Enter Name: otilocaldb
Description: localdb
Server: (localdb)\v11.0
6. Click Finish.
ETAP User Guide Installation

The installation program also installs ETAP Guide along with other documents such as: ETAP Product Overview, ETAP New Features, ETAP Real-Time Overview, System
Requirements, Installation Guide, and ReadMe. The ETAP User Guide and related documents can be viewed through the Installer Program without having to install the
User Guide. This can be done by simply clicking on the User Guide option below the Documentation (PDF) section of the Installer Program.
1. To install the ETAP User Guide, select the ETAP User Guide option that appears below the Installations section of the Installer Program.
2. Click Next on the Welcome screen to continue.
3. Setup requires the name of a destination folder on your hard drive where you would like the ETAP User Guide application to be installed. The default destination
folder is C:\ETAP User Guide XXXX. To install the program in a different location, click Browse and select or type a new destination folder. Click Next.
4. When the installation is complete, the installer displays the ETAP User Guide Installation Complete screen. Click Finish, to complete the installation of the User
Guide.
When the ETAP User Guide installation is completed, the Setup program also creates an ETAP User Guide program shortcut in the Start menu under All Programs.
User Guide Removal

You can remove the ETAP User Guide, by following the steps below:
2. Select ETAP User Guide in the list of currently installed programs.
3. Click the Uninstall/Remove button. Setup displays the ETAP User Guide Setup Wizard.
4. When asked whether you want to remove the application and all of its features, click OK.
5. When the ETAP User Guide Setup Wizard displays the Uninstall Complete dialog box, click Finish.
License Manager Server

For the purpose of running ETAP, the computer containing the network hardware key is called the License Manager Server. The License Manager Server needs to be on
and running to issue authorization for client computers to run ETAP. Each computer running ETAP (Windows 7/8/10, Server 2012/2016/2019) requests authorization
from the License Manager Server via a LAN or WAN. If the License Manager Server does not issue the requested authorization, ETAP will not run.
The License Manager Server computer does not need to have the ETAP program software installed.
ETAP License Manager

The ETAP License Manager is a program that assists the network security hardware key in licensing the use of ETAP. The network hardware key provides licensing of up
to 254 simultaneous users of ETAP via a local area network (LAN) and/or a wide area network (WAN). The ETAP License Manager manages the administration of
simultaneous ETAP users as set forth in the terms of your ETAP license agreement.
Note: Proper operation of ETAP requires the installation of the ETAP License Manager on the License Manager Server and, during each user system ETAP installation,
entering the License Manager Server name or IP address.
To connect to a specific network license you must open your project and from the ETAP Logon Editor click on ETAP License Wizard. The ETAP Logon Editor is the first
editor that appears when you open a project.
The network hardware key and the ETAP License Manager use minimal processor time and do not require more than 10MB of free disk space for proper operation.
Make sure the system meets the ETAP minimum hardware requirements.
License Manager Installation

ETAP 5.0 or higher will use this method of installation. Earlier versions will use the manual installation method described in the following section. You can also use the
manual installation procedure if the ETAP License Manager Installation program does not successfully install the ETAP License Manager.
l Installing ETAP License Manager Automatically

l Installing ETAP for Network Licensing
l Updating the ETAPS.INI File
Automated ETAP License Manager Installation

On the ETAP DVD, a separate Setup program is provided to install the ETAP License Manager. To install the License Manager on a Windows 7/8/10, Server
2012/2016/2019 workstation or server, do the following:
1. Insert the ETAP DVD into the DVD drive. The installer displays ETAP Installer dialog box. Select ETAP “License Manager”.
Note: If a License manager for a previous version is detected, the installer will remove it before installing the updated License Manager.
2. ETAP Setup displays the ETAP License Manager Welcome dialog box. Click Next.
3. The ETAP License Agreement is displayed. Click Accept to accept the terms of the agreement.
4. When the License Manager installation is complete, the installer displays the License Manager Installation Setup Complete screen. Click Finish to complete the
installation.
Return to Topic Top
Installing ETAP for Network Licensing

For each client machine, install ETAP per installation instructions in section 2.2 of this document.
To run ETAP, each user must be a registered user on the License Manager Server. As a minimum, each user must be a member of the Users group on the License
Manager Server. If you use Domain Administration as provided by the Windows server, it is sufficient to add the Domain Users group to the License Manager Server’s
User Manager/Policies/User Rights/Access.
In addition, during each user system ETAP installation, proper operation of ETAP requires entering the License Manager Server name. You can change the key selection
and License Manager Server name setting on a user system at any time after the installation.
To change the server name launch ETAP, open your project and from the Logon Editor, click on the ETAP Key Wizard and change the Server Name.
To change your key from one model to another, insert the new key, click on the Start\All Programs\Reset License Manager. This program configures the License
Manager for the key model you have selected.
Return to Topic Top
Updating the ETAPS.INI File

For each computer in need of permission from the License Manager Server to run ETAP, you can update the ETAP.INI file manually to indicate the location of the
License Manager Server.
License Manager Using TCP/IP Protocol

Update the ETAPS.INI file by doing the following:
1. Using Notepad or a similar text editor, open the ETAPS.INI file in C:\ETAP XXXX. If the ETAPS.INI file is not in the application folder then ETAP will use the
ETAPS.INI file in the C:\WINDOWS folder.
2. Add the LicPath1= line In [AppVariables] section and Add LicIndex=1 in [Etap PowerStation] section.
3. Insert the name of the License Manager Server with domain information (for example, LicPath1= tcplm.oti.com).
4. To use an IP address instead, add the line LicPath1=, and then insert the IP address of the License Manager Server (for example, LicPath1=10.10.10.191).
5. After the TCP Server or IP address is set, you may configure to use a specific port by appending the port number after the LM server name separated by ‘:’, that
you would like to use (for example, LicPath1=tcplm.oti.com:2526). Furthermore, you must verify if your target LMServer has the same TCP Port setup. Check
with your IT department before you do so.
Return to Topic Top
License Manager Verification

This help topic includes the following procedures:
l Verifying ETAP License Manager Installation

l Verifying ETAP License Manager Operation
l Troubleshooting Network License Manager
Verifying ETAP License Manager Installation

1. Restart the License Manager Server system.
2. Open a Command Prompt window, type in regedit, and then Enter. Windows displays the Registry Editor.
3. For the USB key, if the device is installed properly you can find the following device entry from: Control Panel > Administrative Tools > Computer Management >
Device Manager > Universal Serial Bus controllers.
OR... Control Panel > Device Manager > Universal Serial Bus controllers.
4. In the Control Panel, double-click the Administrative Tools icon and then the Services icon.
5. Find the Etaps Lic Mgr service and then verify that the service status is started. If you cannot find Etaps Lic Mgr, you have not installed ETAPSLMT.EXE properly.
The Etaps Lic Mgr Status value should be Started or blank.
6. If the status is blank, right-click Etaps Lic Mgr, and then select Start.
Return to Topic Top
Verifying ETAP License Manager Operation

1. In the Control Panel, double-click the Administrative Tools icon then the Event Viewer icon. The Event Viewer window is displayed.
2. Click on the Application icon. The ETAP License Manager program logs all licensing events to the Application log.
3. When the ETAP License Manager starts, you will see several events in the log identified as Source Etaps LMService. The ETAP License Manager uses this source
when it writes event information to the applications log.
4. Double-click the first ETAP License Manager event to view the Event Properties dialog box. The message references a description similar to the following:
5. The next ETAPS LMService message indicates that ETAPSLM has detected a valid security hardware key.
Etaps LMService message: 0, ETAPS License Manager starting...
6. For the next message you should see a message indication similar to the following:
Key SN: 3087007744-345610626 Licensed to: <Your Company Name> Version: 020000 Users: 5. (Your serial number, the licensee, version, and number of users will be
specific to your network hardware key.)
You have now verified your ETAP License Manager is correctly installed and running properly. The latest issue of ETAP License Manager is version 20.0.0 and is
intended to work with ETAP 4.7.0 to 20.0.0 versions. The earlier ETAP releases require version 5.2.3.102601 either TCP/IP version or Named piped version depending
on selected protocol by ETAP, see early ETAP version documentation for details.
You can check your version of the ETAP License Manager by viewing Properties in the file ; C:\Program Files\OperationTechnologyInc\ETAPLicenseManager1900\Etapslmt.exe
or C:\WINDOWSSYSTEM32\DRIVERS\ETAPSLM.EXE if you have installed the License Manager manually. The file version is displayed at the top of the Version sheet.
Return to Topic Top
Network License Manager Troubleshooting

If you get the message Could Not Find the Security Key or Failed to Receive Authorization, verify that the following statements are true:
l The latest ETAP License Manager is installed.

l Network hardware key is installed on the License Manager Server.
l The License Manager Server is turned on.
l The License Manager Server has user permissions set correctly.
l LicIndex=1 and LicPath1= is in the ETAPS.INI file on the local computer and it has been modified to include the location of the License Manager Server.
l The local computer and the License Manager Server are connected to the network.
If ETAP is still not running, contact Operation Technology, Inc. technical support at:
(949) 900-1000 or HelpDesk@etap.com or https://support.etap.com
Return to Topic Top
License Manager Removal

There may be instances when you want to remove the ETAP License Manager from your system. For example, to install a new version of the ETAP License Manager,
you first need to remove the previous one. Use the following procedure to remove the ETAP License Manager from your Services list.
Removing ETAP License Manager
2. In the list of currently installed programs, select ETAP License Manager.
3. Click the Change/Remove button. Setup prepares the ETAP License Manager Setup Wizard.
4. When asked whether you want to remove the application and all of its features, click OK.
Note: During the uninstall process; you may be prompted to remove the files installed as shared files. Generally, you should not remove shared files to avoid
disruption of other applications.
5. When the ETAP Setup Wizard displays the Maintenance Complete dialog box, click Finish.
Removing ETAP License Manager Manually
1. Logon to the computer you are using as your License Manager Server. Make sure to use an account that has Administrator privileges in Windows.
2. Make sure that no one is currently using ETAP. Removing the ETAP License Manager may disrupt their activities.
3. In the Control Panel, double-click the Administrative Tools icon then the Services icon. The Services window is displayed.
4. If the Etaps Lic Mgr status is started, select Etaps Lic Mgr in the Services list and (with it highlighted) click the Stop Service button in the toolbar. In a few
moments, Etaps Lic Mgr status will change from Started to blank.
5. Open a Command Prompt, and then go to the folder in which ETAPSLMT.EXE is installed (usually C:\Program Files\Operation Technology Inc\ETAP License
Manager\Etapslmt.exe).
6. In the prompt line, type Etapslmt –remove and press the Enter key. You should receive the message Etaps Lic Mgr removed.
The ETAP License Manager is now removed from your system.
ETAP License Wizard

After the complete installation, launch ETAP using the ETAP shortcut on your desktop or go to the Start menu and select All Programs, ETAP XXXX (where XXXX
represents the ETAP version installed).
When ETAP is launched for the first time, it may generate the ETAP License Wizard. The ETAP License Wizard allows you to setup the location of the ETAP licenses. This
Wizard was introduced in ETAP 5.5.0. For previous license setups refer to their appropriate documents.
1. Upon launching ETAP, the ETAP License Wizard prompts you with the ETAP License Path Selection Editor. In this editor the first option is automatically selected
to be your computer. If the Stand-Alone or the ETAP Network key is located on your computer, click OK to continue.
2. If the ETAP Network key is located on a server machine, then select another path option and enter the server name or the IP address in the provided field. The
five entries are designed to easily switch between ETAP Network keys. You may have several network keys with different configurations. ETAP keys must be
installed on separate PCs. Click OK to continue.
Refer to the section License Manager Server for details on installation.
ETAP Key is Found Successfully

If the installation is done properly, the ETAP License Wizard displays a message that the "ETAP key is found successfully."
Click OK.
ETAP Key is Not Found

If the ETAP license key is not found at the port that was previously specified, the ETAP License Wizard displays a message that the "ETAP key is not found or the License
Manager is not ready!"
ETAP License Manager Service (Etaps Lic Mgr)

In that case, verify that the License Manager is installed on the specified location and that the service is started. You can do so by going to the Control
Panel\Administrative Tools\Services. Find the Etaps Lic Mgr entry from the listing of services. This entry should exist and the Status should show as Started.
If this service does not exist you must install the License Manager from the ETAP 19.0.0 DVD.
If the Etaps Lic Mgr is not started then right-click on the entry and Start it. You can also double-click on this service and Start it.
Firewall
If the service starts but the client machine fails to receive authorization, check the server machine to ensure that the Windows’ firewall is not blocking incoming traffic.
To do this, go to the server machine and select “Run/Control Pane/Windows Firewall”. On the General page, note whether the Firewall is On or Off. If it is on, go to the
Exceptions page and see if the License Manager is listed and checked. If not, select the Add Port... button. Enter Etaps Lic Mgr for the Name and enter 6260 as the Port
Number. Ensure that TCP is selected. Also check the check box that requests a notification if a program is blocked and click OK. Click OK on the previous pages until you
return to the Control Panel. You may have to coordinate with your IT department to open this port.
Next go to the client machine and select “Run/Control Pane/Windows Firewall”. If it is on, go to the Exceptions page and check the check box that requests a
notification if a program is blocked and click OK on all pages until you return to the Control Panel. This should cause Windows to notify you if it blocks a request from
ETAP to access the License Manager.
ETAP License Manager Uses TCP/IP

To determine if you have TCP/IP installed, go to Control Panel/Network Connections.
1. It should list all network connections for your computer. Locate the appropriate connection under LAN or High-Speed internet.
2. Right click on the connection and select properties.
3. If you have TCP/IP installed, there will be an item listed and checked "Internet Protocol (TCP/IP)".
4. If you do not have TCP/IP installed, the item may be listed but NOT checked. In such case, there is no need to continue with this procedure, since you do not
have TCP/IP installed.
5. If it is checked, select the Internet Protocol (TCP/IP), and then click on Properties. The resulting Properties will have a general tab. I need to know the settings on
this page. Generally, most companies use Obtain an IP address automatically and Obtain DNS server address automatically.
Now that we know you have TCP/IP installed, please do the same thing (exact same procedure) on the computer running the License Manager.
If both your computer and the License Manager computer have TCP/IP installed, do the following on the computer running the License Manager:
1. Open a Command Prompt (Start/All Programs/Accessories/Command Prompt).
2. Type the following in the Command Prompt (without the quotation marks) "netstat -a". (This will tell us what ports are set up on the Etaps lic mgr server).
3. You should see an entry that lists "TCP the_server_computer_name:6260 ... LISTENING" which shows that the computer is listening for a TCP connection on port
6260. Port 6260 is the License Manager default port.
4. Next enter the following in the Command Prompt - "ipconfig". You should see a listing which contains the IP address of the computer. Note the address to
ensure that it matches the address that you have entered at the ETAP client computer.
Next go to your client computer, open a Command Prompt, and enter "ping ip_address" where ip_address is a placeholder for the IP Address that you obtained above
from you license manager computer. The ping results should indicate the time that it took to ping the computer. If the ping is not successful, it will print a timeout
message.
You should also use ping to check address translation from your computer by entering "ping lic_manager_computer" where lic_manager_computer is a placeholder for
the computer name on which you have installed the License Manager. If both pings pass, you can enter either the name of the License Manager computer *or* it's IP
Address in the ETAP client. Both should succeed. Otherwise, make sure that you have entered the IP address of the License Manager computer in the ETAP client
License Wizard.
ETAP Activation Code

If this is the first time you are launching ETAP, you will be prompted for an Activation Code. Enter the 48-character Activation Code or Borrowing License Activation
Code (case sensitive).
The following entries are generated in the ETAPS.INI file and the Activation Code is saved as shown below.
[Etap PowerStation]
LicIndex=0
[AppVariables]
LicPath0=Your Server Name or IP Address
LicKeyCode0=Your ETAP Activation Code
When authorization is received, it generates the License Administrator dialog box. It shows the total number of licenses and what users are connected to the License
Manager Server and displays a message that the "ETAP key is found successfully."
The following entries are generated in the ETAPS.INI file and the Activation Code is saved as shown below.
[Etap PowerStation]
‘LicIndex=’1 to 5 depending on LicPath
[AppVariables]
‘LicPath1=’ to ‘LicPath5=’
‘LicKeyCode1=’ to LicKeyCode5=’
The ETAP License Wizard may be launched when opening an existing ETAP project. The ETAP Logon editor includes an ETAP License Wizard button to launch the
Wizard. The ETAP Logon editor is the first editor that appears when you open a project. This option may be used to get ETAP license authorization from different
locations.
ETAP License Information

To view information regarding your ETAP license, launch ETAP, go to Help on your main toolbar and select About ETAP.
Selection of the About ETAP option opens the ETAP Enterprise dialog box. ETAP Enterprise consists of three pages: About, Capabilities, and License.
About
The About page includes the following information regarding your ETAP:
l ETAP version
l Copyright information
l ETAP address and website
l ETAP support contact information
l Sales contact information
l Licensee information
Licensee Name
ETAP Serial Number
Number of buses
Configuration (Network/Stand-alone)
License type (Nuclear, Commercial, Advantage, Educational, etc.)
Capabilities
This page of the ETAP Enterprise lists all the available ETAP modules. Modules included in your package will be shown in black letters. Modules not included in your
package will be grayed out.
License
In the License page, information regarding your license usage is displayed.
Stand- Alone Licenses

For the Stand-Alone Licenses, the port used for your hardware key and your ETAP Activation Code is displayed. You can update the ETAP Activation Code from this
page. You may need to change your ETAP Activation Code if you have purchased new modules/capabilities or you wish to switch to another key which has a different
configuration than your current one.
The Display License Managers button allows you to view any network licenses that you have specified as options for connection. This feature also provides information
regarding the selected network license such as the following:
Server Name
Total number of licenses
Number of users connected
Connected computer name
User Name
Login time
Ticket number (ETAP assigns a unique ticket number to each connection and for duration of that connection.)
To connect to a specific network license you must open your project and from the ETAP Logon editor click on ETAP License Wizard. The ETAP Logon editor is the first
editor that appears when you open a project.
ETAP DataX Manager Installation

ETAP DataX Manager (DXM) is an ASP.NET web application hosted in Microsoft Internet Information Services (IIS) Manager. It is a communications service that
provides NetPM functionality (bidirectional queued messaging) across multiple ETAP instances (master and client projects) as well as etapAPP mobile devices. It should
be hosted in a DMZ with an outward internet facing NIC and an inward, corporate LAN facing NIC. DXM does not need to be installed on the same computer as your
ETAP. Alternatively, DXM can be installed on a Cloud service, such as Microsoft Azure, Amazon WS, etc.
This section describes the installation procedure for ETAP DXM including its required database. The installation program installs the ETAP DXM and MongoDB Database
automatically.
1. To install ETAP DXM, you must have administrative access to your computer.
2. Click on DataX Manager (DXM) from ETAP installation Manager and the ETAP DXM License Agreement screen will then appear. The installation and use of ETAP is
governed by the terms and conditions of the ETAP License Grant and Agreement. User must check the checkbox to agree to the license terms and conditions before
the installation can continue. Click Install button to start the installation.
3. ETAP Setup Wizard appears. Click Next on the Welcome screen to continue.
Note: If a previous version of DXM is detected it must first be removed before installing the latest version of DXM. Removing older versions of DXM will not remove
any data that was stored in MongoDB.
4. The installation and use of ETAP is governed by the terms and conditions of the ETAP License Grant and Agreement. These terms must be accepted before the
installation can continue. Click Accept.
5. The Information screen displays hardware and software requirements as well as other useful information. Click Next to continue with the installation.
6. The Database & Notification Setup screen displays the installation path and settings for MongoDB as well as optional configuration settings for E-mail Notifications.
Notes:
l Consult with IT personnel to ensure specified Mongo Port is valid and available
l NetPM and etapAPP e-mail notifications can only be sent from DXM if properly configured during installation or through NetPM Console
7. The Choose Destination Location screen displays the installation path of ETAP DXM. Click Install.
Note: The default destination folder to install ETAP DXM is C:\ETAP XXXX\MultiUser. To install the program in a different location, click Options to switch to Setup
Options screen, Browse and select or type a new destination folder.
8. When the installation of ETAP DXM is complete, the installer displays the ETAP DXM Installation Setup Complete screen. Click Finish to close the ETAP Setup Wizard.
9. Click Close to close the ETAP DXM Setup window.

02 Setup

Uploaded by

Copyright:

Available Formats

02 Setup

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

02 Setup

Uploaded by

Copyright:

Available Formats

Setup Overview Page 1 of 38

l System Requirements for ETAP include minimum and recommended settings.

Note: ETAP 11.1 and higher no longer support Oracle Database.

l License Manager Server describes how the License Manager is used.

Return to Setup Overview

l Microsoft® Windows® 10 (Home Premium, Professional, Enterprise)

l Microsoft .NET Framework v3.5 (SP1)

Other Third-Party Software

l DB Browser for SQLite

100 Bus Projects 1,000 Bus Projects

500 Bus Projects 10,000 Bus Projects and Higher

Return to Setup Overview

Uninstalling Previous Versions of ETAP

l You must have administrator rights to your computer

Operating System Language Package Settings

1. ETAP Installation Manager

5. Previous Version Reports

6. Installation Path Selection

The following is an example of typical folders created by ETAP:

9. Click Verify to run the installation verification tool.

Installing the ETAP Library File

Registering Data Source Name

Completing the ETAP Installation

Return to Setup Overview

SQL Server Database

4. In the Name text box, enter otisql.

Local SQL Database

4. In the Name text box, enter otilocalsql

4. In the Name text box, enter otireportsql

Return to Setup Overview

ETAP will provide an ETAP key for USB ports.

Please contact sales at sales@etap.com or 949-900-1000 for any key replacement.

Stand-Alone System Version of ETAP Licensing

Network Version of ETAP Licensing

Return to Setup Overview

ETAP License Checkout/Borrowing

Borrowing Code Generation

Borrowing Code Activation

2. “STOP” ETAP LM Configuration Console

Click on “Activation License” to finalize activation of verified code.

4. Go to “LM Service” tab and click “Start”.

1. From ETAP’s Network Key Administrator’s view:

Return to Setup Overview

Return to Setup Overview

1. In the Control Panel, double-click the Add or Remove Programs icon.

2. Select ETAP in the list of currently installed programs.

Click Finish after modification, repair, or uninstall is complete.

Return to Setup Overview

l Computer CPU speed

Computer CPU Speed

Computer RAM Size

Operating System Virtual Memory File Size

3. Click the Advanced tab.

4. In the Virtual Memory group, click the Change button.

ODBC DSN Buffer Size

3. Click the System DSN tab.

4. Select otilocalldb, and then click the Configure button.

5. Enter Name: otilocaldb