KSML Annotations
0. Overview
| Attribute Name | Link to Detailed Table |
|---|---|
| _features | features on Type level |
| _ui-hidden | is this element hide on UI |
| _ui-type | ui component adviced |
| _constant | indict if this Type is for defining constant Type |
| _identifier | extra _identifier fields |
| _name | name of the Type |
| _actionDescriptor | indict if this Type is an action describor |
| _ui-no-candidate | no candicate for the ui field |
| _ui-with-custom-candidate | custom the the candite list |
| _view_object | indict if this Type is a view object |
1. _features
| Attribute Name | Example |
|---|---|
| _features | _features="laboratory_function" |
| _features | _features="no_sample_data" |
2. _ui-hidden
| Attribute Name | Example |
|---|---|
| _ui-hidden | _ui-hidden="true" |
3. _ui-type
| Attribute Name | Example |
|---|---|
| _ui-type | _ui-type="text" |
| _ui-type | _ui-type="single-select" |
| _ui-type | _ui-type="checkbox" |
| _ui-type | _ui-type="action-links" |
| _ui-type | _ui-type="table" |
| _ui-type | _ui-type="adjustable-weight" |
| _ui-type | _ui-type="radio" |
| _ui-type | _ui-type="import-message" |
| _ui-type | _ui-type="weight" |
4. _constant
| Attribute Name | Example |
|---|---|
| _constant | _constant="true" |
5. _identifier
| Attribute Name | Example |
|---|---|
| _identifier | _identifier="code" |
6. _name
| Attribute Name | Example |
|---|---|
| _name | _name="Liquid Factory" |
| _name | _name="Employee" |
| _name | _name="Task Type" |
| _name | _name="Analysis Standard" |
| _name | _name="Analysis Report" |
| _name | _name="Liquid Container" |
| _name | _name="Truck Manager" |
| _name | _name="Workstation Binding" |
| _name | _name="Certificate Type" |
7. _actionDescriptor
| Attribute Name | Example |
|---|---|
| _actionDescriptor | _actionDescriptor="true" |
8. _ui_no-candidate
| Attribute Name | Example |
|---|---|
| _ui_no-candidate | _ui_no-candidate="true" |
9. _ui_with-custom-candidate
| Attribute Name | Example |
|---|---|
| _ui_with-custom-candidate | _ui_with-custom-candidate="true" |
10. _view_object
| Attribute Name | Example |
|---|---|
| _view_object | _view_object="true" |
11. Hard Encryption _hard_encrypt
| Attribute Name | Example |
|---|---|
| _hard_encrypt | _hard_encrypt="field" |
<employee salary="140000" _soft_encrypt="salary" />
hard_encrypt means can NOT be changed during runtime and always be serialized as encrypt object.
12. Soft Encryption _soft_encrypt
| Attribute Name | Example |
|---|---|
| _soft_encrypt | _soft_encrypt="age" |
<employee age="140" _soft_encrypt="age" />
_soft_encrypt means CAN be changed during runtime and be serialized as encrypt object by default but can be controlled by code.