Configure Read-only Tables

SuperWEB2's read-only tables feature allows you to share static tables or reports with users. When this feature is enabled for a dataset, users can only access pre-defined tables for that dataset; they cannot create their own tables or modify the static tables (the tree of classifications and summation options will not be available, and users will not be able to drag and drop fields onto the table).

You can either configure this setting to apply to all users of a dataset or only for specific user groups.

To configure read-only access, use the SuperADMIN Console. See the reference page for the readOnlyTables command for full details of the command syntax.

Check and Remove Settings

Check the Current Setting

To see the current read-only status of a dataset enter cfg db <dataset_id> superweb2.readOnlyTables.

For example:

When a dataset does not have read-only tables configured

CODE

> cfg db bank superweb2.readOnlyTables
superweb2.readOnlyTables : not found

When a dataset is read-only for all users

CODE

> cfg db bank superweb2.readOnlyTables
true

When read-only tables for a dataset is disabled

CODE

> cfg db bank superweb2.readOnlyTables
false

When exclude and include groups have been set on a dataset

CODE

> cfg db bank superweb2.readOnlyTables

{
    "excludeGroups":[
        "Managers"
    ],
    "includeGroups":[
        "Staff"
    ]
}

Remove Settings

readOnlyTables is a global setting for the specified dataset. This setting takes precedence over any per-group configuration using includeGroups and/or excludeGroups . If you have already set readOnlyTables you will need to remove the setting using cfg db <dataset_id> superweb2.readOnlyTables remove first (this command will remove the global setting as well as any configured include or exclude groups).

For example:

To remove all readOnlyTable settings from a dataset

CODE

> cfg db bank superweb2.readOnlyTables remove
superweb2.readOnlyTables : Removed

To only remove include or exclude groups from a dataset

CODE

> cfg db bank superweb2.readOnlyTables.includeGroups remove
superweb2.readOnlyTables.includeGroups : Removed

> cfg db bank superweb2.readOnlyTables.excludeGroups remove
superweb2.readOnlyTables.excludeGroups : Removed

Configure Global Access

To set a dataset as read-only enter cfg db <dataset_id> superweb2.readOnlyTables set true.

For example:

CODE

> cfg db bank superweb2.readOnlyTables set true
superweb2.readOnlyTables : Created

A dataset that does not have read-only table configured displays both Fields and Tables.

A SuperWEB2 dataset that does not have read-only tables configured displaying fields

A dataset with read-only table configured only displays Tables. Fields in hidden from view.

A SuperWEB2 dataset with read-only tables configured only displaying tables

Configure Access by Group

You can configure tables with read-only access on a per-user group basis. Multiple user groups can be added to a group.

includeGroups	User groups that will have read-only access to the specified dataset. If only include groups are specified, excluded groups is set to none.
excludeGroups	User groups that will have read-write access to the specified dataset. 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.

Check the Group Setting

To see the current groups status of a dataset enter cfg db <dataset_id> superweb2.readOnlyTables.includeGroups or cfg db <dataset_id> superweb2.readOnlyTables.excludeGroups.

For example:

When a dataset does not have includeGroups configured

CODE

> cfg db bank superweb2.readOnlyTables.includeGroups
superweb2.readOnlyTables.includeGroups : not found

When a dataset has excludeGroups configured

CODE

> cfg db bank superweb2.readOnlyTables.excludeGroups

{
    "excludeGroups":[
        "Managers"
    ],
}

includeGroups

Add includeGroups

To set a user group with read-only access to a dataset enter cfg db <dataset_id> superweb2.readOnlyTables.includeGroups add "<value>".

For example:

CODE

> cfg db bank superweb2.readOnlyTables.includeGroups add "Staff"
superweb2.readOnlyTables.includeGroups : Created

> cfg db bank superweb2.readOnlyTables.includeGroups

[
    "Staff"
]

To add another group, repeat the command adding the additional group.

For example:

CODE

> cfg db bank superweb2.readOnlyTables.includeGroups add "Users"
superweb2.readOnlyTables.includeGroups : Updated

> cfg db bank superweb2.readOnlyTables.includeGroups

[
    "Staff",
    "Users"
]

Remove includeGroups

For detail on how to remove an includeGroup setting, see the Remove Settings section above.

excludeGroups

Add excludeGroups

To set a user group with read-write access to a dataset enter cfg db <dataset_id> superweb2.readOnlyTables.excludeGroups add "<value>".

For example:

CODE

> cfg db bank superweb2.readOnlyTables.excludeGroups add "Managers"
superweb2.readOnlyTables.excludeGroups : Created

> cfg db bank superweb2.readOnlyTables.excludeGroups

[
    "Managers"
]

Remove excludeGroups

For detail on how to remove an excludeGroup setting, see the Remove Settings section above.