RadixWare Administrator Guide/RadixWare Upgrade

From RadixWiki
Jump to: navigation, search

Contents

Revision History

Date RadixWare Manager Version Description of Changes
15.11.2018 1.2.11.29 Added the facility to check the compatibility between the database structure and metainformation of the current software product version. The check is performed:
  • automatically when updating DB;
  • manually by means of the Check Database command located in the context menu of branches containing the software product version (branches of distribution kits, releases in distribution kits, and test, production and release branches).

Updated sections:

02.08.2018

1.2.11.29

To the dialog box used to submit software product for testing/production, added the Synchronize replicas flag.

Updated sections:

To the console version of RadixWare Manager, added the following arguments:
  • QUESTION_YES_SPECIFIC
  • QUESTION_NO_SPECIFIC

Updated sections:

Supported new mechanism of checking the compatibility of user-defined functions. As such:
  • To the dialog box used to submit software product for testing/production, added the Check user-defined functions before update flag.
  • To the context menu of branches containing the software product version (release branches in distribution kits, branches of testing, production and releases), added the Check User-Defined Functions command.
  • Eliminated the Analysis of API Compatibility command of the context menu

Added section Checking User-Defined Functions during Update Installation

Updated sections:

Deleted section Analysing API Changes

Changed the algorithm of updating the software product: now, if there are changes in the hierarchy of software product layers, the system needs to be stopped.

Updated section Analysing System Changes

To the editor of project settings, on the Directories page, added the Details Log Directory parameter.

Updated sections:

To the console version of RadixWare Manager, added the USE_BRANCH argument.

Updated section List of Application Commands

02.08.2018

1.2.11.28

Added requirements to the database user password.

Updated section Installing Software Product / Submitting Software Product for Testing/Production

Changed the algorithm of updating DB: now, if the update procedure has been interrupted, the next update procedure will be started from the interrupted script.

Updated section Updating Software Product / Submitting Software Product for Testing/Production

Changed the applicability conditions for the following parameters located in the manager.conf configuration file:
  • MinPasswordCharacters
  • MinPasswordDigits
  • MinPasswordSpecialCharacters

Updated section Appendix F. RadixWare Manager Configuration File

Changed the output format of the information on system changes displayed in the Changes field in the dialog box used to execute the Analyse System Changes command.

Updated section Analysing System Changes

To the context menu of the main branch, added the Create Production Branch command.

Updated sections:

To the console version of RadixWare Manager, added the DATABASE_DRIVER_PATH argument.

Updated section List of Application Commands

Added display of scripts execution time in the scripts execution log file.

Updated section Appendix C. Scripts Execution Log File

To the project navigation tree, added display of versions of software product layers.

Updated section Project Structure

04.04.2018

-

Added note on RadixWare Manager operation on UNIX platforms.

Updated section System Requirements

Added the recommended base values for the Oracle DB initialization parameters.

Updated section Installing Oracle on DB Server

Added the information on the use of Subversion Edge v.5.x and higher.

Updated section Installing and Configuring Subversion Server

Updated the recommendations for the JDBC driver version.

Updated section Setting up Database Access Parameters

25.09.2017

1.2.11.2

Changed the procedure for submitting the distribution kit for testing / production (modified the mechanism of executing the Build, Install to Database, and Update in Database commands).

Added sections:

Updated sections:

Conventions and Abbreviations

Conventions

Convention Example Applies to
Italic Copy the manager.zip archive to the local disk of the workstation. Names of the files, directories, subdirectories, websites; values of the parameters
Bold RadixWare Manager is to be installed on the administrator workstation Terms introduced for the first time; names of the software products; names of the user interface elements, application units, parameters, fields, operations, tags
Text in brackets "<" and ">" <Layer> - the software product layer name.' Variable
Text afterNote.jpg Note.jpgRadixWare Manager must be installed before installing the software product. Notes
Text afterExample.jpg Example.jpgWhen installing RadixWare, Install URI is as follows: org.radixware Examples


Abbreviations

OS Operating System
DB Database


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 RadixWare platform and the RadixWare Manager application functionality at the development and customer support stages are described in the RadixWare. Software Support Guide documentation.


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.

Related Documents

# Document Name Description
1 RadixWare. Overview. RW_Overview(E).pdf The document describes the RadixWare system: purpose, composition, technologies, capabilities and features, structure and architecture.
2 RadixWare Explorer. User Guide The document describes the capabilities of the RadixWare Desktop Explorer and RadixWare Web Explorer applications and methods of executing various operations.
3 RadixWare. System Administrator Guide RW_SystemAdministratorGuide(E).pdf The document is intended for the RadixWare system administrator and provides the instructions on the overall system configuration.
4 RadixWare Server. Administrator Guide The document describes the RadixWare Server application and its startup procedure.
5 RadixWare Starter. Administrator Guide The document describes the RadixWare Starter application and its startup procedure.
6 RadixWare Web Presentation Server. Administrator Guide The document describes the RadixWare Web Presentation Server application and its startup procedure.
7 RadixWare. Software Support Guide The document describes the general concept of how to support the RadixWare-based software products and work with the RadixWare Manager application when developing software products and supporting customers.
8 RadixWare. Key Store Administrator Utility. Administrator Guide The document describes the Key Store Administrator utility.
9 RadixWare. Programmer Guide The document describes the principal concepts, objects and functionality of the RadixWare technological platform and RadixWare Designer application used to develop applications on basis of RadixWare platform.

RadixWare Manager Overview

On the customer side, RadixWare Manager is used to install and update software products. In compliance with PCI DSS requirements, RadixWare Manager provides the facility to verify the authenticity of file packages received from vendor employing the Digital Certificates technology.

RadixWare Manager provides tools for informing

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

It is possible to employ RadixWare Manager application by using GUI or console.

Principle of Functioning

RadixWare platform components interact as follows:

Structure.jpg

  • 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, 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 the RadixWare. Software Support Guide documentation. 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 the Installing RadixWare Manager section). 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 the Project Structure section).

During the initial software product installation, RadixWare Manager initializes the repository and installs 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.

System Requirements

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

Note.jpg To work with the GUI version of the RadixWare Manager installed on Unix platforms (Linux, AIX and other OS), the window manager for X Window System may be required.
Note.jpg 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, AIX 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 page of the Tools | Options item of the main menu).

The workstation must have Java JDK version 1.7.x/1.8.x installed. It is recommended to use the latest Java version.

The RadixWare Manager requires installing neither SVN client nor Oracle client.


Installing and Updating Software Product

Preparing to Software Product Installation
Before installing a software product based on the Radix 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.

Example.jpgorg.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 file format of the software product package, refer to Appendix A. Software Product File Packages.
2. Prepare to install the RadixWare Manager application, create a project, set up the project and repository parameters.

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:

Example.jpgThe procedures of 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.

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, test DB is installed.
3. After the software product is successfully tested, it can be put into production. At that, the production DB is installed.
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:

Installing and Configuring External Software Products

Installing Oracle on DB Server

The technical requirements to the DB server are described in the documentation on the respective software product being installed. When installing Oracle Software keep only the Partitioning option enabled (if this option is supported by 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, in the Oracle DB, create the tablespaces. The procedure is performed by using the tablspaces.sql script (for the example of script, go to http://radixware.org/downloads.html).
The DB administrator must perform as follows:
1. Download the tablspaces.sql script.
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 and etc.)
3. Run the tablspaces.sql script on the DB as required.

Installing and Configuring Subversion Server

Note.jpgThe 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).
Note.jpgSubversion Edge is provided as an example of how to install and set up the Subversion server. It is possible to use any other software to configure the Subversion server.

The Subversion Edge installation procedure is as follows:
1. Download the Subversion Edge installation file from the official Web site http://www.collab.net/.
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 of repository directory creation by using the svnadmin create command and specify the path that has been described in the Repository Path parameter during the Subversion Edge installation.

Example.jpgThe svnadmin create C:\radinsk_repository command creates the repository structure in the C:\radinsk_repository directory.

5. Edit the SVN configuration files located in the conf subdirectory of the created repository (for example, C:\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 = Radix Repository (or any other name of the repository. This name is requested during authorization 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)
Note.jpgWhen 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.

6. Restart the CSVNsvnserve service from the command line by using the following commands:

net stop CSVNsvnserve
net start CSVNsvnserve

Installing and Starting RadixWare Manager

RadixWare Manager is delivered to the customer as a zip file (manager.zip) together with the initial installation package.

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 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:

Install system 2.jpg

To open the application, run the executable file located in the bin directory. The executable file is OS specific:

  • manager.exe – for 32-bit Windows
  • manager64.exe – for 64-bit Windows
  • manager – for Linux OS

After that, the main dialog box of the RadixWare Manager application opens:

Install system 1.jpg

For details on the application console startup, refer to Working with RadixWare Manager Console Application.

Updating RadixWare Manager

The RadixWare Manager update package is delivered as a zip archive (manager.zip) together with the software product update package. This archive is present in the package only if there is a new version of RadixWare Manager available. 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:

Update RWM 1.jpg

If the user refuses to update the application, the system displays the dialog box suggesting to remind the user on the updated version at the next RadixWare Manager start up:

Update RWM 2.jpg

If the user does not want to be reminded, this dialog box will not be displayed at the next RadixWare Manager start up 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, the application is automatically restarted.

Working in GUI Application of RadixWare Manager

Creating Project

Working with 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:

Create new project 1.jpg

The 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. 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 during the CollabNet Subversion Server setup (for example, SVN://10.7.2.231).
  • SVN Authentification. The user authentication method when accessing the repository.
  • SVN User Name. The SVN repository user name specified during the CollabNet Subversion Server setup.
Note.jpgTo 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.
Note.jpgIt 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 upper layer included into the software product distribution kit).

Note.jpgIt is recommended to ask vendor about the URI of layer that is the upper layer in the product being installed.
Note.jpgIf 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 leave 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 creating the project, click the Finish button; to cancel creating the project, click the Cancel button. The main dialog box of RadixWare Manager after the project creation is as follows:

Create new project 1.jpg

Project Directory The project creation result will be a directory with the following structure:

Create new project 3 .jpg

  • 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 pf 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.
  • project.xml file. The file contains the project settings.
Note.jpgA project created on a computer can be then copied to other computers.

When working with RadixWare Manager, the project can be opened in one of the following ways:

  • automatically at the application startup (the projects used during the previous session are opened)
  • by selecting File | Open Project on the menu

RadixWare Manager User Interface

The RadixWare Manager user-defined interface is based on the interface of NetBeans platform. For the detailed description of the interface and its settings, refer to the NetBeans application documentation. This section contains the description of its main components.

Generally, the main dialog box of RadixWare Manager is as follows:

User interface 15.jpg

The header displays the application name and its current version. The menu bar under the header contains the application main menu and the quick search dialog box. 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. Working with RadixWare Manager implies the use of:

  • application main menu
  • contextual menu of a particular dialog box (see below)
  • contextual menu of a project tree element selected in the Project dialog box (see Project Structure)

Main Menu

The following table describes the application main menu items:

Menu Item

Subitem

Icon

Description

File

Open Project...

user_interface_25.jpg

Opens a project (Ctrl+Shift+O).

Calls the dialog box for selecting the directory. The project directory is marked with user_interface_4.jpg.

Open Recent Project

-

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

Close Project

-

Closes the current project

Project Properties

-

Opens the current project editor (see Editing Project Parameters)

New Project

-

Creates a new project

Save

-

Saves the modified project item to the SVN repository (Ctrl+S)

Save All

user_interface_26.jpg

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

Exit

-

Closes RadixWare Manager

Tools

Options

-

Opens the application general settings. For details, refer to the NetBeans application documentation. The Miscellaneous item of the Options dialog box contains the following specific settings:

  • On the General page, the Jdbc driver file specific parameter is used to define the path to jdbc driver used by the RadixWare Manager application. If the driver file is absent in the specified directory, the parameter value is highlighted in red.
  • The Mail page is used to set up access to mail server.

Window

Projects

user_interface_27.jpg

Opens the Projects dialog box in the working area (Ctrl+1)

Files

user_interface_28.jpg

Opens the Files dialog box in the working area (Ctrl+2)

Favorites

user_interface_29.jpg

Opens the Favorites dialog box in the working area (Ctrl+3)

Output

user_interface_30.jpg

Opens the Output dialog box in the working area (Ctrl+4). The submenu contains a list of active pages of the Output dialog box.

Close Window

-

Closes the current dialog box - Ctrl+W

Maximize Window

-

Maximizes the current dialog box to the size of the application main window (Shift+Escape)

Undock / Dock Window

-

Undocks/docks the current dialog box from/to the application main dialog box(Alt+Shift+D)

Close All Documents

-

Closes all opened files (Ctrl+Shift+W)

Close Other Documents

-

Closes all opened files except for the current one

Documents...

-

Opens the Documents window containing the list of open files (Shift+F4)

Possible 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 window.

Reset Windows

-

Restores the opened dialog boxes to their source positions

Help

Update from Zip File

-

Updates the application from the zip file (for details, refer to Updating RadixWare Manager)

Check update

-

Check 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 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 pages. Each page 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 Description
User interface 17.jpg Shows the list of opened files. To switch to the required file, select it from the list.
User interface 18.jpg 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.
User interface 16.jpg Switches between the opened file dialog boxes
User interface 20.jpg Closes the dialog box

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

Menu Item Description
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)

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

Button Command Description
User interface 34.jpg Find Selection Finds the text selection (Ctrl+F3)
User interface 35.jpg Find Previous Occurrence Finds the target text combinations above the current string (Shift+F3)
User interface 36.jpg Find Next Occurrence Finds the target text combinations below the current string (F3)
User interface 37.jpg Toggle Highlight Search Finds all the target text combinations in the text (Alt+Shift+H)
User interface 38.jpg Shift Line Left Shifts the text selection one position to the left (Alt+Shift+Left)
User interface 39.jpg Shift Line Right Shifts the text selection one position to the right (Alt+Shift+Right)
User interface 40.jpg Comment Comments the text selection (the button is available in the script editor only)
User interface 41.jpg 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 window, press Ctrl+I. To select the category, press Shift+F10.

Embedded Windows

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 page in the Output dialog box, the operation name is displayed in the page header.
  • Files. The dialog box displays the physical structure of the project directories and files in the form of a navigation tree.
  • 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 windows:

Button Description
User interface 19.jpg/User interface 21.jpg/User interface 22.jpg Minimizes the dialog box to a taskbar (bottom/left/right). When the cursor points to the icon in the taskbar, the dialog box opens.
User interface 23.jpg

Restores the minimized dialog box

User interface 20.jpg

Closes the dialog box

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

  • Projects Window

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

Menu Item Description
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 User interface 4.jpg.
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 Structure section.

  • Output Window

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

Menu Item Description
Copy Copies the text selection to clipboard (Ctrl+C)
Paste Pastes the text from clipboard (Ctrl+V)
Find... Searches for text (Ctrl+F)
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 pages of the Output dialog box, the context menu in its header is used. The menu items are described in the following table:

Menu Item Description
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 Description
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 Favorites Adds a new directory to the list of favorite values
Properties Displays the Application Data - Properties dialog box with the following parameters:
  • Name - object name
  • Sort mode - sorting mode

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

Menu Item Description
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 Favorites Adds a new directory to the list of favorite values
Save as Template Saves the file as the template to the selected path
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 Description
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 Favorites Adds the new directory to the list of favorite values
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

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

Menu Item Description
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 Favorites Adds a new file to the list of favorite values
Properties Displays the Application Data - Properties window with the following parameters:
  • Name - object name
  • Sort mode - sorting mode
Add to Favorites Adds a new file to the list of favorite values

Project Structure

A project has a tree-like structure composed of the following elements: branches, directories, files. To expand/collapse a tree branch or a directory, click User interface 31.jpg or User interface 32.jpg 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
<Project Title> User interface 4.jpg Main project branch
Config User interface 12.jpg Settings branch. The branch contains the repository general settings.
Distributives User interface 7.jpg Distribution kits branch. The branch contains the software product distribution kits received from the vendor.
Scripts User interface 9.jpg Scripts branch. The branch contains the scripts for:
  • primary installation of all software product layers
  • installation of software product versions for all layers
Development User interface 6.jpg Development branch. The branch contains the software product files distributed by development subbranches. The branch is used by the vendor. For details, refer to the RadixWare. Product Support Guide documentation.
Releases User interface 8.jpg Releases branch. The branch contains the software product releases. For details, refer to the RadixWare. Product Support Guide documentation.
Clients User interface 5.jpg Customers branch. The branch contains subdirectories with the software product distribution kits for customers (separately for each customer). For details, refer to the RadixWare. Product Support Guide documentation.
Archive User interface 3.jpg Archive branch. The branch contains the customer description, software product releases and distribution kits, scripts relating to the outdated software product versions. For the details, refer to the RadixWare. Product Support Guide documentation.
Test User interface 10.jpg Test branch. The branch contains the software product test files. The branch is used during the software product testing.
'Production User interface 11.jpg Production branch. The branch contains the software product production files. The branch is used when the product is in production.
Note.jpgIf the customer has no own developments, the Сustomers, '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 .

Note.jpgThe 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 refer to the RadixWare. Product Support Guide documentation.

Main Project Branch

This is the repository root directory.

The following table describes the context menu commands of the main project branch:

Name Description Context Menu Specific Commands
<Project Title*> *<Project Title> - project name
  • Configure
  • Initialize Replica
  • Create Test Branch
  • Create Production Branch
  • Validate
  • Close
  • Reopen


Settings Branch

Structure project 2.jpg

Example of the Config branch structure

The branch has the following structure:

Config/
Databases
Notification
Replication
Repository

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

Name Description Context Menu Specific Commands
Databases The database access parameters editor Configure
Notification The notification service parameters editor Configure
Replication The replication parameters editor Configure
Repository The repository parameters editor Configure


Distribution Kits Branch

Structure project 1 .jpg

Example of directories structure in the Distribution Kits branch

The branch has the following structure:

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

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

Name Description Context Menu Specific Commands
Distribution Kits The branch containing the software product distribution kits the customer receives from the vendor. The distribution kits are grouped by the software products of a customer.
  • Load Upgrades
  • Create Product
<Product*> The software product distribution kits directory. The distribution kits are sorted by the package number in descending order.

<Product*> - software product name (the software product upper layer URI is specified in brackets)

  • Configure Distribution Kit Layers
  • Delete
<Distribution Kit*> The distribution kit directory.

*<Distribution Kit> - the software product distribution kit number in the format <N - D>, where N - package sequence number D - distribution kit number composed of the release number (f.f.f.f) and optionally distribution kit version (V)

  • Configure
  • Build | <Test> Environment
  • Build | <Production> Environment
  • Export Starter
  • Export Web-App
  • Check User-Defined Functions
  • Analyse System Changes
  • Generate User Creation Script
  • Generate Product Installation Script
  • Layers Information
  • Check Database
  • Delete
Scripts The directory containing the database scripts distributed between the software product layers (<Layer>*).

*<Layer> - the software product layer name

The following commands are available for the software product layer branches:
  • Create Downgrade Scripts
  • Save Scripts to File
Release The directory containing the software product files distributed between the software product layers (<Layer>). For details on the software product layer structure, refer to here.
  • Configure
  • Install to Database
  • Update in Database
  • Check User-Defined Functions
  • Analyse System Changes
  • Generate User Creation Script
  • Generate Product Installation Script
  • Export XSD Schemas
  • Export HTML Documentation
  • Layers Information
  • Check Database
Properties Depending on the location contains one of the following editors: Configure


Scripts Branch

Structure project 3.jpg

Example of directories structure in the Scripts branch
The branch has the following structure:

Scripts/
<Layer>/
<script type>/
<Ri - Rj>/
<script>.sql
script.xml

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

Name Description Contextual Menu Specific Commands and Procedures
Scripts The branch containing the database scripts. The script packages are distributed between the software product layers (<Layer>). Absent
<Layer*> The directory containing the scripts for a certain software product layer (<Layer>).

*<Layer> - the software product layer name

Absent
<Ri - Rj*> The script package. The scripts are sorted by the batch number in the descending order.

*<Ri - Rj> - the 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. Rj - destination release number; for pre-scripts, it is x. The packages of downgrade scripts are marked in italic font in the project tree. The empty packages of scripts are highlighted in gray in the project tree.

Create Downgrade Scripts
<script*>.sql The file containing the script or the fix.

*<script> - script number

Absent
scripts.xml The file with the scripts description (optional). The file registers the scripts and the states the lower layers must have before the script runs. Absent


Test Branch

Structure project 4 .jpg

Example of directories structure in the Test branch

The branch has the following structure:

Test/
<Layer>/
Properties

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

Name Description Contextual Menu Specific Commands and Procedures
Test The branch containing the software product release test files. The branch is used during the software product testing.
  • Install to Database
  • Update in Database
  • Send to | <Test>
  • Send to | <Production>
  • Export Starter
  • Export Web-App
  • Export XSD Schemas
  • Export HTML Documentation
  • Check User-Defined Functions
  • Analyse System Changes
  • Generate User Creation Script
  • Generate Product Installation Script
  • Layers Information
  • Check Database
<Layer*> The directory containing the software product files distributed between the software product layers (<Layer>). For details on the software product layer structure, refer to here.

*<Layer> - the software product layer name

Show License


Production Branch

Structure project 5 .jpg

Example of directories structure in the Production branch

The branch has the following structure:

Production/
<Layer>/
Properties


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

Name Description Contextual Menu Specific Commands and Procedures
Production The branch containing the software product production files. The branch is used when the product is in production.
  • Install to Database
  • Update in Database
  • Export Starter
  • Export Web-App
  • Export XSD Schemas
  • Export HTML Documentation
  • Check User-Defined Functions
  • Analyse System Changes
  • Generate User Creation Script
  • Generate Product Installation Script
  • Layers Information
  • Check Database
<Layer> The directory containing the software product files distributed between the software product layers (<Layer>). For details on the software product layer structure, refer to here.

*<Layer> - the software product layer name

Show License
Properties The release parameters editor Configure


Software Product Layer

Structure layer .jpg

Example of directories structure in the software product layer

The branch has the following structure:

<Layer>/
<Segment ADS>/
<Modules of Segment DDS>
<Segment DDS>/
<Modules of Segment DDS>
<etc>/
<Segment Kernel>/
<Modules of Segment Kernel>
<Segment UDS>/
<Modules of Segment UDS>
THIRDPARTYLICENSE.txt
directory-layer.xml
directory.xml
layer.xml
license.txt
licenses.xml

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

Name Description Contextual Menu Specific Commands and Procedures
<Layer> Name of software product layer. Show License
<Segment> Name of software product layer segment. Each layer contains the following segments:
  • Application Definition Segment (ADS). The segment contains the application model presented as a set of definitions united in the units.
  • Database Definition Segment (DDS). The segment contains the model of software 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.
Show License
<Module>/<File> Units and files included in the segment. Show License
etc Directory containing the additional files included in the software product distribution kit. Absent
THIRDPARTYLICENSE.txt File with license information on external software product. Absent
directory-layer.xml System file. Absent
directory.xml System file. Absent
license.txt File with license information on layer and its components. Absent
licenses.xml System file containing the information on layer license. Absent

Project Commands

Common Project Tree Commands

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

Command Description
Refresh Updates the selected element contents
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 Shut.jpg (Close)
  • by the Cancel Progress command of the indication area context menu
Copy URL Copies SVN URL of the selected element to clipboard
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 directories / branches:

Command Description
Checkout Creates a working copy of a repository directory selected in the tree. The path to save the working copy to is specified in the dialog box that opens.

The export command is interrupted using the procedure execution indicator area located in the right bottom part of the application main dialog box:

  • by clicking Shut.jpg (Close)
  • by the Cancel Progress command of the indication area context menu

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

Command Description
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 Description
Validate Checks the physical structure of the project repository and brings it in compliance with the requirements
Create Test Branch Creates the test branch in the project repository. The command opens the dialog box for specifying the branch name.
Create Production Branch Creates a production branch in the project repository. The command opens the dialog box for specifying the branch name.
Close Closes the project
Reopen Reopens the current project
Initialize replica Initializes the replica
Load Updates Loads the software product update package to the repository
Build / <Test> Environment Starts the procedure of moving the distribution kit to the test branch, where <Test> is the name of the test branch the distribution kit will be moved to. By default, the project contains only the Test branch. To create additional test branches, use the Create Test Branch command in the context menu of the main branch of the project tree.

If the URI of the product the distribution kit relates to is missing in the System Products in Use list, the command becomes unavailable, and the reason for it is specified in the name of this command (in brackets): "product '<uri>' not used in this system".

Build / <Production> Environment Starts the procedure for moving the distribution kit to the production branch where <Production> is the name of the production branch the distribution kit will be moved to. By default, the project contains the Production branch only. To create additional test branches, use the Create Production Branch command in the context menu of the main branch of the project tree.

If the URI of the product the distribution kit relates to is missing in the System Products in Use list, the command becomes unavailable, and the reason for it is specified in the name of this command (in brackets): "product '<uri>' not used in this system".

Send to / <Test> Starts the procedure for moving the distribution kit loaded to the current test branch to another test branch.
Send to / <Production> Environment Starts the procedure for moving the distribution kit loaded to the current test branch to the production branch.
Delete Deletes the software product/distribution kit

Note.jpg 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.

Install to Database Starts the database installation procedure
Update in Database Starts the database update procedure
Export Starter Exports the starter.jar file. The command opens the dialog box for selecting the directory to save the file to the local disk.

Note.jpg The starter.jar file is used to start the RadixWare applications. For details, refer to RadixWare Starter. Administrator Guide.

Export Web-App Exports the Web-App.war file. The command opens the dialog box for selecting the directory to save the file to the local disk.

Note.jpgThe Web-App.war file is used to start the RadixWare web applications. For details, refer to RadixWare Web Presentation Server. Administrator Guide.

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):

The editor can be also opened by double-clicking the selected editor.

Create Downgrade Scripts Generates the scripts changing the DB structure in order to downgrade to the previous software version.

To downgrade to the previous version, the created scripts must be finalized by the administrator. The command is available in the contextual menu of scripts package if the package is not empty and does not contain the downgrade script.

Save Scripts to File Unloads the scripts updating the DB structure to file. The command opens the dialog box with the following parameters:
  • Source Release. The software source release.
  • Target Release. The software release to update to.

Clicking the ОК button opens the dialog box to select the file to save the scripts to. The ОК button is available if the Target Release parameter value is more than the Source Release parameter value.

Create Product Creates an empty software product directory in the distribution kits branch. The command opens the dialog box with the Product URI parameter. The parameter is used to specify the upper layer URI for the software product supplied by the vendor.
Configure Distribution Kit Layers Opens the Create Copy dialog box used to edit the software product layers.
Export XSD Schemas Exports XSD schemas of software product definitions. For details on how the command is executed, refer to Export of XSD Schemas for Software Product Definitions.
Export HTML Documentation Generates the HTML description of the software product API. The HTML description is based on the radixdoc.zip files included in the software product modules. The command sequentially opens:
  • The dialog box for selecting the directory used to save the files on the local disk.
  • The dialog box for selecting the language of the document with the API description. To select the language, set the flag next to the required language in the list. The list includes the languages from all layers of the distribution kit or from the test / production branch (depending on the context in which this command is called). By default, all languages are selected.

Choose languages.jpg

Check User-Defined Functions Checks compatibility of user-defined functions in different versions of software product. For details, refer to Checking User-Defined Functions during Update Installation
Analyse of System Changes Prepares and displays information on certain actions to be performed when updating the software product release version. For details, refer to Analysing System Changes.
Generate User Creation Script Generates a user creation script for the database to be imported to the schema of this user. When executing the command, specify the path to a file the script will be saved to. The command is called if the database import is required. The script generated by this command needs to be run by any available means before the database import.
Generate Product Installation Script Generates a product installation script. When executing the command, specify the path to a file the script will be saved to.
Show License Shows the license information on the software product components. The license text is stored in the license.txt file. The layer license is used in the layer units by default.
Layers Information Shows information on the software release layers. The following information is displayed in the dialog box:
  • layer URI
  • release version
  • URI of base layers
  • list of languages supported in the layer

Layer info .jpg

The Copy to Clipboard command (Layer info copy command.jpg button) copies the layer information to clipboard.

Check Database Checks the compatibility between DB structure and metainformation of the different versions of the software product. The software product version to be compared with the 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).
Note.jpgThe command is available only in branches containing RadixWare 2.1.20.x and later versions.

When executing the command, it is necessary to specify the database whose structure will be checked. The value is defined in the dialog box containing the following parameters:

  • Database. The value is selected from the drop-down list of databases registered in the project.
  • User <schema> Password. The password of DB user.

When executing the command, the system searches for:

  • invalid database objects (for Oracle); 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 with the format Log_<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)).
Note.jpgIf errors and warnings have been detected during the check, it is recommended to submit the command execution result to the Product Support Service.

Setting up Project and Repository

A project in RadixWare Manager has the following parameters:

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 in one of the following ways:

  • by double-clicking on the main project branch
  • by using the main project branch context menu (Configure command)
  • by using the File | Project Properties menu item

The project editor looks as follows:

Settings 7.jpg

The editor contains the following pages:

  • 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 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 window 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.
Note.jpgRadixWare 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.
  • SVN User Name. The SVN repository user name 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 the Settings 8.jpg button opens a window used to select the file. The parameter is to be defined if the SSH Key File authentication method is used.
  • Project Location. The location of the project directory. Clicking the Settings 8.jpg button opens a window 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 a 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 during the test DB installation/update.
  • Upgrades Prod Log Directory. The subdirectory where the application automatically saves the log files created during the production DB installation/update.
  • 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 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 during the DB installation/update 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 the Settings 8.jpg button that opens a window 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 page contains the following:
    • The parameters for setting up the certificates storage:
      • Key Store Type. The storage type. The value is selected from the drop-down list:
        • FILE - the certificate is stored as a file on a local disk.
        • PKCS11 - the certificate is stored on an electronic device.
      • Key Store File. The parameter purpose depends on the storage type:
        • If the storage type is FILE, specify the path to the file with the certificates storage. By default, the system offers to create the certificates storage in the keystore subdirectory located in the project directory. The file format is *.jceks. The storage file location is changed by clicking Settings 8.jpg button that opens a window used to select the file.
        • If the storage type is PKCS11, specify the location of the device configuration file by clicking Settings 8.jpg button that opens a window 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 a Project). If the certificate storage was not defined at the project creation, the certificate can be created and set up on this page. It is also possible to change the location of the already created storage.
  • Key Store Administrator. The button is used to call the Key Store Administrator utility for managing the keys and certificates storage. By using the utility, the digital certificate received from the vendor is loaded and checked. For details, refer to RadixWare. Key Store Administrator. Administrator Guide.

For the digital signature verification setup procedure, refer to Setting up Digital Signature Verification.

Setting up Digital Signature Verification

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

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

How to Set up Digital Signature Verification for File Certificates Storage

1.Set up the certificates storage (if this setting was not defined during the project creation). For this purpose, on the Key Store page of the project parameters editor 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 certificates storage. Clicking Settings 8.jpg button opens a dialog box used to select the file. 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 certificates storage. To load and view the certificates, use the Key Store Administrator utility (this utility allows managing the keys and certificates storage; it is called by the respective button). At the utility logon, the certificates storage availability in the specified file is checked:

  • If the storage exists, the Login to Key Store dialog box opens where the access password must be entered.
  • If the storage does not exist, RadixWare Manager offers to create the storage. After the creation confirmation, the Create Key Store dialog box opens where the storage password must be set.

Note.jpgIf the Key Store File parameter is not set, RadixWare Manager will display the corresponding warning when calling the utility.

To load the digital certificate, use the Load Trusted Certificate utility command. Loading command parameters:

  • Alias. The name under which the certificate will be saved to the storage.
  • Certificate File. Clicking Settings 8.jpg 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, refer to RadixWare. Key Store Administrator. Administrator Guide.

How to Set up Digital Signature Verification for Storing Certificates on Electronic Device

1.Install the drivers for the device. 2.Set up the certificates storage (if this setting was not defined during the project creation). For this purpose, perform the following on the Key Store page of the project parameters editor:

  • 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 by means of the Key Store Administrator utility (the 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 of the software product zip files is verified automatically when the file package is loaded to the repository (see below). RadixWare Manager starts loading the file only if the signature is valid. If the signature is not valid, RadixWare Manager stops loading the package and displays the respective warning.

Note.jpgWhen loading several update packages, the signature correctness is verified only once (the 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
  • there is no possibility to check the certificate (the certificates storage is not set up, there is no access to the storage, etc.)

If at least one of these circumstances is present, RadixWare Manager will ask to confirm the operation.

Setting up Database Access Parameters

The Databases database access parameters are set up in the editor in the Config branch. The editor can be opened by one of the following ways:

  • by double-clicking on the Config | Databases project branch
  • by using the Configure command of the Databases project editor context menu

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

Settings 1.jpg

The editor includes the following components:

  • Databases. The area contains a list of databases.
The list is created by using the Add and Remove buttons. When adding a database, define the following parameters in the New Database dialog box:
  • Name. The database name.
  • URL. The database location. The value is defined according to the JDBC standards in the following format: jdbc:oracle:thin:@host:port/SID, where:
    • jdbc:oracle:thin:@ - constant
    • host – IP address or DNS name of DB server
    • port – port number (by default, 1521)
    • SID – database ID (by default, it is similar to the database name)
  • Schema. The user name on the database server.
  • Test. The database type:
    • if the flag is set - the test database
    • if the flag is not set - the production database

For editing, double-click on the selected record field.

Example.jpgExample of adding a test database with the RadixDbConnection name and IP address localhost.

New database.jpg

  • Parameters. The area contains a list of additional parameters used when installing/updating the currently selected database. These parameters are used for writing scripts. Each software product has own set of parameters.
The list is created by using the Add and Remove buttons. When adding a parameter, define the following parameters in the New Parameter dialog box:
  • Name. The parameter name.
  • Description. The parameter short description.
  • Value. The parameter value.

For editing, double-click on the selected record field.

Note.jpgTo access the DBs, the jar-file with JDBC-driver is required. It can be the ojdbc6.jar file that is delivered in the Oracle Client distribution kit. At the first execution of any operation requiring the DB access (DB update, installation), the user will be offered to select the used jar file.
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 should correspond to the Java version installed.
The path to jdbc driver used by the RadixWare Manager application can be specified in the Jdbc driver file parameter in the application settings.

Editing Repository Parameters

To view / edit the repository parameters, go to the Repository editor in the Config project branch. 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 one of the following ways:

  • by double-clicking on the Config | Repository project branch
  • by using the Configure command of the Repository project editor context menu

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

Settings 2.jpg

The editor contains the Main and Options pages:
"Main" Page The page 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 upper 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" Page
The page contains the Search downgrade scripts when creating distribution kit parameter used to define where it is required to check presence of downgrade scripts for releases from offshoot development branches. The check should be performed in the repositories of vendors whose customers have own development. Available values:

  • None. The check is not performed.
  • One. The check is performed. Once the first error is found, the check is interrupted with the respective message.
  • All. The check is performed. The list of found errors is displayed to the customer after the check is complete.

Editing Replication Parameters

To arrange the functioning of 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 used project (see below).
  3. Initialize 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 project branch. The editor can be opened by one of the following ways:

  • by double-clicking on the Config | Replication project branch
  • by using the Configure command of the Replication project editor contextual menu

Note.jpgIt 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 contextual menu of the Config project branch . When opening the editor, the following dialog box is displayed in the application working area:

Settings 4.jpg

The editor contains the following components:

  • The list of the current repository replicas. Each replica is characterized by the following parameters:
    • Name. The replica name.
    • SVN Home URL. The location of the SVN repository replicas. The URL is written by the standard rules used when working with the SVN repository.
    • Check. The button is used to check the repository availability. Depending on the user authentication method (see below), the user can be prompted to enter the password when checking.
    • 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.
    • SVN User Name. The user name under which the access to the repository is performed.
    • Reset Password. The button is used to reset the current user password. The button is available if in the current RadixWare Manager session the user entered the repository password. After the password is reset, the new one can be entered when clicking the Check button.
    • SSH Key File. The private key file location. The parameter is available if the 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 Settings 8.jpg button.
  • The buttons for managing the replica:
Button Command Description "Hot" Keys
Add .jpg Add New Replica Adds the new repository replica Ins
Del.jpg Remove Selected Replica Removes the selected replica Del
Settings 5.jpg Replicate Copies the data of the current project repository to the selected repository replica -

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 parameters, go to the Notification editor (the Config project branch). In the notification service parameters editor, the administrator creates the e-mail letter templates and assigns the notification recipients for each event. The editor can be opened by one of the following ways:

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

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

Settings 9 .jpg

The editor contains the Events and Options pages.

"Events" Page

The page contains the following components:

  • The list of events for sending notification. For each event, on the Letter and Subscribers pages, the letter template set up the letter template and create a list of subscribers.
  • The buttons for managing the list of events:
Button Command Description
Add .jpg Add new event Adds the new event
Del.jpg Delete event Deletes the selected event
Settings 10.jpg Configure languages The command opens the Choose Languages dialog box used to select the notification languages.
  • The Letter page is containing the Default subpage used to set up the default letter template for the selected event. The Letter page can also contain the subpages used to set up the letter template in the languages supported by the application (languages specified in the Choose Languages dialog box). Each subpage contains the following areas:
    • Subject template. The area is used to define the letter subject template.
    • Body template. The area is used to defined the letter text template.
  • Subscribers. The page is used to defined 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 Letter | Default page is used for notifications.
The following commands are used to manage the list of subscribers:
Button Command Description
Add .jpg Add new subscriber Adds the new subscriber
Del.jpg Delete subscriber Deletes the selected subscriber

"Options" Page

The page 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.
  2. Adding the required event to the list of events processed by the notification service.
  3. Creating a letter 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 page (select Tools | Options on the main menu and then select Miscellaneous).

On the page, 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.

Adding Event

To add an event, execute the Add New Event command ( Notifications 1.jpg). 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 Development Distribution kit is moved to the Development branch (used by 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 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 Letter Template

The letter templates are created on the Letter page where it is required to perform the following:

  1. In the Subject Template area, enter the letter subject template.
  2. In the Body Template area, enter the letter text template.

The following macroparameters can be used:

  • %release% - release number
  • %product% - software product name
  • %time% - operation start time
  • %user% - user name
  • %changelist% - description of the release/distribution kit
  • %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
  • %patch% - patch number
  • %client% - customer name
  • %distributive% - distribution kit number
  • %distributive_file% - distribution kit file name
  • %rwm_version% - RadixWare Manager version
  • %target_branch% - development branch
  • %product_prefix% - prefix of the software product supplied to the customer

To the Body Template area, the macroparameters are entered manually or by means of the special buttons on the area toolbar. In the Subject Template area the macroparameters are entered manually only.

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

The template of notifications on Distributive Prepared, Distributive 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.
Example.jpgExample of notification template on creating the upgrade package for a particular customer (the Distributive 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%

Subscribing User to Notification Service

The setting is defined on the Subscribers page by means of the Add New Subscriber command (Notifications 1.jpg). In the New Subscriber dialog box that will open, specify the user e-mail address.

Installing Software Product

Note.jpgBefore being put into production, the software product must be tested. The following actions are performed at initial installation:
1.Create a software product directory in the repository. For details, refer to Creating Software Product.

Note.jpgCreating of the software product directory is not mandatory. If the appropriate directory is not found when loading the software product distribution kit, the system will prompt a user to create this directory.

2.Load the software product files package to the repository. For details, refer to Loading Software Product Update Package.
3.Submit the software product for testing. For details, refer to Submitting Software Product for Testing/Production.
4.Note.jpg Submit the scripts execution log to the customer support service.
5.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 Product Support Service as specified in the agreement with the vendor. Change the software product status to "Invalid" (see Appendix D. Release Parameters Editor).
6.Put the software product into production.

  • Build | <Production> Environment. 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> Environment. 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 into 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.

For details, refer to Submitting Software Product for Testing/Production.
7.Note.jpg Submit the scripts execution log to Product Support Service.
8.If necessary, perform the repository replication.

During the software product installation and update procedures, RadixWare Manager modifies the following files and tables:

  • Table of installed versions. The table contains the information about the software product version on each layer (see Appendix B. Auxiliary Database Tables).
  • Table of executed scripts. The table contains the information about the scripts executed during the database installation/update procedure for each layer (see Appendix B. Auxiliary Database Tables).
  • 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 (see Appendix C. Scripts Execution Log File).


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 software product basic functionality. Separate parts of a software product can be developed independently from each other and supplied to a customer by different vendors as products.

A product is a certain set of layers. A customer can employ several products from several vendors. The end software product can contain several products integrated into a single system. At that, the end product must contain the following layers:

  • Layer of customer modifications (the layer can be included not for all customers)
  • Common layer
  • Lower layers of products. A set of layers is defined in the customer settings so as to provide a customer with the possibility to create a single system.
  • Localizing layers for all layers of the end product (the layers are included if the software product requires localization to other additional languages)

To create a product, select the Create Product context menu command in the Distribution Kits branch of the project tree. The dialog box that will open contains the Product URI parameter used to specify the upper layer URI for 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 upper layer to be installed from the distribution kits. After the command is executed, the product directory is created in the Distribution Kits branch. The directory name contains the product upper layer URI.

Editing Layers

When loading the update package, the application searches for the directory of a software product in which the upper layer of the installed distribution kit matches the upper layer of the distribution kit being loaded. If the software product directory with the correspondent layers is not found, the application displays a message prompting to create a new directory.

Example.jpg The example of the application message:

Product not defined.jpg

To load the distribution kit (for which the appropriate software product directory is not found) to one of the existing directories, use the software product layer editor. The editor allows creating a copy of the previous distribution kit with another set of layers in the specified directory.

Software Product Layer Editor

To open the software product layer editor, use the Configure Distribution Kit Layers command of the product directory context menu. When executing the command, the Create Copy dialog box is displayed:

Settings 6.jpg

The editor contains the following components:

  • Source Distribution Kit. The number of the source distribution kit on the basis of which the new one is created. The value is selected from the drop-down list containing the existing (loaded) distribution kits. The default value is the last loaded distribution kit.
  • Release Number. The number of the source distribution kit release.
  • The software product layers list. The list of software product layers included into the last distribution kit.
  • Commands for managing the list of layers:

Button

Command

Description

Add .jpg Add Layer

Adds the new layer. When executing the command, the Append Layer dialog box is displayed where the layer parameters must be defined:

  • Name. The layer name.
  • Title. The software product name.
  • URI. The identifier of the layer to be created.
del.jpg Remove Layer

Removes the selected layer

settings_10.jpg Edit or View Layer

Views / edits the layer parameters

  • Create Copy of Distribution Kit in Product. The name of the software product in which a copy of the distribution kit needs to be created. Select the value from the drop-down list of software products. The default value is the current software product.

To create a new distribution kit, click OK. The distribution kit is placed to the Distribution Kits | <Product> project branch. The new distribution kit is automatically assigned the name of the following format: <D>~, where D is the number of the source distribution kit. The contents of the created distribution kit is the copy of the source distribution kit with the removed / added software product layer.


Procedure of Changing Layers Set

  1. In the layer editor, create a copy of the distribution kit on the basis of the previously installed distribution kit. For this purpose:
    1. In the Source Distribution Kit parameter, select the source distribution kit.
    2. Add / remove the software product layer using the Add Layer / Remove Layer commands.
    3. Click OK
  2. If necessary, correct the repository editor parameters: Base Development URI, System Products in Use.
  3. Install the update package specifying the created distribution kit as the source one (for details, refer to Updating Software Product).

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, 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, 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, the application prompts to create a new directory. To load the distribution kit to one of the existing directories, it is necessary to edit the set of layers.
  3. Correctness of the update package numbers sequence. On attempt to load the package with inappropriate number, RadixWare Manager generates an error message. For details on the update package numbering and loading to different projects, refer to Appendix G. Sequence of Update Package Numbers.
  4. Zip file digital signature.
  • The digital signature is verified. If the signature is present but not valid, RadixWare Manager disables loading the package and displays the respective warning. If the digital signature is absent, RadixWare Manager asks to confirm the package loading.
  • The certificate is verified. If the certificate is present in the list of trusted certificates, 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 certificates storage is not set up, there is no access to the storage, etc.), RadixWare Manager asks to confirm the package loading.

For details on the zip file digital signature verification, refer to Setting up Digital Signature Verification.

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 upper layer URI of the software product being loaded is compared to the URI specified for the product directory. If the product directory with the correspondent layer URIs is not found when loading the update package, RadixWare Manager prompts to create a new directory.
Note.jpgIf when loading the update batch, the a new directory is created, after the procedure completion, check whether the URI of the upper layer is present in the System Products in Use list. If necessary, add the URI to the list. The name of the upper layer URI is specified in brackets in the product directory name.

All zip files saved to the upgrades subdirectory are loaded into the repository in sequence according to the sequence number. If the sequence is not observed, RadixWare Manager generates an error message. Sequence 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.
3.Perform the preparatory steps in the Load Updates procedure dialog box that will open:

Load distrib step1.jpg

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:

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 package files presented in groups:
    • New files. The files to be added.
    • 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 groups:
  • New scripts. The scripts to be added.
  • Modified scripts. The scripts to be updated.
  • Removed scripts. The scripts to be deleted.
Description The description of the changes that will be made during the package loading.

The window contains the Check for binary compatibility flag. If the flag is set, during the package installation the application will check the customer software product layers and the software product layers loaded from the package for binary compatibility.

To switch between the steps, use the Next and Back buttons. To finish preparing the loading procedure, click the Finish button; to cancel the loading procedure, click the Cancel button. 4.Follow the package loading procedure. The procedure progress is displayed on the indicator in the right lower part of the application main dialog box. Note.jpgThe package loading procedure may take a long time. The procedure can be interrupted in the procedure process indicator in the right bottom corner of the application main dialog box by one of the following ways:

  • by clicking the Close button (Shut.jpg)
  • by using the Cancel Progress command of the indication area context menu

If the package loading procedure is interrupted (for example, due to power failure), restart the procedure. When restarting the procedure, RadixWare Manager starts loading from the first step. If the procedure is successfully executed, the RadixWare Manager application performs the following actions:

  • procedure progress
  • information on the units that will be added, changed, deleted in the course of the loading procedure
  • result of the procedure execution
  • description of the occurred errors

The result of the operation successful execution is as follows:

  • The Output window displays the operation results.
  • The package zip file is moved from the upgrades subdirectory to the upgrades.backup subdirectory.
  • The following is displayed in the tree:
    • In the Distribution Kits | <Product> branch - the distribution kit with the Scripts and Release nested directories.
    • In the Scripts branch - the directories with the scripts for initial installation of all software product layers. When loading an update package, apart from the installation scripts the branch contains the scripts for installing the software product versions for all layers.
  • The notifications on the executed operation are created and sent to the software product users (if the notification service is set up).

If any problem is encountered, RadixWare Manager displays an error message and undoes the performed actions. If the problem cannot be resolved without assistance, submit the error message text to the vendor for analysis and resolution.

Submitting Software Product for Testing/Production

To submit the software product for testing, the Build | <Branch> Environment command is used, where <Branch> can be:

  • test branch the distribution kit will be sent to (if the software product needs to be tested). By default, the project contains the Test branch only. To create additional test branches, the Create Test Branch command is used. This command is available in the context menu of the main branch of the project tree.
  • production branch where the distribution kit will be moved to (if the software product is put into production). By default, the project contains the Production branch only. To create additional test branches, use the Create Production Branch command in the context menu of the main branch of the project tree.

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

Note.jpgThe Build | <Test> Environment command is not available (and the name of the command contains the reason for it: "product '<uri>' not used in this system") if the URI of the product the distribution kit under test relates to is missing in the System Products in Use list.

The Build | <Branch> Environment command opens the dialog box used to complete all preparatory steps of the installation procedure:

Install 0 TX .jpg

  • The Available Products area displays the table with the list of products (products whose URIs are specified in the System Products in Use list in the repository settings) included into the end software product supplied to the customer. The Layers\Products column displays the list of all layers included into the product distribution kits. The information on each product is displayed in a separate column. If the layer is included into the product, the column with this product (next to the name of the layer) displays 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.

Note.jpgIf 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 database connection parameters:
  • Database. The database to be installed. Select the required database from the drop-down list of databases added to the project. The DB record contains the following parameters (comma separated): DB name, DB user name (schema), DB type (test / production).
  • SYS password. The password of the user with the system privileges (SYS). The dialog box called by Settings 8.jpg command enables to specify the name of the user with the system privileges to be used instead of the SYS user during the DB installation:

Sys user.jpg

  • User <schema> password. The DB user password.
Note.jpgUsing the character "@" in the DB user password results in errors in the RadixWare Manager versions lower than 1.2.11.29.х.

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 "#" means the beginning of a comment in the configuration file.
Example.jpg [Starter]

...

[Server]

...

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

...


  • Confirm <schema> password. The DB user password confirmation.
Show all databases. If the flag is not set, the drop-down list in the 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 installed in the test branch. By default, the flag is set if the DB is installed 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 Destination Branch State area lists the layers available in the test branch and that will be added / deleted. For each layer, the following information is displayed: current state (the Prior State column) and the state after the software product is sent to the test branch (the New State column).

Available values of the current state:

  • None. The layer is absent in the test branch.
  • Exist. The layer is present in the test branch (the current layer version is specified in brackets).

Available values of the new state:

  • Added. The layer will be added to the branch (the new layer version is specified in brackets).
  • Replaced. The current layer will be replaced with a new one (the new layer version is specified in brackets).
  • Removed. The layer will be deleted from the test branch.

The area contains the Clear destination branch before update flag. 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.

  • Synchronize replicas. If the flag is not set, during the installation / update (when copying / updating files in SVN repository), the replicas will not be synchronized, but after completion of installation / update, the user will be suggested to start replication. The flag is available if repository replication (for details, refer to RadixWare. Software Products Installation and Upgrade Technology / Editing Replication Parameters) is set up in the project. The flag is set, by default.
  • Check binary compatibility before update. This command is used to check the binary compatibility of the software product layers being loaded from the distribution kit.
  • 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.
  • User interface 12.jpg button to open the dialog box containing the Set Path to External jar Directory parameter. This 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 delivery package (in 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.

After the presettings are made, run the procedure for submitting the software product for testing / production using the Next button. Generally, this procedure consists of the following steps:
1.Export of 'starter.jar'. Save the starter.jar file to the directory on the local drive using the Export file button.

Install 1.jpg

2. Export of 'web-app.war'. Save the web-app.war file to the directory on the local drive using the Export file button.

3-4. For the description of the Execution Plan and Database Parameters steps, refer to Installing Database.

5. Before Scripts Execution. This step starts the DB installation procedure. In the course of the installation, the Build dialog box is hidden. The information on the database installation progress is available in the Output dialog box. A scripts execution log file is automatically created during the database installation. All events including error messages are written to this file.

Note.jpgIt is not recommended to interrupt the database installation procedure. In case of any failure, contact the Product Support Service on the vendor side and follow the given instructions.
Note.jpgIf any problem occurs during the database 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 installing the RadixWare 2.1.20.x and later versions, the system automatically checks the compatibility between the DB structure and metainformation of software product version being installed.

Note.jpgIf errors and warnings have been detected during the check, it is recommended to ignore them and proceed the installation procedure. Once the installation is completed, submit the file with the scripts execution log to the Product Support Service.

6. After Scripts Execution. The information page displays the DB update results. No changes are required at this step.
7. Before Files Update. The software product files are copied to the SVN repository. No changes are required at this step.
8. After Files Update. The final step of the software product installation procedure. The information page 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).

Installing Database

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.

During the database installation and update procedures, 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.

During the database installation and update procedures, RadixWare Manager modifies the table of executed scripts. The procedure result is registered in the table of installed versions (refer to Appendix B. Auxiliary Database Tables).

During the database installation (see below), RadixWare Manager creates the database user whose name is specified in the Schema parameter of the database access parameters editor (refer to Database Access Parameters). In addition, the administrator specifies the database password. 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 F. RadixWare Manager Configuration File). During the test database installation, the password strength is not verified.

Database Installation Procedure The installation procedure for the test and production databases is the same.

1.Start the DB 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)
Example.jpgTo install the RadixWare database, in the Radix (org.radixware) branch, select the latest version of 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 be installed. Select the required database from the drop-down list of databases added to the project. The DB record contains the following parameters (comma separated): DB name, DB user name, DB type.
  • SYS password. The password of the user with the system privileges (SYS). The dialog box called by Settings 8.jpg command enables to specify the name of the user with the system privileges to be used instead of the SYS user during the DB installation:

Sys user.jpg

  • User <schema> password. The DB user password.
  • Confirm <schema> 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 DB is installed in the test branches. By default, the flag is set if the DB is installed in the production branches.
  • Synchronize replicas. If the flag is not set, during the installation (when copying files in SVN repository), the replicas will not be synchronized, but after completion of installation, the user will be suggested to start replication. The flag is available if repository replication is set up in the project, and DB is installed to the branch that contains about.xml (test and production branches), as this file is updated, and the changes are committed to svn. The flag is set, by default.

Install DB 2.jpg

3.Complete all preparatory steps of the DB installation procedure 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.

Install to database 1.jpg

The table below lists the preparatory steps and parameters:
Step Description
Execution Plan RadixWare Manager displays the following information:
  • 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.
  • Packets. The page displays the version transition plan.
  • Scripts. The page displays the scripts execution plan for bringing the database structure in compliance with the release being installed.
Database Parameters Additional parameters for the type of the DB being installed:
  • Database. The type of the DB being installed. The value is selected from the drop-down list of available DB types.
  • Version. The version of the DB being installed. The value is selected from the drop-down list of available DB versions.

Note.jpgFor the Oracle DB, it is possible to set Version to 11.1 if the current DB version is higher.

  • 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.

Note.jpgThe additional DB parameters are defined only once and cannot be changed afterwards. When installing the database for any software product based on the RadixWare platform, the Database Parameters dialog box contains the org.radixware\partitioning parameter. If the parameter is used (the Enable flag is set), when pre-processing the SQL scripts, it is considered that the DB created 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.

For details on the additional DB parameters, refer to the documentation for the software product being installed.

Note.jpgNew 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 RadixWare. Programmer Guide). Install to database 2 .jpg

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 database installation procedure, click the Finish button; to cancel the procedure, click the Cancel button.

4. Start the database installation procedure. In the course of the installation, the Install to Database dialog box will be hidden. The information on the database installation progress according to the scripts execution plan will be available in the Output dialog box.

Note.jpg It is not recommended to interrupt the database installation procedure. In case of any failure, contact the Product Support Service on the vendor side and follow the given instructions.
Note.jpg If any problem is encountered during the database installation, 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.
Note.jpg During the database installation, the RadixWare Manager automatically creates a scripts execution log file to write all the events (including error messages) to.
The result of the operation successful execution 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 production database is installed) or log.test subdirectory (if the test database is installed) in the project directory.

Updating Software Product

Note.jpgBefore 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 company’s internal regulations.

To restore the software product files, it is enough to send the previous release version into testing / production (Build | <Test> Environment / Build | <Production> Environment) depending on what repository area (test or production) needs to be restored.

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

Software Product Update Procedure

Note.jpgWhen 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 Analysing System Changes).
Note.jpgIf 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 in updating and installing 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 Updating Database).

Submitting Software Product for Testing / Production

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 clients. To minimise 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 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.
Example.jpgThe 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 procedure for submitting the software product for testing / production during the update procedure is similar to that used during the software product installation. This procedure is started using the Build | <Branch> Environment command, where <Branch> can be:

  • test branch the distribution kit will be sent to (if the software product needs to be tested). By default, the project contains the Test branch only. To create additional test branches, the Create Test Branch command is used. This command is available in the context menu of the main branch of the project tree.
  • production branch where the distribution kit will be moved to (if the software product is put into production). By default, the project contains the Production branch only. To create additional test branches, use the Create Production Branch command in the context menu of the main branch of the project tree.

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

The Build | <Branch> Environment command opens the dialog box used to complete all preparatory steps of the update procedure:

Step0 .jpg

  • The Destination Database area is used to define the database connection parameters:
  • Database. The database to be updated. Select the required database from the drop-down list of databases added to the project. The DB record contains the following parameters (comma separated): DB name, DB user name (schema), DB type (test / production).
  • User <schema> password. The DB user password.
Show all databases. If the flag is not set, the drop-down list in the 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. By default, the flag is set if the DB is updated in the production branches.

If the DB does not need to be updated, set the Do not update database flag. The flag is not set, by default.


  • The Destination Branch State area is used to configure the branch the distribution kit will be sent to:
  • 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.
  • 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 Prior 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:

  • None. The layer is absent in the test / production branch.
  • Exist. The layer is present in the branch (the current layer version is specified in brackets).

Available values of the new state:

  • Added. The layer will be added to the branch (the new layer version is specified in brackets).
  • Replaced. The current layer will be replaced with a new one (the new layer version is specified in brackets).
  • Removed. The layer will be deleted from the test / production branch.
  • Synchronize replicas. If the flag is not set, during the update (when updating files in SVN repository), the replicas will not be synchronized, but after completion of update, the user will be suggested to start replication. The flag is available if repository replication is set up in the project. The flag is set, by default.
  • 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.
  • 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.


Note.jpgIf 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.

  • User interface 12.jpg button to open the dialog box containing the Set Path to External jar Directory parameter. This 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 delivery package (in 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.

After the presettings are made, run the procedure for submitting the software product for testing / production using the Next button.

Example.jpgBefore running the procedure, the versions of the software product layers being sent for testing are checked for compatibility. If the compatibility is violated, a respective message is displayed to the user and the procedure is interrupted.

Generally, the procedure consists of the following steps:
1. 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.

Example.jpgThe 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:
  • Stop the instance
  • Update starter.jar used to start the instance
  • Start the instance
  • Make sure that all instances have been restarted successfully.
Example.jpgIf 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 RadixWare Server. Administrator Guide and RadixWare Starter. Administrator Guide), 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.
Example.jpgIt 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.

Step1.jpg

2. 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.
Example.jpgIt 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.

Step2.jpg

3-5. For the description of the Execution Plan, Current Sessions and Database Parameters steps, refer to Updating Database.

6. Before Scripts Execution. This step starts the DB update procedure. In the course of the update, the Build dialog box is hidden. The information on the database update progress is available in the Output dialog box. The DB update procedure has the following features:

  • Access of the SYS user (user with 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.
  • A scripts execution log file is created automatically. All events including error messages are written to this file.
Note.jpgIt is not recommended to interrupt the database update procedure. In case of any failure, the administrator should contact the Product Support Service on the vendor side and follow the given instructions.
Note.jpgIf any problem occurs during the database 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.

Note.jpg If the database update procedure has been interrupted by the Abort command, the next update procedure will be started from the interrupted script.
  • During the update to RadixWare 2.1.20.x and later versions, the system automatically checks the compatibility between the DB structure and metainformation of software product version being installed.
This check can be performed before the update procedure by executing the Check Database command located in the context menu of the distribution kit loaded with the new software product version. For details on the command, refer to Project Commands section.
Note.jpgIf errors and warnings have been 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.


7. After Scripts Execution. The information page displays the DB update results. No changes are required at this step.
8. 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).
9. 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.
Note.jpgIf, 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 RadixWare Server. Administrator Guide and RadixWare Starter. Administrator Guide), 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 and proceed to the next step.
Note.jpgIt 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 is set.

Step8.jpg

10. 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).
11. 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 the 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.

Note.jpgIt is not possible to complete the procedure (the Finish button is inactive) until the 'Switch to new version of application' command has been executed for all instances of RadixWare Server flag is set.

Step10.jpg

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).

Updating Database

Note.jpg 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 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 dialog box called by Settings 8.jpg command enables to specify the name of the user with the system privileges to be used instead of the SYS user during the DB update:

Sys user.jpg

  • User <schema> password. The DB user password.
  • 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.
Note.jpgWhen 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.
  • Synchronize replicas. If the flag is not set, during the update (when updating files in SVN repository), the replicas will not be synchronized, but after completion of installation, the user will be suggested to start replication. The flag is available if repository replication is set up in the project, and DB is installed to the branch that contains about.xml (test and production branches), as this file is updated, and the changes are committed to svn. The flag is set, by default.
  • Check user-defined functions before update flag

Update database 1.jpg

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.

The table below lists the preparatory steps and parameters:

Step Description
Execution Plan The RadixWare Manager displays the following information:
  • Source Release. The number of the source release.
  • Target Release. The number of the release to be installed.
  • Packets. The page displays the version transition plan.
  • Scripts. The page displays the scripts execution plan for bringing the database structure in compliance with the release being installed.
Current Session The current database sessions:
  • users connected to the database
  • names of workstations
  • applications the database is connected from
Database Parameters If the software product layer settings (in the RadixWare Designer application) contain new parameters added for the type of the database being updated (for details, refer to RadixWare. Programmer Guide), the Database Parameters step will be available before the DB update to specify how these new DB parameters will be used 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.

Note.jpgIt is strongly not recommended 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.
Note.jpgIf any problem is encountered during the database update procedure, 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.
Note.jpgDuring the database update procedure, RadixWare Manager automatically creates a script execution log file that contains all the events including the error messages.
Note.jpg 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.

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 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 of software 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.

Note.jpgFor the compatibility check to be performed correctly in software product, it is recommended to increase the memory size allocated for the RadixWare Manager operation (default value is Xmx690m). The memory size is specified in the Xmx parameter of the configuration file manager.conf available in the application directory manager/etc. The minimum value of the Xmx parameter to start the check is 1G, the recommended value is 2G.

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 page).

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 failed to be detected on the test system exist.

Note.jpgThis check may slightly increase the time of update installation which, in turn, may increase the downtime of the production system only if the update is installed on the complete system shutdown. In this instance, it is recommended to measure the time of 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 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 complete system shutdown), it is recommended to perform the compatibility check beforehand (after the update package is loaded but before it is submitted for testing / production). Use the Check User-Defined Functions command available in the context menu of the following branches:

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

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 command needs to be executed from the context menu of the loaded distribution kit. Executing the command opens the dialog box with the following parameters:

Check UDF 2.jpg

  • Choose branch. The branch with the software product release version to update to and compare the functions of the current version with. The branch in which the command is started is set, by default.
  • 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:
  • Database. The value is selected from the drop-down list containing all databases registered in the project.
  • User <schema> password. The password of the DB user.
  • 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 delivery package (in RadixWare Server and RadixWare Explorer, the startup parameter -udsBuildPath 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.


Analysing System Changes

The RadixWare Manager application allows to get information on actions to be performed when updating the software product release version. For this purpose, execute the Analyse 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 own development)

Analisys changes .jpg

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 contains the information on 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 changes in the application server and web server files
  • information on the updated starter.jar and webapp.war files
  • information on the update scripts compatibility
  • information on changes in the hierarchy of software product layers
  • information on the necessity to restart the RadixWare Server instances.

Errors Management

During the database installation / update procedures, 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 database installation / update procedure. 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 (see Loading Software Product Update Package). The fix package is created by the vendor on the basis of the scripts execution log.
  3. Restart the database installation / update procedure; 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 database installation / update procedure by selecting this action.

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.
  • 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.
  • 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.

XSD-SchemasExport .jpg

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 on the local drive.

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 string 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 string 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.

Example.jpgFor 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 string and configuration file are identical, the arguments from the command string are used.

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_SCHEMA Deletes the DB scheme. Mandatory arguments:
  • PROJECT_DIR
  • DB_ALIAS

Optional arguments:

  • 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
CMD_REMOVE_DB_SCHEMA PROJECT_DIR=c:\ProjectDir DB_ALIAS=testSchema
CMD_LOAD_UPDATES Loads one or all distribution kits available for loading (zip files located in the upgrade directory from which the application extracts the package of product files for installation/update). Mandatory argument: PROJECT_DIR

Optional arguments:

  • CONFIG_FILE
  • KEY_STORE_PWD
  • SVN_PWD
  • One of the following arguments:
  • 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_LOAD_UPDATES PROJECT_DIR=c:\ProjectDir LOAD_UPDATE_ALL_FILES SVN_PWD=testSvnPwd KEY_STORE_PWD=testKeyStorуPwd
CMD_BUILD Executes the Build operation - send the software product to testing or production (depending on the specified target branch). Mandatory arguments:
  • PROJECT_DIR
  • One of the following arguments/groups:
  • USE_PRODUCT and USE_DISTRIBUTION_KIT
  • USE_RELEASE
  • USE_BRANCH
  • DESTINATION_BRANCH_PATH. This argument is optional if the DISABLE_COPY_FILES argument is specified.

Optional arguments:

  • DB_ALIAS/DISABLE_UPGRADE_DB
  • CONFIG_FILE
  • DB_PWD
  • DB_SYS_USER
  • DB_SYS_PWD
  • SVN_PWD
  • DESTINATION_STARTER_JAR_PATH
  • DISABLE_COPY_FILES
  • ENABLE_CHECK_BINARY_COMPATIBILITY
  • DISABLE_CHECK_VERSION_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_PATH
CMD_BUILD PROJECT_DIR=c:\ProjectDir DB_ALIAS=testSchema

DB_PWD=testSchemaPwd DESTINATION_STARTER_JAR_PATH=c:\starter.jar USE_PRODUCT=org.radixware USE_DISTRIBUTION_KIT=1173-1.2.26.20.16 DESTINATION_BRANCH_PATH=test ENABLE_CHECK_BINARY_COMPATIBILITY

CMD_EXTRACT_FILES Extracts the starter.jar and (or) web-app.war file(s) to the specified directory. Mandatory arguments:
  • PROJECT_DIR
  • SOURCE_BRANCH_PATH
  • DESTINATION_STARTER_JAR_PATH and/or DESTINATION_WEB_APP_WAR_PATH

Optional arguments:

  • CONFIG_FILE
  • SVN_PWD
  • One of the following arguments:
  • QUESTION_YES_ALL
  • QUESTION_NO_ALL
  • QUESTION_YES_SPECIFIC
  • QUESTION_NO_SPECIFIC
  • LOCAL_LOG_DIR
CMD_EXTRACT_FILES PROJECT_DIR=c:\ProjectDir

DESTINATION_STARTER_JAR_PATH=c:\starter.jar SOURCE_BRANCH_PATH=distributives/org.radixware/1173-1.2.26.20.16 SVN_PWD=testSvnPwd

CMD_ANALYZE_UPGRADE Analyzes the changes in the distribution kit being loaded. Returns the code (value) defining the actions to be performed once the changes are applied. The code value received as a result of command execution depends on the specified argument. Mandatory arguments:
  • PROJECT_DIR
  • DESTINATION_BRANCH_PATH
  • SOURCE_BRANCH_PATH
  • One of the following arguments:
  • ANALYZE_APP_SERVER_CHANGES
  • ANALYZE_WEB_SERVER_CHANGES
  • ANALYZE_APP_STARTER_CHANGES
  • ANALYZE_WEB_STARTER_CHANGES

Optional arguments:

  • One of the following arguments/groups:
  • USE_PRODUCT и USE_DISTRIBUTION_KIT
  • USE_RELEASE
  • CONFIG_FILE
  • SVN_PWD
  • LOCAL_LOG_DIR
CMD_CREATE_USER_SCRIPT Generates a user creation script for the database to be imported to the schema of this user. The command is called if the database import is required. The script generated by this command needs to be run by any available means before the database import. Mandatory arguments:
  • PROJECT_DIR
  • SOURCE_BRANCH_PATH
  • DESTINATION_SCRIPT_PATH

Optional arguments:

  • CONFIG_FILE
  • SVN_PWD
  • One of the following arguments:
  • QUESTION_YES_ALL
  • QUESTION_NO_ALL
  • QUESTION_YES_SPECIFIC
  • QUESTION_NO_SPECIFIC
  • LOCAL_LOG_DIR
CMD_CREATE_USER_SCRIPT PROJECT_DIR=c:\ProjectDir

SOURCE_BRANCH_PATH=distributives/org.radixware/1173-1.2.26.20.16 DESTINATION_SCRIPT_PATH=c:\Scripts\script.sql

CMD_CREATE_INSTALL_SCRIPT Generates a product installation script. Mandatory arguments:
  • PROJECT_DIR
  • SOURCE_BRANCH_PATH
  • DESTINATION_SCRIPT_PATH

Optional arguments:

  • CONFIG_FILE
  • SVN_PWD
  • One of the following arguments:
  • QUESTION_YES_ALL
  • QUESTION_NO_ALL
  • QUESTION_YES_SPECIFIC
  • QUESTION_NO_SPECIFIC
  • LOCAL_LOG_DIR
CMD_CREATE_INSTALL_SCRIPT PROJECT_DIR=c:\ProjectDir

SOURCE_BRANCH_PATH=distributives/org.radixware/1173-1.2.26.20.16 DESTINATION_SCRIPT_PATH=c:\Scripts\script.sql

CMD_EXTRACT_XML_SCHEMAS Exports the XSD schemas of the software product definitions to the specified directory. Mandatory arguments:
  • PROJECT_DIR
  • SOURCE_BRANCH_PATH
  • DESTINATION_PATH

Optional arguments:

  • CONFIG_FILE
  • SVN_PWD
  • One of the following arguments:
  • QUESTION_YES_ALL
  • QUESTION_NO_ALL
  • QUESTION_YES_SPECIFIC
  • QUESTION_NO_SPECIFIC
  • LOCAL_LOG_DIR
CMD_EXTRACT_XML_SCHEMAS PROJECT_DIR=c:\ProjectDir

SOURCE_BRANCH_PATH=distributives/org.radixware/1173-1.2.26.20.16 DESTINATION_PATH=c:\unloadDir SVN_PWD=testSvnPwd

CMD_EXPORT_HTML_DOC Exports the HTML description of the software product API to the specified directory. Mandatory arguments:
  • PROJECT_DIR
  • SOURCE_BRANCH_PATH
  • DESTINATION_PATH

Optional arguments:

  • CONFIG_FILE
  • SVN_PWD
  • One of the following arguments:
  • QUESTION_YES_ALL
  • QUESTION_NO_ALL
  • QUESTION_YES_SPECIFIC
  • QUESTION_NO_SPECIFIC
  • LOCAL_LOG_DIR
CMD_EXPORT_HTML_DOC PROJECT_DIR=c:\ProjectDir

SOURCE_BRANCH_PATH=distributives/org.radixware/1173-1.2.26.20.16 DESTINATION_PATH=c:\unload\ SVN_PWD=testSvnPwd

CMD_EXTRACT_RELEASE_NOTES Downloads the description of the release included in the distribution kit to the specified file. Mandatory arguments:
  • PROJECT_DIR
  • SOURCE_BRANCH_PATH
  • DESTINATION_PATH

Optional arguments:

  • CONFIG_FILE
  • SVN_PWD
  • One of the following arguments:
  • QUESTION_YES_ALL
  • QUESTION_NO_ALL
  • QUESTION_YES_SPECIFIC
  • QUESTION_NO_SPECIFIC
  • LOCAL_LOG_DIR
CMD_EXTRACT_RELEASE_NOTES PROJECT_DIR=c:\ProjectDir

SOURCE_BRANCH_PATH=distributives/org.radixware/1173-1.2.26.20.16 DESTINATION_PATH=c:\unload\ReleaseNotes.txt SVN_PWD=testSvnPwd

CMD_SEARCH_NEW_MANAGER_IN_ARCHIVE Searches for the archive with the new version of the RadixWare Manager (manager.zip file) in the specified archive containing a package of the software product files for the installation / update procedure.

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.
UPGRADE_FILE_PATH CMD_SEARCH_NEW_MANAGER_IN_ARCHIVE UPGRADE_FILE_PATH="/home/testDir/org.radixware234-49-1.67v2 (48-1.67v1).zip
CMD_UPDATE_MANAGER_FROM_ARCHIVE Updates the RadixWare Manager from the specified archive containing a package of the software product files for the installation / update procedure.

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.
Arguments:

UPGRADE_FILE_PATH

CMD_UPDATE_MANAGER_FROM_ARCHIVE UPGRADE_FILE_PATH="/home/testDir/org.radixware234-49-1.67v2 (48-1.67v1).zip
CMD_VERSION Displays the current version of the RadixWare Manager. Arguments are not used.
CMD_HELP Displays the reference information on commands and arguments used in the console manager. Arguments are not used.

The arguments that can be used at command execution are presented in the table below:

Argument Description Examples
CONFIG_FILE Name of configuration file containing the command arguments.
PROJECT_DIR Path to the project directory in the file system.
SOURCE_BRANCH_PATH Path to the source branch in the svn repository relatively to the project root. SOURCE_BRANCH_PATH=distributives/org.radixware/1160-1.2.26.20.9
DESTINATION_BRANCH_PATH Path to the target branch in the svn repository relatively to the project root. DESTINATION_BRANCH_PATH=test
USE_PRODUCT Prefix of the product being used (postfix can be empty). It is used together with the USE_DISTRIBUTION_KIT argument. USE_PRODUCT1=org.radixware USE_DISTRIBUTION_KIT1=1160-1.2.26.20.9
USE_DISTRIBUTION_KIT Prefix of the distribution kit being used (postfix can be empty). If the argument is specified without value, the last loaded distribution kit is used. This argument is used together with the USE_PRODUCT argument. USE_PRODUCT1=org.radixware USE_DISTRIBUTION_KIT1=1160-1.2.26.20.9
USE_RELEASE Number of release being used. If the argument value is not defined, the last created release is used.

The parameter is used if the project is set up for own development and the software products releases are created within the project.

USE_RELEASE=1.2.26.20.9

or USE_RELEASE

USE_BRANCH Name of the test/production branch being 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)

USE_BRANCH=test
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.
DB_PWD Password to the DB scheme. If the argument is absent, it will be requested from the user.
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 at the DB installation. If the argument is absent, it will be requested from the user.
DB_SYS_USER Name of the user with the system privileges to be used instead of the SYS user when installing and updating the DB. DB_SYS_USER=ADMIN
DB_OPTIONS_DATABASE_TYPE Name of DB type required at the DB installation. The executed parts of 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 DB installation/update.

DB_OPTIONS_DATABASE_TYPE=ORACLE
DB_OPTIONS_DATABASE_VERSION DB version required at the DB installation. The executed parts of 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 DB installation/update.

DB_OPTIONS_DATABASE_VERSION=11.1
DB_OPTIONS_PARAMETER_ Prefix to the preprocessor parameter. The executed parts of installation scripts depend on the specified prefix.

The argument can be used in all commands related to the DB installation/update. Note.jpg*If not all additional DB parameters (DB_OPTIONS_PARAMETER_ arguments) were specified at the DB installation/update, the operation is aborted with an error, and the list of all additional parameters to be specified is displayed in console.

  • When installing the DB for any software product based on the RadixWare platform, the argument DB_OPTIONS_PARAMETER_org.radixware\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.
DB_OPTIONS_PARAMETER_org.radixware\\Partitioning=true
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. Automatically answer with "yes" to the specified question.

Format: QUESTION_YES_SPECIFIC<postfix>="<value>", 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_YES_SPECIFIC_1="Create product?"
QUESTION_NO_SPECIFIC Argument value is the yes/no question. Automatically answer with "no" to the specified question.

Format: QUESTION_NO_SPECIFIC<postfix>="<value>", 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_NO_SPECIFIC="File '/home/testUser/rep/upgrades/org.radixware-1800-2.1.19.10.2-install.zip' is unsigned."
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 be loaded.

It cannot be used together with the LOAD_UPDATE_ALL_FILES argument.

LOAD_UPDATE_FILE="org.radixware-27-1.55 (26-1.54v4).zip"
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_COMPATIBILITY When executing the CMD_BUILD command, check the binary compatibility of files of the software products sent to testing/production.
DISABLE_CHECK_VERSION_COMPATIBILITY Disable the check of versions compatibility for the software product layers when executing the CMD_BUILD command. If the argument is not defined, the check for compatibility is performed.
DESTINATION_STARTER_JAR_PATH Path to the starter.jar file being unloaded.
DESTINATION_WEB_APP_WAR_PATH Path to the web-app.war file being unloaded.
DISABLE_CHECK_MANAGER_UPDATE Do not search for new versions of the 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 are saved after the command execution. LOCAL_LOG_DIR=c:\RadixWareManager\logs
ANALYZE_APP_SERVER_CHANGES When executing the 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_CHANGES When executing the 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_CHANGES When executing the CMD_ANALYZE_UPGRADE command, the system analyzes whether it is required to update the starter.jar file. Return values:
  • 0. It is not required to update the starter.jar file.
  • 1. It is required to update the starter.jar file.
  • 255. An exception occurred.
ANALYZE_WEB_STARTER_CHANGES When executing the 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 Path to the file the generated script will be saved to. DESTINATION_SCRIPT_PATH=c:\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 of the software product files for installation / update. UPGRADE_FILE_PATH="/home/testDir/org.radixware234-49-1.67v2 (48-1.67v1).zip
DATABASE_DRIVER_PATH Path to the jar file containing JDBC driver. The ojdbc6.jar file included in the 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.

DATABASE_DRIVER_PATH=c:\binary-files\ojdbc6.jar

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.

Note.jpgThe 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 command with the LOAD_UPDATE_ALL_FILES argument is executed to load all update batches available in the upgrade directory of the project to the repository. ./console CMD_LOAD_UPDATES PROJECT_DIR=/home/testuser/RadixWareManagerProjects/testproject LOAD_UPDATE_ALL_FILES QUESTION_YES_ALL The QUESTION_YES_ALL argument allows to answer "yes" to all questions from the application to the user when executing the command.

For example, if at the command 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).
The CMD_LOAD_UPDATES command with the LOAD_UPDATE_FILE argument is executed to load the org.testproduct-1472-2.1.3.10.9 (1470-2.1.3.10.8).zip file located in the upgrade directory of the project. ./console CMD_LOAD_UPDATES PROJECT_DIR=/home/testuser/RadixWareManagerProjects/testproject LOAD_UPDATE_FILE="org.radixware-1472-2.1.3.10.9 (1470-2.1.3.10.8).zip" QUESTION_NO_ALL 1.The QUESTION_NO_ALL argument allows to answer "no" to all questions from the application to the user when executing the command.

For example, if the software product update package is not signed at the command 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 command is executed with the LOAD_UPDATE_ALL_FILES argument and defined automatic answers to the specified questions. ./console CMD_LOAD_UPDATES LOAD_UPDATE_ALL_FILES PROJECT_DIR=/home/testUser/rep/ QUESTION_YES_SPECIFIC_1="File '/home/testUser/rep/upgrades/org.radixware-1800-2.1.19.10.2-install.zip' is unsigned." QUESTION_YES_SPECIFIC_2="Create product?" QUESTION_NO_ALL
  • QUESTION_YES_SPECIFIC_1 argument allows to answer "yes" automatically to the question containing the phrase "File '/home/testUser/rep/upgrades/org.radixware-1800-2.1.19.10.2-install.zip' is unsigned".
  • QUESTION_YES_SPECIFIC_2 argument allows to answer "yes" automatically to the question 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 command is executed to analyze the changes that will be performed on the application server if the last loaded distribution kit is sent to testing (the test branch of the repository). ./console CMD_ANALYZE_UPGRADE PROJECT_DIR=/home/testuser/RadixWareManagerProjects/testproject DESTINATION_BRANCH_PATH=test ANALYZE_APP_SERVER_CHANGES 1.Since no USE_PRODUCT, USE_DISTRIBUTION_KIT or USE_RELEASE argument is specified, the last loaded distribution kit and the branch with this kit will be used. If there is the Releases branch (the 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_CHANGES argument).

The CMD_ANALYZE_UPGRADE command is executed to analyze the changes that will be performed on the web server if the 1470-2.1.3.10.8 distribution kit (previously loaded to the org.radixware product directory) will be sent to testing (the test branch of the repository). ./console CMD_ANALYZE_UPGRADE CONFIG_FILE=/home/testuser/RadixWareManagerProjects/config.conf

Example.jpgExample of the config.conf file located in the /home/testuser/RadixWareManagerProjects/ directory:
PROJECT_DIR=/home/testuser/RadixWareManagerProjects/testproject USE_PRODUCT123=org.radixware USE_DISTRIBUTION_KIT123=1470-2.1.3.10.8 DESTINATION_BRANCH_PATH=test ANALYZE_WEB_SERVER_CHANGES

1. The /home/testuser/RadixWareManagerProjects/config.conf configuration file containing the required arguments is specified as the command argument.

2.The used software product and distribution kit are explicitly defined in the configuration file.
3.The USE_PRODUCT/USE_DISTRIBUTION_KIT arguments contain the "123" postfix used to search for the second element of product/distribution kit pair. It is convenient to use the postfix in these arguments if there are several software products in the repository (in this case it is possible to find the respective distribution kit for each product).
These arguments can be used as follows:
USE_PRODUCT=org.radixware
USE_DISTRIBUTION_KIT=1470-2.1.3.10.8

3. Command CMD_EXTRACT_FILES
The CMD_EXTRACT_FILES command is executed to extract the starter.jar and/or web-app.war files from the loaded software product distribution kit and save them to the specified directory. ./console CMD_EXTRACT_FILES PROJECT_DIR=/home/testuser/RadixWareManagerProjects/testproject DESTINATION_STARTER_JAR_PATH=/home/testuser/RadixWareManagerProjects/starter.jar SOURCE_BRANCH_PATH=distributives/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 executed to send the last loaded distribution kit to testing (the test branch of the repository) ./console CMD_BUILD CONFIG_FILE=/home/testuser/RadixWareManagerProjects/config.conf

Example.jpgExample of the config.conf file located in the /home/testuser/RadixWareManagerProjects/ directory: PROJECT_DIR=/home/testuser/RadixWareManagerProjects/testproject DESTINATION_BRANCH_PATH=test DB_ALIAS=MANAGER_TEST DB_SYS_PWD=SYS DB_PWD="abc#123" DB_OPTIONS_PARAMETER_org.radixware\\Partitioning=true

1. Since no USE_PRODUCT, USE_DISTRIBUTION_KIT or USE_RELEASE argument is specified, the last loaded distribution kit and the branch with this kit will be used. If there is the Releases branch (the project is set up for own development), the last created release will be used at the command execution.

2.As a rule, the DB_SYS_PWD argument must be specified only at the software product installation (in some cases at update).
3.The DB_ALIAS argument value - the DB name from the list of DB defined in the project settings.

The CMD_BUILD command is executed to send the 1470-2.1.3.10.8 distribution kit (previously loaded to the org.radixware product directory) to production (the prod branch of the repository). ./console CMD_BUILD CONFIG_FILE=/home/testuser/RadixWareManagerProjects/config.conf

Example.jpgExample of the config.conf file located in the /home/testuser/RadixWareManagerProjects/ directory: PROJECT_DIR=/home/testuser/RadixWareManagerProjects/testproject USE_PRODUCT=org.radixware USE_DISTRIBUTION_KIT=1470-2.1.3.10.8 DESTINATION_BRANCH_PATH=prod DB_ALIAS=MANAGER_TEST DB_SYS_PWD=SYS DB_PWD="abc#123" DB_OPTIONS_PARAMETER_org.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

Unlike the previous example, the distribution kit to be sent to production and path for saving the starter.jar and web-app.war files are explicitly defined in this example.

Appendix

Appendix A. 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
Example.jpgThe 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 changes made to the software product.

Appendix B. Auxiliary Database Tables

Table of Installed Versions (RDX_DDSVERSION) The table is automatically updated during the database installation/update procedure. The table contains the information about the software product version on each layer and has the following structure:

/layeruri/ /version/ /upgrade-toversion/ /upgrade-starttime/ /prevcompatiblayer/ /upgradedate/
Layer name Source version number Destination version number Update procedure start date and time Minimum compatible version Update procedure end date and time

Example.jpgExample:

/layeruri/ /version/ /upgrade-toversion/ /upgrade-starttime/ prevcompatiblayer/ /upgradedate/
org.radixware.radinsk 0.2.46 0.2.46 2010/07/22 12:51:40 0.2.45 2010/07/22 12:52:04
org.radixware 1.1.58.15 1.1.58.16 2010/07/22 12:51:40 1.1.58.11 2010/07/22 12:52:04

Table of Executed Scripts (RDX_DDSUPGRADELOG)

The table is automatically updated during the database installation/update procedure. The table contains the information about the scripts execution for each layer and has the following structure:

/layeruri/ /fromrelease/ /torelease/ /filename/ /problemguid/ /upgradedate/
Layer name Source release number Destination release number Script file name Script execution problem ID Update procedure date and time

Example.jpgExample:

/layeruri/ /fromrelease/ /torelease/ /filename/ /problemguid/ /upgradedate/
org.radixware 0 1.1.58.15 0.sql 2010/07/22 12:50:01
org.radixware 0 1.1.58.15 1.sql 2010/07/22 12:50:40
org.radixware.radinsk 0 0.2.46 0.sql 2010/07/22 12:51:50

Appendix C. Scripts Execution Log File

The log file is generated automatically:

  • during the test database installation/update procedure. This file is stored in the project directory in the log.test subdirectory.
  • during the production database installation/update procedure. This file is stored in the project directory in the log.prod subdirectory.

The file name format is <installUri>-<release>-<timestamp>.log, where

<installUri> - installed software product layer URI
<CustomerUri> - customer name. It is present in the file name if the database is installed / updated from the context menu of the customer distribution kit.
<Ri> - source release number. It is absent in the file name when running installation scripts.
<Rj> - installed software product release number
<timestamp> - current time in the format yymmdd_hhmmss

The file name is unique, a new file is created during each database installation / update procedure.

Example.jpgThe 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 database installation/update procedure and saves the information on its status. In case the database installation/update procedure results in an error, the log file records the following information:

  • name of the script file that caused an error
  • error ID
  • number of the line and column where the error occurred

The log file should be transferred to the vendor in order to control the correctness of the database installation/update procedure.

Example.jpgExample of the log file contents:

Log file .jpg

Appendix D. Release Parameters Editor

The Properties release parameters editor is present in all the tree branch directories containing the software product release files. The editor can be opened by one of the following ways:

  • by double-clicking the Properties editor or the directory / branch containing the editor
  • by using the Configure command of the Properties editor contextual menu
  • by using the Configure command of the contextual menu of the directory / branch containing the editor

The release parameters editor displays the following release parameters:

  • 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.
    • 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.
  • Layers Descriptions. The parameter field contains the Generate Developers Descriptions button used to create the release description template from the comments to the SVN revisions. The button is available only for the vendor.
  • Notification Parameters. The parameter field contains the Send a Notification ’Release Created’ 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 RadixWare. Software Support Guide.

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 (for example, English, Russian).

To view the description, click Settings 8.jpg button.

The editor looks as follows:

Settings 3.jpg

Appendix E. 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 one of the following ways:

  • by double-clicking the Properties editor or the directory of the particular distribution kit
  • by using the Configure command of the Properties editor contextual menu
  • by using the Configure command of the contextual menu of the directory of the particular distribution kit

The distribution kit editor contains the General and Given Elements pages displaying the following parameters:

  • The General page:
    • 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 distributive. The number of the previous distribution kit.
    • Description. The description of the distribution kit.

The parameters are not editable.

  • The Given Elements page:

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 Give 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).

The editor looks as follows:

Settings 11 .jpg

Appendix F. RadixWare Manager Configuration File

The additional setup of the RadixWare Manager application is performed by editing the manager.conf configuration file in the manager/etc directory.

The application supports the following configuration file parameters:

  • The 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 (!№;%:? and 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.

For details on the other parameters of the configuration file, refer to NetBeans documentation.


Appendix G. 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.

Example.jpgInstalling 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
  • 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)

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.

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
Patch package A software product files package containing the release corrections
Update package A software product files package containing a set of update files and previous release correction files
Initial installation package A software product files package containing files and scripts for initial system installation
Software product release An edition of a software product; a deployable software package
Script A program containing a list of instructions modifying the database structure performed sequentially without user interaction

Frequently Asked Questions

The section contains a list of frequently asked questions and answers to them:

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.

Example.jpg 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.Confirm to continue the update package installation:

Faq question.jpg

The further installation procedure is successfully executed.

2.Change the system date to 01.12.2013. Install the update batch.

After solving the problem, contact the Product Support Service and apply for new certificate ca.pem. Load it using the Key Store Administrator utility (for details, refer to Key Store Administrator. Administrator Guide).