DocType Settings

The DocType settings in TechMaju are used to configure the behavior, appearance, and interaction of documents within the system. Below is an explanation of each setting available in the DocType configuration.

General Settings

These are Core settings, thus, may not be recommended to modify after creation of the DocType as it has a high potential for creating errors in your system.
Instead, it is recommended to create a new DocType if a replacement is necessary with different configurations.

Setting Name	Description
Is Submittable	Once submitted, submittable documents cannot be changed. They can only be Cancelled and Amended. The out-of-box functionality manages the document states, but it may be restrictive in certain cases so be aware of your use case as toggling this setting is not recommended after creation.
Is Child Table	Child Tables are shown as a Grid in other DocTypes. This is recommended for 1 to many relationships between parent and children DocTypes.
Is Single	Single Types have only one record with no tables associated. Values are stored in `tabSingles`. This can be used for configuration settings and other cases where only a single record is needed.
Is Tree	Tree structures are implemented using Nested Set.
Is Calendar and Gantt	Enables Calendar and Gantt views for the DocType.
Quick Entry	Opens a dialog with mandatory fields to create a new record quickly.
Track Changes	If enabled, changes to the document are tracked and shown in the timeline.
Track Seen	If enabled, the document is marked as seen the first time a user opens it.
Track Views	If enabled, document views are tracked; this can happen multiple times.
Is Virtual	This setting makes the DocType a virtual one, meaning it doesn't exist as a table in the database.

Naming Settings

Allow Rename checkbox enables Users to change if they have the necessary Roles. However, it is recommended to default this as false to avoid user errors especially if the DocType is linked with other DocTypes.

Setting Name	Description
Naming Rule	Defines how names of the documents are generated. Default is a random 10 character hash.
Auto Name	The format or pattern for automatic naming.
Allow Rename	Allows users to rename the document.
Description	Provides additional information about the naming settings.
Documentation Link	URL for documentation or help.

Naming Options

With Frappe framework, the field 'name' is a reserved field with label 'ID'. This field determines the unique identifier of the DocType record.
The default a random 10 alphanumeric character hash. Hash collisions for the provided combinations become apparent after 2 million records, so depending on your use case, use a custom field name option.

Option	Description
Random (default)	A random 10 alphanumeric character hash is generated as the Name value.
Set by user	User will be prompted to enter in a Name for this DocType
Autoincrement	Uses Database's Auto Increment feature WARNING: After using this option, any other naming option will not be accessible.
By Fieldname field:[fieldname]	Name is set relative to another Field value. Ensure this field exists prior to setting the value.
By Naming Series field	Field called `naming_series` must be present with a format that matches Expression naming conventions
Expression	Format: `format:EXAMPLE-{MM}morewords{fieldname1}-{fieldname2}-{#####}` - Replace all braced words (fieldnames, date words (DD, MM, YY), series) with their value. Outside braces, any characters can be used.
By Script	[Not supported in TechMaju platform]

Form Settings

Setting Name	Description
Image Field	Field that is of type "Attach Image".
Timeline Field	Field where comments and communications will be associated.
Max Attachments	The maximum number of attachments allowed.
Hide Sidebar, Menu, and Comments	Hides these elements in the form view.
Hide Copy	Prevents copying the document.
Allow Import (via Data Import Tool)	Allows the document to be imported using the Data Import Tool.
Allow events in timeline	Allows events to be shown in the timeline.
Allow Auto Repeat	Enables automatic repeating of the document.
Make Attachments Public by Default	Attachments are public by default when added.

View Settings

Recommended: use Title field values to display more user-friendly values on forms and lists. This enables the Name field to be more system-friendly with values that are unique and avoid any duplicate conflicts.

Setting Name	Description
Title Field	Field to use as the title of the document. This will provide a more readable display name instead of the name value.
Show Title in Link Fields	Displays the title in link fields.
Translate Link Fields	Translates the link fields.
Search Fields	Fields that will be used for searching the document.
Default Print Format	The print format to use by default.
Default Sort Field	Field to sort by default.
Default Sort Order	Order to sort by default: ASC DESC
Default View	Default view mode: List Report Dashboard Kanban
Force Re-route to Default View	Forces a re-route to the default view.
Show in Module Section	Module section to show the DocType: Document Setup System Other
Icon	Icon to use for the DocType.
Color	Color to use for the DocType.
Show Preview Popup	Displays a preview popup for the document.
Make "name" searchable in Global Search	Allows the `name` field to be searchable in the global search.

Email Settings

Setting Name	Description
Default Email Template	Default email template to use.
Allow document creation via Email	Allows the creation of documents via email.

Linked Documents

Linked DocTypes will display as Connections on the Form view.

Field Name	Description
Link DocType	Links to other DocTypes.
Link Fieldname	Name of the field that links to the DocType.
Table Fieldname	Name of the field in the table that links to the DocType.
Group	Group for the linked document.
Hidden	Hides the linked document.
Is Child Table	Specifies if the linked document is a child table.

Document States

State value and color will display as pills on Form view titles and also in List view if the column is displayed.

Field Name	Description
Title	Title of the document state.
Color	Color associated with the document state.

Web View

Setting Name	Description
Has Web View	Indicates if the DocType has a web view.
Index Web Pages for Search	Indexes web pages for search.
Route	The URL route for the web view.

Procedure

Configuring General Settings:
- Is Submittable: Enable this option if the document should not be editable after submission. Toggling this in any way is not recommended and should be decided on the creation step.
- Is Child Table: Enable this if the DocType is to be used as a child table in other DocTypes. Toggling this in any way is not recommended and should be decided on the creation step.
- Is Single: Enable this if the DocType should only have a single record.
- Is Tree: Enable this if the DocType represents a tree structure.
- Is Virtual: Enable this if the DocType does not correspond to a database table.
- Is Calendar and Gantt: Enable this to allow Calendar and Gantt views for the DocType.
- Quick Entry: Enable this to allow quick creation of records through a dialog with mandatory fields.
Naming Settings:
- Choose the appropriate Naming Rule for the DocType.
- Fill in the Auto Name field with the desired naming format if applicable.
- Check Allow Rename if it makes sense for your use case.
- Optionally, provide a Description for the naming settings.
- Optionally, provide a Documentation Link for additional help or documentation.
Form Settings:
- Set the Image Field if the DocType includes an image, which will be displayed on the left side menu.
- Set the Timeline Field if the DocType includes comments and communications.
- Configure other form settings such as hiding the sidebar, menu, and comments, allowing import, enabling events in the timeline, and more.
View Settings:
- Configure the Title Field, Search Fields, Default Print Format, and other view-related settings.
- Choose the Default View for the DocType (List, Report, Dashboard, Kanban).
- Set the Icon and Color for the DocType.
- Optionally, enable features like Show Preview Popup and making the "name" field searchable in global search.
Email Settings:
- Set the Default Email Template for the DocType if applicable.
- Enable Allow document creation via Email if you want to allow creating documents through email.
Linked Documents:
- Add linked documents by specifying the Link DocType, Link Fieldname, and other related fields.
- Configure additional settings for the linked documents such as grouping and visibility.
Document States:
- Define various states for the document by adding rows in the Document States section.
- Specify the Title and Color for each state.
Web View:
- Enable Has Web View if the DocType should have a web view.
- Configure the Route and other web view settings.