Systems.Exchange.DataExchanges Entity

Namespace: Systems.Exchange

Denotes a data exchange (import, export, etc.) operation with detailed info about objects, transfer status and more. Entity: Sys_Data_Exchanges (Introduced in version 25.1.1.70)

Default Visualization

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

Systems.Exchange.DataExchanges
- Systems.Exchange.DataExchangeObjects

Attributes

Name	Type	Description
CreatedOn	datetime	The time (in UTC) when the exchange is created. `Required` `Filter(ge;le)` `ReadOnly`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
DriverName	string (64) nullable	The name of the exchange program/procedure, which actuates the exchange operation. `Default("JSON_FILE")` `Filter(eq)`
ExchangedOn	datetime nullable	The time (in UTC) of the exchange. `Filter(ge;le)`
ExchangeLog	string (max) nullable	General log of the last transfer attempt. Messages for the individual objects are kept with the objects. `Filter(like)`
ExternalAddress	string (254) nullable	Address of the external resource from/to which the date is transferred. The value is dependent on the exchange driver. `Filter(like)`
Id	guid
KeepUntil	date	Specify the date until which this package info will be kept. After the date, the package will be automatically purged (deleted). `Required` `Filter(ge;le)`
Mode	Mode	Operation mode of the exchange. `Required` `Default("E")` `Filter(eq)`
Name	string (64) nullable	The name of the package. Can be empty if naming is not important. `Filter(eq;like)`
Notes	string (max) nullable	Notes for the exchange. `Filter(like)`
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.
State	State	State of the exchange. `Required` `Default("PRE")` `Filter(eq)`

References

Name	Type	Description
CreatedByUser	Users	The user who created the exchange. `Required` `Filter(multi eq)` `ReadOnly`
ExchangedByUser	Users (nullable)	The user who made the exchange. `Filter(multi eq)`

Child Collections

Name	Type	Description
Objects	DataExchangeObjects	List of `DataExchangeObject`(Systems.Exchange.DataExchangeObjects.md) child objects, based on the `Systems.Exchange.DataExchangeObject.DataExchange`(Systems.Exchange.DataExchangeObjects.md#dataexchange) back reference

Attribute Details

CreatedOn

The time (in UTC) when the exchange is created. Required Filter(ge;le) ReadOnly

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
DateTime.UtcNow

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

DriverName

The name of the exchange program/procedure, which actuates the exchange operation. Default("JSON_FILE") Filter(eq)

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

ExchangedOn

The time (in UTC) of the exchange. Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

ExchangeLog

General log of the last transfer attempt. Messages for the individual objects are kept with the objects. Filter(like)

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

ExternalAddress

Address of the external resource from/to which the date is transferred. The value is dependent on the exchange driver. Filter(like)

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

Id

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

KeepUntil

Specify the date until which this package info will be kept. After the date, the package will be automatically purged (deleted). Required Filter(ge;le)

Type: date
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
DateTime.Now.AddMonths( 3).Date

Mode

Operation mode of the exchange. Required Default("E") Filter(eq)

Type: Mode
Category: System
Allowed values for the Mode(Systems.Exchange.DataExchanges.md#mode) data attribute
Allowed Values (Systems.Exchange.DataExchangesRepository.Mode Enum Members)

Value	Description
Export	Export. Stored as 'E'. Database Value: 'E' Model Value: 0 Domain API Value: 'Export'
Import	Import. Stored as 'I'. Database Value: 'I' Model Value: 1 Domain API Value: 'Import'

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

Name

The name of the package. Can be empty if naming is not important. Filter(eq;like)

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

Notes

Notes for the exchange. Filter(like)

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

State

State of the exchange. Required Default("PRE") Filter(eq)

Type: State
Category: System
Allowed values for the State(Systems.Exchange.DataExchanges.md#state) data attribute
Allowed Values (Systems.Exchange.DataExchangesRepository.State Enum Members)

Value	Description
Prepare	Prepare. Stored as 'PRE'. Database Value: 'PRE' Model Value: 0 Domain API Value: 'Prepare'
Ready	Ready. Stored as 'RED'. Database Value: 'RED' Model Value: 1 Domain API Value: 'Ready'
FinishedSuccess	Finished Success. Stored as 'FSC'. Database Value: 'FSC' Model Value: 2 Domain API Value: 'FinishedSuccess'
FinishedFail	Finished Fail. Stored as 'FFL'. Database Value: 'FFL' Model Value: 3 Domain API Value: 'FinishedFail'
ClosedSuccess	Closed Success. Stored as 'CSC'. Database Value: 'CSC' Model Value: 4 Domain API Value: 'ClosedSuccess'
ClosedFail	Closed Fail. Stored as 'CFL'. Database Value: 'CFL' Model Value: 5 Domain API Value: 'ClosedFail'

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

Reference Details

CreatedByUser

The user who created the exchange. Required Filter(multi eq) ReadOnly

Type: Users
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Back-End Default Expression:
obj.Transaction.CurrentUser.ToSecurityUser( )

ExchangedByUser

The user who made the exchange. Filter(multi eq)

Type: Users (nullable)
Indexed: True
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