Field Configuration

The field settings in TechMaju are used to define the structure, behavior, and appearance of individual fields within a document. Below is an explanation of each setting available when configuring fields in a DocType.

Out of the Box Field Behavior:

  • If a field is set to 'Read Only', when the field is empty on the form, then the field will be hidden.

  • If a field is set to 'Mandatory' and 'Read Only', then when the form is first created, it will be 'Mandatory'; but, after the form is saved for the first time, it will be 'Read Only'.

  • If a field is set to 'Set Only Once', after a value is entered in the field and the form is saved, then the field will be 'Read Only'.

General Field Settings

Field

Description

Label

The name of the field as it will appear in the form.

Type

The type of the field (e.g., Datetime, Attach, Barcode, etc.).

Name

The internal name of the field.

Options

Additional options specific to the field type.

Mandatory

Whether the field is required to be filled.

Virtual

Indicates if the field is virtual (used for calculations or display only, not stored in the database).

Index

If checked, an index is created on this field in the database for faster searching.

Field Types

More about Field Types →

Field Type

Description

Autocomplete

Provides autocomplete functionality for a text field.

Attach

Allows attaching files to the document.

Attach Image

Allows attaching image files to the document.

Barcode

Displays a barcode field.

Button

Renders a clickable button.

Check

Provides a checkbox input.

Code

A field for entering code, with syntax highlighting.

Color

A field for selecting colors.

Column Break

Used to create a column break in the form layout.

Currency

Allows entering currency values.

Data

A generic data field for text input.

Date

Provides a date picker for selecting dates.

Datetime

Allows entering both date and time.

Duration

Allows entering a duration.

Dynamic Link

Allows linking to a dynamically selected document type.

Float

Allows entering floating-point numbers.

Fold

Used to create collapsible sections in the form layout.

Geolocation

Allows capturing geolocation coordinates.

Heading

Used to create a heading in the form layout.

HTML

Allows entering HTML content.

HTML Editor

A WYSIWYG editor for HTML content.

Icon

Allows selecting an icon.

Image

Displays an image field.

Int

Allows entering integer numbers.

JSON

A field for entering JSON data.

Link

Allows linking to another document.

Long Text

Allows entering long text content.

Markdown Editor

A markdown editor for formatted text.

Password

Provides a password input field.

Percent

Allows entering percentage values.

Phone

A field for entering phone numbers.

Read Only

Displays a read-only field.

Rating

Allows providing a rating input.

Section Break

Used to create a section break in the form layout.

Select

Provides a dropdown select field.

Signature

Allows capturing a signature.

Small Text

Allows entering small text content.

Tab Break

Used to create a tab break in the form layout.

Table

Displays a table field for child documents.

Table MultiSelect

Allows selecting multiple rows from a child table.

Text

A simple text input field.

Text Editor

A rich text editor for formatted content.

Time

Allows entering a time.

Defaults

Field

Description

Default

The default value for the field.

Fetch From

Another DocType from which to fetch the value of this field.

Fetch on Save if Empty

If checked, the value will be fetched from the source DocType only if it is empty on save.

Visibility

Field

Description

Hidden

Hides the field from the form view.

Bold

Displays the field value in bold.

Allow in Quick Entry

Allows this field to be included in the quick entry dialog.

Print Hide

Hides the field from print formats.

Report Hide

Hides the field from report views.

Display Depends On (JS)

A JavaScript condition that determines when this field is displayed.

List / Search Settings

Field

Description

In List View

If checked, the field will be shown in list views.

In List Filter

If checked, the field can be used in list view filters.

In Preview

If checked, the field will be shown in preview popups.

In Filter

If checked, the field will be available as a filter option in the list view.

Permissions

Field

Description

Read Only

Makes the field read-only.

Ignore User Permissions

If checked, user permissions for this field will be ignored.

Perm Level

The permission level required to access this field.

Ignore XSS Filter

If checked, disables the XSS filter for this field (use with caution).

Constraints

Field

Description

Unique

Ensures that the value of the field is unique across all records.

No Copy

Prevents the field from being copied when duplicating a record.

Set only once

Allows the field to be set only once and not changed thereafter.

Display Depends On (JS)

A JavaScript condition that determines when this field is mandatory.


Example:

exec: doc.status == "Pending";

Mandatory Depends On (JS)

A JavaScript condition that determines when this field is mandatory.

Read Only Depends On (JS)

A JavaScript condition that determines when this field is read-only.

Best Practice: Avoid complex logic for the Javascript Depends On fields - instead use UI Policies.

Display

Field

Description

Print Width

The width of the field in print formats.

Width

The width of the field in the form.

Max Height

The maximum height of the field in the form.

Columns

Number of columns to span for this field in the layout.

Description

A description of the field for users.

Documentation URL

A URL for documentation or help related to this field.


Discard
Save

On this page

Review Changes ← Back to Content
Message Status Space Raised By Last update on