Advanced SmartObjects: Properties

SmartObject properties define the data 'fields' of the SmartObject, similar to columns in a database or spreadsheet. SmartObject properties are most often associated with data required by, or returned by, SmartObject methods. This is known as binding: you 'map' or 'bind' a field returned by a method, to a property of that SmartObject. When editing a SmartObject in advanced mode, you can edit the properties for that SmartObject in the Properties tab, as shown below:

Field Description
Name A descriptive name for this SmartObject property.
Type The data type of the property. See SmartBox properties for a listing of the available data types.
Key Whether this property is used as a key/unique value, typically used for ID fields.
SmartBox Whether this property stores its data in K2 SmartBox.
Required Whether this property must have a value, or if it can be null.
Unique Whether this property must be a unique value, such as a GUID.

Considerations

  • Take care when editing existing SmartObjects, especially if renaming or deleting existing properties or methods. If you rename, change or delete a property or method, you could break an application that requires that property or method.