Projects.Agile.UserStates Entity

Workflow states for the case categories. Entity: Apm_User_States (Introduced in version 25.1.0.96)

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
Name
Name Data Member:
Name
Category: Settings
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 Parent:
Projects.Agile.CaseCategories
Aggregate Root:
Projects.Agile.CaseCategories

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
IsActive	boolean	Specifies whether the user state can be set to cases. `Required` `Default(true)` `Filter(eq)`
Name	MultilanguageString (256)	Multi-language name of the user state. `Required` `Filter(eq;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.
Ord	int32	Unique ordinal position of the state within the system state. `Required` `Filter(eq;ge;le)` `ORD`
SystemState	SystemState	The system state, which this state extends. `Required` `Filter(multi eq)`

References

Name	Type	Description
CaseCategory	CaseCategories	The category for which the user state is defined. `Required` `Filter(multi eq)` `Owner`

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
Show in UI: CannotBeShown

IsActive

Specifies whether the user state can be set to cases. Required Default(true) Filter(eq)

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

Name

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

Type: MultilanguageString (256)
Category: System
Supported Filters: Equals, Like
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

Ord

Unique ordinal position of the state within the system state. Required Filter(eq;ge;le) ORD

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

Back-End Default Expression:
obj.SetUserStateOrd( obj.SystemState)

Front-End Recalc Expressions:
obj.SetUserStateOrd( obj.SystemState)

SystemState

The system state, which this state extends. Required Filter(multi eq)

Type: SystemState
Category: System
Allowed values for the SystemState(Projects.Agile.Cases.md#systemstate) data attribute
Allowed Values (Projects.Agile.CasesRepository.SystemState Enum Members)

Value	Description
BACKLOG	BACKLOG. Stored as '1'. Database Value: '1' Model Value: 0 Domain API Value: 'BACKLOG'
CONSIDER	CONSIDER. Stored as '2'. Database Value: '2' Model Value: 1 Domain API Value: 'CONSIDER'
READY	READY. Stored as '3'. Database Value: '3' Model Value: 2 Domain API Value: 'READY'
INPROGRESS	IN PROGRESS. Stored as '4'. Database Value: '4' Model Value: 3 Domain API Value: 'INPROGRESS'
WAITING	WAITING. Stored as '5'. Database Value: '5' Model Value: 4 Domain API Value: 'WAITING'
RESOLVED	RESOLVED. Stored as '6'. Database Value: '6' Model Value: 5 Domain API Value: 'RESOLVED'
CLOSED	CLOSED. Stored as '7'. Database Value: '7' Model Value: 6 Domain API Value: 'CLOSED'

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

Reference Details

CaseCategory

The category for which the user state is defined. Required Filter(multi eq) Owner

Type: CaseCategories
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

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