RadixWare

Software Products Installation and

Upgrade Technology

Administrator Guide
 Contents

1 Revision History
.............................................................................................. 5

2 Conventions and Abbreviations

.............................................................................................. 13

3 Introduction
.............................................................................................. 14

3.1 Related
.............................................................................................
Documents 14

4 RadixWare Manager Overview

.............................................................................................. 16

4.1 Principle
.............................................................................................
of Functioning 16

4.2 System.............................................................................................
Requirements 17

5 Installing and Updating Software Product

.............................................................................................. 18

6 Installing and Configuring External Software Products

.............................................................................................. 20

6.1 Installing
.............................................................................................
Oracle on DB Server 20

6.2 Installing
.............................................................................................
PostgreSQL on DB Server 20

6.3 Installing
.............................................................................................
and Configuring Subversion Server 23

7 Installing and Starting RadixWare Manager

.............................................................................................. 25

8 Updating RadixWare Manager

.............................................................................................. 27

9 Working..............................................................................................
in GUI Application of RadixWare Manager 29

9.1 Creating
.............................................................................................
Project 29

9.2 RadixWare
.............................................................................................
Manager User Interface 32

9.2.1 Project Structure

.................................................................................... 40

9.2.2 Project Commands

.................................................................................... 53

9.3 Setting.............................................................................................
Up Project and Repository 62

9.3.1 Editing Project

....................................................................................
Parameters 62

9.3.2 Setting Up
....................................................................................
Database Access Parameters 68

9.3.3 Editing Repository

....................................................................................
Parameters 71

2 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 9.3.4 Editing Replication
....................................................................................
Parameters 72

9.3.5 Setting Up
....................................................................................
Notification Service Parameters 76

9.4 Installing
.............................................................................................
Software Product 82

9.4.1 Creating ....................................................................................

Software Product 83

9.4.2 Loading Software

....................................................................................
Product Update Package 84

9.4.3 Submitting Software Product for Testing / Production on

.................................................................................... 88
Installation

9.4.4 Installing....................................................................................
Software Product to DB 93

9.4.5 Licensed....................................................................................
Software Product Installation 98

9.4.6 Setting Up
....................................................................................
User with System Privileges 99

9.5 Updating
.............................................................................................
Software Product 100

9.5.1 Submitting Software Product for Testing / Production on

Update .................................................................................... 101

9.5.2 Updating
....................................................................................
Database 109

9.5.3 "Update....................................................................................
Settings" Dialog Box 112

9.5.4 Granting
....................................................................................
Missing Rights to DB Entities 117

9.5.5 Checking
....................................................................................
User-Defined Functions during Update Installation 118

9.5.6 Analyzing
....................................................................................
System Changes 121

9.6 Managing Software Product Configuration in Environments and

............................................................................................. 122
Landscapes

9.6.1 Managing
....................................................................................
List of Environments 123

9.6.2 Operations
....................................................................................
on Environments 125

9.6.3 Setting ....................................................................................

Up Landscapes 127

9.6.4 Console....................................................................................
Application Commands to Manage Configurations 129

9.7 Errors.............................................................................................
Management 141

9.8 Export
.............................................................................................
of XSD Schemas for Software Product Definitions 142

10 Working with RadixWare Manager Console Application

.............................................................................................. 144

10.1 List of.............................................................................................

Application Commands 145

10.2 Examples
.............................................................................................
of Installation/Update Procedures 161

RWU - AG.ENG.06.12.2023. 3
2023 Compass Plus
11 Tools for Conversion of PostgreSQL Data Types to Native
Types .............................................................................................. 165

12 Appendix
.............................................................................................. 169

12.1 Software
.............................................................................................
Product File Packages 169

12.2 Scripts
.............................................................................................
Execution Log File 169

12.3 Release
.............................................................................................
Parameters Editor 173

12.4 Distribution
.............................................................................................
Kit Parameters Editor 176

12.5 RadixWare
.............................................................................................
Manager Configuration File 177

12.6 Local .............................................................................................

List of Databases 178

12.7 Memory
.............................................................................................
Allocated for RadixWare Manager 180

12.8 Sequence
.............................................................................................
of Update Package Numbers 180

12.9 Frequently
.............................................................................................
Asked Questions 182

12.9.1 Certificate
....................................................................................
Usage Errors 182

13 Glossary
.............................................................................................. 183

4 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Revision History

1 Revision History

RadixWare
Date Manager Description of Changes
Version

27.11.2023 1.2.11.38.9 Supported the system enabling to control changes made to the
configuration files. This system rereads the files on a periodic basis
(every 10 seconds) and compares their content against the
corresponding files used when starting the RadixWare Manager /
opening the project. If changes made by the third-party software are
detected for any of the files, a respective warning will be displayed.
The following files are controlled:
manager.conf configuration file
proj ect.xml file with the project settings
*.j ceks file of the certificate store

Updated sections:
Editing Project Parameters
RadixWare Manager Configuration File

Fixed the error that occurred when executing the Configure

Database Warnings command for the PostgreSQL DB.
Additionally, supported the facility to prohibit exclusion of some
warnings from the check. Such warnings are highlighted in grey in
the Warnings area and they cannot be moved to the Ignores area.

Updated section Project Commands

1.2.11.38 Implemented the tools for conversion of the PostgreSQL data types
to native types using the console version of the RadixWare
Manager application. These tools can be used on migration of the
RadixWare-based software products from Oracle DB to PostgreSQL
DB if Oracle GoldenGate is used for data replication.
As such, in the console version of the RadixWare Manager,
supported the
CMD_CREATE_SCRIPTS_TO_CHANGE_COLUMN_TYPES command.

Added section Tools for Conversion of PostgreSQL Data Types

to Native Types

Supported the facility to use keys of the PRIVATE KEY format for
user authentication by SSH Key File (one of the authentication
methods that can be used to access the SVN repository from the
RadixWare Manager application). Previously, only keys of the RSA
PRIVATE KEY format were supported.

Updated sections:
Editing Project Parameters
Editing Replication Parameters

To the context menu of the script available in the distribution kit

(project branch Distribution Kits / <Product> / <Distribution
Kit> / Scripts/ / <Layer>/ <Script>), added the Show Native
Script command.

RWU - AG.ENG.06.12.2023. 5
2023 Compass Plus
 Revision History

RadixWare
Date Manager Description of Changes
Version

Updated sections:
Project Structure
Project Commands

Supported the facility to validate the structure of the directory

storing the RadixWare Manager application files. As such:
To the manager/bin directory, added the executable files used to
run the validation process:
o checkStructure.cmd – for Windows
o checkStructure – for Linux
To the console version of the RadixWare Manager, added the
CMD_CHECK_MANAGER_STRUCTURE command used to run the
validation process.

Updated sections:
Installing and Starting RadixWare Manager
List of Application Commands

In the console version of the RadixWare Manager, supported the

facility to use a forward slash (/) in the names of arguments of the
DB_OPTIONS_PARAMETER_* type (for example,
DB_OPTIONS_PARAMETER_org.radixware/Partitioning).

Updated section List of Application Commands

Supported the facility to check the need to restart the RadixWare

Server and RadixWare Web Presentation Server in the course
of the software product update procedure.

Updated sections:
Submitting Software Product for Testing / Production on
Update
Analyzing System Changes

Supported the facility to use the macro parameter %

distributive_file_len% in templates of notifications generated by the
RadixWare Manager for the Distribution Kit Exported event.

Updated section Setting Up Notification Service Parameters

- Made the following changes to support the PostgreSQL DBMS in the

RadixWare-based software products:
To the General tab available when selecting Tools | Options |
Miscellaneous in the main menu, added the PostgreSQL JDBC
Driver File parameter.
To the editor of the DB access parameters (Databases) available
in the Config branch, added the Type parameter with the
following available values: Oracle (default value) and PostgreSql.
Supported the facility to add PostgreSQL DB to the local list of
DBs. As such, added the Type parameter to be defined in the
manager.conf configuration file when adding DB to the local list.

6 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Revision History

RadixWare
Date Manager Description of Changes
Version

Supported the facility to install the software product to PostgreSQL

DB and update PostgreSQL DB both by using the Install to
Database/Update in Database commands and within the
procedure for submitting the software product for testing/
production (the procedure is called using the Build | Testing
Branch '<BranchName>' and Build | Production Branch
'<BranchName>' commands). As such, a set of parameters and
their available values will be changed at the Database
Parameters stage (exact list of parameters and their values
depend on the software product being installed/updated).

Updated sections:
RadixWare Manager User Interface
Setting Up Database Access Parameters
Submitting Software Product for Testing / Production on
Installation
Installing Software Product to DB
List of Application Commands
Local List of Databases
Console Application Commands to Manage Configurations
Added section Installing PostgreSQL on DB Server

19.05.2023 1.2.11.37 Supported the facility to check DB for the availability of the
tablespaces required for correct operation of the software product.
This check is performed together with the other checks:
In the course of the installation procedure (using the Next button
in the Build dialog box when starting the procedure for submitting
the software product for testing/production as well as when
executing the Check and Check and Save Log commands).
Before installing the software product to the DB (Install to
Database command).

Updated section Submitting Software Product for Testing /

Production on Installation

--- Added the warning of the need to stop the update procedure in case
of certificate read errors.

Updated sections:
Setting Up Digital Signature Verification
Updating Software Product

21.07.2022 1.2.11.36 To the Insufficient Rights dialog box, showing the results of the
check performed before submitting the software product for testing/
production, added the Execute SQL command.
Updated section Granting Missing Rights to DB Entities

In the dialog box with the preparatory steps used when submitting
the software product for testing/production:
Renamed the Check All command to Check.
Added the Check and Save Log command.

RWU - AG.ENG.06.12.2023. 7
2023 Compass Plus
 Revision History

RadixWare
Date Manager Description of Changes
Version

Updated sections:
Submitting Software Product for Testing / Production on
Installation
Installing Software Product to DB
Submitting Software Product for Testing / Production on
Update
Updating Database
"Update Settings" Dialog Box
Checking User-Defined Functions during Update
Installation

To the script search dialog box (invoked using the Search Scripts
command in the context menu of the Scripts branch), added the
Case Sensitive flag.
Updated section Project Commands

Changed the conditions for checking for the software product

directory when loading the upgrade package (Load Updates
command).
Updated sections:
Installing Software Product
Loading Software Product Update Package

Supported the facility to check the file of the JDBC driver for
correctness (the file is specified in the Oracle JDBC driver file
parameter available on the General tab in the Tools | Options |
Miscellaneous menu item).
Updated section RadixWare Manager User Interface

To the Mail tab available in the Tools | Options | Miscellaneous

menu item, added the Subscribers area.
Updated section Setting Up Notification Service Parameters

To the dialog box used to export XSD schemas of the software

product definitions (invoked using the Export XSD Schemas
command in the context menu of the test/production/release
branches), added the schema namespace in addition to the names of
the schemas available/selected for export.
Updated section Export of XSD Schemas for Software Product
Definitions

To the console version of the RadixWare Manager, added the

CMD_SVN_REPLICATE command.
Updated section List of Application Commands

Supported the facility to output the information on the memory

allocated to / used by the application when executing the commands
in the console version of the application.
Updated section Working with RadixWare Manager Console
Application

Supported the facility to use the following macroparameters in

notification templates generated in the RadixWare Manager for
the Distribution Kit Exported event:
%distributive_checksum_md5%. Md5 hash of the file package
prepared for the customer.

8 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Revision History

RadixWare
Date Manager Description of Changes
Version

%distributive_checksum_sha256%. Sha256 hash of the file

package prepared for the customer.
Updated section Setting Up Notification Service Parameters

Supported the facility to use the following macroparameters in

notification templates generated in the RadixWare Manager for
the Distribution Kit Prepared and Distribution Kit Exported
events:
%added_modules% and %removed_modules%. The list of
modules added to/removed from the prepared distribution kit.
%added_modules_exists% and %removed_modules_exists%. The
macroparameters are used to define the condition: the prepared
distribution kit contains the modules added/removed.
Updated section Setting Up Notification Service Parameters

20.07.2022 --- Deleted the outdated section Auxiliary Database Tables.

Updated sections:
Installing Software Product
Installing Software Product to DB

30.11.2021 1.2.11.35 Supported the facility to perform the licensed system installation –
installation from the pre-agreed list stipulated in the license
agreement.
As such, to the dialog box used when submitting the software
product for testing/production, added the Licensed Installation
step when the user is prompted to specify the licensed role, code
and name or to skip this step by setting the Do not set the
parameters of the licensed installation flag.
Attention! The Licensed Installation step is available in the
RadixWare Manager only if the following conditions are met:
The vendor has made the required licensing settings before
building the distribution kit for the customer.
RadixWare is installed / updated to at least v.2.1.36.x.

Added section Licensed Software Product Installation

Updated sections:
Submitting Software Product for Testing / Production on
Installation
Submitting Software Product for Testing / Production on
Update
List of Application Commands

In the dialog box used when submitting the software product for
testing/production (After Kernel Files Update step), updated the
set of recommendations on the user actions.

Updated section Submitting Software Product for Testing /

Production on Update

RWU - AG.ENG.06.12.2023. 9
2023 Compass Plus
 Revision History

RadixWare
Date Manager Description of Changes
Version

To the dialog box used when submitting the software product for
testing/production, added the Scripts Execution step that
corresponds to the process of installing the software product to the
DB / updating the DB. At this step, the dialog box shows the
information on the process of installing the software product to the
DB / updating the DB. Previously, this information was displayed in
the Output dialog box.

Updated sections:
Submitting Software Product for Testing / Production on
Installation
Submitting Software Product for Testing / Production on
Update

To the dialog box used when submitting the software product for
testing/production (Database Parameters step), added the
following parameters:
o Version supported by platform
o Current version
Supported the facility to check whether the software product can
be installed to the selected DB.

Updated sections:
Installing Software Product to DB
Submitting Software Product for Testing / Production on
Installation
Submitting Software Product for Testing / Production on
Update

Supported the facility to generate SQL scripts that can be used to

grant privileges detected as missing when checking for the rights of
the DB user to the required Oracle entities (these checks are
performed before and after the software product is submitted for
testing/production). As such, to the dialog box showing the check
results:
Added the area containing the SQL script.
Added the following commands:
o Copy Sql
o Save Sql
o Fix Problems

Added section Granting Missing Rights to DB Entities

Updated section "Update Settings" Dialog Box

To the console version of the RadixWare Manager, added the

DISABLE_CHECK_RIGHTS argument.

Updated section List of Application Commands

When defining a list of local databases in the configuration file

manager.conf (manager/etc directory), it is now possible to use the
separator character "_" instead of "." in the names of the
parameters of the local databases.

Updated section Local List of Databases

10 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Revision History

RadixWare
Date Manager Description of Changes
Version

Supported the facility to automatically check the available RAM

volume when starting the RadixWare Manager.

Updated section Installing and Starting RadixWare Manager

Supported the facility to disable automatic opening of projects from

the previous session when starting the RadixWare Manager. As
such, in the manager.conf file (manager/etc directory), supported
the flag netbeans.keep.expansion=false.

Updated sections:
Creating Project
RadixWare Manager Configuration File

Since the external SVN client is no longer used in the RadixWare

Manager, the Checkout command (available in the context menu
of the SVN directories / branches of the navigation tree) has been
eliminated.

Updated section Project Commands

Supported the facility to save the HTML description of the software

product API to a ZIP archive when executing the Export HTML
Documentation command. As such, in the command settings, the
dialog boxes for file / segment / language selection displayed one by
one have been replaced with one dialog box.

Updated section Project Commands

It is now possible to disable the capability to check whether the data

of the main repository of the project and of the selected replica is
synchronized (this check is, by default, performed before
replication). As such:
In the manager.conf file (manager/etc directory), supported the
CheckCommitPolicyOnReplicaSync parameter.
To the console version of the RadixWare Manager, added the
CHECK_COMMIT_POLICY_ON_REPLICA_SYNC argument.
Enhanced logging of the replication operation.

Updated sections:
Editing Replication Parameters
List of Application Commands
RadixWare Manager Configuration File

Optimized the algorithm of replicating the SVN repository of the

project (Replication editor, Replicate command): now, the
replication algorithm takes into account the features of copying the
properties of the revisions of the main repository to the repository of
the replica.

Updated section Editing Replication Parameters

Changed the logic of duplicating the repository (Replication editor,

Duplicate command).

Updated section Editing Replication Parameters

RWU - AG.ENG.06.12.2023. 11
2023 Compass Plus
 Revision History

RadixWare
Date Manager Description of Changes
Version

Changed the date format in the names of log files generated when
executing different operations in the RadixWare Manager. Now,
the new format yyyy_mm_dd-hh_mm_ss-<OperationName>.log is
used instead of
Log_dd_mm_yyyy_hh_mm_ss_<OperationName>.log.

Updated section Project Commands

In the console version of the RadixWare Manager, supported the

CMD_MAKE_BRANCH command enabling to create a new branch in
the SVN repository of the project.

Updated section List of Application Commands

1.2.11.34.15 To the console version of the RadixWare Manager, added the

arguments that can be used to set up interaction with the Oracle
Wallet when executing the commands requiring access to the
RadixWare Server:
DB_WALLET_DIR_NAME. The directory name from the
ALL_DIRECTORIES view to be used to search for the path to the
Oracle Wallet ("file" prefix will be added to the path found). Use
case: DB_WALLET_DIR_NAME=SSL_WALLET_DIR.
DB_WALLET_PATH. The path to the Oracle Wallet. Use case:
DB_WALLET_PATH=file:C:/walletDir.
DB_WALLET_PWD. The password to the Oracle Wallet.
Attention! The DB_WALLET_DIR_NAME and DB_WALLET_PATH
arguments cannot be used together in the command (they are
interchangeable).

Updated section Console Application Commands to Manage

Configurations

12 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Conventions and Abbreviations

2 Conventions and Abbreviations

Conventions
Convention Example Applies To

Italic Copy the manager.zip archive to Names of files, directories, sub-

the local disk of the workstation. directories, etc.

Bold RadixWare Manager is installed Terms introduced for the first time;
on the administrator workstation. names of software products, procedures,
user interface elements
Number in [] For details, refer to document [3]. Hyperlink to the name of an external
document
Underlined Setting Up Database Access Hyperlink to a subsection or paragraph
Parameters within the document
Underlined bold For the description of the project Hyperlink to section within the document,
structure, refer to Project to external document
Structure.
Text in <> <Layer> - software product layer Variable
name

Text after RadixWare Manager must be Notes

installed before installing the
software product.

Text after When installing RadixWare, Examples

Install URI is as follows:
org.radixware.

Abbreviations
OS Operating system
DB Database

RWU - AG.ENG.06.12.2023. 13
2023 Compass Plus
 Introduction

3 Introduction

RadixWare Manager application is a tool for maintaining software products based on

RadixWare platform. In a company employing such software products (hereinafter -
customer), RadixWare Manager is used to initially install the software product and then
install updates. In a company developing the software products (hereinafter - vendor),
RadixWare Manager is used to manage the product releases and to prepare the product
updates for customers.

This document is a reference guide describing how to install and use RadixWare
Manager on the customer side.
The general concept of maintaining software products based on the RadixWare
platform and the RadixWare Manager application functionality at the development
and customer support stages are described in the document [7].

The document provides:

General description of RadixWare Manager
Description of how to install and configure the applications required for correct
functioning of RadixWare Manager
Description of how to install and configure RadixWare Manager
Description of the project structure and main elements of the RadixWare Manager
user interface
Description of how to install and update software products by means of RadixWare
Manager

The document is intended for the administrator who is responsible for the software
installation and update on the customer side.

To install, configure and use RadixWare Manager, it is just enough to have the
advanced user skills in the respective operating system.

3.1 Related Documents

# Document Name Description

1 RadixWare. Overview The document describes the RadixWare system:

purpose, composition, technologies, capabilities
RW_Overview(E).pdf
and features, structure and architecture.
2 RadixWare Explorer. User Guide The document describes the capabilities of the
RadixWare Desktop Explorer and RadixWare
RW_Explorer_UserGuide(E).pdf
Web Explorer applications and methods of
executing various operations.
3 RadixWare. System Administrator Guide The document is intended for the RadixWare
system administrator and provides the instructions
RW_SystemAdministratorGuide(E).pdf
on the overall system configuration.

14 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Introduction
Related Documents

# Document Name Description

4 RadixWare Server. Administrator Guide The document describes the RadixWare Server
application and its startup procedure.
RW_Server_AdministratorGuide(E).pdf
5 RadixWare Starter. Administrator Guide The document describes the RadixWare Starter
application and its startup procedure.
RW_Starter_AdministratorGuide(E).pdf
6 RadixWare Web Presentation Server. The document describes the RadixWare Web
Administrator Guide Presentation Server application and its startup
procedure.
RW_WebPresentationServer_AdministratorGui
de(E).pdf
7 RadixWare. Software Support Guide The document describes the general concept of
how to support the RadixWare-based software
RW_Support_AdministratorGuide(E).pdf products and work with the RadixWare Manager
application when developing software products and
supporting customers.
8 RadixWare. Key Store Administrator The document describes the Key Store
Utility. Administrator Guide Administrator utility.
RW_KeyStore_AdministratorGuide(E).pdf
9 RadixWare. Programmer Guide The document describes the basic concepts,
objects and mechanisms of the RadixWare
RW_ProgrammerGuide(E).pdf
platform and tools of the RadixWare Designer
application used to develop applications on the
RadixWare platform.

The electronic versions of the documents are available on the Company sftp server.

RWU - AG.ENG.06.12.2023. 15
2023 Compass Plus
 RadixWare Manager Overview

4 RadixWare Manager Overview

On the customer side, the RadixWare Manager is used to install and update software
products. In compliance with PCI DSS requirements, the RadixWare Manager enables to
authenticate file packages received from the vendor by using the Digital Certificates
technology.

The RadixWare Manager provides the tools for informing:

the vendor's product support service about the current version of the software product
installed on the customer side and about the errors that occur during the updates
installation.
the software product users about the operations performed in the RadixWare Manager
(notification service).

The RadixWare Manager application is accessible either via GUI or console.

4.1 Principle of Functioning

RadixWare platform components interact as follows:

DB Server. Oracle Database is used (it is also possible to use a cluster of DB servers).
The DB server provides access to DB objects of the software product installed.
Application Server. The application server is represented by RadixWare Server
application that interacts with the DB server by using it for storing and selecting data
and with workstations by processing user requests.
Workstations. The RadixWare Explorer application is executed at the workstations.
Repository (SVN). This is a common storage of software product files for client and
server applications. The SVN repository has a tree-like structure of directories where
the files are grouped according to their purpose. The files used for production and for
testing are separated and located in the prod directory and testing directories,

16 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 RadixWare Manager Overview
Principle of Functioning

respectively. RadixWare Server and RadixWare Explorer applications must have

access to the software product files located in the respective repository directory: the
prod directory or any of testing directories. At that, the test DB are created for each
test branch and the production DB is created for the prod branch. For the description of
the repository structure, refer to document [7]. The repository in use can be the replica
(copy) of the remote SVN repository.

The initial distribution kit of the software product is supplied as an initial installation
package. RadixWare Manager application files come with the distribution kit. Thereafter,
the customer is supplied with the software product updates.

RadixWare Manager is to be installed on the workstation of the administrator who

installs and updates the software product on the customer side (refer to Installing
RadixWare Manager). The application controls the DB server and the repository. To
work with the repository, a project is created in RadixWare Manager; the project is a
logical representation of the repository physical structure (for the project structure
description, refer to Project Structure).
During the initial software product installation, RadixWare Manager initializes the
repository and installs the software product to the database. Then the administrator sets
up the workstations and the application server (for details on the procedure, refer to the
documentation on the software product to be installed).
On receiving the software product updates, RadixWare Manager updates the respective
files in the repository and adjusts the database structure in accordance with the current
software product release by running scripts. The software product version in the
repository is tracked on the application server and workstations. The updates are
automatically delivered to the servers and workstations and are installed when ready.

RadixWare Manager also supports the facility to create and synchronize the SVN
repository replicas (for the replication setup, refer to Editing Replication Parameters).
For the description of SVN repositories replication, refer to SVN documentation.

4.2 System Requirements

The RadixWare Manager application can be run on any OS supporting Java: Windows,
Linux, Unix, etc.

To work with the GUI version of the RadixWare Manager installed on Unix platforms
(Linux and other OS), the window manager for X Window System may be required.

When opening the project tree or attempting to export the file(s) from the SVN
repository (using the respective commands available in the context menu of the
project navigation tree) on UNIX platforms (Linux OS, etc.), errors may appear in the
Output dialog box. In this instance, it is necessary to disable proxy in the RadixWare
Manager settings (set the Proxy Settings parameter to No Proxy on the General tab
of the Tools | Options item of the main menu).
The Java Development Kit versions 8/11 must be installed on the workstation. It is
recommended to use the latest Java version.
The RadixWare Manager requires installing neither SVN client nor Oracle client.

RWU - AG.ENG.06.12.2023. 17
2023 Compass Plus
 Installing and Updating Software Product

5 Installing and Updating Software Product

Preparing to Software Product Installation

Before installing a software product based on the RadixWare platform, perform the
following actions:
1.Get the software product files package and RadixWare Manager application from the
vendor.
The software product distribution kit is composed for each customer personally and
contains a set of units as provided by the agreement. The distribution kit is numbered
according to the customer-specific numbering in strict sequence. The initial software
product distribution kit is supplied to the customer as an initial installation package.
Thereafter, the customer is supplied with the software product updates, patches and
fixes.
org.radixware.radinsk-<client X*>-1-1.0.1.2.zip
org.radixware.radinsk-<client X*>-2-1.0.1.3.zip
org.radixware.radinsk-<client X*>-3-1.0.1.4.zip, where

* <client X> - customer name

For details on the format of software product file packages, refer to Appendix.
Software Product File Packages.
2.Prepare to install the RadixWare Manager application:
Provide access to the DB server. For details, refer to Installing Oracle on DB
Server and Installing PostgreSQL on DB Server.
Ensure availability of the SVN repository with the installed Subversion server. For
details on the Subversion server installation and setup (by using Subversion Edge
as an example), refer to Installing and Configuring Subversion Server.
Install Java on the workstation.
3.Install the RadixWare Manager application. For details, refer to Installing and
Starting RadixWare Manager.
4.Create a project in the RadixWare Manager application. For details, refer to Creating
Project.
5.Set up the project and repository parameters:
Set up database access parameters
Set up digital signature verification
Set up repository replication (if necessary)
Set up notification service (if necessary)
The procedures for preparing the software product for installation are available only in
the GUI version of the RadixWare Manager application. The installation and update
procedures are available both in the application GUI and console versions.
6.Install the software product using the RadixWare Manager application as described
below.

18 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Installing and Updating Software Product

Installing Software Product

The software product installation includes the following stages:
1.Load the installation package received from the vendor to the repository.
2.Before putting the software product into production, it is recommended to test it. At
that, the software product is installed to test DB.
3.After the software product is successfully tested, it can be put into production. At
that, the software product is installed to the production DB.
For details on each stage, refer to Installing Software Product (for GUI application). For
description of commands used in the application console version, refer to Working with
RadixWare Manager Console Application.

Updating Software Product

The software product update procedure is identical to the installation procedure:
1.Load the update package received from the vendor to the repository.
2.Before putting the software product into production, it is recommended to test it. At
that, test DB is updated.
3.After the software product is successfully tested, it can be put into production. At
that, the production DB is updated.
For details on each stage, refer to Updating Software Product (for GUI application). For
description of commands used in the application console version, refer to Working with
RadixWare Manager Console Application.

Starting Software Product

The software products based on RadixWare include the client applications, application
server and database server. The data presentation layer to interact with users is
implemented on the basis of the RadixWare Explorer application. For the RadixWare
Explorer operation the server connection is required. Thus, to run the software product,
execute the following actions:
Run the application server (RadixWare Server). For details, refer to document [4].
Run the RadixWare Explorer. For details, refer to [2].

RWU - AG.ENG.06.12.2023. 19
2023 Compass Plus
 Installing and Configuring External Software
Products
Installing Oracle on DB Server

6 Installing and Configuring External Software

Products

6.1 Installing Oracle on DB Server

The section describes the features of installing Oracle on the DB server, which are
common to all software products based on the RadixWare platform. For the detailed
recommendations as well as for the technical requirements for the DB server
configuration, refer to the documentation for the software product being installed.

When installing Oracle Software, it is recommended to keep only the Partitioning option
enabled (if this option is supported in the DB version being installed).

Recommended base values for the Oracle DB initialization parameters:

Parameter Type Parameter Value

NLS SETTINGS NLS_CHARACTERSET AL32UTF8
NLS_NCHAR_CHARACTERSET AL16UTF16
NLS_LENGTH_SEMANTICS CHAR
CURSORS OPEN_CURSORS 2048

Tablespace Requirements
Before the software product is installed to the Oracle DB, it is necessary to create
tablespaces using the script that is provided in the distribution kit as an example
(tablespace.sql file in the etc\DbScripts\ directory in the Radix (org.radixware) layer or in
the software product layer).
The DB administrator needs to:
1.Copy the script intended for Oracle from the tablespace.sql file.
2.Edit the script in compliance with the customer DB requirements. The initial tablespace
volume depends on the stored data volume (type, number and storage period of
customer data, operations, etc.)
3.Run the script on the DB in any possible way.

6.2 Installing PostgreSQL on DB Server

The section describes the features of installing PostgreSQL on the DB server, which are
common to all software products based on the RadixWare platform. For the detailed
recommendations as well as for the technical requirements for the DB server
configuration, refer to the documentation for the software product being installed.

After the PostgreSQL DB is installed, it is necessary to perform the following actions for
the correct operation of the RadixWare-based software product with this DB:
1.Creating DB
2.Creating Tablespaces

20 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Installing and Configuring External Software Products
Installing PostgreSQL on DB Server

3.Installing and Loading Extensions

4.Defining Additional DB Configuration Parameters

Creating DB
It is recommended to create a separate DB for RadixWare to work with PostgreSQL.

Script for DB creation:

CREATE DATABASE rwdb
WITH
OWNER = postgres
ENCODING = 'UTF8'
CONNECTION LIMIT = -1
IS_TEMPLATE = False;
exit;

Creating Tablespaces
Before installing the software product to the PostgreSQL DB, it is necessary to create
tablespaces using the script that is supplied in the distribution kit (tablespace.sql file in
the etc\DbScripts\ directory in the Radix (org.radixware) layer or in the software product
layer).

The DB administrator needs to:

1.Create a separate directory for each tablespace.

Script for creating directories for the radix and radix_eventlog tablespaces in the
DB:
sudo su - postgres
export PGUSERDATA='/var/lib/pgsql/15/data_users_ts'
mkdir -p "${PGUSERDATA}/radix"
mkdir -p "${PGUSERDATA}/radix_eventlog"

2.Copy the script intended for the PostgreSQL DB from the tablespace.sql file
3.Correct the script by specifying the respective directories in the DB as a location for
the tablespaces.
4.Run the script in the DB in any possible way.

Script for the radix and radix_eventlog tablespaces creation:

psql -d txdb <<EOF
CREATE TABLESPACE radix OWNER postgres LOCATION '${PGUSERDATA}/
radix';
CREATE TABLESPACE radix_eventlog OWNER postgres LOCATION '${PGUSERDATA}/
radix_eventlog';
EOF

RWU - AG.ENG.06.12.2023. 21
2023 Compass Plus
 Installing and Configuring External Software
Products
Installing PostgreSQL on DB Server

Installing and Loading Extensions

The list of PostgreSQL extensions provided below is not final and can be expanded for
a particular RadixWare-based software product. Additional extensions required for
correct operation of the software product may be added in the new RadixWare
versions.

List of mandatory extensions:

orafce (minimum version – 3.22)
dblink
pltcl

pgsql-http. This extension is mandatory when working in the console RadixWare

Manager application if the software product configuration management commands are
used.

Additionally, some optional extensions are recommended for RadixWare-based software

products.

Installing extensions:
The installation specifics for the above-listed extensions depends on the OS and type/
version of the DB being used.

Creating extensions:
To create extensions, it is necessary to connect as a superuser (postgres, by default)
and run the following SQL commands in the DB:
CREATE EXTENSION <extension name>;

Command for extension creation:

# psql -d rwdb
CREATE EXTENSION dblink;
CREATE EXTENSION orafce;
CREATE EXTENSION pltcl;

Defining Additional DB Configuration Parameters

For the correct DB operation, it may be required to define the respective parameters in
the postgresql.conf configuration file. The location of this configuration file depends on
the DB type and version. A set of parameters and recommendations on how to define
them depend on the features of a particular system and estimated load on the DB. For
details, refer to the documentation for the software product being installed.

22 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Installing and Configuring External Software Products
Installing PostgreSQL on DB Server

6.3 Installing and Configuring Subversion Server

The section provides the instructions on the SVN server installation and configuration
implying that a user is authenticated by password and provided access via the SVN
protocol (other configurations are also available, for example, authentication by
certificate or access via the http/https protocols).

The RadixWare-based software products operate with the version control system of
the Subversion type. To deploy the Subversion server, distribution kits from different
vendors can be used. This guide describes the Subversion Edge distribution kit as an
example.

The Subversion Edge installation procedure is as follows:

1.Download the Subversion Edge installation file from the official web site.
2.Run the file and install the server following the on-screen instructions. It is not
recommended to unset the Install svnserve to run as Windows service flag during
the installation process (for the Windows service installation).
3.Run the command line and move to the directory where the Subversion Edge is
installed.
4.Run the utility for repository directory creation using the svnadmin create command
and specify the path that has been specified in the Repository Path parameter during
the Subversion Edge installation.

The svnadmin create C:\rw_repository command creates a repository structure in

the C:\rw_repository directory.

5.Edit the SVN configuration files located in the conf subdirectory of the created
repository (for example, C:\rw_repository\conf):
In the svnserve.conf file, uncomment the anon-access, auth-access, password-db,
realm parameters and define them as follows:
anon-access = read
auth-access = write
password-db = passwd
realm = RadixWare Repository (or any other name of the repository. This name is
requested when authorizing on the SVN server)
In the passwd file, add a user creation line in the following format: <user login> =
user password (for example, svnuser = userpass)

When using Subversion Edge v.5.x and higher, it is recommended to create a

separate login account to be further used for authentication on the SVN server from
the RadixWare Manager. The use of the account created by default during the
SVN server installation (<user login> = admin) may affect the duration of the system
installation / update procedures.

RWU - AG.ENG.06.12.2023. 23
2023 Compass Plus
 Installing and Configuring External Software
Products
Installing and Configuring Subversion Server

Restart the CSVNsvnserve service from the command line using the following commands:
net stop CSVNsvnserve
net start CSVNsvnserve

24 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Installing and Starting RadixWare Manager

7 Installing and Starting RadixWare Manager

The RadixWare Manager is delivered to the customer as a zip file (manager.zip)

together with the initial installation package.

The RadixWare Manager is installed on the workstation of the administrator who is

responsible for the software installation and update on the customer side.

Follow the steps to install the RadixWare Manager:

1.Copy the manager.zip archive to a local or network drive.
2.Unpack the manager.zip archive.

The result will be a directory with the following structure:

bin subdirectory. Contains the following files:

o checkStructure and checkStructure.cmd - executable files used
to start validating the structure of the RadixWare Manager
files directory (for Linux and Windows OS respectively). The
validation result contains information on the discrepancies
found between the current directory structure and the expected
one.
o clearCache and clearCache.cmd - executable files used to start
clearing the application cache (for Linux and Windows OS
respectively)
o console and console.cmd - executable files used to run the
console version of the RadixWare Manager (for Linux and
Windows OS respectively). For details, refer to Working with
RadixWare Manager Console Application.
o manager and manager.cmd - executable files used to run the
GUI version of the RadixWare Manager (for Linux and
Windows OS respectively)
o manager.bin and manager64.bin - utility files used to run the
application
etc subdirectory. Contains the following files:
o manager.clusters - utility file
o manager.conf - configuration file of the application. For details,
refer to RadixWare Manager Configuration File.
o manager.inf - utility file used to store information on the
application version, svn revision used to build the application
and hashes of all files
ide, j ava, manager, platform subdirectories. Contain the utility
files. It is not recommended to edit/delete the content of these
subdirectories.

To open the application, run the executable file located in the bin directory. Depending on
the OS the executable file can be:
manager.cmd – for Windows OS
manager – for Linux OS

When running the application, the available RAM is checked automatically. If the maximum
permitted memory volume is smaller than the recommended one, a message is displayed to

RWU - AG.ENG.06.12.2023. 25
2023 Compass Plus
 Installing and Starting RadixWare Manager

the user prompting to adjust the memory required to start the application. For details,
refer to Memory Allocated for RadixWare Manager.

Running the executable file opens the main dialog box of the RadixWare Manager
application:

For details on how to run the console version of the application, refer to Working with
RadixWare Manager Console Application.

26 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Updating RadixWare Manager

8 Updating RadixWare Manager

The RadixWare Manager update package is delivered as a zip archive (manager.zip)

together with the software product update package. The RadixWare Manager update
package can contain:
Production version of the RadixWare Manager - new version including customized
enhancements, planned modifications as part of the software product development, and
bug fixes. The first four groups of digits in the version number are changed.
Urgent version of the RadixWare Manager - version containing urgent bug fixes. Only
the last group of digits is changed in the version number.
The new version of the RadixWare Manager is, by default, included in the update
package that is intended to install the new version of the software product (version in
which the first three groups of digits are changed). The patches for the software product
(version in which the fourth group of digits is changed) include the RadixWare Manager
versions with the Urgent status.

The system searches for updates:

automatically when starting up the RadixWare Manager application. At that, the
system searches for updates in the repositories of projects being opened.
on selecting the Help | Check Update menu item.
when loading the software product update package containing the new version of
RadixWare Manager in the zip archive.
If the zip archive with new version is found, the system displays the dialog box suggesting
the user to update the application. The dialog box displays the current and new
application versions and the name of project whose repository contains the update
packages:

RWU - AG.ENG.06.12.2023. 27
2023 Compass Plus
 Updating RadixWare Manager

If the user refuses to update the application, the system displays the dialog box
prompting to remind of the available updated version when starting the RadixWare
Manager next time:

If the user does not want to be reminded, this dialog box will not be displayed when the
RadixWare Manager is started next time unless the system finds a newer version.
To run the update manually, select Help | Update from Zip File on the menu and in the
opened dialog box, specify the path to the zip-file with new version. Once the file is
selected, the system prompts to confirm the update installation.
After the update procedure is completed, the application is automatically restarted.

28 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Creating Project

9 Working in GUI Application of RadixWare

Manager

9.1 Creating Project

Working with the RadixWare Manager implies working with projects. A project is a
logical representation of the repository physical structure that allows operating on its
objects by using different procedures (see below). It is possible to use the same
repository for different projects created on different workstations.
When creating a project, RadixWare Manager checks whether the required structure is
present in the specified repository. If not, the application initializes the repository.
RadixWare Manager provides tools for creating and maintaining several projects using
different repositories.
To create a new project, select File | New Project on the menu. The New Project
dialog box will open:

A project is created in four steps. These steps are available in the left part of the New
Project dialog box (the current step is marked bold). The right part contains the fields for
defining the project parameters.

RWU - AG.ENG.06.12.2023. 29
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Creating Project

Define the following parameters to create a new project:

1.At the General step:
Name. The project name.
SVN home URL. The path to the SVN repository specified when configuring the
Subversion server (for example, SVN://1.2.3.4).
SVN authentification. The user authentication method when accessing the
repository.
SVN user name. The name of the SVN repository user specified when configuring
the Subversion server.

To verify whether the repository is available and the user specified in the SVN user
name parameter has the rights to read from the repository, use the Check button.
If the SVN Password authentication type is used, the user will be prompted to
enter the password.

Project location. The path to the directory where the project will be created.
It is not recommended to create a new project in the repository containing the
directories or files that do not correspond to the required structure. In this case, the
application displays a warning and prompts the user to confirm the repository
initiation in the specified directory.
2.At the Repository step, add the customer layer URI to the System products in use
list (URI of the top-most layer included in the software product distribution kit).

It is recommended to check with the vendor the URI of the top-most layer in the
software product being installed.

If the repository structure is defined, the parameters are not available for editing at
the Repository step.

3.At the Directories and Key Store steps, it is recommended to keep the default
settings unchanged.
For details on the project and repository parameters, refer to Editing Project
Parameters and Editing Repository Parameters.

To switch between the steps, use the Next and Back buttons. To finish the project
creation, click the Finish button; to cancel the project creation, click the Cancel button.

30 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Creating Project

The main dialog box of the RadixWare Manager after the project is created:

Project Directory
The project creation result will be a directory with the following structure:
- distrib subdirectory. The subdirectory contains the software file packages
created by the vendor for distribution to customers.

- distrib.log subdirectory. The subdirectory contains the log files created

during the installation/update procedures performed on the customer side
for subsequent processing by the vendor.

- log.common subdirectory. The subdirectory contains the log files of all

operations performed in RadixWare Manager (updating DB, checking
user-defined functions, etc.). The files are created and saved in the
RadixWare Manager application automatically. These files are sent by
customer to the vendor for control of different processes.

- log.prod and log.test subdirectories. The subdirectories contain the log

files created during the test and production DB installation/update on the
customer side. The files are created and saved by RadixWare Manager
automatically and are used for the control purposes.

- upgrades subdirectory. The subdirectory contains the software file

packages received from the vendor.

- upgrades.backup subdirectory. The subdirectory contains the installed

software file packages. The files are automatically moved from the
upgrades directory to this subdirectory during the installation/update
procedure.

- proj ect.x ml file. The file contains the project settings.

A project created on one computer can be then copied to other computers.

RWU - AG.ENG.06.12.2023. 31
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Creating Project

When working with the RadixWare Manager, the project can be opened:
automatically when running the application (the projects used during the previous
session are restored). By default, all projects from the previous session are opened and
the positions of the elements opened in the tree are restored. To disable automatic
opening of the projects from the previous session, use the flag
netbeans.keep.expansion=false available in the manager.conf file. For details, refer to
RadixWare Manager Configuration File.
by selecting File | Open Project on the menu.

9.2 RadixWare Manager User Interface

The user interface of the RadixWare Manager is based on the interface of the
NetBeans platform. For the detailed description of the interface and its settings, refer to
the NetBeans documentation. This section contains the description of the main
components.
Generally, the main window of the RadixWare Manager is as follows:

The header of the main window contains:

Application name and current version
Information on the memory allocated for / used by the application:
o PID – ID of the application java process
o Max Memory – maximum memory
o Total Memory – memory allocated from the system
o Free Memory – unused memory (from the allocated memory)
o Use Memory – memory in use (from the allocated memory)
The main menu and quick search box are located under the header.
RadixWare Manager consists of the working area and embedded dialog boxes. The
embedded dialog boxes are opened by using the main menu or automatically during certain
operations.

32 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Working with the RadixWare Manager implies the use of:

application main menu
context menu of a particular dialog box (see below)
context menu of a project tree element selected in the Project dialog box (refer to
Project Commands)

Main Menu
The following table describes the main menu items of the application:

Menu Item Sub-item Icon Function

File New Project... - Creates a new project

Open Project... Opens a project (Ctrl+Shift+O).

Calls the dialog box for selecting the directory.

The project directory is marked with .

Open Recent - Opens the recently used project. The submenu

Project contains the list of such projects.

Close Project - Closes the current project

Close Other - Closes all projects except for the current one
Projects

Close All Projects - Closes all projects

Open File... - Opens the file in the text editor of the application

Open Recent File - Opens the recently used file in the application text
editor. The submenu contains the list of such files.

Project Properties - Opens the current project editor (refer to Editing

Project Parameters)

Save - Saves the modified project item to the SVN

repository (Ctrl+S)

Save All Saves all modified project items (Ctrl+Shift+S)

Exit - Closes RadixWare Manager

Tools Options - Opens the general application settings. For details,

refer to the NetBeans application documentation.
The Miscellaneous item of the Options dialog
box contains the following specific settings:
The General tab contains the Oracle JDBC
Driver File and PostgreSQL JDBC Driver
File parameters enabling to specify the path to
the JDBC drivers used by the RadixWare
Manager when working with the Oracle and
PostgreSQL DBs respectively. When editing the
parameters, the JDBC driver file is checked for
correctness: if the incorrect jar file is selected,
a respective warning is displayed to the user. If
the driver file is absent in the specified
directory, the value of the respective parameter
is highlighted in red.
The Mail tab is used to set up access to mail
server.

RWU - AG.ENG.06.12.2023. 33
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Menu Item Sub-item Icon Function

Window Projects Opens the Projects dialog box in the working

area (Ctrl+1)

Files Opens the Files dialog box in the working area

(Ctrl+2)

Favorites Opens the Favorites dialog box in the working

area (Ctrl+3)

Output Opens the Output dialog box in the working area

(Ctrl+4). The submenu contains a list of active
tabs of the Output dialog box.

Configure Windows - Configures the application main dialog box

appearance. The submenu contains the following
items:
Maximize. Maximizes the current dialog box to
the size of the application main dialog box
(Shift+Escape)
Float. Undocks the current dialog box from the
application main dialog box
Float Group. Undocks the group of opened
dialog boxes from the application main dialog
box
Minimize. Minimizes the current dialog box to
the left-side taskbar
Minimize Group. Minimizes the group of dialog
boxes to the left-side taskbar
Dock. Docks the current dialog boxes to the
application main dialog box (Alt+Shift+D)
Dock Group. Docks the group of dialog boxes
to the application main dialog box

Reset Windows - Restores the opened dialog boxes to their initial

positions

Close Window - Closes the current dialog box - Ctrl+W

Close All - Closes all opened files (Ctrl+Shift+W)

Documents

Close Other - Closes all opened files except for the current one
Documents

Documents... - Opens the Documents dialog box containing the

list of open files (Shift+F4)
Available actions:
Switch to Document. Select to switch to the
selected file.
Close Document(s). Select to close the
selected file.
Save Document(s). Select to save the
selected file.
Close. Select to close the Documents dialog
box.

Help Update from Zip - Updates the application from the zip file (for
File details, refer to Updating RadixWare Manager)

34 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Menu Item Sub-item Icon Function

Check update - Checks for updates of RadixWare Manager (for

details, refer to Updating RadixWare Manager)

About - Displays the application data:

Product Version. RadixWare Manager
version.
Java. Java version.
System. OS version.
Userdir. Directory with the RadixWare
Manager settings.

Working Area
The application working area allows viewing/editing the contents of the project files and
editors. The files are opened in the working area in the text editor. The project editors
are opened in the specialized editor.
The editors are opened in the working area in separate dialog boxes displayed as tabs.
Each tab has a header. The header has a context menu with the commands similar to
those of the Window main menu item.
The following table describes the buttons used to operate on the file dialog boxes in the
application working area:

Button Function

Shows the list of opened files. To switch to the required file, select it from the list.

Maximizes the working area with the opened file dialog boxes to the size of the
application main dialog box. The embedded application dialog boxes are minimized
to the left side taskbar.

Restores the working area initial position

Switches between the opened file dialog boxes

Closes the dialog box

The following context menu commands can be used to work with the text editor:

Menu Item Function

Cut Cuts the highlighted text fragment and places it to the clipboard (Ctrl+X)

Copy Copies the highlighted text fragment to the clipboard (Ctrl+C)

Paste Pastes the text from the clipboard (Ctrl+V)

RWU - AG.ENG.06.12.2023. 35
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

The following toolbar buttons can be used to work with the text editor:

Button Command Function

Find Selection Finds the text selection (Ctrl+F3)

Find Previous Finds the target text combinations above the current
Occurrence string (Shift+F3)

Find Next Occurrence Finds the target text combinations below the current
string (F3)

Toggle Highlight Finds all the target text combinations in the text (Alt
Search +Shift+H)

Shift Line Left Shifts the text selection one position to the left (Alt
+Shift+Left)

Shift Line Right Shifts the text selection one position to the right (Alt
+Shift+Right)

Comment Comments the text selection (the button is available in

the script editor only)

Uncomment Uncomments the text selection (the button is available

in the script editor only)

Quick Search Window

The quick search dialog box is a text field in the right upper corner of the application main
dialog box. The quick search is performed over the whole environment: in the menu items
and actions.
Entering the search string displays the opening list of coinciding elements.
The dialog box contains the drop-down list used to select the category of the items for
searching:
Action. The search in the application actions. When selecting the action, the action will
be called.
Option. The search in the menu items. When selecting the item, the item will be called.
All categories. The search by all categories.
To quickly move to the dialog box , press Ctrl+I.
To select the category, press Shift+F10.

Embedded Window
RadixWare Manager contains the following embedded dialog boxes:
Projects. The dialog box displays the project directories in the form of a navigation
tree. The tree has a hierarchical structure. RadixWare Manager allows creating and
maintaining several projects.
Output. The dialog box displays the operation-related information: execution process
and result, errors, start/end time, etc. For each operation, the information is displayed
on a separate tab in the Output dialog box, the operation name is displayed in the tab
header.
Files. The dialog box displays the physical structure of the project directories and files
in the form of a navigation tree.

36 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Favorites. The dialog box displays the tree of the favorite project files and directories
in the form of a navigation tree.

The embedded dialog box header has a context menu with the commands similar to those
of the Window main menu item.
To change the dialog box location, drag its header. To resize the dialog box (change its
width/height), point to the dialog box border, and when the pointer changes into a
double-headed arrow, drag the border in the required direction.
The following table describes the buttons used to operate on the embedded dialog boxes:

Button Function

Minimizes the dialog box to a taskbar (bottom/left/right). When the cursor points to
the icon in the taskbar, the dialog box opens.

Restores the minimized dialog box

Closes the dialog box

Double-clicking the dialog box header maximizes the dialog box to the size of the
application main dialog box.

Projects Window
The Projects dialog box has a context menu. The menu items are described in the
following table:

Menu Item Function

New Projects... Creates a new project

Open Project Opens a project (Ctrl+Shift+O) and calls the dialog box used to select the
project directory (Ctrl+Shift+O). The project directory is marked with

Open Recent Project Opens the recently used project. The submenu contains the list of such
projects.

The navigation tree context menu items are described in the Project Commands
section.

Output Window
The Output dialog box has a context menu. The menu items are described in the
following table:

Menu Item Function

Copy Copies the text selection to clipboard (Ctrl+C)

Paste Pastes the text from clipboard (Ctrl+V)

Find... Searches for text (Ctrl+F)

RWU - AG.ENG.06.12.2023. 37
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Menu Item Function

Find Next Continues search (F3)

Find Previous Returns to previous found text (Shift+F3)

Filter Opens filter (Ctrl+G)

Wrap Text If set, enables the text wrapping in the Output dialog box (Ctrl+R)

Larger Font Enlarges the text font (Ctrl+Equals)

Smaller Font Reduces the text font (Ctrl+Minus)

Save As... Saves the dialog box contents to a file (Ctrl+S)

Clear Clears the dialog box contents (Ctrl+L)

Close Closes the dialog box (Ctrl+F4)

For working with the tabs of the Output dialog box, the context menu in its header is
used. The menu items are described in the following table:

Menu Item Function

Close Tab Closes the current tab

Close All Tabs Closes all tabs

Close Other Tabs Closes all tabs except the current one

Files Window
When selecting the directory, the Files dialog box has a context menu. The menu items
are described in the following table:

Menu Item Function

New - Other Creates the new project file in the selected folder

Cut Cuts the selected object and places it in the clipboard (Ctrl+X)

Copy Copies the selected object to the clipboard (Ctrl+C)

Paste Pastes the object from the clipboard (Ctrl+V)

Delete Deletes the selected object

Rename Renames the selected object

Tools - Add to Adds a new directory to the list of favorite values

Favorites

Properties Displays the Application Data - Properties dialog box with the following
parameters:
Name - object name
Sort mode - sorting mode

38 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

When selecting the file, the Files dialog box has a context menu. The menu items are
described in the following table:

Menu Item Function

Open Opens the file

Cut Cuts the selected object and places it in the clipboard (Ctrl+X)

Copy Copies the selected object to the clipboard (Ctrl+C)

Paste Pastes the object from the clipboard (Ctrl+V)

Delete Deletes the selected object

Rename Renames the selected object

Tools - Add to Adds a new directory to the list of favorite values

Favorites

Save as Saves the file as the template to the selected path

Template

Properties Displays the Application Data - Properties dialog box with the following
parameters:
Name - object name
Sort mode - sorting mode

Favorites Window
The Favorites dialog box contains the Add to Favorites context menu. The command
allows to add new directories and files to the list of favorites.
The context commands for the directory selected in the navigation tree are described in
the following table:

Menu Item Function

New The submenu contains the following items:

Empty File - creates the new file
Folder - creates the new directory

Cut Cuts the selected object and places it in the clipboard (Ctrl+X)

Copy Copies the selected object to the clipboard (Ctrl+C)

Paste Pastes the object from the clipboard (Ctrl+V)

Delete Deletes the selected object

Rename Renames the selected object

Tools - Add to Adds the new directory to the list of favorite values
Favorites

Properties Displays the Application Data - Properties dialog box with the following
parameters:
Name - object name
Sort mode - sorting mode

Add to Favorites Adds a new directory to the list of favorite values

RWU - AG.ENG.06.12.2023. 39
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

The context commands for the file selected in the navigation tree are described in the
following table:

Menu Item Function

Open Opens the file

Cut Cuts the selected object and places it in the clipboard (Ctrl+X)

Copy Copies the selected object to the clipboard (Ctrl+C)

Paste Pastes the object from the clipboard (Ctrl+V)

Delete Deletes the selected object

Rename Renames the selected object

Tools - Add to Adds a new file to the list of favorite values

Favorites

Properties Displays the Application Data - Properties dialog box with the following
parameters:
Name - object name
Sort mode - sorting mode

Add to Favorites Adds a new file to the list of favorite values

9.2.1 Project Structure

A project has a tree-like structure composed of the following elements: branches,

directories, files. To expand/collapse a tree branch or directory, click or on the
left of the branch / directory name (the button appearance depends on OS).
To work with the project navigation tree elements, use the context menu commands (see
below).
Pointing to a tree element displays a tooltip with the repository-related information: SVN
URL, last modification revision number, repository user name, date and time of the last
modification, size (for files only).
The project tree contains the following branches:

Tree Branch Icon Description

<Proj ect Title> Main project branch

Config Settings branch. The branch contains the repository general

settings.

Distribution Kits Distribution kits branch. The branch contains the software
product distribution kits received from the vendor.

Scripts Scripts branch. The branch contains the scripts for:

initial installation of all software product layers
switching between the versions for all software product layers

Development Development branch. The branch contains the software

product files distributed among development subbranches. The
branch is used by the vendor. For details, refer to document [7].

40 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Tree Branch Icon Description

Releases Releases branch. The branch contains the software product

releases. The branch is used by the vendor. For details, refer to
document [7].

Customers Customers branch. The branch contains subdirectories with the

software product distribution kits for customers (separately for
each customer). For details, refer to document [7].

Environments Environments branch. The branch contains subdirectories with

the software product environments set up in the project. An
environment can belong to one or several landscapes and can be
used for the software product development, testing or operation.

Landscapes Landscapes branch. The branch contains subdirectories with

the software product landscapes.

Branches Software product files branch. The branch contains the

following child branches:

Test (marked with the icon ). The branches contain the

test files of the software product and are used to test the
software product.

Production (marked with the icon ). The branches

contain the working files of the software product and are used
for the software product operation.
It is possible to define one or several test branches (for
example, to test different software product versions) and one or
several production branches. The total number of test /
production branches is unlimited within the project.

Archive Archive branch. The branch contains the distribution kits with
the outdated versions received from the vendor. The branch is
unavailable in the project tree if the distribution kits have never
yet been moved to archive.
If the customer has own developments, the branch can contain
the customer descriptions, software product releases, distribution
kits, scripts of the outdated versions. For details, refer to
document [7].

If the customer is not involved in in-house development, the Customers,

Development and Releases branches are absent in the project tree.

The description of each project branch and the list of available specific commands for
each navigation tree item are provided below. For description of common and specific
commands, refer to Project Commands.

The tables with the description of directories, files and specific commands of branch
context menu contain only the specific commands displayed if the customer does not
have own development.
For the description of available commands, if the project is set up for own
development, refer to document [7].

RWU - AG.ENG.06.12.2023. 41
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Main Project Branch

Root directory of the repository.
The following table describes the context menu commands of the main project branch:

Name Description Specific Commands of Context

Menu

<Proj ect Title*> *<Proj ect Title> - project name Configure

Initialize Replica
Validate
Close
Reopen

Configuration Branch
The branch has the following structure:
Config/
Databases
Notification
Replication
Repository
Example of the Config branch
structure

The following table describes the files and context menu commands of the Config branch:

Name Description Specific Commands of Context

Menu

Databases Editor of the database access Configure

parameters

Notification Editor of the notification service Configure

parameters

Replication Editor of the replication parameters Configure

Repository Editor of the repository parameters Configure

42 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Distribution Kits Branch

The branch has the following structure:

Distribution Kits/
<Product>/
<Distribution Kit>/
Release/
<Layer>/
Properties
Scripts/
<Layer>/
Properties

Example of directories structure in the

Distribution Kits branch

The following table describes the directories, files and context menu commands of the
Distribution Kits branch:

Name Description Specific Commands of Context

Menu

Distribution Kits Branch containing the software product Load Updates

distribution kits the customer receives
Create Product
from the vendor. The distribution kits
are grouped by software product.

<Product*> Directory containing the software Add URI to 'System Products in

product distribution kits. The distribution Use'
kits are sorted by package number in
Remove URI from 'System
descending order.
Products in Use'
<Product*> - software product name
Delete
(URI of the top-most layer of the
software product is specified in
brackets)

<Distribution Directory containing the distribution kit. Configure

Kit*>
*<Distribution Kit> - software product Build | Testing Branch
distribution kit number in the format <N '<BranchName>'
- D>, where
Build | Production Branch
N - sequence number of the package '<BranchName>'
D - number of the distribution kit Send to Archive
consisting of the release number (f.f.f.f)
Database | Generate User
and distribution kit version (V)
Creation Script
(optionally)
Database | Generate Product
Installation Script
Database | Check Database
Database | Configure Database
Warnings

RWU - AG.ENG.06.12.2023. 43
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Name Description Specific Commands of Context

Menu

SVN | Export Starter

SVN | Export Web-App
Check User-Defined Functions
Analyze System Changes
Layers Information
Delete

Scripts Directory containing the database scripts The following commands are available
distributed between the software product for the software product layer branches:
layers (<Layer>*).
Create Downgrade Scripts
*<Layer> - name of software product
Save Scripts to File
layer

For the scripts in this context, the Show

Native Script command is available.

Release Directory containing the software Configure

product files distributed between the
Database | Install to Database
software product layers (<Layer>).
Database | Update in Database
For details on the software product layer
structure, see below. Database | Generate User
Creation Script
Database | Generate Product
Installation Script
Database | Check Database
Database | Configure Database
Warnings
Retrieve List of Modules
Export XSD Schemas
Export HTML Documentation
Check User-Defined Functions
Analyze System Changes
Layers Information

Properties Depending on the location, contains one Configure

of the following editors:
In the directory of <Distribution
Kit*> - editor of distribution kit
parameters
In the Release directory - editor of
release parameters

44 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Scripts Branch
The branch has the following structure:
Scripts/
<Layer>/
<script type>/
<Ri - Rj *>/
<script>.sql
script.x ml

Example of directories
structure in the Scripts branch

The following table describes the directories, files and context menu commands of the
Scripts branch:

Name Description Specific Commands of Context

Menu

Scripts Branch containing the database scripts. Search Scripts

The script packages are distributed
between the software product layers
(<Layer>).

<Layer*> Directory containing the scripts for a Absent

certain software product layer
(<Layer>).
*<Layer> - name of software product
layer

<script type> Script package type. Absent

The script packages for each layer are

grouped by the following types:
Upgrade Scripts - scripts for
upgrading the version of the software
product (the directory can also contain
the scripts for downgrading to the
earlier version).
Create Scripts - scripts for initial
installation of the software product.
Pre Scripts - scripts executed before
updating the software product.
Post Scripts - scripts executed after
updating the software product.

<Ri - Rj *> Script package. The scripts are sorted Create Downgrade Scripts
by package number in descending
order.
*< Ri - Rj > - script package for
changing the release from Ri to Rj ,
where
Ri - source release number; for initial
installation scripts, it is 0; for post-
scripts, it is x.

RWU - AG.ENG.06.12.2023. 45
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Name Description Specific Commands of Context

Menu

Rj - destination release number; for

pre-scripts, it is x.
The packages of downgrade scripts are
marked in italic in the project tree.
The empty packages of scripts are
highlighted in gray in the project tree.

<script*>.sql File containing the script or fix. Absent

*<script> - script number

scripts.x ml File with the scripts description Absent

(optional). It is used to register the
scripts and the states the lower layers
should have before running the script.

Environments Branch

The branch has the following structure:

Environments/
<Environment>/

Example of directories
structure in the Environments
branch

The following table describes the directories and context menu commands of the
Environments branch:

The commands marked with the character "*" are described in Operations on
Environments.

Name Description Specific Commands of Context

Menu

Environments Environments branch Configure

<Environment*> Environment sub-branch Application Core:

o *Build from Distribution Kit
*<Environment> - branch name
o *Build from Environment |
<EnvironmentName> (branch
'<BranchName>')
o Export XSD Schemas
o Export HTML Documentation
o Export Starter
o Export Web-App
o Check User-Defined Functions
o Check Database

46 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Name Description Specific Commands of Context

Menu

o Configure Database Warnings

o Analyze System Changes
o Generate User Creation Script
o Generate Product Installation
Script
*Configuration Package |
Transport From...
*Configuration Snapshot |
Transport From...

Landscapes Branch

The branch has the following structure:

Landscapes/
<Landscape>/
<Environment>

Example of directories
structure in the Landscapes
branch

The following table describes the directories and context menu commands of the
Landscapes branch:

The commands marked with the character "*" are described in Operations on
Environments.

Name Description Specific Commands of Context

Menu

Landscapes Landscapes branch Configure

<Landscape*> Landscape sub-branch. It contains the Absent

sub-branches of the environments used
in the landscape.
*<Landscape> - branch name

<Environment*> Landscape environment sub-branch Application Core:

o *Build from Distribution Kit
*<Environment> - environment name
o *Build from Environment |
<EnvironmentName> (branch
'<BranchName>')
o Export XSD Schemas
o Export HTML Documentation
o Export Starter

RWU - AG.ENG.06.12.2023. 47
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Name Description Specific Commands of Context

Menu

o Export Web-App
o Check User-Defined Functions
o Check Database
o Configure Database Warnings
o Analyze System Changes
o Generate User Creation Script
o Generate Product Installation
Script
*Configuration Package |
Transport From...
*Configuration Snapshot |
Transport From...

Software Product Files Branch

The branch may contain one or several test branches and

one or several production branches.

Example of directories
structure in the Branches
branch

The following table describes the context menu commands of the Branches branch:

Name Description Specific Commands of Context

Menu

Branches Branch with the software product files Create Branch

Test Branch
The branch has the following structure:

<Test>/
<Layer>/

Example of directories
structure in the Test branch

48 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

The following table describes the directories, files and context menu commands of the
Test branch:

Name Description Specific Commands of Context

Menu

<Test*> Software product release test branch Rename Branch

*<Test> - name of the test branch (it is Send to | Testing Branch
specified when creating a branch) '<BranchName>'
Send to | Production Branch
'<BranchName>'
Database | Install to Database
Database | Update in Database
Database | Generate User
Creation Script
Database | Generate Product
Installation Script
Database | Check Database
Database | Configure Database
Warnings
SVN | Export Starter
SVN | Export Web-App
Retrieve List of Modules
Export XSD Schemas
Export HTML Documentation
Check User-Defined Functions
Analyze System Changes
Layers Information
Delete

<Layer*> Directory containing the software Show License

product files distributed between the
software product layers (<Layer>).
*<Layer> - name of the software
product layer
For details on the software product layer
structure, see below.

Production Branch

The branch has the following structure:

<Production>/
<Layer>/

Example of directories
structure in the Production
branch

RWU - AG.ENG.06.12.2023. 49
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

The following table describes the directories, files and context menu commands of the
Production branch:

Name Description Specific Commands of Context

Menu

<Production*> Production branch Rename Branch

*<Production> - name of the Database | Install to Database
production branch (it is specified when
Database | Update in Database
creating a branch)
Database | Generate User
Creation Script
Database | Generate Product
Installation Script
Database | Check Database
Database | Configure Database
Warnings
SVN | Export Starter
SVN | Export Web-App
Retrieve List of Modules
Export XSD Schemas
Export HTML Documentation
Check User-Defined Functions
Analyze System Changes
Layers Information
Delete

<Layer*> Directory containing the software Show License

product files distributed between the
software product layers (<Layer>).
*<Layer> - name of the software
product layer
For details on the software product layer
structure, see below.

Archive Branch

The branch has the following structure:

Archive/
Distributions Kits/
<Distribution Kit>

Example of directories
structure in the Archive branch

50 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

The following table describes the directories, files and context menu commands of the
Archive branch:

Name Description Specific Commands of Context Menu

Archive Archive branch Absent

Distributions Kits List of distribution kits received from the Absent

vendor and moved to archive

<Distribution Distribution kit directory Configure

Kit*>
*<Distribution Kit> - identification Build | Testing Branch
number of the distribution kit in the '<BranchName>'
format <N - D>, where:
Build | Production Branch
N - sequence number of the package '<BranchName>'
D - number of the distribution kit
consisting of the release number Restore from Archive
(f.f.f.f) and distribution kit version (V) Database | Generate User
(optionally) Creation Script
Database | Generate Product
Installation Script
SVN | Export Starter
SVN | Export Web-App
Check User-Defined Functions
Analyze System Changes
Layers Information
Delete

Software Product Layer

The branch has the following structure:

<Layer>/
<Segment ADS>/
<Modules of Segment ADS>
<Segment DDS>/
<Modules of Segment DDS>
<etc>/
<Segment Kernel>/
<Modules of Segment Kernel>
<Segment UDS>/
<Modules of Segment UDS>
THIRDPARTYLICENSE.tx t
Example of directories directory-layer.x ml
structure in the software
product layer directory.x ml
layer.x ml
license.tx t
licenses.x ml
kernel-meta.zip
app-meta.zip

RWU - AG.ENG.06.12.2023. 51
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

The following table describes the directories, files and context menu commands of the
software product layer:

Name Description Specific Commands of Context Menu

<Layer> Name of the software product layer Show License

<Segment> Name of the software product layer Show License

segment. Each layer contains the
following segments:
Application Definition Segment
(ADS). The segment contains the
application model presented as a set
of definitions combined in modules.
Database Definition Segment
(DDS). The segment contains the
model of software product DB
structure.
Kernel. The segment contains the
system core classes implemented on
basis of Java SE without using
RadixWare Designer. The segment
is present not in all layers.
User Definitions Segment (UDS).
The segment contains the user
definitions to be supported on the
vendor side.

<Module>/<File> Modules and files included in the Show License

segment

etc Directory containing the additional files Absent

included in the software product
distribution kit.

THIRDPARTYLICE File with the license information on the Absent

NSE.tx t third-party software

directory- System file Absent

layer.x ml

directory.x ml System file Absent

layer.x ml System file containing the layer settings Absent

license.tx t File with the license information on the Absent

layer and its components

licenses.x ml System file containing the information Absent

on the layer license.

kernel-meta.zip Archives used to speed up the process Absent

and app-meta.zip of uploading utility files.

52 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

9.2.2 Project Commands

Common Commands of Project Tree

The following table describes the commands that are common for all directories:

Command Function

Refresh Updates the selected element contents

SVN | Export Exports the current SVN revision of the selected element. The required directory
is selected in the dialog box that opens.
The export command is interrupted in the procedure execution indicator area
located in the right bottom part of the application main dialog box:

by clicking (Close)
by the Cancel Progress command of the indication area context menu

SVN | Copy URL Copies SVN URL of the selected element to clipboard

SVN | SVN Log Displays the history of the tree element operations in the Output dialog box:
revision number
user name
date and time
log message

The following table describes the commands for the project files / directories:

Command Function

Edit Opens the file / editor in the working area.

Specific Commands of Project Tree

The following table describes the commands specific for the project elements. For the
capability to apply the command to the element, refer to project structure.

Command Function

Validate Checks the physical structure of the project repository and brings it in compliance with
the requirements.

Create Creates a test / production branch in the project repository. The command opens the
Branch dialog box in which it is necessary to specify:
Branch type (test or production) using the Test branch / Production branch switch
button.
Branch name. Depending on the type of the branch being created, the prefix test./prod
is assigned to the respective directory in the repository. This prefix is not output in the
branch name in the project navigation tree.

RWU - AG.ENG.06.12.2023. 53
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Command Function

Rename Renames the test / production branches. The command opens the dialog box in which
Branch the new branch name can be specified.

Close Closes the project

Reopen Reopens the current project

Initialize Initializes the replica

Replica

Load Loads the software product update package to the repository

Updates

Create Creates an empty software product directory in the distribution kits branch. The
Product command opens the dialog box with the Product URI parameter. The parameter is used
to specify the top-most layer URI for the software product supplied by the vendor.

Add URI to Automatically adds the software product URI to the list of System products in use.
'System
The command is not available in the context menu of the software product directory, if
Products in
URI is present in the list of System products in use.
Use'

Remove Automatically removes the software product URI from the list of System products in
URI from use.
'System
The command is not available in the context menu of the software product directory, if
Products in
URI is missing in the list of System products in use.
Use'

Build | Starts the procedure for submitting the distribution kit to test, where <BranchName> is
Testing the name of the test branch the distribution kit will be moved to. To create a test branch,
Branch use the Create Branch command in the context menu of the Branches branch of the
'<BranchNa project tree.
me>'
The command is not available if:
URI of the software product whose distribution kit is submitted for testing / production
is missing in the System Products in Use list. The software product URI can be
added to the list:
o manually in the editor of the repository parameters

54 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Command Function

o automatically using the Add URI to 'System Products in Use' command

available in the context menu of the software product branch.
The test / production branches are missing in the project.
In the above-listed cases, the name of the Build command is changed to Build (Click
for More Information). At the attempt to execute this command a message describing
the reason for unavailability and brief project setup instructions are displayed.

Build | Starts the procedure for submitting the distribution kit to production, where
Production <BranchName> is the name of the production branch the distribution kit will be moved
Branch to. To create a production branch, use the Create Branch command in the context
'<BranchNa menu of the Branches branch of the project tree.
me>'
The command is not available if:
URI of the software product whose distribution kit is submitted for testing / production
is missing in the System Products in Use list. The software product URI can be
added to the list:
o manually in the editor of the repository parameters
o automatically using the Add URI to 'System Products in Use' command
available in the context menu of the software product branch.
The test / production branches are missing in the project.
In the above-listed cases, the name of the Build command is changed to Build (Click
for More Information). At the attempt to execute this command a message describing
the reason for unavailability and brief project setup instructions are displayed.

Send to | Starts the procedure for moving the distribution kit loaded to the current test branch to
Testing another test branch.
Branch
'<BranchNa
me>'

Send to | Starts the procedure for moving the distribution kit loaded to the current test branch to
Production the production branch.
Branch
'<BranchNa
me>'

Delete Deletes the software product/distribution kit

It is not recommended to delete the distribution kit without the agreement with the
software product vendor. When deleting the distribution kit self-dependently, the
installation of the following software product update packages can be impossible.

Database | Starts the installation of the software product to DB

Install to
Database

Database | Starts the database update procedure

Update in
Database

SVN | Exports the starter.j ar file. The command opens the dialog box for selecting the directory
Export to save the file to the local disk.
Starter
The starter.j ar file is used to start the RadixWare applications. For details, refer to
document [5].

SVN | Exports the Web-App.war file. The command opens the dialog box for selecting the
Export directory to save the file to the local disk.
Web-App
The Web-App.war file is used to start the RadixWare web applications. For details,
refer to document [6].

RWU - AG.ENG.06.12.2023. 55
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Command Function

Configure Opens the editor in the working area. The command is available for the editors and
project tree elements (for example, branches, directories) that have own editors.
The service project files contain the parameters of the repository, project, software
product, etc. In RadixWare Manager the service files can be viewed / edited by means
of the special editors (for the editors location, refer to Project Structure):
Project Parameters Editor. Edits the proj ect.xml file located on the local disk in the
project directory.
Database Access Parameters Editor. Edits the databases.xml file; the file is
located in the config repository directory.
Notification Service Parameters Editor. Edits the notification.xml file; the file is
located in the config repository directory.
Repository Parameters Editor. Edits the repository.xml file; the file is located in
the config repository directory.
Replication Parameters Editor. Edits the replication.xml file; the file is located in
the config repository directory.
Release Parameters Editor. Edits the release.xml file; the file is located in the
repository directories containing the software product files, for example, the test, prod
repository directories.
Distribution Kit Parameters Editor. Edits the upgrade.xml file; the file is located in
the directory of the particular distribution kit located in the distributives repository
directory.
Environments Editor. Edits the environments.xml file; the file is located in the config
directory of the repository.
Landscapes Editor. Edits the landscapes.xml file; the file is located in the config
directory of the repository.
The editor can also be opened by double-clicking on the selected editor.

Create Generates the scripts changing the DB structure in order to downgrade to the previous
Downgrade software version.
Scripts
To downgrade to the previous version, the created scripts must be finalized by the
administrator.
The command is available in the context menu of scripts package if the package is not
empty and does not contain the downgrade script.

Save Unloads the scripts updating the DB structure to file. The command opens the dialog box
Scripts to with the following parameters:
File
Source Release. The software source release.
Target Release. The software release to update to.
Clicking the OK button opens the dialog box to select the file to save the scripts to. The
OK button is available if the Target Release parameter value is more than the Source
Release parameter value.

Search Searches for the script according to the specified conditions. The search dialog box
Scripts contains:
Filter by parameter enabling to specify the script attributes to search by. Available
values:
o Script content (default value) - search by script content
o Script name - search by script name. The search result includes the scripts whose
names match the specified value both partially and in full.
o Script generated by - search by name of the user who generated the script. The
search result includes the scripts for which the user name matches the specified
value both partially and in full.
Contains text parameter to enter the text to search for

56 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Command Function

Case Sensitive flag determines whether the search for the scripts (by phrase
specified in the Contains text field) is case-sensitive or not. If the flag is set, the
search is case-sensitive; if the flag is not set, the search is not case-sensitive. The flag
is not set, by default.
Search in archive flag. If the flag is set, the scripts moved to archive are used for
the search. The flag is not available if the project does not contain the Archive branch
(no distribution kits / scripts moved to archive). The flag is set, by default.
Search for create scripts flag. If the flag is set, the scripts used for the initial
software product installation are used for the search. The flag is not set, by default.

The search results are provided in the Output dialog box.

Show Shows the native script that will be executed in the DB with the parameters defined in
Native the dialog box for command execution (the following parameters are defined: DB type –
Script Oracle or PostgreSQL, DB version and additional DB parameters). The dialog box for
command execution contains the following elements:

RWU - AG.ENG.06.12.2023. 57
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Command Function

Parameters to specify the characteristics and values of the additional parameters for
the DB for which a script needs to be generated using the command. For details on the
DB parameters, refer to Installing Software Product to DB.
Show comments after preprocessing. If the flag is set, unused fragments of the
SQL code will be displayed commented after executing the command. If it is unset,
such fragments will be deleted (for example, for the Oracle DB selected in the
command settings, the source code for PostgreSQL will be displayed as comments
when the flag is set, or it will be cleared when the flag is unset). The flag is not set, by
default.
Leave macros. If the flag is set, macros will not be translated to the native SQL code
when executing the command. The flag is not set, by default.

The command is available only for scripts available in the software product distribution
kit (project branch Distribution Kits / <Product> / <Distribution Kit> / Scripts/ /
<Layer>/ <Script>).
The need to view native scripts relates to the capability of RadixWare to implement
scripts using macros (for compatibility with different DB types). Macros are translated to
the native script of Oracle or PostgreSQL using the RadixWare Manager tools directly
before execution. This command enables to retrieve the translation results beforehand.

Retrieve Exports the list of modules included in the software product layers to a TXT file.
List of Executing the command opens the dialog box to select one or several layers (using Shft
Modules / Ctrl hot keys) for which the list of modules will be exported.

Export XSD Exports XSD schemas of software product definitions. For details on how the command is
Schemas executed, refer to Export of XSD Schemas for Software Product Definition.

Export Generates the HTML description of the software product API. The HTML description is
HTML based on the radixdoc.zip files included in the software product modules.
Documenta
The command opens the dialog box containing the following elements:
tion
Export to switch button to define the API description export mode. The available
values are Directory and ZIP archive.
Output path parameter to specify the directory or ZIP archive (depending on the
export mode) to save the API description to on the local disk drive. The dialog box for

directory/archive selection is invoked using command.

Segments parameter to select the segment of the software product layers for which
the API description will be exported: ADS (the generated documentation will contain
the description of the software product API) and/or DDS (the generated documentation
will contain the description of the software product DB structure). The segment (one or
both) is selected by setting the flag next to the required segment in the Choose

Segment dialog box invoked using button. For the correct command
execution, at least one segment should be selected. The parameter is not defined, by
default.
Languages parameter to select the language of the document to be exported. The

58 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Command Function

language (one or several) is selected by setting the flag next to the required language

in the Choose Language dialog box invoked using button. The list
of languages includes the languages from all layers of the distribution kit or test/
production branch (depending on the context in which the command is called). For the
correct command execution, at least one language should be selected. The parameter
is not defined, by default.

Check Checks compatibility of user-defined functions in different versions of software product.

User- For details, refer to section Checking User-Defined Functions during Update
Defined Installation
Functions

Analyze Prepares and displays information on certain actions to be performed when updating the
System software product release version. For details, refer to Analyzing System Changes.
Changes

Database | Generates a user creation script for the database to be imported to the schema of this
Generate user. When executing the command, specify the path to a file the script will be saved to.
User The command is called if the database import is required. The script generated by this
Creation command needs to be run by any available means before the database import.
Script

Database | Generates a product installation script. When executing the command, specify:
Generate
path to a file the script will be saved to
Product
Installation values of the additional DB parameters that will be defined when installing the software
Script product to the DB (the parameters are displayed at the Database Parameters step
of the software product installation process)
The installation script may be required for the preliminary analysis (for example, if the
software product is planned to be installed to the DB under the user other than SYS, and
it is necessary to verify that this user has sufficient rights).

Show Shows the license information on the software product components. The license text is
License stored in the license.txt file. The layer license is used in the layer units by default.

Layers Shows information on the software release layers. The following information is displayed
Informa- in the dialog box:
tion
layer URI
release version
URI of base layers
list of languages supported in the layer

RWU - AG.ENG.06.12.2023. 59
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Command Function

The Copy to Clipboard command ( button) copies the layer information to

clipboard.

Database | Checks the compatibility between the DB structure and metainformation of the different
Check versions of the software product. The software product version to be compared with the
Database DB structure depends on the branch the command is executed from. The command is
available in the context menu of:
test branches
production branches
distribution kits received from vendors and loaded to the branch Distribution Kits |
<Product>
release and development branches (these branches are displayed only if the project is
used for development).

When executing the command, it is necessary to specify the DB whose structure needs
to be checked. The value is set in the dialog box containing the following parameters:
Database. The value is selected from the drop-down list of databases registered in
the project, and databases from the local list (if the local list is defined and enabled for
use).
Password of '<schema>' user. The password of the DB user. For test databases,
the password specified in the Saved password parameter in the editor of the DB
access parameters will be used automatically. If a certain DB has been already
connected during the current user session, the last used password will be automatically
used for the next connection.

When executing the command, the system searches for:

invalid database objects (from Oracle point of view); if any objects are found, the
system makes an attempt to recompile them.
differences between the selected branch and DB; the found mismatches are displayed
in the Output dialog box as messages with different severity level (information,
warning, error) and are saved to the log file of the operation execution (the file <date
and time of operation execution>-Check_Database.log is located in the subdirectory
specified in the Details Log Directory parameter of the project (by default, in the
log.common subdirectory)).
missing rights to the required Oracle entities for the DB user; if the respective rights
are absent, the result of the command execution (in the Output dialog box) will
contain the automatically generated script to be used to grant the missing rights.

60 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
RadixWare Manager User Interface

Command Function

If errors and warnings have been detected during the check, it is recommended to
submit the command execution result to the Product Support Service.

Database | Manages the list of messages (information messages / warnings / errors) that will not be
Configure output in the results of checking the compatibility between the DB and metainformation
Database of the software product being installed (this check is performed automatically when
Warnings installing the software product to the DB / updating the DB, or by executing the Check
Database command).
When executing the command, it is necessary to specify the DB whose structure needs
to be checked. The value is set in the dialog box containing the following parameters:
Database. The value is selected from the drop-down list of databases registered in
the project, and databases from the local list (if the local list is defined and enabled for
use).
Password of '<schema>' user. The password of the DB user. For test databases,
the password specified in the Saved password parameter in the editor of the DB
access parameters will be used automatically. If a certain DB has been already
connected during the current user session, the last used password will be automatically
used for the next connection.

The structure of the selected DB will be checked. Information messages, warnings and
errors detected during the check are output in the Warnings area of the Warnings
dialog box. Messages to be hidden during the subsequent DB checks should be moved to
the Ignores area using the Suppress button. To move messages from Ignores to
Warnings, the Unsuppress button is used.
It is prohibited to exclude some warnings from the check. Such warnings are highlighted
in grey in the Warnings area and they cannot be moved to the Ignores area.

The visibility settings will be applied only to the link Software product branch - DB (if the
software product is installed / updated in the branch in which the command is called, and
to install / update the DB, the DB is selected for which the list of hidden messages is
defined).

Send to Sends to archive the distribution kit received from the vendor.
Archive
Distribution kits with the outdated software product versions can be stored in archive.
The selected distribution kit as well as all older distribution kits are moved to the
Archive branch of the project.

Restore Restores from archive the distribution kit received from the vendor.
from
When restoring the distribution kit from archive, all subsequent distribution kits (newer
Archive
ones) available in the archive are restored as well.

RWU - AG.ENG.06.12.2023. 61
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

9.3 Setting Up Project and Repository

A project in RadixWare Manager has the following parameters:

Project parameters (stored locally on the administrator computer)
General repository parameters (stored in the config repository directory):
Database access parameters
Notification service parameters
Repository parameters
Replica parameters

9.3.1 Editing Project Parameters

The project parameters are defined at the project creation and stored in the project.xml
file on the local disk in the project root directory. The parameters can be viewed/edited in
a special editor that can be opened by:
double-clicking the main project branch
using the Configure command in the context menu of the main project branch
using the File | Project Properties menu item

The RadixWare Manager controls changes made to the project.xml file. The file is
reread on a periodic basis (every 10 seconds) and is compared against the corresponding
file used when starting the RadixWare Manager / opening the project. If changes made
by the third-party software are detected, a respective warning is displayed.
The project editor looks as follows:

The editor contains the following tabs:

General. The current project parameters:
Name. The project name.
SVN home URL (Uniform Resource Locator). The SVN repository coordinates. URL is
defined according to the SVN repository standard rules.
Check. The button is used to check whether the repository is available and the user

62 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

specified in the SVN user name parameter has the rights to read from the repository.
Depending on the authentication type (see below), the user password can be
requested when clicking the button. At that, the dialog box containing the following
parameters is displayed:
Repository. The repository URL. The parameter is not editable.
User. The SVN repository user name.
Password. The SVN repository password.

RadixWare Manager supports working with the repository via SVN, SVN+SSH,
HTTPS and TLS protocols.

SVN authentication. The user authentication method when accessing the repository
from RadixWare Manager. The following methods are available:
None. Without authentication.
SVN Password. Login/password authentication by the SVN protocol.
SSH Password. Login/password authentication by the SSH protocol.
SSH Key File. Public/private key authentication by the SSH protocol.
TLS. Authentication by certificate file or access password (optional) by the TLS
protocol.

It is recommended to use TLS protocol version 1.2.

It is insecure to use TLS protocol version 1.0 and 1.1.

SSH Agent. Authentication by the SSH protocol using the SSH agent. For the
correct operation of this authentication method, the SSH agent should be
installed on the workstation on which the RadixWare Manager is started. The
private key to be used for authentication on the SVN server should be loaded to
this agent. The SSH agents that are included in the list of agents supported by
the jsch-agent-proxy library can be used. In particular, the following utilities are
supported:
ssh-agent (included in the OpenSSH package)
pageant (included in the PuTTY package).
SVN user name. The name of the SVN repository user under which the connection
will be established. The parameter is view-only if the connection by TLS protocol is
used.
Reset password. The button is used to reset the current repository password. The
button is available if the user checked the repository accessibility (the Check button)
when defining the SVN home URL parameter. After the password is reset, the new
password can be entered by clicking the Check button.

SSH key file. The path to the private key file. Clicking button opens the dialog
box used to select the file. The parameter is used for the SSH Key File
authentication method.

RWU - AG.ENG.06.12.2023. 63
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

The following recommendations are applicable to RadixWare Manager

v.1.2.11.37.x and downwards (starting from v.1.2.11.38.x, use of PRIVATE KEY is
supported).
If the SVN authentication is performed via the SSH protocol using a pair of public/
private keys, it is recommended to specify in the SSH key file parameter the pem
file containing RSA PRIVATE KEY (if the PRIVATE KEY is used in the RadixWare
Manager, an authentication error will occur when opening the project).

Example of how to generate a pem file using the openssl utility:

To generate a pem file from the file of *.p12 format, execute the following
command:

openssl pkcs12 -in cert.p12 -out cert.pem -nodes -clcerts

If the version of the utility is 0.9.8 and downwards, a file containing RSA
PRIVATE KEY will be generated.
If the later version of the utility is used, a file containing PRIVATE KEY will be
generated. This file needs to be converted to a file with RSA PRIVATE KEY
using the following command:

openssl rsa -in cert.pem -out cert_new.pem

In the generated file, delete all the data except for the private key (using
any text editor).

Project location. The location of the project directory. Clicking button opens
the dialog box used to select the directory (all the project properties are saved to the
local machine in the local directory).
The current project parameters are similar to those defined at the General step of the
project creation procedure (refer to Creating Project). The parameters can be edited,
for example, in the following cases: change of the repository URL if the repository
location is changed, change of the authentication method, or change of the SVN
password. The project directory location is not editable.
Directories. The location of the project subdirectories:
Upgrades directory. The subdirectory from where the application takes the software
product file package for installation/update.
Upgrades backup directory. The subdirectory where the application automatically
saves the installed software product file package.
Upgrades test log directory. The subdirectory where the application automatically
saves the log files created when installing the software product to DB/updating the
test DB.
Upgrades prod log directory. The subdirectory where the application automatically
saves the log files created when installing the software product to DB/updating the
production DB.
Details log directory. The subdirectory where the application automatically saves
the log files of all operations performed in RadixWare Manager (updating DB,
checking the user-defined functions, etc.).
Distrib directory. The subdirectory where the application unloads the created

64 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

software product file packages for customers (the subdirectory is used by the
vendor).
Distrib log directory. The subdirectory where the application saves the log files
created when installing the software product to DB/updating DB on the customer side
(the subdirectory is used by the vendor).
The location of the subdirectories is determined by RadixWare Manager automatically
(according to the project directory location defined in the Project location parameter
at the General stage). It is possible to change the location of the subdirectories on the

local disk by means of button that opens a dialog box used to select the directory.
The path to the project subdirectories can be specified relatively to the project
directory location.
Key Store. The digital signature verification settings. The tab contains the following:
The parameters for setting up the certificate store:
Key store type. The value is selected from the drop-down list:
FILE - certificate is stored as a file on a local drive.
PKCS11 - certificate is stored on an electronic device.
Key store file. The parameter purpose depends on the store type:
If the store type is FILE, specify the path to the file with the certificate store. By
default, the system offers to create a certificate store in the keystore
subdirectory located in the project directory. The file format is *.jceks. The store

file location is changed by clicking button that opens a dialog box used to
select the file.
The RadixWare Manager controls changes made to the *.jceks file. The file is
reread on a periodic basis (every 10 seconds) and is compared against the
corresponding file used when starting the RadixWare Manager / opening the
project. If changes made by the third-party software are detected, a respective
warning is displayed.
If the store type is PKCS11, specify the location of the device configuration file by

clicking button that opens a dialog box used to select the file. The drivers for
the device must be previously installed. The file format is config.pkcs11
The parameters are similar to those defined at the Key Store step of the project
creation procedure (refer to Creating Project). If the certificate store was not defined
at the project creation, the certificate can be created and set up on this tab. It is also
possible to change the location of the already created store.
Key Store Administrator. The button is used to call the Key Store Administrator
utility for managing the key store and certificate store. By using the utility, the digital
certificate received from the vendor is loaded and checked. For details, refer to
document [8].
For the digital signature verification setup procedure, refer to Setting Up Digital
Signature Verification.

RWU - AG.ENG.06.12.2023. 65
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

9.3.1.1 Setting Up Digital Signature Verification

In compliance with PCI DSS requirements, the RadixWare Manager supports the digital
signature used to protect the software product files supplied by the vendor. The digital
signature is based on the digital certificates for the software file packages.
The digital signature enables to control the software file package integrity, protect it
against unauthorized modifications, and check whether the signature belongs to the
owner of the signature key certificate.
The RadixWare Manager enables to store digital certificates on an electronic device or
in a file on the local drive.
The digital signature verification is set up on the Key Store tab in the editor of the
project parameters. This setting is optional, but if the mechanism is not set up, the
updates installation is not secure, and in this case, the RadixWare Manager will display
a respective warning at the attempt to load the software file package.

The digital signature verification is set up once. It should be edited only in case the
RadixWare Manager is moved to another computer.

How to Set up Digital Signature Verification for Certificate Store

1.Set up the certificate store (if the store has not been set up when creating the
project). For this purpose, on the Key Store tab in the editor of the project
parameters, perform the following:
For the Key Store Type parameter, set the FILE value.
In the Key Store File parameter, specify the location of the file with the certificate

store. Clicking button opens the dialog box for file selection. The file format is
"*.jceks".
2.Receive the digital certificate from the vendor through a secure communication
channel.
3.Load the received digital certificate to the certificate store. To load and view the
certificates, use the Key Store Administrator utility which is called using the
respective button.
At the utility logon, the certificate store availability in the specified file is checked:
If the certificate store is available, the Login to Key Store dialog box opens to enter
the access password.
If the store is missing, the RadixWare Manager prompts to create a store. After the
creation operation is confirmed, the Create Key Store dialog box opens to set the
store password.

If the Key Store File parameter is not defined, the RadixWare Manager will display
a respective warning when calling the utility.

66 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

To load the digital certificate, use the Load Trusted Certificate command. The
command parameters are:
Alias. The name under which the certificate will be saved to the store.

Certificate File. Clicking button opens a dialog box used to specify the path to
the file with the certificate received from the vendor. The file format is "*.cer" or
"*.pem".
For details on the utility, refer to document [8].

How to Set up Digital Signature Verification for Storing Certificate on

Electronic Device
1.Install the drivers for the electronic device.
2.Set up the certificate store (if the store has not been set up when creating the
project). For this purpose, perform the following on the Key Store tab in the editor of
the project parameters:
For the Key Store Type parameter, set the PKSC11 value.
In the Key Store File parameter, specify the location of the device configuration file.
The file format is "config.pkcs11".
3.Check the availability of the certificate on the device using the Key Store
Administrator utility (Key Store Administrator button). At the utility logon, it is
required to enter the device password in the Login to Key Store dialog box.

Using Certificate
The digital signature for the software product zip files is verified automatically when the
file package is loaded to the repository (see below). The RadixWare Manager starts
loading the files only if the signature is valid. If the signature is not valid, the RadixWare
Manager stops loading the package and displays the respective warning.

When loading several update packages, the signature is validated only once (Key
Store password is requested only once).

The file package loading is not secure if:

the digital signature is absent
the certificate is not in the list of trusted certificates
the certificate cannot be validated (the certificate store is not set up, no access to the
store, etc.)
If at least one of these conditions is present, the RadixWare Manager will ask to
confirm the operation.

If the certificate used to sign the update package file / license file is trusted, the
certificate expiration date will be additionally checked when loading the update package.
If the certificate is expired, an error message will be displayed, and the RadixWare
Manager will prohibit loading the update package. If the certificate expires in 30 days or
before, a warning will be displayed prompting to abort or continue the operation.

If certificate read errors occur when installing updates on the production system, it is
necessary to stop the update procedure.

RWU - AG.ENG.06.12.2023. 67
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

9.3.2 Setting Up Database Access Parameters

The DB access parameters are defined in the Databases editor available in the Config
branch. The editor can be opened by:
double-clicking on the project branch Config | Databases.
using the Configure command in the context menu of the Databases editor.

When opening the editor, the following dialog box is displayed in the application working
area:

The editor includes the following elements:

Databases. The area contains the list of databases.
To manage the list, use the Add, Remove, Duplicate, Up and Down buttons. To edit
the parameters of the selected DB, go to the Database Attributes area.
Database Attributes. The tab is used to define the parameters of the DB selected in
the Databases list:
o Name. The database name.
o URL. The database location. The parameter can be defined either manually or in a

special dialog box called using button. This dialog box contains the Connection
type parameter enabling to define the DB URL generation method.

68 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

Available values:
Advanced. The DB URL is defined in the JDBC URL parameter in the form of a
string complying with the JDBC standards: jdbc:oracle:thin:@host:port/SID,
where
jdbc:oracle:thin:@ - constant
host – IP address or DNS name of the DB server
port – port number
SID – DB ID (by default, it is similar to the database name)
For DB of the PostgreSql type, the value of the the JDBC URL parameter is
generated as a string of the following format: jdbc:postgresql://
<host>:<port>/<SID>.
Basic. The string with the DB URL is generated automatically in accordance with
the JDBC standards and is based on the values set in the following parameters:
Host name. The IP address or DNS name of the DB server.
Port. The port number.
SID or service name. The DB ID or service name.

o Schema. The user name on the DB server.

o Type. The type of the database being configured. Available values:
Oracle (default value)
PostgreSql. If this value is specified, the Deployment type and Native
compilation of PL/SQL parameters become unavailable and are not used.
o Deployment type. The database server type. Available values:
Standalone
Amazon Relational Database Service (AWS RDS)
Oracle Autonomous Database (ORACLE ADB)
o Test. The flag defines the database type:
if the flag is set - test database.
if the flag is not set - production database.

RWU - AG.ENG.06.12.2023. 69
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

If the production DB is specified for the software product being tested or test DB
is specified for the software product being put into operation, the RadixWare
Manager generates a respective warning.

o Native compilation of PL/SQL. If the flag is set, native compiled PL/SQL instead of
interpreted PL/SQL will be used when installing the software product to the DB /
updating the DB. The flag is not set, by default.
It is reasonable to use PL/SQL native compilation to optimize the system if PL/SQL
procedures affecting the system performance are detected during the operation of
the software product. However, take into account that it is not possible to evaluate
beforehand which effect the native compilation will have on the system performance
if enabled in a particular case.
o Saved password. The password specified in this parameter will be automatically
used in the dialog boxes asking to connect to the DB (for example, when installing /
updating the software product). The parameter is available for test databases only.
o Check connection. The field contains the following buttons:
Under User. It is used to check the DB connection under the user the DB
schema belongs to. This button is recommended for use after the software
product is installed to the DB. Executing the command opens the dialog box with
the user password input field. After the command is executed, the respective
dialog box outputs the check results and additional information on the DB: DB
type and version; software product version the DB structure corresponds to;
values of the additional DB parameters. This information can be copied to

clipboard using button.

Under Privileged User. It is used to check the DB connection under the user
with system privileges. Executing the command opens the dialog box with the
user name / password input fields (for details, refer to Setting Up User with
System Privileges). After the command is executed, the respective dialog box
outputs the check results and additional information on the DB - DB type and

version. This information can be copied to clipboard using button.

Parameters. The tab contains the list of additional parameters used when installing/
updating the DB selected in the Databases field. These parameters are used to write
scripts. Each software product has own set of parameters.
To manage the list, use the Add, Remove, Duplicate, Up and Down buttons. The
record of the additional parameter has the following attributes:
o Name. The parameter name.
o Description. The brief description of the parameter.
o Value of the parameter.
To edit the attributes, double-click on the selected record field.

To access the DB, a jar file with the JDBC driver is required. This file can be:
For Oracle DBMS - ojdbc8.jar file supplied in the Oracle Client distribution kit.
It is recommended to use the latest version of the JDBC driver available in the
Oracle Client distribution kit. The version of the JDBC driver must be suitable to the
version of JAVA installed.

70 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

For PostgreSQL DBMS - postgresql.jar file that is included in the software product
distribution package (kernel/server/lib/ directory in the Radix (org.radixware) layer).
The path to the JDBC driver used by the RadixWare Manager application when
working with the Oracle or PostgreSQL DB can be specified in the Oracle JDBC Driver
File or PostgreSQL JDBC Driver File parameter, respectively. These parameters are
available in the settings of the RadixWare Manager application (Tools | Options |
Miscellaneous item in the menu | General tab).
Besides, the user will be prompted to select the jar file when executing any operation
that requires DB access for the first time (updating the DB, installing the software
product to the DB).

9.3.3 Editing Repository Parameters

To view / edit the repository parameters, go to the Repository editor in the Config
branch of the project. The repository parameters can be edited, for example, if any errors
were made during the project creation or if there is a need to edit the identifiers of the
software product layers. The editor can be opened by:
double-clicking on the project branch Config | Repository
using the Configure command in the context menu of the Repository editor.

When opening the editor, the following dialog box is displayed in the application working
area:

RWU - AG.ENG.06.12.2023. 71
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

The editor contains the Main and Options tabs:

"Main" Tab
The tab contains the following parameters:
Product name. The software product name.
Base development URI. The identifier of the base layer of the software product used
for development. The development can be conducted in the specified layer and those
above it. The parameter must be specified only if the customer has own development. If
the parameter is defined, the application is automatically set up for supporting the
development process.
System products in use. The list of products being used. The URI of the top-most
layer is specified for each product in the list (it is displayed in the name of the product
directory in brackets).
Manager version. The current version of the RadixWare Manager application stored
in the repository (in the manager.zip file).

"Options" Tab
The tab contains the parameters used by the vendor.

9.3.4 Editing Replication Parameters

For interaction of the server and client applications with the repository replica, perform
the following:
1.Using the Subversion tools, create and set up an empty repository that will store the
replica of the existing repository.
2.In the RadixWare Manager, set up the replica for the project being used (see below).
3.Initialize the replica by executing the special command of the RadixWare Manager
(see below).
4.Set up the client and server applications for using the created replica.

When receiving the software product update packages, the administrator must install the
updates to the main repository. After that the replica is automatically initiated. During the
replication the data of the main repository and its replicas are synchronized.
To set up the replication and work with the repository replicas, go to the Replication
editor in the Config branch.
The editor can be opened by:
double-clicking on the project branch Config | Replication
using the Configure command in the context menu of the Replication editor.

It should be noted that the Replication editor in the newly created project can be
unavailable. To open the editor, execute the Initialize Replica command called from
the context menu of the Config project branch.

72 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

When opening the editor, the following dialog box is displayed in the application working
area:

The editor contains the following elements:

The list of the current repository replicas. Each replica has the following parameters:
Name. The replica name.
SVN home URL. The location of the SVN repository replica. The standard rules for
working with the SVN repository are used to write the URL.
Check. The button is used to check the repository accessibility. Depending on the
authentication method (see below), the user can be prompted to enter the
password during the check.
SVN authentication. The user authentication method to access the repository
replica. The value is selected from the drop-down list:
None. Without authentication.
SVN Password. SVN authentication using the login and password.
SSH Password. SSH authentication using the login and password.
SSH Key File. SSH authentication using the public / private key pair.
TLS. Authentication by certificate file or access password (optional) by the TLS
protocol.
SSH Agent. Authentication by the SSH protocol using the SSH agent.
SVN user name. The name of the user under which the repository is accessed.
Reset password. The button is used to reset the current user password. The
button is available if the user entered the repository password during the current
RadixWare Manager session. After the password is reset, the new one can be
entered when clicking the Check button.
SSH key file. The location of the private key file. The parameter is available if the

RWU - AG.ENG.06.12.2023. 73
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

authentication is performed via SSH protocol (for the SVN authentication

parameter, the SSH Key File value is set). To open the dialog box used to select the

file, click button.

The following recommendation is applicable to RadixWare Manager

v.1.2.11.37.x and downwards (starting from v.1.2.11.38.x, use of PRIVATE KEY is
supported).
If the SVN authentication is performed via the SSH protocol using a pair of
public/private keys, it is recommended to specify in the SSH key file parameter
the pem file containing RSA PRIVATE KEY (if the PRIVATE KEY is used in the
RadixWare Manager, an authentication error will occur).For details on how to
generate a key of the required format, refer to Editing Project Parameters
(description of the SSH key file parameter).

The buttons for managing the replica:

Button Command Function

Add New Replica Adds a new repository replica

(Ins key)

Remove Selected Removes the selected replica

Replica
(Del key)

Replicate Copies the data of the current project repository to the selected
repository replica.
Before the command is executed:
SVN home URL specified in the settings of the replica selected
for duplication is checked for correctness.
Synchronization is checked - all existing revisions of the
original repository and replica and repository properties are
compared. The check of the revisions synchronization can be
disabled using the CheckCommitPolicyOnReplicaSync
parameter available in the manager.conf file. For details, refer
to RadixWare Manager Configuration File.
The replication results are written to the log file of the operation
that is stored in the directory specified in the Details Log
Directory parameter (editor of the project settings |
Directories tab).

Check Checks whether the data of the main repository of the project is
Synchronization synchronized with the selected replica. The check results are
displayed in the Output dialog box and are written to the log file
of the operation that is stored in the directory specified in the
Details Log Directory parameter (editor of the project settings
| Directories tab).

Duplicate Copies the data of the main repository to the selected replica
and saves the information on the latest revision only or on the
specified number of revisions (depending on the settings).

74 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

Button Command Function

The command execution dialog box contains the following

parameters:
Operation type. Available values:
o Duplicate repository with latest revisions. The specified
number of revisions of the main repository is copied to the
replica. To specify the number of revisions to be copied, use
the Duplication mode (number of revisions) radio
buttons:
If Set by user is selected, the number of revisions
specified in the Number of latest revisions parameter
will be copied.
If By branch is selected, the number of revisions is
defined automatically according to the creation date of
the branch specified using the Select Branch command.
If From revision is selected, the data of the main
repository will be copied to the replica, starting from the
revision specified in the From revision parameter.
o Duplicate repository (copy only latest revision). Only the
latest revision of the main repository will be copied to the
replica.
Commit bytes limit. The size of one portion of data to be
copied. The data is copied in parts to reduce the load on the
SVN server. The default value is 100 MB. The parameter is
editable only if Operation type = Duplicate repository (copy
only latest revision).

Before the command is executed, the SVN home URL specified

in the settings of the replica selected for duplication is checked
for correctness.
The command execution results as well as the repository
duplication parameters are written to the log file of the operation
that is stored in the directory specified in the Details Log
Directory parameter (editor of the project settings |
Directories tab).

For the complete replication of the main repository (but not

only the latest/selected revisions), it is recommended to use
the Replicate command.

RWU - AG.ENG.06.12.2023. 75
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

9.3.5 Setting Up Notification Service Parameters

The notification service is used to inform the software product users about the operations
performed in RadixWare Manager. The notifications are sent automatically via e-mail.
To set up the notification service, go to the Notification editor in the Config branch. In
the editor, the administrator creates e-mail message templates and assigns the
notification recipients for each event.

The editor can be opened by:

double-clicking on the project branch Config | Notification
using the Configure command in the context menu of the Notification editor.

When opening the editor in the working area of the application, the following dialog box is
displayed:

The editor contains the Events and Options tabs.

76 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

"Events" Tab
The tab contains the following elements:
The list of events for sending notifications. For each event, on the Message and
Subscribers tabs, set up the message template and create a list of subscribers.
The buttons for managing the list of events:

Button Command Function

Add New Event Adds a new event

Delete Event Deletes the selected event

Configure Languages The command opens the Choose Languages dialog box used
to select the notification languages.

The Message tab containing the Default subtab used to set up the default message
template for the selected event. The Message tab can also contain the subtabs used
to set up the message template in the languages supported by the application
(languages specified in the Choose Languages dialog box). Each subtab contains the
following areas:
Subject template. The area is used to define the message subject template.
Body template. The area is used to defined the message text template.
Subscribers. The tab is used to define the list of subscribers. For each subscriber,
define the following parameters:
Address. The e-mail address for sending notifications to.
Language. The notification language. Select the value from the list of supported
languages (languages specified in the Choose Languages dialog box). If the
parameter value is Not Defined, the template set up on the Message | Default tab
is used for notifications.
The following commands are used to manage the list of subscribers:

Button Command Function

Add new Subscriber Adds a new subscriber

Delete Subscriber Deletes the selected subscriber

"Options" Tab
The tab contains the Prefix of Issue (JIRA) Address parameter used to specify the
prefix to be added to the number of the software product modification issue when
creating a hyperlink to this issue. The hyperlinks are displayed in the notifications
containing the following macroparameters: %changelist%, %devchangelist%, %
translationchangelist% (except for notifications on the Distribution Kit Prepared,
Distribution Kit Exported events).

In the general case, the notification service setup includes the following stages:
1.Setting up access to the mail server.

RWU - AG.ENG.06.12.2023. 77
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

2.Adding the required event to the list of events processed by the notification service.
3.Creating a message template for this event.
4.Subscribing the user to the notification service.

Setting Up Access to Mail Server

This setting is defined on the Mail tab (select Tools | Options on the main menu and
then select Miscellaneous).

On the tab, define the following parameters:

Self email. The sender e-mail address.
SMTP server. The sender outgoing mail server.
SMTP port. By default - 25.
Use secure connection. The parameter defines whether the secure connection is
used. Select the required value from the drop-down list:
None. Do not use the secure connection.
TLS encryption. Use the connection via TLS protocol.
Authentication. The authentication type. Select the required value from the drop-
down list:
None. Do not use authentication.
Login. Use password authentication (the password for the mail server is used).
User. The parameter is available, if authentication is performed using the login and
password (for the Authentication parameter, the Login value is set). If the parameter
is set, the application uses the specified login automatically when sending the message.
Password. The mail server password. The value of the entered password is masked.
The parameter is available, if authentication is performed by the login and password (for
the Authentication parameter, the Login value is set). If the parameter is set, the
application uses the specified login automatically when sending the notification.
Test. The button is used to test the notifications sending. Clicking the button opens
the Input dialog box for specifying the e-mail address of the test notification recipient.
Subscribers. The area is used to define a list of subscribers to notifications of all
events of the RadixWare Manager when working in any project opened in the
application. The following parameters are defined for each subscriber:
o Address. The email address to send notifications to.
o Language. The language to be used for notifications. The default value is Default
(the template defined for the event on the Message | Default tab will be used for
notifications).
If the event has no template set up in the language specified in the Language
parameter, notifications of this event will not be sent to this subscriber.
The Add and Remove commands are used to manage the list of subscribers.
Enable notification. If the flag is not set, notifications of operations executed in the
RadixWare Manager will not be sent. The flag is set, by default (notifications are
enabled).
Enable notification confirmation. If the flag is set, the user will be requested the
respective confirmation before sending notifications of the operations executed in the
RadixWare Manager. The flag is not set, by default (notification confirmation is

78 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

disabled). This flag is available for editing only if the Enable notification flag is set
(when unsetting the Enable notification flag, the Enable notification confirmation
flag is unset automatically and is unavailable for editing).

Adding Event

To add an event, execute the Add New Event command ( ). In the Choose Event
Type dialog box that will open, select the required event type from the drop-down list.
The following table describes possible event types a notification can be created for:

Event Description

Release Created Release is built (used by the vendor)

Distribution Kit Prepared Distribution kit is ready (used by the vendor)

Distribution Kit Exported Distribution kit is unloaded for the customer (used by the
vendor)

Distribution Kit Imported Distribution kit is loaded to the repository

Distribution Kit Sent to Distribution kit is moved to the Development branch (used by
Development the vendor)

Release Sent to Test Release is moved to the Test branch (submit for testing)

Release Sent to Production Release is moved to the Production branch (submit for testing
production)

Release Status set to Urgent Release status is set to Urgent

Release Status Set to Invalid Release status is set to Invalid

Release Status Set to Expired Release status is set to Expired

Database Upgraded Database is updated

Release Status Set to Production Release status is set to Production

Release Status Set to Test Release status is set to Test

Release Description Translated Release description is translated. The event is generated when
translating the release description that is created in the release
parameters editor.

Creating Message Template

Message templates are created on the Message tab where it is required to perform the
following:
1.In the Subject Template area, enter the message subject template.
2.In the Body Template area, enter the message text template.

The following macroparameters can be used in templates for the message subject and
body:
%user_rwm_version% - RadixWare Manager version used to generate a notification
%time% - operation start time
%user% - user name (corresponds to the author menu item called with the Templates
button)

RWU - AG.ENG.06.12.2023. 79
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

%changelist% - description of the release/distribution kit

%distributive% - distribution kit number
%distributive_file% - distribution kit file name
%distributive_checksum_md5% - Md5 hash of the file package prepared for the
customer (it is used by the vendor for Distribution Kit Exported events)
%distributive_checksum_sha256% - Sha256 hash of the file package prepared for the
customer (it is used by the vendor for Distribution Kit Exported events)
%distributive_file_len% - size of the file package prepared for the customer (it is used
by the vendor for Distribution Kit Exported events)
%product% - software product name
%rwm_version% - RadixWare Manager version available in the distribution kit
%rwm_supported_versions% - list of RadixWare Manager versions that can be used
with the distribution kit (i.e. for installation of the file package prepared for the
customer)
%added_modules% - list of modules added to the software product in the prepared
distribution kit (it is used by the vendor for Distribution Kit Prepared and Distribution
Kit Exported events)
%removed_modules% - list of modules removed from the software product in the
prepared distribution kit (it is used by the vendor for Distribution Kit Prepared and
Distribution Kit Exported events)
%devchangelist% - description of the release/distribution kit provided by the developers
%translationchangelist% - description of the release/distribution kit on the supported
languages
%database% - database name
%from release% - source release number
%to release% - installed release number
%client% - customer name
%target_branch% - development branch
%product_prefix% - prefix of the software product supplied to the customer
%release% - software product release number
%release_revision% - number of the revision in the SVN repository used to create the
release (it is used by the vendor for Release Created events)
%release_commit_time% - time when the revision (used to create the release) was
committed to the SVN repository (it is used by the vendor for Release Created
events)

The macroparameters in the Body Template area are entered manually or using a special
menu opened with the Templates button on the toolbar. In the Subject Template area,
the macroparameters are entered manually only.

The macroparameter can be used in the template depending on the event type.

80 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

The template of notifications on Distribution Kit Prepared, Distribution Kit Exported

events can additionally contain commands used to generate notification text depending
on the release status. In general cases, the command syntax is as follows:
%if% <condition> %then%
<Notification text>
%endif%
where the <condition> parameter can have the following values:
%production_status% - release the distribution kit is based on has the Production
status
%test_status% - release the distribution kit is based on has the Test status
%urgent_status% - release the distribution kit is based on has the Urgent status
%manager_zip_exists% - distribution kit contains the manager.zip archive
%rwm_supported_versions_exists% - availability of information on the RadixWare
Manager versions that can be used with the distribution kit (i.e. for installation of the
file package prepared for the customer)
%licenses_changed% - prepared distribution kit contains the updated license file
(licenses.xml)
%added_modules_exists% - prepared distribution kit contains the modules added to the
software product
%removed_modules_exists% - prepared distribution kit contains the modules removed
from the software product

Example of notification template on creating the upgrade package for a particular

customer (Distribution Kit Exported event):
%if% %production_status% %then%
New upgrade is available for you.
File name %distributive_file%, target version %release%. Creation time %time%
%endif%

%if% %urgent_status% %then%

New Upgrade containing urgent patches is available for you.
Please test this version before installing it on Production server.
File name %distributive_file%, target version %release%. Creation time %time%
%endif%

%if% %test_status% %then%

New Upgrade is available for you to install on TEST SERVER.
File name %distributive_file%, target version %release%. Creation time %time%
Attention! Do not install this Upgrade on the production server without the approval of
Product Support Service!
%endif%

RWU - AG.ENG.06.12.2023. 81
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Setting Up Project and Repository

Subscribing User to Notification Service

The Add New Subscriber command ( ) available on the Subscribers tab enables to
subscribe the user to each event option. Clicking this button opens the New Subscriber
dialog box where it is necessary to enter the user email address.
The RadixWare Manager also enables to create a list of subscribers for all events and
projects opened in the application (see the description of the Subscribers area available
in the settings of the email server).

9.4 Installing Software Product

Before being put into production, the software product must be tested.

For initial installation, the following actions are performed:

1.Create a software product directory in the repository. For details, refer to Creating
Software Product.

Creation of the software product directory is not mandatory. If the appropriate

directory is not found when loading the software product distribution kit, it will be
created automatically (if the list of products in the project is empty, i.e. the
software product is being installed in a new project) or the user will be prompted to
create a directory (if the project contains other software product directories).

2.Load the software product files package to the repository. For details, refer to Loading
Software Product Update Package.
3.Create test / production branches to be used in the project in one of the following
ways:
Execute the Create Branch command in the context menu of the Branches branch
of the project navigation tree. For details, refer to the description of the Create
Branch command.
If it is planned to use environments to support the software product, it is necessary
to:
o Create an environment using the Add command in the environment editor
(Environments branch in the navigation tree).
o When defining the Branch parameter of the created environment (environment

editor, Environment Attributes area), create a new branch using button

(for details, refer to the description of the Create Branch command). The
created branch will be automatically associated with the environment.
For details, refer to Managing List of Environments.
4.If URI of the software product whose distribution kit is submitted for testing (and
further for production) is not specified in the System Products in Use list when
creating a project, it is necessary to add URI to the list in one of the following ways:
manually in the editor of the repository parameters
automatically using the Add URI to 'System Products in Use' command available in
the context menu of the software product branch.

82 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Installing Software Product

5.Submit the software product for testing. For details, refer to Submitting Software
Product for Testing / Production.
6. Submit the scripts execution log to the Product Support Service.
7.Test the software product.
If the software product is tested successfully, it can be put into production (item 6 of
this sequence).
If any mismatches or errors are found in the software product, contact the Product
Support Service as specified in the agreement with the vendor. Change the software
product status to Invalid (refer to Appendix. Release Parameters Editor).
8.Put the software product into production using one of the following commands:
Build | Production Branch '<BranchName>'. This command is called from the
context menu of the selected distribution kit (Distribution Kits | <Product> branch
of the project navigation tree).
Send to | Production Branch '<BranchName>'. This command is called from the
context menu of the test branch and has the following differences from the Build
command:
At the preparatory step, the dialog box of the Send to | Production command
has no Available Products area making it impossible to include the layers from
different distribution kits / releases in the list of layers being put into
production).
The destination branch is always cleared before the software product is put into
production. As such, the Clear destination branch before update flag located
in the Destination Branch State area is set and not editable, by default.
If environments are used - Application Core | Build from Distribution Kit and
Application Core | Build from Environment | <EnvironmentName> (branch
'<BranchName>') commands for the environment update. The commands are
called from the context menu of the Environment branch. For details on how to
update environments, refer to Operations on Environments.
For details, refer to Submitting Software Product for Testing / Production.
9. Submit the scripts execution log to the Product Support Service.
10.If necessary, perform the repository replication.

During the software product installation and update procedures, the RadixWare
Manager modifies:
Service DB tables used for keeping track of the software product layer versions installed
and scripts executed when installing / updating the software product.
Scripts execution log file. The log file contains the information about the current
software product version and about the errors occurred during the installation/update
procedure. The log file is to be transferred to the vendor in order to control the
correctness of the installation/update procedure (refer to Appendix. Scripts
Execution Log File).

9.4.1 Creating Software Product

In general, a RadixWare-based software product is a directed graph of layers. The

lowest layer in the graph is org.radixware that is a platform implementing the basic
functionality of the software product. Separate parts of the software product can be

RWU - AG.ENG.06.12.2023. 83
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Installing Software Product

developed independently from each other and supplied to the customer by different
vendors as products.
A product is a certain set of layers. The customer can employ several products from
several vendors. The end software product can contain several products integrated into a
single system including:
Layer of customer modifications (the layer is available not for all customers)
Common layer
Lower layers of products. A set of layers is defined in the customer settings so as to
provide the customer with the possibility to build a single system.
Localizing layers for all layers of the end product (the layers are available if the
software product requires localization to other additional languages)

To create a product, select the Create Product item in the context menu of the
Distribution Kits branch of the project tree. In the respective dialog box, in the Product
URI parameter, specify URI of the top-most layer of the software product supplied by the
vendor. The parameter is used to define whether the distribution kit supplied by the
vendor belongs to a certain product as well as to specify the top-most layer to be
installed from the distribution kits. After the command is executed, a product directory is
created in the Distribution Kits branch. The directory name contains URI of the top-most
layer of the software product.

9.4.2 Loading Software Product Update Package

The procedure is used for loading the software product initial installation package and
updates.
RadixWare Manager allows loading several update packages in succession. At that, it is
enough to update the database to the last loaded distribution kit.

During the software product installation and update procedures, at the stage of the
software product files package loading, the RadixWare Manager verifies the following:
1.Presence of the previous distribution kit (it is required if the update package needs to
be loaded) in one of the software product directories. If the previous distribution kit is
not found, the RadixWare Manager generates an error message.
2.Correspondence of the software product layers of the distribution kit being loaded to
the layers of the distribution kit that has been previously loaded to one of the software
product directories. If the software product directory with the respective layers is not
found, it will be created automatically or after the confirmation from the user (for
details, see below).
3.Correctness of the update package numbers sequence. On attempt to load the package
with inappropriate number, the RadixWare Manager generates an error message. For
details on the update package numbering and loading to different projects, refer to
Appendix. Sequence of Update Package Numbers.
4.Digital signature for the zip file:
The digital signature is verified. If the signature is present but not valid, the
RadixWare Manager disables loading the package and displays the respective
warning. If the digital signature is absent, the RadixWare Manager asks to confirm
the package loading.

84 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Installing Software Product

The certificate is verified. If the certificate is present in the list of trusted

certificates, the RadixWare Manager loads the package. If the certificate is absent
in the list of trusted certificates or there is no possibility to check the certificate (the
certificate store is not set up, there is no access to the store, etc.), the RadixWare
Manager asks to confirm the package loading.
For details on the zip file digital signature verification, refer to Setting Up Digital
Signature Verification.
5.Compatibility of the RadixWare Manager version with the version of the update
package being loaded: if the version incompatibility is detected when loading the
update package, a respective warning will be displayed.

Update Package Loading Procedure

1.Copy the zip file to the upgrades subdirectory of the project directory (the path to the
sub-directory is specified in the Upgrades Directory parameter of the project
settings).
2.Call the Load Updates procedure using the context menu of the Distribution Kits
project branch.
In the Distribution Kits project branch, the distribution kits of different software
products are stored in separate directories. To search for the required directory to load
the updates to, the URI of the top-most layer of the software product being loaded is
compared to the URI specified for the product directory.
If the product directory with the matching layer URIs is not found when loading the
update package, a new product will be created automatically (if the list of products in
the project is empty, i.e. the software product is being installed in a new project) or
the user will be prompted to create a product (if the project contains other software
product directories).

If a new directory is created when loading the update package, after the procedure
is completed, check whether the URI of the top-most layer is present in the System
products in use list. If necessary, add the URI to the list. The name of the top-
most layer URI is specified in brackets in the product directory name.

All zip files saved to the upgrades subdirectory are loaded to the repository in
sequence according to the sequence number. If the sequence is not observed, the
RadixWare Manager generates an error message. The numbering is tracked for each
product being loaded. If the upgrades subdirectory contains the previously loaded
packages, these packages are skipped and the procedure of loading other packages is
not interrupted.

RWU - AG.ENG.06.12.2023. 85
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Installing Software Product

3.Perform the preparatory steps in the dialog box of the Load Updates procedure:

The steps are displayed in the left part of the dialog box (the current step is marked
bold). The right part contains the fields for defining the procedure parameters.
The following table describes the preparatory steps:

The steps and data groups marked in the table with "*" are not available when
loading the initial installation package.

Step Description
General The parameters of the package being loaded:
Target distribution kit. The number of the distribution kit to be installed.
Source distribution kit. The number of the source distribution kit.
Files The Files dialog box displays the following:
The list of new distribution kit files that differ from the previous distribution kit.
The list is presented in the following groups:
New files
*Modified files. The files to be updated.
*Removed files. The files to be deleted.
Show auxiliary files. If the flag is set, the modified auxiliary files (api.xml,
definitions.xml, directory.xml, directory-layer.xml, layer.xml, usages.xml) are
included in the list of files.
Scripts The Scripts dialog box displays the list of script files presented in the following
groups:
New scripts. The new files.
*Modified scripts. The files to be updated.
*Removed scripts. The files to be deleted.

*Description The description of the changes that will be made during the package loading.

To switch between the steps, use the Next and Back buttons. To finish the
preparation for the loading procedure, click the Finish button; to cancel the loading
procedure, click the Cancel button.

86 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Installing Software Product

4.Follow the package loading procedure.

The procedure progress is displayed in the bottom right corner of the main dialog box of
the application.

The package loading procedure may take a long time.

The procedure can be interrupted in the progress indicator field in the bottom right
corner of the main dialog box of the application by:
clicking the Close button ( )
using the Cancel Progress command in the context menu of the indicator field.

If the package loading procedure is interrupted (for example, due to power failure),
restart the procedure. When restarting the procedure, the RadixWare Manager starts
loading from the first step.

The Output dialog box shows:

Progress of the procedure
Information on the modules that will be added, changed, deleted in the course of the
loading procedure
Information on the certificate check result (certificate is not trusted, is expiring or
expired, etc.)
Result of the procedure execution
Description of the errors occurred

If the procedure is executed successfully, the RadixWare Manager application

performs the following actions:
Shows the procedure results in the Output dialog box.
Automatically moves the package zip file from the upgrades subdirectory to the
upgrades.backup subdirectory.
Shows in the project navigation tree:
In the branch Distribution Kits | <Product> - distribution kit with the nested
directories Scripts and Release.
In the Scripts branch - directories with the installation scripts for all software
product layers. When loading the update package, in addition to the installation
scripts, the branch contains the scripts for switching between the versions for all
software product layers.
Generates and sends notifications of the procedure (if the notification service is set
up).
If any problem is detected, the RadixWare Manager displays an error message and
undoes the actions performed. If the problem cannot be resolved without assistance,
submit the text of the error message to the vendor for analysis and resolution.

RWU - AG.ENG.06.12.2023. 87
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Installing Software Product

9.4.3 Submitting Software Product for Testing / Production on

Installation

To submit the software product for testing / production, the following commands are
used:
Build | Testing Branch '<BranchName>', where <BranchName> is a test branch to
which the distribution kit will be moved (if the software product is submitted for
testing).
Build | Production Branch '<BranchName>', where <BranchName> is a production
branch to which the distribution kit will be moved (if the software product is submitted
for production).

The commands used to submit the software product for testing / production are called
from the context menu of the selected distribution kit in the branch Distribution Kits |
<Product> of the project tree.

The software product can also be submitted for testing / production in the context of
environments and landscapes using the Application Core | Build from Distribution Kit
and Application Core | Build from Environment | <EnvironmentName> (branch
'<BranchName>') commands called from the context menu of the Environment branch.
For details on how to work with environments and landscapes, refer to Managing
Software Product Configuration in Environments and Landscapes.

The Build | ... commands are not available if:

URI of the software product whose distribution kit is submitted for testing /
production is missing in the System Products in Use list. The software product URI
can be added to the list:
o manually in the editor of the repository parameters
o automatically using the Add URI to 'System Products in Use' command
available in the context menu of the software product branch.
The test / production branches are missing in the project.
In the above-listed cases, the name of the Build command is changed to Build (Click
for More Information). At the attempt to execute this command a message
describing the reason for unavailability and brief project setup instructions is displayed.

Before executing the Build | ... command, it is checked that the RadixWare Manager
version is compatible with the software product version: if the version incompatibility is
detected before submitting the software product for testing / production, the
procedure is completed with an error.

88 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Installing Software Product

Executing the Build | ... command opens the dialog box used to complete all preparatory
steps of the installation procedure:

The Available Products area contains the table with the list of products (products
whose URIs are specified in the System Products in Use list in the repository settings)
included in the end software product supplied to the customer. The Layers\Products
column displays the list of all layers included in the product distribution kits. The
information on each product is displayed in a separate column. If the layer is included in
the product, the column with this product (next to the name of the layer) contains the
flag and number of the distribution kit with the latest update for this layer. The layers
for which the flag is set will be copied to the test / production branch.
In the Select release row, for each product it is possible to specify the distribution kit
whose layers will be sent to the test / production branch. By default, this row displays
the last distribution kit successfully loaded to the product directory. For other products,
this row displays the last distribution kit successfully loaded to the product directory.

RWU - AG.ENG.06.12.2023. 89
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Installing Software Product

If the products being submitted for testing / production contain the duplicated
layers, it is required to specify the layer of which product will be sent to the test /
production branch. For this, set the flag next to the layer in the column with the
required product.
If the layer is present in the distribution kit of one product only, it will be sent to the
test branch, by default (the flag is set for the layer and is view-only).
All layers listed in the left part of the dialog box (in the Layers\Products column)
are sent to the test branch. It is prohibited to submit not all layers from the list for
testing.

If the customer performs the in-house development, the left part of the dialog box will
contain the Developer Releases column with the list of release layers available to be
sent to the test / production branch.
The Destination Database area is used to define the connection parameters for the
database the software product will be installed to:
o Database. The database to install the software product to. Select the required
database from the drop-down list of databases registered in the project and
databases from the local list (if the local list is defined and enabled for use). The DB
record contains the following parameters (comma separated): DB name, DB user
name (schema), DB type (test / production).
o '<sys_user> as sysdba' password. The password of the user with the system

privileges (SYS). The user is set up in a special dialog box opened by command.
o Password of '<schema>' user. The DB user password. For test DB, the password
specified in the Saved password parameter in the editor of the DB access
parameters will be used automatically.
If the character "#" is used in the DB user password, and the password is
specified in the configuration file used to run the RadixWare Server, the
password needs to be enclosed in quotes. Otherwise, only the part of the string
before "#" will be considered as password since "#" indicates the beginning of a
comment in the configuration file.
[Starter]

...

[Server]

...
dbSchema=TEST
user=TEST
pwd="test#123"
...

90 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Installing Software Product

o Confirm '<schema>' user password. The DB user password confirmation.

o Show all databases. If the flag is not set, the drop-down list in the Database
parameter contains test databases only. If the flag is set, the list contains all
databases added to the project. By default, the flag is not set if the software
product is installed to DB in the test branch. By default, the flag is set if the
software product is installed to DB in the production branches.
If the DB does not need to be installed, set the Do not update database flag. The
flag is not set, by default.
The State of Destination Branch area is used to validate the data displayed in the
table with the list of layers that will be added. For each layer, the New State column
shows the state after the software product is sent to the test / production branch (all
layers have the Added state - layer will be added to the branch, the new layer version
will be specified in brackets).
Update Settings. The command opens the Update Settings dialog box used to set up
the checks to be performed before / after the software product version installation.
Check. The command is used to perform similar checks for the software product version
being installed as those performed after clicking Next, but with the difference that this
command does switch to the step when the software product is submitted for testing /
production. In particular, the command enables to perform a set of mandatory checks
warning of possible problems during the software product installation, and all the checks
set up in the Update Settings dialog box.
Check and Save Log. The command is used to perform similar checks as the Check
command. The only difference is that after the checks are performed, a log file of
standard format is created for the procedure for submitting the software product for
testing/production, but it contains only the general information on the procedure and
the results of the pre-checks performed (further in the course of the procedure,
another file will be created to log the information on the procedure progress). The full
path to the log file is available in the dialog box with the command execution results.
The command can be used, for example, when some errors are detected at the
preparatory step and it is required to generate a log file to be submitted to the Product
Support Service.

After the presettings are made, run the procedure for submitting the software product for
testing / production using the Next button. After clicking Next:
The checks set up in the Update Settings dialog box (at the preparatory step of the
update procedure) are performed automatically. The errors/warnings found are displayed
in a separate dialog box. At this step the update procedure can be cancelled (to
analyze and fix the problems detected).
It is checked that the software product can be installed to the selected DB: if the
version of the selected DB is older than the minimum supported version, the respective
error message is displayed to the user and the installation process cannot be continued.
This check can also be performed using the Check command.
DB is checked for the availability of the tablespaces required for correct operation of
the software product.

RWU - AG.ENG.06.12.2023. 91
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Installing Software Product

Generally, this procedure consists of the following steps:

1.Licensed Installation. Enter the information on the licensed installation. This step is
present only if the following conditions are met:
Before building the distribution kit for the customer, the vendor has made the
required licensing settings.
RadixWare 2.1.36.x or onwards is being installed.
For details, refer to Licensed Software Product Installation.
2.Export of 'starter.jar'. Save the starter.jar file to the directory on the local drive
using the Export file button.

3.Export of 'web-app.war'. Save the web-app.war file to the directory on the local
drive using the Export file button.
4.For the description of the Execution Plan and Database Parameters steps, refer to
Installing Software Product to DB.

6.Before Scripts Execution. This step switches to the installation of the software
product to the DB.
7.Scripts Execution. This step starts the installation of the software product to the DB.
At this step, the dialog box shows:
Description of the current step of the installation process and recommendations on
further actions
Indicator of the installation progress
Show Details/Hide Details button used to show/hide the area with the additional
information on the current step of the installation process.
Area containing the detailed information on the installation process. All events
including error messages are logged to this area. This information is also written to
the scripts execution log (for details, refer to Scripts Execution Log File).

92 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Installing Software Product

It is not recommended to interrupt the installation of the software product to the

DB. In case of any failure, contact the Product Support Service on the vendor side
and follow the given instructions.

If any problem occurs during the installation procedure, the RadixWare Manager
displays an error message and offers the following actions:
Abort (a) - abort the procedure
Ignore (i) - ignore the error
Retry (r) - repeat the action that caused the error
The administrator should estimate the situation and make a decision. If the problem
cannot be resolved without assistance, contact the Product Support Service.

When updating the DB, the checks set up in the Update Settings dialog box (at the
preparatory step of the software product installation procedure) will be performed
automatically.

If errors and warnings are detected during the check, it is recommended to ignore
them and proceed with the installation procedure. Once the installation is completed,
submit the file with the scripts execution log to the Product Support Service.
If the detailed analysis proved that errors and warnings found when checking the
compatibility of the DB structure and metainformation do not need to be fixed and
should be ignored in future (for example, they are not critical and do not affect the
system health), they can be hidden in the check results using the Configure
Database Warnings command.

8.After Scripts Execution. The information tab displays the DB update results. No
changes are required at this step.
9.Before Files Update. The software product files are copied to the SVN repository. No
changes are required at this step.
10.After Files Update. The final step of the software product installation procedure. The
information tab displays the results of copying the files to the SVN repository. No
changes are required at this step.

The result of the successful Build procedure is as follows:

The files of the software product release distributed among the layers are available in
the test / production branch of the project tree.
Notifications of the procedure execution are generated and sent to the users (if the
notification service is set up).

9.4.4 Installing Software Product to DB

The RadixWare Manager application supports working with several databases. As a rule,
test and production databases are used.
The software product files package received from the vendor contains the scripts for
initial installation of all software product layers and the scripts for installation of the
software product versions for all layers. The script packages are loaded to the Scripts
branch when loading the software product file packages.

RWU - AG.ENG.06.12.2023. 93
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Installing Software Product

When installing the software product to DB and updating the DB afterwards, the
RadixWare Manager schedules the scripts execution for bringing the database to a
certain structure; an indispensable condition is that before running the scripts for a higher
layer the lower layers are set to the required states.
When installing the software product to DB and updating the DB, the RadixWare
Manager modifies the table of executed scripts. The procedure result is registered in the
table of installed versions.
When installing the software product to DB (see below), the RadixWare Manager
creates the database user whose name is specified in the Schema parameter of the
database (refer to Setting Up Database Access Parameters). In addition, the
administrator specifies the database password. The RadixWare Manager ensures the
password security by imposing requirements for the password complexity: including
password length, the use of special characters, etc. To set up the password
requirements, go to the application configuration file (refer to Appendix. RadixWare
Manager Configuration File). The password strength is not verified when installing the
software product to test DB.

Installing Software Product to DB

The procedure for installing the software product to the test and production databases is
the same.
1.Start the installation procedure using the Install to Database command available in
the context menu of:
test branches
production branches
distribution kits received from the vendor and loaded to the Distribution Kits |
<Product> branch (the command is available if the project is set up for own
development)
To install the software product to the RadixWare database, in the Radix
(org.radixware) branch, select the latest version of the distribution kit and execute
the Install to Database command from the context menu.
2.Define the DB connection parameters in the Install to Database dialog box:
Database. The database to install the software product to. Select the required
database from the drop-down list of databases registered in the project and
databases from the local list (if the local list is defined and enabled for use). The DB
record contains the following parameters (comma separated): DB name, DB user
name, DB type.
'<sys_user> as sysdba' password. The password of the user with the system

privileges (SYS). The user is set up in a special dialog box opened by command.
Password of '<schema>' user. The DB user password. For test DB, the password
specified in the Saved password parameter in the editor of the DB access
parameters will be used automatically.
Confirm '<schema>' user password. The DB user password confirmation.
Show all databases. If the flag is not set, the drop-down list contains test
databases only (the Database parameter). If the flag is set, the list contains all
databases added to the project. By default, the flag is not set if the software
product is installed to DB in the test branches. By default, the flag is set if the
software product is installed to DB in the production branches.

94 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Installing Software Product

Update Settings. The command opens the Update Settings dialog box used to set
up the checks to be performed after the software product installation to the DB.
Check. The command is used to perform similar checks for the software product
version being installed as those performed after clicking Next, but with the difference
that this command does switch to the next step. In particular, the command enables
to perform a set of mandatory checks warning of possible problems during the
software product installation to the DB, and all the checks set up in the Update
Settings dialog box.
Check and Save Log. The command is used to perform similar checks as the Check
command. The only difference is that after the checks are performed, a log file of
standard format is created for the procedure for installing the software product to the
DB, but it contains only the general information on the procedure and the results of
the pre-checks performed (further in the course of the procedure, another file will be
created to log the information on the procedure progress). The full path to the log file
is available in the dialog box with the command execution results. The command can
be used, for example, when some errors are detected at the preparatory step and it
is required to generate a log file to be submitted to the Product Support Service.

3.Complete all preparatory steps of installation of the software product to DB in the

Install to Database dialog box:
The left part of the dialog box displays the list of steps (the current step is in bold).
The right part contains the installation parameters.

The table below lists the preparatory steps and parameters:

Step Description

Execution The RadixWare Manager displays the following information:

Plan
Source release. The number of the source release. The value is 0 when the DB
is installed.
Target release. The number of the release to be installed.
Packages. The tab displays the version transition plan.
Scripts. The tab displays the scripts execution plan for bringing the database
structure in compliance with the release being installed.

RWU - AG.ENG.06.12.2023. 95
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Installing Software Product

Step Description

Database Additional parameters for the type of the DB to which the software product is
Parameters installed:
Database. The type of the DB to which the software product is installed (Oracle/
PostgreSQL). The parameter is filled automatically depending on the DB type
selected at the preparatory step of the installation procedure.

If only one DB is available, the Database parameter is filled automatically and is

not editable.

Version supported by platform. The minimum DB version supported in the

RadixWare-based software product. The parameter is filled automatically
depending on the DB type specified in the Database parameter.
Current version. The actual version of the DB to which the software product is
installed. The value is filled automatically in compliance with the DB version.
The list of additional DB parameters presented as a table. The table consists of
three columns:
Parameter column contains the parameter name in the <Layer name>
\<Parameter name> format.
Description column contains the parameter description.
Enable column contains the flag indicating whether the parameter is used in
the RadixWare Manager when pre-processing the SQL scripts.

The additional DB parameters are defined only once and cannot be changed
afterwards.

When installing any software product based on the RadixWare platform to the
database, the Database Parameters dialog box contains the following parameters
for the Oracle DB:
org.radixware\partitioning. If the parameter is used (the Enable flag is set),
when pre-processing the SQL scripts, it is considered that the created DB supports
partitioning. The scripts capable to work with the partitioned DB entities will be
executed (for details, refer to the Oracle documentation). By default, the Enable
flag is set.
org.radixware\AWS_RDS. The attribute indicating that the Amazon Relational
Database Service (AWS RDS) is used. The Enable flag is automatically set for the
parameter if Deployment type = Amazon Relational Database Service (AWS
RDS) in the DB access settings. In other instances, the Enable flag is not set. The
parameter is not editable.

96 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Installing Software Product

Step Description

org.radixware\ORACLE_ADB. The attribute indicating that the Oracle

Autonomous Database (ORACLE ADB) is used. The Enable flag is automatically
set for the parameter if Deployment type = Oracle Autonomous Database
(ORACLE ADB) in the DB access settings. In other instances, the Enable flag is not
set. The parameter is not editable.
org.radixware\USE_DEFAULT_TABLESPACE. The auxiliary parameter. It is
used when installing the software product to the Oracle Autonomous Database. The
value is set automatically depending on the Deployment type parameter. The
parameter is not editable.
For details on the additional DB parameters, refer to the documentation for the
software product being installed.
New additional parameters can be added to the customer layers of the software
product. It can be also prohibited to change the parameter values set on the
lower layers (for example, the flag in the Enable column of the org.radixware
\partitioning parameter can be set and view-only).
Additional parameters for the DB type are created when developing the software
product, in the RadixWare Designer, in the settings of the software product
layers (for details, refer to document [9]).

To switch between the steps in the Install to Database dialog box, use the Next and
Back buttons. To complete the preparatory steps of the installation procedure, click
the Finish button; to cancel the procedure, click the Cancel button.
4.Start the installation of the software product to DB. In the course of the installation,
the Install to Database dialog box will be hidden. The information on the installation
progress according to the scripts execution plan will be available in the Output dialog
box.
It is not recommended to interrupt the installation procedure. In case of any failure,
contact the Product Support Service on the vendor side and follow the given
instructions.

If any problem is detected during the installation, the RadixWare Manager displays
an error message and offers the following actions: interrupt the procedure, ignore
the error, repeat the action that caused the error (refer to Processing Errors).
Estimate the situation and make a decision. If the problem cannot be resolved
without assistance, contact the Product Support Service.

When installing the software product to the DB, the RadixWare Manager
automatically creates a file with the scripts execution log to write all events
(including error messages) to.

The successful result of the operation is as follows:

The Output dialog box displays a notice that the installation has been successfully
completed.
The notifications of the operation are created and sent to the software product
users (if the notification service is set up).
5.After the procedure is completed, it is recommended to send the scripts execution log
file to the vendor. This file is automatically saved to the log.prod subdirectory (if the
software product is installed to the production database) or log.test subdirectory (if
the software product is installed to the test database) in the project directory.

RWU - AG.ENG.06.12.2023. 97
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Installing Software Product

9.4.5 Licensed Software Product Installation

For software products developed on the RadixWare platform, it is possible to configure

protection against unauthorized use and to monitor the system maintenance
characteristics.
One of such tools is a licensed system installation – installation from the pre-agreed list
stipulated in the license agreement. In this context, installation means deployment of a
distribution kit on one or several computing environments (a complex which includes a
database and a suite of interconnected application servers), where one of the
environments is a production one (PROD) and the others serve as auxiliary environments
(for example, TEST, PREPROD, etc.). Each installation is identified by the following
attributes:
Licensed installation code – unique short code of the installation from the license
agreement
Licensed installation name – human-readable name of the installation from the license
agreement
Licensed installation role – identifier of the computing environment within the installation
determining the environment purpose (PROD, TEST, PREPROD, etc.)
After the list of licensed installations is agreed with the customer and before the
distribution kit is built, the vendor of the software product should make the required
licensing settings in the RadixWare Manager. After the settings are made, the Licensed
Installation step will appear in the dialog box used to submit the software product for
testing/production on system installation or update. At this step, the user needs to define
the following parameters:
Licensed role. The value is selected from the pre-defined list:
o PROD - production environment
o TEST - testing environment
o DEV - development environment
o PRE-PROD - pre-production environment
o DR - Disaster Recovery environment
o UAT - User Acceptance Testing environment
o SIT - System Integration Testing environment
The parameter enables to define the own value using uppercase Latin letters,
numbers, dash ("-") and underscore ("_") characters.
Licensed name and code. The value is selected from the pre-defined list that is
customer-specific (see above).
The Do not define licensed installation parameters flag enables to skip the step of
entering the information on the licensed installation. In this case, the system installation/
update procedure will continue and the Licensed Installation step will be present in the
dialog box used to submit the software product for testing/production each time the
software product is updated. Once the information on the licensed installation is entered,
this step is no longer displayed when the software product is updated next time. In the
RadixWare Explorer, these parameters are available in the editor of the own system.
Further they are used for licensing supervision.

98 RWU - AG.ENG.06.12.2023.
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Installing Software Product

In the console version of the RadixWare Manager, the LICENSE_CODE, LICENSE_NAME,

LICENSE_ROLE arguments are used to enter the information on the licensed installation.

9.4.6 Setting Up User with System Privileges

When installing the software product to the DB and, sometimes, when updating the DB (in
particular, when the rights are granted during the update procedure), some scripts need
to be executed under the user with system privileges. For this purpose, the system
account SYS is used, by default. However, the RadixWare Manager enables to change
this account in the Change Privileged User dialog box. This dialog box contains the
following parameters:
Privileged user name. The name of the user with system privileges to be used instead
of the SYS user when installing the software product to the DB / updating the DB. For
the Standalone DB type, the default name is sys. For the AWS RDS and ORACLE ADB
types, the default name is admin. The DB type is defined in the Deployment type
parameter.
As sysdba. The set flag indicates that the specified user has system privilege sysdba.
This flag can be unset if, for some reason, instead of the user with system privileges
(sysdba), it is necessary to specify the user who has administrative rights sufficient to
install the software product to the DB or to update the DB (if the rights are granted
during the update procedure), but does not have sysdba privilege. In particular, it may
be necessary when cloud services are used and the users of these services do not have
maximum rights for the DB administration. For the Standalone DB type, the flag is set,
by default. For the AWS RDS and ORACLE ADB types, the flag is not set.

RWU - AG.ENG.06.12.2023. 99
2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Installing Software Product

Note that the user with no sysdba privilege must have a right to grant rights to
other users.

9.5 Updating Software Product

Before the software product release is put into production, it must be tested.

The modifications made to the database are irreversible. In order to protect the system
from various kinds of failures and errors (caused by updates, power failure, etc), it is
necessary to use the backup mechanism. It is the database administrator who is fully
responsible for the databases backup. The backup methods are determined by the internal
regulations of the company.
To restore the software product files, it is enough to submit the previous release version
for testing / production (Build | Testing Branch '<BranchName>' / Build | Production
Branch '<BranchName>') depending on what repository area (test or production) needs
to be restored.

The scripts execution log file related to both test and production databases should be
submitted to the Product Support Service on the vendor side for analysis.

Software Product Update Procedure

If certificate read errors occur when installing updates on the production system, it is
necessary to stop the update procedure.

When installing the software product update, it may be required to restart the
application server, update the starter.jar and web-app.war files, etc. To get
information on whether these actions are required, execute the Analyse System
Changes command before the update (for details, refer to Analyzing System
Changes).

If the user-defined functions are used in the system, when updating the software
product, it is required to check the user-defined functions compatibility with the new
version (for details, refer to Checking User-Defined Functions during Update
Installation).
The sequences of actions to update and install the software product are similar (refer to
Installing Software Product). The only difference is in the procedure for submitting the
software product for testing / production (for details, refer to Submitting Software
Product for Testing / Production).

100 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

9.5.1 Submitting Software Product for Testing / Production on

Update

The recommendations for submitting the software product for testing / production
described in this section enable to install the software product update with a minimum
delay in servicing the customers. To minimize the delay, the following procedures are
divided into separate steps:
Updating the system kernel
Switching the RadixWare Server and RadixWare Web Presentation Server
instances to the new kernel version. The RadixWare Server instances can be switched
to the new kernel version by executing the respective command which restarts the
instances one by one (provided that all the requirements applied to the RadixWare
Server startup files are met, for details, refer to document [4]) or the instances can be
restarted by the administrator manually.
Updating the application code version
Switching the RadixWare Server instances to the new version of the application code
using the respective command. The instances are switched synchronously which
enables to eliminate the risk of system failure when two versions of the application work
with the same DB simultaneously.

The mechanism of the rolling upgrade is not supported in the console version of the
RadixWare Manager.

Procedure for Submitting Software Product for Testing / Production

The software product is submitted for testing / production during the update procedure
similarly to the installation procedure, using the following commands:
Build | Testing Branch '<BranchName>', where <BranchName> is a test branch to
which the distribution kit will be moved (if the software product is submitted for
testing).
Build | Production Branch '<BranchName>', where <BranchName> is a production
branch to which the distribution kit will be moved (if the software product is submitted
for production).

The commands used to submit the software product for testing / production are called
from the context menu of the selected distribution kit in the Distribution Kits |
<Product> branch of the project tree.

The software product can also be submitted for testing / production in the context of
environments and landscapes using the Application Core | Build from Distribution Kit
and Application Core | Build from Environment | <EnvironmentName> (branch
'<BranchName>') commands called from the context menu of the Environment branch.
For details on how to work with environments and landscapes, refer to Managing
Software Product Configuration in Environments and Landscapes.

RWU - AG.ENG.06.12.2023. 101

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

Before executing the Build | ... command, it is checked that the RadixWare Manager
version is compatible with the software product version: if the version incompatibility is
detected before submitting the software product for testing / production, the
procedure is completed with an error.

Executing the Build | ... command opens the dialog box used to complete all preparatory
steps of the update procedure:

The Available Products area contains the table with the following columns:
o Layers\Products. The list of all layers included in the distribution kits. The layers
listed in this column should be sent to the test / production branch.
o Columns containing information on the products used in the end software product
supplied to the customer (products whose URIs are specified in the System
Products in Use list in the repository settings). Next to the name of each layer
included in the product, the column contains the flag and number of the distribution

102 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

kit with the latest update for this layer. The layers for which the flag is set will be
copied to the test / production branch.
In the Select release row, it is possible to specify the distribution kit whose layers will
be sent to the test / production branch. By default, this row displays the last
distribution kit successfully loaded to the product directory.
The Destination Database area is used to define the database connection
parameters:
o Database. The database to be updated. Select the required database from the
drop-down list of databases registered in the project and databases from the local
list (if the local list is defined and enabled for use). The DB record contains the
following parameters (comma separated): DB name, DB user name (schema), DB
type (test / production).
o Password of '<schema>' user. The DB user password. For test DB, the password
specified in the Saved password parameter in the editor of the DB access
parameters will be used automatically. If a certain DB (test or production) has been
already connected during the current user session, the last used password will be
automatically used for the next connection.
o Show all databases. If the flag is not set, the drop-down list in the Database
parameter contains test databases only. If the flag is set, the list contains all
databases added to the project. By default, the flag is not set if the DB is updated
in the test branch. If the DB is updated in the production branches, the flag is set,
by default.
If the DB does not need to be updated, set the Do not update database flag. The flag
is not set, by default.
The State of Destination Branch area is used to configure the branch the distribution
kit will be sent to:
o Set the Clear destination branch before update flag if necessary. If the flag is
set, all files will be deleted from the destination branch before sending the software
product to the test / production branch. If the flag is not set, the destination
branch will store the files of the software product installed in it. The flag is not set,
by default.
o Validate the data displayed in the table with the list of layers available in the
destination branch and that will be added/deleted. For each layer, the following
information is displayed: current state (the Previous State column) and the state
after the software product is sent to the test / production branch (the New State
column).
Available values of the current state:
o None. The layer is absent in the test / production branch.
o Exist. The layer is present in the branch (the current layer version is specified in
brackets).
Available values of the new state:
o Added. The layer will be added to the branch (the new layer version is specified in
brackets).
o Replaced. The current layer will be replaced with a new one (the new layer version
is specified in brackets).
o Removed. The layer will be deleted from the test / production branch.

RWU - AG.ENG.06.12.2023. 103

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

Update Settings. The command opens the Update Settings dialog box used to set up
the checks to be performed before / after the software product update.
Check. The command is used to perform similar checks for the software product version
being installed as those performed after clicking Next, but with the difference that this
command does switch to the step when the software product is submitted for testing /
production. In particular, the command enables to perform a set of mandatory checks
warning of possible problems during the software product update, and all the checks set
up in the Update Settings dialog box.
Check and Save Log. The command is used to perform similar checks as the Check
command. The only difference is that after the checks are performed, a log file of
standard format is created for the procedure for submitting the software product for
testing/production, but it contains only the general information on the procedure and
the results of the pre-checks performed (further in the course of the procedure,
another file will be created to log the information on the procedure progress). The full
path to the log file is available in the dialog box with the command execution results.
The command can be used, for example, when some errors are detected at the
preparatory step and it is required to generate a log file to be submitted to the Product
Support Service.

After the presettings are made, run the procedure for submitting the software product for
testing / production using the Next button. After clicking Next:
The checks set up in the Update Settings dialog box (at the preparatory step of the
update procedure) are performed automatically. The errors/warnings found are displayed
in a separate dialog box.
The version of the selected DB is checked: if the version of the selected DB is older
than the minimum supported version, the respective error message is displayed to the
user and the update process cannot be continued. This check can also be performed
using the Check command.
The need to restart the RadixWare Server and RadixWare Web Presentation
Server is checked in the course of the software product update procedure. This check
is also performed using the Analyze System Changes command which is recommended
for execution before each update procedure.
Check results are output as information messages and warnings in the Confirmation
dialog box. This step enables to cancel the update procedure (to analyze and fix the
problems found). If check results include critical errors, the update procedure cannot be
continued.

Generally, this procedure consists of the following steps:

1.Licensed Installation. Enter the information on the licensed installation. This step is
present only if the following conditions are met:
Before building the distribution kit for the customer, the vendor has made the
required licensing settings.
RadixWare 2.1.36.x or onwards is being installed.
The user has never entered the information on the licensed installation before.
For details, refer to Licensed Software Product Installation.

104 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

2.Export of 'starter.jar'. This step checks whether the starter.jar file needs to be
updated.
If no update is required, proceed to the next step.

The starter.jar file needs to be updated only if the file contains the critical changes,
and its version is considered outdated. In case of minor changes in the starter.jar
file, the updated version of this file is saved to cache and is further used to run the
software product.

If it is detected that the current version of starter.jar is incompatible with the new
software product version:
Save starter.jar to the directory on the local drive using the Export file button.
Restart the RadixWare Server instances using the rolling restart mechanism.
Perform the following actions for each instance in a sequence:
o Stop the instance
o Update starter.jar used to start the instance
o Start the instance
Make sure that all instances have been restarted successfully.
If the commands used to run the RadixWare Server instances enable to restart
the instances by the OS tools and auto update the starter.jar file (for details, refer
to documents [5] and [4]), and all the requirements for the command settings are
met, the above-listed actions are not required (starter.jar will be updated
automatically when restarting the instances at the After Kernel Files Update
step). Otherwise, these actions are mandatory.

Set the Export of 'starter.jar' and restart of RadixWare Server instances have
been completed flag and proceed to the next step.

It is not possible to proceed to the next step (the Next button is inactive) until
the Export of 'starter.jar' and restart of RadixWare Server instances have
been completed flag is set.

RWU - AG.ENG.06.12.2023. 105

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

3.Export of 'web-app.war'. This step checks whether the web-app.war file needs to be
updated.
If no update is required, proceed to the next step.
If it is detected that the current version of web-app.war is incompatible with the new
software product version:
Save web-app.war to the directory on the local drive using the Export file button.
Update web-app.war used to run the RadixWare Web Presentation Server.
Restart the RadixWare Web Presentation Server.
After the Web server is restarted successfully, set the Export of 'web-app.war'
and restart of RadixWare Web Presentation instances have been completed
flag and proceed to the next step.

It is not possible to proceed to the next step (the Next button is inactive) until
the Export of 'web-app.war' and restart of RadixWare Web Presentation
instances was completed flag is set.

4.For the description of the Execution Plan, Current Sessions and Database
Parameters steps, refer to Updating Database.
7.Before Scripts Execution. This step switches to the DB update procedure.
8.Scripts Execution. This step starts the DB update. At this step, the dialog box shows:
Description of the current step of the update process and recommendations on
further actions
Indicator of the update progress
Show Details / Hide Details button used to show/hide the area with the additional
information on the current step of the update process.
Area containing the detailed information on the update process. All events including
error messages are logged to this area. This information is also written to the scripts
execution log (for details, refer to Scripts Execution Log File).

It is not recommended to interrupt the DB update procedure. In case of any failure,

106 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

the administrator should contact the Product Support Service on the vendor side
and follow the given instructions.

If any problem occurs during the DB update procedure, the RadixWare Manager
displays an error message and offers the following actions:
Abort (a) - abort the procedure
Ignore (i) - ignore the error
Retry (r) - repeat the action that caused the error
The administrator should estimate the situation and make a decision. If the problem
cannot be resolved without assistance, contact the Product Support Service.

If the DB update procedure has been interrupted by the Abort command, the next
update procedure will be started from the interrupted script.

The DB update procedure has the following features:

Access of the SYS user (user with the system privileges) may be required. Before
the update procedure starts, a dialog box is displayed to specify the name and
password of the user with the system privileges.
When updating the DB, the checks set up in the Update Settings dialog box (at the
preparatory step of the software product update procedure) will be performed
automatically.

If errors and warnings are detected during the check, it is recommended to

ignore them and proceed the update procedure. Once the update is completed,
submit the file with the scripts execution log to the Product Support Service.
If the detailed analysis proved that errors and warnings found when checking
the compatibility of the DB structure and metainformation do not need to be
fixed and should be ignored in future (for example, they are not critical and do
not affect the system health), they can be hidden in the check results using
the Configure Database Warnings command.

9.After Scripts Execution. The information tab displays the DB update results. No
changes are required at this step.
10.Before Kernel Files Update. This step checks whether the system kernel needs to be
updated. If the update is required, proceeding to the next step starts the update
procedure. The kernel modifications are loaded to the SVN repository and applied to the
system instances only after the instances are switched to the new kernel version and
restarted (see the next step).
11.After Kernel Files Update. This step switches the instances to the new kernel
version. Perform the following actions:
Restart the RadixWare Server instances using the Rolling Restart of Server
Instances command which needs to be executed in the RadixWare Explorer. The
user executing this command should be granted the administrator rights. Depending
on the recommendations output in the Description field, rolling restart may be
required for:
o All system instances
o Instances with the ARTE pool only

RWU - AG.ENG.06.12.2023. 107

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

If, for some reason, the capabilities to restart the instances by the OS tools and
auto update the starter.jar file are not enabled for the commands used to run the
RadixWare Server instances (for details, refer to documents [5] and [4]), the
instances should be restarted manually.

Restart the RadixWare Web Presentation Server.

Make sure that all RadixWare Server and RadixWare Web Presentation Server
instances have been restarted successfully, set the All instances of RadixWare
Server and RadixWare Web Presentation Server have been restarted flag or
Instances of RadixWare Server with ARTE pool and all instances of RadixWare
Web Presentation Server have been restarted flag and proceed to the next
step.

It is not possible to proceed to the next step (the Next button is inactive) until
the All instances of RadixWare Server and RadixWare Web Presentation
Server have been restarted flag or Instances of RadixWare Server with ARTE
pool and all instances of RadixWare Web Presentation Server have been
restarted flag is set.

12. Before Application Files Update. This step checks whether the application files
need to be updated. If the update is required, proceeding to the next step starts the
update procedure. The modified software product files are loaded to the SVN repository
and applied to the system instances only after the instances are switched to the new
software product version (see the next step).
13. After Application Files Update. This step switches the RadixWare Server
instances to the new application version. Execute the Switch Instances to New
Application Version command. The user executing this command should be granted
the administrator rights.
After all instances have been successfully switched to the new application version, set
the 'Switch to new version of application' command has been executed for all
instances of RadixWare Server flag and complete the update procedure.

It is not possible to complete the procedure (the Finish button is inactive) until the
'Switch Instances to New Application Version' command has been executed
for all instances of RadixWare Server flag is set.

108 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

The result of the successful Build procedure is as follows:

The files of the software product release distributed among the layers are available in
the test / production branch of the project tree.
Notifications of the procedure execution are generated and sent to the users (if the
notification service is set up).

9.5.2 Updating Database

Before modifying the database structure or before updating the software

product (if the update procedure implies the database structure modification),
backup the database.

Database Update Procedure

The update procedure for the test and production databases is the same.
1.Start the DB update procedure using the Update in Database command available in
the context menu of:
test branches
production branches
distribution kits received from the vendor and loaded to the Distribution Kits |
<Product> branch (the command is available if the project is set up for own
development)
2.Define the DB connection parameters in the Update in Database dialog box:
Database. Select the required DB from the drop-down list. The DB record contains
the following parameters (comma separated): DB name, DB user name, DB type.
'<sys_user> as sysdba' password. The password of the user with the system
privileges (SYS). The SYS user password may be required if the update scripts
contain the commands for connecting the user with the system privileges to the DB

(as sysdba). The user is set up in a special dialog box opened by command.
Password of '<schema>' user. The DB user password. For test DB, the password
specified in the Saved password parameter in the editor of the DB access

RWU - AG.ENG.06.12.2023. 109

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

parameters will be used automatically. If a certain DB (test or production) has been

already connected during the current user session, the last used password will be
automatically used for the next connection.
Show all databases. If the flag is not set, the drop-down list contains test
databases only (the Database parameter). If the flag is set, the list contains all
databases added to the project. By default, the flag is not set if the DB is updated in
the test branches. By default, the flag is set if the DB is updated in the production
branches.
When updating the database to the distribution kit with the TEST status, it is
recommended to perform the update procedure on the test database first (database
with the Test attribute). To update the production database to the test distribution
kit, the user confirmation is required.
Update Settings. The command opens the Update Settings dialog box used to set
up the checks to be performed before / after the DB update.
Check. The command is used to perform similar checks for the software product
version being installed as those performed after clicking Next, but with the
difference that this command does switch to the next step. In particular, the
command enables to perform a set of mandatory checks warning of possible
problems during the DB update , and all the checks set up in the Update Settings
dialog box.
Check and Save Log. The command is used to perform similar checks as the Check
command. The only difference is that after the checks are performed, a log file of
standard format is created for the procedure for updating the DB, but it contains
only the general information on the procedure and the results of the pre-checks
performed (further in the course of the procedure, another file will be created to log
the information on the procedure progress). The full path to the log file is available
in the dialog box with the command execution results. The command can be used,
for example, when some errors are detected at the preparatory step and it is
required to generate a log file to be submitted to the Product Support Service.

3.Complete all preparatory steps of the DB update procedure in the Update in Database
dialog box:
The left part of the dialog box displays the list of steps (the current step is in bold).
The right part contains the update parameters.

110 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

The table below lists the preparatory steps and parameters:

Step Description

Execution The RadixWare Manager displays the following information:

Plan
Source release. The number of the source release.
Target release. The number of the release to be installed.
Packages. The tab displays the version transition plan.
Scripts. The tab displays the scripts execution plan for bringing the database
structure in compliance with the release being installed.

Current The current database sessions:

Session
users connected to the database
names of workstations
applications the database is connected from

Database If the software product layer settings (in the RadixWare Designer application)
Parameters contain new parameters added for the type of the database being updated (for
details, refer to document [9]), the Database Parameters step will be available
before the DB update to specify how these new DB parameters will be used.

To switch between the steps in the Update in Database dialog box, use the Next and
Back buttons. To complete the preparatory steps of the database update procedure,
click the Finish button; to cancel the procedure, click the Cancel button.
4.Supervise the database update procedure.

It is strongly recommended not to interrupt the database update procedure. In case

of any failure, contact the Product Support Service on the vendor side and follow
the given instructions.

If any problem is detected during the database update procedure, the RadixWare
Manager displays an error message and offers the following actions: interrupt the
procedure, ignore the error, repeat the action that caused the error (refer to
Processing Errors). Estimate the situation and make a decision. If the problem
cannot be resolved without assistance, contact the customer support service.

During the database update procedure, the RadixWare Manager automatically

creates a file with the scripts execution log that contains all events including error
messages.

If the DB update procedure is not completed, the dialog box containing the following
buttons is displayed:
Ignore. Ignores the errors.
Abort. Interrupts the update procedure.

5.After the procedure is completed, it is recommended to send the scripts execution log
file to the vendor.

RWU - AG.ENG.06.12.2023. 111

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

9.5.3 "Update Settings" Dialog Box

When installing / updating the software product, the RadixWare Manager performs a set
of standard checks enabling to detect possible problems in the software product
operation after the update / installation procedure is completed. These checks are set up
in the Update Settings dialog box that is invoked using the same-name command.

The button of the Update Settings command ( ) is available:

in the Build dialog box with the preparatory steps of the software product installation
procedure invoked when submitting the software product for testing / production
(hereafter, Build dialog box on the software product installation).
in the Build dialog box with the preparatory steps of the software product update
procedure invoked when submitting the software product for testing / production
(hereafter, Build dialog box on the software product update).
in the dialog box used to execute the Install to Database command.
in the dialog box used to execute the Update in Database command.

112 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

The dialog box contains the following flags used to enable / disable the respective
checks:

The checks that should not be disabled during the update procedure are marked with
"*". If any of the checks is disabled, a respective warning will be displayed to the user
before submitting the software product for testing / production (after clicking Next in
the dialog box with the preparatory steps), and for the Install to Database / Update
in Database commands - immediately prior to the software product installation to the
DB / DB update. The appearance of the Update Settings button will be changed to

Replication area:
o Synchronize replicas. If the flag is not set, when installing the software product
(at the step of updating the files in the SVN repository), the replicas will not be
synchronized, but after the update is completed, the user will be prompted to start
the replication. The flag is available if the repository replication is set up in the
project. The flag is set, by default.
Binary Compatibility area:
o Check binary compatibility before update. If the flag is set, the binary
compatibility check of the software product layers installed in the test branch and
those being loaded from the distribution kit will be performed before the software
product is submitted for testing / production. The flag is not set, by default.
The area is not available in the dialog boxes used to execute the Install to Database
/ Update in Database commands.
User-Defined Functions area:
o Check user-defined functions before update. If the flag is set, the user-defined
functions from the specified DB (Destination Database area) will be checked for
compatibility with the software product version being installed before the software
product is submitted for testing / production. The flag is set, by default.

If user-defined functions are used in the system, it is not recommended to disable

this check.
For details, refer to Checking User-Defined Functions during Update
Installation.

o Path to external jar files. The parameter is used to specify the path to the folder
with jar files in which the classes will be searched for when compiling the user-
defined functions, and which are absent in the software product distribution kit (in
the RadixWare Server and RadixWare Explorer, the startup parameter -
udsBuildPath is used for this purpose). The parameter is used if the Check user-
defined functions before update flag is set.
The area is not available in the Build dialog box used when installing the software
product and in the dialog boxes used to execute the Install to Database / Update in
Database commands.

RWU - AG.ENG.06.12.2023. 113

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

Validate Database Objects area:

o Validate database objects before update*. If the flag is set, the invalid DB
objects (from the DB point of view) will be searched for before submitting the
software product for testing / production (or before updating the DB - if the Update
in Database command is executed); if such objects are found, they will be
recompiled. The flag is set, by default.
The flag is not available in the Build dialog box used when installing the software
product and in the dialog box used to execute the Install to Database command.
o Validate database objects after update*. If the flag is set, the invalid DB objects
(from the DB point of view) will be searched for after the software product is
installed to the DB / DB is updated; if such objects are found, they will be
recompiled. The flag is set, by default.
Database Structure area:
o Check consistency of database structure and metainformation before
update*. If the flag is set, the consistency of the DB structure and
metainformation of the software product being installed will be checked before
submitting the software product for testing / production. The flag is set, by default.
The flag is not available in the Build dialog box used when installing the software
product and in the dialog boxes used to execute the Install to Database / Update
in Database commands.
o Check consistency of database structure and metainformation after update*.
If the flag is set, the consistency of the DB structure and metainformation of the
software product being installed will be checked after the software product is
installed to the DB / DB is updated. The flag is set, by default.
Rights area:
o Check user rights and role rights before update*. If the flag is set, the presence
of the DB user rights to the required DB entities will be checked before submitting
the software product for testing / production. If the required rights are missing, the
dialog box with the check results will contain the respective warning and
automatically generated script enabling to grant the missing rights. For details, refer
to Granting Missing Rights to DB Entities. The flag is set, by default.
The flag is not available in the Build dialog box used when installing the software
product and in the dialog boxes used to execute the Install to Database / Update
in Database commands.
o Check user rights and role rights after update*. If the flag is set, the presence
of the DB user rights to the required DB entities will be checked after submitting the
software product for testing / production. If the required rights are missing, the
respective warning will be displayed with the automatically generated script enabling
to grant the missing rights. For details, refer to Granting Missing Rights to DB
Entities. The flag is set, by default.
The flag is not available in the dialog boxes used to execute the Install to
Database / Update in Database commands.

114 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

Viewing Check Results

Such checks as "...before update" set up in the Update Settings dialog box are started
immediately prior to submitting the software product for testing / production (or prior to
the DB update procedure - if the Update in Database command is executed), i.e. after
clicking Next in the dialog box with the preparatory steps. If errors / warnings are found
in the course of these checks, they will be output in a separate dialog box. This step
enables to cancel the software product installation procedure (to analyze and fix the
problems found):

Such checks as "...after update" set up in the Update Settings dialog box are started
after the software product is installed to the DB / DB is updated (depending on the
procedure being executed). This step does not enable to cancel the procedure. The
problems detected can be analyzed and fixed after the software product is installed /
updated (for the Install to Database / Update in Database commands - after the
software product is installed to the DB / DB is updated respectively).

RWU - AG.ENG.06.12.2023. 115

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

Messages with the check results can contain recommendations on how to fix the problems
detected, or scripts to be executed. Refer to, for example, Granting Missing Rights to
DB Entities.

Recommendations for Check Settings on Software Product Update

When updating the software product, it is not recommended to disable the checks marked
in the Update Settings dialog box as mandatory (with "*" character). However, these
checks may increase the update installation time, which, in turn, may affect the
downtime of the production system only if the system is updated when it is completely
stopped. When setting up the checks, the recommendations listed below should be
followed:
If the DB can be updated when the system is running (without stopping the application
server completely) and will be updated this way (this possibility can be checked
beforehand using the Analyze System Changes command), it is not recommended to
disable the checks since they will not affect the system operation. Some additional
checks can be performed beforehand in order to analyze and fix the problems, if found,
routinely but not directly during the update procedure.
If it is planned to stop the system completely, the checks can be skipped in the course
of the main update procedure to reduce the system downtime, but they are still
mandatory and can be performed manually before and after the update.
The pre-checks BEFORE the update procedure can be performed using the Check
command available in the Build dialog box with the preparatory steps of the update
procedure. Before executing the command, make sure that all mandatory checks are
enabled in the Update Settings dialog box.
The checks AFTER the update procedure can also be performed using the Check
command available in the Build dialog box with the preparatory steps of the update
procedure. The Build dialog box should be opened as when installing the update (using
the same command in the same branch). Before executing the Check command, make
sure that all mandatory checks are enabled in the Update Settings dialog box.

116 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

9.5.4 Granting Missing Rights to DB Entities

When submitting the software product for testing/production, the check for the rights of
the DB user to the required DB entities is performed. Depending on the values of the flags
in the Rights area in the the Update Settings dialog box, this check can be started
before the procedure for submitting the software product for testing/production and/or in
the course of this procedure (after the software product is installed to the DB / the DB is
updated).
If the missing rights are detected during the check, the Insufficient Rights dialog box is
displayed. This dialog box contains:
Area with the list of missing rights for each software product layer.
Area with the SQL script generated by the application automatically. This script is used
to grant the missing rights. To hide/unhide this area, use the Show sql script/Hide sql
script button.
Commands to work with the script:
o Copy Sql. Copies the generated SQL script to clipboard.
o Save Sql. Saves the script to a file of the SQL format.
o Execute SQL. Runs the script directly from the RadixWare Manager under the
user with the system privileges.
For mandatory rights, the dialog box shows Warning messages; for optional rights -
Information messages. For mandatory rights, it is recommended to run the generated
script in the course of the update procedure or immediately after it in any convenient way
(directly in the RadixWare Manager application or by copying/saving the script to a file)
under the user with the system privileges (SYS) or under the user who is assigned the
rights to grant privileges to other users. Optional rights can be granted later.

The system role PUBLIC often has missing rights. In this case, the check results will
contain warnings, but this will not lead to real errors in the system operation.
However, it is recommended to explicitly grant the missing rights to the user and
associated *_RUN_ROLE role (instead of granting the PUBLIC role – in this case, it will
be further necessary to control the presence of the required rights in the PUBLIC role)
by executing the scripts generated by the RadixWare Manager.
The rights can also be granted after the update is installed.

RWU - AG.ENG.06.12.2023. 117

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

9.5.5 Checking User-Defined Functions during Update Installation

If user-defined functions are used in the system, it is required to check the functions for
compatibility with the new version of the software product when installing the update:
1.Verify that the lists of user-defined functions and the software product version on both
test and production systems match.
2.When installing the update on the test / production system, check whether the user-
defined functions set up in the current version are compatible with the new version
ofsoftware product. This check is performed at the preparatory step before the
software product is submitted for testing / production if the Check user-defined
functions before update flag is set in the Update Settings dialog box.

For the compatibility check to be performed correctly in software product, take into
account the recommendations for the memory allocated for the RadixWare
Manager (specified in the Xmx JVM parameter): the recommended memory size is
2G; minimum value required to start the check is 1G. For 64-bit Windows and Linux
OS (regardless of the capacity), the default memory size (-Xmx2048m) is in
compliance with the recommendations, for 32-bit Windows OS, the default value is -
Xmx690m - therefore, it is recommended to increase this value. For details on the

118 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

memory settings and default values, refer to Appendix. Memory Allocated for
RadixWare Manager.

When the compatibility check is performed, the system:

Searches for errors related to the modification of API or function profile in the new
software product version.
Controls whether the user-defined functions are compatible with the new software
product version - checks whether the new software product version being installed is
in the range of compatible versions of the user-defined function (the compatible
versions are specified in the editor of the user-defined function using the Set
Compatible Versions command).

The check results are provided in a separate dialog box and are duplicated in the
Output dialog box. The log file with the check results is saved to the directory
specified in the Details Log Directory parameter (editor of the project settings |
Directories tab).
3.If errors are detected during the check:
Cancel the update installation procedure.
Fix the errors.
Check the functions for compatibility again and, if no errors and warnings appear,
continue the update installation.
4.If some compatibility errors have been detected and fixed on the test system, make the
similar changes to the production system. The respective changes can be made
manually or using the export / import mechanisms (to export from the test system and
import to the production one, xml files or configuration packages are used).
5.Before the software product is put into production, it is recommended to perform the
same check on the production system (see steps 2-3) to ensure that no errors that
were not detected on the test system are present.

This check may slightly increase the time of the update installation which, in turn,
may increase the downtime of the production system only if the update is installed
on the system which is stopped completely. In this instance, it is recommended to
measure the time of the update installation on the test system (with the same set
of user-defined functions). If the update procedure takes much time, the
compatibility check can be performed before the update is installed (using the
Check User-Defined Functions command of the context menu). If the time of the
update installation on the test system is acceptable, these recommendations may
be ignored.

Checking User-Defined Functions before Update Installation

In some instances (for example, if the update is installed on the system which is
completely stopped), it is recommended to perform the compatibility check beforehand
(after the update package is loaded but before it is submitted for testing / production).
For this, it is possible to use:
Check command available in the Build dialog box used at the preparatory steps of the
software product update procedure.

RWU - AG.ENG.06.12.2023. 119

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

Check User-Defined Functions command available in the context menu of the

following branches:
o test branches
o production branches
o distribution kits received from the vendor and loaded to the branch Distribution
Kits | <Product>
o release branches of the distribution kits received from the vendor and loaded to the
branch Distribution Kits | <Product>
o release branches (it is available only if the project is configured for development).

"Check User-Defined Functions" Command

To check whether the functions in the required DB are compatible with those provided in
the latest distribution kit from the vendor and loaded to the branch Distribution Kits |
<Product>, the Check User-Defined Functions command needs to be executed from
the context menu of the distribution kit loaded.
Executing the command opens the dialog box with the following parameters:

Choose branch. The branch with the software product release version to update to
and compare the functions of the current version with. The default value is the branch
in which the command is started.
Choose database. The database with the current software product version. The user-
defined functions set up in this DB will be checked for compatibility with the new
software product version (version available in the branch specified in the Choose
branch parameter). The parameter is defined in the dialog box containing the following
parameters:
o Database. The value is selected from the drop-down list containing the databases
registered in the project and databases from the local list (if the local list is defined
and enabled for use).
o Password of '<schema>' user. The password of the DB user. For the test DB, the
password specified in the Saved password parameter in the editor of the DB
access parameters will be used automatically. If a certain DB (test or production)
has been already connected during the current user session, the last used password
will be automatically used for the next connection.

120 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

Save report to file. The text file to save the check results to. The value is set in a
standard dialog box used to save files.
Path to external jar files. The path to the folder with jar files in which the classes will
be searched for when compiling the user-defined functions, and which are absent in the
software product distribution kit (in the RadixWare Server and RadixWare Explorer,
the -udsBuildPath startup parameter is used for this purpose). Third-party libraries are
not always used and, therefore, the parameter is optional.
The check results are saved to the specified file and are duplicated in the Output dialog
box.

9.5.6 Analyzing System Changes

The RadixWare Manager application enables to retrieve the information on actions to be

performed when updating the software product release version. For this purpose, execute
the Analyze System Changes command available in the context menu of:
test branches
production branches
distribution kits received from the vendor and loaded to the Distribution Kits |
<Product> branch
releases and development branches (the branches are displayed if the project is set up
for development)

Some of the checks performed using the command are also performed after starting the
procedure for submitting the software product for testing/production (i.e. after clicking
Next in the Build dialog box with the preparatory steps of the procedure). In particular,
the need to restart the RadixWare Server and RadixWare Web Presentation Server
in the course of the software product update procedure is checked.

RWU - AG.ENG.06.12.2023. 121

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Updating Software Product

The command execution dialog box contains the following parameters:

Choose first branch. The branch where the new version of the software product will
be transferred to or compared with, for example, the test branch. If the command is
invoked in the branch for which the branch with the previous software product version
is found, the branch found is used as a default value for this parameter.
Choose second branch. The branch containing the release version the software
product will be updated to. The value used by default is the branch in which the
command is invoked. In most cases, it is recommended to specify the last distribution
kit received from the vendor and loaded to the Distribution Kits | <Product> branch
(invoke the command from the context menu of this distribution kit).
After the branches are defined, the Changes field will show the information on the
system changes that will be applied when the software product version from the first
branch will be updated to the software product version from the second branch:
information on the changes in the application server files and web server files
information on the updated starter.jar and webapp.war files
information on the update scripts compatibility
information on the changes in the hierarchy of software product layers
information on the need to restart the RadixWare Server instances.

9.6 Managing Software Product Configuration in

Environments and Landscapes
The RadixWare-based software products support the configuration management
mechanism enabling to deploy configurations in the test and production environments.
The system configuration is a set of configuration settings made in the development
environment of the configuration vendor in configuration segments and supplied as
configuration packages. The configuration is developed in the RadixWare Explorer.
The configuration packages developed by the vendor are downloaded from the
development environment of the vendor:
optionally - to the development environment of the customer (DEV)
to the build environment of the customer (REF) in which a reference configuration is
created.

After the reference configuration is built in the customer environment (REF), it is

recommended to further deploy it in the test and production environments by
transporting configuration snapshots.

The configuration management mechanism in the RadixWare Manager uses the following
objects:
Environment. A system in which the configuration is developed, stored, tested, and
used. The configuration is developed by the vendor in one or several development
environments (source environment with DEV role). The customer can use several
environments (optionally) to develop, build, test and use configurations. Each
environment uses a separate DB schema and branch of the SVN repository (for test or
production - depending on the environment role). The RadixWare Manager enables to
manage the list of environments and their attributes, to update the software product
versions in the branches used by the environments, and to transport the configuration

122 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

packages and snapshots between the environments. For the automatic transfer of
configuration changes between the environments using configuration packages /
snapshots it is possible to use the commands of the console version of the RadixWare
Manager. For details, refer to Managing List of Environments, Operations on
Environments and Console Application Commands to Manage Configurations.
Landscape. An object that combines several environments, where each environment
plays a certain role. The RadixWare Manager enables to manage the list of
landscapes, to add / remove environments to / from the landscape. For details, refer to
Setting Up Landscapes.

Objects necessary to work with environments and landscapes (Environments and

Landscapes branches) are created:
Automatically when creating a project (if the version of the RadixWare Manager is
1.2.11.30.x and onwards).
When starting the RadixWare Manager v.1.2.11.30.x and onwards for the first time
(after the RadixWare Manager has been updated from v.1.2.11.29.x and
downwards): when opening the existing project, a message offering to modify the
SVN repository structure is displayed to the user. This can be also done later by
using the Validate command available in the context menu of the main project
branch.

9.6.1 Managing List of Environments

To manage the list of environments and their attributes, go to the Environments editor.
The editor can be opened by:
double-clicking on the project branch Environments
using the Configure command in the context menu of the Environments editor.

RWU - AG.ENG.06.12.2023. 123

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

When opening the editor, the following dialog box is displayed in the application working
area:

The editor contains the following elements:

Environments. The area contains the list of environments.
To manage the list, use the Add, Remove, Up and Down buttons. To edit the
parameters of the selected environment, go to the Environment Attributes area.
Environment Attributes. The area is used to define the parameters of the
environment selected in the Environments list:
o Name. The environment name.
o Role. The environment role within the landscape. Available values:
DEV. The development environment. It can be used to load the configuration
received from the vendor and/or to develop own configuration by the customer.
REF. The build environment. This reference environment can be used to load the
configuration received from the vendor, and to transfer the configuration to the
test / production environment.
QA1, QA2, QA3. The test environments.
PROD. The production environment.
o Type. For standard systems in which two equivalent databases are not used (not
AADC systems), this parameter should be set to Standalone.
o Branch. The repository branch associated with the environment. This branch stores
the software product files to be used in the environment. The value is selected from

124 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

the list of branches defined in the project (available in the Branches branch of the
project navigation tree). Using the respective button, it is possible to create a new
branch and link it to the current environment. For details on the dialog box used to
create a branch, refer to the description of the Create Branch command.
For environments with the PROD role, it is necessary to specify the production
branch. For other environments, it is possible to specify only test branches. The
environment role and selected branch are checked for compliance when saving the
changes in the environment editor.
o SCP name. The AAS client profile. The access to AAS is required to execute
different operations within the environments without starting the RadixWare
Explorer, in particular, to connect to the RadixWare Server when executing the
Configuration Package | Transport From... command of the environment or when
executing the console application commands.
o Database. The database to be used by the environment. Select the required
database from the drop-down list of databases registered in the project. The DB
record contains the following parameters (comma separated): DB name, DB user
name (schema), DB type.
Each DB can be used by one environment only.

To view the information on the current version of the DB used by the environment,
version of the software product layers in the branch associated with the environment,
use the editor that can be opened by double-clicking on the branch Environments |
<Environment> or Landscapes | <Landscape> | <Environment>.

9.6.2 Operations on Environments

Main actions on the environments (updating environments and transporting configuration

segments / snapshots between them) are executed using the commands available in the
context menu of the environment. The commands are called from:
context menu of the environment in the branch Environments | <Environment>
context menu of the environment in the branch Landscapes | <Landscape> |
<Environment>
context menu of the environment selected in the landscape editor.
The context menu of the environment includes the following specific commands
(commands common for different branches of the project navigation tree are described in
Project Commands):

Command Description

Read Connects to the DB of the selected environment to retrieve the additional

Database(s) information on this environment. When executing the command, the DB user
password is requested.
The command is available only in the context menu of the environment selected in
the landscape editor (unavailable in the context menu of the navigation tree), and
only if the DB of the selected environment has not been connected yet during the
current session.

RWU - AG.ENG.06.12.2023. 125

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

Command Description

Application Core Starts the update of the environment from the loaded distribution kit.
| Build from
When executing the command, the standard dialog box Build Branch
Distribution Kit
'<BranchName>' is displayed, in which it is necessary to undergo the standard
procedures for the software product installation (if the branch used by the
environment does not contain the software product files) or update (if the branch
contains the software product files). In the dialog box:
In the Available Products area, in the Select release row, the last
distribution kit successfully loaded to the software product directory is specified,
by default.
DB to be updated is predefined: in the Destination Database area, the DB
used by the environment is specified automatically. It is prohibited to modify the
DB being updated.
Branch to be updated is predefined: in the Destination Branch State area,
the branch associated with the current environment is specified.
In all other respects, the environment update procedure is similar to the standard
procedures for submitting the software product for testing / production during the
installation / update.

Application Core Starts the update of the current (target) environment from
| Build from <EnvironmentName> (source environment). The list of available source
Environment | environments is generated as follows:
<EnvironmentNa
If the command is called in the branch Environments | <Environment>, the
me> (branch
list includes all environments defined in the project.
'<BranchName>')
If the command is called in the landscape, the list contains only the
environments included in this landscape.
When executing the command, the standard dialog box Build Branch
'<BranchName>' is displayed, in which it is necessary to undergo the standard
procedures for the software product installation (if the branch used by the
environment does not contain the software product files) or update (if the branch
contains the software product files). In the dialog box:
The Available Products area is unavailable. When updating the target
environment, the changes from all layers of the branch associated with the
source environment are copied to it.
DB to be updated is predefined: in the Destination Database area, the DB
used by the target environment is specified automatically. It is prohibited to
modify the DB being updated.
Branch to be updated is predefined: in the Destination Branch State area,
the branch associated with the target environment is specified.
Clear destination branch before update flag in the Destination Branch
State area is set, by default, and is not editable. Thus, before the update is
performed, the branch associated with the target environment is always
cleared.
In all other respects, the environment update procedure is similar to the standard
procedures for submitting the software product for testing / production during the
installation / update.

126 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

Command Description

Configuration Transports the configuration packages from the source environment to the current
Package | (target) environment. Executing the command opens the dialog box in which it is
Transport From... necessary to select:
Source environment. The value is selected from the list of environments that is
generated with regard to the context in which the command is called:
o If the command is called in the branch Environments | <Environment>,
the list includes all environments defined in the project.
o If the command is called in the landscape, the list contains only the
environments included in this landscape.
Configuration segment. The value is selected from the list of segments of the
selected source environment whose status is Trunk and Offshoot.
All packages absent in the target environment (starting from the package with the
minimum version) are transported sequentially from the specified segment of the
source environment to the respective segment of the target environment. The
packages are assigned the Imported status. If the appropriate segment is absent
in the target environment, the command is completed with an error.

Configuration Transports the configuration snapshot from the source environment to the current
Snapshot | (target) environment. Executing the command opens the dialog box in which it is
Transport From... necessary to select:
Source environment. The value is selected from the list of environments that is
generated with regard to the context in which the command is called:
o If the command is called in the branch Environments | <Environment>,
the list includes all environments defined in the project.
o If the command is called in the landscape, the list contains only the
environments included in this landscape.
Configuration snapshot. The value is selected from the list of snapshots of the
selected source environment that are absent in the target environment.
The snapshot imported from the source to the target environment is assigned the
Imported status.

Delete from Removes the selected environment from the landscape.

Landscape
The command is available only in the context menu of the environment selected in
the landscape editor (unavailable in the context menu of the navigation tree).

9.6.3 Setting Up Landscapes

To set up landscapes, go to the Landscapes editor. The editor can be opened by:
double-clicking on the project branch Landscapes
using the Configure command in the context menu of the Landscapes editor.

RWU - AG.ENG.06.12.2023. 127

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

When opening the editor, the following dialog box is displayed in the application working
area:

128 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

The editor contains the following elements:

Landscapes. The area contains the list of landscapes.
To manage the list, use the Add, Remove, Up and Down buttons.
Landscape Attributes. The Name parameter in this area is used to specify the name
of the landscape selected in the Landscapes list.
Environments. The area contains a graphic editor used to generate a list of
environments to be included in the landscape selected in the Landscapes list. Each
environment is presented as a box (see the screenshot above) containing the following
information:
o Environment name
o Environment role. Environments with different roles are indicated by different colors
and have different positions:
At the top of the editor - environments with the DEV role.
Below - environments with the REF role. Only one environment with this role can
exist within the landscape.
Below - QA1, QA2, QA3 environments. Only one environment with each of the
roles can exist within the landscape.
At the bottom of the editor - environments with the PROD role. Only one
environment with this role can exist within the landscape.
o Version of the top-most layer of the software product located in the test /
production branch associated with the environment.
o Information on the configuration segments present in the environment. For each
segment, the version of the last configuration package in one of the following states
is provided: Development, Released, Applied.
o Information on the snapshot last assigned the Applied state including the name of
the source system, snapshot name and creation date / time. If no snapshots in the
Applied state are present in the environment, the information on the last created
snapshot is displayed (in the graphic editor, the respective record is put in italics).
To add / remove the environment to / from the landscape, use the commands Add

Environment ( ) / Remove from Landscape ( ). One environment can be

included in several landscapes.
To refresh the information on the environments included in the landscape, use the

Refresh Environments command ( ). The information on the configuration

packages and environment snapshot is requested from the DB, so the DB connection is
required to execute the command. When connecting to the DB, it may be required to
enter the DB user password (if the DB password has not been requested yet during the
current user session or the password is not saved in the editor of the DB access
parameters (for test DB only)).

9.6.4 Console Application Commands to Manage Configurations

The configuration management commands available for execution in the console version of
the RadixWare Manager and list of arguments available for each command are
presented in the table below:

RWU - AG.ENG.06.12.2023. 129

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

When using the commands listed below with the PostgreSQL DB, it is necessary to
install the pgsql-http extension. For details, refer to Installing PostgreSQL on DB
Server.

Command Description Arguments Example

CMD_CFG_ Applies the configuration Mandatory arguments: CMD_CFG_APPLY_SEGM

APPLY_SEGMENT_ package of the specified ENT_VERSION
PROJECT_DIR
VERSION version in the specified PROJECT_DIR=c:/
segment, and: ENVIRONMENT_NAME ProjectDir
CFG_SOURCE_SEGMENT_ID ENVIRONMENT_NAME=e
The package is
nv2 DB_PWD=dbPwd
checked. CFG_PACKAGE_VERSION CFG_SOURCE_SEGMEN
If the package is not APP_USER T_ID=21
accepted, it will be CFG_PACKAGE_VERSIO
accepted. Optional arguments: N=1
The package items are DESTINATION_FILE_PATH DESTINATION_FILE_PA
loaded to the DB. TH=c:/files/
CONFIG_FILE reportCheck.html
The package state is DB_PWD APP_USER=TESTUSER
changed to Applied.
SVN_PWD
Return values: DATABASE_DRIVER_PATH
0. The command is One of the following
executed successfully. arguments:
1. Warnings detected QUESTION_YES_ALL
during the command
QUESTION_NO_ALL
execution.
QUESTION_YES_SPECIFIC
255. An exception
occurred during the QUESTION_NO_SPECIFIC
command execution. LOCAL_LOG_DIR
TIMEOUT
The command execution
result (including One of the following
warnings) is saved to the arguments:
report (path to the DB_WALLET_DIR_NAME
report file is defined in
the DB_WALLET_PATH
DESTINATION_FILE_PAT DB_WALLET_PWD
H argument; file format
is HTML). If an exception
is thrown during the
command execution, the
execution process is
terminated (the reason
for the exception is
written to the command
execution log, HTML
report is not generated).
In the RadixWare
Explorer, this command
corresponds to the
Apply command of the
configuration package.

130 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

Command Description Arguments Example

CMD_CFG_APPLY_ Applies the specified Mandatory arguments: CMD_CFG_APPLY_SNAP

SNAPSHOT configuration snapshot. SHOT
PROJECT_DIR
When executing the PROJECT_DIR=c:/
command, the snapshot ENVIRONMENT_NAME ProjectDir
state is changed to CFG_SNAPSHOT_TIMESTAMP ENVIRONMENT_NAME=e
Applied. nv2 DB_PWD=dbPwd
APP_USER CFG_SNAPSHOT_TIMES
Optional arguments: TAMP=2020-07-
Before the snapshot is
15_15:36:01
applied, it is first CFG_CREATE_NEW_OBJECTS CFG_CREATE_NEW_OBJ
accepted. _ON ECTS_ON
In the RadixWare CFG_UPDATE_EXISTING_OBJ CFG_UPDATE_EXISTIN
Explorer, this command ECTS_ON G_OBJECTS_ON
corresponds to the CFG_DELETE_SURPLUS
Apply command of the CFG_DELETE_SURPLUS_OBJE _OBJECTS_ON
configuration snapshot. CTS_ON APP_USER=TESTUSER
CONFIG_FILE
When executing the DB_PWD
command, it is not SVN_PWD
possible to modify
configuration objects. DATABASE_DRIVER_PATH
One of the following
arguments:
QUESTION_YES_ALL
QUESTION_NO_ALL
QUESTION_YES_SPECIFIC
QUESTION_NO_SPECIFIC
LOCAL_LOG_DIR
TIMEOUT
One of the following
arguments:
DB_WALLET_DIR_NAME
DB_WALLET_PATH
DB_WALLET_PWD

CMD_CFG_ Checks the configuration Mandatory arguments: CMD_CFG_CHECK_SEG

CHECK_SEGMENT package of the specified MENT_VERSION
PROJECT_DIR
_VERSION version in the specified PROJECT_DIR=c:/
segment. ENVIRONMENT_NAME ProjectDir
CFG_SOURCE_SEGMENT_ID ENVIRONMENT_NAME=e
Return values: nv2 DB_PWD=dbPwd
CFG_PACKAGE_VERSION CFG_SOURCE_SEGMEN
0. The check is
APP_USER T_ID=21
performed
CFG_PACKAGE_VERSIO
successfully (no errors Optional arguments:
N=1
and warnings
DESTINATION_FILE_PATH DESTINATION_FILE_PA
detected).
TH=c:/files/
1. Warnings detected CONFIG_FILE reportCheck.html
during the command DB_PWD APP_USER=TESTUSER
execution.
SVN_PWD
255. An exception
occurred during the DATABASE_DRIVER_PATH
command execution. One of the following
arguments:
QUESTION_YES_ALL
QUESTION_NO_ALL

RWU - AG.ENG.06.12.2023. 131

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

Command Description Arguments Example

The check result QUESTION_YES_SPECIFIC

(including warnings) is
QUESTION_NO_SPECIFIC
saved to the report (path
to the report file is LOCAL_LOG_DIR
defined in the TIMEOUT
DESTINATION_FILE_PAT
H argument; file format One of the following
is HTML). If an exception arguments:
is thrown during the DB_WALLET_DIR_NAME
command execution, the
execution process is DB_WALLET_PATH
terminated (the reason DB_WALLET_PWD
for the exception is
written to the command
execution log, HTML
report is not generated).
In the RadixWare
Explorer, this command
corresponds to the
Check command of the
configuration package.

CMD_CFG_ Checks the specified Mandatory arguments: CMD_CFG_CHECK_SNA

CHECK_ configuration snapshot. PSHOT
PROJECT_DIR
SNAPSHOT PROJECT_DIR=c:/
ENVIRONMENT_NAME ProjectDir
In the RadixWare
Explorer, this command CFG_SNAPSHOT_TIMESTAMP ENVIRONMENT_NAME
corresponds to the APP_USER =env2 DB_PWD=dbPwd
Check command of the CFG_SNAPSHOT_TIM
configuration snapshot. Optional arguments: ESTAMP=2020-07-
CFG_CREATE_NEW_OBJECTS 15_15:36:01
_ON CFG_CREATE_NEW_OBJ
CFG_UPDATE_EXISTING_OBJ ECTS_ON
ECTS_ON CFG_UPDATE_EXISTI
CFG_DELETE_SURPLUS_OBJE NG_OBJECTS_ON
CTS_ON CFG_DELETE_SURPLUS
_OBJECTS_ON
CONFIG_FILE
APP_USER=TESTUSE
DB_PWD R
SVN_PWD
DATABASE_DRIVER_PATH
One of the following
arguments:
QUESTION_YES_ALL
QUESTION_NO_ALL
QUESTION_YES_SPECIFIC
QUESTION_NO_SPECIFIC
LOCAL_LOG_DIR
TIMEOUT
One of the following
arguments:
DB_WALLET_DIR_NAME
DB_WALLET_PATH
DB_WALLET_PWD

132 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

Command Description Arguments Example

CMD_CFG_ Creates a configuration Mandatory arguments: CMD_CFG_CREATE_SN

CREATE_ snapshot in the specified APSHOT
PROJECT_DIR
SNAPSHOT environment. PROJECT_DIR=c:/
ENVIRONMENT_NAME ProjectDir
APP_USER ENVIRONMENT_NAME=e
The snapshot creation
nv1 DB_PWD=dbPwd
time is written to the Optional arguments:
CFG_LOCK_TABLES
command execution log
CFG_LOCK_TABLES APP_USER=TESTUSER
file (in the format
CFG_SNAPSHOT_TIMEST CONFIG_FILE
AMP=yyyy-MM-
dd_HH:mm:ss). DB_PWD
SVN_PWD
In the RadixWare DATABASE_DRIVER_PATH
Explorer, this command
One of the following
corresponds to the Take
arguments:
Snapshot command of
the configuration QUESTION_YES_ALL
snapshot.
QUESTION_NO_ALL
QUESTION_YES_SPECIFIC
QUESTION_NO_SPECIFIC
LOCAL_LOG_DIR
TIMEOUT
One of the following
arguments:
DB_WALLET_DIR_NAME
DB_WALLET_PATH
DB_WALLET_PWD

CMD_CFG_ Exports the configuration Mandatory arguments: CMD_CFG_EXPORT_SE

EXPORT_SEGMENT package of the specified GMENT_VERSION
PROJECT_DIR
_VERSION version (data of the PROJECT_DIR=c:/
package and its items) in ENVIRONMENT_NAME ProjectDir
the specified segment to CFG_SOURCE_SEGMENT_ID ENVIRONMENT_NAME=e
an XML file. nv1 DB_PWD=dbPwd
CFG_PACKAGE_VERSION CFG_SOURCE_SEGMEN
DESTINATION_FILE_PATH T_ID=123
In the RadixWare
CFG_PACKAGE_VERSIO
Explorer, this command APP_USER N=1.2
corresponds to the
Optional arguments: DESTINATION_FILE_PA
Export to File
TH=c:/files/data.xml
command of the CFG_EXPORT_ALL_ITEMS APP_USER=TESTUSER
configuration package.
CFG_EXPORT_LOCAL_NOTES
CONFIG_FILE
DB_PWD
SVN_PWD
DATABASE_DRIVER_PATH
One of the following
arguments:
QUESTION_YES_ALL
QUESTION_NO_ALL
QUESTION_YES_SPECIFIC
QUESTION_NO_SPECIFIC
LOCAL_LOG_DIR

RWU - AG.ENG.06.12.2023. 133

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

Command Description Arguments Example

TIMEOUT
One of the following
arguments:
DB_WALLET_DIR_NAME
DB_WALLET_PATH
DB_WALLET_PWD

CMD_CFG_ Exports the specified Mandatory arguments: CMD_CFG_EXPORT_SN

EXPORT_ configuration snapshot to APSHOT
PROJECT_DIR
SNAPSHOT an XML file. PROJECT_DIR=c:/
ENVIRONMENT_NAME ProjectDir
In the RadixWare CFG_SNAPSHOT_TIMESTAMP ENVIRONMENT_NAME=e
nv1 DB_PWD=dbPwd
Explorer, this command DESTINATION_FILE_PATH CFG_SNAPSHOT_TIMES
corresponds to the
APP_USER TAMP=2020-07-
Export command of the
15_15:36:01
configuration snapshot. Optional arguments: DESTINATION_FILE_PA
CONFIG_FILE TH=c:/files/data.xml
APP_USER=TESTUSER
DB_PWD
SVN_PWD
DATABASE_DRIVER_PATH
One of the following
arguments:
QUESTION_YES_ALL
QUESTION_NO_ALL
QUESTION_YES_SPECIFIC
QUESTION_NO_SPECIFIC
LOCAL_LOG_DIR
TIMEOUT
One of the following
arguments:
DB_WALLET_DIR_NAME
DB_WALLET_PATH
DB_WALLET_PWD

CMD_CFG_ Imports the Mandatory arguments: CMD_CFG_IMPORT_SE

IMPORT_SEGMENT configuration package GMENT_VERSION
PROJECT_DIR
_VERSION from an XML file to the PROJECT_DIR=c:/
specified segment. ENVIRONMENT_NAME ProjectDir
CFG_DESTINATION_SEGMEN ENVIRONMENT_NAME=e
T_ID nv2 DB_PWD=dbPwd
In the RadixWare
CFG_DESTINATION_SE
Explorer, this command SOURCE_FILE_PATH GMENT_ID=123
corresponds to the
APP_USER SOURCE_FILE_PATH=c:
Import Package from
/files/data.xml
File (Add) command of Optional arguments: APP_USER=TESTUSER
the configuration
package. CONFIG_FILE
DB_PWD
SVN_PWD
DATABASE_DRIVER_PATH
One of the following
arguments:
QUESTION_YES_ALL

134 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

Command Description Arguments Example

QUESTION_NO_ALL
QUESTION_YES_SPECIFIC
QUESTION_NO_SPECIFIC
LOCAL_LOG_DIR
TIMEOUT
One of the following
arguments:
DB_WALLET_DIR_NAME
DB_WALLET_PATH
DB_WALLET_PWD

CMD_CFG_ Imports the specified Mandatory arguments: CMD_CFG_IMPORT_SN

IMPORT_ configuration snapshot APSHOT
PROJECT_DIR
SNAPSHOT from an XML file. PROJECT_DIR=c:/
ENVIRONMENT_DESTINATION ProjectDir
_NAME ENVIRONMENT_DESTIN
In the RadixWare
SOURCE_FILE_PATH ATION_NAME=env2
Explorer, this command
DB_PWD=dbPwd
corresponds to the APP_USER SOURCE_FILE_PATH=c:
Import Snapshot from
Optional arguments: /files/data.xml
File (Add) command of
APP_USER=TESTUSER
the configuration CONFIG_FILE
snapshot.
DB_PWD
SVN_PWD
DATABASE_DRIVER_PATH
One of the following
arguments:
QUESTION_YES_ALL
QUESTION_NO_ALL
QUESTION_YES_SPECIFIC
QUESTION_NO_SPECIFIC
LOCAL_LOG_DIR
TIMEOUT
One of the following
arguments:
DB_WALLET_DIR_NAME
DB_WALLET_PATH
DB_WALLET_PWD

RWU - AG.ENG.06.12.2023. 135

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

Command Description Arguments Example

CMD_CFG_ Transfers the Mandatory arguments: CMD_CFG_TRANSFER_S

TRANSFER_ configuration package of EGMENT_VERSION
PROJECT_DIR
SEGMENT_ the specified version in PROJECT_DIR=c:/
VERSION the specified segment of ENVIRONMENT_NAME ProjectDir
the source environment ENVIRONMENT_NAME=e
ENVIRONMENT_DESTINATION
to the specified segment _NAME nv1
of the target ENVIRONMENT_DESTIN
environment. CFG_SOURCE_SEGMENT_IDATION_NAME=env2
CFG_DESTINATION_SEGMEN DB_PWD=dbPwd1
T_ID DB2_PWD=dbPwd2
Once transferred, the
CFG_SOURCE_SEGMEN
package is assigned the CFG_PACKAGE_VERSION T_ID=1
Imported state in the
APP_USER CFG_DESTINATION_SE
target environment.
GMENT_ID=21
Optional arguments: CFG_PACKAGE_VERSIO
CFG_EXPORT_ALL_ITEMS N=1.2.3
APP_USER=TESTUSER
CFG_EXPORT_LOCAL_NOTES
CONFIG_FILE
DB_PWD
DB2_PWD
SVN_PWD
DATABASE_DRIVER_PATH
One of the following
arguments:
QUESTION_YES_ALL
QUESTION_NO_ALL
QUESTION_YES_SPECIFIC
QUESTION_NO_SPECIFIC
LOCAL_LOG_DIR
TIMEOUT
One of the following
arguments:
DB_WALLET_DIR_NAME
DB_WALLET_PATH
DB_WALLET_PWD

CMD_CFG_ Transfers the specified Mandatory arguments: CMD_CFG_TRANSFER_S

TRANSFER_ configuration snapshot NAPSHOT
PROJECT_DIR
SNAPSHOT between the PROJECT_DIR=c:/
environments. ENVIRONMENT_NAME ProjectDir
ENVIRONMENT_DESTINATION ENVIRONMENT_NAME=e
_NAME nv1 DB_PWD=dbPwd1
Once transferred, the
ENVIRONMENT_DESTIN
snapshot is assigned the CFG_SNAPSHOT_TIMESTAMP ATION_NAME=env2
Imported state in the
Optional arguments: DB2_PWD=dbPwd2
target environment.
CFG_SNAPSHOT_TIMES
CONFIG_FILE TAMP=2020-07-
DB_PWD 15_15:36:01
DB2_PWD
SVN_PWD
DATABASE_DRIVER_PATH

136 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

Command Description Arguments Example

One of the following

arguments:
QUESTION_YES_ALL
QUESTION_NO_ALL
QUESTION_YES_SPECIFIC
QUESTION_NO_SPECIFIC
LOCAL_LOG_DIR
TIMEOUT

CMD_CFG_ Copies the items of the Mandatory arguments: CMD_CFG_COLLECT_C

COLLECT_CHANGE import packages from HANGES
PROJECT_DIR
S the specified source PROJECT_DIR=c:/
segments to the export ENVIRONMENT_NAME ProjectDir
package in the CFG_DESTINATION_SEGMEN ENVIRONMENT_NAME=e
Development state in the T_ID nv1 DB_PWD=dbPwd
specified target CFG_DESTINATION_SE
segment. If the specified CFG_SOURCE_SEGMENT_ID GMENT_ID=789
segment does not (one or several) CFG_SOURCE_SEGMEN
contain the package in APP_USER T_ID_1=123
this state, such package CFG_SOURCE_SEGMEN
will be created when Optional arguments: T_ID_2=124
executing the command. CONFIG_FILE APP_USER=TESTUSER
DB_PWD
When executing the
command: DB2_PWD

The items from the SVN_PWD

import packages of DATABASE_DRIVER_PATH
the specified source
One of the following
segments are added
arguments:
to the export package
(root single items and QUESTION_YES_ALL
items included in the
QUESTION_NO_ALL
root groups).
QUESTION_YES_SPECIFIC
The other items of the
target segment are QUESTION_NO_SPECIFIC
checked. The items LOCAL_LOG_DIR
whose configuration
objects have been TIMEOUT
modified will be added One of the following
to the export package. arguments:
The state of the export DB_WALLET_DIR_NAME
package is changed
to Released. DB_WALLET_PATH
DB_WALLET_PWD
Return values:
0. The items are
copied successfully.
1. The invalid
response is received
from the RadixWare
Server.
255. An exception
occurred during the
command execution.

RWU - AG.ENG.06.12.2023. 137

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

Command Description Arguments Example

The version of the

export package (created
/ modified during the
command execution) is
written to the command
execution log file (in the
format
CFG_PACKAGE_VERSIO
N=1.2.3).

In the RadixWare
Explorer, this command
corresponds to the
Collect Changes from
Import Segment(s)
command of the export
package.

The commands have the following features:

The environments involved when executing the commands should be first configured
in the RadixWare Manager project. To access the objects of the environment, the
SCP name parameter should be defined in the environment settings (refer to
Managing List of Environments).
The above-listed commands (except for CMD_CFG_TRANSFER_SNAPSHOT) need to
be executed with the RadixWare Server instances running in the environments
involved. If none of the RadixWare Server instances is running in the environment,
the configuration snapshots and segments of this environment will be inaccessible.
For the commands to be executed with the RadixWare Server instances running, it
is necessary to define the APP_USER argument – name of the user under which the
respective command will be executed in the software product and who will be
specified as the last one the configuration objects (created / modified when
executing the command) were updated by. A user with the respective name should
be preliminarily created in the software product (in the desktop explorer); this user
should have Chief Administrator rights, but may not have access to the system, i.e.
may be locked.
Files used in the commands CMD_CFG_IMPORT_*, CMD_CFG_EXPORT_* and in the
commands that support report generation should be located on the workstation on
which the RadixWare Manager is running.

When executing the commands, both common arguments and the following specific
arguments can be used:

Argument Description Example

ENVIRONMENT_NAME Name of the environment in which ENVIRONMENT_NAME=env1

actions on the configuration will be
executed (this argument is common
and can be used not only in the
configuration management
commands).

138 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

Argument Description Example

If the command transfers the

information between the
environments, this argument is
used together with
ENVIRONMENT_DESTINATION_NAM
E. In this case,
ENVIRONMENT_NAME is used to
specify the source environment.

ENVIRONMENT_ Name of the target environment. ENVIRONMENT_DESTINATION_NAM

DESTINATION_NAME E=env2
If the command transfers the
information between the
environments, this argument is
used together with
ENVIRONMENT_NAME.

CFG_CREATE_NEW_ Creates new objects when

OBJECTS_ON executing the commands on the
configuration snapshot.

CFG_DELETE_SURPLUS_OBJE Deletes redundant objects when

CTS_ON executing the commands on the
configuration snapshot.

CFG_DESTINATION_ ID of the target configuration CFG_DESTINATION_SEGMENT_ID=

SEGMENT_ID segment 123

CFG_EXPORT_ When exporting the configuration

ALL_ITEMS package to an XML file
(CMD_CFG_EXPORT_SEGMENT_VE
RSION command), the package will
include the items from all versions.
If the argument is missing, the
package will include only the items
of a certain release.

CFG_EXPORT_ When exporting the configuration

LOCAL_NOTES package to an XML file
(CMD_CFG_EXPORT_SEGMENT_VE
RSION command), the local notes
will be exported as well.

CFG_LOCK_TABLES When executing the

CMD_CFG_CREATE_SNAPSHOT
command, all configuration tables
will be locked.

CFG_PACKAGE_ Version of the configuration CFG_PACKAGE_VERSION=1.2

VERSION package. In the RadixWare
Explorer, it corresponds to the
Version parameter of the
configuration snapshot.
It is used to identify the package
the command will be executed on.

CFG_SNAPSHOT_ Time when the snapshot was CFG_SNAPSHOT_TIMESTAMP=2020

TIMESTAMP created in the source environment. -07-15_15:36:01
In the RadixWare Explorer, it
corresponds to the Created
parameter of the configuration
snapshot.
The argument value is specified as
yyyy-MM-dd_HH:mm:ss.

RWU - AG.ENG.06.12.2023. 139

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

Argument Description Example

It is used to identify the snapshot

the command will be executed on.

CFG_SOURCE_ ID of the source segment. CFG_SOURCE_SEGMENT_ID=123

SEGMENT_ID
Some commands enable to specify If several source segments need to
several source segments. In this be specified:
case, the
CFG_SOURCE_SEGMENT_ID_1=123
CFG_SOURCE_SEGMENT_ID
argument can be defined several CFG_SOURCE_SEGMENT_ID_2=124
times with any postfixes. Postfixes
_1 and _2 are used in the example.

CFG_UPDATE_ Modifies the existing objects when

EXISTING_OBJECTS_ON executing the commands on the
configuration snapshot.

DESTINATION_FILE_ Path to the file to which the DESTINATION_FILE_PATH=c:/files/

PATH command execution result will be data.xml
saved (for the commands that
export the information to a file or
generate an execution report).

SOURCE_FILE_PATH Path to the source file (for the SOURCE_FILE_PATH=c:/files/

commands that import the data.xml
information from a file).

APP_USER Name of the user under which the APP_USER=TESTUSER

respective command will be
executed in the software product
(on the side of the application
server) and who will be specified as
the last one the configuration
objects (created / modified when
executing the command) were
updated by.

TIMEOUT Application server access timeout in TIMEOUT=120

seconds. If no response is received
from the application server on the
timeout expiration, the command
execution is completed with an
error. If the argument is not
defined, the server response is, by
default, expected within one
minute.

Arguments that can be used to set up interaction with the Oracle wallet when executing the commands
that require access to the RadixWare Server (all commands listed above except for
CMD_CFG_TRANSFER_SNAPSHOT).

When executing the commands, the value of the Default directory for Oracle wallet
parameter (defined in the RadixWare Explorer, in the settings of the own system) is used, by
default. The DB_WALLET_DIR_NAME/DB_WALLET_PATH arguments are of higher priority: if one
of the arguments is defined in the command, the path to the Oracle Wallet will be searched for in
accordance with the argument value.
The DB_WALLET_DIR_NAME and DB_WALLET_PATH arguments are interchangeable. Both of
them cannot be used in the command.

140 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Managing Software Product Configuration in
Environments and Landscapes

Argument Description Example

DB_WALLET_DIR_NAME Directory name from the DB_WALLET_DIR_NAME=SSL_WALL

ALL_DIRECTORIES system view ET_DIR
used to search for the path to the
Oracle Wallet ("file:" prefix is added
to the path found)

DB_WALLET_PATH Path to the Oracle Wallet DB_WALLET_PATH=file:C:/walletDir

DB_WALLET_PWD Password to the Oracle Wallet. If

this argument is not defined in the
command, the null value will be
passed to Oracle.

9.7 Errors Management

When installing the software product to DB / updating DB, errors may occur. If an error
occurs, RadixWare Manager stops the procedure, displays the error message in the
Output dialog box and suggests the administrator taking one of the following actions:
Abort (a). Select to abort the software product installation / DB update. RadixWare
Manager records the error in the scripts execution log and in the table of executed
scripts.
Then perform the following:
1.Send the scripts execution log with the registered error to the vendor.
2.Receive the fix package from the vendor and load it (refer to Loading Software
Product Update Package). The fix package is created by the vendor on the basis of
the scripts execution log.
3.Restart the software product installation / DB update; at that the fix script will be
executed instead of the erroneous script.
Ignore (i). Select to ignore the error. It is not recommended to take this action
without assistance.
If the problem cannot be resolved without assistance, perform the following:
1.Send the error message text to the vendor for analysis.
2.Follow the instructions received from the vendor.
Retry (r). Select to repeat the action. This alternative is to be selected if the problem
can be resolved without assistance (e.g. if the error was caused by lack of disk space).
Perform the following without stopping the procedure:
1.Eliminate the error cause.
2.Continue the software product installation / DB update by selecting this action.

RWU - AG.ENG.06.12.2023. 141

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Export of XSD Schemas for Software Product
Definitions

9.8 Export of XSD Schemas for Software Product

Definitions
To export the XSD schemas, use the Export XSD Schemas command available in the
context menu of:
test branches
production branches
Release branches in the distribution kits received from the vendor and loaded to the
Distribution Kits | <Product> branch
release and development branches (these branches are available if the project is set up
for own development)

Executing this command in the respective branch opens the export dialog box to define
the following parameters:
Selected Xml Schemas. The list of schemas to be exported. The parameter values are
selected in the Xml Schemas Found list using the arrow buttons. To search for the
respective schema, use the Xml Schema Name filter. The Case Sensitive flag
indicates whether the case is taken into account when searching for the schema by the
phrase entered in the Xml Schema Name field: if the flag is set, the case is taken into
account; if unset, the search is case-insensitive. The flag is not set, by default.
Use Extended File Names. If the flag is set, the names of the schemas being
exported will be supplemented with the namespace in the format <schema
namespace>-<schema name>. The flag is not set, by default.
Linked Schemas. If the flag is set, the selected schema will be exported together with
all linked schemas.
Pack Schemas to ZIP. If the flag is set, the selected schemas will be exported as a
ZIP archive.
Embedded Documentation. If the flag is set, the description of schema fields will be
embedded into the body of the exported schema as tags:
<xs:annotation>
<xs:documentation>
Description
</xs:documentation>
</xs:annotation>
For details, refer to https://www.w3schools.com/xml/el_documentation.asp.
Embedded Documentation Language. The language of the description embedded
into the schema body. Available values:
All Languages (i.e. all languages will be embedded)
The language selected in the list containing the languages from all the layers of the
distribution kit.
The parameter is available if the Embedded Documentation flag is set.
Export Documentation. If the flag is set, the XSD schemas will be exported together
with the document containing the description of XSD schema fields. For example, if the
SstpXsd schema is selected, the SSTP Message Structure Definition.pdf file will be
exported.

142 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working in GUI Application of RadixWare Manager
Export of XSD Schemas for Software Product Definitions

Top Layer URI. The parameter is used to select the top layer the document will be
exported from. The list of layers depends on the layers configured in the distribution kit.
The parameter is available if the Export Documentation flag is set. The parameter is
not available if the schemas are exported by the particular customer. In this case, the
customer layer will be used as a top layer.
Documentation Language. The language of the exported document containing the
description of XSD schema fields. The value is selected from the list containing the
languages from all the layers of the distribution kit. The parameter is available if the
Export Documentation flag is set.

After the export parameters are defined, click OK. Clicking this button opens the dialog
box for selection of the directory to save the files to the local drive.

RWU - AG.ENG.06.12.2023. 143

2023 Compass Plus
 Working with RadixWare Manager Console
Application

10 Working with RadixWare Manager Console

Application

The RadixWare Manager console application is used to execute procedures of installing

and updating the software product.

The preliminary actions for the software installation (procedures of creating and setting
up project and repository) must be executed in the GUI application version.

To work in the application console version, it is required to execute the respective

commands. At that, the following files from the bin directory are used:
console.cmd - for Windows OS
console - for Linux OS and X OS
To start a certain command, it is required to call the command line from the bin directory
and execute as follows:
console <command_name> <name of argument1>=<value of argument1>...<name of
argumentN>=<value of argumentN>

When executing the command, all arguments and values can be defined in the command
line after the command name or in the configuration file. If the configuration file is used,
the command must have the CONFIG_FILE argument containing the name and path to the
configuration file.

For example, in Windows OS, the command of executing the Build operation is
presented as follows:
console CMD_BUILD CONFIG_FILE=c:\manager\bin\config.ini

If the arguments in the command line and configuration file are identical, the arguments
from the command line are used.

The following additional information is output when executing the commands in the
console version of the application:
Application name and current version
Information on the memory allocated to / used by the application:
o PID – ID of the application java process
o Max Memory – maximum memory
o Total Memory – memory allocated from the system
o Free Memory – unused memory (from the allocated memory)
o Use Memory – memory in use (from the allocated memory)

144 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working with RadixWare Manager Console Application

10.1 List of Application Commands

The commands available for execution in the RadixWare Manager console version and
list of arguments available for each command are presented in the table below:

Command Description Arguments Examples

CMD_REMOVE_DB_ Deletes the DB scheme. Mandatory arguments: CMD_REMOVE_DB

SCHEMA _SCHEMA
PROJECT_DIR
PROJECT_DIR=c:
DB_ALIAS \ProjectDir
Optional arguments: DB_ALIAS=testSc
hema
CONFIG_FILE
DB_PWD
DB_SYS_PWD
SVN_PWD
One of the following
arguments:
QUESTION_YES_ALL
QUESTION_NO_ALL
QUESTION_YES_
SPECIFIC
QUESTION_NO_
SPECIFIC
One of the following
arguments:
QUESTION_IGNORE
_ALL
QUESTION_ABORT
LOCAL_LOG_DIR

RWU - AG.ENG.06.12.2023. 145

2023 Compass Plus
 Working with RadixWare Manager Console
Application
List of Application Commands

Command Description Arguments Examples

CMD_LOAD_UPDATES Loads one or all Mandatory argument: CMD_LOAD_UPDA

distribution kits available PROJECT_DIR TES
for loading (zip files PROJECT_DIR=c:
Optional arguments:
located in the upgrade \ProjectDir
directory from which the CONFIG_FILE LOAD_UPDATE_AL
application extracts the KEY_STORE_PWD L_FILES
package of product files SVN_PWD=testSv
for installation/update). SVN_PWD nPwd
One of the following KEY_STORE_PWD
arguments: =testKeyStoryPwd

LOAD_UPDATE_ALL_
FILES
LOAD_UPDATE_FILE
One of the following
arguments:
QUESTION_YES_ALL
QUESTION_NO_ALL
QUESTION_YES_
SPECIFIC
QUESTION_NO_
SPECIFIC
LOCAL_LOG_DIR

CMD_BUILD Executes the Build Mandatory arguments: CMD_BUILD

operation - send the PROJECT_DIR=c:
PROJECT_DIR
software product to testing \ProjectDir
or production (depending One of the following DB_ALIAS=testSc
on the specified target arguments/groups: hema
branch). USE_PRODUCT and DB_PWD=testSch
USE_DISTRIBUTION emaPwd
_KIT DESTINATION_ST
USE_RELEASE ARTER_JAR_PATH
=c:\starter.jar
USE_BRANCH
USE_PRODUCT=o
ENVIRONMENT_NAME or rg.radixware
DESTINATION_BRANCH USE_DISTRIBUTI
_PATH. This argument is ON_KIT=1173-
optional if the 1.2.26.20.16
DISABLE_COPY_FILES
DESTINATION_BR
argument is specified.
ANCH_PATH=test
Optional arguments: ENABLE_CHECK_B
DB_ALIAS/ INARY_COMPATIB
DISABLE_UPGRADE_DB ILITY
CONFIG_FILE
DB_PWD
DB_SYS_USER
DB_SYS_PWD
SVN_PWD
DESTINATION_STARTER
_JAR_PATH
DISABLE_COPY_FILES
ENABLE_CHECK_BINARY
_COMPATIBILITY

146 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working with RadixWare Manager Console Application
List of Application Commands

Command Description Arguments Examples

DISABLE_CHECK_VERSI
ON_COMPATIBILITY
One of the following
arguments:
QUESTION_YES_ALL
QUESTION_NO_ALL
QUESTION_YES_
SPECIFIC
QUESTION_NO_
SPECIFIC
One of the following
arguments:
QUESTION_IGNORE
_ALL
QUESTION_ABORT
LOCAL_LOG_DIR
DATABASE_DRIVER_PA
TH
DISABLE_CHECK_DATA
BASE_AND_META
DISABLE_CHECK_RIGHT
S
CHECK_COMMIT_POLIC
Y_ON_REPLICA_SYNC
LICENSE_CODE
LICENSE_NAME
LICENSE_ROLE

CMD_MAKE_BRANCH Creates a new test/ Mandatory arguments: CMD_MAKE_BRAN

production branch in the CH
PROJECT_DIR
SVN repository of the PROJECT_DIR=c:
project. DESTINATION_BRANCH \ProjectDir
_PATH DESTINATION_BR
The name of the new
ANCH_PATH=test.
branch is specified in the Optional arguments:
abc
DESTINATION_BRANCH_P FORCE_OVERWRITE FORCE_OVERWRI
ATH argument. The name
SVN_PWD TE
should contain the "test."
or "prod." prefix that will One of the following
be used to identify the arguments:
branch type – test or
production. QUESTION_YES_ALL
Return values: QUESTION_NO_ALL
0. Indicates that the QUESTION_YES_
branch specified in the SPECIFIC
DESTINATION_BRANCH QUESTION_NO_
_PATH argument is SPECIFIC
empty. It is assigned in
the following instances: LOCAL_LOG_DIR

RWU - AG.ENG.06.12.2023. 147

2023 Compass Plus
 Working with RadixWare Manager Console
Application
List of Application Commands

Command Description Arguments Examples

If the branch with

the specified name
already exists in the
SVN repository and
the
FORCE_OVERWRITE
argument is defined
for the command,
the existing branch
is deleted when
executing the
command and a new
one with the same
name is created
instead.
If the branch with
the specified name
is missing in the
SVN repository, a
new branch is
created when
executing the
command
regardless of the
FORCE_OVERWRITE
argument.
1. Indicates that the
branch specified in the
DESTINATION_BRANCH
_PATH argument may
contain files. It is
assigned if the branch
with the specified name
already exists in the
SVN repository and the
FORCE_OVERWRITE
argument is defined for
the command. When
executing the command,
no changes are made to
the SVN repository.
255. An exception is
thrown when executing
the command.

CMD_EXTRACT_FILES Extracts the starter.jar and Mandatory arguments: CMD_EXTRACT_FI

(or) web-app.war file(s) to LES
PROJECT_DIR
the specified directory. PROJECT_DIR=c:
SOURCE_BRANCH_PATH \ProjectDir
DESTINATION_STARTER DESTINATION_ST
_JAR_PATH and/or ARTER_JAR_PATH
DESTINATION_WEB_APP =c:\starter.jar
_WAR_PATH
SOURCE_BRANCH
Optional arguments: _PATH=distributiv
CONFIG_FILE es/
org.radixware/117
SVN_PWD 3-1.2.26.20.16
One of the following SVN_PWD=testSv
arguments: nPwd
QUESTION_YES_ALL

148 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working with RadixWare Manager Console Application
List of Application Commands

Command Description Arguments Examples

QUESTION_NO_ALL
QUESTION_YES_
SPECIFIC
QUESTION_NO_
SPECIFIC
LOCAL_LOG_DIR

CMD_ANALYZE_UPGRADE Analyzes the changes in Mandatory arguments:

the distribution kit being
PROJECT_DIR
loaded. Returns the code
(value) defining the actions ENVIRONMENT_NAME or
to be performed once the DESTINATION_BRANCH
changes are applied. The _PATH
code value received as a One of the following
result of command arguments:
execution depends on the
specified argument. ANALYZE_APP_SERV
ER_CHANGES
ANALYZE_WEB_SER
VER_CHANGES
ANALYZE_APP_STAR
TER_CHANGES
ANALYZE_WEB_STA
RTER_CHANGES
Optional arguments:
One of the following
arguments/groups:
USE_PRODUCT and
USE_DISTRIBUTION
_KIT
USE_RELEASE
CONFIG_FILE
SVN_PWD
LOCAL_LOG_DIR

CMD_CREATE_USER_ Generates a user creation Mandatory arguments: CMD_CREATE_US

SCRIPT script for the database to ER_SCRIPT
PROJECT_DIR
be imported to the schema PROJECT_DIR=c:
of this user. The command SOURCE_BRANCH_PATH \ProjectDir
is called if the database DESTINATION_SCRIPT_ SOURCE_BRANCH
import is required. The PATH _PATH=distributiv
script generated by this
es/
command needs to be run Optional arguments:
org.radixware/117
by any available means CONFIG_FILE 3-1.2.26.20.16
before the database
import. SVN_PWD DESTINATION_SC
One of the following RIPT_PATH=c:
arguments: \Scripts\script.sql

QUESTION_YES_ALL
QUESTION_NO_ALL
QUESTION_YES_
SPECIFIC
QUESTION_NO_
SPECIFIC
LOCAL_LOG_DIR

RWU - AG.ENG.06.12.2023. 149

2023 Compass Plus
 Working with RadixWare Manager Console
Application
List of Application Commands

Command Description Arguments Examples

CMD_CREATE_INSTALL_ Generates a product Mandatory arguments:CMD_CREATE_IN

SCRIPT installation script. STALL_SCRIPT
PROJECT_DIR
PROJECT_DIR=c:
SOURCE_BRANCH_PATH \ProjectDir
DESTINATION_SCRIPT_ SOURCE_BRANCH
PATH _PATH=distributiv
Optional arguments: es/
org.radixware/117
CONFIG_FILE 3-1.2.26.20.16
SVN_PWD DESTINATION_SC
One of the following RIPT_PATH=c:
arguments: \Scripts\script.sql

QUESTION_YES_ALL
QUESTION_NO_ALL
QUESTION_YES_
SPECIFIC
QUESTION_NO_
SPECIFIC
LOCAL_LOG_DIR

CMD_EXTRACT_XML_ Exports the XSD schemas Mandatory arguments: CMD_EXTRACT_X

SCHEMAS of the software product ML_SCHEMAS
PROJECT_DIR
definitions to the specified PROJECT_DIR=c:
directory. SOURCE_BRANCH_PATH \ProjectDir
DESTINATION_PATH SOURCE_BRANCH
Optional arguments: _PATH=distributiv
es/
CONFIG_FILE org.radixware/117
SVN_PWD 3-1.2.26.20.16

One of the following DESTINATION_PA

arguments: TH=c:\unloadDir

QUESTION_YES_ALL SVN_PWD=testSv
nPwd
QUESTION_NO_ALL
QUESTION_YES_
SPECIFIC
QUESTION_NO_
SPECIFIC
LOCAL_LOG_DIR

CMD_EXPORT_HTML_DOC Exports the HTML Mandatory arguments: CMD_EXPORT_HT

description of the software ML_DOC
PROJECT_DIR
product API to the PROJECT_DIR=c:
specified directory. SOURCE_BRANCH_PATH \ProjectDir
DESTINATION_PATH SOURCE_BRANCH
Optional arguments: _PATH=distributiv
es/
CONFIG_FILE org.radixware/117
SVN_PWD 3-1.2.26.20.16

One of the following DESTINATION_PA

arguments: TH=c:\unload\
SVN_PWD=testSv
QUESTION_YES_ALL nPwd
QUESTION_NO_ALL
QUESTION_YES_
SPECIFIC

150 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working with RadixWare Manager Console Application
List of Application Commands

Command Description Arguments Examples

QUESTION_NO_
SPECIFIC
LOCAL_LOG_DIR

CMD_EXTRACT_RELEASE_ Downloads the description Mandatory arguments: CMD_EXTRACT_R

NOTES of the release included in ELEASE_NOTES
PROJECT_DIR
the distribution kit to the PROJECT_DIR=c:
specified file. SOURCE_BRANCH_PATH \ProjectDir
DESTINATION_PATH SOURCE_BRANCH
Optional arguments: _PATH=distributiv
es/
CONFIG_FILE org.radixware/117
SVN_PWD 3-1.2.26.20.16

One of the following DESTINATION_PA

arguments: TH=c:\unload
\ReleaseNotes.txt
QUESTION_YES_ALL SVN_PWD=testSv
QUESTION_NO_ALL nPwd
QUESTION_YES_
SPECIFIC
QUESTION_NO_
SPECIFIC
LOCAL_LOG_DIR

CMD_SEARCH_NEW_MANA Searches for the archive UPGRADE_FILE_PATH CMD_SEARCH_NE

GER_IN_ARCHIVE with the new version of W_MANAGER_IN_
the RadixWare Manager ARCHIVE
(manager.zip file) in the UPGRADE_FILE_P
specified archive ATH="/home/
containing a package of testDir/
the software product files org.radixware234-
for the installation / update 49-1.67v2 (48-
procedure. 1.67v1).zip"
Return values:
0. The updates are
missing or cannot be
applied to the current
version of the
RadixWare Manager.
1. The updates are
available and can be
applied to the current
version of the
RadixWare Manager.
255. An exception is
thrown in the course of
the analysis.

CMD_UPDATE_MANAGER_ Updates the RadixWare Arguments: CMD_UPDATE_MA

FROM_ARCHIVE Manager from the NAGER_FROM_AR
UPGRADE_FILE_PATH
specified archive CHIVE
containing a package of UPGRADE_FILE_P
the software product files ATH="/home/
for the installation / update testDir/
procedure. org.radixware234-
49-1.67v2 (48-
1.67v1).zip"

RWU - AG.ENG.06.12.2023. 151

2023 Compass Plus
 Working with RadixWare Manager Console
Application
List of Application Commands

Command Description Arguments Examples

Return values:
0. The updates are
missing or cannot be
applied to the current
version of the
RadixWare Manager.
1. The update procedure
is initiated.
255. An exception is
thrown in the course of
the analysis.

CMD_CHECK_DATABASE Checks the database Mandatory arguments: CMD_CHECK_DAT

structure for compliance ABASE
PROJECT_DIR
with the metainformation PROJECT_DIR=c:
of different versions of the DB_ALIAS \ProjectDir
software product. SOURCE_BRANCH_PATH DB_ALIAS=testSc
hema
Return values: Optional arguments: DB_PWD=sys
0. Inconsistencies in the DB_PWD SOURCE_BRANCH
DB structure are not _PATH=distributiv
found. SVN_PWD es/
1. Inconsistencies with USE_ALL_LAYERS org.radixware/117
the Information severity 3-1.2.26.20.16
level are found.
2. Inconsistencies with
the Warning severity
level are found.
3. Inconsistencies with
the Error severity level
are found.
255. An exception is
thrown during the
command execution.
For details, refer to
Project Commands.
CMD_CHECK_USER_FUNC_ Checks the compatibility of Mandatory arguments: CMD_CHECK_USE
OPERATION the user-defined functions PROJECT_DIR R_FUNC_OPERATI
with different versions of ON
the software product. The DB_URL PROJECT_DIR=c:
result of the command SOURCE_BRANCH_PATH \ProjectDir
execution is saved to the TXT_REPORT_PATH DB_URL=jdbc:ora
specified file. For details, cle:thin:@10.77.99
refer to Checking User- Optional arguments: 9.99:1521/x
Defined Functions DB_PWD DB_PWD=RADIX
during Update DB_SCHEMA DB_SCHEMA=RAD
Installation. IX
TXT_REPORT_PAT
H=c:\ProjectDir
\rep.txt
SOURCE_BRANCH
_PATH=releases/9
.9.99.9

CMD_SVN_REPLICATE Copies the data of the SVN Mandatory arguments: CMD_SVN_REPLIC

repository of the current PROJECT_DIR ATE
project to the specified PROJECT_DIR=C:
replica of the SVN One of the following /ProjectDir
repository or to all replicas arguments: REPLICA=TestRep
set up in the project. lica

152 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working with RadixWare Manager Console Application
List of Application Commands

Command Description Arguments Examples

Beforehand, it is necessary ALL_REPLICAS

to set up the SVN
REPLICA
repository replicas in the
project. Replicas are set Optional arguments:
up in the GUI version of SVN_PWD
the application. For details,
refer to Editing QUESTION_YES_
Replication Parameters. SPECIFIC
QUESTION_NO_
SPECIFIC
LOCAL_LOG_DIR

CMD_VERSION Displays the current Arguments are not used.

version of the RadixWare
Manager.

CMD_HELP Displays the reference Arguments are not used.

information on commands
and arguments used in the
console manager.

CMD_CFG_* Commands to manage

software product
configurations. For details,
refer to Console
Application Commands
to Manage
Configurations

CMD_CHECK_MANAGER_ Validates the structure of MANAGER_PATH CMD_CHECK_MAN

STRUCTURE the directory storing the (optional). If it is not AGER_STRUCTUR
RadixWare Manager defined, the command E
application files. The validates the structure of MANAGER_PATH=
validation result contains the current application c:/RWManagerDir
information on the (application for which the
discrepancies between the command is called from
current directory structure the bin directory).
and the expected one.

The arguments that can be used during the command execution are presented in the
table below:

Argument Description Examples

CONFIG_FILE Name of the configuration file containing

the command arguments.
If the same arguments are present in the
configuration file and in the command
line, the values defined in the command
line are more preferable.

PROJECT_DIR Path to the project directory in the file

system.

SOURCE_BRANCH_PATH Path to the source branch in the svn SOURCE_BRANCH_PATH=distri

repository relatively to the project root. butives/org.radixware/1160-
1.2.26.20.9

DESTINATION_BRANCH_ Path to the target branch in the svn DESTINATION_BRANCH_PATH=

PATH repository relatively to the project root. test

ENVIRONMENT_NAME Name of the target environment. ENVIRONMENT_NAME=TEST_en

RWU - AG.ENG.06.12.2023. 153

2023 Compass Plus
 Working with RadixWare Manager Console
Application
List of Application Commands

Argument Description Examples

Specifics of searching for the target vironment

branch and DB when executing the
CMD_BUILD and
CMD_ANALYZE_UPGRADE commands
with the ENVIRONMENT_NAME
argument:
1.The specified environment is
searched for. If it is found, the
command is executed for the
branch and DB corresponding to the
environment.
2.If the specified environment is not
found, the
DESTINATION_BRANCH_PATH and
DB_ALIAS arguments are searched
for and used.
3.If these arguments are missing in
the command or defined incorrectly,
the command execution is
completed with an error.

USE_PRODUCT Prefix of the product being used (postfix USE_PRODUCT1=org.radixware

can be empty). It is used together with USE_DISTRIBUTION_KIT1=116
the USE_DISTRIBUTION_KIT argument. 0-1.2.26.20.9

USE_DISTRIBUTION_KIT Prefix of the distribution kit being used USE_PRODUCT1=org.radixware

(postfix can be empty). If the argument USE_DISTRIBUTION_KIT1=116
is specified without value, the last loaded 0-1.2.26.20.9
distribution kit is used. This argument is
used together with the USE_PRODUCT
argument.

USE_RELEASE Number of release being used. If the USE_RELEASE=1.2.26.20.9

argument value is not defined, the last
or
created release is used.
USE_RELEASE
The parameter is used if the project is set
up for own development and the software
products releases are created within the
project.

USE_BRANCH Name of the test/production branch being USE_BRANCH=test

used.
The argument is used to move the
distribution kit loaded to the test branch
to another test/production branch (it is
identical to the Send to | ... command of
the application GUI version)

DB_URL DB location - a string in the format

j dbc:oracle:thin:@host:port/SID that is in
compliance with the JDBC standards

DB_SCHEMA User name on the DB server

DB_ALIAS DB name in the project settings (in

repository) used for search. If there are
several DB with identical names in the
project settings, the first DB in the list is
used.

154 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working with RadixWare Manager Console Application
List of Application Commands

Argument Description Examples

DB_PWD Password to the DB scheme. If the

argument is absent, it will be requested
from the user.

RDX_LOCAL_DB* Arguments enabling to define the local RDX_LOCAL_DB.localDb1.Uri=j

DB access parameters. The format of the dbc:oracle:thin:@1.2.3.4:1521/
arguments is RDX_LOCAL_DB. DB1
[DB_ALIAS].[PARAM_NAME], where:
RDX_LOCAL_DB.localDb1.Sche
DB_ALIAS – name of the local DB. ma=schema1
PARAM_NAME – name of the local DB RDX_LOCAL_DB.localDb1.Test=
access parameter. Supported 1
parameters are:
o Uri. The DB location. It is defined
according to the JDBC standards.
o Schema. The user name on the
DB server.
o Test. The DB purpose. Available
values:
1 - test DB
0 - production DB
o Type. The DB type. Available
values:
ORACLE (default value)
POSTGRESQL. If this value is
specified, the value of the
DeploymentType parameter
is not taken into account.
o DeploymentType. The DB server
type. Available values:
STANDALONE (default value).
It is used if the
DeploymentType parameter
is not defined for the local DB
in the configuration file.
AWS_RDS
ORACLE_ADB
To specify the password for the local DB
user, the standard argument DB_PWD is
used.

SVN_PWD Svn and ssh password to the repository.

If the argument is absent, it will be
requested from the user.

KEY_STORE_PWD Password to the keystore. If the

argument is absent, it will be requested
from the user.

DB_SYS_PWD SYS password to the DB required when

installing the software product to DB. If
the argument is absent, it will be
requested from the user.

DB_SYS_USER Name of the user with the system DB_SYS_USER=ADMIN

privileges to be used instead of the SYS
user when installing the software product
to DB and updating the DB.

RWU - AG.ENG.06.12.2023. 155

2023 Compass Plus
 Working with RadixWare Manager Console
Application
List of Application Commands

Argument Description Examples

DB_SYS_DISABLE_AS_SYS Attribute indicating that the user whose

DBA name is specified in the DB_SYS_USER
argument has administrative rights
sufficient to install the software product to
the DB or to update the DB (if the rights
are granted during the update
procedure), but does not have sysdba
privilege.

DB_OPTIONS_DATABASE_ Name of DB type required at the DB DB_OPTIONS_DATABASE_TYPE

TYPE installation. The executed parts of =ORACLE
installation scripts depend on the
specified name. If the DB type is the only
one, the argument is optional.
The argument can be used in all
commands related to the software
product installation/DB update.

DB_OPTIONS_DATABASE_ DB version required at the DB DB_OPTIONS_DATABASE_VER

VERSION installation. The executed parts of SION=11.1
installation scripts depend on the
specified version. If the DB type is the
only one, the argument is optional.
The argument can be used in all
commands related to the software
product installation/DB update.

DB_OPTIONS_PARAMETER_ Prefix to the preprocessor parameter. DB_OPTIONS_PARAMETER_org.

Parts of the installation scripts to be run radixware\Partitioning=true
depend on the specified prefix.
Names of arguments enable to use both
forward and backward slashes.
The argument can be used in all
commands related to the software
product installation/DB update.
If not all additional DB parameters
(DB_OPTIONS_PARAMETER_
arguments) were specified at the
software product installation/DB
update, the operation is aborted
with an error, and the list of all
additional parameters to be
specified is displayed in console.
When installing any software
product based on the RadixWare
platform to DB, the argument
DB_OPTIONS_PARAMETER_org.radi
xware\Partitioning is mandatory. If
this argument is set to true, when
the SQL scripts are pre-processed,
it is considered that the DB created
supports the partitioning. The
scripts capable to work with the
partitioned DB entities will be
executed (for details, refer to
Oracle documentation).
For details on available additional
DB parameters, refer to the
documentation for the software
product being installed.

156 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working with RadixWare Manager Console Application
List of Application Commands

Argument Description Examples

QUESTION_YES_ALL Automatically answer with "yes" to all

yes/no questions.
It cannot be used together with the
QUESTION_NO_ALL argument.

QUESTION_NO_ALL Automatically answer with "no" to all yes/

no questions.
It cannot be used together with the
QUESTION_YES_ALL argument.

QUESTION_YES_SPECIFIC Argument value is the yes/no question. QUESTION_YES_SPECIFIC_1="

Automatically answer with "yes" to the Create product?"
specified question.
Format:
QUESTION_YES_SPECIFIC<postfix>="<v
alue>", where:
<postfix> - any unique (within the set
of arguments of the current command)
sequence of characters (including
empty sequence) that does not contain
spaces (for example: "_1", "_2", "abc",
"AAA", etc.);
<value> - string with question / part of
question asked. If the string is found in
the question, it will be answered with
"yes"

QUESTION_NO_SPECIFIC Argument value is the yes/no question. QUESTION_NO_SPECIFIC="File

Automatically answer with "no" to the '/home/testUser/rep/upgrades/
specified question. org.radixware-1800-
2.1.19.10.2-install.zip' is
Format:
unsigned."
QUESTION_NO_SPECIFIC<postfix>="<val
ue>", where:
<postfix> - any unique (within the set
of arguments of the current command)
sequence of characters (including
empty sequence) that does not contain
spaces (for example: "_1", "_2", "abc",
"AAA", etc.);
<value> - string with question / part of
question asked. If the string is found in
the question, it will be answered with
"no"

QUESTION_IGNORE_ALL If an exception occurs when running a

script, automatically ignore the error and
continue execution.
It cannot be used together with the
QUESTION_ABORT argument.

QUESTION_ABORT If an exception occurs when running a

script, interrupt the execution.
It cannot be used together with the
QUESTION_IGNORE_ALL argument.

LOAD_UPDATE_FILE Name of the product updates package to LOAD_UPDATE_FILE="org.radix

be loaded. ware-27-1.55 (26-1.54v4).zip"
It cannot be used together with the
LOAD_UPDATE_ALL_FILES argument.

RWU - AG.ENG.06.12.2023. 157

2023 Compass Plus
 Working with RadixWare Manager Console
Application
List of Application Commands

Argument Description Examples

LOAD_UPDATE_ALL_FILES Load all packages of software product

updates located in the Upgrades
Directory defined in the project settings.
It cannot be used together with the
LOAD_UPDATE_FILE argument.

DISABLE_UPGRADE_DB When executing the CMD_BUILD

command, do not update DB.

DISABLE_COPY_FILES When executing the CMD_BUILD

command, do not update the destination
branch (DESTINATION_BRANCH). If the
argument is specified, only DB is updated
at the command execution.

ENABLE_CHECK_BINARY_ When executing the CMD_BUILD

COMPATIBILITY command, check the binary compatibility
of files of the software products sent to
testing/production.

DISABLE_CHECK_VERSION Disables the compatibility check

_COMPATIBILITY performed for the software product layer
versions when executing the CMD_BUILD
command. If the argument is not defined,
the compatibility check is performed.

DISABLE_CHECK_ Disables the compatibility check

DATABASE_AND_META performed for the DB structure and
metainformation of the version being
installed when executing the CMD_BUILD
command. If the argument is not defined,
the compatibility check is performed (for
details on this check, refer to the
description of the Check Database
command).

DISABLE_CHECK_RIGHTS Disables the check for the rights of the

DB user to the required Oracle entities,
which is, by default, performed when
executing the CMD_BUILD command
after the DB is updated. If the argument
is not defined, the check for the rights will
be performed.

CHECK_COMMIT_POLICY_ Checks whether the data of the main CHECK_COMMIT_POLICY_ON_

ON_REPLICA_SYNC repository of the project and of the REPLICA_SYNC=NEVER
selected replica is synchronized. This
check is, by default, performed before
replication when executing the
CMD_BUILD command. Available values:
ALWAYS. The check is always
performed.
ASK_USER. The user is requested to
perform the check each time the
replication command is executed.
NEVER. The check is not performed.
If the argument is missing in the CMD
BUILD command, the settings from the
manager.conf file will be used when
selecting the check mode (presence of
the
CheckCommitPolicyOnReplicaSync

158 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working with RadixWare Manager Console Application
List of Application Commands

Argument Description Examples

parameter and value of this parameter).

For details, refer to RadixWare
Manager Configuration File.

DESTINATION_STARTER_ Path to the starter.j ar file being unloaded.

JAR_PATH

DESTINATION_WEB_APP_ Path to the web-app.war file being

WAR_PATH unloaded.

DISABLE_CHECK_ Do not search for new versions of the

MANAGER_UPDATE RadixWare Manager application.
The argument can be used in all
commands containing the PROJECT_DIR
argument.

LOCAL_LOG_DIR Path to the directory where the log files LOCAL_LOG_DIR=c:

are saved after the command execution. \RadixWareManager\logs

ANALYZE_APP_SERVER_ When executing the

CHANGES CMD_ANALYZE_UPGRADE command, the
system analyzes whether it is required to
restart the RadixWare Server. Return
values:
0. There are no changes or the
changes are performed in the ADS
segment only - it is not required to
restart the application server.
1. There are changes in the software
product core - it is required to restart
the application server after updating
the software product.
2. There are incompatible changes in
DB - it is required to stop the
application servers before updating the
software product.
255. An exception occurred.

ANALYZE_WEB_SERVER_ When executing the

CHANGES CMD_ANALYZE_UPGRADE command, the
system analyzes whether it is required to
restart the web server. Return values:
0. It is not required to restart web
server.
1. It is required to restart web server.
255. An exception occurred.

ANALYZE_APP_STARTER_ When executing the

CHANGES CMD_ANALYZE_UPGRADE command, the
system analyzes whether it is required to
update the starter.j ar file. Return values:
0. It is not required to update the
starter.j ar file.
1. It is required to update the
starter.j ar file.
255. An exception occurred.

RWU - AG.ENG.06.12.2023. 159

2023 Compass Plus
 Working with RadixWare Manager Console
Application
List of Application Commands

Argument Description Examples

ANALYZE_WEB_STARTER_ When executing the

CHANGES CMD_ANALYZE_UPGRADE command, the
system analyzes whether it is required to
update the web-app.war file. Return
values:
0. It is not required to update the web-
app.war file.
1. It is required to update the web-
app.war file.
255. An exception occurred.

DESTINATION_SCRIPT_ Path to the file the generated script will DESTINATION_SCRIPT_PATH=c

PATH be saved to. :\Scripts\script.sql

DESTINATION_PATH Path to the directory or file the command

execution result will be saved to.

UPGRADE_FILE_PATH Path to the archive containing a package UPGRADE_FILE_PATH="/home/

of the software product files for testDir/org.radixware234-49-
installation / update. 1.67v2 (48-1.67v1).zip"

DATABASE_DRIVER_PATH Path to the jar file containing JDBC DATABASE_DRIVER_PATH=c:

driver. The ojdbc6.jar file included in the \binary-files\ojdbc6.jar
Oracle Client kit can be used as such
file.
The path to jdbc diver used by
RadixWare Manager application can be
also specified in the Jdbc driver file
parameter in the settings of application
GUI version.

USE_ALL_LAYERS When executing the

CMD_CHECK_DATABASE command, all
software product layers will be used.

TXT_REPORT_PATH Path to the file containing the results of

the
CMD_CHECK_USER_FUNC_OPERATION
command.

FORCE_OVERWRITE Indicates the need to create a new

branch if the branch with the specified
name already exists in the SVN
repository.
It is used in the CMD_MAKE_BRANCH
command (for details on how the
argument affects the command execution
logic, see the command description
above).

LICENSE_CODE Arguments enabling to specify the LICENSE_CODE=1111

information on the licensed installation.
They are used in the CMD_BUILD The format of the licensed
command. If the command is used to code is determined by the
update the system and the values of software product vendor.
these arguments are already written to
LICENSE_NAME the DB, the values specified for the LICENSE_NAME=license1
command will be ignored.
For details, refer to Licensed Software The format of the licensed
Product Installation. name is determined by the
software product vendor.

160 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working with RadixWare Manager Console Application
List of Application Commands

Argument Description Examples

LICENSE_ROLE LICENSE_ROLE=PROD

REPLICA When executing the REPLICA=TestReplica

CMD_SVN_REPLICATE command, the
data of the SVN repository of the current
project is copied to the specified replica
of the SVN repository.

ALL_REPLICAS When executing the ALL_REPLICAS

CMD_SVN_REPLICATE command, the
data of the SVN repository of the current
project is copied to all replicas set up in
the project.

MANAGER_PATH Path to the directory with the RadixWare MANAGER_PATH=c:/

Manager application files RWManagerDir

10.2 Examples of Installation/Update Procedures

The table below contains the examples of commands with different sets of arguments
that must be executed to install/update the software product using the RadixWare
Manager console version (the set of commands and count of arguments depend on the
procedure to be executed and its conditions). For the sequence of the software product
installation and update, refer to Installing and Updating Software Product.

The examples of the commands execution are provided for Linux OS.

Procedure Example of Execution Notes

1.Command CMD_LOAD_UPDATES (the variants of executing the command with different sets of
arguments is presented below)

The CMD_LOAD_UPDATES ./console CMD_LOAD_UPDATES The QUESTION_YES_ALL argument

command with the PROJECT_DIR=/home/testuser/ allows to answer "yes" to all
LOAD_UPDATE_ALL_FILES RadixWareManagerProjects/ questions from the application to
argument is executed to load testproject the user when executing the
all update batches available in LOAD_UPDATE_ALL_FILES command.
the upgrade directory of the QUESTION_YES_ALL
For example, if at the command
project to the repository.
execution:
the software product update
package is not signed at the
command execution, its loading
will be continued (the system
automatically answers with "yes"
to the "File '<update package
name>. zip' signed by not trusted
certificate. Continue?" question).
the directory for loading the
software product update package
is not found in the repository, it
will be created (the system
automatically answers with "yes"
to the suggestion of creating the
directory).

RWU - AG.ENG.06.12.2023. 161

2023 Compass Plus
 Working with RadixWare Manager Console
Application
Examples of Installation/Update Procedures

Procedure Example of Execution Notes

The CMD_LOAD_UPDATES ./console CMD_LOAD_UPDATES 1.The QUESTION_NO_ALL

command with the PROJECT_DIR=/home/testuser/ argument allows to answer "no"
LOAD_UPDATE_FILE argument RadixWareManagerProjects/ to all questions from the
is executed to load the testproject application to the user when
org.testproduct-1472- LOAD_UPDATE_FILE="org.radixwa executing the command.
2.1.3.10.9 (1470- re-1472-2.1.3.10.9 (1470-
For example, if the software
2.1.3.10.8).zip file located in 2.1.3.10.8).zip"
product update package is not
the upgrade directory of the QUESTION_NO_ALL
signed at the command
project.
execution, it will not be loaded
and the application stops (the
system automatically answers
with "no" to the "File '<update
package name>. zip' signed by
not trusted certificate. Continue?"
question).
2.The value of the
LOAD_UPDATE_FILE argument is
specified in the quotation marks
as the file name contains a space
character.

The CMD_LOAD_UPDATES ./console CMD_LOAD_UPDATES QUESTION_YES_SPECIFIC_1

command is executed with the LOAD_UPDATE_ALL_FILES argument allows to answer "yes"
LOAD_UPDATE_ALL_FILES PROJECT_DIR=/home/testUser/ automatically to the question
argument and defined rep/ containing the phrase "File '/
automatic answers to the QUESTION_YES_SPECIFIC_1="Fil home/testUser/rep/upgrades/
specified questions. e '/home/testUser/rep/upgrades/ org.radixware-1800-2.1.19.10.2-
org.radixware-1800-2.1.19.10.2- install.zip' is unsigned.".
install.zip' is unsigned."
QUESTION_YES_SPECIFIC_2
QUESTION_YES_SPECIFIC_2="Cr
argument allows to answer "yes"
eate product?"
automatically to the question
QUESTION_NO_ALL
containing the phrase "Create
product?"
QUESTION_NO_ALL argument
allows to answer "no"
automatically to all other
questions

2.Command CMD_ANALYZE_UPGRADE

The CMD_ANALYZE_UPGRADE ./console 1.Since no USE_PRODUCT,

command is executed to CMD_ANALYZE_UPGRADE USE_DISTRIBUTION_KIT or
analyze the changes that will PROJECT_DIR=/home/testuser/ USE_RELEASE argument is
be performed on the RadixWareManagerProjects/ specified, the last loaded
application server if the last testproject distribution kit and the branch
loaded distribution kit is sent to DESTINATION_BRANCH_PATH=te with this kit will be used. If there
testing (the test branch of the st is the Releases branch (the
repository). ANALYZE_APP_SERVER_CHANGES project is set up for own
development), the last created
release will be used at the
command execution.
2.The result of the command
execution can be as follows: 0, 1,
2 or 255 (for details, refer to the
description of the
ANALYZE_APP_SERVER_CHANGE
S argument).

162 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Working with RadixWare Manager Console Application
Examples of Installation/Update Procedures

Procedure Example of Execution Notes

The CMD_ANALYZE_UPGRADE ./console 1.The /home/testuser/

command is executed to CMD_ANALYZE_UPGRADE RadixWareManagerProj ects/
analyze the changes that will CONFIG_FILE=/home/testuser/ config.conf configuration file
be performed on the web RadixWareManagerProjects/ containing the required
server if the 1470-2.1.3.10.8 config.conf arguments is specified as the
distribution kit (previously command argument.
loaded to the org.radixware 2.The used software product and
product directory) will be sent Example of the config.conf file
distribution kit are explicitly
to testing (the test branch of located in the /home/testuser/
defined in the configuration file.
the repository). RadixWareManagerProj ects/
directory: 3.The USE_PRODUCT/
USE_DISTRIBUTION_KIT
PROJECT_DIR=/home/
arguments contain the "123"
testuser/
postfix used to search for the
RadixWareManagerProjects/
second element of product/
testproject
distribution kit pair. It is
USE_PRODUCT123=org.radixw convenient to use the postfix in
are these arguments if there are
USE_DISTRIBUTION_KIT123= several software products in the
1470-2.1.3.10.8 repository (in this case it is
possible to find the respective
DESTINATION_BRANCH_PATH distribution kit for each product).
=test
These arguments can be used as
ANALYZE_WEB_SERVER_CHAN follows:
GES
USE_PRODUCT=org.radixware
USE_DISTRIBUTION_KIT=1470-
2.1.3.10.8

3.Command CMD_EXTRACT_FILES

The CMD_EXTRACT_FILES ./console CMD_EXTRACT_FILES

command is executed to PROJECT_DIR=/home/testuser/
extract the starter.j ar and/or RadixWareManagerProjects/
web-app.war files from the testproject
loaded software product DESTINATION_STARTER_JAR_PAT
distribution kit and save them H=/home/testuser/
to the specified directory. RadixWareManagerProjects/
starter.jar
SOURCE_BRANCH_PATH=distribut
ives/org.radixware/1470-
2.1.3.10.8

4.Command CMD_BUILD is used to send the software product to testing and production afterward.

The CMD_BUILD command is ./console CMD_BUILD 1.Since no USE_PRODUCT,

executed to send the last CONFIG_FILE=/home/testuser/ USE_DISTRIBUTION_KIT or
loaded distribution kit to testing RadixWareManagerProjects/ USE_RELEASE argument is
(the test branch of the config.conf specified, the last loaded
repository). distribution kit and the branch
with this kit will be used. If there
Example of the config.conf file is the Releases branch (the
located in the /home/testuser/ project is set up for own
RadixWareManagerProj ects/ development), the last created
directory: release will be used at the
PROJECT_DIR=/home/ command execution.
testuser/ 2.As a rule, the DB_SYS_PWD
RadixWareManagerProjects/ argument must be specified only
testproject at the software product
DESTINATION_BRANCH_PATH installation (in some cases at
=test update).
DB_ALIAS=MANAGER_TEST

RWU - AG.ENG.06.12.2023. 163

2023 Compass Plus
 Working with RadixWare Manager Console
Application
Examples of Installation/Update Procedures

Procedure Example of Execution Notes

DB_SYS_PWD=SYS 3.The DB_ALIAS argument value -

the DB name from the list of DB
DB_PWD="abc#123" defined in the project settings.
DB_OPTIONS_PARAMETER_or
g.radixware\\Partitioning=true

The CMD_BUILD command is ./console CMD_BUILD Unlike the previous example, the
executed to send the 1470- CONFIG_FILE=/home/testuser/ distribution kit to be sent to
2.1.3.10.8 distribution kit RadixWareManagerProjects/ production and path for saving the
(previously loaded to the config.conf starter.j ar and web-app.war files
org.radixware product are explicitly defined in this
directory) to production (the example.
prod branch of the repository). Example of the config.conf file
located in the /home/testuser/
RadixWareManagerProj ects/
directory:
PROJECT_DIR=/home/
testuser/
RadixWareManagerProjects/
testproject
USE_PRODUCT=org.radixware
USE_DISTRIBUTION_KIT=147
0-2.1.3.10.8
DESTINATION_BRANCH_PATH
=prod
DB_ALIAS=MANAGER_TEST
DB_SYS_PWD=SYS
DB_PWD="abc#123"
DB_OPTIONS_PARAMETER_or
g.radixware\\Partitioning=true
QUESTION_YES_ALL
DESTINATION_STARTER_JAR_
PATH=/home/testuser/
RadixWareManagerProjects/
starter.jar
DESTINATION_WEB_APP_WAR
_PATH=/home/testuser/
RadixWareManagerProjects/
web-app.war

164 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Tools for Conversion of PostgreSQL Data Types to
Native Types

11 Tools for Conversion of PostgreSQL Data Types

to Native Types

This section describes the tools designated for conversion of the PostgreSQL data types
to native types that can be used for migration of the RadixWare-based software
products from the Oracle DB to PostgreSQL. Such conversion may be required if data
replication involves the tools which impose restrictions on the data types being used
(Oracle GoldenGate). In particular, varchar2 (to varchar) and datetime (to timestamp)
data types are subject to conversion.

The capabilities implemented in the RadixWare Manager and described in this section
can be used as part of the overall procedure for migration of the RadixWare-based
software products from the Oracle DB to PostgreSQL. As such, it is not recommended
to use them as a standalone solution. For migration-related issues, it is recommended
to contact the Product Support Service.

Data types are converted in the PostgreSQL DB using SQL scripts that are executed at
different migration stages. The CMD_CREATE_SCRIPTS_TO_CHANGE_COLUMN_TYPES
command available in the console version of the RadixWare Manager enables to
generate the required scripts (the need to generate each script and additional settings
for command execution are defined in the command arguments):
Initial script for conversion of the PostgreSQL data types to native types
Script to be executed after the data is initially loaded to the PostgreSQL DB
Script for backward conversion of the native data types to the PostgreSQL data types
Script to be executed after migration to the PostgreSQL DB is completed, for example,
after the RadixWare Server is started (the need to generate this script and exact
time to run it depend on the software product for which the data is transferred)

In the PostgreSQL DB, the scripts generated by the command need to be run under
the user with the SUPERUSER privileges.
The distribution kit of the software product the scripts are generated for must
include the source code (the need to include the source code in the distribution kit is
determined by the software product vendor when preparing a distribution kit).
Before the migration procedure, it is recommended to clear the target PostgreSQL
DB.
For all indexes of calculated columns (if such columns are present in the software
product), it is necessary to specify the recreation mode in the command settings
(for details, refer to the description of the INDEX_CREATION_MODE_ argument).

List of arguments to be used

Mandatory arguments:
PROJECT_DIR
SOURCE_BRANCH_PATH
PROBLEM_HANDLING_MODE
TRACE_LEVEL

RWU - AG.ENG.06.12.2023. 165

2023 Compass Plus
 Tools for Conversion of PostgreSQL Data Types to
Native Types

At least one of the following arguments:

o FORWARD_SCRIPT_PATH
o BACKWARD_SCRIPT_PATH
o AFTER_INITIAL_LOAD_SCRIPT_PATH
o POST_BACKWARD_SCRIPT_PATH (it is used only together with
INDEX_CREATION_MODE_)

Optional arguments:
DEBUG_LOGGING
CONFIG_FILE
SVN_PWD
DATABASE_DRIVER_PATH
CONVERT_TYPE_MODE
One of the following arguments:
o QUESTION_YES_ALL
o QUESTION_NO_ALL
QUESTION_YES_SPECIFIC
QUESTION_NO_SPECIFIC
LOCAL_LOG_DIR
INDEX_CREATION_MODE_

Use case
CMD_CREATE_SCRIPTS_TO_CHANGE_COLUMN_TYPES TRACE_LEVEL=INFO
SOURCE_BRANCH_PATH=distributives/org.radixware/117-2.1.48.10.16
TOP_LAYER_URI=org.radixware FORWARD_SCRIPT_PATH=C:/Scripts_path/forward.sql
AFTER_INITIAL_LOAD_SCRIPT_PATH=C:/Scripts_path/afterInitialLoad.sql
BACKWARD_SCRIPT_PATH=C:/Scripts_path/backward.sql
PROBLEM_HANDLING_MODE=STOP_ON_WARNING PROJECT_DIR=C:/managerProjects/rw
DEBUG_LOGGING

Arguments
The table below lists the specific arguments which can be used in data migration
commands (for the arguments common to all commands, refer to List of Application
Commands):

Argument Description Example

TRACE_LEVEL Trace level for events that occur TRACE_LEVEL=INFO

during the command execution.
Available values:
DEBUG
INFO
WARNING
ERROR
NONE

166 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Tools for Conversion of PostgreSQL Data Types to
Native Types

Argument Description Example

PROBLEM_HANDLING_ Problem handling mode. Available PROBLEM_HANDLING_MODE=STO

MODE values: P_NEVER
STOP_ON_WARNING. Command
execution is interrupted when events
with the WARNING severity occur.
STOP_ON_ERROR. Command
execution is interrupted when events
with the ERROR severity occur.
STOP_NEVER. Command execution
continues as long as it is possible.

CONVERT_TYPE_MODE Data conversion mode. Available CONVERT_TYPE_MODE=VARCHAR

values: 2_AND_DATE
VARCHAR2. Conversion of varchar2
to varchar and backward is
performed in the scripts being
generated. This value is used, by
default (used if the argument is not
specified in the command).
VARCHAR2_AND_DATE. Conversion
of varchar2 (to varchar and
backward) and datetime (to
timestamp and backward) is
performed in the scripts being
generated.

FORWARD_SCRIPT_PATH Initial script for conversion of the FORWARD_SCRIPT_PATH=C:/

PostgreSQL data types to native types Scripts_path/forward.sql

AFTER_INITIAL_LOAD_ Script to be executed after the data is AFTER_INITIAL_LOAD_SCRIPT_PA

SCRIPT_PATH initially loaded to PostgreSQL DB TH=C:/Scripts_path/
afterInitialLoad.sql

BACKWARD_SCRIPT_PATH Script for backward conversion of the BACKWARD_SCRIPT_PATH=C:/

native data types to the PostgreSQL Scripts_path/backward.sql
data types

POST_BACKWARD_SCRIPT Script to be executed after migration

_PATH to the PostgreSQL DB is completed
(also see the description of the
INDEX_CREATION_MODE_ argument)

DEBUG_LOGGING If this argument is present in the

command, logging is performed when
generating a script (RAISE NOTICE)

RWU - AG.ENG.06.12.2023. 167

2023 Compass Plus
 Tools for Conversion of PostgreSQL Data Types to
Native Types

Argument Description Example

INDEX_CREATION_MODE_ Some software products can contain CMD_CREATE_SCRIPTS_TO_CHA

<Index_Name> indexes of calculated columns. Such NGE_COLUMN_TYPES
indexes need to be recreated on TRACE_LEVEL=INFO
migration completion (in a backward SOURCE_BRANCH_PATH=distribut
scrip or later). ives/org.radixware/117-
2.1.48.10.16
The PROBLEM_HANDLING_MODE=STO
INDEX_CREATION_MODE_<Index_Na P_ON_WARNING
me> argument is used to define the PROJECT_DIR=C:/
mode of saving the script used to managerProjects/rw
recreate the index specified in the INDEX_CREATION_MODE_IDX_AD
argument name. DRESS=IN_BACKWARD_SCRIPT
Available values: INDEX_CREATION_MODE_IDX_OR
G=IN_POST_BACKWARD_SCRIPT
IN_BACKWARD_SCRIPT. The index INDEX_CREATION_MODE_IDX_PE
is recreated in the backward script. RSON=IN_POST_BACKWARD_SC
RIPT
IN_POST_BACKWARD_SCRIPT. The
FORWARD_SCRIPT_PATH=C:/
index is recreated in the script
Scripts_path/forward.sql
specified in the
AFTER_INITIAL_LOAD_SCRIPT_PA
POST_BACKWARD_SCRIPT_PATH
TH=C:/Scripts_path/
argument. This value is usually
afterInitialLoad.sql
applicable to scripts that can be
BACKWARD_SCRIPT_PATH=C:/
recreated with a delay.
Scripts_path/backward.sql
POST_BACKWARD_SCRIPT_PATH
A list of indexes to be recreated =C:/Scripts_path/
depends on the software product postBackward.sql
whose data is transferred. Possibility toDEBUG_LOGGING
delay script recreation is estimated for
each script separately. The example shows that the
IDX_ORG and IDX_PERSON
If the IN_POST_BACKWARD_SCRIPT indexes will be recreated in the
value is specified for at least one postBackward.sql script whereas
index, the the IDX_ADDRESS index - in the
POST_BACKWARD_SCRIPT_PATH backward.sql script.
argument becomes mandatory for the
command (see above).

168 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Appendix
Software Product File Packages

12 Appendix

12.1 Software Product File Packages

The software product distribution kit is delivered in packages of the following types:
Initial installation package. The file name format is <URI>-<N>-<D>-install.zip, where
URI - ID of the customer layer of the software product
N - sequence number of the distribution kit prepared for a customer, and on which
the file package is based
D - distribution kit number

This package contains the initial software product distribution kit.

Update package. The file name format is <URI>-<N>-<D> (<NP>-<DP>).zip, where

URI - ID of the customer layer of the software product
N - sequence number of the distribution kit prepared for a customer, and on
which the file package is based
D - distribution kit number
NP - sequence number of the previous distribution kit
DP - number of the previous distribution kit

The format of the distribution kit number is f.f.f.f v V, where

f.f.f.f - release number
V - distribution kit version
For an offshoot development, the release number is composed of five digits: f.f.f.f.f

The org.radixware.radinsk-<client X*>-1-1.0.1.2v2 file contains the platform whose

customer layer URI is org.radixware.radinsk-<client X*>, the file package number is
1, the release number is 1.0.1.2, and the distribution kit version is 2.

This package contains the changes made to the software product.

12.2 Scripts Execution Log File

The log file is generated automatically:
when installing the software product to test DB/updating the test DB. This file is stored
in the project directory in the log.test subdirectory.
when installing the software product to production DB/updating the production DB. This
file is stored in the project directory in the log.prod subdirectory.

RWU - AG.ENG.06.12.2023. 169

2023 Compass Plus
 Appendix
Scripts Execution Log File

The file name format is <installUri>-<CustomerUri>-<Ri>-<Rj>-<timestamp>.log, where

<installUri> - URI of the layer of the installed software product
<CustomerUri> - customer name. It is present in the file name if the software product
is installed / DB is updated from the context menu of the customer distribution kit.
<Ri> - number of the source release. It is absent in the file name when running the
installation scripts.
<Rj> - number of the release of the installed software product
<timestamp> - current time in the yymmdd_hhmmss format

The file name is unique. A new file is created during each installation of software product
to DB / DB update.

The file name is org.radixware.radinsk-test-1.2.29.10.15-1.2.29.10.17-

140529_090615.log, where URI - org.radixware.radinsk, customer name - test, initial
release number - 1.1.20.20.15, number of the release being installed - 1.1.20.20.17,
date - 29/05/2014, time - 09:06:15.
In the log file, RadixWare Manager keeps record of the software product installation /
DB update and saves the information on its status.
If an error occurs when installing the software product to DB/updating DB, the log file
records the following information:
name of the script file that caused an error
error ID
number of the row and column where the error occurred
The log file should be transferred to the vendor in order to control the correctness of the
software product installation / DB update.

Example of the log file contents:

RM
MANAGER_VERSION 1.2.11.34.9
MANAGER_ENVIRONMENT GUI
TO_RELEASE org.radixware [2.1.32.10.13]
FROM_RELEASE org.radixware [2.1.32.10.4]
TIME 2021/01/27 16:45:58 +0500
DB_NAME jdbc:oracle:thin:@1.2.3.4:1521/DB1
DB_SCHEMA TEST
DB_PRODUCT Oracle
DB_VERSION Oracle Database 11g Enterprise Edition Release 11.2.0.4.0 - 64bit
Production
DB_VERSION With the Partitioning, OLAP, Data Mining and Real Application Testing
options
RELEASE_STATUS Test
CUSTOMERS_URI org.radixware.radinsk-test
OS_NAME Windows 10
OS_VERSION 10.0

170 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Appendix
Scripts Execution Log File

LOG 16:45:58 AADC system not detected.

LOG 16:45:58 'about.xml' prepared - success.
LOG 16:45:58 The synchronization of replica repository was disabled.
LOG 16:45:58 'starter.jar' copied - success.
LOG 16:45:58 The synchronization of replica repository was disabled.
LOG 16:45:58 --------------------------------------------------
LOG 16:45:58 Action 'Next' has been performed. Previous step '<Not
defined>', next step 'Export of 'starter.jar''.
LOG 16:49:59 'web-app.war' copied - success.
LOG 16:49:59 The synchronization of replica repository was disabled.
LOG 16:50:00 --------------------------------------------------
LOG 16:50:00 Action 'Next' has been performed. Previous step 'Export of
'starter.jar'', next step 'Export of 'web-app.war''.
LOG 16:50:00 The user is shown the message:
LOG 16:50:00 Current version of 'starter.jar' is compatible with new product
version. Export of file is not required.
LOG 16:50:23 --------------------------------------------------
LOG 16:50:23 Action 'Next' has been performed. Previous step 'Export of
'web-app.war'', next step 'Execution Plan'.
LOG 16:50:23 The user is shown the message:
LOG 16:50:23 Current version of 'web-app.war' is compatible with new
product version. Export of file is not required.
LOG 16:50:26 --------------------------------------------------
LOG 16:50:26 Action 'Next' has been performed. Previous step 'Execution
Plan', next step 'Current Sessions'.
LOG 16:50:29 --------------------------------------------------
LOG 16:50:29 Action 'Next' has been performed. Previous step 'Current
Sessions', next step 'Before Scripts Execution'.
LOG 16:50:29 The user is shown the message:
LOG 16:50:29 Changes in database update scripts are backward compatible
with old version.Database will be updated without service interruption.Current sessions
in database in schema 'orcl':
LOG 16:50:36 Change 'about.xml' before database update - success.
LOG 16:50:36 The synchronization of replica repository was disabled.
LOG 16:50:36 Start operation 'Database Update: orcl'.
LOG 16:50:36 Prepare executing scripts ...
LOG 16:50:36 Executing scripts ...
LOG 16:50:36 ******** package scripts/org.radixware/2.1.32.10.4-
2.1.32.10.5:
LOG 16:50:36 *********** script 6.sql (org.radixware 2.1.32.10.4 ->
2.1.32.10.5)
LOG 16:50:36 *********** script 4.sql (org.radixware 2.1.32.10.4 ->
2.1.32.10.5)
LOG 16:50:36 *********** script 2.sql (org.radixware 2.1.32.10.4 ->
2.1.32.10.5)

RWU - AG.ENG.06.12.2023. 171

2023 Compass Plus
 Appendix
Scripts Execution Log File

LOG 16:50:37 --------------------------------------------------

LOG 16:50:37 Action 'Next' has been performed. Previous step 'Before Scripts
Execution', next step 'After Scripts Execution'.
LOG 16:50:37 The user is shown the message:
LOG 16:50:37 All preliminary checks have been performed. The database can
be updated now.
LOG 16:50:46 ******** package scripts/org.radixware/2.1.32.10.5-
2.1.32.10.6:
LOG 16:50:46 *********** script 1.sql (org.radixware 2.1.32.10.5 ->
2.1.32.10.6)
LOG 16:50:46 *********** script 3.sql (org.radixware 2.1.32.10.5 ->
2.1.32.10.6)
LOG 16:50:47 ******** package scripts/org.radixware/2.1.32.10.7-
2.1.32.10.8:
LOG 16:50:47 *********** script 1.sql (org.radixware 2.1.32.10.7 ->
2.1.32.10.8)
LOG 16:50:47 *********** script 3.sql (org.radixware 2.1.32.10.7 ->
2.1.32.10.8)
LOG 16:50:47 Searching for invalid database objects ...
LOG 16:50:57 All database objects are valid.
LOG 16:50:57 Checking consistency of the database structure and meta
information ...
LOG 16:50:59 Done.
LOG 16:50:59 Checking rights ...
LOG 16:51:03 Done.
LOG 16:51:03 Finish operation 'Database Update: TEST' - success.
LOG 16:51:03 Change 'about.xml' after database update - success.
LOG 16:51:03 The synchronization of replica repository was disabled.
LOG 16:51:07 --------------------------------------------------
LOG 16:51:07 Action 'Next' has been performed. Previous step 'After Scripts
Execution', next step 'Before Kernel Files Update'.
LOG 16:51:07 The user is shown the message:
LOG 16:51:07 Database update completed successfully.
LOG 16:51:08 Kernel files updated - success.
LOG 16:51:08 The synchronization of replica repository was disabled.
LOG 16:51:09 --------------------------------------------------
LOG 16:51:09 Action 'Next' has been performed. Previous step 'Before Kernel
Files Update', next step 'After Kernel Files Update'.
LOG 16:51:09 The user is shown the message:
LOG 16:51:09 Files of Kernel segment have been modified.
LOG 16:51:09 Instances of RadixWare Server and RadixWare Web
Presentation Server will be restarted sequentially.
LOG 16:51:34 --------------------------------------------------
LOG 16:51:34 Action 'Next' has been performed. Previous step 'After Kernel
Files Update', next step 'Before Application Files Update'.

172 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Appendix
Scripts Execution Log File

LOG 16:51:34 The user is shown the message:

LOG 16:51:34 Files of Kernel segment have been modified. For the application
to use them, restart all running instances of RadixWare Server and RadixWare Web
Presentation Server. For this, use OS tools or connect RadixWare Explorer under
system administrator.
LOG 16:51:34 Before proceeding further, wait until all instances are loaded
completely.
LOG 16:51:36 Application files updated - success.
LOG 16:51:36 The synchronization of replica repository was disabled.
LOG 16:51:37 --------------------------------------------------
LOG 16:51:37 Action 'Next' has been performed. Previous step 'Before
Application Files Update', next step 'After Application Files Update'.
LOG 16:51:37 The user is shown the message:
LOG 16:51:37 Files of Application segment have been modified and will be
updated.
LOG 16:51:55 --------------------------------------------------
LOG 16:51:55 Action 'Next' has been performed. Previous step 'After
Application Files Update', next step '<Not defined>'.
LOG 16:51:55 The user is shown the message:
LOG 16:51:55 Files of Application segment have been modified.
LOG 16:51:55 To complete the update procedure, connect to RadixWare
Explorer under system administrator and execute the 'Switch Instances to New
Application Version' command for server instances.
LOG 16:51:55 After that you can finish working with the wizard.
LOG 16:51:55
STATUS O

12.3 Release Parameters Editor

The Properties editor is present in all the tree branch directories containing the software
product release files.
The editor can be opened by:
double-clicking the Properties editor or the directory / branch containing the editor
using the Configure command of the Properties editor context menu
using the Configure command of the context menu of the directory / branch containing
the editor

The release parameters editor displays the following release parameters:

"General" Tab
Release number. The release number.
Status. The release status:
Test. The status of the release to be tested.
Urgent. This release must be delivered to customer as quick as possible before the
testing is completed.

RWU - AG.ENG.06.12.2023. 173

2023 Compass Plus
 Appendix
Release Parameters Editor

Production. The production release.

Invalid. The release containing errors. The status is set by the customer in case
essential errors are found during the preliminary testing.
Expired. The expired release.
Source branch. The source development branch. The parameter is defined if the
release represents the customer own development.
Repository revision. The number of the repository revision the current release is
based on. The parameter is defined if the release contains the customer own
developments.
Previous release. The number of the previous release. The parameter is not defined
for the initial version.
Description of layers. The parameter field contains the following buttons:
o Generate Developer Description button used to create a draft of the release
description based on the comments on the SVN revisions. The button is available for
the vendor only.
o Show All Developer Descriptions button is used to view all comments on the SVN
revisions of the current release including comments of the Refactoring and
Incomplete types. These types of comments are used in the course of the
development process and are internal (they are not included in the release
description draft that is generated by the Generate Developer Description
command). The list of comments is output in the dialog box similar to the description
editor (for details, refer to document [7])
Notification. The parameter field contains the Send 'Release Created' Notification
button used to send the e-mail notification of the release to the subscribers. The
button is available only for the vendor.
The area contains the list of layers included in the software product and the number of
the release of each layer.
The area containing the editors describing the changes. For details, refer to document
[7].
The following fields describe the changes:
By Developers. The field contains the release description created by the vendor.
The fields whose names correspond to the supported languages.

To view the description, click button.

"Modules" Tab
The tab contains the list of layers and modules that are included in the release. When
selecting the module from the list in the Dependencies area, the list of dependencies of
this module is displayed on the This Module is Used by and This Module Uses tabs. The
following commands are available when working with the list of dependencies:

Show All ( button). The toggle button with two modes: show all module
dependencies / show only dependencies of the module itself.

174 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Appendix
Release Parameters Editor

Condition: module1 is linked to module2, module2 is linked to module3, module3 is

linked to module4; module1 is selected in the list of all modules (in the left editor
panel).
Result:
If the Show All button is on, the module2, module3 and module4 will be displayed
on the This Module is Used by tab.
If the Show All button is off, the module2 will be displayed on the This Module is
Used by tab.

Unfold the Upper Branch ( button). The button is used to unfold the upper level
containing all module dependencies. If the Show All button is on, all links of two
modules are displayed.
The editor looks as follows:

RWU - AG.ENG.06.12.2023. 175

2023 Compass Plus
 Appendix
Distribution Kit Parameters Editor

12.4 Distribution Kit Parameters Editor

The Properties distribution kit parameters editor is present in all the distribution kit
directories of the Distribution Kits project branches.
The editor can be opened by:
double-clicking the Properties editor or the directory of the particular distribution kit
using the Configure command of the Properties editor context menu
using the Configure command of the context menu of the directory of the particular
distribution kit

The distribution kit editor contains the General and Included Elements tabs displaying
the following parameters:
The General tab:
Distribution kit number. The identification number of the distribution kit.
Initial release status. The status of the release the distribution kit is based on.
Creation time. The distribution kit creation date and time.
Previous distribution kit. The number of the previous distribution kit.
Description. The description of the distribution kit.
Changes list. The area for editing the description of distribution kit changes.
The parameters are not editable.
The Included Elements tab:
The Element column displays the list of software product layers, segments and modules
included in the distribution kit. The list has a tree-like structure. The Format column
shows the format in which the objects are included in the distribution kit (Bin - compiled
binary files, Src - both compiled files and source codes).

176 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Appendix
Distribution Kit Parameters Editor

The editor looks as follows:

12.5 RadixWare Manager Configuration File

The RadixWare Manager application can be additionally configured by editing the

manager.conf file available in the manager/etc directory.
The RadixWare Manager controls changes made to the manager.conf file. The file is
reread on a periodic basis (every 10 seconds) and is compared against the corresponding
file used when starting the RadixWare Manager / opening the project. If changes made
by the third-party software are detected, a respective warning is displayed.
The configuration file enables to define the following parameters:
default_userdir - path to the work directory of the RadixWare Manager application.
The specified directory stores the log files with the information on the application
operation, custom settings for the application appearance and other files stored in the
application cache.
default_options parameter includes:
Parameters defining the JVM settings used by default when running the RadixWare
Manager application. For details, refer to Memory Allocated for RadixWare
Manager.
-J-Dnetbeans.keep.expansion=false flag. If the flag is present in the configuration
file, all projects from the previous session will be available in the project tree when
starting the application, but the respective project will be opened only when it is

RWU - AG.ENG.06.12.2023. 177

2023 Compass Plus
 Appendix
RadixWare Manager Configuration File

selected in the tree. The flag is, by default, missing in the configuration file (when
starting the application, all projects from the previous session will be opened and
the positions of the elements opened in the tree will be restored).
Other JVM and Netbeans parameters.
Parameters defining the restrictions to the DB user password (these restrictions are not
applicable to the test DB):
MinPasswordCharacters. The minimum number of letters in the database user
password created when installing the software product. By default - 5.
MinPasswordDigits. The minimum number of digits in the database user password
created when installing the software product. By default - 5.
MinPasswordSpecialCharacters. The minimum number of the special characters (!
№;%:? etc.) in the database user password created when installing the database.
For details on the characters available for using in the password, refer to Oracle
Database Administrator's Guide. By default - 2.
IsAutoUpdateTraceMode. The mode of logging the automatic update of the
RadixWare Manager:
If the parameter is set to 1, the auto update is logged. Log files are saved to the
directory where the RadixWare Manager is stored. The format of the file names is
AutoUpdateTrace_<Current date and time>.log.
If the parameter is set to 0 or is missing in the configuration file, logging is not
performed.
Parameters to set up the local list of databases.
CheckCommitPolicyOnReplicaSync. The mode to check whether the data of the
main repository of the project and of the selected replica is synchronized. This check is,
by default, performed before replication (when executing the command in the
Replication editor or in the course of the software product update procedure).
Available values:
Always. The check is always performed.
AskUser. The user is requested to perform the check each time the replication
command is executed.
Never. The check is not performed.
The parameter is, by default, missing in the configuration file, i.e. the check is always
performed.
It may be required to disable this check to speed up the replication process.

If the check is disabled, the RadixWare Manager application cannot verify that
the initial state of the replica is correct.

12.6 Local List of Databases

The RadixWare Manager supports the capability to use the databases from the local list
- list of databases that are not stored in the SVN repository of the project and can be
used only on the workstation on which the RadixWare Manager is running. The local list
is created in the configuration file manager.conf located in the manager/etc directory of
the application.

178 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Appendix
Local List of Databases

The databases from the local list become available in the dialog boxes used to execute
different commands that require a connection to the DB (for example, installing the
software product to the DB, updating the DB, executing the Check Database command,
etc.). When adding the DB to the local list, the following parameters should be defined for
it in the configuration file:
Uri. The DB location. It is defined according to the JDBC standards.
Schema. The user name on the DB server.
Password. The DB user password. If this parameter is absent, the password will be
requested from the user.
Type. The DB type:
o ORACLE. This value is used by default if the Type parameter is missing from the
configuration file for the local DB being configured.
o POSTGRESQL
Test. The DB purpose:
o 1 - test DB
o 0 - production DB
DeploymentType. The DB server type. Available values:
o STANDALONE. Default value (it is used if the DeploymentType parameter is not
defined for the local DB in the configuration file).
o AWS_RDS
o ORACLE_ADB

The parameters are defined in one of the following formats:

RdxLocalDb.[DB_ALIAS].[PARAM_NAME]
RdxLocalDb_[DB_ALIAS]_[PARAM_NAME]
where:
DB_ALIAS - name of the DB to be added to the list
PARAM_NAME - parameter name.

For Linux OS, the recommended separator is "_".

Fragment of the manager.conf file with the local list of databases defined:
Example 1 - using "." separator:
RdxLocalDb.localDb1.Uri=jdbc:oracle:thin:@1.2.3.4:1521/DB2
RdxLocalDb.localDb1.Schema=schema1
RdxLocalDb.localDb1.Password=Pass1
RdxLocalDb.localDb1.Type=POSTGRESQL
RdxLocalDb.localDb1.Test=1

Example 2 - using "_" separator:

RdxLocalDb_localDb1_Uri=jdbc:oracle:thin:@1.2.3.4:1521/DB2
RdxLocalDb_localDb1_Schema=schema1

RWU - AG.ENG.06.12.2023. 179

2023 Compass Plus
 Appendix
Local List of Databases

RdxLocalDb_localDb1_Password=Pass1
RdxLocalDb_localDb1_Type=POSTGRESQL
RdxLocalDb_localDb1_Test=1

Local DBs can be used in the console version of the RadixWare Manager. For this, in the
console commands that require a connection to the DB, instead of the standard
arguments (DB_URL, DB_SCHEMA, DB_ALIAS), it is necessary to define the arguments of
the following type - RDX_LOCAL_DB* - which enable to define the local DB access
parameters. The local DB used in the console version may be missing in the local list of
the configuration file. For details, refer to List of Application Commands.
The capability to use the local DB can be disabled by adding RdxLocalDb.Enabled=0 to
the configuration file.

12.7 Memory Allocated for RadixWare Manager

The size of the memory allocated for the RadixWare Manager is defined in the JVM
parameters -Xms and -Xmx. These parameters are searched for in the following
sequence:
1.In the settings made in the RadixWare Manager startup files:
For Windows OS - in the manager/bin/manager.cmd file. The following values are
specified in this file, by default:
o For 32-bit Windows OS: -Xms128m -Xmx690m
o For 64-bit Windows OS: -Xms512m -Xmx2048m.
For Linux OS - in the manager/bin/manager file. The parameters -Xms and -Xmx are
absent in this file, by default.
2.If the parameters -Xms and -Xmx are absent in the startup files, the values specified
in the configuration file manager.conf located in the manager/etc directory of the
application will be used. The following values are specified in this file, by default: -
Xms512m -Xmx2048m.

12.8 Sequence of Update Package Numbers

When loading the update packages, take into account that their sequence numbers must
be successive. However, the vendor can prepare the update packages for customers in
which the released version is the same whereas the previous versions are different. Such
packages have similar sequence numbers and can be used, for example, to update the
software product in different environments.

Installing the updates for the TestCustomer customer in 2 different projects:

1.Project A where the following software product versions have been installed
successively:
org.radixware.testcustomer-1-1.1.29.10.1-install.zip
org.radixware.testcustomer-2-1.1.29.10.2 (1-1.1.29.10.1).zip

180 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Appendix
Sequence of Update Package Numbers

org.radixware.testcustomer-3-1.1.29.10.3 (2-1.1.29.10.2).zip
org.radixware.testcustomer-4-1.1.29.10.4 (3-1.1.29.10.3).zip
2.Project B where the following software product versions have been installed
successively:
org.radixware.testcustomer-3-1.1.29.10.3-install.zip
org.radixware.testcustomer-4-1.1.29.10.4 (3-1.1.29.10.3).zip

The following update packages have been prepared and delivered to this customer:
org.radixware.testcustomer-5-1.1.29.10.5 (4-1.1.29.10.4).zip
org.radixware.testcustomer-6-1.1.29.10.6 (5-1.1.29.10.5).zip
org.radixware.testcustomer-7-1.1.29.10.7 (6-1.1.29.10.6).zip

Option 1
Update the software product in Project A and Project B to version 1.1.29.10.7 using
the delivered update packages. Load these packages successively: copy the zip files
to the upgrades subdirectory of the application project directory; execute the Load
Updates commands to load the packages to the repository successively according to
their sequence numbers.

Option 2
Update the software product in Project A from version 1.1.29.10.3 to 1.1.29.10.7
(without installing the interim updates). Request the vendor to deliver a single update
package org.radixware.testcustomer-7-1.1.29.10.7 (4-1.1.29.10.4).zip. Then in
Project A (where the last installed update is com.tranzaxis.testcustomer-4-
1.1.29.10.4 (3-1.1.29.10.3).zip), it will be possible to directly install the package
com.testcustomer-7-1.1.29.10.7 (4-1.1.29.10.4).zip.

As a result, after the software product is updated to 1.1.29.10.7, the following update
packages will be loaded to each project (the names of the respective distribution kits
to be displayed in the Distribution Kits branch of the project navigation tree are
specified in brackets):
In Project A:
org.radixware.testcustomer-1-1.1.29.10.1-install.zip (1-1.1.29.10.1)
org.radixware.testcustomer-2-1.1.29.10.2 (1-1.1.29.10.1).zip (2-1.1.29.10.2)
org.radixware.testcustomer-3-1.1.29.10.3 (2-1.1.29.10.2).zip (3-1.1.29.10.3)
org.radixware.testcustomer-4-1.1.29.10.4 (3-1.1.29.10.3).zip (4-1.1.29.10.4)
org.radixware.testcustomer-7-1.1.29.10.7 (4-1.1.29.10.4).zip (7-1.1.29.10.7)
In Project B:
org.radixware.testcustomer-3-1.1.29.10.3-install.zip (3-1.1.29.10.3)
org.radixware.testcustomer-4-1.1.29.10.4 (3-1.1.29.10.3).zip (4-1.1.29.10.4)
org.radixware.testcustomer-5-1.1.29.10.5 (4-1.1.29.10.4).zip (5-1.1.29.10.5)
org.radixware.testcustomer-6-1.1.29.10.6 (5-1.1.29.10.5).zip (6-1.1.29.10.6)
org.radixware.testcustomer-7-1.1.29.10.7 (6-1.1.29.10.6).zip (7-1.1.29.10.7)

RWU - AG.ENG.06.12.2023. 181

2023 Compass Plus
 Appendix
Sequence of Update Package Numbers

The current version of the software product in both projects will be 1.1.29.10.7.
However, to update the software product to this version, different update package
have been used.

12.9 Frequently Asked Questions

The section contains a list of frequently asked questions and answers to them:
Certificate Usage Errors

12.9.1 Certificate Usage Errors

Question:
When loading the software update package to the repository, the following warming is
displayed: "File '*. zip' signed by not trusted certificate. Continue?"

where *. zip - software update package file. For example: org.radixware.community-

test-606-1.1.19.10.5 (604-1.1.19.10.4).zip
What actions should we take in this situation?

Answer:
This warning is displayed if the vendor has changed the certificate the software update
package is signed by. The problem can be solved in several ways:
1.Abort the process of loading the update package (select "No" when asked "Continue?"),
update the ca.pem certificate, and after that load the update package again. The new
certificate should be requested from the Product Support Service and loaded using the
Key Store Administrator utility (for details, refer to document [8]).
2.Confirm the update package installation (select "Yes" when asked "Continue?"):

Further the installation procedure is executed successfully. If the problem is solved this
way, it is necessary to apply for and load the new certificate (see item 1).

182 RWU - AG.ENG.06.12.2023.

2023 Compass Plus
 Glossary

13 Glossary

Term Definition

Vendor A company that develops software products and supplies them to other companies
(called customers)

Distribution kit A set of software product files for a particular customer including a certain set of
software product units

Customer A company that uses the software product supplied by the vendor

Unit A functionally separated part of software product

Update package A software product files package containing a set of update files and previous
release correction files

Initial A software product files package containing files and scripts for initial system
installation installation
package

Software product An edition of a software product; a deployable software package

release

Script A program containing a list of instructions modifying the database structure

performed sequentially without user interaction

Product A set of layers stored in a separate directory of the SVN repository. It can operate
as a separate product or can be included in the software product in use (in this
case, the end software product is built to a single system consisting of several
products)

RWU - AG.ENG.06.12.2023. 183

2023 Compass Plus