Crm.SalesPersonAssignmentRules Entity

Namespace: Crm

Contains rules for automated assignment of sales persons for customers, sales orders, leads, etc. Entity: Crm_Sales_Person_Assignment_Rules (Introduced in version 25.1.0.17)

Default Visualization

Default Display Text Format:
{EnterpriseCompany} : {RuleNo} - {SalesPerson}
Default Search Members:
__
Category: Settings
Show in UI: ShownByDefault

Aggregate

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

Aggregate Tree

Crm.SalesPersonAssignmentRules

Attributes

Name	Type	Description
ApplyTo	ApplyTo	Determines whether the rule is applied to customers' definitions (customers and leads) or to documents. `Required` `Default("C")` `Filter(eq)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FromDate	datetime 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)` `Introduced in version 25.1.0.23`
RuleNo	int32	Consecutive number of the rule within the selected enterprise company. `Required` `Filter(eq)` `ORD`
ToDate	datetime nullable	Ending date (inclusive) of rule validity. null means that the rule is valid forever. `Filter(eq;ge;le)`

References

Name	Type	Description
CompanyDivision	CompanyDivisions (nullable)	Our division, which is in charge of the deal. `Filter(multi eq)`
CustomerType	CustomerTypes (nullable)	The type of the customer. `Filter(multi eq)`
EnterpriseCompany	EnterpriseCompanies	The enterprise company for which the rule applies. `Required` `Filter(multi eq)`
SalesArea	Areas (nullable)	The sales area, where the customer is located. `Filter(multi eq)`
SalesPerson	SalesPersons	The sales person to be assigned by the rule. `Required` `Filter(multi eq)`

Attribute Details

ApplyTo

Determines whether the rule is applied to customers' definitions (customers and leads) or to documents. Required Default("C") Filter(eq)

Type: ApplyTo
Category: System
Allowed values for the ApplyTo(Crm.SalesPersonAssignmentRules.md#applyto) data attribute
Allowed Values (Crm.SalesPersonAssignmentRulesRepository.ApplyTo Enum Members)

Value	Description
Customers	Customers . Stored as 'C'. Database Value: 'C' Model Value: 0 Domain API Value: 'Customers'
Documents	Documents . Stored as 'D'. Database Value: 'D' Model Value: 1 Domain API Value: 'Documents'

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

FromDate

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

Type: datetime 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) Introduced in version 25.1.0.23

Type: Priority
Category: System
Allowed values for the Priority(Crm.SalesPersonAssignmentRules.md#priority) data attribute
Allowed Values (Crm.SalesPersonAssignmentRulesRepository.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 within the selected enterprise company. Required Filter(eq) ORD

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

Back-End Default Expression:
obj.SetRuleNo( obj.EnterpriseCompany)

Front-End Recalc Expressions:
obj.SetRuleNo( obj.EnterpriseCompany)

ToDate

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

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

Reference Details

CompanyDivision

Our division, which is in charge of the deal. Filter(multi eq)

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

CustomerType

The type of the customer. Filter(multi eq)

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

EnterpriseCompany

The enterprise company for which the rule applies. Required Filter(multi eq)

Type: EnterpriseCompanies
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

SalesArea

The sales area, where the customer is located. Filter(multi eq)

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

SalesPerson

The sales person to be assigned by the rule. Required Filter(multi eq)

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