About this Documentation

Thank you for using our ProSyst Remote Manager (RM) software. To further help you achieve the best results please follow the instructions on this page and all its suggested further readings.

Last Updated: January 2nd 2018.

Navigating This Documentation

The Installation Guide contains detailed step-by-step information about installing the system and tuning its initial configuration. Read it to get acquainted with the main steps to launch the Remote Manager.

Troubleshooting Problems with the Documentation of a Package

The documentation about a package is available only if you have installed the corresponding package! Otherwise, you should only see a page explaining that you haven't downloaded the necessary package and cannot see its documentation.

To be able to browse the packages' documentation through the common navigation tree, you must install all packages in the root directory where the System package is installed. Otherwise you will still be able to browse each documentation independently but you will see a blank page when you try to open it through the common navigation tree.

Internal Structure of a Package's Documentation

The user documentation of each Remote Manager distribution package contains the following parts:

  • Package Overview - Contains summary of the most essential features of the described package.
  • Conceptual Guide - Describes the principles and concepts of the package.
  • User Guide - Contains the procedures for performing common tasks through mConsole, working with console commands, etc.
  • Programmer Guide - Describes the principles of using the APIs provided with the package to enhance the capabilities of the system.
  • APIs - All API documentation for each package: The Javadoc of the package's accessible components, the Control Unit Reference Documentation (Contains a reference description to the control unit types of the package in javadoc format) and the Web Services documentation (Contains a reference description to the Web Services of the package in a javadoc-like style).

These parts are accessed both through the navigation tree in the left frame, and though the hyperlinks showing the contents of each chapter.

Documentation Conventions

  1. All file and directory paths are related to the folder in which the Remote Manager is installed. For example, if you install the Remote Manager in a directory c:/Remote Manager, the archive of the framework will be marked as lib/server.jar that stands for the c:/Remote Manager/lib/server.jar location.
  2. The Remote Manager program folder stands for the folder in the Start menu that wraps the shortcuts to the applications included in the Remote Manager product.
  3. The special tokens that are used in the documentation are as follows:
    Special Element Example
    File and directory paths /bin/vms/jdk
    Files and file extensions boot.ini
    Java classes, packages, system properties, command lines com.prosyst.mbs.services.crypt.Cipher
    Bundle states Active
    Buttons OK
    Menu commands Server -> Shut Down
  4. Special symbols for user-entered data:
    • <> - delimiter indicating a component name, such as host name, database name or bundleID, that is obligatory to assign.
    • [] - delimiter for optional data.