General.Documents.DocumentPrints Entity

Contains the history of each document print or export. Entity: Gen_Document_Prints

Renames

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

Default Visualization

Default Display Text Format:
{Id}. {Document.DocumentNo} {Document.DocumentType.TypeName:T}
Default Search Members:
Document.DocumentNo
Name Data Member:
Document.EntityName
Category: Definitions
Show in UI: ShownByDefault
API access: ReadWrite

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

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
AdditionalData	string (max) nullable	Contains additional data about the printout. The format of the data is dependent on the Printout Type. `Introduced in version 19.1`
Description	string (254) nullable	The description of this DocumentPrint.
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
IsOriginal	boolean	True when the printout is the first printout (the original printout). `Required` `Filter(eq)`
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.
PrintoutType	PrintoutType nullable	Specifies the type of the printout: PPP - Phisycal Printer Printout; FPP - Fiscal Printer Printout; EXP - Export. `Filter(multi eq)` `Introduced in version 19.1`
PrintTime	datetime	The time when the document was printed or exported. `Required` `Default(Now)` `Filter(ge;le)` `ORD`
PrintUser	string (64)	The user, which printed or exported the document. `Required`
ReferenceNo	string (32) nullable	Used only when the printout reflects export to external system/device. In this case, it can store the reference number, generated by the other system/device. `Filter(multi eq)` `Introduced in version 19.1`

References

Name	Type	Description
Document	Documents	The document which was printed or exported. `Required` `Filter(multi eq)` `Owner`
DocumentPrintImage	DocumentPrintImages (nullable)	Points to the actual contents of the printed document. `Filter(multi eq;like)`

Attribute Details

AdditionalData

Contains additional data about the printout. The format of the data is dependent on the Printout Type. Introduced in version 19.1

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

Description

The description of this DocumentPrint.

Type: string (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 254
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

Id

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

IsOriginal

True when the printout is the first printout (the original printout). Required Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
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

PrintoutType

Specifies the type of the printout: PPP - Phisycal Printer Printout; FPP - Fiscal Printer Printout; EXP - Export. Filter(multi eq) Introduced in version 19.1

Type: PrintoutType nullable
Category: System
Allowed values for the PrintoutType(General.Documents.DocumentPrints.md#printouttype) data attribute
Allowed Values (General.Documents.DocumentPrintsRepository.PrintoutType Enum Members)

Value	Description
PhysicalPrinterPrintout	PhysicalPrinterPrintout value. Stored as 'PPP'. Database Value: 'PPP' Model Value: 0 Domain API Value: 'PhysicalPrinterPrintout'
FiscalPrinterPrintout	FiscalPrinterPrintout value. Stored as 'FPP'. Database Value: 'FPP' Model Value: 1 Domain API Value: 'FiscalPrinterPrintout'
Export	Export value. Stored as 'EXP'. Database Value: 'EXP' Model Value: 2 Domain API Value: 'Export'
UserDownload	UserDownload value. Stored as 'DWN'. Database Value: 'DWN' Model Value: 3 Domain API Value: 'UserDownload'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

PrintTime

The time when the document was printed or exported. Required Default(Now) Filter(ge;le) ORD

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: True
Default Value: CurrentDateTime
Show in UI: ShownByDefault

PrintUser

The user, which printed or exported the document. Required

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

ReferenceNo

Used only when the printout reflects export to external system/device. In this case, it can store the reference number, generated by the other system/device. Filter(multi eq) Introduced in version 19.1

Type: string (32) nullable
Category: System
Supported Filters: Equals, EqualsIn
Supports Order By: False
Maximum Length: 32
Show in UI: ShownByDefault

Reference Details

Document

The document which was printed or exported. Required Filter(multi eq) Owner

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

DocumentPrintImage

Points to the actual contents of the printed document. Filter(multi eq;like)

Type: DocumentPrintImages (nullable)
Indexed: True
Category: System
Supported Filters: Equals, Like, 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: 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

priority
The notification priority.
Type: Systems.Core.NotificationsRepository.Priority
Allowed values for the Priority(Systems.Core.Notifications.md#priority) data attribute
Allowed Values (Systems.Core.NotificationsRepository.Priority Enum Members)

Value	Description
Background	Background value. Stored as 1. Model Value: 1 Domain API Value: 'Background'
Low	Low value. Stored as 2. Model Value: 2 Domain API Value: 'Low'
Normal	Normal value. Stored as 3. Model Value: 3 Domain API Value: 'Normal'
High	High value. Stored as 4. Model Value: 4 Domain API Value: 'High'
Urgent	Urgent value. Stored as 5. Model Value: 5 Domain API Value: 'Urgent'

Optional: True
Default Value: Normal

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 Entity Set: General_Documents_DocumentPrints

Domain API Entity Type: General_Documents_DocumentPrint

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

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

Table of Contents

General.Documents.DocumentPrints Entity

Renames

Default Visualization

Track Changes

Aggregate

Attributes

References

Attribute Details

AdditionalData

Description

DisplayText

Id

IsOriginal

ObjectVersion

PrintoutType

PrintTime

PrintUser

ReferenceNo

Reference Details

Document

DocumentPrintImage

API Methods

GetAllowedCustomPropertyValues

CreateNotification

CreateCopy

Business Rules

Front-End Business Rules

API