cat
Use this command to configure the catalogue; the collection of folders, databases, tables and recodes available to SuperSERVER.
Item | Description |
---|---|
Folder | Similar to a folder in a filesystem, you can use folders to organise the items in the catalogue and group together related items. The folders will be displayed to end users in the client (SuperCROSS, SuperWEB2, etc) |
Database | An sxv4 file containing the SuperSTAR database for cross tabulation. |
Table | A saved table that can be loaded by SuperSTAR clients. |
Recode Group | A set of saved recodes or User Defined Fields (UDFs) that can be loaded by SuperSTAR clients. |
Use the cat
command to:
View Current Catalogue Settings
Usage | Description |
---|---|
cat | Display all the items in the catalogue, including databases, folders, tables and recode groups, along with their settings. |
cat <id> |
Display the settings for the specified database, folder, table or recode group. Note: Items in the catalogue have a display name (the name that is displayed to end users in the client) and an ID (a unique identifier). When managing the item in SuperADMIN, you must always use the ID, not the display name.
If a display name or ID includes non alphanumeric characters (e.g. a space) then you must enclose it in quote marks. You must also enclose a display name or ID in quotes if it starts with a numeric character. |
cat <database_id> fields | List all the fields for the specified database. |
cat <database_id> <field_name> | List all the ID and value set IDs for the specified field. |
cat <database_id> <field_name> <value_set> values | List all the values for this value set. |
cat [ <folder_id> ] databases | List all the databases in the specified folder (or at the root level if you omit the folder ID). |
cat [ <folder_id> ] folders | List all the folders in the specified folder (or at the root level if you omit the folder ID). |
cat [ <folder_id> ] tables | List all the tables in the specified folder (or at the root level if you omit the folder ID). |
cat [ <folder_id> ] recodegroups | List the recode groups in the specified folder (or at the root level if you omit the folder ID). |
Add Databases, Folders, Tables and Recode Groups
Usage | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
cat [ <folder_id> ] adddb <database_id> [ <display_name> ] <path_location> <server_id> |
Add a new database to the catalogue.
| ||||||||||||
cat [ <folder_id> ] addfolder <new_folder_id> [ <display_name> ] |
Create a new folder.
| ||||||||||||
cat [ <folder_id> ] addrecodegroup <recode_group_id> [ <display_name> ] <path_location> |
Add a group of recodes to the catalogue.
| ||||||||||||
cat [ <folder_id> ] addtable <table_id> [ <display_name> ] <path_location> |
Add a table to the catalogue.
|
Modify Databases, Folders, Tables and Recode Groups
Usage | Description |
---|---|
cat <id> {up|down} |
Change the order items are listed in the catalogue (the order of items in the catalogue is also the order they will be displayed to users in the clients). Use this command to move an item up or down the list. |
cat <id> move <folder_id> |
Move the specified item into the specified folder. To move an item to the top level of the catalogue, use the folder ID
TEXT
|
cat <database_id> location <path_location> | Change the location of the sxv4 file that contains the database. This can either be an absolute path or a location relative to the SuperSERVER program data directory (in a default installation, this is C:\ProgramData\STR\SuperSERVER SA). The location must be accessible from the machine that SuperSERVER is installed on. |
cat [ <id> ] displayname <display_name> |
Change the display name of the specified database, folder, table, or recode group. If you omit the
CODE
|
cat <id> id <new_id> |
Change the ID of the specified database, folder, table or recode group. You are recommended not to change IDs, but if you do you will need to restart SuperSERVER and re-apply all the user permissions for the catalogue item. |
cat {<database_id>|<folder_id>} multilingual {true|false} | Set the database or folder to be multilingual. This setting is used in conjunction with multilingual metadata to display database/table names, and field names in multiple languages. See Metadata and Multilingual Tables - SuperCROSS for more details on setting up multilingual metadata. |
cat remove <id> |
Remove the specified database, folder, table, or recode group from the catalogue. Removing a folder will remove all the databases within that folder. |
Set and Check User Access Permissions
Parameter | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
cat <id> [ <item> ] access {<user>|<group>} | Check what permissions the specified user or group has over the specified database, folder, table, or recode group. | ||||||||||||
cat <id> [ <item> ] access {<user>|<group>} reset | Reset the permissions for this user or group over the specified database, folder, table, or recode group to the defaults. | ||||||||||||
cat <id> permissions | Check which users or groups have permissions set for the specified catalogue item. | ||||||||||||
cat userpermissions | Check the logged in user's permissions. | ||||||||||||
cat {<database_id>|<folder_id>} [ <item> ] access {<user>|<group>|<collection>} |
Allow or deny access to the database or table.
|
View and Export Tables and Recode Groups
Usage | Description |
---|---|
cat {<table_id>|<recode_group_id>} content |
Display the details of the table or recode group. For example:
TEXT
|
cat {<table_id>|<recode_group_id>} export <path_location> | Export the table or recode group to a file. The path location must be a full path to the location to save the file on disk. |
Statistical Functions
Usage | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
cat aggregatestatfunction family name <name> |
Set the aggregated statistical function used by SuperSERVER. This algorithm is used for calculating medians, percentiles and paretos in derivations. The default is Parzen#1; you can change it to Parzen#2 if necessary, using the following command:
TEXT
| ||||||||||||
cat [ <database_id> ] addstatfunction {mean|median} |
Add a statistical function to the available options in the SuperWEB2 Summation Options. Currently mean and median are the only available options. If you specify a database ID then the change will apply to that database only. If you omit the ID then it will apply to all databases by default (unless it is overridden for a specific database). This setting applies to SuperWEB2 only. | ||||||||||||
cat [ <database_id> ] removestatfunction {mean|median} |
Remove a statistical function from the available Summation Options in SuperWEB2. If you specify a database ID then the change will apply to that database only. If you omit the ID then the function will be removed from the global default setting. This setting applies to SuperWEB2 only. | ||||||||||||
cat [ <database_id> ] availablestatfunctions |
List the statistical functions currently enabled for the specified database. If you omit the database ID this command will list the functions currently enabled at the root level. This statistical functions apply to SuperWEB2 only. | ||||||||||||
cat unitrecord nullhandling {NullAsSkipped|NullAsZero} |
Configure how SuperSERVER will handle null values when computing statistical functions on measure fields. The treatment of null values can affect the result. For example, suppose you have the following set of values: 4, 2, NULL If you calculate the mean from these values, then the result will either be:
The default setting is NullAsSkipped. | ||||||||||||
cat unitrecord | Display the current null handling setting. | ||||||||||||
cat Quantile |
Display the current quantile settings. | ||||||||||||
cat Quantile algorithm {Step|AverageStep|WeightedAverage} |
Set the algorithm used for quantile calculations:
| ||||||||||||
cat Quantile Buckets [<array_of_integers>] |
Set the quantile ranges available in SuperWEB2. Specify the buckets using an array of integers. These must be whole integers greater than 1. For example:
TEXT
These ranges will be available in SuperWEB2 as follows:
This setting applies to SuperWEB2 only. You must restart Tomcat or the SuperWEB2 service for the change to take effect. | ||||||||||||
cat Quantile confidentialitystring <string> |
Set the confidentiality string. This string is used to conceal the minimum of the bottom range and the maximum of the top range when quantile perturbation is enabled. For example:
CODE
You are recommended not to change the confidentiality string except during the initial system configuration. If the string is changed then it may not be possible to reload some pre saved TXD files with recodes on the quantile. |
Method Catalogue Settings
Usage | Description |
---|---|
cat [ <folder_id> ] findmethod <method_id> |
Displays the database IDs of all the databases that the specified method is assigned to.
SuperADMIN applies permissions to this command. It will only search databases where you have at least read permission. |
cat <database_id> methods | Displays a summary of the methods assigned to this database. |
cat <database_id> methods details <method_id> | Displays detailed information about the specified method. |
cat <database_id> addmethod <method_id> [ <priority> ] |
Apply a method to the specified database. The priority is optional. If you do not specify a priority then it defaults to the highest in the order and the method will be executed last. |
cat <database_id> methods <method_id> priority <priority> | Change the priority of the specified method. |
cat <database_id> removemethod <method_id> | Removes the specified method from this database. |
cat <folder_id> removemethod <method_id> | Removes the specified method from all database in this folder. |
cat <database_id> methods remove | Remove all methods from this database. |
cat <database_id> disablemethods access {<user>|<group>} read {true|false} |
Control whether or not users are allowed to disable mandatory methods in SuperCROSS. Set this to |
cat <database_id> selectTableMethods access {<user>|<group>} read {true|false} | Control whether or not users are allowed to disable table methods in SuperCROSS. Set this to true to allow this or false otherwise. |
Change Other Catalogue Settings
Usage | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
cat <database_id> enablerecodetotals {true|false} |
Enable or disable the ability for users to create recode totals. If you set this to false, then:
| ||||||||
cat <folder_id> maxfiles <value> |
Set the maximum number of files that can be saved into this folder. You can use this setting to prevent users from saving files to a particular folder, or to restrict the number of saved files to a reasonable limit. For example:
TEXT
Set this to "-1" if you do not want to impose a limit on the number of files. When setting the value to -1 you must use quotes. For example:
TEXT
If you use this command without specifying a folder, then it will set the value at the root level. That value will be used as a default for all new folders as they are created. For example:
TEXT
| ||||||||
cat createpersonalfolder <user> |
Create a personal folder accessible only to the specified user and the administrator. Personal folders are used in SuperWEB1. Before issuing this command you must turn on the For example, to create a personal folder for user2 and user3:
TEXT
| ||||||||
cat <id> recordview value {<user>|<group>} {true|false} |
Allow or deny access to the Record View feature in SuperWEB1, SuperWEB2 , and SuperCROSS .
|