Skip to main content
Skip table of contents

ranges

This command configures the limits for the custom range and quantile user defined fields available in SuperWEB2.

If users are currently logged in to SuperWEB2 while you make changes to the range limits, then those users will not see the effect of your changes until they log out and log back in. 

ranges <dataset_id>

Display the limits currently defined for the specified dataset.

For example:

CODE
> ranges bank
Customer Profit:
    custom range: 10.0, 10000.0, 100.0
Account Profit:
    custom range: [min], [max], [min-increment]
Average Account Balance:
    custom range: [min], [max], [min-increment]

In this example:

  • The Customer Profit summation option has range limits defined. SuperWEB2 users will not be able to create custom ranges or quantiles with a From value that is lower than 10, a To value that is higher than 10,000 or an Increment smaller than 100 (the increment limit does not apply to quantiles).
  • Account Profit and Average Account Balance do not have any limits set.
ranges <dataset_id> <field_or_regex>

Display any range limits currently defined for the specified summation option.

You can either specify the summation option using its display name, or you can specify a regular expression and SuperADMIN will display the limits for all matches. For example:

CODE
> ranges bank .*Account.*
Account Profit:
    custom range: [min], [max], [min-increment]
Average Account Balance:
    custom range: [min], [max], [min-increment]
ranges <dataset_id> <field_or_regex> custom <min> <max> <min_increment>

Apply a limit to the specified summation option (or any summation options matching the regular expression).

You can specify:

  • The minimum From value.
  • The maximum To value.
  • The minimum Increment size.

The limits apply to both custom ranges and quantiles, although the increment does not apply to quantiles.

For example, the following command sets custom ranges for the "Customer Profit" field in the bank dataset:

CODE
ranges bank "Customer Profit" custom 10 1000 100
ranges <dataset_id> <field_or_regex> custom clear

Clear the custom range from the specified summation option (or any summation options matching the regular expression).

For example:

CODE
> ranges bank .*Account.* custom clear

To clear all custom ranges for a particular dataset, you can use the regular expression .*

For example, the following command would clear all custom ranges defined for the bank dataset:

CODE
> ranges bank .* custom clear
ranges <dataset_id> id <field_id>

Display any range limits for the specified summation option. This format of command is only available when the ranges configuration has been migrated to configuration server (see the steps below for more details).

For example:

CODE
> ranges bank id SXV4__Retail_Banking__F_Customer__Cust_Profit_FLD
Customer Profit:
    custom range: 10.0, 10000.0, 100.0

Use the command cat <dataset_id> <field_name> to find a field's ID. For example cat bank fields "Customer Profit".

ranges <dataset_id> id <field_id> custom <min> <max> <min_increment>
ranges <dataset_id> id <field_id> custom min <min>
ranges <dataset_id> id <field_id> custom max <max>
ranges <dataset_id> id <field_id> custom minIncrement <min_increment>
ranges <dataset_id> id <field_id> custom clear

Configure the minimum, maximum and increment values for the summation option with this ID.

These formats of the command (which allow lookup by field ID) are only available when the ranges configuration has been migrated to configuration server (see the steps below for more details).

Migrate Ranges to Configuration Server

From version 9.17 onwards, the ranges settings can be stored in the SuperADMIN configuration server. This provides improved performance when defining large numbers of custom range settings. Prior to 9.17, SuperADMIN stored the ranges configuration setting in an XML file (RangesCatalog.xml) within the SuperADMIN .repository directory.

If you do not have any existing range configuration, (i.e., there is no RangesCatalog.xml file in the .repository directory) then from 9.17 onwards, SuperADMIN will use the configuration server by default to store any new custom range settings that you define.

If you already have existing range configuration when you upgrade to 9.17 then SuperADMIN will continue to use the existing XML file until you run the following command to initiate the migration:

CODE
cfg global superadmin.migration.rangesCatalog set true

When you run this command, all of your existing range settings will be migrated, and the XML file will no longer be updated. You can only perform the migration once (running this command more than once will not migrate any later changes to the XML file to the configuration server).

Following the migration, you can continue to use the ranges command described above. You can also view and change range settings via the cfg command:

CODE
cfg db <dataset_id> superweb2.ranges

 For example:

CODE
> cfg db bank superweb2.ranges

{
    "SXV4__Retail_Banking__F_Customer__Cust_Profit_FLD": {
        "max": 10000,
        "min": 10,
        "minIncrement": 100
    }
}

> cfg db bank superweb2.ranges.SXV4__Retail_Banking__F_Customer__Cust_Profit_FLD.max set 1000000

> cfg db bank superweb2.ranges

{
    "SXV4__Retail_Banking__F_Customer__Cust_Profit_FLD": {
        "max": 1000000,
        "min": 10,
        "minIncrement": 100
    }
}
> ranges bank
Customer Profit:
    custom range: 10.0, 1000000.0, 100.0
Account Profit:
    custom range: [min], [max], [min-increment]
Average Account Balance:
    custom range: [min], [max], [min-increment]

As shown in the above example, settings can be viewed and changed either using the old command or via the cfg command.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.