Show / Hide Table of Contents

    General.Printouts Entity

    Namespace: General

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

    Default Visualization

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

    Attributes

    Name Type Description
    AllowPrintingOnState AllowPrintingOnState The user can print documents only with state equal or greater than Allow_Printing_On_State. Required Default(0)
    ApplicationName string (64) The application which stored and uses the printout. Required
    BackwardCompatibility boolean Obsolete. Not used. Required Default(false)
    Copies int32 Number of copies that should be printed when using direct printing. Required Default(1)
    Definition string (max) nullable Obsolete. Not used.
    DefinitionFormat string (16) nullable Obsolete. Not used. Default("default")
    DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
    Id guid
    IsDefault boolean True if this is the default printout for the application form. Required Default(false) Filter(eq)
    Name string (64) The name of the printout. Unique within the application form. Required Filter(like)
    Notes string (512) nullable Notes for this Printout.
    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.
    Ord int32 Order in the list of printouts when using direct printing. Required Default(0)
    OrdFilterXml dataaccessfilter nullable The condition, required to be matched in order for the printout to be executed upon "Print All" command.
    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. Required Filter(multi eq) Owner
    EnterpriseCompany EnterpriseCompanies (nullable) The Enterprise Company to which this Printout applies, or null if it is for all enterprise companies. Filter(multi eq)
    PrintoutLayout PrintoutLayouts The printout layout, that is bound to the document type. Required Filter(multi eq)
    Report DataSources (nullable) If not null points to a custom report that indicates which data will be loaded in the printout. Filter(multi eq)

    Attribute Details

    AllowPrintingOnState

    The user can print documents only with state equal or greater than Allow_Printing_On_State. Required Default(0)

    Type: AllowPrintingOnState
    Category: System
    Allowed values for the AllowPrintingOnState(General.Printouts.md#allowprintingonstate) data attribute
    Allowed Values (General.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 printout. Required

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

    BackwardCompatibility

    Obsolete. Not used. 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 should be printed when using direct printing. Required Default(1)

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

    Definition

    Obsolete. Not used.

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

    DefinitionFormat

    Obsolete. Not used. 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

    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

    IsDefault

    True if this is the default printout for the application form. Required Default(false) Filter(eq)

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

    Name

    The name of the printout. Unique within the application form. 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

    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

    Ord

    Order in the list of printouts when using direct printing. 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.

    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

    Reference Details

    DocumentType

    The document type to which this printout layout is bound. Required Filter(multi eq) Owner

    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

    PrintoutLayout

    The printout layout, that is bound to the document type. Required Filter(multi eq)

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

    Report

    If not null points to a custom report that indicates which data will be loaded in the printout. Filter(multi eq)

    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

    Creates a notification and sends 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 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_Printouts?$top=10

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

    • Improve this Doc
    Back to top Generated by DocFX