Systems.Security.VisualPermissions Entity

Namespace: Systems.Security

Contains permissions, which are honored only by client applications and are used to provide access to (primarily show/hide) different elements of the user interface. Entity: Sec_Visual_Permissions

Default Visualization

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

• Systems.Security.VisualPermissions

Attributes

Name	Type	Description
ApplicationName	string (64)	The application for which the permission is specified. Required Filter(eq)
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
ElementName	string (4000) nullable	Optionally, the element from the panel which will be secured. Filter(eq)
FormName	string (128) nullable	Optionally, the form which will be secured. Filter(eq)
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.
OperationName	string (64) nullable	Optionally, the operation on the element which will be secured. Filter(eq)
PanelName	string (128) nullable	Optionally, the panel from the form which will be secured. Filter(eq)

References

Name	Type	Description
AccessKey	AccessKeys (nullable)	The security access key which controls the access to the visual permission. Filter(multi eq)

Attribute Details

ApplicationName

The application for which the permission is specified. Required Filter(eq)

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

ElementName

Optionally, the element from the panel which will be secured. Filter(eq)

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

FormName

Optionally, the form which will be secured. Filter(eq)

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

OperationName

Optionally, the operation on the element which will be secured. Filter(eq)

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

PanelName

Optionally, the panel from the form which will be secured. Filter(eq)

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

Reference Details

AccessKey

The security access key which controls the access to the visual permission. Filter(multi eq)

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

Remarks
Supported permissions

Permission	Type
Access	-

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 Query: https://demodb.my.erp.net/api/domain/odata/Systems_Security_VisualPermissions?$top=10

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