A document view defines the columns and labels that the storefront shows for a document type. Open Document Views from the side menu to see the list of views.
List screen
The list has a CREATE button, a Delete button, and a table with one row per document view. Each row has a checkbox, and a Select all checkbox sits in the table header. A counter shows how many items are selected, next to an Unselect button. A Rows per page selector and pagination sit below the table.
Column | What it shows | Sorting |
Name | Shows the document view's display name. | Sortable from the column heading. |
Model key | Shows the data model's key identifier. | Sortable from the column heading. |
Model class | Shows the data model's fully-qualified class name. | Sortable from the column heading. |
View key | Shows the view key, which names the live ERP function the view presents. | Sortable from the column heading. |
Source | Shows whether the view is a synced default or an admin override. | Sortable from the column heading. |
Columns | Shows the number of columns configured in the view. | The heading has no sort control. |
List controls
Control | What it does |
CREATE | Opens the create form. |
Delete | Removes the document views whose row checkboxes are selected. |
Create form
Selecting CREATE on the list opens the create form. An alert on the form reads "Save document view first to configure columns". The columns section appears on the record only after the document view is saved for the first time. On the empty form Save is unavailable, and it becomes available after field values change.
Field | What it holds | Required |
Name | A text field with the helper text "This is what an implementer sees in Site Builder". Site Builder shows the name just as you typed it and never substitutes another. | Required. |
View key | A selector with the helper text "The live ERP function this view presents. Leave empty for a model-backed view". | Not marked as required. |
Model Resource | A selector. It picks the data model the view is built on. | Not marked as required. |
Model key | A text field. It holds a unique identifier for the model. | Not marked as required. |
Model class | A text field that is disabled. It is filled in from the chosen data model. | Not marked as required. |
Record screen
The record screen has Back, Delete, Cancel and Save controls. Save is unavailable until field values change. It repeats the fields of the create form and adds Source.
Field | What it holds |
Source | A disabled text field with the helper text "Whether this view is a synced default or an admin override". |
Columns table
The record screen has a Columns section with an ADD COLUMNS button and a table of the view's columns. Each row ends with a row actions button. The table has its own Rows per page selector and pagination.
Column | What it holds |
Field | Holds the column's field name from the data model. |
Label | Holds the display label for the column. |
Type | Holds the column's data type. |
Width | Holds the column's width in pixels. |
Show column by default | Marks whether the column appears by default in the list view. |
Notes
A view targets either a live ERP function, through its view key, or a data model.
Only active ERP document functions are offered as view keys. If the one you need is missing, it has to be added in ERP Manager and pushed to the shop, because you can't enter it here.
A view key can belong to only one view, and a duplicate is rejected with a validation message.
For a view with a view key, the visible columns and labels you save replace the storefront's default columns for that document after a refresh. If you hide every column, or the view has none, the storefront keeps showing its default columns.
Related