Configure Views
A view is what an operator actually looks at: a table of records showing a chosen set of columns. Views are layered, so a summary at level 1 drills down into detail at level 2, and the columns marked as keys are what tie a record at one level to its records at the next.
Before you begin
- The columns and mappings are settled. See Map events to columns. A view can only select from the columns that exist.
What Engage fills in for you
When you configure a new integration, Engage fills in the views before you open the drawer. It asks for the views recommended for the events you mapped and creates one view per mapped event, each with that event's columns. If it has no recommendation for an event, Engage builds the same grouping from the mapping itself. With no event mapping at all, it falls back to one view named after the integration at level 1 containing every column. Review the result: the recommendation is a starting point, and you can rename, reorder, or remove anything. An integration that is already configured keeps its views.
Open the views drawer
- In the Configure Views section, select Configure Views.
The drawer is titled with the integration name followed by Report View. Views appear as tabs across the top, and the active tab's settings fill the drawer.
Set up a view
For each view:
- Enter a View Name. Names must be unique across the integration's views.
- Leave Select View Level as it is. Levels are assigned from the tab order, first tab at level 1, and the field cannot be edited.
- Optionally enter a Description.
- In the Integration View table on the right, mark at least one column as Key. The key columns are what Engage compares when it groups lower-level records under a higher-level one, so every view needs a different combination. The info icon beside Key explains that every incoming record must always have a value in the key column, because Engage groups and identifies rows by it.
- Change a row's column with its Record Name select, remove it with the delete control, or drag rows to reorder them. The order here is the column order in the view.
- To add columns, select Add Column below the table and pick from Select columns to add. Only columns not yet in the view are offered.
The panel on the left, titled with the integration name and Report, lists every column the integration has, for reference.
Add or remove a view
- Select the + on the tab bar to add a view. It is greyed out at four views.
- To remove a view, select its tab, then the delete control beside its name. Engage asks Delete View; select Delete. The first view cannot be removed. Remaining views are renumbered so levels stay consecutive.
Save
Save in the drawer footer stays disabled until every view has a key column. Hover over it and the tooltip names the views that still need one, reading Select a key column for: followed by the view names. The integration's own Save or Update in the Add an integration or Edit Integration drawer is disabled the same way, with the tooltip Select a key column in Configure Views for: and the view names.
Select Save in the drawer footer. Engage checks the views in order and stops at the first problem, switching to the offending tab. Then select the integration's own Save or Update; see Configure an integration.
Designing views
- One view per event type is a reliable starting shape: the scheduler run at level 1, the batches it produced at level 2, the messages in each batch at level 3.
- Show only the columns an operator needs at that level. A view with every column selected is hard to read and adds nothing a lower level does not show better.
- Choose key columns that genuinely identify a record at that level, and that a lower level's records carry too. A batch identifier is a good key for a batch view and a bad one for a message view, where each message needs its own.
How you know it worked
N Views defined in the form matches the number of tabs you saved. After the integration is saved, the application's View selector offers each view by name alongside Default View.
When it does not work
| Symptom | Cause | What to do |
|---|---|---|
| Missing view names | A view has an empty View Name | Enter a name on the tab the drawer switched to |
| Duplicate view names | Two views share a name, ignoring case | Rename one of them |
| Need at least 1 column | A view has no columns | Select Add Column and add at least one |
| Save is disabled with Select a key column for: | A view has no column marked Key. The auto-filled views may need a key chosen. | Mark at least one Key in each view the tooltip names |
| Missing reference column | A view has no column marked Key when the drawer's checks run | Mark at least one Key in that view |
| Duplicate reference combinations | Two views have the same set of key columns | Change the keys so each view's combination is distinct |
| The + on the tab bar is greyed out | Four views already exist | Remove a view before adding another |