Iaf Igent
Iaf Igent
PLATFORM
DML Services Installation
Guide for Windows
October 2017
4325 Alexander Drive, Suite 100 • Alpharetta, GA 30022-3740 • www.aptean.com • [email protected]
Copyright © 2017 Aptean. All Rights Reserved. These materials are provided by Aptean for
informational purposes only, without representation or warranty of any kind, and Aptean shall not
be liable for errors or omissions with respect to the materials. The only warranties for Aptean
products and services are those set forth in the express warranty statements accompanying such
products and services, if any, and nothing herein shall be construed as constituting an additional
warranty. No part of this publication may be reproduced or transmitted in any form or for any
purpose without the express written permission of Aptean. The information contained herein may
be changed without prior notice. Some products marketed by Aptean contain proprietary
software components of other software vendors. Aptean and other Aptean products and
services referenced herein as well as their respective logos are registered trademarks or
trademarks of Aptean or its affiliated companies.
Contents
Chapter 1: Overview 1-1
Purpose 1-2
Intended Audience 1-2
Operating System and Database Engine Requirements 1-2
Related IAF Documents 1-2
Chapter 2: Preparing to Install IAF 9.3 DML Services 2-1
Disk Storage Requirements 2-2
Architecture Supported 2-2
System Requirements 2-2
Upgrade Procedure 2-2
Chapter 3: Installing IAF 9.3 DML Services 3-1
Installing IAF 9.3 DML Services 3-2
IAF 9.3 DML Services Upgrade Installs 3-4
Releases and Service Packs 3-4
Installing a Service Pack 3-5
Uninstalling IAF 9.3 DML Services 3-5
Chapter 4: Post-Installation Procedures 4-1
Installing IAF DML Services on Windows 4-2
Installing the Broker Service 4-2
Example 4-2
Removing the Broker Service 4-2
Example 4-2
Installing the Batch Service 4-3
Example 4-3
Removing the Batch Service 4-3
Example 4-3
Installing the Monitor 4-3
GEM_MONITOR Parameters 4-3
Example 4-4
Monitor Database and Log File Name 4-4
Removing the Monitor 4-4
Purpose
This guide describes the steps to install Aptean DML Services for IAF 9.3 on computers running the
Windows operating system.
Intended Audience
Read this guide if you are responsible for:
For more information about IAF documentation, see the IAF Documentation Overview.
Architecture Supported
IAF 9.3 DML Services has been created to include registration for x64 platforms for Windows.
System Requirements
For information about system requirements for installing IAF 9.3 DML Services, see the Ross
Enterprise Software Compatibility Guide. The guide is updated regularly to include all hardware and
software prerequisites.
Upgrade Procedure
For customers using Oracle:
If you are upgrading to IAF 9.3 from IAF 6.1 or an earlier version, a special upgrade procedure is
necessary due to changes in documentary fields. For details about the upgrade procedure, see the
Guide to using IAF with Oracle.
This kit can be installed using the complete or custom setup. The complete setup installs the default
features, while the custom setup allows you to select the features to be installed.
l Complete
Installs all application features for IAF 9.3. The Destination Folder dialog box displays the default
installation folder path, as illustrated in the figure.
l Custom
Enables you to select specific application features and the location where the features need to be
installed. The following figure illustrates the Custom Setup dialog box:
To install a particular feature, click to the left of the feature you want to install, and select
one of the following:
Note: Installing the IAF Enterprise Server feature installs all the listed features in the
Custom Setup list, i.e., IAF Debugger, IAF Metadata Merge Tool, and IAF
Thin Client by default, even if these features are not selected.
5. Click Next.
6. On the Ready to Install dialog box, click Install to begin the installation process.
If you do not have a version of IAF Enterprise Server installed on your computer, the installation
concludes normally. The IAF Installer starts the IAF Services.
Note that IAF 9.3 uses the default port numbers 9114, 9115, and 9116 for the Broker, Batch, and
Monitor services respectively.
For details regarding installing IAF Services, see section Installing IAF DML Services on
Windows on page 4-2.
After the installation process is complete, you will be prompted to read the readme.txt file, which
contains information on program and documentation updates. It is recommended that you read
the file.
7. Click Finish when the process is complete.
l Service Packs are cumulative and contain all fixes at the time of the release.
l You can only update to Service Packs of higher versions. For example, if you are using Service
Pack 3, you must upgrade to a Service Pack higher than 3.
l Any Service Pack level can be upgraded to a higher Service Pack level.
l Although configuration files may change with the installation of a Service Pack, site specific
information is maintained in the existing configuration.
Where –l log_level indicates the level of the log recording (normal, terse, or verbose), -f log_
file indicates the name of the log file, and Broker_IPCName indicates the IPCName.
Example
gem_broker –install –l verbose –f c:\log\broker tcp,,9317
Note: The default installation port for the Broker Service in IAF 9.3 is 9314.
Example
gem_broker –remove tcp,,9317 (The port number of the broker service you wish to remove)
The Broker Service is removed, regardless of its state.
Where –l log_level indicates the level of the log recording (normal, terse or verbose), -f log_
file indicates the name of the log file, and BatchID indicates the batch identification.
Example
gem_batch –install –l verbose –f batch tcp,,9318 (or port number you
wish to assign)
Note: The default installation port for the Batch Service in IAF 9.3 is 9315.
Example
gem_batch –remove tcp,,9318 (or port number of the batch service you need to remove)
Where -p parameter indicates one or more of the following parameters and MonitorID indicates
the monitor identification.
GEM_MONITOR Parameters
-b
This parameter specifies the IAF batch-id to use. If this parameter is not specified, the default batch-
id is selected from the IAF SCV GEM_DEFAULT_BATCH or the TCP/IP service bat930. The TCP/IP
service name is IAF version dependent, e.g. bat 930 for IAF version 9.3, bat900 for IAF version 9.0,
bat810 for IAF version 8.1, bat800 for IAF version 8.0, bat730 for IAF version 7.3, etc.
-f
This parameter specifies the log file name. If this parameter is not specified, no log file will be created.
-l
This parameter indicates the level of log recording (normal, terse, or verbose).
-r
This parameter specifies the Oracle home directory to be used. If this parameter is not specified, the
home directory is selected from the registry.
-s
This parameter specifies the Oracle SID to use. If this parameter is absent, the SID is selected from
the registry.
-w
This parameter specifies the number of seconds the IAF monitor has to wait before processing the
monitor database. If this parameter is not specified, the monitor waits for 30 seconds. This parameter
is added to the command line so that other database services have a chance to start before GEM_
MONITOR accesses them.
Example
gem_monitor -install -s ORCL -r c:\ORANT -w 45 -b 9318 9319 (or the port numbers you
wish to monitor, respectively)
Example
gem_monitor –remove tcp,,9316 (or the monitor you need to remove)
l Automatic - which allows the server to auto start using the autostart.txt file in the
$\Ross\Soft\IAF\Dml\930\startup folder, which is populated with the appropriate
<server>.res files.
l Manually
Example
Perform the following steps to manually start application servers:
where broker_port is the broker_id you specified when you started the broker service as specified
above.
Overview
The licensing subsystem in IAF 9.3 for all Windows platforms is provided by SafeNet’s Sentinel RMS
License Management System. All IAF 9.3 installations require Sentinel License Server(s) to manage
license counting. While the IAF servers may be on any platform, the Sentinel License Management
(SLM) servers are Windows based computers requiring Win32 and/or X64 architecture.
For SLM licensing in IAF 9.3, the Ethernet physical address (MAC address) is used to license a
server. For redundancy within a server, multiple physical addresses can be provided for a server. For
more information about how to license your server, see the section Obtaining SLM Host IDs on
page 5-4. This section provides information about licensing IAF on Windows platforms.
l License Servers – These are the computers that the SLM license server runs on. SLM servers
can exist as stand alone servers or in a license pooled configuration that provides failover and
redundancy. With IAF 9.3, all SLM license servers must run on Win32 or X64 Windows
platforms.
Note: The term server may be slightly inappropriate in this context, since the SLM
license service is a relatively lightweight application.
l Licensed Servers – These are the actual computers that run IAF and request licenses from the
SLM License Servers.
l License Pooling – License pooling is a feature provided by Sentinel that allows licenses to be
pooled among an odd number of License Servers, so that failover and redundancy can be
provided. License Servers must be in odd numbers (such as 3, 5, 7, etc) in order to have a valid
license pool. For more information, see the Sentinel Administrators Guide.
Each license pool is issued one license, which is shared among all the License Servers in the
pool.
l On a Windows platform, the same computer can be a License Server and the Licensed Server.
Any IAF 9.3 server can be configured as the SLM license server.
l A single license pool can contain both X64 and Win32 License Servers.
Types of Licenses
SLM licensing includes two types of licenses - Server Licenses and Grace Licenses.
l Server Licenses – Server licenses are actual production licenses that are loaded into the SLM
license service. Server licenses define:
o Servers that are valid license servers (the servers running SLM)
o The computers that are to be licensed (the IAF servers)
o The licenses and counts associated with those licenses
o Expiry dates and other properties of a license as applicable to a contract.
l Grace Licenses – A grace license, also known as a local license, is a temporary license that may
be provided by the Aptean Licensing or Support departments in certain cases. Grace licenses do
not require a SLM license server. Attempting to load grace licenses to a license server results in
an error. A grace license must reside on the IAF server that provides licensing.
1. Obtain the SLM Host Ids for the license servers and the servers you intend to license. For more
information, see the section Obtaining SLM Host IDs on the next page.
2. If you have not obtained a SLM license for your IAF 9.3 system, contact Ross licensing 1-855-
411-2783 to obtain the license.
3. If you have not reviewed Sentinel documentation, review the Installing the Sentinel RMS
Developer Kit Server document and the Sentinel RMS Administration document.
4. Install the Sentinel RMS license server by following the instructions provided in the Installing the
Sentinel RMS Developer Kit Server document. The Sentinel kit is located in the $Gem_
Root\Download\Sentinel folder on your IAF server. Install the Sentinel RMS license server
using the Setup.exe file provided in the folder.
5. Install your license file by following the instructions included in the Readme file.
The Ethernet Address(es) listed in the results of this command should be provided to licensing.
The Physical Addresses of the cards listed by this command should be provided to licenses.
Note: It is not necessary to send ALL Ethernet physical addresses to Aptean Licensing in order
to license a Server. Many of today’s servers can have 4 or more network cards and it is
unnecessary to have them all included. In many cases, two addresses in a machine
allows for sufficient redundancy.
1. Edit the echoid.dat file in the folder. Make sure the value is changed to 0x010, from the
default 0x3FF.
2. At the command prompt, execute echoid –d.
The Ethernet Address(es) listed in the results of this command should be provided to Aptean
licensing.
The Physical Addresses of the cards listed by this command should be provided to licenses.
l GEM_LSHOST
This SCV is used for making available to the kernel, the list of License Servers that are available
in a license pool. This SCV can be set to a space separated list of License Server host names or
IP addresses.
l GEM_LSFORCEHOST
This SCV can be set to force the use of a single license server host name or IP address. This
SCV overrides GEM_LSHOST SCV.
l GEM_LSFORCEPORT
This SCV can be used in combination with the GEM_LSFORCEHOST SCV. When specified, it
sets the port number to connect on the license server computer. This would only be necessary if
the default port was modified on the license server that is being contacted.
If you need to use the software tools available with Sentinel (lslic.exe, lsmon.exe, etc), you
require two environmental variables. It is necessary to set one or more of these environmental
variables in the Windows Command Prompt or Unix Shell you are using.
See the Sentinel RMS documentation for more information on the LSHOST and LSFORCEHOST
environment variables.
l GEM_LSFORCEHOST Licence_Server_machine
l GEM_LSHOST License_Server1 License_Server2 License_Server3
(This option is applicable if you are using a license pool)
Do not use GEM_LSHOST if only one computer is listed. Even though this may work, it is possible that
there could be several seconds overhead while trying to locate another server.
Entries in a Server license file should be as follows (the text is wrapped):
In this case, filename.ext is the name of the file that contains the licenses to be registered. Note
that -F contains an uppercase F, not a lowercase f. -F registers a license permanently. “-f” registers
a license for only until the service is restarted.
For example:
lslic –F gembase.lic
lslic –F c:\ross\soft\gem\930\license\your_license.lic
Removing a License
To remove a specific license:
lslic –d licensename version
Note that licensename is case sensitive and that all IAF license names are in uppercase.
Examples:
lslic –d GEMBASE-RUNTIME 9.3
NIC Teaming
Since IAF licensing is tied to the MAC address on a server, licensing servers may appear to be
complicated. NIC teaming in a server can be accomplished in many ways depending on the hardware
platform (including differences in hardware between vendors), operating system and network
configuration. For a more detailed discussion on NIC teaming, see http://en.wikipedia.org/wiki/Link_
aggregation.
The MAC addresses that are available to the licensing software on the box depends on the level
where the NIC teaming occurs. The following procedure describes how to license your teamed cards
correctly:
Changing the teaming configuration for the NICs on a server can, in some cases, lead to different
MAC addresses being provided to the licensing software (and any other application running on the
computer). Since this can occur, it is possible to invalidate the IAF license of a server when you
reconfigure teaming. If this occurs, request a new license with the updated information.
Sentinel Documentation
The Sentinel licensing manuals are placed on your system when installing IAF 9.3 and the Sentinel
RMS product. All system administrators should read this documentation. Read the documentation or
at least skim over it at your first available opportunity.
DML requires concurrent user counting and consumes the following three licenses as needed:
1. DML-RUNTIME
Note: For Smart Client, multiple instances running on a computer requires only one
DML-RUNTIME license, even if multiple tabs are open for each instance.
2. DML-DEVELOPMENT
3. DML-REPORTS
Two separate non-concurrent licenses are used for non-concurrent license counting:
o IAF
All IAF products require the presence of an IAF license. This license does not require
concurrent user counting. Only the presence of this license is checked; it is not counted.
o IAF-MOBILE
This license is required to use the IAF Mobile product in Data Collection and shop floor
management. Only the presence of the license is checked; it is not counted.
Separate license features can be present in your license file for each IAF feature enabled. Each IAF
feature can have its own separate expiry date, its own separate maximum user limit, or be marked as
being a temporary DEMO/TEST license.
DML-
Client Vs License DML-RUNTIME DML-REPORTS IAF-MOBILE IAF
DEVELOPMENT
Char Cell Count Note 1 Count Note 2 Count Note 2
Thin Client Count Note 1 Count Note 2 Count Note 2
GCW Pro Count Note 3 Count Note 2 Count Note 2
MM Tool
iBrowser Count Note 1
Connect Required
Broker Manager
Batch Manager
Security Count Note 1
Manager
Developer Studio Count Note 1
IAF Mobile Required
Smart Client Count Note 1 Required
Reporting functions and development functions executed while a local database is invoked also
request and count DML-REPORTS and DML-DEVELOPMENT licenses respectively. However, all
licenses (including the DML-RUNTIME license) are released after the last local database is finished.
The following examples demonstrate how to compute the count for each client type.
Example 1: Each GEMBASE character-cell user, GEMBASE thin client user and GEMBASE
GCWpro with local database user consumes a DML-RUNTIME license feature. If a DML-RUNTIME
feature cannot be obtained, the database cannot be invoked.
GEM_LICENSE_DEMO_NOTIFY
The setting of this SCV determines whether or not GEMBASE notifies END USERS that they are
running a DEMO/TEST license. DEMO/TEST licenses are only available on platforms on which
GEMBASE uses the FLEXlm licensing system. This SCV can be set to T[RUE], F[ALSE], Y[ES], N
[O], 1, or 0. T[RUE] and Y[ES] cause end user demo license notification messages to be enabled.
FALSE and NO cause end user demo license notification messages to be disabled. If this SCV is not
set, the default is TRUE.
Note that regardless of the setting of this SCV, GEMBASE displays the word "DEMO" with bold and
blink attributes in the upper right-hand portion of the banner next to the time whenever the time is
displayed in the upper right-hand portion of the banner. The word "DEMO" is also included in both the
stock "DML>" prompts (i.e., "DEMO-DML>" and the "GEMBASE Finished" message that
GEMBASE displays as it exits (i.e., "GEMBASE DEMO Finished"). When running in thin
client/server mode, this SCV is negotiated with the thin client. /LOCK may be appended to the SCV
value to prevent the thin client from being able to override the thin server's SCV value.
Examples:
GEM_LICENSE_DEMO_NOTIFY=NO
GEM_LICENSE_DEMO_NOTIFY=YES
GEM_LICENSE_LOG
This SCV is applicable to all licensed platforms, regardless of which underlying licensing software is
in use. The setting of this SCV determines whether or not licensing related actions and errors are
logged. This SCV can contain a comma-separated list of keywords. Valid keywords are:
T[RUE], F[ALSE], Y[ES], N[O], 1, 0, M[ONITOR], F[ILE] {:|=}file-specification, L[EVEL]{:|=}logging-
level.
The FILE=file-specification keyword causes logging messages to be sent to the file specified in 'file-
specification.' This file must be writeable by the user in order for any logging to this file to take place.
If the FILE keyword is specified by itself without any other keywords, the TRUE keyword is implied.
Place single quotes (FILE='filespecification') or double quotes (FILE="file-specification") around the
file-specification if it contains either commas or spaces. The file specification must not contain colon
(":"), equal sign ("="), single quote ("'") or double quote ('"') characters.
The LEVEL=logging-level keyword determines how detailed the license log is to be.
One of the following logging levels can be specified: FATAL, SEVERE, ERROR, TERSE,
WARNING, INFORMATIONAL,VERBOSE, SUCCESS, or INTENSE.
FATAL causes the least amount of logging to take place. INTENSE causes the most logging to take
place. If the logging level is not specified, the default logging level is WARNING.. If the LEVEL
keyword is specified by itself without any other keywords, the TRUE keyword is implied. Please note
that the INTENSE logging level outputs a large amounts of text to the log. This is not recommended
for normal day-to-day logging.
The MONITOR keyword, if specified, causes logging messages to be sent to the GEMBASE
MONITOR and logged centrally in a single licensing log file. If the MONITOR keyword is specified by
itself without any other keywords, the TRUE keyword is implied. See the description of the GEM_
LICENSE_MONITOR_LOG SCV for details.
The TRUE keyword enables logging for this client. If specified all by itself without any other
keywords, it causes logging to be performed via the monitor with the default logging level of
WARNING. YES or any odd numeric value is synonyms for TRUE.
(This is standard GEMBASE true/false SCV logic.)
The FALSE keyword disables logging for this client. NO or any even numeric value are synonyms for
FALSE. If both the FILE and MONITOR keywords are specified, the license log messages are sent
to both locations.
If this SCV is not set, the logging level is set to WARNING and license log messages are sent to the
monitor.
The keyword list may be enclosed within parenthesis for clarity.
Examples:
GEM_LICENSE_LOG=YES
GEM_LICENSE_LOG=NO
GEM_LICENSE_MODE
Setting this SCV causes GEMBASE to request the specified license at GEMBASE startup time and
hold onto that license until GEMBASE exits. This SCV can and should be set when the user knows in
advance that s/he will be performing a series of actions which all require a DML-REPORTS license or
DML-DEVELOPMENT license and which must not fail for lack of a license before all the actions have
been completed (and the user has exited GEMBASE.) If both DML-REPORTS and DML-
DEVELOPMENT licenses will be needed, then specify DML-DEVELOPMENT.
GEMBASE features that require a DML-REPORTS license also operate successfully when the user
already holds a DML-DEVELOPMENT license. You may set this SCV to one of the following values:
DML-DEVELOPMENT, DML-REPORTS, or DML-RUNTIME.
Note however, that interactive IAF sessions (such as character-cell and thin client) always request
and hold a DML-RUNTIME license in addition to any other license that they may request and release.
Therefore, one would usually set this SCV to either DML-REPORTS or DML-DEVELOPMENT. Also,
the "DML-" portion of the license name may be omitted if desired. When running in thin client/server
mode, this SCV is negotiated with the thin client. /LOCK may be appended to the SCV value to
prevent the thin client from being able to override the thin server's SCV value.
Examples:
GEM_LICENSE_MODE=DEVELOPMENT
GEM_LICENSE_MONITOR_LOG
This SCV is applicable to all licensed platforms, regardless of which underlying licensing software is
in use. The setting of this SCV determines the location of the GEMBASE MONITOR licensing log
file. If this SCV is not set, the default monitor licensing log file location is GEM_ROOT\log\gem_
license_monitor_service_log.log on the Windows platforms and
GEM_ROOT/log/gem_license_monitor_service_log.log on UNIX platforms where
service is the monitor service name (or port number if it doesn't have a name in the services file).
Note that this SCV is read by the GEMBASE MONITOR and needs to be visible in the monitor's
environment in order for the monitor to see it.
GEM_LICENSE_NOTIFY
This SCV is applicable to all licensed platforms, regardless of which underlying licensing software is
in use. The setting of this SCV determines whether or not GEMBASE notifies END USERS of
impending license expiration. This SCV can be set to T[RUE], F[ALSE], Y[ES], N[O], or to a number.
T[RUE] and Y[ES] cause end user license expiration warning messages to be enabled and for those
messages to begin to be displayed to end users 30 days prior to the license's expiration date. FALSE
and NO cause end user license expiration warning messages to be disabled. Setting this SCV to a
number causes end user license expiration warnings to be enabled starting number days prior to
license expiration.
Note that license expiration warning messages are always sent to the license log (if enabled) starting
30 days prior to license expiration regardless of the setting of this SCV.
If this SCV is not set, end user license expiration warnings are enabled and begin to be displayed to
end users 30 days prior to license expiration. When running in thin client/server mode, this SCV is
negotiated with the thin client. /LOCK may be appended to the SCV value to prevent the thin client
from being able to override the thin server's SCV value.
Examples:
GEM_LICENSE_NOTIFY=NO
GEM_LICENSE_NOTIFY=YES
GEM_LICENSE_NOTIFY=10
GEM_LICENSE_QUEUE
This SCV can be set to T[RUE], F[ALSE], Y[ES], N[O], 1 or 0. The setting of this SCV determines
whether or not GEMBASE waits for the requested license to become available. If this SCV is set to a
TRUE value and a requested license is not available at this time it is requested, then GEMBASE
silently waits indefinitely for the license to become available before continuing. The default behavior
is for GEMBASE to return an error if the license is not immediately available. When running in thin
client/server mode, this SCV is negotiated with the thin client. /LOCK may be appended to the SCV
value to prevent the thin client from being able to override the thin server's SCV value.
Scenario 1
Each client computer running GTC consumes 1xDML-RUNTIME license, regardless of the number
of GTC instances or the USERNAMEs used.
Scenario 2
Each client computer running Smart Client DmlDesktop consumes 1xDML-RUNTIME license,
regardless of the number of DmlDesktops or the USERNAMEs used.
Scenario 3
Each client computer running iBrowser clients consumes 1xDML-RUNTIME license for each
iBrowser client.
Scenario 4
In this scenario, Client computer #1 consumes 2x DML-RUNTIME licenses; one for running GTC,
and one for running Smart Client DmlDesktop. Client computer #2 consumes 3xDML-RUNTIME
licenses; one for each iBrowser user.