General.Products.ProductCatalogs Entity

Product catalogs serve to organize the products for display primarily in web pages. Entity: Gen_Product_Catalogs

Default Visualization

Default Display Text Format:
{Name:T}
Default Search Members:
Code; Name
Code Data Member:
Code
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 Tree

General.Products.ProductCatalogs

Attributes

Name	Type	Description
BackgroundColor	int32 nullable	When not null, specifies the background color to use for visualization of the catalog. The color is in RGBA color format.
BackgroundImage	byte[] nullable	The background image to be used for web visualization of the catalog. null means that background image won't be displayed.
BackgroundPosition Horizontal	BackgroundPosition Horizontal	Horizontal position of the Background Image. L=Left, C=Center, R=Right. `Required` `Default("L")`
BackgroundPositionVertical	BackgroundPositionVertical	Vertical position of the Background Image. T=Top, C=Center, B=Bottom. `Required` `Default("T")`
BackgroundRepeat	BackgroundRepeat	Specifies if and how the background image will be repeated. R=Repeat both vertically and horizontally; X=Repeat only horizontally; Y=Repeat only vertically; N=No repeat. `Required` `Default("R")`
Code	string (16)	Unique catalog code. `Required`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FooterHtml	string (max) nullable	The footer of the catalog in HTML format. Primarily used for web visualizations of the catalog. null means that there shouldn't be any user-defined footer.
HeaderHtml	string (max) nullable	The header of the catalog in HTML format. Primarily used for web visualizations of the catalog. null specifies that there shouldn't be any user-defined header.
Id	guid
Logo	byte[] nullable	The logo of the product catalog. Used for web and other visualization of the catalog.
Name	MultilanguageString (254)	Product catalog name (multilanguage). `Required`
Notes	string (max) nullable	Notes for this ProductCatalog.
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.

References

Name	Type	Description
RootProductGroup	ProductGroups	The root (starting) product group of the catalog. Each catalog starts from a root product group and includes the products in the sub-groups. `Required` `Filter(multi eq)`
WebSite	WebSites (nullable)	The ECommerce web site, which will be used to host the product catalog. When null, the product catalog would not be hosted with internal ECommerce site. `Filter(multi eq)` `Introduced in version 19.1`

Attribute Details

BackgroundColor

When not null, specifies the background color to use for visualization of the catalog. The color is in RGBA color format.

Type: int32 nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

BackgroundImage

The background image to be used for web visualization of the catalog. null means that background image won't be displayed.

Type: byte[] nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

BackgroundPositionHorizontal

Horizontal position of the Background Image. L=Left, C=Center, R=Right. Required Default("L")

Type: BackgroundPosition
Horizontal
Category: System
Allowed values for the BackgroundPositionHorizontal(General.Products.ProductCatalogs.md#backgroundpositionhorizontal) data attribute
Allowed Values (General.Products.ProductCatalogsRepository.BackgroundPositionHorizontal Enum Members)

Value	Description
Left	Left value. Stored as 'L'. Database Value: 'L' Model Value: 0 Domain API Value: 'Left'
Center	Center value. Stored as 'C'. Database Value: 'C' Model Value: 1 Domain API Value: 'Center'
Right	Right value. Stored as 'R'. Database Value: 'R' Model Value: 2 Domain API Value: 'Right'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: Left
Show in UI: ShownByDefault

BackgroundPositionVertical

Vertical position of the Background Image. T=Top, C=Center, B=Bottom. Required Default("T")

Type: BackgroundPositionVertical
Category: System
Allowed values for the BackgroundPositionVertical(General.Products.ProductCatalogs.md#backgroundpositionvertical) data attribute
Allowed Values (General.Products.ProductCatalogsRepository.BackgroundPositionVertical Enum Members)

Value	Description
Top	Top value. Stored as 'T'. Database Value: 'T' Model Value: 0 Domain API Value: 'Top'
Center	Center value. Stored as 'C'. Database Value: 'C' Model Value: 1 Domain API Value: 'Center'
Bottom	Bottom value. Stored as 'B'. Database Value: 'B' Model Value: 2 Domain API Value: 'Bottom'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: Top
Show in UI: ShownByDefault

BackgroundRepeat

Specifies if and how the background image will be repeated. R=Repeat both vertically and horizontally; X=Repeat only horizontally; Y=Repeat only vertically; N=No repeat. Required Default("R")

Type: BackgroundRepeat
Category: System
Allowed values for the BackgroundRepeat(General.Products.ProductCatalogs.md#backgroundrepeat) data attribute
Allowed Values (General.Products.ProductCatalogsRepository.BackgroundRepeat Enum Members)

Value	Description
RepeatBothVertically AndHorizontally	RepeatBothVertically AndHorizontally value. Stored as 'R'. Database Value: 'R' Model Value: 0 Domain API Value: 'RepeatBothVertically AndHorizontally'
RepeatOnlyHorizontally	RepeatOnlyHorizontally value. Stored as 'X'. Database Value: 'X' Model Value: 1 Domain API Value: 'RepeatOnlyHorizontally'
RepeatOnlyVertically	RepeatOnlyVertically value. Stored as 'Y'. Database Value: 'Y' Model Value: 2 Domain API Value: 'RepeatOnlyVertically'
NoRepeat	NoRepeat value. Stored as 'N'. Database Value: 'N' Model Value: 3 Domain API Value: 'NoRepeat'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: RepeatBothVerticallyAndHorizontally
Show in UI: ShownByDefault

Code

Unique catalog code. Required

Type: string (16)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 16
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

FooterHtml

The footer of the catalog in HTML format. Primarily used for web visualizations of the catalog. null means that there shouldn't be any user-defined footer.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: CannotBeShown

HeaderHtml

The header of the catalog in HTML format. Primarily used for web visualizations of the catalog. null specifies that there shouldn't be any user-defined header.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: CannotBeShown

Id

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

Logo

The logo of the product catalog. Used for web and other visualization of the catalog.

Type: byte[] nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Name

Product catalog name (multilanguage). Required

Type: MultilanguageString (254)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Notes

Notes for this ProductCatalog.

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

Reference Details

RootProductGroup

The root (starting) product group of the catalog. Each catalog starts from a root product group and includes the products in the sub-groups. Required Filter(multi eq)

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

WebSite

The ECommerce web site, which will be used to host the product catalog. When null, the product catalog would not be hosted with internal ECommerce site. Filter(multi eq) Introduced in version 19.1

Type: WebSites (nullable)
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