Annotation¶
Annotations can be used to store user-defined attributes of a source system with any OctoSAM entity. Not to be used to store system defined attributes of source systems (extend the schema to hold such attributes). Annotations are not used for internal data logic within OctoSAM, but can be referenced in custom queries and reports.
Fields¶
| Field | Type | Description |
|---|---|---|
| AnnotationClassID | numeric | Internal ID that references the AnnotationClass entity (Foreign Key) |
| Created | datetime | Date/Time this entity was created |
| CreatedGUID | guid | GUID of the scan file that created this annotation |
| CurrencyVisible | boolean | Default visibility of the currency column for Money fields. Allows to hide the Currency column even though the Money column is visible |
| DefaultDecimalValue | decimal | Optional default value for numeric annotations |
| DefaultValue | string | Optional default value |
| Description | string | Description |
| Hyperlink | boolean | If true, value of the field should be rendered as Hyperlink |
| ID | numeric | Internal ID for the Annotation entity (Primary Key) |
| LastModification | datetime | Date/Time this entity was last modified |
| LastModifiedBy | string | User that last modified this annotation |
| MaxValue | decimal | For Annotations that can be edited through the GUI the Max Value that can be entered |
| MinValue | decimal | For Annotations that can be edited through the GUI the Max Value that can be entered |
| MultiLine | boolean | If true, the text field supports multiple lines |
| MultiSelect | boolean | For code Annotations, true if multiple codes can be selected |
| Name | string | Name of the annotation |
| Regex | string | For annotations that can be edited through the GUI, a regular expression that specifies acceptable values |
| Section | string | Optional section name if a dialog or webpage supports multiple sections of extended attributes |
| SortOrder | numeric | Sort Order of Annotations of the same Class |
| Type | string | S for strings, I for numbers, M for Money, B for boolean values, D for dates, C for lookup codes |
| Visible | boolean | Select if this annotation should be initially visible in queries that reference annotations |
| VisibleInColumnChooser | boolean | Select if this annotation should be visible in the column chooser in queries that reference annotations. If false and Visible is also false, that annotation will not be displayed in queries. |
| WebVisible | boolean | Visibility of this annotation in web grids |