Under UNIX and Windows, EntireX is now installed using the Software AG Installer, which you download from the Software AG Empower website at http://empower.softwareag.com/. You can view the documentation for the Software AG Installer under http://documentation.softwareag.com > webMethods Product Line > webMethods Product Suite 9.7 > System Requirements, Installation, and Upgrade.
This document assumes you have already installed EntireX using the Software AG Installer. It covers installation instructions for components not included in the Software AG Installer; instruction on how to verify the installation and set up EntireX Security. It covers the following topics:
The EntireX Mini Runtime is a set of components that may be used for the deployment of applications using the Broker ACI, the Broker RPC, and - under Windows only - DCOM Wrapper objects and the Broker ActiveX Control. Unlike the full EntireX Runtime, the Mini Runtime does not include Java capabilities.
The Mini Runtime is delivered as install kit entirexminiruntime_x32.exe (32-bit) or entirexminiruntime_x64.exe (64-bit) located in the <drive>:\SoftwareAG\EntireX\etc directory. With a 64-bit EntireX installation, both versions of the runtime are provided. This install kit installs the Broker stubs, the C and .NET RPC runtime; on a 32-bit system it also installs the Broker ActiveX Control.
The default installation directory is "%ProgramFiles%\Common Files\Software AG", but this directory can be changed with an installation option (see below).
The Mini Runtime is no longer installed automatically as in earlier versions. However, as in previous versions, only one instance can be installed on a system. Overinstall of an existing Mini Runtime is only possible with a new version or SP; it is not possible to overinstall the Mini Runtime with an older version or SP. The new installation will always install into the directory where the old Mini Runtime is installed. Installing into a new directory is only possible if the old version has been explicitly uninstalled.
To be able to find the libraries in the Mini Runtime, applications must extend the
PATH variable with the installation directory of the Mini Runtime. If a library in the Mini Runtime needs to load another library
from the Mini Runtime, there are three different scenarios:
The Mini Runtime is installed into the application's bin directory. In this case nothing has to be done. Also the
PATH variable does not have to be extended because all libraries will be found by the operating system automatically.
If the Mini Runtime is installed into an arbitrary directory, this directory must be added to the
PATH. If the first library is found using the
PATH, it will try to load other libraries from the Mini Runtime with the following search algorithm:
Check if the library can be loaded in the same directory
As a fallback, look into %CommonProgramFiles%/Software AG
If the Mini Runtime is installed into %CommonProgramFiles%/Software AG, a library would try to load it from this directory.
To start the default silent installation
Enter the command:
entirexminiruntime.exe /V"/Leoi %temp%\entirexminiruntime.log /qr"
To start the silent installation with a different directory
Enter the command:
entirexminiruntime.exe /V"INSTALLDIR=C:\exxminirt /Leoi %temp%\entirexminiruntime.log /qr"
If the installation directory path contains blanks, specify the path name in quotes, e.g.:
INSTALLDIR=\"C:\exx mini rt\".
To start the silent installation with security (secuexit.dll)
Enter the command:
entirexminiruntime.exe /V"ADDLOCAL=CommonFiles,BrokerActivex,Security /Leoi %temp%\entirexminiruntime.log /qr"
To start the silent installation with security and encryption
Enter the command:
entirexminiruntime.exe /V"ADDLOCAL=CommonFiles,BrokerActivex,Security,Encryption /Leoi %temp%\entirexminiruntime.log /qr"
If check box Turn on Autostart for default EntireX Broker is checked, the installation starts the default broker ETB001. This broker instance listens on the TCP/IP and SSL ports defined in the custom panel during installation. Default port numbers are 1971 (TCP/IP) and 1958 (SSL).
To change the default port of the default broker
Stop the broker, using one of the following methods:
Use System Management Hub. See Stopping a Local Broker.
Use the Windows start menu entry.
Edit the configuration file config/entirex.configand change the TCP/IP and SSL port numbers to a different value. For other broker instances, see
PORT under Broker Attributes.
Start the broker, using one of the following methods:
Use System Management Hub. See Starting a Local Broker.
Use the Windows start menu entry.
The broker service etbsrv.exe must be active on every machine where a broker instance is running. The installation procedure installs it with startup type "automatic" and with status type "started". etbsrv.exe is in the bin subdirectory of the EntireX installation directory.
The Administration Service is started or stopped by the broker service
When the broker has been started successfully, the Administration Service waits for messages from other started brokers. This wait period lasts around 90 seconds.
After this wait period, all brokers are started that have an Autostart value of "yes" that have not already started.
When the Administration Service is restarted, it takes a maximum of 90 seconds until the current system status is displayed correctly.
Eclipse is an optional component of EntireX. For EntireX Workbench, it is required.
If you have not already installed Eclipse at your site, you can install Eclipse and the EntireX Workbench from the installation medium. If you wish to install the EntireX Workbench into an existing Eclipse environment, use the Eclipse update mechanism to deploy the EntireX feature.
When you migrate from one EntireX version to a higher version you have to change the license file setting to the new license file.
To set a new license file
Go to the Preference pages in Eclipse () and select the page .
If you want to install the Workbench plug-ins in standalone mode, that is, not as part of the full webMethods EntireX installation, see Installing the EntireX Workbench Plug-ins in Standalone Mode.
To verify successful installation, you can use the
etbinfo utility. It queries the Broker for information
as described below.
If you have not already created a default Broker, create one using System Management Hub. See Creating a Local Broker.
Start the Broker using SMH.
etbinfo to get back a response from the
broker. Start a Command Prompt session, change your directory to the EntireX
bin directory, for example
C:\SoftwareAG\EntireX\bin, and use the following
etbinfo -blocalhost -dBROKER -pbroker.pro
This assumes that you use the default port 1971. Otherwise use the command:
etbinfo -blocalhost:port -dBROKER -pbroker.pro
port is the port number of your broker.
This should display a simple formatted report with information about the broker.
This section covers the following topics:
You must set up EntireX Security for broker kernel and - if your application(s) use API version 7 or below - also for broker stubs.
To set up EntireX Security for broker kernel under Windows
Determine that all prerequisites for EntireX components have been met before setting up EntireX Security. See Windows Prerequisites.
Insert the following statement into the broker-specific section of the attribute file. See Broker-specific Attributes under Broker Attributes.
Modify the security-specific section of the broker attribute file according to your requirements. See Security-specific Attributes under Broker Attributes. These parameters are used to determine whether you will use Windows local security or LDAP-based authentication. If you are using LDAP-based authentication, authorization rules are not available to you.
Authentication: Windows authentication calls
LogonUser() with the
If you are running your application(s) at ACI version 7 or below, the following steps are required to install EntireX Security for the Broker stubs in all environments where applications execute either as clients or servers. See List of Components per Platform for where EntireX Security for broker stubs is supported.
These steps are not required if you are running your application(s) at ACI version 8 or above.
To install EntireX Security for broker stubs on Windows
When requested to specify the installation type, choose Custom and check the Security box.
(The required directories including secuexit.dll are copied to your computer as part of installing the contents of the EntireX DVD.)
Secuexit.dll is needed for backward compatibility if your applications issue any commands using ACI version 7 or below. Applications using ACI version 8 do not require this additional component in the stub.
To use encrypted communication, set the environment variable
NA2_BKPRIV=1. For no encryption, set
If stub tracing level is > 1, unencrypted contents of the send/receive buffers are exposed in the trace.
Installation of EntireX Security for Broker stubs is now complete. Now you can install the security components for the Broker stubs on the remaining operating systems where your application components are located.
To install the Tutorial
Load all objects of SYSETB.TRA in the ETC subdirectory, using the Natural utility SYSOBJH. See Object Handler in the Natural Tools and Utilities documentation for more information.
Logon to Natural library SYSETB and issue the
CATALL command to catalog all the programs in the library.
As of Natural version 8.3.3 (and NaturalONE 8.3.4) broker stub natetb32.dll is no longer required; the functionality is provided
If you are using an earlier version of Natural or NaturalONE,
install an EntireX Mini Runtime from a version of EntireX lower than 9.7 and add "Common Files\Software AG" to your
Make sure the version of the Mini Runtime matches the Natural version with regard to 32-bit or 64-bit.
Before you can use the Broker ActiveX Control (file ebx.dll) and/or the TOR Editor (file toredit.exe) you have to register the Broker ActiveX Control as a COM component. Start the program regsvr32 with "Run as Administrator":
On a Windows 32-bit operating system, files ebx.dll and toredit.exe are located in the Entirex\bin directory of the installation.
On a Windows 64-bit operating system, files ebx.dll and toredit.exe are located in the Entirex\bin\x86 directory of the installation.
Only program ebx.dll needs to be registered as a COM component.