Systems.Documents.Printouts

Contains data about binding of printout layouts to specific user-defined document types.

General

Namespace: Systems.Documents
Repository: Systems.Documents.Printouts
Base Table: Gen_Printouts
API access: ReadWrite

Renames

Old name: General.Printouts
New name: Systems.Documents.Printouts
Version: 24.1.5.35
Case: 35911

Visualization

Display Format: {Name}
Search Members: Name
Name Member: Name
Category: Definitions
Show in UI: ShownByDefault

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:
Systems.Documents.DocumentTypes
Aggregate Root:
Systems.Documents.DocumentTypes

Attributes

Name	Type	Description
AllowPrintingOnState	AllowPrintingOnState	The minimal document state on wich is permited to print this printout`Required` `Default(0)`
ApplicationName	string (64)	The application which stored and uses the printout`Required`
BackwardCompatibility	boolean	Supports the old data format.`Required` `Default(false)`
Copies	int32	Number of copies that will be printed when the user choses 'Print multiple'.`Required` `Default(1)`
Definition	string (max) nullable	The contents of the printout.
DefinitionFormat	string (16) nullable	System format of the printout definition.`Default("default")`
IsDefault	boolean	If True this printout will be used in direct print or print preview.`Required` `Default(false)` `Filter(eq)`
Name	string (64)	Name of the printout.`Required` `Filter(like)`
Notes	string (512) nullable	Notes for this Printout.
Ord	int32	Order in the multiple print. 0 means that the printout does not participate.`Required` `Default(0)`
OrdFilterXml	dataaccessfilter nullable	The condition, required to be matched in order for the printout to be executed upon "Print All" command.`Unit: obj.DocumentType.EntityName`
OrdPriority	int32 nullable	Ordinal position and priority of the printout, in regard to other printouts within the current document type. Used for sorting, when executing printouts with "Print All" command.`Default(0)`

References

Name	Type	Description
DocumentType	DocumentTypes	The document type to which this printout layout is bound.
EnterpriseCompany	EnterpriseCompanies (nullable)	The Enterprise Company to which this Printout applies, or null if it is for all enterprise companies. `Filter(multi eq)`
FiscalReceiptTemplate	FiscalReceiptTemplates (nullable)	Template for customizing the fiscal receipt.
PrintoutLayout	PrintoutLayouts (nullable)	The printout layout, that is bound to the document type.
Report	DataSources (nullable)	A report that contains the set of data that will be loaded in the printout.

System Attributes

Name	Type	Description
Id	guid
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.
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Attribute Details

AllowPrintingOnState

The minimal document state on wich is permited to print this printoutRequired Default(0)

Type: AllowPrintingOnState
Category: System
Allowed values for the AllowPrintingOnState(Systems.Documents.Printouts.md#allowprintingonstate) data attribute
Allowed Values (Systems.Documents.PrintoutsRepository.AllowPrintingOnState Enum Members)

Value	Description
New	New value. Stored as 0. Database Value: 0 Model Value: 0 Domain API Value: 'New'
Planned	Planned value. Stored as 10. Database Value: 10 Model Value: 10 Domain API Value: 'Planned'
FirmPlanned	FirmPlanned value. Stored as 20. Database Value: 20 Model Value: 20 Domain API Value: 'FirmPlanned'
Released	Released value. Stored as 30. Database Value: 30 Model Value: 30 Domain API Value: 'Released'
Completed	Completed value. Stored as 40. Database Value: 40 Model Value: 40 Domain API Value: 'Completed'
Closed	Closed value. Stored as 50. Database Value: 50 Model Value: 50 Domain API Value: 'Closed'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

ApplicationName

The application which stored and uses the printoutRequired

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

Back-End Default Expression:
obj.Transaction.ApplicationName

BackwardCompatibility

Supports the old data format.Required Default(false)

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

Copies

Number of copies that will be printed when the user choses 'Print multiple'.Required Default(1)

Type: int32
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 1
Show in UI: ShownByDefault

Definition

The contents of the printout.

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

DefinitionFormat

System format of the printout definition.Default("default")

Type: string (16) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 16
Default Value: default
Show in UI: CannotBeShown

IsDefault

If True this printout will be used in direct print or print preview.Required Default(false) Filter(eq)

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

Name

Name of the printout.Required Filter(like)

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

Notes

Notes for this Printout.

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

Ord

Order in the multiple print. 0 means that the printout does not participate.Required Default(0)

Type: int32
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

OrdFilterXml

The condition, required to be matched in order for the printout to be executed upon "Print All" command.Unit: obj.DocumentType.EntityName

Type: dataaccessfilter nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

OrdPriority

Ordinal position and priority of the printout, in regard to other printouts within the current document type. Used for sorting, when executing printouts with "Print All" command.Default(0)

Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

Id

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

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

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

Reference Details

DocumentType

The document type to which this printout layout is bound.

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

EnterpriseCompany

The Enterprise Company to which this Printout applies, or null if it is for all enterprise companies. Filter(multi eq)

Type: EnterpriseCompanies (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

FiscalReceiptTemplate

Template for customizing the fiscal receipt.

Type: FiscalReceiptTemplates (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

PrintoutLayout

The printout layout, that is bound to the document type.

Type: PrintoutLayouts (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Report

A report that contains the set of data that will be loaded in the printout.

Type: DataSources (nullable)
Category: System
Supported Filters: Equals, EqualsIn
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

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

Domain API Entity Type: Systems_Documents_Printout

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

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

Table of Contents

Systems.Documents.Printouts

General

Renames

Visualization

Track Changes

Aggregate

Attributes

References

System Attributes

Attribute Details

AllowPrintingOnState

ApplicationName

BackwardCompatibility

Copies

Definition

DefinitionFormat

IsDefault

Name

Notes

Ord

OrdFilterXml

OrdPriority

Id

ObjectVersion

DisplayText

Reference Details

DocumentType

EnterpriseCompany

FiscalReceiptTemplate

PrintoutLayout

Report

API Methods

GetAllowedCustomPropertyValues

CreateNotification

CreateCopy

Business Rules

Front-End Business Rules

API