Professional Documents
Culture Documents
Sentinel
Version 4.2.0
22 March 2021
Copyright © 2021 Axway. All rights reserved.
Axway Sentinel4.2.0
No part of this publication may be reproduced, transmitted, stored in a retrieval system, or translated into any human or
computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual, or otherwise,
without the prior written permission of the copyright owner, Axway.
This document, provided for informational purposes only, may be subject to significant modification. The descriptions and
information in this document may not necessarily accurately represent or reflect the current or planned functions of this
product. Axway may change this publication, the product described herein, or both. These changes will be incorporated in
new versions of this document. Axway does not warrant that this document is error free.
Axway recognizes the rights of the holders of all trademarks used in its publications.
The documentation may provide hyperlinks to third-party web sites or access to third-party content. Links and access to these
sites are provided for your convenience only. Axway does not control, endorse or guarantee content found in such sites.
Axway is not responsible for any content, associated links, resources or services associated with a third-party site.
Axway shall not be liable for any loss or damage of any sort associated with your use of third-party content.
Contents
Sentinel accessibility 12
Sentinel accessibility strategy 12
Accessibility categories 12
Accessibility prerequisites 13
Screen reader support 13
Documentation accessibility 13
Screen reader support 13
Support for high contrast and accessible use of colors 13
1 Introduction 14
About Sentinel 14
Installation outline 14
3 Prerequisites 22
Hardware 22
Disk space and RAM requirements 22
Screen resolution 23
Supported operating systems 23
Servers 23
Desktop Computer 24
Mobile Devices 24
Flash Player 25
Supported web servers 25
Supported browsers 26
Desktop computer 26
4 Install 42
Installation features 42
Installation navigation 42
Installation modes 42
Installer setup files 43
Installed directories 44
Download the Sentinel install package 45
About other install packages 45
Sentinel installation architecture 46
Sentinel elements 46
Installation architecture 46
Start installation 53
Prerequisites 53
Installation package contents 54
Start the Installer 54
License agreement 54
Select installation 55
5 Post-installation 69
Verify the installation 69
Check the installation results 69
Installation summary 69
Installation log file 70
6 Update Sentinel 83
Prerequisites 83
Install updates in an interactive mode 83
Install updates in a non-interactive mode 84
7 Upgrade 85
Migration (option one) 85
Migration and upgrade (option two) 85
Migration and upgrade (option three) 85
Upgrade Sentinel cluster-mode installations 86
Scenario 1: Upgrade a cluster-mode installation on the Internal Server 86
Scenario 2 - Upgrade a cluster-mode installation on the external web server 86
Before you upgrade 86
Upgrade sequence 87
Start upgrade 87
8 Uninstall 89
GUI mode 89
Console mode 89
Remove updates 89
Remove updates in GUI mode 89
Remove updates in console mode 90
10 Known limitations 95
Known limitations during installation and start up 95
False alerts triggered by Correlation rules 95
Sentinel installed with PassPort does not start due to disabled TLSv1 95
Starting the Installer twice on the same machine 95
Installation fails when JVM runs out of memory (java.lang.OutOfMemoryError) 96
Synchronization issue with Windows service status 96
Install Sentinel on top of Oracle DB and secure database connection 96
Known limitations for configuration 97
Configure Sentinel with Web Dashboard installed on the local Axway database 97
Configure the Sentinel license key 97
Configure Sentinel after an update or new installation 97
Known limitations for upgrades 98
Sentinel installed with PassPort does not start after upgrade due to disabled TLSv1 98
Logging in to Sentinel using single sign-on 98
Starting Sentinel configured to use SSLv3 fails 98
The Sentinel Installation Guide provides information to aid you in installing, upgrading and
uninstalling Sentinel 4.2.0. Use this document to:
After you complete installation tasks you can start the product and log onto the Sentinel user
interface to complete administrative and production tasks.
Others who may find parts of this guide useful include network or systems administrators and other
technical or business users.
Overview
This guide describes how to install Sentinel using the Axway Installer and how to upgrade Sentinel
to the latest version. It also covers:
Plan the deployment – Describes what you should plan for deploying and configuring your
system architecture, database, and configuring other components. See Plan the deployment on
page 16.
Prerequisites – Describes the Sentinel prerequisites, including the system requirements. See
Prerequisites on page 22.
Installing – Describes how to perform a complete install as well as apply a service pack using the
Axway Installer. See Install on page 42.
Post installation – Provides instructions on how to check if the installation was successful and set
up Sentinel before the administrator can log on to the product for initial configuration. See Post-
installation on page 69.
Upgrade – Involves a change in product version and the replacement of binary artifacts; may also
require configuration change. This includes the Sentinel upgrade information, including how to
upgrade the Axway Installer if necessary. See Upgrade on page 85.
Uninstallation – Describes how you can uninstall Sentinel using the Axway Installer. See Uninstall
on page 89.
Known Limitations – Describes the different types of limitations you can encounter during
installation, upgrade and post-installation. See Known limitations on page 95.
Related documentation
The Axway Sentinel documentation set includes the following guides:
l Axway Sentinel Overview
Provides an introduction to Axway Sentinel and describes how the products in the suite can be
used in reference solutions to solve integration problems and govern the flow of data.
l Axway Supported Platforms
Lists the different operating systems, databases, browsers, and thick client platforms supported
by each product in Axway Sentinel.
l Axway Interoperability Matrix
Provides product version and interoperability information for products used in an Axway
Sentinel reference solution.
l Axway Interoperability Guide
Provides interoperability concepts and procedures for a subset of Axway Sentinel products.
l Axway Sentinel Upgrade Guide
Provides upgrade information for a subset of Axway Sentinel products.
Axway reference solution guides provide conceptual information about the reference solution, as
well as guidance on installing, configuring, and managing it.
l B2B Integration Implementation Guide
l Data Flow Integration Implementation Guide
l Financial Integration Implementation Guide
l Managed File Transfer Implementation Guide
Note All Axway documentation is available on docs.axway.com.
Training services
Axway offers training across the globe, including on-site instructor-led classes and self-paced online
learning. For details, go to:
http://www.axway.com/support-services/training
Support services
Support services are available:
l Documentation at https://docs.axway.com
l Product downloads, service packs and patches at support.axway.com
The Axway Global Support team provides worldwide 24 x 7 support, subject to validation of your
license agreement. Email support@axway.com.
Axway strives to create accessible products and documentation for users. The following describes
the accessibility features of Sentinel and its documentation. Accessibility in Sentinel is understood
as the design of Sentinel and its services for people with disabilities and is standardized by United
States government Section 508 requirements and by the Web Content Accessibility Guidelines
(WCAG) Version 2.0.
l Correct personas
l Key use cases
Users matching the End User persona outnumber other users in Sentinel; therefore, they are the
main target of accessibility in Sentinel. The only strategic application destined for End Users is
Sentinel Web Dashboard.
Accessibility categories
Sentinel accessibility focuses on the following accessibility categories:
In our effort to be as accessible as possible, we assure that users with disabilities can successfully
perform their day-to-day activities.
Accessibility prerequisites
For maximum use of Sentinel accessibility, we recommend using Internet Explorer 11 and JAWS
screen reader (version 15).
You interact with JAWS using keyboard shortcuts. Typically, you press the JAWS key in combination
with other keys. By default, the JAWS key is the Insert key.
To use the arrow keys and keyboard shortcuts with Sentinel, turn off the virtual PC cursor by
pressing the JAWS key+Z.
Documentation accessibility
The product documentation provides the following accessibility features:
l Screen reader support
About Sentinel
Axway Sentinel is an application that enables you to perform end-to-end monitoring of data flow,
from start to finish, across the applications in your enterprise that send event information to
Sentinel. Monitoring data flow helps you accurately identify when exceptions occur so that you can
manage issues and resolve them before they negatively impact your business.
Sentinel tracks data flow by capturing events from both Axway and third-party applications and
systems. You can trigger data processing by applying Event processing rules you define to respond
to events or non-events.
Installation outline
The following is a brief outline of the Sentinel Advanced installation steps. For complete installation
details refer to Install on page 42 If you have already installed the application and want to install a
service pack release, see Update Sentinel on page 83.
1. Verify the hardware and software system requirements, review the default ports and possible
conflicts, and accept the user license file. See Prerequisites on page 22.
2. Perform the necessary database prerequisites. See Database prerequisites on page 28.
Platforms
For more information on the exact platforms that Axway supports for Sentinel, refer to the Axway
Supported Platforms document on docs.axway.com.
Servers
For a list of servers, see Supported operating systems on page 23.
Ports
The following table shows the ports used by Sentinel Server for each domain of usage. If a firewall is
being configured on the Sentinel Server machine, then the list of inbound ports that need to be
open can be restricted depending on the active modules of the installation.
Broadcast of Range of 15 ports The first Automatic Broadcast Port can be configured via
objects from 15 starting Installer.
Composer Automatic with
Broadcast 1350
Ports
Note The communication channel between Sentinel and PassPort is always encrypted. To
support TLSv1.2 for this secured channel, Axway Passport version should be 4.6.0 SP9 or
higher.
l Hardware on page 22
l Supported operating systems on page 23
l Supported web servers on page 25
l Supported browsers on page 26
l Supported databases on page 27
l Java on page 36
l UNIX-based platforms on page 36
l Windows platforms on page 38
l Software and license keys on page 39
l Product dependencies on page 40
Note The platforms listed are supported by Sentinel; although, system requirements can change
when Axway releases service packs and patches for a product version. Therefore, it is
important to refer to the Axway Supported Platforms document on docs.axway.com. The
document lists the supported operating systems, databases, web servers, and browsers.
Hardware
The following describes the minimum and recommended disk space and memory requirements.
Axway Database
Minimum RAM for Axway Database depends on the configuration selected at installation.
32-bit
There are three possible configuration sizes:
l Large = 2 GB
64-bit
There are four possible configuration sizes:
Screen resolution
Minimum recommended screen resolution in pixels:
l Desktop: 1024x768
l Tablet: 1024x768
l Smart Phone: 800x400
Servers
l HP-UX
o HPUX 11iV3 (11.31) (ia64)
l IBM AIX
o IBM AIX 6.1 (power-64)
o (Recommended) IBM AIX 7.1 (power-64)
l Red Hat Enterprise Linux
o Red Hat Enterprise Linux 5 (x86-32, x86-64)
o Red Hat Enterprise Linux 6 (x86-32, x86-64)
o (Recommended) Red Hat Enterprise Linux 7 (x86-64)
o (Recommended) Red Hat Enterprise Linux 8 (x86-64) (starting with Sentinel 4.2.0 SP17)
l CentOS
o CentOS 7 (starting with Sentinel 4.2.0 SP12)
o CentOS 8 (starting with Sentinel 4.2.0 SP20)
Desktop Computer
For different Sentinel client applications, Windows 7, 8.1 and 10 operating systems are supported.
Mobile Devices
For Web Dashboard, the following operating systems are supported for both tablets and smart
phones:
l Android
l iOS
Note Sentinel Web Dashboard v4.2.0 was qualified on Android v4.4.2 (tablet Nexus 10) and iOS
v7.1 (iPad). However, it might work with other versions (specifically higher versions).
Contact Axway Support https://support.axway.com if you experience problems with Web
Dashboard on a particular Android or iOS version.
Flash Player
IMPORTANT! Web Monitoring will stop being supported starting with January 1, 2021. As a
consequence, Flash Player will no longer be needed by Sentinel.
Adobe Flash Player must be installed locally in order to use Web Monitoring. It is only necessary to
install it on the client machines, not on the server. Sentinel 4.2.0 is qualified with Adobe Flash
Player 18.
http://www.adobe.com/support/flashplayer/downloads.html
Note Although not included in the Sentinel distribution starting with Sentinel 4.2.0, Apache
Tomcat for Axway (delivered via Axway Infrastructure) is still suitable for both Sentinel
Web Dashboard and Sentinel Web Monitoring.
If you choose to use and manage an external web server for Sentinel web applications, use the
following recommendations for choosing a suitable Tomcat template:
l The Blocking I/O (BIO) connector is the connector used in the server's initial configuration. If
your server receives steady, moderate traffic, this connector is likely to provide the best and most
stable performance. However, if your server receives traffic in high volumes or in occasional
bursts, the number of threads required to hold simultaneous connections may become
excessive. If the server is rejecting connections because it has exhausted its connection thread
pool and you have already expanded the thread pool to a reasonable maximum size, consider
using a different connection type.
l The Non-blocking I/O (NIO) connector uses the Java non-blocking I/O features to accept
multiple connections on a single thread. In high volume traffic or traffic that arrives in a burst,
this connector will not require you to configure a large number of memory consuming threads.
It can provide better scalability without the effort required to tune the thread pools; although,
while processing a burst of new connection requests, it may also increase latency by starving the
other server threads needed to complete requests.
l The Apache JServ Protocol (AJP) is a binary protocol that can proxy inbound requests from a
web server to an application server positioned in the web server. It also supports some
monitoring that allows the web server to ping the application server. Web implementers typically
use AJP in a load-balanced deployment where one or more front-end web servers feed requests
into one or more application servers. Sessions are redirected to the correct application server
using a routing mechanism wherein each application server instance gets a name (called a
route). In this scenario the web server functions as a reverse proxy for the application server.
In conclusion, the most suitable connector for Sentinel Monitoring and Sentinel Web Dashboard
needs are:
l Blocking IO (BIO) HTTP/HTTPS Connector for moderate traffic because of its stability.
l Non-Blocking IO (NIO) connector for HTTP/HTTPS connector for high traffic, because it uses
fewer threads to handle the same number of TCP ports, by accepting multiple connections on a
single thread.
Supported browsers
The following browsers are supported by Sentinel.
Desktop computer
For different Sentinel client applications, the following web browsers are supported:
l Microsoft Edge
l Google Chrome and Mozilla Firefox no longer provide support for running Java Applets.
Therefore, it is only possible to launch Monitoring Applet using Internet Explorer.
l Due to browser/java related limitations, having the client side java on 32 bit is mandatory
for accessing Monitoring Applet and Dashboard Viewer.
l Due to changes introduced in the newer java 8, it is not possible to open Dashboard Viewer with
java 1.8.0 u261 or newer. The java version used on the client machine for Dashboard
Viewer should be 1.8.0 u251 or older.
Mobile Devices
For Sentinel Web Dashboard, the following browsers are supported for both tablets and smart
phones:
Note Sentinel Web Dashboard 4.2.0 was qualified with Chrome browser v35.0 (Android/Nexus
10) and Safari v7.1 (iOS/iPAD). However, Web Dashboard may work on other browsers or
browser versions. Contact Axway Support if you encounter problems with other browsers
or browser versions.
Supported databases
The following database servers can be used with Sentinel:
l MySQL
o MySQL Enterprise Server 5.5
o MySQL Enterprise Server 5.6
o MySQL Enterprise Server 5.7
o MySQL Community Edition 5.7 (starting with Sentinel 4.2.0 SP20)
l Oracle DBMS
o Oracle 11g R2 11.2
o Oracle 12c 12.1
o Oracle 12c 12.2 (starting with Sentinel 4.2.0 SP10)
o Oracle 18c (starting with Sentinel 4.2.0 SP15)
o Oracle 19c (starting with Sentinel 4.2.0 SP18)
l Oracle RAC
o Oracle RAC 11.2
o Oracle RAC 12.1
o Oracle RAC 12.2 (starting with Sentinel 4.2.0 SP14)
o Oracle RAC 19c (starting with Sentinel 4.2.0 SP22)
l IBM DB2 (this database type is not available for new setups)
o IBM DB2 (LUW) 10.5
Database prerequisites
The following describes the pre-installation tasks for the databases to work with Sentinel. Review the
following sections to understand the prerequisites for the database you plan to use with Sentinel:
IBM DB2
This section describes the IBM DB2 recommended databases, buffer pools, tables spaces, users and
schemas used for the Sentinel Server and Sentinel Web Dashboard installation.
Note The character set for both databases should be set to UTF8. By default, databases are
created in the UTF-8 (Unicode) code set.
l One buffer pool of size 8000 of pages and page size 4KB.
l One buffer pool of size 8000 of pages and page size 8KB.
l One buffer pool of size 8000 of pages and page size 16KB.
l One buffer pool of size 250 of pages and page size 32KB.
For the Sentinel Web Dashboard database, create the following buffer pools:
l One buffer pool of size 2000 of pages and page size 4KB.
l One buffer pool of size 750 of pages and page size 8KB.
l One buffer pool of size 500 of pages and page size 16KB.
l One buffer pool of size 250 of pages and page size 32KB.
Note Choose any name for the buffer pools. Information about the created buffer pools is not
asked during installation. Refer to the correct buffer pool during the creation of table
spaces, as described in the following section, Table spaces.
Example: The following DB2 script is used to create a buffer pool, called "MYDATA" with size of
250 pages and page size of 32KB:
l For storing regular data: Link the table space to the buffer pool with page size 32 KB (created
during the previous step for the Sentinel Server database). Set the size to a minimum of 400 MB.
l For storing DICO data: Link the table space to the buffer pool with page size 32 KB (created
during the previous step for the Sentinel Server database). Set the size to a minimum of 100 MB.
l For storing indexes: Link the table space to the buffer pool with page size 32 KB (created at the
previous step for the Sentinel Server database). Set the size to a minimum of 300 MB.
Note Choose any name for the table spaces. It is required to specify the names of the three
regular table spaces during installation.
l Linked to the buffer pool with page size 8 KB (created at the previous step).
l Linked to the buffer pool with page size 16 KB (created at the previous step).
l Linked to the buffer pool with page size 32 KB (created at the previous step).
l Linked to the buffer pool with page size 4 KB (created at the previous step).
Note It is not required to specify the temporary table space names during installation.
For the Sentinel Web Dashboard database, create four system temporary table spaces:
l Linked to the buffer pool with page size 4 KB (created at the previous step for the Sentinel Web
Dashboard database).
l Linked to the buffer pool with page size 8 KB (created at the previous step for the Sentinel Web
Dashboard database).
l Linked to the buffer pool with page size 16 KB (created at the previous step for the Sentinel Web
Dashboard database).
l Linked to the buffer pool with page size 32 KB (created at the previous step for the Sentinel Web
Dashboard database).
Note Choose any name for the table spaces. It will not be required to specify the temporary table
space names during installation.
DBADM
CREATETAB
BINDADD
CONNECT
CREATE_NOT_FENCED
IMPLICIT_SCHEMA
LOAD
Note If your user name contains the "\" character (for example, "ACME\smith"), the installation
process may fail. See the Known limitations on page 95 for trouble shooting.
Important: The schema name must be the same as the user name.
Note For the Sentinel Server, it is necessary to specify the schema name during the installation.
For Sentinel Web Dashboard, it is not required to specify the schema name.
Make sure your Microsoft SQL Server is installed in Mixed Mode (SQL Server authentication and
Windows authentication).
l For regular, non-DICO data, with minimum initial size 400 MB, referred to as "Data filegroup"
during installation.
l For DICO data, with minimum initial size 100 MB, referred to as "Dico filegroup" during
installation.
l For indexes, with minimum initial size 300 MB, referred to as "Index filegroup" during
installation.
Specify the first file group as the default file group for the Sentinel Server database.
Note These files must be specified during the Sentinel Server installation.
Note It is not required to specify the name of this file group during the Sentinel Server
installation.
After creating the users, assign them on the desired schema, as defined in the following section.
For both Logins, choose the option SQL Server Authentication and set the corresponding
default database as the Sentinel Server database or the Web Dashboard database.
For each database, create a dedicated type of user, SQL user with login, and associate it with the
login credentials created in step one.
Set the previously created schemas as the default schema for the users.
l db_ddladmin - enables the user to run any Data Definition Language (DDL) command in a
database
MySQL
This section describes the recommended MySQL databases, server parameters, and users used for
the Sentinel Server and Sentinel Web Dashboard installation.
Note The character set of the database must be set to UTF8, and the default collation to utf8_
general_ci.
Example: The following MySQL script is used to create a database called SENTINEL with character
set UTF8 and collation UTF-8:
default-storage-engine = INNODB
sql-mode = "STRICT_TRANS_TABLES,NO_AUTO_CREATE_USER,NO_ENGINE_
SUBSTITUTION"
transaction-isolation = READ-COMMITTED
innodb_flush_log_at_trx_commit = 1
init_connect = "set session autocommit=0"
log_bin_trust_function_creators = 1
max_sp_recursion_depth = 100
lower_case_table_names = 1
thread_stack = 256K
max_allowed_packet = 16M (this should be at least 16M)
Grant all privileges for the users on the corresponding database. Additionally, both users should be
granted the EXECUTE global privilege.
Verify neither of the users have SUPER privileges by querying the database using the following SQL
script: SELECT user, host, super_priv FROM mysql.user
Example: The following information and script are used to create two dedicated users:
l The user "sentinel" (password "123") will have access to the Sentinel Server database only
(called "db_sent").
l The user "webdashboard" (password "456") will have access only to the Sentinel Web
Dashboard database (called "db_wd").
Since Sentinel is installed on the host foo.com, we will restrict access to the database for these
users to be initiated only from foo.com. For security reasons, it is recommended to restrict access to
the database from the Sentinel server host only.
Oracle
This section describes the Oracle database recommendations and how to create instances,
tablespaces and users/schemas that are used for the Sentinel Server and Sentinel Web Dashboard
installations. It also describes how to install Sentinel on Oracle DataGuard.
Recommendations
Configuration settings
memory_max_target 12G
Note Enables the Automatic
Memory Management
feature.
memory_target 10G
Note Enables the Automatic
Memory Management
feature.
open_cursors 1000
session_cached_cursors 50
If you activate compression for tablespaces, this can decrease disk space usage and accelerate user
requests (for Oracle 11g R2 and above).
If you activate database partitioning, this can impact performance. Refer to the Sentinel
Configuration Guide for information on partitioning.
Create an instance
An Oracle instance is identified by a SID (the unique system identifier of a specific database
instance) or a Service Name. It is necessary to have an Oracle database instance where Sentinel will
be installed. To use an existing database instance, run the command lsnrctl status on the
Oracle server host to identify the available SIDs and Service Names.
l A main table space to keep main data. Minimum recommended size is 400 MB. This table space
can have any name.
l A table space used for storing DICO data. Minimum recommended size is 300 MB.
l A table space to keep indexes. Minimum recommended size is 300 MB.
For Web Dashboard, create a dedicated table space to keep the project data. A large project,
containing more than 200 objects, will need approximately 20 MB with an additional 11M for every
1,000 users if using PassPort AM and Fine Grained Access Control, or 0.5 MB for every 1,000 users if
not using PassPort AM and Fine Grained Access Control. Keeping this in mind, the size of 50 MB
should be able to accommodate most of the projects. This table space can have any name.
Example: The following SQL script is used to create a tablespace named MYTABLESPACE with a size
of 200 MB:
Tip Every database user will have an associated schema with the same name.
Set the default table space for the user destined for the Sentinel Server database. This should be the
same as the main table space, as described above.
Set the default table space for the user destined for the Sentinel Web Dashboard database. This
should be the one defined above for this purpose.
Note The default table space can be set to any table space; however, it is recommended
to use one that is dedicated.
CONNECT
RESOURCE
CREATE VIEW
UNLIMITED QUOTA on the three tablespaces defined above: data, dico, index
CREATE TABLE
Example: The following SQL script is used for creating a user called foo, with the password
mypassword, temporary tablespace TEMP, using the tablespaces SNTL_DATA_WORK, SNTL_DICO_
WORK and SNTL_INDEX_WORK. This user is granted all of the required user rights:
Java
Server
Axway provides Java 8 in the Sentinel installation kit and as such it is not necessary to manually
install a JRE on the machine hosting Sentinel server. The JRE installed during the product
installation is automatically used to run Sentinel. It can be found in this directory:
<installation_root_directory>/java/<platform name>
Client
The Sentinel GUI includes Java applets and a Java webstart application. To run these application on
a client host, Java 8 must be installed.
UNIX-based platforms
UNIX users are required to have Korn Shell (ksh) installed on all UNIX machines.
Use any user to start Sentinel. Make sure the user has the standard read and write permissions on the
installation directory.
The default installation path is the users home directory. It is possible to change the path and install
all products in a specific file-system.
The installation directory must not contain any sub-folders or files that are owned by another user.
By default, it will try one of the following directories: /tmp , /var/tmp , /usr/tmp , $HOME, or
$PWD.
You can force the use of another temporary directory by setting the following environment variable:
TEMPORARY_DIR.
Umask information
Various processes create files during the runtime execution.
To ensure these files are properly used by all the processes, use this command to make sure the user
has all the rights on the created files: umask -S u=rwx.
Depending on the information system architecture and if files need to be shared with other
products, it is possible to grant rights to these files for users from group or others. For this option
use this command: umask -S go=rx.
libstdc++.so information
It is mandatory to install libstdc++.so.5 or higher on a UNIX system in order to run Sentinel
(requirement coming from Java).
Red Hat 6
Axway Installer supports installation on a Red Hat 6. To ensure the installation will start smoothly on
a Red Hat 6 operating system, it is recommended to have the following packages installed on your
system as they may not have been installed by default:
l glibc.i686
l nss-softokn-freebl.i686
Windows platforms
The Windows installation directory must not contain any sub-folders or files that are owned by
another user.
The Windows account used to install Sentinel must be in the Log on as a service group.
Configure this as follows:
Windows firewall
The Windows firewall can block the java and mysqld processes.
Windows installations
The Installer must be started with the same user that did the initial installation (or at least the same
type of user).
The following two scenarios are examples of the problems encountered if the same user is not used:
l Installation done with an admin user: The Installer is launched with a non-admin user (for an
update, configure, uninstall, etc). The Installer is unable to find a previous installation, because
the current non-admin user has insufficient rights to search in the correct location of the
windows registry.
l Installation done with a non-admin user: The Installer is launched with an admin user. Even if
this user has enough rights, the Installer searches in another location (reserved for the admin
users).
You can force the use of another temporary directory by setting the following environment variable:
TEMPORARY_DIR.
l Product announcements
l The case center, to open a new case or to track opened cases
You can also access other resources, such as articles in the Knowledge Base, the Axway User Forum,
and documentation for all Axway products.
License key
To install Sentinel, a valid license key is required. The key corresponds to the logical name of the
installation. For license key requests and information, contact your Axway sales representative.
Cluster installations
Sentinel can be deployed in an Active/Passive cluster. However, Axway Installer does not have an
installation mode dedicated to install Sentinel in cluster. As a consequence, Sentinel must be
installed manually on each cluster node and configured manually. For more information about
cluster installations, contact your Axway representative.
Certificates
By default, Sentinel secures communication with internal components or external parties using
SSL/TLS and certificates. Certificates are required during installation and we recommend you
acquire your own certificates from a valid Certificate Provider, and use these during the installation
Sentinel delivers sample certificates that are automatically used during the installation. It is not
recommenced to use these certificates in a production environment.
After installation, the sample certificates can be found in the following directory:
Sentinel/conf/security
Do not tamper with and do not remove these certificates. Specify your own valid certificates during
installation or configure the product after installation to use valid certificates.
Product dependencies
Sentinel has dependencies on the following Axway products:
Axway recommends keeping your products updated with the latest available Service Packs, which
are downloadable from https://support.axway.com.
It is strongly recommended that all other programs are closed before proceeding with the
installation.
Installation features
The following table describes the tasks that can be performed with the Installer:
Task Description
Update Add or remove patches or Service Packs on previously installed Axway products.
Upgrade Replace a software program with a more recently released, enhanced version.
Installation navigation
When configuring Sentinel, use the Next and Previous buttons to move through the Installer
displays screens.
Installation modes
Installer has three installation modes:
Mode Description
GUI To start the Installer Graphical User Interface (GUI) on UNIX platforms, the Installer
requires an X-Window environment. To use an X-Window distributed environment, it
is necessary to export the DISPLAY environment variable:
export DISPLAY=myhost.mydomain:0.0
Console The Installer console mode displays a series of questions on the current console.
Silent The Installer Silent mode enables you to perform an installation or configuration in a
non-interactive mode (meaning you do not have to enter any parameters in the GUI or
console). To use this mode it is necessary to install the product (or run the Installer
program) and configure the dialog screens until the last screen is displayed (before
you click Install). In the installation directory a Silent File template is created that is
comprised of all the parameter settings entered in the GUI or the CLI. These
parameters can be used to duplicate installations on other machines. See Silent mode
installation Silent mode installation and configuration on page 91.
UNIX
Installer Mode File name
Windows
Installer Mode File name
Installed directories
The following sub-directories are installed in the Axway directory:
Directory Description
Directory Description
l Installer
l Sentinel server and client applications
Note The Sentinel install package does not contain Axway Database, PassPort, or Composer. To
install these products, you must download install packages for each. See About other
install packages on page 45.
1. Download and save the Sentinel install package from the Axway support site at
https://support.axway.com/.
2. Transfer the package to the machine where the product will be installed.
3. Unzip the package in an empty folder.
4. Launch the setup script in the root folder.
Note You must have an unzip tool installed on your target machine. Using decompression tools
other than unzip on UNIX machines could remove the execution permissions on all the files
in the package.
For example, to install Axway Database, PassPort, Sentinel, and Composer, download the four install
packages corresponding to the latest available versions of these products and perform these steps:
1. Extract each package and place each package into a different folder.
2. Establish the functional order of installation (Axway Database, PassPort, Sentinel, Composer).
3. Access the folder where the first installation package was extracted and run setup64.exe for
Windows or setup.sh for Unix.
4. Follow the installation process and complete the installation.
For additional information on the installation, see the installation guide specific to each product
provided in the installation package for the product. Installation documentation is available on
https://support.axway.com.
Note The Installer version to be launched must be the same as the Installer version of the
product that is currently installed.
Sentinel elements
Sentinel is composed of the following:
l SQL Database
l Sentinel Server comprising the following components:
o Front-End Server
o Acquisition Server
o Correlation Server
o Dashboard Server
o Probe Server
l Web Server hosting the following applications:
o Sentinel Monitoring
o Sentinel Web Dashboard
Installation architecture
There are three possible architectures for Sentinel:
l Single-machine
l Remote database
l Fully distributed
Architecture Description
Remote database Sentinel server and client applications are installed with a
remote SQL database.
To install Sentinel with an external database, select the
Advanced installation mode when you run the Installer
program.
Sentinel Description
Component
Front End server Responsible for event acquisition and for supplying data for Sentinel
Acquisition server Web Monitoring and Sentinel Monitoring Java applet.
Dashboard server Responsible for supplying data for Sentinel Dashboard Java applet.
Internal Web Server Hosts the Sentinel landing page, Sentinel Monitoring Applet, Sentinel
Dashboard Applet, and (by default) the Sentinel Web Monitoring and
Sentinel Web Dashboard modules.
Sentinel Description
Component
Web Dashboard Allows you to build dynamic management dashboards based on the
web application data Sentinel collects. The Web Dashboard can display information that
contains several metrics, reports, or alerts, on a single page or arranged
over a number of pages.
Sentinel Web Allows you to build dynamic management reports based on the data
Monitoring web Sentinel collects.
application
1. Install Sentinel and deselect all the other modules from the Modules screen of the Installer.
2. Configure the Front End server and Acquisition server modules manually. They are not visible
during the installation process; although, they are included in the Sentinel server.
Each Sentinel installation must point to the same database and use the same trust stores and key
stores employed for SSL. Also, the different installations must share the following directories:
l Sentinel/broadcast
l Sentinel/conf/security
If employing a specific user exit for authentication and authorization, the exit must be deployed on
all installations. If PassPort AM is used as access manager, each installation must be configured to
use the same PassPort AM instance.
l Common Settings
l Database
l Sentinel Server
l Access Manager
l Dashboard Server
l Correlation Server
l Monitoring for Accounting Integrator
l Probe Server
This installation enables only the Front End server and the Acquisition server.
Install Sentinel on a dedicated host. Select the following Sentinel modules during installation:
l Common Settings
l Database
l Sentinel Server
l Correlation Server
l Access Manager
l Dashboard Server
l Monitoring for Accounting Integrator
l Probe Server
l TelnetServer
l FrontEndServer
l AcquisitionServer
l HTTPServer
The Correlation server (RuleServer) is activated after the installation. The following modules are
deactivated by the installation process:
l DashboardServer
l ProbeServer
On the primary server installation, in trkserver.xml (for the RuleServer), manually configure the
parameters serverRmiHostName and serverRmiPort to point to the host and RMI port of the
Correlation server installation.
Note Sentinel Dashboard (V2) is a deprecated component as of the Sentinel 4.2.0 release. It is
recommended to use Sentinel Web Dashboard.
Install Sentinel on a dedicated host. Select the following Sentinel modules during installation:
l Common Settings
l Database
l Sentinel Server
l Dashboard Server
l Access Manager
l Correlation Server
l Monitoring for Accounting Integrator
l Probe Server
This installation must be manually configured. In trkserver.xml, deactivate the following servers:
l TelnetServer
l FrontEndServer
l AcquisitionServer
l HTTPServer
The Dashboard server (DashboardServer) is activated after the installation. The following modules
are deactivated by the installation process:
l CorrelationServer
l ProbeServer
On the primary server installation, in trkserver.xml (for the DashboardServer ), manually configure
the parameters serverRmiHostName and serverRmiPort to point to the host and RMI port of
the Dashboard server installation.
Adjust the parameter serverRmiHostName for the HTTPServer to point to the host where the
Sentinel internal web server will be installed and running.
Note If PassPort Am is used as the access manager, it is necessary the same web server port is
configured for Sentinel Dashboard and the internal web server, so the SSO URL for Sentinel
Dashboard (V2) is correct on the PassPort SSO landing page.
Install Sentinel on a dedicated host, Select the following Sentinel modules during installation:
l Common Settings
l Database
l Sentinel Server
l Probe Server
l Access Manager
l Correlation Server
l Dashboard server
l Monitoring for Accounting Integrator
This installation must be manually configured. In trkserver.xml, deactivate the following servers:
l TelnetServer
l FrontEndServer
l AcquisitionServer
l HTTPServer
The Probe server (ProbeServer) is activated by the installation process. The following modules are
deactivated by the installation process:
l CorrelationServer
l DashboardServer
On the primary server installation, in trkserver.xml (for the ProbeServer), manually configure the
parameters serverRmiHostName and serverRmiPort to point to the host and RMI port of the
Probe server installation.
l The Sentinel landing page (the entry point to the Sentinel client applications)
l The Sentinel REST API
l The Sentinel web applications, Sentinel Web Monitoring, and Sentinel Web Dashboard.
l Common Settings
l Database
l Sentinel Server
l Sentinel
l Web Monitoring (only if it is deployed on the internal web server)
l New Web Dashboard (only if it is deployed on the internal web server)
l Dashboard server
l Correlation Server
l Monitoring for Accounting Integrator
l Probe Server
Note This is required to initialize the Sentinel landing page and the Sentinel applets.
For web applications, before starting the external web server, perform the same manual
configuration actions as described in the sections Configuring Sentinel Web Monitoring and
Configuring Sentinel Web Dashboard, above.
Note For Sentinel Web Dashboard, when deployed on an external web server, it is not necessary
to change jetty-web.xml.
Additional notes
l Sender applications must send events to the primary server.
l Restarting Sentinel dedicated to Correlation, Dashboard, or Probe modules, will require to restart
also the primary installation.
l Optionally, you can activate the Telnet server on each of the installation. The Telnet server will
have access only to the local installation.
l By default Sentinel can be installed in a distributed way. However, if there is a single-host
installation, restricting to load remote servers could result in stronger security. To restrict the
usage of remote servers, add the following setting in sentinel.properties (Sentinel/conf):
axway.sentinel.allow.remote.servers=false
Known limitations
l Sometimes, committing users created in Sentinel Administration is not propagated to Sentinel
Correlation and Sentinel Dashboard nodes. Retrying the commit, with or without modifications,
may solve this issue.
Start installation
Start here to begin the installation and configuration of Sentinel.
Prerequisites
l You have Download the Sentinel install package on page 45 from Axway .
l You have uncompressed or unzipped the package.
l Components (folder containing configuration files and binaries of Axway Installer and Axway
Sentinel).
l Installer (folder with Java libraries used by Axway Installer).
l Java (the folder containing the Java Virtual Machine (JVM) used by Axway Installer and Axway
Sentinel to run.
l Tools folder (folder containing different tools employed by ; it contains different tools employed
by Axway Installer, for example the Axway Database Manager).
l EULA.html and EULA.txt, files containing the license agreement that accompanies Axway
Sentinel. These are mainly for printing purpose.
On Windows platforms only, the installation package will also contain the file setup64.exe or
setup32.exe (depending on the bit architecture of the platform). These files are the setup file for
launching the Axway Installer. On UNIX/Linux platforms the setup file is setup.sh.
GUI mode
l UNIX/Linux: setup.sh
l Windows: setup32.exe or setup64.exe
Console mode
l UNIX/Linux: setup.sh -m console
l Windows: setup32.exe -m console or setup64.exe -m console
Note setup32.exe is a 32-bit build executable and will run on a 64-bit platform provided that
the compatibility layer has been installed.
License agreement
Review and accept the license agreement to proceed with the installation.
In GUI mode
Read the EULA and select the option I accept the terms and conditions of the license
agreement if you accept the presented terms and conditions. This also lets you continue to the
next page.
l Select Print to print the license agreement (using your default Internet browser).
l Select Quit to stop the installation at any time.
In console mode
In this mode, a Print link for the EULA is not available. If you want to print the license agreement, it
is available in HTML or .txt format at the root folder of the installation package.
Select installation
You can select between two installation modes:
l Standard: Selects Axway Database by default for Sentinel. Some parameters are not displayed
during a standard installation as the Installer assumes default values for them. If your installation
kit does not contain Axway Database, do not use this installation mode.
l Advanced: Allows you to fully customize the installation.
Keep in mind, each Axway product is installed in its own installation folder. If you previously
installed Axway products, do not install Sentinel in the same folder. Install the product in an empty
directory. If you install in a directory with files, the entire directory is deleted when you uninstall.
Note The directory you specify during installation must not be created in advance. Installer will
create the directory (if it does not exist) during the installation process.
Configure Sentinel
The following information provides the configuration options for Sentinel.
Note Starting with Sentinel 4.2.0, Sentinel Dashboard, Probe server and the Sentinel Monitoring
applet are deprecated; therefore, these modules are not selected.
l Common Settings: Provides common settings for all the servers comprising a Sentinel Server
installation.
l Database: (Mandatory module) Prepares the database for the Sentinel server, also known as the
Tracking Database.
l Sentinel Server: (Mandatory module) Installs and activates services/modules like the Front
End server, Acquisition Server and Telnet Server.
When you select the Sentinel Server module, the sub-modules Access Manager and
Correlation Server are automatically selected. Select Monitoring for Accounting
Integrator to monitor Accounting Integrator Events with Sentinel (Accounting Integrator must
be installed).
l Web Monitoring
l New Web Dashboard
Installation directory
Specify the directory where you want to install Sentinel.
By default, Sentinel is installed in a sub-directory of the root installation directory. Use the default
directory, or specify a new directory.
License key
Enter the license information:
l Logical Server Name: Name of the server that corresponds to this license key. Use the same
uppercase and lowercase letters as displayed on the product delivery key notice.
Note This name can be a host name, DNS name, IP address or any other name
designating your Sentinel installation.
l License Key: The license key delivered with the software, corresponding to the logical server
name. Use the same uppercase and lowercase letters as for the logical server name.
l Communication with Sentinel modules in secure mode will be restricted to the specified protocol
version.
l Communication between a browser and Sentinel web applications (for example, Sentinel Web
Dashboard or Sentinel Web Monitoring) will allow any of the supported protocols configured on
the internal web server (see jetty-ssl.xml).
Information related to the key store and trust store, by default, point to a sample key store and trust
store that is delivered inside the installation package. If you use the default settings, do not change
the passwords in this page. These are strictly related to the sample key store and trust store files.
However, it is recommended to purchase a valid certificate and to use your own key store and trust
store. In this case, it is necessary to point to the correct files and to specify the right passwords to
access these.
Note Validity of the password is not verified during the installation process. If you specify the
wrong passwords, your Sentinel installation will not work properly after installation.
l File name: The trust store associated with the SQL database you plan to use for Sentinel.
l Type: The type of the trust store.
l Password: The trust store password. During this step the trust-store password is not validated
against the trust store itself. If you introduce a wrong password, the installation might fail later
on when the database will be contacted or after installation your product might not start.
l Database TCPS port: The secure port configured on the SQL database server. Depending
upon the database type, this port may coincide in some cases with the un-secure port.
Regardless, enter the value of the port on which secure connections are accepted.
Database type
Select the database type for the database dedicated to the Sentinel server. If you have previously
opted for the Local Axway Database, this page is not displayed.
Database options
Depending upon the type of database selected, one or both of the following options are available:
l Verify database configuration: The Installer will use the database information entered
during the installation to connect to the database, testing the validity of the entered data before
the actual installation process begins.
l Use custom URL: Enables you to specify a fully customized JDBC URL for the database
connection. This is useful if you want to pass custom connection parameters. This option is
available for Oracle databases only.
Note If you are running the installer in command line mode, in some terminals (for example in
putty) the "@" character used in a custom URL might need to be escaped as "\@".
Oracle setup
Specify the Oracle properties.
l SID: The unique name of the Oracle database instance. To find the SID of your database try the
command lsnrctl status, local to your Oracle database server.
l Service Name: The service name of the Oracle database instance. This can be used as an
alternative to the SID.
l Hostname: Specify the hostname of the database server. If you are using an IPv6 network, you
cannot use an IP address to define database connection information; the IPv6 addresses contain
colons which interfere with the database connection URL that uses the colon as a separator
between the host name and the port number.
l Port Number: Specify the port number where the Oracle database server is listening.
l Connection user: The connection user that connects to the database. See Oracle on page 33,
Oracle Users and Schemas.
l Connection password: The connection password used to connect with the database.
l Data tablespace name: Enter a name for the main table space. See Oracle on page 33, Oracle
table space.
l Index tablespace name: Enter a name for the index table space.
l DICO tablespace name: Enter the name of the DICO (Combinatorics Dictionary) table space.
MySQL setup
Specify the MySQL configuration settings for the Sentinel Server database:
l Database Name: Enter the name of the MySQL database created for Sentinel server.
l Hostname: If you are using an IPv6 network, you must specify the hostname (IP addresses are
not allowed). IPv6 addresses contain colons which interfere with the database connection URL
that uses the colon as a separator between the hostname and the port number.
l Port Number: The database listening port.
l Connection User: User that connects to the database. See MySQL on page 32 .
l Connection Password: The password used to connect the database.
Note If your DB2 version is 9 and above you do not need to supply the db2jcc_javax.jar.
DB2 setup
Enter values for the following DB2 parameters:
Scripts
For Sentinel Server, the Installer XDBM tool is managing the scripts that create and update the
database during the installation process.
By default, the Generate and launch scripts option is selected, meaning that Installer will create
the necessary SQL scripts and will execute them during the installation process. In case you don't
want your installation to update the database, you can select the option Generate scripts only
(Attention! You won't be able to use the product without an up-to-date database).
If the scripts execution was skipped during the installation and you need to update the database
after the installation is completed, you can do so by manually starting XDBM tool and executing the
available scripts.
The choice made during the installation for the script execution will be kept for the future updates.
For example, if during the installation you chose to only generate scripts, then the execution of the
scripts will be skipped for all future Service Pack/Patch applications.
For multi-server architecture, when the same database is used by multiple Sentinel Server
instances:
l If this is the first installation and the database is empty, you should choose Generate and launch
scripts.
l If the database was already updated by another Sentinel installation, we recommend you to
choose Generate scripts only. This means that the execution of the scripts will not be re-
attempted. You can also use Generate and launch scripts, as Installer knows how to internally
manage the situation and it will not result in database conflicts.
TCP/IP ports
Specify the ports that Sentinel server uses for TCP/IP communication. This option is for expert
users. For the Acquisition Server:
For the Dashboard Server, select the option Use Web Services to use Dashboard Viewer features
in the form of web services.
Buffer files
Specify values for the buffer file parameters:
l Total Size: Enter a value for the buffer file or use the default value displayed (default: 450 MB;
Minimum size: 200 MB).
l Alert by mail: Select this option if you want to send an email alert if there is a problem, for
example, if the buffer file is full. The following values you enter correspond to the email account
and server parameters that Sentinel will use to send the mail:
o Sender's Address: Enter a value in the displayed format.
o Receiver's Address: Enter a value in the displayed format.
o SMTP Server Host: Enter a value in the displayed format.
o SMTP Server Port Number: Enter a value (default: 25).
o Send authenticated emails: Select this option if your SMTP server requires
authentication.
o SMTP Username : Enter a user name if you have opted for authenticated emails.
o SMTP Password: Enter a password if you have opted for authenticated emails.
l RMI port selection: Specify the RMI ports used by the Sentinel server. You have two options:
o Allow Sentinel to select any available ports (Automatic).
o Specify the start of the port number range (Range of ports starting from). In this case
Sentinel will allocate the necessary ports automatically starting with the specified value.
l NAT translation: For NAT configuration, specify the host name or IP address on which the
Sentinel Servers will be visible from outside the private network. This is used by client
applications only, for example, Sentinel applets, Dashboard Viewer, HTTP and Telnet.
If you configure a firewall between the Sentinel server environment and the Sentinel GUIs, open all
RMI ports used by Sentinel in the firewall configuration. The file, tcpservices.html, contains a
list of the Sentinel RMI ports.
To view the list of Sentinel RMI ports, run the Sentinel Server and open the tcpservices.html file
located in the log sub-directory of the Sentinel installation directory.
l Network adapters: Specify the network adapters used for accessing the different parts of the
Sentinel Server architecture.
l Network adapter for clients (Applets, Viewer, HTTP, Telnet): Specify the host name or
IP address used by clients (RMI Registry, Sentinel applets, DashboardViewer, HTTP, Telnet) to
access the Sentinel Servers. The applet/viewer URL is: http://<Network adapter for
clients>:1309/index.html
l Network adapter for Front-end (Tracked Event receivers): Specify the host name or IP
address used by event senders to access the Front-End Server.
Service attributes
Optionally, on Windows you can run Sentinel as a service:
Access management
Select the access management that you want to use:
l Sentinel
l PassPort AM (4.3 and below): Applicable for PassPort versions 4.3 and earlier. You must
create an API user for the product to be able to query PassPort.
l PassPort AM (from 4.4): (Recommended access management) Applicable for PassPort
version 4.4 and above. You configure the product to manage a secure connection with PassPort
using SSL mutual authentication. In addition, you have the SSO option.
l RSA
l Product Instance: Refers to one of the four parameters that PassPort uses to identify a
product. This value is always set to Default by PassPort during the CSD import. Keep the default
value as Default if you are not sure. Refer to the PassPort Administrator's Guide for more
information about how to manage product instances.
l PassPort AM Domain: The default is Synchrony.
l Product Login: The Sentinel login defined in PassPort AM (there is no default value, make sure
that the user is defined in PassPort AM).
l Product Password: The password of the Sentinel login defined in PassPort AM (there is no
default value, make sure that the user is defined in PassPort AM).
l Use SSO: Check this option if you want to use Single-Sign On through PassPort. This option is
available only if the SSO Agent was enabled in the PassPort server during the Passport
installation.
l Product SSO Port: Enables the SSO Agent to connect to the Sentinel Server Default port
number = 1311.
For each RSA authentication server, you must enter the following:
l Hostname
l Authentication Port
l Acceptance Port
For each RSA authentication server, you must enter the following:
Web Monitoring
Select the web server you want to use:
l Internal Web Server: Select this option to deploy Web Monitoring on Sentinel's internal web
server.
l An Existing Server: Select this option to deploy Web Monitoring on an existing web server
(Tomcat). Specify the following parameters:
o Web Application Deployment Directory: Select the webapps directory of your Tomcat
installation.
o Web Server Host
o HTTP Port
o HTTPS Port
o HTTP SSO Port
o Session Timeout (in minutes)
It is recommended that you stop the external Tomcat server if it is running during installation.
Note For the procedure on how to install Sentinel Monitoring on Weblogic, see Post-installation
on page 69.
l Set SMTP parameters for sending Alert message by email: Select and complete the
following fields:
o SMTP Server Host
o SMTP Server Port
l Send authenticated emails: Optionally, select if the previous option is selected and complete
the following fields:
o SMTP Server User
o SMTP Server Password
Probe Server
Specify values for the Probe Server parameters:
l Hostname: Enter a value for the Sentinel Server host name or use the default value.
l Auto Access PortNumber: Enter a value for the access port or use the default value.
l Internal Web Server: Select this option to deploy Web Dashboard on Sentinel's internal web
server.
l Existing server: Select this to use an already installed Tomcat.
o Web Application Deployment Directory: Select the webapps directory of your Tomcat
installation.
o Web Server Host
o HTTP Port
o HTTPS Port
o HTTP SSO Port
o Session Timeout (in minutes)
It is recommended that you stop the external Tomcat server if it is running during installation.
l File name: The trust store associated with the SQL database you plan to use for Sentinel.
l Type: The type of the trust store.
l Password: The trust store password. During this step, the trust-store password is not validated
against the trust store itself. If you introduce a wrong password, the installation may fail when
the database is contacted or after installation, your product may not start.
l Database TCPS port: The secure port configured on the SQL database server. Depending on
the database type, this port may coincide in some cases with the un-secure port. Regardless,
enter the value of the port where the secure connections are accepted.
For Web Dashboard, unlike for Sentinel Server, the Installer XDBM tool is NOT managing the scripts
that create and update the database during the installation process. This means that some
functionality is no longer available, like using XDBM tool manually or having the possibility to
choose during the installation process whether the database scripts will be executed or not. This is
due to the fact that Web Dashboard was added much later to the Sentinel applications list, so it has
its own way of managing the database updates.
l If this is the first installation and the database is empty, the installation process will execute all
the database scripts.
l If the database was already updated by another Sentinel installation, the installation process will
automatically detect that and skip the scripts execution.
Other scripts will be executed on the database during future updates (application of Service Packs
and Patches). But these scripts can be safely run multiple times without causing database errors.
This means that, when the same database is used by multiple Web Dashboard instances, Service
Packs and Patches can be applied on each without concerns regarding the scripts execution.
l SID: The unique name of the Oracle database instance. You can either specify the SID or the
Service Name. To find out the SID or the Service Name of your database try the command
lsnrctl status, local to your Oracle database server.
l Service Name: An alias to one or more instances. You can specify either the SID or the Service
Name.
l Hostname: Specify the host name, where the Oracle database server resides. If you are using an
IPv6 network, you cannot use an IP address to define database connection information. This is
because IPv6 addresses contain colons which interfere with the database connection URL that
uses the colon as a separator between the hostname and the port number.
l Port Number: Specify the port number where the Oracle database server listens.
l Connection user: The connection user that connects to the database. See Oracle on page 33,
Oracle Users and Schemas.
l Connection password: The password used to connect the database.
Note For the Sentinel Web Dashboard's internal database, it is not required to state tablespace
information as in case of the Sentinel server. The connection user's default tablespace is
used for storing data.
l Database Name: Enter the name of the Sentinel Web Dashboard database.
l Hostname: If you are using an IPv6 network, you must specify the hostname (IP addresses are
not allowed). IPv6 addresses contain colons which interfere with the database connection URL
that uses the colon as a separator between the hostname and the port number.
l Port Number: The database listening port.
l Connection User: The user that connects to the Sentinel Web Dashboard database. See MySQL
on page 32.
l Connection Password: The password used to connect the database.
l Database Name: Enter the name of the Sentinel Web Dashboard database.
l Hostname: If you are using an IPv6 network, you must specify the host name (IP addresses are
not allowed). IPv6 addresses contain colons which interfere with the database connection URL
that uses the colon as a separator between the hostname and the port number.
l Port Number: The port that Microsoft SQL Server listens on.
l Connection User: The user that connects to the database. See Microsoft SQL Server on page
30
Ready to install
After Sentinel is configured, review the installation configuration and select Install to begin the
install. When the progress bar displays Installation complete, the installation is finished and
displays one of the following:
Installation summary
Review the installation summary. The Installer displays one of the following messages:
This file holds the information about all actions performed on the installation in time, for example
installation, update, configure and uninstall. Information is always appended to this file.
For support purposes, it is extremely important that you do not tamper with this file. If the file is too
large, archive it. If you need to contact Axway for support, provide them with all archived logs.
By default, Installer only logs messages that have the following level: INFO, WARN, ERROR and
FATAL. To report any installation issues to Axway Support, it is crucial you provide the detailed log
containing the DEBUG level messages. To obtain a log file with DEBUG level information, you must
replay the scenario that involves an erroneous behavior of the product, by launching Installer in
debug mode. To do this run the setup file with the option -d:
l setup.sh -d
Task Description
Log in After a successful start-up, access the Sentinel landing page. The Sentinel
to landing page contains links to all the Sentinel modules: Web Dashboard,
Sentinel Web Monitoring, Correlation Interface, Administration Interface and
Dashboard Viewer.
By default, the landing page is available on port 1309:
https://sentinel-server-host:1309
Note Depending upon your installation choices, the landing
page might be reachable on the http protocol rather than
the default, https. If the latter is used, you may need to
manually install the SSL certificate on the client machine
in order to access Correlation, Administration or
DashboardViewer. You can find more details in the next
section, Import SSL certificate on client machine on page
71.
If relying on Sentinel Administration as access manager, there is an initial
default user (Admin) and password (Admin). For security purposes, it is
important that you immediately change the password for this user.
If relying on Axway PassPort or a custom user exit, make sure the necessary
users are created, including their correctly assigned right roles and rights.
Stop To shut down Sentinel running in normal mode, execute the command:
Sentinel l Windows: stopserver.bat
l UNIX/Linux: stopserver
If installed and started in service mode (Windows only), stop the
corresponding Windows service.
In order to access Correlation Interface, Administration Interface or Dashboard Viewer via HTTPS,
the SSL certificate or the authority that issued it needs to be trusted by the client machine. If your
Sentinel installation is using a self-signed certificate (it's the case of the default certificate shipped
with Sentinel) or a certificate signed by an internal Root Certificate Authority, that certificate needs
to be manually installed on the client machine. There are few ways to accomplish this:
Secure Sentinel
After the installation of Sentinel, prior to use of Sentinel, there are several security items to consider.
For detailed information regarding the security of Sentinel, see the Axway Sentinel Security Guide.
Windows installations
Axway Installer must be started with the same user that performed the initial installation (or with a
user with the same type of user with the same system privileges).
The following two scenarios are examples of the problems encountered if the same user is not used:
l Installation by an admin user: The Installer is launched with a non-admin user (for an update,
configure, uninstall). The Installer is unable to identify necessary files, due to insufficient rights.
l Installation by a non-admin user: The Installer is launched with an admin user. Even if this user
has adequate rights, the Installer searches in another location (reserved for the admin users).
Procedure
To start the Installer in configure mode:
Step Description
Product modules Select the modules you want to configure. Go through the different
screens and make your changes. At the final screen, apply your
changes.
Important Do not change the database type and table space names (if applicable to the
associated database). This action is not supported by Axway Sentinel and will render your
installation unusable.
1. Make sure Sentinel is stopped. Run Installer in configure mode and use Next to view the
various screens without modifying any settings.
2. Select Configure to finish the configuration session on the last screen. This will trigger
structural changes for certain configuration files, allowing you to uninstall the unused modules.
3. Copy a Sentinel 4.2.0 installation kit on the host where the Sentinel server resides.
4. Run the setup file from the installation kit and proceed to the Installation directory screen. Point
to the directory of your installation and select Next.
5. Select Sentinel Server for installation and proceed to the next page.
6. Select Modify the existing installation and proceed to the next page.
7. Deselect the unused modules and select the Install button on the last page to finish the
installation.
8. Manually delete the following files:
l Sentinel Dashboard:
o <Installation>/Sentinel/jetty/webapps/SentinelTools/viewer
o <Installation>/Sentinel/jetty/webapps/SentinelTools/icons
o <Installation>/Sentinel/jetty/webapps/SentinelTools/web
o <Installation>/Sentinel/jetty/webapps/SentinelTools/lib/viewer
o <Installation>/Sentinel/lib/axis
o <Installation>/Sentinel/lib/axway-sentinel/axway-sentinel-dashboard-
server-*.jar
o <Installation>/Sentinel/lib/axway-sentinel/axway-sentinel-
webservices-dashboard-server-*.jar
l Probe Server:
o <Installation>/Sentinel/lib/axway-sentinel/axway-sentinel-probe-
devkit-*.jar
o <Installation>/Sentinel/lib/axway-sentinel/axway-sentinel-probe-
server-*.jar
Prerequisites
1. First let's make sure that Web Dashboard is in fact not present in your Sentinel existing
installation.
NewWebDashboard = false
NewWebDashboard.Type = Module
NewWebDashboard.ModuleType = NotInstalled
NewWebDashboard.LogicalName = NewWebDashboard
NewWebDashboard.ParentName = Sentinel_V4.2.0
2. Verify if your Sentinel license include the Web Dashboard. If you are not sure contact your Axway
account manager to verify it. If your license does not include Web Dashboard, you will need to
purchase a new license which does include it.
3. You will need a dedicated schema/database for Web Dashboard depending on the database you
are using. Refer to the Database prerequisites chapter for details.
Preparation
Before altering your installation to include Web Dashboard, the following preparation steps must be
performed:
Prep 1
Download the Sentinel 4.2.0 installation package from Axway support portal depending the
Operating System and bit architecture used and unpack it in a folder outside of the current Sentinel
installation.
Note Use the same package used first time to install Sentinel. For example, if you had
installed a Sentinel 32 bit on a linux-x64 , you should use the installation package
linux-x32.
Prep 2
Stop your Sentinel installation and make sure there are no active processes related to it on the
machine.
Prep 3
Backup the following configuration files in which you may have customizations set: (properties,
exit configurations, etc):
l conf/trkserver.xml
l conf/server.properties
l bin/trkserver.sh
l jetty/start.ini
l jetty/webapps/SentinelMonitoring/WEB-INF/web.xml
Prep 4
At the end of this procedure, a Service Pack will need to be applied. So, make sure your installation
is not on the latest Service Pack available. For example, if the latest SP available is SP21, then you
will need to have the maximum SP20, so that at the end you can apply SP21. If you are already at
the latest service available, then you can remove it.
Prep 5
If you have Sentinel SP14 or higher then you will need to change your Java configuration.
a. Enter the <install_dir>/Java folder. The only Java version allowed there is the
one used in the 4.2.0 installation kit (jre8 u40). If you have higher java versions, you
will need to remove them.
Note If you had removed at some point jre8 u40, you should put it back.
You will find it in the installation kit in an archived form. Unarchive
it in your installation, by keeping the expected folder structure.
2. Go through the entire license agreement and click next for each page:
4. Choose option 2 and then enter the path of the existing Sentinel installation:
5. Type 2 and click Enter to select installing Sentinel Server. Then type 1 and click Enter:
6. Click Enter:
10. Now you will be walked through the Web Dashboard configuration screens. Please refer to the
Install/Configure Sentinel chapter for details on completing the installation, starting with section
“New Web Dashboard parameters”, where you will choose “Internal Web Server”:
Post 1
Restore the configuration files, by placing them in the corresponding folders (overwriting the
existing ones):
l conf/trkserver.xml
l conf/server.properties
l bin/trkserver.sh
l jetty/start.ini
l jetty/webapps/SentinelMonitoring/WEB-INF/web.xml
Post 2
In trkserver.xml identify the WebDashboard tag, which will have empty values for all
attributes. Fill in all the values to be the same as the WebMonitoring tag.
For example:
Post 3
Now you must apply a Sentinel Service Pack on top of the installation. This step is vital to the
outcome. Running the installation kit on top of the existing installation has misaligned the code
base and other files. For example, the Web Dashboard you added will be at the 4.2.0 version, not
the SP level you currently have on the installation. Applying a Service Pack will realign everything,
resulting in a functional installation.
Post 4
You must run Installer in configure mode if:
l your installation is configured with Passport. You do not need to change any parameters, just go
through the screens.
l your license needs to be changes to one that allows Web Dashboard usage.
2. Open the Sentinel landing page. The Web Dashboard should be in the available modules list:
Prerequisites
l Download the product updates from Axway Support site and copy it to the host where your
installation resides.
l Read the update readme file and follow the instructions.
l Stop Sentinel. If you have installed Sentinel in service mode, make sure the associated Windows
services are stopped. The database must be running.
l For launching Installer, use the same user as the one used for installing the user; alternatively
you can use another user but with the same level of privileges.
The update progresses without user interaction. Once the update process is complete, the summary
is displayed and you can check the log files.
The installation of updates is tracked in the updates install.log file, located in the installation
root directory.
Make sure you understand how the Sentinel instance is installed. If it is installed in a multi-product
configuration (several Axway products in the same folder), after you upgrade it, it may no longer be
possible to update or upgrade the other products in the folder.
To avoid this, it is recommended that prior to an upgrade, if neccessary, change your configuration
by re-installing or migrating each product in its own folder. To do this you have the choice of three
options:
Sentinel 4.1.0 installations done with Installer's Cluster-mode may still be upgraded as follows:
Apply the upgrade procedures described in the following sections and applicable to standalone
Sentinel installation, to one of the cluster nodes. This will upgrade the entire cluster, leaving
additional manual post-upgrade procedures to be executed depending on the cluster setup.
In this case, upgrading one node will migrate the web applications the new Internal Web Server
(Jetty) situated on the shared disk. With this change, Sentinel will be transformed into a standalone
installation, since all of its components will be residing on the shared disk. To achieve a realistic
Active/Passive cluster, you will have to set up one manually. Contact your Axway representative for
assistance on how to do this.
In this case, upgrading one node will upgrade Sentinel server residing on the shared disk and the
web applications deployed on the external web server residing on the upgraded node. You will have
to copy manually the web application folders (SentinelMonitoring and SentinelWebDashboard)
from the upgraded node to the remaining nodes. Do not look for .war files, as there are none in
Sentinel 4.2.0.
Upgrade sequence
1. It is recommended that you update Installer and Sentinel to the latest available Service Pack
level.
2. Download the Installer and the Sentinelupgrade packs from .
3. Stop Sentinel and stop the web server (typically Tomcat) on which Sentinel components are
deployed.
4. Before the Upgrade procedure, verify the connection to the database.
5. Apply the Installer upgrade pack.
6. Apply the Sentinel upgrade pack.
7. Perform a manual clean-up operation described later in this section.
Start upgrade
This topic describes how to upgrade Sentinel from version 4.1.0 to 4.2.0. The 4.2.0 Upgrade Pack
must be applied when upgrading Sentinel.
Note If updating from a version older than version 4.1.0, it is required to first upgrade to
version 4.1.0 and then 4.2.0.
l Sentinel Server must be stopped; also the web server hosting Sentinel Web Monitoring and
Sentinel Web Dashboard web application must be stopped.
l It is recommended to backup the <Sentinel_Install_Dir>/broadcast folder before
applying the Upgrade Pack. Also, it is recommended to back up files and directories added
manually in the installation directory (for example, user exit implementations, and custom
commands).
l It is highly recommended to make a database backup for the Sentinel Server database and for
the Web Dashboard database.
l If you want to skip the update of the Web Dashboard database during the upgrade of Sentinel to
4.2.0 version, add the property WD_SKIP_DB_UPDATE = true in the file <Install_
Dir>/Configuration/Install_Sentinel_V4.1.0.properties, prior to the application
of the Upgrade Pack. This need appears when there are multiple Web Dashboard installations
pointing to the same database, situation in which only one of the installations should allow the
database update and the rest should be configured to skip it.
1. Make sure Axway Installer and Axway Sentinel are at the latest Service Pack level. To verify the
current Service Pack level, launch Installer update.sh/update32.exe/update64.exe and
navigate to the screen listing your installed components. Close installer, canceling the update
option. Alternatively, launch display.sh/display.bat located in the root directory of your
installation. Access the Axway site, and in the Downloads section search for the latest available
service pack for the mentioned components.
2. Download the Axway Installer and Axway Sentinelupgrade packs, from Axway
(https://support.axway.com/). Make sure you copy them to the host where your Sentinel
installation resides.
3. Launch update.sh/update32.exe/update64.exe, in function of the underlying platform
and apply the Axway Installer upgrade pack.
4. Launch update.sh/update32.exe/update64.exe, in function of the underlying platform
and apply the Axway Sentinel upgrade pack.
5. Download from Axway and apply the latest available Service Pack for Axway Installer (if any).
6. Download from Axway and apply the latest available Service Pack for Sentinel 4.2.0.
7. Execute the post-installation procedure.
If problems are encountered when using the new version of Sentinel, uninstall the Upgrade Pack.
Note This will not rollback the changes made to the database.
To restore the database, it is necessary to restore it using the backup made before applying the
Upgrade Pack.
If you installed products on Windows in service mode, the Installer removes the service.
GUI mode
UNIX/Linux: uninstall.sh –m gui
Console mode
UNIX/Linux: uninstall.sh –m console
Windows:
l uninstall32.exe –m console
l uninstall64.exe –m console
Remove updates
You can remove updates in GUI mode or console mode.
To use this mode, you must install the product or run the Installer program and configure the dialog
screens until you get to the last screen just before you select Install. This process will generate
Silent File templates in your home installation directory (in a folder named SilentFile/yyyy_mm_
dd_hh_mm_ss_install). Use this template to replicate the installation on other hosts.
UNIX/Linux:
Windows:
You should always call the Axway Installer Silent File from the command line and not the silent files
corresponding to the products. Edit the Axway_Installer silent file and modify the
IncludeFiles specifying the number of products included in the installation. You must not
modify anything else in this file except the InstallDir, SynchronyLogicalName and list of
IncludeFiles.
l You must use the absolute path to the Silent File and not the relative one.
l The product Silent Files installed in Silent mode must be in the same directory as the Installer
Silent File.
IncludeFiles =
IncludeFiles.Infrastructure = Install_Infrastructure_
V4.4.0.properties
IncludeFiles.Administration = Install_Administration_
V4.4.0.0.properties
IncludeFiles.Synchrony_Database = Install_Synchrony_Database_
V4.4.0.properties
IncludeFiles.Integrator = Install_Integrator_
V3.6.0.properties
IncludeFiles.Interchange = Install_Interchange_
V5.10.0.properties
IncludeFiles.B2BiXServer = Install_B2BiXServer_
V1.5.0.properties
IncludeFiles.B2Bi = Install_B2Bi_V1.5.0.properties
UNIX:
Windows:
The most common values that you replace when preparing a new installation using a silent file are
the InstallDir and CommonDir variables. The value of these fields is used to concatenate other
paths in the products silent file properties file.
Location
You can find the Silent File Editor in the installation directory in Tools/SilentFileEditor. You
must install a product in order to use the Silent File Editor.
Note It is not supported to copy the Silent File Editor from the installation package because it
uses binary files from the Installer.
l In Windows: SilentFileEditor.bat
l In UNIX: SilentFileEditor.sh
You can have more than one group of arguments as shown in the following examples:
Example
SilentFileEditor.bat SilentFilePath varName1 value1 –c/-u
varName2 value2 –c/-u … varNameN valueN –c/-u
Windows example
SilentFileEditor.bat
C:\root installation directory\SilentFile\Install_Composer_
V3.6.0.properties DB_ADMIN_PASSWORD composer –c InstallDir
C:\root installation directory –u
UNIX example
./SilentFileEditor.sh
/root installation directory/SilentFile/Install_Composer_
V3.6.0.properties ServerHost item-51923 –u Common new value 1 –c
DB_SCRIPTS new value COPY_LAUNCH -u
In Windows
[Installation
directory]\Tools\SilentFileEditor\SilentFileEditorGUI.bat
In UNIX
[Installation
directory]/Tools/SilentFileEditor/SilentFileEditorGUI.sh
Use File > Open to open the silent file you want to edit.
l Encrypt Selected: Encrypts the Values selected with the AES128 algorithm.
l Undo Selected: Undoes the changes made on the current selection.
l Undo all changes : Undoes all changes made on the current selection.
l Replace : Finds a variable and replaces it with the value you select. Inside of the Replace
command there are other options:
o Replace all: Replaces all paths in all the variable values.
o Find next: Goes to the next value occurrence and if you click Replace it replaces the value.
o Encrypt: Encrypts the value in the Replace Value with field.
Once you have completed all the modifications, use File > Save to save the Silent File, then File >
Exit to quit the Silent File Editor UI.
The solution is to configure PassPort to support TLSv1.2 (for this refer to the Axway PassPort
documentation) or to apply Service Pack 1 for Sentinel 4.2.0.
This setting allows Sentinel to accept other TLS versions beside TLSv1.2 to secure the
communication between Sentinel and PassPort.
To avoid file access conflict it is mandatory not to start the Installer twice on the same machine. If
you have no other alternative, you must set the TEMPORARY_DIR variable before starting the
Installer. This avoids any conflict with the temporary file for each Installer instance.
Solution: Specify the memory allocated at installation time by adding the following parameters
when launching the setup:
N} -Xmx512M line.
JAVA_OPTION="${JAVA_OPTION} -Djava.security.egd=file:/dev/../dev/urandom"
1. During the installation, for Sentinel Server select the Generate the scripts only option, and
complete the installation.
2. In the folder Tools\XDBM create a backup for the xdbmcmd file and add the following options
for the invoked Java process:
-Djavax.net.ssl.trustStore=<trustorel_location> -
Djavax.net.ssl.trustStoreType=<type> -
Djavax.net.ssl.trustStorePassword=<password>
3. Run xdbm manually to execute the database scripts generated during installation.
4. In the future, when any update is applied (for example, a Service Pack or Patch) it will be
necessary to manually execute xdbm to update the database.
l If you launch configure and do not intend to make changes to Web Dashboard, on the Axway
Sentinel Server page with the sub-title "Modules", deselect the option New Web Dashboard.
l If the New Web Dashboard option is selected, Installer will attempt to re-execute database scripts
for Web Dashboard. In this case, make sure the Axway Database is started; otherwise, Installer
will not be able to carry out the configure action and will fail with error.
Workaround: Do not use the Installer Configure mode to change the license key if the FIPS option
setting differs between the two keys.
The update removes the old Sentinel Monitoring application folder and replaces it with a new
Sentinel Monitoring war file. The configuration process fails because it does not find the application
folder if the war file is not deployed.
Workaround: Start the Tomcat web application server to automatically deploy Sentinel Monitoring.
The solution is to configure PassPort to support TLSv1.2 (for this refer to the Axway PassPort
documentation) or to apply Service Pack 1 for Sentinel 4.2.0.
This setting allows Sentinel to accept other TLS versions besides TLSv1.2 to secure the
communication between Sentinel and PassPort.
l The Sentinel installation relies on PassPort AM as access manager and has SSO activated.
l Sentinel is installed with PassPort as access manager while PassPort is already being used to
manage access rights for an earlier Sentinel version.
Note It is possible to bypass SSO and log in directly without restarting PassPort.