Introduction

Getting started

Walkthrough Guides

CafeX Apps

Workflows

Using CafeX Collaborate App

Reporting

Managing CafeX

Integrating CafeX

Security

CafeX Apps

Using Table and Form Components

Modified on Thu, 21 Sep 2023 at 06:22 AM

As an App Builder, the Table and Form Components are efficient ways to map data source fields onto interface fields. 


For example, if you have an external API that provides your App with 10 fields you can display them on the interface by setting the Data Path of the Form Component.  You can then use the Component to order, toggle visibility, and rename those fields. Traditional applications, would have to carefully manage the mapping of API field names to Interface Components.  If the underlying API changes, then the Component detects the new fields and you can add them without the need to carefully map API fields onto, or remove them from the interface.


In App Studio, both Table and Form Components automatically interpret Data Sources to give you the fields to manage.


For a full list of Components see: Introducing App Studio.


Using the Form and Table Components


The following example introduces the Form and Tables Components. In this example, the App provides a user with the ability to search for Users, display a list of search results, and allow the user to select a record to find out more information about their selection.


This example requires the following 3 Components:

  • A Form Component—that an App User can use to provides values to submit to a search Data Set.
  • A Table Component—that displays the search result, and an App User can use to select a record to open.
  • A read-only Form Component—to display a Record in more detail.
     

For more information about changing the appearance of a Component see: Altering the appearance of a App Studio Component.


Configuring Table Components

To configure a Table Component:

  1. If necessary, drag-and-drop a new Table Component onto the App Canvas
  2. Select the Table Component,
    • Click the Table Component in the Explorer menu.
      or
    • Click the Table Component in the Canvas.
  3. In the Appearance & Configuration Panel, select Configuration
  4. As you require configure the following:
    ConfigurationDescription
    Show Record IndexAdds an additional column that automatically increment from 1 onwards.
    Read OnlyPrevents users from setting values in the table cells.
    Show headerDisplays the header of each column
    Keep header in viewMaintains the header in view as the user scrolls through the table rows
    Show selection columnAdds an additional column with a checkbox App users use to 
    SelectionSpecifies that App users can select rows of the table.
    Empty messageA message that displays if there no data to display on the table
    Error messageA message what displays if the Data Set, typically an External Data Source, errors.
    Data SetSpecifies the Data Set to present data from when it evaluates.
    Data pathSelect an array of objects from the Data Set output to display on the table
    FiltersYou add filters to select specific records that match the criteria of the filter from the Data path array
    Show field type iconDisplays an appropriate icon in the column header of each row
    Event handlersSee: Adding event handlers


Configuring Form Components

To configure a Form Component:

  1. If necessary, drag-and-drop a new Form Component onto the App Canvas
  2. Select the Form Component,
    • Click the Form Component in the Explorer menu.
      or
    • Click the Form Component in the Canvas.
  3. In the Appearance & Configuration Panel, select Configuration
  4. As you require configure the following:
    ConfigurationDescription
    LayoutSelect a suitable layout for the Form to use to display fields.
    Label positionPlaces the field label relative to the field.
    Read OnlyIf disabled, you provide the App user with input fields to complete or provide inputs on, that they can edit.
    If enabled, you use the form to display the fields and records of a single Data Set record.
    Submit on value changeIf enabled, the Data Set to evaluate every time the App User updates a value.  You use this if you need to capture User inputs without waiting for a form to Submit.
    Primary button textSpecifies the text on the App button
    Show secondary buttonDisplays the secondary button
    Secondary button textSets the text on the secondary action button
    Data SetSpecifies the Data Set to present data from when it evaluates.
    Data pathSelect an array of objects from the Data Set output to display on the table
    Event handlersSee: Adding event handlers

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article