Windows: Objectivity/DB Configuration

Printer-friendly version

As the foundation of the Objectivity product set, Objectivity/DB provides:

  • Tools for database administration and data inspection.
  • Servers for managing concurrency and accessing remote files.
  • Runtime libraries containing the Objectivity/DB kernel, which is used by the tools and servers, and by the database applications you develop.

To configure Objectivity/DB, refer to the following:

Checking and Setting Up Servers

The following servers are provided with Objectivity/DB:

  • The lock server, which manages concurrent access to persistent objects in one or more federated databases. The lock server must be running in order to use Objectivity/DB.
  • The Advanced Multithreaded Server (AMS), which allows remote database applications to access to local data files and journal files in a distributed Objectivity/DB system.
  • The query server, which executes the subtasks of a parallel query or a navigation query initiated from within an Objectivity/DB database application.

For more information about these servers, refer to Objectivity/DB Administration.

A default Full or Typical installation with administrative privileges does the following:

  • Installs the lock server as a Windows service with an Automatic startup type and starts the service. With this startup type, the lock server starts automatically whenever the computer boots and runs even when no user is logged in.
  • Installs AMS and the query server as Windows services with Manual startup types and does not start these servers. With this startup type, the services must be manually started, either through the Objectivity Network Services (ONS) tool or the Windows Services Control interface. These services will not restart when the system reboots unless you change their service startup type.

For security purposes, you should consider configuring AMS and the query server to use a special-purpose account that can be granted the minimum necessary permissions. Note that when an application uses AMS, the logon account for AMS establishes the ownership of any data files created by the application.

You must log in as administrator or as a user with equivalent privileges to make any changes through ONS.

Checking Objectivity Server Status

After installation, check the status of Objectivity servers:

► Click Start > Programs (or All Programs) > Objectivity version > Objectivity Network Services.

The status of each server is listed next to its name. After a default Objectivity/DB installation, each server should be listed as installed, and the lock server should be listed as installed and running.

Note: If you purchased and installed Objectivity/SQL++, the ODBC server is listed as installed and running and has an Automatic startup type.

You can use ONS to stop running services or start ones that are not running. Starting or stopping a server using ONS does not change that service's startup type. To change the startup type of a Windows service, use the Windows Service Control Manager (SCM).

As you refine the design of your distributed Objectivity/DB system, you will:

  • Choose one or more computers on your network to be lock-server hosts for your federated databases.
  • Decide whether or not to use AMS as your data-server software on the computers that host data files or journal files.

For more information, see Objectivity/DB Administration.

If the Lock Server is Stopped

If the lock server is listed as stopped in ONS, you should check whether another process is already running on the port that the server expected to use.

Each Objectivity server is assigned a default TCP/IP port number by Objectivity/DB. If another service already uses one of the default ports, you should try to reassign that service to a different port. If you cannot do this, you may have to change the default port for the Objectivity server. To confirm that a port conflict exists or to change the default port for an Objectivity server, see "Using a Lock Server" in Objectivity/DB Administration.

Note: If you change the port number for an Objectivity server, you must make this change on every host that is to run a process that uses the server.

If Servers are Uninstalled

In certain cases, an Objectivity server might listed as uninstalled.

This means the installer simply copied the executables to your computer but did not install the server as a service. You can use ONS to install the services at any time.

Choosing a Logon Account for Objectivity Servers

The lock server and AMS log on to the local system account by default. For security purposes, you should consider configuring each Objectivity server to use a special-purpose account that can be granted the minimum necessary permissions. Note that when an application uses AMS, the logon account for AMS establishes the ownership of any data files created by the application.

For information about starting an Objectivity server with the required permissions, see the chapter for that server in Objectivity/DB Administration.

Alternatively, you can run a custom installation to install particular services and configure them under a given user account.

Configuring Windows Firewall

An Objectivity server on a particular computer can serve an Objectivity/DB database application running anywhere on the same network. If an Objectivity server is on a computer that has Windows Firewall turned on, you must configure Windows Firewall to enable traffic to the server. See Running Objectivity Servers on Windows in Objectivity/DB Administration.

Changing the Service Startup Type

To change the startup type of a Windows service, use the Windows Service Control Manager (SCM).

  1. Choose Start > Run and type services.msc to open the Windows SCM tool.
  2. Locate the name of the service you want, right click on it, and modify its properties.
    • ools-13 for the lock server
    • ooams-3 for AMS
    • ooqs-1 for the query server

Setting Environment Variables

With a default installation with adminstrative privileges, the installer adds the search path for executables to the path system environment variable.

Variable Value
path Search path for executables, including Objectivity/DB administration and database tools as well as Objectivity/Assist. Modified to contain installDir\bin and installDir\assist.

If you chose not to set environment variables when you installed, you must manually set these variables. Alternatively, you can execute the installDir/setup.cmd script to set these variables temporarily in a shell window.

Starting Objectivity/Assist

Objectivity/Assist (Assist) is a graphical tool for getting started quickly with Objectivity/DB. You can use Assist to perform tasks such as:

  • Creating and administering a federated database.
  • Listing a federated database’s physical components (files and servers) and logical components (databases, containers, and persistent objects).
  • Creating, browsing, and changing the data in a federated database, and the types in a federated database’s schema.
  • Generating C++ and Java class definitions (including accessor methods) from a federated database’s schema.

Assist also provides tutorials for getting started with Objectivity/DB basic concepts, as well as application development for selected programming-language interfaces. Assist is implemented as a rich client application on the Eclipse Rich Client Platform (RCP).

To start Assist:

  1. Click Start > Programs (or All Programs) > Objectivity > Objectivity Assist.
  2. At the prompt, specify a workspace directory for Assist project files.

Any folder can serve as your Assist workspace directory. For example, to keep your Assist files with your Objectivity/DB installation, you can specify installDir\assist\workspace. If necessary, a directory with the name you specified is created.

Note: To run Assist, you must have read and write permissions to the .metadata folder in the Assist workspace directory.

Assist provides tutorials for getting started with Objectivity/DB. To find a tutorial, click on its link in Assist’s Welcome page.

Configuring Your Own Eclipse Platform

If you already have a compatible release of the Eclipse Platform or Eclipse SDK, you can install the Assist plugin into that framework:

  1. Copy all the subdirectories in installDir\assist\plugins that begin with com.objy.assist except com.objy.assist.rcp_x.x.x into the eclipseInstallDir\plugins directory, where:
    • installDir is the Objectivity/DB installation directory.
    • eclipseInstallDir is the directory containing the Eclipse installation to be used—for example, C:\eclipse.
  2. Copy the installDir\assist\features\com.objy.assist_x.x.x directory into the eclipseInstallDir\features directory.
  3. Start Eclipse, then choose Window > Open Perspective > Other and choose the Objectivity/Assist perspective.
Monday, August 20, 2012