Skip to content

Latest commit

 

History

History
248 lines (177 loc) · 9.64 KB

Crm.Marketing.ProductDistributionChannels.md

File metadata and controls

248 lines (177 loc) · 9.64 KB
Raw
uid
Crm.Marketing.ProductDistributionChannels

Crm.Marketing.ProductDistributionChannels Entity

Namespace: Crm.Marketing

Channel assignments (listing) for products. Entity: Crm_Product_Distribution_Channels

Default Visualization

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

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 When the product was listed. null-the product was not yet listed. The data is for informational purposes only and does not affect the listing status of the product (Is_Active does). Default(Today) Filter(ge;le)
Id guid
IsActive boolean Is this product listing active? true=Yes, false=No. Required Default(true) Filter(eq)
MinimalSalesPricePerLot Amount (18, 4) nullable Minimal allowed price for sales of this product through this channel. The price is for one standard lot and in the costing currency of the product. The minimum is enforced upon planning and/or releasing a document. null means that there is no minimal sales price enforcement. Currency: Product.CostingCurrency
MinimalSalesQuantityBase decimal (18, 3) nullable Minimal base quantity of the current product that has to be specified in any sale for this distribution channel.
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.
ToDate date nullable When the product was de-listed. null=unknown or the product was not de-listed. The data is for informational purposes only and does not affect the listing status of the product (Is_Active does). Filter(ge;le)

References

Name Type Description
DistributionChannel DistributionChannels The distribution channel in which the product is listed. Required Filter(multi eq)
Product Products The listed product. 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

FromDate

When the product was listed. null-the product was not yet listed. The data is for informational purposes only and does not affect the listing status of the product (Is_Active does). Default(Today) Filter(ge;le)

Type: date nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDate
Show in UI: ShownByDefault

Id

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

IsActive

Is this product listing active? true=Yes, false=No. Required Default(true) Filter(eq)

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

MinimalSalesPricePerLot

Minimal allowed price for sales of this product through this channel. The price is for one standard lot and in the costing currency of the product. The minimum is enforced upon planning and/or releasing a document. null means that there is no minimal sales price enforcement. Currency: Product.CostingCurrency

Type: Amount (18, 4) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

MinimalSalesQuantityBase

Minimal base quantity of the current product that has to be specified in any sale for this distribution channel.

Type: decimal (18, 3) nullable
Category: System
Supported Filters: NotFilterable
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

ToDate

When the product was de-listed. null=unknown or the product was not de-listed. The data is for informational purposes only and does not affect the listing status of the product (Is_Active does). Filter(ge;le)

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

Reference Details

DistributionChannel

The distribution channel in which the product is listed. Required Filter(multi eq)

Type: DistributionChannels
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Product

The listed product. Required Filter(multi eq) Owner

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

[!list limit=1000 erp.entity=Crm.Marketing.ProductDistributionChannels erp.type=business-rule default-text="None"]

Front-End Business Rules

[!list limit=1000 erp.entity=Crm.Marketing.ProductDistributionChannels erp.type=front-end-business-rule default-text="None"]

API

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

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