Crm.Sales.CustomerClientCenterPermissions Entity

Namespace: Crm.Sales

Defines the users permissions to specific customer data within the Client Center. Entity: Crm_Customer_Client_Center_Permissions (Introduced in version 25.1.2.29)

Default Visualization

Default Display Text Format:
{CustomerId} - {ShipToCustomerId} - {UserId}
Default Search Members:
Customer.Party.PartyName
Name Data Member:
Customer.Party.PartyName
Category: Definitions
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:
Crm.Sales.Customers
Aggregate Root:
Crm.Sales.Customers

Attributes

Name	Type	Description
DaysBackAccess	int32 nullable	The maximum number of past days the user is allowed to view. If null, the access is unlimited. `Default(30)` `Filter(eq;ge;le)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
Notes	string (max) nullable	Notes for this Permission.
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.
Role	Role	The role defines the granted permissions. `Required` `Default("L30")` `Filter(eq)`

References

Name	Type	Description
Customer	Customers	The customer whose data is being accessed. `Required` `Filter(multi eq)` `Owner`
ShipToCustomer	Customers (nullable)	The customers location, whose data is being accessed. `Filter(multi eq)`
User	Users	The user for whom the access is granted. `Required` `Filter(multi eq)`

Attribute Details

DaysBackAccess

The maximum number of past days the user is allowed to view. If null, the access is unlimited. Default(30) Filter(eq;ge;le)

Type: int32 nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Default Value: 30
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

Id

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

Notes

Notes for this Permission.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
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

Role

The role defines the granted permissions. Required Default("L30") Filter(eq)

Type: Role
Category: System
Allowed values for the Role(Crm.Sales.CustomerClientCenterPermissions.md#role) data attribute
Allowed Values (Crm.Sales.CustomerClientCenterPermissionsRepository.Role Enum Members)

Value	Description
Basic	Basic. Stored as 'L10'. Database Value: 'L10' Model Value: 0 Domain API Value: 'Basic'
Orders	Orders. Stored as 'L20'. Database Value: 'L20' Model Value: 1 Domain API Value: 'Orders'
OrdersPayments	Orders & Payments. Stored as 'L30'. Database Value: 'L30' Model Value: 2 Domain API Value: 'OrdersPayments'
Admin	Admin. Stored as 'L80'. Database Value: 'L80' Model Value: 3 Domain API Value: 'Admin'
Owner	Owner. Stored as 'L90'. Database Value: 'L90' Model Value: 4 Domain API Value: 'Owner'

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

Reference Details

Customer

The customer whose data is being accessed. Required Filter(multi eq) Owner

Type: Customers
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

ShipToCustomer

The customers location, whose data is being accessed. Filter(multi eq)

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

User

The user for whom the access is granted. Required Filter(multi eq)

Type: Users
Indexed: True
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