RadixWare Administrator Guide/RadixWare Server

From RadixWiki
Jump to: navigation, search

Revision History

Date RadixWare Version Description of Changes
19.03.2019 2.1.21.x Due to update of system core components, eliminated the facility to start applications running on Java JDK 1.7.x.

Updated section RadixWare Server Startup

08.06.2018 - Modified description of keyStorePwd parameter of instance startup.

Updated section RadixWare Server Startup

29.03.2018 - Added section Introduction

Updated sections:

27.09.2017

2.1.13.х

Added the description of script used to restart the instance using OS tools if required. This script is used to protect the system from the leak of system sources (for example, memory leak) when restarting the instances during the system update (the instances should be restarted if there are changes in the system core).

Updated section RadixWare Server Startup
Added section Restarting Instance Automatically Using OS Tools

In the GUI version of RadixWare Server application, changed the format of displaying the information on ARTE instance loading.

Updated section "ARTE Pool" Page

Trace page; unit dialog box | Trace page; ARTE instance dialog box), added the Save to file command of the context menu. To select several messages to be saved, keep Ctrl or Shift button pressed.

Updated section "Trace" Page


Conventions and Abbreviations

Conventions

Convention

Example

Applies to

Bold

The appearance of the Connection Manager dialog box

First mentioned terms; user interface elements; names of the software products

Bold separated by a vertical slash

Menu | Start Server

Menu item description

Bold italic

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

Names of the documents

Underlined

Connect to DB

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

Text after note.jpg

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

Remarks

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

RadixWare Server is the application server of the RadixWare technological platform.

To start up RadixWare Server, use the RadixWare Starter application (for details, refer to RadixWare Starter. Administrator Guide). RadixWare Server performs the following functions:

  • interacts with clients (the RadixWare Explorer application is used as a client) and performs client-specified processing of data
  • interacts with external systems
  • interacts with the database server (Oracle Database is used as a database server), using it for the data storage and selection of 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 administrator defines a set of units included in this instance. When starting up the server, it is necessary to specify the identifier of the instance to be started.

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

RadixWare Server executable components are loaded from the SVN repository defined in the RadixWare Starter startup parameters. The repository in use can be the main repository or its replication. For the replication settings of the SVN repositories, refer to Subversion documentation.

RadixWare Server executable components can be updated in two ways:

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

To set up the system instance properties and describe a set of units for each instance, use the RadixWare Explorer application.


RadixWare Server Startup

To start up RadixWare Server, use the RadixWare Starter application. At that, it is recommended to start up the Java virtual machine with the -server option. Therefore, RadixWare Server startup command looks 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 RadixWare Server are presented in the following table:

Parameter, Field in Startup Dialog Box

Description

Example of Parameter in Use

-dbUrl DBURL, Database URL field

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

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

-dbSchema DBSCHEME, Database Schema field

The used database scheme

-dbSchema RADIX

-user USER, User field

The user name for the database connection.

note.jpgThe specified user must be the owner of the used database scheme or have <SCHEMA>_RUN_ROLE, where <SCHEMA> is the name of the used database.

-user RADIX

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

Applies external authentication in the database

-externalAuth

-autostart

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

-autostart

-switchGuiOff

Does not display the RadixWare Server dialog box. It implies the -autostart

-switchGuiOff

-instance ID, the Instance drop-down list

The system instance identifier

-instance 1

-configFile FILE

At the startup, uses the settings defined in the FILE configuration file

-configFile /home/user/server.ini

-sensitiveTraceFinishTime TIME

At the startup, enables the sensitive data tracing and performs it until the time defined by the TIME parameter. The time must be specified in the yyyy-MM-dd-HH:mm format. The sensitive data tracing is enabled for a period not longer than 8 hours.

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

-detailed3rdPartyLogging

At the startup, enables the detailed tracing of external libraries.

-detailed3rdPartyLogging

–udsBuildPath

The list of jar-files where to search for 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


All RadixWare Server startup parameters are mandatory. It is possible to define these parameters in the dialog box that will open at the instance startup. The startup parameters defined in the command string 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 the description of 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 identical to the startup parameter names, except the initial "-" character.

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

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

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

Parameter

Description

Passwords ([Server] section):

dbPwd

The password to the user account in the database

keyStorePwd

The password to the RSA key storage. The key storage 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 page)

oraWalletPwd

The password to the Oracle wallet

System security parameters (section [App]):

askUserPwdAfterInactivity

Asks for the password after the idle state

uniquePwdSeqLen

The number of previous passwords that must not match the current user password

pwdMinLen

The minimum length of the user password

pwdMustContainAChars

The password must contain the alphabetical characters

pwdMustContainACharsInMixedCase

The password must contain the alphabetical characters of both cases

pwdMustContainNChars

The password must contain the numeric characters

pwdMustContainSChars

The password must contain the special characters

blockUserInvalidLogonCnt

The number of unsuccessful attempts to enter the password before the user is blocked

blockUserInvalidLogonMins

The time period within which the user remains blocked

pwdExpirationPeriod

The password expiration date

pwdMustDifferFromName

The password must differ from the user name

dualControlRoleAssignment

The use of dual control mechanism when managing the roles of system users/users group.

During the first RadixWare Server startup, the parameters defining the passwords will be removed from the configuration file. At that, the passwords will be encrypted and saved to the file in parameters with other names.

The security parameters define the minimum system security requirements. These parameters cannot be overridden by the system settings defined by means of RadixWare Explorer.

Example of the possible configuration file contents:

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 RadixWare Server startup command using the config.ini configuration file:

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


When changing the parameters in the configuration file, these changes can be applied to the running instance by means of a special command from 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 the -autostart or -switchGuiOff parameters are used, define (in the command line and configuration file) all the parameters required to connect to the SVN repository and database because the startup dialog box is not displayed in this mode.

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


Additional Startup Parameters

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

Parameter

Description

-switchEasVerCheckOff

Disables the check of compatibility between RadixWare Explorer and RadixWare Server versions.

-restart

Applies the settings of the last startup. This parameter is used automatically during the normal instance restart.

Safe Connection to Database

To comply with the PCI DSS requirements (paragraph 2.2.2), the connection between RadixWare Server and the database server must be encrypted. For this purpose:

  • connection encryption must be set up on the Oracle Database server.
  • Oracle Client must be installed and configured for encrypted connection on the computer where the RadixWare Server is started up.
  • RadixWare Server must use JDBC OCI Oracle driver to connect to the database (DB URL of the jdbc:oracle:oci:@dbserver:1521:orcl type, where dbserver — the database server address, 1521 — the port used by the database server, orcl — the Oracle resource identifier).

For details on how to set up the encrypted connection to the Oracle Database, refer to Oracle Database Advanced Security Administrator\’s Guide.

The Keystore password parameter in RadixWare Server startup dialog box defines the password to the RSA key storage. The system supports key storages on PKCS\#11 devices and in JCEKS files. The used key storage is specified by means of the RadixWare Explorer application, in the settings of the server instance being started.

Using Encrypted Tablespace

To provide security of the data stored on the Oracle server, it is possible to use the encrypted tablespace. At that, the data on the Oracle server are saved in the encrypted form. The data are automatically encrypted when writing and automatically decrypted when reading it. This technology is called Transparent Data Encryption (TDE).

The key for data encryption is stored in the special storage called wallet. The administrator must open the wallet when starting up the Oracle server (at that, the system asks to enter the password to the wallet). 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 by means of Oracle and how to work with the Oracle wallet, refer to Oracle Database Advanced Security Administrator\’s Guide.

If the Oracle wallet has been closed by the time RadixWare Server is started up, the wallet opening dialog box will be displayed in the server startup dialog box at the attempt to expand the Instance drop-down list. In this dialog box, enter the Oracle wallet password and click the OK button. If the wallet opening error occurs, click Refresh.png next to the Instance drop-down list and repeat the attempt. Note.jpgTo enable RadixWare Server to open the Oracle wallet, the Oracle account must 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 there are changes in the system core), 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 stopped operating and will be further restarted as scheduled. If this variable is defined and the instance needs to be restarted, the instance will terminate with the specified exit code, and the restart script will allow for the instance restart.
  • RESTART_ON_ANY_NONZERO_EXIT_CODE. The logical variable enables / disables the automatic restart of the instance after this instance process has terminated with any non-zero return code.
Example.jpgThe command for RadixWare Server startup containing the procedure of automatic restart of instances using OS tools (for Linux OS) and procedure of automatic restart of starter.jar file (for details, refer to RadixWare Starter. Administrator Guide / Updating Local starter.jar):

Auto start.jpg

RadixWare Server Logs and System Unit Logs

RadixWare Server logs and system unit logs are registered:

  • In the dialog boxes of server and units trace if the -switchGuiOff parameter is not used.
  • In the special database tables. It is possible to view the logs stored in the database by means of the RadixWare Explorer application.
  • In the text files. The path to the directory where the log files must be created is specified in the instance settings.

The level of detail of the logs displayed on the screen and registered in the database and file is specified by the system administrator in the instance settings and in the settings of particular units.

Instance Stop

If RadixWare Server has been started up without specifying the -switchGuiOff parameter, 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 has been started up with the -switchGuiOff parameter, it can be stopped correctly by:

  • "Ctrl+C" key combination in the console used for the instance startup;
  • sending the SIGTERM signal to the instance process.

Starting Up RadixWare Server as Windows Service

In Windows OS, RadixWare Server can be started up as a service. For this purpose, special toolkit is used. The toolkit is called java service wrappers. Two examples of using such programs (Java Service Launcher and Java Service Wrapper from Tanuki) are given below.

To start up and stop RadixWare Server installed as Windows service, use the standard OS tools.

RadixWare Server Startup Using Java Service Launcher

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

Settings for Java Service Launcher: Editing Configuration File

To start up Java Service Launcher, edit the jsl.ini configuration file (or jsl64.ini in the 64-bit system). The configuration file parameters used to authorize on the SVN server by login / password pair are described in the following table:

Parameter

Description

Example of Value

WORK_DIR

Path to the directory from which RadixWare Server is started up

C:\

CLASSPATH

Full path to the starter.jar file

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

SVN_URL

URL of the used SVN repository and the branch in it

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

SVN_USER

User name for authorization in SVN

svn

SVN_PWD

User password for authorization in SVN

svn

TOP_LAYER_URI

URI of the top product layer

org.radixware.radinsk

DB_URL

URL of the used database. For the description of 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

Used database scheme

RADIX

INSTANCE

System instance identifier

1


To use authorization on the SVN server by 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 open SSH key. For example, SSH_KEY=/home/user/.ssh/id_rsa.pub.
  • SSH_PWD. The password to the open SSH key. For example, SSH_PWD=1234.

3.At the end of the configuration file, change the parameter values param07 and param08 to the following:

param07 = -sshKeyFile=%SSH_KEY%

param08 = -sshKeyPassword=%SSH_PWD%

Settings for Java Service Launcher: Checking Service Configuration

To check the service configuration, execute the following command from the org.radixware/etc/Jsl/ directory:

  • jsl -debug (for the 32-bit system)
  • jsl64 -debug (for the 64 bit system)

Settings for Java Service Launcher: Installing Service

To install RadixWare Server as Windows service, execute the following command from the org.radixware/etc/Jsl/ directory:

  • jsl -install (for the 32-bit system)
  • jsl64 -install (for the 64-bit system)

Settings Using Java Service Launcher: Uninstalling Service

To uninstall the RadixWare Server service, execute the following command from the org.radixware/etc/Jsl/ directory:

  • jsl -remove (for the 32-bit system)
  • jsl64 -remove (for the 64-bit system)

RadixWare Server Startup Using Tanuki Java Service Wrapper

Settings For Tanuki Java Service Wrapper: Editing Configuration File

To set RadixWare Server as Windows service, edit the copied wrapper.conf configuration file. The parameters to be defined are described in the following table (all the parameter names must start with wrapper.; this prefix is omitted in the table):

Parameter

Description

Example of Value

java.classpath.1

Path to the starter.jar file

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

java.classpath.2

Path to the wrapper.jar file from the Java Service Launcher distribution kit

../lib/wrapper.jar

java.additional.1

Parameter defining that JVM must be started up in the server mode

-server

java.additional.2, .3, …

Additional JVM startup parameters

-Xmx1024m

app.parameter.1, .2, …

RadixWare Starter startup parameters

org.radixware.kernel.starter.Starter, -workDir=…

name

Name of the Windows service being installed

RadixWare Server

displayname

Displayed service name

RadixWare Server

description

Description displayed in the service properties

RadixWare Server

ntservice.starttype

Default startup mode of the service. Other possible parameter values: DELAY_START, DEMAND_START

AUTO_START

Configure the wrapper.app.parameter.* parameters according to the requirements specified in RadixWare Starter. Administrator Guide and in RadixWare Server Startup. Below see the example of the possible parameter values used to start up RadixWare Server from SVN.

example.jpg
wrapper.app.parameter.1=org.radixware.kernel.starter.Starter 
wrapper.app.parameter.2=-svnHomeUrl=svn://svn.server.local/tx/ 
wrapper.app.parameter.3=-authUser=svn 
wrapper.app.parameter.4=-authPassword=svn 
wrapper.app.parameter.5=-topLayerUri=org.radixware.radinsk 
wrapper.app.parameter.6=org.radixware.kernel.server.Server 
wrapper.app.parameter.7=-dbUrl 
wrapper.app.parameter.8=jdbc:oracle:thin:@dbserver:1521/orcl 
wrapper.app.parameter.9=-user 
wrapper.app.parameter.10=RADIX 
wrapper.app.parameter.11=-dbSchema 
wrapper.app.parameter.12=RADIX 
wrapper.app.parameter.13=-instance 
wrapper.app.parameter.14=1 
wrapper.app.parameter.15=-switchGuiOff

Settings For Tanuki Java Service Wrapper: Checking Service Configuration

To check the service configuration, run the RadixWareServer.bat file from the bin directory.

Settings For Tanuki Java Service Wrapper: Installing Service

To install RadixWare Server as Windows service, run the InstallRdxSrvService.bat file from the bin directory.

Settings For Tanuki Java Service Wrapper: Uninstalling Service

To uninstall the RadixWare Server service, run the UninstallRdxSrvService.bat file from the bin directory.

RadixWare Server User Interface

After establishing connection to the database, the main window of the RadixWare Server application opens. Starting up RadixWare Server for the first time, also opens the dialog boxes of the units being started. The next application startup opens only those unit dialog boxes that were opened before closing the RadixWare Server application main window.

RadixWare Server Main Window

The RadixWare Server main window looks as follows:

Server-window.png

RadixWare Server main window contains the following elements:

  • Menu item including the following subitems:
    • Start Server. Opens the instance startup dialog box of the (for details, refer to RadixWare Server Startup). The menu item is inactive for the running instance.
    • Stop Server. Disconnects the instance from the database and stops the instance. The menu item is inactive for the running instance.
    • Update Runtime Components. Loads the last versions of RadixWare Server executable components from the SVN repository and uses them. In case of changes in the system core (the Kernel segment) or the database structure, the instance is 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, re-reads the settings, resets the metrics data in the database.
    • Reload ARTE Pool. Stops the ARTE instances in turn (with the average time 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 settings for sensitive data tracing (for details, refer to Sensitive Data Tracing).
    • Create Instance for Recovery. Opens the dialog box used to create the instance for configuration recovery (for details, refer to Creating Additional Instance for Configuration Recovery). The menu item is inactive for the running server.
    • 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 information about the versions of the running product layers.
  • Trace page (for details, refer to "Trace" Page).
  • Units page (for details, refer to "Units" Page).
  • ARTE Pool page (for details, refer to "ARTE Pool" Page).

When closing RadixWare Server main window, the user is asked to confirm stopping the instance.

Oracle Session Tracing Setup

To set up Oracle session tracing, select Menu \| Oracle Session Trace Options in RadixWare Server main window. The Oracle session tracing setup dialog box 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 RadixWare Server is connected.
  • Dump files folder. The directory on the database server containing the Oracle trace file. This parameter is defined in the DBMS configuration.
  • Dump file size. The trace file size restriction. The unlimited value means that the file size has no restrictions. 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 executed by DBMS. 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 the Menu \| Enable Sensitive Data Tracing menu item in the RadixWare Server main window. The dialog box for sensitive data tracing setup looks as follows:

Sensitive-data-trace-resized.png

Parameters:

  • Global permission for sensitive data tracing. The current state of the global settings of the sensitive data tracing. It is possible to enable the sensitive data tracing globally by means of the RadixWare Explorer system settings. For security purposes, it is recommended to recall 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 has 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 RadixWare Server main window. At that, the dialog box similar to the server startup dialog box – but without the Instance drop-down list – opens (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 opens:

Create-rescue-instance.png

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

  • Instance control SAP address. The network address (the host name and port number separated by colon) that the SAP of the instance management service must listen to.
  • EAS SAP address. The network address (the host name and port number separated by colon) that the SAP of the created instance EAS service must listen to. Specify the same address 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 connect to the created instance. If the No SCP option is selected, only the stations that are not assigned to any client profile can connect to the created instance (but such stations can also connect to other SAPs of the EAS service).

Note.jpgThe host name must be localhost or one of the network addresses of the computer where the instance is started up (the 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 instance is described in the database, therefore, the created instance can be used again later.

Creating Configuration File

Selecting Menu | Create Configuration File opens the dialog box used to create the 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 has a value at the moment, this value will be set automatically. The Preview field on the right pane of the dialog box displays the contents 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 has been started with the use of a configuration file, the file used at its startup will be selected by default. Once the configuration file is saved, the "Do you want to use this file as current configuration file?" question is displayed. If the action is confirmed, the Apply Settings from Configuration File instance command will use the settings from the created file (the command is executed in RadixWare Explorer).

"Trace" Page

The page displays a table containing information on the events invoked by the instance.

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

Double-clicking the table row opens a dialog box containing 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 subsystem where the event occurred.
  • Message. The event message.
  • Context. The object that 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. It is possible to select several messages to be saved by keeping Ctrl or Shift button pressed.

"Trace" Page Toolbar

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

Button

Command

Function

icon-clean.png

Clear List

Clears the unit or instance list of events displayed on the page

icon-colors.png

Appearance Options

Opens the appearance options dialog box (see below)

icon-find.png

Find

Opens the dialog box for searching through the trace

icon-find-next.png

Find Next

Finds the next match with the key word in the trace

icon-trace-profile.png

Show Trace Profile

Opens the trace profile dialog box

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. Possible values:

  • Debug. Shows all events including the debugging messages.
  • Events. Shows the messages with the "events" severity and higher.
  • Warnings. Shows the warnings (messages on abnormal but not critical situations) and messages with higher severity.
  • Errors. Shows the error messages, including fatal errors.
  • Alarm. Shows only the fatal error messages.

Appearance Options Dialog Box

This dialog box is used to set up the appearance of the trace dialog box. The appearance options dialog box contains the toolbar and two pages: 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 page displays the name of the font used to display the events and the Change button used to open the font selection dialog box.

The Color page contains the buttons for selecting the colors used to display different types of events in the trace.

Trace Profile Setup

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

"Units" Page

The page displays a table containing information on the server units included in the instance. The table contains the following columns:

  • Severity. The severity of the most important event of those contained 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 unit state (Unit Stopped, Unit Started, Unit Start Postponed, etc.).

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

"Units" Page Toolbar

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

Button

Command

Function

icon-clean.png

Clear List

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

icon-trace-profile.png

Show Trace Profile

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

"ARTE Pool" Page

The page displays the table containing the information about the ARTE instances related to the current system instance. The table includes the following columns:

  • Severity. The severity of the most important event raised by the process.
  • No. The ARTE instance ordinal number.
  • State. The current instance state (free / busy).
  • Usage (Time %). The ratio of the instance loading time to its total working time, in percent. The ratio is calculated for the following categories:
  • cpu. Time spent for system operations.
  • db. Time spent for requests to DB.
  • ext. Time spent for requests to external systems.
  • other. Time spent for 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 loading 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.

"ARTE Pool" Page Toolbar

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

Button

Command

Function

icon-clean.png

Clear List

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

icon-trace-profile.png

Show Trace Profile

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

Unit Dialog Boxes

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

  • Start Unit. Loads the unit and starts all the processes related to it. This menu item is inactive for the running unit.
  • Stop Unit. Stops all the processes started by the unit and unloads the unit. This menu item is inactive for the running unit.
  • Restart Unit. Stops the unit and restarts it. This menu item is inactive for the running unit.
  • Abort and Unload. Closes all unit resources (DB connection, sockets, etc.), 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 Oracle session tracing for the current unit (for details, refer to Oracle Session Tracing Setup).

Each unit dialog box contains the Trace page that is similar to the Trace page of the RadixWare Server main window, but it displays the events raised by this unit. Moreover, additional pages are displayed for some units (for details, see below).

ARTE Unit

The ARTE unit dialog box contains the additional Statistics page 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 Job Executor unit dialog box contains the additional Statistics page with the diagram showing the unit workload in time.

Executor-stats.png

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

Network Port Handler Unit

The Network Port Handler unit dialog box contains the additional Network Channels page providing a table with the information on active network channels. The table contains the following columns:

  • Severity. The severity of the most important event raised 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 on the table row opens the dialog box containing the trace of events generated by the channel.