Skip to main content

Document Views screen

The Document Views screen lists named column configurations for data models.

N
Written by Niyaz

The Document Views screen lists named column configurations for data models. Open Document Views from the Admin Panel navigation.

Document Views list with configured views and sortable columns.

List screen

Column

What it shows

Name

The document view’s display name.

Model key

The data model’s key identifier.

Model class

The data model’s fully qualified class name.

View key

The live ERP function that the view presents.

Source

Whether the view is a synced default or an admin override.

Columns

The number of columns configured in the view.

List controls

Control

What it does

Select all

Selects all document views on the current page.

Rows per page

Sets the page size used to display results and page through them.

Create form

The create form opens when you select Create on the list screen.

Field

What it is

State

Name

A display name for the document view.

Required.

View key

The live ERP function that the view presents.

Optional; it can be left empty for a model-backed view.

Model Resource

The data model selected from the available models.

Optional.

Model key

A unique identifier for the model.

Optional.

Model class

The data model’s fully qualified class name.

The field is disabled on the create form.

Record screen

Field

What it is

State

Source

Whether the view is a synced default or an admin override.

Read-only.

Rows per page

Sets the page size used to display results.

The default page size is 10.

Columns section

After you save a document view, a Columns section appears on the record screen. The table lists each configured column.

Field

What it is

Field

The column’s field name from the data model.

Label

A display label for the column.

Type

The column’s data type, such as text, date, or number.

Width

The column’s width in pixels.

Show column by default

Indicates whether the column appears by default in the list view.

Control

What it does

ADD COLUMNS

Adds a new column to the view.

SHOW COLUMN BY DEFAULT

Controls whether a column appears without being chosen.

Notes

The create form displays the alert “Save document view first to configure columns.”. The Columns section appears only after you save the document view for the first time.

Related

Did this answer your question?