Interfaces
An interface is a screen your administrator has built for a particular job, bringing several views of your data together in one place: for example, a count of documents next to the list of those documents, and buttons that take you to the pages you need. Instead of opening several dataviews one after another, you see everything for that job at once, and one filter narrows all of it. Interfaces are listed with dataviews on the Dataviews tab of Explorer.
What you can do in Interfaces
- Open an interface, in the current tab or a new one, or from a link
- Read its panels, and search the lists in them
- Use the buttons on it to go where you need
- Filter the whole interface, for example by document type
- Refresh it to see the latest data
- Export it as a file you can open in a web browser
Interfaces on the Dataviews tab
Interfaces are listed on the Dataviews tab of Explorer, under named groups, alongside dataviews. A people icon marks an interface. Select a group's name to show or hide what is in it. If an interface you need is not listed, ask your administrator.
The Dataviews tab, with an interface open| Item | Description |
|---|---|
| Search Reports & Interfaces | Finds an interface or dataview by name. |
| Interface name | Opens the interface on the right, replacing what the current tab shows. |
| Open in new tab (arrow icon) | Opens the interface in a new tab, so you can keep the current one open. |
| People icon | Marks an interface. Dataviews have a grid icon. See Dataviews. |
Working in an open interface
An open interface shows its name at the top, with Export on the right (see Exporting an interface). Below are its panels, each with a title. Which panels an interface has depends on how your administrator set it up. The interface in the example above has three kinds:
| Panel | Description |
|---|---|
| Figure | A single number, such as how many documents there are. In the example, Sample documents shows 8. |
| List | Rows of data, such as the documents behind a figure. The Doc Grid features work here as they do elsewhere: type in Search to narrow the rows to those containing that text, and use the column headers to sort and filter. Row Count at the bottom right shows how many rows the list has. |
| Buttons | Links to other pages, such as the help pages for the job. Select a button to open its page. In the example, Open the Docwize help opens the help in a new browser tab, and the interface stays open. |
Select Refresh (the circular arrow) at the top right of a figure or list panel to reload just that panel. To reload the whole interface, select the circular arrow on the interface's tab.
Filters
Filters let you look at one part of the data, for example only policies, without opening a different interface. If an interface has filters, a Filters icon is shown on its left edge. Select it to open the Filters panel, then choose a value in a filter: every panel the filter applies to is narrowed to match.
Choosing a value in the Filters panelWhen you close the panel, the Filters icon shows how many filters are in use. In the example below, the figure and the list both show only the two policies.
An interface filtered to one document typeTo show everything again, open the Filters panel and select the cross next to the value you chose.
Exporting an interface
Export an interface to keep a copy of what it shows, or to share it with someone. Select Export at the top right of the interface. The Export dashboard window opens, with Format set to Interactive HTML.
The Export dashboard windowSelect Export. A message says Exporting interface… while the file is prepared, and your browser downloads it when it is ready. Open the HTML file in a web browser to see the interface's panels and data.
Opening an interface from a link
Someone may send you a link to an interface, for example in an email. Select the link to open the interface in Docwize, without going through Explorer.
How to open an interface
| Step | Description |
|---|---|
| 1 | In Explorer, select the Dataviews tab. |
| 2 | Select the name of the group the interface is in, or type its name in Search Reports & Interfaces. |
| 3 | Select the interface's name to open it in the current tab, or Open in new tab (the arrow on the right) to keep the current tab open. |
How to filter an interface
| Step | Description |
|---|---|
| 1 | Open the interface. |
| 2 | Select the Filters icon on the interface's left edge. The Filters panel opens. |
| 3 | Select a filter, then choose a value. The panels the filter applies to change to match. |
| 4 | Select the round button on the right edge of the Filters panel to close it. |
The video below opens an interface, filters it to one document type, then clears the filter.
Example: Opening an Interface and Filtering It
How to export an interface
| Step | Description |
|---|---|
| 1 | Open the interface. |
| 2 | Select Export at the top right of the interface. Export dashboard opens. |
| 3 | Leave Format as Interactive HTML, and select Export. |
| 4 | Wait for your browser to download the HTML file. |
Related pages
- Explorer: overview of the Explorer module
- Dataviews: ready-made lists, on the same tab
- Virtual Interfaces (config): how administrators build interfaces