What are data views?
Data views allow authors to configure a filtered view of an underlying Case Database within a Service. This enables authors to create more than one data view that uses the same underlying case database but is geared towards several stakeholders who should see different fields of the records.
Authors may customize their data view by choosing which field(s) and/or record(s) they would like to be displayed. Additionally, authors can set a specific action to be applied to a record, for instance, to allow for further processing in a BRYTER module.
Why are data views useful?
Different groups of people look at the same data in very different ways, filtering out the information that may not be relevant to their role or position. This is where data views come in. Data views act as a filtration system: In other words, depending on your role within an organization you are shown different data, specifically, data that is relevant and appropriate to you.
Let us look at an example use case, the administration of vacation requests:
When an employee submits a vacation request, a new entry is created in the relevant case database within your service. For a variety of different reasons, it may be necessary that employees are able to access their vacation requests. However, you would generally want the employee to only see the request(s) that they have submitted. On the other hand, you would want managers to see all vacation requests submitted by any of the employees. In that case, you would simply set up two different data views, one is geared towards employees ("end-user dashboard"), and the other being geared towards managers ("operator dashboard").
This becomes even more significant when you allow for further processing within a data view. E.g. an employee cannot only view their submitted vacation request but edit it to change the dates on a pending request. Or a manager can click a "Review" action button to process the vacation request in a linked BRYTER module which 1) checks against the employee's remaining vacation days and 2) asks whether the manager would like to approve or reject the request.
The filters for a new data view can be configured to meet the specific needs of the different groups. While an employee may be interested in seeing all of their past vacation requests, a manager who is responsible for several employees will likely only find current and pending requests important which allow easy administration of vacation requests.
How to use data views
- You can find "Data Views" in the sidebar of a service.
- "New data view" lets you configure a data view, based on a case database within the same service.
- "Save" automatically publishes Test and Live versions of the data view. (A Live data view shows data from the underlying Live database, which is used in Live modules.)
- From the list of data views, click Test or Live to open the published version of the data view.
How to create a new data view
- General: Provide a name for your data view by clicking into the breadcrumb trail in the black navigation bar.
- Case database: Select the underlying case database for your data view in the data view editor on the righthand side. Once you select the database, options for "Fields" will appear, along with "Filter records (optional)" and "Actions (optional)".
- Fields: Select the fields you would like to be displayed in your data view by clicking the checkboxes. Note that there are two columns. The first one (where you select the fields) displays the field's name. The second column displays the name used when referencing in "Filter records" or "Actions". It is displayed in grey. If you select no checkboxes, no fields will be displayed. Ticking Select All will display all options.
- Filter records (optional): You can set conditions for fields to appear when the condition is met. In our above example, one filter record could be
status is Cancelled, showing only cancelled requests.
💡 Find more detailed documentation in 🗄 How to filter in data views
- Actions (optional): Set up a button to allow for further processing in a BRYTER module. In our above example, the Button label could be "Cancel" and link to the module that simplifies the cancelling the request by eliminating unnecessary steps. Different URLs can be specified for Test and Live environments, e.g. the same Module published in either TEST or LIVE.
💡 Find more detailed documentation in 🗄 How to use action buttons in data views
Use case examples, best practices, and known limitations
👍 Good use of data views
- Different stakeholders see only the data that is relevant: In the vacation request example, only a manager would see all requests whereas employees will only be able to see their own requests.
- Combining relevant data inputs of several databases and associated modules for BRYTER users: While collaborators of a service, i.e. Authors and Admins, are able to download the Stats of each module within the service separately, a data view allows to pull together and link relevant data collected across several modules for BRYTER users without editing rights. They can download the necessary data as a CSV file.
👎 Bad use of data views
- Using data views simply as another way of downloading module stats for authors and admins: Module Stats provide richer data than data views for a single module. They can however be used to ensure that only completed sessions are displayed
💡 Best practices
- Use human-friendly column names: Data views will display the column names of the fields in the selected database. Consider using sentence case instead of only lower case and adding emojis such as calendars or exclamation marks to create user-friendly data views.
- Avoid displaying too much irrelevant data: If authors only want to display records with a certain status or only containing a certain manager email, they should consider using filters and refrain from also adding as a field.
❗ Known limitations
- Configurable sort order or column reordering
- Linking to a non BRYTER module: As a workaround, you can publish a module that goes straight to a redirect result node.
- Ad-hoc filtering and sorting by data view users
- Embedding data views: Data views can only be used by logged-in BRYTER users (anyone with a BRYTER account, e.g. user, author, or admin)
- Multiple action buttons or conditional actions
- Advanced filtering such as comparators for dates and numbers. Possible workaround: Instead of age ≤ 30, use age < 30 OR age is 30
Keywords: dataview; dataviews; Datenansicht; Dashboard; case overview; data base; databse; Datenbank