Skip to end of metadata
Go to start of metadata
This command maintains the settings for the registered and available SuperSERVERs.

If you make any changes to the server configuration (server <id> config) using this command, then you must restart SuperSERVER in order for your changes to take effect.

UsageDescription
server

Displays a list of available servers and any SuperWEB2 instances that are registered with the server. SuperWEB2 automatically registers with the server when it starts up.

The list of registered SuperWEB2 instances is used by SuperADMIN when users run commands that add or change tables in the user data repository. By default, if there are multiple SuperWEB2 instances then the one listed first is the one that commands will be directed to, but you can change this by using the connection command.

server <id>
Displays the properties and settings for the specified server.
server servers
Displays the settings for all configured servers.
server register sw2 <url>

Manually registers a SuperWEB2 instance with this server.

server deregister sw2 <url>

Deregisters a SuperWEB2 server from the server. Copy the URL from the list of SuperWEB2 servers that is displayed when you run the server command on its own.

server <id> config cacheDatabases {true|false}

Configures whether or not to cache databases on the specified server:

true
Cache all databases irrespective of their usage. This will cause high memory usage.
false
Cache databases on demand. This will cache the databases only upon user requests. Memory usage will grow with demand for new tables.
server <id> config dataCubeTransferLimit <value>

Sets the transfer size (in number of cells) of tabulation results sent to client programs.

Tabulation results are essentially n dimensional data cubes, and they can be millions of cells in size. To ensure network performance does not degrade when SuperSERVER transfers a large chunk of data, SuperSERVER uses the dataCubeTransferLimit to set the number of cells it sends in each chunk of data.

The size of the cell depends on the type of job, either 32 or 64 bytes. 1024 cells is therefore equivalent to (at most) a 64 kb chunk of data.

If client programs spend long periods waiting for results, you might need to increase the size of this setting. However, if you make the setting too large, other clients will be locked out of communicating with the server while it spends time transmitting large data chunks.

server <id> config dataCubeDenseMemoryLimit <value>

Sets the cache memory limit (in bytes) beyond which SuperSERVER suppresses zero value cells from the cache.

When the memory required to contain the cross tabulation results goes over the configured limit, SuperSERVER switches the storage to a more compact storage mechanism, which may be a bit slower.

There is a trade off between memory usage and speed of tabulation: the more compact storage mechanism uses much less memory for large sparse result cubes. For large databases with an extremely large number of records, if the results cube is very dense, then the compact storage may use more memory than the standard one.

The default setting is 1000000.

See Performance Considerations - SuperSERVER for more information.

server <id> config xtabProcessors <value>

Sets the number of queries that can be run at the same time.

Depending on the number of users or queries being run, you might need to increase the number of concurrent queries. This will not affect the running time of queries. However it will prevent large queries from taking over the system and causing users who are running smaller queries to wait.

The default setting is 2, meaning that two jobs can be processed at a time.

If the SuperSERVER machine has multiple CPUs that other applications do not use, you can increase the number of concurrent queries.

See Performance Considerations - SuperSERVER for more information.

server <id> config numberThreadsPerCrossTab <value>

Set the number of parallel threads for each cross tabulation.

The default setting is 4.

Setting this to a higher value will usually give a faster cross tabulation, depending on the hardware available on the machine running SuperSERVER.

See Performance Considerations - SuperSERVER for more information.

server <id> config jobAgingTime <value>
This setting has been deprecated. Do not change.
server <id> config jobPurgeResultTime <value>

Sets the time (in seconds) to wait before purging unclaimed jobs.

This setting configures the length of time a result will sit in the result queue before it is deleted. You are recommended to set this to a higher value (sometimes even one or more minutes) in case there are jobs with longer processing times.

server <id> config findServiceTime <value>
This setting is no longer used.
server <id> config cubeConcealmentRule {nullAsConcealed|nullAsZero}

This setting is used by the Production System when creating an SXV4 cube. It sets the cube concealment rule:

nullAsConcealed
Configures Production System to treat a summation or recode total as concealed if all contributing cells are also concealed. If any of the cells are not concealed then all the remaining concealed values are treated as having the value 0.
nullAsZero
Concealed data is treated as having the value 0. This is the default setting.
server <id> config cacheUserDBCatalog {true|false}

Configures whether or not to cache user database catalogues. This can speed up a user's first login.

true
Cache the user database catalogue.
false
Do not cache the user database catalogue. This is the default.
server <id> host <host>

Sets the name of the host where the specified SuperSERVER is running.

server <id> host port <port>
Sets the port of the specified SuperSERVER.
server <id> path <path>
Changes the file path location of the specified server.
server <id> displayname <display_name>
Changes the server's display name.
server <id> id <new_id>
Changes the ID for this server.
server <id> remove
Removes the SuperSERVER's configuration from the list.
server add <id>
Adds a new server with the specified ID. This is not normally required as a running SuperSERVER should automatically register itself with the SuperADMIN server.
server addmd <id>
Adds a new Metadata server with the specified ID.
server defaultid <id>
Sets a given server configuration as the default for new servers.
server mdservers
Displays the settings for the configured metadata servers.