Show / Hide Table of Contents

    General.DocumentTypeUserStatuses Entity

    Namespace: General

    User-defined document statuses. Entity: Gen_Document_Type_User_Statuses

    Default Visualization

    Default Display Text Format:
    {UserStatusName}
    Default Search Members:
    UserStatusName
    Name Data Member:
    UserStatusName
    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.DocumentTypes
    Aggregate Root:
    General.DocumentTypes

    Attributes

    Name Type Description
    Active boolean Is the user status active for applying to documents. Required Default(true) Filter(eq)
    DisplayOrder int32 Consecutive display order of the status, with regard to other statuses within the same document type. Required Filter(ge;le)
    DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
    Id guid
    Instructions string (max) nullable Instructions what should be done when this user status is active (Rich Text).
    IsExitStatus boolean True when the status allows going to the next system status, false otherwise. For example for system status Firm Planned, only user status Approved might allow going to Released. Required Default(true) 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.
    State DocumentState The system state to which this user status is bound. Required Filter(eq)
    UserStatusName string (128) Multi-language name of the user status. Required Filter(eq;like)

    References

    Name Type Description
    DocumentType DocumentTypes The document type, to which this user status is bound. Required Filter(multi eq) Owner

    Attribute Details

    Active

    Is the user status active for applying to documents. Required Default(true) Filter(eq)

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

    DisplayOrder

    Consecutive display order of the status, with regard to other statuses within the same document type. Required Filter(ge;le)

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

    Back-End Default Expression:
    ( obj.DocumentType.UserStatuses.Select( c => c.DisplayOrder).DefaultIfEmpty( 0).Max( ) + 1)

    Front-End Recalc Expressions:
    ( obj.DocumentType.UserStatuses.Select( c => c.DisplayOrder).DefaultIfEmpty( 0).Max( ) + 1)

    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

    Instructions

    Instructions what should be done when this user status is active (Rich Text).

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

    IsExitStatus

    True when the status allows going to the next system status, false otherwise. For example for system status Firm Planned, only user status Approved might allow going to Released. Required Default(true) Filter(eq)

    Type: boolean
    Category: System
    Supported Filters: Equals
    Supports Order By: False
    Default Value: True
    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

    The system state to which this user status is bound. Required Filter(eq)

    Type: DocumentState
    Category: System
    Enumeration of document system states
    Allowed Values (General.DocumentState Enum Members)

    Value Description
    New New document, just created. Can be edited. (Stored as 0).
    Database Value: 0
    Model Value: 0
    Domain API Value: 'New'
    Adjustment Document which adjusts other released documents. (Stored as 5).
    Database Value: 5
    Model Value: 5
    Domain API Value: 'Adjustment'
    Planned Planned by the system for future releasing. (Stored as 10).
    Database Value: 10
    Model Value: 10
    Domain API Value: 'Planned'
    FirmPlanned Planned by operator for future releasing. (Stored as 20).
    Database Value: 20
    Model Value: 20
    Domain API Value: 'FirmPlanned'
    Released Released document. Changes can be applied only through adjustment documents. (Stored as 30).
    Database Value: 30
    Model Value: 30
    Domain API Value: 'Released'
    Completed Work has completed. (Stored as 40).
    Database Value: 40
    Model Value: 40
    Domain API Value: 'Completed'
    Closed The document is audited and closed. Adjustments are not allowed, but reopening is allowed. (Stored as 50).
    Database Value: 50
    Model Value: 50
    Domain API Value: 'Closed'

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

    UserStatusName

    Multi-language name of the user status. Required Filter(eq;like)

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

    Reference Details

    DocumentType

    The document type, to which this user status is bound. Required Filter(multi eq) Owner

    Type: DocumentTypes
    Indexed: True
    Category: System
    Supported Filters: Equals, EqualsIn
    Filterable Reference: True
    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

    • R29435 DocumentTypeUserStatus - No User Statuses If Transitional

    Front-End Business Rules

    None

    API

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

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

    • Improve this Doc
    Back to top Generated by DocFX