Overview
The Basic Information section identifies a Field, determines the type of data it stores and helps users and App Builders understand its purpose.
These properties are available across Field Types:
Configure them carefully when creating a Field. The Identifier and Type can be difficult or impossible to change later, while a clear Label and Description make the App easier to use and maintain.
For instructions on creating or editing a Field, see Adding and Editing Fields. For a complete reference covering the other configuration options, see Field Parameters.
Label
The Label is the user-facing name of the Field. It should clearly explain what information the Field displays or what the user needs to enter.
Examples include:
- Project Name
- Action Owner
- Date Raised
- What is the Project Scope?
A Label can contain spaces and other display characters.
Although a Label is recommended for most Fields, it can be left blank where a visible heading is not required. For example, an Embedded Report may not need a heading, or an Action Field may use an image that already explains its purpose.
Identifier
The Identifier is the unique system reference for the Field. It is used when the Field is referenced in:
- Expressions
- Workflows
- Reports
- Templates
- Imports and exports
- APIs and integrations
When creating a Field, Softools suggests an Identifier based on its Label by removing spaces and unsupported characters. You can change the suggested Identifier before saving the Field.
For example:
| Label | Suggested Identifier |
|---|---|
| Project Name | ProjectName |
| Action Owner | ActionOwner |
| Date Raised | DateRaised |
| What is the Project Scope? | ProjectScope |
An Identifier:
- Must be unique within the App
- Must start with a letter
- Must contain only letters and numbers
- Must contain at least three characters
Important: A Field Identifier cannot be changed after the Field has been created. Check it carefully before saving the Field.
Choose an Identifier that is clear, concise and likely to remain appropriate throughout the life of the App.
Type
The Type determines what kind of data the Field stores, how users interact with it and which additional configuration options are available.
Examples include Text, Number, Date, Selection, Person and Document.
Most Field Types cannot be changed after the Field has been created. Changes are only supported between certain compatible Types. Existing data is retained when changing between compatible Types, but the change may affect how the Field is displayed or used.
See Field Types for help choosing the appropriate Type. The supported Type changes are listed in Adding and Editing Fields.
Description
The Description provides additional guidance about the purpose and use of the Field.
A useful Description might explain:
- What information the user should enter
- Where the information can be found
- Why it is required
- Which format or convention should be followed
- How the value is populated or calculated
- How the Field is used elsewhere in the App
Workspace users can access the Description by hovering over the Field Label and selecting the information icon. App Builders may also see the Field Identifier, Field Type and relevant App Studio navigation options in the same panel.
Descriptions are particularly useful where the Label alone cannot provide enough guidance. They also help other App Builders understand and maintain the App.
Comments
0 comments
Please sign in to leave a comment.