By Type
commercetools Connector Extend (Customisation) Guidelines
FeatureA Fluent Connector project typically has the structure as defined below :
com.fluentcommerce.connect.custom
Any customizations/extensions can either be done under the custom folder or as a separate module (jar) altogether.
Regardless of which way one chooses to extend it, the key message here is that any custom code should be under the `com.fluentcommerce.connect` package. This is due to how the FluentConnectorApplication is wired to work with Spring, and in its current form, Spring will only scan for components under `com.fluentcommerce.connect`.
During the server start-up, the commercetools-connector will load all handlers found in the spring context and bind them to the correct service they belong to. As part of this binding process, the commercetools-connector also determines which handler has precedence over others of the same name. In other words, it is possible to override existing handlers by assigning a higher priority to the custom handler. By default, all handlers will have a priority of zero, and the commercetools-connector understands the highest priority as the higher number. For example, priority = 100 takes precedence over priority = 1.`@HandlerInfo(name = "CustomCategoryUpsert", priority = 100)`Adding a Ruleset to your Workflow
How-to Guide- The Ruleset, defining the executed actions for matching events, can be added through the UI using either an existing Ruleset list or the Entity Workflow Swimlane.
- Green icons in the Status rectangles represent Rulesets triggered on that State, while those outside a status transition the entity to the indicated state.
- Adding a Ruleset via JSON requires inclusion in the Workflow JSON's Rulesets Array, following a schema with mandatory elements like name, rules, and triggers, and optional elements like description, type, subtype, eventType, and userActions.
View Category with assigned Products in OMS Webapp
How-to Guide- Standard Product Page: A standard product page typically includes detailed information about a single product, such as descriptions, specifications, images, pricing, and customer reviews. They are essential for providing customers with all the necessary information to make an informed purchase decision.
- Variant Product Page: A variant product page is used when a product comes in different versions, such as sizes, colors, or models. These pages allow customers to choose their preferred variant while viewing the product's overall information. This approach simplifies the shopping experience and helps customers find the exact product they need.
- Consistent Layout: When adding both standard and variant product pages to a product category page, it's crucial to maintain a consistent layout and design. This consistency ensures a seamless user experience and makes it easier for customers to navigate and compare products.
- Clear Navigation: Implement clear navigation elements, such as filters and sorting options, on the product category page. This helps customers quickly find the specific products or variants they are looking for, improving their overall experience.
Raise a Support Request for Reference Modules
How-to Guide- Before raising a ticket, review the reference module setup and configuration guides, Use the Event API to validate the workflow process executed, including source Event, Rulesets, and Rules, and Check all Settings, Users, Roles, Auth Tokens, etc. before raising an issue.
- Support is provided for reference modules, which are Core, Order, Fulfilment, and Inventory.
- Raise a Support Request for Reference Modules with a Fluent Retail Support (FRS) ticket.