Show / Hide Table of Contents

    General.DocumentStateChanges Entity

    Namespace: General

    History of document state changes. Entity: Gen_Document_State_Changes

    Default Visualization

    Default Display Text Format:
    {Document.EntityName}
    Default Search Members:
    Document.EntityName
    Name Data Member:
    Document.EntityName
    Category: Definitions
    Show in UI: ShownByDefault

    Aggregate

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

    Aggregate Parent:
    General.Documents
    Aggregate Root:
    General.Documents

    Attributes

    Name Type Description
    DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
    Id guid
    NewState NewState The new state after the change. Required Filter(eq)
    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.
    SystemInitiated boolean Specifies whether the state change was caused by system process or from user action. Required Default(false) ReadOnly
    UpdateTime datetime The time when the change took effect. Required Filter(ge;le) ORD
    UpdateUser string (64) The login name of the user, who made the status change. Required Filter(eq)
    Void boolean True if the document is voided with this change. Required Default(false) Filter(eq) Introduced in version 19.1

    References

    Name Type Description
    Document Documents The document which has changed state. Required Filter(multi eq) Owner
    UserStatus DocumentTypeUserStatuses (nullable) The new user status after the change. Filter(multi eq)

    Attribute Details

    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

    Id

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

    NewState

    The new state after the change. Required Filter(eq)

    Type: NewState
    Category: System
    Allowed values for the NewState(General.DocumentStateChanges.md#newstate) data attribute
    Allowed Values (General.DocumentStateChangesRepository.NewState Enum Members)

    Value Description
    New New value. Stored as 0.
    Database Value: 0
    Model Value: 0
    Domain API Value: 'New'
    Corrective Corrective value. Stored as 5.
    Database Value: 5
    Model Value: 5
    Domain API Value: 'Corrective'
    Planned Planned value. Stored as 10.
    Database Value: 10
    Model Value: 10
    Domain API Value: 'Planned'
    FirmPlanned FirmPlanned value. Stored as 20.
    Database Value: 20
    Model Value: 20
    Domain API Value: 'FirmPlanned'
    Released Released value. Stored as 30.
    Database Value: 30
    Model Value: 30
    Domain API Value: 'Released'
    Completed Completed value. Stored as 40.
    Database Value: 40
    Model Value: 40
    Domain API Value: 'Completed'
    Closed Closed value. Stored as 50.
    Database Value: 50
    Model Value: 50
    Domain API Value: 'Closed'

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

    SystemInitiated

    Specifies whether the state change was caused by system process or from user action. Required Default(false) ReadOnly

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

    UpdateTime

    The time when the change took effect. Required Filter(ge;le) ORD

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

    UpdateUser

    The login name of the user, who made the status change. Required Filter(eq)

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

    Void

    True if the document is voided with this change. Required Default(false) Filter(eq) Introduced in version 19.1

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

    Reference Details

    Document

    The document which has changed state. Required Filter(multi eq) Owner

    Type: Documents
    Indexed: True
    Category: System
    Supported Filters: Equals, EqualsIn
    Filterable Reference: True
    Show in UI: CannotBeShown

    UserStatus

    The new user status after the change. Filter(multi eq)

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

    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/General_DocumentStateChanges?$top=10

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

    • Improve this Doc
    Back to top Generated by DocFX