Systems.Core.InstanceChangeRequests Entity

Namespace: Systems.Core

Major changes to enterprise companies (like base or reporting currency change). Entity: Sys_Instance_Change_Requests (Introduced in version 26.1.4.40)

Default Visualization

Default Display Text Format:
{RequestNo}: {ChangeKind}
Default Search Members:
__
Category: Definitions
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.Core.InstanceChangeRequests

Attributes

Name	Type	Description
ChangeKind	ChangeKind	The type of change requested for the enterprise company. `Required` `Filter(multi eq)`
CurrencyRate	decimal (20, 10) nullable	Currency Rate, applied for the change when relevant (e.g. reporting or base currency change). Used to fix the conversion rate at the time of change execution. `Filter(eq)` `Introduced in version 26.1.4.51`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
EffectiveDate	date	The date from which the change is effective. Might differ from execution date. `Required` `Filter(eq;ge;le)`
ExecutionDate	date	The date on which the change should be initiated. `Required` `Filter(eq;ge;le)`
Id	guid
Notes	string (max) nullable	Notes. `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.
ProgressDate	date nullable	The date up to which the data is updated in the database. Updated by the batch job. `Filter(eq;ge;le)`
ProgressPercent	decimal (5, 2) nullable	Progress, updated by the batch job. `Filter(ge;le)`
ReferenceNo	string (32) nullable	Text for internal reference of the change request. `Filter(eq)`
RequestNo	int32	Global consequtive request number. `Required` `Filter(eq)` `ORD`
SettingsJson	string (max) nullable	Additional settings for the change; expressed in Json. The format depends on the change kind. `Filter(like)`
State	State	Current state of the request. `Required` `Default("DRF")` `Filter(eq)`

References

Name	Type	Description
AssignedToUser	Users (nullable)	The user, to which it is assigned. `Filter(multi eq)`
EnterpriseCompany	EnterpriseCompanies (nullable)	The enterprise company being changed. Null means that the change is for the whole instance. `Filter(multi eq)`
NewValueCurrency	Currencies (nullable)	New value, when the change is for currency. `Filter(multi eq)`
OldValueCurrency	Currencies (nullable)	Old value, when the change is for currency. `Filter(multi eq)`

Attribute Details

ChangeKind

The type of change requested for the enterprise company. Required Filter(multi eq)

Type: ChangeKind
Category: System
Allowed values for the ChangeKind(Systems.Core.InstanceChangeRequests.md#changekind) data attribute
Allowed Values (Systems.Core.InstanceChangeRequestsRepository.ChangeKind Enum Members)

Value	Description
ReportingCurrencyChange	Reporting Currency Change. Stored as 'REP'. Database Value: 'REP' Model Value: 0 Domain API Value: 'ReportingCurrencyChange'
BaseCurrencyChange	Base Currency Change. Stored as 'BAS'. Database Value: 'BAS' Model Value: 1 Domain API Value: 'BaseCurrencyChange'
CurrencyOfDefaultsChange	Currency of Defaults Change. Stored as 'DEF'. Database Value: 'DEF' Model Value: 2 Domain API Value: 'CurrencyOfDefaultsChange'

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

CurrencyRate

Currency Rate, applied for the change when relevant (e.g. reporting or base currency change). Used to fix the conversion rate at the time of change execution. Filter(eq) Introduced in version 26.1.4.51

Type: decimal (20, 10) nullable
Category: System
Supported Filters: Equals
Supports Order By: False
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

EffectiveDate

The date from which the change is effective. Might differ from execution date. Required Filter(eq;ge;le)

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

ExecutionDate

The date on which the change should be initiated. Required Filter(eq;ge;le)

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

Id

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

Notes

Notes. 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

ProgressDate

The date up to which the data is updated in the database. Updated by the batch job. Filter(eq;ge;le)

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

ProgressPercent

Progress, updated by the batch job. Filter(ge;le)

Type: decimal (5, 2) nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

ReferenceNo

Text for internal reference of the change request. Filter(eq)

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

RequestNo

Global consequtive request number. Required Filter(eq) ORD

Type: int32
Category: System
Supported Filters: Equals
Supports Order By: True
Show in UI: ShownByDefault

SettingsJson

Additional settings for the change; expressed in Json. The format depends on the change kind. Filter(like)

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

State

Current state of the request. Required Default("DRF") Filter(eq)

Type: State
Category: System
Allowed values for the State(Systems.Core.InstanceChangeRequests.md#state) data attribute
Allowed Values (Systems.Core.InstanceChangeRequestsRepository.State Enum Members)

Value	Description
Draft	Draft. Stored as 'DRF'. Database Value: 'DRF' Model Value: 0 Domain API Value: 'Draft'
Submitted	Submitted. Stored as 'SUB'. Database Value: 'SUB' Model Value: 1 Domain API Value: 'Submitted'
Approved	Approved. Stored as 'APR'. Database Value: 'APR' Model Value: 2 Domain API Value: 'Approved'
PreparationsNeeded	Preparations Needed. Stored as 'PRN'. Database Value: 'PRN' Model Value: 3 Domain API Value: 'PreparationsNeeded'
PreparationsCompleted	Preparations Completed. Stored as 'PRP'. Database Value: 'PRP' Model Value: 4 Domain API Value: 'PreparationsCompleted'
Scheduled	Scheduled. Stored as 'SCH'. Database Value: 'SCH' Model Value: 5 Domain API Value: 'Scheduled'
InProgress	In Progress. Stored as 'INP'. Database Value: 'INP' Model Value: 6 Domain API Value: 'InProgress'
Paused	Paused. Stored as 'PAU'. Database Value: 'PAU' Model Value: 7 Domain API Value: 'Paused'
CompletedSuccessfully	Completed Successfully. Stored as 'CMP'. Database Value: 'CMP' Model Value: 8 Domain API Value: 'CompletedSuccessfully'
Cancelled	Cancelled. Stored as 'CNC'. Database Value: 'CNC' Model Value: 9 Domain API Value: 'Cancelled'
Failed	Failed. Stored as 'FLD'. Database Value: 'FLD' Model Value: 10 Domain API Value: 'Failed'

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

Reference Details

AssignedToUser

The user, to which it is assigned. Filter(multi eq)

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

EnterpriseCompany

The enterprise company being changed. Null means that the change is for the whole instance. Filter(multi eq)

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

NewValueCurrency

New value, when the change is for currency. Filter(multi eq)

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

OldValueCurrency

Old value, when the change is for currency. Filter(multi eq)

Type: Currencies (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

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

Front-End Business Rules

R39094 Instance Change Request - Configuring Settings_Json

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Systems_Core_InstanceChangeRequests?$top=10

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

Table of Contents

Systems.Core.InstanceChangeRequests Entity

Default Visualization

Track Changes

Aggregate

Attributes

References

Attribute Details

ChangeKind

CurrencyRate

DisplayText

EffectiveDate

ExecutionDate

Id

Notes

ObjectVersion

ProgressDate

ProgressPercent

ReferenceNo

RequestNo

SettingsJson

State

Reference Details

AssignedToUser

EnterpriseCompany

NewValueCurrency

OldValueCurrency

API Methods

GetAllowedCustomPropertyValues

CreateNotification

CreateCopy

Business Rules

Front-End Business Rules

API