Skip to main content

Fields

Tb_Rn_System_ObjectFields

In this section we will examine in detail the field properties used in Octo Lab.

Common Properties​

Fields

ObjectFieldId​

  • The unique identifier number of the field

ObjectId​

  • The ID of the object this field belongs to

FieldName​

  • Represents the field names of the object in the database
  • Important: Must be exactly the same as in the database
  • If different, it may cause system errors
  • Attention must be paid to case sensitivity
tip
DB Field Name: CustomerName
FieldName: CustomerName ✅
FieldName: customername ❌

DisplayOrder​

  • The order in which the fields are displayed on the screen

FieldDbTypeId​

  • The database data type of the field (int, nvarchar, decimal, datetime, etc.)

EditorTypeId​

  • The editing type of the field (TextEdit, SpinEdit, CheckEdit, DateTimeEdit, DateEdit, etc.)
tip

By default, the following mapping is used.

SQL Data Type GroupEditor NameDescription
bitCheckEditCheckbox for boolean fields.
dateDateEditDate selection only.
datetime, datetime2, smalldatetime, datetimeoffsetDateTimeEditDate + time selection.
int, bigint, smallint, tinyint, decimal, float, real, money, smallmoneySpinEditSpinner / numeric input for numeric entry.
image, binary, varbinaryImageEditBinary fields containing images/files.
text, ntextMemoLong text entries (legacy types).
All other types (e.g. char, nchar, varchar, nvarchar, uniqueidentifier, time, xml …)TextEditDefault free text input field.

FieldCaption​

  • The field title that the end user will see in the interface
  • May contain Turkish characters
  • Must be user-friendly and understandable
tip
FieldName: CustomerName
FieldCaption: Müşteri Adı

Fields 2

Width​

  • The width of the field on the screen

ReadOnly​

  • Determines whether the field is read-only
  • Overrides the object-level ReadOnly setting

Visible​

  • Determines whether the field is visible

Required​

  • Determines whether the field is required

Fields 3

DefaultValue​

  • The default value of the field

DisplayFormat​

  • The display format of the field

Lookup Operations​

Lookup fields are field types that allow the user to make a selection from a list.

danger

The LookupDataSourceObjectId, LookupValueFieldName, and LookupTextFieldName fields must be filled in together. Otherwise it may throw an error.

LookupDataSourceObjectId​

  • Specifies the ID of the object to be used as the data source in the lookup operation
  • This object contains the data to be shown in the selection list
  • Must be a valid ObjectId
tip
LookupDataSourceObjectId: 15
// Object number 15 contains the customer list

LookupValueFieldName​

  • Specifies the value to be saved after the user's selection
  • Usually used for ID fields
  • Must be an existing field in the LookupDataSource object
tip
LookupValueFieldName: CustomerId
// If the user selects "Ahmet Yılmaz", CustomerId (e.g.: 123) is saved

LookupTextFieldName​

  • Specifies the text to be shown to the user.
  • Must be an existing field in the LookupDataSource object.
tip
LookupTextFieldName: CustomerName
// The user sees the name "Ahmet Yılmaz" in the dropdown

LookupPopupFieldNames​

  • Can be selected from the LookupDataSource ObjectFields.FieldCaption fields
  • Multiple fields can be shown
  • Represents the additional parameter information to be shown to the user during selection
tip
LookupPopupFieldNames: CustomerCode,CustomerName,City
// The following columns appear in the popup:
// Customer Code | Customer Name | City
// 001          | Ahmet Yılmaz  | İstanbul
// 002          | Mehmet Ali    | Ankara

LookupWhereClause​

  • WHERE condition to filter the lookup data

LookupOrderClause​

  • ORDER BY condition to sort the lookup data

Lookup Usage Scenario​

tip

When creating a lookup field for customer selection:

LookupDataSourceObjectId: 15        // Customer list object ID
LookupValueFieldName: CustomerId     // Value to be saved (123)
LookupTextFieldName: CustomerName    // Text to be displayed (Ahmet Yılmaz)
LookupPopupFieldNames: CustomerCode,CustomerName,City

Result: The user sees the name "Ahmet Yılmaz", but the ID "123" is saved in the system.

SetRangeSourceFieldName​

These are properties that are meaningful for fields with lookups.

  • A field can be provided from the list of fields also defined in ObjectId.
  • When this field is filled in, the LookupDataSourceObjectId lookup data is filtered according to the value of this field
  • Used to create interdependent fields.
SetRangeTargetFieldName​
  • A field can be provided from the list of fields also defined in LookupDataSourceObjectId.
  • When SetRangeSourceFieldName changes, the lookup data in this field is updated
  • The two fields work together to provide cascading dropdown functionality
Example Usage
// Filter the district list when a province is selected
SetRangeSourceFieldName: CityId        // Province selection
SetRangeTargetFieldName: DistrictId    // District selection

// When the user selects İstanbul, only İstanbul's districts 
// (Kadıköy, Beşiktaş, etc.) are shown in the district dropdown

GroupName​

  • The group name of the fields

AfterSPObjectId​

  • The ID of the SP that will run after the field changes

FileTableId​

  • File table ID
tip

For detailed information on FileTable definitions, see ->

Preview​

  • Preview property

EditFormColumnSpan​

  • Valid for those that are a Grid Popup Form
  • The column width in the edit form

LinkDataSourceObjectId​

  • Link data source object ID

LinkFieldName​

  • Link field name

Table/View Specific Properties​

PrimaryKey​

  • Determines whether the field is a primary key

SummaryTypeId​

  • Summary type (Sum, Count, Average, etc.)

ExcludedFromCopy​

  • The selected fields are excluded from the Copy Row operation.

VisibleInEditForm​

  • Valid for objects that are a Grid Popup Form.
  • Determines whether it is visible in the edit form.

Regex​

  • The validation pattern of the field

AutoCodePrefix​

  • Automatic code prefix

AutoCodeLength​

  • Automatic code length

AutoCodeValue​

  • Automatic code value