Configure User Filter Manual Mode

Let’s consider the Hotel Revenue Management Dashboard sample here. In this dashboard, we will configure the user filter so that the staff and managers can view the data specific to the continent.

To start, open the User Filter Dialog by following the steps mentioned here

In the manual mode UI, we will first select the column to be used as the filter. In this case, we will choose the Region column. A name can also be set for the filter for better user understanding when multiple filters are created for the same dashboard.

Once the column is selected, the User Group section and the Fields section will be enabled. The user can do the mapping for the user or group here.

The selected column and the name of the filter will be shown in the tile on the left.

The filter can be set for each user or group by selecting the user or group and checking the required value in the fields section. In this example, we are focusing on applying the filter for the groups so that all users in the group will have data restrictions applied.

Users/Groups

All active users and groups on the Bold BI server will be listed. Users will be listed at the top followed by the groups.

Auto Mapping based on user email / full name (1)

When creating a data source with a column containing user email, full name, or group name, the auto map feature can be used to assign the filter automatically. This can be set by selecting the data column, clicking on the Auto Mapping icon, and selecting the type from the menu.

You can manually assign different values to users or groups as well, even after setting auto mapping. For those users or groups, the selected data will be shown.

To remove auto mapping, choose the None option from the menu.

NOTE: The mapping will only be shown in the UI if the settings match a result. If not, no indication will be shown.

Filter(2)

Users and groups can be filtered using the filter icon to show all, mapped, or unmapped users and groups. Users are sorted in ascending order by default.

Sort(3)

The users are sorted in ascending order by default, and this can be toggled using the sort icon.

Refresh(4)

The user group list can be refreshed to get the latest list of users and groups from the server by clicking on the refresh icon. The configured settings will not be reset during this action.

More Options(5)

Use filter from

You can merge or copy the settings applied to another user or group by using the Use filter from option in the view. A dialog will pop up listing the users or groups that have the mapping configured. You can choose one or more users to merge with the selected user or group.

View Users

You can view the list of users who are present in a group by using the View Users option.

A dialog will pop up listing the users that belong to the group.

IMPORTANT: If a user is present in multiple groups, the user will be able to see the data mapped in all the groups while viewing the dashboard.

Clear

You can remove the settings applied for the user by clicking the Clear option.

Fields

The values of the column selected as the data column will be listed in the fields section. The action icons in the field section have the same behavior as those in the user group list section.

Inverting the data restriction

By default, when a user is not mapped with any data in the user filter, no data will be shown to the user when the dashboard is viewed. There will be cases where you will have to apply the restriction to a few users and let other users see the full data.

This can be achieved by checking the Show all data for unmapped users or groups option. Checking this option will remove the filter restriction for all the unmapped users or groups. Only the users who have any filter configured will see the restricted data. All other users will be able to see the data without any restrictions.

NOTE: When multiple filters are created for the data source, make sure to check the Show all data for unmapped users or groups option if the user has no mapping set in that filter setting. Failing to do so will result in a No data available message being shown to that user.

Create User Filter Via Rest API - Manual Mode

Using the Rest API, add the user filter to the data source.

Rest API - v4.0

1. To get the item ID, click the three dotted option and choose info.

   

2. You can pass the values in JSON format.

If we don’t give the “BasedOn” and “Mode”, it will assign a default value as “BasedOn”:“None” and “Mode”:“Auto”.

3. Using the Name option, we can give the filter a name.

Parameters for adding user filter

NOTE::

1. Please note that the UserId or GroupId listed in the above JSON should be used in Bold BI as users or groups.

2. Currently, the User filter API is supported only for Manual mode.

Sample for creating User Filter via Rest Api using group Id

{
    "BasicFilters": [
        {
            "Mode": "Manual",
            "UserInfo": [
                {
                    "IsGroup": true,
                    "IsCheckAll": false,
                    "SelectedValues": [
                        "12345"
                    ],
                    "IncludeFutureValues": false,
                    "RelativeDateFilter": null,
                    "UserId": null,
                    "GroupId": "string"
                }
            ],
            "ShowRecordsToUnmappedUsers": true,
            "ColumnId": "string",
            "Name": "string",
            "BasedOn": "None"
        }
    ],
    "AdvancedFilter": null
}

Sample for creating User filter with relative date

{
    "BasicFilters": [
        {
            "Mode": "Manual",
            "UserInfo": [
                {
                    "IsGroup": false,
                    "IsCheckAll": false,
                    "SelectedValues": [],
                    "IncludeFutureValues": false,
                    "RelativeDateFilter": {
                        "RelativeDateFormat": "Month",
                        "DateInstance": "Past",
                        "StartDate": "07/25/1996 12:00 AM",
                        "EndDate": "10/24/1996 11:59 PM",
                        "Range": 3,
                        "UseAnchorDate": true,
                        "AnchorDate": "10/19/1996"
                    },
                    "UserId": "user@domain.com"
                }
            ],
            "ShowRecordsToUnmappedUsers": true,
            "ColumnId": "string",
            "Name": "string",
            "BasedOn": "None"
        }
    ],
    "AdvancedFilter": null
}