Docs
  • Getting Started
  • Overview
    • Understanding
      • User-Interface
      • Shortcuts
    • Getting Started
      • Creating A New Application
      • Adding Basic Structure using Class Designer
      • Creating a link to the TIVITY File Class
      • Setting Rights
      • Creating Queries
      • Building The Layout
        • Creating an App Page
        • Creating an Object Page
        • Creating a List Item Layout
  • Building an Application
    • Application Setup
      • General
      • Documentation
      • License Management
      • Publishing the Application
      • Advanced Settings
        • Document-MailEditor
    • Data
      • Sources
      • Data Modelling
        • Class
        • Field
        • Action
        • Link
      • Query Data
        • Get Started with Query Designer
        • Common
        • Fields
        • Conditions
        • Default Values
        • Preview
      • Roles & Permissions
        • Rights Designer
      • Access Control Lists (ACL)
    • Views
      • Design UI
        • Page Types
        • Fields and Links
        • Layout Controls
          • Actions
          • Panels
          • Sections
          • Lists
          • Input
        • Layout Templates
      • Document Templates
        • Get started with Template Designer
        • Expressions in Templates
    • Execution
      • Functions
      • Workflows
        • Control Types
      • Trigger
      • Scripting
        • Accessing the Script Designer
        • Using the Script Designer
        • Commonly used Actions
        • Reference: Actions
          • Math
          • System
          • Date
          • Collection
          • LogicalOperators
          • Web
          • Structure
          • Constants
          • Converters
          • Commands
          • Text
          • PDF
          • Operators
          • PowerPoint
          • QR-/Barcode
          • Messaging
          • Cells
          • Xml
          • Admin
          • Integrations
    • Expressions
      • Expressions in Expressions
      • Expressions in Condition Values
  • Administration
    • Platform
    • Workspace
    • Security
    • Platform Setup
  • Extensibility and Integration
    • REST API
    • Source Adapter
      • Getting Started
      • Source Adapter Interface
      • RESTful Adapter Service
  • Adapter Portfolio
    • MongoDB Adapter
  • Platform Features
    • Enterprise Search
      • Integration into an App
      • General Settings
    • Templates
    • Tagging
      • Getting Started
      • Manage Tags
      • Settings
      • Usage
        • Tag filter
        • Tag panel
    • DMS Setup
Powered by GitBook
On this page
  • Overview
  • App Page
  • Name
  • Description
  • Page Size
  • Object Page
  • Name
  • Description
  • Page Size
  • Layout for Class
  • Object Section
  • Object Links Page
  • List-Result Page
  • Name
  • Description
  • Page Size
  • Layout Config
  • List Item Layout
  • Name
  • Description
  • Page Size
  • Layout for Class
  • Dashboard Widget
  • Name
  • Description
  • Widget Size
  • App Dashboard
  • Name
  • Description
  • Base Layout

Was this helpful?

  1. Building an Application
  2. Views
  3. Design UI

Page Types

The Layout Designer provides support for different page types that are designed to cater for different needs that your application may have. This section explores each page type individually.

PreviousDesign UINextFields and Links

Last updated 11 months ago

Was this helpful?

Overview

The first step to creating your new layout is selecting your Page Type. The platform supports several page types each catering for different types of user interfaces.

Page Types

After selecting your page type, the page settings can be configured by selecting Page Settings option in the action toolbar (located at the top of the layout designer).

App Page

The app page is a page is one that is not bound to any objects or object context. It is mostly used to display general information and other content related to your application.

The first app page created is used as the default landing page of your application.

Name

The name property is used to define a unique name for the page.

Description

The description field can be used to describe the purposes of your page for the users.

Page Size

The size determines the dimensions of the page to be displayed.

Supported values for Page Size: Very Small, Small, Regular, Very Large, Extra Wide and Full Width

Object Page

The object page displays information retrieved for a specific object instance. Hence, it must be bound to a particular object in order to be used.

Special information related only to a particular object can be displayed using this page.

Name

The name property for an object page is used to define a unique name for the page.

Description

The description field can be used to describe the purposes of your object page to the users.

Page Size

The size determines the dimensions of the page to be displayed.

Supported values for Page Size: Very Small, Small, Regular, Very Large, Extra Wide and Full Width

Layout for Class

The object page needs to be created for use within the context of a particular class. This field allows you to set which class should be associated to your page.

Object Section

The Object Section page type acts as a custom component bound to a class. This can be used to embed your component within other class-bound page layouts by using the Object Section control.

Object Links Page

The Object Links Page is a special page that displays all the links and linked instances for the current object instance. This page can be opened by the user if it is placed within an Instance Links Panel on your layout.

List-Result Page

The list-result page is a unique page used when creating layouts to display lists of items, such as search results. The page can be used with

  • Classes - to display a list of objects of the same class

  • Queries - to display results from a query

Regardless of where the query is called in your application, the associated list-result page is always used to display the results.

List-Result Pages can be displayed as the result of an action in the layout as well.

Name

The name property for a list-result page is used to define a unique name for the page.

Description

The description field can be used to describe the purposes of your list-result page to the users.

Page Size

The size determines the dimensions of the page to be displayed.

Supported values for Page Size: Very Small, Small, Regular, Very Large, Extra Wide and Full Width

Layout Config

The layout config allows you to determine for which classes/queries should this list-result page be used.

  • Use for classes: Select the classes that will use this page

  • Use for selections: Select the queries that will use this page

  • Use for links: Select which class links will use this page

List Item Layout

The list item layout page can be used to define how an individual item (for instance from a set of search results) should appear in Represents List, Timelines or Kanban Cards.

List Item Layout is prioritized and will always be used to display your items when used, overriding alternate display layouts such as HTML layouts.

Name

The name property for a list item layout is used to define a unique name for the page.

Description

The description field can be used to describe the purposes of your list item layout to the users.

Page Size

The size determines the dimensions of the page to be displayed.

Supported values for Page Size: Very Small, Small, Regular, Very Large, Extra Wide and Full Width

Layout for Class

The list item layout needs to be created for use within the context of a particular class. This field allows you to set which class should be associated to your page.

Dashboard Widget

The dashboard widget is a small layout element which can users can pin on their dashboards.

Name

The name property for a dashboard widget is used to define a unique name for the page.

Description

The description field can be used to describe the purposes of your dashboard widget to the users.

Widget Size

You can determine the size of your widget for dashboards.

  • Widget Size-X: Size of widget horizontally (x-axis)

  • Widget Size-Y: Size of widget vertically (y-axis)

Widget size values (both horizontally and vertically) vary between 1 to 4, where 4 takes the most space possible for a widget on the dashboard.

App Dashboard

Instead of creating a single widget layout using the dashboard widget page type, a complete dashboard can be defined using app dashboard.

When adding new dashboard tabs, an end user can select your app dashboard page to add a full pre-configured dashboard layout to their tabs.

Name

The name property for an app dashboard is used to define a unique name for the page.

Description

The description field can be used to describe the purposes of your app dashboard to the users.

Base Layout

The Base Layout is a special layout that is used for instances where no custom object page layout has been defined yet.

When no base layouts are specified, the platform will generate one for you. Alternately, if a base layout has been created, the platform will use it as the fallback item.

App Page
Object Page
Object Section
Object Links Page
List-Result Page
List Item Layout
Dashboard Widget
App Dashboard
Base Layout
Accessing Page Properties
App Page Configuration
Object Page Configuration
List-Result Page Configuration
List Item Layout Configuration
Dashboard Widget Configurations
App Dashboard Configuration