Table of Contents

General.Documents.DocumentFileAttachments Entity

Namespace: General.Documents

Contains files, attached to the documents. Entity: Gen_Document_File_Attachments (Obsoleted in version 25.1.0.48)

Note

OBSOLETE! Do not use!

Renames

Old name: General.DocumentFileAttachments
New name: General.Documents.DocumentFileAttachments
Version: 25.1.0.64
Case: 37169

Default Visualization

Default Display Text Format:
{FileName}
Default Search Members:
FileName
Name Data Member:
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 Parent:
General.Documents.Documents
Aggregate Root:
General.Documents.Documents

Attributes

Name Type Description
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
EmbeddedFileContents byte[] nullable The contents of the embedded file. null when the file is linked.
FileName string (128) The display name of the file. Initially set to the file name (without path) of the linked or the embedded file. Required
Id guid
IsLinked boolean True when the document is linked (ony file name is kept). false when the document is embedded. Required Default(false) Filter(eq)
LinkedFilePath string (254) nullable Path to the linked file. null when the file is embedded.
Notes string (max) nullable Notes for this DocumentFileAttachment.
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.

References

Name Type Description
Document Documents The to which this DocumentFileAttachment belongs. Required Filter(multi eq) Owner

Attribute Details

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

The contents of the embedded file. null when the file is linked.

Type: byte[] nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: CannotBeShown

FileName

The display name of the file. Initially set to the file name (without path) of the linked or the embedded file. Required

Type: string (128)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 128
Show in UI: ShownByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

IsLinked

True when the document is linked (ony file name is kept). false when the document is embedded. Required Default(false) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

LinkedFilePath

Path to the linked file. null when the file is embedded.

Type: string (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

Notes

Notes for this DocumentFileAttachment.

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

Reference Details

Document

The to which this DocumentFileAttachment belongs. Required Filter(multi eq) Owner

Type: Documents
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: CannotBeShown

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: string

  • search
    The search text - searches by value or description. Can contain wildcard character %.
    Type: string
    Optional: True
    Default Value: null

  • exactMatch
    If true the search text should be equal to the property value
    Type: boolean
    Optional: True
    Default Value: False

  • orderByDescription
    If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
    Type: boolean
    Optional: True
    Default Value: False

  • top
    The top clause - default is 10
    Type: int32
    Optional: True
    Default Value: 10

  • skip
    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: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    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

None

Front-End Business Rules

None

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/General_Documents_DocumentFileAttachments?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#General_Documents_DocumentFileAttachments?$top=10