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
  • Add a Field
  • Edit a Field
  • Edit a Linked Class
  • Aggregate
  • Inline
  • Delete a Field

Was this helpful?

  1. Building an Application
  2. Data
  3. Query Data

Fields

Query Designer is divided into several sections - Common, Fields, Conditions, Default Values and Preview. This article provides detailed information about the Fields section.

PreviousCommonNextConditions

Last updated 2 years ago

Was this helpful?

Overview

In the Fields section you can define and manage the information that you want to see as result of a query. This section is divided into two areas - List of selected fields and collections of fields to add.

On the left-hand side is a list of selected fields from your Source and Query Context. Each entry is identified by its original Field name. You can define the Position - top to bottom means left to right in the result -, give the entry a Title and specify the Order about how the matching records should be sorted in the result. The column Actions offers you to edit, to delete and to position each entry in the list.

The right-hand side offers you collections of fields based on the Main Query Class definition selected by the Source and optionally based on the Linked Class definition selected by the Query Context in the Common attributes of the query. Lastly, the Virtual Fields section gives you access to the Script Configuration and any kind of constructed information you would need in the query result.

Add a Field

To create the result of your query you need to add at least one field to the list of fields. Whether you choose a field of the Main Query Class, select a field of the Linked Class, or create a Virtual Field is equivalent. To add a field to your list of fields open the Class drop-down on the right-hand side. You can either tick the All checkbox at the top to choose all available fields in the Class or select multiple entities of the Class by setting a tick in front of the list element. Finally, click on Add fields to add them to the list of fields on the left-hand side.

Edit a Field

On the Query Field Properties view you can enter and modify values for the field Alias (Title), Name (for translations in English and German language), choose the sorting order of records, and define where records with NULL (undefined) value should be located in the result.

A query contains of at least one Field entry. This is compulsory to verify and validate the query.

Edit a Linked Class

The section Place provides you with a drop-down to define the functionality of the Field Group. You can choose one of the following features:

  • Aggregate

  • Inline

Each functionality has additional, individual configuration options.

Aggregate

A selection of most commonly used aggregate functions are available. Following options in the Aggregation drop-down are available.

  • Sum

  • Count

  • Average

  • Min

  • Max

You can choose one option.

Commonly an aggregation would be used to retrieve an information based on a numeric value, e.g. age of person, number of days, products in stock, etc.

Inline

The Inline functionality offers you to display the record values of one or multiple fields of a Linked Class. Those records of a field are separated by semicolon.

Several fields of a Linked Class are shown separated by comma within the record while multiple records are separated by semicolon.

Delete a Field

Repeat this process until all requested fields have been added to the query. You can choose fields from the Main Query Class, the Linked Class or any Virtual Fields alike. More information on Virtual Fields is described in the article.

Under Actions of each field you have the ability to Edit , Delete , and Position the selected row.

Click on the Edit icon to open a details view of the properties of the field.

Despite same appearance of Actions of a Linked Class record in the list of fields a click on the Edit icon opens the Field Group Properties view. Here you can define advanced features like aggregation or inline display of information of the field group.

To remove a row from the list of fields click on the Delete icon in the column Actions. Repeat to remove more than one row from the list.

Scripting
Definition of Fields in a query
Adding a collection of fields from the Source
Adding individual fields from Source and Query Context
Editing Query Field
Review and edit properties of a Context
Available options of an aggregation
Multiple fields of the context are used as inline information in the result