The following commands set properties on a per-dataset basis:
Default Table
| Description | Define the default table for this dataset. |
|---|
| Usage | View the current configuration:
CODE
cfg db <dataset_id> superweb2.defaultTable
cfg db <dataset_id> superweb2.udrDefaultTable
Update the configuration:
CODE
cfg db <dataset_id> superweb2.defaultTable set <table_name>
cfg db <dataset_id> superweb2.udrDefaultTable.tableName set <table_name>
cfg db <dataset_id> superweb2.udrDefaultTable.folderId set <folder_id>
Clear the configuration:
CODE
cfg db <dataset_id> superweb2.defaultTable remove
cfg db <dataset_id> superweb2.udrDefaultTable remove
|
|---|
| Examples | The following example sets the default table for the Retail Banking dataset to be a saved system table.
CODE
cfg db bank superweb2.defaultTable set "My Table"
The following example removes the default table from Retail Banking.
CODE
cfg db bank superweb2.defaultTable remove
|
|---|
| More Information | Configure a Default Table for your Datasets |
|---|
Default Percentages
| Description | Enable default percentages for this dataset. |
|---|
| Usage | View the current configuration:
CODE
cfg db <dataset_id> superweb2.defaultPercentageAxis
Update the configuration:
CODE
cfg db <dataset_id> superweb2.defaultPercentageAxis set "{ROW|COLUMN|TOTAL}"
Clear the configuration:
CODE
cfg db <dataset_id> superweb2.defaultPercentageAxis remove
|
|---|
| Examples | The following example sets the Retail Banking dataset to use total percentages by default.
CODE
cfg db bank superweb2.defaultPercentageAxis set "TOTAL"
The following example removes the default table from Retail Banking.
CODE
cfg db bank superweb2.defaultPercentageAxis remove
|
|---|
| More Information | Enable Default Percentages |
|---|
Field Exclusion Rules
| Description | Define a field exclusion rule for this dataset. This rule will apply in addition to any global rules that are defined. |
|---|
| Usage | View the current configuration:
CODE
cfg db <dataset_id> superweb2.rules.fieldExclusion
Update the configuration:
CODE
cfg db <dataset_id> superweb2.rules.fieldExclusion[<index>].limit set <limit>
cfg db <dataset_id> superweb2.rules.fieldExclusion[<index>].fields set <list_of_fields>
Clear the configuration:
CODE
cfg db <dataset_id> superweb2.rules.fieldExclusion remove
|
|---|
Examples | The following command specifies that (for Retail Banking) only one of Age, Area and Occupation can be added to a table at any one time:
CODE
cfg db bank superweb2.rules.fieldExclusion[0].limit set 1
cfg db bank superweb2.rules.fieldExclusion[0].fields set [ "Age", "Area", "Occupation" ]
The following command removes all field exclusion rules defined for Retail Banking:
CODE
cfg db bank superweb2.rules.fieldExclusion remove
|
|---|
| More Information | Field Exclusion Rules |
|---|
Graph View Colours
| Description | Set specific colours for individual field items in Graph View. |
|---|
| Usage | View the current configuration:
CODE
cfg db <dataset_id> superweb2.fieldValueColors
Update the configuration:
CODE
cfg db <dataset_id> superweb2.fieldValueColors.<field>.values.<value> set <color>
cfg db <dataset_id> superweb2.fieldValueColors.<field>.nestedGradations set <value>
Clear the configuration:
CODE
cfg db <dataset_id> superweb2.fieldValueColors remove
|
|---|
| Examples | The following example sets the colours for specific Australian states within the Retail Banking Area field.
CODE
cfg db bank superweb2.fieldValueColors.SXV4__Retail_Banking__F_Customer__Area_FLD.values.1 set "SkyBlue"
cfg db bank superweb2.fieldValueColors.SXV4__Retail_Banking__F_Customer__Area_FLD.values.2 set "#000080"
|
|---|
| More Information | Configure Graph View |
|---|
Mandatory Fields
| Description | Define a mandatory field rule for this dataset. |
|---|
| Usage | View the current configuration:
CODE
cfg db <dataset_id> superweb2.rules.mandatoryFields
Update the configuration:
CODE
cfg db <dataset_id> superweb2.rules.mandatoryFields[<index>].axis set <axis>
cfg db <dataset_id> superweb2.rules.mandatoryFields[<index>].field set <field>
cfg db <dataset_id> superweb2.rules.mandatoryFields[<index>].valueSet set <valueset>
cfg db <dataset_id> superweb2.rules.mandatoryFields[<index>].values set <list_of_values>
cfg db <dataset_id> superweb2.rules.mandatoryFields[<index>].factTable set <fact_table>
Clear the configuration:
CODE
cfg db <dataset_id> superweb2.rules.mandatoryFields remove
|
|---|
Examples | The following commands specify that the Gender field will be add to the columns automatically:
CODE
cfg db bank superweb2.rules.mandatoryFields[0].axis set "Column"
cfg db bank superweb2.rules.mandatoryFields[0].field set "SXV4__Retail_Banking__F_Customer__Gender_FLD"
cfg db bank superweb2.rules.mandatoryFields[0].factTable set "Customers"
The following command removes all mandatory field rules defined for Retail Banking:
CODE
cfg db bank superweb2.rules.mandatoryFields remove
|
|---|
| More Information | Mandatory Fields |
|---|
| Description | Activate metadata links in the list of fields in the customise table panel. |
|---|
| Usage | View the current configuration:
CODE
cfg db <dataset_id> superweb2.metadata
Show metadata links for specified fields, groups and measures:
CODE
cfg db <dataset_id> superweb2.metadata.fields add <id>
cfg db <dataset_id> superweb2.metadata.groups add <id>
cfg db <dataset_id> superweb2.metadata.measures add <id>
cfg db <dataset_id> superweb2.metadata.fieldItems[<index>].field set <id>
cfg db <dataset_id> superweb2.metadata.fieldItems[<index>].fieldItems add <id>
Remove metadata links from a specific field, group or measure:
CODE
cfg db <dataset_id> superweb2.metadata.fields[<index>] remove
cfg db <dataset_id> superweb2.metadata.groups[<index>] remove
cfg db <dataset_id> superweb2.metadata.measures[<index>] remove
cfg db <dataset_id> superweb2.metadata.fieldItems[<index>] remove
Remove all metadata links for groups, fields, or measures:
CODE
cfg db <dataset_id> superweb2.metadata.fields remove
cfg db <dataset_id> superweb2.metadata.groups remove
cfg db <dataset_id> superweb2.metadata.measures remove
cfg db <dataset_id> superweb2.metadata.fieldItems remove
Clear the configuration:
CODE
cfg db <dataset_id> superweb2.metadata remove
|
|---|
| Examples |
CODE
cfg db bank superweb2.metadata.fields add "SXV4__Retail_Banking__F_Customer__Marital_Status_FLD"
cfg db bank superweb2.metadata.fields add "SXV4__Retail_Banking__F_Customer__Gender_FLD"
cfg db bank superweb2.metadata.fields[1] remove
|
|---|
| More Information | Display Metadata Icons |
|---|
Prevent Alphabetical Sorting of Fields
| Description | Prevent a field from sorting alphabetically. This is designed for fields where alphabetical sorting does not make sense, such as a date field containing the names of months or days. |
|---|
| Usage | View the current configuration:
CODE
cfg db <dataset_id> superweb2.rules.valueSetItemIndexOrders
Update the configuration:
CODE
cfg db <dataset_id> superweb2.rules.valueSetItemIndexOrders[<index>].field set <field_id>
cfg db <dataset_id> superweb2.rules.valueSetItemIndexOrders[<index>].autoSort set true
Clear the configuration:
CODE
cfg db <dataset_id> superweb2.rules.valueSetItemIndexOrders[<index>].autoSort remove
cfg db <dataset_id> superweb2.rules.valueSetItemIndexOrders[<index>] remove
cfg db <dataset_id> superweb2.rules.valueSetItemIndexOrders remove
|
|---|
| Examples |
CODE
cfg db bank superweb2.rules.valueSetItemIndexOrders[0].field set "SXV4__Retail_Banking__F_Account__Last_Transaction_Date_Cal_FLD"
cfg db bank superweb2.rules.valueSetItemIndexOrders[1].field set "SXV4__Retail_Banking__F_Customer__Cust_Open_Date_Cal_FLD"
cfg db bank superweb2.rules.valueSetItemIndexOrders[2].field set "SXV4__Retail_Banking__F_Customer__Cust_Open_Date_Month_FLD"
cfg db bank superweb2.rules.valueSetItemIndexOrders[2].autoSort set true
|
|---|
| More Information | Prevent Fields from Sorting Alphabetically |
|---|
Read-only Tables
| Description | Settings to enable read-only access on a per-dataset and per-user group basis. This feature allows SuperWEB2 to share static tables or reports to users. When read-only tables is enabled, all users of the specified dataset will have read-only access. Users will not be able to edit any read-only tables, for example, the database schema tree and add/remove functionality will not be available. You can use the following optional properties for additional group access configuration. includeGroups | Specify user groups that will have read-only access to the specified dataset.
Multiple user groups can be added.
If only include groups are specified, excluded groups is set to none. |
|---|
excludeGroups | Specify user groups that will have read-write access to the specified dataset.
Multiple user groups can be added.
If only excluded groups are specified, include groups is set to match all. All other users will have read-only access. |
|---|
- If the same group is a member of both
includeGroups and excludeGroups, excludeGroups takes precedence. - If a user is a member of multiple groups that are added to both
includeGroups and excludeGroups, excludeGroups takes precedence.
|
|---|
| Usage | View the current configuration:
CODE
cfg db <dataset_id> superweb2.readOnlyTables
cfg db <dataset_id> superweb2.readOnlyTables.includeGroups
cfg db <dataset_id> superweb2.readOnlyTables.excludeGroups
Update the configuration:
CODE
cfg db <dataset_id> superweb2.readOnlyTables set {true|false}
cfg db <dataset_id> superweb2.readOnlyTables.includeGroups add "<value>"
cfg db <dataset_id> superweb2.readOnlyTables.excludeGroups add "<value>"
readOnlyTables is a global setting for the specified dataset. If you want to specify includeGroups and/or excludeGroups, the global setting takes precedence. If you have already set readOnlyTables you will need to remove the setting using cfg db <dataset_id> superweb2.readOnlyTables remove first.
Clear the configuration:
CODE
cfg db <dataset_id> superweb2.readOnlyTables remove
cfg db <dataset_id> superweb2.readOnlyTables.includeGroups remove
cfg db <dataset_id> superweb2.readOnlyTables.excludeGroups remove
|
|---|
| Examples | In the following example all users of the specified dataset will have read-only access.
CODE
cfg db bank superweb2.readOnlyTables set true
In the following example read-only tables is disabled for the specified dataset.
CODE
cfg db bank superweb2.readOnlyTables set false
In the following example members of group_1 will have read-only access the specified dataset. If excludeGroups has not been specified, then all other users will have read-write access to the dataset.
CODE
cfg db bank superweb2.readOnlyTables.includeGroups add "group_1"
In the following example members of the administrators group will have read-write access to the specified dataset. If includeGroups has not been specified, then all other users will have read-only access to the dataset.
CODE
cfg db bank superweb2.readOnlyTables.excludeGroups add "administrators"
|
|---|
| More Information | Configure Read-only Tables |
|---|
Survey Date
| Description | Set the survey date (in ISO-8601 format: YYYY-MM-DD). The date is included in SDMX downloads. |
|---|
| Usage | View the current configuration:
CODE
cfg db <dataset_id> superweb2.surveyDate
Update the configuration:
CODE
cfg db <dataset_id> superweb2.surveyDate set <date>
Clear the configuration:
CODE
cfg db <dataset_id> superweb2.surveyDate remove
|
|---|
| Examples |
CODE
cfg db bank superweb2.surveyDate set "2010-03-05"
|
|---|
| More Information | Branding SDMX Downloads |
|---|
Zero Suppression
| Description | Configure whether zero suppression is activated by default. |
|---|
| Usage | View the current configuration:
CODE
cfg db <dataset_id> superweb2.zeroSuppression
Update the configuration:
CODE
cfg db <dataset_id> superweb2.zeroSuppression.rows set {true|false}
cfg db <dataset_id> superweb2.zeroSuppression.columns set {true|false}
Clear the configuration (this is equivalent to setting both rows and columns to false):
CODE
cfg db <dataset_id> superweb2.zeroSuppression remove
|
|---|
| Examples |
CODE
cfg db bank superweb2.zeroSuppression.rows set true
cfg db bank superweb2.zeroSuppression.columns set true
|
|---|
| More Information | Configure Zero Suppression |
|---|
