Systems.Core.ObjectFiles Entity
Namespace: Systems.Core
Contains files attached to objects. Entity: Sys_Object_Files
Default Visualization
Default Display Text Format:
{FileName}
Default Search Members:
FileName
Category: Definitions
Show in UI: ShownByDefault
Aggregate
An aggregate is a cluster of domain objects that can be treated as a single unit.
Aggregate Tree
Attributes
Name | Type | Description |
---|---|---|
AccessPermission | AccessPermission | Indicates who has permission to access this file. Required Default("IN") Filter(multi eq) Introduced in version 24.1.4.56 |
ContentLocation | ContentLocation | The location of the file contents. EMB=Embedded in the database; URL=Internet URL; FSL=File system link. Required Default("EMB") Filter(multi eq) Introduced in version 20.1 |
CreationTimeUtc | datetime | Time (in UTC), when the file was created. Required Default(NowUtc) Filter(ge;le) Introduced in version 20.1 |
DisplayText | string | Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object. |
EmbeddedFileContents | byte[] nullable | Contains the contents of the file, when it is embedded in the database. null for linked files. |
EmbeddedThumbnailContents | byte[] nullable | Contains the compressed and/or resized contents of the file if applicable. ReadOnly Introduced in version 24.1.1.85 |
FileName | string (254) | The file name of the linked or embedded file. Required Filter(eq;like) |
FileSizeBytes | int32 nullable | The file size in bytes. If empty the file size is unknown. Introduced in version 22.1.5.46 |
Id | guid | |
LastUpdateTimeUtc | datetime | Time (in UTC), when the file was last updated. Required Default(NowUtc) Filter(ge;le) Introduced in version 20.1 |
LinkedFilePath | string (1024) nullable | When the file is linked, contains the full path (including the file name) to the linked file. null for embedded files. Filter(eq;like) |
MediaHeight | int32 nullable | Used (non-null) only for media files. Specifies the width for displaying the media. Introduced in version 20.1 |
MediaType | string (128) nullable | For media files, contains the Media Type as per the IANA registry (formerly known as the MIME Type). null for non-media files. Introduced in version 20.1 |
MediaWidth | int32 nullable | Used (non-null) only for media files. Specifies the width for displaying the media. Introduced in version 20.1 |
Notes | string (max) nullable | User notes for the file attachment. |
ObjectVersion | int32 | The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking. |
PurposeCode | string (32) nullable | Code, designating the usage purpose of the file. The meaning of each code is up to the application with the exception of 'default/image', which is standartised as the default image for many types of objects. Filter(eq) |
Section | string (64) nullable | A section name used to group files. Introduced in version 21.1.1.84 |
References
Name | Type | Description |
---|---|---|
CreationUser | Users (nullable) | The user, who created the file record. null if it is unknown. Filter(multi eq) Introduced in version 20.1 |
LastUpdateUser | Users (nullable) | The user, who performed the last update to the file record. null if it is unknown. Filter(multi eq) Introduced in version 20.1 |
Object | ExtensibleDataObjects | The object to which the file is attached. Required Filter(multi eq) |
Attribute Details
AccessPermission
Indicates who has permission to access this file. Required
Default("IN")
Filter(multi eq)
Introduced in version 24.1.4.56
Type: AccessPermission
Category: System
Allowed values for the AccessPermission
(Systems.Core.ObjectFiles.md#accesspermission) data attribute
Allowed Values (Systems.Core.ObjectFilesRepository.AccessPermission Enum Members)
Value | Description |
---|---|
Creator | Creator value. Stored as 'CU'. Database Value: 'CU' Model Value: 0 Domain API Value: 'Creator' |
Internal | Only internal users have access.. Stored as 'IN'. Database Value: 'IN' Model Value: 1 Domain API Value: 'Internal' |
External | External and internal users have access.. Stored as 'EX'. Database Value: 'EX' Model Value: 2 Domain API Value: 'External' |
Supported Filters: Equals, EqualsIn
Supports Order By: False
Default Value: Internal
Show in UI: ShownByDefault
ContentLocation
The location of the file contents. EMB=Embedded in the database; URL=Internet URL; FSL=File system link. Required
Default("EMB")
Filter(multi eq)
Introduced in version 20.1
Type: ContentLocation
Category: System
Allowed values for the ContentLocation
(Systems.Core.ObjectFiles.md#contentlocation) data attribute
Allowed Values (Systems.Core.ObjectFilesRepository.ContentLocation Enum Members)
Value | Description |
---|---|
Embedded | The content is stored in the database. Stored as 'EMB'. Database Value: 'EMB' Model Value: 0 Domain API Value: 'Embedded' |
InternetUrl | Internet resource location. Stored as 'URL'. Database Value: 'URL' Model Value: 1 Domain API Value: 'InternetUrl' |
FileSystemLink | Path to the file in the local file system. Stored as 'FSL'. Database Value: 'FSL' Model Value: 2 Domain API Value: 'FileSystemLink' |
Supported Filters: Equals, EqualsIn
Supports Order By: False
Default Value: Embedded
Show in UI: ShownByDefault
CreationTimeUtc
Time (in UTC), when the file was created. Required
Default(NowUtc)
Filter(ge;le)
Introduced in version 20.1
Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTimeUtc
Show in UI: ShownByDefault
DisplayText
Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault
EmbeddedFileContents
Contains the contents of the file, when it is embedded in the database. null for linked files.
Type: byte[] nullable
Category: Delay Loaded Attributes
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault
EmbeddedThumbnailContents
Contains the compressed and/or resized contents of the file if applicable. ReadOnly
Introduced in version 24.1.1.85
Type: byte[] nullable
Category: Delay Loaded Attributes
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: HiddenByDefault
FileName
The file name of the linked or embedded file. Required
Filter(eq;like)
Type: string (254)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault
FileSizeBytes
The file size in bytes. If empty the file size is unknown. Introduced in version 22.1.5.46
Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault
Id
Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown
LastUpdateTimeUtc
Time (in UTC), when the file was last updated. Required
Default(NowUtc)
Filter(ge;le)
Introduced in version 20.1
Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTimeUtc
Show in UI: ShownByDefault
LinkedFilePath
When the file is linked, contains the full path (including the file name) to the linked file. null for embedded files. Filter(eq;like)
Type: string (1024) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 1024
Show in UI: ShownByDefault
MediaHeight
Used (non-null) only for media files. Specifies the width for displaying the media. Introduced in version 20.1
Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault
MediaType
For media files, contains the Media Type as per the IANA registry (formerly known as the MIME Type). null for non-media files. Introduced in version 20.1
Type: string (128) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 128
Show in UI: ShownByDefault
MediaWidth
Used (non-null) only for media files. Specifies the width for displaying the media. Introduced in version 20.1
Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault
Notes
User notes for the file attachment.
Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault
ObjectVersion
The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault
PurposeCode
Code, designating the usage purpose of the file. The meaning of each code is up to the application with the exception of 'default/image', which is standartised as the default image for many types of objects. Filter(eq)
Type: string (32) nullable
Category: System
Supported Filters: Equals
Supports Order By: False
Maximum Length: 32
Show in UI: ShownByDefault
Section
A section name used to group files. Introduced in version 21.1.1.84
Type: string (64) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault
Reference Details
CreationUser
The user, who created the file record. null if it is unknown. Filter(multi eq)
Introduced in version 20.1
Type: Users (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
LastUpdateUser
The user, who performed the last update to the file record. null if it is unknown. Filter(multi eq)
Introduced in version 20.1
Type: Users (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
Object
The object to which the file is attached. Required
Filter(multi eq)
Type: ExtensibleDataObjects
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
API Methods
Methods that can be invoked in public APIs.
GetAllowedCustomPropertyValues
Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET
Parameters
customPropertyCode
The code of the custom property
Type: stringsearch
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: nullexactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: FalseorderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: Falsetop
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0
CreateNotification
Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST
Parameters
user
The user.
Type: UsersnotificationClass
The notification class.
Type: stringsubject
The notification subject.
Type: string
CreateCopy
Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST
Business Rules
- R30812-1 ObjectFile - Set Last Update User And Time
- R30812-2 ObjectFile - Set Creation User And Time
- R31762 ObjectFiles - Set FileSizeBytes, MediaType, MediaWidth, MediaHeight
- R32058 ObjectFile - Embedded File Contents Max Size
- R32058 ObjectFile - Set Embedded Thumbnail Contents
- R33122 ObjectFile - Change File Name If Same Filename Exists
- R33213 ObjectFile - Check File Name Compatibility
Front-End Business Rules
None
API
Domain API Query: https://demodb.my.erp.net/api/domain/odata/Systems_Core_ObjectFiles?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Systems_Core_ObjectFiles?$top=10