Documentation Home
Basics Admin Page

Admin Pages

This guide will teach you about the basic make-up of an Admin Page

Overview

The Admin Item/Entity Pages are where an admin user can edit and view all the information about any one particular item/entity. The content, and style, of each Admin Page is dependent on what item/entity is being displayed, the current admin user’s Admin Roles and Permissions, and whatever custom development has been been for the application. This guide will show some basic out-of-box features relating to Admin Item/Entity Pages (Admin Pages).

Anatomy of an Admin Page

Breadcrumb/Navigation Bar

The navigation bar displays the admin user’s current path/location within the application.

Preview Button

This button will allow an Admin User to preview the changes made to the item on the site.

Note

The item must be "previewable" and there must exist saved changes in order to preview the item on site.

Save Button

Save the changes made to the current item/entity.

Note

All Required fields must be filled out to be able to save.

Dropdown Options

This button is a dropdown for other user actions such as Delete.

Tabs

The Tabs are were all related Field Groups reside. While the available tabs will differ depending on item being viewed, most pages will contain the following three tabs (in order of likelihood)

  • General

  • Audit

  • Advanced

The General tab will always be displayed by default and will always have a default "general" Field Group.

The Audit tab will generally contain information of when they item was created, last updated, and by whom.

The Advanced tab is a generic tab that contains different Field Groups depending on the item.

Field Groups

Field Groups are where concept related Fields are grouped together to be contained and displayed with a Tab. Some Field Groups can have toggled visibility while others will always remain visible. Some Field Groups may also have a label on them while others may not.

The default General Field Group is displayed on every Tab as a static Field Group without a label.

Fields

A Field is where users view and edit the data that comprises the item being viewed. The look, style, and values a Field can store varies depending the how the Admin Application is customized.

Here are some common styles of Fields

Required Field that can Lookup its value

field required

40

Indicates that the field is Required

40

Indicates that the value is a lookup reference to another item

Field with ToolTip

field toolTip

40

Indicates the field has a tooltip that can be used to see more information about a particular field

Field with Help Text

field help text

40

This is called Field "Help Text". It displays more information about the field

Field that has Translations

field translations

40

Indicates that the value can be multiple translations that can be seen on the site. In the example, this could mean that the value "$50 Gift Card" can have a spanish translation of "Tarjeta de Regalos de $50 ". Clicking the icon will bring up a screen that allows the admin user to edit, create, and view the different translation for the value.

Collection Field

field collection

40

Count of all field records

40

Collection Field actions. This is were actions such as Add, Edit, Delete, Filter, etc. live.

40

A Collection record

40

If the collection can be sorted, then the sort icon will appear once the Admin User hovers over the record. To move the order of the record, click the sort icon and then drag-and-drop the record in the desired position

Rule Builder Field

The following is an example Rule/Criteria that says

"Match 1 item whose order sub-total is 12 and has a blank Locale tied to it."

field RuleBuilder

40

How many items must qualify to satisfy the criteria

40

Select if item(s) must match ALL or just ANY rules to satisfy the criteria

40

Add another rule

40

Attribute/Field on which rule is based on

40

The "comparator" or "operator" method to apply on the rule field/attribute

40

The "value" that the rule compares against

40

Remove the current rule