Skip to main content

Object Metadata

Object .object.yml

Defines object name, display name, basic object information, and feature toggles.

name: contracts
enable_api: true
enable_audit: true
enable_chatter: false
enable_events: false
enable_files: true
enable_inline_edit: true
enable_instances: false
enable_notes: false
enable_search: true
enable_tasks: false
enable_trash: true
enable_workflow: true
enable_enhanced_lookup: true
icon: contract
is_enable: true
label: Contract
Property NameTypeMeaning
datasourcemaster_detailData Source
labeltextDisplay Name
nametextAPI Name
in_developmentselectDevelopment Status
enable_searchbooleanAllow Search
enable_filesbooleanAllow File Upload
enable_tasksbooleanAllow Task Addition
enable_notesbooleanAllow Adding Notes
enable_eventsbooleanAllow Event Addition
enable_apibooleanAllow API Access
enable_workflowbooleanAllow Object Workflow Configuration
enable_instancesbooleanAllow Viewing Applications
enable_chatterbooleanAllow Comments
enable_auditbooleanRecord Field History
enable_inline_editbooleanAllow Single Field Edit
enable_treebooleanEnable Tree View of Records
enable_enhanced_lookupbooleanEnable Popup Window Lookup Mode
table_nametextDatabase Table Name
fields_serial_numbernumberSerial number for new fields on object increments by +10
created_bylookupCreated by
modified_bylookupModified by
formobjectForm Events
form.onValuesChangecodeWhen data changes
form.initialValuescodeWhen data initializes
form.beforeDeletecodeBefore data deletion
form.afterDeletecodeAfter data deletion
form.beforeViewcodeBefore record display
form.afterViewcodeAfter record display

Additional notes:

  • datasource: Data source, there's a "default data source" and "external data source (like Oracle)". The default is "default data source".
  • name: API Name, used for calling this field in form events, triggers, etc.
  • icon: Icon, corresponding to salesforce's Standard Icons.
  • is_enable: Enabled, whether the object is enabled or not.
  • in_development: Development status, options include "In Development (only accessible by admin)" and "Deployed".
  • enable_search: Allows global search.
  • enable_files: Enables attachment uploads on the details page.
  • enable_tasks: Enables task subtable on the details page.
  • enable_notes: Enables memo subtable on the details page.
  • enable_events: Enables calendar subtable on the details page.
  • enable_api: If disabled, the object's actions won't be converted to REST APIs.
  • enable_workflow: To set approval process, this property must be enabled.
  • enable_instances: Enables approval subtable on the details page.
  • enable_chatter: Enables comment subpage on the details page.
  • enable_audit: Enables audit log subtable on the details page, which records field modification history.
  • enable_inline_edit: Enables field editing from the list view.
  • enable_tree: Enables tree view of records on the list page.
  • enable_trash: If true, the deleted data of this object will move to the recycle bin. If false, it will be deleted permanently.
  • enable_enhanced_lookup: When enabled, fields on related tables that reference this object will use a popup window for selection, otherwise, they use a dropdown list.
  • table_name: Name of the database table when referring to an external data source.
  • description: Notes about the object.
  • is_system: Indicates if the object is a built-in standard object of the system.
  • is_deleted: Indicates if the object is deleted.
  • form: Form events
  • form.onValuesChange: Function executed when data changes.
  • form.initialValues: Function executed during data initialization.
  • form.beforeDelete: Function executed before data deletion.
  • form.afterDelete: Function executed after data deletion.
  • form.beforeView: Function executed before record display.
  • form.afterView: Function executed after record display.

Field .field.yml

Defines field name, field type, and specific attributes.

name: await_proceeds
type: summary
data_type: number
filterable: false
group: Payment Information
index: false
is_name: false
is_wide: false
label: Accumulated Payments (Pending Payments)
hidden: false
omit: false
precision: 18
required: false
scale: 2
searchable: false
sort_no: 500
sortable: true
summary_field: amount
- field: contract_receipts_state
operation: '='
value: unreceived
summary_object: finance_receive
summary_type: sum

Common Attributes

objectmaster_detailAffiliated Object
labeltextDisplay Name
nametextAPI Name
typeselectField Type
defaultValuetextDefault Value
grouptextField Group
sort_nonumberSorting Number
is_namebooleanName Field
is_widebooleanWide Field
hiddenbooleanIgnore this Field
omitbooleanIgnore this Field
uniquebooleanUnique Index Field
indexbooleanCreate Field Index
filterablebooleanDefault Field for Advanced Search
visible_ontextareaField Display Formula
depend_ontext[]Dependent Fields
inlineHelpTexttextareaTip Text

Additional Notes:

  • name: API Name, this field's name used in form events, triggers, etc.
  • is_name: Name Field, marking this option means this field will replace the default 'name' field as the "Name Field". By default, an object uses the field named 'name' as its "Name Field". Clicking on the "Name Field" will navigate to the record detail page.
  • is_wide: Wide Field, a standard field occupies one column on the details page, a wide field spans two columns.
  • hidden: This field is always ignored and neither displayed nor loaded on both the creation/edit forms and the list/detail views. Typically used for system-level hidden fields.
  • omit: Same as hidden.
  • unique: Setting this option will automatically generate a unique index for the field.
  • index: Creates an index. If set to true, it will automatically create an index for the database field.
  • searchable: Can be globally searched.
  • filterable: Default Field for Advanced Search.
  • visible_on: Field display formula.
  • depend_on: When the value of the dependent field changes, the value of this field will be cleared.
  • inlineHelpText: Tip text displayed next to the field name on the detail page.
column_nametextDatabase Field Name
primarybooleanPrimary Key

Additional Notes:

  • column_name: Database field name, only supports relational databases.
  • primary: Primary key. Set the field as the primary key by ticking the "Primary Key" checkbox in the "External Data Source" column. Only supports relational databases.
  • generated: Field auto-increment, only supports relational databases.
Property NameTypeMeaningField Type
reference_tolookupReferenced Objectlookup/master_detail
reference_to_fieldstringReferenced Fieldlookup/master_detail
write_requires_master_readbooleanSubtable Permission Switchmaster_detail
filtersFunctiontextareaFilter Functionlookup/master_detail
optionsFunctiontextareaOption Functionlookup/master_detail/select
depend_ontext[]Dependent Fieldslookup/master_detail/select
reference_limitnumberDisplay Option Limitlookup/master_detail
showIconbooleanDisplay Icon or Notlookup/master_detail
precisioncurrencyPrecision (Number Length)number/currency/percent
scalecurrencyDecimal Placesnumber/currency/percent
minnumberMinimum Valuenumber/currency/percent/text/textarea
maxnumberMaximum Valuenumber/currency/percent/text/textarea
rowscurrencyText Rowstextarea
options.$.labeltextDisplay Name
options.$.valuetextOption Value
options.$.colortextBackground Color
data_typeselectData Typeformula/select
formula_blank_valueselectBlank Field Handlingformula
summary_objectlookupObject to Summarizesummary
summary_typeselectSummarization Typesummary
summary_fieldlookupField to Aggregatesummary
summary_filtersgridFilter Conditionssummary
summary_filters.$objectFilter Criteria
show_as_qrbooleanDisplay as QR Codeurl
  • reference_to: Referenced object. Only the "related table" and "master/subtable" field types support this property.
  • reference_to_field: Field of the referenced object. The default value is the primary key _id. It represents which field value of the object should be saved as the value of the related table in the database. Only the "related table" and "master/subtable" field types support this property.
  • multiple: Multi-choice. When enabled, multiple values can be saved. Only the "related table", "master/subtable", and "select box" field types support this property.
  • write_requires_master_read: This switch means "when a user has read permission for the master record, they can add, modify, or delete a subtable record." By default, only users with both read and write permissions for the master record can create, edit, or delete subtable records. Checking this property allows users with only read permission for the master record to create, edit, or delete sub-records. Only the "master/subtable" field type applies to this property.
  • filtersFunction: Filter function. The return value of this function defines the filter conditions for the related table (lookup) and master/subtable (master_detail) field types.
  • optionsFunction: Option function. The return value of this function defines the option values for the select box (select), related table (lookup), and master/subtable (master_detail) field types.
  • options: Selections. Define the dropdown options for the "select box" field type. Only the "select box" field type supports this property...
  • options.$: Selections.
  • options.$.label: Display Name.
  • options.$.value: Option Value.
  • options.$.color: Background Color.
  • options.$.description: Description.
  • reference_limit: Display option limit. When displayed as dropdown options, by default only 10 options will be listed for selection. Only the "related table", "master/subtable", and "select box" field types support this property.
  • showIcon: Whether to display an icon. Each object can have an icon configured. By default, the related table field will display the icon of the referenced object in the options. Configuring this property value as false can hide the icon in the options. Only the "related table", "master/subtable", and "select box" field types support this property.
  • depend_on: Dependent fields. When the value of the dependent field changes, it will not only clear the value of this field but also trigger the optionsFunction and filtersFunction functions to re-execute. This is typically used to implement cascading functionality in form fields.
  • formula: Formula. Automatically calculates the field value through a user-defined algorithm. Only the "formula" and "autonumber" field types support this property.
  • data_type: Data type. Defines the value type saved in the database. Only the "formula" and "select box" field types support this property.
  • formula_blank_value: Blank field handling. "zeroes" means treating blank fields as zero, while "blanks" means treating them as blank. The default is "zeroes". Only the "formula" field type supports this property.
  • summary_object: Object to summarize. Only the "cumulative summarization" field type supports this property.
  • summary_type: Summarization type. Contains five choices: COUNT, SUM, MIN, MAX, AVG. Only the "cumulative summarization" field type supports this property.
  • summary_field: Field to aggregate. Defines which field to aggregate during summarization, such as summarizing contract amounts. Only the "cumulative summarization" field type supports this property.
  • summary_filters: Filter conditions. Defines which records need to be summarized during summarization, only summarizing records that meet this filter condition. Only the "cumulative summarization" field type supports this property.
  • summary_filters.$: Filter criteria.
  • summary_filters.$.field: Field.
  • summary_filters.$.operation: Operator.
  • summary_filters.$.value: Value.
  • precision: Precision (number length). Defines the precision of the numeric field type. Only the "number", "currency", and "percentage" field types support this property.
  • scale: Decimal places. Defines the number of decimal places for the numeric field type. Only the "number", "currency", and "percentage" field types support this property.
  • min: Minimum value. Defines the minimum allowable value for the numeric field type. Only the "number", "currency", and "percentage" field types support this function. When used for text field types, it represents the minimum allowable character length.
  • max: Maximum value. Defines the maximum allowable value for the numeric field type. Only the "number", "currency", and "percentage" field types support this function. When used for text field types, it represents the maximum allowable character length.
  • rows: Number of text rows. Defines the number of rows displayed for the "textarea" field type. Only the "textarea" field type supports this property.
  • show_as_qr: Display as QR code. When enabled, the field will display a QR code based on its value. Only the "URL" field type supports this property.