Skip to end of metadata
Go to start of metadata

The following commands set properties on a per-dataset basis:

Default Table

DescriptionDefine the default table for this dataset.
Usage

View the current configuration:

cfg db <dataset_id> superweb2.defaultTable
cdf db <dataset_id> superweb2.udrDefaultTable

Update the configuration:

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:

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.

cfg db bank superweb2.defaultTable set "My Table"

The following example removes the default table from Retail Banking.

cfg db bank superweb2.defaultTable remove
More InformationConfigure a Default Table for your Datasets - SuperWEB2

Field Exclusion Rules

DescriptionDefine 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:

cfg db <dataset_id> superweb2.rules.fieldExclusion

Update the configuration:

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:

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:

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:

cfg db bank superweb2.rules.fieldExclusion remove
More InformationField Exclusion Rules - SuperWEB2

Mandatory Fields

Description

Define a mandatory field rule for this dataset.

Usage

View the current configuration:

cfg db <dataset_id> superweb2.rules.mandatoryFields

Update the configuration:

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:

cfg db <dataset_id> superweb2.rules.mandatoryFields remove

Examples

The following commands specify that the Gender field will be add to the columns automatically:

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:

cfg db bank superweb2.rules.fieldExclusion remove
More InformationMandatory Fields - SuperWEB2

Metadata

DescriptionActivate metadata links in the list of fields in the customise table panel.
Usage

View the current configuration:

cfg db <dataset_id> superweb2.metadata

Show metadata links for specified fields, groups and measures:

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:

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:

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:

cfg db <dataset_id> superweb2.metadata remove
Examples
cfg db bank superweb2.metadata.field add SXV4__Retail_Banking__F_Customer__Marital_Status_FLD
cfg db bank superweb2.metadata.field add SXV4__Retail_Banking__F_Customer__Gender_FLD
cfg db bank superweb2.metadata.field[3] remove
More InformationDisplay Metadata Icons in the Field List - SuperWEB2

Prevent Alphabetical Sorting of Fields

DescriptionPrevent 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:

cfg db <dataset_id> superweb2.rules.valueSetItemIndexOrders

Update the configuration:

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:

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
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 InformationPrevent Fields from Sorting Alphabetically - SuperWEB2

 

Survey Date

DescriptionSet the survey date (in ISO-8601 format: YYYY-MM-DD). The date is included in SDMX downloads.
Usage

View the current configuration:

cfg db <dataset_id> superweb2.surveyDate

Update the configuration:

cfg db <dataset_id> superweb2.surveyDate set <date>

Clear the configuration:

cfg db <dataset_id> superweb2.surveyDate remove
Examples
cfg db bank superweb2.surveyDate set "2010-03-05"
More InformationBranding SDMX Downloads - SuperWEB2

Zero Suppression

DescriptionConfigure whether zero suppression is activated by default.
Usage

View the current configuration:

cfg db <dataset_id> superweb2.zeroSuppression

Update the configuration:

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):

cfg db <dataset_id> superweb2.zeroSuppression remove
Examples
cfg db bank superweb2.zeroSuppression.rows set true
cfg db bank superweb2.zeroSuppression.columns set true
More InformationConfigure Zero Suppression - SuperWEB2
  • No labels