Common Properties

Object Field

Object fields are configured on an object. Just click on the name of each object to see the different fields. Each object field has input settings and output settings. Input settings are used when the value is sent to the external system. Output settings are used when the value is retrieved from the external system.

Common Properties Object Field

Properties Description
Id This is a unique GUID which is used internally.
Name The name of the field.
Label The label of the field. Labels are multi language enabled and are used by the ADM and synchronization module.
Description Specify a description. Descriptions are only used internally.
Type Specify the type of the field. It is important to choose the correct type, the framework will try to cast data to a .NET type. In short you could use the following guidelines:

The external software application will always return:

  • Text: select the Text type.
    • This is a piece of text
    • Numbers could be also text: 506
  • One character: select the Char type.
    • A
    • ...
    • Z
    • 5
  • Natural numbers: select the Integer type.
    • 3
    • -150
    • 95354
  • Real numbers: select the Number type.
    • 3
    • -150,6984
    • 0.25987
    • 1'954'330.28
  • Currency numbers: select the Currency type.
  • Boolean (two states): select the YesNo type.
    • 0 or 1
    • Yes or No
    • True or False
    • Juist or Fout
  • Date or Time: select the DateTime type.
    • 31/12/2018 14:24:32
    • Mon 31 Dec 2018
    • 1994-11-05T08:15:30Z
  • Files stored as a base64 string: select the Media type.
    • RGl0IGlzIGVlbiB2b29yYmVlbGQgYmFzZTY0IHN0cmluZw==
  • URL: select the Link type.
Value Type Contains the .NET type of the selected type.

Type .NET Type
YesNo Boolean
Text String
Char Char
Number Double
Currency Decimal
DateTime DateTime
Integer Int32
Media String (Base64)
Link Uri
Unique Specify if the object field is unique. Each object must have a unique or primary key.
External Name Specify the name of the field in the external software application. In most cases the external name is case sensitive.
Required Specify if the field is required. Required fields must be filled in and will be validated by the Ometa BC before sending it to the external system.
Default Value Specify a default value. Default values are only used if the field is empty in create views. Default values are not used in multi record, single record and update views.
Conversion Script Specify a conversion script.
Validation Script Specify a validation script.

View Field

Common Properties View Field

Properties Description
Id This is a unique GUID which is used internally.
Name The name of the field. This could not be changed.
Label The label is inherited from the linked method. We advise not to break inheritance on view field or method field level. Change the label on object level.

The label is used in the ADM.
Description The description is inherited from the linked method.
Hidden Specify if the field is made hidden. Hidden fields are not displayed in the ADM but they contain information and can be used as context. Unique fields (a.k.a. primary key) are often made hidden.
Width The width expressed in pixels in multi record and single record views. With create and update views there is the possibility to express the width in other lengths like percentage, ems, inches or centimetres.