Table of Contents

Systems.Core.FormLayouts Entity

Namespace: Systems.Core

Contains user layouts of the screen forms. Entity: Sys_Form_Layouts

Renames

Old name: Systems.UI.FormLayouts
New name: Systems.Core.FormLayouts
Version: 24.1.5.35
Case: 35911

Default Visualization

Default Display Text Format:
{ApplicationName}
Default Search Members:
ApplicationName
Name Data Member:
ApplicationName
Category: Settings
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 Tree

Attributes

Name Type Description
ApplicationName string (64) The application, which consumes the layout. Required Filter(eq) ORD
Category string (36) nullable The object category for which the layout is applied. Object category is usually user-defined and further divides the objects of a given object type. Filter(eq) Introduced in version 23.1.1.25
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FormName string (128) The form, for which the layout is applied. Required Filter(eq;like)
Id guid
Layout byte[] nullable The byte storage of the layout.
LayoutFormat LayoutFormat The format of the data in the Layout column. Values can be: 'U' - uncompressed; 'L' - LZO compressed; 'D' - Deflate compressed. Required Default("U")
LayoutName string (64) The name of a named layout. Standard layouts have empty string names. Required Filter(eq;like)
LayoutXml string (max) nullable OBSOLETE! Do not use! Layout xml - not used. Obsolete Obsoleted in version 22.1.6.61
MachineName string (128) nullable OBSOLETE! Do not use! The machine name - not used. Obsolete Filter(eq;like) Obsoleted in version 22.1.6.61
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.
PanelName string (64) The visual panel, for which the layout is applied. Required Default("Form") Filter(eq)
UserName string (64) nullable The user for which the layout is applied. null means that the layout is applied for all users. Filter(eq;like)

References

Name Type Description
AccessKey AccessKeys (nullable) The security access key which controls the access to the layout view. Filter(multi eq)
InheritFormLayout FormLayouts (nullable) Specified when the current layout inherits from another layout. Filter(multi eq) Introduced in version 25.1.1.56
Role Roles (nullable) The role, for which the layout is applied. Filter(multi eq)

Attribute Details

ApplicationName

The application, which consumes the layout. Required Filter(eq) ORD

Type: string (64)
Indexed: True
Category: System
Supported Filters: Equals
Supports Order By: True
Maximum Length: 64
Show in UI: ShownByDefault

Category

The object category for which the layout is applied. Object category is usually user-defined and further divides the objects of a given object type. Filter(eq) Introduced in version 23.1.1.25

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

FormName

The form, for which the layout is applied. Required Filter(eq;like)

Type: string (128)
Category: System
Supported Filters: Equals, Like
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

Layout

The byte storage of the layout.

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

LayoutFormat

The format of the data in the Layout column. Values can be: 'U' - uncompressed; 'L' - LZO compressed; 'D' - Deflate compressed. Required Default("U")

Type: LayoutFormat
Category: System
Allowed values for the LayoutFormat(Systems.Core.FormLayouts.md#layoutformat) data attribute
Allowed Values (Systems.Core.FormLayoutsRepository.LayoutFormat Enum Members)

Value Description
CompressedDeflate CompressedDeflate value. Stored as 'D'.
Database Value: 'D'
Model Value: 0
Domain API Value: 'CompressedDeflate'
CompressedLZO CompressedLZO value. Stored as 'L'.
Database Value: 'L'
Model Value: 1
Domain API Value: 'CompressedLZO'
Uncompressed Uncompressed value. Stored as 'U'.
Database Value: 'U'
Model Value: 2
Domain API Value: 'Uncompressed'

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

LayoutName

The name of a named layout. Standard layouts have empty string names. Required Filter(eq;like)

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

LayoutXml

OBSOLETE! Do not use! Layout xml - not used. Obsolete Obsoleted in version 22.1.6.61

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

MachineName

OBSOLETE! Do not use! The machine name - not used. Obsolete Filter(eq;like) Obsoleted in version 22.1.6.61

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

PanelName

The visual panel, for which the layout is applied. Required Default("Form") Filter(eq)

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

UserName

The user for which the layout is applied. null means that the layout is applied for all users. Filter(eq;like)

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

Reference Details

AccessKey

The security access key which controls the access to the layout view. Filter(multi eq)

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

Remarks
Supported permissions

Permission Type
Update -
Delete -
Administer (manage security) -

InheritFormLayout

Specified when the current layout inherits from another layout. Filter(multi eq) Introduced in version 25.1.1.56

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

Role

The role, for which the layout is applied. Filter(multi eq)

Type: Roles (nullable)
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: 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/Systems_Core_FormLayouts?$top=10

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

Suggest improvement to this page