Relativity Server Admin Tool (Windows)

From RemObjects Wiki

Jump to:navigation, search

This is a HowTo topic about Data Abstract
Feel free to add your notes to this topic below.

NOTE: This is article is a work in progress and not finished yet.
Unless you are the author, please do not make changes or rely yet on information presented in this article.

When done, the author should change the first line from wip to wipr to show that the page is ready for review.

If you have suggestions for this page, please send them to us: email.

Contents

Overview

Relativity AdminTool is an administration and configuration tool for Relativity servers. Using it you can setup every aspect of Relativity server, from server channels settings to domains and schemas.


Relativity AdminTool


Main Relativity AdminTool form is divided to two panels – Action Tree and Properties pane. Actions tree contains list of registered Relativity connections, list of available actions for connected servers, and list of Relativity instances discovered via ZeroConf, connections to whom are still not registered.


Registering Relativity connection

To register Relativity connection double-click tree node representing ZeroConf-discovered Relativity instance. Login dialog will appear where you should enter login and password.


Note: Default login / password are Administrator / Relativity


Note: Credentials for registered connections are stored with encryption.


As an alternative you can register server connection manually. Press 'Register new Relativity connection' button on toolbar and select proper channel type, message type etc.


Relativity AdminTool Login dialog


You can also select service via ZeroConf browser:


Relativity AdminTool ZeroConf Browser


Note: For services registered via ZeroConf channel and message type and port will be adjusted automatically if according Relativity ZeroConf registration will change.


Server Information

This page is displayed when tree node representing connected server is selected.

AdminTool Server Information page

On this page you can check server Url and active Relativity license.

Also you can upload license file using Upload license file button. If this file contains valid license it will be stored in the Relativity configuration folder and Relativity license will be reloaded from it.


Network Settings

To change network configuration of Relativity server select tree node ‘Network Settings’. In the right pane Network Settings pane will open. Using it you will be able to change properties of default and custom server channels.

To save changes made press Save Changes button, to revert them – Revert Changes button (both can be found in pane toolbar)

Available types of server channels and messages are listed here.

Note: Option Enable Http Info page is treated as always on for Relativity servers deployed under Royalty-Free License. See the Relativity Server Licensing page for more details about available licensing options.

Note: Relativity instance will be restarted to apply network connectivity settings changes

Creation of new Domain

To create new domain expand Domains node in Actions tree view and double-click 'Add new Domain' tree node. New Domain will be added to the Relativity and node representing it will be selected


Relativity AdminTool Add new Domain

Note: Newly created domains have Data login defined by default with login Data and password Relativity.

General Domain settings

To change Domain settings select this Domain’s tree node in Actions tree view. You will be able to change Domain name, DataService settings for this domain, ConectionManager settings and DataStreamer type.

Also you will be able to delete this Domain.


Note: Do not set Domain name equal to name of other Domain served by this Relativity instance! This Domain will be not accessible after that.


Note: Domain Delete operation cannot be reverted.


Domain Login Provider settings

To change Domain Login Provider settings select this Domain’s 'Login' tree node in Actions tree view. Available login provider types are described in Security Settings section


Domain Connections

This pane allows you to manage Domain connections. You can add, edit or remove connection definitions or download connection file if format that is recognized by Schema Manager.


Relativity AdminTool Domain Connections


Domain Schema properties

To add new schema to the Domain double-click 'Add new Schema' tree node. New Schema will be created with default name 'SchemaXX' where XX is some number. You can rename Schema, download or upload its representation (in Schema Modeler format) or open it in Schema Modeler.


Relativity AdminTool Schema Settings


Note: Valid DataAbstract installation and license is required to open Schema in Schema Modeler

Navigation
products
platforms
special
Toolbox