RadixWare Administrator Guide/RadixWare Server

From RadixWiki
Jump to: navigation, search

Revision History

Date RadixWare Version Description of Changes
03.06.2022 2.1.39.х Supported the facility to explicitly define the ID of the system instance to be started in the –startupGroup parameter of the instance. The parameter value should be specified in the format: __rdx_instance_<instance id>.

Updated section RadixWare Server Startup

15.11.2021

2.1.36.х

Added the -XX:-OmitStackTraceInFastThrow parameter to the files used to start the RadixWare Server.

Updated section Restarting Instance Automatically Using OS Tools

18.02.2021

2.1.32.х

Added the facility to use the substitution variables in the configuration file.

Updated section RadixWare Server Startup

Supported the facility to start the instance using the name of the stratup group. As such, added the following parameters used to run the RadixWare Server:
  • -startupGroup
  • -noRetryOnStartError

Updated section RadixWare Server Startup

30.07.2020 2.1.29.х Supported the RadixWare Server startup parameters required to set up a connection to the additional DB - PostgreSQL DB:
  • auxDbUrl
  • auxDbUser
  • auxDbPwd

Updated section RadixWare Server Startup

09.06.2020 - Deleted the outdated section Starting Up RadixWare Server as Windows Service / RadixWare Server Startup Using Tanuki Java Service Wrapper.

Conventions and Abbreviations

Conventions

Convention

Example

Applies to

Bold

Appearance of the Connection Manager dialog box

Terms introduced for the first time; names of the software products; names of the user interface elements, application units, parameters, fields, operations, tags

Bold separated by a vertical slash

Menu | Start Server

Menu items

Bold italic

To start theRadixWare Server, use the RadixWare Starter application (for details, refer to RadixWare Starter. Administrator Guide).

Names of documents

Underlined

Connect to the DB

Reference to a topic / section / subsection / page within the document

Text after note.jpg

note.jpgTo enable the RadixWare Server to open the Oracle Wallet, the Oracle account should have the ALTER SYSTEM right.

Notes

Text after example.jpg

example.jpguser=RADIX

instance=1

Examples


Abbreviations

DBMS - Database Management System
JVM - Java Virtual Machine
OS - Operating System
SVN - Subversion

Introduction

The document describes the RadixWare Server application and its startup procedure.

Related Documents

# Document name Description
1 RadixWare Explorer. User Guide The document describes the RadixWare Desktop Explorer and RadixWare Web Explorer application facilities and methods of executing various operations.
2 RadixWare Starter. Administrator Guide The document describes the RadixWare Starter application and its startup procedure.


Overview

The RadixWare Server is an application server of the RadixWare platform.

The RadixWare Server is started using the RadixWare Starter application (for details, refer to RadixWare Starter. Administrator Guide).

The RadixWare Server performs the following functions:

  • Interacts with clients (RadixWare Explorer application is used as a client) and processes the data of each client.
  • Interacts with external systems.
  • Interacts with the database server (Oracle Database is used as a database server) and uses it to store the data and select the data to be processed.
  • Acts as a container (runtime environment) for the system units.

The system can comprise several application servers. The running server copy is called an instance. For each instance, the system administrator defines a set of units included in this instance. When launching the server, it is necessary to specify the identifier of the instance to be started.

Once connected to the database, the server loads the units described for this instance in the database. Each unit runs one or several OS threads.

The executable components of the RadixWare Server are downloaded from the SVN repository specified in the RadixWare Starter startup parameters. The repository in use can be a main repository or replica of the main repository. For details on the SVN repository replication, refer to the Subversion documentation.

The executable components of the RadixWare Server can be updated:

  • Automatically. When updating the versions of the RadixWare Server components in the SVN repository, they will be updated on the application server automatically. This method is used by default.
  • Manually. The RadixWare Server components are updated on the application server by the administrator command.

The RadixWare Explorer application is used to set up the system instance properties and describe a set of units for each instance.

RadixWare Server Startup

To start the RadixWare Server, use the RadixWare Starter application. It is recommended to start the Java virtual machine with the -server option. Therefore, the RadixWare Server startup command will be as follows:

java -server -jar starter.jar <RadixWare Starter startup parameters> org.radixware.kernel.server.Server <RadixWare Server startup parameters>

Note.jpgFor the appropriate performance of the system update procedure, it is strongly recommended to meet the following requirements when configuring the files used to run the RadixWare Server:
  • On Windows OS, for the possibility of the rolling upgrade of the starter.jar file for different RadixWare Server instances, it is necessary to have a separate copy of starter.jar for each instance.
  • On Linux OS, it is possible to use one starter.jar for several instances. If the instances are restarted manually, it is enough to update starter.jar once for the first instance to be restarted, the other instances will use the updated file.
  • In the commands used to run the RadixWare Server instances, it is necessary to use the script enabling to restart the instance in the OS and the script enabling to auto update starter.jar. For details on these scripts, refer to:

To ensure the correct execution of the starter.jar auto update script, the following additional requirements should be met:

  • for each instance, the command file for running the RadixWare Server instance and starter.jar file should be located in a separate directory (for Windows OS only)
  • starter.jar should not be renamed since the auto update script contains the name of the file being updated (starter.jar).

The startup parameters specific for the RadixWare Server are presented in the following table:

Parameter, Field in Startup Dialog Box

Description

Example of Parameter Use Case

-dbUrl DBURL, Database URL field

URL of the database being used. For the description of the URL format, refer to the Java SE documentation.

-dbUrl jdbc:oracle:thin:@dbserver:1521/x

-dbHost;
-dbPort;
-dbSid;
-dbService

Instead of the full URI of the DB (-dbUrl parameter), it is possible to define separate startup parameters of the RadixWare Server that will be used to automatically generate URI in the format jdbc:oracle:thin:@host:port:SID or jdbc:oracle:thin:@host:port/service, where:

  • jdbc:oracle:thin:@ - constant
  • host – IP address or DNS name of the DB server; it is defined in -dbHost parameter
  • port – port number; it is defined in -dbPort parameter
  • SID – DB identifier; it is defined in -dbSid parameter
  • service – DB service name; it is defined in -dbService parameter.
Note.jpg
  • When using the parameters, it is mandatory to define -dbHost, -dbPort and -dbSid or -dbService. If not all parameters are defined, the RadixWare Server will not be started and an error message will be displayed in the console.
  • The parameters cannot be used together with the –dbUrl parameter. If the parameters are used together, the RadixWare Server will not be started and an error message will be displayed in the console.

-dbHost dbserver -dbPort 1521 -dbService x

-dbSchema DBSCHEME, Database Schema field

DB schema being used

-dbSchema RADIX

-user USER, User field

User name for the database connection.

note.jpgThe specified user should be the owner of the DB schema being used or have <SCHEMA>_RUN_ROLE, where <SCHEMA> is the name of the DB schema being used.

-user RADIX

-externalAuth, the External value in the Authentication drop-down list

Enables the external authentication in the database

-externalAuth

-autostart

Starts the RadixWare Server immediately, without displaying the startup dialog box

-autostart

-switchGuiOff

Does not display the RadixWare Server dialog box - this means -autostart

-switchGuiOff

-instance ID, Instance drop-down list

System instance identifier

-instance 1

-startupGroup Group

Name of the instance startup group.

When using the –instance parameter, the instance with the appropriate number is started, if the startup group is specified, a free instance belonging to the specified group is selected and started.

The list of startup groups is defined in the Startup group parameter (instance editor | General tab). One of the groups from the list must be defined in this parameter. An instance for which one of the conditions is met is considered free:

  • No linked sessions in the DB.
  • More than one minute has passed since the last self-check of the instance and units. In this case, if the unresponsive sessions are found when starting the instance, they should be terminated. To be able to terminate sessions, the KILL_DATABASE_SESSION procedure must be configured in the DB.
Note.jpg

The -instance and -startupGroup parameters are mutually exclusive.

When starting an instance in GUI, the -startupGroup parameter is used only if the –autostart parameter is defined.

It may sometimes be required to start one instance with the specified ID instead of a group of instances without modifying the configuration file. In particular, if the container is configured to start the instance, the startupGroup value is passed as a substitution variable (via the OS environment variable used to start the container), and if it is necessary to specify the instance ID explicitly (for example, for test purposes), there is no simple way to replace the startupGroup parameter with the instance parameter in the configuration file within the container. For such a situation, it is possible to explicitly define the ID of the instance to be started in the startupGroup parameter of the instance. The parameter value should be specified in the format: __rdx_instance_<instance id>.

Example.jpg

Value startupGroup=__rdx_instance_123 is equal to value instance=123.

-startupGroup Group

-noRetryOnStartError

If the instance failed to start when using this parameter, the process will end immediately. If this parameter is not used, the startup attempts will be made every 5 seconds.

-noRetryOnStartError


-configFile FILE

Enables to use the settings made in the configuration file (FILE)

-configFile /home/user/server.ini

-sensitiveTraceFinishTime TIME

Enables the sensitive data tracing and performs it until the time specified in the TIME parameter. The time should be specified in the format yyyy-MM-dd-HH:mm. The sensitive data tracing is enabled for a period no longer than 8 hours.

-sensitiveTraceFinishTime=2012-01-20-15:00

-detailed3rdPartyLogging

Enables the detailed tracing for the external libraries

-detailed3rdPartyLogging

–udsBuildPath

List of jar files where to search for the classes when compiling the user-defined functions.

-udsBuildPath <jar1>:<jar2>:<jar3>

-udsBuildPath org.radixware/kernel/server/lib/ojdbc6.jar

-disableArteDbConnCloseOnClientDisconnect

Disables the mechanism of ARTE instances protection against hangup during the long-lasting requests to the database.

If an instance waits for the database response more than 10 seconds and the party that has initiated the request processing breaks the connection, the system aborts the operation to the database and stops the hanging ARTE instance. If necessary, the system starts the new instance instead of the stopped one

-disableArteDbConnCloseOnClientDisconnect

-auxDbUrl

URL of the JDBC connection to the Postgresql DB used to store the event log (in the format described in the documentation for Postgresql - https://jdbc.postgresql.org/documentation/head/connect.html). The currentSchema parameter of the DB URL should contain the DB schema that is currently used. If this parameter contains several schemas, the first one will be used for which the DB user specified in the -auxDbUser parameter has access. If the parameter is not defined, the public schema will be used.

-auxDbUrl jdbc:postgresql://1.2.3.4:5432/radixpostgresql?currentSchema=radix

-auxDbUser

Name of the user to connect to the Postgresql DB used to store the event log

-auxDbUser radixpostgresql


All RadixWare Server startup parameters are not mandatory. These parameters can also be defined in the dialog box displayed when starting the instance. The startup parameters defined in the command line are used in this dialog box as default values.

The instance startup dialog box looks as follows:

Server-db-connect.jpg

The instance startup parameters can be described in the configuration file. For details on the configuration file, refer to RadixWare Starter. Administrator Guide. The instance startup parameters are located in the [Server] section of the configuration file. The supported configuration file options are similar to the names of the startup parameters except for the initial "-" character.

note.jpgIf the RadixWare Server is started using the configuration file, only the -configFile FILE startup parameter should be used. The other parameters should be defined in the configuration file.

The RadixWare Starter and RadixWare Server can use the same configuration file - the RadixWare Starter uses the parameters of the [Starter] section, and the RadixWare Server uses the parameters of the [Server] and [App] sections. For this purpose, the configuration file should be specified in the -configFile startup parameter of the RadixWare Starter (for details, refer to RadixWare Starter. Administrator Guide).

Note.jpg

The parameters in the configuration file can be defined using the substitution variables. The values of substitution variables are taken from the JVM system properties specified in the server startup command, and from the environment variables. For example:

instance=${instance.id}

user=${db.user[RADIX]}

The substitution variable can have the default value (in the example above, the default value of db.user is RADIX).

Example.jpg

Section [Server] of the configuration file contains the user name used to establish a connection to the DB (-user startup parameter of the RadixWare Server); this name is defined using the substitution variable:

user=${some.var}

The command used to run the RadixWare Server contains the environment variable: export RDX_VAR_SOME_VAR="RADIX"

The value of variable some.var is searched for sequentially in the following objects:

  • JVM system property rdx.var.some.var
  • Environment variable RDX_VAR_SOME_VAR. The parameter value will be found at this stage.
  • JVM system property some.var. The search in this object will not be performed as the parameter value is found at the previous stage.

The following parameters can also be defined in the configuration file:

Parameter

Description

Passwords ([Server] section):

dbPwd

Password for the user account in the database

keyStorePwd

Password for the RSA keystore. The keystore is set up in the RadixWare Desktop Explorer, in the Keystore type and Keystore file path parameters of the system instance (branch System Settings / System Instances / <System instance> / General tab)

auxDbPwd

Password for the account in the Postgresql DB used to store the event log. After the server is started for the first time, this parameter is deleted from the configuration file and the password is stored encrypted in the auxDbEncryptedPwd parameter.

oraWalletPwd

Password for the Oracle wallet

System security parameters (section [App]):

askUserPwdAfterInactivity

Requests the password if the user is inactive

uniquePwdSeqLen

Number of previous passwords the current user password should not match

pwdMinLen

Minimum length of the user password

pwdMustContainAChars

Password contains alpha characters

pwdMustContainACharsInMixedCase

Password contains alpha characters of both cases

pwdMustContainNChars

Password contains numeric characters

pwdMustContainSChars

Password contains special characters

blockUserInvalidLogonCnt

Number of unsuccessful attempts to enter the password before the user is blocked

blockUserInvalidLogonMins

Period within which the user is blocked

pwdExpirationPeriod

Password expiration date

pwdMustDifferFromName

Password differs from the user name

dualControlRoleAssignment

Dual control mechanism is used when managing the roles of system users/user groups

When the RadixWare Server is started for the first time, the parameters defining the passwords are deleted from the configuration file, and the passwords are encrypted and saved to the file in the parameters with different names.

The security parameters define the minimum requirements for the system security. These parameters cannot be overridden by the system settings made in the RadixWare Explorer.

Example of the configuration file:

example.jpg[Starter] 
svnHomeUrl = svn://svn.server.local/radix/ 
topLayerUri = org.radixware 
appClass = org.radixware.kernel.server.Server 
showSplashScreen = Server  
[Server] 
#sensitiveTraceFinishTime=2012-01-20-15:00 
development 
autostart 
#switchGuiOff 
user = RADIX 
dbPwd = PASSWORD 
dbSchema = RADIX
dbUrl = jdbc:oracle:thin:@oracle.server.local:1521/XE
instance = 1  
[App] 
askUserPwdAfterInactivity 
uniquePwdSeqLen = 3 
pwdMinLen = 8 
pwdExpirationPeriod = 90
  

Example of the RadixWare Server startup command using the config.ini file:

example.jpgjava -Xmx4g -jar starter.jar -configFile config.ini


When editing the parameters in the configuration file, these changes can be applied to the running instance using a special command in the RadixWare Explorer. The following parameters can be applied to the running instance:

  • Time of sensitive data tracing
  • User name and password for database access
  • External authentication in database

If using the -autostart or -switchGuiOff parameters, it is necessary to define (in the command line or configuration file) all the parameters required to connect to the SVN repository and database since the startup dialog box is not displayed in this mode.

If using the -switchGuiOff parameter, the -showSplashScreen parameter of the RadixWare Starter is not necessary since the startup screen is displayed when using the latter.


Additional Startup Parameters

Some additional startup parameters supported by the RadixWare Server are described in the following table:

Parameter

Description

-switchEasVerCheckOff

Disables the compatibility check for the RadixWare Explorer and RadixWare Server versions.

-restart

Applies the settings used during the last start of the RadixWare Server. This parameter is used automatically when the instance is restarted normally.

Safe Connection to Database

To comply with the PCI DSS requirements (paragraph 2.2.2), the connection between the RadixWare Server and database server should be encrypted. The connection between the application server and DB server can be encrypted using any secure method, in particular:

Example of how to set up TLS encryption

The TLS encryption is set up using the standard tools of the Oracle JDBC Thin driver. To encrypt the connection, a keystore / certificate store should be available on the application server, for example, in the form of a file in JKS format. To manage keys and certificates, it is possible to use either standard tools, for example, keytool utility, or Key Store Administrator utility included in RadixWare. To enable the TLS encryption of the DB connection:

1.Add the following JVM parameters to the RadixWare Server startup command:

  • -Djavax.net.ssl.trustStore - path to the truststore file (file used to store trusted certificates)
  • -Djavax.net.ssl.trustStorePassword - password for the truststore file
  • -Djavax.net.ssl.trustStoreType - format of the truststore file (for example, JKS)
  • -Djavax.net.ssl.keyStore - path to the keystore file
  • -Djavax.net.ssl.keyStoreType - format of the keystore file (for example, JKS)
  • -Djavax.net.ssl.keyStorePassword - password for the keystore file
Example.jpg

Example of the RadixWare Server startup command:

java -Djavax.net.ssl.trustStore=/tmp/db_keystore.jks -Djavax.net.ssl.trustStorePassword=123456 - Djavax.net.ssl.trustStoreType=JKS -Djavax.net.ssl.keyStore=/tmp/db_keystore.jks -Djavax.net.ssl.keyStoreType=JKS -Djavax.net.ssl.keyStorePassword=123456 -server -Xmx4g -Xms3g -XX:ReservedCodeCacheSize=512m -cp starter.jar org.radixware.kernel.starter.Starter –configFile server.cfg

This example assumes that:

  • The Oracle Listener service is configured correctly, in particular, the network port is configured to receive connections via the TLS protocol, encryption keys and certificates are set up as well.
  • The private key of the application server and trusted certificate of the DB server are loaded to the keystore db_keystore.jks on the application server.
  • In the dbUrl parameter of the configuration file used to run the RadixWare Server, the DB URL is defined including the parameters enabling the encryption. Example of the dbUrl parameter value:

dbUrl='jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCPS)(PORT=1543)(HOST=1.2.3.4))(CONNECT_DATA=(SERVICE_NAME=radixdb)))'

2.Configure the RadixWare Manager: in the configuration file manager.conf (present in the manager/etc directory), add the JVM parameters (with paths and passwords to the keystore / certificate store) to the default_options parameter:

  • -J-Djavax.net.ssl.trustStore
  • -J-Djavax.net.ssl.trustStorePassword
  • -J-Djavax.net.ssl.trustStoreType
  • -J-Djavax.net.ssl.keyStore
  • -J-Djavax.net.ssl.keyStoreType
  • -J-Djavax.net.ssl.keyStorePassword
Example.jpg

Example of the default_options parameter value:

default_options="--branding manager -J-Xms512m -J-Xmx2048m -J-XX:MaxPermSize=512m -J-Dsun.java2d.noddraw=true -J-Dnetbeans.exception.report.min.level=900 -J-Dnetbeans.security.nocheck=true --locale en:US -J-Djavax.net.ssl.trustStore=/tmp/db_keystore.jks -J-Djavax.net.ssl.trustStorePassword=123456 -J-Djavax.net.ssl.trustStoreType=JKS -J-Djavax.net.ssl.keyStore=/tmp/db_keystore.jks -J-Djavax.net.ssl.keyStoreType=JKS -J-Djavax.net.ssl.keyStorePassword=123456"

Using Encrypted Tablespace

To ensure the security of data stored on the Oracle server, it is possible to use the encrypted tablespace. The data on the Oracle server is stored in encrypted form. The data is automatically encrypted when being written and automatically decrypted when being read. This technology is called Transparent Data Encryption (TDE).

The key for data encryption is stored in a special storage called wallet. The wallet is opened by the administrator when running the Oracle server (the password to enter the wallet is required). The administrator can open the wallet at any time. When the server is stopped, the wallet will be closed in any case.

For details on how to set up the transparent data encryption using the Oracle tools and how to work with the Oracle wallet, refer to Oracle Database Advanced Security Administrator\’s Guide.

If the Oracle wallet is closed when starting the RadixWare Server, the dialog box to open the wallet will be displayed in the dialog box displayed when starting the server at the attempt to expand the Instance drop-down list. In this dialog box, the password for the Oracle wallet and click the OK button. If an error opening the wallet occurs, click Refresh.png next to the Instance drop-down list and repeat the attempt. Note.jpgTo enable the RadixWare Server to open the Oracle wallet, the Oracle account should have the ALTER SYSTEM right.

Wallet-not-open.png

Restarting Instance Automatically Using OS Tools

To ensure the stable automatic instance restart when the instance terminates abnormally (for example, due to insufficient memory) or during the update procedure (instances should be restarted if the system core has been modified), it is recommended to add the procedure of automatic instance restart using OS tools to the RadixWare Server startup command. The following environment variables can be used in the procedure:

  • RDX_STARTER_RESTART_EXIT_CODE. The process exit code indicating that the instance has been stopped and will be further restarted as scheduled. If this variable is defined and the instance needs to be restarted, the instance will be stopped with the specified exit code, and the restart script will be used to restart the instance.
  • RESTART_ON_ANY_NONZERO_EXIT_CODE. The logical variable enables / disables the automatic restart of the instance after this instance process has been completed with any non-zero return code.
Example.jpgExample of the RadixWare Server startup command containing the procedure of the automatic restart of the instances using OS tools (for Linux OS) and procedure of the automatic update of starter.jar (for details, refer to RadixWare Starter. Administrator Guide / Updating Local starter.jar):

Auto start 1.jpg

RadixWare Server Logs and System Unit Logs

The logs of the RadixWare Server and system units are available:

  • In the dialog boxes in which the trace of the server and units is output if the -switchGuiOff parameter is not used.
  • In the special database tables. The logs stored in the database can be viewed in the RadixWare Explorer application.
  • In the text files. The path to the directory where log files will be created is specified in the instance settings.

The level of detail for the logs output on the screen, in the database and in the file is specified by the system administrator in the instance settings and in the settings of separate units.

Stopping Instance

If the RadixWare Server is started with the -switchGuiOff parameter undefined, the instance will be stopped when closing the server trace dialog box (the user will be asked to confirm the action).

If the RadixWare Server application is started with the -switchGuiOff parameter defined, it can be stopped correctly:

  • using the combination Ctrl+C in the console where the instance is started.
  • by sending the SIGTERM signal to the instance process.

Starting RadixWare Server with Java Service Launcher

In Windows OS, the RadixWare Server can be started as a service. For this purpose, a special tool - Java Service Launcher - is used. The RadixWare Server installed as a Windows service is started and stopped using the standard OS tools.

Java Service Launcher is included in the RadixWare distribution kit (in the org.radixware/etc/Jsl/ directory).

The RadixWare Server can be started with JSL on 64-bit systems only.

Settings for Java Service Launcher: Editing Configuration File

To start the Java Service Launcher, edit the jsl64.ini configuration file. The configuration file parameters used for authorization on the SVN server by login / password are described in the following table:

Parameter

Description

Example of Value

WORK_DIR

Path to the directory where the RadixWare Server is started

C:\

CLASSPATH

Full path to the starter.jar file

c:/org.radixware/kernel/starter/bin/dist/starter.jar

SVN_URL

URL of the SVN repository being used and the branch in it

svn://svn.server.local/rw/

SVN_USER

User name for authorization on SVN

svn

SVN_PWD

User password for authorization on SVN

svn

TOP_LAYER_URI

URI of the top layer of the software product

org.radixware.radinsk

DB_URL

URL of the database being used. For details on the URL format, refer to Java SE documentation

jdbc:oracle:thin:@dbserver:1521/XE

USER

User name for connection to the database

RADIX

PWD

Password for connection to the database

1234

DB_SCHEMA

Database schema being used

RADIX

INSTANCE

System instance identifier

1

autoupdatestarter

Enables / disables the automatic update of local starter.jar when starting the RadixWare Server (for details on the starter auto update, refer to RadixWare Starter. Administrator Guide).

1


For the authorization on the SVN server using the public/private SSH key pair, make the following changes to the configuration file:

1.Delete the strings defining the SVN_USER and SVN_PWD parameters.

2.Instead of them, add the following strings:

  • SSH_KEY. The path to the public SSH key. For example, SSH_KEY=/home/user/.ssh/id_rsa.pub.
  • SSH_PWD. The password for the public SSH key. For example, SSH_PWD=1234.

3.At the end of the configuration file, edit the param07 and param08 parameters:

param07 = -sshKeyFile=%SSH_KEY%

param08 = -sshKeyPassword=%SSH_PWD%

Settings for Java Service Launcher: Checking Service Configuration

To check the service configuration, execute the jsl64 -debug command from the org.radixware/etc/Jsl/ directory.

Settings for Java Service Launcher: Installing Service

To install the RadixWare Server as a Windows service, execute the jsl64 -install command from the org.radixware/etc/Jsl/ directory.

Settings Using Java Service Launcher: Uninstalling Service

To uninstall the RadixWare Server service, execute the jsl64 -remove command from the org.radixware/etc/Jsl/ directory.

RadixWare Server User Interface

After a database connection is established, the main window of the RadixWare Server application is opened. When the RadixWare Server is started for the first time, the dialog boxes of the units being started are also opened. When the application is started next times, the dialog boxes will be opened that were opened before closing the main window of the RadixWare Server.

Main Window of RadixWare Server

The main window of the RadixWare Server looks as follows:

Server-window.png

The main window of the RadixWare Server contains the following elements:

  • Menu including the following items:
    • Start Server. Opens the instance startup dialog box (for details, refer to RadixWare Server Startup). The menu item is inactive if the instance is running.
    • Stop Server. Disconnects the instance from the database and stops the instance. The menu item is inactive if the instance is not running.
    • Update Runtime Components. Downloads the latest versions of the RadixWare Server executable components from the SVN repository and applies them. If the changes are present in the system core (Kernel segment) or database structure, the instance will be automatically restarted.
    • Refresh List of Units. Updates the current list of started units.
    • Perform Instance Maintenance. Checks whether the new version of the application is available, rereads the settings, resets the metrics data in the database.
    • Reload ARTE Pool. Stops the ARTE instances in turn (with the average interval of 10 sec.).
    • Oracle Session Trace Options. Opens the dialog box with the settings for the Oracle session tracing on the database server (for details, refer to Oracle Session Tracing Setup).
    • Enable Sensitive Data Tracing. Opens the dialog box with the sensitive data tracing settings (for details, refer to Sensitive Data Tracing).
    • Create Instance for Recovery. Opens the dialog box used to create an instance for the configuration recovery (for details, refer to Creating Additional Instance for Configuration Recovery). The menu item is inactive if the server is running.
    • Create Configuration File. Opens the dialog box used to save the current server startup parameters to the configuration file (for details, refer to Creating Configuration File).
    • About. Opens the dialog box with the information on the versions of the running layers of the software product.
  • Trace tab (for details, refer to "Trace" Tab).
  • Units tab (for details, refer to "Units" Tab).
  • ARTE Pool tab (for details, refer to "ARTE Pool" Tab).

When closing the main window of the RadixWare Server, the user is asked for confirmation of the instance stop.

Oracle Session Tracing Setup

To set up the Oracle session tracing, select Menu | Oracle Session Trace Options in the main window of the RadixWare Server.

The dialog box with the Oracle session tracing settings looks as follows:

Sql-trace-setup-resized.png

The dialog box contains the following information:

  • Server process ID (SPID). The identifier of the DBMS process to which the RadixWare Server is connected.
  • Trace file directory. The directory on the database server containing the Oracle trace file. This parameter is defined in the DBMS configuration.
  • Trace file size. This parameter is defined in the DBMS configuration.

Clicking the Change Trace Level button opens the dialog box containing the New trace level parameter used to set up the tracing. The following tracing levels are available:

  • None
  • 1 — Basic statistics
  • 4 — Basic statistics + bind params
  • 8 — Basic statistics + wait events
  • 12 — Basic statistics + bind params + wait events

Trace level dialog.png

Sensitive Data Tracing

To set up the sensitive data tracing, select Menu | Enable Sensitive Data Tracing in the main window of the RadixWare Server. The dialog box with the sensitive data tracing settings looks as follows:

Sensitive-data-trace-resized.png

Parameters:

  • Global permission for sensitive data tracing. The current state of the global permission for the sensitive data tracing. The global permission for the sensitive data tracing can be enabled in the RadixWare Explorer, in the system settings. For security purposes, it is recommended to withdraw the global permission as soon as the tracing of these data becomes unnecessary.
  • Sensitive data tracing end time. The date and time when the sensitive data tracing will be disabled. Enter the date and time manually or select it in the calendar ( button).

Note.jpgThe sensitive data tracing can be enabled for a period not longer than 8 hours. In case the user defines the time exceeding this restriction, the system displays a warning message.

The sensitive data tracing will be performed only if the global permission on the tracing is on and the date of the local permission displayed in this dialog box is not expired.

Creating Additional Instance for Configuration Recovery

To create an additional instance for the system configuration recovery, select Menu | Create Instance for Recovery in the main window of the RadixWare Server. The dialog box will be opened that is similar to the server startup dialog box, but without the Instance drop-down list (for details, refer to RadixWare Server Startup). After clicking the OK button in this dialog box and connecting to the database, the New Recovery Instance dialog box will be opened:

Create-rescue-instance.png

This dialog box is used to set up and run the additional instance not described in the database. This instance can be used in case the instance settings have been changed in such a way that the application server becomes inoperable (for example, none of the instances contains a unit providing the EAS service). The dialog box contains the following parameters:

  • Instance control SAP address. The network address (host name and port number separated by colon) that the SAP of the instance management service should listen to.
  • EAS SAP address. The network address (host name and port number separated by colon) that the SAP of the instance EAS service should listen to. This address should be specified in the RadixWare Explorer connection settings to connect to the created instance.
  • SCP name. The service\’s client profile. It is possible to select one of the client profiles defined in the database or the No SCP option. If the client profile is selected in this parameter, only the stations assigned to this profile can be connected to the created instance. If the No SCP option is selected, only the stations not assigned to any client profile can be connected to the created instance (but such stations can also be connected to other SAPs of the EAS service).

Note.jpgThe host name should be localhost or one of the network addresses of the computer where the instance is started (IP address or domain name).

Clicking the OK button in the dialog box creates a new instance and selects it as the one to be started. The description of this instance appears in the database, therefore, the instance can be used again later.

Creating Configuration File

Selecting Menu | Create Configuration File opens the dialog box used to create a configuration file with the server startup parameters:

Create-config-file.png

The flags on the left pane of the dialog box define the parameters to be saved in the configuration file:

  • Starter Parameters
  • Database URL
  • Database Schema
  • User
  • Database Password (encrypted)
  • Use External Authentication
  • Keystore Password (encrypted)
  • Oracle Wallet Password (encrypted)
  • Instance
  • Autostart
  • Start without GUI

If the parameter is currently set to a certain value, this value will be used automatically. The Preview field on the right pane of the dialog box displays the content of the configuration file being created.

Clicking the Save button opens the dialog box for the selection of the configuration file to be created. If the server is started using the configuration file, this file will be selected by default.

Once the configuration file is saved, the following message will be displayed: Do you want to use this file as current configuration file?. If the action is confirmed, the Apply Settings from Configuration File command of the instance will use the settings from the created file (the command is executed in the RadixWare Explorer).

"Trace" Tab

The tab contains the table with the information on the events generated by the instance.

Right-clicking the name of any table column opens the dialog box where it is possible to set up the columns visibility.

Double-clicking the table row opens the dialog box containing the full information on the event: The table contains the following columns:

  • Severity. The event severity displayed as an icon.
  • Date, Time. The event date and time.
  • Source. The system component where the event occurred.
  • Message. The event message.
  • Context. The object the event relates to. Some events do not relate to any particular object.

Event info.jpg

Right-clicking the table row displays the context menu containing the Save to file command used to save the trace message to the file. The command can be executed on several messages selected with Ctrl or Shift pressed.

Toolbar of "Trace" Tab

The following table describes the toolbar buttons on the Trace tab:

Button

Command

Function

icon-clean.png

Clear List

Clears the list of events of the instance or unit

icon-colors.png

Appearance Options

Opens the dialog box with the trace appearance settings (see below)

icon-find.png

Find

Opens the dialog box used to search in the trace

icon-find-next.png

Find Next

Searches for the next occurrence of the key word in the trace

icon-trace-profile.png

Show Trace Profile

Opens the dialog box with the trace settings

In addition to the buttons described in the table, the toolbar contains the Filter parameter. This parameter defines the minimum severity of the events to be displayed. Available values:

  • Debug. Shows all events including debug messages.
  • Events. Shows messages with the Event severity and higher severity level.
  • Warnings. Shows messages with the Warning severity and higher severity level (messages on abnormal but not critical situations).
  • Errors. Shows error messages including critical errors.
  • Alarm. Shows only critical error messages.

Dialog Box with Trace Appearance Options

This dialog box is used to set up the trace appearance. The dialog box contains the toolbar and two tabs: Font and Color.

The table below describes the toolbar buttons:

Button

Command

Function

default-settings.png

Restore Default Settings

Restores all default settings

icon-reload.png

Cancel Changes

Rereads the current settings (and cancels the changes)

The Font tab shows the name of the font used to display the events and the Change button used to open the dialog box for font selection.

The Color tab contains the buttons to select the colors to indicate different types of events in the trace.

Trace Profile Settings

The system administrator sets the trace profile for each server unit using the RadixWare Explorer application. Clicking the Show Trace Profile button opens the dialog box showing the current trace profile of the unit to be output in the trace. This dialog box enables to enter another profile. If the trace profile is changed, the name of the Show Trace Profile button will change to Show Trace Profile (Profile Was Locally Overridden), and the icon will change to icon-trace-profile-over.png.

"Units" Tab

The tab contains the table with the information on the server units included in the instance. The table includes the following columns:

  • Severity. The severity of the most important event of those present in the unit trace. It is displayed as an icon.
  • ID. The unit identifier.
  • Type. The unit type.
  • Name. The unit name.
  • State. The current state of the unit (stopped, started, start postponed, etc.).

Double-clicking the table row opens the dialog box dialog box for unit selection (for details, refer to Unit Dialog Boxes).

Toolbar of "Units" Tab

The following table describes the toolbar buttons on the Units tab:

Button

Command

Function

icon-clean.png

Clear List

Clears the list of events in the trace of the units included in the current instance.

icon-trace-profile.png

Show Trace Profile

Opens the dialog box to set up the tracing level (severity level of the events to be displayed in the main window of the RadixWare Server) for the units included in the current instance.

"ARTE Pool" Tab

The tab contains the table with the information on the ARTE instances related to the current system instance. The table includes the following columns:

  • Severity. The severity of the most important event initiated by the process.
  • No. The sequence number of the ARTE instance.
  • State. The current state of the instance (free / busy).
  • Usage (Time %). The ratio of the instance usage time to the total operation time, in percent. The ratio is calculated for the following categories:
  • cpu. Time spent by the system on calculations.
  • db. Time spent by the system on DB queries.
  • ext. Time spent on requests to external systems.
  • other. Time spent on other actions.
  • idle. Idle time.
The information on the instance usage can be displayed as text (in this case, the information is displayed for the current moment) or as a diagram showing the instance load information for the last minute. To select the display mode, right-click the table header and set/unset the Usage as diagram flag.

Double-clicking the table row opens the dialog box containing the event trace of the selected ARTE instance.

Toolbar of "ARTE Pool" Tab

The following table describes the toolbar buttons on the ARTE Pool tab:

Button

Command

Function

icon-clean.png

Clear List

Clears the list of events in the trace of the ARTE instances included in the current instance.

icon-trace-profile.png

Show Trace Profile

Opens the dialog box used to set up the tracing level (severity level of events to the displayed in the main window of the RadixWare Server) for the ARTE instances included in the current instance.

Unit Dialog Boxes

To open the dialog box of the unit, double-click the table row on the Units tab in the main window of the RadixWare Server. The dialog box of each unit contains the menu bar and a set of tabs that depends on the unit type. The unit menu contains the following items:

  • Start Unit. Loads the unit and starts all processes related to it. This menu item is inactive if the unit is running.
  • Stop Unit. Stops all the processes initiated by the unit and unloads the unit. This menu item is inactive if the unit is not running.
  • Restart Unit. Stops the unit and restarts it. This menu item is inactive if the unit is not running.
  • Abort and Unload. Closes all resources (DB connection, sockets, etc.) of the unit, marks this unit in the DB as stopped, and unloads it from the server memory.
  • Server-Side SQL Trace Options. Opens the dialog box to set up the Oracle session tracing for the current unit (for details, refer to Oracle Session Tracing Setup).

Each dialog box contains the Trace tab that is similar to the Trace tab in the main window of the RadixWare Server, but it contains the events generated by a certain unit. For some types of units, the dialog box can have additional tabs (for details, see below).

ARTE Unit

The dialog box of the ARTE unit contains the Statistics tab with the diagram showing the unit workload in time.

Arte-stats.png

The Speed slider enables to control the speed of the diagram movement. The Start and Stop buttons start and stop the diagram movement, respectively.

Job Executor Unit

The dialog box of the Job Executor unit contains the Statistics tab with the diagram showing the unit workload in time.

Executor-stats.png

The control elements on this tab are similar to those on the Statistics tab of the ARTE unit (for details, refer to ARTE Unit).

Network Port Handler Unit

The dialog box of the Network Port Handler unit contains the Network Channels tab with the information on the active network channels. The table contains the following columns:

  • Severity. The severity of the most important event initiated by the process.
  • ID. The process identifier.
  • Name. The process name.
  • Active connections. The number of network connections set in the current channel.

Network-listeners.png

Double-clicking the table row opens the dialog box containing the trace of events initiated by the channel.