Essbase Studio Server Commands

Essbase Studio Server commands inform you about the tasks the server is performing and the state of the server in terms of the request manager, which controls the flow of tasks into Essbase Studio Server and the execution of the tasks. There are also commands that allow you to modify the task flow.

Essbase Studio Server commands are listed in the server window at startup. The commands are entered directly into the server window, along with any required response.

Some commands are used to make changes to the default server settings or to override the value you specified for the setting in server.properties. Changes you make to the settings using server commands are not persistent to the next Essbase Studio Server session. After restarting the server, any command settings you changed are reset to the default or to the value you specified for the setting in server.properties.

You can press Enter in the server window anytime for a list of available commands.

Essbase Studio Server commands are described below.

Server Commands

version—Prints onscreen the Essbase Studio Server version information.
Command
version
Example
version
Returns
```
Oracle Essbase Studio Server version 11.1.2.0.00 Build Number 1206
```

dumps—Displays stack traces of all server threads. This command is used mainly in the development environment.

Command

dumps

Example

dumps

Returns

The following is an example of a portion of the information returned when running the dumps command:

thread: Finalizer        at java.lang.Object.wait(Native Method)       at java.lang.ref.ReferenceQueue.remove(Unknown Source)       at java.lang.ref.ReferenceQueue.remove(Unknown Source)       at java.lang.ref.Finalizer$FinalizerThread.run(Unknown Source) thread: Reference Handler       at java.lang.Object.wait(Native Method)       at java.lang.Object.wait(Unknown Source)       at java.lang.ref.Reference$ReferenceHandler.run(Unknown Source) thread: Signal Dispatcher thread: Thread-1       at java.lang.Object.wait(Native Method)       at com.sun.jndi.ldap.pool.PoolCleaner.run(Unknown Source)

pconf—Displays the state of the following Essbase Studio Server request manager parameters: the number of worker threads specified, the number of resources allocated, the number of resources available, the size of the queue, and the number of queues in use.
See server.threadCount for a description of worker threads.
Command
pconf
Example
pconf
Returns
The following is an example of the information returned when running the pconf command.
```
Request manager configuration:    Threads: 10, Resources: 5 (4 avail), Queue Size: 100 (10 in use)
```

squeue—Sets the queue size in terms of number of tasks. The queue holds the tasks waiting to be executed by Essbase Studio Server.

The default number of tasks in the queue is 200.

Command

squeue

When you run this command, you are prompted to enter the new queue size.

Example

squeue
new queue size: 250

Note:

Any change you make to this setting is not persistent to the next Essbase Studio Server session. After restarting the server, the squeue parameter is either reset to the default or to the value you specified for server.queueSize, described in Configuring the Server Properties File.

sthd—Sets the number of worker threads allocated to Essbase Studio Server.

See server.threadCount for a description of worker threads.

Note:

To account for the worker threads that listen for and get tasks from Essbase Studio clients, the number of workers threads must be set to a number greater than the number of resources.

The default setting is 30 threads.

Command

sthd

When you run this command, you are prompted to enter the new thread count.

Example

sthd
new thread count: 45

Note:

Any change you make to this setting is not persistent to the next Essbase Studio Server session. After restarting the server, the sthd parameter is either reset to the default or to the value you specified for server.threadCount, described in Configuring the Server Properties File.

sres—Sets the number of resources, which defines the number of tasks that can be executed concurrently.

The default setting is 20 resources.

Command

sres

When you run this command, you are prompted to enter the new number of resources.

Example

sres
new resource count: 30

Note:

Any change you make to this setting is not persistent to the next Essbase Studio Server session. After restarting the server, the sres parameter is either reset to the default or to the value you specified for server.resourceCount, described in Configuring the Server Properties File.

exit—Stops Essbase Studio Server and closes the server window.
Command
exit
Example
exit