Systems.Core.ExternalApplications Entity

List of external applications. Used to run external applications. Entity: Sys_External_Applications

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
Name
Name Data Member:
Name
Category: Settings
Show in UI: ShownByDefault

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

Systems.Core.ExternalApplications

Attributes

Name	Type	Description
Address	string (max)	The address (path) to the application. The address is platform-dependant. `Required`
AvailableInMode	AvailableInMode	Whether the application will be displayed to the end users when a single object is opened or when multiple objects are listed. `Required` `Default("SINGLE")` `Filter(eq)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
EntityName	string (64)	The entity, for which the application is defined. `Required` `Filter(eq)` `ORD`
ExecuteForAllObjects	boolean	Whether to execute the application for all selected objects at once or to execute the application for each object, one by one. `Required` `Default(true)` `Filter(eq)`
Id	guid
IsActive	boolean nullable	Specifies whether the external application is currently used. `Default(true)` `Filter(eq)`
Name	MultilanguageString (254)	The name of the external application. `Required` `Filter(eq;like)`
Notes	string (max) nullable	Notes for this ExternalApplication.
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.
Platform	Platform	The execution platform of the application. `Required` `Filter(eq)`
RefreshAfterFinish	boolean	Whether to refresh the data, displayed to the user, after the execution finishes. Not all platforms and/or applications support finish notification. `Required` `Default(true)` `Filter(eq)`
SaveBeforeStart	boolean	Whether to save the form data to the server before starting the application. `Required` `Default(true)` `Filter(eq)`

References

Name	Type	Description
AccessKey	AccessKeys (nullable)	The access key, containing the user permissions for this ExternalApplication. Null means that all users have unlimited permissions. `Filter(multi eq)`

Attribute Details

Address

The address (path) to the application. The address is platform-dependant. Required

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

AvailableInMode

Whether the application will be displayed to the end users when a single object is opened or when multiple objects are listed. Required Default("SINGLE") Filter(eq)

Type: AvailableInMode
Category: System
Allowed values for the AvailableInMode(Systems.Core.ExternalApplications.md#availableinmode) data attribute
Allowed Values (Systems.Core.ExternalApplicationsRepository.AvailableInMode Enum Members)

Value	Description
SINGLE	SINGLE value. Stored as 'SINGLE'. Database Value: 'SINGLE' Model Value: 0 Domain API Value: 'SINGLE'
LIST	LIST value. Stored as 'LIST'. Database Value: 'LIST' Model Value: 1 Domain API Value: 'LIST'
ALL	ALL value. Stored as 'ALL'. Database Value: 'ALL' Model Value: 2 Domain API Value: 'ALL'

Supported Filters: Equals
Supports Order By: False
Default Value: SINGLE
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

EntityName

The entity, for which the application is defined. 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

ExecuteForAllObjects

Whether to execute the application for all selected objects at once or to execute the application for each object, one by one. Required Default(true) Filter(eq)

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

Id

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

IsActive

Specifies whether the external application is currently used. Default(true) Filter(eq)

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

Name

The name of the external application. Required Filter(eq;like)

Type: MultilanguageString (254)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Show in UI: ShownByDefault

Notes

Notes for this ExternalApplication.

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

Platform

The execution platform of the application. Required Filter(eq)

Type: Platform
Category: System
Allowed values for the Platform(Systems.Core.ExternalApplications.md#platform) data attribute
Allowed Values (Systems.Core.ExternalApplicationsRepository.Platform Enum Members)

Value	Description
WINDOWS	WINDOWS value. Stored as 'WINDOWS'. Database Value: 'WINDOWS' Model Value: 0 Domain API Value: 'WINDOWS'
WEBPAGE	WEBPAGE value. Stored as 'WEBPAGE'. Database Value: 'WEBPAGE' Model Value: 1 Domain API Value: 'WEBPAGE'
WEBSERVICE	WEBSERVICE value. Stored as 'WEBSERVICE'. Database Value: 'WEBSERVICE' Model Value: 2 Domain API Value: 'WEBSERVICE'
ANDROID	ANDROID value. Stored as 'ANDROID'. Database Value: 'ANDROID' Model Value: 3 Domain API Value: 'ANDROID'
IOS	IOS value. Stored as 'iOS'. Database Value: 'iOS' Model Value: 4 Domain API Value: 'IOS'

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

RefreshAfterFinish

Whether to refresh the data, displayed to the user, after the execution finishes. Not all platforms and/or applications support finish notification. Required Default(true) Filter(eq)

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

SaveBeforeStart

Whether to save the form data to the server before starting the application. Required Default(true) Filter(eq)

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

Reference Details

AccessKey

The access key, containing the user permissions for this ExternalApplication. Null means that all users have unlimited permissions. Filter(multi eq)

Type: AccessKeys (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/Systems_Core_ExternalApplications?$top=10

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

Table of Contents

Systems.Core.ExternalApplications Entity

Default Visualization

Aggregate

Attributes

References

Attribute Details

Address

AvailableInMode

DisplayText

EntityName

ExecuteForAllObjects

Id

IsActive

Name

Notes

ObjectVersion

Platform

RefreshAfterFinish

SaveBeforeStart

Reference Details

AccessKey

API Methods

GetAllowedCustomPropertyValues

CreateNotification

CreateCopy

Business Rules

Front-End Business Rules

API