Projects.Agile.CaseAssignmentRules Entity

Namespace: Projects.Agile

Contains rules for automatically assigning cases to users based on the values of the case fields, such as project, project area, case category, system state, user state, etc. Entity: Apm_Case_Assignment_Rules (Introduced in version 25.1.3.5)

Default Visualization

Default Display Text Format:
{RuleNo} - {AssignToUser}
Default Search Members:
__
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 Tree

Projects.Agile.CaseAssignmentRules

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FromDate	date nullable	Starting date of rule validity. null means no from date restriction. `Filter(eq;ge;le)`
Id	guid
IsActive	boolean	Indicates whether the current rule is active. `Required` `Default(true)` `Filter(eq)`
Notes	string (max) nullable	Additional information or comments related to the rule. `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.
Priority	Priority	Priority when multiple rules match the criteria. `Required` `Default("3")` `Filter(eq)`
RuleNo	int32	Consecutive number of the rule. `Required` `Filter(eq)` `ORD`
SystemState	SystemState nullable	The system state to which the rule applies. null means the rule applies to all user states. `Filter(multi eq)`
ToDate	date nullable	Ending date (inclusive) of rule validity. null means that the rule is valid forever. `Filter(eq;ge;le)`

References

Name	Type	Description
AssignToUser	Users	The user who will be automatically assigned to the case when the rule conditions are matched. `Required` `Filter(multi eq)`
CaseCategory	CaseCategories (nullable)	The case category to which the rule applies. null means the rule applies to all categories. `Filter(multi eq)`
Project	Projects (nullable)	The project to which the rule applies. null means the rule applies to all projects. `Filter(multi eq)`
ProjectArea	ProjectAreas (nullable)	The project area to which the rule applies. null means the rule applies to all project areas. `Filter(multi eq)`
ProjectMilestone	ProjectMilestones (nullable)	The project milestone to which the rule applies. null means the rule applies to all milestones. `Filter(multi eq)`
StakeholderParty	Parties (nullable)	The stakeholder party to which the rule applies. null means the rule applies to all parties. `Filter(multi eq)`
UserState	UserStates (nullable)	The user state to which the rule applies. null means the rule applies to all user states. `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

FromDate

Starting date of rule validity. null means no from date restriction. Filter(eq;ge;le)

Type: date nullable
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

IsActive

Indicates whether the current rule is active. Required Default(true) Filter(eq)

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

Notes

Additional information or comments related to the rule. 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

Priority

Priority when multiple rules match the criteria. Required Default("3") Filter(eq)

Type: Priority
Category: System
Allowed values for the Priority(Projects.Agile.CaseAssignmentRules.md#priority) data attribute
Allowed Values (Projects.Agile.CaseAssignmentRulesRepository.Priority Enum Members)

Value	Description
Highest	Highest. Stored as '1'. Database Value: '1' Model Value: 0 Domain API Value: 'Highest'
High	High. Stored as '2'. Database Value: '2' Model Value: 1 Domain API Value: 'High'
Medium	Medium. Stored as '3'. Database Value: '3' Model Value: 2 Domain API Value: 'Medium'
Low	Low. Stored as '4'. Database Value: '4' Model Value: 3 Domain API Value: 'Low'
Lowest	Lowest. Stored as '5'. Database Value: '5' Model Value: 4 Domain API Value: 'Lowest'

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

RuleNo

Consecutive number of the rule. Required Filter(eq) ORD

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

Back-End Default Expression:
obj.SetRuleNo( )

Front-End Recalc Expressions:
obj.SetRuleNo( )

SystemState

The system state to which the rule applies. null means the rule applies to all user states. Filter(multi eq)

Type: SystemState nullable
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

ToDate

Ending date (inclusive) of rule validity. null means that the rule is valid forever. Filter(eq;ge;le)

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

Reference Details

AssignToUser

The user who will be automatically assigned to the case when the rule conditions are matched. Required Filter(multi eq)

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

CaseCategory

The case category to which the rule applies. null means the rule applies to all categories. Filter(multi eq)

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

Project

The project to which the rule applies. null means the rule applies to all projects. Filter(multi eq)

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

ProjectArea

The project area to which the rule applies. null means the rule applies to all project areas. Filter(multi eq)

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

ProjectMilestone

The project milestone to which the rule applies. null means the rule applies to all milestones. Filter(multi eq)

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

StakeholderParty

The stakeholder party to which the rule applies. null means the rule applies to all parties. Filter(multi eq)

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

UserState

The user state to which the rule applies. null means the rule applies to all user states. Filter(multi eq)

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

None

Front-End Business Rules

R38648 Case Assignment Rule - Set Rule No (Recalc)

API

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

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

Table of Contents

Projects.Agile.CaseAssignmentRules Entity

Default Visualization

Track Changes

Aggregate

Attributes

References

Attribute Details

DisplayText

FromDate

Id

IsActive

Notes

ObjectVersion

Priority

RuleNo

SystemState

ToDate

Reference Details

AssignToUser

CaseCategory

Project

ProjectArea

ProjectMilestone

StakeholderParty

UserState

API Methods

GetAllowedCustomPropertyValues

CreateNotification

CreateCopy

Business Rules

Front-End Business Rules

API