Strategy ONE

Creating and Configuring Intelligence Server Instances with mstrctl

You can create and configure Intelligence Server instances with the mstrctl tool. Intelligence Servers running with a particular server definition are referred to as server instances.

  1. From a Linux console window, browse to HOME_PATH, where HOME_PATH is the directory that you specified as the home directory during installation.
  2. Browse to the folder bin.
  3. Enter mstrctl -h and click Enter.
  4. Review the help information and run any required configuration tasks.

There are some commands that can output information to a file, or require a long definition that can be retrieved from a file. For information on using files to store output from and provide input to mstrctl commands, see Using files to store output and provide input.

You do not need to enter any command to quit the mstrctl tool because it is a one-line command line tool.

Using files to store output and provide input

With the mstrctl command line tool, you can perform the following tasks:

  • Display and modify a server configuration
  • Display and modify a service configuration
  • Display and modify a server instance configuration

The commands that display the configurations listed above output long XML definitions to the command line. The commands that modify the configurations listed above require a long XML definition as input.

Rather than displaying and inputting long XML definitions from the command line, you can use files to store and provide input for long XML definitions.

Configuring Intelligence Server with XML files requires extensive knowledge of the various parameters and values used to define Intelligence Server configurations. Providing an incorrect XML definition to configure Intelligence Server can cause errors and unexpected functionality.

Prior to using commands to display and modify service configurations (gsvc and ssvc) you must register Intelligence Server as a service. You can perform this task by using the rs command for mstrctl. To register an Intelligence Server as a service on a Linux machine, you must be logged in with an account that has root user privileges and permissions.

The following commands can have their output sent to a file:

  • gsc: Displays a server configuration
  • gsvc: Displays a service configuration
  • gsic: Displays a server instance configuration

For example, you can run the following command to output the server instance configuration to an XML file:

mstrctl -s IntelligenceServer gsic > ServerInstance.xml

A ServerInstance.xml file is saved in the current directory.

The following commands can read input from a file:

  • ssc: Modifies a server configuration
  • ssvc: Modifies a service configuration
  • ssic: Modifies a server instance configuration

For example, you can run the following command to modify the server instance configuration by reading input from an XML file:

mstrctl -s IntelligenceServer ssic < ServerInstance.xml

The XML definition in ServerInstance.xml is used to define the server instance configuration.

It would be difficult and time consuming to type a complete server, service, or server instance configuration from the command line. An easier way to provide this type of configuration is to output the current configuration to a file, modify the file with a text editor, and then use the file as input to a command to modify the configuration.