Profile

SnapApp Fundamentals: Fields

on 02-20-2024 11:26 PM by Catherine Boxler

1037

Fields: The Fundamentals

Explore and manage your objects as described in the following sections:

What is a field

A field represents a column within your dataset. They are attributes that describe the records. Common examples are name, address, date, and id. Each field has a name, data type, and may have other additional properties.

After adding an object, you can create a field and configure its properties to define its role and functions.

Create a field

To create a field:

  1. Open settings from the User menu.
  2. Select Fields from the Data menu.
  3. Click + Add New from the top header to create a field...

To create a field from an object:

  1. Open settings from the User menu.
  2. Open settings from the User menu.
  3. Select Objects form the Data menu.
  4. Select object from the list
  5. Click +Add New Field at the header of the Fields section
Screenshot 2024-02-16 at 7.33.18 AM.png

Add multiple fields

You can repeat the steps described in Add a table to add multiple tables.

If you're migrating from an existing database or other structured data source that stores data in a rows and columns, a faster way to create objects it to use the Data Migration utility.

Configure basic properties of a field

The basic properties of a field describe the field and are the details of how the field is identified. These properties are configured upon creation of the field. 

Assign the field a data type:

The field's data type defines the function of the field in your app
Below is a list of data types you can use. To set the data type, click on the Data Type dropdown and select from the list.

  • Type Description
    Text A text string
    LongText A text field designed to hold large blocks of text. SnapApp stores up to _______ characters in a long text field. This data type is useful for storing notes, comments, and long descriptions. 
    Date Stores date information without time. The Date format in SnapApp is YYYY-MM-DD.
    DateTime Stores date and time information in the format YYYY-MM-DD 00:00:00.
    Time Only the time is captured in the format 00:00:00.
    Number A data type used for storing numeric information such as integers, floating-points, and doubles.
    Price Used to represent the monetary value of an item, service, etc. These values are displayed with the currency symbol.
    Percent Percentages are displayed with the % symbol and are stored with either an integer or floating-point format.
  • Content Types:
    Type Description
    File Any file content that is saved on a computer or in a browser. This can be in the form of a PDF or document. The file is saved to the cloud or desired platform and made accessible through the app.
    Image Saved as URLs of the source. These images are accesible through the app and are .jpg, .png, and .gif types.
    Video
    DocAI
    Drawing When selected this data type allows the user to access a drawing pad and annotate on screen.
  • Enumerated types:
    Type Description
    Enum Allows users to select a value from a list of specified values. The typical application of this data type is a dropdown menu on a form.
    EnumList EnumList is the same functionality as an enum, but allows the user to select multiple values from the list. 
    EnumVisualList This data type allows the user to select one or multiple images from a list of images.
    YesNo A boolean data type that allows users to select from a binary menu.
    Color
  • Communication types:
    Type Description
    Email Used to store the email addresses of users. The typical email format is required containing an ampri
    Phone The plural version of the label (e.g. Products). Plural labels are used when referencing a collection of records in an object or the object qas a whole.
    Address The name used to store the object in the underlying database. This is not visible anywhere in the application and can not be changed once set.
    LatLong This is set to 'id' by default and can be changed once you add fields. The record label field is used to identify a record through out the application. This field will be treated as the primary field on list views and displayed when a records is referenced on other objects. For example, if you set the record label field to product number, the product number would display instead of a big id throughout the application. This makes your records more recognizable and easier to use.
  • Define the label:

    1. This is the name of the field that is visible to the user

    Input a column name:

  • Each field has a name. This is the name used by the application to identify the field. In most cases this should match the column name in the underlying data structure.
  • A field name should rarely be changed. Editing the field name later in the development process could lead to cascading errors within other areas of the application. If changing a field name is necessary, it is important to ensure all formulas and references to the field name are updated appropriately. 

    To assign a description: 

    Type the desired information into the description field. This is an optional value used to describe the field to system administrators. The description will be displayed only in the field details for system admins. 

    Configure display properties of a field

    The display and edit properties determine the behavior of the field. Utilize these properties to customize your field. These properties can be configured upon creation of the field or edited later on.

    Assign a placeholder:

    This is a value for the user that explains the expected format of the data entered, either a sample value or a description of what is expected.

    Enter an initial value:

    The initial value is the default that is automatically set when a record is created. 
    Users have the option to override the initial value unlike a formula.
    Type the desired text or numeric initial value into the Initial Value field, or open the Expression Builder from the field to enter an expression.

    Help text:

    Help text assists in directing the application user. It is the information offered to describe the purpose of the field and is displayed on the screen when the user hovers over it.

    Define a formula:

    The formula will auto-update the value of this field when the row is modified. Unlike the initial value, users cannot manually edit the value in this field.
    Type the formula directly in the field or open the Expression Builder to enter an expression.
    Check the Apply Formula To Existing Records box to immediately apply this formula to all existing records.

    Set the show settings:

    Use show and show if to specify the audience and conditions under which the field should be displayed.
    By default, the Show option is enabled, meaning that the field will be visible to all viewers wherever it appears. Disabling this option hides the field throughout the application for all users. To hide the field, uncheck the "Show" checkbox.
    If you want the field to be visible to only certain users or in specific contexts enter a Yes/No expression into the Show If field. 

    Check validity on field entries:

    The "Valid If" is a condition expression the determines whether the user input for the field is acceptable. If the data does not meet the constraint, it may not be saved, or if filling out a form, the user may not be able to proceed.
    The "Invalid Error" field is the message that is displayed to the user when the Valid If constraint is not met.

    Set the field width:

    Enter the sequence:

    Configure the edit properties of a field

    Set the validation properties:

    Check the "Require" checkbox to require user input for this field. Required fields must be completed or selected by users. The field will be marked with an asterisk and will see an error message if they attempt to proceed without entering the necessary information. If filling out a form, the user will not be able to submit if the field is not filled out.
    Mark editable
    Editable If

    Make the field required:

    View details of a field:

    To view the details of a field:

    1. Open settings from the User menu.
    2. Select fields from the Data menu.
    3. Click the name of the field you want to view.
    4. Click through the properties tabs to view the configurations.

    Edit a field:

    To edit a field:

    1. Open settings from the User menu.
    2. Select fields from the Data menu.
    3. Find the field in the list you want to edit.
    4. Click the pencil icon on the right. To see the edit button, you must have edit options on the field in one of the permission sets assigned to your user role.

    Delete a field:

    To delete a field:

    1. Open settings from the User menu.
    2. Select fields from the Data menu.
    3. Click the Delete action on the field you want to delete.

    Generate Text